temporalio 0.0.1 → 0.0.2

data/lib/gen/temporal/api/workflowservice/v1/request_response_pb.rb

@@ -14,6 +14,7 @@ require 'temporal/api/enums/v1/task_queue_pb'
 require 'temporal/api/enums/v1/update_pb'
 require 'temporal/api/common/v1/message_pb'
 require 'temporal/api/history/v1/message_pb'
+require 'temporal/api/interaction/v1/message_pb'
 require 'temporal/api/workflow/v1/message_pb'
 require 'temporal/api/command/v1/message_pb'
 require 'temporal/api/failure/v1/message_pb'
@@ -23,7 +24,6 @@ require 'temporal/api/query/v1/message_pb'
 require 'temporal/api/replication/v1/message_pb'
 require 'temporal/api/schedule/v1/message_pb'
 require 'temporal/api/taskqueue/v1/message_pb'
-require 'temporal/api/update/v1/message_pb'
 require 'temporal/api/version/v1/message_pb'
 require 'temporal/api/batch/v1/message_pb'
 require 'google/protobuf/duration_pb'
@@ -143,7 +143,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :task_queue, :message, 2, "temporal.api.taskqueue.v1.TaskQueue"
       optional :identity, :string, 3
       optional :binary_checksum, :string, 4
-      optional :worker_versioning_build_id, :string, 5
+      optional :worker_versioning_id, :message, 5, "temporal.api.taskqueue.v1.VersionId"
     end
     add_message "temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse" do
       optional :task_token, :bytes, 1
@@ -160,6 +160,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :scheduled_time, :message, 12, "google.protobuf.Timestamp"
       optional :started_time, :message, 13, "google.protobuf.Timestamp"
       map :queries, :string, :message, 14, "temporal.api.query.v1.WorkflowQuery"
+      repeated :interactions, :message, 15, "temporal.api.interaction.v1.Invocation"
     end
     add_message "temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest" do
       optional :task_token, :bytes, 1
@@ -171,10 +172,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :binary_checksum, :string, 7
       map :query_results, :string, :message, 8, "temporal.api.query.v1.WorkflowQueryResult"
       optional :namespace, :string, 9
+      optional :worker_versioning_id, :message, 10, "temporal.api.taskqueue.v1.VersionId"
     end
     add_message "temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedResponse" do
       optional :workflow_task, :message, 1, "temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse"
       repeated :activity_tasks, :message, 2, "temporal.api.workflowservice.v1.PollActivityTaskQueueResponse"
+      optional :reset_history_event_id, :int64, 3
     end
     add_message "temporal.api.workflowservice.v1.RespondWorkflowTaskFailedRequest" do
       optional :task_token, :bytes, 1
@@ -191,7 +194,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :task_queue, :message, 2, "temporal.api.taskqueue.v1.TaskQueue"
       optional :identity, :string, 3
       optional :task_queue_metadata, :message, 4, "temporal.api.taskqueue.v1.TaskQueueMetadata"
-      optional :worker_versioning_build_id, :string, 5
+      optional :worker_versioning_id, :message, 5, "temporal.api.taskqueue.v1.VersionId"
     end
     add_message "temporal.api.workflowservice.v1.PollActivityTaskQueueResponse" do
       optional :task_token, :bytes, 1
@@ -357,6 +360,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "temporal.api.workflowservice.v1.TerminateWorkflowExecutionResponse" do
     end
+    add_message "temporal.api.workflowservice.v1.DeleteWorkflowExecutionRequest" do
+      optional :namespace, :string, 1
+      optional :workflow_execution, :message, 2, "temporal.api.common.v1.WorkflowExecution"
+    end
+    add_message "temporal.api.workflowservice.v1.DeleteWorkflowExecutionResponse" do
+    end
     add_message "temporal.api.workflowservice.v1.ListOpenWorkflowExecutionsRequest" do
       optional :namespace, :string, 1
       optional :maximum_page_size, :int32, 2
