hook up new options to CLI

Author: josephjclark

packages/ws-worker/src/server.ts

@@ -56,6 +56,9 @@ export type ServerOptions = {
   collectionsVersion?: string;
   collectionsUrl?: string;
   monorepoDir?: string;
+
+  timeoutRetryCount?: number;
+  timeoutRetryDelayMs?: number;
 };
 
 // this is the server/koa API
@@ -301,6 +304,9 @@ function createServer(engine: RuntimeEngine, options: ServerOptions = {}) {
         if (!('payloadLimitMb' in options)) {
           options.payloadLimitMb = app.options.payloadLimitMb;
         }
+        options.timeoutRetryCount = app.options.timeoutRetryCount;
+        options.timeoutRetryDelay =
+          app.options.timeoutRetryDelayMs ?? app.options.socketTimeoutSeconds;
 
         // Callback to be triggered when the work is done (including errors)
         const onFinish = () => {

packages/ws-worker/src/start.ts

@@ -49,6 +49,8 @@ function engineReady(engine: any) {
     claimTimeoutSeconds: args.claimTimeoutSeconds,
     // deprecated!
     socketTimeoutSeconds: args.socketTimeoutSeconds,
+    timeoutRetryCount: args.timeoutRetryCount,
+    timeoutRetryDelayMs: args.timeoutRetryDelayMs,
   };
 
   if ('socketTimeoutSeconds' in args) {

packages/ws-worker/src/util/cli.ts

@@ -12,17 +12,19 @@ const DEFAULT_WORKER_CAPACITY = 5;
 type Args = {
   _: string[];
   backoff: string;
-  debug?: boolean;
   capacity?: number;
+  claimTimeoutSeconds?: number;
   collectionsUrl?: string;
   collectionsVersion?: string;
-  engineValidationTimeoutMs?: number;
+  debug?: boolean;
   engineValidationRetries?: number;
+  engineValidationTimeoutMs?: number;
   lightning?: string;
   lightningPublicKey?: string;
   log?: LogLevel;
   loop?: boolean;
   maxRunDurationSeconds: number;
+  messageTimeoutSeconds?: number;
   mock?: boolean;
   monorepoDir?: string;
   payloadMemory?: number;
@@ -32,12 +34,12 @@ type Args = {
   repoDir?: string;
   runMemory?: number;
   secret?: string;
-  socketTimeoutSeconds?: number; // deprecated
-  messageTimeoutSeconds?: number;
-  claimTimeoutSeconds?: number;
-  statePropsToRemove?: string[];
   sentryDsn?: string;
   sentryEnv?: string;
+  socketTimeoutSeconds?: number; // deprecated
+  statePropsToRemove?: string[];
+  timeoutRetryCount?: number;
+  timeoutRetryDelayMs?: number;
 };
 
 type ArgTypes = string | string[] | number | boolean | undefined;
@@ -82,14 +84,16 @@ export default function parseArgs(argv: string[]): Args {
     WORKER_MAX_RUN_MEMORY_MB,
     WORKER_MESSAGE_TIMEOUT_SECONDS,
     WORKER_PORT,
-    WORKER_PROFILE,
     WORKER_PROFILE_POLL_INTERVAL_MS,
+    WORKER_PROFILE,
     WORKER_REPO_DIR,
     WORKER_SECRET,
     WORKER_SENTRY_DSN,
     WORKER_SENTRY_ENV,
     WORKER_SOCKET_TIMEOUT_SECONDS,
     WORKER_STATE_PROPS_TO_REMOVE,
+    WORKER_TIMEOUT_RETRY_COUNT,
+    WORKER_TIMEOUT_RETRY_DELAY_MS,
     WORKER_VALIDATION_RETRIES,
     WORKER_VALIDATION_TIMEOUT_MS,
   } = process.env;
@@ -219,6 +223,16 @@ export default function parseArgs(argv: string[]): Args {
       description:
         'Interval for polling profile data, in milliseconds. Default 10. Env: WORKER_PROFILE_POLL_INTERVAL_MS',
       type: 'number',
+    })
+    .option('timeout-retry-count', {
+      description:
+        'When a websocket event receives a timeout, this option sets how many times the worker should retry it. Default 10. Env: WORKER_TIMEOUT_RETRY_COUNT',
+      type: 'number',
+    })
+    .option('timeout-retry-delay', {
+      description:
+        'When a websocket event receives a timeout, this option sets how log to wait before retrying Default 30000. Env: WORKER_TIMEOUT_RETRY_DELAY_MS',
+      type: 'number',
     });
 
   const args = parser.parse() as Args;
@@ -289,5 +303,15 @@ export default function parseArgs(argv: string[]): Args {
       WORKER_PROFILE_POLL_INTERVAL_MS,
       10
     ),
+    timeoutRetryCount: setArg(
+      args.timeoutRetryCount,
+      WORKER_TIMEOUT_RETRY_COUNT,
+      10
+    ),
+    timeoutRetryDelayMs: setArg(
+      args.timeoutRetryDelayMs,
+      WORKER_TIMEOUT_RETRY_DELAY_MS,
+      30 * 1000
+    ),
   } as Args;
 }

packages/ws-worker/src/util/send-event.ts

@@ -2,17 +2,6 @@ import * as Sentry from '@sentry/node';
 import type { Context } from '../api/execute';
 import { LightningSocketError, LightningTimeoutError } from '../errors';
 
-// // When a message receives a timeout, how many times should we retry?
-// const TIMEOUT_RETRY_COUNT = process.env.WORKER_TIMEOUT_RETRY_COUNT
-//   ? parseInt(process.env.WORKER_TIMEOUT_RETRY_COUNT)
-//   : 10;
-
-// // When a message receives a timeout, how long should we wait before retrying?
-// const TIMEOUT_RETRY_DELAY =
-//   process.env.WORKER_TIMEOUT_RETRY_DELAY ??
-//   process.env.WORKER_MESSAGE_TIMEOUT_SECONDS ??
-//   30 * 1000;
-
 export const sendEvent = <T>(
   context: Pick<Context, 'logger' | 'channel' | 'id' | 'options'>,
   event: string,
@@ -63,7 +52,7 @@ export const sendEvent = <T>(
           report(new LightningTimeoutError(event));
         } else {
           logger.warn(
-            `${runId} event ${event} timed out, will retry (attempt ${
+            `${runId} event ${event} timed out, will retry in ${timeoutRetryDelay}ms (attempt ${
               thisAttempt + 1
             } of ${timeoutRetryCount})`
           );