@aws-amplify/pubsub 4.2.10-cloud-logging.7 → 4.2.10-cloud-logging.8

package/src/Providers/AWSIotProvider.ts

@@ -10,12 +10,21 @@
  * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
  * and limitations under the License.
  */
-import { MqttOverWSProvider } from './MqttOverWSProvider';
+import { MqttOverWSProvider, MqttProviderOptions } from './MqttOverWSProvider';
 import { Signer, Credentials } from '@aws-amplify/core';
 
 const SERVICE_NAME = 'iotdevicegateway';
 
+export interface AWSIoTProviderOptions extends MqttProviderOptions {
+	aws_pubsub_region?: string;
+	aws_pubsub_endpoint?: string;
+}
+
 export class AWSIoTProvider extends MqttOverWSProvider {
+	constructor(options: AWSIoTProviderOptions = {}) {
+		super(options);
+	}
+
 	protected get region() {
 		return this.options.aws_pubsub_region;
 	}

package/src/Providers/MqttOverWSProvider.ts

@@ -15,7 +15,7 @@ import { v4 as uuid } from 'uuid';
 import Observable from 'zen-observable-ts';
 
 import { AbstractPubSubProvider } from './PubSubProvider';
-import { ProvidertOptions, SubscriptionObserver } from '../types';
+import { ProviderOptions, SubscriptionObserver } from '../types';
 import { ConsoleLogger as Logger } from '@aws-amplify/core';
 
 const logger = new Logger('MqttOverWSProvider');
@@ -34,32 +34,40 @@ export function mqttTopicMatch(filter: string, topic: string) {
 	return length === topicArray.length;
 }
 
-export interface MqttProvidertOptions extends ProvidertOptions {
+export interface MqttProviderOptions extends ProviderOptions {
 	clientId?: string;
 	url?: string;
 }
 
+/**
+ * @deprecated Migrated to MqttProviderOptions
+ */
+export type MqttProvidertOptions = MqttProviderOptions;
+
 class ClientsQueue {
 	private promises: Map<string, Promise<any>> = new Map();
 
-	async get(clientId: string, clientFactory: (string) => Promise<any>) {
-		let promise = this.promises.get(clientId);
-		if (promise) {
-			return promise;
+	async get(clientId: string, clientFactory?: (input: string) => Promise<any>) {
+		const cachedPromise = this.promises.get(clientId);
+		if (cachedPromise) {
+			return cachedPromise;
 		}
 
-		promise = clientFactory(clientId);
+		if (clientFactory) {
+			const newPromise = clientFactory(clientId);
 
-		this.promises.set(clientId, promise);
+			this.promises.set(clientId, newPromise);
 
-		return promise;
+			return newPromise;
+		}
+		return undefined;
 	}
 
 	get allClients() {
 		return Array.from(this.promises.keys());
 	}
 
-	remove(clientId) {
+	remove(clientId: string) {
 		this.promises.delete(clientId);
 	}
 }
@@ -69,7 +77,7 @@ const topicSymbol = typeof Symbol !== 'undefined' ? Symbol('topic') : '@@topic';
 export class MqttOverWSProvider extends AbstractPubSubProvider {
 	private _clientsQueue = new ClientsQueue();
 
-	constructor(options: MqttProvidertOptions = {}) {
+	constructor(options: MqttProviderOptions = {}) {
 		super({ ...options, clientId: options.clientId || uuid() });
 	}
 
@@ -90,7 +98,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 			.aws_appsync_dangerously_connect_to_http_endpoint_for_testing;
 	}
 
-	protected getTopicForValue(value) {
+	protected getTopicForValue(value: any) {
 		return typeof value === 'object' && value[topicSymbol];
 	}
 
@@ -98,11 +106,21 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 		return 'MqttOverWSProvider';
 	}
 
-	public onDisconnect({ clientId, errorCode, ...args }) {
+	public onDisconnect({
+		clientId,
+		errorCode,
+		...args
+	}: {
+		clientId?: string;
+		errorCode?: number;
+	}) {
 		if (errorCode !== 0) {
 			logger.warn(clientId, JSON.stringify({ errorCode, ...args }, null, 2));
 
-			const topicsToDelete = [];
+			const topicsToDelete: string[] = [];
+			if (!clientId) {
+				return;
+			}
 			const clientIdObservers = this._clientIdObservers.get(clientId);
 			if (!clientIdObservers) {
 				return;
@@ -128,10 +146,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 		}
 	}
 
-	public async newClient({
-		url,
-		clientId,
-	}: MqttProvidertOptions): Promise<any> {
+	public async newClient({ url, clientId }: MqttProviderOptions): Promise<any> {
 		logger.debug('Creating new MQTT client', clientId);
 
 		// @ts-ignore
@@ -140,10 +155,18 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 		client.onMessageArrived = ({
 			destinationName: topic,
 			payloadString: msg,
+		}: {
+			destinationName: string;
+			payloadString: string;
 		}) => {
 			this._onMessage(topic, msg);
 		};
-		client.onConnectionLost = ({ errorCode, ...args }) => {
+		client.onConnectionLost = ({
+			errorCode,
+			...args
+		}: {
+			errorCode: number;
+		}) => {
 			this.onDisconnect({ clientId, errorCode, ...args });
 		};
 
@@ -161,7 +184,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 
 	protected async connect(
 		clientId: string,
-		options: MqttProvidertOptions = {}
+		options: MqttProviderOptions = {}
 	): Promise<any> {
 		return await this.clientsQueue.get(clientId, clientId =>
 			this.newClient({ ...options, clientId })
@@ -169,7 +192,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 	}
 
 	protected async disconnect(clientId: string): Promise<void> {
-		const client = await this.clientsQueue.get(clientId, () => null);
+		const client = await this.clientsQueue.get(clientId);
 
 		if (client && client.isConnected()) {
 			client.disconnect();
@@ -189,19 +212,15 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 		targetTopics.forEach(topic => client.send(topic, message));
 	}
 
-	protected _topicObservers: Map<
-		string,
-		Set<SubscriptionObserver<any>>
-	> = new Map();
+	protected _topicObservers: Map<string, Set<SubscriptionObserver<any>>> =
+		new Map();
 
-	protected _clientIdObservers: Map<
-		string,
-		Set<SubscriptionObserver<any>>
-	> = new Map();
+	protected _clientIdObservers: Map<string, Set<SubscriptionObserver<any>>> =
+		new Map();
 
 	private _onMessage(topic: string, msg: any) {
 		try {
-			const matchedTopicObservers = [];
+			const matchedTopicObservers: Set<SubscriptionObserver<any>>[] = [];
 			this._topicObservers.forEach((observerForTopic, observerTopic) => {
 				if (mqttTopicMatch(observerTopic, topic)) {
 					matchedTopicObservers.push(observerForTopic);
@@ -223,7 +242,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 
 	subscribe(
 		topics: string[] | string,
-		options: MqttProvidertOptions = {}
+		options: MqttProviderOptions = {}
 	): Observable<any> {
 		const targetTopics = ([] as string[]).concat(topics);
 		logger.debug('Subscribing to topic(s)', targetTopics.join(','));
@@ -271,9 +290,9 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 				logger.debug('Unsubscribing from topic(s)', targetTopics.join(','));
 
 				if (client) {
-					this._clientIdObservers.get(clientId).delete(observer);
+					this._clientIdObservers.get(clientId)?.delete(observer);
 					// No more observers per client => client not needed anymore
-					if (this._clientIdObservers.get(clientId).size === 0) {
+					if (this._clientIdObservers.get(clientId)?.size === 0) {
 						this.disconnect(clientId);
 						this._clientIdObservers.delete(clientId);
 					}

package/src/Providers/PubSubProvider.ts

@@ -11,19 +11,19 @@
  * and limitations under the License.
  */
 import Observable from 'zen-observable-ts';
-import { PubSubProvider, ProvidertOptions } from '../types';
+import { PubSubProvider, ProviderOptions } from '../types';
 import { ConsoleLogger as Logger } from '@aws-amplify/core';
 
 const logger = new Logger('AbstractPubSubProvider');
 
 export abstract class AbstractPubSubProvider implements PubSubProvider {
-	private _config: ProvidertOptions;
+	private _config: ProviderOptions;
 
-	constructor(options: ProvidertOptions = {}) {
+	constructor(options: ProviderOptions = {}) {
 		this._config = options;
 	}
 
-	configure(config: ProvidertOptions = {}): ProvidertOptions {
+	configure(config: ProviderOptions = {}): ProviderOptions {
 		this._config = { ...config, ...this._config };
 
 		logger.debug(`configure ${this.getProviderName()}`, this._config);
@@ -37,20 +37,20 @@ export abstract class AbstractPubSubProvider implements PubSubProvider {
 
 	abstract getProviderName(): string;
 
-	protected get options(): ProvidertOptions {
+	protected get options(): ProviderOptions {
 		return { ...this._config };
 	}
 
-	public abstract newClient(clientOptions: ProvidertOptions): Promise<any>;
+	public abstract newClient(clientOptions: ProviderOptions): Promise<any>;
 
 	public abstract publish(
 		topics: string[] | string,
 		msg: any,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	): void;
 
 	public abstract subscribe(
 		topics: string[] | string,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	): Observable<any>;
 }

package/src/PubSub.ts

@@ -20,7 +20,7 @@ import {
 	INTERNAL_AWS_APPSYNC_PUBSUB_PROVIDER,
 	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
 } from '@aws-amplify/core';
-import { PubSubProvider, PubSubOptions, ProvidertOptions } from './types';
+import { PubSubProvider, PubSubOptions, ProviderOptions } from './types';
 import { AWSAppSyncProvider, AWSAppSyncRealTimeProvider } from './Providers';
 
 const { isNode } = browserOrNode();
@@ -34,12 +34,12 @@ export class PubSubClass {
 	/**
 	 * Internal instance of AWSAppSyncProvider used by the API category to subscribe to AppSync
 	 */
-	private _awsAppSyncProvider: AWSAppSyncProvider;
+	private _awsAppSyncProvider?: AWSAppSyncProvider;
 
 	/**
 	 * Internal instance of AWSAppSyncRealTimeProvider used by the API category to subscribe to AppSync
 	 */
-	private _awsAppSyncRealTimeProvider: AWSAppSyncRealTimeProvider;
+	private _awsAppSyncRealTimeProvider?: AWSAppSyncRealTimeProvider;
 
 	/**
 	 * Lazy instantiate AWSAppSyncProvider when it is required by the API category
@@ -68,8 +68,8 @@ export class PubSubClass {
 	 *
 	 * @param {PubSubOptions} options - Configuration object for PubSub
 	 */
-	constructor(options: PubSubOptions) {
-		this._options = options;
+	constructor(options?: PubSubOptions) {
+		this._options = options ?? {};
 		logger.debug('PubSub Options', this._options);
 		this._pluggables = [];
 		this.subscribe = this.subscribe.bind(this);
@@ -120,7 +120,7 @@ export class PubSubClass {
 		);
 	}
 
-	private getProviderByName(providerName) {
+	private getProviderByName(providerName: string | symbol) {
 		if (providerName === INTERNAL_AWS_APPSYNC_PUBSUB_PROVIDER) {
 			return this.awsAppSyncProvider;
 		}
@@ -133,7 +133,7 @@ export class PubSubClass {
 		);
 	}
 
-	private getProviders(options: ProvidertOptions = {}) {
+	private getProviders(options: ProviderOptions = {}) {
 		const { provider: providerName } = options;
 		if (!providerName) {
 			return this._pluggables;
@@ -150,7 +150,7 @@ export class PubSubClass {
 	async publish(
 		topics: string[] | string,
 		msg: any,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	) {
 		return Promise.all(
 			this.getProviders(options).map(provider =>
@@ -161,7 +161,7 @@ export class PubSubClass {
 
 	subscribe(
 		topics: string[] | string,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	): Observable<any> {
 		if (isNode && this._options && this._options.ssr) {
 			throw new Error(
@@ -194,5 +194,5 @@ export class PubSubClass {
 	}
 }
 
-export const PubSub = new PubSubClass(null);
+export const PubSub = new PubSubClass();
 Amplify.register(PubSub);

package/src/types/Provider.ts

@@ -11,7 +11,7 @@
  * and limitations under the License.
  */
 import Observable from 'zen-observable-ts';
-import { ProvidertOptions } from './PubSub';
+import { ProviderOptions } from './PubSub';
 
 export interface PubSubProvider {
 	// configure your provider
@@ -23,14 +23,10 @@ export interface PubSubProvider {
 	// return the name of you provider
 	getProviderName(): string;
 
-	publish(
-		topics: string[] | string,
-		msg: any,
-		options?: ProvidertOptions
-	): void;
+	publish(topics: string[] | string, msg: any, options?: ProviderOptions): void;
 
 	subscribe(
 		topics: string[] | string,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	): Observable<any>;
 }

package/src/types/PubSub.ts

@@ -14,6 +14,11 @@ export interface PubSubOptions {
 	[key: string]: any;
 }
 
-export interface ProvidertOptions {
+export interface ProviderOptions {
 	[key: string]: any;
 }
+
+/**
+ * @deprecated Migrated to ProviderOptions
+ */
+export type ProvidertOptions = ProviderOptions;