@fluidframework/container-loader 1.3.0 → 2.0.0-dev.1.4.5.105745

package/src/connectionManager.ts

@@ -31,7 +31,7 @@ import {
     waitForConnectedState,
     DeltaStreamConnectionForbiddenError,
     logNetworkFailure,
-    // isRuntimeMessage,
+    isRuntimeMessage,
 } from "@fluidframework/driver-utils";
 import {
     ConnectionMode,
@@ -97,7 +97,6 @@ class NoDeltaStream
     serviceConfiguration: IClientConfiguration = {
         maxMessageSize: 0,
         blockSize: 0,
-        summary: undefined as any,
     };
     checkpointSequenceNumber?: number | undefined = undefined;
     submit(messages: IDocumentMessage[]): void {
@@ -137,8 +136,8 @@ interface IPendingConnection {
 
 /**
  * Implementation of IConnectionManager, used by Container class
- * Implements constant connectivity to relay service, by reconnecting in case of loast connection or error.
- * Exposes various controls to influecen this process, including manual reconnects, forced read-only mode, etc.
+ * Implements constant connectivity to relay service, by reconnecting in case of lost connection or error.
+ * Exposes various controls to influence this process, including manual reconnects, forced read-only mode, etc.
  */
 export class ConnectionManager implements IConnectionManager {
     /** Connection mode used when reconnecting on error or disconnect. */
@@ -169,7 +168,7 @@ export class ConnectionManager implements IConnectionManager {
     private clientSequenceNumber = 0;
     private clientSequenceNumberObserved = 0;
     /** Counts the number of noops sent by the client which may not be acked. */
-    private trailingNoopCount = 0;
+    private localOpsToIgnore = 0;
 
     /** track clientId used last time when we sent any ops */
     private lastSubmittedClientId: string | undefined;
@@ -202,7 +201,7 @@ export class ConnectionManager implements IConnectionManager {
      * Automatic reconnecting enabled or disabled.
      * If set to Never, then reconnecting will never be allowed.
      */
-     public get reconnectMode(): ReconnectMode {
+    public get reconnectMode(): ReconnectMode {
         return this._reconnectMode;
     }
 
@@ -234,21 +233,19 @@ export class ConnectionManager implements IConnectionManager {
      * Returns set of props that can be logged in telemetry that provide some insights / statistics
      * about current or last connection (if there is no connection at the moment)
     */
-     public get connectionProps(): ITelemetryProperties {
-        if (this.connection !== undefined) {
-            return this._connectionProps;
-        } else {
-            return {
+    public get connectionProps(): ITelemetryProperties {
+        return this.connection !== undefined
+            ? this._connectionProps
+            : {
                 ...this._connectionProps,
                 // Report how many ops this client sent in last disconnected session
                 sentOps: this.clientSequenceNumber,
             };
-        }
     }
 
     public shouldJoinWrite(): boolean {
         // We don't have to wait for ack for topmost NoOps. So subtract those.
-        return this.clientSequenceNumberObserved < (this.clientSequenceNumber - this.trailingNoopCount);
+        return this.clientSequenceNumberObserved < (this.clientSequenceNumber - this.localOpsToIgnore);
     }
 
     /**
@@ -379,7 +376,7 @@ export class ConnectionManager implements IConnectionManager {
      *
      * @param readonly - set or clear force readonly.
      */
-     public forceReadonly(readonly: boolean) {
+    public forceReadonly(readonly: boolean) {
         if (readonly !== this._forceReadonly) {
             this.logger.sendTelemetryEvent({
                 eventName: "ForceReadOnly",
@@ -568,11 +565,11 @@ export class ConnectionManager implements IConnectionManager {
     }
 
     /**
-     * Start the connection. Any error should result in container being close.
-     * And report the error if it excape for any reason.
+     * Start the connection. Any error should result in container being closed.
+     * And report the error if it escapes for any reason.
      * @param args - The connection arguments
      */
-     private triggerConnect(connectionMode: ConnectionMode) {
+    private triggerConnect(connectionMode: ConnectionMode) {
         assert(this.connection === undefined, 0x239 /* "called only in disconnected state" */);
         if (this.reconnectMode !== ReconnectMode.Enabled) {
             return;
@@ -585,7 +582,7 @@ export class ConnectionManager implements IConnectionManager {
      * @param reason - Text description of disconnect reason to emit with disconnect event
      * @returns A boolean that indicates if there was an existing connection (or pending connection) to disconnect
      */
-     private disconnectFromDeltaStream(reason: string): boolean {
+    private disconnectFromDeltaStream(reason: string): boolean {
         this.pendingReconnect = false;
 
         if (this.connection === undefined) {
@@ -638,7 +635,7 @@ export class ConnectionManager implements IConnectionManager {
      * initial messages.
      * @param connection - The newly established connection
      */
-     private setupNewSuccessfulConnection(connection: IDocumentDeltaConnection, requestedMode: ConnectionMode) {
+    private setupNewSuccessfulConnection(connection: IDocumentDeltaConnection, requestedMode: ConnectionMode) {
         // Old connection should have been cleaned up before establishing a new one
         assert(this.connection === undefined, 0x0e6 /* "old connection exists on new connection setup" */);
         assert(!connection.disposed, 0x28a /* "can't be disposed - Callers need to ensure that!" */);
@@ -736,7 +733,7 @@ export class ConnectionManager implements IConnectionManager {
      * @param error - Error reconnect information including whether or not to reconnect
      * @returns A promise that resolves when the connection is reestablished or we stop trying
      */
-     private reconnectOnError(
+    private reconnectOnError(
         requestedMode: ConnectionMode,
         error: IAnyDriverError,
     ) {
@@ -744,7 +741,7 @@ export class ConnectionManager implements IConnectionManager {
             requestedMode,
             error.message,
             error)
-        .catch(this.props.closeHandler);
+            .catch(this.props.closeHandler);
     }
 
     /**
@@ -773,7 +770,7 @@ export class ConnectionManager implements IConnectionManager {
             this.logger.sendTelemetryEvent({
                 eventName: "reconnectingDespiteFatalError",
                 reconnectMode: this.reconnectMode,
-             }, error);
+            }, error);
         }
 
         if (this.reconnectMode === ReconnectMode.Never) {
@@ -820,10 +817,10 @@ export class ConnectionManager implements IConnectionManager {
             this.clientSequenceNumberObserved = 0;
         }
 
-        if (message.type === MessageType.NoOp) {
-            this.trailingNoopCount++;
+        if (!isRuntimeMessage(message)) {
+            this.localOpsToIgnore++;
         } else {
-            this.trailingNoopCount = 0;
+            this.localOpsToIgnore = 0;
         }
 
         return {
@@ -858,8 +855,7 @@ export class ConnectionManager implements IConnectionManager {
                             "Switch to write", // message
                         );
                     }
-                })
-                .catch(() => {});
+                }).catch(() => { });
             }
             return;
         }

package/src/connectionState.ts

@@ -17,12 +17,6 @@ export enum ConnectionState {
      */
     EstablishingConnection = 3,
 
-    /**
-     * See {@link ConnectionState.CatchingUp}, which is the new name for this state.
-     * @deprecated - This state itself is not gone, just being renamed. Please use {@link ConnectionState.CatchingUp}.
-     */
-    Connecting = 1,
-
     /**
      * The container has an inbound connection only, and is catching up to the latest known state from the service.
      */