@fluidframework/datastore 2.0.0-internal.3.0.2 → 2.0.0-internal.3.2.0

package/lib/dataStoreRuntime.js

@@ -8,12 +8,12 @@ import { assert, Deferred, LazyPromise, TypedEventEmitter, unreachableCase, } fr
 import { ChildLogger, generateStack, LoggingError, loggerToMonitoringContext, raiseConnectedEvent, TelemetryDataTag, } from "@fluidframework/telemetry-utils";
 import { buildSnapshotTree } from "@fluidframework/driver-utils";
 import { SummaryType, } from "@fluidframework/protocol-definitions";
-import { BindState, CreateSummarizerNodeSource, VisibilityState, } from "@fluidframework/runtime-definitions";
+import { CreateSummarizerNodeSource, VisibilityState, } from "@fluidframework/runtime-definitions";
 import { convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, generateHandleContextPath, RequestParser, SummaryTreeBuilder, create404Response, createResponseError, exceptionToResponse, requestFluidObject, packagePathToTelemetryProperty, } from "@fluidframework/runtime-utils";
-import { GCDataBuilder, removeRouteFromAllNodes, unpackChildNodesGCDetails, unpackChildNodesUsedRoutes, } from "@fluidframework/garbage-collector";
+import { GCDataBuilder, unpackChildNodesUsedRoutes } from "@fluidframework/garbage-collector";
 import { v4 as uuid } from "uuid";
 import { summarizeChannel } from "./channelContext";
-import { LocalChannelContext, LocalChannelContextBase, RehydratedLocalChannelContext } from "./localChannelContext";
+import { LocalChannelContext, LocalChannelContextBase, RehydratedLocalChannelContext, } from "./localChannelContext";
 import { RemoteChannelContext } from "./remoteChannelContext";
 import { FluidObjectHandle } from "./fluidHandle";
 export var DataStoreMessageType;
