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

package/lib/{deltaManager.d.ts → deltaManager.d.mts}

@@ -2,17 +2,17 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { default as AbortController } from "abort-controller";
-import { ITelemetryLogger, IEventProvider, ITelemetryProperties, ITelemetryErrorEvent } from "@fluidframework/common-definitions";
-import { IDeltaHandlerStrategy, IDeltaManager, IDeltaManagerEvents, IDeltaQueue, ICriticalContainerError, IThrottlingWarning } from "@fluidframework/container-definitions";
-import { TypedEventEmitter } from "@fluidframework/common-utils";
+import { IThrottlingWarning, IEventProvider, ITelemetryProperties, ITelemetryErrorEvent } from "@fluidframework/core-interfaces";
+import { ICriticalContainerError, IDeltaManager, IDeltaManagerEvents, IDeltaQueue } from "@fluidframework/container-definitions";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { IDocumentService } from "@fluidframework/driver-definitions";
 import { IDocumentMessage, ISequencedDocumentMessage, ISignalMessage, MessageType, ConnectionMode } from "@fluidframework/protocol-definitions";
-import { IConnectionManagerFactoryArgs, IConnectionManager } from "./contracts";
+import { IConnectionDetailsInternal, IConnectionManager, IConnectionManagerFactoryArgs, IConnectionStateChangeReason } from "./contracts.mjs";
 export interface IConnectionArgs {
     mode?: ConnectionMode;
     fetchOpsFromStorage?: boolean;
-    reason: string;
+    reason: IConnectionStateChangeReason;
 }
 /**
  * Includes events emitted by the concrete implementation DeltaManager
@@ -20,7 +20,23 @@ export interface IConnectionArgs {
  */
 export interface IDeltaManagerInternalEvents extends IDeltaManagerEvents {
     (event: "throttled", listener: (error: IThrottlingWarning) => void): any;
-    (event: "closed", listener: (error?: ICriticalContainerError) => void): any;
+    (event: "closed" | "disposed", listener: (error?: ICriticalContainerError) => void): any;
+    (event: "connect", listener: (details: IConnectionDetailsInternal, opsBehind?: number) => void): any;
+    (event: "establishingConnection", listener: (reason: IConnectionStateChangeReason) => void): any;
+    (event: "cancelEstablishingConnection", listener: (reason: IConnectionStateChangeReason) => void): any;
+}
+/**
+ * Interface used to define a strategy for handling incoming delta messages
+ */
+export interface IDeltaHandlerStrategy {
+    /**
+     * Processes the message.
+     */
+    process: (message: ISequencedDocumentMessage) => void;
+    /**
+     * Processes the signal.
+     */
+    processSignal: (message: ISignalMessage) => void;
 }
 /**
  * Manages the flow of both inbound and outbound messages. This class ensures that shared objects receive delta
@@ -36,22 +52,27 @@ export declare class DeltaManager<TConnectionManager extends IConnectionManager>
     get IDeltaSender(): this;
     private pending;
     private fetchReason;
+    private currentlyProcessingOps;
     private minSequenceNumber;
     private lastQueuedSequenceNumber;
     private lastObservedSeqNumber;
     private lastProcessedSequenceNumber;
     private lastProcessedMessage;
-    private baseTerm;
+    /** count number of noops sent by the client which may not be acked */
+    private noOpCount;
+    /** Track clientSequenceNumber of the last op */
+    private lastClientSequenceNumber;
     /**
      * Track down the ops size.
-    */
+     */
     private opsSize;
     private prevEnqueueMessagesReason;
     private previouslyProcessedMessage;
     private initSequenceNumber;
     private readonly _inbound;
     private readonly _inboundSignal;
-    private closed;
+    private _closed;
+    private _disposed;
     private handler;
     private deltaStorage;
     private readonly throttlingIdSet;
@@ -67,7 +88,6 @@ export declare class DeltaManager<TConnectionManager extends IConnectionManager>
     get lastSequenceNumber(): number;
     get lastMessage(): ISequencedDocumentMessage | undefined;
     get lastKnownSeqNumber(): number;
-    get referenceTerm(): number;
     get minimumSequenceNumber(): number;
     /**
      * Tells if  current connection has checkpoint information.
@@ -80,8 +100,8 @@ export declare class DeltaManager<TConnectionManager extends IConnectionManager>
     get outbound(): IDeltaQueue<IDocumentMessage[]>;
     get readOnlyInfo(): import("@fluidframework/container-definitions").ReadOnlyInfo;
     get clientDetails(): import("@fluidframework/protocol-definitions").IClientDetails;
-    submit(type: MessageType, contents: any, batch?: boolean, metadata?: any): number;
-    submitSignal(content: any): void;
+    submit(type: MessageType, contents?: string, batch?: boolean, metadata?: any, compression?: string, referenceSequenceNumber?: number): number;
+    submitSignal(content: any, targetClientId?: string): void;
     flush(): void;
     get connectionProps(): ITelemetryProperties;
     /**
@@ -91,19 +111,35 @@ export declare class DeltaManager<TConnectionManager extends IConnectionManager>
      * @param event - Event to log.
      */
     logConnectionIssue(event: ITelemetryErrorEvent): void;
