Skip to content
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

fix(analytics-browser): should send batches sequentially #935

Merged
merged 1 commit into from
Dec 17, 2024
Merged

fix(analytics-browser): should send batches sequentially #935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion packages/analytics-core/src/plugins/destination.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,12 @@ export class Destination implements DestinationPlugin {

const batches = chunk(list, this.config.flushQueueSize);

await Promise.all(batches.map((batch) => this.send(batch, useRetry)));
// Promise.all() doesn't guarantee resolve order.
// Sequentially resolve to make sure backend receives events in order
await batches.reduce(async (promise, batch) => {
Mercy811 marked this conversation as resolved.
Show resolved Hide resolved
await promise;
return await this.send(batch, useRetry);
}, Promise.resolve());
Comment on lines +156 to +159
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just noticed that it's auto changed by Intellij

I had

await batches.reduce(
      (promise, batch) => {
        return promise.then(() => this.send(batch, useRetry))
      },
      Promise.resolve()
    );

After clicking that "convert to async function", it updated to what we have here.
image

I was expecting to have

await batches.reduce(
      async (promise, batch) => {
        await promise;
        return this.send(batch, false);
      },
      Promise.resolve()
    );

It's still working although a little bit redundant. Should clean it in AMP-120671.


this.scheduleTryable(later);
}
Expand Down
56 changes: 54 additions & 2 deletions packages/analytics-core/test/plugins/destination.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,57 @@ describe('destination', () => {
expect(result).toBe(undefined);
expect(send).toHaveBeenCalledTimes(0);
});
test('should send batches in order', async () => {
const destination = new Destination();
destination.config = {
...useDefaultConfig(),
flushQueueSize: 1,
};

const context1 = {
event: { event_type: 'event_type_1' },
attempts: 0,
callback: () => undefined,
timeout: 0,
};
const context2 = {
event: { event_type: 'event_type_2' },
attempts: 0,
callback: () => undefined,
timeout: 0,
};
destination.queue = [context1, context2];

const resolveOrder: number[] = [];
const send = jest
.spyOn(destination, 'send')
.mockImplementationOnce(
() =>
new Promise((resolve) =>
setTimeout(() => {
resolveOrder.push(1);
resolve();
}, 1000),
),
) // 1st call resolves in 1 sec
.mockImplementationOnce(
() =>
new Promise((resolve) =>
setTimeout(() => {
resolveOrder.push(2);
resolve();
}, 500),
),
); // 2nd call resolves in 0.5 sec

const result = await destination.flush();

expect(result).toBe(undefined);
expect(send).toHaveBeenNthCalledWith(1, [context1], false);
expect(send).toHaveBeenNthCalledWith(2, [context2], false);
expect(send).toHaveBeenCalledTimes(2);
expect(resolveOrder).toEqual([1, 2]);
});
});

describe('send', () => {
Expand Down Expand Up @@ -1233,9 +1284,10 @@ describe('destination', () => {
code: 200,
});

expect(transportProvider.send).toHaveBeenCalledTimes(eventCount + 1);
// When 413, retry of the second batch won't be recorded here as it's async
expect(transportProvider.send).toHaveBeenCalledTimes(2);
// eslint-disable-next-line @typescript-eslint/unbound-method
expect(loggerProvider.warn).toHaveBeenCalledTimes(eventCount);
expect(loggerProvider.warn).toHaveBeenCalledTimes(1);
// eslint-disable-next-line @typescript-eslint/unbound-method,@typescript-eslint/restrict-template-expressions
expect(loggerProvider.warn).toHaveBeenCalledWith(jsons(response.body));
},
Expand Down
Loading