feat: Expose nonStickyToStickyPollRatio WorkerOption (#1254)

Author: bergundy

packages/core-bridge/src/conversions.rs

@@ -332,6 +332,9 @@ impl ObjectHandleConversionsExt for Handle<'_, JsObject> {
             js_optional_getter!(cx, self, "shutdownGraceTimeMs", JsNumber)
                 .map(|num| Duration::from_millis(num.value(cx) as u64));
 
+        let nonsticky_to_sticky_poll_ratio =
+            js_value_getter!(cx, self, "nonStickyToStickyPollRatio", JsNumber) as f32;
+
         match WorkerConfigBuilder::default()
             .worker_build_id(js_value_getter!(cx, self, "buildId", JsString))
             .client_identity_override(Some(js_value_getter!(cx, self, "identity", JsString)))
@@ -342,6 +345,7 @@ impl ObjectHandleConversionsExt for Handle<'_, JsObject> {
             .max_outstanding_local_activities(max_outstanding_local_activities)
             .max_concurrent_wft_polls(max_concurrent_wft_polls)
             .max_concurrent_at_polls(max_concurrent_at_polls)
+            .nonsticky_to_sticky_poll_ratio(nonsticky_to_sticky_poll_ratio)
             .max_cached_workflows(max_cached_workflows)
             .sticky_queue_schedule_to_start_timeout(sticky_queue_schedule_to_start_timeout)
             .graceful_shutdown_period(graceful_shutdown_period)

packages/core-bridge/ts/index.ts

@@ -286,6 +286,7 @@ export interface WorkerOptions {
   maxConcurrentActivityTaskExecutions: number;
   maxConcurrentWorkflowTaskExecutions: number;
   maxConcurrentLocalActivityExecutions: number;
+  nonStickyToStickyPollRatio: number;
 
   /**
    * Maximum number of Workflow tasks to poll concurrently.

packages/test/src/run-a-worker.ts

@@ -22,6 +22,7 @@ async function main() {
     activities,
     workflowsPath: require.resolve('./workflows'),
     taskQueue: 'test',
+    nonStickyToStickyPollRatio: 0.5,
   });
   await worker.run();
   console.log('Worker gracefully shutdown');

packages/worker/src/worker-options.ts

@@ -256,6 +256,20 @@ export interface WorkerOptions {
    */
   maxConcurrentWorkflowTaskExecutions?: number;
 
+  /**
+   * `maxConcurrentWorkflowTaskPolls` * this number = the number of max pollers that will
+   * be allowed for the nonsticky queue when sticky tasks are enabled. If both defaults are used,
+   * the sticky queue will allow 8 max pollers while the nonsticky queue will allow 2. The
+   * minimum for either poller is 1, so if `maxConcurrentWorkflowTaskPolls` is 1 and sticky queues are
+   * enabled, there will be 2 concurrent polls.
+   *
+   * ⚠️ This API is experimental and may be removed in the future if the poll scaling algorithm changes.
+   *
+   * @experimental This API is experimental and may be removed in the future if the poll scaling algorithm changes.
+   * @default 0.2
+   */
+  nonStickyToStickyPollRatio?: number;
+
   /**
    * Maximum number of Workflow Tasks to poll concurrently.
    *
@@ -514,6 +528,7 @@ export type WorkerOptionsWithDefaults = WorkerOptions &
       | 'maxConcurrentWorkflowTaskExecutions'
       | 'maxConcurrentWorkflowTaskPolls'
       | 'maxConcurrentActivityTaskPolls'
+      | 'nonStickyToStickyPollRatio'
       | 'enableNonLocalActivities'
       | 'stickyQueueScheduleToStartTimeout'
       | 'maxCachedWorkflows'
@@ -564,6 +579,9 @@ export interface ReplayWorkerOptions
     | 'maxConcurrentActivityTaskExecutions'
     | 'maxConcurrentLocalActivityExecutions'
     | 'maxConcurrentWorkflowTaskExecutions'
+    | 'maxConcurrentActivityTaskPolls'
+    | 'maxConcurrentWorkflowTaskPolls'
+    | 'nonStickyToStickyPollRatio'
     | 'maxHeartbeatThrottleInterval'
     | 'defaultHeartbeatThrottleInterval'
     | 'debugMode'
@@ -649,6 +667,7 @@ export function addDefaultWorkerOptions(options: WorkerOptions): WorkerOptionsWi
     namespace,
     reuseV8Context,
     sinks,
+    nonStickyToStickyPollRatio,
     ...rest
   } = options;
   const debugMode = options.debugMode || isSet(process.env.TEMPORAL_DEBUG);
@@ -686,6 +705,7 @@ export function addDefaultWorkerOptions(options: WorkerOptions): WorkerOptionsWi
     reuseV8Context: reuseV8Context ?? false,
     debugMode: debugMode ?? false,
     interceptors: appendDefaultInterceptors({}),
+    nonStickyToStickyPollRatio: nonStickyToStickyPollRatio ?? 0.2,
     sinks: { ...defaultSinks(), ...sinks },
     ...rest,
     maxConcurrentWorkflowTaskExecutions,