Skip to content

Use default data converter for search attributes and memo #483

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
merged 4 commits into from
May 12, 2021
Merged

Use default data converter for search attributes and memo #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f747f5a
Use default data converter for search attributes and memo
vitarb May 11, 2021
e023b2f
do it for memo as well
vitarb May 11, 2021
ded59bc
apply google format
vitarb May 11, 2021
1d756e0
Rename function and add comment
vitarb May 12, 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
11 changes: 4 additions & 7 deletions temporal-sdk/src/main/java/io/temporal/internal/client/RootWorkflowClientHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

package io.temporal.internal.client;

import static io.temporal.internal.common.HeaderUtils.convertMapFromObjectToBytes;
import static io.temporal.internal.common.HeaderUtils.intoPayloadMapWithDefaultConverter;
import static io.temporal.internal.common.HeaderUtils.toHeaderGrpc;
import static io.temporal.internal.common.SerializerUtils.toRetryPolicy;

Expand Down Expand Up @@ -84,12 +84,13 @@ StartWorkflowExecutionRequest newStartWorkflowExecutionRequest(
request.setCronSchedule(options.getCronSchedule());
}
if (options.getMemo() != null) {
request.setMemo(Memo.newBuilder().putAllFields(convertFromObjectToBytes(options.getMemo())));
request.setMemo(
Memo.newBuilder().putAllFields(intoPayloadMapWithDefaultConverter(options.getMemo())));
}
if (options.getSearchAttributes() != null) {
request.setSearchAttributes(
SearchAttributes.newBuilder()
.putAllIndexedFields(convertFromObjectToBytes(options.getSearchAttributes())));
.putAllIndexedFields(intoPayloadMapWithDefaultConverter(options.getSearchAttributes())));
}

Header grpcHeader =
Expand All @@ -100,10 +101,6 @@ StartWorkflowExecutionRequest newStartWorkflowExecutionRequest(
return request.build();
}

private Map<String, Payload> convertFromObjectToBytes(Map<String, Object> map) {
return convertMapFromObjectToBytes(map, clientOptions.getDataConverter());
}

