sdk-core, browser, react-native: fix abort event not being removed from signal (#265)

* session-replay: add prepublish script

* sdk-core: fix 'abort' event not being removed from signal

* react-native: dispose signal in ReactNativeRequestHandler

* browser: dispose signal in ReactNativeRequestHandler

---------

Co-authored-by: Sebastian Alex <[email protected]>

Author: perf2711

packages/browser/src/BacktraceBrowserRequestHandler.ts

@@ -44,13 +44,14 @@ export class BacktraceBrowserRequestHandler implements BacktraceRequestHandler {
     ): Promise<BacktraceReportSubmissionResult<T>> {
         const controller = new AbortController();
         const id = setTimeout(() => controller.abort(), this._timeout);
+        const signal = anySignal(abortSignal, controller.signal);
 
         try {
             const response = await fetch(submissionUrl, {
                 method: 'POST',
                 body: payload,
                 headers: typeof payload === 'string' ? this.JSON_HEADERS : this.MULTIPART_HEADERS,
-                signal: anySignal(abortSignal, controller.signal),
+                signal,
             });
 
             clearInterval(id);
@@ -84,6 +85,11 @@ export class BacktraceBrowserRequestHandler implements BacktraceRequestHandler {
             }
 
             return BacktraceReportSubmissionResult.OnUnknownError(err.message);
+        } finally {
+            // Check for backwards compatibility
+            if ('dispose' in signal && typeof signal.dispose === 'function') {
+                signal.dispose();
+            }
         }
     }
 

packages/react-native/src/ReactNativeRequestHandler.ts

@@ -45,12 +45,14 @@ export class ReactNativeRequestHandler implements BacktraceRequestHandler {
         const controller = new AbortController();
         const id = setTimeout(() => controller.abort(), this._timeout);
 
+        const signal = anySignal(abortSignal, controller.signal);
+
         try {
             const response = await fetch(submissionUrl, {
                 method: 'POST',
                 body: payload,
                 headers: typeof payload === 'string' ? this.JSON_HEADERS : this.MULTIPART_HEADERS,
-                signal: anySignal(abortSignal, controller.signal),
+                signal,
             });
 
             clearInterval(id);
@@ -84,6 +86,11 @@ export class ReactNativeRequestHandler implements BacktraceRequestHandler {
             }
 
             return BacktraceReportSubmissionResult.OnUnknownError(err.message);
+        } finally {
+            // Check for backwards compatibility
+            if ('dispose' in signal && typeof signal.dispose === 'function') {
+                signal.dispose();
+            }
         }
     }
 

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

@@ -202,12 +202,14 @@ export function createAbortController(): OriginalAbortController {
     }
 }
 
-export function anySignal(...signals: (OriginalAbortSignal | undefined)[]): OriginalAbortSignal {
-    const controller = createAbortController();
+interface DisposableAbortSignal extends OriginalAbortSignal {
+    dispose(): void;
+}
 
-    function onAbort() {
-        controller.abort();
+export function anySignal(...signals: (OriginalAbortSignal | undefined)[]): DisposableAbortSignal {
+    const controller = createAbortController();
 
+    function cleanup() {
         // Cleanup
         for (const signal of signals) {
             if (signal) {
@@ -216,6 +218,11 @@ export function anySignal(...signals: (OriginalAbortSignal | undefined)[]): Orig
         }
     }
 
+    function onAbort() {
+        controller.abort();
+        cleanup();
+    }
+
     for (const signal of signals) {
         if (!signal) {
             continue;
@@ -228,5 +235,6 @@ export function anySignal(...signals: (OriginalAbortSignal | undefined)[]): Orig
         signal.addEventListener('abort', onAbort);
     }
 
-    return controller.signal;
+    (controller.signal as DisposableAbortSignal).dispose = cleanup;
+    return controller.signal as DisposableAbortSignal;
 }

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

@@ -276,34 +276,38 @@ export class BacktraceDatabase implements BacktraceModule {
             const records = [...this._databaseRecordContext.getBucket(bucketIndex)];
             const signal = anySignal(abortSignal, this._abortController.signal);
 
-            for (const record of records) {
-                if (!this.enabled) {
-                    return;
-                }
-                if (record.locked) {
-                    continue;
-                }
-                try {
-                    record.locked = true;
-
-                    const result =
-                        record.type === 'report'
-                            ? await this._requestHandler.send(record.data, record.attachments, signal)
-                            : await this._requestHandler.sendAttachment(record.rxid, record.attachment, signal);
-
-                    if (
-                        result.status === 'Ok' ||
-                        result.status === 'Unsupported' ||
-                        result.status === 'Report skipped'
-                    ) {
-                        this.remove(record);
+            try {
+                for (const record of records) {
+                    if (!this.enabled) {
+                        return;
+                    }
+                    if (record.locked) {
                         continue;
                     }
-                    this._databaseRecordContext.increaseBucket(bucketIndex);
-                    return;
-                } finally {
-                    record.locked = false;
+                    try {
+                        record.locked = true;
+
+                        const result =
+                            record.type === 'report'
+                                ? await this._requestHandler.send(record.data, record.attachments, signal)
+                                : await this._requestHandler.sendAttachment(record.rxid, record.attachment, signal);
+
+                        if (
+                            result.status === 'Ok' ||
+                            result.status === 'Unsupported' ||
+                            result.status === 'Report skipped'
+                        ) {
+                            this.remove(record);
+                            continue;
+                        }
+                        this._databaseRecordContext.increaseBucket(bucketIndex);
+                        return;
+                    } finally {
+                        record.locked = false;
+                    }
                 }
+            } finally {
+                signal.dispose();
             }
         }
     }

packages/sdk-core/src/modules/metrics/MetricsSubmissionQueue.ts

@@ -42,7 +42,12 @@ export class MetricsSubmissionQueue<T extends MetricsEvent> implements MetricsQu
 
     public async send(abortSignal?: AbortSignal) {
         const eventsToProcess = this._events.splice(0);
-        return await this.submit(eventsToProcess, anySignal(abortSignal, this._abortController.signal));
+        const signal = anySignal(abortSignal, this._abortController.signal);
+        try {
+            return await this.submit(eventsToProcess, signal);
+        } finally {
+            signal.dispose();
+        }
     }
 
     public dispose() {

packages/session-replay/package.json

@@ -13,6 +13,7 @@
         "format": "prettier --write '**/*.ts'",
         "lint": "eslint . --ext .ts",
         "watch": "npm run build -- --watch",
+        "prepublishOnly": "cross-env NODE_ENV=production npm run clean && npm run build",
         "test": "cross-env NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" NODE_NO_WARNINGS=1 NODE_ENV=test jest"
     },
     "repository": {