Merge pull request #1514 from AxonFramework/result-message-payload-ac…

…cess-alignment

[#1477] ResultMessage illegal payload access alignment

axon-server-connector/src/main/java/org/axonframework/axonserver/connector/query/GrpcBackedResponseMessage.java

@@ -20,6 +20,7 @@
 import org.axonframework.axonserver.connector.ErrorCode;
 import org.axonframework.axonserver.connector.util.GrpcMetaData;
 import org.axonframework.axonserver.connector.util.GrpcSerializedObject;
+import org.axonframework.messaging.IllegalPayloadAccessException;
 import org.axonframework.messaging.MetaData;
 import org.axonframework.queryhandling.QueryResponseMessage;
 import org.axonframework.serialization.LazyDeserializingObject;
@@ -88,6 +89,13 @@ public MetaData getMetaData() {
 
  @Override
  public R getPayload() {
+ if (isExceptional()) {
+ throw new IllegalPayloadAccessException(
+ "This result completed exceptionally, payload is not available. "
+ + "Try calling 'exceptionResult' to see the cause of failure.",
+ exception
+ );
+ }
  return serializedPayload == null ? null : serializedPayload.getObject();
  }
 

axon-server-connector/src/main/java/org/axonframework/axonserver/connector/query/subscription/GrpcBackedQueryUpdateMessage.java

@@ -20,6 +20,7 @@
 import org.axonframework.axonserver.connector.ErrorCode;
 import org.axonframework.axonserver.connector.util.GrpcMetaData;
 import org.axonframework.axonserver.connector.util.GrpcSerializedObject;
+import org.axonframework.messaging.IllegalPayloadAccessException;
 import org.axonframework.messaging.MetaData;
 import org.axonframework.queryhandling.SubscriptionQueryUpdateMessage;
 import org.axonframework.serialization.LazyDeserializingObject;
@@ -88,6 +89,13 @@ public MetaData getMetaData() {
 
  @Override
  public U getPayload() {
+ if (isExceptional()) {
+ throw new IllegalPayloadAccessException(
+ "This result completed exceptionally, payload is not available. "
+ + "Try calling 'exceptionResult' to see the cause of failure.",
+ exception
+ );
+ }
  return serializedPayload == null ? null : serializedPayload.getObject();
  }
 

axon-server-connector/src/test/java/org/axonframework/axonserver/connector/query/GrpcBackedResponseMessageTest.java

@@ -18,6 +18,7 @@
 
 import io.axoniq.axonserver.grpc.query.QueryResponse;
 import org.axonframework.axonserver.connector.AxonServerConfiguration;
+import org.axonframework.messaging.IllegalPayloadAccessException;
 import org.axonframework.messaging.MetaData;
 import org.axonframework.queryhandling.GenericQueryResponseMessage;
 import org.axonframework.queryhandling.QueryResponseMessage;
@@ -79,7 +80,7 @@ void testGetPayloadReturnsAnIdenticalObjectAsInsertedThroughTheQueryResponseMess
  }
 
  @Test
- void testGetPayloadReturnsNullIfTheQueryResponseMessageDidNotContainAnyPayload() {
+ void testGetPayloadThrowIllegalPayloadExceptionIfTheQueryResponseMessageDidNotContainAnyPayload() {
  QueryResponseMessage<TestQueryResponse> testQueryResponseMessage =
  GenericQueryResponseMessage.asResponseMessage(
  TestQueryResponse.class, new IllegalArgumentException("some-exception")
@@ -89,7 +90,7 @@ TestQueryResponse.class, new IllegalArgumentException("some-exception")
  GrpcBackedResponseMessage<TestQueryResponse> testSubject =
  new GrpcBackedResponseMessage<>(testQueryResponse, serializer);
 
- assertNull(testSubject.getPayload());
+ assertThrows(IllegalPayloadAccessException.class, testSubject::getPayload);
  }
 
  @Test

axon-server-connector/src/test/java/org/axonframework/axonserver/connector/query/subscription/GrpcBackedQueryUpdateMessageTest.java

@@ -18,6 +18,7 @@
 
 import io.axoniq.axonserver.grpc.query.QueryUpdate;
 import org.axonframework.axonserver.connector.AxonServerConfiguration;
+import org.axonframework.messaging.IllegalPayloadAccessException;
 import org.axonframework.messaging.MetaData;
 import org.axonframework.queryhandling.GenericSubscriptionQueryUpdateMessage;
 import org.axonframework.queryhandling.SubscriptionQueryUpdateMessage;
@@ -27,9 +28,7 @@
 
 import java.util.Objects;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * Test all the functions provided on the {@link GrpcBackedQueryUpdateMessage}. The {@link QueryUpdate} to be passed to
@@ -96,6 +95,18 @@ void testGetPayloadTypeReturnsTheTypeOfTheInsertedQueryUpdate() {
  assertEquals(TestQueryUpdate.class, testSubject.getPayloadType());
  }
 
+ @Test
+ void testGetPayloadThrowsIllegalPayloadExceptionWhenUpdateIsExceptional() {
+ SubscriptionQueryUpdateMessage<TestQueryUpdate> testSubscriptionQueryUpdateMessage =
+ GenericSubscriptionQueryUpdateMessage.asUpdateMessage(TestQueryUpdate.class, new RuntimeException());
+ QueryUpdate testQueryUpdate =
+ subscriptionMessageSerializer.serialize(testSubscriptionQueryUpdateMessage);
+ GrpcBackedQueryUpdateMessage<TestQueryUpdate> testSubject =
+ new GrpcBackedQueryUpdateMessage<>(testQueryUpdate, serializer);
+
+ assertThrows(IllegalPayloadAccessException.class, testSubject::getPayload);
+ }
+
  @Test
  void testWithMetaDataCompletelyReplacesTheInitialMetaDataMap() {
  MetaData testMetaData = MetaData.with("some-key", "some-value");

messaging/src/main/java/org/axonframework/messaging/responsetypes/ConvertingResponseMessage.java

@@ -1,5 +1,6 @@
 package org.axonframework.messaging.responsetypes;
 
+import org.axonframework.messaging.IllegalPayloadAccessException;
 import org.axonframework.messaging.MetaData;
 import org.axonframework.queryhandling.QueryResponseMessage;
 import org.axonframework.serialization.SerializedObject;
@@ -74,6 +75,13 @@ public MetaData getMetaData() {
 
  @Override
  public R getPayload() {
+ if (isExceptional()) {
+ throw new IllegalPayloadAccessException(
+ "This result completed exceptionally, payload is not available. "
+ + "Try calling 'exceptionResult' to see the cause of failure.",
+ optionalExceptionResult().orElse(null)
+ );
+ }
  return expectedResponseType.convert(responseMessage.getPayload());
  }
 

messaging/src/main/java/org/axonframework/queryhandling/GenericSubscriptionQueryUpdateMessage.java

@@ -63,6 +63,19 @@ public static <T> SubscriptionQueryUpdateMessage<T> asUpdateMessage(Object paylo
  return new GenericSubscriptionQueryUpdateMessage<>((T) payload);
  }
 
+ /**
+ * Creates a {@link GenericSubscriptionQueryUpdateMessage} with the given {@code declaredType} and {@code exception}
+ * result.
+ *
+ * @param declaredType The declared type of the Subscription Query Update Message to be created
+ * @param exception The exception describing the cause of an error
+ * @param <T> type of the {@link GenericSubscriptionQueryUpdateMessage}
+ * @return a message containing exception result
+ */
+ public static <T> SubscriptionQueryUpdateMessage<T> asUpdateMessage(Class<T> declaredType, Throwable exception) {
+ return new GenericSubscriptionQueryUpdateMessage<>(declaredType, exception, MetaData.emptyInstance());
+ }
+
  /**
  * Initializes {@link GenericSubscriptionQueryUpdateMessage} with incremental update.
  *

messaging/src/test/java/org/axonframework/messaging/responsetypes/ConvertingResponseMessageTest.java

@@ -1,5 +1,6 @@
 package org.axonframework.messaging.responsetypes;
 
+import org.axonframework.messaging.IllegalPayloadAccessException;
 import org.axonframework.messaging.MetaData;
 import org.axonframework.queryhandling.GenericQueryResponseMessage;
 import org.axonframework.queryhandling.QueryResponseMessage;
@@ -8,7 +9,7 @@
 import java.util.List;
 
 import static java.util.Collections.singletonList;
-import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.*;
 
 class ConvertingResponseMessageTest {
 
@@ -24,4 +25,15 @@ void testPayloadIsConvertedToExpectedType() {
  assertEquals(singletonList("Some string result"), wrapped.getPayload());
  assertEquals("value", wrapped.getMetaData().get("test"));
  }
+
+ @Test
+ void testIllegalAccessPayloadWhenResultIsExceptional() {
+ QueryResponseMessage<?> msg = GenericQueryResponseMessage.asResponseMessage(List.class, new RuntimeException());
+ QueryResponseMessage<List<String>> wrapped = new ConvertingResponseMessage<>(
+ ResponseTypes.multipleInstancesOf(String.class),
+ msg);
+
+ assertEquals(List.class, wrapped.getPayloadType());
+ assertThrows(IllegalPayloadAccessException.class, wrapped::getPayload);
+ }
 }