Make ColumnIndexAttribute bitflags in the ABI #212
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
As we're adding more variants, it's getting harder to keep track of the "A implies B" relationships between enum variants and to correctly do checks like "is this column autoinc" in different places. Using bitflags makes expressing those relationships more natural and checking simpler - e.g. you can just do `contains(AUTO_INC)` as a single bit operation instead of having to remember and list all possible variants that imply autoinc, especially if we're going to add more flags in the future. Initially I was going to make this change just in C# module generator and convert between ABI enum and bitflags over there, but it seems better to do this at ABI level so it simplifies Rust handling as well.
kulakowski
reviewed
Aug 21, 2023
kulakowski
approved these changes
Aug 21, 2023
Contributor
kulakowski
left a comment
kulakowski
left a comment
There was a problem hiding this comment.
Approved but I don't know when a good time for an ABI breaking change is right now.
Contributor
Author
|
We probably need to come up with some strategy to update C# dep when we change ABI. If this PR is merged now, that will make all the C# deps incompatible. The only way I can think of to avoid that would be to bump C# dep to I'm not sure what strategy is to update all of them together, in a way that ABI used by the website is compatible with that of the backend. |
RReverser
added a commit
that referenced
this pull request
Sep 12, 2023
This bumps C# dependency to be compatible with #212 when the next version of SpacetimeDB is released.
bfops
pushed a commit
that referenced
this pull request
Jul 17, 2025
* Standalone guide * Several improvements * Title update * Updated nav.js * Guide updated * Small fix * Guide working again after `--root-dir` change * Finished + tested * Apply suggestions from code review * Updates after review * Update navigation * Apply suggestions from code review * Update docs/deploying/spacetimedb-standalone.md * Update docs/deploying/spacetimedb-standalone.md --------- Co-authored-by: John Detter <no-reply@boppygames.gg> Co-authored-by: Mazdak Farrokhzad <twingoow@gmail.com>
bfops
added a commit
that referenced
this pull request
Jul 17, 2025
## Description of Changes `WithCredentials` was designed for our old auth model, where tokens were always issued by the SpacetimeDB host alongside an `Identity`, and therefore the bearer always knew their `Identity`. In our new auth model, a client may have a valid auth-able JWT but not know what `Identity` it will result in, as the `Identity` is computed based on the hash of some of the token's contents, and this hashing algorithm is not included in our client SDKs. As such, this PR revises `WithCredentials` to `WithToken`, which just accepts the token. ## API - [x] This is an API breaking change to the SDK *If the API is breaking, please state below what will break* `WithCredentials` is renamed and its signature changes. ## Requires SpacetimeDB PRs *List any PRs here that are required for this SDK change to work* ## Testsuite *If you would like to run the your SDK changes in this PR against a specific SpacetimeDB branch, specify that here. This can be a branch name or a link to a PR.* SpacetimeDB branch name: master ## Testing *Write instructions for a test that you performed for this PR* - [ ] @cloutiertyler should test this with the Unity tutorial, if possible. --------- Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>
bfops
added a commit
that referenced
this pull request
Aug 7, 2025
## Description of Changes `WithCredentials` was designed for our old auth model, where tokens were always issued by the SpacetimeDB host alongside an `Identity`, and therefore the bearer always knew their `Identity`. In our new auth model, a client may have a valid auth-able JWT but not know what `Identity` it will result in, as the `Identity` is computed based on the hash of some of the token's contents, and this hashing algorithm is not included in our client SDKs. As such, this PR revises `WithCredentials` to `WithToken`, which just accepts the token. ## API - [x] This is an API breaking change to the SDK *If the API is breaking, please state below what will break* `WithCredentials` is renamed and its signature changes. ## Requires SpacetimeDB PRs *List any PRs here that are required for this SDK change to work* ## Testsuite *If you would like to run the your SDK changes in this PR against a specific SpacetimeDB branch, specify that here. This can be a branch name or a link to a PR.* SpacetimeDB branch name: master ## Testing *Write instructions for a test that you performed for this PR* - [ ] @cloutiertyler should test this with the Unity tutorial, if possible. --------- Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>
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 is reopened #72 with some fixes.)
As we're adding more variants, it's getting harder to keep track of the "A implies B" relationships between enum variants and to correctly do checks like "is this column autoinc" in different places.
Using bitflags makes expressing those relationships more natural and checking simpler - e.g. you can just do
contains(AUTO_INC)as a single bit operation instead of having to remember and list all possible variants that imply autoinc, especially if we're going to add more flags in the future.Initially I was going to make this change just in C# module generator and convert between ABI enum and bitflags over there, but it seems better to do this at ABI level so it simplifies Rust handling as well.
API
If the API is breaking, please state below what will break