mirror of
https://github.com/clockworklabs/SpacetimeDB.git
synced 2026-03-20 09:01:05 +08:00
14f79910ee
# Description of Changes
- Migrated the C++ module-definition assembly path to V10-first
internals:
- Added v10_builder and module_type_registration systems.
- Switched Module::__describe_module__ to serialize RawModuleDef with
V10 payload.
- Updated macro registration pipeline to register through V10
- Added explicit naming support across macro surface (*_NAMED variants
for reducer/procedure/
view and field/index macros).
- Reworked multi-column index macros (FIELD_MultiColumnIndex,
FIELD_MultiColumnIndex_NAMED) with
migration alias.
- Added SPACETIMEDB_SETTING_CASE_CONVERSION(...) to support case
conversion policy
- Error-path hardening by adding explicit constraint-registration error
tracking and preinit validation
- Codegen updates:
- Updated C++ moduledef regen to V10 builder types.
- Adjusted C++ codegen duplicate-variant wrapper generation to emit
proper product-type
wrappers.
- Test/harness updates:
- type-isolation-test runner now defaults to focused V10 regression
checks; --v9 runs broader
legacy/full suite.
- Added focused modules for positive/negative V10 checks:
- test_multicolumn_index_valid
- error_multicolumn_missing_field
- error_default_missing_field
- Re-enabled C++ paths in sdks/rust/tests/test.rs procedure/view/test
suites.
# API and ABI breaking changes
- Refactor of the underlying module definition
- New *_NAMED variant macros for explicit canonical naming
- FIELD_NamedMultiColumnIndex renamed to FIELD_MultiColumnIndex
# Expected complexity level and risk
3 - Large set of changes moving over to V10 with underlying changes to
make future updates a little easier
# Testing
- [x] Ran the type isolation test and expanded it
- [x] Ran the spacetimedb-sdk test framework to confirm no more drift
between C++ and other module languages
- [x] Ran Unreal test suite though not really applicable
- [x] New app creation with `spacetime init --template basic-cpp`
- [x] Ran describe module tests against Rust + C# matching with C++ on
the /modules/sdk-test* modules to find any possible mis-alignment
# Review
- [x] Another look at the new features with C++
- [x] Thoughts on *_NAMED macros, I couldn't come up with a better
solution with C++20
sdk-test-cpp C++ test module
Exercise the functionality of the SpacetimeDB C++ bindings API surface, modeling all combinations of types, with several examples of tables, indexes, and reducers.
Used to validate C++ bindings functionality and ensure parity with Rust/C# implementations.
Note: Mirrors functionality from
modules/sdk-testandmodules/sdk-test-cs.
Building
cd modules/sdk-test-cpp
spacetime build -p .
The built WASM module will be at build/lib.wasm.
Testing
# Start SpacetimeDB
spacetime start
# Publish the module
spacetime publish . test-db --delete-data
# Verify module schema
spacetime describe test-db
# Call example reducer
spacetime call test-db add_player '"Alice"'
# View logs
spacetime logs test-db -f
Module Contents
lib.cpp contains comprehensive testing of:
- All primitive types (integers, floats, bool, string)
- Special types (Identity, ConnectionId, Timestamp, TimeDuration)
- Collections (vectors, optionals)
- Custom structs and enums
- Table constraints (PrimaryKey, Unique, AutoInc, indexes)
- Lifecycle reducers (init, connect, disconnect)
- CRUD operations
For C++ bindings usage documentation, see crates/bindings-cpp/.