@fluidframework/container-runtime 2.0.0-internal.2.1.1 → 2.0.0-internal.2.2.0

package/dist/gcSweepReadyUsageDetection.js

@@ -6,7 +6,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SweepReadyUsageDetectionHandler = exports.SweepReadyUsageError = exports.closuresMapLocalStorageKey = exports.skipClosureForXDaysKey = void 0;
 const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
-const garbageCollection_1 = require("./garbageCollection");
+const garbageCollectionConstants_1 = require("./garbageCollectionConstants");
 /**
  * Feature Gate Key -
  * How many days between closing the container from this error (avoids locking user out of their file altogether)
@@ -104,7 +104,7 @@ class SweepReadyUsageDetectionHandler {
             }
             lastCloseTime = (_a = pastClosuresMap[this.uniqueContainerKey]) === null || _a === void 0 ? void 0 : _a.lastCloseTime;
             // Don't close if we did already within the Skip Closure Period
-            if (lastCloseTime !== undefined && Date.now() < lastCloseTime + skipClosureForXDays * garbageCollection_1.oneDayMs) {
+            if (lastCloseTime !== undefined && Date.now() < lastCloseTime + skipClosureForXDays * garbageCollectionConstants_1.oneDayMs) {
                 shouldClose = false;
             }
         }

package/dist/gcSweepReadyUsageDetection.js.map

@@ -1 +1 @@
-{"version":3,"file":"gcSweepReadyUsageDetection.js","sourceRoot":"","sources":["../src/gcSweepReadyUsageDetection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,qEAKyC;AACzC,2DAA+C;AAE/C;;;GAGG;AACU,QAAA,sBAAsB,GAAG,8EAA8E,CAAC;AAErH;;;GAGG;AACU,QAAA,0BAA0B,GAAG,mEAAmE,CAAC;AAE9G;;;GAGG;AACH,MAAM,+BAA+B,GAAG;IACpC,IAAI,CAAC,MAAuB;QACxB,MAAM,2BAA2B,GAAG,0DAA0D,CAAC;QAC/F,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QAC5D,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;SAC1D;QACD,OAAO;YACH,iBAAiB,EAAE,KAAK,CAAC,QAAQ,CAAC,mBAAmB,CAAC;YACtD,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC;SAC3C,CAAC;IACN,CAAC;CACJ,CAAC;AAEF;;;;;;;GAOG;AACH,MAAa,oBAAqB,SAAQ,8BAAY;IAAtD;;QACI,oHAAoH;QAC7G,cAAS,GAAW,6CAA6C,CAAC;IAC7E,CAAC;CAAA;AAHD,oDAGC;AAED;;;;;;;GAOG;AACH,MAAa,+BAA+B;IAGxC,YACqB,kBAA0B,EAC1B,EAAqB,EACrB,OAAkD,EACnE,oBAA2D;;QAH1C,uBAAkB,GAAlB,kBAAkB,CAAQ;QAC1B,OAAE,GAAF,EAAE,CAAmB;QACrB,YAAO,GAAP,OAAO,CAA2C;QAGnE,MAAM,WAAW,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC;QAC/D,0FAA0F;QAC1F,IAAI,CAAC,YAAY,GAAG,MAAA,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,UAAU,CAAC,YAAY,mCAAI,WAAW,CAAC;QAEnF,IAAI,IAAI,CAAC,YAAY,KAAK,WAAW,EAAE;YACnC,0DAA0D;YAC1D,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,4CAA4C,EAAE,CAAC,CAAC;SAClG;IACL,CAAC;IAED;;;;;;OAMG;IACI,gCAAgC,CAAC,UAAgC;;QACpE,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE;YACzE,OAAO;SACV;QAED,iGAAiG;QACjG,gGAAgG;QAChG,oGAAoG;QACpG,IAAI,WAAW,GAAY,IAAI,CAAC;QAChC,IAAI,eAAe,GAA2D,EAAE,CAAC;QACjF,IAAI,aAAiC,CAAC;QACtC,MAAM,mBAAmB,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,8BAAsB,CAAC,CAAC;QAC7E,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,qFAAqF;YACrF,IAAI;gBACA,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,kCAA0B,CAAC,CAAC;gBACvE,MAAM,WAAW,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAClE,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;oBACjC,eAAe,GAAG,WAAW,CAAC;iBACjC;aACJ;YAAC,OAAO,CAAC,EAAE;aACX;YACD,aAAa,GAAG,MAAA,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,0CAAE,aAAa,CAAC;YAExE,+DAA+D;YAC/D,IAAI,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,aAAa,GAAG,mBAAmB,GAAG,4BAAQ,EAAE;gBAC5F,WAAW,GAAG,KAAK,CAAC;aACvB;SACJ;QAED,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAClC,iDAAiD,EACjD,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,iCAAM,UAAU,KAAE,aAAa,EAAE,mBAAmB,IAAG,EAAE,CAC1F,CAAC;QACF,IAAI,WAAW,EAAE;YACb,qDAAqD;YACrD,8FAA8F;YAC9F,mGAAmG;YACnG,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACzE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,kCAA0B,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;YAEvF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACvB;aAAM;YACH,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,+BAA+B,EAAE,EAAE,KAAK,CAAC,CAAC;SACxF;IACL,CAAC;CACJ;AAxED,0EAwEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport {\n    IConfigProvider,\n    IFluidErrorBase,\n    LoggingError,\n    MonitoringContext,\n} from \"@fluidframework/telemetry-utils\";\nimport { oneDayMs } from \"./garbageCollection\";\n\n/**\n * Feature Gate Key -\n * How many days between closing the container from this error (avoids locking user out of their file altogether)\n */\nexport const skipClosureForXDaysKey = \"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.SkipClosureForXDays\";\n\n/**\n * LocalStorage key (NOT via feature gate / monitoring context)\n * A map from docId to info about the last time we closed due to this error\n */\nexport const closuresMapLocalStorageKey = \"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.Closures\";\n\n/**\n * Feature gate key to enable closing the container if SweepReady objects are used.\n * Value should contain keywords \"interactiveClient\" and/or \"summarizer\" to enable detection in each container type\n */\nconst sweepReadyUsageDetectionSetting = {\n    read(config: IConfigProvider) {\n        const sweepReadyUsageDetectionKey = \"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection\";\n        const value = config.getString(sweepReadyUsageDetectionKey);\n        if (value === undefined) {\n            return { interactiveClient: false, summarizer: false };\n        }\n        return {\n            interactiveClient: value.includes(\"interactiveClient\"),\n            summarizer: value.includes(\"summarizer\"),\n        };\n    },\n};\n\n/**\n * Error class raised when a SweepReady object is used, indicating a bug in how\n * references are managed in the container by the application, or a bug in how\n * GC tracks those references.\n *\n * There's a chance for false positives when this error is raised by an Interactive Container,\n * since only the Summarizer has the latest truth about unreferenced node tracking\n */\nexport class SweepReadyUsageError extends LoggingError implements IFluidErrorBase {\n    /** This errorType will be in temporary use (until Sweep is fully implemented) so don't add to any errorType type */\n    public errorType: string = \"unreferencedObjectUsedAfterGarbageCollected\";\n}\n\n/**\n * This class encapsulates the logic around what to do when a SweepReady object is used.\n * There are several tactics we plan to use in Dogfood environments to aid diagnosis of these cases:\n * - Closing the interactive container when either the interactive or summarizer client detects this kind of violation\n * (via sweepReadyUsageDetectionSetting above)\n * - Throttling the frequency of these crashes via a \"Skip Closure Period\" per container per device\n * (via skipClosureForXDaysKey above.  Uses localStorage and closuresMapLocalStorageKey to implement this behavior)\n */\nexport class SweepReadyUsageDetectionHandler {\n    private readonly localStorage: Pick<Storage, \"getItem\" | \"setItem\">;\n\n    constructor(\n        private readonly uniqueContainerKey: string,\n        private readonly mc: MonitoringContext,\n        private readonly closeFn: (error?: ICriticalContainerError) => void,\n        localStorageOverride?: Pick<Storage, \"getItem\" | \"setItem\">,\n    ) {\n        const noopStorage = { getItem: () => null, setItem: () => {} };\n        // localStorage is not defined in Node environment, so fall back to noopStorage if needed.\n        this.localStorage = localStorageOverride ?? globalThis.localStorage ?? noopStorage;\n\n        if (this.localStorage === noopStorage) {\n            // This means the Skip Closure Period logic will not work.\n            this.mc.logger.sendTelemetryEvent({ eventName: \"SweepReadyUsageDetectionHandlerNoopStorage\" });\n        }\n    }\n\n    /**\n      * If SweepReady Usage Detection is enabled, close the interactive container.\n      * If the SkipClosureForXDays setting is set, don't close the container more than once in that period.\n      *\n      * Once Sweep is fully implemented, this will be removed since the objects will be gone\n      * and errors will arise elsewhere in the runtime\n     */\n    public usageDetectedInInteractiveClient(errorProps: ITelemetryProperties) {\n        if (!sweepReadyUsageDetectionSetting.read(this.mc.config).interactiveClient) {\n            return;\n        }\n\n        // Default stance is we close every time - this reflects the severity of SweepReady Object Usage.\n        // However, we may choose to \"throttle\" the closures by setting the SkipClosureForXDays setting,\n        // which will only allow the container to close once during that period, to avoid locking users out.\n        let shouldClose: boolean = true;\n        let pastClosuresMap: Record<string, { lastCloseTime: number; } | undefined> = {};\n        let lastCloseTime: number | undefined;\n        const skipClosureForXDays = this.mc.config.getNumber(skipClosureForXDaysKey);\n        if (skipClosureForXDays !== undefined) {\n            // Read pastClosuresMap from localStorage then extract the lastCloseTime from the map\n            try {\n                const rawValue = this.localStorage.getItem(closuresMapLocalStorageKey);\n                const parsedValue = rawValue === null ? {} : JSON.parse(rawValue);\n                if (typeof parsedValue === \"object\") {\n                    pastClosuresMap = parsedValue;\n                }\n            } catch (e) {\n            }\n            lastCloseTime = pastClosuresMap[this.uniqueContainerKey]?.lastCloseTime;\n\n            // Don't close if we did already within the Skip Closure Period\n            if (lastCloseTime !== undefined && Date.now() < lastCloseTime + skipClosureForXDays * oneDayMs) {\n                shouldClose = false;\n            }\n        }\n\n        const error = new SweepReadyUsageError(\n            \"SweepReady object used in Non-Summarizer Client\",\n            { errorDetails: JSON.stringify({ ...errorProps, lastCloseTime, skipClosureForXDays }) },\n        );\n        if (shouldClose) {\n            // Update closures map in localStorage before closing\n            // Note there is a race condition between different tabs updating localStorage and overwriting\n            // each others' updates. If so, some tab will crash again. Just reload one at a time to get unstuck\n            pastClosuresMap[this.uniqueContainerKey] = { lastCloseTime: Date.now() };\n            this.localStorage.setItem(closuresMapLocalStorageKey, JSON.stringify(pastClosuresMap));\n\n            this.closeFn(error);\n        } else {\n            this.mc.logger.sendErrorEvent({ eventName: \"SweepReadyObject_UsageAllowed\" }, error);\n        }\n    }\n}\n"]}
+{"version":3,"file":"gcSweepReadyUsageDetection.js","sourceRoot":"","sources":["../src/gcSweepReadyUsageDetection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,qEAKyC;AACzC,6EAAwD;AAExD;;;GAGG;AACU,QAAA,sBAAsB,GAAG,8EAA8E,CAAC;AAErH;;;GAGG;AACU,QAAA,0BAA0B,GAAG,mEAAmE,CAAC;AAE9G;;;GAGG;AACH,MAAM,+BAA+B,GAAG;IACpC,IAAI,CAAC,MAAuB;QACxB,MAAM,2BAA2B,GAAG,0DAA0D,CAAC;QAC/F,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QAC5D,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;SAC1D;QACD,OAAO;YACH,iBAAiB,EAAE,KAAK,CAAC,QAAQ,CAAC,mBAAmB,CAAC;YACtD,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC;SAC3C,CAAC;IACN,CAAC;CACJ,CAAC;AAEF;;;;;;;GAOG;AACH,MAAa,oBAAqB,SAAQ,8BAAY;IAAtD;;QACI,oHAAoH;QAC7G,cAAS,GAAW,6CAA6C,CAAC;IAC7E,CAAC;CAAA;AAHD,oDAGC;AAED;;;;;;;GAOG;AACH,MAAa,+BAA+B;IAGxC,YACqB,kBAA0B,EAC1B,EAAqB,EACrB,OAAkD,EACnE,oBAA2D;;QAH1C,uBAAkB,GAAlB,kBAAkB,CAAQ;QAC1B,OAAE,GAAF,EAAE,CAAmB;QACrB,YAAO,GAAP,OAAO,CAA2C;QAGnE,MAAM,WAAW,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC;QAC/D,0FAA0F;QAC1F,IAAI,CAAC,YAAY,GAAG,MAAA,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,UAAU,CAAC,YAAY,mCAAI,WAAW,CAAC;QAEnF,IAAI,IAAI,CAAC,YAAY,KAAK,WAAW,EAAE;YACnC,0DAA0D;YAC1D,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,4CAA4C,EAAE,CAAC,CAAC;SAClG;IACL,CAAC;IAED;;;;;;OAMG;IACI,gCAAgC,CAAC,UAAgC;;QACpE,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE;YACzE,OAAO;SACV;QAED,iGAAiG;QACjG,gGAAgG;QAChG,oGAAoG;QACpG,IAAI,WAAW,GAAY,IAAI,CAAC;QAChC,IAAI,eAAe,GAA2D,EAAE,CAAC;QACjF,IAAI,aAAiC,CAAC;QACtC,MAAM,mBAAmB,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,8BAAsB,CAAC,CAAC;QAC7E,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,qFAAqF;YACrF,IAAI;gBACA,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,kCAA0B,CAAC,CAAC;gBACvE,MAAM,WAAW,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAClE,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;oBACjC,eAAe,GAAG,WAAW,CAAC;iBACjC;aACJ;YAAC,OAAO,CAAC,EAAE;aACX;YACD,aAAa,GAAG,MAAA,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,0CAAE,aAAa,CAAC;YAExE,+DAA+D;YAC/D,IAAI,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,aAAa,GAAG,mBAAmB,GAAG,qCAAQ,EAAE;gBAC5F,WAAW,GAAG,KAAK,CAAC;aACvB;SACJ;QAED,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAClC,iDAAiD,EACjD,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,iCAAM,UAAU,KAAE,aAAa,EAAE,mBAAmB,IAAG,EAAE,CAC1F,CAAC;QACF,IAAI,WAAW,EAAE;YACb,qDAAqD;YACrD,8FAA8F;YAC9F,mGAAmG;YACnG,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACzE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,kCAA0B,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;YAEvF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACvB;aAAM;YACH,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,+BAA+B,EAAE,EAAE,KAAK,CAAC,CAAC;SACxF;IACL,CAAC;CACJ;AAxED,0EAwEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport {\n    IConfigProvider,\n    IFluidErrorBase,\n    LoggingError,\n    MonitoringContext,\n} from \"@fluidframework/telemetry-utils\";\nimport { oneDayMs } from \"./garbageCollectionConstants\";\n\n/**\n * Feature Gate Key -\n * How many days between closing the container from this error (avoids locking user out of their file altogether)\n */\nexport const skipClosureForXDaysKey = \"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.SkipClosureForXDays\";\n\n/**\n * LocalStorage key (NOT via feature gate / monitoring context)\n * A map from docId to info about the last time we closed due to this error\n */\nexport const closuresMapLocalStorageKey = \"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.Closures\";\n\n/**\n * Feature gate key to enable closing the container if SweepReady objects are used.\n * Value should contain keywords \"interactiveClient\" and/or \"summarizer\" to enable detection in each container type\n */\nconst sweepReadyUsageDetectionSetting = {\n    read(config: IConfigProvider) {\n        const sweepReadyUsageDetectionKey = \"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection\";\n        const value = config.getString(sweepReadyUsageDetectionKey);\n        if (value === undefined) {\n            return { interactiveClient: false, summarizer: false };\n        }\n        return {\n            interactiveClient: value.includes(\"interactiveClient\"),\n            summarizer: value.includes(\"summarizer\"),\n        };\n    },\n};\n\n/**\n * Error class raised when a SweepReady object is used, indicating a bug in how\n * references are managed in the container by the application, or a bug in how\n * GC tracks those references.\n *\n * There's a chance for false positives when this error is raised by an Interactive Container,\n * since only the Summarizer has the latest truth about unreferenced node tracking\n */\nexport class SweepReadyUsageError extends LoggingError implements IFluidErrorBase {\n    /** This errorType will be in temporary use (until Sweep is fully implemented) so don't add to any errorType type */\n    public errorType: string = \"unreferencedObjectUsedAfterGarbageCollected\";\n}\n\n/**\n * This class encapsulates the logic around what to do when a SweepReady object is used.\n * There are several tactics we plan to use in Dogfood environments to aid diagnosis of these cases:\n * - Closing the interactive container when either the interactive or summarizer client detects this kind of violation\n * (via sweepReadyUsageDetectionSetting above)\n * - Throttling the frequency of these crashes via a \"Skip Closure Period\" per container per device\n * (via skipClosureForXDaysKey above.  Uses localStorage and closuresMapLocalStorageKey to implement this behavior)\n */\nexport class SweepReadyUsageDetectionHandler {\n    private readonly localStorage: Pick<Storage, \"getItem\" | \"setItem\">;\n\n    constructor(\n        private readonly uniqueContainerKey: string,\n        private readonly mc: MonitoringContext,\n        private readonly closeFn: (error?: ICriticalContainerError) => void,\n        localStorageOverride?: Pick<Storage, \"getItem\" | \"setItem\">,\n    ) {\n        const noopStorage = { getItem: () => null, setItem: () => {} };\n        // localStorage is not defined in Node environment, so fall back to noopStorage if needed.\n        this.localStorage = localStorageOverride ?? globalThis.localStorage ?? noopStorage;\n\n        if (this.localStorage === noopStorage) {\n            // This means the Skip Closure Period logic will not work.\n            this.mc.logger.sendTelemetryEvent({ eventName: \"SweepReadyUsageDetectionHandlerNoopStorage\" });\n        }\n    }\n\n    /**\n      * If SweepReady Usage Detection is enabled, close the interactive container.\n      * If the SkipClosureForXDays setting is set, don't close the container more than once in that period.\n      *\n      * Once Sweep is fully implemented, this will be removed since the objects will be gone\n      * and errors will arise elsewhere in the runtime\n     */\n    public usageDetectedInInteractiveClient(errorProps: ITelemetryProperties) {\n        if (!sweepReadyUsageDetectionSetting.read(this.mc.config).interactiveClient) {\n            return;\n        }\n\n        // Default stance is we close every time - this reflects the severity of SweepReady Object Usage.\n        // However, we may choose to \"throttle\" the closures by setting the SkipClosureForXDays setting,\n        // which will only allow the container to close once during that period, to avoid locking users out.\n        let shouldClose: boolean = true;\n        let pastClosuresMap: Record<string, { lastCloseTime: number; } | undefined> = {};\n        let lastCloseTime: number | undefined;\n        const skipClosureForXDays = this.mc.config.getNumber(skipClosureForXDaysKey);\n        if (skipClosureForXDays !== undefined) {\n            // Read pastClosuresMap from localStorage then extract the lastCloseTime from the map\n            try {\n                const rawValue = this.localStorage.getItem(closuresMapLocalStorageKey);\n                const parsedValue = rawValue === null ? {} : JSON.parse(rawValue);\n                if (typeof parsedValue === \"object\") {\n                    pastClosuresMap = parsedValue;\n                }\n            } catch (e) {\n            }\n            lastCloseTime = pastClosuresMap[this.uniqueContainerKey]?.lastCloseTime;\n\n            // Don't close if we did already within the Skip Closure Period\n            if (lastCloseTime !== undefined && Date.now() < lastCloseTime + skipClosureForXDays * oneDayMs) {\n                shouldClose = false;\n            }\n        }\n\n        const error = new SweepReadyUsageError(\n            \"SweepReady object used in Non-Summarizer Client\",\n            { errorDetails: JSON.stringify({ ...errorProps, lastCloseTime, skipClosureForXDays }) },\n        );\n        if (shouldClose) {\n            // Update closures map in localStorage before closing\n            // Note there is a race condition between different tabs updating localStorage and overwriting\n            // each others' updates. If so, some tab will crash again. Just reload one at a time to get unstuck\n            pastClosuresMap[this.uniqueContainerKey] = { lastCloseTime: Date.now() };\n            this.localStorage.setItem(closuresMapLocalStorageKey, JSON.stringify(pastClosuresMap));\n\n            this.closeFn(error);\n        } else {\n            this.mc.logger.sendErrorEvent({ eventName: \"SweepReadyObject_UsageAllowed\" }, error);\n        }\n    }\n}\n"]}

