Prevent infinite recursion when migrating secrets to credentials while loading GitLab server configuration #450
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
…e loading GitLab server configuration
dwnusbaum
commented
Oct 4, 2024
src/test/java/io/jenkins/plugins/gitlabserverconfig/servers/GitLabServersTest.java
Outdated
Show resolved
Hide resolved
src/test/java/io/jenkins/plugins/gitlabserverconfig/servers/GitLabServersTest.java
Outdated
Show resolved
Hide resolved
dwnusbaum
commented
Oct 4, 2024
Comment on lines
+70
to
+74
| // Prior to fix, this caused the GitLabServer migration code to recurse infinitely, causing problems when | ||
| // starting Jenkins. | ||
| // In practice this was caused by a lookup of another descriptor type, but I am using GitLabServers for | ||
| // clarity. | ||
| Jenkins.get().getDescriptor(GitLabServers.class); |
There was a problem hiding this comment.
This is just a minimal reproducer. In practice the real issue was with a CloudBees-specific CredentialProvider implementation which included a call to Jenkins.getDescriptor.
dwnusbaum
commented
Oct 4, 2024
Comment on lines
+58
to
+59
| assertThat( | ||
| logger.getMessages(), not(hasItem(containsString("Trouble loading " + GitLabServers.class.getName())))); |
There was a problem hiding this comment.
I wasn't sure about the best way to test the regression, but this assertion does fail if you revert the changes to src/main, and the test log output will be full of exceptions and error messages.
jetersen
approved these changes
Oct 15, 2024
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.
I recently ran into a case where the migration code in #267 was causing an infinite loop while loading extensions during Jenkins startup, leading to various issues.
The problem is that
readResolveon a class that is part of a@Extension PersistentDescriptorwill be called while extensions are being loaded becausePersistentDescriptor.loadis annotated with@PostConstructwhich gets called here when the extension is loaded. This means that it is not safe to do anything that requires other extensions to be loaded from withinloadand any other methods that loading may trigger. In this case the problem was the call toCredentialsProvider.lookupCredentialsinGitLabServer.readResolve. To avoid this issue, I moved the migration to a static@Initializermethod that runs afterEXTENSIONS_AUGMENTED, so all extensions have already been loaded at that point.Here is what the
OldDataMonitorwarning looked like, filtered to just the repeating stack frames:There was also this Guice exception in the logs:
Testing done
See new automated test.
Submitter checklist