Skip to content

fix(idempotency): record validation not using hash #1502

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 3 commits into from
Jun 15, 2023
Merged

fix(idempotency): record validation not using hash #1502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9fa0cc
fix: record validation
dreamorosi Jun 15, 2023
e49f7fc
tests: update unit
dreamorosi Jun 15, 2023
a4c95c2
chore: updated node types
dreamorosi Jun 15, 2023
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
19 changes: 16 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"@middy/core": "^3.6.2",
"@types/aws-lambda": "^8.10.109",
"@types/jest": "^29.2.4",
"@types/node": "^18.11.15",
"@types/node": "^18.16.18",
"@types/uuid": "^9.0.0",
"@typescript-eslint/eslint-plugin": "^5.46.1",
"@typescript-eslint/parser": "^5.46.1",
Expand Down
16 changes: 8 additions & 8 deletions packages/idempotency/src/persistence/BasePersistenceLayer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ abstract class BasePersistenceLayer implements BasePersistenceLayerInterface {
idempotencyKey: this.getHashedIdempotencyKey(data),
status: IdempotencyRecordStatus.INPROGRESS,
expiryTimestamp: this.getExpiryTimestamp(),
payloadHash: this.generateHash(JSON.stringify(data)),
payloadHash: this.getHashedPayload(data),
});

if (remainingTimeInMillis) {
Expand Down Expand Up @@ -167,7 +167,7 @@ abstract class BasePersistenceLayer implements BasePersistenceLayerInterface {
status: IdempotencyRecordStatus.COMPLETED,
expiryTimestamp: this.getExpiryTimestamp(),
responseData: result,
payloadHash: this.generateHash(JSON.stringify(data)),
payloadHash: this.getHashedPayload(data),
});

