@fluidframework/datastore 2.41.0-338401 → 2.42.0

package/dist/dataStoreRuntime.js

@@ -37,6 +37,21 @@ var DataStoreMessageType;
 const defaultPolicies = {
     readonlyInStagingMode: true,
 };
+/**
+ * Set up the boxed pendingOpCount value.
+ */
+function initializePendingOpCount() {
+    let value = 0;
+    return {
+        get value() {
+            return value;
+        },
+        set value(newValue) {
+            (0, internal_1.assert)(newValue >= 0, 0xbbd /* pendingOpCount must be non-negative */);
+            value = newValue;
+        },
+    };
+}
 /**
  * Base data store class
  * @legacy
@@ -67,6 +82,8 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
     get idCompressor() {
         return this.dataStoreContext.idCompressor;
     }
+    // TODO: the methods below should have more specific return typing, per the interfaces they are implementing.
+    // Doing so would be a breaking change.
     get IFluidHandleContext() {
         return this;
     }
@@ -121,6 +138,11 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
          * is currently marked as legacy alpha. So, using unknown here.
          */
         this.ILayerCompatDetails = dataStoreLayerCompatState_js_1.dataStoreCompatDetailsForRuntime;
+        /**
+         * Count of pending ops that have been submitted but not yet ack'd.
+         * Used to compute {@link FluidDataStoreRuntime.isDirty}
+         */
+        this.pendingOpCount = initializePendingOpCount();
         (0, internal_1.assert)(!dataStoreContext.id.includes("/"), 0x30e /* Id cannot contain slashes. DataStoreContext should have validated this. */);
         this.policies = { ...defaultPolicies, ...policies };
         // Validate that the Runtime is compatible with this DataStore.
@@ -151,10 +173,10 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         const tree = dataStoreContext.baseSnapshot;
         // Must always receive the data store type inside of the attributes
         if (tree?.trees !== undefined) {
-            Object.entries(tree.trees).forEach(([path, subtree]) => {
+            for (const [path, subtree] of Object.entries(tree.trees)) {
                 // Issue #4414
                 if (path === "_search") {
-                    return;
+                    continue;
                 }
                 let channelContext;
                 // If already exists on storage, then create a remote channel. However, if it is case of rehydrating a
@@ -166,11 +188,11 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                     // data store, if the data store is loaded after the container is attached, then we missed making
                     // the channel visible. So do it now. Otherwise, add it to local channel context queue, so
                     // that it can be make it visible later with the data store.
-                    if (dataStoreContext.attachState !== container_definitions_1.AttachState.Detached) {
-                        channelContext.makeVisible();
+                    if (dataStoreContext.attachState === container_definitions_1.AttachState.Detached) {
+                        this.localChannelContextQueue.set(path, channelContext);
                     }
                     else {
-                        this.localChannelContextQueue.set(path, channelContext);
+                        channelContext.makeVisible();
                     }
                 }
                 else {
@@ -179,7 +201,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                     }));
                 }
                 this.contexts.set(path, channelContext);
-            });
+            }
         }
         this.entryPoint = new fluidHandle_js_1.FluidObjectHandle(new internal_1.LazyPromise(async () => provideEntryPoint(this)), "", this.objectsRoutingContext);
         this.attachListener();
@@ -210,17 +232,27 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         // By default, a data store can log maximum 10 local changes telemetry in summarizer.
         this.localChangesTelemetryCount =
             this.mc.config.getNumber("Fluid.Telemetry.LocalChangesTelemetryCount") ?? 10;
