refactor: wip

Author: BioPhoton

packages/utils/src/lib/exit-process.int.test.ts

@@ -1,8 +1,8 @@
 import process from 'node:process';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import { SIGNAL_EXIT_CODES, installExitHandlers } from './exit-process.js';
+import { SIGNAL_EXIT_CODES, subscribeProcessExit } from './exit-process.js';
 
-describe('installExitHandlers', () => {
+describe('subscribeProcessExit', () => {
   const onError = vi.fn();
   const onExit = vi.fn();
   const processOnSpy = vi.spyOn(process, 'on');
@@ -26,7 +26,7 @@ describe('installExitHandlers', () => {
   });
 
   it('should install event listeners for all expected events', () => {
-    expect(() => installExitHandlers({ onError, onExit })).not.toThrow();
+    expect(() => subscribeProcessExit({ onError, onExit })).not.toThrow();
 
     expect(processOnSpy).toHaveBeenCalledWith(
       'uncaughtException',
@@ -43,7 +43,7 @@ describe('installExitHandlers', () => {
   });
 
   it('should call onError with error and kind for uncaughtException', () => {
-    expect(() => installExitHandlers({ onError })).not.toThrow();
+    expect(() => subscribeProcessExit({ onError })).not.toThrow();
 
     const testError = new Error('Test uncaught exception');
 
@@ -55,7 +55,7 @@ describe('installExitHandlers', () => {
   });
 
   it('should call onError with reason and kind for unhandledRejection', () => {
-    expect(() => installExitHandlers({ onError })).not.toThrow();
+    expect(() => subscribeProcessExit({ onError })).not.toThrow();
 
     const testReason = 'Test unhandled rejection';
 
@@ -67,7 +67,7 @@ describe('installExitHandlers', () => {
   });
 
   it('should call onExit and exit with code 0 for SIGINT', () => {
-    expect(() => installExitHandlers({ onExit })).not.toThrow();
+    expect(() => subscribeProcessExit({ onExit })).not.toThrow();
 
     (process as any).emit('SIGINT');
 
@@ -80,7 +80,7 @@ describe('installExitHandlers', () => {
   });
 
   it('should call onExit and exit with code 0 for SIGTERM', () => {
-    expect(() => installExitHandlers({ onExit })).not.toThrow();
+    expect(() => subscribeProcessExit({ onExit })).not.toThrow();
 
     (process as any).emit('SIGTERM');
 
@@ -93,7 +93,7 @@ describe('installExitHandlers', () => {
   });
 
   it('should call onExit and exit with code 0 for SIGQUIT', () => {
-    expect(() => installExitHandlers({ onExit })).not.toThrow();
+    expect(() => subscribeProcessExit({ onExit })).not.toThrow();
 
     (process as any).emit('SIGQUIT');
 
@@ -106,7 +106,7 @@ describe('installExitHandlers', () => {
   });
 
   it('should call onExit for successful process termination with exit code 0', () => {
-    expect(() => installExitHandlers({ onExit })).not.toThrow();
+    expect(() => subscribeProcessExit({ onExit })).not.toThrow();
 
     (process as any).emit('exit', 0);
 
@@ -117,7 +117,7 @@ describe('installExitHandlers', () => {
   });
 
   it('should call onExit for failed process termination with exit code 1', () => {
-    expect(() => installExitHandlers({ onExit })).not.toThrow();
+    expect(() => subscribeProcessExit({ onExit })).not.toThrow();
 
     (process as any).emit('exit', 1);
 

packages/utils/src/lib/exit-process.ts

@@ -94,7 +94,7 @@ export function subscribeProcessExit(
       const handler = () => {
         close(SIGNAL_EXIT_CODES()[signal], { kind: 'signal', signal });
         if (exitOnSignal) {
-          // eslint-disable-next-line n/no-process-exit
+          // eslint-disable-next-line unicorn/no-process-exit
           process.exit(SIGNAL_EXIT_CODES()[signal]);
         }
       };

packages/utils/src/lib/exit-process.unit.test.ts

@@ -1,9 +1,9 @@
 import os from 'node:os';
 import process from 'node:process';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import { SIGNAL_EXIT_CODES, installExitHandlers } from './exit-process.js';
+import { SIGNAL_EXIT_CODES, subscribeProcessExit } from './exit-process.js';
 
-describe('exit-process tests', () => {
+describe('subscribeProcessExit', () => {
   const onError = vi.fn();
   const onExit = vi.fn();
   const processOnSpy = vi.spyOn(process, 'on');
@@ -27,7 +27,7 @@ describe('exit-process tests', () => {
   });
 
   it('should install event listeners for all expected events', () => {
-    expect(() => installExitHandlers({ onError, onExit })).not.toThrow();
+    expect(() => subscribeProcessExit({ onError, onExit })).not.toThrow();
 
     expect(processOnSpy).toHaveBeenCalledWith(
       'uncaughtException',
@@ -44,7 +44,7 @@ describe('exit-process tests', () => {
   });
 
   it('should call onError with error and kind for uncaughtException', () => {
-    expect(() => installExitHandlers({ onError })).not.toThrow();
+    expect(() => subscribeProcessExit({ onError })).not.toThrow();
 
     const testError = new Error('Test uncaught exception');
 
@@ -56,7 +56,7 @@ describe('exit-process tests', () => {
   });
 
   it('should call onError with reason and kind for unhandledRejection', () => {
-    expect(() => installExitHandlers({ onError })).not.toThrow();
+    expect(() => subscribeProcessExit({ onError })).not.toThrow();
 
     const testReason = 'Test unhandled rejection';
 
@@ -69,7 +69,7 @@ describe('exit-process tests', () => {
 
   it('should call onExit with correct code and reason for SIGINT', () => {
     expect(() =>
-      installExitHandlers({ onExit, exitOnSignal: true }),
+      subscribeProcessExit({ onExit, exitOnSignal: true }),
     ).not.toThrow();
 
     (process as any).emit('SIGINT');
@@ -85,7 +85,7 @@ describe('exit-process tests', () => {
 
   it('should call onExit with correct code and reason for SIGTERM', () => {
     expect(() =>
-      installExitHandlers({ onExit, exitOnSignal: true }),
+      subscribeProcessExit({ onExit, exitOnSignal: true }),
     ).not.toThrow();
 
     (process as any).emit('SIGTERM');
@@ -101,7 +101,7 @@ describe('exit-process tests', () => {
 
   it('should call onExit with correct code and reason for SIGQUIT', () => {
     expect(() =>
-      installExitHandlers({ onExit, exitOnSignal: true }),
+      subscribeProcessExit({ onExit, exitOnSignal: true }),
     ).not.toThrow();
 
     (process as any).emit('SIGQUIT');
@@ -117,7 +117,7 @@ describe('exit-process tests', () => {
 
   it('should not exit process when exitOnSignal is false', () => {
     expect(() =>
-      installExitHandlers({ onExit, exitOnSignal: false }),
+      subscribeProcessExit({ onExit, exitOnSignal: false }),
     ).not.toThrow();
 
     (process as any).emit('SIGINT');
@@ -132,7 +132,7 @@ describe('exit-process tests', () => {
   });
 
   it('should not exit process when exitOnSignal is not set', () => {
-    expect(() => installExitHandlers({ onExit })).not.toThrow();
+    expect(() => subscribeProcessExit({ onExit })).not.toThrow();
 
     (process as any).emit('SIGTERM');
 
@@ -146,7 +146,7 @@ describe('exit-process tests', () => {
   });
 
   it('should call onExit with exit code and reason for normal exit', () => {
-    expect(() => installExitHandlers({ onExit })).not.toThrow();
+    expect(() => subscribeProcessExit({ onExit })).not.toThrow();
 
     const exitCode = 42;
     (process as any).emit('exit', exitCode);
@@ -159,7 +159,7 @@ describe('exit-process tests', () => {
 
   it('should call onExit with fatal reason when exitOnFatal is true', () => {
     expect(() =>
-      installExitHandlers({ onError, onExit, exitOnFatal: true }),
+      subscribeProcessExit({ onError, onExit, exitOnFatal: true }),
     ).not.toThrow();
 
     const testError = new Error('Test uncaught exception');
@@ -177,7 +177,7 @@ describe('exit-process tests', () => {
 
   it('should use custom fatalExitCode when exitOnFatal is true', () => {
     expect(() =>
-      installExitHandlers({
+      subscribeProcessExit({
         onError,
         onExit,
         exitOnFatal: true,
@@ -200,7 +200,7 @@ describe('exit-process tests', () => {
 
   it('should call onExit with fatal reason for unhandledRejection when exitOnFatal is true', () => {
     expect(() =>
-      installExitHandlers({ onError, onExit, exitOnFatal: true }),
+      subscribeProcessExit({ onError, onExit, exitOnFatal: true }),
     ).not.toThrow();
 
     const testReason = 'Test unhandled rejection';
@@ -244,7 +244,7 @@ describe('exit-process tests', () => {
 
   it('should call onExit only once even when close is called multiple times', () => {
     expect(() =>
-      installExitHandlers({ onExit, exitOnSignal: true }),
+      subscribeProcessExit({ onExit, exitOnSignal: true }),
     ).not.toThrow();
 
     (process as any).emit('SIGINT');

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

@@ -1,6 +1,6 @@
 import process from 'node:process';
 import { isEnvVarEnabled } from '../env.js';
-import { subscribeProcessExit } from '../exit-process';
+import { subscribeProcessExit } from '../exit-process.js';
 import type { TraceEvent } from '../trace-file.type';
 import {
   type ActionTrackConfigs,
@@ -232,17 +232,17 @@ export class Profiler<T extends ActionTrackConfigs> {
 
 // @TODO implement ShardedWAL
 type WalSink = {
-  append(event: TraceEvent): void;
-  open(): void;
-  close(): void;
-  isClosed(): boolean;
+  append: (event: TraceEvent) => void;
+  open: () => void;
+  close: () => void;
+  isClosed: () => boolean;
 };
 
 export type NodeJsProfilerOptions<T extends ActionTrackConfigs> =
   ProfilerOptions<T> & {
     // @TODO implement WALFormat
     format: {
-      encode(v: string | object): string;
+      encode: (v: string | object) => string;
     };
   };
 
@@ -275,7 +275,7 @@ export class NodeJsProfiler<T extends ActionTrackConfigs> extends Profiler<T> {
   protected subscribeProcessExit(): () => void {
     return subscribeProcessExit({
       onError: (err, kind) => {
-        if (!this.isRunning()) {
+        if (!super.isEnabled()) {
           return;
         }
         this.marker('Fatal Error', {
@@ -285,11 +285,11 @@ export class NodeJsProfiler<T extends ActionTrackConfigs> extends Profiler<T> {
         this.close();
       },
       onExit: (code, reason) => {
-        if (!this.isRunning()) {
+        if (!super.isEnabled()) {
           return;
         }
         this.marker('Process Exit', {
-          ...(code !== 0 ? { color: 'warning' } : {}),
+          ...(code === 0 ? {} : { color: 'warning' }),
           properties: [['reason', JSON.stringify(reason)]],
           tooltipText: `Process exited with code ${code}`,
         });
@@ -298,15 +298,6 @@ export class NodeJsProfiler<T extends ActionTrackConfigs> extends Profiler<T> {
     });
   }
 
-  isRunning(): boolean {
-    return this.isEnabled() && !this.sink?.isClosed();
-  }
-
-  override setEnabled(enabled: boolean): void {
-    super.setEnabled(enabled);
-    enabled ? this.sink?.open() : this.sink?.close();
-  }
-
   /**
    * Closes the profiler and releases all associated resources.
    * Profiling is finished forever for this instance.
@@ -315,16 +306,10 @@ export class NodeJsProfiler<T extends ActionTrackConfigs> extends Profiler<T> {
    * data is flushed and the WAL sink is properly closed.
    */
   close(): void {
-    if (!this.isEnabled()) return;
-    this.flush();
+    if (!this.isEnabled()) {
+      return;
+    }
     this.setEnabled(false);
     this.#exitHandlerSubscribscription?.();
   }
-
-  /**
-   * Forces all buffered Performance Entries to be written to the WAL sink.
-   */
-  flush(): void {
-    // @TODO implement WAL flush, currently all entries are buffered in memory
-  }
 }

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

@@ -428,6 +428,7 @@ describe('Profiler', () => {
     expect(workFn).toHaveBeenCalled();
   });
 });
+
 describe('NodeJsProfiler', () => {
   const mockSubscribeProcessExit = vi.mocked(subscribeProcessExit);
 
@@ -545,60 +546,16 @@ describe('NodeJsProfiler', () => {
       },
     ]);
   });
-  it('shutdown method shuts down profiler', () => {
-    profiler = createProfiler({ enabled: true });
-    const setEnabledSpy = vi.spyOn(profiler, 'setEnabled');
-    const sinkCloseSpy = vi.spyOn((profiler as any).sink, 'close');
-    expect(profiler.isEnabled()).toBe(true);
 
-    (profiler as any).shutdown();
-
-    expect(setEnabledSpy).toHaveBeenCalledTimes(1);
-    expect(setEnabledSpy).toHaveBeenCalledWith(false);
-    expect(sinkCloseSpy).toHaveBeenCalledTimes(1);
-    expect(profiler.isEnabled()).toBe(false);
-  });
   it('exit handler shuts down profiler', () => {
     profiler = createProfiler({ enabled: true });
-    const shutdownSpy = vi.spyOn(profiler, 'shutdown' as any);
+    const setEnabledSpy = vi.spyOn(profiler, 'setEnabled');
     expect(profiler.isEnabled()).toBe(true);
 
     capturedOnExit?.(0, { kind: 'exit' });
 
     expect(profiler.isEnabled()).toBe(false);
-    expect(shutdownSpy).toHaveBeenCalledTimes(1);
-  });
-
-  it('close method shuts down profiler', () => {
-    profiler = createProfiler({ enabled: true });
-    const shutdownSpy = vi.spyOn(profiler, 'shutdown' as any);
-    expect(profiler.isEnabled()).toBe(true);
-
-    profiler.close();
-
-    expect(shutdownSpy).toHaveBeenCalledTimes(1);
-    expect(profiler.isEnabled()).toBe(false);
-  });
-
-  it('error handler does nothing when profiler is disabled', () => {
-    profiler = createProfiler({ enabled: false }); // Start disabled
-    expect(profiler.isEnabled()).toBe(false);
-
-    const testError = new Error('Test error');
-    capturedOnError?.call(profiler, testError, 'uncaughtException');
-
-    // Should not create any marks when disabled
-    expect(performance.getEntriesByType('mark')).toHaveLength(0);
-  });
-
-  it('exit handler does nothing when profiler is disabled', () => {
-    profiler = createProfiler({ enabled: false }); // Start disabled
-    expect(profiler.isEnabled()).toBe(false);
-
-    // Should not call shutdown when disabled
-    const shutdownSpy = vi.spyOn(profiler, 'shutdown' as any);
-    capturedOnExit?.(0, { kind: 'exit' });
-
-    expect(shutdownSpy).not.toHaveBeenCalled();
+    expect(setEnabledSpy).toHaveBeenCalledTimes(1);
+    expect(setEnabledSpy).toHaveBeenCalledWith(false);
   });
 });