fix(logs): remove support for number (NangoHQ#2523)

bodinsamuel · web-flow · commit 3c5607a2fae6 · 2024-07-19T15:02:33.000+02:00
## Describe your changes Fixes https://linear.app/nango/issue/NAN-1448/remove-number-from-activitylogid - Activity log id has been `string` for the last 2 months now
diff --git a/packages/cli/lib/services/__snapshots__/model.service.unit.test.ts.snap b/packages/cli/lib/services/__snapshots__/model.service.unit.test.ts.snap
@@ -233,7 +233,7 @@ export interface NangoProps {
     connectionId: string;
     environmentId: number;
     environmentName?: string;
-    activityLogId?: number | string | undefined;
+    activityLogId?: string | undefined;
     providerConfigKey: string;
     provider?: string;
     lastSyncDate?: Date;
@@ -266,7 +266,7 @@ export declare class NangoAction {
     protected nango: Nango;
     private attributes;
     protected persistApi: AxiosInstance;
-    activityLogId?: number | string | undefined;
+    activityLogId?: string | undefined;
     syncId?: string;
     nangoConnectionId?: number;
     environmentId: number;
diff --git a/packages/jobs/lib/integration.service.ts b/packages/jobs/lib/integration.service.ts
@@ -8,7 +8,7 @@ import { logContextGetter } from '@nangohq/logs';
 
 interface ScriptObject {
     runner: Runner;
-    activityLogId: number | undefined;
+    activityLogId: string | undefined;
     cancelled?: boolean;
 }
 
diff --git a/packages/node-client/lib/index.ts b/packages/node-client/lib/index.ts
@@ -57,7 +57,7 @@ export class Nango {
     providerConfigKey?: string;
     isSync = false;
     dryRun = false;
-    activityLogId?: number | string | undefined;
+    activityLogId?: string | undefined;
     userAgent: string;
     http: AxiosInstance;
 
diff --git a/packages/node-client/lib/types.ts b/packages/node-client/lib/types.ts
@@ -61,7 +61,7 @@ export interface NangoProps {
     providerConfigKey?: string;
     isSync?: boolean;
     dryRun?: boolean;
-    activityLogId?: number | string | undefined;
+    activityLogId?: string | undefined;
 }
 
 export interface CreateConnectionOAuth1 extends OAuth1Credentials {
diff --git a/packages/orchestrator/lib/clients/client.integration.test.ts b/packages/orchestrator/lib/clients/client.integration.test.ts
@@ -167,7 +167,7 @@ describe('OrchestratorClient', async () => {
                         provider_config_key: 'P',
                         environment_id: 456
                     },
-                    activityLogId: 789,
+                    activityLogId: '789',
                     input: { foo: 'bar' }
                 }
             });
@@ -204,7 +204,7 @@ describe('OrchestratorClient', async () => {
                             provider_config_key: 'P',
                             environment_id: 5678
                         },
-                        activityLogId: 9876,
+                        activityLogId: '9876',
                         input: { foo: 'bar' }
                     }
                 });
@@ -235,7 +235,7 @@ describe('OrchestratorClient', async () => {
                             provider_config_key: 'P',
                             environment_id: 5678
                         },
-                        activityLogId: 9876,
+                        activityLogId: '9876',
                         input: { foo: 'bar' }
                     }
                 });
@@ -272,7 +272,7 @@ describe('OrchestratorClient', async () => {
                             provider_config_key: 'P',
                             environment_id: 5678
                         },
-                        activityLogId: 9876,
+                        activityLogId: '9876',
                         input: { foo: 'bar' }
                     }
                 });
@@ -304,7 +304,7 @@ describe('OrchestratorClient', async () => {
                             provider_config_key: 'P',
                             environment_id: 5678
                         },
-                        activityLogId: 9876,
+                        activityLogId: '9876',
                         input: { foo: 'bar' }
                     }
                 });
