Expose poller automation #275

Sushisource · 2025-05-29T00:42:58Z

What was changed

Expose poller automation options

Why?

SDK Parity

Checklist

Needs #274 to merge first

Closes
How was this tested:
Added test
Any docs updates needed?

cretz · 2025-05-29T13:16:22Z

temporalio/ext/src/worker.rs

+            initial: poller_behavior.member::<usize>(id!("initial"))?,
+        }
+    } else {
+        PollerBehavior::SimpleMaximum(poller_behavior.member::<usize>(id!("maximum"))?)


Suggested change

PollerBehavior::SimpleMaximum(poller_behavior.member::<usize>(id!("maximum"))?)

PollerBehavior::SimpleMaximum(poller_behavior.member::<usize>(id!("simple_maximum"))?)

🤦‍♂️ thanks

cretz · 2025-05-29T13:17:36Z

temporalio/lib/temporalio/worker.rb

+      workflow_task_poller_behavior: nil,
+      activity_task_poller_behavior: nil,


Add these to docs

cretz · 2025-05-29T13:18:20Z

temporalio/lib/temporalio/worker.rb

+      :debug_mode,
+      :workflow_task_poller_behavior,
+      :activity_task_poller_behavior


Suggested change

:debug_mode,

:workflow_task_poller_behavior,

:activity_task_poller_behavior

:workflow_task_poller_behavior,

:activity_task_poller_behavior,

:debug_mode

Might as well keep the same order as initialize (and update where you instantiate the options too)

cretz · 2025-05-29T13:20:27Z

temporalio/lib/temporalio/worker.rb

+      # Convert deprecated max concurrent polls to poller behaviors if not specified
+      workflow_task_poller_behavior ||= SimpleMaximumPollerBehavior.new(maximum: max_concurrent_workflow_task_polls)
+      activity_task_poller_behavior ||= SimpleMaximumPollerBehavior.new(maximum: max_concurrent_activity_task_polls)


I'm thinking we should set these as parameter defaults. Ruby is cool in that not only does the default expression not get evaluated if a value is provided, but a default parameter expression can use parameters defined before it.

cretz · 2025-05-29T13:21:36Z

temporalio/lib/temporalio/worker/poller_behavior.rb

+      # Creates a simple maximum poller behavior
+      # The poller will attempt to poll as long as a slot is available, up to the
+      # provided maximum. Cannot be less than two for workflow tasks, or one for other tasks.
+      #
+      # @param maximum [Integer] Maximum number of concurrent poll requests.
+      # @return [SimpleMaximumPollerBehavior] A simple maximum poller behavior
+      def self.simple_maximum(maximum = 5)
+        SimpleMaximumPollerBehavior.new(maximum: maximum)
+      end
+
+      # Creates an autoscaling poller behavior
+      # The poller will automatically scale the number of pollers based on feedback
+      # from the server. A slot must be available before beginning polling.
+      #
+      # @param minimum [Integer] Minimum number of poll calls (assuming slots are available).
+      # @param maximum [Integer] Maximum number of poll calls that will ever be open at once.
+      # @param initial [Integer] Number of polls attempted initially before scaling kicks in.
+      # @return [AutoscalingPollerBehavior] An autoscaling poller behavior
+      def self.autoscaling(minimum: 1, maximum: 100, initial: 5)
+        AutoscalingPollerBehavior.new(minimum: minimum, maximum: maximum, initial: initial)
+      end


Suggested change

# Creates a simple maximum poller behavior

# The poller will attempt to poll as long as a slot is available, up to the

# provided maximum. Cannot be less than two for workflow tasks, or one for other tasks.

#

# @param maximum [Integer] Maximum number of concurrent poll requests.

# @return [SimpleMaximumPollerBehavior] A simple maximum poller behavior

def self.simple_maximum(maximum = 5)

SimpleMaximumPollerBehavior.new(maximum: maximum)

end

# Creates an autoscaling poller behavior

# The poller will automatically scale the number of pollers based on feedback

# from the server. A slot must be available before beginning polling.

#

# @param minimum [Integer] Minimum number of poll calls (assuming slots are available).

# @param maximum [Integer] Maximum number of poll calls that will ever be open at once.

# @param initial [Integer] Number of polls attempted initially before scaling kicks in.

# @return [AutoscalingPollerBehavior] An autoscaling poller behavior

def self.autoscaling(minimum: 1, maximum: 100, initial: 5)

AutoscalingPollerBehavior.new(minimum: minimum, maximum: maximum, initial: initial)

end

Probably don't need either of these if we're not hiding the subclasses. Ruby users have no problem instantiating classes in these cases and therefore the helpers do not provide much value

Hmm, I added because I did this for VersioningOverride (same with the prefixed name) and we were fine with it there. I have no problem removing it though.

I can fix those in this PR since it's unreleased if we want

👍 I see now that versioning override not only made the subclasses adjacent to the parent (usually Ruby prefers them inside) but that we added helpers that don't have too much value. Sorry I didn't notice at the time.

For Ruby users Temporalio::Worker::PollerBehavior.autoscaling(maximum: 500) and Temporalio::Worker::PollerBehavior::Autoscaling.new(maximum: 500) are effectively equivalent and I think most even prefer the latter. Would suggest moving the versioning behavior ones too (move subclass to inside parent, remove class name suffix, remove helper).

cretz · 2025-05-29T13:22:11Z

temporalio/lib/temporalio/worker/poller_behavior.rb

+
+    # A poller behavior that attempts to poll as long as a slot is available, up to the
+    # provided maximum. Cannot be less than two for workflow tasks, or one for other tasks.
+    class SimpleMaximumPollerBehavior < PollerBehavior


Suggested change

class SimpleMaximumPollerBehavior < PollerBehavior

class SimpleMaximum < PollerBehavior

It is idiomatic in Ruby to remove this suffix (same for autoscaling one below)

If so it seems like these should be inside a PollerBehavior module or the class? B/c

Temporalio::Worker::Autoscaling.new is super confusing

I moved them inside the class.

cretz

Nothing blocking

cretz · 2025-05-29T19:45:29Z

temporalio/lib/temporalio/worker/poller_behavior.rb

+        attr_reader :maximum
+
+        # @param maximum [Integer] Maximum number of concurrent poll requests.
+        def initialize(maximum: 5)


Suggested change

def initialize(maximum: 5)

def initialize(maximum = 5)

Feel free to make this a positional arg if it makes more sense, which it seems to here.

cretz · 2025-05-29T19:46:51Z

temporalio/lib/temporalio/worker/poller_behavior.rb

+        attr_reader :maximum
+
+        # @param maximum [Integer] Maximum number of concurrent poll requests.
+        def initialize(maximum: 5)


Arguably this shouldn't have a default, but rather where it's used as a default can provide this parameter value. Maybe same for autoscaling. But not a big deal either way.

cretz · 2025-05-29T19:49:04Z

temporalio/test/worker_test.rb

+      # Give pollers a beat to get started
+      sleep(0.3)


I am worried about flakiness of this kind of assumption. Maybe something like assert_eventually that asserts temporal_num_pollers exists and returns that line?

Sushisource requested a review from a team as a code owner May 29, 2025 00:42

cretz reviewed May 29, 2025

View reviewed changes

Sushisource force-pushed the poller-automation branch from b2da34b to f2feea4 Compare May 29, 2025 18:16

cretz approved these changes May 29, 2025

View reviewed changes

Base automatically changed from priority-annotations to main May 29, 2025 21:18

Sushisource added 4 commits May 29, 2025 14:24

Add priority annotations

e93350c

Expose poller automation

e8a5168

Review comments

caab471

Make versioning overrides structure nicer

41bf274

Sushisource force-pushed the poller-automation branch 2 times, most recently from 5b925f7 to 60d1238 Compare May 29, 2025 21:32

Sushisource enabled auto-merge (squash) May 29, 2025 21:32

Last review comments

9003ad2

Sushisource force-pushed the poller-automation branch from 60d1238 to 9003ad2 Compare May 29, 2025 21:41

Sushisource merged commit 251c16f into main May 29, 2025
12 checks passed

Sushisource deleted the poller-automation branch May 29, 2025 21:52

	PollerBehavior::SimpleMaximum(poller_behavior.member::<usize>(id!("maximum"))?)
	PollerBehavior::SimpleMaximum(poller_behavior.member::<usize>(id!("simple_maximum"))?)

		workflow_task_poller_behavior: nil,
		activity_task_poller_behavior: nil,

	class SimpleMaximumPollerBehavior < PollerBehavior
	class SimpleMaximum < PollerBehavior

Expose poller automation #275

Expose poller automation #275

Uh oh!

Conversation

Sushisource commented May 29, 2025

What was changed

Why?

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cretz May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sushisource May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cretz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cretz May 29, 2025 •

edited

Loading

Sushisource May 29, 2025 •

edited

Loading