private io.temporal.common.interceptors.Header extractContextsAndConvertToBytes(
List<ContextPropagator> contextPropagators) {
if (contextPropagators == null) {
Expand Down
9 changes: 7 additions & 2 deletions temporal-sdk/src/main/java/io/temporal/internal/common/HeaderUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,16 @@ public static Header toHeaderGrpc(
return builder.build();
}

public static Map<String, Payload> convertMapFromObjectToBytes(
Map<String, Object> map, DataConverter dataConverter) {
/*
* Converts a Map<String, Object> into a Map<String, Payload> by applying default data converter on each value.
* Note that this does not use user defined converters and should be used only for things like search attributes and
* memo that need to be converted back from bytes on the server.
*/
public static Map<String, Payload> intoPayloadMapWithDefaultConverter(Map<String, Object> map) {
if (map == null) {
return null;
}
DataConverter dataConverter = DataConverter.getDefaultInstance();
Map<String, Payload> result = new HashMap<>();
for (Map.Entry<String, Object> item : map.entrySet()) {
try {
Expand Down
3 changes: 2 additions & 1 deletion temporal-sdk/src/main/java/io/temporal/internal/common/InternalUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ public static Object getValueOrDefault(Object value, Class<?> valueClass) {
}

public static SearchAttributes convertMapToSearchAttributes(
Map<String, Object> searchAttributes, DataConverter converter) {
Map<String, Object> searchAttributes) {
DataConverter converter = DataConverter.getDefaultInstance();
Map<String, Payload> mapOfByteBuffer = new HashMap<>();
searchAttributes.forEach(
(key, value) -> mapOfByteBuffer.put(key, converter.toPayload(value).get()));
Expand Down
11 changes: 4 additions & 7 deletions temporal-sdk/src/main/java/io/temporal/internal/sync/SyncWorkflowContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

package io.temporal.internal.sync;

import static io.temporal.internal.common.HeaderUtils.convertMapFromObjectToBytes;
import static io.temporal.internal.common.HeaderUtils.intoPayloadMapWithDefaultConverter;
import static io.temporal.internal.common.HeaderUtils.toHeaderGrpc;
import static io.temporal.internal.common.SerializerUtils.toRetryPolicy;

Expand Down Expand Up @@ -732,15 +732,13 @@ public void continueAsNew(ContinueAsNewInput input) {
}
Map<String, Object> memo = ops.getMemo();
if (memo != null) {
attributes.setMemo(
Memo.newBuilder().putAllFields(convertMapFromObjectToBytes(memo, getDataConverter())));
attributes.setMemo(Memo.newBuilder().putAllFields(intoPayloadMapWithDefaultConverter(memo)));
}
Map<String, Object> searchAttributes = ops.getSearchAttributes();
if (searchAttributes != null) {
attributes.setSearchAttributes(
SearchAttributes.newBuilder()
.putAllIndexedFields(
convertMapFromObjectToBytes(searchAttributes, getDataConverter())));
.putAllIndexedFields(intoPayloadMapWithDefaultConverter(searchAttributes)));
}
}
Optional<Payloads> payloads = getDataConverter().toPayloads(input.getArgs());
Expand Down Expand Up @@ -790,8 +788,7 @@ public void upsertSearchAttributes(Map<String, Object> searchAttributes) {
throw new IllegalArgumentException("Empty search attributes");
}

SearchAttributes attr =
InternalUtils.convertMapToSearchAttributes(searchAttributes, getDataConverter());
SearchAttributes attr = InternalUtils.convertMapToSearchAttributes(searchAttributes);
context.upsertSearchAttributes(attr);
}

Expand Down
6 changes: 2 additions & 4 deletions temporal-sdk/src/test/java/io/temporal/internal/common/InternalUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import static junit.framework.TestCase.assertEquals;

import io.temporal.api.common.v1.SearchAttributes;
import io.temporal.common.converter.DataConverter;
import io.temporal.common.converter.DataConverterException;
import java.io.FileOutputStream;
import java.util.HashMap;
Expand All @@ -37,8 +36,7 @@ public void testConvertMapToSearchAttributes() throws Throwable {
String value = "keyword";
attr.put("CustomKeywordField", value);

SearchAttributes result =
InternalUtils.convertMapToSearchAttributes(attr, DataConverter.getDefaultInstance());
SearchAttributes result = InternalUtils.convertMapToSearchAttributes(attr);
assertEquals(
value,
SearchAttributesUtil.getValueFromSearchAttributes(
Expand All @@ -49,6 +47,6 @@ public void testConvertMapToSearchAttributes() throws Throwable {
public void testConvertMapToSearchAttributesException() throws Throwable {
Map<String, Object> attr = new HashMap<>();
attr.put("InvalidValue", new FileOutputStream("dummy"));
InternalUtils.convertMapToSearchAttributes(attr, DataConverter.getDefaultInstance());
InternalUtils.convertMapToSearchAttributes(attr);
}
}
7 changes: 2 additions & 5 deletions temporal-sdk/src/test/java/io/temporal/internal/common/SearchAttributesUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import static junit.framework.TestCase.assertEquals;

import io.temporal.api.common.v1.SearchAttributes;
import io.temporal.common.converter.DataConverter;
import java.util.HashMap;
import java.util.Map;
import org.junit.Test;
Expand All @@ -47,8 +46,7 @@ public void TestGetValueFromSearchAttributes() {
attr.put("CustomDoubleField", doubleVal);
Boolean boolVal = Boolean.TRUE;
attr.put("CustomBooleanField", boolVal);
SearchAttributes searchAttributes =
InternalUtils.convertMapToSearchAttributes(attr, DataConverter.getDefaultInstance());
SearchAttributes searchAttributes = InternalUtils.convertMapToSearchAttributes(attr);

assertEquals(
stringVal,
Expand All @@ -73,8 +71,7 @@ public void TestGetValueFromSearchAttributesRepeated() {
Map<String, Object> attr = new HashMap<>();
String stringVal = "keyword";
attr.put("CustomKeywordField", stringVal);
SearchAttributes searchAttributes =
InternalUtils.convertMapToSearchAttributes(attr, DataConverter.getDefaultInstance());
SearchAttributes searchAttributes = InternalUtils.convertMapToSearchAttributes(attr);
assertEquals(
stringVal,
SearchAttributesUtil.getValueFromSearchAttributes(
Expand Down
3 changes: 1 addition & 2 deletions temporal-sdk/src/test/java/io/temporal/internal/sync/SyncWorkflowContextTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ public void setUp() {
public void testUpsertSearchAttributes() throws Throwable {
Map<String, Object> attr = new HashMap<>();
attr.put("CustomKeywordField", "keyword");
SearchAttributes serializedAttr =
InternalUtils.convertMapToSearchAttributes(attr, DataConverter.getDefaultInstance());
SearchAttributes serializedAttr = InternalUtils.convertMapToSearchAttributes(attr);

context.upsertSearchAttributes(attr);
verify(mockReplayWorkflowContext, times(1)).upsertSearchAttributes(serializedAttr);
Expand Down