Add support for `browser` platform by CloneDeath · Pull Request #274 · clockworklabs/com.clockworklabs.spacetimedbsdk

CloneDeath · 2025-03-15T13:30:55Z

Description of Changes

Added support for the browser platform.

This required:

Replacing Thread.Start with a Task (Thread.Start is not supported for browser platforms)
- also made PreProcessMessages async, in order to use Channels async methods
Configuring the Task to be allowed to run on a separate thread (ConfigureAwait(false))
Replacing BlockingCollection (which is not supported on the browser platform) with Channel (which is supported on all platforms)
Configuring the task spawned in IDbConnection.Connect to run on any thread, not necessarily the caller (ConfigureAwait(false))
Removed Ws.Options.UseDefaultCredentials = true; (this is already true by default. In addition, using this setter is not being supported by browser platforms.)

Unrelated:

Added check to IsConnected before closing a connection, to avoid an exception being thrown about the connection not being open (as it's already closed).

Remaining Issues:

Subscriptions still do not work on the browser platform (likely either to a task misconfiguration, or it could be an issue in my Blazor chat implementation). Regardless, subscriptions still work fine on the CLI implementation, so this is not a regression.

API

This is an API breaking change to the SDK

N/A. No changes to the API.

Requires SpacetimeDB PRs

N/A

Testsuite

SpacetimeDB branch name: master

Testing

Testing was performed manually inside of a Blazor "quickstart-chat" client, code can be found here: https://github.com/CloneDeath/SpacetimeWebChat/tree/stdb-browser-support

Able to send messages in the Blazor chat client
Able to send and receive messages in the CLI chat client

…i-updates Some API updates

…i-updates2 More API updates

…w updates and reducer events

…Improvements API callback improvements

…ption Add sslEnabled option to Connect function

* Fix compilation issue with master * Initial push for SATS (still WIP) * Small build fix * Small update * Updates from meeting with Tyler * Fixed issues with LayoutExplicit and added some missing functions * AlgebraicValue cleanup * Copied changes from BitCraftMini * Removed TypeDef --------- Co-authored-by: Clockwork Labs <no-reply@clockworklabs.io> Co-authored-by: Tyler Cloutier <cloutiertyler@aol.com> Co-authored-by: John Detter <no-reply@boppygames.gg>

* Upload script to help deploying to our partners * You have to specify hosts individually * Small fix * Another small fix - tested + working --------- Co-authored-by: John Detter <no-reply@boppygames.gg>

* Serialize byte arrays as hex * Fix namespace * Small fix --------- Co-authored-by: John Detter <no-reply@boppygames.gg>

* First pass * Committing meta file * Removed option type - unneeded * Implementing new some converter * Some converter updates * Tons of fixes here * Cleaned up the some/enum serialization implementation --------- Co-authored-by: John Detter <no-reply@boppygames.gg>

Co-authored-by: John <no-reply@boppygames.gg>

Co-authored-by: John Detter <no-reply@boppygames.gg>

…ckworklabs#15) Co-authored-by: John Detter <no-reply@boppygames.gg>

* Several updates to the way ClientCache + processing updates works * Client cache changes working * Removed log statements --------- Co-authored-by: John Detter <no-reply@boppygames.gg>

* Copied changes from BitCraft * Applied state diff changes * State diffs complete * Compilation fix * Fix build issues --------- Co-authored-by: John Detter <no-reply@boppygames.gg>

* Pulled SpacetimeUnitySDK from the BitCraft project * Removed unused logs * Removed primary key functionality * Fix compilation issues with older version of C# * Primary key client implementation * Another row update fix --------- Co-authored-by: John <no-reply@boppygames.gg>

* Pulled SpacetimeUnitySDK from the BitCraft project * Removed unused logs * Removed primary key functionality * Fix compilation issues with older version of C# --------- Co-authored-by: John <no-reply@boppygames.gg>

* Adding event parameter to table callbacks * Reverted a namespace change --------- Co-authored-by: Steve <steve@codefics.com> Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

Co-authored-by: Derek Brinkmann <dbrinkmann@citadelstudios.net>

* Add onSubscriptionUpdate callback * Remove unnecesary onTransactionComplete --------- Co-authored-by: Derek Brinkmann <dbrinkmann@citadelstudios.net>

…ed from callbacks (clockworklabs#20) Co-authored-by: Steve <steve@codefics.com>

* Deserializing reducer args before table updates so they can be accessed from callbacks * Reducer arguments in table events * Removed redundant onSubscriptionUpdate --------- Co-authored-by: Steve <steve@codefics.com> Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com> Co-authored-by: John Detter <no-reply@boppygames.gg>

Co-authored-by: Steve <steve@codefics.com>

Co-authored-by: John Detter <no-reply@boppygames.gg>

* Deserializing reducer args before table updates so they can be accessed from callbacks * Reducer arguments in table events * Adding OnBeforeDelete event to tables * Renaming ReducerCallInfo to ReducerEvent * Removed extra onSubscriptionUpdate --------- Co-authored-by: Steve <steve@codefics.com> Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

* Deserializing reducer args before table updates so they can be accessed from callbacks * Reducer arguments in table events * Adding OnBeforeDelete event to tables --------- Co-authored-by: Steve <steve@codefics.com> Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

…clockworklabs#244) ## Description of Changes as described ## API no breaks ## Requires SpacetimeDB PRs clockworklabs/SpacetimeDB#2241 ## Testsuite SpacetimeDB branch name: jgilles/unknown_reducer ## Testing see SpacetimeDB PR

## Description of Changes Companion PR for the http api glowup. ## API Not a breaking change; this catches us up to being compatible with a breakage introduced by - clockworklabs/SpacetimeDB#2225. ## Requires SpacetimeDB PRs - clockworklabs/SpacetimeDB#2225 ## Testsuite SpacetimeDB branch name: master ## Testing Existing CI passes (it was failing without this change since it couldn't connect). Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>

## Description of Changes We were not stripping `/` from the end of URIs provided to `Connect`. We manually append `/...` to the provided addresses, so if we don't start by stripping trailing `/`s, we end up with `//` in the URI and we get errors. Addresses part of clockworklabs/SpacetimeDB#1551. ## API No breaking changes. This fixes an error case. ## Requires SpacetimeDB PRs None ## Testsuite SpacetimeDB branch name: master ## Testing - [x] Tested the quickstart chat client with a host containing a trailing `/` ``` # start a server, publish the module, send some input # I also updated one line in `client.csproj` to use `Net8.0` because I no longer have `Net7.0` installed $ cd examples~/quickstart/client $ dotnet run [I] SpacetimeDBClient: Connecting to ws://localhost:3000 quickstart-chat C200098E is online Connected C2007471: hello C2007471: godo C2007471: asdf $ sed -i 's/localhost:3000/localhost:3000\//' Program.cs $ dotnet run [I] SpacetimeDBClient: Connecting to ws://localhost:3000 quickstart-chat C2000601 is online Connected C2007471: hello C2007471: godo C2007471: asdf $ git diff diff --git a/examples~/quickstart/client/Program.cs b/examples~/quickstart/client/Program.cs index 9eb43b1..289e736 100644 --- a/examples~/quickstart/client/Program.cs +++ b/examples~/quickstart/client/Program.cs @@ -7,8 +7,8 @@ using System.Threading; using SpacetimeDB; using SpacetimeDB.Types; -const string HOST = "http://localhost:3000"; -const string DBNAME = "chatqs"; +const string HOST = "http://localhost:3000/"; +const string DBNAME = "quickstart-chat"; // our local client SpacetimeDB identity Identity? local_identity = null; diff --git a/examples~/quickstart/client/client.csproj b/examples~/quickstart/client/client.csproj index 48917cc..ab7ce44 100644 --- a/examples~/quickstart/client/client.csproj +++ b/examples~/quickstart/client/client.csproj @@ -2,7 +2,7 @@ <PropertyGroup> <OutputType>Exe</OutputType> - <TargetFramework>net7.0</TargetFramework> + <TargetFramework>net8.0</TargetFramework> <CheckEolTargetFramework>false</CheckEolTargetFramework> <ImplicitUsings>disable</ImplicitUsings> <Nullable>enable</Nullable> ``` --------- Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>

## Description of Changes Switches to Bearer authentication, which is the more proper auth schema to use with tokens. ## API - [ ] This is an API breaking change to the SDK ## Requires SpacetimeDB PRs - clockworklabs/SpacetimeDB#2181 ## 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 --------- Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com> Co-authored-by: rekhoff <r.ekhoff@clockworklabs.io> Co-authored-by: James Gilles <jameshgilles@gmail.com>

## Description of Changes This updates the CI check protecting the release branch, as part of clockworklabs#226 (see that ticket for more details). Once this is merged, it will need to be cherrypicked into our release branch in order to take effect there. The check itself has also been renamed. I have already updated the branch protection rules to look for the new name. ## API No code changes. ## Requires SpacetimeDB PRs None ## Testsuite SpacetimeDB branch name: master ## Testing The previous behavior was well-tested, and I've just changed some strings here, so I have not done further testing. It does pass on this branch though. Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>

## Description of Changes Add SubscribeMulti and UnsubscribeMulti from upstream. Fix unsubscribe bug found by testing against Bitcraft: Calling `UnsubscribeThen` with any (non-null) callback would result in an exception incorrectly telling the user that `Unsubscribe` had been called twice. Multiplicity support is implemented with unit tests + manual testing of quickstart-chat. Also, rows in the client cache are now looked up by primary key if available, which I suspect is going to be a large performance boost. ## API - [x] This is an API breaking change to the SDK *If the API is breaking, please state below what will break* ## 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: jgilles/final-cs-codegen-changes ## Testing *Write instructions for a test that you performed for this PR* - [x] unit tests - [ ] Working with Ryan to add a test suite. - [x] blackholio

## Description of Changes Updates comment on `SubscribeToAllTables` since undefined behavior is not possible anymore. No code changes made in this patch. ## API - [ ] This is an API breaking change to the SDK *If the API is breaking, please state below what will break* ## Requires SpacetimeDB PRs N/A ## 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 No code changes made in this patch.

## Description of Changes Adds closing `</summary>` to end of comment. ## API No breaking changes ## Requires SpacetimeDB PRs N/A ## 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 Just fixing a comment. No tests required.

…ument. (clockworklabs#258) # Description of Changes Update the C# server and client SDK quickstart-chat example to match the code presented in the tutorial, as of clockworklabs/spacetime-docs#170 . Also renamed the directory from `quickstart` to `quickstart-chat` in order to be more specific. # API and ABI breaking changes If this is an API or ABI breaking change, please apply the corresponding GitHub label. # Expected complexity level and risk 1 ## Requires SpacetimeDB PRs SpacetimeDB branch name: master com.clockworklabs.spacetimedbsdk: master # Testing *Describe any testing you've done, and any testing you'd like your reviewers to do, so that you're confident that all the changes work as expected!* - [x] Ran `quickstart-chat` C# server and C# client locally and: - Set my name. - Sent a message. - Restarted and viewed the message backlog. - Sent a few more messages. - Exited, deleted my local token, restarted and connected as a new identity. - Set my new identity's name. - Sent a message as my new identity. --------- Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com> Co-authored-by: John Detter <no-reply@boppygames.gg> Co-authored-by: james gilles <jameshgilles@gmail.com>

## Description of Changes Just link to the existing docs. ## API - [ ] This is an API breaking change to the SDK *If the API is breaking, please state below what will break* ## Requires SpacetimeDB PRs ## Testsuite SpacetimeDB branch name: master ## Testing

## Description of Changes This just bumps our package versions to be 1.0.0. ## API No breaking changes ## Requires SpacetimeDB PRs clockworklabs/SpacetimeDB#2283 ## Testsuite SpacetimeDB branch name: bfops/bump-version ## Testing Existing CI only. --------- Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com> Co-authored-by: John Detter <no-reply@boppygames.gg> Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

…abs#270) ## Description of Changes Relaxed this version number from `1.0.0` to `1.0.*` ## API No breaking changes. ## Requires SpacetimeDB PRs None ## Testsuite SpacetimeDB branch name: master ## Testing Existing CI should run `dotnet test` and confirm that this is not broken. --------- Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>

## Description of Changes *Describe what has been changed, any new features or bug fixes* I've already pushed this out to nuget here: <https://www.nuget.org/packages/SpacetimeDB.ClientSDK> - We want to update our REAME on nuget.org because the README that we released as part of 1.0.1 was very much out of date. ## API - [ ] This is an API breaking change to the SDK *If the API is breaking, please state below what will break* ## Requires SpacetimeDB PRs *List any PRs here that are required for this SDK change to work* NA ## 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* - [x] The README is updated. Co-authored-by: John Detter <no-reply@boppygames.gg>

Adds an additional test of the `GenericEqualityComparer` function for `Integer`, `String`, `Byte Array`, `Identity`, `User` and `TaggedEnum` type comparisons. This PR resolves additional checks as reported in by [Issue 230](clockworklabs#230) that where not-yet covered elsewhere. ## API - [ ] This is an API breaking change to the SDK ## Requires SpacetimeDB PRs No other PR are needed for this to work. ## Testsuite SpacetimeDB branch name: master ## Testing - [X] Locally ran `dotnet test` against the `tests.csproj` project and it passed all tests

…abs#268) ## Description of Changes Updated two README docs: * README.md - Updated links to point to Blackholio repo and tutorial docs. * README.dotnet.md - Updated to point to new URL paths for C# SDK Quickstart and Reference docs. ## API - [ ] This is an API breaking change to the SDK ## Requires SpacetimeDB PRs N/A - Docs only change ## Testsuite N/A - Docs only change SpacetimeDB branch name: master ## Testing - [X] Clicked on each new link and confirm the browser can locate the new locations. --------- Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com> Co-authored-by: John Detter <no-reply@boppygames.gg>

## Description of Changes I don't know if the DLLs need updating, but updated the DLLs just in case. ## API Incorporate any chances in SpacetimeDB 1.0.1. There should be no breaking changes. ## Requires SpacetimeDB PRs *List any PRs here that are required for this SDK change to work* ## Testsuite SpacetimeDB branch name: release/v1.0.1 ## Testing None. Will test in release. --------- Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>

Updates package version to 1.0.1 ## API - [ ] This is an API breaking change to the SDK ## Requires SpacetimeDB PRs No specific PR needed ## Testsuite SpacetimeDB branch name: release/v1.0.1 ## Testing - [X] Confirmed Unity sees version as 1.0.1 after change

…r compatible Channels

CloneDeath · 2025-03-15T13:33:50Z

Fixes clockworklabs/SpacetimeDB#2414

z0isch · 2025-03-24T14:06:01Z

@@ -66,10 +65,6 @@ public async Task Connect(string? auth, string host, string nameOrAddress, Conne
            {
                Ws.Options.SetRequestHeader("Authorization", $"Bearer {auth}");


I ran into issues here as well, I don't think browser supports SetRequestHeader.

You can use a param in the querystring instead though like

if (auth != null) { uri += $"&token={Uri.EscapeDataString(auth)}"; }

bfops · 2025-04-03T18:31:58Z

Thanks for opening this! We'll work on getting it reviewed.

bfops · 2025-08-07T21:58:35Z

I think this is superseded by clockworklabs/SpacetimeDB#2975.

We're currently in the process of merging this repo into SpacetimeDB, so if clockworklabs/SpacetimeDB#2975 is insufficient, please open any remaining changes against SpacetimeDB/sdks/csharp.

jdetter and others added 30 commits November 2, 2022 12:01

Merge pull request clockworklabs#1 from clockworklabs/jdetter/some-ap…

583b612

…i-updates Some API updates

Merge pull request clockworklabs#2 from clockworklabs/jdetter/some-ap…

a9f8bef

…i-updates2 More API updates

Improved names

7832181

.gitignore change

b37b468

Several fixes to sending when the websocket is closed.

fe3a8ad

Give SDK users access to the token key

355b9e9

Changes to the Unity SDK to support callbacks for individual table ro…

842cb00

…w updates and reducer events

Merge pull request clockworklabs#3 from clockworklabs/Derek-Callback-…

40b19b7

…Improvements API callback improvements

Add sslEnabled option to Connect function

ab12cef

Merge pull request clockworklabs#4 from clockworklabs/derek-add-SSL-o…

3364cd7

…ption Add sslEnabled option to Connect function

SDK Upload Script (clockworklabs#7)

7fc5463

* Upload script to help deploying to our partners * You have to specify hosts individually * Small fix * Another small fix - tested + working --------- Co-authored-by: John Detter <no-reply@boppygames.gg>

Json Byte Arrays Serialized as Hex (clockworklabs#8)

28897a3

* Serialize byte arrays as hex * Fix namespace * Small fix --------- Co-authored-by: John Detter <no-reply@boppygames.gg>

Fix compilation issue (clockworklabs#11)

ca5eefe

Co-authored-by: John <no-reply@boppygames.gg>

Automatically find Unity on macOS (clockworklabs#12)

6151939

Co-authored-by: John Detter <no-reply@boppygames.gg>

GetEntries now returns both AlgebraicValue and object as a tuple (clo…

cddda19

…ckworklabs#15) Co-authored-by: John Detter <no-reply@boppygames.gg>

Use Network Thread for Processing DB Rows (clockworklabs#14)

9f9e549

* Several updates to the way ClientCache + processing updates works * Client cache changes working * Removed log statements --------- Co-authored-by: John Detter <no-reply@boppygames.gg>

State Diffs (clockworklabs#16)

51086a2

* Copied changes from BitCraft * Applied state diff changes * State diffs complete * Compilation fix * Fix build issues --------- Co-authored-by: John Detter <no-reply@boppygames.gg>

SpacetimeDB SDK Version 0.4.1 (clockworklabs#17)

aad6c4b

* Pulled SpacetimeUnitySDK from the BitCraft project * Removed unused logs * Removed primary key functionality * Fix compilation issues with older version of C# --------- Co-authored-by: John <no-reply@boppygames.gg>

Adding event parameter to table callbacks (clockworklabs#19)

11801d4

* Adding event parameter to table callbacks * Reverted a namespace change --------- Co-authored-by: Steve <steve@codefics.com> Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>

Fix compile error in sdk (clockworklabs#22)

bc6ed3e

Co-authored-by: Derek Brinkmann <dbrinkmann@citadelstudios.net>

Add onSubscriptionUpdate callback (clockworklabs#21)

c15c54e

* Add onSubscriptionUpdate callback * Remove unnecesary onTransactionComplete --------- Co-authored-by: Derek Brinkmann <dbrinkmann@citadelstudios.net>

Deserializing reducer args before table updates so they can be access…

fb72396

…ed from callbacks (clockworklabs#20) Co-authored-by: Steve <steve@codefics.com>

Changed guid (clockworklabs#25)

30f4347

Co-authored-by: Steve <steve@codefics.com>

Fixed API (clockworklabs#26)

cf771d3

Co-authored-by: John Detter <no-reply@boppygames.gg>

kazimuth and others added 19 commits February 11, 2025 13:21

Switched Thread.Start to Task.Run, for browser compatability.

c0c56bf

Fixed other task issues, and replaced BlockingCollections with browse…

e2fd71c

…r compatible Channels

jdetter added the community label Mar 16, 2025

z0isch reviewed Mar 24, 2025

View reviewed changes

jdetter mentioned this pull request Mar 24, 2025

Support for Unity WebGL builds #278

Closed

2 tasks

bfops linked an issue Apr 3, 2025 that may be closed by this pull request

C# Blazor / Browser Support clockworklabs/SpacetimeDB#2414

Open

This was referenced Jul 21, 2025

Add support for browser platform #353

Closed

Add support for browser platform clockworklabs/SpacetimeDB#2975

Closed

bfops force-pushed the master branch from aecb141 to a916977 Compare August 5, 2025 21:13

bfops closed this Aug 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for `browser` platform#274

Add support for `browser` platform#274
CloneDeath wants to merge 188 commits into
clockworklabs:masterfrom
CloneDeath:master

CloneDeath commented Mar 15, 2025 •

edited

Loading

Uh oh!

CloneDeath commented Mar 15, 2025 •

edited

Loading

Uh oh!

z0isch Mar 24, 2025

Uh oh!

bfops commented Apr 3, 2025

Uh oh!

bfops commented Aug 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

18 participants

		@@ -66,10 +65,6 @@ public async Task Connect(string? auth, string host, string nameOrAddress, Conne
		{
		Ws.Options.SetRequestHeader("Authorization", $"Bearer {auth}");

Conversation

CloneDeath commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Changes

API

Requires SpacetimeDB PRs

Testsuite

Testing

Uh oh!

CloneDeath commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

z0isch Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

bfops commented Apr 3, 2025

Uh oh!

bfops commented Aug 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

18 participants

CloneDeath commented Mar 15, 2025 •

edited

Loading

CloneDeath commented Mar 15, 2025 •

edited

Loading