Throwing error message if oauth argument set to anything other than basic for usse #2525 #2554
Conversation
This file contains hidden or 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
blueww
reviewed
May 22, 2025
| public oauth(): string | undefined { | ||
| return this.flags.oauth; | ||
| if (this.flags.oauth !== undefined) { | ||
| if (this.flags.oauth !== "basic") { |
There was a problem hiding this comment.
Please don't hard code "basic".
The basic here means Azurite only do basic validation of the Bearer token. It give the scalability for adding more validation to the bearer token with more value for "--Oauth" in the future.
So please add an enum for the value support by Oauth, and report error when the value not in the enum.
It's better to have the validation code in a single function, instead of several copy of it.
blueww
reviewed
May 22, 2025
|
|
||
| public oauth(): string | undefined { | ||
| return this.flags.oauth; | ||
| if (this.flags.oauth !== undefined) { |
There was a problem hiding this comment.
Please add changelog, and better with test cases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 pull request introduces stricter validation for the
oauthflag across multiple environment classes and improves type safety in theConfigurationBaseclass as highlighted in #2525 . The main changes ensure that only the value"basic"is accepted for theoauthflag, with an appropriate error thrown for invalid values.Stricter validation for
oauthflag:src/blob/BlobEnvironment.ts: Added validation in theoauthmethod to ensure that only"basic"is accepted as a valid value for theoauthflag, throwing aRangeErrorotherwise.src/common/Environment.ts: Applied the same validation logic in theoauthmethod for theEnvironmentclass.src/queue/QueueEnvironment.ts: Implemented the same validation in theoauthmethod for theQueueEnvironmentclass.src/table/TableEnvironment.ts: Added the same validation in theoauthmethod for theTableEnvironmentclass.Improved type safety:
src/common/ConfigurationBase.ts: Updated thegetOAuthLevelmethod to explicitly check thatthis.oauthis a string before processing it, improving type safety.