@fluidframework/container-loader 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

package/dist/connectionStateHandler.d.ts

@@ -2,25 +2,98 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ITelemetryLogger, ITelemetryProperties } from "@fluidframework/common-definitions";
-import { IConnectionDetails } from "@fluidframework/container-definitions";
-import { IProtocolHandler } from "@fluidframework/protocol-base";
-import { ConnectionMode, IQuorumClients } from "@fluidframework/protocol-definitions";
+import { ITelemetryProperties, TelemetryEventCategory } from "@fluidframework/core-interfaces";
+import { IDeltaManager } from "@fluidframework/container-definitions";
+import { ISequencedClient, IClient } from "@fluidframework/protocol-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { IAnyDriverError } from "@fluidframework/driver-definitions";
 import { ConnectionState } from "./connectionState";
+import { IConnectionDetailsInternal, IConnectionStateChangeReason } from "./contracts";
+import { IProtocolHandler } from "./protocol";
 /** Constructor parameter type for passing in dependencies needed by the ConnectionStateHandler */
 export interface IConnectionStateHandlerInputs {
-    /** Provides access to the clients currently in the quorum */
-    quorumClients: () => IQuorumClients | undefined;
+    logger: ITelemetryLoggerExt;
     /** Log to telemetry any change in state, included to Connecting */
-    logConnectionStateChangeTelemetry: (value: ConnectionState, oldState: ConnectionState, reason?: string | undefined) => void;
+    connectionStateChanged: (value: ConnectionState, oldState: ConnectionState, reason?: IConnectionStateChangeReason) => void;
     /** Whether to expect the client to join in write mode on next connection */
     shouldClientJoinWrite: () => boolean;
     /** (Optional) How long should we wait on our previous client's Leave op before transitioning to Connected again */
     maxClientLeaveWaitTime: number | undefined;
     /** Log an issue encountered while in the Connecting state. details will be logged as a JSON string */
-    logConnectionIssue: (eventName: string, details?: ITelemetryProperties) => void;
-    /** Callback whenever the ConnectionState changes between Disconnected and Connected */
-    connectionStateChanged: () => void;
+    logConnectionIssue: (eventName: string, category: TelemetryEventCategory, details?: ITelemetryProperties) => void;
+    /** Callback to note that an old local client ID is still present in the Quorum that should have left and should now be considered invalid */
+    clientShouldHaveLeft: (clientId: string) => void;
+}
+/**
+ * interface that connection state handler implements
+ */
+export interface IConnectionStateHandler {
+    readonly connectionState: ConnectionState;
+    readonly pendingClientId: string | undefined;
+    containerSaved(): void;
+    dispose(): void;
+    initProtocol(protocol: IProtocolHandler): void;
+    receivedConnectEvent(details: IConnectionDetailsInternal): void;
+    receivedDisconnectEvent(reason: IConnectionStateChangeReason): void;
+    establishingConnection(reason: IConnectionStateChangeReason): void;
+    /**
+     * Switches state to disconnected when we are still establishing connection during container.load(),
+     * container connect() or reconnect and the container gets closed or disposed or disconnect happens.
+     * @param reason - reason for cancelling the connection.
+     */
+    cancelEstablishingConnection(reason: IConnectionStateChangeReason): void;
+}
+export declare function createConnectionStateHandler(inputs: IConnectionStateHandlerInputs, deltaManager: IDeltaManager<any, any>, clientId?: string): ConnectionStateHandler | ConnectionStateCatchup;
+export declare function createConnectionStateHandlerCore(connectedRaisedWhenCaughtUp: boolean, readClientsWaitForJoinSignal: boolean, inputs: IConnectionStateHandlerInputs, deltaManager: IDeltaManager<any, any>, clientId?: string): ConnectionStateHandler | ConnectionStateCatchup;
+/**
+ * Helper internal interface to abstract away Audience & Quorum
+ */
+interface IMembership {
+    on(eventName: "addMember" | "removeMember", listener: (clientId: string, details: IClient | ISequencedClient) => void): any;
+    getMember(clientId: string): undefined | unknown;
+}
+/**
+ * Class that can be used as a base class for building IConnectionStateHandler adapters / pipeline.
+ * It implements both ends of communication interfaces and passes data back and forward
+ */
+declare class ConnectionStateHandlerPassThrough implements IConnectionStateHandler, IConnectionStateHandlerInputs {
+    protected readonly inputs: IConnectionStateHandlerInputs;
+    protected readonly pimpl: IConnectionStateHandler;
+    constructor(inputs: IConnectionStateHandlerInputs, pimplFactory: (handler: IConnectionStateHandlerInputs) => IConnectionStateHandler);
+    /**
+     * IConnectionStateHandler
+     */
+    get connectionState(): ConnectionState;
+    get pendingClientId(): string | undefined;
+    containerSaved(): void;
+    dispose(): void;
+    initProtocol(protocol: IProtocolHandler): void;
+    receivedDisconnectEvent(reason: IConnectionStateChangeReason<IAnyDriverError>): void;
+    establishingConnection(reason: IConnectionStateChangeReason): void;
+    cancelEstablishingConnection(reason: IConnectionStateChangeReason): void;
+    receivedConnectEvent(details: IConnectionDetailsInternal): void;
+    /**
+     * IConnectionStateHandlerInputs
+     */
+    get logger(): ITelemetryLoggerExt;
+    connectionStateChanged(value: ConnectionState, oldState: ConnectionState, reason?: IConnectionStateChangeReason): void;
+    shouldClientJoinWrite(): boolean;
+    get maxClientLeaveWaitTime(): number | undefined;
+    logConnectionIssue(eventName: string, category: TelemetryEventCategory, details?: ITelemetryProperties): void;
+    clientShouldHaveLeft(clientId: string): void;
+}
+/**
+ * Implementation of IConnectionStateHandler pass-through adapter that waits for specific sequence number
+ * before raising connected event
+ */
+declare class ConnectionStateCatchup extends ConnectionStateHandlerPassThrough {
+    private readonly deltaManager;
+    private catchUpMonitor;
+    constructor(inputs: IConnectionStateHandlerInputs, pimplFactory: (handler: IConnectionStateHandlerInputs) => IConnectionStateHandler, deltaManager: IDeltaManager<any, any>);
+    private _connectionState;
+    get connectionState(): ConnectionState;
+    connectionStateChanged(value: ConnectionState, oldState: ConnectionState, reason?: IConnectionStateChangeReason<IAnyDriverError>): void;
+    private readonly transitionToConnectedState;
 }
 /**
  * In the lifetime of a container, the connection will likely disconnect and reconnect periodically.
@@ -28,36 +101,54 @@ export interface IConnectionStateHandlerInputs {
  * sequenced or blocked by the server before emitting the new "connected" event and allowing runtime to resubmit ops.
  *
  * Each connection is assigned a clientId by the service, and the connection is book-ended by a Join and a Leave op
- * generated by the service. Due to the distributed nature of the ordering service, in the case of reconnect we cannot
+ * generated by the service. Due to the distributed nature of the Relay Service, in the case of reconnect we cannot
  * make any assumptions about ordering of operations between the old and new connections - i.e. new Join op could
  * be sequenced before old Leave op (and some acks from pending ops that were in flight when we disconnected).
  *
  * The job of this class is to encapsulate the transition period during reconnect, which is identified by
  * ConnectionState.CatchingUp. Specifically, before moving to Connected state with the new clientId, it ensures that:
- * (A) We process the Leave op for the previous clientId. This allows us to properly handle any acks from in-flight ops
- *     that got sequenced with the old clientId (we'll recognize them as local ops). After the Leave op, any other
- *     pending ops can safely be submitted with the new clientId without fear of duplication in the sequenced op stream.
- * (B) We process the Join op for the new clientId (identified when the underlying connection was first established),
- *     indicating the service is ready to sequence ops sent with the new clientId.
  *
- * For (A) we give up waiting after some time (same timeout as server uses), and go ahead and transition to Connected.
- * For (B) we log telemetry if it takes too long, but still only transition to Connected when the Join op is processed
- * and we are added to the Quorum.
+ * a. We process the Leave op for the previous clientId. This allows us to properly handle any acks from in-flight ops
+ * that got sequenced with the old clientId (we'll recognize them as local ops). After the Leave op, any other
+ * pending ops can safely be submitted with the new clientId without fear of duplication in the sequenced op stream.
+ *
+ * b. We process the Join op for the new clientId (identified when the underlying connection was first established),
+ * indicating the service is ready to sequence ops sent with the new clientId.
+ *
+ * c. We process all ops known at the time the underlying connection was established (so we are "caught up")
+ *
+ * For (a) we give up waiting after some time (same timeout as server uses), and go ahead and transition to Connected.
+ *
+ * For (b) we log telemetry if it takes too long, but still only transition to Connected when the Join op/signal is
+ * processed.
+ *
+ * For (c) this is optional behavior, controlled by the parameters of receivedConnectEvent
  */
