Skip to content

💥 Carry over search attributes on continue-as-new if none are explicitly set #2731

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

💥 Carry over search attributes on continue-as-new if none are explicitly set #2731

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
91b0eb5
Carry over search attributes on continue-as-new if none are explicitl…
Quinn-With-Two-Ns Nov 19, 2025
6595b29
Fix check
Quinn-With-Two-Ns Nov 19, 2025
296c6b2
Don't copy search attributes if they are set in the options and empty
Quinn-With-Two-Ns Nov 19, 2025
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
9 changes: 8 additions & 1 deletion temporal-sdk/src/main/java/io/temporal/internal/sync/SyncWorkflowContext.java
View file
Open in desktop
Copy link
Member

@cretz cretz Nov 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Technically this is a change to behavior incompatibly if people have built expectation on the carryover not occurring. Should we add a 💥 in the title and note it in release notes? I assume if they want to go back to today's behavior they can provide an explicit empty attr collection?

(not reviewing the PR itself, just confirming the relaying of compatibility change)

Copy link
Contributor Author

@Quinn-With-Two-Ns Quinn-With-Two-Ns Nov 19, 2025

Choose a reason for hiding this comment

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

So according to the Javadoc the behaviour has always been to copy if none are specify, the SDK just hasn't been. This is a change in behavior so I have no issue calling it out with 💥 .

And yes if a user wants the previous behaviour they can set an empt collection.

Original file line number Diff line number Diff line change
Expand Up @@ -1365,6 +1365,12 @@ public void continueAsNew(ContinueAsNewInput input) {
&& options.getTypedSearchAttributes().size() > 0) {
attributes.setSearchAttributes(
SearchAttributesUtil.encodeTyped(options.getTypedSearchAttributes()));
} else {
// Carry over existing search attributes if none are specified.
SearchAttributes existing = replayContext.getSearchAttributes();
if (existing != null && !existing.getIndexedFieldsMap().isEmpty()) {
attributes.setSearchAttributes(existing);
}
}
Map<String, Object> memo = options.getMemo();
if (memo != null) {
Expand All @@ -1380,8 +1386,9 @@ public void continueAsNew(ContinueAsNewInput input) {
replayContext.getTaskQueue().equals(options.getTaskQueue())));
}
} else if (replayContext.getRetryOptions() != null) {
// Have to copy retry options as server doesn't copy them.
// Have to copy certain options as server doesn't copy them.
attributes.setRetryPolicy(toRetryPolicy(replayContext.getRetryOptions()));
attributes.setSearchAttributes(replayContext.getSearchAttributes());
}

List<ContextPropagator> propagators =
Expand Down
2 changes: 1 addition & 1 deletion temporal-sdk/src/main/java/io/temporal/workflow/ContinueAsNewOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import javax.annotation.Nullable;

/**
* This class contain overrides for continueAsNew call. Every field can be null and it means that
* This class contain overrides for continueAsNew call. Every field can be null, and it means that
* the value of the option should be taken from the originating workflow run.
*/
public final class ContinueAsNewOptions {
Expand Down
21 changes: 15 additions & 6 deletions temporal-sdk/src/test/java/io/temporal/workflow/ContinueAsNewTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,17 @@
import org.junit.Test;

public class ContinueAsNewTest {
static final SearchAttributeKey<String> CUSTOM_KEYWORD_SA =
SearchAttributeKey.forKeyword("CustomKeywordField");

public static final int INITIAL_COUNT = 4;

@Rule
public SDKTestWorkflowRule testWorkflowRule =
SDKTestWorkflowRule.newBuilder().setWorkflowTypes(TestContinueAsNewImpl.class).build();
SDKTestWorkflowRule.newBuilder()
.setWorkflowTypes(TestContinueAsNewImpl.class)
.setUseExternalService(true)
.build();

@Test
public void testContinueAsNew() {
Expand All @@ -30,6 +35,8 @@ public void testContinueAsNew() {
options =
WorkflowOptions.newBuilder(options)
.setRetryOptions(RetryOptions.newBuilder().setMaximumAttempts(10).build())
.setTypedSearchAttributes(
SearchAttributes.newBuilder().set(CUSTOM_KEYWORD_SA, "foo0").build())
.build();
TestContinueAsNew client =
testWorkflowRule.getWorkflowClient().newWorkflowStub(TestContinueAsNew.class, options);
Expand Down Expand Up @@ -68,8 +75,10 @@ public int execute(int count, String continueAsNewTaskQueue) {
String taskQueue = Workflow.getInfo().getTaskQueue();
if (count >= INITIAL_COUNT - 2) {
assertEquals(10, Workflow.getInfo().getRetryOptions().getMaximumAttempts());
assertEquals("foo0", Workflow.getTypedSearchAttributes().get(CUSTOM_KEYWORD_SA));
} else {
assertEquals(5, Workflow.getInfo().getRetryOptions().getMaximumAttempts());
assertEquals("foo1", Workflow.getTypedSearchAttributes().get(CUSTOM_KEYWORD_SA));
}
if (count == 0) {
assertEquals(continueAsNewTaskQueue, taskQueue);
Expand All @@ -78,22 +87,22 @@ public int execute(int count, String continueAsNewTaskQueue) {
Map<String, Object> memo = new HashMap<>();
memo.put("myKey", "MyValue");
RetryOptions retryOptions = null;
SearchAttributes searchAttributes = null;
// don't specify ContinueAsNewOptions on the first continue-as-new to test that RetryOptions
// and SearchAttributes
// are copied from the previous run.
if (count == INITIAL_COUNT) {
TestContinueAsNew next = Workflow.newContinueAsNewStub(TestContinueAsNew.class);
next.execute(count - 1, continueAsNewTaskQueue);
throw new RuntimeException("unreachable");
}
// don't specify RetryOptions on the second continue-as-new to test that they are copied from
// don't specify RetryOptions and SearchAttributes on the second continue-as-new to test that
// they are copied from
// the previous run.
if (count < INITIAL_COUNT - 1) {
retryOptions = RetryOptions.newBuilder().setMaximumAttempts(5).build();
searchAttributes = SearchAttributes.newBuilder().set(CUSTOM_KEYWORD_SA, "foo1").build();
}
SearchAttributes searchAttributes =
SearchAttributes.newBuilder()
.set(SearchAttributeKey.forKeyword("CustomKeywordField"), "foo1")
.build();
ContinueAsNewOptions options =
ContinueAsNewOptions.newBuilder()
.setTaskQueue(continueAsNewTaskQueue)
Expand Down
Loading