@fluidframework/container-loader 2.0.0-dev.6.4.0.191515 → 2.0.0-dev.7.2.0.203917

package/lib/connectionManager.js

@@ -4,9 +4,12 @@
  */
 import { assert } from "@fluidframework/core-utils";
 import { performance, TypedEventEmitter } from "@fluid-internal/client-utils";
+import { 
+// eslint-disable-next-line import/no-deprecated
+DriverErrorType, } from "@fluidframework/driver-definitions";
 import { canRetryOnError, createWriteError, createGenericNetworkError, getRetryDelayFromError, logNetworkFailure, isRuntimeMessage, calculateMaxWaitTime, } from "@fluidframework/driver-utils";
 import { MessageType, ScopeType, } from "@fluidframework/protocol-definitions";
-import { formatTick, GenericError, normalizeError, UsageError, } from "@fluidframework/telemetry-utils";
+import { formatTick, GenericError, isFluidError, normalizeError, UsageError, } from "@fluidframework/telemetry-utils";
 import { ReconnectMode, } from "./contracts";
 import { DeltaQueue } from "./deltaQueue";
 import { SignalType } from "./protocol";
@@ -33,9 +36,15 @@ const clientNoDeltaStream = {
 };
 const clientIdNoDeltaStream = "storage-only client";
 class NoDeltaStream extends TypedEventEmitter {
-    constructor(storageOnlyReason) {
+    /**
+     * Connection which is not connected to socket.
+     * @param storageOnlyReason - Reason on why the connection to delta stream is not allowed.
+     * @param readonlyConnectionReason - reason/error if any which lead to using NoDeltaStream.
+     */
+    constructor(storageOnlyReason, readonlyConnectionReason) {
         super();
         this.storageOnlyReason = storageOnlyReason;
+        this.readonlyConnectionReason = readonlyConnectionReason;
         this.clientId = clientIdNoDeltaStream;
         this.claims = {
             scopes: [ScopeType.DocRead],
@@ -98,67 +107,6 @@ const waitForOnline = async () => {
  * Exposes various controls to influence this process, including manual reconnects, forced read-only mode, etc.
  */
 export class ConnectionManager {
-    constructor(serviceProvider, containerDirty, client, reconnectAllowed, logger, props) {
-        this.serviceProvider = serviceProvider;
-        this.containerDirty = containerDirty;
-        this.client = client;
-        this.logger = logger;
-        this.props = props;
-        /** tracks host requiring read-only mode. */
-        this._forceReadonly = false;
-        /** True if there is pending (async) reconnection from "read" to "write" */
-        this.pendingReconnect = false;
-        this.clientSequenceNumber = 0;
-        this.clientSequenceNumberObserved = 0;
-        /** Counts the number of non-runtime ops sent by the client which may not be acked. */
-        this.localOpsToIgnore = 0;
-        this.connectFirstConnection = true;
-        this._connectionVerboseProps = {};
-        this._connectionProps = {};
-        this._disposed = false;
-        this.opHandler = (documentId, messagesArg) => {
-            const messages = Array.isArray(messagesArg) ? messagesArg : [messagesArg];
-            this.props.incomingOpHandler(messages, "opHandler");
-        };
-        // Always connect in write mode after getting nacked.
-        this.nackHandler = (documentId, messages) => {
-            const message = messages[0];
-            if (this._readonlyPermissions === true) {
-                this.props.closeHandler(createWriteError("writeOnReadOnlyDocument", { driverVersion: undefined }));
-                return;
-            }
-            const reconnectInfo = getNackReconnectInfo(message.content);
-            // If the nack indicates we cannot retry, then close the container outright
-            if (!reconnectInfo.canRetry) {
-                this.props.closeHandler(reconnectInfo);
-                return;
-            }
-            this.reconnectOnError("write", reconnectInfo);
-        };
-        // Connection mode is always read on disconnect/error unless the system mode was write.
-        this.disconnectHandlerInternal = (disconnectReason) => {
-            // Note: we might get multiple disconnect calls on same socket, as early disconnect notification
-            // ("server_disconnect", ODSP-specific) is mapped to "disconnect"
-            this.reconnectOnError(this.defaultReconnectionMode, disconnectReason);
-        };
-        this.errorHandler = (error) => {
-            this.reconnectOnError(this.defaultReconnectionMode, error);
-        };
-        this.clientDetails = this.client.details;
-        this.defaultReconnectionMode = this.client.mode;
-        this._reconnectMode = reconnectAllowed ? ReconnectMode.Enabled : ReconnectMode.Never;
-        // Outbound message queue. The outbound queue is represented as a queue of an array of ops. Ops contained
-        // within an array *must* fit within the maxMessageSize and are guaranteed to be ordered sequentially.
-        this._outbound = new DeltaQueue((messages) => {
-            if (this.connection === undefined) {
-                throw new Error("Attempted to submit an outbound message without connection");
-            }
-            this.connection.submit(messages);
-        });
-        this._outbound.on("error", (error) => {
-            this.props.closeHandler(normalizeError(error));
-        });
-    }
     get connectionVerboseProps() {
         return this._connectionVerboseProps;
     }
@@ -272,6 +220,71 @@ export class ConnectionManager {
             reason,
         };
     }
+    constructor(serviceProvider, containerDirty, client, reconnectAllowed, logger, props) {
+        this.serviceProvider = serviceProvider;
+        this.containerDirty = containerDirty;
+        this.client = client;
+        this.logger = logger;
+        this.props = props;
+        /** tracks host requiring read-only mode. */
+        this._forceReadonly = false;
+        /** True if there is pending (async) reconnection from "read" to "write" */
+        this.pendingReconnect = false;
+        this.clientSequenceNumber = 0;
+        this.clientSequenceNumberObserved = 0;
+        /** Counts the number of non-runtime ops sent by the client which may not be acked. */
+        this.localOpsToIgnore = 0;
+        this.connectFirstConnection = true;
+        this._connectionVerboseProps = {};
+        this._connectionProps = {};
+        this._disposed = false;
+        this.opHandler = (documentId, messagesArg) => {
+            const messages = Array.isArray(messagesArg) ? messagesArg : [messagesArg];
+            this.props.incomingOpHandler(messages, "opHandler");
+        };
+        this.signalHandler = (signalsArg) => {
+            const signals = Array.isArray(signalsArg) ? signalsArg : [signalsArg];
+            this.props.signalHandler(signals);
+        };
+        // Always connect in write mode after getting nacked.
+        this.nackHandler = (documentId, messages) => {
+            const message = messages[0];
+            if (this._readonlyPermissions === true) {
+                this.props.closeHandler(createWriteError("writeOnReadOnlyDocument", { driverVersion: undefined }));
+                return;
+            }
+            const reconnectInfo = getNackReconnectInfo(message.content);
+            // If the nack indicates we cannot retry, then close the container outright
+            if (!reconnectInfo.canRetry) {
+                this.props.closeHandler(reconnectInfo);
+                return;
+            }
+            this.reconnectOnError("write", reconnectInfo);
+        };
+        // Connection mode is always read on disconnect/error unless the system mode was write.
+        this.disconnectHandlerInternal = (disconnectReason) => {
+            // Note: we might get multiple disconnect calls on same socket, as early disconnect notification
+            // ("server_disconnect", ODSP-specific) is mapped to "disconnect"
+            this.reconnectOnError(this.defaultReconnectionMode, disconnectReason);
+        };
+        this.errorHandler = (error) => {
+            this.reconnectOnError(this.defaultReconnectionMode, error);
+        };
+        this.clientDetails = this.client.details;
+        this.defaultReconnectionMode = this.client.mode;
+        this._reconnectMode = reconnectAllowed ? ReconnectMode.Enabled : ReconnectMode.Never;
+        // Outbound message queue. The outbound queue is represented as a queue of an array of ops. Ops contained
+        // within an array *must* fit within the maxMessageSize and are guaranteed to be ordered sequentially.
+        this._outbound = new DeltaQueue((messages) => {
+            if (this.connection === undefined) {
+                throw new Error("Attempted to submit an outbound message without connection");
+            }
+            this.connection.submit(messages);
+        });
+        this._outbound.on("error", (error) => {
+            this.props.closeHandler(normalizeError(error));
+        });
+    }
     dispose(error, switchToReadonly = true) {
         if (this._disposed) {
             return;
@@ -291,7 +304,7 @@ export class ConnectionManager {
             // Notify everyone we are in read-only state.
             // Useful for data stores in case we hit some critical error,
             // to switch to a mode where user edits are not accepted
-            this.set_readonlyPermissions(true, oldReadonlyValue);
+            this.set_readonlyPermissions(true, oldReadonlyValue, disconnectReason);
         }
     }
     /**
@@ -307,21 +320,7 @@ export class ConnectionManager {
         }
     }
     /**
-     * Sends signal to runtime (and data stores) to be read-only.
-     * Hosts may have read only views, indicating to data stores that no edits are allowed.
-     * This is independent from this._readonlyPermissions (permissions) and this.connectionMode
-     * (server can return "write" mode even when asked for "read")
-     * Leveraging same "readonly" event as runtime & data stores should behave the same in such case
-     * as in read-only permissions.
-     * But this.active can be used by some DDSes to figure out if ops can be sent
-     * (for example, read-only view still participates in code proposals / upgrades decisions)
-     *
-     * Forcing Readonly does not prevent DDS from generating ops. It is up to user code to honour
-     * the readonly flag. If ops are generated, they will accumulate locally and not be sent. If
-     * there are pending in the outbound queue, it will stop sending until force readonly is
-     * cleared.
-     *
-     * @param readonly - set or clear force readonly.
+     * {@inheritDoc Container.forceReadonly}
      */
     forceReadonly(readonly) {
         if (readonly !== this._forceReadonly) {
@@ -355,10 +354,10 @@ export class ConnectionManager {
             }
         }
     }
-    set_readonlyPermissions(newReadonlyValue, oldReadonlyValue) {
+    set_readonlyPermissions(newReadonlyValue, oldReadonlyValue, readonlyConnectionReason) {
         this._readonlyPermissions = newReadonlyValue;
         if (oldReadonlyValue !== this.readonly) {
-            this.props.readonlyChangeHandler(this.readonly);
+            this.props.readonlyChangeHandler(this.readonly, readonlyConnectionReason);
         }
     }
     connect(reason, connectionMode) {
@@ -439,7 +438,22 @@ export class ConnectionManager {
             }
             catch (origError) {
                 if (isDeltaStreamConnectionForbiddenError(origError)) {
-                    connection = new NoDeltaStream(origError.storageOnlyReason);
+                    connection = new NoDeltaStream(origError.storageOnlyReason, {
+                        text: origError.message,
+                        error: origError,
+                    });
+                    requestedMode = "read";
+                    break;
+                }
+                else if (isFluidError(origError) &&
+                    // eslint-disable-next-line import/no-deprecated
+                    origError.errorType === DriverErrorType.outOfStorageError) {
+                    // If we get out of storage error from calling joinsession, then use the NoDeltaStream object so
+                    // that user can at least load the container.
+                    connection = new NoDeltaStream(undefined, {
+                        text: origError.message,
+                        error: origError,
+                    });
                     requestedMode = "read";
                     break;
                 }
@@ -547,7 +561,7 @@ export class ConnectionManager {
         this.connection = undefined;
         // Remove listeners first so we don't try to retrigger this flow accidentally through reconnectOnError
         connection.off("op", this.opHandler);
-        connection.off("signal", this.props.signalHandler);
+        connection.off("signal", this.signalHandler);
         connection.off("nack", this.nackHandler);
         connection.off("disconnect", this.disconnectHandlerInternal);
         connection.off("error", this.errorHandler);
@@ -600,7 +614,7 @@ export class ConnectionManager {
         // removed after those packages have released and become ubiquitous.
         assert(requestedMode === "read" || readonly === (this.connectionMode === "read"), 0x0e7 /* "claims/connectionMode mismatch" */);
         assert(!readonly || this.connectionMode === "read", 0x0e8 /* "readonly perf with write connection" */);
-        this.set_readonlyPermissions(readonly, oldReadonlyValue);
+        this.set_readonlyPermissions(readonly, oldReadonlyValue, isNoDeltaStreamConnection(connection) ? connection.readonlyConnectionReason : undefined);
         if (this._disposed) {
             // Raise proper events, Log telemetry event and close connection.
             this.disconnectFromDeltaStream({ text: "ConnectionManager already closed" });
@@ -608,7 +622,7 @@ export class ConnectionManager {
         }
         this._outbound.resume();
         connection.on("op", this.opHandler);
-        connection.on("signal", this.props.signalHandler);
+        connection.on("signal", this.signalHandler);
         connection.on("nack", this.nackHandler);
         connection.on("disconnect", this.disconnectHandlerInternal);
         connection.on("error", this.errorHandler);
@@ -659,26 +673,26 @@ export class ConnectionManager {
                 type: SignalType.Clear,
             }),
         };
-        this.props.signalHandler(clearSignal);
-        for (const priorClient of connection.initialClients ?? []) {
-            const joinSignal = {
-                clientId: null,
-                content: JSON.stringify({
-                    type: SignalType.ClientJoin,
-                    content: priorClient, // ISignalClient
-                }),
-            };
-            this.props.signalHandler(joinSignal);
+        // list of signals to process due to this new connection
+        let signalsToProcess = [clearSignal];
+        const clientJoinSignals = (connection.initialClients ?? []).map((priorClient) => ({
+            clientId: null,
+            content: JSON.stringify({
+                type: SignalType.ClientJoin,
+                content: priorClient, // ISignalClient
+            }),
+        }));
+        if (clientJoinSignals.length > 0) {
+            signalsToProcess = signalsToProcess.concat(clientJoinSignals);
         }
         // Unfortunately, there is no defined order between initialSignals (including join & leave signals)
         // and connection.initialClients. In practice, connection.initialSignals quite often contains join signal
         // for "self" and connection.initialClients does not contain "self", so we have to process them after
         // "clear" signal above.
-        if (connection.initialSignals !== undefined) {
-            for (const signal of connection.initialSignals) {
-                this.props.signalHandler(signal);
-            }
+        if (connection.initialSignals !== undefined && connection.initialSignals.length > 0) {
+            signalsToProcess = signalsToProcess.concat(connection.initialSignals);
         }
+        this.props.signalHandler(signalsToProcess);
     }
     /**
      * Disconnect the current connection and reconnect. Closes the container if it fails.