Add versioning override

Author: Sushisource

temporalio/lib/temporalio.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'temporalio/version'
+require 'temporalio/versioning_override'
 
 # Temporal Ruby SDK. See the README at https://github.com/temporalio/sdk-ruby.
 module Temporalio

temporalio/lib/temporalio/client.rb

@@ -22,6 +22,7 @@
 require 'temporalio/retry_policy'
 require 'temporalio/runtime'
 require 'temporalio/search_attributes'
+require 'temporalio/versioning_override'
 require 'temporalio/workflow/definition'
 
 module Temporalio
@@ -239,6 +240,7 @@ def start_workflow(
       search_attributes: nil,
       start_delay: nil,
       request_eager_start: false,
+      versioning_override: nil,
       rpc_options: nil
     )
       @impl.start_workflow(Interceptor::StartWorkflowInput.new(
@@ -260,6 +262,7 @@ def start_workflow(
                              start_delay:,
                              request_eager_start:,
                              headers: {},
+                             versioning_override:,
                              rpc_options:
                            ))
     end
@@ -316,9 +319,11 @@ def execute_workflow(
       search_attributes: nil,
       start_delay: nil,
       request_eager_start: false,
+      versioning_override: nil,
+      follow_runs: true,
       rpc_options: nil
     )
-      start_workflow(
+      handle = start_workflow(
         workflow,
         *args,
         id:,
@@ -336,8 +341,10 @@ def execute_workflow(
         search_attributes:,
         start_delay:,
         request_eager_start:,
+        versioning_override:,
         rpc_options:
-      ).result
+      )
+      follow_runs ? handle.result : handle
     end
 
     # Get a workflow handle to an existing workflow by its ID.

temporalio/lib/temporalio/client/interceptor.rb

@@ -37,6 +37,7 @@ def intercept_client(next_interceptor)
         :start_delay,
         :request_eager_start,
         :headers,
+        :versioning_override,
         :rpc_options
       )
 

temporalio/lib/temporalio/internal/client/implementation.rb

@@ -69,7 +69,8 @@ def start_workflow(input)
             user_metadata: ProtoUtils.to_user_metadata(
               input.static_summary, input.static_details, @client.data_converter
             ),
-            header: ProtoUtils.headers_to_proto(input.headers, @client.data_converter)
+            header: ProtoUtils.headers_to_proto(input.headers, @client.data_converter),
+            versioning_override: input.versioning_override&._to_proto
           )
 
           # Send request

temporalio/lib/temporalio/versioning_override.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'temporalio/worker_deployment_version'
+
+module Temporalio
+  # Base class for version overrides that can be provided in start workflow options.
+  # Used to control the versioning behavior of workflows started with this override.
+  #
+  # Use factory methods {.auto_upgrade} or {.pinned} to create instances.
+  #
+  # WARNING: Experimental API.
+  class VersioningOverride
+    # Creates an auto-upgrade versioning override
+    # The workflow will auto-upgrade to the current deployment version on the next workflow task.
+    #
+    # @return [AutoUpgradeVersioningOverride] An auto-upgrade versioning override
+    def self.auto_upgrade
+      AutoUpgradeVersioningOverride.new
+    end
+
+    # Creates a pinned versioning override
+    # The workflow will be pinned to a specific deployment version.
+    #
+    # @param version [WorkerDeploymentVersion] The worker deployment version to pin the workflow to
+    # @return [PinnedVersioningOverride] A pinned versioning override
+    def self.pinned(version)
+      PinnedVersioningOverride.new(version)
+    end
+
+    # @!visibility private
+    def _to_proto
+      raise NotImplementedError, 'Subclasses must implement this method'
+    end
+  end
+
+  # Represents a versioning override to pin a workflow to a specific version
+  class PinnedVersioningOverride < VersioningOverride
+    # The worker deployment version to pin to
+    # @return [WorkerDeploymentVersion]
+    attr_reader :version
+
+    # Create a new pinned versioning override
+    #
+    # @param version [WorkerDeploymentVersion] The worker deployment version to pin to
+    def initialize(version)
+      @version = version
+      super()
+    end
+
+    # TODO: Remove deprecated field setting once removed from server
+
+    # @!visibility private
+    def _to_proto
+      Temporalio::Api::Workflow::V1::VersioningOverride.new(
+        behavior: Temporalio::Api::Enums::V1::VersioningBehavior::VERSIONING_BEHAVIOR_PINNED,
+        pinned_version: @version.to_canonical_string,
+        pinned: Temporalio::Api::Workflow::V1::VersioningOverride::PinnedOverride.new(
+          version: @version._to_proto
+        )
+      )
+    end
+  end
+
+  # Represents a versioning override to auto-upgrade a workflow
+  class AutoUpgradeVersioningOverride < VersioningOverride
+    # @!visibility private
+    def _to_proto
+      Temporalio::Api::Workflow::V1::VersioningOverride.new(
+        behavior: Temporalio::Api::Enums::V1::VersioningBehavior::VERSIONING_BEHAVIOR_AUTO_UPGRADE,
+        auto_upgrade: true
+      )
+    end
+  end
+end

