Add Rust client SDK bindings for calling procedures #3532
Merged
Conversation
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 commit adds support to the Rust client SDK for calling procedures. Similar to reducers, each `DbContext` implementor has a `pub procedures: RemoteProcedures` field, with methods provided by extension traits for each procedure. Unlike reducers, the provided methods are invoke and invoke-then. Invoke-then takes a `FnOnce` callback to run when the SDK is notified of the procedure's termination status, while invoke ignores that notification. No mechanism is provided for observing procedures invoked by other clients. Procedure callbacks are implemented by storing a map from `request_id` to `ProcedureCallback`, with the callback closure internally knowing how to deserialize the return value. It's mildly unfortunate to deserialize within the callback instead of on the preprocess background task, but it saves significant complexity. This commit also adds a new sdk-test module, `sdk-test-procedures`, and a new Rust test client, `procedure-client`. Together, these are used in two tests of invoking and observing procedures. I've left TODOs for other tests that we should write as we implement additional procedure features.
Contributor
Author
|
Closes #3513 |
…SpacetimeDB into phoebe/procedure/rust-sdk
This was referenced Oct 30, 2025
We're generating empty files for C# and TypeScript bindings for now, which still appear in the snaps
Centril
approved these changes
Oct 31, 2025
Contributor
Centril
left a comment
Centril
left a comment
There was a problem hiding this comment.
Looks good, just some minor things.
cloutiertyler
approved these changes
Oct 31, 2025
Contributor
cloutiertyler
left a comment
cloutiertyler
left a comment
There was a problem hiding this comment.
Approving my code owned files.
JasonAtClockwork
approved these changes
Nov 6, 2025
Contributor
JasonAtClockwork
left a comment
JasonAtClockwork
left a comment
There was a problem hiding this comment.
Looks good to me, just adding into Unreal + C# now
I realize now that this wasn't necessary, and it makes `nix develop` and direnv take much longer than they should.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of Changes
This commit adds support to the Rust client SDK for calling procedures.
Similar to reducers, each
DbContextimplementor has apub procedures: RemoteProceduresfield, with methods provided by extension traits for each procedure.Unlike reducers, the provided methods are invoke and invoke-then. Invoke-then takes a
FnOncecallback to runwhen the SDK is notified of the procedure's termination status, while invoke ignores that notification.
No mechanism is provided for observing procedures invoked by other clients.
Procedure callbacks are implemented by storing a map from
request_idtoProcedureCallback, with the callback closure internally knowing how to deserialize the return value. It's mildly unfortunate to deserialize within the callback instead of on the preprocess background task, but it saves significant complexity.This commit also adds a new sdk-test module,
sdk-test-procedures, and a new Rust test client,procedure-client.Together, these are used in two tests of invoking and observing procedures. I've left TODOs for other tests that we should write as we implement additional procedure features.
I also had to fix a few minor bugs in the Rust codegen which were not strictly related to procedures: we previously assumed that the sets of reducers and of tables were non-empty, which led to wonky invalid codegen on modules which did not define any reducers or which did not define any tables.
I'm sneaking a change to the Nix flake into this PR as well - when initially writing it I had included
cargoArtifacts(the pre-built and cached dependencies of our actual builds) in itspackages, but that was neither necessary or useful, and just made building the shell take a long time after dependency changes.API and ABI breaking changes
Breaks the internal interface between the Rust client SDK and codegen, so users will have to re-run
spacetime generate.Expected complexity level and risk
2-ish? Pretty simple change to the Rust SDK overall.
Testing