+        // Reference these properties to avoid unused private member errors.
+        // They're accessed via IFluidDataStoreRuntimeExperimental interface.
+        // eslint-disable-next-line no-void
+        void [this.inStagingMode, this.isDirty];
+    }
+    /**
+     * Implementation of IFluidDataStoreRuntimeExperimental.inStagingMode
+     */
+    // eslint-disable-next-line import/no-deprecated
+    get inStagingMode() {
+        return (
         // eslint-disable-next-line import/no-deprecated
-        const base = 
-        // eslint-disable-next-line import/no-deprecated
-        this.dataStoreContext.containerRuntime;
-        if (base !== undefined && "inStagingMode" in base) {
-            Object.defineProperty(this, "inStagingMode", {
-                get: () => {
-                    return base.inStagingMode;
-                },
-            });
-        }
+        this.dataStoreContext.containerRuntime
+            ?.inStagingMode);
+    }
+    /**
+     * Implementation of IFluidDataStoreRuntimeExperimental.isDirty
+     */
+    // eslint-disable-next-line import/no-deprecated
+    get isDirty() {
+        return this.pendingOpCount.value > 0;
     }
     get deltaManager() {
         return (0, internal_4.toDeltaManagerErased)(this.deltaManagerInternal);
@@ -321,11 +353,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
     }
     createChannel(idArg, type) {
         let id;
-        if (idArg !== undefined) {
-            id = idArg;
-            this.validateChannelId(id);
-        }
-        else {
+        if (idArg === undefined) {
             /**
              * Return uuid if short-ids are explicitly disabled via feature flags.
              */
@@ -339,19 +367,23 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 // - uuids
                 // In first two cases we will encode result as strings in more compact form, with leading underscore,
                 // to ensure no overlap with user-provided DDS names (see validateChannelId())
-                if (this.visibilityState !== internal_3.VisibilityState.GloballyVisible) {
-                    // container is detached, only one client observes content, no way to hit collisions with other clients.
-                    id = (0, internal_4.encodeCompactIdToString)(2 * this.contexts.size, "_");
-                }
-                else {
+                if (this.visibilityState === internal_3.VisibilityState.GloballyVisible) {
                     // Due to back-compat, we could not depend yet on generateDocumentUniqueId() being there.
                     // We can remove the need to leverage uuid() as fall-back in couple releases.
                     const res = this.dataStoreContext.containerRuntime.generateDocumentUniqueId?.() ?? (0, uuid_1.v4)();
                     id = typeof res === "number" ? (0, internal_4.encodeCompactIdToString)(2 * res + 1, "_") : res;
                 }
+                else {
+                    // container is detached, only one client observes content, no way to hit collisions with other clients.
+                    id = (0, internal_4.encodeCompactIdToString)(2 * this.contexts.size, "_");
+                }
             }
             (0, internal_1.assert)(!id.includes("/"), 0x8fc /* slash */);
         }
+        else {
+            id = idArg;
+            this.validateChannelId(id);
+        }
         this.verifyNotClosed();
         (0, internal_1.assert)(!this.contexts.has(id), 0x179 /* "createChannel() with existing ID" */);
         (0, internal_1.assert)(type !== undefined, 0x209 /* "Factory Type should be defined" */);
@@ -415,9 +447,9 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
             return;
         }
         this.visibilityState = internal_3.VisibilityState.LocallyVisible;
-        this.pendingHandlesToMakeVisible.forEach((handle) => {
+        for (const handle of this.pendingHandlesToMakeVisible) {
             handle.attachGraph();
-        });
+        }
         this.pendingHandlesToMakeVisible.clear();
         this.dataStoreContext.makeLocallyVisible();
     }
@@ -483,7 +515,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
          */
         let currentAddress;
         let currentMessagesContent = [];
-        const { messagesContent, local } = messageCollection;
+        const { messagesContent, local, envelope } = messageCollection;
         const sendBunchedMessages = () => {
             // Current address will be undefined for the first message in the list.
             if (currentAddress === undefined) {
@@ -493,7 +525,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
             const channelContext = this.contexts.get(currentAddress);
             (0, internal_1.assert)(!!channelContext, 0xa6b /* Channel context not found */);
             channelContext.processMessages({
-                envelope: messageCollection.envelope,
+                envelope,
                 messagesContent: currentMessagesContent,
                 local,
             });
@@ -548,15 +580,20 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      */
     processMessages(messageCollection) {
         this.verifyNotClosed();
-        const { envelope, messagesContent } = messageCollection;
+        const { envelope, local, messagesContent } = messageCollection;
+        if (local) {
+            this.pendingOpCount.value -= messagesContent.length;
+        }
         try {
             switch (envelope.type) {
-                case DataStoreMessageType.ChannelOp:
+                case DataStoreMessageType.ChannelOp: {
                     this.processChannelMessages(messageCollection);
                     break;
-                case DataStoreMessageType.Attach:
+                }
+                case DataStoreMessageType.Attach: {
                     this.processAttachMessages(messageCollection);
                     break;
+                }
                 default:
             }
         }
@@ -758,7 +795,10 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
             }
         }
     }
