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.

Sign up for GitHub

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

Jump to bottom

Deprecates non-inclusive config names #1467

Merged
merged 1 commit into from
Apr 15, 2022
Merged

Deprecates non-inclusive config names #1467

merged 1 commit into from
Apr 15, 2022

Conversation

boktorbb
Copy link
Contributor

@boktorbb boktorbb commented Apr 15, 2022 •
edited
Loading

Adds deprecation functionality that uses new name without replacing old

Deprecates but not changes opensearch.requestHeadersWhitelist

Deprecates but not changes server.xsrf.whitelist

Deprecates but not changes server.compression.referrerWhitelist

Currently, this change is allowing the user to use allowlist version of the config names but under the hood, we're mapping the new value back to the old value used in code so that we don't have breaking changes for plugins. If the old non-inclusive config is used, a deprecation warning will be logged.

Signed-off-by: Bishoy Boktor boktorbb@amazon.com

Description

[Describe what this change achieves]

Issues Resolved

[List any issues this PR will resolve]

Check List

  • New functionality includes testing.
    • All tests pass
      • yarn test:jest
      • yarn test:jest_integration
      • yarn test:ftr
  • New functionality has been documented.
  • Commits are signed per the DCO using --signoff

Adds deprecation functionality that uses new name without replacing old
5cb4735 
Deprecates but not changes `opensearch.requestHeadersWhitelist`

Deprecates but not changes `server.xsrf.whitelist`

Deprecates but not changes `server.compression.referrerWhitelist`

Signed-off-by: Bishoy Boktor <boktorbb@amazon.com>
@boktorbb boktorbb requested a review from a team as a code owner April 15, 2022 18:18
kavilla
kavilla approved these changes Apr 15, 2022
View reviewed changes
Copy link
Member

@kavilla kavilla left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you, is there any other references like master?

@boktorbb
Copy link
Contributor Author

LGTM! Thank you, is there any other references like master?

Not in the configs, no.

ananzh
ananzh approved these changes Apr 15, 2022
View reviewed changes
Copy link
Member

@ananzh ananzh left a comment

Choose a reason for hiding this comment

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

LGTM

@boktorbb boktorbb merged commit 848a5fd into opensearch-project:main Apr 15, 2022
@boktorbb boktorbb mentioned this pull request Apr 15, 2022
Closed
10 tasks
@tmarkley tmarkley mentioned this pull request Jun 6, 2022
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kavilla kavilla kavilla approved these changes

@ananzh ananzh ananzh approved these changes

Assignees
No one assigned
Labels
rename :sanitize v2.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@boktorbb @kavilla @ananzh