@fluidframework/container-loader 0.52.1 → 0.54.0

package/dist/connectionManager.d.ts

@@ -0,0 +1,153 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryLogger, ITelemetryProperties } from "@fluidframework/common-definitions";
+import { IDeltaQueue, ReadOnlyInfo } from "@fluidframework/container-definitions";
+import { IDocumentService } from "@fluidframework/driver-definitions";
+import { ConnectionMode, IClient, IClientConfiguration, IClientDetails, IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { ReconnectMode, IConnectionManager, IConnectionManagerFactoryArgs } from "./contracts";
+/**
+ * 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.
+ */
+export declare class ConnectionManager implements IConnectionManager {
+    private readonly serviceProvider;
+    private client;
+    private readonly logger;
+    private readonly props;
+    /** Connection mode used when reconnecting on error or disconnect. */
+    private readonly defaultReconnectionMode;
+    private pendingConnection;
+    private connection;
+    /** file ACL - whether user has only read-only access to a file */
+    private _readonlyPermissions;
+    /** tracks host requiring read-only mode. */
+    private _forceReadonly;
+    /**
+     * Controls whether the DeltaManager will automatically reconnect to the delta stream after receiving a disconnect.
+     */
+    private _reconnectMode;
+    /** True if there is pending (async) reconnection from "read" to "write" */
+    private pendingReconnect;
+    /** downgrade "write" connection to "read" */
+    private downgradedConnection;
+    private clientSequenceNumber;
+    private clientSequenceNumberObserved;
+    /** Counts the number of noops sent by the client which may not be acked. */
+    private trailingNoopCount;
+    /** track clientId used last time when we sent any ops */
+    private lastSubmittedClientId;
+    private connectFirstConnection;
+    private _connectionVerboseProps;
+    private _connectionProps;
+    private closed;
+    private readonly _outbound;
+    get connectionVerboseProps(): Record<string, string | number>;
+    readonly clientDetails: IClientDetails;
+    /**
+     * The current connection mode, initially read.
+     */
+    get connectionMode(): ConnectionMode;
+    get connected(): boolean;
+    get clientId(): string | undefined;
+    /**
+     * Automatic reconnecting enabled or disabled.
+     * If set to Never, then reconnecting will never be allowed.
+     */
+    get reconnectMode(): ReconnectMode;
+    get maxMessageSize(): number;
+    get version(): string;
+    get serviceConfiguration(): IClientConfiguration | undefined;
+    get scopes(): string[] | undefined;
+    get outbound(): IDeltaQueue<IDocumentMessage[]>;
+    /**
+     * 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)
+    */
+    get connectionProps(): ITelemetryProperties;
+    shouldJoinWrite(): boolean;
+    /**
+     * Tells if container is in read-only mode.
+     * Data stores should listen for "readonly" notifications and disallow user
+     * making changes to data stores.
+     * Readonly state can be because of no storage write permission,
+     * or due to host forcing readonly mode for container.
+     * It is undefined if we have not yet established websocket connection
+     * and do not know if user has write access to a file.
+     */
+    private get readonly();
+    get readOnlyInfo(): ReadOnlyInfo;
+    private static detailsFromConnection;
+    constructor(serviceProvider: () => IDocumentService | undefined, client: IClient, reconnectAllowed: boolean, logger: ITelemetryLogger, props: IConnectionManagerFactoryArgs);
+    dispose(error: any): void;
+    /**
+     * Enables or disables automatic reconnecting.
+     * Will throw an error if reconnectMode set to Never.
+    */
+    setAutoReconnect(mode: ReconnectMode): void;
+    /**
+     * 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.
+     */
+    forceReadonly(readonly: boolean): void;
+    private set_readonlyPermissions;
+    connect(connectionMode?: ConnectionMode): void;
+    private connectCore;
+    /**
+     * Start the connection. Any error should result in container being close.
+     * And report the error if it excape for any reason.
+     * @param args - The connection arguments
+     */
+    private triggerConnect;
+    /**
+     * Disconnect the current connection.
+     * @param reason - Text description of disconnect reason to emit with disconnect event
+     */
+    private disconnectFromDeltaStream;
+    /**
+     * Once we've successfully gotten a connection, we need to set up state, attach event listeners, and process
+     * initial messages.
+     * @param connection - The newly established connection
+     */
+    private setupNewSuccessfulConnection;
+    /**
+     * Disconnect the current connection and reconnect.
+     * @param connection - The connection that wants to reconnect - no-op if it's different from this.connection
+     * @param requestedMode - Read or write
+     * @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;
+    /**
+     * Disconnect the current connection and reconnect.
+     * @param connection - The connection that wants to reconnect - no-op if it's different from this.connection
+     * @param requestedMode - Read or write
+     * @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 reconnectOnErrorCore;
+    prepareMessageToSend(message: Omit<IDocumentMessage, "clientSequenceNumber">): IDocumentMessage | undefined;
+    submitSignal(content: any): void;
+    sendMessages(messages: IDocumentMessage[]): void;
+    beforeProcessingIncomingOp(message: ISequencedDocumentMessage): void;
+    private readonly opHandler;
+    private readonly nackHandler;
+    private readonly disconnectHandlerInternal;
+    private readonly errorHandler;
+}
+//# sourceMappingURL=connectionManager.d.ts.map

package/dist/connectionManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectionManager.d.ts","sourceRoot":"","sources":["../src/connectionManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,gBAAgB,EAChB,oBAAoB,EACvB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACH,WAAW,EACX,YAAY,EAEf,MAAM,uCAAuC,CAAC;AAO/C,OAAO,EACH,gBAAgB,EAInB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACH,cAAc,EACd,OAAO,EACP,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAGhB,yBAAyB,EAO5B,MAAM,sCAAsC,CAAC;AAe9C,OAAO,EACH,aAAa,EACb,kBAAkB,EAClB,6BAA6B,EAChC,MAAM,aAAa,CAAC;AAmErB;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,kBAAkB;IA8JpD,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,MAAM;IAEd,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAjK1B,qEAAqE;IACrE,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAiB;IAEzD,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,UAAU,CAAuC;IAEzD,kEAAkE;IAClE,OAAO,CAAC,oBAAoB,CAAsB;IAElD,4CAA4C;IAC5C,OAAO,CAAC,cAAc,CAAS;IAE/B;;OAEG;IACH,OAAO,CAAC,cAAc,CAAgB;IAEtC,2EAA2E;IAC3E,OAAO,CAAC,gBAAgB,CAAS;IAEjC,6CAA6C;IAC7C,OAAO,CAAC,oBAAoB,CAAS;IAErC,OAAO,CAAC,oBAAoB,CAAK;IACjC,OAAO,CAAC,4BAA4B,CAAK;IACzC,4EAA4E;IAC5E,OAAO,CAAC,iBAAiB,CAAK;IAE9B,yDAAyD;IACzD,OAAO,CAAC,qBAAqB,CAAqB;IAElD,OAAO,CAAC,sBAAsB,CAAQ;IAEtC,OAAO,CAAC,uBAAuB,CAAuC;IAEtE,OAAO,CAAC,gBAAgB,CAA4B;IAEpD,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiC;IAE3D,IAAW,sBAAsB,oCAA2C;IAE5E,SAAgB,aAAa,EAAE,cAAc,CAAC;IAE9C;;OAEG;IACF,IAAW,cAAc,IAAI,cAAc,CAO3C;IAED,IAAW,SAAS,YAA4C;IAEhE,IAAW,QAAQ,uBAAwC;IAC3D;;;OAGG;IACF,IAAW,aAAa,IAAI,aAAa,CAEzC;IAED,IAAW,cAAc,IAAI,MAAM,CAGlC;IAED,IAAW,OAAO,IAAI,MAAM,CAK3B;IAED,IAAW,oBAAoB,IAAI,oBAAoB,GAAG,SAAS,CAElE;IAED,IAAW,MAAM,IAAI,MAAM,EAAE,GAAG,SAAS,CAExC;IAED,IAAW,QAAQ,IAAI,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAErD;IAED;;;MAGE;IACD,IAAW,eAAe,IAAI,oBAAoB,CAUlD;IAEM,eAAe,IAAI,OAAO;IAKjC;;;;;;;;OAQG;IACH,OAAO,KAAK,QAAQ,GAKnB;IAED,IAAW,YAAY,IAAI,YAAY,CAYtC;IAED,OAAO,CAAC,MAAM,CAAC,qBAAqB;gBAcf,eAAe,EAAE,MAAM,gBAAgB,GAAG,SAAS,EAC5D,MAAM,EAAE,OAAO,EACvB,gBAAgB,EAAE,OAAO,EACR,MAAM,EAAE,gBAAgB,EACxB,KAAK,EAAE,6BAA6B;IAqBlD,OAAO,CAAC,KAAK,EAAE,GAAG;IA0BzB;;;MAGE;IACK,gBAAgB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAYlD;;;;;;;;;;;;;;;;OAgBG;IACK,aAAa,CAAC,QAAQ,EAAE,OAAO;IAoCvC,OAAO,CAAC,uBAAuB;IAQxB,OAAO,CAAC,cAAc,CAAC,EAAE,cAAc;YAOhC,WAAW;IA+GzB;;;;OAIG;IACF,OAAO,CAAC,cAAc;IAQvB;;;OAGG;IACF,OAAO,CAAC,yBAAyB;IAkClC;;;;OAIG;IACF,OAAO,CAAC,4BAA4B;IA8FrC;;;;;;OAMG;IACF,OAAO,CAAC,gBAAgB;IAWzB;;;;;;OAMG;YACW,oBAAoB;IAsC3B,oBAAoB,CAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,EAAE,sBAAsB,CAAC,GAAG,gBAAgB,GAAG,SAAS;IAmC3G,YAAY,CAAC,OAAO,EAAE,GAAG;IAQzB,YAAY,CAAC,QAAQ,EAAE,gBAAgB,EAAE;IA8BzC,0BAA0B,CAAC,OAAO,EAAE,yBAAyB;IA2BpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAGxB;IAGF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAiB1B;IAGF,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAOxC;IAEF,OAAO,CAAC,QAAQ,CAAC,YAAY,CAK3B;CACL"}