Provide log line and stack trace on runtime worker errors. (#17)

Author: radovan-jorgic

README.md

@@ -2,6 +2,10 @@
 
 ## Release Notes
 
+### v1.1.4
+
+- Provide log line and stack trace on runtime worker errors.
+
 ### v1.1.3
 
 - Exported `axios` and `axiosClient` with exponential backoff retry mechanism for HTTP requests and omitting Authorization headers from Axios errors.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/ts-adaas",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Typescript library containing the ADaaS(AirDrop as a Service) control protocol.",
   "type": "commonjs",
   "main": "./dist/index.js",

src/common/control-protocol.ts

@@ -7,7 +7,7 @@ import {
   LoaderEvent,
 } from '../types/extraction';
 import { LoaderEventType } from '../types/loading';
-import { formatAxiosError } from '../logger/logger';
+import { serializeAxiosError } from '../logger/logger';
 
 export interface EmitInterface {
   event: AirdropEvent;
@@ -49,7 +49,7 @@ export const emit = async ({
       if (axios.isAxiosError(error)) {
         console.error(
           `Failed to emit event with event type ${eventType}.`,
-          formatAxiosError(error)
+          serializeAxiosError(error)
         );
       } else {
         // TODO: Stop it through UI or think about retrying this request. Implement exponential retry mechanism.

src/common/install-initial-domain-mapping.ts

@@ -2,7 +2,7 @@ import { axios, axiosClient } from '../http/axios-client';
 import { FunctionInput } from '@devrev/typescript-sdk/dist/snap-ins';
 
 import { InitialDomainMapping } from '../types/common';
-import { formatAxiosError } from '../logger/logger';
+import { serializeAxiosError } from '../logger/logger';
 
 export async function installInitialDomainMapping(
   event: FunctionInput,
@@ -71,7 +71,7 @@ export async function installInitialDomainMapping(
         if (axios.isAxiosError(error)) {
           console.error(
             'Error while creating recipe blueprint',
-            formatAxiosError(error)
+            serializeAxiosError(error)
           );
         } else {
           console.error('Error while creating recipe blueprint', error);
@@ -109,7 +109,7 @@ export async function installInitialDomainMapping(
       if (axios.isAxiosError(error)) {
         console.error(
           'Error while installing initial domain mapping',
-          formatAxiosError(error)
+          serializeAxiosError(error)
         );
       } else {
         console.error('Error while installing initial domain mapping', error);
@@ -118,7 +118,7 @@ export async function installInitialDomainMapping(
     }
   } catch (error) {
     if (axios.isAxiosError(error)) {
-      console.error('Error while fetching snap in', formatAxiosError(error));
+      console.error('Error while fetching snap in', serializeAxiosError(error));
     } else {
       console.error('Error while fetching snap in', error);
     }

src/index.ts

@@ -14,3 +14,4 @@ export { spawn } from './workers/spawn';
 export * from './types/workers';
 
 export { formatAxiosError } from './logger/logger';
+export { serializeAxiosError } from './logger/logger';

src/logger/logger.test.ts

@@ -1,5 +1,5 @@
 import { AxiosError } from 'axios';
-import { getPrintableState, formatAxiosError } from './logger';
+import { getPrintableState, serializeAxiosError } from './logger';
 
 it('getPrintableState should return printable state', () => {
   const state = {
@@ -33,7 +33,7 @@ it('getPrintableState should return printable state', () => {
   });
 });
 
-it('formatAxiosError should return formatted error', () => {
+it('serializeAxiosError should return formatted error', () => {
   const error = {
     response: {
       status: 500,
@@ -44,14 +44,21 @@ it('formatAxiosError should return formatted error', () => {
     },
   } as AxiosError;
 
-  const formattedError = formatAxiosError(error);
+  const formattedError = serializeAxiosError(error);
 
   expect(formattedError).toEqual({
-    status: 500,
-    data: 'Internal server error',
-    method: 'GET',
-    baseURL: undefined,
-    url: undefined,
-    payload: undefined,
+    config: {
+      method: 'GET',
+      params: undefined,
+      url: undefined,
+    },
+    isAxiosError: true,
+    isCorsOrNoNetworkError: false,
+    response: {
+      data: 'Internal server error',
+      headers: undefined,
+      status: 500,
+      statusText: undefined,
+    },
   });
 });

src/logger/logger.ts

@@ -9,7 +9,7 @@ import {
 } from './logger.interfaces';
 import { isMainThread, parentPort } from 'node:worker_threads';
 import { WorkerAdapterOptions, WorkerMessageSubject } from '../types/workers';
-import { AxiosError } from 'axios';
+import { AxiosError, RawAxiosResponseHeaders } from 'axios';
 import { getCircularReplacer } from '../common/helpers';
 
 export class Logger extends Console {
@@ -93,18 +93,43 @@ export function getPrintableState(state: Record<string, any>): PrintableState {
   // Process the state object directly since it's guaranteed to be an object
   return processValue(state) as PrintableState;
 }
-
+/**
+ * @deprecated
+ */
 export function formatAxiosError(error: AxiosError): object {
-  if (error.response) {
-    return {
-      status: error.response.status,
-      data: error.response.data,
-      method: error.config?.method,
-      baseURL: error.config?.baseURL,
-      url: error.config?.url,
-      payload: error.config?.data,
-    };
+  return serializeAxiosError(error);
+}
+
+export const serializeError = (error: unknown): Error => {
+  let serializedError = error;
+  try {
+    serializedError = JSON.parse(
+      JSON.stringify(error, Object.getOwnPropertyNames(error))
+    );
+  } catch (err) {
+    console.error('Failed to serialize error object for logger', err);
   }
+  return serializedError as Error;
+};
 
-  return error;
+export function serializeAxiosError(error: AxiosError) {
+  const response = error.response
+    ? {
+        data: error.response.data,
+        headers: error.response.headers as RawAxiosResponseHeaders,
+        status: error.response.status,
+        statusText: error.response.statusText,
+      }
+    : null;
+  const config = {
+    method: error.config?.method,
+    params: error.config?.params,
+    url: error.config?.url,
+  };
+  return {
+    config,
+    isAxiosError: true,
+    isCorsOrNoNetworkError: !error.response,
+    response,
+  };
 }

src/state/state.ts

@@ -2,7 +2,7 @@ import { axios, axiosClient } from '../http/axios-client';
 
 import { AirdropEvent, SyncMode } from '../types/extraction';
 import { STATELESS_EVENT_TYPES } from '../common/constants';
-import { formatAxiosError, getPrintableState } from '../logger/logger';
+import { serializeAxiosError, getPrintableState } from '../logger/logger';
 import { ErrorRecord } from '../types/common';
 
 import { AdapterState, SdkState, StateInterface } from './state.interfaces';
@@ -101,7 +101,7 @@ export class State<ConnectorState> {
       );
     } catch (error) {
       if (axios.isAxiosError(error)) {
-        console.error('Failed to update state.', formatAxiosError(error));
+        console.error('Failed to update state.', serializeAxiosError(error));
       } else {
         console.error('Failed to update state.', error);
       }

src/uploader/uploader.ts

@@ -18,7 +18,7 @@ import {
   StreamAttachmentsResponse,
   UploaderFactoryInterface,
 } from './uploader.interfaces';
-import { formatAxiosError } from '../logger/logger';
+import { serializeAxiosError } from '../logger/logger';
 
 export class Uploader {
   private event: AirdropEvent;
@@ -106,7 +106,7 @@ export class Uploader {
       if (axios.isAxiosError(error)) {
         console.error(
           'Error while preparing artifact.',
-          formatAxiosError(error)
+          serializeAxiosError(error)
         );
       } else {
         console.error('Error while preparing artifact.', error);
@@ -137,7 +137,7 @@ export class Uploader {
       if (axios.isAxiosError(error)) {
         console.error(
           'Error while uploading artifact.',
-          formatAxiosError(error)
+          serializeAxiosError(error)
         );
       } else {
         console.error('Error while uploading artifact.', error);
@@ -171,7 +171,7 @@ export class Uploader {
       if (axios.isAxiosError(error)) {
         console.error(
           'Error while streaming artifact.',
-          formatAxiosError(error)
+          serializeAxiosError(error)
         );
       } else {
         console.error('Error while streaming artifact.', error);
@@ -278,7 +278,7 @@ export class Uploader {
       if (axios.isAxiosError(error)) {
         console.error(
           'Error while downloading artifact from URL.',
-          formatAxiosError(error)
+          serializeAxiosError(error)
         );
       } else {
         console.error('Error while downloading artifact from URL.', error);
@@ -386,7 +386,7 @@ export class Uploader {
       if (axios.isAxiosError(error)) {
         console.error(
           'Error while fetching attachment from URL.',
-          formatAxiosError(error)
+          serializeAxiosError(error)
         );
       } else {
         console.error('Error while fetching attachment from URL.', error);

src/workers/create-worker.ts

@@ -1,7 +1,7 @@
 import { isMainThread, Worker } from 'node:worker_threads';
 
 import { WorkerData, WorkerEvent } from '../types/workers';
-import { Logger } from '../logger/logger';
+import { Logger, serializeError } from '../logger/logger';
 
 async function createWorker<ConnectorState>(
   workerData: WorkerData<ConnectorState>
@@ -19,7 +19,7 @@ async function createWorker<ConnectorState>(
       } as WorkerOptions);
 
       worker.on(WorkerEvent.WorkerError, (error) => {
-        logger.error('Worker error', error);
+        logger.error('Worker error', serializeError(error));
         reject();
       });
       worker.on(WorkerEvent.WorkerOnline, () => {