Skip to content

feat(parser): add support for tumbling windows in Kinesis and DynamoDB events #3931

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 7 commits into from
May 19, 2025
Merged

feat(parser): add support for tumbling windows in Kinesis and DynamoDB events #3931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e46324b
update comment
kiitosu May 15, 2025
39093e2
add parameters to kinesis stream
kiitosu May 15, 2025
5e45e1c
add parameters to dynamodb stream
kiitosu May 15, 2025
caf5478
Merge branch 'main' into add_tumbling_window_parameters
dreamorosi May 15, 2025
6039e6a
chore: fix kinesis types + test + docstrings
dreamorosi May 16, 2025
268b744
Merge branch 'main' into add_tumbling_window_parameters
dreamorosi May 16, 2025
dd65cbb
Merge branch 'main' into add_tumbling_window_parameters
dreamorosi May 19, 2025
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
157 changes: 101 additions & 56 deletions packages/parser/src/schemas/dynamodb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,69 +151,103 @@ const DynamoDBStreamToKinesisRecord = DynamoDBStreamRecord.extend({
* @example
* ```json
* {
* "Records": [
* {
* "eventID": "1",
* "eventVersion": "1.0",
* "dynamodb": {
* "ApproximateCreationDateTime": 1693997155.0,
* "Keys": {
* "Id": {
* "N": "101"
* }
* },
* "NewImage": {
* "Message": {
* "S": "New item!"
* },
* "Id": {
* "N": "101"
* }
* "Records":[{
* "eventID":"1",
* "eventName":"INSERT",
* "eventVersion":"1.0",
* "eventSource":"aws:dynamodb",
* "awsRegion":"us-east-1",
* "dynamodb":{
* "Keys":{
* "Id":{
* "N":"101"
* }
* },
* "NewImage":{
* "Message":{
* "S":"New item!"
* },
* "StreamViewType": "NEW_AND_OLD_IMAGES",
* "SequenceNumber": "111",
* "SizeBytes": 26
* "Id":{
* "N":"101"
* }
* },
* "awsRegion": "us-west-2",
* "eventName": "INSERT",
* "eventSourceARN": "eventsource_arn",
* "eventSource": "aws:dynamodb"
* "SequenceNumber":"111",
* "SizeBytes":26,
* "StreamViewType":"NEW_AND_OLD_IMAGES"
* },
* {
* "eventID": "2",
* "eventVersion": "1.0",
* "dynamodb": {
* "OldImage": {
* "Message": {
* "S": "New item!"
* },
* "Id": {
* "N": "101"
* }
* "eventSourceARN":"stream-ARN"
* },
* {
* "eventID":"2",
* "eventName":"MODIFY",
* "eventVersion":"1.0",
* "eventSource":"aws:dynamodb",
* "awsRegion":"us-east-1",
* "dynamodb":{
* "Keys":{
* "Id":{
* "N":"101"
* }
* },
* "NewImage":{
* "Message":{
* "S":"This item has changed"
* },
* "SequenceNumber": "222",
* "Keys": {
* "Id": {
* "N": "101"
* }
* "Id":{
* "N":"101"
* }
* },
* "OldImage":{
* "Message":{
* "S":"New item!"
* },
* "SizeBytes": 59,
* "NewImage": {
* "Message": {
* "S": "This item has changed"
* },
* "Id": {
* "N": "101"
* }
* "Id":{
* "N":"101"
* }
* },
* "SequenceNumber":"222",
* "SizeBytes":59,
* "StreamViewType":"NEW_AND_OLD_IMAGES"
* },
* "eventSourceARN":"stream-ARN"
* },
* {
* "eventID":"3",
* "eventName":"REMOVE",
* "eventVersion":"1.0",
* "eventSource":"aws:dynamodb",
* "awsRegion":"us-east-1",
* "dynamodb":{
* "Keys":{
* "Id":{
* "N":"101"
* }
* },
* "OldImage":{
* "Message":{
* "S":"This item has changed"
* },
* "StreamViewType": "NEW_AND_OLD_IMAGES"
* "Id":{
* "N":"101"
* }
* },
* "awsRegion": "us-west-2",
* "eventName": "MODIFY",
* "eventSourceARN": "source_arn",
* "eventSource": "aws:dynamodb"
* }
* ]
* "SequenceNumber":"333",
* "SizeBytes":38,
* "StreamViewType":"NEW_AND_OLD_IMAGES"
* },
* "eventSourceARN":"stream-ARN"
* }],
* "window": {
* "start": "2020-07-30T17:00:00Z",
* "end": "2020-07-30T17:05:00Z"
* },
* "state": {
* "1": "state1"
* },
* "shardId": "shard123456789",
* "eventSourceARN": "stream-ARN",
* "isFinalInvokeForWindow": false,
* "isWindowTerminatedEarly": false
* }
* ```
*
Expand All @@ -222,6 +256,17 @@ const DynamoDBStreamToKinesisRecord = DynamoDBStreamRecord.extend({
*/
const DynamoDBStreamSchema = z.object({
Records: z.array(DynamoDBStreamRecord).min(1),
window: z
.object({
start: z.string().datetime(),
end: z.string().datetime(),
})
.optional(),
state: z.record(z.string(), z.string()).optional(),
shardId: z.string().optional(),
eventSourceARN: z.string().optional(),
isFinalInvokeForWindow: z.boolean().optional(),
isWindowTerminatedEarly: z.boolean().optional(),
});

export {
Expand Down
51 changes: 29 additions & 22 deletions packages/parser/src/schemas/kinesis.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,41 +70,48 @@ const KinesisDynamoDBStreamSchema = z.object({
* "partitionKey": "1",
* "sequenceNumber": "49590338271490256608559692538361571095921575989136588898",
* "data": "SGVsbG8sIHRoaXMgaXMgYSB0ZXN0Lg==",
* "approximateArrivalTimestamp": 1545084650.987
* "approximateArrivalTimestamp": 1607497475.000
* },
* "eventSource": "aws:kinesis",
* "eventVersion": "1.0",
* "eventID": "shardId-000000000006:49590338271490256608559692538361571095921575989136588898",
* "eventName": "aws:kinesis:record",
* "invokeIdentityArn": "arn:aws:iam::123456789012:role/lambda-role",
* "awsRegion": "us-east-2",
* "eventSourceARN": "arn:aws:kinesis:us-east-2:123456789012:stream/lambda-stream"
* },
* {
* "kinesis": {
* "kinesisSchemaVersion": "1.0",
* "partitionKey": "1",
* "sequenceNumber": "49590338271490256608559692540925702759324208523137515618",
* "data": "VGhpcyBpcyBvbmx5IGEgdGVzdC4=",
* "approximateArrivalTimestamp": 1545084711.166
* },
* "eventSource": "aws:kinesis",
* "eventVersion": "1.0",
* "eventID": "shardId-000000000006:49590338271490256608559692540925702759324208523137515618",
* "eventName": "aws:kinesis:record",
* "invokeIdentityArn": "arn:aws:iam::123456789012:role/lambda-role",
* "awsRegion": "us-east-2",
* "eventSourceARN": "arn:aws:kinesis:us-east-2:123456789012:stream/lambda-stream"
* "invokeIdentityArn": "arn:aws:iam::123456789012:role/lambda-kinesis-role",
* "awsRegion": "us-east-1",
* "eventSourceARN": "arn:aws:kinesis:us-east-1:123456789012:stream/lambda-stream"
* }
* ]
* ],
* "window": {
* "start": "2020-12-09T07:04:00Z",
* "end": "2020-12-09T07:06:00Z"
* },
* "state": {
* "1": 282,
* "2": 715
* },
* "shardId": "shardId-000000000006",
* "eventSourceARN": "arn:aws:kinesis:us-east-1:123456789012:stream/lambda-stream",
* "isFinalInvokeForWindow": false,
* "isWindowTerminatedEarly": false
* }
*```
* @see {@link types.KinesisDataStreamEvent | KinesisDataStreamEvent}
* @see {@link https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-event-example}
* @see {@link https://docs.aws.amazon.com/lambda/latest/dg/services-kinesis-windows.html#streams-tumbling-processing}
*
*/
const KinesisDataStreamSchema = z.object({
Records: z.array(KinesisDataStreamRecord).min(1),
window: z
.object({
start: z.string().datetime(),
end: z.string().datetime(),
})
.optional(),
state: z.record(z.string(), z.unknown()).optional(),
shardId: z.string().optional(),
eventSourceARN: z.string().optional(),
isFinalInvokeForWindow: z.boolean().optional(),
isWindowTerminatedEarly: z.boolean().optional(),
});

export {
Expand Down
81 changes: 81 additions & 0 deletions packages/parser/tests/unit/schema/dynamodb.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,85 @@ describe('Schema: DynamoDB', () => {
// Act & Assess
expect(() => DynamoDBStreamSchema.parse(event)).toThrow();
});

it('parses a DynamoDB Stream with tumbling window event', () => {
// Prepare
const event = structuredClone(baseEvent);
event.window = {
start: '2020-07-30T17:00:00Z',
end: '2020-07-30T17:05:00Z',
};
event.state = {
'1': 'state1',
};
event.shardId = 'shard123456789';
event.eventSourceARN = 'stream-ARN';
event.isFinalInvokeForWindow = false;
event.isWindowTerminatedEarly = false;

// Act
const result = DynamoDBStreamSchema.parse(event);

// Assess
expect(result).toStrictEqual({
Records: [
{
eventID: '1',
eventVersion: '1.0',
dynamodb: {
ApproximateCreationDateTime: 1693997155.0,
Keys: {
Id: 101,
},
NewImage: {
Message: 'New item!',
Id: 101,
},
StreamViewType: 'NEW_IMAGE',
SequenceNumber: '111',
SizeBytes: 26,
},
awsRegion: 'us-west-2',
eventName: 'INSERT',
eventSourceARN: 'eventsource_arn',
eventSource: 'aws:dynamodb',
},
{
eventID: '2',
eventVersion: '1.0',
dynamodb: {
OldImage: {
Message: 'New item!',
Id: 101,
},
SequenceNumber: '222',
Keys: {
Id: 101,
},
SizeBytes: 59,
NewImage: {
Message: 'This item has changed',
Id: 101,
},
StreamViewType: 'NEW_AND_OLD_IMAGES',
},
awsRegion: 'us-west-2',
eventName: 'MODIFY',
eventSourceARN: 'source_arn',
eventSource: 'aws:dynamodb',
},
],
window: {
start: '2020-07-30T17:00:00Z',
end: '2020-07-30T17:05:00Z',
},
state: {
'1': 'state1',
},
shardId: 'shard123456789',
eventSourceARN: 'stream-ARN',
isFinalInvokeForWindow: false,
isWindowTerminatedEarly: false,
});
});
});
35 changes: 35 additions & 0 deletions packages/parser/tests/unit/schema/kinesis.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,41 @@ describe('Schema: Kinesis', () => {
expect(parsed).toStrictEqual(transformedInput);
});

it('parses Kinesis event with tumbling window', () => {
// Prepare
const testEvent = structuredClone(kinesisStreamEvent);
testEvent.window = {
start: '2020-07-30T17:00:00Z',
end: '2020-07-30T17:05:00Z',
};
testEvent.state = {
'1': 'state1',
};
testEvent.shardId = 'shard123456789';
testEvent.eventSourceARN = 'stream-ARN';
testEvent.isFinalInvokeForWindow = false;
testEvent.isWindowTerminatedEarly = false;

// Act
const parsed = KinesisDataStreamSchema.parse(testEvent);

const transformedInput = {
...testEvent,
Records: testEvent.Records.map((record, index) => {
return {
...record,
kinesis: {
...record.kinesis,
data: Buffer.from(record.kinesis.data, 'base64').toString(),
},
};
}),
};

// Assess
expect(parsed).toStrictEqual(transformedInput);
});

it('throws if cannot parse SQS record of KinesisFirehoseSqsRecord', () => {
// Prepare
const testEvent = getTestEvent<KinesisFireHoseSqsEvent>({
Expand Down
Loading