@aws-amplify/pubsub 5.2.2-unstable.f47d472.1 → 5.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/pubsub",
-  "version": "5.2.2-unstable.f47d472.1+f47d472ea",
+  "version": "5.3.0",
   "description": "Pubsub category of aws-amplify",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -47,12 +47,13 @@
   "files": [
     "lib",
     "lib-esm",
-    "src"
+    "src",
+    "internals"
   ],
   "dependencies": {
-    "@aws-amplify/auth": "5.4.2-unstable.f47d472.1+f47d472ea",
-    "@aws-amplify/cache": "5.1.1-unstable.f47d472.4+f47d472ea",
-    "@aws-amplify/core": "5.4.1-unstable.f47d472.4+f47d472ea",
+    "@aws-amplify/auth": "5.5.0",
+    "@aws-amplify/cache": "5.1.1",
+    "@aws-amplify/core": "5.5.0",
     "graphql": "15.8.0",
     "tslib": "^1.8.0",
     "url": "0.11.0",
@@ -64,13 +65,13 @@
       "name": "PubSub (IoT provider)",
       "path": "./lib-esm/index.js",
       "import": "{ Amplify, PubSub, AWSIoTProvider }",
-      "limit": "79.15 kB"
+      "limit": "80 kB"
     },
     {
       "name": "PubSub (Mqtt provider)",
       "path": "./lib-esm/index.js",
       "import": "{ Amplify, PubSub, MqttOverWSProvider }",
-      "limit": "79 kB"
+      "limit": "80 kB"
     }
   ],
   "jest": {
@@ -123,5 +124,5 @@
       "lib-esm"
     ]
   },
-  "gitHead": "f47d472ea021dadb1a04d03295c3c6065155f0c0"
+  "gitHead": "95ab2ccdd0fd62afd90c02e3e8273d4acc400ddc"
 }

package/src/Providers/AWSAppSyncRealTimeProvider/index.ts

@@ -17,6 +17,8 @@ import {
 	NonRetryableError,
 	ICredentials,
 	isNonRetryableError,
+	CustomUserAgentDetails,
+	getAmplifyUserAgentString,
 } from '@aws-amplify/core';
 import { Cache } from '@aws-amplify/cache';
 import { Auth, GRAPHQL_AUTH_MODE } from '@aws-amplify/auth';