package/dist/index.d.ts

@@ -2,12 +2,14 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { ContainerMessageType, IChunkedOp, ContainerRuntimeMessage, IGCRuntimeOptions, ISummaryRuntimeOptions, ISummaryBaseConfiguration, ISummaryConfigurationHeuristics, ISummaryConfigurationDisableSummarizer, ISummaryConfigurationDisableHeuristics, IContainerRuntimeOptions, IRootSummaryTreeWithStats, isRuntimeMessage, RuntimeMessage, unpackRuntimeMessage, agentSchedulerId, ContainerRuntime, RuntimeHeaders, ISummaryConfiguration, DefaultSummaryConfiguration, ICompressionRuntimeOptions, } from "./containerRuntime";
+export { ContainerMessageType, ContainerRuntimeMessage, IGCRuntimeOptions, ISummaryRuntimeOptions, ISummaryBaseConfiguration, ISummaryConfigurationHeuristics, ISummaryConfigurationDisableSummarizer, ISummaryConfigurationDisableHeuristics, IContainerRuntimeOptions, IRootSummaryTreeWithStats, isRuntimeMessage, RuntimeMessage, agentSchedulerId, ContainerRuntime, RuntimeHeaders, ISummaryConfiguration, DefaultSummaryConfiguration, ICompressionRuntimeOptions, CompressionAlgorithms, } from "./containerRuntime";
 export { FluidDataStoreRegistry } from "./dataStoreRegistry";
