FCE-2044. sdk clients should fail fast#82
Open
czerwiukk wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds fail-fast credential validation to the Python Fishjam SDK so misconfigured clients/notifiers error immediately, and provides an explicit “construct + live verify” path for callers that want backend validation up front.
Changes:
- Introduces
MissingFishjamIdError/MissingManagementTokenErrorand a sharedvalidate_fishjam_config()helper. - Ensures
Client(and thereforeFishjamClient) andFishjamNotifiervalidate required credentials during construction. - Adds
FishjamClient.create_and_verify()andFishjamClient.check_credentials()plus new unit tests for config validation / live-check behavior.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
tests/test_config_validation.py |
Adds unit tests covering constructor validation and create_and_verify / check_credentials behaviors. |
fishjam/utils.py |
Adds validate_fishjam_config() utility used by client/notifier constructors. |
fishjam/errors.py |
Adds new public exceptions for missing fishjam_id / management_token. |
fishjam/api/_fishjam_client.py |
Documents constructor validation semantics and adds create_and_verify() + check_credentials(). |
fishjam/api/_client.py |
Enforces credential validation in the shared base client constructor. |
fishjam/_ws_notifier.py |
Enforces credential validation for the WebSocket notifier constructor. |
fishjam/__init__.py |
Re-exports the new validation exception types as part of the public package API. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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
Types of changes
not work as expected)