@fluidframework/datastore 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.1

package/dist/dataStoreRuntime.js

@@ -6,18 +6,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mixinSummaryHandler = exports.mixinRequestHandler = exports.FluidDataStoreRuntime = exports.DataStoreMessageType = void 0;
 const client_utils_1 = require("@fluid-internal/client-utils");
-const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
-const core_utils_1 = require("@fluidframework/core-utils");
 const container_definitions_1 = require("@fluidframework/container-definitions");
-const driver_utils_1 = require("@fluidframework/driver-utils");
+const internal_1 = require("@fluidframework/core-utils/internal");
+const internal_2 = require("@fluidframework/driver-utils/internal");
 const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
-const runtime_definitions_1 = require("@fluidframework/runtime-definitions");
-const runtime_utils_1 = require("@fluidframework/runtime-utils");
+const internal_3 = require("@fluidframework/runtime-definitions/internal");
+const internal_4 = require("@fluidframework/runtime-utils/internal");
+const internal_5 = require("@fluidframework/telemetry-utils/internal");
 const uuid_1 = require("uuid");
 const channelContext_js_1 = require("./channelContext.js");
+const fluidHandle_js_1 = require("./fluidHandle.js");
 const localChannelContext_js_1 = require("./localChannelContext.js");
+const packageVersion_js_1 = require("./packageVersion.js");
 const remoteChannelContext_js_1 = require("./remoteChannelContext.js");
-const fluidHandle_js_1 = require("./fluidHandle.js");
 /**
  * @alpha
  */
@@ -48,7 +49,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         return this._attachState;
     }
     get absolutePath() {
-        return (0, runtime_utils_1.generateHandleContextPath)(this.id, this.routeContext);
+        return (0, internal_4.generateHandleContextPath)(this.id, this.routeContext);
     }
     get routeContext() {
         return this.dataStoreContext.IFluidHandleContext;
@@ -106,18 +107,18 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         this._disposed = false;
         this.contexts = new Map();
         this.pendingAttach = new Set();
-        this.deferredAttached = new core_utils_1.Deferred();
+        this.deferredAttached = new internal_1.Deferred();
         this.localChannelContextQueue = new Map();
         this.notBoundedChannelContextSet = new Set();
         // A list of handles that are bound when the data store is not visible. We have to make them visible when the data
         // store becomes visible.
         this.pendingHandlesToMakeVisible = new Set();
-        (0, core_utils_1.assert)(!dataStoreContext.id.includes("/"), 0x30e /* Id cannot contain slashes. DataStoreContext should have validated this. */);
-        this.mc = (0, telemetry_utils_1.createChildMonitoringContext)({
+        (0, internal_1.assert)(!dataStoreContext.id.includes("/"), 0x30e /* Id cannot contain slashes. DataStoreContext should have validated this. */);
+        this.mc = (0, internal_5.createChildMonitoringContext)({
             logger: dataStoreContext.logger,
             namespace: "FluidDataStoreRuntime",
             properties: {
-                all: { dataStoreId: (0, uuid_1.v4)() },
+                all: { dataStoreId: (0, uuid_1.v4)(), dataStoreVersion: packageVersion_js_1.pkgVersion },
             },
         });
         this.id = dataStoreContext.id;
@@ -152,13 +153,13 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 }
                 else {
                     channelContext = new remoteChannelContext_js_1.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: runtime_definitions_1.CreateSummarizerNodeSource.FromSummary,
+                        type: internal_3.CreateSummarizerNodeSource.FromSummary,
                     }));
                 }
                 this.contexts.set(path, channelContext);
             });
         }