@@ -498,6 +507,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :activity_failure_include_heartbeat, :bool, 3
       optional :supports_schedules, :bool, 4
       optional :encoded_failure_attributes, :bool, 5
+      optional :build_id_based_versioning, :bool, 6
+      optional :upsert_memo, :bool, 7
     end
     add_message "temporal.api.workflowservice.v1.ListTaskQueuePartitionsRequest" do
       optional :namespace, :string, 1
@@ -599,30 +610,32 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :namespace, :string, 3
       optional :workflow_execution, :message, 4, "temporal.api.common.v1.WorkflowExecution"
       optional :first_execution_run_id, :string, 5
-      optional :update, :message, 6, "temporal.api.update.v1.WorkflowUpdate"
+      optional :identity, :string, 6
+      optional :input, :message, 7, "temporal.api.interaction.v1.Input"
     end
     add_message "temporal.api.workflowservice.v1.UpdateWorkflowResponse" do
       optional :update_token, :bytes, 1
-      oneof :result do
-        optional :success, :message, 2, "temporal.api.common.v1.Payloads"
-        optional :failure, :message, 3, "temporal.api.failure.v1.Failure"
-      end
+      optional :output, :message, 2, "temporal.api.interaction.v1.Output"
     end
     add_message "temporal.api.workflowservice.v1.StartBatchOperationRequest" do
       optional :namespace, :string, 1
       optional :visibility_query, :string, 2
+      optional :job_id, :string, 3
+      optional :reason, :string, 4
       oneof :operation do
         optional :termination_operation, :message, 10, "temporal.api.batch.v1.BatchOperationTermination"
         optional :signal_operation, :message, 11, "temporal.api.batch.v1.BatchOperationSignal"
         optional :cancellation_operation, :message, 12, "temporal.api.batch.v1.BatchOperationCancellation"
+        optional :deletion_operation, :message, 13, "temporal.api.batch.v1.BatchOperationDeletion"
       end
     end
     add_message "temporal.api.workflowservice.v1.StartBatchOperationResponse" do
-      optional :job_id, :string, 1
     end
     add_message "temporal.api.workflowservice.v1.StopBatchOperationRequest" do
       optional :namespace, :string, 1
       optional :job_id, :string, 2
+      optional :reason, :string, 3
+      optional :identity, :string, 4
     end
     add_message "temporal.api.workflowservice.v1.StopBatchOperationResponse" do
     end
@@ -639,6 +652,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :total_operation_count, :int64, 6
       optional :complete_operation_count, :int64, 7
       optional :failure_operation_count, :int64, 8
+      optional :identity, :string, 9
+      optional :reason, :string, 10
     end
     add_message "temporal.api.workflowservice.v1.ListBatchOperationsRequest" do
       optional :namespace, :string, 1
@@ -652,7 +667,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
 end
 
-module Temporal
+module Temporalio
   module Api
     module WorkflowService
       module V1
@@ -706,6 +721,8 @@ module Temporal
         ResetWorkflowExecutionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.workflowservice.v1.ResetWorkflowExecutionResponse").msgclass
         TerminateWorkflowExecutionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.workflowservice.v1.TerminateWorkflowExecutionRequest").msgclass
         TerminateWorkflowExecutionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.workflowservice.v1.TerminateWorkflowExecutionResponse").msgclass
+        DeleteWorkflowExecutionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.workflowservice.v1.DeleteWorkflowExecutionRequest").msgclass
+        DeleteWorkflowExecutionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.workflowservice.v1.DeleteWorkflowExecutionResponse").msgclass
         ListOpenWorkflowExecutionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.workflowservice.v1.ListOpenWorkflowExecutionsRequest").msgclass
         ListOpenWorkflowExecutionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.workflowservice.v1.ListOpenWorkflowExecutionsResponse").msgclass
         ListClosedWorkflowExecutionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("temporal.api.workflowservice.v1.ListClosedWorkflowExecutionsRequest").msgclass