-export { gcBlobPrefix, gcTombstoneBlobKey, gcTreeKey, IGCStats, } from "./garbageCollection";
+export { IGCStats, } from "./garbageCollection";
+export { gcBlobPrefix, gcTombstoneBlobKey, gcTreeKey, } from "./garbageCollectionConstants";
 export { IPendingFlush, IPendingLocalState, IPendingMessage, IPendingState, } from "./pendingStateManager";
 export { Summarizer } from "./summarizer";
 export { EnqueueSummarizeResult, IAckSummaryResult, IBaseSummarizeResult, IBroadcastSummaryResult, ICancellationToken, IConnectableRuntime, IEnqueueSummarizeOptions, IGenerateSummaryTreeResult, IGeneratedSummaryStats, INackSummaryResult, IOnDemandSummarizeOptions, IProvideSummarizer, IRefreshSummaryAckOptions, ISubmitSummaryOpResult, ISubmitSummaryOptions, ISummarizeOptions, ISummarizeResults, ISummarizer, ISummarizerEvents, ISummarizerInternalsProvider, ISummarizerRuntime, ISummarizingWarning, ISummaryCancellationToken, IUploadSummaryResult, SubmitSummaryResult, SummarizeResultPart, SummarizerStopReason, } from "./summarizerTypes";
 export { IAckedSummary, IClientSummaryWatcher, ISummary, ISummaryCollectionOpEvents, ISummaryAckMessage, ISummaryNackMessage, ISummaryOpMessage, OpActionEventListener, OpActionEventName, SummaryCollection, } from "./summaryCollection";
 export { ICancellableSummarizerController, neverCancelledSummaryToken } from "./runWhileConnectedCoordinator";
+export { IChunkedOp, unpackRuntimeMessage } from "./opLifecycle";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,oBAAoB,EACpB,UAAU,EACV,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,yBAAyB,EACzB,+BAA+B,EAC/B,sCAAsC,EACtC,sCAAsC,EACtC,wBAAwB,EACxB,yBAAyB,EACzB,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EACH,YAAY,EACZ,kBAAkB,EAClB,SAAS,EACT,QAAQ,GACX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACH,aAAa,EACb,kBAAkB,EAClB,eAAe,EACf,aAAa,GAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EACH,sBAAsB,EACtB,iBAAiB,EACjB,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC1B,sBAAsB,EACtB,kBAAkB,EAClB,yBAAyB,EACzB,kBAAkB,EAClB,yBAAyB,EACzB,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,4BAA4B,EAC5B,kBAAkB,EAClB,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,GACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,0BAA0B,EAC1B,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gCAAgC,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,oBAAoB,EACpB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,yBAAyB,EACzB,+BAA+B,EAC/B,sCAAsC,EACtC,sCAAsC,EACtC,wBAAwB,EACxB,yBAAyB,EACzB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EACH,QAAQ,GACX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACH,YAAY,EACZ,kBAAkB,EAClB,SAAS,GACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACH,aAAa,EACb,kBAAkB,EAClB,eAAe,EACf,aAAa,GAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EACH,sBAAsB,EACtB,iBAAiB,EACjB,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC1B,sBAAsB,EACtB,kBAAkB,EAClB,yBAAyB,EACzB,kBAAkB,EAClB,yBAAyB,EACzB,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,4BAA4B,EAC5B,kBAAkB,EAClB,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,GACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,0BAA0B,EAC1B,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gCAAgC,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC;AAC9G,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -4,22 +4,22 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.neverCancelledSummaryToken = exports.SummaryCollection = exports.ISummarizer = exports.Summarizer = exports.gcTreeKey = exports.gcTombstoneBlobKey = exports.gcBlobPrefix = exports.FluidDataStoreRegistry = exports.DefaultSummaryConfiguration = exports.RuntimeHeaders = exports.ContainerRuntime = exports.agentSchedulerId = exports.unpackRuntimeMessage = exports.RuntimeMessage = exports.isRuntimeMessage = exports.ContainerMessageType = void 0;
+exports.unpackRuntimeMessage = exports.neverCancelledSummaryToken = exports.SummaryCollection = exports.ISummarizer = exports.Summarizer = exports.gcTreeKey = exports.gcTombstoneBlobKey = exports.gcBlobPrefix = exports.FluidDataStoreRegistry = exports.CompressionAlgorithms = exports.DefaultSummaryConfiguration = exports.RuntimeHeaders = exports.ContainerRuntime = exports.agentSchedulerId = exports.RuntimeMessage = exports.isRuntimeMessage = exports.ContainerMessageType = void 0;
 var containerRuntime_1 = require("./containerRuntime");
 Object.defineProperty(exports, "ContainerMessageType", { enumerable: true, get: function () { return containerRuntime_1.ContainerMessageType; } });
 Object.defineProperty(exports, "isRuntimeMessage", { enumerable: true, get: function () { return containerRuntime_1.isRuntimeMessage; } });
 Object.defineProperty(exports, "RuntimeMessage", { enumerable: true, get: function () { return containerRuntime_1.RuntimeMessage; } });
