FCE-2044. sdk clients should fail fast#82
Conversation
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.
| @@ -0,0 +1,75 @@ | |||
| # pylint: disable=missing-class-docstring, missing-function-docstring, missing-module-docstring | |||
There was a problem hiding this comment.
question: What happened here? I'm pretty sure we use ruff, not pylint
| def check_credentials(self) -> None: | ||
| """Verify configured credentials by pinging the backend. | ||
|
|
||
| Performs a single lightweight call (``get_all_rooms``) and lets the |
There was a problem hiding this comment.
issue: I have a small concern that get_all_rooms isn't actually lightweight
There was a problem hiding this comment.
it is now, but lets plan creating a dedicated endpoint for such validation
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)