temporalio 1.0.0 → 1.2.0

data/lib/temporalio/worker/workflow_replayer.rb

@@ -7,6 +7,7 @@ require 'temporalio/internal/bridge/worker'
 require 'temporalio/internal/worker/multi_runner'
 require 'temporalio/internal/worker/workflow_worker'
 require 'temporalio/worker/interceptor'
+require 'temporalio/worker/plugin'
 require 'temporalio/worker/poller_behavior'
 require 'temporalio/worker/thread_pool'
 require 'temporalio/worker/tuner'
@@ -24,6 +25,7 @@ module Temporalio
         :task_queue,
         :data_converter,
         :workflow_executor,
+        :plugins,
         :interceptors,
         :identity,
         :logger,
@@ -50,6 +52,8 @@ module Temporalio
       #   payloads.
       # @param workflow_executor [WorkflowExecutor] Workflow executor that workflow tasks run within. This must be a
       #   {WorkflowExecutor::ThreadPool} currently.
+      # @param plugins [Array<Plugin>] Plugins to use for configuring replayer and intercepting replay. WARNING: Plugins
+      #   are experimental.
       # @param interceptors [Array<Interceptor::Workflow>] Workflow interceptors.
       # @param identity [String, nil] Override the identity for this replater.
       # @param logger [Logger] Logger to use. Defaults to stdout with warn level. Callers setting this logger are
@@ -83,6 +87,7 @@ module Temporalio
         task_queue: 'ReplayTaskQueue',
         data_converter: Converters::DataConverter.default,
         workflow_executor: WorkflowExecutor::ThreadPool.default,
+        plugins: [],
         interceptors: [],
         identity: nil,
         logger: Logger.new($stdout, level: Logger::WARN),
@@ -100,6 +105,7 @@ module Temporalio
           task_queue:,
           data_converter:,
           workflow_executor:,
+          plugins:,
           interceptors:,
           identity:,
           logger:,
@@ -110,13 +116,18 @@ module Temporalio
           debug_mode:,
           runtime:
         ).freeze
+        # Apply plugins
+        Worker._validate_plugins!(plugins)
+        @options = plugins.reduce(@options) { |options, plugin| plugin.configure_workflow_replayer(options) }
+
         # Preload definitions and other settings
         @workflow_definitions = Internal::Worker::WorkflowWorker.workflow_definitions(
-          workflows, should_enforce_versioning_behavior: false
+          @options.workflows, should_enforce_versioning_behavior: false
         )
         @nondeterminism_as_workflow_fail, @nondeterminism_as_workflow_fail_for_types =
           Internal::Worker::WorkflowWorker.bridge_workflow_failure_exception_type_options(
-            workflow_failure_exception_types:, workflow_definitions: @workflow_definitions
+            workflow_failure_exception_types: @options.workflow_failure_exception_types,
+            workflow_definitions: @workflow_definitions
           )
         # If there is a block, we'll go ahead and assume it's for with_replay_worker
         with_replay_worker(&) if block_given? # steep:ignore
@@ -154,7 +165,18 @@ module Temporalio
       # @yield Block of code to run with a replay worker.
       # @yieldparam [ReplayWorker] Worker to run replays on. Note, only one workflow can replay at a time.
       # @yieldreturn [Object] Result of the block.
-      def with_replay_worker(&)
+      def with_replay_worker(&block)
+        # Apply plugins
+        run_block = proc do |options|
+          # @type var options: Plugin::WithWorkflowReplayWorkerOptions
+          block.call(options.worker)
+        end
+        run_block = options.plugins.reverse_each.reduce(run_block) do |next_call, plugin|
+          proc do |options|
+            plugin.with_workflow_replay_worker(options, next_call) # steep:ignore
+          end
+        end
+
         worker = ReplayWorker.new(
           options:,
           workflow_definitions: @workflow_definitions,
@@ -162,7 +184,7 @@ module Temporalio
           nondeterminism_as_workflow_fail_for_types: @nondeterminism_as_workflow_fail_for_types
         )
         begin
-          yield worker
+          run_block.call(Plugin::WithWorkflowReplayWorkerOptions.new(worker:))
         ensure
           worker._shutdown
         end