-        this.entryPoint = new fluidHandle_js_1.FluidObjectHandle(new core_utils_1.LazyPromise(async () => provideEntryPoint(this)), "", this.objectsRoutingContext);
+        this.entryPoint = new fluidHandle_js_1.FluidObjectHandle(new internal_1.LazyPromise(async () => provideEntryPoint(this)), "", this.objectsRoutingContext);
         this.attachListener();
         this._attachState = dataStoreContext.attachState;
         /**
@@ -174,11 +175,11 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         if (existing) {
             this.visibilityState =
                 dataStoreContext.attachState === container_definitions_1.AttachState.Detached
-                    ? runtime_definitions_1.VisibilityState.LocallyVisible
-                    : runtime_definitions_1.VisibilityState.GloballyVisible;
+                    ? internal_3.VisibilityState.LocallyVisible
+                    : internal_3.VisibilityState.GloballyVisible;
         }
         else {
-            this.visibilityState = runtime_definitions_1.VisibilityState.NotVisible;
+            this.visibilityState = internal_3.VisibilityState.NotVisible;
         }
         // If it's existing we know it has been attached.
         if (existing) {
@@ -201,7 +202,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
     }
     async request(request) {
         try {
-            const parser = runtime_utils_1.RequestParser.create(request);
+            const parser = internal_4.RequestParser.create(request);
             const id = parser.pathParts[0];
             if (id === "_channels" || id === "_custom") {
                 return await this.request(parser.createSubRequest(1));
@@ -215,21 +216,21 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 }
                 catch (error) {
                     this.mc.logger.sendErrorEvent({ eventName: "GetChannelFailedInRequest" }, error);
-                    return (0, runtime_utils_1.createResponseError)(500, `Failed to get Channel: ${error}`, request);
+                    return (0, internal_4.createResponseError)(500, `Failed to get Channel: ${error}`, request);
                 }
             }
             // Otherwise defer to an attached request handler
-            return (0, runtime_utils_1.create404Response)(request);
+            return (0, internal_4.create404Response)(request);
         }
         catch (error) {
-            return (0, runtime_utils_1.exceptionToResponse)(error);
+            return (0, internal_4.exceptionToResponse)(error);
         }
     }
     async getChannel(id) {
         this.verifyNotClosed();
         const context = this.contexts.get(id);
         if (context === undefined) {
-            throw new telemetry_utils_1.LoggingError("Channel does not exist");
+            throw new internal_5.LoggingError("Channel does not exist");
         }
         return context.getChannel();
     }
@@ -241,10 +242,10 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      */
     validateChannelId(id) {
         if (id.includes("/")) {
-            throw new telemetry_utils_1.UsageError(`Id cannot contain slashes: ${id}`);
+            throw new internal_5.UsageError(`Id cannot contain slashes: ${id}`);
         }
         if (id.startsWith("_")) {
-            throw new telemetry_utils_1.UsageError(`Id cannot start with underscore: ${id}`);
+            throw new internal_5.UsageError(`Id cannot start with underscore: ${id}`);
         }
     }
     /**
@@ -258,7 +259,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         const id = channel.id;
         this.validateChannelId(id);
         this.verifyNotClosed();
-        (0, core_utils_1.assert)(!this.contexts.has(id), 0x865 /* addChannel() with existing ID */);
+        (0, internal_1.assert)(!this.contexts.has(id), 0x865 /* addChannel() with existing ID */);
         const type = channel.attributes.type;
         const factory = this.sharedObjectRegistry.get(channel.attributes.type);
         if (factory === undefined) {
@@ -281,21 +282,21 @@ 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 !== runtime_definitions_1.VisibilityState.GloballyVisible) {
+            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, runtime_utils_1.encodeCompactIdToString)(2 * this.contexts.size, "_");
+                id = (0, internal_4.encodeCompactIdToString)(2 * this.contexts.size, "_");
             }
             else {
                 // 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, runtime_utils_1.encodeCompactIdToString)(2 * res + 1, "_") : res;
+                id = typeof res === "number" ? (0, internal_4.encodeCompactIdToString)(2 * res + 1, "_") : res;
             }
-            (0, core_utils_1.assert)(!id.includes("/"), 0x8fc /* slash */);
+            (0, internal_1.assert)(!id.includes("/"), 0x8fc /* slash */);
         }
         this.verifyNotClosed();
