Add UUID built-in convenience type to SpacetimeDB #3538

mamcx · 2025-10-30T19:14:05Z

Description of Changes

Closes #3290.

Adds a new "special" type to SATS, UUID, which is represented as the product { __uuid__: u128 }. Adds versions of this type to all of our various languages' module bindings libraries and client SDKs, and updates codegen to recognize it and output references to those named library types. Adds methods for creating new UUIDs according to the V4 (all random) and V7 (timestamp, monotonic counter and random) specifications.

API and ABI breaking changes

We add a new type

Expected complexity level and risk

2

it impacts all over the code

Testing

Extends the Rust and Unreal SDK tests, and the associated module-test modules in Rust, C# and TypeScript, with uses of UUIDs.
Extends the C# SDK regression tests with uses of UUIDs.
Extends the TypeScript test suite with tests with uses of UUIDs.

JasonAtClockwork · 2025-12-02T22:25:39Z

I've rebased my changes and added them to the branch; this reworks the Unreal C++ side of things for UUID to introduce a new type, adds tests to the TestClient that confirms values and matches all the changes up with the Unreal codegen. If you have any questions don't hesitate to reach out!

JasonAtClockwork · 2025-12-06T02:13:57Z

@rekhoff - I'll need your eyes on the Unreal changes as they were significant enough to add the new UUID object and integration tests.

sdks/rust/tests/test-client/src/main.rs

JasonAtClockwork

I've gone through the Rust, TypeScript, and C# updates as well as retested my Unreal changes and it's looking solid but there seems to be missing integration tests for both TypeScript and C#. Rust looks solid but we'll want someone with more experience to review that.

For TypeScript I'm not sure how our testing framework is set up so I could be wrong. Maybe Noa can help guide here.

For C# sadly we're not hooked directly into the sdk-test or sdk-test-cs but we should add integration test for Uuid into /sdks/csharp/~examples/regression-tests to make sure there is coverage. Myself or Ryan can help here if it isn't clear how to plug in and run those.

# Description of Changes As the title says, required for #3538. # Expected complexity level and risk 1 # Testing Will be done on the `uuid` pr. --------- Signed-off-by: Mario Montoya <mamcx@elmalabarista.com> Co-authored-by: Phoebe Goldman <phoebe@clockworklabs.io>

JasonAtClockwork

C# + Unreal looks good to me though I highly advise another pair of eyes before merging.

sdks/rust/src/lib.rs

crates/bindings/src/lib.rs

gefjon · 2025-12-18T18:51:06Z

From Wikipedia:

remaining 74 bits are random seeded counter (optional, at least 12 bits but no longer than 42 bits) and random.

It looks like we should be putting the counter in the low bits, not the timestamp.

gefjon · 2025-12-18T18:53:26Z

Plan is to move the counter part of the generated UUIDv7 into the space reserved for the counter, and not increment the timestamp part. We'll store the source for the counter in the ReducerContext or ProcedureContext.

gefjon

This is looking very good, I think we're very close to merging. Thanks for all your hard work.

crates/bindings/src/lib.rs

crates/client-api/Cargo.toml

crates/sats/src/uuid.rs

rekhoff · 2025-12-29T22:24:19Z

@rekhoff - I'll need your eyes on the Unreal changes as they were significant enough to add the new UUID object and integration tests.

I reviewed both the C# and the Unreal code. I think you caught the concerns. The Unreal tests could provide better coverage, they are fairly light at the moment. I did load up the Unreal TestClient and manually check a few different behaviors of the UUID, including adding them to blueprints. They where simple tests, but no issues found.

rekhoff

Signing off approval for the C# and as secondary on the Unreal changes.

Fix uuid parsing and to_string in ts and c# Apply suggestions from code review Co-authored-by: Phoebe Goldman <phoebe@clockworklabs.io> Signed-off-by: Mario Montoya <mamcx@elmalabarista.com>

Added new Builtin for UUID

Co-authored-by: Phoebe Goldman <phoebe@clockworklabs.io> Signed-off-by: Mario Montoya <mamcx@elmalabarista.com>

jdetter

I'm just reviewing as a CLI crate owner - the updates here are only within the tests and the updates look correct.

One request: could we update the PR description with the latest info for this PR in its current state before it merges? Thanks 👍

# Description of Changes #3538 added a `uuid_counter` field to ReducerCtx, which has no need to be public. Implementing ReducerCtx as a class allows us to encapsulate better, and lets us enumerate exactly the data that it needs to hold so that the runtime could possibly optimize it. # Expected complexity level and risk 1: straightforward switch # Testing - [x] Automated testing is sufficient.