-export declare class ConnectionStateHandler {
+declare class ConnectionStateHandler implements IConnectionStateHandler {
     private readonly handler;
-    private readonly logger;
-    private _clientId?;
+    private readonly readClientsWaitForJoinSignal;
     private _connectionState;
     private _pendingClientId;
+    /**
+     * Tracks that we observe the "leave" op within the timeout for our previous clientId (see comment on ConnectionStateHandler class)
+     * ! This ensures we do not switch to a new clientId until we process all potential messages from old clientId
+     * ! i.e. We will always see the "leave" op for a client after we have seen all the ops it has sent
+     * ! This check helps prevent the same op from being resubmitted by the PendingStateManager upon reconnecting
+     */
     private readonly prevClientLeftTimer;
+    /**
+     * Tracks that we observe our own "join" op within the timeout after receiving a "connected" event from the DeltaManager
+     */
     private readonly joinOpTimer;
+    private protocol?;
+    private connection?;
+    private _clientId?;
+    /** Track how long we waited to see "leave" op for previous clientId */
     private waitEvent;
     get connectionState(): ConnectionState;
-    get connected(): boolean;
-    get clientId(): string | undefined;
+    private get clientId();
     get pendingClientId(): string | undefined;
-    constructor(handler: IConnectionStateHandlerInputs, logger: ITelemetryLogger, _clientId?: string | undefined);
+    constructor(handler: IConnectionStateHandlerInputs, readClientsWaitForJoinSignal: boolean, clientIdFromPausedSession?: string);
     private startJoinOpTimer;
     private stopJoinOpTimer;
     private get waitingForLeaveOp();
@@ -66,16 +157,23 @@ export declare class ConnectionStateHandler {
     private receivedAddMemberEvent;
     private applyForConnectedState;
     private receivedRemoveMemberEvent;
-    receivedDisconnectEvent(reason: string): void;
+    receivedDisconnectEvent(reason: IConnectionStateChangeReason<IAnyDriverError>): void;
+    cancelEstablishingConnection(reason: IConnectionStateChangeReason): void;
+    establishingConnection(reason: IConnectionStateChangeReason): void;
+    private shouldWaitForJoinSignal;
     /**
      * The "connect" event indicates the connection to the Relay Service is live.
      * However, some additional conditions must be met before we can fully transition to
      * "Connected" state. This function handles that interim period, known as "Connecting" state.
-     * @param connectionMode - Read or Write connection
-     * @param details - Connection details returned from the ordering service
+     * @param details - Connection details returned from the Relay Service
+     * @param deltaManager - DeltaManager to be used for delaying Connected transition until caught up.
+     * If it's undefined, then don't delay and transition to Connected as soon as Leave/Join op are accounted for
      */
-    receivedConnectEvent(connectionMode: ConnectionMode, details: IConnectionDetails): void;
+    receivedConnectEvent(details: IConnectionDetailsInternal): void;
     private setConnectionState;
+    protected get membership(): IMembership | undefined;
     initProtocol(protocol: IProtocolHandler): void;
+    protected hasMember(clientId?: string): boolean;
 }
+export {};
 //# sourceMappingURL=connectionStateHandler.d.ts.map

package/dist/connectionStateHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connectionStateHandler.d.ts","sourceRoot":"","sources":["../src/connectionStateHandler.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE5F,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAyB,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACxF,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAEtF,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,kGAAkG;AAClG,MAAM,WAAW,6BAA6B;IAC1C,6DAA6D;IAC7D,aAAa,EAAE,MAAM,cAAc,GAAG,SAAS,CAAC;IAChD,mEAAmE;IACnE,iCAAiC,EAC7B,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;IAC7F,4EAA4E;IAC5E,qBAAqB,EAAE,MAAM,OAAO,CAAC;IACrC,mHAAmH;IACnH,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,sGAAsG;IACtG,kBAAkB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAChF,uFAAuF;IACvF,sBAAsB,EAAE,MAAM,IAAI,CAAC;CACtC;AAID;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,sBAAsB;IAyB3B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,SAAS,CAAC;IA1BtB,OAAO,CAAC,gBAAgB,CAAgC;IACxD,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IAEpC,OAAO,CAAC,SAAS,CAA+B;IAEhD,IAAW,eAAe,IAAI,eAAe,CAE5C;IAED,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAExC;IAED,IAAW,eAAe,IAAI,MAAM,GAAG,SAAS,CAE/C;gBAGoB,OAAO,EAAE,6BAA6B,EACtC,MAAM,EAAE,gBAAgB,EACjC,SAAS,CAAC,oBAAQ;IAoC9B,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,eAAe;IAKvB,OAAO,KAAK,iBAAiB,GAE5B;IAEM,OAAO;IAKP,cAAc;IASrB,OAAO,CAAC,sBAAsB;IAwB9B,OAAO,CAAC,sBAAsB;IAkC9B,OAAO,CAAC,yBAAyB;IAQ1B,uBAAuB,CAAC,MAAM,EAAE,MAAM;IAO7C;;;;;;OAMG;IACI,oBAAoB,CACvB,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,kBAAkB;IA6C/B,OAAO,CAAC,kBAAkB;IA0DnB,YAAY,CAAC,QAAQ,EAAE,gBAAgB;CAcjD"}
+{"version":3,"file":"connectionStateHandler.d.ts","sourceRoot":"","sources":["../src/connectionStateHandler.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAE/F,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACN,mBAAmB,EAGnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAErE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,0BAA0B,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AACvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAU9C,kGAAkG;AAClG,MAAM,WAAW,6BAA6B;IAC7C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,mEAAmE;IACnE,sBAAsB,EAAE,CACvB,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,eAAe,EACzB,MAAM,CAAC,EAAE,4BAA4B,KACjC,IAAI,CAAC;IACV,4EAA4E;IAC5E,qBAAqB,EAAE,MAAM,OAAO,CAAC;IACrC,mHAAmH;IACnH,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,sGAAsG;IACtG,kBAAkB,EAAE,CACnB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,sBAAsB,EAChC,OAAO,CAAC,EAAE,oBAAoB,KAC1B,IAAI,CAAC;IACV,6IAA6I;IAC7I,oBAAoB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAC1C,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7C,cAAc,IAAI,IAAI,CAAC;IACvB,OAAO,IAAI,IAAI,CAAC;IAChB,YAAY,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC/C,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAChE,uBAAuB,CAAC,MAAM,EAAE,4BAA4B,GAAG,IAAI,CAAC;IACpE,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,GAAG,IAAI,CAAC;IACnE;;;;OAIG;IACH,4BAA4B,CAAC,MAAM,EAAE,4BAA4B,GAAG,IAAI,CAAC;CACzE;AAED,wBAAgB,4BAA4B,CAC3C,MAAM,EAAE,6BAA6B,EACrC,YAAY,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EACrC,QAAQ,CAAC,EAAE,MAAM,mDAUjB;AAED,wBAAgB,gCAAgC,CAC/C,2BAA2B,EAAE,OAAO,EACpC,4BAA4B,EAAE,OAAO,EACrC,MAAM,EAAE,6BAA6B,EACrC,YAAY,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EACrC,QAAQ,CAAC,EAAE,MAAM,mDAWjB;AAED;;GAEG;AACH,UAAU,WAAW;IACpB,EAAE,CACD,SAAS,EAAE,WAAW,GAAG,cAAc,EACvC,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,gBAAgB,KAAK,IAAI,OACxE;IACF,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;CACjD;AAED;;;GAGG;AACH,cAAM,iCACL,YAAW,uBAAuB,EAAE,6BAA6B;IAKhE,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,6BAA6B;IAHzD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,uBAAuB,CAAC;gBAG9B,MAAM,EAAE,6BAA6B,EACxD,YAAY,EAAE,CAAC,OAAO,EAAE,6BAA6B,KAAK,uBAAuB;IAKlF;;OAEG;IACH,IAAW,eAAe,oBAEzB;IACD,IAAW,eAAe,uBAEzB;IAEM,cAAc;IAGd,OAAO;IAGP,YAAY,CAAC,QAAQ,EAAE,gBAAgB;IAGvC,uBAAuB,CAAC,MAAM,EAAE,4BAA4B,CAAC,eAAe,CAAC;IAI7E,sBAAsB,CAAC,MAAM,EAAE,4BAA4B;IAI3D,4BAA4B,CAAC,MAAM,EAAE,4BAA4B;IAIjE,oBAAoB,CAAC,OAAO,EAAE,0BAA0B;IAI/D;;OAEG;IAEH,IAAW,MAAM,wBAEhB;IACM,sBAAsB,CAC5B,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,eAAe,EACzB,MAAM,CAAC,EAAE,4BAA4B;IAI/B,qBAAqB;IAG5B,IAAW,sBAAsB,uBAEhC;IACM,kBAAkB,CACxB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,sBAAsB,EAChC,OAAO,CAAC,EAAE,oBAAoB;IAIxB,oBAAoB,CAAC,QAAQ,EAAE,MAAM;CAG5C;AAED;;;GAGG;AACH,cAAM,sBAAuB,SAAQ,iCAAiC;IAMpE,OAAO,CAAC,QAAQ,CAAC,YAAY;IAL9B,OAAO,CAAC,cAAc,CAA8B;gBAGnD,MAAM,EAAE,6BAA6B,EACrC,YAAY,EAAE,CAAC,OAAO,EAAE,6BAA6B,KAAK,uBAAuB,EAChE,YAAY,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC;IAMvD,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,IAAW,eAAe,oBAEzB;IAEM,sBAAsB,CAC5B,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,eAAe,EACzB,MAAM,CAAC,EAAE,4BAA4B,CAAC,eAAe,CAAC;IA+CvD,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CASzC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,cAAM,sBAAuB,YAAW,uBAAuB;IAqC7D,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,4BAA4B;IArC9C,OAAO,CAAC,gBAAgB,CAAgC;IACxD,OAAO,CAAC,gBAAgB,CAAqB;IAE7C;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAQ;IAE5C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IAEpC,OAAO,CAAC,QAAQ,CAAC,CAAmB;IACpC,OAAO,CAAC,UAAU,CAAC,CAA6B;IAChD,OAAO,CAAC,SAAS,CAAC,CAAS;IAE3B,uEAAuE;IACvE,OAAO,CAAC,SAAS,CAA+B;IAEhD,IAAW,eAAe,IAAI,eAAe,CAE5C;IAED,OAAO,KAAK,QAAQ,GAEnB;IAED,IAAW,eAAe,IAAI,MAAM,GAAG,SAAS,CAE/C;gBAGiB,OAAO,EAAE,6BAA6B,EACtC,4BAA4B,EAAE,OAAO,EACtD,yBAAyB,CAAC,EAAE,MAAM;IAmCnC,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,eAAe;IAKvB,OAAO,KAAK,iBAAiB,GAE5B;IAEM,OAAO;IAKP,cAAc;IASrB,OAAO,CAAC,sBAAsB;IAuC9B,OAAO,CAAC,sBAAsB;IA0C9B,OAAO,CAAC,yBAAyB;IAQ1B,uBAAuB,CAAC,MAAM,EAAE,4BAA4B,CAAC,eAAe,CAAC;IAK7E,4BAA4B,CAAC,MAAM,EAAE,4BAA4B;IAWjE,sBAAsB,CAAC,MAAM,EAAE,4BAA4B;IASlE,OAAO,CAAC,uBAAuB;IAQ/B;;;;;;;OAOG;IACI,oBAAoB,CAAC,OAAO,EAAE,0BAA0B;IA4C/D,OAAO,CAAC,kBAAkB;IA0E1B,SAAS,KAAK,UAAU,IAAI,WAAW,GAAG,SAAS,CAOlD;IAEM,YAAY,CAAC,QAAQ,EAAE,gBAAgB;IAsC9C,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM;CAGrC"}

package/dist/container-loader-alpha.d.ts

@@ -0,0 +1,274 @@
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { IAudienceOwner } from '@fluidframework/container-definitions';
+import { IClientDetails } from '@fluidframework/protocol-definitions';
+import { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import { IContainer } from '@fluidframework/container-definitions';
+import { IDocumentAttributes } from '@fluidframework/protocol-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IFluidCodeDetails } from '@fluidframework/container-definitions';
+import { IFluidModule } from '@fluidframework/container-definitions';
+import { IHostLoader } from '@fluidframework/container-definitions';
+import { ILoaderOptions as ILoaderOptions_2 } from '@fluidframework/container-definitions';
+import { ILocationRedirectionError } from '@fluidframework/driver-definitions';
+import { IProtocolHandler as IProtocolHandler_2 } from '@fluidframework/protocol-base';
+import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions';
+import { IQuorumSnapshot } from '@fluidframework/protocol-base';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+
+/**
+ * @alpha
+ */
+export declare enum ConnectionState {
+    /**
+     * The container is not connected to the ordering service
+     * Note - When in this state the container may be about to reconnect,
+     * or may remain disconnected until explicitly told to connect.
+     */
+    Disconnected = 0,
+    /**
+     * The container is disconnected but actively trying to establish a new connection
+     * PLEASE NOTE that this numerical value falls out of the order you may expect for this state
+     */
+    EstablishingConnection = 3,
+    /**
+     * The container has an inbound connection only, and is catching up to the latest known state from the service.
+     */
+    CatchingUp = 1,
+    /**
+     * The container is fully connected and syncing
+     */
+    Connected = 2
+}
+
+/**
+ * @deprecated ICodeDetailsLoader interface is moved to {@link @fluidframework/container-definition#ICodeDetailsLoader}
+ * to have code loading modules in one package. #8193
+ * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as
+ * a package name and package version range.
+ * @alpha
+ */
+export declare interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
+    /**
+     * Load the code module (package) that is capable to interact with the document.
+     *
+     * @param source - Code proposal that articulates the current schema the document is written in.
+     * @returns Code module entry point along with the code details associated with it.
+     */
+    load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
+}
+
+/* Excluded from this release type: IContainerExperimental */
+
+/**
+ * Subset of IDocumentStorageService which only supports createBlob() and readBlob(). This is used to support
+ * blobs in detached containers.
+ * @alpha
+ */
+export declare type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" | "readBlob"> & {
+    size: number;
+    /**
+     * Return an array of all blob IDs present in storage
+     */
+    getBlobIds(): string[];
+};
+
+/**
+ * @deprecated IFluidModuleWithDetails interface is moved to
+ * {@link @fluidframework/container-definitions#IFluidModuleWithDetails}
+ * to have all the code loading modules in one package. #8193
+ * Encapsulates a module entry point with corresponding code details.
+ * @alpha
+ */
+export declare interface IFluidModuleWithDetails {
+    /** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
+    module: IFluidModule;
+    /**
+     * Code details associated with the module. Represents a document schema this module supports.
+     * If the code loader implements the {@link @fluidframework/core-interfaces#IFluidCodeDetailsComparer} interface,
+     * it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.
+     */
+    details: IFluidCodeDetails;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ILoaderOptions extends ILoaderOptions_2 {
+    summarizeProtocolTree?: boolean;
+}
+
+/**
+ * Services and properties necessary for creating a loader
+ * @alpha
+ */
+export declare interface ILoaderProps {
+    /**
+     * The url resolver used by the loader for resolving external urls
+     * into Fluid urls such that the container specified by the
+     * external url can be loaded.
+     */
+    readonly urlResolver: IUrlResolver;
+    /**
+     * The document service factory take the Fluid url provided
+     * by the resolved url and constructs all the necessary services
+     * for communication with the container's server.
+     */
+    readonly documentServiceFactory: IDocumentServiceFactory;
+    /**
+     * The code loader handles loading the necessary code
+     * for running a container once it is loaded.
+     */
+    readonly codeLoader: ICodeDetailsLoader;
+    /**
+     * A property bag of options used by various layers
+     * to control features
+     */
+    readonly options?: ILoaderOptions;
+    /**
+     * Scope is provided to all container and is a set of shared
+     * services for container's to integrate with their host environment.
+     */
+    readonly scope?: FluidObject;
+    /**
+     * The logger that all telemetry should be pushed to.
+     */
+    readonly logger?: ITelemetryBaseLogger;
+    /**
+     * Blobs storage for detached containers.
+     */
+    readonly detachedBlobStorage?: IDetachedBlobStorage;
+    /**
+     * The configuration provider which may be used to control features.
+     */
+    readonly configProvider?: IConfigProviderBase;
+    /**
+     * Optional property for allowing the container to use a custom
+     * protocol implementation for handling the quorum and/or the audience.
+     */
+    readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
+}
+
+/**
+ * Services and properties used by and exposed by the loader
+ * @alpha
+ */
+export declare interface ILoaderServices {
+    /**
+     * The url resolver used by the loader for resolving external urls
+     * into Fluid urls such that the container specified by the
+     * external url can be loaded.
+     */
+    readonly urlResolver: IUrlResolver;
+    /**
+     * The document service factory take the Fluid url provided
+     * by the resolved url and constructs all the necessary services
+     * for communication with the container's server.
+     */
+    readonly documentServiceFactory: IDocumentServiceFactory;
+    /**
+     * The code loader handles loading the necessary code
+     * for running a container once it is loaded.
+     */
+    readonly codeLoader: ICodeDetailsLoader;
+    /**
+     * A property bag of options used by various layers
+     * to control features
+     */
+    readonly options: ILoaderOptions;
+    /**
+     * Scope is provided to all container and is a set of shared
+     * services for container's to integrate with their host environment.
+     */
+    readonly scope: FluidObject;
+    /**
+     * The logger downstream consumers should construct their loggers from
+     */
+    readonly subLogger: ITelemetryLoggerExt;
+    /**
+     * Blobs storage for detached containers.
+     */
+    readonly detachedBlobStorage?: IDetachedBlobStorage;
+    /**
+     * Optional property for allowing the container to use a custom
+     * protocol implementation for handling the quorum and/or the audience.
+     */
+    readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
+}
+
+/* Excluded from this release type: IParsedUrl */
+
+/**
+ * @alpha
+ */
+export declare interface IProtocolHandler extends IProtocolHandler_2 {
+    readonly audience: IAudienceOwner;
+    processSignal(message: ISignalMessage): any;
+}
+
+/* Excluded from this release type: isLocationRedirectionError */
+
+/**
+ * Manages Fluid resource loading
+ * @alpha
+ */
+export declare class Loader implements IHostLoader {
+    readonly services: ILoaderServices;
+    private readonly mc;
+    constructor(loaderProps: ILoaderProps);
+    createDetachedContainer(codeDetails: IFluidCodeDetails, createDetachedProps?: {
+        canReconnect?: boolean;
+        clientDetailsOverride?: IClientDetails;
+    }): Promise<IContainer>;
+    rehydrateDetachedContainerFromSnapshot(snapshot: string, createDetachedProps?: {
+        canReconnect?: boolean;
+        clientDetailsOverride?: IClientDetails;
+    }): Promise<IContainer>;
+    resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
+    private resolveCore;
+    private loadContainer;
+}
+
+/**
+ * Function to be used for creating a protocol handler.
+ * @alpha
+ */
+export declare type ProtocolHandlerBuilder = (attributes: IDocumentAttributes, snapshot: IQuorumSnapshot, sendProposal: (key: string, value: any) => number) => IProtocolHandler;
+
+/**
+ * Handles location redirection while fulfilling the loader request.
+ * @param api - Callback in which user can wrap the loader.resolve or loader.request call.
+ * @param request - request to be resolved.
+ * @param urlResolver - resolver used to resolve the url.
+ * @param logger - logger to send events.
+ * @returns Response from the API call.
+ * @alpha
+ */
+export declare function resolveWithLocationRedirectionHandling<T>(api: (request: IRequest) => Promise<T>, request: IRequest, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger): Promise<T>;
+
+/* Excluded from this release type: tryParseCompatibleResolvedUrl */
+
+/**
+ * Waits until container connects to delta storage and gets up-to-date.
+ *
+ * Useful when resolving URIs and hitting 404, due to container being loaded from (stale) snapshot and not being
+ * up to date. Host may chose to wait in such case and retry resolving URI.
+ *
+ * Warning: Will wait infinitely for connection to establish if there is no connection.
+ * May result in deadlock if Container.disconnect() is called and never followed by a call to Container.connect().
+ *
+ * @returns `true`: container is up to date, it processed all the ops that were know at the time of first connection.
+ *
+ * `false`: storage does not provide indication of how far the client is. Container processed all the ops known to it,
+ * but it maybe still behind.
+ *
+ * @throws an error beginning with `"Container closed"` if the container is closed before it catches up.
+ * @alpha
+ */
+export declare function waitContainerToCatchUp(container: IContainer): Promise<boolean>;
+
+export { }

package/dist/container-loader-beta.d.ts

@@ -0,0 +1,75 @@
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { IAudienceOwner } from '@fluidframework/container-definitions';
+import { IClientDetails } from '@fluidframework/protocol-definitions';
+import { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import { IContainer } from '@fluidframework/container-definitions';
+import { IDocumentAttributes } from '@fluidframework/protocol-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IFluidCodeDetails } from '@fluidframework/container-definitions';
+import { IFluidModule } from '@fluidframework/container-definitions';
+import { IHostLoader } from '@fluidframework/container-definitions';
+import { ILoaderOptions as ILoaderOptions_2 } from '@fluidframework/container-definitions';
+import { ILocationRedirectionError } from '@fluidframework/driver-definitions';
+import { IProtocolHandler as IProtocolHandler_2 } from '@fluidframework/protocol-base';
+import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions';
+import { IQuorumSnapshot } from '@fluidframework/protocol-base';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+
+/* Excluded from this release type: ConnectionState */
+
+/* Excluded from this release type: IAudienceOwner */
+
+/* Excluded from this release type: ICodeDetailsLoader */
+
+/* Excluded from this release type: IContainer */
+
+/* Excluded from this release type: IContainerExperimental */
+
+/* Excluded from this release type: IDetachedBlobStorage */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IFluidCodeDetails */
+
+/* Excluded from this release type: IFluidModule */
+
+/* Excluded from this release type: IFluidModuleWithDetails */
+
+/* Excluded from this release type: IHostLoader */
+
+/* Excluded from this release type: ILoaderOptions */
+
+/* Excluded from this release type: ILoaderProps */
+
+/* Excluded from this release type: ILoaderServices */
+
+/* Excluded from this release type: ILocationRedirectionError */
+
+/* Excluded from this release type: IParsedUrl */
+
+/* Excluded from this release type: IProtocolHandler */
+
+/* Excluded from this release type: IProvideFluidCodeDetailsComparer */
+
+/* Excluded from this release type: isLocationRedirectionError */
+
+/* Excluded from this release type: IUrlResolver */
+
+/* Excluded from this release type: Loader */
+
+/* Excluded from this release type: ProtocolHandlerBuilder */
+
+/* Excluded from this release type: resolveWithLocationRedirectionHandling */
+
+/* Excluded from this release type: tryParseCompatibleResolvedUrl */
+
+/* Excluded from this release type: waitContainerToCatchUp */
+
+export { }

package/dist/container-loader-public.d.ts

@@ -0,0 +1,75 @@
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { IAudienceOwner } from '@fluidframework/container-definitions';
+import { IClientDetails } from '@fluidframework/protocol-definitions';
+import { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import { IContainer } from '@fluidframework/container-definitions';
+import { IDocumentAttributes } from '@fluidframework/protocol-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IFluidCodeDetails } from '@fluidframework/container-definitions';
+import { IFluidModule } from '@fluidframework/container-definitions';
+import { IHostLoader } from '@fluidframework/container-definitions';
+import { ILoaderOptions as ILoaderOptions_2 } from '@fluidframework/container-definitions';
+import { ILocationRedirectionError } from '@fluidframework/driver-definitions';
+import { IProtocolHandler as IProtocolHandler_2 } from '@fluidframework/protocol-base';
+import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions';
+import { IQuorumSnapshot } from '@fluidframework/protocol-base';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+
+/* Excluded from this release type: ConnectionState */
+
+/* Excluded from this release type: IAudienceOwner */
+
+/* Excluded from this release type: ICodeDetailsLoader */
+
+/* Excluded from this release type: IContainer */
+
+/* Excluded from this release type: IContainerExperimental */
+
+/* Excluded from this release type: IDetachedBlobStorage */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IFluidCodeDetails */
+
+/* Excluded from this release type: IFluidModule */
+
+/* Excluded from this release type: IFluidModuleWithDetails */
+
+/* Excluded from this release type: IHostLoader */
+
+/* Excluded from this release type: ILoaderOptions */
+
+/* Excluded from this release type: ILoaderProps */
+
+/* Excluded from this release type: ILoaderServices */
+
+/* Excluded from this release type: ILocationRedirectionError */
+
+/* Excluded from this release type: IParsedUrl */
+
+/* Excluded from this release type: IProtocolHandler */
+
+/* Excluded from this release type: IProvideFluidCodeDetailsComparer */
+
+/* Excluded from this release type: isLocationRedirectionError */
+
+/* Excluded from this release type: IUrlResolver */
+
+/* Excluded from this release type: Loader */
+
+/* Excluded from this release type: ProtocolHandlerBuilder */
+
+/* Excluded from this release type: resolveWithLocationRedirectionHandling */
+
+/* Excluded from this release type: tryParseCompatibleResolvedUrl */
+
+/* Excluded from this release type: waitContainerToCatchUp */
+
+export { }