-
Notifications
You must be signed in to change notification settings - Fork 22
Add Ruby SDK support #41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
c52d376
Add all Ruby SDK reference files (11 files, ~2100 lines)
donald-pinckney 0dcac1e
Fix alignment issues in Ruby reference files
donald-pinckney dfcdc82
Fix correctness issues in Ruby reference files
donald-pinckney ef5d989
Add Ruby to all language references in SKILL.md and core files
donald-pinckney 2e936b2
Merge branch 'main' into add-ruby-support
donald-pinckney f9c81ee
Apply suggestions from code review
donald-pinckney c3181b8
Apply suggestions from code review
donald-pinckney 5312401
Apply suggestion from @chris-olszewski
donald-pinckney 734a347
copy over sample code
donald-pinckney ce0d434
Remove useless section, mention Mutex
donald-pinckney d051bf3
cleanup mutex mentions
donald-pinckney b22eb20
Clean up transitive NDE section
donald-pinckney b0630d7
Menial changes to align to python structure
donald-pinckney afc00ef
Add Workflow Init section to Ruby advanced-features
donald-pinckney d3b0c3c
Document graceful_shutdown_period in Ruby Worker Tuning
donald-pinckney 76a4f02
Propagate cancellation in Ruby activity-error handling
donald-pinckney 41c6f0e
Align Ruby Workflow Failure section to Python
donald-pinckney adcb0d4
Add logger configuration to Ruby observability
donald-pinckney 1269e03
Make Ruby Saga compensations cancellation-proof
donald-pinckney b08606a
Document patched() memoization caveat in Ruby versioning
donald-pinckney d0d5f4b
Add default versioning behavior to Ruby worker versioning
donald-pinckney 649d296
Fix worker versioning config API names in Ruby docs
donald-pinckney dc1994b
Fix worker concurrency config in Ruby Worker Tuning
donald-pinckney 5fe7a95
Align Ruby Workflow Init title with Python
donald-pinckney 2c4004a
Structure Ruby Metrics to match Python
donald-pinckney File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,247 @@ | ||
| # Ruby SDK Advanced Features | ||
|
|
||
| ## Schedules | ||
|
|
||
| Create recurring workflow executions with `Temporalio::Client::Schedule`. | ||
|
|
||
| ```ruby | ||
| require 'temporalio/client' | ||
|
|
||
| # Create a schedule | ||
| schedule_id = 'daily-report' | ||
| client.create_schedule( | ||
| schedule_id, | ||
| Temporalio::Client::Schedule.new( | ||
| action: Temporalio::Client::Schedule::Action::StartWorkflow.new( | ||
| DailyReportWorkflow, | ||
| id: 'daily-report', | ||
| task_queue: 'reports' | ||
| ), | ||
| spec: Temporalio::Client::Schedule::Spec.new( | ||
| intervals: [ | ||
| Temporalio::Client::Schedule::Spec::Interval.new(every: 86_400) # 1 day in seconds | ||
| ] | ||
| ) | ||
| ) | ||
| ) | ||
|
|
||
| # Manage schedules | ||
| handle = client.schedule_handle(schedule_id) | ||
| handle.pause(note: 'Maintenance window') | ||
| handle.unpause | ||
| handle.trigger | ||
| handle.delete | ||
| ``` | ||
|
|
||
| ## Async Activity Completion | ||
|
|
||
| For activities that complete asynchronously (e.g., human tasks, external callbacks). | ||
|
|
||
| **Note:** If the external system that completes the asynchronous action can reliably be trusted to do the task and Signal back with the result, and it doesn't need to Heartbeat or receive Cancellation, then consider using **signals** instead. | ||
|
|
||
| ```ruby | ||
| class RequestApproval < Temporalio::Activity::Definition | ||
| def execute(request_id) | ||
| # Get task token for async completion | ||
| task_token = Temporalio::Activity::Context.current.info.task_token | ||
|
|
||
| # Store task token for later completion (e.g., in database) | ||
| store_task_token(request_id, task_token) | ||
|
|
||
| # Signal that this activity completes asynchronously | ||
| Temporalio::Activity::Context.current.raise_complete_async | ||
| end | ||
| end | ||
|
|
||
| # Later, complete the activity from another process | ||
| client = Temporalio::Client.connect('localhost:7233') | ||
| task_token = get_task_token(request_id) | ||
| handle = client.async_activity_handle(task_token: task_token) | ||
|
|
||
| if approved | ||
| handle.complete('approved') | ||
| else | ||
| handle.fail(Temporalio::Error::ApplicationError.new('Rejected')) | ||
| end | ||
| ``` | ||
|
|
||
| If you configure a `heartbeat_timeout:` on the activity, the external completer is responsible for sending heartbeats via the async handle. If you do NOT set a `heartbeat_timeout`, no heartbeats are required. | ||
|
|
||
| ## Worker Tuning | ||
|
|
||
| Configure worker performance settings. | ||
|
|
||
| ```ruby | ||
| worker = Temporalio::Worker.new( | ||
| client: client, | ||
| task_queue: 'my-queue', | ||
| workflows: [MyWorkflow], | ||
| activities: [MyActivity], | ||
| # Max concurrent execution slots (default 100 each): how many workflow tasks | ||
| # and activities run at once on this worker. | ||
| tuner: Temporalio::Worker::Tuner.create_fixed( | ||
| workflow_slots: 100, | ||
| activity_slots: 100 | ||
| ), | ||
| # Grace period (seconds) after shutdown is requested before in-progress | ||
| # activities are canceled. Defaults to 0 (cancel immediately on shutdown). | ||
| graceful_shutdown_period: 30 | ||
| ) | ||
| worker.run | ||
| ``` | ||
|
|
||
| On shutdown the worker stops polling for new tasks and cancels the `worker_shutdown_cancellation` on each running activity's context. After `graceful_shutdown_period` seconds it then issues actual cancellation to any still-running activities. The worker will not finish shutting down until all in-progress activities complete, so activities that ignore cancellation can block shutdown indefinitely. | ||
|
|
||
| ## Workflow Init Decorator | ||
|
|
||
| Always initialize workflow state before signals/updates arrive. Signal and Update handlers can run *before* the main `execute` method -- for example with Signal-with-Start, when the Task Queue is backlogged, or right after continue-as-new -- so a handler may otherwise read uninitialized instance variables. | ||
|
|
||
| Normally `initialize` must accept no required arguments. If you place the `workflow_init` class method directly above `initialize`, the constructor receives the same workflow arguments that `execute` receives (the same input the Client sent). It is guaranteed to run before any handler. | ||
|
|
||
| ```ruby | ||
| class GreetingWorkflow < Temporalio::Workflow::Definition | ||
| workflow_init | ||
| def initialize(input) | ||
| # Runs before any signal/update handler | ||
| @name_with_title = "Sir #{input['name']}" | ||
| @title_has_been_checked = false | ||
| end | ||
|
|
||
| def execute(input) | ||
| Temporalio::Workflow.wait_condition { @title_has_been_checked } | ||
| "Hello, #{@name_with_title}" | ||
| end | ||
|
|
||
| workflow_update | ||
| def check_title_validity | ||
| # Guaranteed to see workflow input, since initialize ran first | ||
| valid = Temporalio::Workflow.execute_activity( | ||
| CheckTitleValidityActivity, | ||
| @name_with_title, | ||
| start_to_close_timeout: 100 | ||
| ) | ||
| @title_has_been_checked = true | ||
| valid | ||
| end | ||
| end | ||
| ``` | ||
|
|
||
| `initialize` (with `workflow_init`) and `execute` must have the same parameters with the same types. You cannot make blocking calls (activities, sleeps, etc.) from `initialize`. | ||
|
|
||
| ## Workflow Failure Exception Types | ||
|
|
||
| Control which exceptions cause workflow failure vs workflow task failure (which Temporal retries automatically). | ||
|
|
||
| ### Per-Workflow Configuration | ||
|
|
||
| ```ruby | ||
| class MyWorkflow < Temporalio::Workflow::Definition | ||
| # Class method approach | ||
| def self.workflow_failure_exception_type | ||
| MyCustomError | ||
| end | ||
|
|
||
| def execute | ||
| raise MyCustomError, 'This fails the workflow, not just the task' | ||
| end | ||
| end | ||
| ``` | ||
|
|
||
| ### Worker-Level Configuration | ||
|
|
||
| ```ruby | ||
| Temporalio::Worker.new( | ||
| client: client, | ||
| task_queue: 'my-queue', | ||
| workflows: [MyWorkflow], | ||
| workflow_failure_exception_types: [MyCustomError] | ||
| ) | ||
| ``` | ||
|
|
||
| **Tips:** | ||
| - Set to `[Exception]` in tests so any unhandled exception fails the workflow immediately rather than retrying the workflow task forever. Surfaces bugs faster. | ||
| - Include `Temporalio::Workflow::NondeterminismError` to fail the workflow instead of leaving it in a retrying state on non-determinism errors. | ||
|
|
||
| ## Activity Concurrency and Executors | ||
|
|
||
| Ruby uses `Temporalio::Worker::ActivityExecutor::ThreadPool` by default. Activities run in a thread pool. | ||
|
|
||
| ```ruby | ||
| # Default: activities run in thread pool | ||
| worker = Temporalio::Worker.new( | ||
| client: client, | ||
| task_queue: 'my-queue', | ||
| workflows: [MyWorkflow], | ||
| activities: [MyActivity], | ||
| activity_executors: { | ||
| default: Temporalio::Worker::ActivityExecutor::ThreadPool.new(max_threads: 20) | ||
| } | ||
| ) | ||
| ``` | ||
|
|
||
| Fiber-based execution is also possible for IO-bound activities using Ruby's fiber scheduler. | ||
|
|
||
| ## Rails Integration | ||
|
|
||
| ### ActiveRecord Considerations | ||
|
|
||
| Never pass ActiveRecord models directly to Temporal workflows or activities. Serialize to plain data structures. | ||
|
|
||
| ```ruby | ||
| # BAD - Passing AR model | ||
| client.execute_workflow( | ||
| ProcessOrderWorkflow, | ||
| Order.find(42), # Don't pass AR objects! | ||
| id: 'order-42', | ||
| task_queue: 'orders' | ||
| ) | ||
|
|
||
| # GOOD - Pass serializable data | ||
| client.execute_workflow( | ||
| ProcessOrderWorkflow, | ||
| { id: 42, total: order.total, status: order.status }, | ||
| id: 'order-42', | ||
| task_queue: 'orders' | ||
| ) | ||
| ``` | ||
|
|
||
| ### Zeitwerk and Autoloading | ||
|
|
||
| Rails autoloading can result in unexpected I/O during replay. `config.eager_load` must be enabled or Workflows must explicitly require code dependencies before they are executed. Usually the easiest place to do that is when starting the worker, and requiring all activities and workflows that the worker needs *before* starting the worker. For example: | ||
|
|
||
| ```ruby | ||
| require "temporal_client" | ||
| require "temporalio/worker" | ||
| require "workflows/shopping_cart_activities.rb" | ||
| require "workflows/shopping_cart_workflow.rb" | ||
|
|
||
| worker = Temporalio::Worker.new( | ||
| client: TemporalClient.instance, | ||
| task_queue: TemporalClient.task_queue, | ||
| activities: [ | ||
| Workflows::ShoppingCartActivities::FetchProducts, | ||
| ... | ||
| ], | ||
| workflows: [ Workflows::ShoppingCartWorkflow ] | ||
| ) | ||
| worker.run | ||
| ``` | ||
|
|
||
| ### Forking Considerations | ||
|
|
||
| If using a forking server (Puma, Unicorn), workers must be created **after** the fork. Connections established before fork are not safe to share across processes. | ||
|
|
||
| ```ruby | ||
| # In Puma config (puma.rb) | ||
| before_worker_boot do | ||
| # Create Temporal client and worker AFTER fork | ||
| client = Temporalio::Client.connect('localhost:7233') | ||
| worker = Temporalio::Worker.new( | ||
| client: client, | ||
| task_queue: 'my-queue', | ||
| workflows: [MyWorkflow], | ||
| activities: [MyActivity] | ||
| ) | ||
| Thread.new { worker.run } | ||
| end | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.