temporalio/lib/temporalio/worker/workflow_replayer.rb

@@ -217,7 +217,10 @@ def initialize(
               graceful_shutdown_period: 0.0,
               nondeterminism_as_workflow_fail:,
               nondeterminism_as_workflow_fail_for_types:,
-              deployment_options: nil
+              deployment_options: DeploymentOptions.new(
+                version: WorkerDeploymentVersion.new(deployment_name: '',
+                                                     build_id: Worker.default_build_id)
+              )._to_bridge_options
             )
           )
 

temporalio/lib/temporalio/worker_deployment_version.rb

@@ -55,5 +55,13 @@ def _to_bridge_options
         build_id: build_id
       )
     end
+
+    # @!visibility private
+    def _to_proto
+      Api::Deployment::V1::WorkerDeploymentVersion.new(
+        deployment_name: deployment_name,
+        build_id: build_id
+      )
+    end
   end
 end

temporalio/sig/temporalio/client.rbs

@@ -75,6 +75,7 @@ module Temporalio
       ?search_attributes: SearchAttributes?,
       ?start_delay: duration?,
       ?request_eager_start: bool,
+      ?versioning_override: VersioningOverride?,
       ?rpc_options: RPCOptions?
     ) -> WorkflowHandle
 
@@ -96,6 +97,8 @@ module Temporalio
       ?search_attributes: SearchAttributes?,
       ?start_delay: duration?,
       ?request_eager_start: bool,
+      ?versioning_override: VersioningOverride?,
+      ?follow_runs: bool,
       ?rpc_options: RPCOptions?
     ) -> Object?
 

temporalio/sig/temporalio/client/interceptor.rbs

@@ -22,6 +22,7 @@ module Temporalio
         attr_reader start_delay: duration?
         attr_reader request_eager_start: bool
         attr_reader headers: Hash[String, Object?]
+        attr_reader versioning_override: VersioningOverride?
         attr_reader rpc_options: RPCOptions?
 
         def initialize: (
@@ -43,6 +44,7 @@ module Temporalio
           start_delay: duration?,
           request_eager_start: bool,
           headers: Hash[String, Object?],
+          versioning_override: VersioningOverride?,
           rpc_options: RPCOptions?
         ) -> void
       end

temporalio/sig/temporalio/versioning_override.rbs

@@ -0,0 +1,20 @@
+module Temporalio
+  class VersioningOverride
+    def self.auto_upgrade: -> AutoUpgradeVersioningOverride
+    def self.pinned: (WorkerDeploymentVersion version) -> PinnedVersioningOverride
+
+    def _to_proto: -> untyped
+  end
+
+  class PinnedVersioningOverride < VersioningOverride
+    attr_reader version: WorkerDeploymentVersion
+
+    def initialize: (WorkerDeploymentVersion version) -> void
+    def _to_proto: -> untyped
+  end
+
+  class AutoUpgradeVersioningOverride < VersioningOverride
+    def initialize: -> void
+    def _to_proto: -> untyped
+  end
+end