-Object.defineProperty(exports, "unpackRuntimeMessage", { enumerable: true, get: function () { return containerRuntime_1.unpackRuntimeMessage; } });
 Object.defineProperty(exports, "agentSchedulerId", { enumerable: true, get: function () { return containerRuntime_1.agentSchedulerId; } });
 Object.defineProperty(exports, "ContainerRuntime", { enumerable: true, get: function () { return containerRuntime_1.ContainerRuntime; } });
 Object.defineProperty(exports, "RuntimeHeaders", { enumerable: true, get: function () { return containerRuntime_1.RuntimeHeaders; } });
 Object.defineProperty(exports, "DefaultSummaryConfiguration", { enumerable: true, get: function () { return containerRuntime_1.DefaultSummaryConfiguration; } });
+Object.defineProperty(exports, "CompressionAlgorithms", { enumerable: true, get: function () { return containerRuntime_1.CompressionAlgorithms; } });
 var dataStoreRegistry_1 = require("./dataStoreRegistry");
 Object.defineProperty(exports, "FluidDataStoreRegistry", { enumerable: true, get: function () { return dataStoreRegistry_1.FluidDataStoreRegistry; } });
-var garbageCollection_1 = require("./garbageCollection");
-Object.defineProperty(exports, "gcBlobPrefix", { enumerable: true, get: function () { return garbageCollection_1.gcBlobPrefix; } });
-Object.defineProperty(exports, "gcTombstoneBlobKey", { enumerable: true, get: function () { return garbageCollection_1.gcTombstoneBlobKey; } });
-Object.defineProperty(exports, "gcTreeKey", { enumerable: true, get: function () { return garbageCollection_1.gcTreeKey; } });
+var garbageCollectionConstants_1 = require("./garbageCollectionConstants");
+Object.defineProperty(exports, "gcBlobPrefix", { enumerable: true, get: function () { return garbageCollectionConstants_1.gcBlobPrefix; } });
+Object.defineProperty(exports, "gcTombstoneBlobKey", { enumerable: true, get: function () { return garbageCollectionConstants_1.gcTombstoneBlobKey; } });
+Object.defineProperty(exports, "gcTreeKey", { enumerable: true, get: function () { return garbageCollectionConstants_1.gcTreeKey; } });
 var summarizer_1 = require("./summarizer");
 Object.defineProperty(exports, "Summarizer", { enumerable: true, get: function () { return summarizer_1.Summarizer; } });
 var summarizerTypes_1 = require("./summarizerTypes");
@@ -28,4 +28,6 @@ var summaryCollection_1 = require("./summaryCollection");
 Object.defineProperty(exports, "SummaryCollection", { enumerable: true, get: function () { return summaryCollection_1.SummaryCollection; } });
 var runWhileConnectedCoordinator_1 = require("./runWhileConnectedCoordinator");
 Object.defineProperty(exports, "neverCancelledSummaryToken", { enumerable: true, get: function () { return runWhileConnectedCoordinator_1.neverCancelledSummaryToken; } });
+var opLifecycle_1 = require("./opLifecycle");
+Object.defineProperty(exports, "unpackRuntimeMessage", { enumerable: true, get: function () { return opLifecycle_1.unpackRuntimeMessage; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uDAqB4B;AApBxB,wHAAA,oBAAoB,OAAA;AAWpB,oHAAA,gBAAgB,OAAA;AAChB,kHAAA,cAAc,OAAA;AACd,wHAAA,oBAAoB,OAAA;AACpB,oHAAA,gBAAgB,OAAA;AAChB,oHAAA,gBAAgB,OAAA;AAChB,kHAAA,cAAc,OAAA;AAEd,+HAAA,2BAA2B,OAAA;AAG/B,yDAA6D;AAApD,2HAAA,sBAAsB,OAAA;AAC/B,yDAK6B;AAJzB,iHAAA,YAAY,OAAA;AACZ,uHAAA,kBAAkB,OAAA;AAClB,8GAAA,SAAS,OAAA;AASb,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,qDA4B2B;AAVvB,8GAAA,WAAW,OAAA;AAWf,yDAW6B;AADzB,sHAAA,iBAAiB,OAAA;AAErB,+EAA8G;AAAnE,0IAAA,0BAA0B,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n    ContainerMessageType,\n    IChunkedOp,\n    ContainerRuntimeMessage,\n    IGCRuntimeOptions,\n    ISummaryRuntimeOptions,\n    ISummaryBaseConfiguration,\n    ISummaryConfigurationHeuristics,\n    ISummaryConfigurationDisableSummarizer,\n    ISummaryConfigurationDisableHeuristics,\n    IContainerRuntimeOptions,\n    IRootSummaryTreeWithStats,\n    isRuntimeMessage,\n    RuntimeMessage,\n    unpackRuntimeMessage,\n    agentSchedulerId,\n    ContainerRuntime,\n    RuntimeHeaders,\n    ISummaryConfiguration,\n    DefaultSummaryConfiguration,\n    ICompressionRuntimeOptions,\n} from \"./containerRuntime\";\nexport { FluidDataStoreRegistry } from \"./dataStoreRegistry\";\nexport {\n    gcBlobPrefix,\n    gcTombstoneBlobKey,\n    gcTreeKey,\n    IGCStats,\n} from \"./garbageCollection\";\nexport {\n    IPendingFlush,\n    IPendingLocalState,\n    IPendingMessage,\n    IPendingState,\n} from \"./pendingStateManager\";\nexport { Summarizer } from \"./summarizer\";\nexport {\n    EnqueueSummarizeResult,\n    IAckSummaryResult,\n    IBaseSummarizeResult,\n    IBroadcastSummaryResult,\n    ICancellationToken,\n    IConnectableRuntime,\n    IEnqueueSummarizeOptions,\n    IGenerateSummaryTreeResult,\n    IGeneratedSummaryStats,\n    INackSummaryResult,\n    IOnDemandSummarizeOptions,\n    IProvideSummarizer,\n    IRefreshSummaryAckOptions,\n    ISubmitSummaryOpResult,\n    ISubmitSummaryOptions,\n    ISummarizeOptions,\n    ISummarizeResults,\n    ISummarizer,\n    ISummarizerEvents,\n    ISummarizerInternalsProvider,\n    ISummarizerRuntime,\n    ISummarizingWarning,\n    ISummaryCancellationToken,\n    IUploadSummaryResult,\n    SubmitSummaryResult,\n    SummarizeResultPart,\n    SummarizerStopReason,\n} from \"./summarizerTypes\";\nexport {\n    IAckedSummary,\n    IClientSummaryWatcher,\n    ISummary,\n    ISummaryCollectionOpEvents,\n    ISummaryAckMessage,\n    ISummaryNackMessage,\n    ISummaryOpMessage,\n    OpActionEventListener,\n    OpActionEventName,\n    SummaryCollection,\n} from \"./summaryCollection\";\nexport { ICancellableSummarizerController, neverCancelledSummaryToken } from \"./runWhileConnectedCoordinator\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uDAoB4B;AAnBxB,wHAAA,oBAAoB,OAAA;AAUpB,oHAAA,gBAAgB,OAAA;AAChB,kHAAA,cAAc,OAAA;AACd,oHAAA,gBAAgB,OAAA;AAChB,oHAAA,gBAAgB,OAAA;AAChB,kHAAA,cAAc,OAAA;AAEd,+HAAA,2BAA2B,OAAA;AAE3B,yHAAA,qBAAqB,OAAA;AAEzB,yDAA6D;AAApD,2HAAA,sBAAsB,OAAA;AAI/B,2EAIsC;AAHlC,0HAAA,YAAY,OAAA;AACZ,gIAAA,kBAAkB,OAAA;AAClB,uHAAA,SAAS,OAAA;AAQb,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,qDA4B2B;AAVvB,8GAAA,WAAW,OAAA;AAWf,yDAW6B;AADzB,sHAAA,iBAAiB,OAAA;AAErB,+EAA8G;AAAnE,0IAAA,0BAA0B,OAAA;AACrE,6CAAiE;AAA5C,mHAAA,oBAAoB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n    ContainerMessageType,\n    ContainerRuntimeMessage,\n    IGCRuntimeOptions,\n    ISummaryRuntimeOptions,\n    ISummaryBaseConfiguration,\n    ISummaryConfigurationHeuristics,\n    ISummaryConfigurationDisableSummarizer,\n    ISummaryConfigurationDisableHeuristics,\n    IContainerRuntimeOptions,\n    IRootSummaryTreeWithStats,\n    isRuntimeMessage,\n    RuntimeMessage,\n    agentSchedulerId,\n    ContainerRuntime,\n    RuntimeHeaders,\n    ISummaryConfiguration,\n    DefaultSummaryConfiguration,\n    ICompressionRuntimeOptions,\n    CompressionAlgorithms,\n} from \"./containerRuntime\";\nexport { FluidDataStoreRegistry } from \"./dataStoreRegistry\";\nexport {\n    IGCStats,\n} from \"./garbageCollection\";\nexport {\n    gcBlobPrefix,\n    gcTombstoneBlobKey,\n    gcTreeKey,\n} from \"./garbageCollectionConstants\";\nexport {\n    IPendingFlush,\n    IPendingLocalState,\n    IPendingMessage,\n    IPendingState,\n} from \"./pendingStateManager\";\nexport { Summarizer } from \"./summarizer\";\nexport {\n    EnqueueSummarizeResult,\n    IAckSummaryResult,\n    IBaseSummarizeResult,\n    IBroadcastSummaryResult,\n    ICancellationToken,\n    IConnectableRuntime,\n    IEnqueueSummarizeOptions,\n    IGenerateSummaryTreeResult,\n    IGeneratedSummaryStats,\n    INackSummaryResult,\n    IOnDemandSummarizeOptions,\n    IProvideSummarizer,\n    IRefreshSummaryAckOptions,\n    ISubmitSummaryOpResult,\n    ISubmitSummaryOptions,\n    ISummarizeOptions,\n    ISummarizeResults,\n    ISummarizer,\n    ISummarizerEvents,\n    ISummarizerInternalsProvider,\n    ISummarizerRuntime,\n    ISummarizingWarning,\n    ISummaryCancellationToken,\n    IUploadSummaryResult,\n    SubmitSummaryResult,\n    SummarizeResultPart,\n    SummarizerStopReason,\n} from \"./summarizerTypes\";\nexport {\n    IAckedSummary,\n    IClientSummaryWatcher,\n    ISummary,\n    ISummaryCollectionOpEvents,\n    ISummaryAckMessage,\n    ISummaryNackMessage,\n    ISummaryOpMessage,\n    OpActionEventListener,\n    OpActionEventName,\n    SummaryCollection,\n} from \"./summaryCollection\";\nexport { ICancellableSummarizerController, neverCancelledSummaryToken } from \"./runWhileConnectedCoordinator\";\nexport { IChunkedOp, unpackRuntimeMessage } from \"./opLifecycle\";\n"]}

