[JENKINS-45327] Pickle EnvActionImpl to prevent multiple instances from existing after resumption #539
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
…om existing after resumption
dwnusbaum
commented
May 19, 2022
| import org.kohsuke.accmod.Restricted; | ||
| import org.kohsuke.accmod.restrictions.DoNotUse; | ||
| import org.kohsuke.stapler.export.Exported; | ||
| import org.kohsuke.stapler.export.ExportedBean; | ||
|
|
||
| @ExportedBean | ||
| public class EnvActionImpl extends GroovyObjectSupport implements EnvironmentAction.IncludingOverrides, Serializable, RunAction2 { |
There was a problem hiding this comment.
This will cause Pipelines which already have a serialized instance of EnvActionImpl to fail, but those instances would have thrown an NPE anyway if they were used, so my thinking is that this should not affect a significant number of users. We could leave it in place if we want to be extra careful though.
There was a problem hiding this comment.
I think removing Serializable makes sense here.
src/main/java/org/jenkinsci/plugins/workflow/cps/EnvActionImpl.java
Outdated
Show resolved
Hide resolved
dwnusbaum
commented
May 19, 2022
| * Prevents multiple instances of {@link EnvActionImpl} from existing for a single Pipeline after a Jenkins restart | ||
| * in case {@code env} is serialized into the program. | ||
| */ | ||
| private static class EnvActionImplPickle extends Pickle { |
There was a problem hiding this comment.
This has no internal state, we just use it as a hook to return EnvActionImpl.forRun(owner.getExecutable()) during deserialization, completely discarding the serialized object.
jglick
reviewed
May 19, 2022
src/main/java/org/jenkinsci/plugins/workflow/cps/EnvActionImpl.java
Outdated
Show resolved
Hide resolved
src/test/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecutionTest.java
Outdated
Show resolved
Hide resolved
jglick
approved these changes
May 19, 2022
| import org.kohsuke.accmod.Restricted; | ||
| import org.kohsuke.accmod.restrictions.DoNotUse; | ||
| import org.kohsuke.stapler.export.Exported; | ||
| import org.kohsuke.stapler.export.ExportedBean; | ||
|
|
||
| @ExportedBean | ||
| public class EnvActionImpl extends GroovyObjectSupport implements EnvironmentAction.IncludingOverrides, Serializable, RunAction2 { |
There was a problem hiding this comment.
I think removing Serializable makes sense here.
car-roll
approved these changes
May 26, 2022
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.
See JENKINS-45327.
Right now, if you use
envin a Pipeline in a way that causesEnvActionImplto be serialized into the program's state, then after resumption you end up with a distinct instance ofEnvActionImplthat is unrelated to the action attached to theWorkflowRun, so theownerfor the deserializedEnvActionImplis null, andgetPropertyandsetPropertythrow NPEs.This PR fixes the issue by pickling
EnvActionImplso that it can be rehydrated using the action attached to theWorkflowRun, which maintains the expected singleton semantics and prevents issues.