@aws-amplify/pubsub 4.4.9 → 4.4.10-next.20

package/src/index.ts

@@ -14,18 +14,11 @@ import { PubSub } from './PubSub';
 
 export * from './Providers';
 
-enum CONTROL_MSG {
-	CONNECTION_CLOSED = 'Connection closed',
-	CONNECTION_FAILED = 'Connection failed',
-	REALTIME_SUBSCRIPTION_INIT_ERROR = 'AppSync Realtime subscription init error',
-	SUBSCRIPTION_ACK = 'Subscription ack',
-	TIMEOUT_DISCONNECT = 'Timeout disconnect',
-}
+export { CONNECTION_STATE_CHANGE } from './Providers/constants';
 
-export const CONNECTION_STATE_CHANGE = 'ConnectionStateChange';
-export { ConnectionState } from './types';
+export { ConnectionState, CONTROL_MSG } from './types';
 
-export { PubSub, CONTROL_MSG };
+export { PubSub };
 
 /**
  * @deprecated use named import

package/src/types/Provider.ts

@@ -11,7 +11,19 @@
  * and limitations under the License.
  */
 import Observable from 'zen-observable-ts';
-import { ProviderOptions } from './PubSub';
+
+export interface PubSubOptions {
+	[key: string]: any;
+}
+
+export interface ProviderOptions {
+	[key: string]: any;
+}
+
+/**
+ * @deprecated Migrated to ProviderOptions
+ */
+export type ProvidertOptions = ProviderOptions;
 
 export interface PubSubProvider {
 	// configure your provider

package/src/types/PubSub.ts

@@ -10,15 +10,54 @@
  * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
  * and limitations under the License.
  */
-export interface PubSubOptions {
-	[key: string]: any;
+
+export interface SubscriptionObserver<T> {
+	closed: boolean;
+	next(value: T): void;
+	error(errorValue: any): void;
+	complete(): void;
 }
 
-export interface ProviderOptions {
-	[key: string]: any;
+export enum CONTROL_MSG {
+	CONNECTION_CLOSED = 'Connection closed',
+	CONNECTION_FAILED = 'Connection failed',
+	REALTIME_SUBSCRIPTION_INIT_ERROR = 'AppSync Realtime subscription init error',
+	SUBSCRIPTION_ACK = 'Subscription ack',
+	TIMEOUT_DISCONNECT = 'Timeout disconnect',
 }
 
-/**
- * @deprecated Migrated to ProviderOptions
- */
-export type ProvidertOptions = ProviderOptions;
+/** @enum {string} */
+export enum ConnectionState {
+	/*
+	 * The connection is alive and healthy
+	 */
+	Connected = 'Connected',
+	/*
+	 * The connection is alive, but the connection is offline
+	 */
+	ConnectedPendingNetwork = 'ConnectedPendingNetwork',
+	/*
+	 * The connection has been disconnected while in use
+	 */
+	ConnectionDisrupted = 'ConnectionDisrupted',
+	/*
+	 * The connection has been disconnected and the network is offline
+	 */
+	ConnectionDisruptedPendingNetwork = 'ConnectionDisruptedPendingNetwork',
+	/*
+	 * The connection is in the process of connecting
+	 */
+	Connecting = 'Connecting',
+	/*
+	 * The connection is not in use and is being disconnected
+	 */
+	ConnectedPendingDisconnect = 'ConnectedPendingDisconnect',
+	/*
+	 * The connection is not in use and has been disconnected
+	 */
+	Disconnected = 'Disconnected',
+	/*
+	 * The connection is alive, but a keep alive message has been missed
+	 */
+	ConnectedPendingKeepAlive = 'ConnectedPendingKeepAlive',
+}

package/src/types/index.ts

@@ -12,46 +12,3 @@
  */
 export * from './Provider';
 export * from './PubSub';
-
-export interface SubscriptionObserver<T> {
-	closed: boolean;
-	next(value: T): void;
-	error(errorValue: any): void;
-	complete(): void;
-}
-
-/** @enum {string} */
-export enum ConnectionState {
-	/*
-	 * The connection is alive and healthy
-	 */
-	Connected = 'Connected',
-	/*
-	 * The connection is alive, but the connection is offline
-	 */
-	ConnectedPendingNetwork = 'ConnectedPendingNetwork',
-	/*
-	 * The connection has been disconnected while in use
-	 */
-	ConnectionDisrupted = 'ConnectionDisrupted',
-	/*
-	 * The connection has been disconnected and the network is offline
-	 */
-	ConnectionDisruptedPendingNetwork = 'ConnectionDisruptedPendingNetwork',
-	/*
-	 * The connection is in the process of connecting
-	 */
-	Connecting = 'Connecting',
-	/*
-	 * The connection is not in use and is being disconnected
-	 */
-	ConnectedPendingDisconnect = 'ConnectedPendingDisconnect',
-	/*
-	 * The connection is not in use and has been disconnected
-	 */
-	Disconnected = 'Disconnected',
-	/*
-	 * The connection is alive, but a keep alive message has been missed
-	 */
-	ConnectedPendingKeepAlive = 'ConnectedPendingKeepAlive',
-}

package/src/utils/ConnectionStateMonitor.ts

@@ -13,7 +13,8 @@
 
 import { Reachability } from '@aws-amplify/core';
 import Observable, { ZenObservable } from 'zen-observable-ts';
-import { ConnectionState } from '../index';
+import { ConnectionState } from '../types/PubSub';
+import { ReachabilityMonitor } from './ReachabilityMonitor';
 
 // Internal types for tracking different connection states
 type LinkedConnectionState = 'connected' | 'disconnected';
@@ -62,6 +63,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;
@@ -72,6 +74,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);
@@ -83,15 +95,18 @@ 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 = new Reachability()
-				.networkMonitor()
-				.subscribe(({ online }) => {
+			this._networkMonitoringSubscription = ReachabilityMonitor().subscribe(
+				({ online }) => {
 					this.record(
 						online ? CONNECTION_CHANGE.ONLINE : CONNECTION_CHANGE.OFFLINE
 					);
-				});
+				}
+			);
 		}
 	}
 