data/lib/gen/temporal/api/workflowservice/v1/service_pb.rb

@@ -10,7 +10,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
 end
 
-module Temporal
+module Temporalio
   module Api
     module WorkflowService
       module V1

data/lib/gen/temporal/sdk/core/workflow_activation/workflow_activation_pb.rb

@@ -61,6 +61,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :cron_schedule_to_schedule_interval, :message, 20, "google.protobuf.Duration"
       optional :memo, :message, 21, "temporal.api.common.v1.Memo"
       optional :search_attributes, :message, 22, "temporal.api.common.v1.SearchAttributes"
+      optional :start_time, :message, 23, "google.protobuf.Timestamp"
     end
     add_message "coresdk.workflow_activation.FireTimer" do
       optional :seq, :uint32, 1

data/lib/gen/temporal/sdk/core/workflow_commands/workflow_commands_pb.rb

@@ -33,6 +33,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
         optional :schedule_local_activity, :message, 16, "coresdk.workflow_commands.ScheduleLocalActivity"
         optional :request_cancel_local_activity, :message, 17, "coresdk.workflow_commands.RequestCancelLocalActivity"
         optional :upsert_workflow_search_attributes, :message, 18, "coresdk.workflow_commands.UpsertWorkflowSearchAttributes"
+        optional :modify_workflow_properties, :message, 19, "coresdk.workflow_commands.ModifyWorkflowProperties"
       end
     end
     add_message "coresdk.workflow_commands.StartTimer" do
@@ -46,7 +47,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :seq, :uint32, 1
       optional :activity_id, :string, 2
       optional :activity_type, :string, 3
-      optional :namespace, :string, 4
       optional :task_queue, :string, 5
       map :headers, :string, :message, 6, "temporal.api.common.v1.Payload"
       repeated :arguments, :message, 7, "temporal.api.common.v1.Payload"
@@ -157,6 +157,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "coresdk.workflow_commands.UpsertWorkflowSearchAttributes" do
       map :search_attributes, :string, :message, 1, "temporal.api.common.v1.Payload"
     end
+    add_message "coresdk.workflow_commands.ModifyWorkflowProperties" do
+      optional :upserted_memo, :message, 1, "temporal.api.common.v1.Memo"
+    end
     add_enum "coresdk.workflow_commands.ActivityCancellationType" do
       value :TRY_CANCEL, 0
       value :WAIT_CANCELLATION_COMPLETED, 1
@@ -187,6 +190,7 @@ module Coresdk
     SignalExternalWorkflowExecution = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("coresdk.workflow_commands.SignalExternalWorkflowExecution").msgclass
     CancelSignalWorkflow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("coresdk.workflow_commands.CancelSignalWorkflow").msgclass
     UpsertWorkflowSearchAttributes = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("coresdk.workflow_commands.UpsertWorkflowSearchAttributes").msgclass
+    ModifyWorkflowProperties = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("coresdk.workflow_commands.ModifyWorkflowProperties").msgclass
     ActivityCancellationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("coresdk.workflow_commands.ActivityCancellationType").enummodule
   end
 end

data/lib/temporalio/activity/context.rb

