@aws-amplify/datastore 4.5.2-unstable.c1fa9c7.5 → 4.6.0

package/src/sync/processors/subscription.ts

@@ -1,8 +1,12 @@
-import { API, GraphQLResult, GRAPHQL_AUTH_MODE } from '@aws-amplify/api';
+import { GraphQLResult, GRAPHQL_AUTH_MODE } from '@aws-amplify/api';
+import { InternalAPI } from '@aws-amplify/api/internals';
 import { Auth } from '@aws-amplify/auth';
 import { Cache } from '@aws-amplify/cache';
 import {
+	Category,
 	ConsoleLogger as Logger,
+	CustomUserAgentDetails,
+	DataStoreAction,
 	Hub,
 	HubCapsule,
 	BackgroundProcessManager,
@@ -37,7 +41,7 @@ import {
 	generateRTFRemediation,
 } from '../utils';
 import { ModelPredicateCreator } from '../../predicates';
-import { validatePredicate, USER_AGENT_SUFFIX_DATASTORE } from '../../util';
+import { validatePredicate } from '../../util';
 import { getSubscriptionErrorType } from './errorMaps';
 
 const logger = new Logger('DataStore');
@@ -79,7 +83,11 @@ class SubscriptionProcessor {
 		private readonly amplifyConfig: Record<string, any> = {},
 		private readonly authModeStrategy: AuthModeStrategy,
 		private readonly errorHandler: ErrorHandler,
-		private readonly amplifyContext: AmplifyContext = { Auth, API, Cache }
+		private readonly amplifyContext: AmplifyContext = {
+			Auth,
+			InternalAPI,
+			Cache,
+		}
 	) {}
 
 	private buildSubscription(
@@ -421,6 +429,11 @@ class SubscriptionProcessor {
 
 										const variables = {};
 
+										const customUserAgentDetails: CustomUserAgentDetails = {
+											category: Category.DataStore,
+											action: DataStoreAction.Subscribe,
+										};
+
 										if (addFilter && predicatesGroup) {
 											variables['filter'] =
 												predicateToGraphQLFilter(predicatesGroup);
@@ -443,19 +456,20 @@ class SubscriptionProcessor {
 											}`
 										);
 
-										const userAgentSuffix = USER_AGENT_SUFFIX_DATASTORE;
-
 										const queryObservable = <
 											Observable<{
 												value: GraphQLResult<Record<string, PersistentModel>>;
 											}>
-										>(<unknown>this.amplifyContext.API.graphql({
-											query,
-											variables,
-											...{ authMode },
-											authToken,
-											userAgentSuffix,
-										}));
+										>(<unknown>this.amplifyContext.InternalAPI.graphql(
+											{
+												query,
+												variables,
+												...{ authMode },
+												authToken,
+											},
+											undefined,
+											customUserAgentDetails
+										));
 
 										let subscriptionReadyCallback: () => void;
 

package/src/sync/processors/sync.ts

@@ -1,4 +1,5 @@
-import { API, GraphQLResult, GRAPHQL_AUTH_MODE } from '@aws-amplify/api';
+import { GraphQLResult, GRAPHQL_AUTH_MODE } from '@aws-amplify/api';
+import { InternalAPI } from '@aws-amplify/api/internals';
 import Observable from 'zen-observable-ts';
 import {
 	InternalSchema,
@@ -20,10 +21,12 @@ import {
 	predicateToGraphQLFilter,
 	getTokenForCustomAuth,
 } from '../utils';
-import { USER_AGENT_SUFFIX_DATASTORE } from '../../util';
 import {
 	jitteredExponentialRetry,
+	Category,
 	ConsoleLogger as Logger,
+	CustomUserAgentDetails,
+	DataStoreAction,
 	Hub,
 	NonRetryableError,
 	BackgroundProcessManager,
@@ -54,7 +57,7 @@ class SyncProcessor {
 		private readonly errorHandler: ErrorHandler,
 		private readonly amplifyContext: AmplifyContext
 	) {
-		amplifyContext.API = amplifyContext.API || API;
+		amplifyContext.InternalAPI = amplifyContext.InternalAPI || InternalAPI;
 		this.generateQueries();
 	}
 
@@ -214,13 +217,21 @@ class SyncProcessor {
 						this.amplifyConfig
 					);
 
-					return await this.amplifyContext.API.graphql({
-						query,
-						variables,
-						authMode,
-						authToken,
-						userAgentSuffix: USER_AGENT_SUFFIX_DATASTORE,
-					});
+					const customUserAgentDetails: CustomUserAgentDetails = {
+						category: Category.DataStore,
+						action: DataStoreAction.GraphQl,
+					};
+
+					return await this.amplifyContext.InternalAPI.graphql(
+						{
+							query,
+							variables,
+							authMode,
+							authToken,
+						},
+						undefined,
+						customUserAgentDetails
+					);
 
 					// TODO: onTerminate.then(() => API.cancel(...))
 				} catch (error) {

package/src/types.ts

@@ -15,7 +15,7 @@ import {
 import { PredicateAll } from './predicates';
 import { GRAPHQL_AUTH_MODE } from '@aws-amplify/api-graphql';
 import { Auth } from '@aws-amplify/auth';
-import { API } from '@aws-amplify/api';
+import { InternalAPI } from '@aws-amplify/api/internals';
 import { Cache } from '@aws-amplify/cache';
 import { Adapter } from './storage/adapter';
 
@@ -1101,7 +1101,7 @@ export enum LimitTimerRaceResolvedValues {
 
 export type AmplifyContext = {
 	Auth: typeof Auth;
-	API: typeof API;
+	InternalAPI: typeof InternalAPI;
 	Cache: typeof Cache;
 };
 

package/src/util.ts

@@ -75,7 +75,6 @@ const SYNC = NAMESPACES.SYNC;
 const STORAGE = NAMESPACES.STORAGE;
 
 export { USER, SYNC, STORAGE, DATASTORE };
-export const USER_AGENT_SUFFIX_DATASTORE = '/DataStore';
 
 export const exhaustiveCheck = (obj: never, throwOnError: boolean = true) => {
 	if (throwOnError) {