pr feedback

Author: chris-olszewski

patching/README.md

@@ -109,7 +109,7 @@ As expected, this will output "Query result for id deprecated-id: post-patch".
 ## Stage 4
 
 Once we know we don't even have any workflows running on "Stage 2" or before (i.e. the workflow with the patch with both code paths), we can just remove the patch deprecation altogether.
-To use the patch complete workflow, stop the workflow from before and start it again with:
+To use the patch complete workflow, stop the worker from before and start it again with:
 
 ```bash
   bundle exec ruby worker.rb complete
@@ -139,4 +139,3 @@ And if we execute a query against the latest workflow:
 As expected, this will output "Query result for id complete-id: post-patch".
 
 Following these stages, we have successfully altered our workflow code.
-

patching/starter.rb

@@ -13,7 +13,7 @@
 when 'start'
   # Start a workflow with the given id
   client.start_workflow(
-    'MyWorkflow',
+    :MyWorkflow,
     id: workflow_id,
     task_queue: 'patching-sample'
   )

patching/workflow_1_initial.rb

@@ -5,7 +5,7 @@
 
 module Patching
   class MyWorkflow1Initial < Temporalio::Workflow::Definition
-    workflow_name 'MyWorkflow'
+    workflow_name :MyWorkflow
     workflow_query_attr_reader :result
 
     def execute

patching/workflow_2_patched.rb

@@ -5,12 +5,12 @@
 
 module Patching
   class MyWorkflow2Patched < Temporalio::Workflow::Definition
-    workflow_name 'MyWorkflow'
+    workflow_name :MyWorkflow
     workflow_query_attr_reader :result
 
     def execute
       # Decide which activity to use based on workflow's patch status
-      @result = if Temporalio::Workflow.patched :my_patch
+      @result = if Temporalio::Workflow.patched(:my_patch)
                   Temporalio::Workflow.execute_activity(
                     MyActivities::PostPatch,
                     start_to_close_timeout: 5 * 60

patching/workflow_3_deprecated.rb

@@ -5,11 +5,11 @@
 
 module Patching
   class MyWorkflow3Deprecated < Temporalio::Workflow::Definition
-    workflow_name 'MyWorkflow'
+    workflow_name :MyWorkflow
     workflow_query_attr_reader :result
 
     def execute
-      Temporalio::Workflow.deprecate_patch :my_patch
+      Temporalio::Workflow.deprecate_patch(:my_patch)
       @result = Temporalio::Workflow.execute_activity(
         MyActivities::PostPatch,
         start_to_close_timeout: 5 * 60

patching/workflow_4_complete.rb

@@ -5,7 +5,7 @@
 
 module Patching
   class MyWorkflow4Complete < Temporalio::Workflow::Definition
-    workflow_name 'MyWorkflow'
+    workflow_name :MyWorkflow
     workflow_query_attr_reader :result
 
     def execute

test/patching/my_workflow_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'test'
+require 'patching/my_activities'
+require 'patching/workflow_1_initial'
+require 'patching/workflow_2_patched'
+require 'patching/workflow_3_deprecated'
+require 'patching/workflow_4_complete'
+
+require 'securerandom'
+require 'temporalio/client'
+require 'temporalio/testing'
+require 'temporalio/worker'
+
+module Patching
+  class PatchingWorkflowTest < Test
+    def setup
+      @task_queue = "tq-#{SecureRandom.uuid}"
+    end
+
+    def with_handle(env, workflow, id)
+      Temporalio::Worker.new(
+        client: env.client,
+        activities: [MyActivities::PrePatch, MyActivities::PostPatch],
+        task_queue: @task_queue,
+        workflows: [workflow]
+      ).run do
+        handle = env.client.start_workflow(
+          :MyWorkflow, id:, task_queue: @task_queue
+        )
+        yield handle
+      end
+    end
+
+    def test_workflow
+      Temporalio::Testing::WorkflowEnvironment.start_local do |env|
+        initial_handle = with_handle(env, MyWorkflow1Initial, 'initial-id') do |handle|
+          handle.result
+          assert_equal 'pre-patch', handle.query(:result)
+          handle
+        end
+
+        patched_handle = with_handle(env, MyWorkflow2Patched, 'patched-id') do |handle|
+          handle.result
+          assert_equal 'pre-patch', initial_handle.query(:result)
+          assert_equal 'post-patch', handle.query(:result)
+          handle
+        end
+
+        deprecated_handle = with_handle(env, MyWorkflow3Deprecated, 'deprecated-id') do |handle|
+          handle.result
+          assert_raises(Temporalio::Error::WorkflowQueryFailedError) { initial_handle.query(:result) }
+          assert_equal 'post-patch', patched_handle.query(:result)
+          assert_equal 'post-patch', handle.query(:result)
+          handle
+        end
+
+        with_handle(env, MyWorkflow4Complete, 'deprecated-id') do |complete_handle|
+          complete_handle.result
+          assert_raises(Temporalio::Error::WorkflowQueryFailedError) { initial_handle.query(:result) }
+          assert_raises(Temporalio::Error::WorkflowQueryFailedError) { patched_handle.query(:result) }
+          assert_equal 'post-patch', deprecated_handle.query(:result)
+          assert_equal 'post-patch', complete_handle.query(:result)
+        end
+      end
+    end
+  end
+end