org.gradle.internal.operations.DefaultBuildOperationRunner Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.internal.operations;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.Nullable;
public class DefaultBuildOperationRunner implements BuildOperationRunner {
private static final Logger LOGGER = LoggerFactory.getLogger(DefaultBuildOperationRunner.class);
private static final BuildOperationWorker RUNNABLE_BUILD_OPERATION_WORKER = new BuildOperationWorker() {
@Override
public void execute(RunnableBuildOperation buildOperation, BuildOperationContext context) throws Exception {
buildOperation.run(context);
}
};
private final TimeSupplier clock;
private final BuildOperationIdFactory buildOperationIdFactory;
private final CurrentBuildOperationRef currentBuildOperationRef;
private final BuildOperationExecutionListenerFactory listenerFactory;
public DefaultBuildOperationRunner(CurrentBuildOperationRef currentBuildOperationRef, TimeSupplier clock, BuildOperationIdFactory buildOperationIdFactory) {
this(currentBuildOperationRef, clock, buildOperationIdFactory, new BuildOperationExecutionListenerFactory() {
@Override
public BuildOperationExecutionListener createListener() {
return BuildOperationExecutionListener.NO_OP;
}
});
}
public DefaultBuildOperationRunner(CurrentBuildOperationRef currentBuildOperationRef, TimeSupplier clock, BuildOperationIdFactory buildOperationIdFactory, BuildOperationExecutionListenerFactory listenerFactory) {
this.currentBuildOperationRef = currentBuildOperationRef;
this.clock = clock;
this.buildOperationIdFactory = buildOperationIdFactory;
this.listenerFactory = listenerFactory;
}
@Override
public void run(RunnableBuildOperation buildOperation) {
execute(buildOperation, RUNNABLE_BUILD_OPERATION_WORKER, getCurrentBuildOperation());
}
@Override
public T call(CallableBuildOperation buildOperation) {
CallableBuildOperationWorker worker = new CallableBuildOperationWorker();
execute(buildOperation, worker, getCurrentBuildOperation());
return worker.getReturnValue();
}
@Override
public void execute(final O buildOperation, final BuildOperationWorker worker, @Nullable BuildOperationState defaultParent) {
execute(buildOperation.description(), defaultParent, new BuildOperationExecution() {
@Override
public O execute(BuildOperationDescriptor descriptor, BuildOperationState operationState, @Nullable BuildOperationState parent, ReadableBuildOperationContext context, BuildOperationExecutionListener listener) {
Throwable failure = null;
try {
listener.start(descriptor, operationState);
try {
worker.execute(buildOperation, context);
} catch (Throwable t) {
if (context.getFailure() == null) {
context.failed(t);
}
failure = t;
}
listener.stop(descriptor, operationState, parent, context);
if (failure != null) {
throw throwAsBuildOperationInvocationException(failure);
}
return buildOperation;
} finally {
listener.close(descriptor, operationState);
}
}
});
}
@Override
public BuildOperationContext start(BuildOperationDescriptor.Builder descriptorBuilder) {
return execute(descriptorBuilder, getCurrentBuildOperation(), new BuildOperationExecution() {
@Override
public BuildOperationContext execute(final BuildOperationDescriptor descriptor, final BuildOperationState operationState, @Nullable final BuildOperationState parent, final ReadableBuildOperationContext context, final BuildOperationExecutionListener listener) {
listener.start(descriptor, operationState);
return new BuildOperationContext() {
private boolean finished;
@Override
public void failed(@Nullable Throwable failure) {
assertNotFinished();
context.failed(failure);
finish();
}
@Override
public void setResult(Object result) {
assertNotFinished();
context.setResult(result);
finish();
}
@Override
public void setStatus(String status) {
assertNotFinished();
context.setStatus(status);
}
private void finish() {
finished = true;
try {
listener.stop(descriptor, operationState, parent, context);
} finally {
listener.close(descriptor, operationState);
}
}
private void assertNotFinished() {
if (finished) {
throw new IllegalStateException(String.format("Operation (%s) has already finished.", descriptor));
}
}
};
}
});
}
private O execute(BuildOperationDescriptor.Builder descriptorBuilder, @Nullable BuildOperationState defaultParent, BuildOperationExecution execution) {
BuildOperationState descriptorParent = (BuildOperationState) descriptorBuilder.getParentState();
BuildOperationState parent = descriptorParent == null ? defaultParent : descriptorParent;
OperationIdentifier id = new OperationIdentifier(buildOperationIdFactory.nextId());
BuildOperationDescriptor descriptor = descriptorBuilder.build(id, parent == null
? null
: parent.getDescription().getId());
assertParentRunning("Cannot start operation (%s) as parent operation (%s) has already completed.", descriptor, parent);
BuildOperationState operationState = new BuildOperationState(descriptor, clock.getCurrentTime());
DefaultBuildOperationContext context = new DefaultBuildOperationContext();
return execution.execute(
descriptor,
operationState,
parent,
context,
new BuildOperationTrackingListener(currentBuildOperationRef, listenerFactory.createListener())
);
}
private static void assertParentRunning(String message, BuildOperationDescriptor child, @Nullable BuildOperationState parent) {
if (parent != null && !parent.isRunning()) {
String parentName = parent.getDescription().getDisplayName();
throw new IllegalStateException(String.format(message, child.getDisplayName(), parentName));
}
}
@Nullable
private BuildOperationState getCurrentBuildOperation() {
return (BuildOperationState) currentBuildOperationRef.get();
}
public interface TimeSupplier {
long getCurrentTime();
}
private static RuntimeException throwAsBuildOperationInvocationException(Throwable t) {
if (t instanceof InterruptedException) {
Thread.currentThread().interrupt();
}
if (t instanceof RuntimeException) {
throw (RuntimeException) t;
}
if (t instanceof Error) {
throw (Error) t;
}
throw new BuildOperationInvocationException(t.getMessage(), t);
}
private interface BuildOperationExecution {
O execute(BuildOperationDescriptor descriptor, BuildOperationState operationState, @Nullable BuildOperationState parent, ReadableBuildOperationContext context, BuildOperationExecutionListener listener);
}
private static class CallableBuildOperationWorker implements BuildOperationWorker> {
private T returnValue;
@Override
public void execute(CallableBuildOperation buildOperation, BuildOperationContext context) throws Exception {
returnValue = buildOperation.call(context);
}
public T getReturnValue() {
return returnValue;
}
}
private static class BuildOperationTrackingListener implements BuildOperationExecutionListener {
private final CurrentBuildOperationRef currentBuildOperationRef;
private final BuildOperationExecutionListener delegate;
private BuildOperationState originalCurrentBuildOperation;
private BuildOperationTrackingListener(CurrentBuildOperationRef currentBuildOperationRef, BuildOperationExecutionListener delegate) {
this.currentBuildOperationRef = currentBuildOperationRef;
this.delegate = delegate;
}
@Override
public void start(BuildOperationDescriptor descriptor, BuildOperationState operationState) {
originalCurrentBuildOperation = (BuildOperationState) currentBuildOperationRef.get();
currentBuildOperationRef.set(operationState);
operationState.setRunning(true);
LOGGER.debug("Build operation '{}' started", descriptor.getDisplayName());
delegate.start(descriptor, operationState);
}
@Override
public void stop(BuildOperationDescriptor descriptor, BuildOperationState operationState, @Nullable BuildOperationState parent, ReadableBuildOperationContext context) {
delegate.stop(descriptor, operationState, parent, context);
LOGGER.debug("Completing Build operation '{}'", descriptor.getDisplayName());
assertParentRunning("Parent operation (%2$s) completed before this operation (%1$s).", descriptor, parent);
}
@Override
public void close(BuildOperationDescriptor descriptor, BuildOperationState operationState) {
delegate.close(descriptor, operationState);
currentBuildOperationRef.set(originalCurrentBuildOperation);
operationState.setRunning(false);
LOGGER.debug("Build operation '{}' completed", descriptor.getDisplayName());
}
}
public interface ReadableBuildOperationContext extends BuildOperationContext {
@Nullable
Object getResult();
@Override
void setResult(@Nullable Object result);
@Nullable
Throwable getFailure();
@Nullable
String getStatus();
@Override
void setStatus(@Nullable String status);
}
public interface BuildOperationExecutionListener {
BuildOperationExecutionListener NO_OP = new BuildOperationExecutionListener() {
@Override
public void start(BuildOperationDescriptor descriptor, BuildOperationState operationState) {}
@Override
public void stop(BuildOperationDescriptor descriptor, BuildOperationState operationState, @Nullable BuildOperationState parent, ReadableBuildOperationContext context) {}
@Override
public void close(BuildOperationDescriptor descriptor, BuildOperationState operationState) {}
};
void start(BuildOperationDescriptor descriptor, BuildOperationState operationState);
void stop(BuildOperationDescriptor descriptor, BuildOperationState operationState, @Nullable BuildOperationState parent, ReadableBuildOperationContext context);
void close(BuildOperationDescriptor descriptor, BuildOperationState operationState);
}
public interface BuildOperationExecutionListenerFactory {
BuildOperationExecutionListener createListener();
}
private static class DefaultBuildOperationContext implements ReadableBuildOperationContext {
private Throwable failure;
private Object result;
private String status;
@Nullable
@Override
public Object getResult() {
return result;
}
@Override
public void setResult(@Nullable Object result) {
this.result = result;
}
@Nullable
@Override
public Throwable getFailure() {
return failure;
}
@Override
public void failed(@Nullable Throwable t) {
failure = t;
}
@Nullable
@Override
public String getStatus() {
return status;
}
@Override
public void setStatus(@Nullable String status) {
this.status = status;
}
}
}