-    submitMessage(type, content, localOpMetadata) {
+    submitMessage(type, 
+    // TODO: use something other than `any` here (breaking change)
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    content, localOpMetadata) {
         this.submit(type, content, localOpMetadata);
     }
     /**
@@ -769,7 +809,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      */
     submitSignal(type, content, targetClientId) {
         this.verifyNotClosed();
-        return this.dataStoreContext.submitSignal(type, content, targetClientId);
+        this.dataStoreContext.submitSignal(type, content, targetClientId);
     }
     /**
      * Will return when the data store is attached.
@@ -813,6 +853,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
     submit(type, content, localOpMetadata = undefined) {
         this.verifyNotClosed();
         this.dataStoreContext.submitMessage(type, content, localOpMetadata);
+        ++this.pendingOpCount.value;
     }
     /**
      * For messages of type MessageType.Operation, finds the right channel and asks it to resubmit the message.
@@ -821,8 +862,14 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      * @param content - The content of the original message.
      * @param localOpMetadata - The local metadata associated with the original message.
      */
-    reSubmit(type, content, localOpMetadata, squash) {
+    reSubmit(type, 
+    // TODO: use something other than `any` here (breaking change)
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    content, localOpMetadata, squash) {
         this.verifyNotClosed();
+        // The op being resubmitted was not / will not be submitted, so decrement the count.
+        // The calls below may result in one or more ops submitted again, which will increment the count (or not if nothing needs to be submitted anymore).
+        --this.pendingOpCount.value;
         switch (type) {
             case DataStoreMessageType.ChannelOp: {
                 // For Operations, find the right channel and trigger resubmission on it.
@@ -832,12 +879,14 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 channelContext.reSubmit(envelope.contents, localOpMetadata, squash);
                 break;
             }
-            case DataStoreMessageType.Attach:
+            case DataStoreMessageType.Attach: {
                 // For Attach messages, just submit them again.
                 this.submit(type, content, localOpMetadata);
                 break;
-            default:
+            }
+            default: {
                 (0, internal_1.unreachableCase)(type);
+            }
         }
     }
     /**
@@ -845,8 +894,13 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      * @param content - The content of the original message.
      * @param localOpMetadata - The local metadata associated with the original message.
      */
-    rollback(type, content, localOpMetadata) {
+    rollback(type, 
+    // TODO: use something other than `any` here (breaking change)
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    content, localOpMetadata) {
         this.verifyNotClosed();
+        // The op being rolled back was not/will not be submitted, so decrement the count.
+        --this.pendingOpCount.value;
         switch (type) {
             case DataStoreMessageType.ChannelOp: {
                 // For Operations, find the right channel and trigger resubmission on it.
@@ -856,14 +910,22 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 channelContext.rollback(envelope.contents, localOpMetadata);
                 break;
             }
-            default:
+            default: {
                 throw new internal_5.LoggingError(`Can't rollback ${type} message`);
+            }
         }
     }
+    // TODO: use something other than `any` here
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     async applyStashedOp(content) {
+        // The op being applied may have been submitted in a previous session, so we increment the count here.
+        // Either the ack will arrive and be processed, or that previous session's connection will end, at which point the op will be resubmitted.
+        ++this.pendingOpCount.value;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
         const type = content?.type;
         switch (type) {
             case DataStoreMessageType.Attach: {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
                 const attachMessage = content.content;
                 const flatBlobs = new Map();
                 const snapshotTree = (0, internal_2.buildSnapshotTree)(attachMessage.snapshot.entries, flatBlobs);
@@ -880,16 +942,25 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 return;
             }
             case DataStoreMessageType.ChannelOp: {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
                 const envelope = content.content;
                 const channelContext = this.contexts.get(envelope.address);
                 (0, internal_1.assert)(!!channelContext, 0x184 /* "There should be a channel context for the op" */);
                 await channelContext.getChannel();
                 return channelContext.applyStashedOp(envelope.contents);
             }
-            default:
+            default: {
                 (0, internal_1.unreachableCase)(type);
+            }
         }
     }
+    /**
+     * Indicates the given channel is dirty from Summarizer's point of view,
+     * i.e. it has local changes that need to be included in the summary.
+     *
+     * @remarks - If a channel's changes are rolled back or rebased away, we won't
+     * clear the dirty flag set here.
+     */
     setChannelDirty(address) {
         this.verifyNotClosed();
         this.dataStoreContext.setChannelDirty(address);
@@ -898,11 +969,13 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         this.setMaxListeners(Number.MAX_SAFE_INTEGER);
         // back-compat, to be removed in the future.
         // Added in "2.0.0-rc.2.0.0" timeframe.
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-explicit-any
         this.dataStoreContext.once?.("attaching", () => {
             this.setAttachState(container_definitions_1.AttachState.Attaching);
         });
         // back-compat, to be removed in the future.
         // Added in "2.0.0-rc.2.0.0" timeframe.
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-explicit-any
         this.dataStoreContext.once?.("attached", () => {
             this.setAttachState(container_definitions_1.AttachState.Attached);
         });
@@ -938,7 +1011,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
     }
     setAttachState(attachState) {
         switch (attachState) {
-            case container_definitions_1.AttachState.Attaching:
+            case container_definitions_1.AttachState.Attaching: {
                 /**
                  * back-compat 0.59.1000 - Ideally, attachGraph() should have already been called making the data store
                  * locally visible. However, before visibility state was added, this may not have been the case and data
@@ -953,21 +1026,24 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 (0, internal_1.assert)(this.visibilityState === internal_3.VisibilityState.LocallyVisible, 0x2d1 /* "Data store should be locally visible before it can become globally visible." */);
                 // Mark the data store globally visible and make its child channels visible as well.
                 this.visibilityState = internal_3.VisibilityState.GloballyVisible;
-                this.localChannelContextQueue.forEach((channel) => {
+                for (const [, channel] of this.localChannelContextQueue) {
                     channel.makeVisible();
-                });
+                }
                 this.localChannelContextQueue.clear();
                 // This promise resolution will be moved to attached event once we fix the scheduler.
                 this.deferredAttached.resolve();
                 this.emit("attaching");
                 break;
-            case container_definitions_1.AttachState.Attached:
+            }
+            case container_definitions_1.AttachState.Attached: {
                 (0, internal_1.assert)(this.visibilityState === internal_3.VisibilityState.GloballyVisible, 0x2d2 /* "Data store should be globally visible when its attached." */);
                 this._attachState = container_definitions_1.AttachState.Attached;
                 this.emit("attached");
                 break;
-            default:
+            }
+            default: {
                 (0, internal_1.unreachableCase)(attachState, "unreached");
+            }
         }
     }
 }
@@ -1020,6 +1096,7 @@ const mixinSummaryHandler = (handler, Base = FluidDataStoreRuntime) => class Run
         summary.summary.tree[firstName] = blob;
     }
     async summarize(...args) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         const summary = await super.summarize(...args);
         try {
             const content = await handler(this);
@@ -1027,9 +1104,9 @@ const mixinSummaryHandler = (handler, Base = FluidDataStoreRuntime) => class Run
                 this.addBlob(summary, content.path, content.content);
             }
         }
-        catch (e) {
+        catch (error) {
             // Any error coming from app-provided handler should be marked as DataProcessingError
-            throw internal_5.DataProcessingError.wrapIfUnrecognized(e, "mixinSummaryHandler");
+            throw internal_5.DataProcessingError.wrapIfUnrecognized(error, "mixinSummaryHandler");
         }
         return summary;
     }