@fluidframework/container-runtime 2.0.0-internal.1.4.2 → 2.0.0-internal.2.0.0

package/dist/containerRuntime.js

@@ -12,6 +12,7 @@ const runtime_definitions_1 = require("@fluidframework/runtime-definitions");
 const runtime_utils_1 = require("@fluidframework/runtime-utils");
 const garbage_collector_1 = require("@fluidframework/garbage-collector");
 const uuid_1 = require("uuid");
+const lz4js_1 = require("lz4js");
 const containerHandleContext_1 = require("./containerHandleContext");
 const dataStoreRegistry_1 = require("./dataStoreRegistry");
 const summarizer_1 = require("./summarizer");
@@ -50,7 +51,6 @@ var ContainerMessageType;
 })(ContainerMessageType = exports.ContainerMessageType || (exports.ContainerMessageType = {}));
 exports.DefaultSummaryConfiguration = {
     state: "enabled",
-    idleTime: 15 * 1000,
     minIdleTime: 0,
     maxIdleTime: 30 * 1000,
     maxTime: 60 * 1000,
@@ -80,6 +80,11 @@ var RuntimeHeaders;
 })(RuntimeHeaders = exports.RuntimeHeaders || (exports.RuntimeHeaders = {}));
 const maxConsecutiveReconnectsKey = "Fluid.ContainerRuntime.MaxConsecutiveReconnects";
 const defaultFlushMode = runtime_definitions_1.FlushMode.TurnBased;
+// The actual limit is 1Mb (socket.io and Kafka limits)
+// We can't estimate it fully, as we
+// - do not know what properties relay service will add
+// - we do not stringify final op, thus we do not know how much escaping will be added.
+const defaultMaxBatchSizeInBytes = 950 * 1024;
 /**
  * @deprecated - use ContainerRuntimeMessage instead
  */
