Skip to content

fix(analytics): add validation for flushInterval #12498

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

Draft
wants to merge 2 commits into
base: next/main
Choose a base branch
from
Draft

fix(analytics): add validation for flushInterval #12498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1da98e7
fix(analytics): add validation for flushInterval bottom
Nov 2, 2023
917ea48
fix(analytics): periodically submit events with recursive setTimeout
Nov 2, 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
14 changes: 14 additions & 0 deletions packages/analytics/__tests__/providers/kinesis-firehose/utils/resolveConfig.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import { Amplify } from '@aws-amplify/core';
import { resolveConfig } from '../../../../src/providers/kinesis-firehose/utils';
import { DEFAULT_KINESIS_FIREHOSE_CONFIG } from '../../../../src/providers/kinesis-firehose/utils/constants';
import { FLUSH_INTERVAL_MIN } from '../../../../src/utils/constants';

describe('Analytics KinesisFirehose Provider Util: resolveConfig', () => {
const providedConfig = {
Expand Down Expand Up @@ -65,4 +66,17 @@ describe('Analytics KinesisFirehose Provider Util: resolveConfig', () => {

expect(resolveConfig).toThrow();
});

it('throws if flushInterval is smaller than min', () => {
getConfigSpy.mockReturnValue({
Analytics: {
KinesisFirehose: {
...providedConfig,
flushInterval: FLUSH_INTERVAL_MIN - 1,
},
},
});

expect(resolveConfig).toThrow();
});
});
11 changes: 11 additions & 0 deletions packages/analytics/__tests__/providers/kinesis/utils/resolveConfig.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import { Amplify } from '@aws-amplify/core';
import { resolveConfig } from '../../../../src/providers/kinesis/utils/resolveConfig';
import { DEFAULT_KINESIS_CONFIG } from '../../../../src/providers/kinesis/utils/constants';
import { FLUSH_INTERVAL_MIN } from '../../../../src/utils/constants';

describe('Analytics Kinesis Provider Util: resolveConfig', () => {
const kinesisConfig = {
Expand Down Expand Up @@ -62,4 +63,14 @@ describe('Analytics Kinesis Provider Util: resolveConfig', () => {

expect(resolveConfig).toThrow();
});

it('throws if flushInterval is smaller than min', () => {
getConfigSpy.mockReturnValue({
Analytics: {
Kinesis: { ...kinesisConfig, flushInterval: FLUSH_INTERVAL_MIN - 1 },
},
});

expect(resolveConfig).toThrow();
});
});
14 changes: 14 additions & 0 deletions packages/analytics/__tests__/providers/personalize/utils/resolveConfig.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
DEFAULT_PERSONALIZE_CONFIG,
PERSONALIZE_FLUSH_SIZE_MAX,
} from '../../../../src/providers/personalize/utils';
import { FLUSH_INTERVAL_MIN } from '../../../../src/utils/constants';

describe('Analytics Personalize Provider Util: resolveConfig', () => {
const providedConfig = {
Expand Down Expand Up @@ -70,4 +71,17 @@ describe('Analytics Personalize Provider Util: resolveConfig', () => {

expect(resolveConfig).toThrow();
});

it('throws if flushInterval is smaller than min', () => {
getConfigSpy.mockReturnValue({
Analytics: {
Personalize: {
...providedConfig,
flushInterval: FLUSH_INTERVAL_MIN - 1,
},
},
});

expect(resolveConfig).toThrow();
});
});
20 changes: 12 additions & 8 deletions packages/analytics/src/errors/validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ export enum AnalyticsValidationErrorCode {
NoCredentials = 'NoCredentials',
NoEventName = 'NoEventName',
NoRegion = 'NoRegion',
InvalidTracker = 'InvalidTracker',
UnsupportedPlatform = 'UnsupportedPlatform',
NoTrackingId = 'NoTrackingId',
InvalidFlushInterval = 'InvalidFlushInterval',
InvalidFlushSize = 'InvalidFlushSize',
InvalidTracker = 'InvalidTracker',
UnsupportedPlatform = 'UnsupportedPlatform',
}

export const validationErrorMap: AmplifyErrorMap<AnalyticsValidationErrorCode> =
Expand All @@ -28,16 +29,19 @@ export const validationErrorMap: AmplifyErrorMap<AnalyticsValidationErrorCode> =
[AnalyticsValidationErrorCode.NoRegion]: {
message: 'Missing region.',
},
[AnalyticsValidationErrorCode.NoTrackingId]: {
message: 'A trackingId is required to use Amazon Personalize.',
},
[AnalyticsValidationErrorCode.InvalidFlushInterval]: {
message: 'Invalid FlushInterval.',
},
[AnalyticsValidationErrorCode.InvalidFlushSize]: {
message: 'Invalid FlushSize, it should be smaller than BufferSize.',
},
[AnalyticsValidationErrorCode.InvalidTracker]: {
message: 'Invalid tracker type specified.',
},
[AnalyticsValidationErrorCode.UnsupportedPlatform]: {
message: 'Only session tracking is supported on React Native.',
},
[AnalyticsValidationErrorCode.InvalidFlushSize]: {
message: 'Invalid FlushSize, it should be smaller than BufferSize',
},
[AnalyticsValidationErrorCode.NoTrackingId]: {
message: 'A trackingId is required to use Amazon Personalize',
},
};
7 changes: 7 additions & 0 deletions packages/analytics/src/providers/kinesis-firehose/utils/resolveConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
assertValidationError,
} from '../../../errors';
import { DEFAULT_KINESIS_FIREHOSE_CONFIG } from './constants';
import { FLUSH_INTERVAL_MIN } from '../../../utils/constants';

