@fluidframework/container-runtime 2.0.0-dev.1.4.6.106135 → 2.0.0-dev.2.3.0.115467

package/src/summarizerTypes.ts

@@ -61,12 +61,7 @@ export interface ISummarizerInternalsProvider {
     submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
 
     /** Callback whenever a new SummaryAck is received, to update internal tracking state */
-    refreshLatestSummaryAck(
-        proposalHandle: string,
-        ackHandle: string,
-        summaryRefSeq: number,
-        summaryLogger: ITelemetryLogger,
-    ): Promise<void>;
+    refreshLatestSummaryAck(options: IRefreshSummaryAckOptions): Promise<void>;
 }
 
 /**
@@ -114,6 +109,20 @@ export interface ISummarizeOptions {
     readonly refreshLatestAck?: boolean;
 }
 
+/**
+ * Data required to update internal tracking state after receiving a Summary Ack.
+ */
+ export interface IRefreshSummaryAckOptions {
+    /** Handle from the ack's summary op. */
+    readonly proposalHandle: string | undefined;
+    /** Handle from the summary ack just received */
+    readonly ackHandle: string;
+    /** Reference sequence number from the ack's summary op */
+    readonly summaryRefSeq: number;
+    /** Telemetry logger to which telemetry events will be forwarded. */
+    readonly summaryLogger: ITelemetryLogger;
+}
+
 export interface ISubmitSummaryOptions extends ISummarizeOptions {
     /** Logger to use for correlated summary events */
     readonly summaryLogger: ITelemetryLogger;
@@ -292,7 +301,11 @@ export type SummarizerStopReason =
      * client to no longer be elected as responsible for summaries. Then it
      * tries to stop its spawned summarizer client.
      */
-    | "parentShouldNotSummarize"
+    | "notElectedParent"
+    /**
+     * We are not already running the summarizer and we are not the current elected client id.
+     */
+    | "notElectedClient"
     /** Summarizer client was disconnected */
     | "summarizerClientDisconnected"
     /* running summarizer threw an exception */

package/src/summaryFormat.ts

@@ -8,7 +8,7 @@ import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import { readAndParse } from "@fluidframework/driver-utils";
 import { ISequencedDocumentMessage, ISnapshotTree, SummaryType } from "@fluidframework/protocol-definitions";
 import { channelsTreeName, ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
-import { gcTreeKey } from "./garbageCollection";
+import { gcTreeKey } from "./garbageCollectionConstants";
 
 type OmitAttributesVersions<T> = Omit<T, "snapshotFormatVersion" | "summaryFormatVersion">;
 interface IFluidDataStoreAttributes0 {
@@ -99,14 +99,16 @@ export interface IGCMetadata {
      * - A value greater than 0 means GC is enabled.
      */
     readonly gcFeature?: GCVersion;
-    /** If this is present, the session for this container will expire after this time and the container will close */
-    readonly sessionExpiryTimeoutMs?: number;
     /**
      * Tells whether the GC sweep phase is enabled for this container.
      * - True means sweep phase is enabled.
      * - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.
      */
     readonly sweepEnabled?: boolean;
+    /** If this is present, the session for this container will expire after this time and the container will close */
+    readonly sessionExpiryTimeoutMs?: number;
+    /** How long to wait after an object is unreferenced before deleting it via GC Sweep */
+    readonly sweepTimeoutMs?: number;
 }
 
 /** The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary. */

package/src/summaryGenerator.ts

@@ -231,13 +231,14 @@ export class SummaryGenerator {
             const category = cancellationToken.cancelled || error?.errorType === DriverErrorType.offlineError ?
                 "generic" : "error";
 
+            const message = getFailMessage(errorCode);
             summarizeEvent.cancel({
                  ...properties,
                  reason: errorCode,
                  category,
                  retryAfterSeconds,
-            }, error);
-            resultsBuilder.fail(getFailMessage(errorCode), error, nackSummaryResult, retryAfterSeconds);
+            }, error ?? message); // disconnect & summaryAckTimeout do not have proper error.
+            resultsBuilder.fail(message, error, nackSummaryResult, retryAfterSeconds);
         };
 
         // Wait to generate and send summary

package/src/summaryManager.ts

@@ -29,7 +29,8 @@ export enum SummaryManagerState {
 // Please note that all reasons in this list are not errors,
 // and thus they are not raised today to parent container as error.
 // If this needs to be changed in future, we should re-evaluate what and how we raise to summarizer
-type StopReason = Extract<SummarizerStopReason, "parentNotConnected" | "parentShouldNotSummarize">;
+type StopReason = Extract<SummarizerStopReason,
+    "parentNotConnected" | "notElectedParent" | "notElectedClient">;
 type ShouldSummarizeState =
     | { shouldSummarize: true; }
     | { shouldSummarize: false; stopReason: StopReason; };
@@ -141,13 +142,23 @@ export class SummaryManager implements IDisposable {
         // enforce connectedState.clientId === clientElection.electedClientId. But once we're Running, we should
         // only transition to Stopping when the electedParentId changes. Stopping the summarizer without
         // changing the electedParent will just cause us to transition to Starting again.
-        if (this.connectedState.clientId !== this.clientElection.electedParentId ||
-            (this.state !== SummaryManagerState.Running &&
-                this.connectedState.clientId !== this.clientElection.electedClientId)) {
-            return { shouldSummarize: false, stopReason: "parentShouldNotSummarize" };
-        } else if (!this.connectedState.connected) {
+
+        // New Parent has been elected and it is not the current client, or
+        if (this.connectedState.clientId !== this.clientElection.electedParentId) {
+            return { shouldSummarize: false, stopReason: "notElectedParent" };
+        }
+
+        // We are not already running the summarizer and we are not the current elected client id.
+        if (this.state !== SummaryManagerState.Running &&
+                this.connectedState.clientId !== this.clientElection.electedClientId) {
+            return { shouldSummarize: false, stopReason: "notElectedClient" };
+        }
+
+        if (!this.connectedState.connected) {
             return { shouldSummarize: false, stopReason: "parentNotConnected" };
-        } else if (this.disposed) {
+        }
+
+        if (this.disposed) {
             assert(false, 0x260 /* "Disposed should mean disconnected!" */);
         } else {
             return { shouldSummarize: true };

package/dist/batchManager.d.ts

@@ -1,37 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IBatchMessage } from "@fluidframework/container-definitions";
-import { ContainerRuntimeMessage } from "./containerRuntime";
-/**
- * Message type used by BatchManager
- */
-export declare type BatchMessage = IBatchMessage & {
-    localOpMetadata: unknown;
-    deserializedContent: ContainerRuntimeMessage;
-    referenceSequenceNumber: number;
-};
-/**
- * Helper class that manages partial batch & rollback.
- */
-export declare class BatchManager {
-    readonly softLimit?: number | undefined;
-    private pendingBatch;
-    private batchContentSize;
-    private static readonly hardLimit;
-    get length(): number;
-    get limit(): number;
-    static get limit(): number;
-    constructor(softLimit?: number | undefined);
-    push(message: BatchMessage): boolean;
-    get empty(): boolean;
-    popBatch(): BatchMessage[];
-    /**
-     * Capture the pending state at this point
-     */
-    checkpoint(): {
-        rollback: (process: (message: BatchMessage) => void) => void;
-    };
-}
-//# sourceMappingURL=batchManager.d.ts.map

package/dist/batchManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchManager.d.ts","sourceRoot":"","sources":["../src/batchManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE7D;;GAEG;AACH,oBAAY,YAAY,GAAG,aAAa,GAAG;IACvC,eAAe,EAAE,OAAO,CAAC;IACzB,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,uBAAuB,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,qBAAa,YAAY;aAcO,SAAS,CAAC;IAbtC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,gBAAgB,CAAK;IAM7B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAc;IAE/C,IAAW,MAAM,WAAuC;IACxD,IAAW,KAAK,WAAqC;IACrD,WAAkB,KAAK,WAAqC;gBAEhC,SAAS,CAAC,oBAAQ;IAEvC,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO;IA2B3C,IAAW,KAAK,YAA6C;IAEtD,QAAQ;IAOf;;OAEG;IACK,UAAU;sCAGoB,YAAY,KAAK,IAAI;;CAY9D"}

package/dist/batchManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchManager.js","sourceRoot":"","sources":["../src/batchManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAcH;;GAEG;AACH,MAAa,YAAY;IAcrB,YAA4B,SAAkB;QAAlB,cAAS,GAAT,SAAS,CAAS;QAbtC,iBAAY,GAAoB,EAAE,CAAC;QACnC,qBAAgB,GAAG,CAAC,CAAC;IAYoB,CAAC;IAJlD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD,IAAW,KAAK,KAAK,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9C,MAAM,KAAK,KAAK,KAAK,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAIrD,IAAI,CAAC,OAAqB;QAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;QACpE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QAEzC,2DAA2D;QAC3D,iEAAiE;QACjE,sGAAsG;QACtG,iGAAiG;QACjG,gFAAgF;QAChF,MAAM,iBAAiB,GAAG,WAAW,GAAG,GAAG,GAAG,OAAO,CAAC;QAEtD,0DAA0D;QAC1D,wGAAwG;QACxG,0DAA0D;QAC1D,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,iBAAiB,IAAI,IAAI,CAAC,SAAS,EAAE;YACxF,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,iBAAiB,IAAI,IAAI,CAAC,KAAK,EAAE;YACjC,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC;QACpC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IAEtD,QAAQ;QACX,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAC1B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACK,UAAU;QACd,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QAC5C,OAAO;YACH,QAAQ,EAAE,CAAC,OAAwC,EAAE,EAAE;gBACnD,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,GAAG,UAAU,GAAG;oBACpD,CAAC,EAAE,CAAC;oBACJ,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;oBACrC,IAAI,CAAC,gBAAgB,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;oBACjD,OAAO,CAAC,OAAO,CAAC,CAAC;iBACpB;gBAED,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,UAAU,CAAC;YAC1C,CAAC;SACJ,CAAC;IACN,CAAC;;AArEL,oCAsEC;AAlEG,uDAAuD;AACvD,oCAAoC;AACpC,uDAAuD;AACvD,uFAAuF;AAC/D,sBAAS,GAAG,GAAG,GAAG,IAAI,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IBatchMessage } from \"@fluidframework/container-definitions\";\nimport { ContainerRuntimeMessage } from \"./containerRuntime\";\n\n/**\n * Message type used by BatchManager\n */\nexport type BatchMessage = IBatchMessage & {\n    localOpMetadata: unknown;\n    deserializedContent: ContainerRuntimeMessage;\n    referenceSequenceNumber: number;\n};\n\n/**\n * Helper class that manages partial batch & rollback.\n */\nexport class BatchManager {\n    private pendingBatch: BatchMessage [] = [];\n    private batchContentSize = 0;\n\n    // The actual limit is 1Mb (socket.io and Kafka limits)\n    // We can't estimate it fully, as we\n    // - do not know what properties relay service will add\n    // - we do not stringify final op, thus we do not know how much escaping will be added.\n    private static readonly hardLimit = 950 * 1024;\n\n    public get length() { return this.pendingBatch.length; }\n    public get limit() { return BatchManager.hardLimit; }\n    public static get limit() { return BatchManager.hardLimit; }\n\n    constructor(public readonly softLimit?: number) {}\n\n    public push(message: BatchMessage): boolean {\n        const contentSize = this.batchContentSize + message.contents.length;\n        const opCount = this.pendingBatch.length;\n\n        // Attempt to estimate batch size, aka socket message size.\n        // Each op has pretty large envelope, estimating to be 200 bytes.\n        // Also content will be strigified, and that adds a lot of overhead due to a lot of escape characters.\n        // Not taking it into account, as compression work should help there - compressed payload will be\n        // initially stored as base64, and that requires only 2 extra escape characters.\n        const socketMessageSize = contentSize + 200 * opCount;\n\n        // If we were provided soft limit, check for exceeding it.\n        // But only if we have any ops, as the intention here is to flush existing ops (on exceeding this limit)\n        // and start over. That's not an option if we have no ops.\n        if (this.softLimit !== undefined && this.length > 0 && socketMessageSize >= this.softLimit) {\n            return false;\n        }\n\n        if (socketMessageSize >= this.limit) {\n            return false;\n        }\n\n        this.batchContentSize = contentSize;\n        this.pendingBatch.push(message);\n        return true;\n    }\n\n    public get empty() { return this.pendingBatch.length === 0; }\n\n    public popBatch() {\n        const batch = this.pendingBatch;\n        this.pendingBatch = [];\n        this.batchContentSize = 0;\n        return batch;\n    }\n\n    /**\n     * Capture the pending state at this point\n     */\n     public checkpoint() {\n        const startPoint = this.pendingBatch.length;\n        return {\n            rollback: (process: (message: BatchMessage) => void) => {\n                for (let i = this.pendingBatch.length; i > startPoint;) {\n                    i--;\n                    const message = this.pendingBatch[i];\n                    this.batchContentSize -= message.contents.length;\n                    process(message);\n                }\n\n                this.pendingBatch.length = startPoint;\n            },\n        };\n    }\n}\n"]}

package/lib/batchManager.d.ts

@@ -1,37 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IBatchMessage } from "@fluidframework/container-definitions";
-import { ContainerRuntimeMessage } from "./containerRuntime";
-/**
- * Message type used by BatchManager
- */
-export declare type BatchMessage = IBatchMessage & {
-    localOpMetadata: unknown;
-    deserializedContent: ContainerRuntimeMessage;
-    referenceSequenceNumber: number;
-};
-/**
- * Helper class that manages partial batch & rollback.
- */
-export declare class BatchManager {
-    readonly softLimit?: number | undefined;
-    private pendingBatch;
-    private batchContentSize;
-    private static readonly hardLimit;
-    get length(): number;
-    get limit(): number;
-    static get limit(): number;
-    constructor(softLimit?: number | undefined);
-    push(message: BatchMessage): boolean;
-    get empty(): boolean;
-    popBatch(): BatchMessage[];
-    /**
-     * Capture the pending state at this point
-     */
-    checkpoint(): {
-        rollback: (process: (message: BatchMessage) => void) => void;
-    };
-}
-//# sourceMappingURL=batchManager.d.ts.map