package/dist/opLifecycle/batchManager.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ICompressionRuntimeOptions } from "../containerRuntime";
+import { BatchMessage, IBatch, IBatchCheckpoint } from "./definitions";
+export interface IBatchManagerOptions {
+    readonly hardLimit: number;
+    readonly softLimit?: number;
+    readonly compressionOptions?: ICompressionRuntimeOptions;
+}
+/**
+ * Helper class that manages partial batch & rollback.
+ */
+export declare class BatchManager {
+    readonly options: IBatchManagerOptions;
+    private pendingBatch;
+    private batchContentSize;
+    get length(): number;
+    get contentSizeInBytes(): number;
+    constructor(options: IBatchManagerOptions);
+    push(message: BatchMessage): boolean;
+    get empty(): boolean;
+    popBatch(): IBatch;
+    /**
+     * Capture the pending state at this point
+     */
+    checkpoint(): IBatchCheckpoint;
+}
+//# sourceMappingURL=batchManager.d.ts.map

package/dist/opLifecycle/batchManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batchManager.d.ts","sourceRoot":"","sources":["../../src/opLifecycle/batchManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEvE,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,kBAAkB,CAAC,EAAE,0BAA0B,CAAC;CAC5D;AAED;;GAEG;AACH,qBAAa,YAAY;aAOO,OAAO,EAAE,oBAAoB;IANzD,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,gBAAgB,CAAK;IAE7B,IAAW,MAAM,WAAuC;IACxD,IAAW,kBAAkB,WAAoC;gBAErC,OAAO,EAAE,oBAAoB;IAElD,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO;IA+B3C,IAAW,KAAK,YAA6C;IAEtD,QAAQ,IAAI,MAAM;IAYzB;;OAEG;IACI,UAAU,IAAI,gBAAgB;CAexC"}

package/dist/{batchManager.js → opLifecycle/batchManager.js}

