feat: add version check support #299
Open
Conversation
This file contains 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
☂️ Python Coverage
Overall Coverage
New Files
Modified Files
|
tdstein
commented
Sep 26, 2024
tdstein
commented
Sep 26, 2024
tdstein
commented
Sep 27, 2024
| @@ -48,6 +48,7 @@ def test_posit_credentials_provider(self): | |||
| register_mocks() | |||
|
|
|||
| client = Client(api_key="12345", url="https://connect.example/") | |||
| client.ctx.version = None | |||
There was a problem hiding this comment.
We are setting the version to None to avoid mocking the API request to /server_settings.
|
After a few iterations, I landed on the decorator approach. This seems idiomatic and self-documenting. I tried a few declarative approaches (i.e., checking the version inline), but that felt brittle. |
dbkegley
reviewed
Sep 27, 2024
| con = Client(api_key="12345", url="https://connect.example/") | ||
| assert con.oauth.get_credentials("cit")["access_token"] == "viewer-token" | ||
| c = Client(api_key="12345", url="https://connect.example/") | ||
| c.ctx.version = None |
There was a problem hiding this comment.
Should we test here that the oauth client resource respects the server's version constraint?
There was a problem hiding this comment.
Good call. I'll add it.
dbkegley
approved these changes
Sep 27, 2024
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.
Adds a new decorator,
@context.requires, which asserts version compatibility when the server version is known. The check is skipped if the server version is unknown (e.g., the Connect configuration disables version information).Also marks the OAuth API with a '2024.08.0' requirement.
Closes #272