-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Make ThreadContext.markAsSystemContext
package-private
#14988
Closed
Closed
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
bc19108
Make ThreadContext.markAsSystemContext package-private
cwperks a62b147
Add to CHANGELOG
cwperks 39a7a0b
Add null check
cwperks 7313e5f
Get from transportService if null
cwperks 777a546
Fix typo
cwperks 288d8f2
Move to doStart
cwperks 5be69fc
Fix tests
cwperks File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
34 changes: 34 additions & 0 deletions
34
server/src/main/java/org/opensearch/common/util/concurrent/InternalThreadContextWrapper.java
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
/* | ||
* SPDX-License-Identifier: Apache-2.0 | ||
* | ||
* The OpenSearch Contributors require contributions made to | ||
* this file be licensed under the Apache-2.0 license or a | ||
* compatible open source license. | ||
*/ | ||
|
||
package org.opensearch.common.util.concurrent; | ||
|
||
import java.util.Objects; | ||
|
||
/** | ||
* Wrapper around the ThreadContext to expose methods to the core repo without | ||
* exposing them to plugins | ||
* | ||
* @opensearch.internal | ||
*/ | ||
public class InternalThreadContextWrapper { | ||
private final ThreadContext threadContext; | ||
|
||
private InternalThreadContextWrapper(final ThreadContext threadContext) { | ||
this.threadContext = threadContext; | ||
} | ||
|
||
public static InternalThreadContextWrapper from(ThreadContext threadContext) { | ||
return new InternalThreadContextWrapper(threadContext); | ||
} | ||
|
||
public void markAsSystemContext() { | ||
Objects.requireNonNull(threadContext, "threadContext cannot be null"); | ||
threadContext.markAsSystemContext(); | ||
} | ||
} |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cwperks definitely +1 for the intent but I don't think the taking implementation path is correct:
ThreadContext
within core should be frictionless. TheInternalThreadContextWrapper
does break this promise, plus the class exposespublic static from
so anyone could doInternalThreadContextWrapper.from(threadPool.getThreadContext());
to gain the accessThreadContext
outside of the core should not be possible. The long term solution for that is using JPMS but meanwhile, we could close it up using security permissions:Yes, the compile time checks won't be enforced but runtime checks will be.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@reta That sounds like a good approach to grant/prohibit the usage of certain methods in this class in the plugin ecosystem.
I decided to take this approach initially to take advantage of the
@opensearch.internal
annotation so that this repo could useInternalThreadContextWrapper.from(threadPool.getThreadContext());
, but plugins cannot. I will look into making this a permission that is granted through the JSM policy file.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@reta I opened 2 other PRs similar to this one, but they don't make use of this class.
Do you think the other 2 PRs should be updated similarly, or would the changes in those PRs be ok?
ThreadContext.stashWithOrigin
package-private #14987ThreadContext.stashAndMergeHeaders
package-private #14983There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @cwperks , I think if we cannot cleanly seal the ThreadContext methods, we would need same change there (plus, changing the method visibility for public API is breaking).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wasn't able to find any usages of those 2 methods outside of the core:
stashWithOrigin
: https://github.com/search?q=org%3Aopensearch-project+stashWithOrigin&type=codestashAndMergeHeaders
: https://github.com/search?q=org%3Aopensearch-project%20stashAndMergeHeaders&type=codeThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean those are public, right? We sadly don't know who might have been using them (since we don't host all plugins)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be safe to change the modifier on
stashWithOrigin
because a plugin would still have access tostashContext
after that PR and could refactor to 2 lines.I think
stashAndMergeHeaders
would be safe to change based on the usages I see in the core repo, but yes generally changing an access modifier could be breaking.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's the thing, thank you