@aws-amplify/pubsub 4.5.12-unstable.4 → 4.5.13

package/src/Providers/AWSIotProvider.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 import { MqttOverWSProvider, MqttProviderOptions } from './MqttOverWSProvider';
 import { Signer, Credentials } from '@aws-amplify/core';
 

package/src/Providers/MqttOverWSProvider.ts

@@ -1,21 +1,27 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 import * as Paho from 'paho-mqtt';
 import { v4 as uuid } from 'uuid';
-import Observable, { ZenObservable } from 'zen-observable-ts';
+import Observable from 'zen-observable-ts';
 
 import { AbstractPubSubProvider } from './PubSubProvider';
-import { SubscriptionObserver, ConnectionState } from '../types/PubSub';
+import { SubscriptionObserver } from '../types/PubSub';
 import { ProviderOptions } from '../types/Provider';
 import { ConsoleLogger as Logger, Hub } from '@aws-amplify/core';
 import {
 	ConnectionStateMonitor,
 	CONNECTION_CHANGE,
 } from '../utils/ConnectionStateMonitor';
-import {
-	ReconnectEvent,
-	ReconnectionMonitor,
-} from '../utils/ReconnectionMonitor';
 import { AMPLIFY_SYMBOL, CONNECTION_STATE_CHANGE } from './constants';
 
 const logger = new Logger('MqttOverWSProvider');
@@ -39,20 +45,27 @@ export interface MqttProviderOptions extends ProviderOptions {
 	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?: (input: string) => Promise<any>) {
 		const cachedPromise = this.promises.get(clientId);
-		if (cachedPromise) return cachedPromise;
+		if (cachedPromise) {
+			return cachedPromise;
+		}
 
 		if (clientFactory) {
 			const newPromise = clientFactory(clientId);
+
 			this.promises.set(clientId, newPromise);
-			newPromise.catch(v => this.promises.delete(clientId));
+
 			return newPromise;
 		}
-
 		return undefined;
 	}
 
@@ -73,9 +86,7 @@ const topicSymbol = typeof Symbol !== 'undefined' ? Symbol('topic') : '@@topic';
 
 export class MqttOverWSProvider extends AbstractPubSubProvider {
 	private _clientsQueue = new ClientsQueue();
-	private connectionState: ConnectionState;
 	private readonly connectionStateMonitor = new ConnectionStateMonitor();
-	private readonly reconnectionMonitor = new ReconnectionMonitor();
 
 	constructor(options: MqttProviderOptions = {}) {
 		super({ ...options, clientId: options.clientId || uuid() });
@@ -91,16 +102,6 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 					},
 					`Connection state is ${connectionStateChange}`
 				);
-
-				this.connectionState = connectionStateChange;
-
-				// Trigger reconnection when the connection is disrupted
-				if (connectionStateChange === ConnectionState.ConnectionDisrupted) {
-					this.reconnectionMonitor.record(ReconnectEvent.START_RECONNECT);
-				} else if (connectionStateChange !== ConnectionState.Connecting) {
-					// Trigger connected to halt reconnection attempts
-					this.reconnectionMonitor.record(ReconnectEvent.HALT_RECONNECT);
-				}
 			}
 		);
 	}
@@ -141,6 +142,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 		if (errorCode !== 0) {
 			logger.warn(clientId, JSON.stringify({ errorCode, ...args }, null, 2));
 
+			const topicsToDelete: string[] = [];
 			if (!clientId) {
 				return;
 			}
@@ -148,7 +150,24 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 			if (!clientIdObservers) {
 				return;
 			}
-			this.disconnect(clientId);
+			clientIdObservers.forEach(observer => {
+				observer.error('Disconnected, error code: ' + errorCode);
+				// removing observers for disconnected clientId
+				this._topicObservers.forEach((observerForTopic, observerTopic) => {
+					observerForTopic.delete(observer);
+					if (observerForTopic.size === 0) {
+						topicsToDelete.push(observerTopic);
+					}
+				});
+			});
+
+			// forgiving any trace of clientId
+			this._clientIdObservers.delete(clientId);
+
+			// Removing topics that are not listen by an observer
+			topicsToDelete.forEach(topic => {
+				this._topicObservers.delete(topic);
+			});
 		}
 	}
 