package/src/utils/ReachabilityMonitor/index.native.ts

@@ -0,0 +1,5 @@
+import { Reachability } from '@aws-amplify/core';
+import { default as NetInfo } from '@react-native-community/netinfo';
+
+export const ReachabilityMonitor = () =>
+	new Reachability().networkMonitor(NetInfo);

package/src/utils/ReachabilityMonitor/index.ts

@@ -0,0 +1,3 @@
+import { Reachability } from '@aws-amplify/core';
+
+export const ReachabilityMonitor = () => new Reachability().networkMonitor();

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/lib/Providers/AWSAppSyncRealTimeProvider/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/Providers/AWSAppSyncRealTimeProvider/constants.ts"],"names":[],"mappings":";;AAAa,QAAA,YAAY,GAAG,IAAI,CAAC;AAEpB,QAAA,mBAAmB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAEnD,IAAY,aAmDX;AAnDD,WAAY,aAAa;IACxB;;;OAGG;IACH,wDAAuC,CAAA;IACvC;;;OAGG;IACH,0DAAyC,CAAA;IACzC;;;OAGG;IACH,sDAAqC,CAAA;IACrC;;;OAGG;IACH,oCAAmB,CAAA;IACnB;;;OAGG;IACH,4CAA2B,CAAA;IAC3B;;;OAGG;IACH,kCAAiB,CAAA;IACjB;;;OAGG;IACH,iDAAgC,CAAA;IAChC;;;OAGG;IACH,kCAAiB,CAAA;IACjB;;;OAGG;IACH,0CAAyB,CAAA;IACzB;;;OAGG;IACH,oCAAmB,CAAA;AACpB,CAAC,EAnDW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAmDxB;AAED,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC9B,mEAAO,CAAA;IACP,uEAAS,CAAA;IACT,iEAAM,CAAA;AACP,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACxB,qDAAM,CAAA;IACN,mDAAK,CAAA;IACL,6DAAU,CAAA;AACX,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAEY,QAAA,cAAc,GAAG,CAC7B,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU;IAChE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAC/B,CAAC,CAAC,mBAAmB,CACZ,CAAC;AAEC,QAAA,4BAA4B,GAAG;IAC3C,MAAM,EAAE,mCAAmC;IAC3C,kBAAkB,EAAE,SAAS;IAC7B,cAAc,EAAE,iCAAiC;CACjD,CAAC;AAEF;;GAEG;AACU,QAAA,uBAAuB,GAAG,KAAK,CAAC;AAE7C;;GAEG;AACU,QAAA,iBAAiB,GAAG,KAAK,CAAC;AAEvC;;GAEG;AACU,QAAA,0BAA0B,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAExD;;GAEG;AACU,QAAA,gCAAgC,GAAG,EAAE,GAAG,IAAI,CAAC"}

package/lib-esm/Providers/AWSAppSyncRealTimeProvider/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/Providers/AWSAppSyncRealTimeProvider/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,YAAY,GAAG,IAAI,CAAC;AAEjC,MAAM,CAAC,IAAM,mBAAmB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAEnD,MAAM,CAAN,IAAY,aAmDX;AAnDD,WAAY,aAAa;IACxB;;;OAGG;IACH,wDAAuC,CAAA;IACvC;;;OAGG;IACH,0DAAyC,CAAA;IACzC;;;OAGG;IACH,sDAAqC,CAAA;IACrC;;;OAGG;IACH,oCAAmB,CAAA;IACnB;;;OAGG;IACH,4CAA2B,CAAA;IAC3B;;;OAGG;IACH,kCAAiB,CAAA;IACjB;;;OAGG;IACH,iDAAgC,CAAA;IAChC;;;OAGG;IACH,kCAAiB,CAAA;IACjB;;;OAGG;IACH,0CAAyB,CAAA;IACzB;;;OAGG;IACH,oCAAmB,CAAA;AACpB,CAAC,EAnDW,aAAa,KAAb,aAAa,QAmDxB;AAED,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC9B,mEAAO,CAAA;IACP,uEAAS,CAAA;IACT,iEAAM,CAAA;AACP,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AAED,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACxB,qDAAM,CAAA;IACN,mDAAK,CAAA;IACL,6DAAU,CAAA;AACX,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAED,MAAM,CAAC,IAAM,cAAc,GAAG,CAC7B,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU;IAChE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAC/B,CAAC,CAAC,mBAAmB,CACZ,CAAC;AAEZ,MAAM,CAAC,IAAM,4BAA4B,GAAG;IAC3C,MAAM,EAAE,mCAAmC;IAC3C,kBAAkB,EAAE,SAAS;IAC7B,cAAc,EAAE,iCAAiC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,IAAM,uBAAuB,GAAG,KAAK,CAAC;AAE7C;;GAEG;AACH,MAAM,CAAC,IAAM,iBAAiB,GAAG,KAAK,CAAC;AAEvC;;GAEG;AACH,MAAM,CAAC,IAAM,0BAA0B,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAExD;;GAEG;AACH,MAAM,CAAC,IAAM,gCAAgC,GAAG,EAAE,GAAG,IAAI,CAAC"}