@@ -0,0 +1,97 @@
+require 'temporalio/error/failure'
+require 'temporalio/errors'
+
+module Temporalio
+  class Activity
+    # This class provides methods that can be called from activity classes.
+    class Context
+      # Information about the running activity.
+      #
+      # @return [Temporalio::Activity::Info]
+      attr_reader :info
+
+      # @api private
+      def initialize(info, heartbeat_proc, shielded: false)
+        @thread = Thread.current
+        @info = info
+        @heartbeat_proc = heartbeat_proc
+        @pending_cancellation = nil
+        @shielded = shielded
+        @mutex = Mutex.new
+      end
+
+      # Send a heartbeat for the current activity.
+      #
+      # @param details [Array<any>] Data to store with the heartbeat.
+      def heartbeat(*details)
+        heartbeat_proc.call(*details)
+      end
+
+      # Protect a part of activity's implementation from cancellations.
+      #
+      # Activity cancellations are implemented using the `Thread#raise`, which can unsafely
+      # terminate your implementation. To disable this behaviour make sure to wrap critical parts of
+      # your business logic in this method.
+      #
+      # For shielding a whole activity consider using {Temporalio::Activity.shielded!}.
+      #
+      # A cancellation that got requested while in a shielded block will not interrupt the execution
+      # and will raise a {Temporalio::Error::CancelledError} right after the block has finished.
+      #
+      # @yield Block to be protected from cancellations.
+      def shield(&block)
+        # The whole activity is shielded, called from a nested shield
+        #   or while handling a CancelledError (in a rescue or ensure blocks)
+        return block.call if @shielded || cancelled?
+
+        if Thread.current != thread
+          # TODO: Use logger instead when implemented
+          warn "Activity shielding is not intended to be used outside of activity's thread."
+          return block.call
+        end
+
+        mutex.synchronize do
+          @shielded = true
+          result = block.call
+          # RBS: StandardError fallback is only needed to satisfy steep - https://github.com/soutaro/steep/issues/477
+          raise @pending_cancellation || StandardError if cancelled?
+
+          result
+        ensure # runs while still holding the lock
+          @shielded = false
+        end
+      end
+
+      # Whether a cancellation was ever requested on this activity.
+      #
+      # @return [Boolean] true if the activity has had a cancellation request, false otherwise.
+      def cancelled?
+        !!@pending_cancellation
+      end
+
+      # Cancel the running activity by raising a provided error.
+      #
+      # @param reason [String] Reason for cancellation.
+      # @param by_request [Boolean] Cancellation requested by the server or not.
+      #
+      # @api private
+      def cancel(reason, by_request: false)
+        error = Temporalio::Error::ActivityCancelled.new(reason, by_request)
+        @pending_cancellation = error
+
+        locked = mutex.try_lock
+        # @shielded inside the lock means the whole activity is shielded
+        if locked && !@shielded
+          thread.raise(error)
+        end
+      ensure
+        # only release the lock if we locked it
+        mutex.unlock if locked
+      end
+
+      private
+
+      attr_reader :thread, :heartbeat_proc, :mutex
+    end
+  end
+end

data/lib/temporalio/activity/info.rb

@@ -0,0 +1,67 @@
+module Temporalio
+  class Activity
+    # Class containing information about an activity.
+    class Info < Struct.new(
+      :activity_id,
+      :activity_type,
+      :attempt,
+      :current_attempt_scheduled_time,
+      :heartbeat_details,
+      :heartbeat_timeout,
+      :local,
+      :schedule_to_close_timeout,
+      :scheduled_time,
+      :start_to_close_timeout,
+      :started_time,
+      :task_queue,
+      :task_token,
+      :workflow_id,
+      :workflow_namespace,
+      :workflow_run_id,
+      :workflow_type,
+      keyword_init: true,
+    )
+      # @!attribute [r] activity_id
+      #   @return [String] Activity ID.
+      # @!attribute [r] activity_type
+      #   @return [String] Name of the activity.
+      # @!attribute [r] attempt
+      #   @return [Integer] Activity's execution attempt.
+      # @!attribute [r] current_attempt_scheduled_time
+      #   @return [Time] Scheduled time of the current attempt.
+      # @!attribute [r] heartbeat_details
+      #   @return [Array<any>] Details submitted with the last heartbeat.
+      # @!attribute [r] heartbeat_timeout
+      #   @return [Float] Max time between heartbeats (in seconds).
+      # @!attribute [r] local
+      #   @return [Boolean] Whether activity is local or not.
+      # @!attribute [r] schedule_to_close_timeout
+      #   @return [Float] Max overall activity execution time (in seconds).
+      # @!attribute [r] scheduled_time
+      #   @return [Time] Time when activity was first scheduled.
+      # @!attribute [r] start_to_close_timeout
+      #   @return [Floaat] Max time of a single invocation (in seconds).
+      # @!attribute [r] started_time
+      #   @return [Time] Time when activity was started.
+      # @!attribute [r] task_queue
+      #   @return [String] Task queue on which the activity got scheduled.
+      # @!attribute [r] task_token
+      #   @return [String] A token for completing the activity.
+      # @!attribute [r] workflow_id
+      #   @return [String] Workflow ID.
+      # @!attribute [r] workflow_namespace
+      #   @return [String] Workflow namespace.
+      # @!attribute [r] workflow_run_id
+      #   @return [String] Workflow run ID.
+      # @!attribute [r] workflow_type
+      #   @return [String] Name of the workflow.
+
+      # Whether activity is local or not
+      #
+      # @return [Boolean] True for local activities, falst otherwise.
+      def local?
+        local
+      end
+    end
+  end
+end