@@ -9,16 +9,16 @@ exports.BatchManager = void 0;
  * Helper class that manages partial batch & rollback.
  */
 class BatchManager {
-    constructor(hardLimit, softLimit) {
-        this.hardLimit = hardLimit;
-        this.softLimit = softLimit;
+    constructor(options) {
+        this.options = options;
         this.pendingBatch = [];
         this.batchContentSize = 0;
     }
     get length() { return this.pendingBatch.length; }
-    get limit() { return this.hardLimit; }
+    get contentSizeInBytes() { return this.batchContentSize; }
     push(message) {
-        const contentSize = this.batchContentSize + message.contents.length;
+        var _a, _b;
+        const contentSize = this.batchContentSize + ((_b = (_a = message.contents) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0);
         const opCount = this.pendingBatch.length;
         // Attempt to estimate batch size, aka socket message size.
         // Each op has pretty large envelope, estimating to be 200 bytes.
@@ -29,10 +29,14 @@ class BatchManager {
         // If we were provided soft limit, check for exceeding it.
         // But only if we have any ops, as the intention here is to flush existing ops (on exceeding this limit)
         // and start over. That's not an option if we have no ops.
-        if (this.softLimit !== undefined && this.length > 0 && socketMessageSize >= this.softLimit) {
+        // If compression is enabled, the soft and hard limit are ignored and the message will be pushed anyways.
+        // Cases where the message is still too large will be handled by the maxConsecutiveReconnects path.
+        if (this.options.softLimit !== undefined
+            && this.length > 0
+            && socketMessageSize >= this.options.softLimit) {
             return false;
         }
-        if (socketMessageSize >= this.limit) {
+        if (socketMessageSize >= this.options.hardLimit) {
             return false;
         }
         this.batchContentSize = contentSize;
@@ -41,10 +45,13 @@ class BatchManager {
     }
     get empty() { return this.pendingBatch.length === 0; }
     popBatch() {
-        const batch = this.pendingBatch;
+        const batch = {
+            content: this.pendingBatch,
+            contentSizeInBytes: this.batchContentSize,
+        };
         this.pendingBatch = [];
         this.batchContentSize = 0;
-        return batch;
+        return addBatchMetadata(batch);
     }
     /**
      * Capture the pending state at this point
@@ -53,10 +60,11 @@ class BatchManager {
         const startPoint = this.pendingBatch.length;
         return {
             rollback: (process) => {
+                var _a, _b;
                 for (let i = this.pendingBatch.length; i > startPoint;) {
                     i--;
                     const message = this.pendingBatch[i];
-                    this.batchContentSize -= message.contents.length;
+                    this.batchContentSize -= (_b = (_a = message.contents) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0;
                     process(message);
                 }
                 this.pendingBatch.length = startPoint;
@@ -65,4 +73,11 @@ class BatchManager {
     }
 }
 exports.BatchManager = BatchManager;
+const addBatchMetadata = (batch) => {
+    if (batch.content.length > 1) {
+        batch.content[0].metadata = Object.assign(Object.assign({}, batch.content[0].metadata), { batch: true });
+        batch.content[batch.content.length - 1].metadata = Object.assign(Object.assign({}, batch.content[batch.content.length - 1].metadata), { batch: false });
+    }
+    return batch;
+};
 //# sourceMappingURL=batchManager.js.map

package/dist/opLifecycle/batchManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batchManager.js","sourceRoot":"","sources":["../../src/opLifecycle/batchManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAWH;;GAEG;AACH,MAAa,YAAY;IAOrB,YAA4B,OAA6B;QAA7B,YAAO,GAAP,OAAO,CAAsB;QANjD,iBAAY,GAAmB,EAAE,CAAC;QAClC,qBAAgB,GAAG,CAAC,CAAC;IAKgC,CAAC;IAH9D,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD,IAAW,kBAAkB,KAAK,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAI1D,IAAI,CAAC,OAAqB;;QAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,GAAG,CAAC,MAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,MAAM,mCAAI,CAAC,CAAC,CAAC;QAC5E,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,yGAAyG;QACzG,mGAAmG;QACnG,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,SAAS;eACjC,IAAI,CAAC,MAAM,GAAG,CAAC;eACf,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YAChD,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YAC7C,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,GAAW;YAClB,OAAO,EAAE,IAAI,CAAC,YAAY;YAC1B,kBAAkB,EAAE,IAAI,CAAC,gBAAgB;SAC5C,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAE1B,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,UAAU;QACb,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,MAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,MAAM,mCAAI,CAAC,CAAC;oBACvD,OAAO,CAAC,OAAO,CAAC,CAAC;iBACpB;gBAED,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,UAAU,CAAC;YAC1C,CAAC;SACJ,CAAC;IACN,CAAC;CACJ;AAxED,oCAwEC;AAED,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE;IAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,mCAClB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,KAC5B,KAAK,EAAE,IAAI,GACd,CAAC;QACF,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,mCACzC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,KACnD,KAAK,EAAE,KAAK,GACf,CAAC;KACL;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ICompressionRuntimeOptions } from \"../containerRuntime\";\nimport { BatchMessage, IBatch, IBatchCheckpoint } from \"./definitions\";\n\nexport interface IBatchManagerOptions {\n    readonly hardLimit: number;\n    readonly softLimit?: number;\n    readonly compressionOptions?: ICompressionRuntimeOptions;\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    public get length() { return this.pendingBatch.length; }\n    public get contentSizeInBytes() { return this.batchContentSize; }\n\n    constructor(public readonly options: IBatchManagerOptions) { }\n\n    public push(message: BatchMessage): boolean {\n        const contentSize = this.batchContentSize + (message.contents?.length ?? 0);\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 compression is enabled, the soft and hard limit are ignored and the message will be pushed anyways.\n        // Cases where the message is still too large will be handled by the maxConsecutiveReconnects path.\n        if (this.options.softLimit !== undefined\n            && this.length > 0\n            && socketMessageSize >= this.options.softLimit) {\n            return false;\n        }\n\n        if (socketMessageSize >= this.options.hardLimit) {\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(): IBatch {\n        const batch: IBatch = {\n            content: this.pendingBatch,\n            contentSizeInBytes: this.batchContentSize,\n        };\n\n        this.pendingBatch = [];\n        this.batchContentSize = 0;\n\n        return addBatchMetadata(batch);\n    }\n\n    /**\n     * Capture the pending state at this point\n     */\n    public checkpoint(): IBatchCheckpoint {\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 ?? 0;\n                    process(message);\n                }\n\n                this.pendingBatch.length = startPoint;\n            },\n        };\n    }\n}\n\nconst addBatchMetadata = (batch: IBatch): IBatch => {\n    if (batch.content.length > 1) {\n        batch.content[0].metadata = {\n            ...batch.content[0].metadata,\n            batch: true\n        };\n        batch.content[batch.content.length - 1].metadata = {\n            ...batch.content[batch.content.length - 1].metadata,\n            batch: false\n        };\n    }\n\n    return batch;\n};\n"]}

package/dist/opLifecycle/definitions.d.ts

@@ -0,0 +1,40 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IBatchMessage } from "@fluidframework/container-definitions";
+import { MessageType } from "@fluidframework/protocol-definitions";
+import { CompressionAlgorithms, ContainerMessageType, ContainerRuntimeMessage } from "..";
+/**
+ * Batch message type used internally by the runtime
+ */
+export declare type BatchMessage = IBatchMessage & {
+    localOpMetadata: unknown;
+    deserializedContent: ContainerRuntimeMessage;
+    referenceSequenceNumber: number;
+    compression?: CompressionAlgorithms;
+};
+/**
+ * Batch interface used internally by the runtime.
+ */
+export interface IBatch {
+    /**
+     * Sum of the in-memory content sizes of all messages in the batch.
+     * If the batch is compressed, this number reflects the post-compression size.
+     */
+    readonly contentSizeInBytes: number;
+    /**
+     * All the messages in the batch
+     */
+    readonly content: BatchMessage[];
+}
+export interface IBatchCheckpoint {
+    rollback: (action: (message: BatchMessage) => void) => void;
+}
+export interface IChunkedOp {
+    chunkId: number;
+    totalChunks: number;
+    contents: string;
+    originalType: MessageType | ContainerMessageType;
+}
+//# sourceMappingURL=definitions.d.ts.map

package/dist/opLifecycle/definitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/opLifecycle/definitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,MAAM,IAAI,CAAC;AAE1F;;GAEG;AACH,oBAAY,YAAY,GAAG,aAAa,GAAG;IACvC,eAAe,EAAE,OAAO,CAAC;IACzB,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,uBAAuB,EAAE,MAAM,CAAC;IAChC,WAAW,CAAC,EAAE,qBAAqB,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,MAAM;IACnB;;;OAGG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,YAAY,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,KAAK,IAAI,CAAC;CAC/D;AAED,MAAM,WAAW,UAAU;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,WAAW,GAAG,oBAAoB,CAAC;CACpD"}

package/dist/opLifecycle/definitions.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=definitions.js.map

package/dist/opLifecycle/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/opLifecycle/definitions.ts"],"names":[],"mappings":";AAAA;;;GAGG","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 { MessageType } from \"@fluidframework/protocol-definitions\";\nimport { CompressionAlgorithms, ContainerMessageType, ContainerRuntimeMessage } from \"..\";\n\n/**\n * Batch message type used internally by the runtime\n */\nexport type BatchMessage = IBatchMessage & {\n    localOpMetadata: unknown;\n    deserializedContent: ContainerRuntimeMessage;\n    referenceSequenceNumber: number;\n    compression?: CompressionAlgorithms;\n};\n\n/**\n * Batch interface used internally by the runtime.\n */\nexport interface IBatch {\n    /**\n     * Sum of the in-memory content sizes of all messages in the batch.\n     * If the batch is compressed, this number reflects the post-compression size.\n     */\n    readonly contentSizeInBytes: number;\n    /**\n     * All the messages in the batch\n     */\n    readonly content: BatchMessage[];\n}\n\nexport interface IBatchCheckpoint {\n    rollback: (action: (message: BatchMessage) => void) => void;\n}\n\nexport interface IChunkedOp {\n    chunkId: number;\n    totalChunks: number;\n    contents: string;\n    originalType: MessageType | ContainerMessageType;\n}\n"]}

package/dist/opLifecycle/index.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { BatchManager } from "./batchManager";
+export { BatchMessage, IBatch, IBatchCheckpoint, IChunkedOp, } from "./definitions";
+export { Outbox } from "./outbox";
+export { OpCompressor } from "./opCompressor";
+export { OpDecompressor } from "./opDecompressor";
+export { OpSplitter } from "./opSplitter";
+export { RemoteMessageProcessor, unpackRuntimeMessage } from "./remoteMessageProcessor";
+//# sourceMappingURL=index.d.ts.map

package/dist/opLifecycle/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/opLifecycle/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EACH,YAAY,EACZ,MAAM,EACN,gBAAgB,EAChB,UAAU,GACb,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/opLifecycle/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unpackRuntimeMessage = exports.RemoteMessageProcessor = exports.OpSplitter = exports.OpDecompressor = exports.OpCompressor = exports.Outbox = exports.BatchManager = void 0;
+var batchManager_1 = require("./batchManager");
+Object.defineProperty(exports, "BatchManager", { enumerable: true, get: function () { return batchManager_1.BatchManager; } });
+var outbox_1 = require("./outbox");
+Object.defineProperty(exports, "Outbox", { enumerable: true, get: function () { return outbox_1.Outbox; } });
+var opCompressor_1 = require("./opCompressor");
+Object.defineProperty(exports, "OpCompressor", { enumerable: true, get: function () { return opCompressor_1.OpCompressor; } });
+var opDecompressor_1 = require("./opDecompressor");
+Object.defineProperty(exports, "OpDecompressor", { enumerable: true, get: function () { return opDecompressor_1.OpDecompressor; } });
+var opSplitter_1 = require("./opSplitter");
+Object.defineProperty(exports, "OpSplitter", { enumerable: true, get: function () { return opSplitter_1.OpSplitter; } });
+var remoteMessageProcessor_1 = require("./remoteMessageProcessor");
+Object.defineProperty(exports, "RemoteMessageProcessor", { enumerable: true, get: function () { return remoteMessageProcessor_1.RemoteMessageProcessor; } });
+Object.defineProperty(exports, "unpackRuntimeMessage", { enumerable: true, get: function () { return remoteMessageProcessor_1.unpackRuntimeMessage; } });
+//# sourceMappingURL=index.js.map

package/dist/opLifecycle/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/opLifecycle/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AAOrB,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AACf,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AACvB,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,mEAAwF;AAA/E,gIAAA,sBAAsB,OAAA;AAAE,8HAAA,oBAAoB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { BatchManager } from \"./batchManager\";\nexport {\n    BatchMessage,\n    IBatch,\n    IBatchCheckpoint,\n    IChunkedOp,\n} from \"./definitions\";\nexport { Outbox } from \"./outbox\";\nexport { OpCompressor } from \"./opCompressor\";\nexport { OpDecompressor } from \"./opDecompressor\";\nexport { OpSplitter } from \"./opSplitter\";\nexport { RemoteMessageProcessor, unpackRuntimeMessage } from \"./remoteMessageProcessor\";\n"]}

package/dist/opLifecycle/opCompressor.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { IBatch } from "./definitions";
+/**
+ * Compresses batches of ops. It generates a single compressed op that contains
+ * the contents of each op in the batch. It then submits empty ops for each original
+ * op to reserve sequence numbers.
+ */
+export declare class OpCompressor {
+    private readonly logger;
+    private compressedBatchCount;
+    constructor(logger: ITelemetryLogger);
+    compressBatch(batch: IBatch): IBatch;
+}
+//# sourceMappingURL=opCompressor.d.ts.map

