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

Allow creating a stub of an update only interface #1967

Merged
merged 2 commits into from
Jan 13, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,7 @@
import io.temporal.serviceclient.MetricsTag;
import io.temporal.serviceclient.WorkflowServiceStubs;
import io.temporal.worker.WorkerFactory;
import io.temporal.workflow.Functions;
import io.temporal.workflow.QueryMethod;
import io.temporal.workflow.SignalMethod;
import io.temporal.workflow.WorkflowMethod;
import io.temporal.workflow.*;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
Expand Down Expand Up @@ -175,7 +172,12 @@ public <T> T newWorkflowStub(Class<T> workflowInterface, String workflowId) {
@Override
public <T> T newWorkflowStub(
Class<T> workflowInterface, String workflowId, Optional<String> runId) {
checkAnnotation(workflowInterface, WorkflowMethod.class, QueryMethod.class, SignalMethod.class);
checkAnnotation(
workflowInterface,
WorkflowMethod.class,
QueryMethod.class,
SignalMethod.class,
UpdateMethod.class);
if (Strings.isNullOrEmpty(workflowId)) {
throw new IllegalArgumentException("workflowId is null or empty");
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
/*
* Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved.
*
* Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Modifications copyright (C) 2017 Uber Technologies, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this material 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 io.temporal.workflow.updateTest;

import static org.junit.Assert.assertEquals;

import io.temporal.api.common.v1.WorkflowExecution;
import io.temporal.client.WorkflowClient;
import io.temporal.client.WorkflowOptions;
import io.temporal.testing.internal.SDKTestOptions;
import io.temporal.testing.internal.SDKTestWorkflowRule;
import io.temporal.workflow.UpdateMethod;
import io.temporal.workflow.Workflow;
import io.temporal.workflow.WorkflowInterface;
import io.temporal.workflow.WorkflowMethod;
import java.util.Optional;
import org.junit.Rule;
import org.junit.Test;

public class UpdateAnnotationTest {
@Rule
public SDKTestWorkflowRule testWorkflowRule =
SDKTestWorkflowRule.newBuilder().setWorkflowTypes(WorkflowImpl.class).build();

@Test
public void testUpdateOnlyInterface() {
// Verify a stub to an interface with only @UpdateMethod can be created.
WorkflowClient workflowClient = testWorkflowRule.getWorkflowClient();
WorkflowOptions options =
SDKTestOptions.newWorkflowOptionsWithTimeouts(testWorkflowRule.getTaskQueue()).toBuilder()
.build();
WorkflowTestInterface workflow =
workflowClient.newWorkflowStub(WorkflowTestInterface.class, options);

WorkflowExecution execution = WorkflowClient.start(workflow::execute);

UpdateWorkflowInterface updateOnlyWorkflow =
workflowClient.newWorkflowStub(UpdateWorkflowInterface.class, execution.getWorkflowId());
updateOnlyWorkflow.update();

String result =
testWorkflowRule
.getWorkflowClient()
.newUntypedWorkflowStub(execution, Optional.empty())
.getResult(String.class);
assertEquals("success", result);
}

public interface UpdateWorkflowInterface {
@UpdateMethod
void update();
}

@WorkflowInterface
public interface WorkflowTestInterface extends UpdateWorkflowInterface {
@WorkflowMethod
String execute();
}

public static class WorkflowImpl implements WorkflowTestInterface {
boolean complete = false;

@Override
public String execute() {
Workflow.await(() -> complete);
return "success";
}

@Override
public void update() {
complete = true;
}
}
}
Loading