@coralogix/browser 2.6.0 → 2.7.0

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.7.0 (2025-05-05)
+
+🚀 Features
+Add Web Worker error handling.
+
 ## 2.6.0 (2025-05-04)
 
 ### 🚀 Features

package/README.md

@@ -839,6 +839,53 @@ You can also manually trigger memory usage data collection.
 CoralogixRum.measureUserAgentSpecificMemory();
 ```
 
+## Web Worker Support
+
+Web Worker support enables the capture of events originating from Web Workers, including unhandled errors, custom logs, and other functionalities provided by the SDK.
+
+> By default, Web Worker support is **disabled**.
+
+---
+
+### Enabling Web Worker Support
+
+```javascript
+CoralogixRum.init({
+  workerSupport: true,
+});
+```
+
+---
+
+#### Examples
+
+```javascript
+// App code – creating a worker. The SDK will automatically capture errors from it.
+
+const worker = new Worker('my-worker.js');
+```
+
+```javascript
+// Worker code
+
+// Log a basic info log
+worker.CoralogixRum.log(CoralogixLogSeverity.Info, 'Test log from worker');
+
+// Manually capture errors
+try {
+  // Some code that might throw an error
+} catch (error) {
+  worker.CoralogixRum.captureError(error, { worker: 'analytics-worker' }, { label1: 'value1' });
+}
+
+// Log messages received in the worker
+self.onmessage = (message) => {
+  worker.CoralogixRum.log(CoralogixLogSeverity.Info, message);
+};
+```
+
+---
+
 ## CDN
 
 Coralogix Browser SDK is also provided via CDN.<br>

package/index.esm2.js

@@ -381,6 +381,7 @@ var ErrorSource;
     ErrorSource["UNHANDLED_REJECTION"] = "unhandledrejection";
     ErrorSource["DOCUMENT"] = "document";
     ErrorSource["CAPTURED"] = "captured";
+    ErrorSource["WEB_WORKER"] = "web_worker";
 })(ErrorSource || (ErrorSource = {}));
 function buildStacktrace(span, err) {
     return __awaiter(this, void 0, void 0, function () {
@@ -1251,6 +1252,8 @@ var DOM_INSTRUMENTATION_NAME = 'dom';
 var DOM_INSTRUMENTATION_VERSION = '1.0.0';
 var CUSTOM_MEASUREMENT_INSTRUMENTATION_NAME = 'custom_measurement';
 var CUSTOM_MEASUREMENT_INSTRUMENTATION_VERSION = '1.0.0';
+var WORKER_INSTRUMENTATION = 'web_worker';
+var WORKER_INSTRUMENTATION_VERSION = '1.0.0';
 var XHR_INSTRUMENTATION_NAME = 'xhr';
 var FETCH_INSTRUMENTATION_NAME = 'fetch';
 var CUSTOM_INSTRUMENTATION_NAME = 'custom';
@@ -2429,6 +2432,76 @@ var CoralogixDOMInstrumentation = /** @class */ (function (_super) {
     return CoralogixDOMInstrumentation;
 }(InstrumentationBase));
 
+var ERROR_TYPES = {
+    RUNTIME: 'web-worker-runtime-error',
+    MESSAGE_ERROR: 'web-worker-messageerror',
+};
+var ERROR_MESSAGES = {
+    UNKNOWN_RUNTIME: 'Unknown worker runtime error',
+    DESERIALIZATION_FAILED: 'Failed to deserialize message from worker',
+};
+var WORKER_EVENTS = {
+    ERROR: 'error',
+    MESSAGE_ERROR: 'messageerror',
+};
+
+var CoralogixWorkerInstrumentation = /** @class */ (function (_super) {
+    __extends(CoralogixWorkerInstrumentation, _super);
+    function CoralogixWorkerInstrumentation(config, errorInstrumentation, coralogixRum) {
+        var _this = _super.call(this, WORKER_INSTRUMENTATION, WORKER_INSTRUMENTATION_VERSION, config) || this;
+        _this.errorInstrumentation = errorInstrumentation;
+        _this.coralogixRum = coralogixRum;
+        _this.init();
+        return _this;
+    }
+    CoralogixWorkerInstrumentation.prototype.disable = function () { };
+    CoralogixWorkerInstrumentation.prototype.enable = function () { };
+    CoralogixWorkerInstrumentation.prototype.init = function () {
+        var globalObj = CxGlobal;
+        var OriginalWorker = globalObj.Worker;
+        globalObj.Worker = this.createCxWorker(OriginalWorker);
+    };
+    CoralogixWorkerInstrumentation.prototype.createCxWorker = function (OriginalWorker) {
+        var self = this;
+        var CxWorker = /** @class */ (function (_super) {
+            __extends(CxWorker, _super);
+            function CxWorker(scriptURL, options) {
+                var _this = _super.call(this, scriptURL, options) || this;
+                _this.CoralogixRum = self.coralogixRum;
+                self.attachWorkerErrorHandlers(_this, scriptURL);
+                return _this;
+            }
+            return CxWorker;
+        }(OriginalWorker));
+        return CxWorker;
+    };
+    CoralogixWorkerInstrumentation.prototype.attachWorkerErrorHandlers = function (worker, scriptURL) {
+        var _this = this;
+        var source = scriptURL.toString();
+        worker.addEventListener(WORKER_EVENTS.ERROR, function (event) {
+            var message = event.message || ERROR_MESSAGES.UNKNOWN_RUNTIME;
+            _this.reportWorkerError(message, {
+                scriptURL: source,
+                filename: event.filename,
+                lineno: event.lineno,
+                colno: event.colno,
+                originalError: event.error || null,
+            }, { type: ERROR_TYPES.RUNTIME });
+        });
+        worker.addEventListener(WORKER_EVENTS.MESSAGE_ERROR, function (event) {
+            _this.reportWorkerError(ERROR_MESSAGES.DESERIALIZATION_FAILED, {
+                scriptURL: source,
+                event: event,
+            }, { type: ERROR_TYPES.MESSAGE_ERROR });
+        });
+    };
+    CoralogixWorkerInstrumentation.prototype.reportWorkerError = function (message, customData, labels) {
+        var _a;
+        (_a = this.errorInstrumentation) === null || _a === void 0 ? void 0 : _a.reportError(ErrorSource.WEB_WORKER, new Error(message), customData, labels);
+    };
+    return CoralogixWorkerInstrumentation;
+}(InstrumentationBase));
+
 var CORALOGIX_LOGS_URL_SUFFIX = '/browser/v1beta/logs';
 var CORALOGIX_RECORDING_URL_SUFFIX = '/sessionrecording';
 var MAX_EXPORT_BATCH_SIZE = 50;
@@ -2548,6 +2621,11 @@ var INSTRUMENTATIONS = [
         confKey: SCREENSHOT_INSTRUMENTATION_NAME,
         disable: false,
     },
+    {
+        Instrument: CoralogixWorkerInstrumentation,
+        confKey: WORKER_INSTRUMENTATION,
+        disable: false,
+    },
 ];
 var CoralogixAttributes = {
     USER_AGENT: 'user_agent',
@@ -4134,7 +4212,7 @@ function resolveUrlBlueprinters(urlBlueprinters) {
     return resolvedUrlBlueprinters;
 }
 
-var SDK_VERSION = '2.6.0';
+var SDK_VERSION = '2.7.0';
 
 function shouldDropEvent(cxRumEvent, options) {
     if (isDocumentErrorWithoutMessage(cxRumEvent)) {
@@ -4621,7 +4699,7 @@ function getTiming(duration) {
     return getNowTime() - getSessionManager().currentPageTimestamp;
 }
 
-if (supportedPerformanceTypes.has(PerformanceTypes.LongTask)) {
+if (supportedPerformanceTypes === null || supportedPerformanceTypes === void 0 ? void 0 : supportedPerformanceTypes.has(PerformanceTypes.LongTask)) {
     var ttiHandler_1 = (CxGlobal.__tti = {
         e: [],
     });
@@ -4650,6 +4728,7 @@ var CoralogixRum = {
     },
     init: function (options) {
         var _a, _b;
+        var _this = this;
         try {
             // Check if CoralogixRum already inited.
             if (isInited) {
@@ -4691,6 +4770,12 @@ var CoralogixRum = {
                 if (pluginConf) {
                     var instrumentation = void 0;
                     switch (confKey) {
+                        case WORKER_INSTRUMENTATION: {
+                            if (resolvedOptions_1.workerSupport) {
+                                instrumentation = new Instrument(pluginConf, errorsInstrumentation, _this);
+                            }
+                            break;
+                        }
                         case ERROR_INSTRUMENTATION_NAME: {
                             instrumentation = new Instrument(pluginConf);
                             errorsInstrumentation =

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coralogix/browser",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "Official Coralogix SDK for browsers",
   "license": "Apache-2.0",
   "author": "Coralogix",

package/src/constants.d.ts

@@ -12,6 +12,7 @@ import { CoralogixScreenshotInstrumentation } from './instrumentations/screensho
 import { CoralogixCustomMeasurementInstrumentation } from './instrumentations/custom-measurements';
 import { CoralogixInternalInstrumentation } from './instrumentations/CoralogixInternalInstrumentation';
 import { CoralogixDOMInstrumentation } from './instrumentations/CoralogixDOMInstrumentation';
+import { CoralogixWorkerInstrumentation } from './instrumentations/web-worker/CoralogixWorkerInstrumentation';
 export declare const CORALOGIX_LOGS_URL_SUFFIX = "/browser/v1beta/logs";
 export declare const CORALOGIX_RECORDING_URL_SUFFIX = "/sessionrecording";
 export declare const MAX_EXPORT_BATCH_SIZE = 50;
@@ -82,6 +83,10 @@ export declare const INSTRUMENTATIONS: readonly [{
     readonly Instrument: typeof CoralogixScreenshotInstrumentation;
     readonly confKey: "screenshot";
     readonly disable: false;
+}, {
+    readonly Instrument: typeof CoralogixWorkerInstrumentation;
+    readonly confKey: "web_worker";
+    readonly disable: false;
 }];
 export declare const CoralogixAttributes: {
     USER_AGENT: string;

package/src/coralogix-rum.d.ts

@@ -1,11 +1,15 @@
 import { CoralogixOtelWebType, CoralogixWindow, CxSpan } from './types';
 import { MemoryUsageContext } from './instrumentations/memory-usage';
 declare global {
+    interface Worker {
+        CoralogixRum: CoralogixOtelWebType;
+    }
     interface Object {
         __cx_global__: unknown;
     }
     interface Window extends CoralogixWindow {
         cachedLogs: CxSpan[];
+        Worker: typeof Worker;
     }
     interface Performance {
         measureUserAgentSpecificMemory(): Promise<MemoryUsageContext>;

package/src/instrumentations/CoralogixErrorInstrumentation.d.ts

@@ -12,7 +12,8 @@ export declare enum ErrorSource {
     WINDOW = "window",
     UNHANDLED_REJECTION = "unhandledrejection",
     DOCUMENT = "document",
-    CAPTURED = "captured"
+    CAPTURED = "captured",
+    WEB_WORKER = "web_worker"
 }
 interface CoralogixErrorInstrumentationConfig extends InstrumentationConfig {
     ignoreErrors?: Array<string | RegExp>;

package/src/instrumentations/instrumentation.consts.d.ts

@@ -9,6 +9,8 @@ export declare const DOM_INSTRUMENTATION_NAME = "dom";
 export declare const DOM_INSTRUMENTATION_VERSION = "1.0.0";
 export declare const CUSTOM_MEASUREMENT_INSTRUMENTATION_NAME = "custom_measurement";
 export declare const CUSTOM_MEASUREMENT_INSTRUMENTATION_VERSION = "1.0.0";
+export declare const WORKER_INSTRUMENTATION = "web_worker";
+export declare const WORKER_INSTRUMENTATION_VERSION = "1.0.0";
 export declare const XHR_INSTRUMENTATION_NAME = "xhr";
 export declare const FETCH_INSTRUMENTATION_NAME = "fetch";
 export declare const CUSTOM_INSTRUMENTATION_NAME = "custom";

package/src/instrumentations/web-worker/CoralogixWorkerInstrumentation.d.ts

@@ -0,0 +1,14 @@
+import { CoralogixOtelWebType } from '../../types';
+import { InstrumentationBase, InstrumentationConfig } from '@opentelemetry/instrumentation';
+import { CoralogixErrorInstrumentation } from '../CoralogixErrorInstrumentation';
+export declare class CoralogixWorkerInstrumentation extends InstrumentationBase {
+    private errorInstrumentation;
+    coralogixRum: CoralogixOtelWebType;
+    constructor(config: InstrumentationConfig, errorInstrumentation: CoralogixErrorInstrumentation | undefined, coralogixRum: CoralogixOtelWebType);
+    disable(): void;
+    enable(): void;
+    init(): void;
+    private createCxWorker;
+    private attachWorkerErrorHandlers;
+    private reportWorkerError;
+}

package/src/instrumentations/web-worker/web-worker.consts.d.ts

@@ -0,0 +1,12 @@
+export declare const ERROR_TYPES: {
+    RUNTIME: string;
+    MESSAGE_ERROR: string;
+};
+export declare const ERROR_MESSAGES: {
+    readonly UNKNOWN_RUNTIME: "Unknown worker runtime error";
+    readonly DESERIALIZATION_FAILED: "Failed to deserialize message from worker";
+};
+export declare const WORKER_EVENTS: {
+    readonly ERROR: "error";
+    readonly MESSAGE_ERROR: "messageerror";
+};

package/src/types.d.ts

@@ -198,6 +198,8 @@ export interface CoralogixBrowserSdkConfig {
     networkExtraConfig?: NetworkExtraConfig[];
     /** Enable MFE support. Defaults to false */
     supportMfe?: boolean;
+    /** Enable Web Worker support. Defaults to false */
+    workerSupport?: boolean;
 }
 export interface CoralogixOtelWebType extends SendLog {
     /**

package/src/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.6.0";
+export declare const SDK_VERSION = "2.7.0";