@fluidframework/container-runtime 2.41.0 → 2.42.0

package/dist/containerRuntime.js

@@ -197,6 +197,20 @@ async function loadContainerRuntime(params) {
 }
 exports.loadContainerRuntime = loadContainerRuntime;
 const defaultMaxConsecutiveReconnects = 7;
+/**
+ * These are the ONLY message types that are allowed to be submitted while in staging mode
+ * (Does not apply to pre-StagingMode batches that are resubmitted, those are not considered to be staged)
+ */
+function canStageMessageOfType(type) {
+    return (
+    // These are user changes coming up from the runtime's DataStores
+    type === messageTypes_js_1.ContainerMessageType.FluidDataStoreOp ||
+        // GC ops are used to detect issues in the reference graph so all clients can repair their GC state.
+        // These can be submitted at any time, including while in Staging Mode.
+        type === messageTypes_js_1.ContainerMessageType.GC ||
+        // These are typically sent shortly after boot and will not be common in Staging Mode, but it's possible.
+        type === messageTypes_js_1.ContainerMessageType.DocumentSchemaChange);
+}
 /**
  * Represents the runtime of the container. Contains helper functions/state of the container.
  * It will define the store level mappings.
@@ -245,6 +259,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         if (!(0, compatUtils_js_1.isValidMinVersionForCollab)(minVersionForCollab)) {
             throw new internal_8.UsageError(`Invalid minVersionForCollab: ${minVersionForCollab}. It must be an existing FF version (i.e. 2.22.1).`);
         }
+        // We also validate that there is not a mismatch between `minVersionForCollab` and runtime options that
+        // were manually set.
+        (0, compatUtils_js_1.validateRuntimeOptions)(minVersionForCollab, runtimeOptions);
         const defaultsAffectingDocSchema = (0, compatUtils_js_1.getMinVersionForCollabDefaults)(minVersionForCollab);
         // The following are the default values for the options that do not affect the DocumentSchema.
         const defaultsNotAffectingDocSchema = {
@@ -510,8 +527,12 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     ensureNoDataModelChanges(callback) {
         return this.dataModelChangeRunner.run(callback);
     }
+    /**
+     * Indicates whether the container is in a state where it is able to send
+     * ops (connected to op stream and not in readonly mode).
+     */
     get connected() {
-        return this._connected;
+        return this.canSendOps;
     }
     /**
      * clientId of parent (non-summarizing) container that owns summarizer container
@@ -599,7 +620,10 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         // eslint-disable-next-line import/no-deprecated
         this.enterStagingMode = () => {
             if (this.stageControls !== undefined) {
-                throw new Error("already in staging mode");
+                throw new internal_8.UsageError("already in staging mode");
+            }
+            if (this.attachState === container_definitions_1.AttachState.Detached) {
+                throw new internal_8.UsageError("cannot enter staging mode while detached");
             }
             // Make sure all BatchManagers are empty before entering staging mode,
             // since we mark whole batches as "staged" or not to indicate whether to submit them.
@@ -620,7 +644,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                     // Pop all staged batches from the PSM and roll them back in LIFO order
                     this.pendingStateManager.popStagedBatches(({ runtimeOp, localOpMetadata }) => {
                         (0, internal_2.assert)(runtimeOp !== undefined, 0xb82 /* Staged batches expected to have runtimeOp defined */);
-                        this.rollback(runtimeOp, localOpMetadata);
+                        this.rollbackStagedChanges(runtimeOp, localOpMetadata);
                     });
                     this.updateDocumentDirtyState();
                 }),
@@ -657,6 +681,11 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         this.mc = (0, internal_8.createChildMonitoringContext)({
             logger: this.baseLogger,
             namespace: "ContainerRuntime",
+            properties: {
+                all: {
+                    inStagingMode: this.inStagingMode,
+                },
+            },
         });
         // If we support multiple algorithms in the future, then we would need to manage it here carefully.
         // We can use runtimeOptions.compressionOptions.compressionAlgorithm, but only if it's in the schema list!
