fix(analytics): Buffer limit should be adhered to (aws-amplify#10015)

Co-authored-by: Chris Fang <chrfang@amazon.com>
stocaaro · Jun 29, 2022 · 3dd9035 · 3dd9035
1 parent 11b537c
commit 3dd9035
Show file tree

Hide file tree

Showing 12 changed files with 69 additions and 1 deletion.
diff --git a/...nalytics/__tests__/Analytics-unit-test.ts → ...ges/analytics/__tests__/Analytics.test.ts b/...nalytics/__tests__/Analytics-unit-test.ts → ...ges/analytics/__tests__/Analytics.test.ts
diff --git a/...s/AWSKinesisFirehoseProvider-unit-test.ts → ...viders/AWSKinesisFirehoseProvider.test.ts b/...s/AWSKinesisFirehoseProvider-unit-test.ts → ...viders/AWSKinesisFirehoseProvider.test.ts
diff --git a/...Providers/AWSKinesisProvider-unit-test.ts → ...ts__/Providers/AWSKinesisProvider.test.ts b/...Providers/AWSKinesisProvider-unit-test.ts → ...ts__/Providers/AWSKinesisProvider.test.ts
diff --git a/...roviders/AWSPinpointProvider-unit-test.ts → ...s__/Providers/AWSPinpointProvider.test.ts b/...roviders/AWSPinpointProvider-unit-test.ts → ...s__/Providers/AWSPinpointProvider.test.ts
diff --git a/...rs/AmazonPersonalizeProvider-unit-test.ts → ...oviders/AmazonPersonalizeProvider.test.ts b/...rs/AmazonPersonalizeProvider-unit-test.ts → ...oviders/AmazonPersonalizeProvider.test.ts
diff --git a/packages/analytics/__tests__/Providers/EventBuffer.test.ts b/packages/analytics/__tests__/Providers/EventBuffer.test.ts
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+import EventBuffer from '../../src/Providers/EventBuffer';
+
+const DEFAULT_CONFIG = {
+	bufferSize: 1000,
+	flushSize: 100,
+	flushInterval: 5 * 1000, // 5s
+	resendLimit: 5,
+};
+
+const EVENT_OBJECT = {
+	params: {
+		event: {
+			eventId: 'event-id',
+			name: 'name',
+			attributes: 'attributes',
+			metrics: 'metrics',
+			session: {},
+			immediate: false,
+		},
+		timestamp: '2022-06-22T17:24:58Z',
+		config: {
+			appId: 'app-id',
+			endpointId: 'endpoint-id',
+			region: 'region',
+			resendLimit: 5,
+		},
+		credentials: {},
+		resendLimit: 5,
+	},
+	handlers: {
+		resolve: jest.fn(),
+		reject: jest.fn(),
+	},
+};
+
+describe('EventBuffer', () => {
+	beforeEach(() => {
+		jest.clearAllMocks();
+	});
+
+	test('can be constructed', () => {
+		const buffer = new EventBuffer({}, DEFAULT_CONFIG);
+		expect(buffer).toBeDefined();
+	});
+
+	test('does not allow buffer size to be exceeded', () => {
+		const config = { ...DEFAULT_CONFIG, bufferSize: 1 };
+		const buffer = new EventBuffer({}, config);
+		buffer.push(EVENT_OBJECT);
+		buffer.push(EVENT_OBJECT);
+		expect(EVENT_OBJECT.handlers.reject).toBeCalledWith(
+			Error('Exceeded the size of analytics events buffer')
+		);
+	});
+});
diff --git a/...s/__tests__/trackers/EventTracker-test.ts → ...s/__tests__/trackers/EventTracker.test.ts b/...s/__tests__/trackers/EventTracker-test.ts → ...s/__tests__/trackers/EventTracker.test.ts
diff --git a/..._tests__/trackers/PageViewTracker-test.ts → ..._tests__/trackers/PageViewTracker.test.ts b/..._tests__/trackers/PageViewTracker-test.ts → ..._tests__/trackers/PageViewTracker.test.ts
diff --git a/...ests__/trackers/SessionTracker-rn-test.ts → ...ests__/trackers/SessionTracker-rn.test.ts b/...ests__/trackers/SessionTracker-rn-test.ts → ...ests__/trackers/SessionTracker-rn.test.ts
diff --git a/...__tests__/trackers/SessionTracker-test.ts → ...__tests__/trackers/SessionTracker.test.ts b/...__tests__/trackers/SessionTracker-test.ts → ...__tests__/trackers/SessionTracker.test.ts
diff --git a/packages/analytics/__tests__/utils-test.ts → packages/analytics/__tests__/utils.test.ts b/packages/analytics/__tests__/utils-test.ts → packages/analytics/__tests__/utils.test.ts
diff --git a/packages/analytics/src/Providers/EventBuffer.ts b/packages/analytics/src/Providers/EventBuffer.ts
@@ -43,7 +43,8 @@ export default class EventsBuffer {
 	}
 
 	public push(event: EventObject) {
-		if (this._buffer > this._config.bufferSize) {
+		// if the buffer is currently at the configured limit, pushing would exceed it
+		if (this._buffer.length >= this._config.bufferSize) {
 			logger.debug('Exceeded analytics events buffer size');
 			return event.handlers.reject(
 				new Error('Exceeded the size of analytics events buffer')