@fluidframework/container-runtime 2.0.0-internal.1.1.2 → 2.0.0-internal.1.2.0

package/src/dataStoreContext.ts

@@ -37,6 +37,7 @@ import {
     IContainerRuntime,
 } from "@fluidframework/container-runtime-definitions";
 import {
+    BindState,
     channelsTreeName,
     CreateChildSummarizerNodeFn,
     CreateChildSummarizerNodeParam,
@@ -224,9 +225,8 @@ export abstract class FluidDataStoreContext extends TypedEventEmitter<IFluidData
     protected registry: IFluidDataStoreRegistry | undefined;
 
     protected detachedRuntimeCreation = false;
-    // back-compat (for tests) - can be removed in 2.0.0-alpha.2.0.0, or earlier if compat tests drop n/n-2 coverage
-    // @ts-expect-error - This shouldn't be referenced in the current version, but needs to be here for back-compat
-    private readonly bindToContext: () => void;
+    /** @deprecated - To be replaced by calling makeLocallyVisible directly  */
+    public readonly bindToContext: () => void;
     protected channel: IFluidDataStoreChannel | undefined;
     private loaded = false;
     protected pending: ISequencedDocumentMessage[] | undefined = [];
@@ -253,6 +253,7 @@ export abstract class FluidDataStoreContext extends TypedEventEmitter<IFluidData
     constructor(
         props: IFluidDataStoreContextProps,
         private readonly existing: boolean,
+        private bindState: BindState,  // Used to assert for state tracking purposes
         public readonly isLocalDataStore: boolean,
         private readonly makeLocallyVisibleFn: () => void,
     ) {
@@ -273,8 +274,11 @@ export abstract class FluidDataStoreContext extends TypedEventEmitter<IFluidData
             this.containerRuntime.attachState : AttachState.Detached;
 
         this.bindToContext = () => {
+            assert(this.bindState === BindState.NotBound, 0x13b /* "datastore context is already in bound state" */);
+            this.bindState = BindState.Binding;
             assert(this.channel !== undefined, 0x13c /* "undefined channel on datastore context" */);
             this.makeLocallyVisible();
+            this.bindState = BindState.Bound;
         };
 
         const thisSummarizeInternal =
@@ -515,12 +519,18 @@ export abstract class FluidDataStoreContext extends TypedEventEmitter<IFluidData
 
     /**
      * After GC has run, called to notify the data store of routes used in it. These are used for the following:
+     *
      * 1. To identify if this data store is being referenced in the document or not.
+     *
      * 2. To determine if it needs to re-summarize in case used routes changed since last summary.
+     *
      * 3. These are added to the summary generated by the data store.
-     * 4. To notify child contexts of their used routes. This is done immediately if the data store is loaded. Else,
-     *    it is done when realizing the data store.
+     *
+     * 4. To notify child contexts of their used routes. This is done immediately if the data store is loaded.
+     * Else, it is done when realizing the data store.
+     *
      * 5. To update the timestamp when this data store or any children are marked as unreferenced.
+     *
      * @param usedRoutes - The routes that are used in this data store.
      * @param gcTimestamp - The time when GC was run that generated these used routes. If any node becomes unreferenced
      * as part of this GC run, this should be used to update the time when it happens.
@@ -700,7 +710,7 @@ export abstract class FluidDataStoreContext extends TypedEventEmitter<IFluidData
     public abstract getInitialSnapshotDetails(): Promise<ISnapshotDetails>;
 
     /**
-     * @deprecated - Sets the datastore as root, for aliasing purposes: #7948
+     * @deprecated Sets the datastore as root, for aliasing purposes: #7948
      * This method should not be used outside of the aliasing context.
      * It will be removed, as the source of truth for this flag will be the aliasing blob.
      */
@@ -709,7 +719,7 @@ export abstract class FluidDataStoreContext extends TypedEventEmitter<IFluidData
     }
 
     /**
-     * @deprecated - Renamed to getBaseGCDetails().
+     * @deprecated Renamed to `{@link FluidDataStoreContext.getBaseGCDetails}()`.
      */
     public abstract getInitialGCSummaryDetails(): Promise<IGarbageCollectionSummaryDetails>;
 
@@ -776,6 +786,7 @@ export class RemoteFluidDataStoreContext extends FluidDataStoreContext {
         super(
             props,
             true /* existing */,
+            BindState.Bound,
             false /* isLocalDataStore */,
             () => {
                 throw new Error("Already attached");
@@ -814,11 +825,9 @@ export class RemoteFluidDataStoreContext extends FluidDataStoreContext {
             // For snapshotFormatVersion = "0.1" (1) or above, pkg is jsonified, otherwise it is just a string.
             const formatVersion = getAttributesFormatVersion(attributes);
             if (formatVersion < 1) {
-                if (attributes.pkg.startsWith("[\"") && attributes.pkg.endsWith("\"]")) {
-                    pkgFromSnapshot = JSON.parse(attributes.pkg) as string[];
-                } else {
-                    pkgFromSnapshot = [attributes.pkg];
-                }
+                pkgFromSnapshot = attributes.pkg.startsWith("[\"") && attributes.pkg.endsWith("\"]")
+                    ? JSON.parse(attributes.pkg) as string[]
+                    : [attributes.pkg];
             } else {
                 pkgFromSnapshot = JSON.parse(attributes.pkg) as string[];
             }
@@ -851,7 +860,7 @@ export class RemoteFluidDataStoreContext extends FluidDataStoreContext {
     }
 
     /**
-     * @deprecated - Renamed to getBaseGCDetails.
+     * @deprecated Renamed to {@link RemoteFluidDataStoreContext.getBaseGCDetails}.
      */
     public async getInitialGCSummaryDetails(): Promise<IGarbageCollectionSummaryDetails> {
         return this.getBaseGCDetails();
@@ -880,6 +889,7 @@ export class LocalFluidDataStoreContextBase extends FluidDataStoreContext {
         super(
             props,
             props.snapshotTree !== undefined ? true : false /* existing */,
+            props.snapshotTree ? BindState.Bound : BindState.NotBound,
             true /* isLocalDataStore */,
             props.makeLocallyVisibleFn,
         );
@@ -965,7 +975,7 @@ export class LocalFluidDataStoreContextBase extends FluidDataStoreContext {
     }
 
     /**
-     * @deprecated - Renamed to getBaseGCDetails.
+     * @deprecated Renamed to {@link LocalFluidDataStoreContextBase.getBaseGCDetails}.
      */
     public async getInitialGCSummaryDetails(): Promise<IGarbageCollectionSummaryDetails> {
         // Local data store does not have initial summary.
@@ -1008,7 +1018,10 @@ export class LocalDetachedFluidDataStoreContext
         registry: IProvideFluidDataStoreFactory,
         dataStoreChannel: IFluidDataStoreChannel) {
         assert(this.detachedRuntimeCreation, 0x154 /* "runtime creation is already attached" */);
+        this.detachedRuntimeCreation = false;
+
         assert(this.channelDeferred === undefined, 0x155 /* "channel deferral is already set" */);
+        this.channelDeferred = new Deferred<IFluidDataStoreChannel>();
 
         const factory = registry.IFluidDataStoreFactory;
 
@@ -1018,9 +1031,6 @@ export class LocalDetachedFluidDataStoreContext
         assert(this.registry === undefined, 0x157 /* "datastore registry already attached" */);
         this.registry = entry.registry;
 
-        this.detachedRuntimeCreation = false;
-        this.channelDeferred = new Deferred<IFluidDataStoreChannel>();
-
         super.bindRuntime(dataStoreChannel);
 
         if (await this.isRoot()) {

package/src/dataStores.ts

@@ -469,12 +469,7 @@ export class DataStores implements IDisposable {
     }
 
     public setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void {
-        let eventName: "attaching" | "attached";
-        if (attachState === AttachState.Attaching) {
-            eventName = "attaching";
-        } else {
-            eventName = "attached";
-        }
+        const eventName = attachState === AttachState.Attaching ? "attaching" : "attached";
         for (const [, context] of this.contexts) {
             // Fire only for bounded stores.
             if (!this.contexts.isNotBound(context.id)) {
@@ -566,11 +561,15 @@ export class DataStores implements IDisposable {
 
     /**
      * Generates data used for garbage collection. It does the following:
+     *
      * 1. Calls into each child data store context to get its GC data.
+     *
      * 2. Prefixes the child context's id to the GC nodes in the child's GC data. This makes sure that the node can be
-     *    identified as belonging to the child.
+     * identified as belonging to the child.
+     *
      * 3. Adds a GC node for this channel to the nodes received from the children. All these nodes together represent
-     *    the GC data of this channel.
+     * the GC data of this channel.
+     *
      * @param fullGC - true to bypass optimizations and force full generation of GC data.
      */
     public async getGCData(fullGC: boolean = false): Promise<IGarbageCollectionData> {

package/src/deltaScheduler.ts

@@ -18,12 +18,14 @@ import {
  * DeltaScheduler is responsible for the scheduling of inbound delta queue in cases where there
  * is more than one op a particular run of the queue. It does not schedule if there is just one
  * op or just one batch in the run. It does the following two things:
+ *
  * 1. If the ops have been processed for more than a specific amount of time, it pauses the queue
- *    and calls setTimeout to schedule a resume of the queue. This ensures that we don't block
- *    the JS thread for a long time processing ops synchronously (for example, when catching up
- *    ops right after boot or catching up ops / delayed realizing data stores by summarizer).
+ * and calls setTimeout to schedule a resume of the queue. This ensures that we don't block
+ * the JS thread for a long time processing ops synchronously (for example, when catching up
+ * ops right after boot or catching up ops / delayed realizing data stores by summarizer).
+ *
  * 2. If we scheduled a particular run of the queue, it logs telemetry for the number of ops
- *    processed, the time and number of turns it took to process the ops.
+ * processed, the time and number of turns it took to process the ops.
  */
 export class DeltaScheduler {
     private readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;