data/lib/temporalio/activity.rb

@@ -0,0 +1,85 @@
+module Temporalio
+  # This is an abstract superclass for implementing activities.
+  #
+  # Temporal SDK users are expected to subclass it and implement the {#execute} method by adding
+  # their desired business logic.
+  #
+  # @abstract
+  #
+  # @example "Hello World" Activity
+  #   class HelloWorld < Temporalio::Activity
+  #     def execute(name)
+  #       "Hello, #{name}!"
+  #     end
+  #   end
+  class Activity
+    # Specify a custom name to be used for this activity.
+    #
+    # By default a full class (with any namespace modules/classes) name will be used.
+    #
+    # @param new_name [String] Name to be used for this activity
+    #
+    # @example
+    #   class Test < Temporalio::Activity
+    #     activity_name 'custom-activity-name'
+    #
+    #     def execute
+    #       ...
+    #     end
+    #   end
+    def self.activity_name(new_name)
+      @activity_name = new_name
+    end
+
+    # Mark the activity as shielded from cancellations.
+    #
+    # Activity cancellations are implemented using the `Thread#raise`, which can unsafely terminate
+    # your implementation. To disable this behaviour make sure to mark critical activities as
+    # `shielded!`. For shielding a part of your activity consider using
+    # {Temporalio::Activity::Context#shield}.
+    #
+    # @example
+    #   class Test < Temporalio::Activity
+    #     shielded!
+    #
+    #     def execute
+    #       ...
+    #     end
+    #   end
+    def self.shielded!
+      @shielded = true
+    end
+
+    # @api private
+    def self._name
+      @activity_name || name || ''
+    end
+
+    # @api private
+    def self._shielded
+      @shielded || false
+    end
+
+    # @api private
+    def initialize(context)
+      @context = context
+    end
+
+    # This is the main body of your activity's implementation.
+    #
+    # When implementing this method, you can use as many positional arguments as needed, which will
+    # get converted based on the activity invocation in your workflow.
+    #
+    # Inside of this method you have access to activity's context using the `activity` method. Check
+    # out {Temporalio::Activity::Context} for more information on how to use it.
+    def execute(*_args)
+      raise NoMethodError, 'must implement #execute'
+    end
+
+    private
+
+    def activity
+      @context
+    end
+  end
+end

data/lib/temporalio/bridge/error.rb

@@ -0,0 +1,8 @@
+module Temporalio
+  module Bridge
+    # @api private
+    class Error < StandardError
+      class WorkerShutdown < Error; end
+    end
+  end
+end

data/lib/temporalio/bridge.rb

@@ -0,0 +1,14 @@
+require 'rutie'
+require 'temporalio/bridge/error'
+
+# RBS: for some reason __dir__ has a type of (String | nil)
+BRIDGE_DIR = File.expand_path('..', __dir__ || '.')
+
+module Temporalio
+  # @api private
+  module Bridge
+    Rutie
+      .new(:bridge, lib_path: '', lib_suffix: 'so', lib_prefix: '')
+      .init('init_bridge', BRIDGE_DIR)
+  end
+end