package/lib/batchManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchManager.d.ts","sourceRoot":"","sources":["../src/batchManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE7D;;GAEG;AACH,oBAAY,YAAY,GAAG,aAAa,GAAG;IACvC,eAAe,EAAE,OAAO,CAAC;IACzB,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,uBAAuB,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,qBAAa,YAAY;aAcO,SAAS,CAAC;IAbtC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,gBAAgB,CAAK;IAM7B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAc;IAE/C,IAAW,MAAM,WAAuC;IACxD,IAAW,KAAK,WAAqC;IACrD,WAAkB,KAAK,WAAqC;gBAEhC,SAAS,CAAC,oBAAQ;IAEvC,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO;IA2B3C,IAAW,KAAK,YAA6C;IAEtD,QAAQ;IAOf;;OAEG;IACK,UAAU;sCAGoB,YAAY,KAAK,IAAI;;CAY9D"}

package/lib/batchManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchManager.js","sourceRoot":"","sources":["../src/batchManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAcH;;GAEG;AACH,MAAM,OAAO,YAAY;IAcrB,YAA4B,SAAkB;QAAlB,cAAS,GAAT,SAAS,CAAS;QAbtC,iBAAY,GAAoB,EAAE,CAAC;QACnC,qBAAgB,GAAG,CAAC,CAAC;IAYoB,CAAC;IAJlD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD,IAAW,KAAK,KAAK,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9C,MAAM,KAAK,KAAK,KAAK,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAIrD,IAAI,CAAC,OAAqB;QAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;QACpE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QAEzC,2DAA2D;QAC3D,iEAAiE;QACjE,sGAAsG;QACtG,iGAAiG;QACjG,gFAAgF;QAChF,MAAM,iBAAiB,GAAG,WAAW,GAAG,GAAG,GAAG,OAAO,CAAC;QAEtD,0DAA0D;QAC1D,wGAAwG;QACxG,0DAA0D;QAC1D,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,iBAAiB,IAAI,IAAI,CAAC,SAAS,EAAE;YACxF,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,iBAAiB,IAAI,IAAI,CAAC,KAAK,EAAE;YACjC,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC;QACpC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IAEtD,QAAQ;QACX,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAC1B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACK,UAAU;QACd,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QAC5C,OAAO;YACH,QAAQ,EAAE,CAAC,OAAwC,EAAE,EAAE;gBACnD,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,GAAG,UAAU,GAAG;oBACpD,CAAC,EAAE,CAAC;oBACJ,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;oBACrC,IAAI,CAAC,gBAAgB,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;oBACjD,OAAO,CAAC,OAAO,CAAC,CAAC;iBACpB;gBAED,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,UAAU,CAAC;YAC1C,CAAC;SACJ,CAAC;IACN,CAAC;;AAjED,uDAAuD;AACvD,oCAAoC;AACpC,uDAAuD;AACvD,uFAAuF;AAC/D,sBAAS,GAAG,GAAG,GAAG,IAAI,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IBatchMessage } from \"@fluidframework/container-definitions\";\nimport { ContainerRuntimeMessage } from \"./containerRuntime\";\n\n/**\n * Message type used by BatchManager\n */\nexport type BatchMessage = IBatchMessage & {\n    localOpMetadata: unknown;\n    deserializedContent: ContainerRuntimeMessage;\n    referenceSequenceNumber: number;\n};\n\n/**\n * Helper class that manages partial batch & rollback.\n */\nexport class BatchManager {\n    private pendingBatch: BatchMessage [] = [];\n    private batchContentSize = 0;\n\n    // The actual limit is 1Mb (socket.io and Kafka limits)\n    // We can't estimate it fully, as we\n    // - do not know what properties relay service will add\n    // - we do not stringify final op, thus we do not know how much escaping will be added.\n    private static readonly hardLimit = 950 * 1024;\n\n    public get length() { return this.pendingBatch.length; }\n    public get limit() { return BatchManager.hardLimit; }\n    public static get limit() { return BatchManager.hardLimit; }\n\n    constructor(public readonly softLimit?: number) {}\n\n    public push(message: BatchMessage): boolean {\n        const contentSize = this.batchContentSize + message.contents.length;\n        const opCount = this.pendingBatch.length;\n\n        // Attempt to estimate batch size, aka socket message size.\n        // Each op has pretty large envelope, estimating to be 200 bytes.\n        // Also content will be strigified, and that adds a lot of overhead due to a lot of escape characters.\n        // Not taking it into account, as compression work should help there - compressed payload will be\n        // initially stored as base64, and that requires only 2 extra escape characters.\n        const socketMessageSize = contentSize + 200 * opCount;\n\n        // If we were provided soft limit, check for exceeding it.\n        // But only if we have any ops, as the intention here is to flush existing ops (on exceeding this limit)\n        // and start over. That's not an option if we have no ops.\n        if (this.softLimit !== undefined && this.length > 0 && socketMessageSize >= this.softLimit) {\n            return false;\n        }\n\n        if (socketMessageSize >= this.limit) {\n            return false;\n        }\n\n        this.batchContentSize = contentSize;\n        this.pendingBatch.push(message);\n        return true;\n    }\n\n    public get empty() { return this.pendingBatch.length === 0; }\n\n    public popBatch() {\n        const batch = this.pendingBatch;\n        this.pendingBatch = [];\n        this.batchContentSize = 0;\n        return batch;\n    }\n\n    /**\n     * Capture the pending state at this point\n     */\n     public checkpoint() {\n        const startPoint = this.pendingBatch.length;\n        return {\n            rollback: (process: (message: BatchMessage) => void) => {\n                for (let i = this.pendingBatch.length; i > startPoint;) {\n                    i--;\n                    const message = this.pendingBatch[i];\n                    this.batchContentSize -= message.contents.length;\n                    process(message);\n                }\n\n                this.pendingBatch.length = startPoint;\n            },\n        };\n    }\n}\n"]}