Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore precedence of token over password in AbstractRestClient - V3 #2125

Merged
merged 2 commits into from
May 3, 2024

Conversation

gejohnston
Copy link
Member

What It Does

Implements the same changes into V3 as the following pull request did in V2:
Reinstate token precedence over password in AbstractRestClient #2119

Related issue : Breaking Change in User/Password/Token Order of Precedence #2109 (already closed)

How to Test

Review Checklist
I certify that I have:

Additional Comments

Copy link

codecov bot commented May 1, 2024

Codecov Report

Attention: Patch coverage is 98.33333% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 91.05%. Comparing base (9cca349) to head (7272153).
Report is 2 commits behind head on next.

Files Patch % Lines
...perative/src/rest/src/client/AbstractRestClient.ts 98.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2125      +/-   ##
==========================================
+ Coverage   90.98%   91.05%   +0.07%     
==========================================
  Files         618      618              
  Lines       17484    17515      +31     
  Branches     3605     3617      +12     
==========================================
+ Hits        15907    15948      +41     
+ Misses       1576     1566      -10     
  Partials        1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look identical to the other PR. 🥳

LGTM! 😋

Left a small question in case we wanted to reverse the order in the array to Basic > Token (for consistency with other implementations) 😋

Comment on lines +248 to +249
SessConstants.AUTH_TYPE_TOKEN,
SessConstants.AUTH_TYPE_BASIC,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to reverse the order here (basic > Token) since this is against the next branch (to be consistent)?
or keep it as is?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though we are "allowed" to make breaking changes in V3, I think that the same extenders will hit the same dead-end failure with no practical solution. Their products will be broken.

I think that we will have to keep the current credential order in place until we implement a means for extenders (and maybe end-users) to specify their preferred order of credentials. I don't think that we know when we will undertake such an enhancement. I also cannot predict if that enhancement can be done in a non-breaking fashion after V3 is released. None-the-less, I think we have to stick with the current order for now.

@gejohnston gejohnston merged commit 67d630a into next May 3, 2024
43 checks passed
@gejohnston gejohnston deleted the cred-order-v3 branch May 3, 2024 17:32
Copy link

sonarcloud bot commented May 3, 2024

Copy link

github-actions bot commented May 3, 2024

Release succeeded for the next branch. 🎉

The following packages have been published:

Powered by Octorelease 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

4 participants