Forward compatibility with Jetty 10 in JenkinsRule
#455
Conversation
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
basil
force-pushed
the
NoListenerConfiguration
branch
from
b513060
to
1ad7129
Compare
This was referenced Jul 7, 2022
rsandell
approved these changes
Jul 11, 2022
rsandell
reviewed
Jul 11, 2022
| protected void doStart() { | ||
| for (EventListener eventListener : context.getEventListeners()) { | ||
| if (eventListener instanceof WebAppMain) { | ||
| context.removeEventListener(eventListener); |
There was a problem hiding this comment.
So this isn't causing a ConcurrentModificationException?
There was a problem hiding this comment.
No. The internal data structure is a CopyOnWriteArrayList.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Required for jenkinsci/jenkins#6805, #453, jenkinsci/jenkins#6802.
Problem
When the application is started from
java -jar jenkins.war,hudson.WebAppMainruns to initialize the application. In the context of the test harness, we do not want this to happen, since the test harness initializes Jenkins itself.The current method does this with a call to
context.setEventListeners(null)inNoListenerConfiguration. This has three problems:final, forcing the need for copypasta in https://github.com/jenkinsci/jenkins/blob/6de288f424f3a76d9fab9e54e379ca171b08e158/test/src/test/java/hudson/util/BootFailureTest.java#L79-L80=.JenkinsRuleTest.hudson.WebAppMain, which is its purpose, but it also clears all other listeners, including other valuable cleanup listeners. The current (ordered) list of listeners in Jetty 9 is:org.eclipse.jetty.servlet.listener.ELContextCleanerorg.eclipse.jetty.servlet.listener.IntrospectorCleanerjenkins.util.SystemProperties.Listenerhudson.WebAppMain(needs to be cleared in the test harness)jenkins.JenkinsHttpSessionListenerSolution
We make the class non-
finaland remove only theWebAppMainlistener. This fixes all three problems:JenkinsRuleTeststarts working in Jetty 10.org.eclipse.jetty.websocket.core.server.WebSocketServerComponentsCleanupListenerorg.eclipse.jetty.websocket.server.JettyWebSocketServerContainerorg.eclipse.jetty.websocket.server.JettyWebSocketServerContainerCleanupListenerorg.eclipse.jetty.servlet.listener.ELContextCleanerorg.eclipse.jetty.servlet.listener.IntrospectorCleanerjenkins.util.SystemProperties.Listenerhudson.WebAppMain(needs to be cleared in the test harness)jenkins.JenkinsHttpSessionListenerorg.eclipse.jetty.server.AllowedResourceAliasChecker.AllowedResourceAliasCheckListenerTesting done
I tested this with
BootFailureTestin core with both Jetty 9 (jenkinsci/jenkins#6805) and Jetty 10 (jenkinsci/jenkins#6802).