fix(runner): always truncate errors

NangoHQ · Nov 26, 2024 · 05327a2 · 05327a2
1 parent 26a0bf9
commit 05327a2
Show file tree

Hide file tree

Showing 3 changed files with 123 additions and 5 deletions.
diff --git a/packages/runner/lib/exec.ts b/packages/runner/lib/exec.ts
@@ -9,7 +9,7 @@ import * as zod from 'zod';
 import * as soap from 'soap';
 import * as botbuilder from 'botbuilder';
 import tracer from 'dd-trace';
-import { errorToObject, metrics } from '@nangohq/utils';
+import { errorToObject, metrics, truncateJson } from '@nangohq/utils';
 import { logger } from './utils.js';
 import type { RunnerOutput } from '@nangohq/types';
 
@@ -154,7 +154,9 @@ export async function exec(
                     success: false,
                     error: {
                         type,
-                        payload: Array.isArray(payload) || (typeof payload !== 'object' && payload !== null) ? { message: payload } : payload || {}, // TODO: fix ActionError so payload is always an object
+                        payload: truncateJson(
+                            Array.isArray(payload) || (typeof payload !== 'object' && payload !== null) ? { message: payload } : payload || {}
+                        ), // TODO: fix ActionError so payload is always an object
                         status: 500
                     },
                     response: null
@@ -180,7 +182,7 @@ export async function exec(
                         success: false,
                         error: {
                             type: 'script_http_error',
-                            payload: typeof errorResponse === 'string' ? { message: errorResponse } : errorResponse,
+                            payload: truncateJson(typeof errorResponse === 'string' ? { message: errorResponse } : errorResponse),
                             status: error.response.status
                         },
                         response: null
@@ -204,7 +206,7 @@ export async function exec(
                     success: false,
                     error: {
                         type: 'script_internal_error',
-                        payload: { name: tmp.name || 'Error', code: tmp.code, message: tmp.message },
+                        payload: truncateJson({ name: tmp.name || 'Error', code: tmp.code, message: tmp.message }),
                         status: 500
                     },
                     response: null
@@ -216,7 +218,7 @@ export async function exec(
                     success: false,
                     error: {
                         type: 'script_internal_error',
-                        payload: { name: tmp.name || 'Error', code: tmp.code, message: tmp.message },
+                        payload: truncateJson({ name: tmp.name || 'Error', code: tmp.code, message: tmp.message }),
                         status: 500
                     },
                     response: null

diff --git a/packages/runner/lib/exec.unit.test.ts b/packages/runner/lib/exec.unit.test.ts
@@ -149,4 +149,116 @@ describe('Exec', () => {
         });
         expect(res.success).toEqual(false);
     });
+
+    it('should truncate a large error', async () => {
+        const nangoProps = getNangoProps();
+        const jsCode = `
+        fn = async (nango) => {
+            throw new nango.ActionError({
+                message: "A manual error",
+                reason: "a".repeat(1_000_000),
+            });
+        };
+        exports.default = fn
+        `;
+        const res = await exec(nangoProps, jsCode);
+
+        expect(res.error).toStrictEqual({
+            payload: {
+                message: 'A manual error'
+            },
+            status: 500,
+            type: 'action_script_runtime_error'
+        });
+        expect(res.success).toEqual(false);
+    });
+
+    it('should redac Authorization', async () => {
+        const nangoProps = getNangoProps();
+        const jsCode = `
+        fn = async (nango) => {
+            throw new nango.ActionError({
+                message: "A manual error",
+                Authorization: 'a very secret secret'
+            });
+        };
+        exports.default = fn
+        `;
+        const res = await exec(nangoProps, jsCode);
+
+        expect(res.error).toStrictEqual({
+            payload: {
+                message: 'A manual error',
+                Authorization: '[Redacted]'
+            },
+            status: 500,
+            type: 'action_script_runtime_error'
+        });
+        expect(res.success).toEqual(false);
+    });
+
+    it('should truncate caught AxiosError', async () => {
+        const nangoProps = getNangoProps();
+        const jsCode = `
+        fn = async (nango) => {
+            try {
+                await nango.getConnection();
+            } catch (err) {
+                throw new nango.ActionError({
+                    message: "A manual error",
+                    reason: err,
+                });
+            }
+        };
+        exports.default = fn
+        `;
+        const res = await exec(nangoProps, jsCode);
+
+        expect(res.error).toStrictEqual({
+            payload: {
+                message: 'A manual error',
+                reason: {
+                    code: expect.any(String),
+                    config: {
+                        adapter: ['xhr', 'http', 'fetch'],
+                        env: {},
+                        headers: {
+                            Accept: 'application/json, text/plain, */*',
+                            'Accept-Encoding': 'gzip, compress, deflate, br',
+                            Authorization: '[Redacted]',
+                            'Content-Type': 'application/json',
+                            'Nango-Is-Dry-Run': 'true',
+                            'Nango-Is-Sync': 'true',
+                            'User-Agent': 'nango-node-client/0.45.0 (darwin/23.2.0; node.js/20.12.2); sdk'
+                        },
+                        maxBodyLength: -1,
+                        maxContentLength: -1,
+                        method: 'get',
+                        params: {
+                            force_refresh: false,
+                            provider_config_key: 'provider-config-key',
+                            refresh_token: false
+                        },
+                        timeout: 0,
+                        transformRequest: [null],
+                        transformResponse: [null],
+                        transitional: {
+                            clarifyTimeoutError: false,
+                            forcedJSONParsing: true,
+                            silentJSONParsing: true
+                        },
+                        url: 'http://localhost:3003/connection/connection-id',
+                        xsrfCookieName: 'XSRF-TOKEN',
+                        xsrfHeaderName: 'X-XSRF-TOKEN'
+                    },
+                    message: '',
+                    name: 'AggregateError',
+                    status: null
+                }
+            },
+            status: 500,
+            type: 'action_script_runtime_error'
+        });
+        expect(res.success).toEqual(false);
+    });
 });
diff --git a/packages/utils/lib/json.ts b/packages/utils/lib/json.ts
@@ -15,6 +15,10 @@ export function stringifyObject(value: any): string {
             }
             if (key === 'Authorization') {
                 return '[Redacted]';
+            } else if (key === 'httpAgent' || key === 'httpsAgent') {
+                return undefined;
+            } else if (key === 'stack') {
+                return undefined;
             }
             return value;
         },