await this._updateRecord(idempotencyRecord);
Expand Down Expand Up @@ -264,13 +264,13 @@ abstract class BasePersistenceLayer implements BasePersistenceLayerInterface {
* @param data payload
*/
private getHashedPayload(data: Record<string, unknown>): string {
// This method is only called when payload validation is enabled.
// For payload validation to be enabled, the validation key jmespath must be set.
// Therefore, the assertion is safe.
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
data = search(data, this.validationKeyJmesPath!);
if (this.isPayloadValidationEnabled() && this.validationKeyJmesPath) {
data = search(data, this.validationKeyJmesPath);

return this.generateHash(JSON.stringify(data));
return this.generateHash(JSON.stringify(data));
} else {
return '';
}
}

private static isMissingIdempotencyKey(
Expand Down
3 changes: 2 additions & 1 deletion packages/idempotency/src/persistence/DynamoDBPersistenceLayer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class DynamoDBPersistenceLayer extends BasePersistenceLayer {
this.statusAttr = config.statusAttr ?? 'status';
this.expiryAttr = config.expiryAttr ?? 'expiration';
this.inProgressExpiryAttr =
config.inProgressExpiryAttr ?? 'in_progress_expiry_attr';
config.inProgressExpiryAttr ?? 'in_progress_expiration';
this.dataAttr = config.dataAttr ?? 'data';
this.validationKeyAttr = config.validationKeyAttr ?? 'validation';
if (config.sortKeyAttr === this.keyAttr) {
Expand Down Expand Up @@ -106,6 +106,7 @@ class DynamoDBPersistenceLayer extends BasePersistenceLayer {
expiryTimestamp: item[this.expiryAttr],
inProgressExpiryTimestamp: item[this.inProgressExpiryAttr],
responseData: item[this.dataAttr],
payloadHash: item[this.validationKeyAttr],
});
}

Expand Down
4 changes: 2 additions & 2 deletions packages/idempotency/tests/unit/persistence/BasePersistenceLayer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ describe('Class: BasePersistenceLayer', () => {
idempotencyKey: 'my-lambda-function#mocked-hash',
status: IdempotencyRecordStatus.INPROGRESS,
expiryTimestamp: Date.now() / 1000 + 3600,
payloadHash: 'mocked-hash',
payloadHash: '',
inProgressExpiryTimestamp: Date.now() + remainingTimeInMs,
responseData: undefined,
})
Expand Down Expand Up @@ -455,7 +455,7 @@ describe('Class: BasePersistenceLayer', () => {
idempotencyKey: 'my-lambda-function#mocked-hash',
status: IdempotencyRecordStatus.COMPLETED,
expiryTimestamp: Date.now() / 1000 + 3600,
payloadHash: 'mocked-hash',
payloadHash: '',
inProgressExpiryTimestamp: undefined,
responseData: result,
})
Expand Down
46 changes: 38 additions & 8 deletions packages/idempotency/tests/unit/persistence/DynamoDbPersistenceLayer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
keyAttr: 'id',
statusAttr: 'status',
expiryAttr: 'expiration',
inProgressExpiryAttr: 'in_progress_expiry_attr',
inProgressExpiryAttr: 'in_progress_expiration',
dataAttr: 'data',
validationKeyAttr: 'validation',
staticPkValue: 'idempotency#my-lambda-function',
Expand Down Expand Up @@ -230,7 +230,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
'#id': 'id',
'#expiry': 'expiration',
'#status': 'status',
'#in_progress_expiry': 'in_progress_expiry_attr',
'#in_progress_expiry': 'in_progress_expiration',
},
ExpressionAttributeValues: marshall({
':now': Date.now() / 1000,
Expand Down Expand Up @@ -273,7 +273,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
'#id': 'id',
'#expiry': 'expiration',
'#status': 'status',
'#in_progress_expiry': 'in_progress_expiry_attr',
'#in_progress_expiry': 'in_progress_expiration',
},
ExpressionAttributeValues: marshall({
':now': Date.now() / 1000,
Expand Down Expand Up @@ -310,13 +310,13 @@ describe('Class: DynamoDBPersistenceLayer', () => {
id: dummyKey,
expiration: expiryTimestamp,
status,
in_progress_expiry_attr: inProgressExpiryTimestamp,
in_progress_expiration: inProgressExpiryTimestamp,
}),
ExpressionAttributeNames: {
'#id': 'id',
'#expiry': 'expiration',
'#status': 'status',
'#in_progress_expiry': 'in_progress_expiry_attr',
'#in_progress_expiry': 'in_progress_expiration',
},
ExpressionAttributeValues: marshall({
':now': Date.now() / 1000,
Expand Down Expand Up @@ -361,7 +361,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
'#id': 'id',
'#expiry': 'expiration',
'#status': 'status',
'#in_progress_expiry': 'in_progress_expiry_attr',
'#in_progress_expiry': 'in_progress_expiration',
},
ExpressionAttributeValues: marshall({
':now': Date.now() / 1000,
Expand Down Expand Up @@ -433,7 +433,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
id: dummyKey,
status: IdempotencyRecordStatus.INPROGRESS,
expiration: getFutureTimestamp(15),
in_progress_expiry_attr: getFutureTimestamp(10),
in_progress_expiration: getFutureTimestamp(10),
data: {},
}),
});
Expand Down Expand Up @@ -465,7 +465,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
id: dummyKey,
status,
expiration: expiryTimestamp,
in_progress_expiry_attr: inProgressExpiryTimestamp,
in_progress_expiration: inProgressExpiryTimestamp,
data: responseData,
}),
});
Expand Down Expand Up @@ -526,6 +526,36 @@ describe('Class: DynamoDBPersistenceLayer', () => {
ConsistentRead: true,
});
});

test('when called with a record that had the ', async () => {
// Prepare
const persistenceLayer = new TestDynamoDBPersistenceLayer({
tableName: dummyTableName,
staticPkValue: 'idempotency#my-lambda-function',
sortKeyAttr: 'sortKey',
});
client.on(GetItemCommand).resolves({
Item: marshall({
id: dummyKey,
status: IdempotencyRecordStatus.INPROGRESS,
expiration: getFutureTimestamp(15),
in_progress_expiration: getFutureTimestamp(10),
data: {},
validation: 'someHash',
}),
});

// Act
const record = await persistenceLayer._getRecord(dummyKey);

// Assess
expect(record.idempotencyKey).toEqual(dummyKey);
expect(record.getStatus()).toEqual(IdempotencyRecordStatus.INPROGRESS);
expect(record.expiryTimestamp).toEqual(getFutureTimestamp(15));
expect(record.inProgressExpiryTimestamp).toEqual(getFutureTimestamp(10));
expect(record.responseData).toStrictEqual({});
expect(record.payloadHash).toEqual('someHash');
});
});

describe('Method: _updateRecord', () => {
Expand Down