temporalio 0.6.0 → 1.0.0

data/lib/temporalio/internal/worker/workflow_instance.rb

@@ -125,6 +125,7 @@ module Temporalio
               continued_run_id: ProtoUtils.string_or(@init_job.continued_from_execution_run_id),
               cron_schedule: ProtoUtils.string_or(@init_job.cron_schedule),
               execution_timeout: ProtoUtils.duration_to_seconds(@init_job.workflow_execution_timeout),
+              first_execution_run_id: @init_job.first_execution_run_id,
               headers: ProtoUtils.headers_from_proto_map(@init_job.headers, @payload_converter) || {},
               last_failure: if @init_job.continued_failure
                               @failure_converter.from_failure(@init_job.continued_failure, @payload_converter)
@@ -162,86 +163,9 @@ module Temporalio
         end
 
         def activate(activation)
-          # Run inside of scheduler
-          run_in_scheduler { activate_internal(activation) }
-        end
-
-        def add_command(command)
-          raise Workflow::InvalidWorkflowStateError, 'Cannot add commands in this context' if @context_frozen
-
-          @commands << command
-        end
-
-        def instance
-          @instance or raise 'Instance accessed before created'
-        end
-
-        def search_attributes
-          # Lazy on first access
-          @search_attributes ||= SearchAttributes._from_proto(
-            @init_job.search_attributes, disable_mutations: true, never_nil: true
-          ) || raise
-        end
-
-        def memo
-          # Lazy on first access
-          @memo ||= ExternallyImmutableHash.new(ProtoUtils.memo_from_proto(@init_job.memo, payload_converter) || {})
-        end
-
-        def now
-          # Create each time
-          ProtoUtils.timestamp_to_time(@now_timestamp) or raise 'Time unexpectedly not present'
-        end
-
-        def illegal_call_tracing_disabled(&)
-          @tracer.disable(&)
-        end
-
-        def patch(patch_id:, deprecated:)
-          # Use memoized result if present. If this is being deprecated, we can still use memoized result and skip the
-          # command.
-          patch_id = patch_id.to_s
-          @patches_memoized ||= {}
-          @patches_memoized.fetch(patch_id) do
-            patched = !replaying || @patches_notified.include?(patch_id)
-            @patches_memoized[patch_id] = patched
-            if patched
-              add_command(
-                Bridge::Api::WorkflowCommands::WorkflowCommand.new(
-                  set_patch_marker: Bridge::Api::WorkflowCommands::SetPatchMarker.new(patch_id:, deprecated:)
-                )
-              )
-            end
-            patched
-          end
-        end
-
-        def metric_meter
-          @metric_meter ||= ReplaySafeMetric::Meter.new(
-            @runtime_metric_meter.with_additional_attributes(
-              {
-                namespace: info.namespace,
-                task_queue: info.task_queue,
-                workflow_type: info.workflow_type
-              }
-            )
-          )
-        end
-
-        private
-
-        def run_in_scheduler(&)
+          # Run inside of scheduler (removed on ensure)
           Fiber.set_scheduler(@scheduler)
-          if @tracer
-            @tracer.enable(&)
-          else
-            yield
-          end
-        ensure
-          Fiber.set_scheduler(nil)
-        end
 
-        def activate_internal(activation)
           # Reset some activation state
           @commands = []
           @current_activation_error = nil
@@ -266,8 +190,12 @@ module Temporalio
             # the first activation)
             @primary_fiber ||= schedule(top_level: true) { run_workflow }
 
-            # Run the event loop
-            @scheduler.run_until_all_yielded
+            # Run the event loop in the tracer if it exists
+            if @tracer
+              @tracer.enable { @scheduler.run_until_all_yielded }
+            else
+              @scheduler.run_until_all_yielded
+            end
           rescue Exception => e # rubocop:disable Lint/RescueException
             on_top_level_exception(e)
           end
@@ -306,8 +234,77 @@ module Temporalio
         ensure
           @commands = nil
           @current_activation_error = nil