@@ -158,7 +177,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 		this.connectionStateMonitor.record(CONNECTION_CHANGE.OPENING_CONNECTION);
 		// @ts-ignore
 		const client = new Paho.Client(url, clientId);
-
+		// client.trace = (args) => logger.debug(clientId, JSON.stringify(args, null, 2));
 		client.onMessageArrived = ({
 			destinationName: topic,
 			payloadString: msg,
@@ -178,24 +197,23 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 		};
 
-		const connected = await new Promise((resolve, reject) => {
+		await new Promise((resolve, reject) => {
 			client.connect({
 				useSSL: this.isSSLEnabled,
 				mqttVersion: 3,
-				onSuccess: () => resolve(true),
-				onFailure: x => {
-					if (clientId) this._clientsQueue.remove(clientId);
-					this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
-					resolve(false);
+				onSuccess: () => resolve(client),
+				onFailure: () => {
+					reject();
+					this.connectionStateMonitor.record(
+						CONNECTION_CHANGE.CONNECTION_FAILED
+					);
 				},
 			});
 		});
 
-		if (connected) {
-			this.connectionStateMonitor.record(
-				CONNECTION_CHANGE.CONNECTION_ESTABLISHED
-			);
-		}
+		this.connectionStateMonitor.record(
+			CONNECTION_CHANGE.CONNECTION_ESTABLISHED
+		);
 
 		return client;
 	}
@@ -204,19 +222,9 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 		clientId: string,
 		options: MqttProviderOptions = {}
 	): Promise<any> {
-		return await this.clientsQueue.get(clientId, async clientId => {
-			const client = await this.newClient({ ...options, clientId });
-
-			if (client) {
-				// Once connected, subscribe to all topics registered observers
-				this._topicObservers.forEach(
-					(_value: Set<SubscriptionObserver<any>>, key: string) => {
-						client.subscribe(key);
-					}
-				);
-			}
-			return client;
-		});
+		return await this.clientsQueue.get(clientId, clientId =>
+			this.newClient({ ...options, clientId })
+		);
 	}
 
 	protected async disconnect(clientId: string): Promise<void> {
@@ -224,27 +232,21 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 
 		if (client && client.isConnected()) {
 			client.disconnect();
+			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 		}
 		this.clientsQueue.remove(clientId);
-		this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 	}
 
 	async publish(topics: string[] | string, msg: any) {
 		const targetTopics = ([] as string[]).concat(topics);
 		const message = JSON.stringify(msg);
 
-		const client = await this.clientsQueue.get(this.clientId);
-
-		if (client) {
-			logger.debug('Publishing to topic(s)', targetTopics.join(','), message);
-			targetTopics.forEach(topic => client.send(topic, message));
-		} else {
-			logger.debug(
-				'Publishing to topic(s) failed',
-				targetTopics.join(','),
-				message
-			);
-		}
+		const url = await this.endpoint;
+
+		const client = await this.connect(this.clientId, { url });
+
+		logger.debug('Publishing to topic(s)', targetTopics.join(','), message);
+		targetTopics.forEach(topic => client.send(topic, message));
 	}
 
 	protected _topicObservers: Map<string, Set<SubscriptionObserver<any>>> =
@@ -281,7 +283,6 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 	): Observable<any> {
 		const targetTopics = ([] as string[]).concat(topics);
 		logger.debug('Subscribing to topic(s)', targetTopics.join(','));
-		let reconnectSubscription: ZenObservable.Subscription;
 
 		return new Observable(observer => {
 			targetTopics.forEach(topic => {
@@ -297,6 +298,8 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 				observersForTopic.add(observer);
 			});
 
+			// @ts-ignore
+			let client: Paho.Client;
 			const { clientId = this.clientId } = options;
 
 			// this._clientIdObservers is used to close observers when client gets disconnected
@@ -308,44 +311,30 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 			this._clientIdObservers.set(clientId, observersForClientId);
 
 			(async () => {
-				const getClient = async () => {
-					try {
-						const { url = await this.endpoint } = options;
-						const client = await this.connect(clientId, { url });
-						if (client !== undefined) {
-							targetTopics.forEach(topic => {
-								client.subscribe(topic);
-							});
-						}
-					} catch (e) {
-						logger.debug('Error forming connection', e);
-					}
-				};
+				const { url = await this.endpoint } = options;
 
-				// Establish the initial connection
-				await getClient();
-
-				// Add an observable to the reconnection list to manage reconnection for this subscription
-				reconnectSubscription = new Observable(observer => {
-					this.reconnectionMonitor.addObserver(observer);
-				}).subscribe(() => {
-					getClient();
-				});
+				try {
+					client = await this.connect(clientId, { url });
+					targetTopics.forEach(topic => {
+						client.subscribe(topic);
+					});
+				} catch (e) {
+					observer.error(e);
+				}
 			})();
 
-			return async () => {
-				const client = await this.clientsQueue.get(clientId);
-
-				reconnectSubscription?.unsubscribe();
+			return () => {
+				logger.debug('Unsubscribing from topic(s)', targetTopics.join(','));
 
 				if (client) {
 					this._clientIdObservers.get(clientId)?.delete(observer);
 					// No more observers per client => client not needed anymore
 					if (this._clientIdObservers.get(clientId)?.size === 0) {
-						this.disconnect(clientId);
 						this.connectionStateMonitor.record(
 							CONNECTION_CHANGE.CLOSING_CONNECTION
 						);
+
+						this.disconnect(clientId);
 						this._clientIdObservers.delete(clientId);
 					}
 

package/src/Providers/PubSubProvider.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 import Observable from 'zen-observable-ts';
 import { PubSubProvider, ProviderOptions } from '../types/Provider';
 import { ConsoleLogger as Logger } from '@aws-amplify/core';

package/src/Providers/constants.ts

@@ -100,13 +100,3 @@ export const DEFAULT_KEEP_ALIVE_TIMEOUT = 5 * 60 * 1000;
  * Default Time in milleseconds to alert for missed GQL_CONNECTION_KEEP_ALIVE message
  */
 export const DEFAULT_KEEP_ALIVE_ALERT_TIMEOUT = 65 * 1000;
-
-/**
- * Default delay time in milleseconds between when reconnect is triggered vs when it is attempted
- */
-export const RECONNECT_DELAY = 5 * 1000;
-
-/**
- * Default interval time in milleseconds between when reconnect is re-attempted
- */
-export const RECONNECT_INTERVAL = 60 * 1000;

package/src/Providers/index.ts

@@ -1,15 +1,17 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export { AbstractPubSubProvider } from './PubSubProvider';
-export { AWSAppSyncProvider } from './AWSAppSyncProvider';
-export {
-	AWSAppSyncRealTimeProvider,
-	AWSAppSyncRealTimeProviderOptions,
-	ObserverQuery,
-} from './AWSAppSyncRealTimeProvider';
-export { AWSIoTProvider, AWSIoTProviderOptions } from './AWSIotProvider';
-export {
-	MqttProviderOptions,
-	MqttOverWSProvider,
-	mqttTopicMatch,
-} from './MqttOverWSProvider';
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+export * from './PubSubProvider';
+export * from './AWSAppSyncProvider';
+export * from './AWSAppSyncRealTimeProvider';
+export * from './AWSIotProvider';
+export * from './MqttOverWSProvider';

package/src/PubSub.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 // import '../Common/Polyfills';
 import Observable from 'zen-observable-ts';
 

package/src/index.ts

@@ -1,18 +1,26 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+import { PubSub } from './PubSub';
+
+export * from './Providers';
 
-export { PubSub } from './PubSub';
 export { CONNECTION_STATE_CHANGE } from './Providers/constants';
+
 export { ConnectionState, CONTROL_MSG } from './types';
-export {
-	AWSAppSyncProvider,
-	AWSAppSyncRealTimeProvider,
-	AWSAppSyncRealTimeProviderOptions,
-	AWSIoTProvider,
-	AWSIoTProviderOptions,
-	AbstractPubSubProvider,
-	MqttOverWSProvider,
-	MqttProviderOptions,
-	ObserverQuery,
-	mqttTopicMatch,
-} from './Providers';
+
+export { PubSub };
+
+/**
+ * @deprecated use named import
+ */
+export default PubSub;

package/src/types/Provider.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 import Observable from 'zen-observable-ts';
 
 export interface PubSubOptions {
@@ -10,6 +20,11 @@ export interface ProviderOptions {
 	[key: string]: any;
 }
 
+/**
+ * @deprecated Migrated to ProviderOptions
+ */
+export type ProvidertOptions = ProviderOptions;
+
 export interface PubSubProvider {
 	// configure your provider
 	configure(config: object): object;

package/src/types/PubSub.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 
 export interface SubscriptionObserver<T> {
 	closed: boolean;

package/src/types/index.ts

@@ -1,4 +1,14 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 export * from './Provider';
 export * from './PubSub';

package/src/utils/ConnectionStateMonitor.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 
 import { Reachability } from '@aws-amplify/core';
 import Observable, { ZenObservable } from 'zen-observable-ts';
@@ -53,7 +63,6 @@ export class ConnectionStateMonitor {
 	private _linkedConnectionStateObservable: Observable<LinkedConnectionStates>;
 	private _linkedConnectionStateObserver: ZenObservable.SubscriptionObserver<LinkedConnectionStates>;
 	private _networkMonitoringSubscription?: ZenObservable.Subscription;
-	private _initialNetworkStateSubscription?: ZenObservable.Subscription;
 
 	constructor() {
 		this._networkMonitoringSubscription = undefined;
@@ -64,16 +73,6 @@ export class ConnectionStateMonitor {
 			keepAliveState: 'healthy',
 		};
 
-		// Attempt to update the state with the current actual network state
-		this._initialNetworkStateSubscription = ReachabilityMonitor().subscribe(
-			({ online }) => {
-				this.record(
-					online ? CONNECTION_CHANGE.ONLINE : CONNECTION_CHANGE.OFFLINE
-				);
-				this._initialNetworkStateSubscription?.unsubscribe();
-			}
-		);
-
 		this._linkedConnectionStateObservable =
 			new Observable<LinkedConnectionStates>(connectionStateObserver => {
 				connectionStateObserver.next(this._linkedConnectionState);
@@ -85,9 +84,6 @@ export class ConnectionStateMonitor {
 	 * Turn network state monitoring on if it isn't on already
 	 */
 	private enableNetworkMonitoring() {
-		// If no initial network state was discovered, stop trying
-		this._initialNetworkStateSubscription?.unsubscribe();
-
 		// Maintain the network state based on the reachability monitor
 		if (this._networkMonitoringSubscription === undefined) {
 			this._networkMonitoringSubscription = ReachabilityMonitor().subscribe(

package/webpack.config.dev.js

@@ -0,0 +1,6 @@
+var config = require('./webpack.config.js');
+
+var entry = {
+	'aws-amplify-pubsub': './lib-esm/index.js',
+};
+module.exports = Object.assign(config, { entry, mode: 'development' });

package/lib/.tsbuildinfo

@@ -1,3 +0,0 @@
-{
-  "version": "3.8.3"
-}

package/lib/Providers/AWSAppSyncProvider.d.ts

@@ -1,21 +0,0 @@
-import Observable from 'zen-observable-ts';
-import { MqttOverWSProvider } from './MqttOverWSProvider';
-/**
- * @deprecated Unused, all usecases have migrated to AWSAppSyncRealtimeProvider
- */
-export declare class AWSAppSyncProvider extends MqttOverWSProvider {
-    protected get endpoint(): void;
-    getProviderName(): string;
-    publish(topics: string[] | string, msg: any, options?: any): Promise<void>;
-    private _cleanUp;
-    private _cleanUpForTopic;
-    onDisconnect({ clientId, errorCode, ...args }: {
-        [x: string]: any;
-        clientId: any;
-        errorCode: any;
-    }): void;
-    private _topicClient;
-    private _topicAlias;
-    protected disconnect(clientId: string): Promise<void>;
-    subscribe(topics: string[] | string, options?: any): Observable<any>;
-}