@@ -197,8 +219,6 @@ module Temporalio
           @bridge_replayer, @bridge_worker = Internal::Bridge::Worker::WorkflowReplayer.new(
             options.runtime._core_runtime,
             Internal::Bridge::Worker::Options.new(
-              activity: false,
-              workflow: true,
               namespace: options.namespace,
               task_queue: options.task_queue,
               tuner: Tuner.create_fixed(
@@ -211,7 +231,10 @@ module Temporalio
               nonsticky_to_sticky_poll_ratio: 1.0,
               activity_task_poller_behavior:
                 Temporalio::Worker::PollerBehavior::SimpleMaximum.new(1)._to_bridge_options,
-              no_remote_activities: true,
+              enable_workflows: true,
+              enable_local_activities: false,
+              enable_remote_activities: false,
+              enable_nexus: false,
               sticky_queue_schedule_to_start_timeout: 1.0,
               max_heartbeat_throttle_interval: 1.0,
               default_heartbeat_throttle_interval: 1.0,
@@ -220,7 +243,8 @@ module Temporalio
               graceful_shutdown_period: 0.0,
               nondeterminism_as_workflow_fail:,
               nondeterminism_as_workflow_fail_for_types:,
-              deployment_options: Worker.default_deployment_options._to_bridge_options
+              deployment_options: Worker.default_deployment_options._to_bridge_options,
+              plugins: options.plugins.map(&:name).uniq.sort
             )
           )
 

data/lib/temporalio/worker.rb

@@ -15,6 +15,7 @@ require 'temporalio/worker/activity_executor'
 require 'temporalio/worker/deployment_options'
 require 'temporalio/worker/illegal_workflow_call_validator'
 require 'temporalio/worker/interceptor'
+require 'temporalio/worker/plugin'
 require 'temporalio/worker/poller_behavior'
 require 'temporalio/worker/thread_pool'
 require 'temporalio/worker/tuner'
@@ -35,6 +36,7 @@ module Temporalio
       :tuner,
       :activity_executors,
       :workflow_executor,
+      :plugins,
       :interceptors,
       :identity,
       :logger,
@@ -122,6 +124,42 @@ module Temporalio
       raise_in_block_on_shutdown: Error::CanceledError.new('Workers finished'),
       wait_block_complete: true,
       &block
+    )
+      # We have to apply plugins. However, every plugin has a different worker. So we provide them the worker along with
+      # other options, but we disregard any mutation of the worker on the next call.
+      run_worker = proc do |options|
+        # @type var options: Plugin::RunWorkerOptions
+        _run_all_root(*workers,
+                      cancellation: options.cancellation,
+                      shutdown_signals: options.shutdown_signals,
+                      raise_in_block_on_shutdown: options.raise_in_block_on_shutdown,
+                      wait_block_complete:, &block)
+      end
+      plugins_with_workers = workers.flat_map { |w| w._plugins.map { |p| [p, w] } }
+      run_worker = plugins_with_workers.reverse_each.reduce(run_worker) do |next_call, plugin_with_worker|
+        plugin, worker = plugin_with_worker
+        proc do |options|
+          plugin.run_worker(options.with(worker:), next_call) # steep:ignore
+        end
+      end
+
+      run_worker.call(Plugin::RunWorkerOptions.new(
+        # Intentionally violating typing here because we set this on each call
+        worker: nil, # steep:ignore
+        cancellation:,
+        shutdown_signals:,
+        raise_in_block_on_shutdown:
+      ))
+    end
+
+    # @!visibility private
+    def self._run_all_root(
+      *workers,
+      cancellation:,
+      shutdown_signals:,
+      raise_in_block_on_shutdown:,
+      wait_block_complete:,
+      &block
     )
       # Confirm there is at least one and they are all workers
       raise ArgumentError, 'At least one worker required' if workers.empty?
@@ -301,6 +339,19 @@ module Temporalio
       end
     end
 
+    # @!visibility private
+    def self._validate_plugins!(plugins)
+      plugins.each do |plugin|
+        raise ArgumentError, "#{plugin.class} does not implement Worker::Plugin" unless plugin.is_a?(Plugin)
+
+        # Validate plugin has implemented expected methods
+        missing = Plugin.instance_methods(false).select { |m| plugin.method(m).owner == Plugin }
+        unless missing.empty?
+          raise ArgumentError, "#{plugin.class} missing the following worker plugin method(s): #{missing.join(', ')}"
+        end
+      end
+    end
+
     # @return [Options] Options for this worker which has the same attributes as {initialize}.
     attr_reader :options
 