@@ -27,16 +27,16 @@ export var DataStoreMessageType;
  */
 export class FluidDataStoreRuntime extends TypedEventEmitter {
     /**
-    * Create an instance of a DataStore runtime.
-    *
-    * @param dataStoreContext - Context object for the runtime.
-    * @param sharedObjectRegistry - The registry of shared objects that this data store will be able to instantiate.
-    * @param existing - Pass 'true' if loading this datastore from an existing file; pass 'false' otherwise.
-    * @param initializeEntryPoint - Function to initialize the entryPoint object for the data store runtime. The
-    * handle to this data store runtime will point to the object returned by this function. If this function is not
-    * provided, the handle will be left undefined. This is here so we can start making handles a first-class citizen
-    * and the primary way of interacting with some Fluid objects, and should be used if possible.
-    */
+     * Create an instance of a DataStore runtime.
+     *
+     * @param dataStoreContext - Context object for the runtime.
+     * @param sharedObjectRegistry - The registry of shared objects that this data store will be able to instantiate.
+     * @param existing - Pass 'true' if loading this datastore from an existing file; pass 'false' otherwise.
+     * @param initializeEntryPoint - Function to initialize the entryPoint object for the data store runtime. The
+     * handle to this data store runtime will point to the object returned by this function. If this function is not
+     * provided, the handle will be left undefined. This is here so we can start making handles a first-class citizen
+     * and the primary way of interacting with some Fluid objects, and should be used if possible.
+     */
     constructor(dataStoreContext, sharedObjectRegistry, existing, initializeEntryPoint) {
         var _a;
         super();
@@ -62,10 +62,6 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         this.quorum = dataStoreContext.getQuorum();
         this.audience = dataStoreContext.getAudience();
         const tree = dataStoreContext.baseSnapshot;
-        this.channelsBaseGCDetails = new LazyPromise(async () => {
-            const baseGCDetails = await this.dataStoreContext.getBaseGCDetails();
-            return unpackChildNodesGCDetails(baseGCDetails);
-        });
         // Must always receive the data store type inside of the attributes
         if ((tree === null || tree === void 0 ? void 0 : tree.trees) !== undefined) {
             Object.keys(tree.trees).forEach((path) => {
@@ -91,7 +87,9 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
                     }
                 }
                 else {
-                    channelContext = new RemoteChannelContext(this, dataStoreContext, dataStoreContext.storage, (content, localOpMetadata) => this.submitChannelOp(path, content, localOpMetadata), (address) => this.setChannelDirty(address), (srcHandle, outboundHandle) => this.addedGCOutboundReference(srcHandle, outboundHandle), path, tree.trees[path], this.sharedObjectRegistry, undefined /* extraBlobs */, this.dataStoreContext.getCreateChildSummarizerNodeFn(path, { type: CreateSummarizerNodeSource.FromSummary }), async () => this.getChannelBaseGCDetails(path));
+                    channelContext = new RemoteChannelContext(this, dataStoreContext, dataStoreContext.storage, (content, localOpMetadata) => this.submitChannelOp(path, content, localOpMetadata), (address) => this.setChannelDirty(address), (srcHandle, outboundHandle) => this.addedGCOutboundReference(srcHandle, outboundHandle), path, tree.trees[path], this.sharedObjectRegistry, undefined /* extraBlobs */, this.dataStoreContext.getCreateChildSummarizerNodeFn(path, {
+                        type: CreateSummarizerNodeSource.FromSummary,
+                    }));
                 }
                 const deferred = new Deferred();
                 deferred.resolve(channelContext);
@@ -104,8 +102,6 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
             this.entryPoint = new FluidObjectHandle(promise, "", this.objectsRoutingContext);
         }
         this.attachListener();
-        // If exists on storage or loaded from a snapshot, it should already be bound.
-        this.bindState = existing ? BindState.Bound : BindState.NotBound;
         this._attachState = dataStoreContext.attachState;
         /**
          * If existing flag is false, this is a new data store and is not visible. The existing flag can be true in two
@@ -118,8 +114,10 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
          * when an attach op comes in. In both these cases, the data store is already globally visible.
          */
         if (existing) {
-            this.visibilityState = dataStoreContext.attachState === AttachState.Detached
-                ? VisibilityState.LocallyVisible : VisibilityState.GloballyVisible;
+            this.visibilityState =
+                dataStoreContext.attachState === AttachState.Detached
+                    ? VisibilityState.LocallyVisible
+                    : VisibilityState.GloballyVisible;
         }
         else {
             this.visibilityState = VisibilityState.NotVisible;
@@ -143,7 +141,9 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
     static load(context, sharedObjectRegistry, existing) {
         return new FluidDataStoreRuntime(context, sharedObjectRegistry, existing, async (dataStoreRuntime) => requestFluidObject(dataStoreRuntime, "/"));
     }
-    get IFluidRouter() { return this; }
+    get IFluidRouter() {
+        return this;
+    }
     get connected() {
         return this.dataStoreContext.connected;
     }
@@ -165,11 +165,21 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
     get routeContext() {
         return this.dataStoreContext.IFluidHandleContext;
     }
-    get IFluidHandleContext() { return this; }
-    get rootRoutingContext() { return this; }
-    get channelsRoutingContext() { return this; }
-    get objectsRoutingContext() { return this; }
-    get disposed() { return this._disposed; }
+    get IFluidHandleContext() {
+        return this;
+    }
+    get rootRoutingContext() {
+        return this;
+    }
+    get channelsRoutingContext() {
+        return this;
+    }
+    get objectsRoutingContext() {
+        return this;
+    }
+    get disposed() {
+        return this._disposed;
+    }
     get logger() {
         return this.mc.logger;
     }
@@ -183,9 +193,9 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
      */
     ensureNoDataModelChanges(callback) {
         // back-compat ADO:2309
-        return this.dataStoreContext.ensureNoDataModelChanges === undefined ?
-            callback() :
-            this.dataStoreContext.ensureNoDataModelChanges(callback);
+        return this.dataStoreContext.ensureNoDataModelChanges === undefined
+            ? callback()
+            : this.dataStoreContext.ensureNoDataModelChanges(callback);
     }
     dispose() {
         if (this._disposed) {
@@ -307,7 +317,7 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
             handle.attachGraph();
         });
         this.pendingHandlesToMakeVisible.clear();
-        this.bindToContext();
+        this.dataStoreContext.makeLocallyVisible();
     }
     /**
      * This function is called when a handle to this data store is added to a visible DDS.
@@ -323,12 +333,7 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
      * 2. Attaching the graph if the data store becomes attached.
      */
     bindToContext() {
-        if (this.bindState !== BindState.NotBound) {
-            return;
-        }
-        this.bindState = BindState.Binding;
-        this.dataStoreContext.bindToContext();
-        this.bindState = BindState.Bound;
+        this.makeVisibleAndAttachGraph();
     }
     bind(handle) {
         // If visible, attach the incoming handle's graph. Else, this will be done when we become visible.
@@ -370,14 +375,14 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
                         this.pendingAttach.delete(id);
                     }
                     else {
-                        assert(!this.contexts.has(id), 0x17d);
+                        assert(!this.contexts.has(id), 0x17d /* "Unexpected attach channel OP" */);
                         const flatBlobs = new Map();
                         const snapshotTree = buildSnapshotTree(attachMessage.snapshot.entries, flatBlobs);
                         const remoteChannelContext = new RemoteChannelContext(this, this.dataStoreContext, this.dataStoreContext.storage, (content, localContentMetadata) => this.submitChannelOp(id, content, localContentMetadata), (address) => this.setChannelDirty(address), (srcHandle, outboundHandle) => this.addedGCOutboundReference(srcHandle, outboundHandle), id, snapshotTree, this.sharedObjectRegistry, flatBlobs, this.dataStoreContext.getCreateChildSummarizerNodeFn(id, {
                             type: CreateSummarizerNodeSource.FromAttach,
                             sequenceNumber: message.sequenceNumber,
                             snapshot: attachMessage.snapshot,
-                        }), async () => this.getChannelBaseGCDetails(id), attachMessage.type);
+                        }), attachMessage.type);
                         this.contexts.set(id, remoteChannelContext);
                         if (this.contextsDeferred.has(id)) {
                             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -409,13 +414,13 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         return (
         // Added in createChannel
         // Removed when bindChannel is called
-        !this.notBoundedChannelContextSet.has(id)
+        !this.notBoundedChannelContextSet.has(id) &&
             // Added in bindChannel only if this is not attached yet
             // Removed when this is attached by calling attachGraph
-            && !this.localChannelContextQueue.has(id)
+            !this.localChannelContextQueue.has(id) &&
             // Added in attachChannel called by bindChannel
             // Removed when attach op is broadcast
-            && !this.pendingAttach.has(id));
+            !this.pendingAttach.has(id));
     }
     /**
      * Returns the outbound routes of this channel. Currently, all contexts in this channel are considered
@@ -465,7 +470,8 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
             // Get GC data only for attached contexts. Detached contexts are not connected in the GC reference
             // graph so any references they might have won't be connected as well.
             return this.isChannelAttached(contextId);
-        }).map(async ([contextId, context]) => {
+        })
+            .map(async ([contextId, context]) => {
             const contextGCData = await context.getGCData(fullGC);
             // Prefix the child's id to the ids of its GC nodes so they can be identified as belonging to the child.
             // This also gradually builds the id of each node to be a path from the root.
@@ -502,29 +508,6 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         var _a, _b;
         (_b = (_a = this.dataStoreContext).addedGCOutboundReference) === null || _b === void 0 ? void 0 : _b.call(_a, srcHandle, outboundHandle);
     }
-    /**
-     * Returns the base GC details for the channel with the given id. This is used to initialize its GC state.
-     * @param channelId - The id of the channel context that is asked for the initial GC details.
-     * @returns the requested channel's base GC details.
-     */
-    async getChannelBaseGCDetails(channelId) {
-        var _a;
-        let channelBaseGCDetails = (await this.channelsBaseGCDetails).get(channelId);
-        if (channelBaseGCDetails === undefined) {
-            channelBaseGCDetails = {};
-        }
-        else if (((_a = channelBaseGCDetails.gcData) === null || _a === void 0 ? void 0 : _a.gcNodes) !== undefined) {
-            // Note: if the child channel has an explicit handle route to its parent, it will be removed here and
-            // expected to be added back by the parent when getGCData is called.
-            removeRouteFromAllNodes(channelBaseGCDetails.gcData.gcNodes, this.absolutePath);
-        }
-        // Currently, channel context's are always considered used. So, it there are no used routes for it, we still
-        // need to mark it as used. Add self-route (empty string) to the channel context's used routes.
-        if (channelBaseGCDetails.usedRoutes === undefined || channelBaseGCDetails.usedRoutes.length === 0) {
-            channelBaseGCDetails.usedRoutes = [""];
-        }
-        return channelBaseGCDetails;
-    }
     /**
      * Returns a summary at the current sequence number.
      * @param fullTree - true to bypass optimizations and force a full summary tree
@@ -542,7 +525,8 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
             // If the object is registered - and we have received the sequenced op creating the object
             // (i.e. it has a base mapping) - then we go ahead and summarize
             return isAttached;
-        }).map(async ([contextId, context]) => {
+        })
+            .map(async ([contextId, context]) => {
             const contextSummary = await context.summarize(fullTree, trackState, telemetryContext);
             summaryBuilder.addWithStats(contextId, contextSummary);
         }));
@@ -647,15 +631,14 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
     reSubmit(type, content, localOpMetadata) {
         this.verifyNotClosed();
         switch (type) {
-            case DataStoreMessageType.ChannelOp:
-                {
-                    // For Operations, find the right channel and trigger resubmission on it.
-                    const envelope = content;
-                    const channelContext = this.contexts.get(envelope.address);
-                    assert(!!channelContext, 0x183 /* "There should be a channel context for the op" */);
-                    channelContext.reSubmit(envelope.contents, localOpMetadata);
-                    break;
-                }
+            case DataStoreMessageType.ChannelOp: {
+                // For Operations, find the right channel and trigger resubmission on it.
+                const envelope = content;
+                const channelContext = this.contexts.get(envelope.address);
+                assert(!!channelContext, 0x183 /* "There should be a channel context for the op" */);
+                channelContext.reSubmit(envelope.contents, localOpMetadata);
+                break;
+            }
             case DataStoreMessageType.Attach:
                 // For Attach messages, just submit them again.
                 this.submit(type, content, localOpMetadata);
@@ -672,15 +655,14 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
     rollback(type, content, localOpMetadata) {
         this.verifyNotClosed();
         switch (type) {
-            case DataStoreMessageType.ChannelOp:
-                {
-                    // For Operations, find the right channel and trigger resubmission on it.
-                    const envelope = content;
-                    const channelContext = this.contexts.get(envelope.address);
-                    assert(!!channelContext, 0x2ed /* "There should be a channel context for the op" */);
-                    channelContext.rollback(envelope.contents, localOpMetadata);
-                    break;
-                }
+            case DataStoreMessageType.ChannelOp: {
+                // For Operations, find the right channel and trigger resubmission on it.
+                const envelope = content;
+                const channelContext = this.contexts.get(envelope.address);
+                assert(!!channelContext, 0x2ed /* "There should be a channel context for the op" */);
+                channelContext.rollback(envelope.contents, localOpMetadata);
+                break;
+            }
             default:
                 throw new LoggingError(`Can't rollback ${type} message`);
         }