Implement default methods in TaskListener and BuildListener #3122

jglick · Oct 31, 2017

Would avoid the need for LessAbstractTaskListener in jenkinsci/workflow-support-plugin#15, for example.

reviewbybees · Oct 31, 2017

This pull request originates from a CloudBees employee. At CloudBees, we require that all pull requests be reviewed by other CloudBees employees before we seek to have the change accepted. If you want to learn more about our process please see this explanation.

svanoort · Nov 1, 2017

svanoort reviewed Nov 1, 2017

View changes

svanoort · Nov 1, 2017

core/src/main/java/hudson/util/LogTaskListener.java

@@ -82,12 +70,13 @@ public void close() {
        private final StackTraceElement caller;
        private final ByteArrayOutputStream baos = new ByteArrayOutputStream();

-        public LogOutputStream(Logger logger, Level level, StackTraceElement caller) {
+        LogOutputStream(Logger logger, Level level, StackTraceElement caller) {


🐛 - Potential breaker for code depending on this constructor.

Not true; the class was private already, so the public modifier on its constructor was just misleading.

svanoort · Nov 1, 2017

svanoort reviewed Nov 1, 2017

View changes

svanoort · Nov 1, 2017

core/src/main/java/hudson/util/StreamTaskListener.java

@@ -58,7 +52,7 @@
 * 
 * @author Kohsuke Kawaguchi
 */
-public class StreamTaskListener extends AbstractTaskListener implements Serializable, Closeable {
+public class StreamTaskListener implements TaskListener, Closeable {


🐛 You can no longer cast to AbstractTaskListener or check for instanceof AbstractTaskListener.

That is true, but AbstractTaskListener was only ever a convenience base class, so there was never a legitimate reason to do so to begin with.

I was unable to find the implementation, which may be affected. But I agree that keeping the inheritance from a deprecated class would be the safest option for now. This old class is not doing anything wrong anyway

As in #2879 I would prefer to eliminate all usages of the deprecated type to reduce confusion, since there is no plausible risk from the technical API change here.

svanoort · Nov 1, 2017

svanoort requested changes Nov 1, 2017

View changes

A couple small compatibility issues but otherwise looks reasonable AFAICT.

jglick · Nov 2, 2017

jglick reviewed Nov 2, 2017

View changes

Not issues I think.

jglick · Nov 2, 2017

core/src/main/java/hudson/util/LogTaskListener.java

@@ -82,12 +70,13 @@ public void close() {
        private final StackTraceElement caller;
        private final ByteArrayOutputStream baos = new ByteArrayOutputStream();

-        public LogOutputStream(Logger logger, Level level, StackTraceElement caller) {
+        LogOutputStream(Logger logger, Level level, StackTraceElement caller) {


Not true; the class was private already, so the public modifier on its constructor was just misleading.

jglick · Nov 2, 2017

core/src/main/java/hudson/util/StreamTaskListener.java

@@ -58,7 +52,7 @@
 * 
 * @author Kohsuke Kawaguchi
 */
-public class StreamTaskListener extends AbstractTaskListener implements Serializable, Closeable {
+public class StreamTaskListener implements TaskListener, Closeable {


That is true, but AbstractTaskListener was only ever a convenience base class, so there was never a legitimate reason to do so to begin with.

oleg-nenashev · Nov 6, 2017

No strong opinion since I do not see any usages which will be affected by the change.
Would be great to get more votes from @jenkinsci/code-reviewers in order to elaborate whether it's fine to break binary compatibility for such cleanup.

jglick · Nov 13, 2017

I do not see any usages which will be affected by the change.

And I would be happy to break any such usage if there were one, because it would be ridiculous.

svanoort · Nov 13, 2017

svanoort approved these changes Nov 13, 2017

View changes

oleg-nenashev · Nov 14, 2017

oleg-nenashev approved these changes Nov 14, 2017

View changes

Weak 🐝 since I cannot find any usages of the API to be broken. @reviewbybees done, I'd guess

oleg-nenashev · Nov 19, 2017

formally it's ready to go. YOLO.

jtnord · Mar 9, 2018

noting that this caused a breakage as the class serialVersionUID are different in the AbstractTaskListener - so Serialized formats are no longer the compatable.
The follow up #3154 did not restore this :-(

jglick · Mar 9, 2018

@jtnord Normally that would be irrelevant since master → agent connections will use identical bytecode. Would only matter for other uses of Remoting involving diachronic serialization. Probably fixable by adding a serialVersionUID to AbstractTaskListener matching the original value.

daniel-beck · Mar 10, 2018

@jtnord Do you have an issue reference for that?

jtnord · Mar 12, 2018

@daniel-beck JENKINS-50124

Implement default methods in TaskListener and BuildListener.

9ed6b01

jglick requested a review from svanoort Oct 31, 2017

jglick referenced this pull request Oct 31, 2017
Merged
[JEP-210] Log handling rewrite #15
5 of 6 tasks complete

jglick added the needs-review label Nov 2, 2017

jglick requested a review from oleg-nenashev Nov 6, 2017

jglick requested a review from svanoort Nov 13, 2017

oleg-nenashev added ready-for-merge and removed needs-review labels Nov 14, 2017

oleg-nenashev merged commit 5b9ad64 into jenkinsci:master Nov 19, 2017
1 check passed

1 check passed

continuous-integration/jenkins/pr-head This commit looks good
Details

oleg-nenashev referenced this pull request Nov 19, 2017
Open
[JENKINS-47896] - Introduce SerializableOnlyOverRemoting in classes. #3144
4 of 4 tasks complete

jglick deleted the jglick:TaskListener branch Nov 20, 2017

oleg-nenashev referenced this pull request Nov 21, 2017
Merged
[JENKINS-48116] - Restore AbstractTaskListener binary compatibility in the core. #3154
4 of 4 tasks complete

jglick referenced this pull request Jun 26, 2018
Merged
[JEP-206] Define API for gathering command output in a local encoding #61

orgi pushed a commit to orgi/workflow-durable-task-step-plugin that referenced this pull request Nov 13, 2018

Deleting LessAbstractTaskListener as it is superseded by jenkinsci/je…
…nkins#3122.

c52fe3b

jenkinsci/jenkins

Join GitHub today

Implement default methods in TaskListener and BuildListener #3122

Conversation

jglick commented Oct 31, 2017

jglick requested a review from svanoort Oct 31, 2017

jglick referenced this pull request Oct 31, 2017

This comment has been minimized.

reviewbybees commented Oct 31, 2017

svanoort reviewed Nov 1, 2017 View changes

This comment has been minimized.

This comment has been minimized.

svanoort reviewed Nov 1, 2017 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

svanoort requested changes Nov 1, 2017 View changes

jglick reviewed Nov 2, 2017 View changes

This comment has been minimized.

This comment has been minimized.

jglick added the needs-review label Nov 2, 2017

jglick requested a review from oleg-nenashev Nov 6, 2017

This comment has been minimized.

oleg-nenashev commented Nov 6, 2017

This comment has been minimized.

jglick commented Nov 13, 2017

jglick requested a review from svanoort Nov 13, 2017

svanoort approved these changes Nov 13, 2017 View changes

oleg-nenashev approved these changes Nov 14, 2017 View changes

oleg-nenashev added ready-for-merge and removed needs-review labels Nov 14, 2017

This comment has been minimized.

oleg-nenashev commented Nov 19, 2017

Hide details View details oleg-nenashev merged commit 5b9ad64 into jenkinsci:master Nov 19, 2017 1 check passed

1 check passed

oleg-nenashev referenced this pull request Nov 19, 2017

jglick deleted the jglick:TaskListener branch Nov 20, 2017

oleg-nenashev referenced this pull request Nov 21, 2017

This comment has been minimized.

jtnord commented Mar 9, 2018

This comment has been minimized.

jglick commented Mar 9, 2018

This comment has been minimized.

daniel-beck commented Mar 10, 2018

This comment has been minimized.

jtnord commented Mar 12, 2018 • edited

jglick added a commit to jglick/workflow-support-plugin that referenced this pull request Jun 11, 2018

jglick added a commit to jglick/workflow-durable-task-step-plugin that referenced this pull request Jun 11, 2018

jglick referenced this pull request Jun 26, 2018

orgi pushed a commit to orgi/workflow-durable-task-step-plugin that referenced this pull request Nov 13, 2018

svanoort reviewed Nov 1, 2017

View changes

svanoort reviewed Nov 1, 2017

View changes

svanoort requested changes Nov 1, 2017

View changes

jglick reviewed Nov 2, 2017

View changes

svanoort approved these changes Nov 13, 2017

View changes

oleg-nenashev approved these changes Nov 14, 2017

View changes

oleg-nenashev merged commit `5b9ad64` into jenkinsci:master Nov 19, 2017
1 check passed

jtnord commented Mar 12, 2018 •

edited