Class BasePersistenceLayerAbstract

constructor

• new BasePersistenceLayer(): BasePersistenceLayer

• Returns BasePersistenceLayer

idempotencyKeyPrefix

configure

• configure(config: BasePersistenceLayerOptions): void

• Initialize the base persistence layer from the configuration settings

  Parameters

  • config: BasePersistenceLayerOptions

    configuration object for the persistence layer

  Returns void

deleteRecord

• deleteRecord(data: JSONValue): Promise<void>

• Deletes a record from the persistence store for the persistence key generated from the data passed in.

  Parameters

  • data: JSONValue

    the data payload that will be hashed to create the hash portion of the idempotency key

  Returns Promise<void>

getExpiresAfterSeconds

• getExpiresAfterSeconds(): number

• Retrieve the number of seconds that records will be kept in the persistence store

  Returns number

getRecord

• getRecord(data: JSONValue): Promise<IdempotencyRecord>

• Retrieves idempotency key for the provided data and fetches data for that key from the persistence store

  Parameters

  • data: JSONValue

    the data payload that will be hashed to create the hash portion of the idempotency key

  Returns Promise<IdempotencyRecord>

isPayloadValidationEnabled

• isPayloadValidationEnabled(): boolean

• Check whether payload validation is enabled or not

  Returns boolean

processExistingRecord

• processExistingRecord(
      storedDataRecord: IdempotencyRecord,
      processedData: JSONValue | IdempotencyRecord,
  ): IdempotencyRecord

• Validates an existing record against the data payload being processed. If the payload does not match the stored record, an IdempotencyValidationError error is thrown.

  Whenever a record is retrieved from the persistence layer, it should be validated against the data payload being processed. This is to ensure that the data payload being processed is the same as the one that was used to create the record in the first place.

  The record is also saved to the local cache if local caching is enabled.

  Parameters

  • storedDataRecord: IdempotencyRecord

    the stored record to validate against
  • processedData: JSONValue | IdempotencyRecord

    the data payload being processed and to be validated against the stored record

  Returns IdempotencyRecord

saveInProgress

• saveInProgress(data: JSONValue, remainingTimeInMillis?: number): Promise<void>

• Saves a record indicating that the function's execution is currently in progress

  Parameters

  • data: JSONValue

    the data payload that will be hashed to create the hash portion of the idempotency key
  • OptionalremainingTimeInMillis: number

    the remaining time left in the lambda execution context

  Returns Promise<void>

saveSuccess

• saveSuccess(data: JSONValue, result: JSONValue): Promise<void>

• Saves a record of the function completing successfully. This will create a record with a COMPLETED status and will save the result of the completed function in the idempotency record.

  Parameters

  • data: JSONValue

    the data payload that will be hashed to create the hash portion of the idempotency key
  • result: JSONValue

    the result of the successfully completed function

  Returns Promise<void>