Data Converters now have method deserializing all the Payloads at once (#1726)

Issue #1345

Author: Spikhalskiy

build.gradle

@@ -1,7 +1,7 @@
 buildscript {
     ext {
         palantirGitVersionVersion = "${JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_11) ? '0.15.0' : '0.13.0'}"
-        kotlinVersion = "${project.hasProperty("edgeDepsTest") ? '1.8.10' : (JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_16) ? '1.5.32' : '1.4.32')}"
+        kotlinVersion = "${project.hasProperty("edgeDepsTest") ? '1.8.20' : (JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_16) ? '1.5.32' : '1.4.32')}"
     }
 }
 
@@ -10,14 +10,14 @@ plugins {
     id 'org.cadixdev.licenser' version '0.6.1'
     id 'com.palantir.git-version' version "${palantirGitVersionVersion}" apply false
     id 'io.github.gradle-nexus.publish-plugin' version '1.3.0'
-    id 'com.diffplug.spotless' version '6.17.0' apply false
+    id 'com.diffplug.spotless' version '6.18.0' apply false
     id 'com.github.nbaztec.coveralls-jacoco' version "1.2.15" apply false
 
     //    id 'org.jetbrains.kotlin.jvm' version '1.4.32'
     //    id 'org.jetbrains.kotlin.jvm' version '1.5.32'
     //    id 'org.jetbrains.kotlin.jvm' version '1.6.21'
     //    id 'org.jetbrains.kotlin.jvm' version '1.7.22'
-    //    id 'org.jetbrains.kotlin.jvm' version '1.8.10'
+    //    id 'org.jetbrains.kotlin.jvm' version '1.8.20'
     id 'org.jetbrains.kotlin.jvm' version "${kotlinVersion}" apply false
     id 'base'
 }
@@ -30,7 +30,7 @@ allprojects {
 
 ext {
     // Platforms
-    grpcVersion = '1.54.0' // [1.38.0,) Needed for io.grpc.protobuf.services.HealthStatusManager
+    grpcVersion = '1.54.1' // [1.38.0,) Needed for io.grpc.protobuf.services.HealthStatusManager
     jacksonVersion = '2.14.2' // [2.9.0,)
     // we don't upgrade to 1.10.x because it requires kotlin 1.6. Users may use 1.10.x in their environments though.
     micrometerVersion = project.hasProperty("edgeDepsTest") ? '1.10.5' : '1.9.9' // [1.0.0,)
@@ -50,7 +50,7 @@ ext {
 
     gsonVersion = '2.10.1' // [2.0,)
 
-    jsonPathVersion = '2.7.0' // compileOnly
+    jsonPathVersion = '2.8.0' // compileOnly
 
     cronUtilsVersion = '9.2.1' // for test server only
 

gradle/jacoco.gradle

@@ -51,7 +51,7 @@ subprojects {
     apply plugin: 'jacoco'
 
     jacoco {
-        toolVersion = "0.8.8"
+        toolVersion = "0.8.9"
     }
 
     jacocoTestReport {

temporal-sdk/src/main/java/io/temporal/common/converter/CodecDataConverter.java

@@ -175,6 +175,17 @@ public <T> T fromPayloads(
         .fromPayloads(index, content, valueType, valueGenericType);
   }
 
+  @Override
+  public Object[] fromPayloads(
+      Optional<Payloads> content, Class<?>[] parameterTypes, Type[] genericParameterTypes)
+      throws DataConverterException {
+    if (content.isPresent()) {
+      content = Optional.of(decodePayloads(content.get()));
+    }
+    return ConverterUtils.withContext(dataConverter, serializationContext)
+        .fromPayloads(content, parameterTypes, genericParameterTypes);
+  }
+
   @Override
   @Nonnull
   public Failure exceptionToFailure(@Nonnull Throwable throwable) {

temporal-sdk/src/main/java/io/temporal/common/converter/DataConverter.java

@@ -99,13 +99,12 @@ <T> T fromPayload(Payload payload, Class<T> valueClass, Type valueType)
   Optional<Payloads> toPayloads(Object... values) throws DataConverterException;
 
   /**
-   * Implements conversion of an array of values of different types. Useful for deserializing
-   * arguments of function invocations.
+   * Implements conversion of a single {@link Payload} from the serialized {@link Payloads}.
    *
    * @param index index of the value in the payloads
    * @param content serialized value to convert to Java objects.
-   * @param valueType type of the value stored in the content
-   * @param valueGenericType generic type of the value stored in the content
+   * @param valueType type of the value stored in the {@code content}
+   * @param valueGenericType generic type of the value stored in the {@code content}
    * @return converted Java object
    * @throws DataConverterException if conversion of the data passed as parameter failed for any
    *     reason.
@@ -115,32 +114,23 @@ <T> T fromPayloads(
       throws DataConverterException;
 
   /**
-   * Instantiate an appropriate Java Exception from a serialized Failure object. The default
-   * implementation delegates the conversion process to an instance of {@link FailureConverter},
-   * using this data converter for payload decoding.
+   * Implements conversion of the whole {@code content} {@link Payloads} into an array of values of
+   * different types.
    *
-   * @param failure Failure protobuf object to deserialize into an exception
-   * @throws NullPointerException if failure is null
-   */
-  @Nonnull
-  TemporalFailure failureToException(@Nonnull Failure failure);
-
-  /**
-   * Serialize an existing Throwable object into a Failure object. The default implementation
-   * delegates the conversion process to an instance of {@link FailureConverter}, using this data
-   * converter for payload encoding.
+   * <p>Implementation note<br>
+   * This method is expected to return an array of the same length as {@code parameterTypes}. If
+   * {@code content} has not enough {@link Payload} elements, this method provides default
+   * instances.
    *
-   * @param throwable a Throwable object to serialize into a Failure protobuf object
-   * @throws NullPointerException if throwable is null
+   * @param content serialized value to convert to Java objects.
+   * @param parameterTypes types of the values stored in the @code content}
+   * @param genericParameterTypes generic types of the values stored in the {@code content}
+   * @return array if converted Java objects
+   * @throws DataConverterException if conversion of the data passed as parameter failed for any
+   *     reason.
    */
-  @Nonnull
-  Failure exceptionToFailure(@Nonnull Throwable throwable);
-
-  static Object[] arrayFromPayloads(
-      DataConverter converter,
-      Optional<Payloads> content,
-      Class<?>[] parameterTypes,
-      Type[] genericParameterTypes)
+  default Object[] fromPayloads(
+      Optional<Payloads> content, Class<?>[] parameterTypes, Type[] genericParameterTypes)
       throws DataConverterException {
     if (parameterTypes != null
         && (genericParameterTypes == null
@@ -152,8 +142,8 @@ static Object[] arrayFromPayloads(
               + Arrays.toString(genericParameterTypes));
     }
 
-    int length = parameterTypes.length;
-    Object[] result = new Object[length];
+    int totalLength = parameterTypes.length;
+    Object[] result = new Object[totalLength];
     if (!content.isPresent()) {
       // Return defaults for all the parameters
       for (int i = 0; i < parameterTypes.length; i++) {
@@ -169,12 +159,34 @@ static Object[] arrayFromPayloads(
       if (i >= count) {
         result[i] = Defaults.defaultValue((Class<?>) gt);
       } else {
-        result[i] = converter.fromPayload(payloads.getPayloads(i), pt, gt);
+        result[i] = this.fromPayload(payloads.getPayloads(i), pt, gt);
       }
     }
     return result;
   }
 
+  /**
+   * Instantiate an appropriate Java Exception from a serialized Failure object. The default
+   * implementation delegates the conversion process to an instance of {@link FailureConverter},
+   * using this data converter for payload decoding.
+   *
+   * @param failure Failure protobuf object to deserialize into an exception
+   * @throws NullPointerException if failure is null
+   */
+  @Nonnull
+  TemporalFailure failureToException(@Nonnull Failure failure);
+
+  /**
+   * Serialize an existing Throwable object into a Failure object. The default implementation
+   * delegates the conversion process to an instance of {@link FailureConverter}, using this data
+   * converter for payload encoding.
+   *
+   * @param throwable a Throwable object to serialize into a Failure protobuf object
+   * @throws NullPointerException if throwable is null
+   */
+  @Nonnull
+  Failure exceptionToFailure(@Nonnull Throwable throwable);
+
   /**
    * A correct implementation of this interface should have a fully functional "contextless"
    * implementation. Temporal SDK will call this method when a knowledge of the context exists, but
@@ -197,4 +209,18 @@ static Object[] arrayFromPayloads(
   default DataConverter withContext(@Nonnull SerializationContext context) {
     return this;
   }
+
+  /**
+   * @deprecated use {@link DataConverter#fromPayloads(int, Optional, Class, Type)}. This is an SDK
+   *     implementation detail and never was expected to be exposed to users.
+   */
+  @Deprecated
+  static Object[] arrayFromPayloads(
+      DataConverter converter,
+      Optional<Payloads> content,
+      Class<?>[] parameterTypes,
+      Type[] genericParameterTypes)
+      throws DataConverterException {
+    return converter.fromPayloads(content, parameterTypes, genericParameterTypes);
+  }
 }

temporal-sdk/src/main/java/io/temporal/internal/activity/ActivityTaskExecutors.java

@@ -200,11 +200,8 @@ ActivityInboundCallsInterceptor createRootInboundInterceptor() {
 
     @Override
     Object[] provideArgs(Optional<Payloads> input, DataConverter dataConverterWithActivityContext) {
-      return DataConverter.arrayFromPayloads(
-          dataConverterWithActivityContext,
-          input,
-          method.getParameterTypes(),
-          method.getGenericParameterTypes());
+      return dataConverterWithActivityContext.fromPayloads(
+          input, method.getParameterTypes(), method.getGenericParameterTypes());
     }
 
     @Override

temporal-sdk/src/main/java/io/temporal/internal/sync/POJOWorkflowImplementationFactory.java

@@ -306,11 +306,8 @@ public Optional<Payloads> execute(Header header, Optional<Payloads> input)
         throws CanceledFailure, WorkflowExecutionException {
 
       Object[] args =
-          DataConverter.arrayFromPayloads(
-              dataConverterWithWorkflowContext,
-              input,
-              workflowMethod.getParameterTypes(),
-              workflowMethod.getGenericParameterTypes());
+          dataConverterWithWorkflowContext.fromPayloads(
+              input, workflowMethod.getParameterTypes(), workflowMethod.getGenericParameterTypes());
       Preconditions.checkNotNull(workflowInvoker, "initialize not called");
       WorkflowInboundCallsInterceptor.WorkflowOutput result =
           workflowInvoker.execute(new WorkflowInboundCallsInterceptor.WorkflowInput(header, args));

temporal-sdk/src/main/java/io/temporal/internal/sync/QueryDispatcher.java

@@ -80,11 +80,8 @@ public Optional<Payloads> handleQuery(String queryName, Optional<Payloads> input
       args = new Object[] {new EncodedValues(input, dataConverterWithWorkflowContext)};
     } else {
       args =
-          DataConverter.arrayFromPayloads(
-              dataConverterWithWorkflowContext,
-              input,
-              handler.getArgTypes(),
-              handler.getGenericArgTypes());
+          dataConverterWithWorkflowContext.fromPayloads(
+              input, handler.getArgTypes(), handler.getGenericArgTypes());
     }
     Object result =
         inboundCallsInterceptor

temporal-sdk/src/main/java/io/temporal/internal/sync/SignalDispatcher.java

@@ -89,11 +89,8 @@ public void handleSignal(String signalName, Optional<Payloads> input, long event
     } else {
       try {
         args =
-            DataConverter.arrayFromPayloads(
-                dataConverterWithWorkflowContext,
-                input,
-                handler.getArgTypes(),
-                handler.getGenericArgTypes());
+            dataConverterWithWorkflowContext.fromPayloads(
+                input, handler.getArgTypes(), handler.getGenericArgTypes());
       } catch (DataConverterException e) {
         logSerializationException(signalName, eventId, e);
         return;

temporal-sdk/src/test/java/io/temporal/common/converter/JsonDataConverterTest.java

@@ -117,8 +117,7 @@ public void AdditionalInputArgumentsAreIgnored() throws NoSuchMethodException {
     Optional<Payloads> data =
         converter.toPayloads(1234, struct1, "a string", list, "an extra string :o!!!");
     Object[] deserializedArguments =
-        DataConverter.arrayFromPayloads(
-            converter, data, m.getParameterTypes(), m.getGenericParameterTypes());
+        converter.fromPayloads(data, m.getParameterTypes(), m.getGenericParameterTypes());
     assertEquals(4, deserializedArguments.length);
     assertEquals(1234, (int) deserializedArguments[0]);
     assertEquals(struct1, deserializedArguments[1]);
@@ -136,8 +135,7 @@ public void MissingInputArgumentsArePopulatedWithDefaultValues() throws NoSuchMe
     Optional<Payloads> data = converter.toPayloads(1);
     @SuppressWarnings("unchecked")
     Object[] deserializedArguments =
-        DataConverter.arrayFromPayloads(
-            converter, data, m.getParameterTypes(), m.getGenericParameterTypes());
+        converter.fromPayloads(data, m.getParameterTypes(), m.getGenericParameterTypes());
     assertEquals(5, deserializedArguments.length);
     assertEquals(1, (int) deserializedArguments[0]);
     assertEquals(null, deserializedArguments[1]);

temporal-spring-boot-autoconfigure-alpha/build.gradle

@@ -1,7 +1,7 @@
 description = '''Spring Boot AutoConfigure for Temporal Java SDK'''
 
 ext {
-    otelVersion = '1.24.0'
+    otelVersion = '1.25.0'
     otShimVersion = "${otelVersion}-alpha"
 }