Add default setting tests

Author: Sushisource

temporalio/lib/temporalio/internal/worker/workflow_worker.rb

@@ -13,7 +13,7 @@ module Internal
     module Worker
       # Worker for handling workflow activations. Most activation work is delegated to the workflow executor.
       class WorkflowWorker
-        def self.workflow_definitions(workflows)
+        def self.workflow_definitions(workflows, should_enforce_versioning_behavior: false)
           workflows.each_with_object({}) do |workflow, hash|
             # Load definition
             defn = begin
@@ -29,6 +29,12 @@ def self.workflow_definitions(workflows)
             # Confirm name not in use
             raise ArgumentError, "Multiple workflows named #{defn.name || '<dynamic>'}" if hash.key?(defn.name)
 
+            # Enforce versioning behavior is set when versioning is on
+            if should_enforce_versioning_behavior &&
+               defn.versioning_behavior == VersioningBehavior::UNSPECIFIED && defn.dynamic_options_method.nil?
+              raise ArgumentError, "Workflow #{defn.name} must specify a versioning behavior"
+            end
+
             hash[defn.name] = defn
           end
         end

temporalio/lib/temporalio/worker.rb

@@ -429,8 +429,15 @@ def initialize(
         debug_mode:
       ).freeze
 
+      should_enforce_versioning_behavior =
+        !deployment_options.nil? &&
+        deployment_options.use_worker_versioning &&
+        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)
+      workflow_definitions = Internal::Worker::WorkflowWorker.workflow_definitions(
+        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:

temporalio/lib/temporalio/workflow/definition.rb

@@ -431,7 +431,7 @@ def self._build_workflow_definition
           signals:,
           queries:,
           updates:,
-          versioning_behavior: @versioning_behavior,
+          versioning_behavior: @versioning_behavior || VersioningBehavior::UNSPECIFIED,
           dynamic_options_method: @dynamic_options_method
         )
       end

temporalio/test/worker_workflow_test.rb

@@ -2634,6 +2634,87 @@ def _test_worker_deployment_dynamic_workflow(workflow_class, expected_versioning
     end
   end
 
+  class NoVersioningAnnotationWorkflow < Temporalio::Workflow::Definition
+    def execute
+      'whee'
+    end
+  end
+
+  class NoVersioningAnnotationDynamicWorkflow < Temporalio::Workflow::Definition
+    workflow_dynamic
+
+    def execute(*_raw_args)
+      'whee'
+    end
+  end
+
+  def test_workflows_must_have_versioning_behavior_when_feature_turned_on
+    error = assert_raises(ArgumentError) do
+      Temporalio::Worker.new(
+        client: env.client,
+        task_queue: 'whatever',
+        workflows: [NoVersioningAnnotationWorkflow],
+        deployment_options: Temporalio::Worker::DeploymentOptions.new(
+          version: Temporalio::WorkerDeploymentVersion.new('whatever', '1.0'),
+          use_worker_versioning: true
+        )
+      )
+    end
+    assert_includes error.message, 'must specify a versioning behavior'
+
+    print "?huh"
+    error = assert_raises(ArgumentError) do
+      Temporalio::Worker.new(
+        client: env.client,
+        task_queue: 'whatever',
+        workflows: [NoVersioningAnnotationDynamicWorkflow],
+        deployment_options: Temporalio::Worker::DeploymentOptions.new(
+          version: Temporalio::WorkerDeploymentVersion.new('whatever', '1.0'),
+          use_worker_versioning: true
+        )
+      )
+    end
+    assert_includes error.message, 'must specify a versioning behavior'
+  end
+
+  def test_workflows_can_use_default_versioning_behavior
+    deployment_name = "deployment-default-versioning-#{SecureRandom.uuid}"
+    worker_v1 = Temporalio::WorkerDeploymentVersion.new(deployment_name, '1.0')
+
+    worker = Temporalio::Worker.new(
+      client: env.client,
+      task_queue: "tq-#{SecureRandom.uuid}",
+      workflows: [NoVersioningAnnotationWorkflow],
+      deployment_options: Temporalio::Worker::DeploymentOptions.new(
+        version: worker_v1,
+        use_worker_versioning: true,
+        default_versioning_behavior: Temporalio::VersioningBehavior::PINNED
+      )
+    )
+
+    worker.run do
+      describe_resp = wait_until_worker_deployment_visible(env.client, worker_v1)
+      set_current_deployment_version(env.client, describe_resp.conflict_token, worker_v1)
+
+      handle = env.client.start_workflow(
+        NoVersioningAnnotationWorkflow,
+        id: "default-versioning-behavior-#{SecureRandom.uuid}",
+        task_queue: worker.task_queue
+      )
+      handle.result
+
+      events = handle.fetch_history.events
+      has_expected_behavior = events.any? do |event|
+        event.workflow_task_completed_event_attributes &&
+          event.workflow_task_completed_event_attributes.versioning_behavior ==
+            Temporalio::Api::Enums::V1::VersioningBehavior.lookup(
+              Temporalio::Api::Enums::V1::VersioningBehavior::VERSIONING_BEHAVIOR_PINNED.to_i
+            )
+      end
+      assert has_expected_behavior, 'Expected versioning behavior PINNED not found in history'
+    end
+  end
+
   def wait_until_worker_deployment_visible(client, version)
     assert_eventually do
       res = client.workflow_service.describe_worker_deployment(

temporalio/test/workflow/definition_test.rb

@@ -63,6 +63,7 @@ def my_base_signal3; end
 
     class ValidWorkflowAdvanced1 < ValidWorkflowAdvancedBase
       workflow_name 'custom-workflow-name'
+      workflow_versioning_behavior Temporalio::VersioningBehavior::PINNED
       workflow_raw_args
 
       workflow_init
@@ -99,6 +100,13 @@ def my_new_signal; end
 
       workflow_update name: 'custom-update-name'
       def another_update; end
+
+      workflow_dynamic_options
+      def myopts
+        Temporalio::Workflow::DefinitionOptions.new(
+          versioning_behavior: Temporalio::VersioningBehavior::AUTO_UPGRADE
+        )
+      end
     end
 
     def test_valid_advanced
@@ -122,6 +130,7 @@ def test_valid_advanced
                    defn.updates['custom-update-name'].unfinished_policy
       assert_equal :another_update_validator, defn.updates['custom-update-name'].validator_to_invoke
       assert_equal 'custom-update-name', ValidWorkflowAdvanced1.another_update.name
+      assert_equal Temporalio::VersioningBehavior::PINNED, defn.versioning_behavior
 
       defn = Temporalio::Workflow::Definition::Info.from_class(ValidWorkflowAdvanced2)
 
@@ -136,6 +145,7 @@ def test_valid_advanced
       assert_equal :my_renamed_signal, defn.signals['custom-signal-name-2'].to_invoke
       assert_equal :my_base_signal3, defn.signals['my_base_signal3'].to_invoke
       assert_equal :my_new_signal, defn.signals['my_new_signal'].to_invoke
+      assert defn.dynamic_options_method
     end
 
     def assert_invalid_workflow_code(message_contains, code_to_eval)