feat: publish RBS and RBI types with Gem by chris-olszewski · Pull Request #410 · temporalio/sdk-ruby

chris-olszewski · 2026-04-06T17:35:46Z

What was changed

Include RBS types in published Gem along with newly added RBI types.

RBS

The codebase is already type checked with RBS, we just never included these type definitions as part of the gem. We now include these in the gem with experimental support.

RBI

These are net new, initially generated with Tapioca, narrowed via Claude/myself, and validated using srb tc and enabling sobet-runtime in our tests.

SigApplicator

To better verify that the RBI is correct, we run our tests with each method with sorbet-runtime signatures generated from our RBI files. Currently this added check is only enabled on for the ubuntu-latest test runs. These will also be released as experimental.

We cannot apply this to every class as some:

Would require generic which we cannot easily declare without altering runtime behavior e.g. Temporalio::Workflow::Future
We intentionally avoid following the type definition e.g. base constructor for interceptors

Using SigApplicator is controlled by the TEMPORAL_SORBET_RUNTIME_CHECK environment variable.

We did have to update some tests where we intentionally pass in mistyped data.

Review Guidelines

I would focus highly on the SigApplicator module as this is our primary tool for verifying our RBI file. Any changes to Ruby files should be reviewed as these are the more impactful.

Looking at the RBI definitions for Workflow and Activities are worthwhile, but we rely on the tests to validate correctness for the majority of these new type signatures.

Why?

Community ask

Checklist

Closes [Feature Request] Publish RBI types #412
How was this tested:
See RBI section above.
Any docs updates needed?
Updated README, further docs will be updated as we move this out of experimental.

jazev-stripe

This looks really promising, and I think would already be pretty useful to us. The approach of applying the runtime checks during tests is new to me--seems quite cool!