@@ -315,6 +366,9 @@ module Temporalio
     # @param activity_executors [Hash<Symbol, Worker::ActivityExecutor>] Executors that activities can run within.
     # @param workflow_executor [WorkflowExecutor] Workflow executor that workflow tasks run within. This must be a
     #   {WorkflowExecutor::ThreadPool} currently.
+    # @param plugins [Array<Plugin>] Plugins to use for configuring workers and intercepting the running of workers. Any
+    #   plugins that were set on the client that include {Plugin} will automatically be applied to the worker and
+    #   should not be configured explicitly via this option. WARNING: Plugins are experimental.
     # @param interceptors [Array<Interceptor::Activity, Interceptor::Workflow>] Interceptors specific to this worker.
     #   Note, interceptors set on the client that include the {Interceptor::Activity} or {Interceptor::Workflow} module
     #   are automatically included here, so no need to specify them again.
@@ -387,6 +441,7 @@ module Temporalio
       tuner: Tuner.create_fixed,
       activity_executors: ActivityExecutor.defaults,
       workflow_executor: WorkflowExecutor::ThreadPool.default,
+      plugins: [],
       interceptors: [],
       identity: nil,
       logger: client.options.logger,
@@ -411,8 +466,6 @@ module Temporalio
       activity_task_poller_behavior: PollerBehavior::SimpleMaximum.new(max_concurrent_activity_task_polls),
       debug_mode: %w[true 1].include?(ENV['TEMPORAL_DEBUG'].to_s.downcase)
     )
-      raise ArgumentError, 'Must have at least one activity or workflow' if activities.empty? && workflows.empty?
-
       Internal::ProtoUtils.assert_non_reserved_name(task_queue)
 
       @options = Options.new(
@@ -423,6 +476,7 @@ module Temporalio
         tuner:,
         activity_executors:,
         workflow_executor:,
+        plugins:,
         interceptors:,
         identity:,
         logger:,
@@ -447,54 +501,68 @@ module Temporalio
         activity_task_poller_behavior:,
         debug_mode:
       ).freeze
+      # Collect applicable client plugins and worker plugins, then validate and apply to options
+      @plugins = client.options.plugins.grep(Plugin) + plugins
+      Worker._validate_plugins!(@plugins)
+      @options = @plugins.reduce(@options) { |options, plugin| plugin.configure_worker(options) }
+      # Initialize the worker for the given options
+      _initialize_from_options
+    end
+
+    # @!visibility private
+    def _initialize_from_options
+      if @options.activities.empty? && @options.workflows.empty?
+        raise ArgumentError, 'Must have at least one activity or workflow'
+      end
 
       should_enforce_versioning_behavior =