package/dist/opLifecycle/opCompressor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opCompressor.d.ts","sourceRoot":"","sources":["../../src/opLifecycle/opCompressor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAKtE,OAAO,EAAE,MAAM,EAAgB,MAAM,eAAe,CAAC;AAErD;;;;GAIG;AACH,qBAAa,YAAY;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IACxB,OAAO,CAAC,oBAAoB,CAAK;gBAErB,MAAM,EAAE,gBAAgB;IAI7B,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAsC9C"}

package/dist/opLifecycle/opCompressor.js

@@ -0,0 +1,53 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpCompressor = void 0;
+const common_utils_1 = require("@fluidframework/common-utils");
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+const lz4js_1 = require("lz4js");
+const containerRuntime_1 = require("../containerRuntime");
+/**
+ * Compresses batches of ops. It generates a single compressed op that contains
+ * the contents of each op in the batch. It then submits empty ops for each original
+ * op to reserve sequence numbers.
+ */
+class OpCompressor {
+    constructor(logger) {
+        this.compressedBatchCount = 0;
+        this.logger = telemetry_utils_1.ChildLogger.create(logger, "OpCompressor");
+    }
+    compressBatch(batch) {
+        const messages = [];
+        this.compressedBatchCount++;
+        const contentToCompress = [];
+        for (const message of batch.content) {
+            contentToCompress.push(message.deserializedContent);
+        }
+        const compressionStart = Date.now();
+        const contentsAsBuffer = new TextEncoder().encode(JSON.stringify(contentToCompress));
+        const compressedContents = (0, lz4js_1.compress)(contentsAsBuffer);
+        const compressedContent = common_utils_1.IsoBuffer.from(compressedContents).toString("base64");
+        const duration = Date.now() - compressionStart;
+        if (batch.contentSizeInBytes > 200000 || this.compressedBatchCount % 25) {
+            this.logger.sendPerformanceEvent({
+                eventName: "CompressedBatch",
+                duration,
+                sizeBeforeCompression: batch.contentSizeInBytes,
+                sizeAfterCompression: compressedContent.length,
+            });
+        }
+        messages.push(Object.assign(Object.assign({}, batch.content[0]), { contents: JSON.stringify({ packedContents: compressedContent }), metadata: Object.assign(Object.assign({}, batch.content[0].metadata), { compressed: true }), compression: containerRuntime_1.CompressionAlgorithms.lz4 }));
+        for (const message of batch.content.slice(1)) {
+            messages.push(Object.assign(Object.assign({}, message), { contents: undefined }));
+        }
+        return {
+            contentSizeInBytes: compressedContent.length,
+            content: messages,
+        };
+    }
+}
+exports.OpCompressor = OpCompressor;
+//# sourceMappingURL=opCompressor.js.map

package/dist/opLifecycle/opCompressor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opCompressor.js","sourceRoot":"","sources":["../../src/opLifecycle/opCompressor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAyD;AACzD,qEAA8D;AAC9D,iCAAiC;AACjC,0DAAqF;AAGrF;;;;GAIG;AACH,MAAa,YAAY;IAIrB,YAAY,MAAwB;QAF5B,yBAAoB,GAAG,CAAC,CAAC;QAG7B,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC7D,CAAC;IAEM,aAAa,CAAC,KAAa;QAC9B,MAAM,QAAQ,GAAmB,EAAE,CAAC;QACpC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,MAAM,iBAAiB,GAA8B,EAAE,CAAC;QACxD,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE;YACjC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;SACvD;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,gBAAgB,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACrF,MAAM,kBAAkB,GAAG,IAAA,gBAAQ,EAAC,gBAAgB,CAAC,CAAC;QACtD,MAAM,iBAAiB,GAAG,wBAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAChF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,gBAAgB,CAAC;QAE/C,IAAI,KAAK,CAAC,kBAAkB,GAAG,MAAM,IAAI,IAAI,CAAC,oBAAoB,GAAG,EAAE,EAAE;YACrE,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAC7B,SAAS,EAAE,iBAAiB;gBAC5B,QAAQ;gBACR,qBAAqB,EAAE,KAAK,CAAC,kBAAkB;gBAC/C,oBAAoB,EAAE,iBAAiB,CAAC,MAAM;aACjD,CAAC,CAAC;SACN;QAED,QAAQ,CAAC,IAAI,iCACN,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC,EACpF,QAAQ,kCAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAE,UAAU,EAAE,IAAI,KAC1D,WAAW,EAAE,wCAAqB,CAAC,GAAG,IACxC,CAAC;QAEH,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YAC1C,QAAQ,CAAC,IAAI,iCAAM,OAAO,KAAE,QAAQ,EAAE,SAAS,IAAG,CAAC;SACtD;QAED,OAAO;YACH,kBAAkB,EAAE,iBAAiB,CAAC,MAAM;YAC5C,OAAO,EAAE,QAAQ;SACpB,CAAC;IACN,CAAC;CACJ;AA9CD,oCA8CC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { IsoBuffer } from \"@fluidframework/common-utils\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { compress } from \"lz4js\";\nimport { CompressionAlgorithms, ContainerRuntimeMessage } from \"../containerRuntime\";\nimport { IBatch, BatchMessage } from \"./definitions\";\n\n/**\n * Compresses batches of ops. It generates a single compressed op that contains\n * the contents of each op in the batch. It then submits empty ops for each original\n * op to reserve sequence numbers.\n */\nexport class OpCompressor {\n    private readonly logger;\n    private compressedBatchCount = 0;\n\n    constructor(logger: ITelemetryLogger) {\n        this.logger = ChildLogger.create(logger, \"OpCompressor\");\n    }\n\n    public compressBatch(batch: IBatch): IBatch {\n        const messages: BatchMessage[] = [];\n        this.compressedBatchCount++;\n        const contentToCompress: ContainerRuntimeMessage[] = [];\n        for (const message of batch.content) {\n            contentToCompress.push(message.deserializedContent);\n        }\n\n        const compressionStart = Date.now();\n        const contentsAsBuffer = new TextEncoder().encode(JSON.stringify(contentToCompress));\n        const compressedContents = compress(contentsAsBuffer);\n        const compressedContent = IsoBuffer.from(compressedContents).toString(\"base64\");\n        const duration = Date.now() - compressionStart;\n\n        if (batch.contentSizeInBytes > 200000 || this.compressedBatchCount % 25) {\n            this.logger.sendPerformanceEvent({\n                eventName: \"CompressedBatch\",\n                duration,\n                sizeBeforeCompression: batch.contentSizeInBytes,\n                sizeAfterCompression: compressedContent.length,\n            });\n        }\n\n        messages.push({\n            ...batch.content[0], contents: JSON.stringify({ packedContents: compressedContent }),\n            metadata: { ...batch.content[0].metadata, compressed: true },\n            compression: CompressionAlgorithms.lz4,\n        });\n\n        for (const message of batch.content.slice(1)) {\n            messages.push({ ...message, contents: undefined });\n        }\n\n        return {\n            contentSizeInBytes: compressedContent.length,\n            content: messages,\n        };\n    }\n}\n"]}

package/dist/opLifecycle/opDecompressor.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+/**
+ * State machine that "unrolls" contents of compressed batches of ops after decompressing them.
+ * This class relies on some implicit contracts defined below:
+ * 1. A compressed batch will have its first message with batch metadata set to true and compressed set to true
+ * 2. Messages in the middle of a compressed batch will have neither batch metadata nor the compression property set
+ * 3. The final message of a batch will have batch metadata set to false
+ * 4. An individually compressed op will have undefined batch metadata and compression set to true
+ */
+export declare class OpDecompressor {
+    private activeBatch;
+    private rootMessageContents;
+    private processedCount;
+    processMessage(message: ISequencedDocumentMessage): ISequencedDocumentMessage;
+}
+//# sourceMappingURL=opDecompressor.d.ts.map

package/dist/opLifecycle/opDecompressor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opDecompressor.d.ts","sourceRoot":"","sources":["../../src/opLifecycle/opDecompressor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAIjF;;;;;;;GAOG;AACH,qBAAa,cAAc;IACvB,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,cAAc,CAAK;IAEpB,cAAc,CAAC,OAAO,EAAE,yBAAyB,GAAG,yBAAyB;CA4DvF"}

package/dist/opLifecycle/opDecompressor.js

