[JEP-228] Unforking XStream #4944

jglick · 2020-09-21T18:58:11Z

JEP-228

Proposed changelog entries

Jenkins now uses an updated version of the XStream serialization library without custom patches.

Proposed upgrade guidelines

https://www.jenkins.io/blog/2020/11/10/spring-xstream/

See the compatibility table.

Desired reviewers

@jenkinsci/core

Maintainer checklist

Before the changes are marked as ready-for-merge:

There are at least 2 approvals for the pull request and no outstanding requests for change
Conversations in the pull request are over OR it is explicit that a reviewer does not block the change
Changelog entries in the PR title and/or Proposed changelog entries are correct
Proper changelog labels are set so that the changelog can be generated automatically
If the change needs additional upgrade steps from users, upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the PR title. (example)
If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

jglick · 2020-09-21T19:37:56Z

Seems that the defense in #3248 is no longer necessary as of x-stream/xstream@d0ad410, though it is harmless to leave in.

jglick · 2020-09-21T19:50:23Z

core/src/main/java/hudson/tools/ToolInstallation.java

@@ -82,8 +81,7 @@
    /**
     * {@link ToolProperty}s that are associated with this tool.
     */
-    @XStreamSerializable
-    private transient /*almost final*/ DescribableList<ToolProperty<?>,ToolPropertyDescriptor> properties
+    private /*almost final*/ DescribableList<ToolProperty<?>,ToolPropertyDescriptor> properties


This is a problem. DescribableList is not Serializable so removing transient will prevent this class from being serialized over Remoting. Yet keeping transient will prevent tool installations from saving their properties in XML. I have not found any way to get the effect of XStreamSerializable without patching PureJavaReflectionProvider.

(I am not sure why ToolInstallation was ever made Serializable to begin with. The normal usage is to have it define some PATH entry on the controller side, which does not require the ToolInstallation itself to ever be sent to the agent.)

Also the current annotation was explicitly rejected upstream: x-stream/xstream#70 (comment)

…rom subclasses

Fixing MavenInstallation accordingly. AntInstallation was already fixed: jenkinsci/ant-plugin@c957dca

…onsReported

…ppress warning

daniel-beck · 2020-09-28T19:10:00Z

core/src/main/java/hudson/tools/ToolInstallation.java

        return this;
    }