-        deployment_options.use_worker_versioning &&
-        deployment_options.default_versioning_behavior == VersioningBehavior::UNSPECIFIED
+        @options.deployment_options.use_worker_versioning &&
+        @options.deployment_options.default_versioning_behavior == VersioningBehavior::UNSPECIFIED
       # Preload workflow definitions and some workflow settings for the bridge
       workflow_definitions = Internal::Worker::WorkflowWorker.workflow_definitions(
-        workflows,
-        should_enforce_versioning_behavior: should_enforce_versioning_behavior
+        @options.workflows,
+        should_enforce_versioning_behavior:
       )
       nondeterminism_as_workflow_fail, nondeterminism_as_workflow_fail_for_types =
         Internal::Worker::WorkflowWorker.bridge_workflow_failure_exception_type_options(
-          workflow_failure_exception_types:, workflow_definitions:
+          workflow_failure_exception_types: @options.workflow_failure_exception_types,
+          workflow_definitions:
         )
 
       # Create the bridge worker
       @bridge_worker = Internal::Bridge::Worker.new(
-        client.connection._core_client,
+        @options.client.connection._core_client,
         Internal::Bridge::Worker::Options.new(
-          activity: !activities.empty?,
-          workflow: !workflows.empty?,
-          namespace: client.namespace,
-          task_queue:,
-          tuner: tuner._to_bridge_options,
-          identity_override: identity,
-          max_cached_workflows:,
-          workflow_task_poller_behavior: workflow_task_poller_behavior._to_bridge_options,
-          nonsticky_to_sticky_poll_ratio:,
-          activity_task_poller_behavior: activity_task_poller_behavior._to_bridge_options,
-          # For shutdown to work properly, we must disable remote activities
-          # ourselves if there are no activities
-          no_remote_activities: no_remote_activities || activities.empty?,
-          sticky_queue_schedule_to_start_timeout:,
-          max_heartbeat_throttle_interval:,
-          default_heartbeat_throttle_interval:,
-          max_worker_activities_per_second: max_activities_per_second,
-          max_task_queue_activities_per_second:,
-          graceful_shutdown_period:,
+          namespace: @options.client.namespace,
+          task_queue: @options.task_queue,
+          tuner: @options.tuner._to_bridge_options,
+          identity_override: @options.identity,
+          max_cached_workflows: @options.max_cached_workflows,
+          workflow_task_poller_behavior: @options.workflow_task_poller_behavior._to_bridge_options,
+          nonsticky_to_sticky_poll_ratio: @options.nonsticky_to_sticky_poll_ratio,
+          activity_task_poller_behavior: @options.activity_task_poller_behavior._to_bridge_options,
+          enable_workflows: !@options.workflows.empty?,
+          enable_local_activities: !@options.workflows.empty? && !@options.activities.empty?,
+          enable_remote_activities: !@options.activities.empty? && !@options.no_remote_activities,
+          enable_nexus: false,
+          sticky_queue_schedule_to_start_timeout: @options.sticky_queue_schedule_to_start_timeout,
+          max_heartbeat_throttle_interval: @options.max_heartbeat_throttle_interval,
+          default_heartbeat_throttle_interval: @options.default_heartbeat_throttle_interval,
+          max_worker_activities_per_second: @options.max_activities_per_second,
+          max_task_queue_activities_per_second: @options.max_task_queue_activities_per_second,
+          graceful_shutdown_period: @options.graceful_shutdown_period,
           nondeterminism_as_workflow_fail:,
           nondeterminism_as_workflow_fail_for_types:,
-          deployment_options: deployment_options._to_bridge_options
+          deployment_options: @options.deployment_options._to_bridge_options,
+          plugins: (@options.client.options.plugins + @options.plugins).map(&:name).uniq.sort
         )
       )
 
       # Collect interceptors from client and params
-      @activity_interceptors = (client.options.interceptors + interceptors).select do |i|
+      @activity_interceptors = (@options.client.options.interceptors + @options.interceptors).select do |i|
         i.is_a?(Interceptor::Activity)
       end
-      @workflow_interceptors = (client.options.interceptors + interceptors).select do |i|
+      @workflow_interceptors = (@options.client.options.interceptors + @options.interceptors).select do |i|
         i.is_a?(Interceptor::Workflow)
       end
 
@@ -502,27 +570,27 @@ module Temporalio
       @worker_shutdown_cancellation = Cancellation.new
 
       # Create workers
-      unless activities.empty?
+      unless @options.activities.empty?
         @activity_worker = Internal::Worker::ActivityWorker.new(worker: self,
                                                                 bridge_worker: @bridge_worker)
       end
-      unless workflows.empty?
+      unless @options.workflows.empty?
         @workflow_worker = Internal::Worker::WorkflowWorker.new(
           bridge_worker: @bridge_worker,
-          namespace: client.namespace,
-          task_queue:,
+          namespace: @options.client.namespace,
+          task_queue: @options.task_queue,
           workflow_definitions:,
-          workflow_executor:,
-          logger:,
-          data_converter: client.data_converter,
-          metric_meter: client.connection.options.runtime.metric_meter,
+          workflow_executor: @options.workflow_executor,
+          logger: @options.logger,
+          data_converter: @options.client.data_converter,
+          metric_meter: @options.client.connection.options.runtime.metric_meter,
           workflow_interceptors: @workflow_interceptors,
-          disable_eager_activity_execution:,
-          illegal_workflow_calls:,
-          workflow_failure_exception_types:,
-          workflow_payload_codec_thread_pool:,
-          unsafe_workflow_io_enabled:,
-          debug_mode:,
+          disable_eager_activity_execution: @options.disable_eager_activity_execution,
+          illegal_workflow_calls: @options.illegal_workflow_calls,
+          workflow_failure_exception_types: @options.workflow_failure_exception_types,
+          workflow_payload_codec_thread_pool: @options.workflow_payload_codec_thread_pool,
+          unsafe_workflow_io_enabled: @options.unsafe_workflow_io_enabled,
+          debug_mode: @options.debug_mode,
           assert_valid_local_activity: ->(activity) { _assert_valid_local_activity(activity) }
         )
       end