@@ -334,7 +334,7 @@ describe('OrchestratorClient', async () => {
                         provider_config_key: 'P',
                         environment_id: 456
                     },
-                    activityLogId: 789,
+                    activityLogId: '789',
                     input: { foo: 'bar' }
                 }
             });
@@ -360,7 +360,7 @@ describe('OrchestratorClient', async () => {
                         provider_config_key: 'P',
                         environment_id: 456
                     },
-                    activityLogId: 789,
+                    activityLogId: '789',
                     input: { foo: 'bar' }
                 }
             });
@@ -378,7 +378,7 @@ describe('OrchestratorClient', async () => {
                         provider_config_key: 'P',
                         environment_id: 456
                     },
-                    activityLogId: 789,
+                    activityLogId: '789',
                     input: { foo: 'bar' }
                 }
             });
@@ -409,7 +409,7 @@ describe('OrchestratorClient', async () => {
                         provider_config_key: 'P',
                         environment_id: 456
                     },
-                    activityLogId: 789,
+                    activityLogId: '789',
                     input: { foo: 'bar' }
                 }
             });
@@ -428,7 +428,7 @@ describe('OrchestratorClient', async () => {
                         provider_config_key: 'P',
                         environment_id: 456
                     },
-                    activityLogId: 789,
+                    activityLogId: '789',
                     input: { foo: 'bar' }
                 }
             });
