@fluidframework/datastore 2.0.0-internal.3.0.5 → 2.0.0-internal.3.1.1

package/lib/dataStoreRuntime.js

@@ -5,15 +5,15 @@
 import { AttachState, } from "@fluidframework/container-definitions";
 import { DataProcessingError, UsageError } from "@fluidframework/container-utils";
 import { assert, Deferred, LazyPromise, TypedEventEmitter, unreachableCase, } from "@fluidframework/common-utils";
-import { ChildLogger, generateStack, LoggingError, loggerToMonitoringContext, raiseConnectedEvent, TelemetryDataTag, } from "@fluidframework/telemetry-utils";
+import { ChildLogger, LoggingError, raiseConnectedEvent } 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 { convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, generateHandleContextPath, RequestParser, SummaryTreeBuilder, create404Response, createResponseError, exceptionToResponse, requestFluidObject, packagePathToTelemetryProperty, } from "@fluidframework/runtime-utils";
+import { convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, generateHandleContextPath, RequestParser, SummaryTreeBuilder, create404Response, createResponseError, exceptionToResponse, requestFluidObject, } from "@fluidframework/runtime-utils";
 import { GCDataBuilder, removeRouteFromAllNodes, unpackChildNodesGCDetails, 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,18 +27,17 @@ 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();
         this.dataStoreContext = dataStoreContext;
         this.sharedObjectRegistry = sharedObjectRegistry;
@@ -53,9 +52,9 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         // store becomes visible.
         this.pendingHandlesToMakeVisible = new Set();
         assert(!dataStoreContext.id.includes("/"), 0x30e /* Id cannot contain slashes. DataStoreContext should have validated this. */);
-        this.mc = loggerToMonitoringContext(ChildLogger.create(dataStoreContext.logger, "FluidDataStoreRuntime", {
+        this.logger = ChildLogger.create(dataStoreContext.logger, "FluidDataStoreRuntime", {
             all: { dataStoreId: uuid() },
-        }));
+        });
         this.id = dataStoreContext.id;
         this.options = dataStoreContext.options;
         this.deltaManager = dataStoreContext.deltaManager;
@@ -91,7 +90,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,
+                    }), async () => this.getChannelBaseGCDetails(path));
                 }
                 const deferred = new Deferred();
                 deferred.resolve(channelContext);
@@ -118,8 +119,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;
@@ -128,9 +131,6 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         if (existing) {
             this.deferredAttached.resolve();
         }
-        // By default, a data store can log maximum 10 local changes telemetry in summarizer.
-        this.localChangesTelemetryCount =
-            (_a = this.mc.config.getNumber("Fluid.Telemetry.LocalChangesTelemetryCount")) !== null && _a !== void 0 ? _a : 10;
     }
     /**
      * @deprecated - Instantiate the class using its constructor instead.
@@ -143,7 +143,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,13 +167,20 @@ 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 logger() {
-        return this.mc.logger;
+    get IFluidHandleContext() {
+        return this;
+    }
+    get rootRoutingContext() {
+        return this;
+    }
+    get channelsRoutingContext() {
+        return this;
+    }
+    get objectsRoutingContext() {
+        return this;
+    }
+    get disposed() {
+        return this._disposed;
     }
     /**
      * Invokes the given callback and expects that no ops are submitted
@@ -183,9 +192,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) {
@@ -214,7 +223,7 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
                     return { mimeType: "fluid/object", status: 200, value: channel };
                 }
                 catch (error) {
-                    this.mc.logger.sendErrorEvent({ eventName: "GetChannelFailedInRequest" }, error);
+                    this.logger.sendErrorEvent({ eventName: "GetChannelFailedInRequest" }, error);
                     return createResponseError(500, `Failed to get Channel: ${error}`, request);
                 }
             }
@@ -256,8 +265,6 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
             deferred.resolve(context);
             this.contextsDeferred.set(id, deferred);
         }
-        // Channels (DDS) should not be created in summarizer client.
-        this.identifyLocalChangeInSummarizer("DDSCreatedInSummarizer", id, type);
         assert(!!context.channel, 0x17a /* "Channel should be loaded when created!!" */);
         return context.channel;
     }
@@ -370,7 +377,9 @@ 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,
+                        is in pendingAttach set: ${this.pendingAttach.has(id)},
+                        is local channel contexts: ${this.contexts.get(id) instanceof LocalChannelContextBase}` */);
                         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, {
@@ -409,13 +418,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 +474,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.
@@ -520,7 +530,8 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         }
         // 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) {
+        if (channelBaseGCDetails.usedRoutes === undefined ||
+            channelBaseGCDetails.usedRoutes.length === 0) {
             channelBaseGCDetails.usedRoutes = [""];
         }
         return channelBaseGCDetails;
@@ -542,7 +553,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 +659,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 +683,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`);
         }
@@ -741,34 +751,6 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
             throw new LoggingError("Runtime is closed");
         }
     }
-    /**
-     * Summarizer client should not have local changes. These changes can become part of the summary and can break
-     * eventual consistency. For example, the next summary (say at ref seq# 100) may contain these changes whereas
-     * other clients that are up-to-date till seq# 100 may not have them yet.
-     */
-    identifyLocalChangeInSummarizer(eventName, channelId, channelType) {
-        if (this.clientDetails.type !== "summarizer" || this.localChangesTelemetryCount <= 0) {
-            return;
-        }
-        // Log a telemetry if there are local changes in the summarizer. This will give us data on how often
-        // this is happening and which data stores do this. The eventual goal is to disallow local changes
-        // in the summarizer and the data will help us plan this.
-        this.mc.logger.sendTelemetryEvent({
-            eventName,
-            channelType,
-            channelId: {
-                value: channelId,
-                tag: TelemetryDataTag.CodeArtifact,
-            },
-            fluidDataStoreId: {
-                value: this.id,
-                tag: TelemetryDataTag.CodeArtifact,
-            },
-            fluidDataStorePackagePath: packagePathToTelemetryProperty(this.dataStoreContext.packagePath),
-            stack: generateStack(),
-        });
-        this.localChangesTelemetryCount--;
-    }
 }
 /**
  * Mixin class that adds request handler to FluidDataStoreRuntime