-    constructor(serviceProvider: () => IDocumentService | undefined, logger: ITelemetryLogger, _active: () => boolean, createConnectionManager: (props: IConnectionManagerFactoryArgs) => TConnectionManager);
+    constructor(serviceProvider: () => IDocumentService | undefined, logger: ITelemetryLoggerExt, _active: () => boolean, createConnectionManager: (props: IConnectionManagerFactoryArgs) => TConnectionManager);
+    private cancelEstablishingConnection;
+    private establishingConnection;
     private connectHandler;
-    dispose(): void;
     /**
      * Sets the sequence number from which inbound messages should be returned
      */
-    attachOpHandler(minSequenceNumber: number, sequenceNumber: number, term: number, handler: IDeltaHandlerStrategy, prefetchType?: "cached" | "all" | "none"): Promise<void>;
+    attachOpHandler(minSequenceNumber: number, sequenceNumber: number, handler: IDeltaHandlerStrategy, prefetchType?: "sequenceNumber" | "cached" | "all" | "none"): Promise<void>;
     connect(args: IConnectionArgs): void;
     private getDeltas;
     /**
      * Closes the connection and clears inbound & outbound queues.
+     *
+     * Differences from dispose:
+     * - close will trigger readonly notification
+     * - close emits "closed"
+     * - close cannot be called after dispose
      */
     close(error?: ICriticalContainerError): void;