+          Fiber.set_scheduler(nil)
+        end
+
+        def add_command(command)
+          raise Workflow::InvalidWorkflowStateError, 'Cannot add commands in this context' if @context_frozen
+
+          @commands << command
+        end
+
+        def instance
+          @instance or raise 'Instance accessed before created'
+        end
+
+        def search_attributes
+          # Lazy on first access
+          @search_attributes ||= SearchAttributes._from_proto(
+            @init_job.search_attributes, disable_mutations: true, never_nil: true
+          ) || raise
+        end
+
+        def memo
+          # Lazy on first access
+          @memo ||= ExternallyImmutableHash.new(ProtoUtils.memo_from_proto(@init_job.memo, payload_converter) || {})
+        end
+
+        def now
+          # Create each time
+          ProtoUtils.timestamp_to_time(@now_timestamp) or raise 'Time unexpectedly not present'
         end
 
+        def illegal_call_tracing_disabled(&)
+          if @tracer
+            @tracer.disable_temporarily(&)
+          else
+            yield
+          end
+        end
+
+        def patch(patch_id:, deprecated:)
+          # Use memoized result if present. If this is being deprecated, we can still use memoized result and skip the
+          # command.
+          patch_id = patch_id.to_s
+          @patches_memoized ||= {}
+          @patches_memoized.fetch(patch_id) do
+            patched = !replaying || @patches_notified.include?(patch_id)
+            @patches_memoized[patch_id] = patched
+            if patched
+              add_command(
+                Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                  set_patch_marker: Bridge::Api::WorkflowCommands::SetPatchMarker.new(patch_id:, deprecated:)
+                )
+              )
+            end
+            patched
+          end
+        end
+
+        def metric_meter
+          @metric_meter ||= ReplaySafeMetric::Meter.new(
+            @runtime_metric_meter.with_additional_attributes(
+              {
+                namespace: info.namespace,
+                task_queue: info.task_queue,
+                workflow_type: info.workflow_type
+              }
+            )
+          )
+        end
+
+        private
+
         def create_instance
           # Convert workflow arguments
           @workflow_arguments = convert_args(payload_array: @init_job.arguments,

data/lib/temporalio/testing/activity_environment.rb

@@ -25,6 +25,7 @@ module Temporalio
           local?: false,
           priority: Temporalio::Priority.default,
           raw_heartbeat_details: [],
+          retry_policy: RetryPolicy.new,
           schedule_to_close_timeout: 1.0,
           scheduled_time: Time.at(0),
           start_to_close_timeout: 1.0,

data/lib/temporalio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Temporalio
-  VERSION = '0.6.0'
+  VERSION = '1.0.0'
 end

data/lib/temporalio/worker/interceptor.rb

@@ -228,6 +228,7 @@ module Temporalio
         ExecuteLocalActivityInput = Data.define(
           :activity,
           :args,
+          :summary,
           :schedule_to_close_timeout,
           :schedule_to_start_timeout,
           :start_to_close_timeout,

data/lib/temporalio/worker/tuner.rb

@@ -22,10 +22,11 @@ module Temporalio
           end
 
           # @!visibility private
-          def _to_bridge_options
+          def _to_bridge_options(_tuner)
             Internal::Bridge::Worker::TunerSlotSupplierOptions.new(
               fixed_size: slots,
-              resource_based: nil
+              resource_based: nil,
+              custom: nil
             )
           end
         end
@@ -36,7 +37,7 @@ module Temporalio
         class ResourceBased < SlotSupplier
           attr_reader :tuner_options, :slot_options
 
-          # Create a reosurce-based slot supplier.
+          # Create a resource-based slot supplier.
           #
           # @param tuner_options [ResourceBasedTunerOptions] General tuner options.
           # @param slot_options [ResourceBasedSlotOptions] Slot-supplier-specific tuner options.
@@ -46,7 +47,7 @@ module Temporalio
           end
 
           # @!visibility private
-          def _to_bridge_options
+          def _to_bridge_options(_tuner)
             Internal::Bridge::Worker::TunerSlotSupplierOptions.new(
               fixed_size: nil,
               resource_based: Internal::Bridge::Worker::TunerResourceBasedSlotSupplierOptions.new(
@@ -55,14 +56,175 @@ module Temporalio
                 min_slots: slot_options.min_slots,
                 max_slots: slot_options.max_slots,
                 ramp_throttle: slot_options.ramp_throttle
+              ),
+              custom: nil
+            )
+          end
+        end
+
+        # A slot supplier that has callbacks invoked to handle slot supplying.
+        #
+        # Users should be cautious when implementing this and make sure it is heavily tested and the documentation for
+        # every method is well understood.
+        #
+        # @note WARNING: This API is experimental.
+        class Custom < SlotSupplier
+          # Context provided for slot reservation on custom slot supplier.
+          #
+          # @!attribute slot_type
+          #   @return [:workflow, :activity, :local_activity, :nexus] Slot type.
+          # @!attribute task_queue
+          #   @return [String] Task queue.
+          # @!attribute worker_identity
+          #   @return [String] Worker identity.
+          # @!attribute worker_deployment_name
+          #   @return [String] Worker deployment name or empty string if not applicable.
+          # @!attribute worker_build_id
+          #   @return [String] Worker build ID or empty string if not applicable.
+          # @!attribute sticky?
+          #   @return [Boolean] True if this reservation is for a sticky workflow task.
+          ReserveContext = Data.define(
+            :slot_type,
+            :task_queue,
+            :worker_identity,
+            :worker_deployment_name,
+            :worker_build_id,
+            :sticky?
+          )
+
+          # Context provided for marking a slot used.
+          #
+          # @!attribute slot_info
+          #   @return [SlotInfo::Workflow, SlotInfo::Activity, SlotInfo::LocalActivity, SlotInfo::Nexus] Information
+          #     about the slot. This is never nil.
+          # @!attribute permit
+          #   @return [Object] Object that was provided as the permit on reserve.
+          MarkUsedContext = Data.define(
+            :slot_info,
+            :permit
+          )
+
+          # Context provided for releasing a slot.
+          #
+          # @!attribute slot_info
+          #   @return [SlotInfo::Workflow, SlotInfo::Activity, SlotInfo::LocalActivity, SlotInfo::Nexus, nil]
+          #     Information about the slot. This may be nil if the slot was never used.
+          # @!attribute permit
+          #   @return [Object] Object that was provided as the permit on reserve.
+          ReleaseContext = Data.define(
+            :slot_info,
+            :permit
+          )
+
+          # Reserve a slot.
+          #
+          # This can/should block and must provide the permit to the (code) block. The permit is any object (including
+          # nil) that will be given on the context for mark_slot_used and release_slot.
+          #
+          # Just returning from this call is not enough to reserve the slot, a permit must be provided to the block
+          # (e.g. via yield or block.call). If the call completes, the system will still wait on the block (so this can
+          # be backgrounded by passing the block to something else). Reservations may be canceled via the given
+          # cancellation. Users can do things like add_cancel_callback, but it is very important that the code in the
+          # callback is fast as it is run on the same reactor thread as many other Temporal Ruby worker calls.
+          #
+          # @note WARNING: This call should never raise an exception. Any exception raised is ignored and this is called
+          #   again after 1 second.
+          #
+          # @param context [ReserveContext] Contextual information about this reserve call.
+          # @param cancellation [Cancellation] Cancellation that is canceled when the reservation is no longer being
+          #   asked for.
+          # @yield [Object] Confirm reservation and provide a permit.
+          def reserve_slot(context, cancellation, &)
+            raise NotImplementedError
+          end
+
+          # Try to reserve a slot.
+          #
+          # @note WARNING: This should never block, this should return immediately with a permit, or nil if the
+          #   reservation could not occur.
+          #
+          # @note WARNING: This call should never raise an exception. Any exception raised is ignored and the slot
+          #   reservation attempt fails (i.e. same as if this method returned nil).
+          #
+          # @param context [ReserveContext] Contextual information about this reserve call.
+          # @return [Object, nil] A non-nil object to perform the reservation successfully, a nil to fail the
+          #   reservation.
+          def try_reserve_slot(context)
+            raise NotImplementedError
+          end
+
+          # Mark a slot as used.
+          #
+          # Due to the nature of Temporal polling, slots are reserved before they are used and may never get used. This
+          # call is made as just a notification when a slot is actually used.
+          #
+          # @note WARNING: This should never block, this should return immediately.
+          #
+          # @note WARNING: This call should never raise an exception. Any exception raised is ignored.
+          #
+          # @param context [MarkUsedContext] Contextual information about this reserve call.
+          def mark_slot_used(context)
+            raise NotImplementedError
+          end
+
+          # Release a previously reserved slot.
+          #
+          # @note WARNING: This should never block, this should return immediately.
+          #
+          # @note WARNING: This call should never raise an exception. Any exception raised is ignored.
+          #
+          # @param context [ReleaseContext] Contextual information about this reserve call.
+          def release_slot(context)
+            raise NotImplementedError
+          end
+
+          # @!visibility private
+          def _to_bridge_options(tuner)
+            Internal::Bridge::Worker::TunerSlotSupplierOptions.new(
+              fixed_size: nil,
+              resource_based: nil,
+              custom: Internal::Bridge::Worker::CustomSlotSupplier.new(
+                slot_supplier: self,
+                thread_pool: tuner.custom_slot_supplier_thread_pool
               )
             )
           end
+
+          # Slot information.
+          module SlotInfo
+            # Information about a workflow slot.
+            #
+            # @!attribute workflow_type
+            #   @return [String] Workflow type.
+            # @!attribute sticky?
+            #   @return [Boolean] Whether the slot was for a sticky task.
+            Workflow = Data.define(:workflow_type, :sticky?)
+
+            # Information about an activity slot.
+            #
+            # @!attribute activity_type
+            #   @return [String] Activity type.
+            Activity = Data.define(:activity_type)
+
+            # Information about a local activity slot.
+            #
+            # @!attribute activity_type
+            #   @return [String] Activity type.
+            LocalActivity = Data.define(:activity_type)
+
+            # Information about a Nexus slot.
+            #
+            # @!attribute service
+            #   @return [String] Nexus service.
+            # @!attribute operation
+            #   @return [String] Nexus operation.
+            Nexus = Data.define(:service, :operation)
+          end
         end
 
         # @!visibility private
-        def _to_bridge_options
-          raise ArgumentError, 'Tuner slot suppliers must be instances of Fixed or ResourceBased'
+        def _to_bridge_options(_tuner)
+          raise ArgumentError, 'Tuner slot suppliers must be instances of Fixed, ResourceBased, or Custom'
         end
       end
 
@@ -75,10 +237,9 @@ module Temporalio
       # @!attribute target_cpu_usage
       #   @return [Float] A value between 0 and 1 that represents the target (system) CPU usage. This can be set to 1.0
       #     if desired, but it's recommended to leave some headroom for other processes.
-      ResourceBasedTunerOptions = Struct.new(
+      ResourceBasedTunerOptions = Data.define(
         :target_memory_usage,
-        :target_cpu_usage,
-        keyword_init: true
+        :target_cpu_usage
       )
 
       # Options for a specific slot type being used with {SlotSupplier::ResourceBased}.
@@ -94,11 +255,10 @@ module Temporalio
       #
       #     This value matters because how many resources a task will use cannot be determined ahead of time, and thus
       #     the system should wait to see how much resources are used before issuing more slots.
-      ResourceBasedSlotOptions = Struct.new(
+      ResourceBasedSlotOptions = Data.define(
         :min_slots,
         :max_slots,
-        :ramp_throttle,
-        keyword_init: true
+        :ramp_throttle
       )
 
       # Create a fixed-size tuner with the provided number of slots.
@@ -161,27 +321,36 @@ module Temporalio
       # @return [SlotSupplier] Slot supplier for local activities.
       attr_reader :local_activity_slot_supplier
 
+      # @return [ThreadPool, nil] Thread pool for custom slot suppliers.
+      attr_reader :custom_slot_supplier_thread_pool
+
       # Create a tuner from 3 slot suppliers.
       #
       # @param workflow_slot_supplier [SlotSupplier] Slot supplier for workflows.
       # @param activity_slot_supplier [SlotSupplier] Slot supplier for activities.
       # @param local_activity_slot_supplier [SlotSupplier] Slot supplier for local activities.
+      # @param custom_slot_supplier_thread_pool [ThreadPool, nil] Thread pool to make all custom slot supplier calls on.
+      #   If there are no custom slot suppliers, this parameter is ignored. Technically users may set this to nil which
+      #   will not use a thread pool to make slot supplier calls, but that is dangerous and not advised because even the
+      #   slightest blocking call can slow down the system.
       def initialize(
         workflow_slot_supplier:,
         activity_slot_supplier:,
-        local_activity_slot_supplier:
+        local_activity_slot_supplier:,
+        custom_slot_supplier_thread_pool: ThreadPool.default
       )
         @workflow_slot_supplier = workflow_slot_supplier
         @activity_slot_supplier = activity_slot_supplier
         @local_activity_slot_supplier = local_activity_slot_supplier
+        @custom_slot_supplier_thread_pool = custom_slot_supplier_thread_pool
       end
 
       # @!visibility private
       def _to_bridge_options
         Internal::Bridge::Worker::TunerOptions.new(
-          workflow_slot_supplier: workflow_slot_supplier._to_bridge_options,
-          activity_slot_supplier: activity_slot_supplier._to_bridge_options,
-          local_activity_slot_supplier: local_activity_slot_supplier._to_bridge_options
+          workflow_slot_supplier: workflow_slot_supplier._to_bridge_options(self),
+          activity_slot_supplier: activity_slot_supplier._to_bridge_options(self),
+          local_activity_slot_supplier: local_activity_slot_supplier._to_bridge_options(self)
         )
       end
     end

data/lib/temporalio/workflow/info.rb

@@ -7,6 +7,7 @@ module Temporalio
       :continued_run_id,
       :cron_schedule,
       :execution_timeout,
+      :first_execution_run_id,
       :headers,
       :last_failure,
       :last_result,
@@ -35,6 +36,8 @@ module Temporalio
     #   @return [String, nil] Cron schedule if applicable.
     # @!attribute execution_timeout
     #   @return [Float, nil] Execution timeout for the workflow.
+    # @!attribute first_execution_run_id
+    #   @return [String] The very first run ID the workflow ever had, following continuation chains.
     # @!attribute headers
     #   @return [Hash<String, Api::Common::V1::Payload>] Headers.
     # @!attribute last_failure

data/lib/temporalio/workflow.rb

@@ -208,14 +208,16 @@ module Temporalio
     #
     # @param activity [Class<Activity::Definition>, Symbol, String] Activity definition class or name.
     # @param args [Array<Object>] Arguments to the activity.
+    # @param summary [String, nil] Single-line summary for this activity that may appear in CLI/UI. This can be in
+    #   single-line Temporal markdown format. This is currently experimental.
     # @param schedule_to_close_timeout [Float, nil] Max amount of time the activity can take from first being scheduled
     #   to being completed before it times out. This is inclusive of all retries.
     # @param schedule_to_start_timeout [Float, nil] Max amount of time the activity can take to be started from first
     #   being scheduled.
     # @param start_to_close_timeout [Float, nil] Max amount of time a single activity run can take from when it starts
     #   to when it completes. This is per retry.
-    # @param retry_policy [RetryPolicy] How an activity is retried on failure. If unset, a server-defined default is
-    #   used. Set maximum attempts to 1 to disable retries.
+    # @param retry_policy [RetryPolicy, nil] How an activity is retried on failure. If unset, a default policy is used.
+    #   Set maximum attempts to 1 to disable retries.
     # @param local_retry_threshold [Float, nil] If the activity is retrying and backoff would exceed this value, a timer
     #   is scheduled and the activity is retried after. Otherwise, backoff will happen internally within the task.
     #   Defaults to 1 minute.
@@ -238,6 +240,7 @@ module Temporalio
     def self.execute_local_activity(
       activity,
       *args,
+      summary: nil,
       schedule_to_close_timeout: nil,
       schedule_to_start_timeout: nil,
       start_to_close_timeout: nil,
@@ -251,7 +254,7 @@ module Temporalio
     )
       _current.execute_local_activity(
         activity, *args,
-        schedule_to_close_timeout:, schedule_to_start_timeout:, start_to_close_timeout:,
+        summary:, schedule_to_close_timeout:, schedule_to_start_timeout:, start_to_close_timeout:,
         retry_policy:, local_retry_threshold:, cancellation:, cancellation_type:,
         activity_id:, arg_hints:, result_hint:
       )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temporalio
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Temporal Technologies Inc
@@ -160,6 +160,7 @@ files:
 - lib/temporalio/converters/payload_converter/json_plain.rb
 - lib/temporalio/converters/payload_converter/json_protobuf.rb
 - lib/temporalio/converters/raw_value.rb
+- lib/temporalio/env_config.rb
 - lib/temporalio/error.rb
 - lib/temporalio/error/failure.rb
 - lib/temporalio/internal.rb