[Fix] PulsarCtl 1266 Oauth2 Client credentials flow use scopes from the keyfile as well #1244
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.
(If this PR fixes a github issue, please add
Fixes #<xyz>
.)Fixes streamnative/pulsarctl#1266 which uses the code being touched here.
Motivation
As the issue shows when using Pulsarctl which works with a context as configuration style, Oauth2 is used under the hood.
However the library does not expose any way to inject the context configuration
scope
value, and then relies on reading that from thekeyFile
forclient_credentials flow
.However that is not being utilized in the current code as the scope value is not read from from the file.
Explain here the context, and why you're making that change. What is the problem you're trying to solve.
To allow the usage of oauth2 with a keyfile in Pulsarctl 3+ which it doesn't right now
Modifications
Describe the modifications you've done.
Alters so reading the keyFile for client credentials also returns the
scope
value.The value is then split on spaces, and added to a temporary slice.
After that the value of any additionalScopes that was already in the options is then added to the temp slice as well.
In the end the additionalScopes property on the options is set to the temp slice containing values from previous additionalScopes and the ones from the keyFile.
Verifying this change
(Please pick either of the following options)
This change is a trivial rework / code cleanup without any test coverage.
(or)
This change is already covered by existing tests, such as (please describe tests).
(or)
This change added tests and can be verified as follows:
(example:)
Does this pull request potentially affect one of the following parts:
If
yes
was chosen, please highlight the changesDocumentation