I left a few comments; we also have a thread in the shared Stripe <> Temporal Slack channel (#support-stripe-temporal) about this.

jez

@jazev-stripe mentioned that you might want some feedback on this approach, don't mean to intrude, very excited to see this in any form it takes, it's extremely cool!

chris-olszewski · 2026-06-03T20:47:12Z


        # @see ActivityExecutor.initialize_activity
-        def execute_activity(_defn, &)
+        def execute_activity(defn, &) # rubocop:disable Lint/UnusedMethodArgument


Sorbet cares about argument names so it is better to suppress the unused method lint explicitly instead of using _

chris-olszewski · 2026-06-03T20:47:16Z


        # @see ActivityExecutor.execute_activity
-        def execute_activity(_defn, &)
+        def execute_activity(defn, &) # rubocop:disable Lint/UnusedMethodArgument


Sorbet cares about argument names so it is better to suppress the unused method lint explicitly instead of using _

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Generated via `tapioca gem temporalio` against SDK v1.3.0. This file is used by CI to detect when the public API surface changes and the enriched RBI needs updating. It is not shipped to users. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Hand-maintained RBI file with typed sig blocks covering the full public API surface (~8,250 lines). Types are derived from the existing RBS signatures in sig/. Internal APIs are excluded. Also adds rbi/temporalio.rbi to the gemspec so it ships with the gem. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

- Move tapioca baseline from rbi/ to extra/ to prevent Sorbet from loading it alongside the enriched RBI via path: gem references - Fix parameter ordering in list_workflow_page sig - Fix Future Elem type_member variance (remove :out since result= uses it as input) - Replace T.nilable(T.untyped) with T.untyped - Fix unresolved bare Worker:: references to use full qualification Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

These classes inherit from ::Mutex, ::Queue, ::SizedQueue respectively. Without the inheritance, methods like `synchronize` are not available to Sorbet users. Found while porting message_passing_simple sample to Sorbet. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Custom PayloadCodec implementations reference these protobuf types directly. Without stubs, Sorbet cannot resolve them. Found while porting encryption sample to Sorbet. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Adds extra/sorbet_check/ — a self-contained Sorbet project that validates the enriched RBI against realistic SDK usage patterns (activities, workflows, client, worker, codecs, errors, cancellation, search attributes, mutex). Runs `srb tc` on the checkTarget CI matrix. Also removes the tapioca baseline (extra/tapioca_baseline/) — the Sorbet type check provides better validation than diffing tapioca output, which is fragile across tapioca versions. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Adds a "Maintaining Type Signatures" section under Development with instructions on keeping RBS and RBI in sync, type mapping reference, and guidance on what to include/exclude from the RBI. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…ints

chris-olszewski mentioned this pull request Apr 6, 2026

fix: use workflow type name in WorkflowAlreadyStartedError #411

Merged

chris-olszewski force-pushed the olszewski/feat_publish_types branch from 5e70a0f to 68ce2da Compare April 7, 2026 01:05

chris-olszewski marked this pull request as ready for review April 7, 2026 01:19

chris-olszewski requested a review from a team as a code owner April 7, 2026 01:19

jazev-stripe reviewed Apr 7, 2026

View reviewed changes

jez reviewed Apr 7, 2026

View reviewed changes

Comment thread temporalio/test/support/sig_applicator.rb Outdated

Comment thread temporalio/test/support/sig_applicator.rb Outdated

Comment thread temporalio/test/support/sig_applicator.rb Outdated

chris-olszewski force-pushed the olszewski/feat_publish_types branch from 68ce2da to 76e1c77 Compare April 10, 2026 00:18

chris-olszewski force-pushed the olszewski/feat_publish_types branch from 76e1c77 to cd3758a Compare May 29, 2026 14:59

chris-olszewski marked this pull request as draft June 2, 2026 16:45

chris-olszewski mentioned this pull request Jun 3, 2026

chore: RBS fixups #452

Open

chris-olszewski force-pushed the olszewski/feat_publish_types branch from db4afac to e6cc2f5 Compare June 9, 2026 12:35

chris-olszewski commented Jun 9, 2026

View reviewed changes

chris-olszewski marked this pull request as ready for review June 9, 2026 12:53

chris-olszewski and others added 17 commits June 9, 2026 10:52

Extract RBS updates

d09690e

Remove stale generated service RBS files

1e29880

Add sig/ to gemspec to ship RBS types with the gem

ba2fa0e

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fixup rbi

4f89530

strip comments

4f04569

feat: add sorbet runtime check to tests

7a4a5f9

fixup type errors

dfda801

test: run sorbet runtime typecheck in ci

94f0935

chore: fix interceptor type errors

c3278cb

fix(test): fix activity info test to avoid type error

421e69a

chris-olszewski added 29 commits June 9, 2026 10:52

ci: only run sorbet checks on ubuntu

242e0dc

add rbi signatures for protobuf types

b484e65

prep for splitting up rbi file

67a3569

split out massive rbi

dcfe07c

add additional rbi types

ad22865

add missing rbi files

5a37762

add support for attr_reader/writer/accessor

77fac4b

isolate sig applicator tests

9f98345

remove skip prefix

ec0bb96

clean up comments wrt future

b98acaf

use accessors

23b7615

leverage after run hook to fail tests

4de57c1

add typing for testing env blocks

acec242

fix lint

2372f01

fix steep error

9a8165d

fully type support dir

59d40ff

remove mutex in sigapplicator

47f6936

tighten sig applicator rbs

1978f81

switch to use T.anything where applicable

a09f570

use Object for vals in to_h

9c14793

fix from_h to use object

8272925

Add generated service namespace RBS files

d4d450c

clean up old comments

5649fcf

fail on nested error suppression

934b388

add rbi for services

3e8547e

refactor sig applicator to use accumulator instead of passing around …

d69b717

…ints

update rbs for sig applicator

73c3aad

clean up readme

b908992

add rbi for SAA

4c21098

chris-olszewski force-pushed the olszewski/feat_publish_types branch from 5f0f624 to 4c21098 Compare June 9, 2026 15:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: publish RBS and RBI types with Gem#410

feat: publish RBS and RBI types with Gem#410
chris-olszewski wants to merge 60 commits into
mainfrom
olszewski/feat_publish_types

chris-olszewski commented Apr 6, 2026 •

edited

Loading

Uh oh!

jazev-stripe left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jez left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chris-olszewski Jun 3, 2026

Uh oh!

chris-olszewski Jun 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

chris-olszewski commented Apr 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What was changed

RBS

RBI

SigApplicator

Review Guidelines

Why?

Checklist

Uh oh!

jazev-stripe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chris-olszewski Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

chris-olszewski Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chris-olszewski commented Apr 6, 2026 •

edited

Loading