@@ -0,0 +1,72 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpDecompressor = void 0;
+const lz4js_1 = require("lz4js");
+const common_utils_1 = require("@fluidframework/common-utils");
+const containerRuntime_1 = require("../containerRuntime");
+/**
+ * State machine that "unrolls" contents of compressed batches of ops after decompressing them.
+ * This class relies on some implicit contracts defined below:
+ * 1. A compressed batch will have its first message with batch metadata set to true and compressed set to true
+ * 2. Messages in the middle of a compressed batch will have neither batch metadata nor the compression property set
+ * 3. The final message of a batch will have batch metadata set to false
+ * 4. An individually compressed op will have undefined batch metadata and compression set to true
+ */
+class OpDecompressor {
+    constructor() {
+        this.activeBatch = false;
+        this.processedCount = 0;
+    }
+    processMessage(message) {
+        var _a, _b, _c, _d, _e, _f;
+        // We're checking for compression = true or top level compression property so
+        // that we can enable compression without waiting on all ordering services
+        // to pick up protocol change. Eventually only the top level property should
+        // be used.
+        if (((_a = message.metadata) === null || _a === void 0 ? void 0 : _a.batch) === true
+            && (((_b = message.metadata) === null || _b === void 0 ? void 0 : _b.compressed) || message.compression !== undefined)) {
+            // Beginning of a compressed batch
+            (0, common_utils_1.assert)(this.activeBatch === false, 0x4b8 /* shouldn't have multiple active batches */);
+            if (message.compression) {
+                // lz4 is the only supported compression algorithm for now
+                (0, common_utils_1.assert)(message.compression === containerRuntime_1.CompressionAlgorithms.lz4, 0x4b9 /* lz4 is currently the only supported compression algorithm */);
+            }
+            this.activeBatch = true;
+            const contents = common_utils_1.IsoBuffer.from(message.contents.packedContents, "base64");
+            const decompressedMessage = (0, lz4js_1.decompress)(contents);
+            const intoString = (0, common_utils_1.Uint8ArrayToString)(decompressedMessage);
+            const asObj = JSON.parse(intoString);
+            this.rootMessageContents = asObj;
+            return Object.assign(Object.assign({}, message), { contents: this.rootMessageContents[this.processedCount++] });
+        }
+        if (this.rootMessageContents !== undefined && ((_c = message.metadata) === null || _c === void 0 ? void 0 : _c.batch) === undefined && this.activeBatch) {
+            // Continuation of compressed batch
+            return Object.assign(Object.assign({}, message), { contents: this.rootMessageContents[this.processedCount++] });
+        }
+        if (this.rootMessageContents !== undefined && ((_d = message.metadata) === null || _d === void 0 ? void 0 : _d.batch) === false) {
+            // End of compressed batch
+            const returnMessage = Object.assign(Object.assign({}, message), { contents: this.rootMessageContents[this.processedCount++] });
+            this.activeBatch = false;
+            this.rootMessageContents = undefined;
+            this.processedCount = 0;
+            return returnMessage;
+        }
+        if (((_e = message.metadata) === null || _e === void 0 ? void 0 : _e.batch) === undefined &&
+            (((_f = message.metadata) === null || _f === void 0 ? void 0 : _f.compressed) || message.compression === containerRuntime_1.CompressionAlgorithms.lz4)) {
+            // Single compressed message
+            (0, common_utils_1.assert)(this.activeBatch === false, 0x4ba /* shouldn't receive compressed message in middle of a batch */);
+            const contents = common_utils_1.IsoBuffer.from(message.contents.packedContents, "base64");
+            const decompressedMessage = (0, lz4js_1.decompress)(contents);
+            const intoString = new TextDecoder().decode(decompressedMessage);
+            const asObj = JSON.parse(intoString);
+            return Object.assign(Object.assign({}, message), { contents: asObj[0] });
+        }
+        return message;
+    }
+}
+exports.OpDecompressor = OpDecompressor;
+//# sourceMappingURL=opDecompressor.js.map

package/dist/opLifecycle/opDecompressor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opDecompressor.js","sourceRoot":"","sources":["../../src/opLifecycle/opDecompressor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iCAAmC;AAEnC,+DAAqF;AACrF,0DAA4D;AAE5D;;;;;;;GAOG;AACH,MAAa,cAAc;IAA3B;QACY,gBAAW,GAAG,KAAK,CAAC;QAEpB,mBAAc,GAAG,CAAC,CAAC;IA8D/B,CAAC;IA5DU,cAAc,CAAC,OAAkC;;QACpD,6EAA6E;QAC7E,0EAA0E;QAC1E,4EAA4E;QAC5E,WAAW;QACX,IAAI,CAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,MAAK,IAAI;eAC7B,CAAC,CAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,UAAU,KAAI,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,EAAE;YACxE,kCAAkC;YAClC,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,KAAK,KAAK,EAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;YACvF,IAAI,OAAO,CAAC,WAAW,EAAE;gBACrB,0DAA0D;gBAC1D,IAAA,qBAAM,EAAC,OAAO,CAAC,WAAW,KAAK,wCAAqB,CAAC,GAAG,EACpD,KAAK,CAAC,+DAA+D,CAAC,CAAC;aAC9E;YAED,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YAExB,MAAM,QAAQ,GAAG,wBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YAC3E,MAAM,mBAAmB,GAAG,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC;YACjD,MAAM,UAAU,GAAG,IAAA,iCAAkB,EAAC,mBAAmB,CAAC,CAAC;YAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACrC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC;YAEjC,uCAAY,OAAO,KAAE,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,IAAG;SACpF;QAED,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,IAAI,CAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,MAAK,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE;YACrG,mCAAmC;YACnC,uCAAY,OAAO,KAAE,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,IAAG;SACpF;QAED,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,IAAI,CAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,MAAK,KAAK,EAAE;YAC7E,0BAA0B;YAC1B,MAAM,aAAa,mCACZ,OAAO,KACV,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,GAC5D,CAAC;YAEF,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;YACzB,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;YACrC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;YAExB,OAAO,aAAa,CAAC;SACxB;QAED,IAAI,CAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,MAAK,SAAS;YACrC,CAAC,CAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,UAAU,KAAI,OAAO,CAAC,WAAW,KAAK,wCAAqB,CAAC,GAAG,CAAC,EAAE;YACrF,4BAA4B;YAC5B,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,KAAK,KAAK,EAAE,KAAK,CAAC,+DAA+D,CAAC,CAAC;YAE1G,MAAM,QAAQ,GAAG,wBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YAC3E,MAAM,mBAAmB,GAAG,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC;YACjD,MAAM,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;YACjE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAErC,uCAAY,OAAO,KAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,IAAG;SAC7C;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ;AAjED,wCAiEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { decompress } from \"lz4js\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { assert, IsoBuffer, Uint8ArrayToString } from \"@fluidframework/common-utils\";\nimport { CompressionAlgorithms } from \"../containerRuntime\";\n\n/**\n * State machine that \"unrolls\" contents of compressed batches of ops after decompressing them.\n * This class relies on some implicit contracts defined below:\n * 1. A compressed batch will have its first message with batch metadata set to true and compressed set to true\n * 2. Messages in the middle of a compressed batch will have neither batch metadata nor the compression property set\n * 3. The final message of a batch will have batch metadata set to false\n * 4. An individually compressed op will have undefined batch metadata and compression set to true\n */\nexport class OpDecompressor {\n    private activeBatch = false;\n    private rootMessageContents: any | undefined;\n    private processedCount = 0;\n\n    public processMessage(message: ISequencedDocumentMessage): ISequencedDocumentMessage {\n        // We're checking for compression = true or top level compression property so\n        // that we can enable compression without waiting on all ordering services\n        // to pick up protocol change. Eventually only the top level property should\n        // be used.\n        if (message.metadata?.batch === true\n            && (message.metadata?.compressed || message.compression !== undefined)) {\n            // Beginning of a compressed batch\n            assert(this.activeBatch === false, 0x4b8 /* shouldn't have multiple active batches */);\n            if (message.compression) {\n                // lz4 is the only supported compression algorithm for now\n                assert(message.compression === CompressionAlgorithms.lz4,\n                    0x4b9 /* lz4 is currently the only supported compression algorithm */);\n            }\n\n            this.activeBatch = true;\n\n            const contents = IsoBuffer.from(message.contents.packedContents, \"base64\");\n            const decompressedMessage = decompress(contents);\n            const intoString = Uint8ArrayToString(decompressedMessage);\n            const asObj = JSON.parse(intoString);\n            this.rootMessageContents = asObj;\n\n            return { ...message, contents: this.rootMessageContents[this.processedCount++] };\n        }\n\n        if (this.rootMessageContents !== undefined && message.metadata?.batch === undefined && this.activeBatch) {\n            // Continuation of compressed batch\n            return { ...message, contents: this.rootMessageContents[this.processedCount++] };\n        }\n\n        if (this.rootMessageContents !== undefined && message.metadata?.batch === false) {\n            // End of compressed batch\n            const returnMessage = {\n                ...message,\n                contents: this.rootMessageContents[this.processedCount++]\n            };\n\n            this.activeBatch = false;\n            this.rootMessageContents = undefined;\n            this.processedCount = 0;\n\n            return returnMessage;\n        }\n\n        if (message.metadata?.batch === undefined &&\n            (message.metadata?.compressed || message.compression === CompressionAlgorithms.lz4)) {\n            // Single compressed message\n            assert(this.activeBatch === false, 0x4ba /* shouldn't receive compressed message in middle of a batch */);\n\n            const contents = IsoBuffer.from(message.contents.packedContents, \"base64\");\n            const decompressedMessage = decompress(contents);\n            const intoString = new TextDecoder().decode(decompressedMessage);\n            const asObj = JSON.parse(intoString);\n\n            return { ...message, contents: asObj[0] };\n        }\n\n        return message;\n    }\n}\n"]}