Skip to content
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.

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

Amend withCredentials to withToken #128

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Amend withCredentials to withToken #128

wants to merge 3 commits into from

Conversation

gefjon
Copy link
Contributor

@gefjon gefjon commented Jan 13, 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

  • This is an API breaking change to the SDK

See description.

Requires SpacetimeDB PRs

N/a

Testing

Completely untested.

`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.
Copy link

changeset-bot bot commented Jan 13, 2025

⚠️ No Changeset found

Latest commit: b63386a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

pkg-pr-new bot commented Jan 14, 2025

Open in Stackblitz

npm i https://pkg.pr.new/@clockworklabs/spacetimedb-sdk@128

commit: b63386a

Copy link

pkg-pr-new bot commented Jan 14, 2025

Open in Stackblitz

npm i https://pkg.pr.new/@clockworklabs/spacetimedb-sdk@128

commit: ce67be7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant