Aesthetic clean-up / format OAuth code #7782
Merged
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
github-actions
bot
added
area/connectors
Phlair
reviewed
Nov 9, 2021
| public BaseOAuthFlow(final ConfigRepository configRepository, HttpClient httpClient) { | ||
| this(configRepository, httpClient, BaseOAuthFlow::generateRandomState); | ||
| } | ||
| public abstract class BaseOAuthFlow implements OAuthFlowImplementation { |
There was a problem hiding this comment.
This renaming of these base classes implies abstraction for both OAuth[1] and OAuth2, because we have BaseOAuthFlow and then BaseOAuth2Flow that extends it.
Is it the intention (and therefore possible) that BaseOAuthFlow can be used for OAuth[1] flows? If not, then what is the purpose of distinction?
There was a problem hiding this comment.
Yes, Trello OAuth is the only OAuth 1 for the moment
I am guessing if we have another oauth 1 flow, we'll be able to introduce a BaseOAuth1Flow at that moment to factor whatever common code shared between trello and that new one?
There was a problem hiding this comment.
Gotcha, yeah agreed with that approach.
Phlair
approved these changes
Nov 9, 2021
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.
What
Cleaning up oauth classes formatting code and renaming the base classes before changing APIs
How
The major change in this PR is that
extractRefreshToken()is being refactored intoextractOAuthOutput()which is now always returning a flat map (non-nested) of values.
Then a second separate method
formatOAuthOutput()is called to handle nesting of OAuth results under "credentials" (or some other node names) if necessary.This method will be refactored in the future to follow some "AuthSpecification" fields in the spec.json instead of being hard-coded in the Flow implementation code.
The renaming of base classes is;