Add support for viewer-based credentials on Posit Connect #289
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
This commit wires up a new credential provider for Connect's viewer-based credentials feature [0]. Most of the actual work is outsourced to a new shared package, `connectcreds` [1]. Viewer credentials are inherently tied to a given Shiny session, which is at odds with `gargle`'s existing view that a single credential is active for a given R process -- so we need to unwind this assumption. In order to support storing and retrieving "session" credentials from the existing `AuthState` object -- while preserving backward- and forward-compatibility with existing packages -- I have modified its API so that setters and getters are now aware of the existince of session credentials. (There are comprehensive unit tests that explain the details.) Existing packages need to be updated to use this getter, if they aren't already (most are not), but in the meantime they will continue to work -- though they won't be able to use viewer-based credentials. This seems like a reasonable tradeoff, and allows us to say e.g. "upgrade `bigrquery` if you want to use it with Connect's viewer-based credentials". Unit tests are included. [0]: https://docs.posit.co/connect/user/oauth-integrations/ [1]: https://github.com/posit-dev/connectcreds/ Signed-off-by: Aaron Jacobs <aaron.jacobs@posit.co>
atheriel
force-pushed
the
viewer-based-auth
branch
from
72ff6cf to
af990f7
Compare
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.
This commit wires up a new credential provider for Connect's viewer-based credentials feature. Most of the actual work is outsourced to a new shared package,
connectcreds.Viewer credentials are inherently tied to a given Shiny session, which is at odds with
gargle's existing view that a single credential is active for a given R process -- so we need to unwind this assumption.In order to support storing and retrieving "session" credentials from the existing
AuthStateobject -- while preserving backward- and forward-compatibility with existing packages -- I have modified its API so that setters and getters are now aware of the existince of session credentials. (There are comprehensive unit tests that explain the details.)Existing packages need to be updated to use this getter, if they aren't already (most are not), but in the meantime they will continue to work -- though they won't be able to use viewer-based credentials. This seems like a reasonable tradeoff, and allows us to say e.g. "upgrade
bigrqueryif you want to use it with Connect's viewer-based credentials".Unit tests are included.