+    protected Object writeReplace() throws Exception {
+        if (Channel.current() == null) { // XStream


Well, not nice, but seems to work well enough. I am trying to fix popular plugins to not need this hack.

…ases covered by jenkinsci/jenkins-test-harness#243

…tream

jglick · 2020-10-26T18:55:02Z

Would prefer to get at least the following released first:

~~Use ExtendedHierarchicalStreamReader matrix-auth-plugin#89 @daniel-beck~~
~~private readResolve not honored by subtypes email-ext-plugin#220~~ some owner TBD (@basil?)
~~Avoid com.thoughtworks.xstream.annotations github-plugin#239~~ some owner TBD (@lanwen? @integer? @KostyaSha despite not appearing to have deploy permission in RPU?)

oleg-nenashev

Please follow the pull request template. Changelog and upgrade guide drafts are required for this pull request

done

jvz

LGTM, seems to work with random plugins I tried out. Read through the associated JEP-228 docs as well.

timja · 2020-11-01T09:18:25Z

Is anyone else wanting to review this or should we ship in the next weekly?

timja · 2020-11-03T21:20:12Z

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

pom.xml

daniel-beck · 2020-11-03T22:53:03Z

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Given the PR size, might make sense to wait a few days longer, since the next weekly is still a week off anyway.

Co-authored-by: Basil Crow <me@basilcrow.com>

…tream

jvz · 2020-11-06T18:08:37Z

I'll be merging this after #4848 is merged.

…tream

…ns#4944 to be as well, to be released 2020-11-10

jglick · 2020-11-06T21:12:55Z

Cleanup: INFRA-2794

rsandell · 2021-01-26T08:33:26Z

core/src/main/java/hudson/model/ListView.java

@@ -132,7 +132,7 @@ public void setJobFilters(List<ViewJobFilter> jobFilters) throws IOException {
        this.jobFilters.replaceBy(jobFilters);
    }

-    private Object readResolve() {
+    protected Object readResolve() {


Does this imply that all plugins must make the same change?

If the class is extended and the parent read resolve needs to be called

https://github.com/jenkinsci/jep/tree/master/jep/228#inherited-private-serialization-methods explains this

I attempted to search for extant plugins using an incorrect private override, but I might have missed some of course.

Unforking XStream required the access level of this method to be protected. Fortunately this means the super method can be called directly instead of using reflection. jenkinsci/jenkins#4944

* refactor: Modernize to latest versions supported by Java 8 Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.jenkins.ModernizePluginForJava8?organizationId=SmVua2lucyBDSQ%3D%3D Co-authored-by: Moderne <team@moderne.io> * Raise access modifier of readResolve to protected Unforking XStream required the access level of this method to be protected. Fortunately this means the super method can be called directly instead of using reflection. jenkinsci/jenkins#4944 --------- Co-authored-by: Moderne <team@moderne.io> Co-authored-by: Steve Hill <sghill.dev@gmail.com>

jglick added 2 commits September 21, 2020 14:56

Unforking XStream

d27a501

Some overrides missing from MapperDelegate

f5edc8f

jglick commented Sep 21, 2020

View reviewed changes

This was referenced Sep 21, 2020

@XStreamAliasType jenkinsci/persona-plugin#7

Open

Do not fail serializing collection that is a subject to modification jenkinsci/xstream-fork#1

Merged

writeReplace should be protected when intended for use from subtypes jenkinsci/jenkins-test-harness#243

Merged

jglick added 4 commits September 23, 2020 16:25

[XSTR-762] writeReplace & readResolve must be accessible to be used f…

0e5aeec

…rom subclasses

Merge branch 'master' of github.com:jenkinsci/jenkins into xstream

e7609db

DomElement.click overloads changed incompatibly

69eaa76

Giving up on ToolInstallation being Serializable.

4af6099

Fixing MavenInstallation accordingly. AntInstallation was already fixed: jenkinsci/ant-plugin@c957dca

jglick mentioned this pull request Sep 24, 2020

Use ExtendedHierarchicalStreamReader jenkinsci/matrix-auth-plugin#89

Merged

jglick added 4 commits September 24, 2020 14:52

Relaxing message assertion in RobustReflectionConverter.randomExcepti…

08771f7

…onsReported

Picking up jenkinsci/matrix-auth-plugin#89 caught via JobTest

232a012

jenkinsci/jenkins-test-harness#243 released

861ca26

Another case forgotten in 0e5aeec

b89f6d1

XStream has SecurityMapper, but we have our own system already, so su…

1cec1e1

…ppress warning

This was referenced Sep 25, 2020

Do not assume GroovyInstallation is serializable over Remoting jenkinsci/groovy-plugin#29

Merged

Jenkins 2.266+ compatibility: Stop serializing the CustomTool object over Remoting jenkinsci/custom-tools-plugin#51

Merged

GetMavenVersion was also serializing its outer class

0ba7df4

jglick mentioned this pull request Sep 25, 2020

Do not try to serialize MavenInstallation over Remoting jenkinsci/maven-plugin#142

Merged

Trying to make ToolInstallation serializable compatible

cdc1414

daniel-beck reviewed Sep 28, 2020

View reviewed changes

This was referenced Sep 28, 2020

Do not try to serialize GradleInstallation over Remoting jenkinsci/gradle-plugin#100

Merged

Do not try to serialize NodeJSInstallation over Remoting, and fix test mocks jenkinsci/nodejs-plugin#36

Merged

jglick added 2 commits September 28, 2020 16:14

Merge branch 'master' of github.com:jenkinsci/jenkins into xstream

80ab2fe

Avoid throwing IOException from PersistedList.inModified for common c…

b45ffbc

…ases covered by jenkinsci/jenkins-test-harness#243

This was referenced Oct 23, 2020

Do not claim that the working tree represents a release version jenkinsci/xstream-fork#5

Closed

pop unmarshalled type on exception jenkinsci/xstream-fork#2

Closed

Bump xstream from 1.4.7 to 1.4.10-java7 jenkinsci/xstream#9

Closed

Merge branch 'master' of https://github.com/jenkinsci/jenkins into xs…

af44d41

…tream

oleg-nenashev previously requested changes Oct 26, 2020

View reviewed changes

jglick changed the title ~~Unforking XStream~~ [JEP-228] Unforking XStream Oct 26, 2020

jvz approved these changes Oct 30, 2020

View reviewed changes

jglick removed the needs-more-reviews Complex change, which would benefit from more eyes label Oct 30, 2020

jglick added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Nov 3, 2020

basil approved these changes Nov 3, 2020

View reviewed changes

pom.xml Outdated Show resolved Hide resolved

jglick and others added 2 commits November 3, 2020 18:07

Picking up release of jenkinsci/matrix-auth-plugin#89

91e0fa6

Co-authored-by: Basil Crow <me@basilcrow.com>

Merge branch 'master' of https://github.com/jenkinsci/jenkins into xs…

7e748d9

…tream

jansohn mentioned this pull request Nov 4, 2020

WARNING: An illegal reflective access operation has occurred x-stream/xstream#101

Open

Merge branch 'master' of https://github.com/jenkinsci/jenkins into xs…

44a9b59

…tream

jglick added a commit to jglick/jenkins.io that referenced this pull request Nov 6, 2020

jenkinsci/jenkins#4848 merged toward 2.266, expecting jenkinsci/jenki…

17cc0cf

…ns#4944 to be as well, to be released 2020-11-10

jvz merged commit 77f24bf into jenkinsci:master Nov 6, 2020

jglick deleted the xstream branch November 6, 2020 21:04

jetersen mentioned this pull request Nov 10, 2020

Jenkins not starting after upgrading to 2.266 jenkinsci/configuration-as-code-plugin#1531

Closed

3 tasks

jglick mentioned this pull request Nov 23, 2020

Updated the bundled XStream library from 1.4.13 to 1.4.14 #5074

Merged

6 tasks

rsandell reviewed Jan 26, 2021

View reviewed changes

cpoenisch mentioned this pull request Feb 5, 2021

Ensure XStream compatibility jenkinsci/ecutest-plugin#263

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JEP-228] Unforking XStream #4944

[JEP-228] Unforking XStream #4944

jglick commented Sep 21, 2020 •

edited

Loading

jglick commented Sep 21, 2020

jglick Sep 21, 2020

jglick Sep 21, 2020

jglick Sep 21, 2020

daniel-beck Sep 28, 2020

jglick Sep 28, 2020

jglick commented Oct 26, 2020 •

edited by timja

Loading

oleg-nenashev left a comment

jvz left a comment

timja commented Nov 1, 2020

timja commented Nov 3, 2020

daniel-beck commented Nov 3, 2020

jvz commented Nov 6, 2020

jglick commented Nov 6, 2020

rsandell Jan 26, 2021

timja Jan 26, 2021

daniel-beck Jan 26, 2021

jglick Jan 26, 2021

[JEP-228] Unforking XStream #4944

[JEP-228] Unforking XStream #4944

Conversation

jglick commented Sep 21, 2020 • edited Loading

Proposed changelog entries

Proposed upgrade guidelines

Desired reviewers

Maintainer checklist

jglick commented Sep 21, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jglick commented Oct 26, 2020 • edited by timja Loading

oleg-nenashev left a comment

Choose a reason for hiding this comment

jvz left a comment

Choose a reason for hiding this comment

timja commented Nov 1, 2020

timja commented Nov 3, 2020

daniel-beck commented Nov 3, 2020

jvz commented Nov 6, 2020

jglick commented Nov 6, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jglick commented Sep 21, 2020 •

edited

Loading

jglick commented Oct 26, 2020 •

edited by timja

Loading