Skip to content

Make workflow-api compatible with Guava 21.0 and newer #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
car-roll merged 12 commits into from
Mar 15, 2021
Merged

Make workflow-api compatible with Guava 21.0 and newer #135

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b7bf0d8
Upgrade guava
timja Jan 16, 2021
ec8ea59
Add trilead dep for ArtifactManagerTest
timja Jan 16, 2021
564ca43
Update workflow-support
timja Jan 17, 2021
37e412d
Merge branch 'master' into upgrade-guava
timja Feb 6, 2021
284918f
Spotbugs fixes
timja Feb 6, 2021
31acbee
Downgrade workflow-support for noW
timja Feb 6, 2021
8d974b8
Tweak settings
timja Feb 6, 2021
c363cc8
Fallback to old guava API if needed and avoid core bump
amuniz Mar 4, 2021
d6bfed6
Re-upgrade core and invert fallback code
timja Mar 8, 2021
d0626eb
Update src/main/java/org/jenkinsci/plugins/workflow/flow/FlowExecutio…
timja Mar 8, 2021
c8e40e3
Vendor guava classes from 30.1
timja Mar 15, 2021
1051efe
Merge branch 'upgrade-guava' of github.com:timja/workflow-api-plugin …
timja Mar 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 3 additions & 22 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<properties>
<revision>2.42</revision>
<changelist>-SNAPSHOT</changelist>
<jenkins.version>2.273-rc30689.09147672b85b</jenkins.version>
<jenkins.version>2.222.4</jenkins.version>
<java.level>8</java.level>
<no-test-jar>false</no-test-jar>
<useBeta>true</useBeta>
Expand All @@ -74,8 +74,8 @@
<dependencies>
<dependency>
<groupId>io.jenkins.tools.bom</groupId>
<artifactId>bom-2.176.x</artifactId>
<version>16</version>
<artifactId>bom-2.222.x</artifactId>
<version>25</version>
<scope>import</scope>
<type>pom</type>
</dependency>
Expand Down Expand Up @@ -105,11 +105,6 @@
<artifactId>workflow-basic-steps</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>trilead-api</artifactId>
<scope>test</scope>
</dependency>
<!-- For Semaphore step -->
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
Expand Down Expand Up @@ -139,18 +134,4 @@
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<!-- TODO the tests depend on workflow-support and cps which both need api published first... -->
<!-- need to run at least one flag or the pipeline fails -->
<test>InjectedTest</test>
</configuration>
</plugin>
</plugins>
</build>
</project>
48 changes: 34 additions & 14 deletions src/main/java/org/jenkinsci/plugins/workflow/flow/FlowExecutionList.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@

import java.io.File;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.concurrent.CancellationException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
Expand Down Expand Up @@ -181,11 +184,9 @@ public void onLoaded() {
Futures.addCallback(e.getCurrentExecutions(false), new FutureCallback<List<StepExecution>>() {
@Override
public void onSuccess(List<StepExecution> result) {
if (result != null) {
LOGGER.log(FINE, "Will resume {0}", result);
for (StepExecution se : result) {
se.onResume();
}
LOGGER.log(FINE, "Will resume {0}", result);
for (StepExecution se : result) {
se.onResume();
}
}

Expand All @@ -197,7 +198,7 @@ public void onFailure(Throwable t) {
LOGGER.log(WARNING, "Failed to load " + e, t);
}
}
}, MoreExecutors.newDirectExecutorService());
}, newExecutorService());
Copy link
Member

@jglick jglick Mar 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I get it. The original code was not specifying an executor service, so why do we need to add this code now?

Copy link
Member Author

@timja timja Mar 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deprecated in v22 https://github.com/google/guava/blob/v22.0/guava/src/com/google/common/util/concurrent/Futures.java#L1073

Removed in v26
https://github.com/google/guava/blob/v26.0/guava/src/com/google/common/util/concurrent/Futures.java (not there anymore)

Copy link
Member

@jglick jglick Mar 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/google/guava/blob/v22.0/guava/src/com/google/common/util/concurrent/Futures.java#L1158-L1167 I guess you mean. 👍

}
}
}
Expand All @@ -220,13 +221,11 @@ public ListenableFuture<?> apply(final Function<StepExecution, Void> f) {
Futures.addCallback(execs,new FutureCallback<List<StepExecution>>() {
@Override
public void onSuccess(List<StepExecution> result) {
if (result != null) {
for (StepExecution e : result) {
try {
f.apply(e);
} catch (RuntimeException x) {
LOGGER.log(Level.WARNING, null, x);
}
for (StepExecution e : result) {
try {
f.apply(e);
} catch (RuntimeException x) {
LOGGER.log(Level.WARNING, null, x);
}
}
}
Expand All @@ -235,7 +234,7 @@ public void onSuccess(List<StepExecution> result) {
public void onFailure(Throwable t) {
LOGGER.log(Level.WARNING, null, t);
}
}, MoreExecutors.newDirectExecutorService());
}, newExecutorService());
}

return Futures.allAsList(all);
Expand All @@ -259,4 +258,25 @@ public void onFailure(Throwable t) {
executor.awaitTermination(1, TimeUnit.MINUTES);
}

/**
* Returns an {@link ExecutorService} to be used as a parameter in other methods.
* It calls {@code MoreExecutors#sameThreadExecutor} or falls back to {@code MoreExecutors#newDirectExecutorService}
* for compatibility with newer (> 18.0) versions of guava.
*/
private static ExecutorService newExecutorService() {
try {
try {
// guava older than 18
Method method = MoreExecutors.class.getMethod("sameThreadExecutor");
return (ExecutorService) method.invoke(null);
} catch (NoSuchMethodException e) {
// TODO invert this to prefer the newer guava method once guava is upgraded in Jenkins core
Method method = MoreExecutors.class.getMethod("newDirectExecutorService");
return (ExecutorService) method.invoke(null);
}
} catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e ) {
throw new RuntimeException(e);
}
}

}
2 changes: 1 addition & 1 deletion src/main/java/org/jenkinsci/plugins/workflow/graphanalysis/ForkScanner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@

import com.google.common.base.Predicate;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.jenkinsci.plugins.workflow.actions.ThreadNameAction;
import org.jenkinsci.plugins.workflow.actions.TimingAction;
import org.jenkinsci.plugins.workflow.graph.BlockEndNode;
Expand All @@ -37,6 +36,7 @@

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import java.util.ArrayDeque;
import java.util.ArrayList;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/jenkinsci/plugins/workflow/graphanalysis/NodeStepNamePredicate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@
package org.jenkinsci.plugins.workflow.graphanalysis;

import com.google.common.base.Predicate;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.jenkinsci.plugins.workflow.graph.FlowEndNode;
import org.jenkinsci.plugins.workflow.graph.FlowNode;
import org.jenkinsci.plugins.workflow.graph.FlowStartNode;
import org.jenkinsci.plugins.workflow.graph.StepNode;
import org.jenkinsci.plugins.workflow.steps.StepDescriptor;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/jenkinsci/plugins/workflow/graphanalysis/NodeStepTypePredicate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@
package org.jenkinsci.plugins.workflow.graphanalysis;

import com.google.common.base.Predicate;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.jenkinsci.plugins.workflow.graph.FlowEndNode;
import org.jenkinsci.plugins.workflow.graph.FlowNode;
import org.jenkinsci.plugins.workflow.graph.FlowStartNode;
import org.jenkinsci.plugins.workflow.graph.StepNode;
import org.jenkinsci.plugins.workflow.steps.StepDescriptor;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

Expand Down