refactor: make CollectorExporterError a subclass of Error

open-telemetry · Sep 16, 2020 · 2673088 · 2673088
1 parent e2e66f6
commit 2673088
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 28 deletions.
diff --git a/packages/opentelemetry-exporter-collector-proto/src/util.ts b/packages/opentelemetry-exporter-collector-proto/src/util.ts
@@ -80,8 +80,6 @@ export function send<ExportItem, ServiceRequest>(
       );
     }
   } else {
-    onError({
-      message: 'No proto',
-    });
+    onError(new collectorTypes.CollectorExporterError('No proto'));
   }
 }
diff --git a/packages/opentelemetry-exporter-collector-proto/test/CollectorTraceExporter.test.ts b/packages/opentelemetry-exporter-collector-proto/test/CollectorTraceExporter.test.ts
@@ -161,9 +161,9 @@ describe('CollectorTraceExporter - node with proto over http', () => {
         const callback = args[1];
         callback(mockResError);
         setTimeout(() => {
-          const response: any = spyLoggerError.args[0][0];
+          const response = spyLoggerError.args[0][0] as string;
 
-          assert.strictEqual(response, 'code: 400');
+          assert.ok(response.includes('code: 400'));
           assert.strictEqual(responseSpy.args[0][0], 1);
           done();
         });

diff --git a/packages/opentelemetry-exporter-collector/src/platform/browser/util.ts b/packages/opentelemetry-exporter-collector/src/platform/browser/util.ts
@@ -34,7 +34,9 @@ export function sendWithBeacon(
     logger.debug('sendBeacon - can send', body);
     onSuccess();
   } else {
-    const error = { message: 'sendBeacon - cannot send', body };
+    const error = new collectorTypes.CollectorExporterError(
+      `sendBeacon - cannot send ${body}`
+    );
     globalErrorHandler(error);
     onError(error);
   }
@@ -71,12 +73,11 @@ export function sendWithXhr(
         logger.debug('xhr success', body);
         onSuccess();
       } else {
-        const error = {
-          body,
-          xhrData: xhr,
-          code: xhr.status,
-          message: xhr.responseText,
-        };
+        const error = new collectorTypes.CollectorExporterError(
+          xhr.responseText,
+          xhr.status
+        );
+
         globalErrorHandler(error);
         onError(error);
       }

diff --git a/packages/opentelemetry-exporter-collector/src/platform/node/util.ts b/packages/opentelemetry-exporter-collector/src/platform/node/util.ts
@@ -55,10 +55,10 @@ export function sendWithHttp<ExportItem, ServiceRequest>(
       collector.logger.debug(`statusCode: ${res.statusCode}`);
       onSuccess();
     } else {
-      const error = {
-        code: res.statusCode,
-        message: res.statusMessage || '',
-      };
+      const error = new collectorTypes.CollectorExporterError(
+        res.statusMessage,
+        res.statusCode
+      );
       globalErrorHandler(error);
       onError(error);
     }

diff --git a/packages/opentelemetry-exporter-collector/src/types.ts b/packages/opentelemetry-exporter-collector/src/types.ts
@@ -269,16 +269,21 @@ export namespace opentelemetryProto {
 /**
  * Interface for handling error
  */
-export interface CollectorExporterError {
-  code?: number;
-  message: string;
-  stack?: string;
+export class CollectorExporterError extends Error {
+  readonly code?: number;
+  readonly name: string = 'CollectorExporterError';
+
+  constructor(message?: string, code?: number) {
+    super(message);
+    this.code = code;
+  }
 }
 
 /**
  * Interface for handling export service errors
  */
 export interface ExportServiceError {
+  name: string;
   code: number;
   details: string;
   metadata: { [key: string]: unknown };

diff --git a/packages/opentelemetry-exporter-collector/test/browser/CollectorMetricExporter.test.ts b/packages/opentelemetry-exporter-collector/test/browser/CollectorMetricExporter.test.ts
@@ -332,8 +332,6 @@ describe('CollectorMetricExporter - web', () => {
           request.respond(400);
 
           const response = spyLoggerError.args[0][0] as string;
-          assert.ok(response.includes('body: '));
-          assert.ok(response.includes('xhrData: '));
           assert.ok(response.includes('code: 400'));
 
           assert.strictEqual(spyBeacon.callCount, 0);

diff --git a/packages/opentelemetry-exporter-collector/test/browser/CollectorTraceExporter.test.ts b/packages/opentelemetry-exporter-collector/test/browser/CollectorTraceExporter.test.ts
@@ -253,8 +253,6 @@ describe('CollectorTraceExporter - web', () => {
 
           const response = spyLoggerError.args[0][0] as string;
 
-          assert.ok(response.includes('body: '));
-          assert.ok(response.includes('xhrData: '));
           assert.ok(response.includes('code: 400'));
 
           assert.strictEqual(spyBeacon.callCount, 0);

diff --git a/packages/opentelemetry-exporter-collector/test/node/CollectorMetricExporter.test.ts b/packages/opentelemetry-exporter-collector/test/node/CollectorMetricExporter.test.ts
@@ -220,9 +220,9 @@ describe('CollectorMetricExporter - node with json over http', () => {
         const callback = args[1];
         callback(mockResError);
         setTimeout(() => {
-          const response: any = spyLoggerError.args[0][0];
-          assert.strictEqual(response, 'code: 400');
+          const response = spyLoggerError.args[0][0] as string;
 
+          assert.ok(response.includes('code: 400'));
           assert.strictEqual(responseSpy.args[0][0], 1);
           done();
         });

diff --git a/packages/opentelemetry-exporter-collector/test/node/CollectorTraceExporter.test.ts b/packages/opentelemetry-exporter-collector/test/node/CollectorTraceExporter.test.ts
@@ -175,9 +175,9 @@ describe('CollectorTraceExporter - node with json over http', () => {
         const callback = args[1];
         callback(mockResError);
         setTimeout(() => {
-          const response: any = spyLoggerError.args[0][0];
+          const response = spyLoggerError.args[0][0] as string;
 
-          assert.strictEqual(response, 'code: 400');
+          assert.ok(response.includes('code: 400'));
           assert.strictEqual(responseSpy.args[0][0], 1);
           done();
         });