Skip to content

Switch to using imported module idents for marking version requirements #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Oct 11, 2023
Merged

Switch to using imported module idents for marking version requirements #335

merged 2 commits into from
Oct 11, 2023

Conversation

@coolreader18
Copy link
Collaborator

@coolreader18 coolreader18 commented Sep 27, 2023

Description of Changes

Alternative to #233

API and ABI

  • This is a breaking change to the module ABI
  • This is a breaking change to the module API
  • This is a breaking change to the ClientAPI
  • This is a breaking change to the SDK API

If the API is breaking, please state below what will break

@coolreader18 coolreader18 force-pushed the noa/module-ident-abi-version branch 2 times, most recently from e8f6832 to 7b6a024 Compare September 27, 2023 22:50
mamcx
mamcx approved these changes Sep 28, 2023
View reviewed changes
Copy link
Contributor

@mamcx mamcx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@cloutiertyler cloutiertyler mentioned this pull request Sep 30, 2023
Merged
4 tasks
@coolreader18 coolreader18 force-pushed the noa/module-ident-abi-version branch from 7b6a024 to a0e6b75 Compare October 3, 2023 19:29
@coolreader18 coolreader18 force-pushed the noa/module-ident-abi-version branch from a0e6b75 to 9896525 Compare October 4, 2023 17:05
@coolreader18 coolreader18 force-pushed the noa/module-ident-abi-version branch from 9896525 to 8092fdc Compare October 11, 2023 17:49
RReverser
RReverser reviewed Oct 11, 2023
View reviewed changes
crates/cli/src/subcommands/generate/mod.rs Outdated
},
)?;
linker.func_wrap("spacetime", "_buffer_alloc", WasmCtx::buffer_alloc)?;
linker.func_wrap("spacetime_6.0", "_buffer_alloc", WasmCtx::buffer_alloc)?;
Copy link
Contributor

@RReverser RReverser Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: extract the constant somewhere at the top of the file?

Copy link
Collaborator Author

@coolreader18 coolreader18 Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh maybe I'll just use the constant from spacetimedb-lib