diff --git a/packages/orchestrator/lib/clients/processor.integration.test.ts b/packages/orchestrator/lib/clients/processor.integration.test.ts
@@ -124,7 +124,7 @@ async function immediateTask({ groupKey }: { groupKey: string }) {
         heartbeatTimeoutSecs: 30,
         payload: {
             type: 'action',
-            activityLogId: 1234,
+            activityLogId: '1234',
             actionName: 'Task',
             connection: {
                 id: 1234,
diff --git a/packages/orchestrator/lib/clients/types.ts b/packages/orchestrator/lib/clients/types.ts
@@ -27,7 +27,7 @@ interface ActionArgs {
         environment_id: number;
         connection_id: string;
     };
-    activityLogId: string | number;
+    activityLogId: string;
     input: JsonValue;
 }
 interface WebhookArgs {
@@ -39,7 +39,7 @@ interface WebhookArgs {
         provider_config_key: string;
         environment_id: number;
     };
-    activityLogId: string | number;
+    activityLogId: string;
     input: JsonValue;
 }
 
@@ -53,7 +53,7 @@ interface PostConnectionArgs {
     };
     version: string;
     fileLocation: string;
-    activityLogId: string | number;
+    activityLogId: string;
 }
 export type SchedulesReturn = Result<OrchestratorSchedule[]>;
 export type VoidReturn = Result<void, ClientError>;
diff --git a/packages/orchestrator/lib/clients/validate.ts b/packages/orchestrator/lib/clients/validate.ts
@@ -27,15 +27,15 @@ export const syncArgsSchema = z.object({
 export const actionArgsSchema = z.object({
     type: z.literal('action'),
     actionName: z.string().min(1),
-    activityLogId: z.union([z.number(), z.string()]),
+    activityLogId: z.string(),
     input: jsonSchema,
     ...commonSchemaArgsFields
 });
 export const webhookArgsSchema = z.object({
     type: z.literal('webhook'),
     webhookName: z.string().min(1),
     parentSyncName: z.string().min(1),
-    activityLogId: z.union([z.number(), z.string()]),
+    activityLogId: z.string(),
     input: jsonSchema,
     ...commonSchemaArgsFields
 });
@@ -44,7 +44,7 @@ export const postConnectionArgsSchema = z.object({
     postConnectionName: z.string().min(1),
     version: z.string().min(1),
     fileLocation: z.string().min(1),
-    activityLogId: z.union([z.number(), z.string()]),
+    activityLogId: z.string(),
     ...commonSchemaArgsFields
 });
 
diff --git a/packages/persist/lib/controllers/persist.controller.ts b/packages/persist/lib/controllers/persist.controller.ts
@@ -23,7 +23,7 @@ type RecordRequest = Request<
         records: Record<string, any>[];
         providerConfigKey: string;
         connectionId: string;
-        activityLogId: number | string;
+        activityLogId: string;
     },
     void
 >;
@@ -32,7 +32,7 @@ const MAX_LOG_CHAR = 10000;
 
 class PersistController {
     public async saveLog(
-        req: Request<{ environmentId: number }, void, { activityLogId: number | string; level: LegacyLogLevel; msg: string; timestamp?: number }, void>,
+        req: Request<{ environmentId: number }, void, { activityLogId: string; level: LegacyLogLevel; msg: string; timestamp?: number }, void>,
         res: Response,
         next: NextFunction
     ) {
@@ -168,7 +168,7 @@ class PersistController {
         syncJobId: number;
         model: string;
         records: Record<string, any>[];
-        activityLogId: number | string;
+        activityLogId: string;
         softDelete: boolean;
         persistFunction: (records: FormattedRecord[]) => Promise<Result<UpsertSummary>>;
     }): Promise<Result<void>> {
diff --git a/packages/persist/lib/server.ts b/packages/persist/lib/server.ts
@@ -32,7 +32,7 @@ server.post(
         }),
         body: z
             .object({
-                activityLogId: z.union([z.number(), z.string()]),
+                activityLogId: z.string(),
                 level: z.enum(['info', 'debug', 'error', 'warn', 'http', 'verbose', 'silly']),
                 msg: z.string(),
                 timestamp: z.number().optional() // Optional until fully deployed
@@ -54,7 +54,7 @@ const validateRecordsRequest = validateRequest({
         records: z.array(z.object({ id: z.union([z.string().max(255).min(1), z.number()]) })).nonempty(),
         providerConfigKey: z.string(),
         connectionId: z.string(),
-        activityLogId: z.union([z.number(), z.string()])
+        activityLogId: z.string()
     })
 });
 const recordPath = '/environment/:environmentId/connection/:nangoConnectionId/sync/:syncId/job/:syncJobId/records';
diff --git a/packages/runner/lib/client.unit.test.ts b/packages/runner/lib/client.unit.test.ts
@@ -12,7 +12,7 @@ describe('Runner client', () => {
         connectionId: 'connection-id',
         environmentId: 1,
         providerConfigKey: 'provider-config-key',
-        activityLogId: 1,
+        activityLogId: '1',
         secretKey: 'secret-key',
         nangoConnectionId: 1,
         syncId: 'sync-id',
diff --git a/packages/runner/lib/exec.unit.test.ts b/packages/runner/lib/exec.unit.test.ts
@@ -9,7 +9,7 @@ describe('Exec', () => {
             connectionId: 'connection-id',
             environmentId: 1,
             providerConfigKey: 'provider-config-key',
-            activityLogId: 1,
+            activityLogId: '1',
             secretKey: 'secret-key',
             nangoConnectionId: 1,
             syncId: 'sync-id',
diff --git a/packages/server/lib/controllers/proxy.controller.ts b/packages/server/lib/controllers/proxy.controller.ts
@@ -43,7 +43,7 @@ class ProxyController {
             const isSync = (req.get('Nango-Is-Sync') as string) === 'true';
             const isDryRun = (req.get('Nango-Is-Dry-Run') as string) === 'true';
             const retryOn = req.get('Retry-On') ? (req.get('Retry-On') as string).split(',').map(Number) : null;
-            const existingActivityLogId = req.get('Nango-Activity-Log-Id') as number | string;
+            const existingActivityLogId = req.get('Nango-Activity-Log-Id') as string;
 
             if (!isSync) {
                 metrics.increment(metrics.Types.PROXY, 1, { accountId: account.id });
diff --git a/packages/shared/lib/models/Proxy.ts b/packages/shared/lib/models/Proxy.ts
@@ -39,7 +39,7 @@ export type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text'
 export interface InternalProxyConfiguration {
     provider: string;
     connection: Connection;
-    existingActivityLogId?: number | string | null;
+    existingActivityLogId?: string | null;
 }
 
 export interface RetryHeaderConfig {
diff --git a/packages/shared/lib/models/Sync.ts b/packages/shared/lib/models/Sync.ts
@@ -157,7 +157,7 @@ export interface RunScriptOptions {
     syncConfig?: SyncConfig;
     syncName: string;
     syncId: string;
-    activityLogId?: number | undefined;
+    activityLogId?: string | undefined;
     nangoProps: NangoProps;
     writeToDb: boolean;
     isInvokedImmediately: boolean;
diff --git a/packages/shared/lib/models/index.ts b/packages/shared/lib/models/index.ts
@@ -9,4 +9,3 @@ export * from './Flow.js';
 export * from './NangoConfig.js';
 export * from './Proxy.js';
 export * from './Runner.js';
-export * from './worker.js';
diff --git a/packages/shared/lib/models/worker.ts b/packages/shared/lib/models/worker.ts
diff --git a/packages/shared/lib/sdk/sync.ts b/packages/shared/lib/sdk/sync.ts
@@ -295,7 +295,7 @@ export interface NangoProps {
     connectionId: string;
     environmentId: number;
     environmentName?: string;
-    activityLogId?: number | string | undefined;
+    activityLogId?: string | undefined;
     providerConfigKey: string;
     provider?: string;
     lastSyncDate?: Date;
@@ -335,7 +335,7 @@ export class NangoAction {
     protected nango: Nango;
     private attributes = {};
     protected persistApi: AxiosInstance;
-    activityLogId?: number | string | undefined;
+    activityLogId?: string | undefined;
     syncId?: string;
     nangoConnectionId?: number;
     environmentId: number;
diff --git a/packages/shared/lib/services/sync/run.service.ts b/packages/shared/lib/services/sync/run.service.ts
@@ -75,7 +75,7 @@ export type SyncRunConfig = {
 } & (
     | {
           writeToDb: true;
-          activityLogId: string | number;
+          activityLogId: string;
           logCtx: LogContext;
           slackService: SlackService;
           sendSyncWebhook: (params: SendSyncParams) => Promise<void>;
@@ -115,7 +115,7 @@ export class SyncRunService {
 
     syncId?: string;
     syncJobId?: number;
-    activityLogId?: string | number;
+    activityLogId?: string;
     provider?: string;
     loadLocation?: string;
     debug?: boolean;
@@ -328,7 +328,7 @@ export class SyncRunService {
                 syncId:
                     (this.syncId as string) ||
                     `${syncName}-${this.nangoConnection.environment_id}-${this.nangoConnection.provider_config_key}-${this.nangoConnection.connection_id}`,
-                activityLogId: this.activityLogId as unknown as number,
+                activityLogId: this.activityLogId as unknown as string,
                 nangoProps,
                 writeToDb: this.writeToDb,
                 isInvokedImmediately: this.isInvokedImmediately,

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import { logContextGetter } from '@nangohq/logs';`
`8`	`8`
`9`	`9`	`interface ScriptObject {`
`10`	`10`	`runner: Runner;`
`11`		`- activityLogId: number \| undefined;`
	`11`	`+ activityLogId: string \| undefined;`
`12`	`12`	`cancelled?: boolean;`
`13`	`13`	`}`
`14`	`14`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ export interface NangoProps {`
`61`	`61`	`providerConfigKey?: string;`
`62`	`62`	`isSync?: boolean;`
`63`	`63`	`dryRun?: boolean;`
`64`		`- activityLogId?: number \| string \| undefined;`
	`64`	`+ activityLogId?: string \| undefined;`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`export interface CreateConnectionOAuth1 extends OAuth1Credentials {`