@@ -644,5 +712,10 @@ module Temporalio
             "Activity #{activity} " \
             'is not registered on this worker, no available activities.'
     end
+
+    # @!visibility private
+    def _plugins
+      @plugins
+    end
   end
 end

data/lib/temporalio/workflow/definition.rb

@@ -102,7 +102,9 @@ module Temporalio
 
             # Just run this as if done manually
             workflow_query(description:)
-            define_method(attr_name) { instance_variable_get("@#{attr_name}") }
+            define_method(attr_name) do
+              instance_variable_get("@#{attr_name}") # steep:ignore NoMethod
+            end
           end
         end
 

data/lib/temporalio/workflow/info.rb

@@ -11,6 +11,7 @@ module Temporalio
       :headers,
       :last_failure,
       :last_result,
+      :has_last_result?,
       :namespace,
       :parent,
       :priority,
@@ -44,6 +45,9 @@ module Temporalio
     #   @return [Exception, nil] Failure if this workflow run is a continuation of a failure.
     # @!attribute last_result
     #   @return [Object, nil] Successful result if this workflow is a continuation of a success.
+    # @!attribute has_last_result?
+    #   @return [Boolean] Successful result if this workflow is a continuation of a success.
+
     # @!attribute namespace
     #   @return [String] Namespace for the workflow.
     # @!attribute parent

data/lib/temporalio/workflow.rb

@@ -533,11 +533,18 @@ module Temporalio
     # Unsafe module contains only-in-workflow methods that are considered unsafe. These should not be used unless the
     # consequences are understood.
     module Unsafe
-      # @return [Boolean] True if the workflow is replaying, false otherwise. Most code should not check this value.
+      # @return [Boolean] True if the workflow is replaying (including during queries and update validators), false
+      #   otherwise. Most code should not check this value.
       def self.replaying?
         Workflow._current.replaying?
       end
 
+      # @return [Boolean] True if the workflow is replaying history events (excluding queries and update validators),
+      #   false otherwise. Most code should not check this value.
+      def self.replaying_history_events?
+        Workflow._current.replaying_history_events?
+      end
+
       # Run a block of code with illegal call tracing disabled. Users should be cautious about using this as it can
       # often signify unsafe code.
       #

data/temporalio.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.extensions = ['ext/Cargo.toml']
   spec.metadata['rubygems_mfa_required'] = 'true'
-  spec.required_ruby_version = '>= 3.2.0'
+  spec.required_ruby_version = '>= 3.3.0'
 
   spec.add_dependency 'google-protobuf', '>= 3.25.0'
   spec.add_dependency 'logger'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temporalio
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Temporal Technologies Inc
@@ -79,6 +79,7 @@ files:
 - lib/temporalio/api/common/v1/grpc_status.rb
 - lib/temporalio/api/common/v1/message.rb
 - lib/temporalio/api/deployment/v1/message.rb
+- lib/temporalio/api/enums/v1/activity.rb
 - lib/temporalio/api/enums/v1/batch_operation.rb
 - lib/temporalio/api/enums/v1/command_type.rb
 - lib/temporalio/api/enums/v1/common.rb
@@ -135,6 +136,7 @@ files:
 - lib/temporalio/client/connection/test_service.rb
 - lib/temporalio/client/connection/workflow_service.rb
 - lib/temporalio/client/interceptor.rb
+- lib/temporalio/client/plugin.rb
 - lib/temporalio/client/schedule.rb
 - lib/temporalio/client/schedule_handle.rb
 - lib/temporalio/client/with_start_workflow_operation.rb
@@ -207,6 +209,7 @@ files:
 - lib/temporalio/runtime/metric_buffer.rb
 - lib/temporalio/scoped_logger.rb
 - lib/temporalio/search_attributes.rb
+- lib/temporalio/simple_plugin.rb
 - lib/temporalio/testing.rb
 - lib/temporalio/testing/activity_environment.rb
 - lib/temporalio/testing/workflow_environment.rb
@@ -219,6 +222,7 @@ files:
 - lib/temporalio/worker/deployment_options.rb
 - lib/temporalio/worker/illegal_workflow_call_validator.rb
 - lib/temporalio/worker/interceptor.rb
+- lib/temporalio/worker/plugin.rb
 - lib/temporalio/worker/poller_behavior.rb
 - lib/temporalio/worker/thread_pool.rb
 - lib/temporalio/worker/tuner.rb
@@ -253,14 +257,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Temporal.io Ruby SDK
 test_files: []