fix(core): fail to clean up framework observers

packages/api-graphql/package.json

@@ -65,7 +65,7 @@
       "name": "API (GraphQL client)",
       "path": "./lib-esm/index.js",
       "import": "{ Amplify, GraphQLAPI }",
-      "limit": "89.51 kB"
+      "limit": "89.52 kB"
     }
   ],
   "jest": {

packages/api/package.json

@@ -67,7 +67,7 @@
 			"name": "API (top-level class)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, API }",
-			"limit": "90.27 kB"
+			"limit": "90.28 kB"
 		}
 	],
 	"jest": {

packages/core/__tests__/Platform-test.ts

@@ -9,7 +9,18 @@ import { detectFramework, clearCache } from '../src/Platform/detectFramework';
 import * as detection from '../src/Platform/detection';
 
 describe('Platform test', () => {
-	beforeEach(() => clearCache());
+	beforeAll(() => {
+		jest.useFakeTimers();
+	});
+
+	afterAll(() => {
+		jest.useRealTimers();
+	});
+
+	beforeEach(() => {
+		clearCache();
+	});
+
 	describe('isReactNative test', () => {
 		test('happy case', () => {
 			expect(Platform.isReactNative).toBe(false);
@@ -70,8 +81,6 @@ describe('Platform test', () => {
 
 	describe('detectFramework', () => {
 		test('retries detection after 10ms', () => {
-			jest.useFakeTimers();
-
 			jest.spyOn(detection, 'detect');
 
 			detectFramework();
@@ -81,3 +90,33 @@ describe('Platform test', () => {
 		});
 	});
 });
+
+describe('detectFramework observers', () => {
+	let module;
+
+	beforeAll(() => {
+		jest.resetModules();
+		module = require('../src/Platform/detectFramework');
+		jest.useFakeTimers();
+	});
+
+	afterAll(() => {
+		jest.useRealTimers();
+	});
+
+	test('it notifies and cleans up the observers and rejects new observer after detection completes', () => {
+		const mockObserver = jest.fn();
+		module.observeFrameworkChanges(mockObserver);
+		expect(module.frameworkChangeObservers.length).toBe(1);
+
+		module.detectFramework();
+		expect(mockObserver).toHaveBeenCalledTimes(1);
+		jest.runOnlyPendingTimers();
+		module.detectFramework();
+		expect(mockObserver).toHaveBeenCalledTimes(2);
+		expect(module.frameworkChangeObservers.length).toBe(0);
+
+		module.observeFrameworkChanges(mockObserver);
+		expect(module.frameworkChangeObservers.length).toBe(0);
+	});
+});

packages/core/src/Platform/detectFramework.ts

@@ -7,7 +7,7 @@ import { detect } from './detection';
 // We want to cache detection since the framework won't change
 let frameworkCache: Framework | undefined;
 
-const frameworkChangeObservers: (() => void)[] = [];
+export const frameworkChangeObservers: (() => void)[] = [];
 
 // Setup the detection reset tracking / timeout delays
 let resetTriggered = false;
@@ -19,8 +19,19 @@ export const detectFramework = (): Framework => {
 	if (!frameworkCache) {
 		frameworkCache = detect();
 
-		// Everytime we update the cache, call each observer function
-		frameworkChangeObservers.forEach(fcn => fcn());
+		if (resetTriggered) {
+			// The final run of detectFramework:
+			// Starting from this point, the `frameworkCache` becomes "final".
+			// So we don't need to notify the observers again so the observer
+			// can be removed after the final notice.
+			while (frameworkChangeObservers.length) {
+				frameworkChangeObservers.pop()();
+			}
+		} else {
+			// The first run of detectFramework:
+			// Every time we update the cache, call each observer function
+			frameworkChangeObservers.forEach(fcn => fcn());
+		}
 
 		// Retry once for either Unknown type after a delay (explained below)
 		resetTimeout(Framework.ServerSideUnknown, SSR_RESET_TIMEOUT);
@@ -33,6 +44,12 @@ export const detectFramework = (): Framework => {
  * @internal Setup observer callback that will be called everytime the framework changes
  */
 export const observeFrameworkChanges = (fcn: () => void) => {
+	// When the `frameworkCache` won't be updated again, we ignore all incoming
+	// observers.
+	if (resetTriggered) {
+		return;
+	}
+
 	frameworkChangeObservers.push(fcn);
 };
 

packages/geo/package.json

@@ -58,7 +58,7 @@
 			"name": "Geo (top-level class)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Geo }",
-			"limit": "52.1 kB"
+			"limit": "52.12 kB"
 		}
 	],
 	"jest": {

packages/interactions/package.json

@@ -59,7 +59,7 @@
 			"name": "Interactions (top-level class with Lex v2)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Interactions, AWSLexV2Provider }",
-			"limit": "76 kB"
+			"limit": "76.02 kB"
 		}
 	],
 	"jest": {

packages/predictions/package.json

@@ -75,7 +75,7 @@
 			"name": "Predictions (Identify provider)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Predictions, AmazonAIIdentifyPredictionsProvider }",
-			"limit": "73.55 kB"
+			"limit": "73.57 kB"
 		},
 		{
 			"name": "Predictions (Interpret provider)",

packages/pubsub/package.json

@@ -65,13 +65,13 @@
       "name": "PubSub (IoT provider)",
       "path": "./lib-esm/index.js",
       "import": "{ Amplify, PubSub, AWSIoTProvider }",
-      "limit": "81.37 kB"
+      "limit": "81.39 kB"
     },
     {
       "name": "PubSub (Mqtt provider)",
       "path": "./lib-esm/index.js",
       "import": "{ Amplify, PubSub, MqttOverWSProvider }",
-      "limit": "81.24 kB"
+      "limit": "81.26 kB"
     }
   ],
   "jest": {

packages/storage/package.json

@@ -60,7 +60,7 @@
       "name": "Storage (top-level class)",
       "path": "./lib-esm/index.js",
       "import": "{ Amplify, Storage }",
-      "limit": "38.95 kB"
+      "limit": "38.96 kB"
     }
   ],
   "jest": {