export const resolveConfig = () => {
const config = Amplify.getConfig().Analytics?.KinesisFirehose;
Expand All @@ -26,6 +27,12 @@ export const resolveConfig = () => {
flushSize < bufferSize,
AnalyticsValidationErrorCode.InvalidFlushSize
);
assertValidationError(
flushInterval >= FLUSH_INTERVAL_MIN,
AnalyticsValidationErrorCode.InvalidFlushInterval,
`FlushInterval should be greater than or equal to ${FLUSH_INTERVAL_MIN} milliseconds`
);

return {
region,
bufferSize,
Expand Down
7 changes: 7 additions & 0 deletions packages/analytics/src/providers/kinesis/utils/resolveConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
assertValidationError,
} from '../../../errors';
import { DEFAULT_KINESIS_CONFIG } from './constants';
import { FLUSH_INTERVAL_MIN } from '../../../utils/constants';

export const resolveConfig = () => {
const config = Amplify.getConfig().Analytics?.Kinesis;
Expand All @@ -26,6 +27,12 @@ export const resolveConfig = () => {
flushSize < bufferSize,
AnalyticsValidationErrorCode.InvalidFlushSize
);
assertValidationError(
flushInterval >= FLUSH_INTERVAL_MIN,
AnalyticsValidationErrorCode.InvalidFlushInterval,
`FlushInterval should be greater than or equal to ${FLUSH_INTERVAL_MIN} milliseconds`
);

return {
region,
bufferSize,
Expand Down
6 changes: 6 additions & 0 deletions packages/analytics/src/providers/personalize/utils/resolveConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
assertValidationError,
} from '../../../errors';
import { DEFAULT_PERSONALIZE_CONFIG, PERSONALIZE_FLUSH_SIZE_MAX } from './';
import { FLUSH_INTERVAL_MIN } from '../../../utils/constants';

export const resolveConfig = () => {
const config = Amplify.getConfig().Analytics?.Personalize;
Expand All @@ -30,6 +31,11 @@ export const resolveConfig = () => {
AnalyticsValidationErrorCode.InvalidFlushSize,
`FlushSize for Personalize should be less or equal than ${PERSONALIZE_FLUSH_SIZE_MAX}`
);
assertValidationError(
flushInterval >= FLUSH_INTERVAL_MIN,
AnalyticsValidationErrorCode.InvalidFlushInterval,
`FlushInterval should be greater than or equal to ${FLUSH_INTERVAL_MIN} milliseconds`
);

return {
region,
Expand Down
4 changes: 4 additions & 0 deletions packages/analytics/src/utils/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

export const FLUSH_INTERVAL_MIN = 100;
13 changes: 8 additions & 5 deletions packages/analytics/src/utils/eventBuffer/EventBuffer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export class EventBuffer<T> {
private readonly config: EventBufferConfig;
private getAnalyticsClient: () => IAnalyticsClient<T>;

private timer?: ReturnType<typeof setInterval>;
private timer?: ReturnType<typeof setTimeout>;

constructor(
config: EventBufferConfig,
Expand Down Expand Up @@ -60,13 +60,16 @@ export class EventBuffer<T> {

private startEventLoop() {
if (this.timer) {
clearInterval(this.timer);
clearTimeout(this.timer);
}

const { flushSize, flushInterval } = this.config;
setInterval(() => {
this.submitEvents(flushSize);
}, flushInterval);
const submit = () => {
this.timer = setTimeout(() => {
this.submitEvents(flushSize).finally(() => submit());
}, flushInterval);
};
submit();
}

private submitEvents(count: number): Promise<void> {
Expand Down