mirror of
https://github.com/clockworklabs/SpacetimeDB.git
synced 2026-07-24 19:12:59 -04:00
Jason Larabie
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
BSATN C++ Library
This directory contains a self-contained C++ implementation of BSATN (Binary SpacetimeDB Algebraic Type Notation) serialization.
For C++ Client Usage
The BSATN library can be used independently for serialization/deserialization without any SpacetimeDB module dependencies.
What you need:
- All headers in this directory
- Standard C++ library (C++20)
- No external dependencies
What you DON'T need:
ITypeRegistrar.h- This is only for modules, not clients- Type registration functionality
- Any files from outside this directory
Basic usage:
#include "bsatn/bsatn.h"
// Define your struct
struct MyData {
uint32_t id;
std::string name;
};
// Define serialization traits
SPACETIMEDB_STRUCT(MyData, id, name)
// Serialize
MyData data{42, "example"};
std::vector<uint8_t> buffer;
SpacetimeDB::bsatn::Writer writer(buffer);
SpacetimeDB::bsatn::serialize(writer, data);
// Deserialize
SpacetimeDB::bsatn::Reader reader(buffer);
auto result = SpacetimeDB::bsatn::deserialize<MyData>(reader);
Architecture Notes
-
ITypeRegistrar.h: Interface for optional type registration. Clients can ignore this - it's only used by SpacetimeDB modules. The interface is kept here to avoid circular dependencies while maintaining clean architecture.
-
No external dependencies: All files only include other BSATN headers or standard C++ library headers.
-
Special types: The library includes SpacetimeDB special types (Identity, ConnectionId, Timestamp, TimeDuration) that serialize with specific tags for compatibility.
File Structure
- Core:
reader.h,writer.h,serialization.h - Type system:
algebraic_type.h,traits.h,primitive_traits.h - Special types:
types.h,timestamp.h,time_duration.h,special_types.h - Utilities:
size_calculator.h,sum_type.h - Module-only:
ITypeRegistrar.h(can be ignored by clients)