@aws-amplify/pubsub 4.5.11 → 4.5.12-unstable.2

package/src/Providers/index.ts

@@ -1,17 +1,15 @@
-/*
- * 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';
+// 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';

package/src/PubSub.ts

@@ -1,15 +1,5 @@
-/*
- * 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.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 // import '../Common/Polyfills';
 import Observable from 'zen-observable-ts';
 

package/src/index.ts

@@ -1,26 +1,18 @@
-/*
- * 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';
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 
+export { PubSub } from './PubSub';
 export { CONNECTION_STATE_CHANGE } from './Providers/constants';
-
 export { ConnectionState, CONTROL_MSG } from './types';
-
-export { PubSub };
-
-/**
- * @deprecated use named import
- */
-export default PubSub;
+export {
+	AWSAppSyncProvider,
+	AWSAppSyncRealTimeProvider,
+	AWSAppSyncRealTimeProviderOptions,
+	AWSIoTProvider,
+	AWSIoTProviderOptions,
+	AbstractPubSubProvider,
+	MqttOverWSProvider,
+	MqttProviderOptions,
+	ObserverQuery,
+	mqttTopicMatch,
+} from './Providers';

package/src/types/Provider.ts

@@ -1,15 +1,5 @@
-/*
- * 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.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import Observable from 'zen-observable-ts';
 
 export interface PubSubOptions {
@@ -20,11 +10,6 @@ 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,15 +1,5 @@
-/*
- * 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.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 
 export interface SubscriptionObserver<T> {
 	closed: boolean;

package/src/types/index.ts

@@ -1,14 +1,4 @@
-/*
- * 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.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export * from './Provider';
 export * from './PubSub';

package/src/utils/ConnectionStateMonitor.ts

@@ -1,15 +1,5 @@
-/*
- * 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.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 
 import { Reachability } from '@aws-amplify/core';
 import Observable, { ZenObservable } from 'zen-observable-ts';
@@ -63,6 +53,7 @@ export class ConnectionStateMonitor {
 	private _linkedConnectionStateObservable: Observable<LinkedConnectionStates>;
 	private _linkedConnectionStateObserver: ZenObservable.SubscriptionObserver<LinkedConnectionStates>;
 	private _networkMonitoringSubscription?: ZenObservable.Subscription;
+	private _initialNetworkStateSubscription?: ZenObservable.Subscription;
 
 	constructor() {
 		this._networkMonitoringSubscription = undefined;
@@ -73,6 +64,16 @@ 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);
@@ -84,6 +85,9 @@ 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/src/utils/ReconnectionMonitor.ts

@@ -0,0 +1,74 @@
+import { Observer } from 'zen-observable-ts';
+import { RECONNECT_DELAY, RECONNECT_INTERVAL } from '../Providers/constants';
+
+export enum ReconnectEvent {
+	START_RECONNECT = 'START_RECONNECT',
+	HALT_RECONNECT = 'HALT_RECONNECT',
+}
+
+/**
+ * Captures the reconnect event logic used to determine when to reconnect to PubSub providers.
+ *   Reconnnect attempts are delayed by 5 seconds to let the interface settle.
+ *   Attempting to reconnect only once creates unrecoverable states when the network state isn't
+ *   supported by the browser, so this keeps retrying every minute until halted.
+ */
+export class ReconnectionMonitor {
+	private reconnectObservers: Observer<void>[] = [];
+	private reconnectIntervalId?: ReturnType<typeof setInterval>;
+	private reconnectSetTimeoutId?: ReturnType<typeof setTimeout>;
+
+	/**
+	 * Add reconnect observer to the list of observers to alert on reconnect
+	 */
+	addObserver(reconnectObserver: Observer<void>) {
+		this.reconnectObservers.push(reconnectObserver);
+	}
+
+	/**
+	 * Given a reconnect event, start the appropriate behavior
+	 */
+	record(event: ReconnectEvent) {
+		if (event === ReconnectEvent.START_RECONNECT) {
+			// If the reconnection hasn't been started
+			if (
+				this.reconnectSetTimeoutId === undefined &&
+				this.reconnectIntervalId === undefined
+			) {
+				this.reconnectSetTimeoutId = setTimeout(() => {
+					// Reconnect now
+					this._triggerReconnect();
+					// Retry reconnect every periodically until it works
+					this.reconnectIntervalId = setInterval(() => {
+						this._triggerReconnect();
+					}, RECONNECT_INTERVAL);
+				}, RECONNECT_DELAY);
+			}
+		}
+
+		if (event === ReconnectEvent.HALT_RECONNECT) {
+			if (this.reconnectIntervalId) {
+				clearInterval(this.reconnectIntervalId);
+				this.reconnectIntervalId = undefined;
+			}
+			if (this.reconnectSetTimeoutId) {
+				clearTimeout(this.reconnectSetTimeoutId);
+				this.reconnectSetTimeoutId = undefined;
+			}
+		}
+	}
+
+	/**
+	 * Complete all reconnect observers
+	 */
+	close() {
+		this.reconnectObservers.forEach(reconnectObserver => {
+			reconnectObserver.complete?.();
+		});
+	}
+
+	private _triggerReconnect() {
+		this.reconnectObservers.forEach(reconnectObserver => {
+			reconnectObserver.next?.();
+		});
+	}
+}

package/build.js

@@ -1,5 +0,0 @@
-'use strict';
-
-const build = require('../../scripts/build');
-
-build(process.argv[2], process.argv[3]);