fix: Add upkeep to platform/framework caches (#11505)

aws-amplify · Jun 15, 2023 · 03aa356 · 03aa356
1 parent 019b5b1
commit 03aa356
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 8 deletions.
diff --git a/packages/analytics/package.json b/packages/analytics/package.json
@@ -63,7 +63,7 @@
 			"name": "Analytics (Pinpoint)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Analytics, AWSPinpointProvider }",
-			"limit": "30.9 kB"
+			"limit": "30.95 kB"
 		},
 		{
 			"name": "Analytics (Kinesis)",

diff --git a/packages/api-rest/package.json b/packages/api-rest/package.json
@@ -56,7 +56,7 @@
       "name": "API (rest client)",
       "path": "./lib-esm/index.js",
       "import": "{ Amplify, RestAPI }",
-      "limit": "30.8 kB"
+      "limit": "30.9 kB"
     }
   ],
   "jest": {

diff --git a/packages/auth/src/Auth.ts b/packages/auth/src/Auth.ts
@@ -139,6 +139,9 @@ export class AuthClass {
 
 		addAuthCategoryToCognitoUserAgent();
 		addFrameworkToCognitoUserAgent(Platform.framework);
+		Platform.observeFrameworkChanges(() => {
+			addFrameworkToCognitoUserAgent(Platform.framework);
+		});
 	}
 
 	public getModuleName() {

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -105,7 +105,7 @@
 			"name": "Core (Credentials)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Credentials }",
-			"limit": "13.25 kB"
+			"limit": "13.3 kB"
 		},
 		{
 			"name": "Core (Signer)",

diff --git a/packages/core/src/AwsClients/CognitoIdentity/base.ts b/packages/core/src/AwsClients/CognitoIdentity/base.ts
@@ -18,6 +18,7 @@ import {
 	getRetryDecider,
 } from '../../clients/middleware/retry';
 import { getAmplifyUserAgentString } from '../../Platform';
+import { observeFrameworkChanges } from '../../Platform/detectFramework';
 
 /**
  * The service name used to sign requests if the API requires authentication.
@@ -65,6 +66,10 @@ export const defaultConfig = {
 	userAgentValue: getAmplifyUserAgentString(),
 };
 
+observeFrameworkChanges(() => {
+	defaultConfig.userAgentValue = getAmplifyUserAgentString();
+});
+
 /**
  * @internal
  */

diff --git a/packages/core/src/Platform/detectFramework.ts b/packages/core/src/Platform/detectFramework.ts
@@ -7,22 +7,35 @@ import { detect } from './detection';
 // We want to cache detection since the framework won't change
 let frameworkCache: Framework | undefined;
 
+const frameworkChangeObservers: (() => void)[] = [];
+
 // Setup the detection reset tracking / timeout delays
 let resetTriggered = false;
 const SSR_RESET_TIMEOUT = 10; // ms
 const WEB_RESET_TIMEOUT = 10; // ms
+const PRIME_FRAMEWORK_DELAY = 1_000; // ms
 
 export const detectFramework = (): Framework => {
 	if (!frameworkCache) {
 		frameworkCache = detect();
 
+		// Everytime 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);
 		resetTimeout(Framework.WebUnknown, WEB_RESET_TIMEOUT);
 	}
 	return frameworkCache;
 };
 
+/**
+ * @internal Setup observer callback that will be called everytime the framework changes
+ */
+export const observeFrameworkChanges = (fcn: () => void) => {
+	frameworkChangeObservers.push(fcn);
+};
+
 export function clearCache() {
 	frameworkCache = undefined;
 }
@@ -38,6 +51,7 @@ function resetTimeout(framework: Framework, delay: number) {
 		setTimeout(() => {
 			clearCache();
 			resetTriggered = true;
+			setTimeout(detectFramework, PRIME_FRAMEWORK_DELAY);
 		}, delay);
 	}
 }
diff --git a/packages/core/src/Platform/index.ts b/packages/core/src/Platform/index.ts
@@ -3,7 +3,7 @@
 
 import { CustomUserAgentDetails, Framework } from './types';
 import { version } from './version';
-import { detectFramework } from './detectFramework';
+import { detectFramework, observeFrameworkChanges } from './detectFramework';
 import { UserAgent as AWSUserAgent } from '@aws-sdk/types';
 
 const BASE_USER_AGENT = `aws-amplify`;
@@ -17,6 +17,10 @@ class PlatformBuilder {
 	get isReactNative() {
 		return this.framework === Framework.ReactNative;
 	}
+
+	observeFrameworkChanges(fcn: () => void) {
+		observeFrameworkChanges(fcn);
+	}
 }
 
 export const Platform = new PlatformBuilder();

diff --git a/packages/geo/package.json b/packages/geo/package.json
@@ -57,7 +57,7 @@
 			"name": "Geo (top-level class)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Geo }",
-			"limit": "51.6 kB"
+			"limit": "51.7 kB"
 		}
 	],
 	"jest": {

diff --git a/packages/interactions/package.json b/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": "75.6 kB"
+			"limit": "76 kB"
 		}
 	],
 	"jest": {

diff --git a/packages/notifications/package.json b/packages/notifications/package.json
@@ -65,13 +65,13 @@
 			"name": "Notifications (top-level class)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Notifications }",
-			"limit": "29.75 kB"
+			"limit": "29.8 kB"
 		},
 		{
 			"name": "Notifications (with Analytics)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Notifications, Analytics }",
-			"limit": "29.75 kB"
+			"limit": "29.8 kB"
 		}
 	]
 }