refactor: wip

Author: BioPhoton

packages/utils/src/lib/profiler/constants.ts

@@ -17,14 +17,13 @@ export const PROFILER_ENABLED_ENV_VAR = 'CP_PROFILING';
 export const PROFILER_DEBUG_ENV_VAR = 'DEBUG';
 
 /**
- * Environment variable name for setting the Sharded WAL Coordinator ID.
+ * Environment variable name for setting the Profiler Sharder ID.
  * This ID is used to identify the coordinator instance in a sharded Write-Ahead Logging setup.
  *
  * @example
- * CP_SHARDED_WAL_COORDINATOR_ID=coordinator-1 npm run dev
+ * CP_PROFILER_SHARDER_ID=coordinator-1 npm run dev
  */
-export const SHARDED_WAL_COORDINATOR_ID_ENV_VAR =
-  'CP_SHARDED_WAL_COORDINATOR_ID';
+export const PROFILER_SHARDER_ID_ENV_VAR = 'CP_PROFILER_SHARDER_ID';
 
 /**
  * Default output directory for persisted profiler data.

packages/utils/src/lib/profiler/profiler-node.int.test.ts

@@ -21,7 +21,7 @@ import {
   PROFILER_ENABLED_ENV_VAR,
   PROFILER_MEASURE_NAME_ENV_VAR,
   PROFILER_OUT_DIR_ENV_VAR,
-  SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+  PROFILER_SHARDER_ID_ENV_VAR,
 } from './constants.js';
 import { NodejsProfiler, type NodejsProfilerOptions } from './profiler-node.js';
 import { entryToTraceEvents } from './trace-file-utils.js';
@@ -187,7 +187,7 @@ describe('NodeJS Profiler Integration', () => {
     vi.stubEnv(PROFILER_ENABLED_ENV_VAR, undefined!);
     vi.stubEnv(PROFILER_DEBUG_ENV_VAR, undefined!);
     // eslint-disable-next-line functional/immutable-data
-    delete process.env[SHARDED_WAL_COORDINATOR_ID_ENV_VAR];
+    delete process.env[PROFILER_SHARDER_ID_ENV_VAR];
   });
 
   afterEach(() => {
@@ -201,7 +201,7 @@ describe('NodeJS Profiler Integration', () => {
     vi.stubEnv(PROFILER_ENABLED_ENV_VAR, undefined!);
     vi.stubEnv(PROFILER_DEBUG_ENV_VAR, undefined!);
     // eslint-disable-next-line functional/immutable-data
-    delete process.env[SHARDED_WAL_COORDINATOR_ID_ENV_VAR];
+    delete process.env[PROFILER_SHARDER_ID_ENV_VAR];
   });
 
   afterAll(async () => {
@@ -396,7 +396,7 @@ describe('NodeJS Profiler Integration', () => {
     const numProcesses = 3;
 
     const {
-      [SHARDED_WAL_COORDINATOR_ID_ENV_VAR]: _coordinatorId,
+      [PROFILER_SHARDER_ID_ENV_VAR]: _coordinatorId,
       [PROFILER_MEASURE_NAME_ENV_VAR]: _measureName,
       ...cleanEnv
     } = process.env;

packages/utils/src/lib/profiler/profiler-node.ts

@@ -20,7 +20,7 @@ import {
   PROFILER_MEASURE_NAME_ENV_VAR,
   PROFILER_OUT_DIR_ENV_VAR,
   PROFILER_PERSIST_OUT_DIR,
-  SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+  PROFILER_SHARDER_ID_ENV_VAR,
 } from './constants.js';
 import { Profiler, type ProfilerOptions } from './profiler.js';
 
@@ -132,7 +132,7 @@ export class NodejsProfiler<
     this.#sharder = new ShardedWal<DomainEvents>({
       dir: process.env[PROFILER_OUT_DIR_ENV_VAR] ?? outDir,
       format,
-      coordinatorIdEnvVar: SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+      coordinatorIdEnvVar: PROFILER_SHARDER_ID_ENV_VAR,
       measureNameEnvVar: PROFILER_MEASURE_NAME_ENV_VAR,
       groupId: measureName,
     });

packages/utils/src/lib/profiler/profiler-node.unit.test.ts

@@ -16,7 +16,7 @@ import type {
 import * as WalModule from '../wal.js';
 import {
   PROFILER_PERSIST_OUT_DIR,
-  SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+  PROFILER_SHARDER_ID_ENV_VAR,
 } from './constants';
 import { NodejsProfiler, type NodejsProfilerOptions } from './profiler-node.js';
 import { Profiler, getProfilerId } from './profiler.js';
@@ -43,7 +43,7 @@ const resetEnv = () => {
   // eslint-disable-next-line functional/immutable-data
   delete process.env.CP_PROFILING;
   // eslint-disable-next-line functional/immutable-data
-  delete process.env[SHARDED_WAL_COORDINATOR_ID_ENV_VAR];
+  delete process.env[PROFILER_SHARDER_ID_ENV_VAR];
 };
 
 const expectRunning = (p: NodejsProfiler<any>) => {
@@ -229,7 +229,7 @@ describe('NodejsProfiler', () => {
     });
 
     it('should NOT initialize as coordinator if env vars is defined', async () => {
-      vi.stubEnv(SHARDED_WAL_COORDINATOR_ID_ENV_VAR, getProfilerId());
+      vi.stubEnv(PROFILER_SHARDER_ID_ENV_VAR, getProfilerId());
       const profiler = createProfiler('is-coordinator');
       expect(profiler.stats.isCoordinator).toBe(false);
       profiler.marker('special-marker');

packages/utils/src/lib/wal-sharded.int.test.ts

@@ -1,7 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
-import { SHARDED_WAL_COORDINATOR_ID_ENV_VAR } from './profiler/constants.js';
+import { PROFILER_SHARDER_ID_ENV_VAR } from './profiler/constants.js';
 import { ShardedWal } from './wal-sharded.js';
 import { createTolerantCodec, stringCodec } from './wal.js';
 
@@ -40,7 +40,7 @@ describe('ShardedWal Integration', () => {
         finalExtension: '.json',
         finalizer: records => `${JSON.stringify(records)}\n`,
       },
-      coordinatorIdEnvVar: SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+      coordinatorIdEnvVar: PROFILER_SHARDER_ID_ENV_VAR,
       groupId: 'create-finalize',
       filename: 'test-shard-1',
     });
@@ -80,7 +80,7 @@ describe('ShardedWal Integration', () => {
         finalExtension: '.json',
         finalizer: records => `${JSON.stringify(records)}\n`,
       },
-      coordinatorIdEnvVar: SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+      coordinatorIdEnvVar: PROFILER_SHARDER_ID_ENV_VAR,
       groupId: 'merge-shards',
       filename: 'shard-1',
     });
@@ -126,7 +126,7 @@ describe('ShardedWal Integration', () => {
         codec: tolerantCodec,
         finalizer: records => `${JSON.stringify(records)}\n`,
       },
-      coordinatorIdEnvVar: SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+      coordinatorIdEnvVar: PROFILER_SHARDER_ID_ENV_VAR,
       groupId: 'invalid-entries',
       filename: 'test-shard',
     });
@@ -163,7 +163,7 @@ describe('ShardedWal Integration', () => {
         finalExtension: '.json',
         finalizer: records => `${JSON.stringify(records)}\n`,
       },
-      coordinatorIdEnvVar: SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+      coordinatorIdEnvVar: PROFILER_SHARDER_ID_ENV_VAR,
       groupId: 'cleanup-test',
       filename: 'shard-1',
     });
@@ -210,7 +210,7 @@ describe('ShardedWal Integration', () => {
         finalizer: (records, opt) =>
           `${JSON.stringify({ records, metadata: opt })}\n`,
       },
-      coordinatorIdEnvVar: SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+      coordinatorIdEnvVar: PROFILER_SHARDER_ID_ENV_VAR,
       groupId: 'custom-finalizer',
       filename: 'custom-shard',
     });
@@ -246,7 +246,7 @@ describe('ShardedWal Integration', () => {
         finalExtension: '.json',
         finalizer: records => `${JSON.stringify(records)}\n`,
       },
-      coordinatorIdEnvVar: SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+      coordinatorIdEnvVar: PROFILER_SHARDER_ID_ENV_VAR,
       groupId: 'empty-shards',
     });
 

packages/utils/src/lib/wal-sharded.unit.test.ts

@@ -2,7 +2,7 @@ import { vol } from 'memfs';
 import { beforeEach, describe, expect, it } from 'vitest';
 import { MEMFS_VOLUME } from '@code-pushup/test-utils';
 import { getUniqueInstanceId } from './process-id.js';
-import { SHARDED_WAL_COORDINATOR_ID_ENV_VAR } from './profiler/constants.js';
+import { PROFILER_SHARDER_ID_ENV_VAR } from './profiler/constants.js';
 import { ShardedWal } from './wal-sharded.js';
 import { WriteAheadLogFile, createTolerantCodec } from './wal.js';
 
@@ -17,7 +17,7 @@ const getShardedWal = (overrides?: {
   new ShardedWal({
     dir: '/test/shards',
     format: { baseName: 'test-wal' },
-    coordinatorIdEnvVar: SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
+    coordinatorIdEnvVar: PROFILER_SHARDER_ID_ENV_VAR,
     ...overrides,
   });
 
@@ -26,7 +26,7 @@ describe('ShardedWal', () => {
     vol.reset();
     vol.fromJSON({}, MEMFS_VOLUME);
     // Clear coordinator env var for fresh state
-    delete process.env[SHARDED_WAL_COORDINATOR_ID_ENV_VAR];
+    delete process.env[PROFILER_SHARDER_ID_ENV_VAR];
   });
 
   describe('initialization', () => {
@@ -226,7 +226,7 @@ describe('ShardedWal', () => {
       });
 
       // Ensure no coordinator is set
-      delete process.env[SHARDED_WAL_COORDINATOR_ID_ENV_VAR];
+      delete process.env[PROFILER_SHARDER_ID_ENV_VAR];
 
       const sw = getShardedWal({
         dir: '/shards',
@@ -246,7 +246,7 @@ describe('ShardedWal', () => {
       });
 
       // Ensure no coordinator is set
-      delete process.env[SHARDED_WAL_COORDINATOR_ID_ENV_VAR];
+      delete process.env[PROFILER_SHARDER_ID_ENV_VAR];
 
       const sw = getShardedWal({
         dir: '/shards',
@@ -364,10 +364,7 @@ describe('ShardedWal', () => {
       });
 
       // Set coordinator BEFORE creating instance
-      ShardedWal.setCoordinatorProcess(
-        SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
-        instanceId,
-      );
+      ShardedWal.setCoordinatorProcess(PROFILER_SHARDER_ID_ENV_VAR, instanceId);
 
       const sw = getShardedWal({
         dir: '/shards',
@@ -416,10 +413,7 @@ describe('ShardedWal', () => {
       });
 
       // Set coordinator BEFORE creating instance
-      ShardedWal.setCoordinatorProcess(
-        SHARDED_WAL_COORDINATOR_ID_ENV_VAR,
-        instanceId,
-      );
+      ShardedWal.setCoordinatorProcess(PROFILER_SHARDER_ID_ENV_VAR, instanceId);
 
       const sw = getShardedWal({
         dir: '/shards',
@@ -451,7 +445,7 @@ describe('ShardedWal', () => {
       });
 
       // Not coordinator - cleanupIfCoordinator should be no-op
-      delete process.env[SHARDED_WAL_COORDINATOR_ID_ENV_VAR];
+      delete process.env[PROFILER_SHARDER_ID_ENV_VAR];
       sw.cleanupIfCoordinator();
       expect(vol.toJSON()).not.toStrictEqual({});
       expect(sw.getState()).toBe('active');