@@ -697,7 +726,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         // Values are generally expected to be set from the runtime side.
         this.options = options ?? {};
         this.clientDetails = clientDetails;
-        const isSummarizerClient = this.clientDetails.type === index_js_4.summarizerClientType;
+        this.isSummarizerClient = this.clientDetails.type === index_js_4.summarizerClientType;
         this.loadedFromVersionId = context.getLoadedFromVersion()?.id;
         // eslint-disable-next-line unicorn/consistent-destructuring
         this._getClientId = () => context.clientId;
@@ -734,7 +763,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             details: { attachState: this.attachState },
         }));
         // In cases of summarizer, we want to dispose instead since consumer doesn't interact with this container
-        this.closeFn = isSummarizerClient ? this.disposeFn : closeFn;
+        this.closeFn = this.isSummarizerClient ? this.disposeFn : closeFn;
         let loadSummaryNumber;
         // Get the container creation metadata. For new container, we initialize these. For existing containers,
         // get the values from the metadata blob.
@@ -758,7 +787,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         this.messageAtLastSummary = lastMessageFromMetadata(metadata);
         // Note that we only need to pull the *initial* connected state from the context.
         // Later updates come through calls to setConnectionState.
-        this._connected = connected;
+        this.canSendOps = connected;
         this.mc.logger.sendTelemetryEvent({
             eventName: "GCFeatureMatrix",
             metadataValue: JSON.stringify(metadata?.gcFeatureMatrix),
@@ -851,7 +880,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             existing,
             metadata,
             createContainerMetadata: this.createContainerMetadata,
-            isSummarizerClient,
+            isSummarizerClient: this.isSummarizerClient,
             getNodePackagePath: async (nodePath) => this.getGCNodePackagePath(nodePath),
             getLastSummaryTimestampMs: () => this.messageAtLastSummary?.timestamp,
             readAndParseBlob: async (id) => (0, internal_4.readAndParse)(this.storage, id),
@@ -935,7 +964,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             // Keep the old flag name even though we renamed the class member (it shipped in 2.31.0)
             this.mc.config.getBoolean("Fluid.ContainerRuntime.DisableFlushBeforeProcess") === true;
         this.outbox = new index_js_3.Outbox({
-            shouldSend: () => this.canSendOps(),
+            shouldSend: () => this.shouldSendOps(),
             pendingStateManager: this.pendingStateManager,
             submitBatchFn,
             legacySendBatchFn,
@@ -1074,7 +1103,14 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         await this.initializeSummarizer(loader);
         if (this.sessionSchema.idCompressorMode === "on" ||
             (this.sessionSchema.idCompressorMode === "delayed" && this.connected)) {
-            this._idCompressor = this.createIdCompressorFn();
+            internal_8.PerformanceEvent.timedExec(this.mc.logger, { eventName: "CreateIdCompressorOnBoot" }, (event) => {
+                this._idCompressor = this.createIdCompressorFn();
+                event.end({
+                    details: {
+                        idCompressorMode: this.sessionSchema.idCompressorMode,
+                    },
+                });
+            });
             // This is called from loadRuntime(), long before we process any ops, so there should be no ops accumulated yet.
             (0, internal_2.assert)(this.pendingIdCompressorOps.length === 0, 0x8ec /* no pending ops */);
         }
@@ -1103,8 +1139,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         const orderedClientCollection = new index_js_4.OrderedClientCollection(orderedClientLogger, this.innerDeltaManager, this._quorum);
         const orderedClientElectionForSummarizer = new index_js_4.OrderedClientElection(orderedClientLogger, orderedClientCollection, this.electedSummarizerData ?? this.innerDeltaManager.lastSequenceNumber, index_js_4.SummarizerClientElection.isClientEligible, this.mc.config.getBoolean("Fluid.ContainerRuntime.OrderedClientElection.EnablePerformanceEvents"));
         this.summarizerClientElection = new index_js_4.SummarizerClientElection(orderedClientLogger, summaryCollection, orderedClientElectionForSummarizer, maxOpsSinceLastSummary);
-        const isSummarizerClient = this.clientDetails.type === index_js_4.summarizerClientType;
-        if (isSummarizerClient) {
+        if (this.isSummarizerClient) {
             // We want to dynamically import any thing inside summaryDelayLoadedModule module only when we are the summarizer client,
             // so that all non summarizer clients don't have to load the code inside this module.
             const module = await import(
@@ -1452,7 +1487,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     }
     replayPendingStates() {
         // We need to be able to send ops to replay states
-        if (!this.canSendOps()) {
+        if (!this.shouldSendOps()) {
             return;
         }
         // Replaying is an internal operation and we don't want to generate noise while doing it.
@@ -1534,25 +1569,35 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     loadIdCompressor() {
         if (this._idCompressor === undefined &&
             this.sessionSchema.idCompressorMode !== undefined) {
-            this._idCompressor = this.createIdCompressorFn();
-            // Finalize any ranges we received while the compressor was turned off.
-            const ops = this.pendingIdCompressorOps;
-            this.pendingIdCompressorOps = [];
-            for (const range of ops) {
-                this._idCompressor.finalizeCreationRange(range);
-            }
+            internal_8.PerformanceEvent.timedExec(this.mc.logger, { eventName: "CreateIdCompressorOnDelayedLoad" }, (event) => {
+                this._idCompressor = this.createIdCompressorFn();
+                // Finalize any ranges we received while the compressor was turned off.
+                const ops = this.pendingIdCompressorOps;
+                this.pendingIdCompressorOps = [];
+                const trace = client_utils_1.Trace.start();
+                for (const range of ops) {
+                    this._idCompressor.finalizeCreationRange(range);
+                }
+                event.end({
+                    details: {
+                        finalizeCreationRangeDuration: trace.trace().duration,
+                        idCompressorMode: this.sessionSchema.idCompressorMode,
+                        pendingIdCompressorOps: ops.length,
+                    },
+                });
+            });
             (0, internal_2.assert)(this.pendingIdCompressorOps.length === 0, 0x976 /* No new ops added */);
         }
     }
-    setConnectionState(connected, clientId) {
+    setConnectionState(canSendOps, clientId) {
         // Validate we have consistent state
         const currentClientId = this._audience.getSelf()?.clientId;
         (0, internal_2.assert)(clientId === currentClientId, 0x977 /* input clientId does not match Audience */);
         (0, internal_2.assert)(this.clientId === currentClientId, 0x978 /* this.clientId does not match Audience */);
-        if (connected && this.sessionSchema.idCompressorMode === "delayed") {
+        if (canSendOps && this.sessionSchema.idCompressorMode === "delayed") {
             this.loadIdCompressor();
         }
-        if (connected === false && this.delayConnectClientId !== undefined) {
+        if (canSendOps === false && this.delayConnectClientId !== undefined) {
             this.delayConnectClientId = undefined;
             this.mc.logger.sendTelemetryEvent({
                 eventName: "UnsuccessfulConnectedTransition",
@@ -1560,37 +1605,39 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             // Don't propagate "disconnected" event because we didn't propagate the previous "connected" event
             return;
         }
-        if (!connected) {
-            this.documentsSchemaController.onDisconnect();
-        }
         // If there are stashed blobs in the pending state, we need to delay
         // propagation of the "connected" event until we have uploaded them to
         // ensure we don't submit ops referencing a blob that has not been uploaded
-        const connecting = connected && !this._connected;
+        const connecting = canSendOps && !this.canSendOps;
         if (connecting && this.blobManager.hasPendingStashedUploads()) {
             (0, internal_2.assert)(!this.delayConnectClientId, 0x791 /* Connect event delay must be canceled before subsequent connect event */);
             (0, internal_2.assert)(!!clientId, 0x792 /* Must have clientId when connecting */);
             this.delayConnectClientId = clientId;
             return;
         }
-        this.setConnectionStateCore(connected, clientId);
+        this.setConnectionStateCore(canSendOps, clientId);
     }
-    setConnectionStateCore(connected, clientId) {
+    /**
+     * Raises and propagates connected events.
+     * @param canSendOps - Indicates whether the container can send ops or not (connected and not readonly).
+     * @remarks The connection state from container context used here when raising connected events.
+     */
+    setConnectionStateCore(canSendOps, clientId) {
         (0, internal_2.assert)(!this.delayConnectClientId, 0x394 /* connect event delay must be cleared before propagating connect event */);
         this.verifyNotClosed();
         // There might be no change of state due to Container calling this API after loading runtime.
-        const changeOfState = this._connected !== connected;
-        const reconnection = changeOfState && !connected;
+        const canSendOpsChanged = this.canSendOps !== canSendOps;
+        const reconnection = canSendOpsChanged && !canSendOps;
         // We need to flush the ops currently collected by Outbox to preserve original order.
         // This flush NEEDS to happen before we set the ContainerRuntime to "connected".
         // We want these ops to get to the PendingStateManager without sending to service and have them return to the Outbox upon calling "replayPendingStates".
-        if (changeOfState && connected) {
+        if (canSendOpsChanged && canSendOps) {
             this.flush();
         }
-        this._connected = connected;
-        if (connected) {
+        this.canSendOps = canSendOps;
+        if (canSendOps) {
             (0, internal_2.assert)(this.attachState === container_definitions_1.AttachState.Attached, 0x3cd /* Connection is possible only if container exists in storage */);
-            if (changeOfState) {
+            if (canSendOpsChanged) {
                 this.signalTelemetryManager.resetTracking();
             }
         }
@@ -1606,12 +1653,12 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 return;
             }
         }
-        if (changeOfState) {
+        if (canSendOpsChanged) {
             this.replayPendingStates();
         }
-        this.channelCollection.setConnectionState(connected, clientId);
-        this.garbageCollector.setConnectionState(connected, clientId);
-        (0, internal_8.raiseConnectedEvent)(this.mc.logger, this, connected, clientId);
+        this.channelCollection.setConnectionState(canSendOps, clientId);
+        this.garbageCollector.setConnectionState(canSendOps, clientId);
+        (0, internal_8.raiseConnectedEvent)(this.mc.logger, this, this.connected /* canSendOps */, clientId);
     }
     async notifyOpReplay(message) {
         await this.pendingStateManager.applyStashedOpsAt(message.sequenceNumber);
@@ -2018,7 +2065,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 if (checkpoint) {
                     // This will throw and close the container if rollback fails
                     try {
-                        checkpoint.rollback((message) => this.rollback(message.runtimeOp, message.localOpMetadata));
+                        checkpoint.rollback((message) => 
+                        // These changes are staged since we entered staging mode above
+                        this.rollbackStagedChanges(message.runtimeOp, message.localOpMetadata));
                         this.updateDocumentDirtyState();
                         stageControls?.discardChanges();
                         stageControls = undefined;
@@ -2095,7 +2144,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         const context = this.channelCollection.createDataStoreContext(Array.isArray(pkg) ? pkg : [pkg], loadingGroupId);
         return (0, dataStore_js_1.channelToDataStore)(await context.realize(), context.id, this.channelCollection, this.mc.logger);
     }
-    canSendOps() {
+    shouldSendOps() {
         // Note that the real (non-proxy) delta manager is needed here to get the readonly info. This is because
         // container runtime's ability to send ops depend on the actual readonly state of the delta manager.
         return (this.connected && !this.innerDeltaManager.readOnlyInfo.readonly && !this.imminentClosure);
@@ -2784,6 +2833,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         try {
             // If we're resubmitting a batch, keep the same "staged" value as before.  Otherwise, use the current "global" state.
             const staged = this.batchRunner.resubmitInfo?.staged ?? this.inStagingMode;
+            (0, internal_2.assert)(!staged || canStageMessageOfType(type), 0xbba /* Unexpected message type submitted in Staging Mode */);
             // Before submitting any non-staged change, submit the ID Allocation op to cover any compressed IDs included in the op.
             if (!staged) {
                 this.submitIdAllocationOpIfNeeded({ staged: false });
@@ -2791,7 +2841,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             // Allow document schema controller to send a message if it needs to propose change in document schema.
             // If it needs to send a message, it will call provided callback with payload of such message and rely
             // on this callback to do actual sending.
-            const schemaChangeMessage = this.documentsSchemaController.maybeSendSchemaMessage();
+            const schemaChangeMessage = this.documentsSchemaController.maybeGenerateSchemaMessage();
             if (schemaChangeMessage) {
                 this.mc.logger.sendTelemetryEvent({
                     eventName: "SchemaChangeProposal",
@@ -2889,43 +2939,72 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     }
     /**
      * Resubmits each message in the batch, and then flushes the outbox.
+     * This typically happens when we reconnect and there are pending messages.
      *
-     * @remarks - If the "Offline Load" feature is enabled, the batchId is included in the resubmitted messages,
+     * @remarks
+     * Attempting to resubmit a batch that has been successfully sequenced will not happen due to
+     * checks in the ConnectionStateHandler (Loader layer)
+     *
+     * The only exception to this would be if the Container "forks" due to misuse of the "Offline Load" feature.
+     * If the "Offline Load" feature is enabled, the batchId is included in the resubmitted messages,
      * for correlation to detect container forking.
      */
     reSubmitBatch(batch, { batchId, staged, squash }) {
+        (0, internal_2.assert)(this._summarizer === undefined, 0x8f2 /* Summarizer never reconnects so should never resubmit */);
         const resubmitInfo = {
             // Only include Batch ID if "Offline Load" feature is enabled
             // It's only needed to identify batches across container forks arising from misuse of offline load.
             batchId: this.offlineEnabled ? batchId : undefined,
             staged,
         };
+        const resubmitFn = squash
+            ? this.reSubmitWithSquashing.bind(this)
+            : this.reSubmit.bind(this);
         this.batchRunner.run(() => {
             for (const message of batch) {
-                this.reSubmit(message, squash);
+                resubmitFn(message);
             }
         }, resubmitInfo);
         this.flush(resubmitInfo);
     }
-    reSubmit(message, squash) {
-        this.reSubmitCore(message.runtimeOp, message.localOpMetadata, message.opMetadata, squash);
+    /**
+     * Resubmit the given message as part of a squash rebase upon exiting Staging Mode.
+     * How exactly to resubmit the message is up to the subsystem that submitted the op to begin with.
+     */
+    reSubmitWithSquashing(resubmitData) {
+        const message = resubmitData.runtimeOp;
+        (0, internal_2.assert)(canStageMessageOfType(message.type), 0xbbb /* Expected message type to be compatible with staging */);
+        switch (message.type) {
+            case messageTypes_js_1.ContainerMessageType.FluidDataStoreOp: {
+                this.channelCollection.reSubmit(message.type, message.contents, resubmitData.localOpMetadata, 
+                /* squash: */ true);
+                break;
+            }
+            // NOTE: Squash doesn't apply to GC or DocumentSchemaChange ops, fallback to typical resubmit logic.
+            case messageTypes_js_1.ContainerMessageType.GC:
+            case messageTypes_js_1.ContainerMessageType.DocumentSchemaChange: {
+                this.reSubmit(resubmitData);
+                break;
+            }
+            default: {
+                (0, internal_2.unreachableCase)(message.type);
+            }
+        }
     }
     /**
-     * Finds the right store and asks it to resubmit the message. This typically happens when we
-     * reconnect and there are pending messages.
-     * ! Note: successfully resubmitting an op that has been successfully sequenced is not possible due to checks in the ConnectionStateHandler (Loader layer)
-     * @param message - The original LocalContainerRuntimeMessage.
-     * @param localOpMetadata - The local metadata associated with the original message.
+     * Resubmit the given message which was previously submitted to the ContainerRuntime but not successfully
+     * transmitted to the ordering service (e.g. due to a disconnect, or being in Staging Mode)
+     * How to resubmit is up to the subsystem that submitted the op to begin with
      */
-    reSubmitCore(message, localOpMetadata, opMetadata, squash) {
-        (0, internal_2.assert)(this._summarizer === undefined, 0x8f2 /* Summarizer never reconnects so should never resubmit */);
+    reSubmit({ runtimeOp: message, localOpMetadata, opMetadata, }) {
         switch (message.type) {
             case messageTypes_js_1.ContainerMessageType.FluidDataStoreOp:
             case messageTypes_js_1.ContainerMessageType.Attach:
             case messageTypes_js_1.ContainerMessageType.Alias: {
                 // For Operations, call resubmitDataStoreOp which will find the right store
                 // and trigger resubmission on it.
-                this.channelCollection.reSubmit(message.type, message.contents, localOpMetadata, squash);
+                this.channelCollection.reSubmit(message.type, message.contents, localOpMetadata, 
+                /* squash: */ false);
                 break;
             }
             case messageTypes_js_1.ContainerMessageType.IdAllocation: {
@@ -2951,9 +3030,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 break;
             }
             case messageTypes_js_1.ContainerMessageType.DocumentSchemaChange: {
-                // There is no need to resend this message. Document schema controller will properly resend it again (if needed)
-                // on a first occasion (any ops sent after reconnect). There is a good chance, though, that it will not want to
-                // send any ops, as some other client already changed schema.
+                // We shouldn't directly resubmit due to Compare-And-Swap semantics.
+                // If needed it will be generated from scratch before other ops are submitted.
+                this.documentsSchemaController.pendingOpNotAcked();
                 break;
             }
             default: {
@@ -2963,8 +3042,11 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             }
         }
     }
-    rollback(runtimeOp, localOpMetadata) {
-        const { type, contents } = runtimeOp;
+    /**
+     * Rollback the given op which was only staged but not yet submitted.
+     */
+    rollbackStagedChanges({ type, contents }, localOpMetadata) {
+        (0, internal_2.assert)(canStageMessageOfType(type), 0xbbc /* Unexpected message type to be rolled back */);
         switch (type) {
             case messageTypes_js_1.ContainerMessageType.FluidDataStoreOp: {
                 // For operations, call rollbackDataStoreOp which will find the right store
@@ -2972,8 +3054,24 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 this.channelCollection.rollback(type, contents, localOpMetadata);
                 break;
             }
+            case messageTypes_js_1.ContainerMessageType.GC: {
+                // Just drop it, but log an error, this is not expected and not ideal, but not critical failure either.
+                // Currently the only expected type here is TombstoneLoaded, which will have been preceded by one of these events as well:
+                // GC_Tombstone_DataStore_Requested, GC_Tombstone_SubDataStore_Requested, GC_Tombstone_Blob_Requested
+                this.mc.logger.sendErrorEvent({
+                    eventName: "GC_OpDiscarded",
+                    details: { subType: contents.type },
+                });
+                break;
+            }
+            case messageTypes_js_1.ContainerMessageType.DocumentSchemaChange: {
+                // Notify the document schema controller that the pending op was not acked.
+                // This will allow it to propose the schema change again if needed.
+                this.documentsSchemaController.pendingOpNotAcked();
+                break;
+            }
             default: {
-                throw new Error(`Can't rollback ${type}`);
+                (0, internal_2.unreachableCase)(type);
             }
         }
     }
@@ -3151,6 +3249,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 },
                 getQuorum: this.getQuorum.bind(this),
                 getAudience: this.getAudience.bind(this),
+                supportedFeatures: this.ILayerCompatDetails.supportedFeatures,
             };
             entry = new factory(runtime, ...useContext);
             this.extensions.set(id, entry);