handle strings

Author: pkanal

plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts

@@ -51,8 +51,31 @@ export class WebExceptionInstrumentation extends InstrumentationBase<GlobalError
   init() {}
 
   onError = (event: ErrorEvent | PromiseRejectionEvent) => {
+    const EXCEPTION_EVENT_NAME = 'exception';
     const error: Error | undefined =
       'reason' in event ? event.reason : event.error;
+
+    const eventLogger = events.getEventLogger(
+      this.instrumentationName,
+      this.instrumentationVersion
+    );
+
+    if (typeof error === 'string') {
+      const customAttributes = this.applyCustomAttributes
+        ? this.applyCustomAttributes(error)
+        : {};
+
+      eventLogger.emit({
+        name: EXCEPTION_EVENT_NAME,
+        data: {
+          [ATTR_EXCEPTION_MESSAGE]: error,
+        },
+        attributes: customAttributes,
+        severityNumber: SeverityNumber.ERROR,
+        timestamp: hrTime(),
+      });
+    }
+
     if (error) {
       const message = error.message;
       const type = error.name;
@@ -62,17 +85,12 @@ export class WebExceptionInstrumentation extends InstrumentationBase<GlobalError
         [ATTR_EXCEPTION_STACKTRACE]: error.stack,
       };
 
-      const eventLogger = events.getEventLogger(
-        this.instrumentationName,
-        this.instrumentationVersion
-      );
-
       const customAttributes = this.applyCustomAttributes
         ? this.applyCustomAttributes(error)
         : {};
 
       eventLogger.emit({
-        name: 'exception',
+        name: EXCEPTION_EVENT_NAME,
         data: errorAttributes,
         attributes: customAttributes,
         severityNumber: SeverityNumber.ERROR,

plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts

@@ -66,13 +66,20 @@ describe('WebExceptionInstrumentation', () => {
       source?: string,
       lineno?: number,
       colno?: number,
-      error?: Error
+      error?: Error | string
     ) => {
-      if (error?.name !== 'ValidationError') {
+      console.log(error);
+      if (error instanceof Error && error.name !== 'ValidationError') {
         // If we are testing our instrumentation, we want to let the error propagate.
         // If it is any other kind of error, we want Mocha to handle the error as expected.
         mochaErrorHandler?.call(window, event, source, lineno, colno, error);
       }
+
+      if (typeof error === 'string' && error !== 'string') {
+        // If we are testing our instrumentation, we want to let the error propagate.
+        // If it is any other kind of error, we want Mocha to handle the error as expected.
+        mochaErrorHandler?.call(window, event, source, lineno, colno);
+      }
     };
   });
 
@@ -140,10 +147,27 @@ describe('WebExceptionInstrumentation', () => {
         assert.strictEqual(body[ATTR_EXCEPTION_STACKTRACE], stack);
       }, 0);
     });
+
+    it('should handle throwing an error as a string', async () => {
+      setTimeout(() => {
+        throw 'string';
+      });
+
+      setTimeout(() => {
+        const events = exporter.getFinishedLogRecords();
+        // assert.ok(events.length > 0, 'Expected at least one log record');
+        const event = events[0];
+        const body = event.body as Record<string, any>;
+        assert.strictEqual(body[ATTR_EXCEPTION_MESSAGE], 'string');
+      }, 0);
+    });
   });
 
   describe('adding custom attributes', () => {
-    const applyCustomAttrs = (error: Error) => {
+    const applyCustomAttrs = (error: Error | string) => {
+      if (typeof error === 'string') {
+        return { 'app.custom.exception': error.toLocaleUpperCase() };
+      }
       return {
         'app.custom.exception': error.message.toLocaleUpperCase(),
       };
@@ -178,5 +202,20 @@ describe('WebExceptionInstrumentation', () => {
         );
       }, 0);
     });
+
+    it('should add custom attributes if the error is a string', async () => {
+      setTimeout(() => {
+        throw 'string';
+      });
+
+      setTimeout(() => {
+        const events = exporter.getFinishedLogRecords();
+        assert.ok(events.length > 0, 'Expected at least one log record');
+        const event = events[0];
+        const body = event.body as Record<string, any>;
+        assert.strictEqual(body[ATTR_EXCEPTION_MESSAGE], 'string');
+        assert.strictEqual(event.attributes['app.custom.exception'], 'STRING');
+      }, 0);
+    });
   });
 });