@@ -208,7 +210,8 @@ export class AWSAppSyncRealTimeProvider extends AbstractPubSubProvider<AWSAppSyn
 
 	subscribe(
 		_topics: string[] | string,
-		options?: AWSAppSyncRealTimeProviderOptions
+		options?: AWSAppSyncRealTimeProviderOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Observable<Record<string, unknown>> {
 		const appSyncGraphqlEndpoint = options?.appSyncGraphqlEndpoint;
 
@@ -230,11 +233,13 @@ export class AWSAppSyncRealTimeProvider extends AbstractPubSubProvider<AWSAppSyn
 				const startSubscription = () => {
 					if (!subscriptionStartActive) {
 						subscriptionStartActive = true;
+
 						const startSubscriptionPromise =
 							this._startSubscriptionWithAWSAppSyncRealTime({
 								options,
 								observer,
 								subscriptionId,
+								customUserAgentDetails,
 							}).catch<any>(err => {
 								logger.debug(
 									`${CONTROL_MSG.REALTIME_SUBSCRIPTION_INIT_ERROR}: ${err}`
@@ -301,10 +306,12 @@ export class AWSAppSyncRealTimeProvider extends AbstractPubSubProvider<AWSAppSyn
 		options,
 		observer,
 		subscriptionId,
+		customUserAgentDetails,
 	}: {
 		options: AWSAppSyncRealTimeProviderOptions;
 		observer: PubSubContentObserver;
 		subscriptionId: string;
+		customUserAgentDetails: CustomUserAgentDetails;
 	}) {
 		const {
 			appSyncGraphqlEndpoint,
@@ -346,7 +353,7 @@ export class AWSAppSyncRealTimeProvider extends AbstractPubSubProvider<AWSAppSyn
 			})),
 			...(await graphql_headers()),
 			...additionalHeaders,
-			[USER_AGENT_HEADER]: Constants.userAgent,
+			[USER_AGENT_HEADER]: getAmplifyUserAgentString(customUserAgentDetails),
 		};
 
 		const subscriptionMessage = {

package/src/Providers/PubSubProvider.ts

@@ -2,7 +2,10 @@
 // SPDX-License-Identifier: Apache-2.0
 import Observable from 'zen-observable-ts';
 import { PubSubProvider, ProviderOptions } from '../types/Provider';
-import { ConsoleLogger as Logger } from '@aws-amplify/core';
+import {
+	CustomUserAgentDetails,
+	ConsoleLogger as Logger,
+} from '@aws-amplify/core';
 import { PubSubContent } from '../types/PubSub';
 
 const logger = new Logger('AbstractPubSubProvider');
@@ -44,6 +47,7 @@ export abstract class AbstractPubSubProvider<T extends ProviderOptions>
 
 	public abstract subscribe(
 		topics: string[] | string,
-		options?: T
+		options?: T,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Observable<PubSubContent>;
 }

package/src/PubSub.ts

@@ -7,169 +7,25 @@ import {
 	Amplify,
 	browserOrNode,
 	ConsoleLogger as Logger,
-	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
 } from '@aws-amplify/core';
-import { PubSubProvider, PubSubOptions, ProviderOptions } from './types';
-import { AWSAppSyncRealTimeProvider } from './Providers';
-import { PubSubContent } from './types/PubSub';
-
-const { isNode } = browserOrNode();
-const logger = new Logger('PubSub');
+import { PubSubProvider, ProviderOptions } from './types';
+import { InternalPubSubClass } from './internals';
 
 type PubSubObservable = {
 	provider: PubSubProvider;
 	value: string | Record<string, unknown>;
 };
 
-export class PubSubClass {
-	private _options: PubSubOptions;
-
-	private _pluggables: PubSubProvider[];
-
-	/**
-	 * Internal instance of AWSAppSyncRealTimeProvider used by the API category to subscribe to AppSync
-	 */
-	private _awsAppSyncRealTimeProvider?: AWSAppSyncRealTimeProvider;
-
-	/**
-	 * Lazy instantiate AWSAppSyncRealTimeProvider when it is required by the API category
-	 */
-	private get awsAppSyncRealTimeProvider() {
-		if (!this._awsAppSyncRealTimeProvider) {
-			this._awsAppSyncRealTimeProvider = new AWSAppSyncRealTimeProvider(
-				this._options
-			);
-		}
-		return this._awsAppSyncRealTimeProvider;
-	}
-
-	/**
-	 * Initialize PubSub with AWS configurations
-	 *
-	 * @param {PubSubOptions} options - Configuration object for PubSub
-	 */
-	constructor(options?: PubSubOptions) {
-		this._options = options ?? {};
-		logger.debug('PubSub Options', this._options);
-		this._pluggables = [];
-		this.subscribe = this.subscribe.bind(this);
-	}
-
+export class PubSubClass extends InternalPubSubClass {
 	public getModuleName() {
 		return 'PubSub';
 	}
 
-	/**
-	 * Configure PubSub part with configurations
-	 *
-	 * @param {PubSubOptions} config - Configuration for PubSub
-	 * @return {Object} - The current configuration
-	 */
-	configure(options: PubSubOptions) {
-		const opt: Record<string, unknown> = options
-			? options.PubSub || options
-			: {};
-		logger.debug('configure PubSub', { opt });
-
-		this._options = Object.assign({}, this._options, opt);
-
-		this._pluggables.map(pluggable => pluggable.configure(this._options));
-
-		return this._options;
-	}
-
-	/**
-	 * add plugin into Analytics category
-	 * @param {Object} pluggable - an instance of the plugin
-	 */
-	public async addPluggable(pluggable: PubSubProvider) {
-		if (pluggable && pluggable.getCategory() === 'PubSub') {
-			this._pluggables.push(pluggable);
-
-			const config = pluggable.configure(this._options);
-
-			return config;
-		}
-	}
-
-	/**
-	 * remove plugin from PubSub category
-	 * @param providerName - the name of the plugin
-	 */
-	removePluggable(providerName: string): void {
-		this._pluggables = this._pluggables.filter(
-			pluggable => pluggable.getProviderName() !== providerName
-		);
-	}
-
-	private getProviderByName(providerName: string | symbol) {
-		if (providerName === INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER) {
-			return this.awsAppSyncRealTimeProvider;
-		}
-
-		return this._pluggables.find(
-			pluggable => pluggable.getProviderName() === providerName
-		);
-	}
-
-	private getProviders(options: ProviderOptions = {}) {
-		const providerName = options.provider;
-		if (!providerName) {
-			return this._pluggables;
-		}
-
-		const provider = this.getProviderByName(providerName);
-		if (!provider) {
-			throw new Error(`Could not find provider named ${String(providerName)}`);
-		}
-
-		return [provider];
-	}
-
-	async publish(
-		topics: string[] | string,
-		msg: PubSubContent,
-		options?: ProviderOptions
-	) {
-		return Promise.all(
-			this.getProviders(options).map(provider =>
-				provider.publish(topics, msg, options)
-			)
-		);
-	}
-
 	subscribe(
 		topics: string[] | string,
 		options?: ProviderOptions
 	): Observable<PubSubObservable> {
-		if (isNode && this._options && this._options.ssr) {
-			throw new Error(
-				'Subscriptions are not supported for Server-Side Rendering (SSR)'
-			);
-		}
-
-		logger.debug('subscribe options', options);
-
-		const providers = this.getProviders(options);
-
-		return new Observable<PubSubObservable>(observer => {
-			const observables = providers.map(provider => ({
-				provider,
-				observable: provider.subscribe(topics, options),
-			}));
-
-			const subscriptions = observables.map(({ provider, observable }) =>
-				observable.subscribe({
-					start: console.error,
-					next: (value: PubSubContent) => observer.next({ provider, value }),
-					error: (error: unknown) => observer.error({ provider, error }),
-					// complete: observer.complete, // TODO: when all completed, complete the outer one
-				})
-			);
-
-			return () =>
-				subscriptions.forEach(subscription => subscription.unsubscribe());
-		});
+		return super.subscribe(topics, options);
 	}
 }
 

package/src/internals/InternalPubSub.ts

@@ -0,0 +1,185 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import {
+	Amplify,
+	browserOrNode,
+	Category,
+	ConsoleLogger as Logger,
+	CustomUserAgentDetails,
+	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
+	PubSubAction,
+} from '@aws-amplify/core';
+import { PubSubProvider, PubSubOptions, ProviderOptions } from '../types';
+import { AWSAppSyncRealTimeProvider } from '../Providers';
+import { PubSubContent } from '../types/PubSub';
+import Observable from 'zen-observable-ts';
+
+const { isNode } = browserOrNode();
+const logger = new Logger('PubSub');
+
+type PubSubObservable = {
+	provider: PubSubProvider;
+	value: string | Record<string, unknown>;
+};
+
+export class InternalPubSubClass {
+	private _options: PubSubOptions;
+
+	private _pluggables: PubSubProvider[];
+
+	/**
+	 * Internal instance of AWSAppSyncRealTimeProvider used by the API category to subscribe to AppSync
+	 */
+	private _awsAppSyncRealTimeProvider?: AWSAppSyncRealTimeProvider;
+
+	/**
+	 * Lazy instantiate AWSAppSyncRealTimeProvider when it is required by the API category
+	 */
+	private get awsAppSyncRealTimeProvider() {
+		if (!this._awsAppSyncRealTimeProvider) {
+			this._awsAppSyncRealTimeProvider = new AWSAppSyncRealTimeProvider(
+				this._options
+			);
+		}
+		return this._awsAppSyncRealTimeProvider;
+	}
+
+	/**
+	 * Initialize PubSub with AWS configurations
+	 *
+	 * @param {PubSubOptions} options - Configuration object for PubSub
+	 */
+	constructor(options?: PubSubOptions) {
+		this._options = options ?? {};
+		logger.debug('PubSub Options', this._options);
+		this._pluggables = [];
+		this.subscribe = this.subscribe.bind(this);
+	}
+
+	public getModuleName() {
+		return 'InternalPubSub';
+	}
+
+	/**
+	 * Configure PubSub part with configurations
+	 *
+	 * @param {PubSubOptions} config - Configuration for PubSub
+	 * @return {Object} - The current configuration
+	 */
+	configure(options: PubSubOptions) {
+		const opt: Record<string, unknown> = options
+			? options.PubSub || options
+			: {};
+		logger.debug('configure PubSub', { opt });
+
+		this._options = Object.assign({}, this._options, opt);
+
+		this._pluggables.map(pluggable => pluggable.configure(this._options));
+
+		return this._options;
+	}
+
+	/**
+	 * add plugin into Analytics category
+	 * @param {Object} pluggable - an instance of the plugin
+	 */
+	public async addPluggable(pluggable: PubSubProvider) {
+		if (pluggable && pluggable.getCategory() === 'PubSub') {
+			this._pluggables.push(pluggable);
+
+			const config = pluggable.configure(this._options);
+
+			return config;
+		}
+	}
+
+	/**
+	 * remove plugin from PubSub category
+	 * @param providerName - the name of the plugin
+	 */
+	removePluggable(providerName: string): void {
+		this._pluggables = this._pluggables.filter(
+			pluggable => pluggable.getProviderName() !== providerName
+		);
+	}
+
+	private getProviderByName(providerName: string | symbol) {
+		if (providerName === INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER) {
+			return this.awsAppSyncRealTimeProvider;
+		}
+
+		return this._pluggables.find(
+			pluggable => pluggable.getProviderName() === providerName
+		);
+	}
+
+	private getProviders(options: ProviderOptions = {}) {
+		const providerName = options.provider;
+		if (!providerName) {
+			return this._pluggables;
+		}
+
+		const provider = this.getProviderByName(providerName);
+		if (!provider) {
+			throw new Error(`Could not find provider named ${String(providerName)}`);
+		}
+
+		return [provider];
+	}
+
+	async publish(
+		topics: string[] | string,
+		msg: PubSubContent,
+		options?: ProviderOptions
+	) {
+		return Promise.all(
+			this.getProviders(options).map(provider =>
+				provider.publish(topics, msg, options)
+			)
+		);
+	}
+
+	subscribe(
+		topics: string[] | string,
+		options?: ProviderOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
+	): Observable<PubSubObservable> {
+		if (isNode && this._options && this._options.ssr) {
+			throw new Error(
+				'Subscriptions are not supported for Server-Side Rendering (SSR)'
+			);
+		}
+
+		logger.debug('subscribe options', options);
+
+		const providers = this.getProviders(options);
+
+		const pubSubUserAgentDetails: CustomUserAgentDetails = {
+			category: Category.PubSub,
+			action: PubSubAction.Subscribe,
+			...customUserAgentDetails,
+		};
+
+		return new Observable<PubSubObservable>(observer => {
+			const observables = providers.map(provider => ({
+				provider,
+				observable: provider.subscribe(topics, options, pubSubUserAgentDetails),
+			}));
+
+			const subscriptions = observables.map(({ provider, observable }) =>
+				observable.subscribe({
+					start: console.error,
+					next: (value: PubSubContent) => observer.next({ provider, value }),
+					error: (error: unknown) => observer.error({ provider, error }),
+					// complete: observer.complete, // TODO: when all completed, complete the outer one
+				})
+			);
+
+			return () =>
+				subscriptions.forEach(subscription => subscription.unsubscribe());
+		});
+	}
+}
+
+export const InternalPubSub = new InternalPubSubClass();
+Amplify.register(InternalPubSub);

package/src/internals/index.ts

@@ -0,0 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export { InternalPubSub, InternalPubSubClass } from './InternalPubSub';