Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin #15039

cwperks · 2024-07-31T14:26:21Z

Description

Similar to #15016, but extends it to more methods in the ThreadContextClass. This PR introduces permissions for stashAndMergeHeaders (used in test context only) and stashWithOrigin.

Related Issues

Related to #14931

Check List

Functionality includes testing.
API changes companion pull request created, if applicable.
Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Craig Perkins <cwperx@amazon.com>

github-actions · 2024-07-31T14:49:55Z

❌ Gradle check result for 3892188: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2024-07-31T14:56:23Z

❌ Gradle check result for fccc486: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

cwperks · 2024-07-31T15:22:06Z

Looking into test failures

Signed-off-by: Craig Perkins <cwperx@amazon.com>

cwperks · 2024-07-31T16:20:46Z

D'oh. I forgot to surround the invocations in ThreadContextAccess.doPrivileged(() -> ...). Pushed a commit to fix the failing tests.

github-actions · 2024-07-31T16:53:09Z

❌ Gradle check result for c0324b4: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2024-07-31T18:07:10Z

✅ Gradle check result for c0324b4: SUCCESS

codecov · 2024-07-31T18:10:38Z

Codecov Report

Attention: Patch coverage is 72.72727% with 3 lines in your changes missing coverage. Please review.

Project coverage is 71.87%. Comparing base (eb306d2) to head (c0324b4).
Report is 4 commits behind head on main.

Files	Patch %	Lines
...ensearch/common/util/concurrent/ThreadContext.java	75.00%	0 Missing and 2 partials ⚠️
.../org/opensearch/client/support/AbstractClient.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #15039      +/-   ##
============================================
+ Coverage     71.77%   71.87%   +0.09%     
- Complexity    62689    62810     +121     
============================================
  Files          5163     5165       +2     
  Lines        294412   294446      +34     
  Branches      42582    42589       +7     
============================================
+ Hits         211325   211636     +311     
+ Misses        65689    65390     -299     
- Partials      17398    17420      +22

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

…gin (#15039) * Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add to CHANGELOG Signed-off-by: Craig Perkins <cwperx@amazon.com> * Use ThreadContextAccess Signed-off-by: Craig Perkins <cwperx@amazon.com> --------- Signed-off-by: Craig Perkins <cwperx@amazon.com> (cherry picked from commit e7ee950) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

cwperks · 2024-07-31T19:10:41Z

I'll open up a manual backport with the deprecationLogger

…gin (opensearch-project#15039) * Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add to CHANGELOG Signed-off-by: Craig Perkins <cwperx@amazon.com> * Use ThreadContextAccess Signed-off-by: Craig Perkins <cwperx@amazon.com> --------- Signed-off-by: Craig Perkins <cwperx@amazon.com>

cwperks · 2024-07-31T19:18:49Z

Opened a manual backport with deprecationLogger changes: #15049

reta · 2024-07-31T20:50:31Z

server/src/main/java/org/opensearch/common/util/concurrent/ThreadContext.java

@@ -213,6 +215,10 @@ public Writeable captureAsWriteable() {
     * if it can't find the task in memory.
     */
    public StoredContext stashWithOrigin(String origin) {


@cwperks my apologies, I missed that, could you please add javadocs here the same way we did for markAsSystemContext? Thank you.

yes absolutely. That's my bad. I should have included that in the PR. Good catch.

…nd stashWithOrigin (#15049) * Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin (#15039) * Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add to CHANGELOG Signed-off-by: Craig Perkins <cwperx@amazon.com> * Use ThreadContextAccess Signed-off-by: Craig Perkins <cwperx@amazon.com> --------- Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add deprecationLogger Signed-off-by: Craig Perkins <cwperx@amazon.com> --------- Signed-off-by: Craig Perkins <cwperx@amazon.com>

…gin (opensearch-project#15039) * Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add to CHANGELOG Signed-off-by: Craig Perkins <cwperx@amazon.com> * Use ThreadContextAccess Signed-off-by: Craig Perkins <cwperx@amazon.com> --------- Signed-off-by: Craig Perkins <cwperx@amazon.com>

Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin

3892188

Signed-off-by: Craig Perkins <cwperx@amazon.com>

cwperks requested review from anasalkouz, andrross, ashking94, Bukhtawar, CEHENKLE, dblock, dbwiddis, gbbafna, kotwanikunal, mch2, msfroh, nknize, owaiskazi19, reta, Rishikesh1159, sachinpkale, saratvemulapalli, shwetathareja, sohami and VachaShah as code owners July 31, 2024 14:26

Add to CHANGELOG

fccc486

Signed-off-by: Craig Perkins <cwperx@amazon.com>

reta approved these changes Jul 31, 2024

View reviewed changes

reta added the backport 2.x Backport to 2.x branch label Jul 31, 2024

reta added v3.0.0 Issues and PRs related to version 3.0.0 v2.17.0 labels Jul 31, 2024

reta mentioned this pull request Jul 31, 2024

[META] Breaking changes in 3.0 #3351

Open

19 tasks

Use ThreadContextAccess

c0324b4

Signed-off-by: Craig Perkins <cwperx@amazon.com>

reta approved these changes Jul 31, 2024

View reviewed changes

reta merged commit e7ee950 into opensearch-project:main Jul 31, 2024
31 checks passed

opensearch-trigger-bot bot mentioned this pull request Jul 31, 2024

[Backport 2.x] Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin #15046

Closed

cwperks mentioned this pull request Jul 31, 2024

[Backport 2.x] Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin #15049

Merged

reta reviewed Jul 31, 2024

View reviewed changes

cwperks mentioned this pull request Aug 8, 2024

[META] Remove usages of ThreadContext.stashContext and adopt new mechanism for System Index access opensearch-project/opensearch-plugins#238

Open

BrewTestBot mentioned this pull request Sep 18, 2024

opensearch 2.17.0 Homebrew/homebrew-core#191052

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin #15039

Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin #15039

cwperks commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

cwperks commented Jul 31, 2024

cwperks commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

codecov bot commented Jul 31, 2024

cwperks commented Jul 31, 2024

cwperks commented Jul 31, 2024

reta Jul 31, 2024

cwperks Jul 31, 2024

Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin #15039

Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin #15039

Conversation

cwperks commented Jul 31, 2024

Description

Related Issues

Check List

github-actions bot commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

cwperks commented Jul 31, 2024

cwperks commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

codecov bot commented Jul 31, 2024

Codecov Report

cwperks commented Jul 31, 2024

cwperks commented Jul 31, 2024

reta Jul 31, 2024

Choose a reason for hiding this comment

cwperks Jul 31, 2024

Choose a reason for hiding this comment