fix(logs): unify HTTP logs and retry (#3503)

## Changes Fixes https://linear.app/nango/issue/NAN-2682/unify-http-logs - Unify HTTP logs and retry - Messages were inconsistent - Retry messages were displayed before the failed HTTP call - `type: http` was used for non-http logs - Proxy was not logging retries - Fix could not use warn and logToConsole - Fix typo in openapi spec ## 🧪 Tests - Run the dashboard - Make some proxy calls - Run some syncs with proxy calls **Sync with successful proxy** <img src="https://github.com/user-attachments/assets/d207b4a3-213e-447c-b9ca-3c2c68344bcb" width="500px" /> **Sync with failed proxy** <img src="https://github.com/user-attachments/assets/9d8c08e0-ac1f-4a3d-a82b-0b68e9222389" width="500px" /> **Failed proxy with retries** <img src="https://github.com/user-attachments/assets/247716be-3da3-462d-9feb-845783c14b44" width="500px" /> **Failed proxy no retries** <img src="https://github.com/user-attachments/assets/8586f71d-0e04-4446-b0cf-9083cd35cf9d" width="500px" /> **Successful proxy** <img src="https://github.com/user-attachments/assets/5e1e7470-6d03-4488-8994-820abef525ce" width="500px" />
NangoHQ · Feb 11, 2025 · 8b92740 · 8b92740
1 parent 5656023
commit 8b92740
Show file tree

Hide file tree

Showing 8 changed files with 142 additions and 161 deletions.
diff --git a/docs-v2/snippets/generated/salesforce-cdp/PreBuiltUseCases.mdx b/docs-v2/snippets/generated/salesforce-cdp/PreBuiltUseCases.mdx
@@ -2,4 +2,4 @@
 
 _No pre-built integration yet (time to contribute: &lt;48h)_
 
-<Tip>Not seeing the integration you need? [Build your own](https://docs.nango.dev/guides/custom-integration-builder/overview) independently.</Tip>
+<Tip>Not seeing the integration you need? [Build your own](https://docs.nango.dev/guides/custom-integrations/overview) independently.</Tip>
diff --git a/docs-v2/spec.yaml b/docs-v2/spec.yaml
@@ -1531,7 +1531,7 @@ paths:
                       type: string
                   description: The number of retries in case of failure (with exponential back-off). Optional, default 0.
                 - in: header
-                  name: Retry On
+                  name: Retry-On
                   schema:
                       type: string
                   description: Comma separated status codes to explicitly retry on in addition to the default 5xx and 429.

diff --git a/packages/logs/lib/client.ts b/packages/logs/lib/client.ts
@@ -1,8 +1,8 @@
 import type { MessageRow, MessageRowInsert, MessageMeta, OperationRow } from '@nangohq/types';
 import { setRunning, createMessage, setFailed, setCancelled, setTimeouted, setSuccess, update } from './models/messages.js';
 import { getFormattedMessage } from './models/helpers.js';
-import { errorToObject, metrics, stringifyError } from '@nangohq/utils';
-import { isCli, logger } from './utils.js';
+import { metrics, stringifyError } from '@nangohq/utils';
+import { errorToDocument, isCli, logger, logLevelToLogger } from './utils.js';
 import { envs } from './env.js';
 import { OtlpSpan } from './otlp/otlpSpan.js';
 
@@ -26,11 +26,15 @@ export class LogContextStateless {
     }
 
     async log(data: MessageRowInsert): Promise<boolean> {
+        if (data.error && data.error.constructor.name !== 'Object') {
+            data.error = errorToDocument(data.error);
+        }
+
         if (this.logToConsole) {
             const obj: Record<string, any> = {};
             if (data.error) obj['error'] = data.error;
             if (data.meta) obj['meta'] = data.meta;
-            logger[data.level!](`${this.dryRun ? '[dry] ' : ''}log: ${data.message}`, Object.keys(obj).length > 0 ? obj : undefined);
+            logger[logLevelToLogger[data.level!]](`${this.dryRun ? '[dry] ' : ''}log: ${data.message}`, Object.keys(obj).length > 0 ? obj : undefined);
         }
         if (this.dryRun) {
             return true;
@@ -63,34 +67,31 @@ export class LogContextStateless {
 
     async error(message: string, meta: (MessageMeta & { error?: unknown; err?: never; e?: never }) | null = null): Promise<boolean> {
         const { error, ...rest } = meta || {};
-        const err = error ? { name: 'Unknown Error', message: 'unknown error', ...errorToObject(error) } : null;
         return await this.log({
             type: 'log',
             level: 'error',
             message,
-            error: err
-                ? {
-                      name: error instanceof Error ? error.constructor.name : err.name,
-                      message: err.message,
-                      type: 'type' in err ? (err.type as string) : null,
-                      payload: 'payload' in err ? err.payload : null
-                  }
-                : null,
+            error: errorToDocument(error),
             meta: Object.keys(rest).length > 0 ? rest : null,
             source: 'internal'
         });
     }
 
     async http(
         message: string,
-        data: {
+        {
+            error,
+            ...data
+        }: {
             request: MessageRow['request'];
             response: MessageRow['response'];
+            error?: unknown;
             meta?: MessageRow['meta'];
+            level?: MessageRow['level'];
         }
     ): Promise<boolean> {
-        const level: MessageRow['level'] = data.response && data.response.code >= 400 ? 'error' : 'info';
-        return await this.log({ type: 'http', level, message, ...data, source: 'internal' });
+        const level: MessageRow['level'] = data.level ?? (data.response && data.response.code >= 400 ? 'error' : 'info');
+        return await this.log({ type: 'http', level, message, ...data, error: errorToDocument(error), source: 'internal' });
     }
 
     /**

diff --git a/packages/logs/lib/utils.ts b/packages/logs/lib/utils.ts
@@ -1,6 +1,7 @@
-import { getLogger } from '@nangohq/utils';
+import { errorToObject, getLogger } from '@nangohq/utils';
 import { createKVStore } from '@nangohq/kvstore';
 import type { KVStore } from '@nangohq/kvstore';
+import type { MessageRow } from '@nangohq/types';
 
 export const logger = getLogger('logs');
 
@@ -14,3 +15,27 @@ export async function getKVStore() {
 
     return kvstore;
 }
+
+export const logLevelToLogger = {
+    info: 'info',
+    debug: 'debug',
+    error: 'error',
+    warn: 'warning',
+    http: 'info',
+    verbose: 'debug',
+    silly: 'debug'
+} as const;
+
+export function errorToDocument(error?: unknown): MessageRow['error'] {
+    if (!error) {
+        return null;
+    }
+
+    const err = { name: 'Unknown Error', message: 'unknown error', ...errorToObject(error) };
+    return {
+        name: error instanceof Error ? error.constructor.name : err.name,
+        message: err.message,
+        type: 'type' in err ? (err.type as string) : null,
+        payload: 'payload' in err ? err.payload : null
+    };
+}
diff --git a/packages/server/lib/controllers/proxy.controller.ts b/packages/server/lib/controllers/proxy.controller.ts
@@ -243,7 +243,7 @@ class ProxyController {
         const valuesToFilter = Object.values(config.connection.credentials);
         const safeHeaders = redactHeaders({ headers: requestConfig.headers, valuesToFilter });
         const redactedURL = redactURL({ url: requestConfig.url!, valuesToFilter });
-        await logCtx.http(`${config.method} ${redactedURL} was successful`, {
+        await logCtx.http(`${config.method} ${redactedURL}`, {
             request: {
                 method: config.method,
                 url: redactedURL,
@@ -321,19 +321,7 @@ class ProxyController {
         });
     }
 
-    private async handleErrorResponse({
-        res,
-        e,
-        config,
-        requestConfig,
-        logCtx
-    }: {
-        res: Response;
-        e: unknown;
-        config: ApplicationConstructedProxyConfiguration;
-        requestConfig: AxiosRequestConfig;
-        logCtx: LogContext;
-    }) {
+    private async handleErrorResponse({ res, e, requestConfig, logCtx }: { res: Response; e: unknown; requestConfig: AxiosRequestConfig; logCtx: LogContext }) {
         const error = e as AxiosError;
 
         if (!error.response?.data && error.toJSON) {
@@ -345,8 +333,6 @@ class ProxyController {
                 status
             } = error.toJSON() as any;
 
-            await this.reportError({ error, config, requestConfig, errorContent: message, logCtx });
-
             const errorObject = { message, stack, code, status, url: requestConfig.url, method };
 
             const responseStatus = error.response?.status || 500;
@@ -388,11 +374,12 @@ class ProxyController {
                         // Intentionally left blank - errorData will be a string
                     }
                 }
-                void this.reportError({ error, config, requestConfig, errorContent: errorData, logCtx });
+                void logCtx.error('Failed with this body', { body: errorData });
             });
         } else {
-            await logCtx.error('Unknown error');
+            await logCtx.error('Unknown error', { error });
             await logCtx.failed();
+            res.status(500).send();
         }
     }
 
@@ -434,54 +421,27 @@ class ProxyController {
                 requestConfig.data = data;
             }
             const responseStream: AxiosResponse = await backOff(
-                () => {
-                    return axios(requestConfig);
+                async () => {
+                    try {
+                        return await axios(requestConfig);
+                    } catch (err) {
+                        const handling = proxyService.logErrorResponse({ error: err, requestConfig, config });
+                        logs.push(...handling.logs);
+                        throw err;
+                    }
                 },
                 { numOfAttempts: Number(config.retries), retry: proxyService.retry.bind(this, config, logs) }
             );
 
             await flushLogsBuffer(logs, logCtx);
-
             await this.handleResponse({ res, responseStream, config, requestConfig, logCtx });
         } catch (err) {
-            await this.handleErrorResponse({ res, e: err, requestConfig, config, logCtx });
+            await flushLogsBuffer(logs, logCtx);
+            await this.handleErrorResponse({ res, e: err, requestConfig, logCtx });
+            await logCtx.failed();
             metrics.increment(metrics.Types.PROXY_FAILURE);
         }
     }
-
-    private async reportError({
-        error,
-        config,
-        requestConfig,
-        errorContent,
-        logCtx
-    }: {
-        error: AxiosError;
-        config: ApplicationConstructedProxyConfiguration;
-        requestConfig: AxiosRequestConfig;
-        errorContent: string | Record<string, string>;
-        logCtx: LogContext;
-    }) {
-        const valuesToFilter = Object.values(config.connection.credentials);
-        const safeHeaders = redactHeaders({ headers: requestConfig.headers, valuesToFilter });
-        const redactedURL = redactURL({ url: requestConfig.url!, valuesToFilter });
-
-        await logCtx.http(`${requestConfig.method} ${redactedURL} failed with status '${error.response?.status}'`, {
-            meta: {
-                content: errorContent
-            },
-            request: {
-                method: config.method,
-                url: redactedURL,
-                headers: safeHeaders
-            },
-            response: {
-                code: error.response?.status || 500,
-                headers: error.response?.headers ? redactHeaders({ headers: error.response.headers as Record<string, string> }) : {}
-            }
-        });
-        await logCtx.failed();
-    }
 }
 
 /**
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		_No pre-built integration yet (time to contribute: <48h)_

		<Tip>Not seeing the integration you need? [Build your own](https://docs.nango.dev/guides/custom-integration-builder/overview) independently.</Tip>
		<Tip>Not seeing the integration you need? [Build your own](https://docs.nango.dev/guides/custom-integrations/overview) independently.</Tip>