@@ -97,22 +102,28 @@ var RuntimeMessage;
  * @deprecated - please use version in driver-utils
  */
 function isRuntimeMessage(message) {
-    if (Object.values(RuntimeMessage).includes(message.type)) {
-        return true;
-    }
-    return false;
+    return Object.values(RuntimeMessage).includes(message.type);
 }
 exports.isRuntimeMessage = isRuntimeMessage;
 /**
  * Unpacks runtime messages
  *
- * @remarks This API makes no promises regarding backward-compatability. This is internal API.
+ * @remarks This API makes no promises regarding backward-compatibility. This is internal API.
  * @param message - message (as it observed in storage / service)
  * @returns unpacked runtime message
  *
  * @internal
  */
 function unpackRuntimeMessage(message) {
+    var _a;
+    if ((_a = message.metadata) === null || _a === void 0 ? void 0 : _a.compressed) {
+        const contents = common_utils_1.IsoBuffer.from(message.contents.contents, "base64");
+        const decompressedMessage = (0, lz4js_1.decompress)(contents);
+        const intoString = new TextDecoder().decode(decompressedMessage);
+        const asObj = JSON.parse(intoString);
+        message.contents.contents = asObj;
+        message.metadata.compressed = false;
+    }
     if (message.type === protocol_definitions_1.MessageType.Operation) {
         // legacy op format?
         if (message.contents.address !== undefined && message.contents.type === undefined) {
@@ -163,7 +174,7 @@ exports.getDeviceSpec = getDeviceSpec;
  */
 class ContainerRuntime extends common_utils_1.TypedEventEmitter {
     constructor(context, registry, metadata, electedSummarizerData, chunks, dataStoreAliasMap, runtimeOptions, containerScope, logger, existing, blobManagerSnapshot, _storage, requestHandler, summaryConfiguration) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         if (summaryConfiguration === void 0) { summaryConfiguration = Object.assign(Object.assign({}, exports.DefaultSummaryConfiguration), (_a = runtimeOptions.summaryOptions) === null || _a === void 0 ? void 0 : _a.summaryConfigOverrides); }
         super();
         this.context = context;
@@ -176,9 +187,10 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         this.summaryConfiguration = summaryConfiguration;
         this.defaultMaxConsecutiveReconnects = 7;
         this._orderSequentiallyCalls = 0;
-        this.flushTrigger = false;
+        this.flushMicroTaskExists = false;
         this.savedOps = [];
         this.consecutiveReconnects = 0;
+        this.compressedOpCount = 0;
         this._disposed = false;
         this.emitDirtyDocumentEvent = true;
         this.defaultTelemetrySignalSampleCount = 100;
@@ -188,12 +200,6 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             signalTimestamp: 0,
             trackingSignalSequenceNumber: undefined,
         };
-        // Provide lower soft limit - we want to have some number of ops to get efficiency in compression & bandwidth usage,
-        // but at the same time we want to send these ops sooner, to reduce overall latency of processing a batch.
-        // So there is some ballance here, that depends on compression algorithm and its efficiency working with smaller
-        // payloads. That number represents final (compressed) bits (once compression is implemented).
-        this.pendingAttachBatch = new batchManager_1.BatchManager(64 * 1024);
-        this.pendingBatch = new batchManager_1.BatchManager();
         this.summarizeOnDemand = (...args) => {
             if (this.clientDetails.type === summarizerClientElection_1.summarizerClientType) {
                 return this.summarizer.summarizeOnDemand(...args);
@@ -238,8 +244,22 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         this.maxConsecutiveReconnects =
             (_b = this.mc.config.getNumber(maxConsecutiveReconnectsKey)) !== null && _b !== void 0 ? _b : this.defaultMaxConsecutiveReconnects;
         this._flushMode = runtimeOptions.flushMode;
+        // Provide lower soft limit - we want to have some number of ops to get efficiency in compression
+        // & bandwidth usage, but at the same time we want to send these ops sooner, to reduce overall
+        // latency of processing a batch.
+        // So there is some ballance here, that depends on compression algorithm and its efficiency working with smaller
+        // payloads. That number represents final (compressed) bits (once compression is implemented).
+        this.pendingAttachBatch = new batchManager_1.BatchManager(runtimeOptions.maxBatchSizeInBytes, 64 * 1024);
+        this.pendingBatch = new batchManager_1.BatchManager(runtimeOptions.maxBatchSizeInBytes);
         const pendingRuntimeState = context.pendingLocalState;
         const baseSnapshot = (_c = pendingRuntimeState === null || pendingRuntimeState === void 0 ? void 0 : pendingRuntimeState.baseSnapshot) !== null && _c !== void 0 ? _c : context.baseSnapshot;
+        const maxSnapshotCacheDurationMs = (_e = (_d = this._storage) === null || _d === void 0 ? void 0 : _d.policies) === null || _e === void 0 ? void 0 : _e.maximumCacheDurationMs;
+        if (maxSnapshotCacheDurationMs !== undefined && maxSnapshotCacheDurationMs > 5 * 24 * 60 * 60 * 1000) {
+            // This is a runtime enforcement of what's already explicit in the policy's type itself,
+            // which dictates the value is either undefined or exactly 5 days in ms.
+            // As long as the actual value is less than 5 days, the assumptions GC makes here are valid.
+            throw new container_utils_1.UsageError("Driver's maximumCacheDurationMs policy cannot exceed 5 days");
+        }
         this.garbageCollector = garbageCollection_1.GarbageCollector.create({
             runtime: this,
             gcOptions: this.runtimeOptions.gcOptions,
@@ -272,9 +292,9 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             gcDisabled: !this.garbageCollector.shouldRunGC,
         });
         if (baseSnapshot) {
-            this.summarizerNode.loadBaseSummaryWithoutDifferential(baseSnapshot);
+            this.summarizerNode.updateBaseSummaryState(baseSnapshot);
         }
-        this.dataStores = new dataStores_1.DataStores((0, dataStores_1.getSummaryForDatastores)(baseSnapshot, metadata), this, (attachMsg) => this.submit(ContainerMessageType.Attach, attachMsg), (id, createParam) => (summarizeInternal, getGCDataFn, getBaseGCDetailsFn) => this.summarizerNode.createChild(summarizeInternal, id, createParam, undefined, getGCDataFn, getBaseGCDetailsFn), (id) => this.summarizerNode.deleteChild(id), this.mc.logger, async () => this.garbageCollector.getBaseGCDetails(), (path, timestampMs, packagePath) => this.garbageCollector.nodeUpdated(path, "Changed", timestampMs, packagePath), new Map(dataStoreAliasMap), this.garbageCollector.writeDataAtRoot);
+        this.dataStores = new dataStores_1.DataStores((0, dataStores_1.getSummaryForDatastores)(baseSnapshot, metadata), this, (attachMsg) => this.submit(ContainerMessageType.Attach, attachMsg), (id, createParam) => (summarizeInternal, getGCDataFn, getBaseGCDetailsFn) => this.summarizerNode.createChild(summarizeInternal, id, createParam, undefined, getGCDataFn, getBaseGCDetailsFn), (id) => this.summarizerNode.deleteChild(id), this.mc.logger, async () => this.garbageCollector.getBaseGCDetails(), (path, timestampMs, packagePath) => this.garbageCollector.nodeUpdated(path, "Changed", timestampMs, packagePath), new Map(dataStoreAliasMap));
         this.blobManager = new blobManager_1.BlobManager(this.handleContext, blobManagerSnapshot, () => this.storage, (blobId, localId) => {
             if (!this.disposed) {
                 this.submit(ContainerMessageType.BlobAttach, undefined, undefined, { blobId, localId });
@@ -288,10 +308,10 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             close: this.closeFn,
             connected: () => this.connected,
             flush: this.flush.bind(this),
-            flushMode: () => this.flushMode,
             reSubmit: this.reSubmit.bind(this),
-            setFlushMode: (mode) => this.setFlushMode(mode),
-        }, this._flushMode, pendingRuntimeState === null || pendingRuntimeState === void 0 ? void 0 : pendingRuntimeState.pending);
+            rollback: this.rollback.bind(this),
+            orderSequentially: this.orderSequentially.bind(this),
+        }, pendingRuntimeState === null || pendingRuntimeState === void 0 ? void 0 : pendingRuntimeState.pending);
         this.context.quorum.on("removeMember", (clientId) => {
             this.clearPartialChunks(clientId);
         });
@@ -315,7 +335,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                 // if summaries are enabled and we are not the summarizer client.
                 const defaultAction = () => {
                     if (this.summaryCollection.opsSinceLastAck > this.maxOpsSinceLastSummary) {
-                        this.logger.sendErrorEvent({ eventName: "SummaryStatus:Behind" });
+                        this.logger.sendTelemetryEvent({ eventName: "SummaryStatus:Behind" });
                         // unregister default to no log on every op after falling behind
                         // and register summary ack handler to re-register this handler
                         // after successful summary
@@ -371,7 +391,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             };
             // summaryNumber was renamed from summaryCount. For older docs that haven't been opened for a long time,
             // the count is reset to 0.
-            loadSummaryNumber = (_d = metadata === null || metadata === void 0 ? void 0 : metadata.summaryNumber) !== null && _d !== void 0 ? _d : 0;
+            loadSummaryNumber = (_f = metadata === null || metadata === void 0 ? void 0 : metadata.summaryNumber) !== null && _f !== void 0 ? _f : 0;
         }
         else {
             this.createContainerMetadata = {
@@ -406,7 +426,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                 runtimeVersion: packageVersion_1.pkgVersion,
             },
         });
-        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", flushMode = defaultFlushMode, enableOfflineLoad = false, } = runtimeOptions;
+        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", flushMode = defaultFlushMode, enableOfflineLoad = false, compressionOptions = {}, maxBatchSizeInBytes = defaultMaxBatchSizeInBytes, } = runtimeOptions;
         const pendingRuntimeState = context.pendingLocalState;
         const baseSnapshot = (_b = pendingRuntimeState === null || pendingRuntimeState === void 0 ? void 0 : pendingRuntimeState.baseSnapshot) !== null && _b !== void 0 ? _b : context.baseSnapshot;
         const storage = !pendingRuntimeState ?
@@ -461,6 +481,8 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             loadSequenceNumberVerification,
             flushMode,
             enableOfflineLoad,
+            compressionOptions,
+            maxBatchSizeInBytes,
         }, containerScope, logger, loadExisting, blobManagerSnapshot, storage, requestHandler);
         if (pendingRuntimeState) {
             await runtime.processSavedOps(pendingRuntimeState);
@@ -734,11 +756,9 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         if (Object.keys(blobManagerSummary.summary.tree).length > 0) {
             (0, runtime_utils_1.addTreeToSummary)(summaryTree, summaryFormat_1.blobsTreeName, blobManagerSummary);
         }
-        if (this.garbageCollector.writeDataAtRoot) {
-            const gcSummary = this.garbageCollector.summarize(fullTree, trackState, telemetryContext);
-            if (gcSummary !== undefined) {
-                (0, runtime_utils_1.addSummarizeResultToSummary)(summaryTree, garbageCollection_1.gcTreeKey, gcSummary);
-            }
+        const gcSummary = this.garbageCollector.summarize(fullTree, trackState, telemetryContext);
+        if (gcSummary !== undefined) {
+            (0, runtime_utils_1.addSummarizeResultToSummary)(summaryTree, garbageCollection_1.gcTreeKey, gcSummary);
         }
     }
     // Track how many times the container tries to reconnect with pending messages.
@@ -1015,23 +1035,10 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         (0, common_utils_1.assert)(await context.isRoot(), 0x12b /* "did not get root data store" */);
         return context.realize();
     }
-    setFlushMode(mode) {
-        if (mode === this._flushMode) {
-            return;
-        }
-        this.mc.logger.sendTelemetryEvent({
-            eventName: "FlushMode Updated",
-            old: this._flushMode,
-            new: mode,
-        });
-        // Flush any pending batches if switching to immediate
-        if (mode === runtime_definitions_1.FlushMode.Immediate) {
-            this.flush();
-        }
-        this._flushMode = mode;
-        // Let the PendingStateManager know that FlushMode has been updated.
-        this.pendingStateManager.onFlushModeUpdated(mode);
-    }
+    /**
+     * Flush the pending ops manually.
+     * This method is expected to be called at the end of a batch.
+     */
     flush() {
         (0, common_utils_1.assert)(this._orderSequentiallyCalls === 0, 0x24c /* "Cannot call `flush()` from `orderSequentially`'s callback" */);
         this.flushBatch(this.pendingAttachBatch.popBatch());
@@ -1060,7 +1067,33 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             if (this.context.submitBatchFn !== undefined) {
                 const batchToSend = [];
                 for (const message of batch) {
-                    batchToSend.push({ contents: message.contents, metadata: message.metadata });
+                    let contents = message.contents;
+                    let metadata = message.metadata;
+                    if (this.runtimeOptions.compressionOptions.minimumSize &&
+                        this.runtimeOptions.compressionOptions.minimumSize < message.contents.length) {
+                        this.compressedOpCount++;
+                        const copiedMessage = Object.assign({}, message.deserializedContent);
+                        const compressionStart = Date.now();
+                        const contentsAsBuffer = new TextEncoder().encode(JSON.stringify(copiedMessage.contents));
+                        const compressedContents = (0, lz4js_1.compress)(contentsAsBuffer);
+                        const compressedContent = common_utils_1.IsoBuffer.from(compressedContents).toString("base64");
+                        const duration = Date.now() - compressionStart;
+                        if (this.compressedOpCount % 100) {
+                            this.mc.logger.sendPerformanceEvent({
+                                eventName: "compressedOp",
+                                duration,
+                                sizeBeforeCompression: message.contents.length,
+                                sizeAfterCompression: compressedContent.length,
+                            });
+                        }
+                        copiedMessage.contents = compressedContent;
+                        const stringifiedContents = JSON.stringify(copiedMessage);
+                        if (stringifiedContents.length < message.contents.length) {
+                            contents = JSON.stringify(copiedMessage);
+                            metadata = Object.assign(Object.assign({}, message.metadata), { compressed: true });
+                        }
+                    }
+                    batchToSend.push({ contents, metadata });
                 }
                 // returns clientSequenceNumber of last message in a batch
                 clientSequenceNumber = this.context.submitBatchFn(batchToSend);
@@ -1087,26 +1120,6 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         this.pendingStateManager.onFlush();
     }
     orderSequentially(callback) {
-        // If flush mode is already TurnBased we are either
-        // nested in another orderSequentially, or
-        // the app is flushing manually, in which
-        // case this invocation doesn't own
-        // flushing.
-        if (this.flushMode === runtime_definitions_1.FlushMode.TurnBased) {
-            this.trackOrderSequentiallyCalls(callback);
-            return;
-        }
-        const savedFlushMode = this.flushMode;
-        this.setFlushMode(runtime_definitions_1.FlushMode.TurnBased);
-        try {
-            this.trackOrderSequentiallyCalls(callback);
-            this.flush();
-        }
-        finally {
-            this.setFlushMode(savedFlushMode);
-        }
-    }
-    trackOrderSequentiallyCalls(callback) {
         let checkpoint;
         if (this.mc.config.getBoolean("Fluid.ContainerRuntime.EnableRollback")) {
             // Note: we are not touching this.pendingAttachBatch here, for two reasons:
@@ -1141,6 +1154,9 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         finally {
             this._orderSequentiallyCalls--;
         }
+        if (this.flushMode === runtime_definitions_1.FlushMode.Immediate && this._orderSequentiallyCalls === 0) {
+            this.flush();
+        }
     }
     async createDataStore(pkg) {
         const internalId = (0, uuid_1.v4)();
@@ -1167,6 +1183,12 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
     canSendOps() {
         return this.connected && !this.deltaManager.readOnlyInfo.readonly;
     }
+    /**
+     * Are we in the middle of batching ops together?
+     */
+    currentlyBatching() {
+        return this.flushMode === runtime_definitions_1.FlushMode.TurnBased || this._orderSequentiallyCalls !== 0;
+    }
     getQuorum() {
         return this.context.quorum;
     }
@@ -1317,10 +1339,8 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
      * Implementation of IGarbageCollectionRuntime::updateUsedRoutes.
      * After GC has run, called to notify this container's nodes of routes that are used in it.
      * @param usedRoutes - The routes that are used in all nodes in this Container.
-     * @param gcTimestamp - The time when GC was run that generated these used routes. If any node node becomes
-     * unreferenced as part of this GC run, this should be used to update the time when it happens.
      */
-    updateUsedRoutes(usedRoutes, gcTimestamp) {
+    updateUsedRoutes(usedRoutes) {
         // Update our summarizer node's used routes. Updating used routes in summarizer node before
         // summarizing is required and asserted by the the summarizer node. We are the root and are
         // always referenced, so the used routes is only self-route (empty string).
@@ -1331,7 +1351,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                 dataStoreUsedRoutes.push(route);
             }
         }
-        return this.dataStores.updateUsedRoutes(dataStoreUsedRoutes, gcTimestamp);
+        return this.dataStores.updateUsedRoutes(dataStoreUsedRoutes);
     }
     /**
      * When running GC in test mode, this is called to delete objects whose routes are unused. This enables testing
@@ -1717,8 +1737,8 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             //    issue than sending.
             // Please note that this does not change file format, so it can be disabled in the future if this
             // optimization no longer makes sense (for example, batch compression may make it less appealing).
-            if (type === ContainerMessageType.Attach &&
-                this.mc.config.getBoolean("Fluid.ContainerRuntime.disableAttachOpReorder") !== true) {
+            if (this.currentlyBatching() && type === ContainerMessageType.Attach &&
+                this.mc.config.getBoolean("Fluid.ContainerRuntime.enableAttachOpReorder") === true) {
                 if (!this.pendingAttachBatch.push(message)) {
                     // BatchManager has two limits - soft limit & hard limit. Soft limit is only engaged
                     // when queue is not empty.
@@ -1743,18 +1763,18 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                         limit: this.pendingBatch.limit,
                     });
                 }
-            }
-            if (this._flushMode !== runtime_definitions_1.FlushMode.TurnBased) {
-                this.flush();
-            }
-            else if (!this.flushTrigger) {
-                this.flushTrigger = true;
-                // Queue a microtask to detect the end of the turn and force a flush.
-                // eslint-disable-next-line @typescript-eslint/no-floating-promises
-                Promise.resolve().then(() => {
-                    this.flushTrigger = false;
+                if (!this.currentlyBatching()) {
                     this.flush();
-                });
+                }
+                else if (!this.flushMicroTaskExists) {
+                    this.flushMicroTaskExists = true;
+                    // Queue a microtask to detect the end of the turn and force a flush.
+                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                    Promise.resolve().then(() => {
+                        this.flushMicroTaskExists = false;
+                        this.flush();
+                    });
+                }
             }
         }
         catch (error) {
@@ -1825,7 +1845,8 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         }
     }
     /** Implementation of ISummarizerInternalsProvider.refreshLatestSummaryAck */
-    async refreshLatestSummaryAck(proposalHandle, ackHandle, summaryRefSeq, summaryLogger) {
+    async refreshLatestSummaryAck(options) {
+        const { proposalHandle, ackHandle, summaryRefSeq, summaryLogger } = options;
         const readAndParseBlob = async (id) => (0, driver_utils_1.readAndParse)(this.storage, id);
         // The call to fetch the snapshot is very expensive and not always needed.
         // It should only be done by the summarizerNode, if required.
@@ -1898,6 +1919,9 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         // getPendingLocalState() is only exposed through Container.closeAndGetPendingLocalState(), so it's safe
         // to close current batch.
         this.flush();
+        if (this._orderSequentiallyCalls !== 0) {
+            throw new container_utils_1.UsageError("can't get state during orderSequentially");
+        }
         const previousPendingState = this.context.pendingLocalState;
         if (previousPendingState) {
             return {