CI fixes

cretz · cretz · commit 4e7f60fba637 · 2025-01-08T14:32:59.000-06:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -73,4 +73,6 @@ jobs:
 
       - name: Lint, compile, test Ruby
         working-directory: ./temporalio
+        # Timeout just in case there's a hanging part in rake
+        timeout-minutes: 20
         run: bundle exec rake TESTOPTS="--verbose"
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <div style="overflow: hidden"><img src="https://raw.githubusercontent.com/temporalio/assets/main/files/w/ruby.png" alt="Temporal Ruby SDK" /></div>
 
-![Ruby 3.1 | 3.2 | 3.3 | 3.4](https://img.shields.io/badge/ruby-3.1%20%7C%203.2%20%7C%203.3-blue.svg?style=for-the-badge)
+![Ruby 3.1 | 3.2 | 3.3](https://img.shields.io/badge/ruby-3.1%20%7C%203.2%20%7C%203.3-blue.svg?style=for-the-badge)
 [![MIT](https://img.shields.io/github/license/temporalio/sdk-ruby.svg?style=for-the-badge)](LICENSE)
 [![Gem](https://img.shields.io/gem/v/temporalio?style=for-the-badge)](https://rubygems.org/gems/temporalio)
 
@@ -29,15 +29,32 @@ until the SDK is marked stable.
 
 - [Quick Start](#quick-start)
   - [Installation](#installation)
-  - [Implementing an Activity](#implementing-an-activity)
-  - [Running a Workflow](#running-a-workflow)
+  - [Implementing a Workflow and Activity](#implementing-a-workflow-and-activity)
+  - [Running a Worker](#running-a-worker)
+  - [Executing a Workflow](#executing-a-workflow)
 - [Usage](#usage)
   - [Client](#client)
     - [Cloud Client Using mTLS](#cloud-client-using-mtls)
+    - [Cloud Client Using API Key](#cloud-client-using-api-key)
     - [Data Conversion](#data-conversion)
       - [ActiveRecord and ActiveModel](#activerecord-and-activemodel)
   - [Workers](#workers)
   - [Workflows](#workflows)
+    - [Workflow Definition](#workflow-definition)
+    - [Running Workflows](#running-workflows)
+    - [Invoking Activities](#invoking-activities)
+    - [Invoking Child Workflows](#invoking-child-workflows)
+    - [Timers and Conditions](#timers-and-conditions)
+    - [Workflow Task Scheduling and Cancellation](#workflow-task-scheduling-and-cancellation)
+    - [Workflow Futures](#workflow-futures)
+    - [Workflow Utilities](#workflow-utilities)
+    - [Workflow Exceptions](#workflow-exceptions)
+    - [Workflow Logic Constraints](#workflow-logic-constraints)
+    - [Workflow Testing](#workflow-testing)
+      - [Automatic Time Skipping](#automatic-time-skipping)
+      - [Manual Time Skipping](#manual-time-skipping)
+      - [Mocking Activities](#mocking-activities)
+    - [Workflow Replay](#workflow-replay)
   - [Activities](#activities)
     - [Activity Definition](#activity-definition)
     - [Activity Context](#activity-context)
@@ -59,6 +76,8 @@ until the SDK is marked stable.
 
 ### Installation
 
+The Ruby SDK works with Ruby 3.1, 3.2, and 3.3. 3.4 support will be added soon, and 3.1 support will be dropped soon.
+
 Can require in a Gemfile like:
 
 ```
diff --git a/temporalio/Gemfile b/temporalio/Gemfile
@@ -17,7 +17,7 @@ group :development do
   gem 'rbs', '~> 3.5.3'
   gem 'rb_sys', '~> 0.9.63'
   gem 'rubocop'
-  gem 'sqlite3', '~> 1.4'
+  gem 'sqlite3'
   gem 'steep', '~> 1.7.1'
   gem 'yard'
 end
diff --git a/temporalio/lib/temporalio/client/schedule.rb b/temporalio/lib/temporalio/client/schedule.rb
@@ -958,7 +958,8 @@ def initialize(raw_info)
 
         State = Struct.new(
           :note,
-          :paused
+          :paused,
+          keyword_init: true
         )
 
         # State of a listed schedule.
diff --git a/temporalio/lib/temporalio/internal/worker/workflow_instance/illegal_call_tracer.rb b/temporalio/lib/temporalio/internal/worker/workflow_instance/illegal_call_tracer.rb
@@ -33,31 +33,45 @@ def self.frozen_validated_illegal_calls(illegal_calls)
             end.freeze
           end
 
-          # Illegal calls are Hash[String, Hash[Symbol, Bool]]
+          # Illegal calls are Hash[String, :all | Hash[Symbol, Bool]]
           def initialize(illegal_calls)
             @tracepoint = TracePoint.new(:call, :c_call) do |tp|
               cls = tp.defined_class
               next unless cls.is_a?(Module)
 
-              # We need this to be quick so we don't do extra validations to satisfy type checker
-              # steep:ignore:start
-              if cls.singleton_class?
-                cls = cls.attached_object
-                next unless cls.is_a?(Module)
-              end
-              vals = illegal_calls[cls.name]
-              if vals == :all || vals&.[](tp.callee_id)
+              # Extract the class name from the defined class. This is more difficult than it seems because you have to
+              # resolve the attached object of the singleton class. But in older Ruby (at least <= 3.1), the singleton
+              # class of things like `Date` does not have `attached_object` so you have to fall back in these rare cases
+              # to parsing the string output. Reaching the string parsing component is rare, so this should not have
+              # significant performance impact.
+              cls_name = if cls.singleton_class?
+                           if cls.respond_to?(:attached_object)
+                             cls = cls.attached_object # steep:ignore
+                             next unless cls.is_a?(Module)
+
+                             cls.name.to_s
+                           else
+                             cls.to_s.delete_prefix('#<Class:').delete_suffix('>')
+                           end
+                         else
+                           cls.name.to_s
+                         end
+
+              # Check if the call is considered illegal
+              vals = illegal_calls[cls_name]
+              if vals == :all || vals&.[](tp.callee_id) # steep:ignore
                 raise Workflow::NondeterminismError,
-                      "Cannot access #{cls.name} #{tp.callee_id} from inside a " \
+                      "Cannot access #{cls_name} #{tp.callee_id} from inside a " \
                       'workflow. If this is known to be safe, the code can be run in ' \
                       'a Temporalio::Workflow::Unsafe.illegal_call_tracing_disabled block.'
               end
-              # steep:ignore:end
             end
           end
 
           def enable(&)
-            @tracepoint.enable(&)
+            # Setting current thread explicitly because it wasn't until Ruby 3.2 that this
+            # was done automatically, ref https://github.com/ruby/ruby/pull/5359
+            @tracepoint.enable(target_thread: Thread.current, &)
           end
 
           def disable(&)
diff --git a/temporalio/lib/temporalio/worker/interceptor.rb b/temporalio/lib/temporalio/worker/interceptor.rb
@@ -273,7 +273,8 @@ def handle_update(input)
         SleepInput = Struct.new(
           :duration,
           :summary,
-          :cancellation
+          :cancellation,
+          keyword_init: true
         )
 
         # Input for {Outbound.start_child_workflow}.
diff --git a/temporalio/lib/temporalio/workflow/info.rb b/temporalio/lib/temporalio/workflow/info.rb
@@ -74,7 +74,8 @@ class Info
       ParentInfo = Struct.new(
         :namespace,
         :run_id,
-        :workflow_id
+        :workflow_id,
+        keyword_init: true
       )
     end
   end
diff --git a/temporalio/test/api/payload_visitor_test.rb b/temporalio/test/api/payload_visitor_test.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'temporalio/api/payload_visitor'
-require 'test_base'
+require 'test'
 
 module Api
-  class PayloadVisitorTest < TestBase
+  class PayloadVisitorTest < Test
     def test_basics
       # Make protos that have:
       # * single payload
diff --git a/temporalio/test/cancellation_test.rb b/temporalio/test/cancellation_test.rb
@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require 'temporalio/cancellation'
-require 'test_base'
+require 'test'
 
-class CancellationTest < TestBase
+class CancellationTest < Test
   also_run_all_tests_in_fiber
 
   def test_simple_cancellation
diff --git a/temporalio/test/client_schedule_test.rb b/temporalio/test/client_schedule_test.rb
@@ -4,9 +4,9 @@
 require 'temporalio/client'
 require 'temporalio/client/schedule'
 require 'temporalio/testing'
-require 'test_base'
+require 'test'
 
-class ClientScheduleTest < TestBase
+class ClientScheduleTest < Test
   also_run_all_tests_in_fiber
 
   def test_basics # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
diff --git a/temporalio/test/client_test.rb b/temporalio/test/client_test.rb
@@ -3,9 +3,9 @@
 require 'async'
 require 'temporalio/client'
 require 'temporalio/testing'
-require 'test_base'
+require 'test'
 
-class ClientTest < TestBase
+class ClientTest < Test
   def test_version_number
     assert !Temporalio::VERSION.nil?
   end
diff --git a/temporalio/test/client_workflow_test.rb b/temporalio/test/client_workflow_test.rb
@@ -3,9 +3,9 @@
 require 'async'
 require 'temporalio/client'
 require 'temporalio/testing'
-require 'test_base'
+require 'test'
 
-class ClientWorkflowTest < TestBase
+class ClientWorkflowTest < Test
   also_run_all_tests_in_fiber
 
   def test_start_simple
diff --git a/temporalio/test/converters/data_converter_test.rb b/temporalio/test/converters/data_converter_test.rb
@@ -5,10 +5,10 @@
 require 'temporalio/converters/data_converter'
 require 'temporalio/converters/payload_codec'
 require 'temporalio/testing'
-require 'test_base'
+require 'test'
 
 module Converters
-  class DataConverterTest < TestBase
+  class DataConverterTest < Test
     def test_with_codec
       converter = Temporalio::Converters::DataConverter.new(
         failure_converter: Ractor.make_shareable(
diff --git a/temporalio/test/converters/failure_converter_test.rb b/temporalio/test/converters/failure_converter_test.rb
@@ -3,10 +3,10 @@
 require 'temporalio/api'
 require 'temporalio/converters/failure_converter'
 require 'temporalio/testing'
-require 'test_base'
+require 'test'
 
 module Converters
-  class FailureConverterTest < TestBase
+  class FailureConverterTest < Test
     def test_failure_with_causes
       # Make multiple nested errors
       orig_err = assert_raises do
diff --git a/temporalio/test/converters/payload_converter_test.rb b/temporalio/test/converters/payload_converter_test.rb
@@ -4,10 +4,10 @@
 require 'active_record'
 require 'temporalio/api'
 require 'temporalio/converters/payload_converter'
-require 'test_base'
+require 'test'
 
 module Converters
-  class PayloadConverterTest < TestBase
+  class PayloadConverterTest < Test
     # @type method assert_payload: (
     #   untyped input,
     #   String expected_encoding,
diff --git a/temporalio/test/scoped_logger_test.rb b/temporalio/test/scoped_logger_test.rb
@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require 'temporalio/scoped_logger'
-require 'test_base'
+require 'test'
 
-class ScopedLoggerTest < TestBase
+class ScopedLoggerTest < Test
   def test_logger_with_values
     # Default doesn't change anything
     out, = safe_capture_io do
diff --git a/temporalio/test/sig/client_workflow_test.rbs b/temporalio/test/sig/client_workflow_test.rbs
@@ -1,3 +1,3 @@
-class ClientWorkflowTest < TestBase
+class ClientWorkflowTest < Test
   def start_simple: -> void
 end
diff --git a/temporalio/test/sig/test.rbs b/temporalio/test/sig/test.rbs
@@ -1,4 +1,4 @@
-class TestBase < Minitest::Test
+class Test < Minitest::Test
   include ExtraAssertions
   include WorkflowUtils
 
diff --git a/temporalio/test/sig/worker_activity_test.rbs b/temporalio/test/sig/worker_activity_test.rbs
@@ -1,4 +1,4 @@
-class WorkerActivityTest < TestBase
+class WorkerActivityTest < Test
   def execute_activity: [T] (
     untyped activity,
     *untyped args,
diff --git a/temporalio/test/sig/workflow/definition_test.rbs b/temporalio/test/sig/workflow/definition_test.rbs
@@ -1,5 +1,5 @@
 module Workflow
-  class DefinitionTest < TestBase
+  class DefinitionTest < Test
     class ValidWorkflowAdvancedBase < Temporalio::Workflow::Definition
     end
 
diff --git a/temporalio/test/test.rb b/temporalio/test/test.rb
@@ -19,7 +19,7 @@
 #   report.pretty_print
 # end
 
-class TestBase < Minitest::Test
+class Test < Minitest::Test
   include ExtraAssertions
   include WorkflowUtils
 
diff --git a/temporalio/test/testing/activity_environment_test.rb b/temporalio/test/testing/activity_environment_test.rb
@@ -2,10 +2,10 @@
 
 require 'temporalio/activity'
 require 'temporalio/testing/activity_environment'
-require 'test_base'
+require 'test'
 
 module Testing
-  class ActivityEnvironmentTest < TestBase
+  class ActivityEnvironmentTest < Test
     also_run_all_tests_in_fiber
 
     class SimpleActivity < Temporalio::Activity::Definition
diff --git a/temporalio/test/testing/workflow_environment_test.rb b/temporalio/test/testing/workflow_environment_test.rb
@@ -6,11 +6,11 @@
 require 'temporalio/testing/workflow_environment'
 require 'temporalio/worker'
 require 'temporalio/workflow'
-require 'test_base'
+require 'test'
 require 'workflow_utils'
 
 module Testing
-  class WorkflowEnvironmentTest < TestBase
+  class WorkflowEnvironmentTest < Test
     include WorkflowUtils
 
     class SlowWorkflow < Temporalio::Workflow::Definition
diff --git a/temporalio/test/worker/thread_pool_test.rb b/temporalio/test/worker/thread_pool_test.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'temporalio/worker/thread_pool'
-require 'test_base'
+require 'test'
 
 module Worker
-  class ThreadPoolTest < TestBase
+  class ThreadPoolTest < Test
     def test_unlimited_max_with_idle
       pool = Temporalio::Worker::ThreadPool.new(idle_timeout: 0.3)
 
diff --git a/temporalio/test/worker_activity_test.rb b/temporalio/test/worker_activity_test.rb
@@ -7,9 +7,9 @@
 require 'temporalio/client'
 require 'temporalio/testing'
 require 'temporalio/worker'
-require 'test_base'
+require 'test'
 
-class WorkerActivityTest < TestBase
+class WorkerActivityTest < Test
   also_run_all_tests_in_fiber
 
   class ClassActivity < Temporalio::Activity::Definition
@@ -822,7 +822,7 @@ def test_interceptor_from_client
     assert_equal ['heartbeat-val'], interceptor.calls[2][1].details
   end
 
-  class CustomMetricActivity < Temporalio::Activity
+  class CustomMetricActivity < Temporalio::Activity::Definition
     def execute
       counter = Temporalio::Activity::Context.current.metric_meter.create_metric(
         :counter, 'my-counter'
diff --git a/temporalio/test/worker_test.rb b/temporalio/test/worker_test.rb
@@ -3,9 +3,9 @@
 require 'temporalio/client'
 require 'temporalio/testing'
 require 'temporalio/worker'
-require 'test_base'
+require 'test'
 
-class WorkerTest < TestBase
+class WorkerTest < Test
   also_run_all_tests_in_fiber
 
   class SimpleActivity < Temporalio::Activity::Definition
diff --git a/temporalio/test/worker_workflow_activity_test.rb b/temporalio/test/worker_workflow_activity_test.rb
diff --git a/temporalio/test/worker_workflow_child_test.rb b/temporalio/test/worker_workflow_child_test.rb
diff --git a/temporalio/test/worker_workflow_external_test.rb b/temporalio/test/worker_workflow_external_test.rb
diff --git a/temporalio/test/worker_workflow_handler_test.rb b/temporalio/test/worker_workflow_handler_test.rb
diff --git a/temporalio/test/worker_workflow_test.rb b/temporalio/test/worker_workflow_test.rb
diff --git a/temporalio/test/workflow/definition_test.rb b/temporalio/test/workflow/definition_test.rb
diff --git a/temporalio/test/workflow_utils.rb b/temporalio/test/workflow_utils.rb

Original file line number	Diff line number	Diff line change
`@@ -958,7 +958,8 @@ def initialize(raw_info)`
`958`	`958`
`959`	`959`	`State = Struct.new(`
`960`	`960`	`:note,`
`961`		`- :paused`
	`961`	`+ :paused,`
	`962`	`+ keyword_init: true`
`962`	`963`	`)`
`963`	`964`
`964`	`965`	`# State of a listed schedule.`
Original file line number	Diff line number	Diff line change
`@@ -273,7 +273,8 @@ def handle_update(input)`
`273`	`273`	`SleepInput = Struct.new(`
`274`	`274`	`:duration,`
`275`	`275`	`:summary,`
`276`		`- :cancellation`
	`276`	`+ :cancellation,`
	`277`	`+ keyword_init: true`
`277`	`278`	`)`
`278`	`279`
`279`	`280`	`# Input for {Outbound.start_child_workflow}.`