sdk-core: use core client as event emitter

Author: perf2711

packages/sdk-core/src/BacktraceCoreClient.ts

@@ -1,6 +1,6 @@
 import { CoreClientSetup } from './builder/CoreClientSetup.js';
 import { Events } from './common/Events.js';
-import { ReportEvents } from './events/ReportEvents.js';
+import { ClientEvents } from './events/ClientEvents.js';
 import {
     BacktraceAttachment,
     BacktraceAttributeProvider,
@@ -34,7 +34,9 @@ import { MetricsBuilder } from './modules/metrics/MetricsBuilder.js';
 import { SingleSessionProvider } from './modules/metrics/SingleSessionProvider.js';
 import { RateLimitWatcher } from './modules/rateLimiter/RateLimitWatcher.js';
 
-export abstract class BacktraceCoreClient<O extends BacktraceConfiguration = BacktraceConfiguration> {
+export abstract class BacktraceCoreClient<
+    O extends BacktraceConfiguration = BacktraceConfiguration,
+> extends Events<ClientEvents> {
     /**
      * Backtrace client instance
      */
@@ -112,7 +114,7 @@ export abstract class BacktraceCoreClient<O extends BacktraceConfiguration = Bac
     }
 
     protected readonly options: O;
-    protected readonly reportEvents: Events<ReportEvents>;
+
     protected readonly attributeManager: AttributeManager;
     protected readonly attachmentManager: AttachmentManager;
     protected readonly fileSystem?: FileSystem;
@@ -128,7 +130,7 @@ export abstract class BacktraceCoreClient<O extends BacktraceConfiguration = Bac
     private _enabled = false;
 
     protected constructor(setup: CoreClientSetup<O>) {
-        this.reportEvents = new Events();
+        super();
 
         this.options = setup.options;
         this.fileSystem = setup.fileSystem;
@@ -316,7 +318,7 @@ export abstract class BacktraceCoreClient<O extends BacktraceConfiguration = Bac
                   skipFrames: this.skipFrameOnMessage(data),
               });
 
-        this.reportEvents.emit('before-skip', report);
+        this.emit('before-skip', report);
 
         if (this.options.skipReport && this.options.skipReport(report)) {
             return Promise.resolve(BacktraceReportSubmissionResult.ReportSkipped());
@@ -329,12 +331,12 @@ export abstract class BacktraceCoreClient<O extends BacktraceConfiguration = Bac
 
         const submissionAttachments = this.generateSubmissionAttachments(report, reportAttachments);
 
-        this.reportEvents.emit('before-send', report, backtraceData, submissionAttachments);
+        this.emit('before-send', report, backtraceData, submissionAttachments);
 
         return this._reportSubmission
             .send(backtraceData, submissionAttachments, abortSignal)
             .then((submissionResult) => {
-                this.reportEvents.emit('after-send', report, backtraceData, submissionAttachments, submissionResult);
+                this.emit('after-send', report, backtraceData, submissionAttachments, submissionResult);
                 return submissionResult;
             });
     }
@@ -403,7 +405,6 @@ export abstract class BacktraceCoreClient<O extends BacktraceConfiguration = Bac
         return {
             client: this,
             options: this.options,
-            reportEvents: this.reportEvents,
             attributeManager: this.attributeManager,
             attachmentManager: this.attachmentManager,
             reportSubmission: this._reportSubmission,

packages/sdk-core/src/common/Events.ts

@@ -1,33 +1,31 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-interface EventCallback {
-    callback: (...args: any[]) => unknown;
+interface EventCallback<A extends any[] = any[]> {
+    callback: (...args: A) => unknown;
     once?: boolean;
 }
 
-export class Events<
-    E extends Record<string | number | symbol, (...args: any[]) => unknown> = Record<
-        string | number | symbol,
-        (...args: any[]) => unknown
-    >,
-> {
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export type EventMap = Record<string, any[]>;
+
+export class Events<E extends EventMap = EventMap> {
     private readonly _callbacks: Partial<Record<keyof E, EventCallback[]>> = {};
 
-    public on<N extends keyof E>(event: N, callback: E[N]): this {
+    public on<N extends keyof E>(event: N, callback: (...args: E[N]) => unknown): this {
         this.addCallback(event, { callback });
         return this;
     }
 
-    public once<N extends keyof E>(event: N, callback: E[N]): this {
+    public once<N extends keyof E>(event: N, callback: (...args: E[N]) => unknown): this {
         this.addCallback(event, { callback, once: true });
         return this;
     }
 
-    public off<N extends keyof E>(event: N, callback: E[N]): this {
+    public off<N extends keyof E>(event: N, callback: (...args: E[N]) => unknown): this {
         this.removeCallback(event, callback);
         return this;
     }
 
-    public emit<N extends keyof E>(event: N, ...args: Parameters<E[N]>): boolean {
+    public emit<N extends keyof E>(event: N, ...args: E[N]): boolean {
         const callbacks = this._callbacks[event];
         if (!callbacks || !callbacks.length) {
             return false;
@@ -48,7 +46,7 @@ export class Events<
         return true;
     }
 
-    private addCallback(event: keyof E, callback: EventCallback) {
+    private addCallback<A extends unknown[]>(event: keyof E, callback: EventCallback<A>) {
         const list = this._callbacks[event];
         if (list) {
             list.push(callback);
@@ -57,7 +55,7 @@ export class Events<
         }
     }
 
-    private removeCallback(event: keyof E, callback: EventCallback['callback']) {
+    private removeCallback<A extends unknown[]>(event: keyof E, callback: EventCallback<A>['callback']) {
         const list = this._callbacks[event];
         if (!list) {
             return;

packages/sdk-core/src/events/AttachmentEvents.ts

@@ -1,5 +1,5 @@
 import { BacktraceAttachment } from '../model/attachment/index.js';
 
 export type AttachmentEvents = {
-    'scoped-attachments-updated'(attachments: BacktraceAttachment[]): void;
+    'scoped-attachments-updated': [attachments: BacktraceAttachment[]];
 };

packages/sdk-core/src/events/AttributeEvents.ts

@@ -1,5 +1,5 @@
 import { ReportData } from '../model/report/ReportData.js';
 
 export type AttributeEvents = {
-    'scoped-attributes-updated'(attributes: ReportData): void;
+    'scoped-attributes-updated': [attributes: ReportData];
 };

packages/sdk-core/src/events/ReportEvents.ts renamed to packages/sdk-core/src/events/ClientEvents.ts

@@ -3,13 +3,13 @@ import { BacktraceData } from '../model/data/index.js';
 import { BacktraceReportSubmissionResult, BacktraceSubmissionResponse } from '../model/http/index.js';
 import { BacktraceReport } from '../model/report/BacktraceReport.js';
 
-export type ReportEvents = {
-    'before-skip'(report: BacktraceReport): void;
-    'before-send'(report: BacktraceReport, data: BacktraceData, attachments: BacktraceAttachment[]): void;
-    'after-send'(
+export type ClientEvents = {
+    'before-skip': [report: BacktraceReport];
+    'before-send': [report: BacktraceReport, data: BacktraceData, attachments: BacktraceAttachment[]];
+    'after-send': [
         report: BacktraceReport,
         data: BacktraceData,
         attachments: BacktraceAttachment[],
         result: BacktraceReportSubmissionResult<BacktraceSubmissionResponse>,
-    ): void;
+    ];
 };

packages/sdk-core/src/modules/BacktraceModule.ts

@@ -1,5 +1,3 @@
-import { Events } from '../common/Events.js';
-import { ReportEvents } from '../events/ReportEvents.js';
 import {
     BacktraceConfiguration,
     BacktraceCoreClient,
@@ -17,7 +15,6 @@ export interface BacktraceModuleBindData {
     readonly options: BacktraceConfiguration;
     readonly attributeManager: AttributeManager;
     readonly attachmentManager: AttachmentManager;
-    readonly reportEvents: Events<ReportEvents>;
     readonly reportSubmission: BacktraceReportSubmission;
     readonly requestHandler: BacktraceRequestHandler;
     readonly database?: BacktraceDatabase;

packages/sdk-core/src/modules/breadcrumbs/BreadcrumbsManager.ts

@@ -66,7 +66,7 @@ export class BreadcrumbsManager implements BacktraceBreadcrumbs, BacktraceModule
         }
     }
 
-    public bind({ client, reportEvents, attachmentManager }: BacktraceModuleBindData): void {
+    public bind({ client, attachmentManager }: BacktraceModuleBindData): void {
         if (this._storage.getAttachmentProviders) {
             attachmentManager.addProviders(...this._storage.getAttachmentProviders());
         } else {
@@ -77,7 +77,7 @@ export class BreadcrumbsManager implements BacktraceBreadcrumbs, BacktraceModule
             [BREADCRUMB_ATTRIBUTE_NAME]: this._storage.lastBreadcrumbId,
         }));
 
-        reportEvents.on('before-skip', (report) => this.logReport(report));
+        client.on('before-skip', (report) => this.logReport(report));
     }
 
     public initialize() {

packages/sdk-core/src/modules/database/BacktraceDatabase.ts

@@ -82,7 +82,7 @@ export class BacktraceDatabase implements BacktraceModule {
         return true;
     }
 
-    public bind({ reportEvents }: BacktraceModuleBindData): void {
+    public bind({ client }: BacktraceModuleBindData): void {
         if (this._enabled) {
             return;
         }
@@ -91,7 +91,7 @@ export class BacktraceDatabase implements BacktraceModule {
             return;
         }
 
-        reportEvents.on('before-send', (_, data, attachments) => {
+        client.on('before-send', (_, data, attachments) => {
             const record = this.add(data, attachments);
 
             if (!record || record.locked) {
@@ -101,7 +101,7 @@ export class BacktraceDatabase implements BacktraceModule {
             record.locked = true;
         });
 
-        reportEvents.on('after-send', (_, data, __, submissionResult) => {
+        client.on('after-send', (_, data, __, submissionResult) => {
             const record = this._databaseRecordContext.find(
                 (record) => record.type === 'report' && record.data.uuid === data.uuid,
             );

packages/sdk-core/src/modules/storage/SessionFiles.ts

@@ -11,7 +11,7 @@ interface FileSession {
 }
 
 type SessionEvents = {
-    unlocked(): void;
+    unlocked: [];
 };
 
 const SESSION_MARKER_PREFIX = 'bt-session';