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

[Deprecation] Deprecate the Blacklist / Whitelist nomenclature #1808

Merged
merged 24 commits into from
Aug 4, 2022

Conversation

kaddy645
Copy link
Contributor

@kaddy645 kaddy645 commented Jun 27, 2022

Signed-off-by: kaddy645 xdeskart@amazon.com

Description

OpenSearch repository is going to replace the terminology "blacklist / whitelist" with "denylist / allowlist".

Changes required for config files are through root renameFromRootWithoutMap method

http.compression.referrerWhitelist config (parent config is opensearch, ( Unknown configuration key(s)/ does not exists)
http.compression.referrerWhitelistConfigured config (parent config is opensearch, ( Unknown configuration key(s)/ does not exists)
http.xsrf.whitelist config (parent config is opensearch, ( Unknown configuration key(s)/ does not exists)
http.xsrf.whitelistConfigured config (parent config is opensearch, ( Unknown configuration key(s)/ does not exists)
opensearch.requestHeadersWhitelist config   --> renameFromRootWithoutMap
opensearch.requestHeadersWhitelistConfigured config   --> renameFromRootWithoutMap
server.compression.referrerWhitelist config   --> renameFromRootWithoutMap
server.xsrf.whitelist config   --> renameFromRootWithoutMap

Issues Resolved

#1319
#1544

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

@kaddy645 kaddy645 marked this pull request as ready for review June 27, 2022 19:06
@kaddy645 kaddy645 requested a review from a team as a code owner June 27, 2022 19:06
@kavilla kavilla removed the enhancement New feature or request label Jun 27, 2022
@kaddy645 kaddy645 changed the title Deprecate the Blacklist / Whitelist nomenclature [Deprecation] Deprecate the Blacklist / Whitelist nomenclature Jun 27, 2022
@kaddy645 kaddy645 self-assigned this Jun 27, 2022
Copy link
Member

@joshuarrrr joshuarrrr left a comment

Choose a reason for hiding this comment

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

Nice start - I had a couple questions about whether some other config values and functions needed updates.

config/opensearch_dashboards.yml Show resolved Hide resolved
config/opensearch_dashboards.yml Show resolved Hide resolved
release-notes/opensearch-dashboards.release-notes-1.0.0.md Outdated Show resolved Hide resolved
@kavilla
Copy link
Member

kavilla commented Jun 27, 2022

Looks like the linter is failing.

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.

Blocking for now since the configs were updated which would be a breaking change, they should be deprecated.

@codecov-commenter
Copy link

codecov-commenter commented Jun 28, 2022

Codecov Report

Merging #1808 (8b71d15) into main (5fb4143) will decrease coverage by 0.00%.
The diff coverage is 80.00%.

@@            Coverage Diff             @@
##             main    #1808      +/-   ##
==========================================
- Coverage   67.51%   67.50%   -0.01%     
==========================================
  Files        3077     3077              
  Lines       59188    59199      +11     
  Branches     9003     9011       +8     
==========================================
+ Hits        39958    39963       +5     
- Misses      17045    17049       +4     
- Partials     2185     2187       +2     
Impacted Files Coverage Δ
src/core/server/opensearch/opensearch_config.ts 93.50% <ø> (ø)
...aps_legacy/public/map/opensearch_dashboards_map.js 25.62% <0.00%> (ø)
...line/server/series_functions/fixtures/tl_config.js 72.72% <ø> (ø)
...gins/vis_type_timeseries/common/ui_restrictions.ts 100.00% <ø> (ø)
...es/public/application/lib/check_ui_restrictions.js 76.92% <33.33%> (ø)
...arch_dashboards_react/public/markdown/markdown.tsx 87.87% <85.71%> (-4.43%) ⬇️
.../public/application/components/tutorial/content.js 100.00% <100.00%> (ø)
src/plugins/maps_legacy/public/map/map_messages.js 29.03% <100.00%> (ø)
...server/series_functions/helpers/graphite_helper.js 81.81% <100.00%> (ø)
...b/search_strategies/default_search_capabilities.js 95.23% <100.00%> (+0.79%) ⬆️
... and 2 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@manasvinibs
Copy link
Member

Blocking for now since the configs were updated which would be a breaking change, they should be deprecated.

@kaddy645 Did we address this comment as I can still see some config values being deleted? Is it intended?

Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
Signed-off-by: kaddy645 <xdeskart@amazon.com>
ananzh
ananzh previously approved these changes Aug 4, 2022
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

Signed-off-by: kaddy645 <xdeskart@amazon.com>
@ananzh ananzh merged commit 54f2aeb into opensearch-project:main Aug 4, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Aug 4, 2022
This PR does deprecate  the terminology blacklist / whitelist with denylist / allowlist

Signed-off-by: kaddy645 <xdeskart@amazon.com>
(cherry picked from commit 54f2aeb)
ananzh pushed a commit that referenced this pull request Aug 5, 2022
#2074)

This PR does deprecate  the terminology blacklist / whitelist with denylist / allowlist

Signed-off-by: kaddy645 <xdeskart@amazon.com>
(cherry picked from commit 54f2aeb)

Co-authored-by: Kartik Desai <xdeskart@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change blocklist to denylist to make consistency Deprecate the "Blacklist / Whitelist" nomenclature
6 participants