Add debug IDs support to sdk-core, node and browser packages (#33)

perf2711 · web-flow · commit fec485f9776b · 2023-07-03T12:58:10.000+02:00
* sdk-core: add DebugIdProvider and DebugIdMapProvider

* sdk-core: add appending debugId to frames

* browser, node: use VariableDebugIdMapProvider

* sdk-core: change debugId to debug_identifier

* sdk-core: fix unit tests, add test for debug_identifier set

* sdk core: load debugIds on DebugIdProvider construction

---------

Co-authored-by: Sebastian Alex &lt;sebastian.alex@saucelabs.com&gt;
diff --git a/packages/browser/src/BacktraceClient.ts b/packages/browser/src/BacktraceClient.ts
@@ -3,10 +3,12 @@ import {
     BacktraceCoreClient,
     BacktraceRequestHandler,
     BacktraceStackTraceConverter,
+    DebugIdContainer,
+    VariableDebugIdMapProvider,
 } from '@backtrace/sdk-core';
-import { AGENT } from './agentDefinition';
 import { BacktraceBrowserSessionProvider } from './BacktraceBrowserSessionProvider';
 import { BacktraceConfiguration } from './BacktraceConfiguration';
+import { AGENT } from './agentDefinition';
 import { BacktraceClientBuilder } from './builder/BacktraceClientBuilder';
 
 export class BacktraceClient extends BacktraceCoreClient {
@@ -16,7 +18,15 @@ export class BacktraceClient extends BacktraceCoreClient {
         attributeProviders: BacktraceAttributeProvider[],
         stackTraceConverter: BacktraceStackTraceConverter,
     ) {
-        super(options, AGENT, handler, attributeProviders, stackTraceConverter, new BacktraceBrowserSessionProvider());
+        super(
+            options,
+            AGENT,
+            handler,
+            attributeProviders,
+            stackTraceConverter,
+            new BacktraceBrowserSessionProvider(),
+            new VariableDebugIdMapProvider(window as DebugIdContainer),
+        );
     }
 
     public static builder(options: BacktraceConfiguration): BacktraceClientBuilder {
diff --git a/packages/node/src/BacktraceClient.ts b/packages/node/src/BacktraceClient.ts
@@ -1,11 +1,13 @@
 import {
     BacktraceAttributeProvider,
-    BacktraceConfiguration as CoreConfiguration,
     BacktraceCoreClient,
     BacktraceRequestHandler,
+    BacktraceConfiguration as CoreConfiguration,
+    DebugIdContainer,
+    VariableDebugIdMapProvider,
 } from '@backtrace/sdk-core';
-import { AGENT } from './agentDefinition';
 import { BacktraceConfiguration } from './BacktraceConfiguration';
+import { AGENT } from './agentDefinition';
 import { BacktraceClientBuilder } from './builder/BacktraceClientBuilder';
 
 export class BacktraceClient extends BacktraceCoreClient {
@@ -14,7 +16,15 @@ export class BacktraceClient extends BacktraceCoreClient {
         handler: BacktraceRequestHandler,
         attributeProviders: BacktraceAttributeProvider[],
     ) {
-        super(options, AGENT, handler, attributeProviders);
+        super(
+            options,
+            AGENT,
+            handler,
+            attributeProviders,
+            undefined,
+            undefined,
+            new VariableDebugIdMapProvider(global as DebugIdContainer),
+        );
     }
 
     public static builder(options: BacktraceConfiguration): BacktraceClientBuilder {
diff --git a/packages/sdk-core/src/BacktraceCoreClient.ts b/packages/sdk-core/src/BacktraceCoreClient.ts
@@ -3,6 +3,8 @@ import {
     BacktraceAttributeProvider,
     BacktraceSessionProvider,
     BacktraceStackTraceConverter,
+    DebugIdMapProvider,
+    DebugIdProvider,
 } from '.';
 import { SdkOptions } from './builder/SdkOptions';
 import { BacktraceConfiguration } from './model/configuration/BacktraceConfiguration';
@@ -75,8 +77,14 @@ export abstract class BacktraceCoreClient {
         attributeProviders: BacktraceAttributeProvider[] = [],
         stackTraceConverter: BacktraceStackTraceConverter = new V8StackTraceConverter(),
         private readonly _sessionProvider: BacktraceSessionProvider = new SingleSessionProvider(),
+        debugIdMapProvider?: DebugIdMapProvider,
     ) {
-        this._dataBuilder = new BacktraceDataBuilder(this._sdkOptions, stackTraceConverter);
+        this._dataBuilder = new BacktraceDataBuilder(
+            this._sdkOptions,
+            stackTraceConverter,
+            new DebugIdProvider(stackTraceConverter, debugIdMapProvider),
+        );
+
         this._reportSubmission = new BacktraceReportSubmission(options, requestHandler);
         this._rateLimitWatcher = new RateLimitWatcher(options.rateLimit);
         this._attributeProvider = new AttributeManager([
diff --git a/packages/sdk-core/src/index.ts b/packages/sdk-core/src/index.ts
@@ -11,3 +11,4 @@ export * from './model/report/BacktraceReport';
 export * from './modules/attribute/BacktraceAttributeProvider';
 export * from './modules/converter';
 export * from './modules/metrics/BacktraceSessionProvider';
+export * from './sourcemaps/index';
diff --git a/packages/sdk-core/src/model/data/BacktraceStackTrace.ts b/packages/sdk-core/src/model/data/BacktraceStackTrace.ts
@@ -4,6 +4,7 @@ export interface BacktraceStackFrame {
     column?: number;
     sourceCode?: string;
     library: string;
+    debug_identifier?: string;
 }
 
 /**
diff --git a/packages/sdk-core/src/modules/data/BacktraceDataBuilder.ts b/packages/sdk-core/src/modules/data/BacktraceDataBuilder.ts
@@ -1,4 +1,4 @@
-import { BacktraceStackTraceConverter } from '../..';
+import { BacktraceStackTraceConverter, DebugIdProvider } from '../..';
 import { SdkOptions } from '../../builder/SdkOptions';
 import { IdGenerator } from '../../common/IdGenerator';
 import { TimeHelper } from '../../common/TimeHelper';
@@ -12,6 +12,7 @@ export class BacktraceDataBuilder {
     constructor(
         private readonly _sdkOptions: SdkOptions,
         private readonly _stackTraceConverter: BacktraceStackTraceConverter,
+        private readonly _debugIdProvider: DebugIdProvider,
     ) {}
 
     public build(
@@ -21,6 +22,12 @@ export class BacktraceDataBuilder {
     ): BacktraceData {
         const reportData = ReportDataBuilder.build(report.attributes);
 
+        const stackTrace = this._stackTraceConverter.convert(report.stackTrace, report.message);
+
+        for (const frame of stackTrace) {
+            frame.debug_identifier = this._debugIdProvider.getDebugId(frame.library);
+        }
+
         return {
             uuid: IdGenerator.uuid(),
             timestamp: TimeHelper.toTimestampInSec(report.timestamp),
@@ -34,7 +41,7 @@ export class BacktraceDataBuilder {
                 [this.MAIN_THREAD_NAME]: {
                     fault: true,
                     name: this.MAIN_THREAD_NAME,
-                    stack: this._stackTraceConverter.convert(report.stackTrace, report.message),
+                    stack: stackTrace,
                 },
             },
             annotations: {
diff --git a/packages/sdk-core/src/sourcemaps/DebugIdProvider.ts b/packages/sdk-core/src/sourcemaps/DebugIdProvider.ts
@@ -0,0 +1,41 @@
+import { BacktraceStackTraceConverter } from '../modules/converter';
+import { DebugIdMapProvider } from './interfaces/DebugIdMapProvider';
+
+export const SOURCE_DEBUG_ID_VARIABLE = '_btDebugIds';
+
+export class DebugIdProvider {
+    private readonly _fileDebugIds: Record<string, string>;
+
+    constructor(
+        private readonly _stackTraceConverter: BacktraceStackTraceConverter,
+        private readonly _debugIdMapProvider?: DebugIdMapProvider,
+    ) {
+        this._fileDebugIds = this.loadDebugIds();
+    }
+
+    public getDebugId(file: string): string | undefined {
+        return this._fileDebugIds[file];
+    }
+
+    private loadDebugIds() {
+        const debugIdMap = this._debugIdMapProvider?.getDebugIdMap();
+        if (!debugIdMap) {
+            return {};
+        }
+
+        const message = new Error().message;
+        const result: Record<string, string> = {};
+        for (const [rawStack, debugId] of Object.entries(debugIdMap)) {
+            const frames = this._stackTraceConverter.convert(rawStack, message);
+            if (!frames.length) {
+                continue;
+            }
+
+            // The first frame will have the file's path
+            const frame = frames[0];
+            result[frame.library] = debugId;
+        }
+
+        return result;
+    }
+}
diff --git a/packages/sdk-core/src/sourcemaps/VariableDebugIdMapProvider.ts b/packages/sdk-core/src/sourcemaps/VariableDebugIdMapProvider.ts
@@ -0,0 +1,14 @@
+import { SOURCE_DEBUG_ID_VARIABLE } from './DebugIdProvider';
+import { DebugIdMapProvider } from './interfaces/DebugIdMapProvider';
+
+export interface DebugIdContainer {
+    [SOURCE_DEBUG_ID_VARIABLE]?: Record<string, string>;
+}
+
+export class VariableDebugIdMapProvider implements DebugIdMapProvider {
+    constructor(private readonly _variable: DebugIdContainer) {}
+
+    public getDebugIdMap(): Record<string, string> {
+        return this._variable[SOURCE_DEBUG_ID_VARIABLE] ?? {};
+    }
+}
diff --git a/packages/sdk-core/src/sourcemaps/index.ts b/packages/sdk-core/src/sourcemaps/index.ts
@@ -0,0 +1,3 @@
+export * from './DebugIdProvider';
+export * from './VariableDebugIdMapProvider';
+export * from './interfaces/DebugIdMapProvider';
diff --git a/packages/sdk-core/src/sourcemaps/interfaces/DebugIdMapProvider.ts b/packages/sdk-core/src/sourcemaps/interfaces/DebugIdMapProvider.ts
@@ -0,0 +1,3 @@
+export interface DebugIdMapProvider {
+    getDebugIdMap(): Record<string, string>;
+}
diff --git a/packages/sdk-core/tests/report/dataGenerationTests.spec.ts b/packages/sdk-core/tests/report/dataGenerationTests.spec.ts
@@ -1,5 +1,6 @@
-import { BacktraceReport } from '../../src';
+import { BacktraceReport, DebugIdProvider } from '../../src';
 import { TimeHelper } from '../../src/common/TimeHelper';
+import { BacktraceStackFrame } from '../../src/model/data/BacktraceStackTrace';
 import { V8StackTraceConverter } from '../../src/modules/converter/V8StackTraceConverter';
 import { BacktraceDataBuilder } from '../../src/modules/data/BacktraceDataBuilder';
 
@@ -10,7 +11,11 @@ describe('Data generation tests', () => {
         langName: 'test',
         langVersion: 'test',
     };
-    const dataBuilder = new BacktraceDataBuilder(sdkOptions, new V8StackTraceConverter());
+    const dataBuilder = new BacktraceDataBuilder(
+        sdkOptions,
+        new V8StackTraceConverter(),
+        new DebugIdProvider(new V8StackTraceConverter()),
+    );
 
     it('Should set sdk options in the Backtrace data', () => {
         const backtraceData = dataBuilder.build(new BacktraceReport(new Error()));
@@ -66,4 +71,33 @@ describe('Data generation tests', () => {
         expect(backtraceData.attributes).toBeDefined();
         expect(backtraceData.attributes).toMatchObject(errorReport.attributes);
     });
+
+    it('Should append debug_identifier to each frame', () => {
+        const stackTraceConverter = new V8StackTraceConverter();
+        const debugIdProvider = new DebugIdProvider(stackTraceConverter);
+
+        const frames: BacktraceStackFrame[] = [
+            {
+                funcName: 'x',
+                library: 'x',
+            },
+            {
+                funcName: 'y',
+                library: 'y',
+            },
+        ];
+
+        const expected = 'DEBUG_ID';
+        const expectedFrames = frames.map((m) => ({ ...m, debug_identifier: expected }));
+
+        jest.spyOn(stackTraceConverter, 'convert').mockReturnValue(frames);
+        jest.spyOn(debugIdProvider, 'getDebugId').mockReturnValue(expected);
+
+        const dataBuilder = new BacktraceDataBuilder(sdkOptions, stackTraceConverter, debugIdProvider);
+
+        const errorReport = new BacktraceReport(new Error());
+        const backtraceData = dataBuilder.build(errorReport);
+
+        expect(backtraceData.threads[backtraceData.mainThread].stack).toEqual(expectedFrames);
+    });
 });

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ export interface BacktraceStackFrame {`
`4`	`4`	`column?: number;`
`5`	`5`	`sourceCode?: string;`
`6`	`6`	`library: string;`
	`7`	`+ debug_identifier?: string;`
`7`	`8`	`}`
`8`	`9`
`9`	`10`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export * from './DebugIdProvider';`
	`2`	`+export * from './VariableDebugIdMapProvider';`
	`3`	`+export * from './interfaces/DebugIdMapProvider';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export interface DebugIdMapProvider {`
	`2`	`+ getDebugIdMap(): Record<string, string>;`
	`3`	`+}`