mamcx self-assigned this Oct 30, 2025

mamcx added enhancement New feature or request release-any To be landed in any release window Do not merge Do not merge PRs with this label without coordinating further labels Oct 30, 2025

mamcx requested review from JasonAtClockwork, coolreader18 and rekhoff October 31, 2025 18:11

mamcx force-pushed the mamcx/uuid-type branch 6 times, most recently from 17d38a5 to 21c25de Compare November 20, 2025 19:17

mamcx force-pushed the mamcx/uuid-type branch 4 times, most recently from 15d7a9d to 7328782 Compare December 3, 2025 20:52

JasonAtClockwork reviewed Dec 6, 2025

View reviewed changes

sdks/rust/tests/test-client/src/main.rs Outdated Show resolved Hide resolved

JasonAtClockwork requested changes Dec 6, 2025

View reviewed changes

mamcx mentioned this pull request Dec 10, 2025

Add rng support to ProcedureContext on Rust #3865

Merged

mamcx force-pushed the mamcx/uuid-type branch 3 times, most recently from ef735c9 to a68fd5f Compare December 11, 2025 21:16

mamcx removed the Do not merge Do not merge PRs with this label without coordinating further label Dec 11, 2025

mamcx force-pushed the mamcx/uuid-type branch from a68fd5f to 687fba2 Compare December 12, 2025 16:15

mamcx marked this pull request as ready for review December 12, 2025 17:19

mamcx requested a review from bfops as a code owner December 12, 2025 17:19

mamcx requested a review from jdetter as a code owner December 12, 2025 17:19

JasonAtClockwork approved these changes Dec 16, 2025

View reviewed changes

gefjon reviewed Dec 18, 2025

View reviewed changes

mamcx force-pushed the mamcx/uuid-type branch 4 times, most recently from 6fe9cef to ba86593 Compare December 25, 2025 17:44

gefjon reviewed Dec 29, 2025

View reviewed changes

rekhoff approved these changes Dec 30, 2025

View reviewed changes

mamcx force-pushed the mamcx/uuid-type branch 2 times, most recently from 00d3c8c to b5ba0bb Compare December 30, 2025 21:27

gefjon approved these changes Dec 30, 2025

View reviewed changes

mamcx and others added 3 commits December 30, 2025 18:02

Add UUID built-in convenience type to SpacetimeDB

b4ea8cb

Fix uuid parsing and to_string in ts and c# Apply suggestions from code review Co-authored-by: Phoebe Goldman <phoebe@clockworklabs.io> Signed-off-by: Mario Montoya <mamcx@elmalabarista.com>

Rework UUID in Unreal SDK and added tests

bb0bcb6

Added new Builtin for UUID

Apply suggestions from code review

c86e720

Co-authored-by: Phoebe Goldman <phoebe@clockworklabs.io> Signed-off-by: Mario Montoya <mamcx@elmalabarista.com>

mamcx force-pushed the mamcx/uuid-type branch from b5ba0bb to c86e720 Compare December 30, 2025 23:04

jdetter approved these changes Dec 31, 2025

View reviewed changes

The DLL files here are getting reworked soon - don't add these for now.

fe119a5

gefjon enabled auto-merge December 31, 2025 22:18

gefjon disabled auto-merge December 31, 2025 22:18

gefjon added this pull request to the merge queue Jan 2, 2026

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 2, 2026

gefjon added this pull request to the merge queue Jan 2, 2026

Merged via the queue into master with commit 8fb0bcf Jan 2, 2026
40 of 42 checks passed

coolreader18 mentioned this pull request Jan 6, 2026

Use a class for ReducerCtx #3958

Merged

1 task

Add UUID built-in convenience type to SpacetimeDB #3538

Add UUID built-in convenience type to SpacetimeDB #3538

Uh oh!

Conversation

mamcx commented Oct 30, 2025 • edited by gefjon Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Changes

API and ABI breaking changes

Expected complexity level and risk

Testing

Uh oh!

JasonAtClockwork commented Dec 2, 2025

Uh oh!

JasonAtClockwork commented Dec 6, 2025

Uh oh!

Uh oh!

JasonAtClockwork left a comment

Choose a reason for hiding this comment

Uh oh!

JasonAtClockwork left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gefjon commented Dec 18, 2025

Uh oh!

gefjon commented Dec 18, 2025

Uh oh!

gefjon 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!

Uh oh!

Uh oh!

Uh oh!

rekhoff commented Dec 29, 2025

Uh oh!

rekhoff left a comment

Choose a reason for hiding this comment

Uh oh!

jdetter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

mamcx commented Oct 30, 2025 •

edited by gefjon

Loading