-        (0, core_utils_1.assert)(!this.contexts.has(id), 0x179 /* "createChannel() with existing ID" */);
-        (0, core_utils_1.assert)(type !== undefined, 0x209 /* "Factory Type should be defined" */);
+        (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" */);
         const factory = this.sharedObjectRegistry.get(type);
         if (factory === undefined) {
             throw new Error(`Channel Factory ${type} not registered`);
@@ -320,7 +321,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      * @param channel - channel to be registered.
      */
     bindChannel(channel) {
-        (0, core_utils_1.assert)(this.notBoundedChannelContextSet.has(channel.id), 0x17b /* "Channel to be bound should be in not bounded set" */);
+        (0, internal_1.assert)(this.notBoundedChannelContextSet.has(channel.id), 0x17b /* "Channel to be bound should be in not bounded set" */);
         this.notBoundedChannelContextSet.delete(channel.id);
         // If our data store is attached, then attach the channel.
         if (this.isAttached) {
@@ -352,10 +353,10 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      * globally visible.
      */
     makeVisibleAndAttachGraph() {
-        if (this.visibilityState !== runtime_definitions_1.VisibilityState.NotVisible) {
+        if (this.visibilityState !== internal_3.VisibilityState.NotVisible) {
             return;
         }
-        this.visibilityState = runtime_definitions_1.VisibilityState.LocallyVisible;
+        this.visibilityState = internal_3.VisibilityState.LocallyVisible;
         this.pendingHandlesToMakeVisible.forEach((handle) => {
             handle.attachGraph();
         });
@@ -370,7 +371,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
     }
     bind(handle) {
         // If visible, attach the incoming handle's graph. Else, this will be done when we become visible.
-        if (this.visibilityState !== runtime_definitions_1.VisibilityState.NotVisible) {
+        if (this.visibilityState !== internal_3.VisibilityState.NotVisible) {
             handle.attachGraph();
             return;
         }
@@ -381,7 +382,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         for (const [, object] of this.contexts) {
             object.setConnectionState(connected, clientId);
         }
-        (0, telemetry_utils_1.raiseConnectedEvent)(this.logger, this, connected, clientId);
+        (0, internal_5.raiseConnectedEvent)(this.logger, this, connected, clientId);
     }
     getQuorum() {
         return this.quorum;
@@ -395,7 +396,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
     }
     createRemoteChannelContext(attachMessage, summarizerNodeParams) {
         const flatBlobs = new Map();
-        const snapshotTree = (0, driver_utils_1.buildSnapshotTree)(attachMessage.snapshot.entries, flatBlobs);
+        const snapshotTree = (0, internal_2.buildSnapshotTree)(attachMessage.snapshot.entries, flatBlobs);
         return new remoteChannelContext_js_1.RemoteChannelContext(this, this.dataStoreContext, this.dataStoreContext.storage, (content, localContentMetadata) => this.submitChannelOp(attachMessage.id, content, localContentMetadata), (address) => this.setChannelDirty(address), (srcHandle, outboundHandle) => this.addedGCOutboundReference(srcHandle, outboundHandle), attachMessage.id, snapshotTree, this.sharedObjectRegistry, flatBlobs, this.dataStoreContext.getCreateChildSummarizerNodeFn(attachMessage.id, summarizerNodeParams), attachMessage.type);
     }
     process(message, local, localOpMetadata) {
@@ -407,7 +408,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                     const attachMessage = message.contents;
                     const id = attachMessage.id;
                     // We need to process the GC Data for both local and remote attach messages
-                    (0, runtime_utils_1.processAttachMessageGCData)(attachMessage.snapshot, (nodeId, toPath) => {
+                    (0, internal_4.processAttachMessageGCData)(attachMessage.snapshot, (nodeId, toPath) => {
                         // Note: nodeId will be "/" unless and until we support sub-DDS GC Nodes
                         const fromPath = `/${this.id}/${id}${nodeId === "/" ? "" : nodeId}`;
                         this.dataStoreContext.addedGCOutboundRoute?.(fromPath, toPath);
@@ -415,12 +416,12 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                     // If a non-local operation then go and create the object
                     // Otherwise mark it as officially attached.
                     if (local) {
-                        (0, core_utils_1.assert)(this.pendingAttach.delete(id), 0x17c /* "Unexpected attach (local) channel OP" */);
+                        (0, internal_1.assert)(this.pendingAttach.delete(id), 0x17c /* "Unexpected attach (local) channel OP" */);
                     }
                     else {
-                        (0, core_utils_1.assert)(!this.contexts.has(id), 0x17d /* "Unexpected attach channel OP" */);
+                        (0, internal_1.assert)(!this.contexts.has(id), 0x17d /* "Unexpected attach channel OP" */);
                         const summarizerNodeParams = {
-                            type: runtime_definitions_1.CreateSummarizerNodeSource.FromAttach,
+                            type: internal_3.CreateSummarizerNodeSource.FromAttach,
                             sequenceNumber: message.sequenceNumber,
                             snapshot: attachMessage.snapshot,
                         };
@@ -437,7 +438,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
             this.emit("op", message);
         }
         catch (error) {
-            throw telemetry_utils_1.DataProcessingError.wrapIfUnrecognized(error, "fluidDataStoreRuntimeFailedToProcessMessage", message);
+            throw internal_5.DataProcessingError.wrapIfUnrecognized(error, "fluidDataStoreRuntimeFailedToProcessMessage", message);
         }
     }
     processSignal(message, local) {
@@ -496,7 +497,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      * @param fullGC - true to bypass optimizations and force full generation of GC data.
      */
     async getGCData(fullGC = false) {
-        const builder = new runtime_utils_1.GCDataBuilder();
+        const builder = new internal_4.GCDataBuilder();
         // Iterate over each channel context and get their GC data.
         await Promise.all(Array.from(this.contexts)
             .filter(([contextId, _]) => {
@@ -520,10 +521,10 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      */
     updateUsedRoutes(usedRoutes) {
         // Get a map of channel ids to routes used in it.
-        const usedContextRoutes = (0, runtime_utils_1.unpackChildNodesUsedRoutes)(usedRoutes);
+        const usedContextRoutes = (0, internal_4.unpackChildNodesUsedRoutes)(usedRoutes);
         // Verify that the used routes are correct.
         for (const [id] of usedContextRoutes) {
-            (0, core_utils_1.assert)(this.contexts.has(id), 0x17e /* "Used route does not belong to any known context" */);
+            (0, internal_1.assert)(this.contexts.has(id), 0x17e /* "Used route does not belong to any known context" */);
         }
         // Update the used routes in each context. Used routes is empty for unused context.
         for (const [contextId, context] of this.contexts) {
@@ -550,13 +551,13 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      * @param telemetryContext - summary data passed through the layers for telemetry purposes
      */
     async summarize(fullTree = false, trackState = true, telemetryContext) {
-        const summaryBuilder = new runtime_utils_1.SummaryTreeBuilder();
+        const summaryBuilder = new internal_4.SummaryTreeBuilder();
         // Iterate over each data store and ask it to summarize
         await Promise.all(Array.from(this.contexts)
             .filter(([contextId, _]) => {
             const isAttached = this.isChannelAttached(contextId);
             // We are not expecting local dds! Summary may not capture local state.
-            (0, core_utils_1.assert)(isAttached, 0x17f /* "Not expecting detached channels during summarize" */);
+            (0, internal_1.assert)(isAttached, 0x17f /* "Not expecting detached channels during summarize" */);
             // 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;
@@ -568,19 +569,19 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         return summaryBuilder.getSummaryTree();
     }
     getAttachSummary(telemetryContext) {
-        const summaryBuilder = new runtime_utils_1.SummaryTreeBuilder();
+        const summaryBuilder = new internal_4.SummaryTreeBuilder();
         this.visitLocalBoundContextsDuringAttach((contextId, context) => {
             let summaryTree;
             if (context.isLoaded) {
                 const contextSummary = context.getAttachSummary(telemetryContext);
-                (0, core_utils_1.assert)(contextSummary.summary.type === protocol_definitions_1.SummaryType.Tree, 0x180 /* "getAttachSummary should always return a tree" */);
+                (0, internal_1.assert)(contextSummary.summary.type === protocol_definitions_1.SummaryType.Tree, 0x180 /* "getAttachSummary should always return a tree" */);
                 summaryTree = { stats: contextSummary.stats, summary: contextSummary.summary };
             }
             else {
                 // If this channel is not yet loaded, then there should be no changes in the snapshot from which
                 // it was created as it is detached container. So just use the previous snapshot.
-                (0, core_utils_1.assert)(!!this.dataStoreContext.baseSnapshot, 0x181 /* "BaseSnapshot should be there as detached container loaded from snapshot" */);
-                summaryTree = (0, runtime_utils_1.convertSnapshotTreeToSummaryTree)(this.dataStoreContext.baseSnapshot.trees[contextId]);
+                (0, internal_1.assert)(!!this.dataStoreContext.baseSnapshot, 0x181 /* "BaseSnapshot should be there as detached container loaded from snapshot" */);
+                summaryTree = (0, internal_4.convertSnapshotTreeToSummaryTree)(this.dataStoreContext.baseSnapshot.trees[contextId]);
             }
             summaryBuilder.addWithStats(contextId, summaryTree);
         });
@@ -590,7 +591,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
      * Get the GC Data for the initial state being attached so remote clients can learn of this DataStore's outbound routes
      */
     getAttachGCData(telemetryContext) {
-        const gcDataBuilder = new runtime_utils_1.GCDataBuilder();
+        const gcDataBuilder = new internal_4.GCDataBuilder();
         this.visitLocalBoundContextsDuringAttach((contextId, context) => {
             if (context.isLoaded) {
                 const contextGCData = context.getAttachGCData(telemetryContext);
@@ -627,7 +628,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         // );
         for (const [contextId, context] of this.contexts) {
             if (!(context instanceof localChannelContext_js_1.LocalChannelContextBase)) {
-                throw new telemetry_utils_1.LoggingError("Should only be called with local channel handles");
+                throw new internal_5.LoggingError("Should only be called with local channel handles");
             }
             if (!this.notBoundedChannelContextSet.has(contextId)) {
                 visitor(contextId, context);
@@ -640,7 +641,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
     /**
      * Submits the signal to be sent to other clients.
      * @param type - Type of the signal.
-     * @param content - Content of the signal.
+     * @param content - Content of the signal. Should be a JSON serializable object or primitive.
      * @param targetClientId - When specified, the signal is only sent to the provided client id.
      */
     submitSignal(type, content, targetClientId) {
@@ -664,14 +665,14 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
             return;
         }
         channel.handle.attachGraph();
-        (0, core_utils_1.assert)(this.isAttached, 0x182 /* "Data store should be attached to attach the channel." */);
-        (0, core_utils_1.assert)(this.visibilityState === runtime_definitions_1.VisibilityState.GloballyVisible, 0x2d0 /* "Data store should be globally visible to attach channels." */);
+        (0, internal_1.assert)(this.isAttached, 0x182 /* "Data store should be attached to attach the channel." */);
+        (0, internal_1.assert)(this.visibilityState === internal_3.VisibilityState.GloballyVisible, 0x2d0 /* "Data store should be globally visible to attach channels." */);
         const summarizeResult = (0, channelContext_js_1.summarizeChannel)(channel, true /* fullTree */, false /* trackState */);
         // We need to include the channel's GC Data so remote clients can learn of this channel's outbound routes
         const gcData = channel.getGCData(/* fullGC: */ true);
-        (0, runtime_utils_1.addBlobToSummary)(summarizeResult, runtime_definitions_1.gcDataBlobKey, JSON.stringify(gcData));
+        (0, internal_4.addBlobToSummary)(summarizeResult, internal_3.gcDataBlobKey, JSON.stringify(gcData));
         // Attach message needs the summary in ITree format. Convert the ISummaryTree into an ITree.
-        const snapshot = (0, runtime_utils_1.convertSummaryTreeToITree)(summarizeResult.summary);
+        const snapshot = (0, internal_4.convertSummaryTreeToITree)(summarizeResult.summary);
         const message = {
             id: channel.id,
             snapshot,
@@ -704,7 +705,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 // For Operations, find the right channel and trigger resubmission on it.
                 const envelope = content;
                 const channelContext = this.contexts.get(envelope.address);
-                (0, core_utils_1.assert)(!!channelContext, 0x183 /* "There should be a channel context for the op" */);
+                (0, internal_1.assert)(!!channelContext, 0x183 /* "There should be a channel context for the op" */);
                 channelContext.reSubmit(envelope.contents, localOpMetadata);
                 break;
             }
@@ -713,7 +714,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 this.submit(type, content, localOpMetadata);
                 break;
             default:
-                (0, core_utils_1.unreachableCase)(type);
+                (0, internal_1.unreachableCase)(type);
         }
     }
     /**
@@ -728,12 +729,12 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
                 // For Operations, find the right channel and trigger resubmission on it.
                 const envelope = content;
                 const channelContext = this.contexts.get(envelope.address);
-                (0, core_utils_1.assert)(!!channelContext, 0x2ed /* "There should be a channel context for the op" */);
+                (0, internal_1.assert)(!!channelContext, 0x2ed /* "There should be a channel context for the op" */);
                 channelContext.rollback(envelope.contents, localOpMetadata);
                 break;
             }
             default:
-                throw new telemetry_utils_1.LoggingError(`Can't rollback ${type} message`);
+                throw new internal_5.LoggingError(`Can't rollback ${type} message`);
         }
     }
     async applyStashedOp(content) {
@@ -742,7 +743,7 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
             case DataStoreMessageType.Attach: {
                 const attachMessage = content.content;
                 const flatBlobs = new Map();
-                const snapshotTree = (0, driver_utils_1.buildSnapshotTree)(attachMessage.snapshot.entries, flatBlobs);
+                const snapshotTree = (0, internal_2.buildSnapshotTree)(attachMessage.snapshot.entries, flatBlobs);
                 const channelContext = this.createRehydratedLocalChannelContext(attachMessage.id, snapshotTree, flatBlobs);
                 await channelContext.getChannel();
                 this.contexts.set(attachMessage.id, channelContext);
@@ -758,12 +759,12 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
             case DataStoreMessageType.ChannelOp: {
                 const envelope = content.content;
                 const channelContext = this.contexts.get(envelope.address);
-                (0, core_utils_1.assert)(!!channelContext, 0x184 /* "There should be a channel context for the op" */);
+                (0, internal_1.assert)(!!channelContext, 0x184 /* "There should be a channel context for the op" */);
                 await channelContext.getChannel();
                 return channelContext.applyStashedOp(envelope.contents);
             }
             default:
-                (0, core_utils_1.unreachableCase)(type);
+                (0, internal_1.unreachableCase)(type);
         }
     }
     setChannelDirty(address) {
@@ -778,44 +779,26 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
             contents: envelope.contents,
         };
         const channelContext = this.contexts.get(envelope.address);
-        (0, core_utils_1.assert)(!!channelContext, 0x185 /* "Channel not found" */);
+        (0, internal_1.assert)(!!channelContext, 0x185 /* "Channel not found" */);
         channelContext.processOp(transformed, local, localOpMetadata);
         return channelContext;
     }
     attachListener() {
         this.setMaxListeners(Number.MAX_SAFE_INTEGER);
-        this.dataStoreContext.once("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
-             * store can move to "attaching" state in 2 scenarios:
-             * 1) Before attachGraph() is called - When a data store is created and bound in an attached container.
-             * 2) After attachGraph() is called - When a detached container is attached.
-             *
-             * The basic idea is that all local object should become locally visible before they are globally visible.
-             */
-            this.attachGraph();
-            this._attachState = container_definitions_1.AttachState.Attaching;
-            (0, core_utils_1.assert)(this.visibilityState === runtime_definitions_1.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 = runtime_definitions_1.VisibilityState.GloballyVisible;
-            this.localChannelContextQueue.forEach((channel) => {
-                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");
+        // back-compat, to be removed in the future.
+        // Added in "2.0.0-rc.2.0.0" timeframe.
+        this.dataStoreContext.once?.("attaching", () => {
+            this.setAttachState(container_definitions_1.AttachState.Attaching);
         });
-        this.dataStoreContext.once("attached", () => {
-            (0, core_utils_1.assert)(this.visibilityState === runtime_definitions_1.VisibilityState.GloballyVisible, 0x2d2 /* "Data store should be globally visible when its attached." */);
-            this._attachState = container_definitions_1.AttachState.Attached;
-            this.emit("attached");
+        // back-compat, to be removed in the future.
+        // Added in "2.0.0-rc.2.0.0" timeframe.
+        this.dataStoreContext.once?.("attached", () => {
+            this.setAttachState(container_definitions_1.AttachState.Attached);
         });
     }
     verifyNotClosed() {
         if (this._disposed) {
-            throw new telemetry_utils_1.LoggingError("Runtime is closed");
+            throw new internal_5.LoggingError("Runtime is closed");
         }
     }
     /**
@@ -832,16 +815,50 @@ class FluidDataStoreRuntime extends client_utils_1.TypedEventEmitter {
         // in the summarizer and the data will help us plan this.
         this.mc.logger.sendTelemetryEvent({
             eventName,
-            ...(0, telemetry_utils_1.tagCodeArtifacts)({
+            ...(0, internal_5.tagCodeArtifacts)({
                 channelType,
                 channelId,
                 fluidDataStoreId: this.id,
                 fluidDataStorePackagePath: this.dataStoreContext.packagePath.join("/"),
             }),
-            stack: (0, telemetry_utils_1.generateStack)(),
+            stack: (0, internal_5.generateStack)(),
         });
         this.localChangesTelemetryCount--;
     }
+    setAttachState(attachState) {
+        switch (attachState) {
+            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
+                 * store can move to "attaching" state in 2 scenarios:
+                 * 1) Before attachGraph() is called - When a data store is created and bound in an attached container.
+                 * 2) After attachGraph() is called - When a detached container is attached.
+                 *
+                 * The basic idea is that all local object should become locally visible before they are globally visible.
+                 */
+                this.attachGraph();
+                this._attachState = container_definitions_1.AttachState.Attaching;
+                (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) => {
+                    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:
+                (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:
+                (0, internal_1.unreachableCase)(attachState, "unreached");
+        }
+    }
 }
 exports.FluidDataStoreRuntime = FluidDataStoreRuntime;
 /**
@@ -849,7 +866,7 @@ exports.FluidDataStoreRuntime = FluidDataStoreRuntime;
  * Request handler is only called when data store can't resolve request, i.e. for custom requests.
  * @param Base - base class, inherits from FluidDataStoreRuntime
  * @param requestHandler - request handler to mix in
- * @internal
+ * @alpha
  */
 const mixinRequestHandler = (requestHandler, Base = FluidDataStoreRuntime) => class RuntimeWithRequestHandler extends Base {
     async request(request) {
@@ -872,7 +889,7 @@ const mixinSummaryHandler = (handler, Base = FluidDataStoreRuntime) => class Run
     addBlob(summary, path, content) {
         const firstName = path.shift();
         if (firstName === undefined) {
-            throw new telemetry_utils_1.LoggingError("Path can't be empty");
+            throw new internal_5.LoggingError("Path can't be empty");
         }
         let blob = {
             type: protocol_definitions_1.SummaryType.Blob,
@@ -899,7 +916,7 @@ const mixinSummaryHandler = (handler, Base = FluidDataStoreRuntime) => class Run
         }
         catch (e) {
             // Any error coming from app-provided handler should be marked as DataProcessingError
-            throw telemetry_utils_1.DataProcessingError.wrapIfUnrecognized(e, "mixinSummaryHandler");
+            throw internal_5.DataProcessingError.wrapIfUnrecognized(e, "mixinSummaryHandler");
         }
         return summary;
     }