RReverser
RReverser reviewed Oct 11, 2023
View reviewed changes
crates/bindings-csharp/Runtime/bindings.c
__attribute__((import_module("spacetime"),
#define STDB_ABI_MAJOR_VERSION "6"
#define STDB_IMPORT_MODULE_MINOR(minor) "spacetime_" STDB_ABI_MAJOR_VERSION "." #minor
#define STDB_IMPORT_MODULE STDB_IMPORT_MODULE_MINOR(0)
Copy link
Contributor

@RReverser RReverser Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: let's just inline the string here, same as Rust does. It's a bit weird to edit two parts of version in two places.

Copy link
Collaborator Author

@coolreader18 coolreader18 Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure 👍

Copy link
Contributor

@RReverser RReverser Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant inline minor into the same string too, so that it's just spacetime_6.0 like in Rust.

RReverser
RReverser approved these changes Oct 11, 2023
View reviewed changes
Copy link
Contributor

@RReverser RReverser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM % nits

@coolreader18 coolreader18 merged commit 4c6c947 into master Oct 11, 2023
@coolreader18 coolreader18 deleted the noa/module-ident-abi-version branch October 11, 2023 19:15
@jdetter jdetter removed the invalid label Oct 17, 2023
cloutiertyler added a commit that referenced this pull request Oct 18, 2023
@cloutiertyler
Revert "Switch to using imported module idents for marking version re…
f25df58 
…quirements (#335)"

This reverts commit 4c6c947.
jdetter pushed a commit that referenced this pull request Oct 31, 2023
@cloutiertyler @jdetter
Revert "Switch to using imported module idents for marking version re…
aa7f14b 
…quirements (#335)"

This reverts commit 4c6c947.
@jdetter jdetter mentioned this pull request Oct 31, 2023
Closed
4 tasks
@kulakowski kulakowski added the abi-break A PR that makes an ABI breaking change label Nov 7, 2023
@jdetter jdetter mentioned this pull request Nov 15, 2023
Closed
bfops pushed a commit that referenced this pull request Jul 17, 2025
@Lethalchip
Correcting Reducer Callback Information in llms.md (#335)
45a83c9 
* update reducer callback with correct info

* remove flavor text - not needed
bfops added a commit that referenced this pull request Jul 17, 2025
@bfops
Add tools~/upgrade-version.py (#335)
6c419cc 
## Description of Changes
I'm tired of messing up version updates. I "vibecoded" a script to do
it.

## API

 - [ ] This is an API breaking change to the SDK

No. No changes to runtime code.

## Requires SpacetimeDB PRs
None

## Testsuite
SpacetimeDB branch name: master

## Testing
```
$ python3 tools~/update-version.py 1.1.1
Updated: ./SpacetimeDB.ClientSDK.csproj
Updated: ./tests~/tests.csproj
Updated: ./examples~/regression-tests/server/StdbModule.csproj
Updated: ./examples~/regression-tests/client/client.csproj
Updated: ./examples~/quickstart-chat/server/StdbModule.csproj
Updated: ./examples~/quickstart-chat/client/client.csproj
Updated version in package.json to 1.1.1

$ git diff -U1
diff --git a/SpacetimeDB.ClientSDK.csproj b/SpacetimeDB.ClientSDK.csproj
index 5248df6..b3ca7e8 100644
--- a/SpacetimeDB.ClientSDK.csproj
+++ b/SpacetimeDB.ClientSDK.csproj
@@ -18,4 +18,4 @@
     <RepositoryUrl>https://github.com/clockworklabs/com.clockworklabs.spacetimedbsdk</RepositoryUrl>
-    <AssemblyVersion>1.2.1</AssemblyVersion>
-    <Version>1.2.1</Version>
+    <AssemblyVersion>1.1.1</AssemblyVersion>
+    <Version>1.1.1</Version>
     <DefaultItemExcludes>$(DefaultItemExcludes);*~/**</DefaultItemExcludes>
@@ -27,3 +27,3 @@
   <ItemGroup>
-    <PackageReference Include="SpacetimeDB.BSATN.Runtime" Version="1.2.*" />
+    <PackageReference Include="SpacetimeDB.BSATN.Runtime" Version="1.1.*" />
 
diff --git a/examples~/quickstart-chat/server/StdbModule.csproj b/examples~/quickstart-chat/server/StdbModule.csproj
index 0513a81..f290d22 100644
--- a/examples~/quickstart-chat/server/StdbModule.csproj
+++ b/examples~/quickstart-chat/server/StdbModule.csproj
@@ -16,3 +16,3 @@
   <ItemGroup>
-    <PackageReference Include="SpacetimeDB.Runtime" Version="1.2.*" />
+    <PackageReference Include="SpacetimeDB.Runtime" Version="1.1.*" />
   </ItemGroup>
diff --git a/examples~/regression-tests/server/StdbModule.csproj b/examples~/regression-tests/server/StdbModule.csproj
index c6b1cba..3284863 100644
--- a/examples~/regression-tests/server/StdbModule.csproj
+++ b/examples~/regression-tests/server/StdbModule.csproj
@@ -10,3 +10,3 @@
   <ItemGroup>
-    <PackageReference Include="SpacetimeDB.Runtime" Version="1.2.*" />
+    <PackageReference Include="SpacetimeDB.Runtime" Version="1.1.*" />
   </ItemGroup>
diff --git a/package.json b/package.json
index 7839151..a627246 100644
--- a/package.json
+++ b/package.json
@@ -3,3 +3,3 @@
   "displayName": "SpacetimeDB SDK",
-  "version": "1.2.1",
+  "version": "1.1.1",
   "description": "The SpacetimeDB Client SDK is a software development kit (SDK) designed to interact with and manipulate SpacetimeDB modules..",
```

---------

Co-authored-by: Zeke Foppa <[email protected]>
bfops added a commit that referenced this pull request Aug 7, 2025
@bfops
Add tools~/upgrade-version.py (#335)
830b23d 
## Description of Changes
I'm tired of messing up version updates. I "vibecoded" a script to do
it.

## API

 - [ ] This is an API breaking change to the SDK

No. No changes to runtime code.

## Requires SpacetimeDB PRs
None

## Testsuite
SpacetimeDB branch name: master

## Testing
```
$ python3 tools~/update-version.py 1.1.1
Updated: ./SpacetimeDB.ClientSDK.csproj
Updated: ./tests~/tests.csproj
Updated: ./examples~/regression-tests/server/StdbModule.csproj
Updated: ./examples~/regression-tests/client/client.csproj
Updated: ./examples~/quickstart-chat/server/StdbModule.csproj
Updated: ./examples~/quickstart-chat/client/client.csproj
Updated version in package.json to 1.1.1

$ git diff -U1
diff --git a/SpacetimeDB.ClientSDK.csproj b/SpacetimeDB.ClientSDK.csproj
index 5248df6..b3ca7e8 100644
--- a/SpacetimeDB.ClientSDK.csproj
+++ b/SpacetimeDB.ClientSDK.csproj
@@ -18,4 +18,4 @@
     <RepositoryUrl>https://github.com/clockworklabs/com.clockworklabs.spacetimedbsdk</RepositoryUrl>
-    <AssemblyVersion>1.2.1</AssemblyVersion>
-    <Version>1.2.1</Version>
+    <AssemblyVersion>1.1.1</AssemblyVersion>
+    <Version>1.1.1</Version>
     <DefaultItemExcludes>$(DefaultItemExcludes);*~/**</DefaultItemExcludes>
@@ -27,3 +27,3 @@
   <ItemGroup>
-    <PackageReference Include="SpacetimeDB.BSATN.Runtime" Version="1.2.*" />
+    <PackageReference Include="SpacetimeDB.BSATN.Runtime" Version="1.1.*" />
 
diff --git a/examples~/quickstart-chat/server/StdbModule.csproj b/examples~/quickstart-chat/server/StdbModule.csproj
index 0513a81..f290d22 100644
--- a/examples~/quickstart-chat/server/StdbModule.csproj
+++ b/examples~/quickstart-chat/server/StdbModule.csproj
@@ -16,3 +16,3 @@
   <ItemGroup>
-    <PackageReference Include="SpacetimeDB.Runtime" Version="1.2.*" />
+    <PackageReference Include="SpacetimeDB.Runtime" Version="1.1.*" />
   </ItemGroup>
diff --git a/examples~/regression-tests/server/StdbModule.csproj b/examples~/regression-tests/server/StdbModule.csproj
index c6b1cba..3284863 100644
--- a/examples~/regression-tests/server/StdbModule.csproj
+++ b/examples~/regression-tests/server/StdbModule.csproj
@@ -10,3 +10,3 @@
   <ItemGroup>
-    <PackageReference Include="SpacetimeDB.Runtime" Version="1.2.*" />
+    <PackageReference Include="SpacetimeDB.Runtime" Version="1.1.*" />
   </ItemGroup>
diff --git a/package.json b/package.json
index 7839151..a627246 100644
--- a/package.json
+++ b/package.json
@@ -3,3 +3,3 @@
   "displayName": "SpacetimeDB SDK",
-  "version": "1.2.1",
+  "version": "1.1.1",
   "description": "The SpacetimeDB Client SDK is a software development kit (SDK) designed to interact with and manipulate SpacetimeDB modules..",
```

---------

Co-authored-by: Zeke Foppa <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mamcx mamcx mamcx approved these changes

+1 more reviewer

@RReverser RReverser RReverser approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

abi-break A PR that makes an ABI breaking change

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@coolreader18 @mamcx @RReverser @kulakowski @jdetter @cloutiertyler