-
Notifications
You must be signed in to change notification settings - Fork 20
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
Draft
donald-pinckney
wants to merge
4
commits into
main
Choose a base branch
from
add-ruby-support
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 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 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,191 @@ | ||||||
| # 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). | ||||||
|
|
||||||
| ```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_workflow_tasks: 100, | ||||||
| max_concurrent_activities: 100 | ||||||
| ) | ||||||
| worker.run | ||||||
| ``` | ||||||
|
|
||||||
| ## 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 uses Zeitwerk for autoloading. Workflow and activity classes must be loadable by Zeitwerk or explicitly required. | ||||||
|
|
||||||
| ```ruby | ||||||
| # In config/initializers/temporal.rb or similar | ||||||
| # Eager load Temporal classes so they're available to the worker | ||||||
| Rails.application.config.after_initialize do | ||||||
| Dir[Rails.root.join('app/workflows/**/*.rb')].each { |f| require f } | ||||||
| Dir[Rails.root.join('app/activities/**/*.rb')].each { |f| require f } | ||||||
| end | ||||||
| ``` | ||||||
|
|
||||||
| ### 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) | ||||||
| on_worker_boot do | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This has been renamed in Puma 7.
Suggested change
|
||||||
| # 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Between the line above and this example it's not clear if the example code is required or not? "Loadable by Zeitwerk" seems to imply it should be autoloadable/reloadable in development without additional work, assuming the conventions are followed. Is that right?
In my experience both humans and and LLMs will default to using the example if it's not clear it is not required.