fix #1200

powertools-idempotency/src/main/java/software/amazon/lambda/powertools/idempotency/exceptions/NullIdempotencyKeyException.java

@@ -0,0 +1,12 @@
+package software.amazon.lambda.powertools.idempotency.exceptions;
+
+/**
+ * Exception that occurs when the Idepmpotency Key is null or could not be found with the provided JMESPath
+ */
+public class NullIdempotencyKeyException extends Exception {
+ private static final long serialVersionUID = 5115004524004542891L;
+
+ public NullIdempotencyKeyException(String message) {
+ super(message);
+ }
+}

powertools-idempotency/src/main/java/software/amazon/lambda/powertools/idempotency/internal/IdempotencyHandler.java

@@ -84,7 +84,9 @@ private Object processIdempotency() throws Throwable {
  persistenceStore.saveInProgress(data, Instant.now(), getRemainingTimeInMillis());
  } catch (IdempotencyItemAlreadyExistsException iaee) {
  DataRecord record = getIdempotencyRecord();
- return handleForStatus(record);
+ if (record != null) {
+ return handleForStatus(record);
+ }
  } catch (IdempotencyKeyException ike) {
  throw ike;
  } catch (Exception e) {
@@ -111,7 +113,7 @@ private OptionalInt getRemainingTimeInMillis() {
  /**
  * Retrieve the idempotency record from the persistence layer.
  *
- * @return the record if available
+ * @return the record if available, potentially null
  */
  private DataRecord getIdempotencyRecord() {
  try {

powertools-idempotency/src/main/java/software/amazon/lambda/powertools/idempotency/persistence/BasePersistenceStore.java

@@ -21,10 +21,7 @@
 import org.slf4j.LoggerFactory;
 import software.amazon.awssdk.utils.StringUtils;
 import software.amazon.lambda.powertools.idempotency.IdempotencyConfig;
-import software.amazon.lambda.powertools.idempotency.exceptions.IdempotencyItemAlreadyExistsException;
-import software.amazon.lambda.powertools.idempotency.exceptions.IdempotencyItemNotFoundException;
-import software.amazon.lambda.powertools.idempotency.exceptions.IdempotencyKeyException;
-import software.amazon.lambda.powertools.idempotency.exceptions.IdempotencyValidationException;
+import software.amazon.lambda.powertools.idempotency.exceptions.*;
 import software.amazon.lambda.powertools.idempotency.internal.cache.LRUCache;
 import software.amazon.lambda.powertools.utilities.JsonConfig;
 
@@ -34,12 +31,8 @@
 import java.security.NoSuchAlgorithmException;
 import java.time.Instant;
 import java.time.temporal.ChronoUnit;
-import java.util.Map;
-import java.util.OptionalLong;
-import java.util.OptionalInt;
+import java.util.*;
 import java.util.stream.Stream;
-import java.util.Spliterators;
-import java.util.Spliterator;
 import java.util.stream.StreamSupport;
 
 import static software.amazon.lambda.powertools.core.internal.LambdaConstants.LAMBDA_FUNCTION_NAME_ENV;
@@ -130,6 +123,9 @@ public void saveSuccess(JsonNode data, Object result, Instant now) {
  } catch (JsonProcessingException e) {
  // TODO : throw ?
  throw new RuntimeException("Error while serializing the response", e);
+ } catch (NullIdempotencyKeyException e) {
+ // missing idempotency key => non-idempotent transaction, we do not store the data, simply return
+ return;
  }
  }
 
@@ -140,7 +136,13 @@ public void saveSuccess(JsonNode data, Object result, Instant now) {
  * @param now
  */
  public void saveInProgress(JsonNode data, Instant now, OptionalInt remainingTimeInMs) throws IdempotencyItemAlreadyExistsException {
- String idempotencyKey = getHashedIdempotencyKey(data);
+ String idempotencyKey;
+ try {
+ idempotencyKey = getHashedIdempotencyKey(data);
+ } catch (NullIdempotencyKeyException e) {
+ // missing idempotency key => non-idempotent transaction, we do not store the data, simply return
+ return;
+ }
 
  if (retrieveFromCache(idempotencyKey, now) != null) {
  throw new IdempotencyItemAlreadyExistsException();
@@ -170,7 +172,13 @@ public void saveInProgress(JsonNode data, Instant now, OptionalInt remainingTime
  * @param throwable The throwable thrown by the function
  */
  public void deleteRecord(JsonNode data, Throwable throwable) {
- String idemPotencyKey = getHashedIdempotencyKey(data);
+ String idemPotencyKey;
+ try {
+ idemPotencyKey = getHashedIdempotencyKey(data);
+ } catch (NullIdempotencyKeyException e) {
+ // missing idempotency key => non-idempotent transaction, we do not delete the data, simply return
+ return;
+ }
 
  LOG.debug("Function raised an exception {}. " +
  "Clearing in progress record in persistence store for idempotency key: {}",
@@ -190,7 +198,13 @@ public void deleteRecord(JsonNode data, Throwable throwable) {
  * @throws IdempotencyItemNotFoundException Exception thrown if no record exists in persistence store with the idempotency key
  */
  public DataRecord getRecord(JsonNode data, Instant now) throws IdempotencyValidationException, IdempotencyItemNotFoundException {
- String idemPotencyKey = getHashedIdempotencyKey(data);
+ String idemPotencyKey;
+ try {
+ idemPotencyKey = getHashedIdempotencyKey(data);
+ } catch (NullIdempotencyKeyException e) {
+ // missing idempotency key => non-idempotent transaction, we do not get the data, simply return nothing
+ return null;
+ }
 
  DataRecord cachedRecord = retrieveFromCache(idemPotencyKey, now);
  if (cachedRecord != null) {
@@ -211,7 +225,7 @@ public DataRecord getRecord(JsonNode data, Instant now) throws IdempotencyValida
  * @param data incoming data
  * @return Hashed representation of the data extracted by the jmespath expression
  */
- private String getHashedIdempotencyKey(JsonNode data) {
+ private String getHashedIdempotencyKey(JsonNode data) throws NullIdempotencyKeyException {
  JsonNode node = data;
 
  if (eventKeyJMESPath != null) {
@@ -221,8 +235,10 @@ private String getHashedIdempotencyKey(JsonNode data) {
  if (isMissingIdemPotencyKey(node)) {
  if (throwOnNoIdempotencyKey) {
  throw new IdempotencyKeyException("No data found to create a hashed idempotency key");
+ } else {
+ LOG.warn("No data found to create a hashed idempotency key. JMESPath: {}", eventKeyJMESPath);
+ throw new NullIdempotencyKeyException("No data found to create a hashed idempotency key");
  }
- LOG.warn("No data found to create a hashed idempotency key. JMESPath: {}", eventKeyJMESPath);
  }
 
  String hash = generateHash(node);

powertools-idempotency/src/test/java/software/amazon/lambda/powertools/idempotency/persistence/BasePersistenceStoreTest.java

@@ -143,15 +143,15 @@ public void saveInProgress_jmespath_NotFound_shouldThrowException() {
  }
 
  @Test
- public void saveInProgress_jmespath_NotFound_shouldNotThrowException() {
+ public void saveInProgress_jmespath_NotFound_shouldNotPersist() {
  APIGatewayProxyRequestEvent event = EventLoader.loadApiGatewayRestEvent("apigw_event.json");
  persistenceStore.configure(IdempotencyConfig.builder()
  .withEventKeyJMESPath("unavailable")
  .build(), "");
  Instant now = Instant.now();
  persistenceStore.saveInProgress(JsonConfig.get().getObjectMapper().valueToTree(event), now, OptionalInt.empty());
- assertThat(dr.getStatus()).isEqualTo(DataRecord.Status.INPROGRESS);
- assertThat(status).isEqualTo(1);
+ assertThat(dr).isNull();
+ assertThat(status).isEqualTo(-1);
  }
 
  @Test