Skip to content
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.

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

Add determinstic UUID generation #947

Merged
merged 5 commits into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<grpc.version>1.42.1</grpc.version>
<grpc.version>1.59.0</grpc.version>
<protobuf.version>3.17.3</protobuf.version>
<dapr.proto.baseurl>https://raw.githubusercontent.com/dapr/dapr/v1.12.0-rc.2/dapr/proto</dapr.proto.baseurl>
<dapr.sdk-workflows.version>0.11.0-SNAPSHOT</dapr.sdk-workflows.version>
Expand Down
2 changes: 1 addition & 1 deletion sdk-actors/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<properties>
<maven.deploy.skip>false</maven.deploy.skip>
<grpc.version>1.42.1</grpc.version>
<grpc.version>1.59.0</grpc.version>
</properties>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion sdk-autogen/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<protobuf.output.directory>${project.build.directory}/generated-sources</protobuf.output.directory>
<protobuf.input.directory>${project.build.directory}/proto</protobuf.input.directory>
<maven.deploy.skip>false</maven.deploy.skip>
<grpc.version>1.42.1</grpc.version>
<grpc.version>1.59.0</grpc.version>
</properties>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion sdk-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<dapr.sdk.version>1.11.0-SNAPSHOT</dapr.sdk.version>
<protobuf.output.directory>${project.build.directory}/generated-sources</protobuf.output.directory>
<protobuf.input.directory>${project.basedir}/proto</protobuf.input.directory>
<grpc.version>1.42.1</grpc.version>
<grpc.version>1.59.0</grpc.version>
<protobuf.version>3.17.3</protobuf.version>
<opentelemetry.version>0.14.0</opentelemetry.version>
<spring-boot.version>2.7.8</spring-boot.version>
Expand Down
2 changes: 1 addition & 1 deletion sdk-workflows/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
<dependency>
<groupId>com.microsoft</groupId>
<artifactId>durabletask-client</artifactId>
<version>1.1.1</version>
<version>1.5.0</version>
</dependency>
<!--
manually declare durabletask-client's jackson dependencies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import java.time.Duration;
import java.time.Instant;
import java.util.List;
import java.util.UUID;

public class DaprWorkflowContextImpl implements WorkflowContext {
private final TaskOrchestrationContext innerContext;
Expand Down Expand Up @@ -204,4 +205,12 @@ public void continueAsNew(Object input) {
public void continueAsNew(Object input, boolean preserveUnprocessedEvents) {
this.innerContext.continueAsNew(input, preserveUnprocessedEvents);
}

/**
* {@inheritDoc}
*/
@Override
public UUID newUuid() {
return this.innerContext.newUUID();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import java.time.ZonedDateTime;
import java.util.Arrays;
import java.util.List;
import java.util.UUID;

/**
* Context object used by workflow implementations to perform actions such as scheduling activities,
Expand Down Expand Up @@ -514,4 +515,19 @@ default void continueAsNew(Object input) {
* history, otherwise {@code false}
*/
void continueAsNew(Object input, boolean preserveUnprocessedEvents);

/**
* Create a new UUID that is safe for replay within a workflow.
*
* <p>
* The default implementation of this method creates a name-based UUID
* using the algorithm from RFC 4122 §4.3. The name input used to generate
* this value is a combination of the workflow instance ID and an
* internally managed sequence number.
*</p>
* @return a deterministic UUID
*/
default UUID newUuid() {
throw new RuntimeException("No implementation found.");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,25 @@

package io.dapr.workflows;

import com.microsoft.durabletask.CompositeTaskFailedException;
import com.microsoft.durabletask.RetryPolicy;
import com.microsoft.durabletask.Task;
import com.microsoft.durabletask.TaskCanceledException;
import com.microsoft.durabletask.TaskOptions;
import com.microsoft.durabletask.TaskOrchestrationContext;

import org.jetbrains.annotations.Nullable;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;

import java.time.Duration;
import java.time.Instant;
import java.time.ZonedDateTime;
import java.util.Arrays;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
Expand All @@ -37,11 +42,95 @@
public class DaprWorkflowContextImplTest {
private DaprWorkflowContextImpl context;
private TaskOrchestrationContext mockInnerContext;
private WorkflowContext testWorkflowContext;

@BeforeEach
public void setUp() {
mockInnerContext = mock(TaskOrchestrationContext.class);
context = new DaprWorkflowContextImpl(mockInnerContext);
testWorkflowContext = new WorkflowContext() {
@Override
public Logger getLogger() {
return null;
}

@Override
public String getName() {
return null;
}

@Override
public String getInstanceId() {
return null;
}

@Override
public Instant getCurrentInstant() {
return null;
}

@Override
public void complete(Object output) {

}

@Override
public <V> Task<V> waitForExternalEvent(String name, Duration timeout, Class<V> dataType)
throws TaskCanceledException {
return null;
}

@Override
public <V> Task<Void> waitForExternalEvent(String name, Duration timeout) throws TaskCanceledException {
return null;
}

@Override
public <V> Task<Void> waitForExternalEvent(String name) throws TaskCanceledException {
return null;
}

@Override
public <V> Task<V> callActivity(String name, Object input, TaskOptions options, Class<V> returnType) {
return null;
}

@Override
public boolean isReplaying() {
return false;
}

@Override
public <V> Task<List<V>> allOf(List<Task<V>> tasks) throws CompositeTaskFailedException {
return null;
}

@Override
public Task<Task<?>> anyOf(List<Task<?>> tasks) {
return null;
}

@Override
public Task<Void> createTimer(Duration duration) {
return null;
}

@Override
public <V> V getInput(Class<V> targetType) {
return null;
}

@Override
public <V> Task<V> callSubWorkflow(String name, @Nullable Object input, @Nullable String instanceID,
@Nullable TaskOptions options, Class<V> returnType) {
return null;
}

@Override
public void continueAsNew(Object input, boolean preserveUnprocessedEvents) {

}
};
}

@Test
Expand Down Expand Up @@ -207,4 +296,17 @@ public void callSubWorkflow() {
context.callSubWorkflow(expectedName, expectedInput, String.class);
verify(mockInnerContext, times(1)).callSubOrchestrator(expectedName, expectedInput, null, null, String.class);
}

@Test
public void newUuidTest() {
context.newUuid();
verify(mockInnerContext, times(1)).newUUID();
}

@Test
public void newUuidTestNoImplementationExceptionTest() {
RuntimeException runtimeException = assertThrows(RuntimeException.class, testWorkflowContext::newUuid);
String expectedMessage = "No implementation found.";
assertEquals(expectedMessage, runtimeException.getMessage());
}
}
2 changes: 1 addition & 1 deletion sdk/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<properties>
<maven.deploy.skip>false</maven.deploy.skip>
<grpc.version>1.42.1</grpc.version>
<grpc.version>1.59.0</grpc.version>
<argLine>
--add-opens java.base/java.util=ALL-UNNAMED
</argLine>
Expand Down