review changes

Author: THardy98

README.md

@@ -31,6 +31,7 @@ Prerequisites:
 * [rails_app](rails_app) - Basic Rails API application using Temporal workflows and activities.
 * [sorbet_generic](sorbet_generic) - Proof of concept of how to do _advanced_ Sorbet typing with the SDK.
 * [worker_specific_task_queues](worker_specific_task_queues) - Use a unique Task Queue for each Worker to run a sequence of Activities on the same Worker.
+* [polling/infrequent](polling/infrequent/) - implement an infrequent polling mechanism using Temporal's automatic Activity Retry feature
 
 ## Development
 

polling/infrequent/compose_greeting_activity.rb

@@ -3,16 +3,18 @@
 require 'temporalio/activity'
 require_relative 'test_service'
 
-module InfrequentPolling
-  class ComposeGreetingActivity < Temporalio::Activity::Definition
-    def execute(input)
-      activity_info = Temporalio::Activity::Context.current.info
-      TestService.get_service_result(input, activity_info)
-    rescue TestService::TestServiceError => e
-      raise Temporalio::Error::ApplicationError.new(
-        e.message,
-        category: Temporalio::Error::ApplicationError::Category::BENIGN
-      )
+module Polling
+  module Infrequent
+    class ComposeGreetingActivity < Temporalio::Activity::Definition
+      def execute(input)
+        activity_info = Temporalio::Activity::Context.current.info
+        TestService.get_service_result(input, activity_info)
+      rescue TestService::TestServiceError => e
+        raise Temporalio::Error::ApplicationError.new(
+          e.message,
+          category: Temporalio::Error::ApplicationError::Category::BENIGN
+        )
+      end
     end
   end
 end

polling/infrequent/greeting_workflow.rb

@@ -4,18 +4,20 @@
 require_relative 'compose_greeting_activity'
 require_relative 'test_service'
 
-module InfrequentPolling
-  class GreetingWorkflow < Temporalio::Workflow::Definition
-    def execute(name)
-      Temporalio::Workflow.execute_activity(
-        ComposeGreetingActivity,
-        TestService::ComposeGreetingInput.new('Hello', name),
-        retry_policy: Temporalio::RetryPolicy.new(
-          initial_interval: 60, # seconds
-          backoff_coefficient: 1.0
-        ),
-        start_to_close_timeout: 2
-      )
+module Polling
+  module Infrequent
+    class GreetingWorkflow < Temporalio::Workflow::Definition
+      def execute(name)
+        Temporalio::Workflow.execute_activity(
+          ComposeGreetingActivity,
+          { greeting: 'Hello', name: name },
+          retry_policy: Temporalio::RetryPolicy.new(
+            initial_interval: 1, # seconds
+            backoff_coefficient: 1.0
+          ),
+          start_to_close_timeout: 2
+        )
+      end
     end
   end
 end

polling/infrequent/starter.rb

@@ -9,7 +9,7 @@
 # Run workflow
 puts 'Executing workflow'
 result = client.execute_workflow(
-  InfrequentPolling::GreetingWorkflow,
+  Polling::Infrequent::GreetingWorkflow,
   'World',
   id: "infrequent-polling-sample-workflow-id-#{Time.now.to_i}",
   task_queue: 'infrequent-polling-sample'

polling/infrequent/test_service.rb

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
-require 'temporalio/activity'
+module Polling
+  module Infrequent
+    # A mock external service with simulated errors.
+    module TestService
+      class TestServiceError < StandardError; end
 
-# A mock external service with simulated errors.
-module TestService
-  class TestServiceError < StandardError; end
+      @attempts = Hash.new(0)
+      ERROR_ATTEMPTS = 5
 
-  @attempts = Hash.new(0)
-  ERROR_ATTEMPTS = 5
+      def get_service_result(input, activity_info)
+        workflow_id = activity_info.workflow_id
+        @attempts[workflow_id] ||= 0
+        @attempts[workflow_id] += 1
 
-  ComposeGreetingInput = Struct.new(:greeting, :name)
+        puts "Attempt #{@attempts[workflow_id]} of #{ERROR_ATTEMPTS} to invoke service"
 
-  def get_service_result(input, activity_info)
-    workflow_id = activity_info.workflow_id
-    @attempts[workflow_id] ||= 0
-    @attempts[workflow_id] += 1
+        raise TestServiceError, 'service is down' unless @attempts[workflow_id] == ERROR_ATTEMPTS
 
-    puts "Attempt #{@attempts[workflow_id]} of #{ERROR_ATTEMPTS} to invoke service"
-
-    raise TestServiceError, 'service is down' unless @attempts[workflow_id] == ERROR_ATTEMPTS
-
-    "#{input['greeting']}, #{input['name']}!"
+        "#{input['greeting']}, #{input['name']}!"
+      end
+      module_function :get_service_result
+    end
   end
-  module_function :get_service_result
 end

polling/infrequent/worker.rb

@@ -11,8 +11,8 @@
 worker = Temporalio::Worker.new(
   client:,
   task_queue: 'infrequent-polling-sample',
-  workflows: [InfrequentPolling::GreetingWorkflow],
-  activities: [InfrequentPolling::ComposeGreetingActivity]
+  workflows: [Polling::Infrequent::GreetingWorkflow],
+  activities: [Polling::Infrequent::ComposeGreetingActivity]
 )
 
 puts 'Starting worker (ctrl+c to exit)'