+    /**
+     * Disposes the connection and clears the inbound & outbound queues.
+     *
+     * Differences from close:
+     * - dispose will emit "disposed"
+     * - dispose will remove all listeners
+     * - dispose can be called after closure
+     */
+    dispose(error?: Error | ICriticalContainerError): void;
+    private clearQueues;
     refreshDelayInfo(id: string): void;
     private disconnectHandler;
     /**
@@ -121,8 +157,8 @@ export declare class DeltaManager<TConnectionManager extends IConnectionManager>
      */
     private fetchMissingDeltas;
     /**
-    * Retrieves the missing deltas between the given sequence numbers
-    */
+     * Retrieves the missing deltas between the given sequence numbers
+     */
     private fetchMissingDeltasCore;
     /**
      * Sorts pending ops and attempts to apply them

package/lib/deltaManager.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deltaManager.d.ts","sourceRoot":"","sources":["../src/deltaManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAGI,EACN,kBAAkB,EAClB,cAAc,EACd,oBAAoB,EACpB,oBAAoB,EAEpB,MAAM,iCAAiC;OACjC,EACN,uBAAuB,EACvB,aAAa,EACb,mBAAmB,EACnB,WAAW,EACX,MAAM,uCAAuC;OACvC,EAAE,iBAAiB,EAAE,MAAM,8BAA8B;OAEzD,EAMN,mBAAmB,EAInB,MAAM,iCAAiC;OACjC,EAEN,gBAAgB,EAEhB,MAAM,oCAAoC;OACpC,EACN,gBAAgB,EAChB,yBAAyB,EACzB,cAAc,EACd,WAAW,EACX,cAAc,EACd,MAAM,sCAAsC;OAGtC,EACN,0BAA0B,EAC1B,kBAAkB,EAClB,6BAA6B,EAC7B,4BAA4B,EAC5B;AAID,MAAM,WAAW,eAAe;IAC/B,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,MAAM,EAAE,4BAA4B,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACvE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,OAAE;IACpE,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,EAAE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,OAAE;IACpF,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,0BAA0B,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,OAAE;IAChG,CAAC,KAAK,EAAE,wBAAwB,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,4BAA4B,KAAK,IAAI,OAAE;IAC5F,CACC,KAAK,EAAE,8BAA8B,EACrC,QAAQ,EAAE,CAAC,MAAM,EAAE,4BAA4B,KAAK,IAAI,OACvD;CACF;AASD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACjD;AA4CD;;;GAGG;AACH,qBAAa,YAAY,CAAC,kBAAkB,SAAS,kBAAkB,CACtE,SAAQ,iBAAiB,CAAC,2BAA2B,CACrD,YACC,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EAC1D,cAAc,CAAC,2BAA2B,CAAC;IA8P3C,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO;IA9PzB,SAAgB,iBAAiB,EAAE,kBAAkB,CAAC;IAEtD,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED,IAAW,QAAQ,YAElB;IAED,IAAW,YAAY,SAEtB;IAED,OAAO,CAAC,OAAO,CAAmC;IAClD,OAAO,CAAC,WAAW,CAAqB;IAGxC,OAAO,CAAC,sBAAsB,CAAkB;IAGhD,OAAO,CAAC,iBAAiB,CAAa;IAStC,OAAO,CAAC,wBAAwB,CAAa;IAC7C,OAAO,CAAC,qBAAqB,CAAa;IAC1C,OAAO,CAAC,2BAA2B,CAAa;IAChD,OAAO,CAAC,oBAAoB,CAAwC;IAEpE,sEAAsE;IACtE,OAAO,CAAC,SAAS,CAAa;IAC9B,gDAAgD;IAChD,OAAO,CAAC,wBAAwB,CAAa;IAE7C;;OAEG;IACH,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,yBAAyB,CAAqB;IACtD,OAAO,CAAC,0BAA0B,CAAwC;IAK1E,OAAO,CAAC,kBAAkB,CAAa;IAEvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAwC;IACjE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA6B;IAE5D,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAS;IAE1B,OAAO,CAAC,OAAO,CAAoC;IACnD,OAAO,CAAC,YAAY,CAA2C;IAE/D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqB;IACrD,OAAO,CAAC,kBAAkB,CAAa;IAEvC,SAAgB,oBAAoB,kBAAyB;IAE7D,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAU;IAC9C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAE7C,OAAO,CAAC,aAAa,CAA0B;IAE/C,OAAO,CAAC,yBAAyB,CAAqB;IAEtD,IAAW,OAAO,IAAI,WAAW,CAAC,yBAAyB,CAAC,CAE3D;IAED,IAAW,aAAa,IAAI,WAAW,CAAC,cAAc,CAAC,CAEtD;IAED,IAAW,qBAAqB,IAAI,MAAM,CAEzC;IAED,IAAW,kBAAkB,IAAI,MAAM,CAEtC;IAED,IAAW,WAAW,0CAErB;IAED,IAAW,kBAAkB,WAE5B;IAED,IAAW,qBAAqB,IAAI,MAAM,CAEzC;IAED;;;OAGG;IACH,IAAW,2BAA2B,YAIrC;IAGD,IAAW,cAAc,IAAI,MAAM,CAElC;IACD,IAAW,OAAO,WAEjB;IACD,IAAW,oBAAoB,oFAE9B;IACD,IAAW,QAAQ,oCAElB;IACD,IAAW,YAAY,iEAEtB;IACD,IAAW,aAAa,kEAEvB;IAEM,MAAM,CACZ,IAAI,EAAE,WAAW,EACjB,QAAQ,CAAC,EAAE,MAAM,EACjB,KAAK,UAAQ,EACb,QAAQ,CAAC,EAAE,GAAG,EACd,WAAW,CAAC,EAAE,MAAM,EACpB,uBAAuB,CAAC,EAAE,MAAM;IAwC1B,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,MAAM;IAIlD,KAAK;IAgCZ,IAAW,eAAe,IAAI,oBAAoB,CAOjD;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,KAAK,EAAE,oBAAoB;gBAwBnC,eAAe,EAAE,MAAM,gBAAgB,GAAG,SAAS,EACnD,MAAM,EAAE,mBAAmB,EAC3B,OAAO,EAAE,MAAM,OAAO,EACvC,uBAAuB,EAAE,CAAC,KAAK,EAAE,6BAA6B,KAAK,kBAAkB;IA0EtF,OAAO,CAAC,4BAA4B;IAIpC,OAAO,CAAC,sBAAsB;IAI9B,OAAO,CAAC,cAAc;IAiDtB;;OAEG;IACU,eAAe,CAC3B,iBAAiB,EAAE,MAAM,EACzB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,qBAAqB,EAC9B,YAAY,GAAE,gBAAgB,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAe;IAuD7D,OAAO,CAAC,IAAI,EAAE,eAAe;YAyBtB,SAAS;IAyGvB;;;;;;;OAOG;IACI,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI;IAWnD;;;;;;;OAOG;IACI,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,uBAAuB,GAAG,IAAI;IAoB7D,OAAO,CAAC,WAAW;IAeZ,gBAAgB,CAAC,EAAE,EAAE,MAAM;IAOlC,OAAO,CAAC,iBAAiB;IAKzB;;;;;OAKG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;IAsBhE,OAAO,CAAC,wBAAwB;IAIhC,OAAO,CAAC,eAAe;IAyJvB,OAAO,CAAC,qBAAqB;IAoG7B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAM1B;;OAEG;YACW,sBAAsB;IA6DpC;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAgCzB,OAAO,CAAC,4BAA4B;CAKpC"}