FCE-2044 sdk clients should fail fast when misconfigured#259
Open
czerwiukk wants to merge 1 commit into
Open
Conversation
This was referenced May 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the backend server setup documentation to reflect new SDK client initialization behavior that verifies credentials early (“fail fast”) rather than deferring failures until the first room operation.
Changes:
- Adds examples of “create + verify” client initialization for TypeScript and Python.
- Updates the synchronous-construction path to use the plain constructor plus an explicit credential check call.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| First of all, view your app in the [**Fishjam developer panel**](https://fishjam.io/app) and copy your **Fishjam ID** and the **Management Token**. | ||
| They are required to proceed. Now, we are ready to dive into the code. | ||
|
|
||
| The verifying factory constructs the client and pings the Fishjam backend with the supplied credentials, so a bad `fishjamId` or `managementToken` fails at startup instead of on the first room operation. |
Comment on lines
+99
to
+100
| If you need synchronous construction (for example inside a framework plugin that is not async), use the plain constructor and verify separately. The constructor only checks that the fields are non-empty; it does not contact the backend. | ||
|
|
czerwiukk
added a commit
to fishjam-cloud/js-server-sdk
that referenced
this pull request
Jun 2, 2026
## Description Adds credentials validation to the preferred way of creating the client. There is also a separate checkCredentials method if someone needs to create the client synchronously. ## Motivation and Context The SDK client should fail fast when misconfigured. ## Documentation impact - [ ] Documentation update required - [x] Documentation updated [in another PR](fishjam-cloud/documentation#259) - [ ] No documentation update required ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
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
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
Adjusts the docs to the new sdk changes.