@fluidframework/datastore 2.0.0-internal.1.1.3 → 2.0.0-internal.1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/datastore",
-  "version": "2.0.0-internal.1.1.3",
+  "version": "2.0.0-internal.1.2.0",
   "description": "Fluid data store implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -63,28 +63,28 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-definitions": "^2.0.0-internal.1.1.3",
-    "@fluidframework/container-utils": "^2.0.0-internal.1.1.3",
-    "@fluidframework/core-interfaces": "^2.0.0-internal.1.1.3",
-    "@fluidframework/datastore-definitions": "^2.0.0-internal.1.1.3",
-    "@fluidframework/driver-definitions": "^2.0.0-internal.1.1.3",
-    "@fluidframework/driver-utils": "^2.0.0-internal.1.1.3",
-    "@fluidframework/garbage-collector": "^2.0.0-internal.1.1.3",
-    "@fluidframework/protocol-base": "^0.1037.1000",
+    "@fluidframework/container-definitions": "^2.0.0-internal.1.2.0",
+    "@fluidframework/container-utils": "^2.0.0-internal.1.2.0",
+    "@fluidframework/core-interfaces": "^2.0.0-internal.1.2.0",
+    "@fluidframework/datastore-definitions": "^2.0.0-internal.1.2.0",
+    "@fluidframework/driver-definitions": "^2.0.0-internal.1.2.0",
+    "@fluidframework/driver-utils": "^2.0.0-internal.1.2.0",
+    "@fluidframework/garbage-collector": "^2.0.0-internal.1.2.0",
+    "@fluidframework/protocol-base": "^0.1038.1000",
     "@fluidframework/protocol-definitions": "^1.0.0",
-    "@fluidframework/runtime-definitions": "^2.0.0-internal.1.1.3",
-    "@fluidframework/runtime-utils": "^2.0.0-internal.1.1.3",
-    "@fluidframework/telemetry-utils": "^2.0.0-internal.1.1.3",
+    "@fluidframework/runtime-definitions": "^2.0.0-internal.1.2.0",
+    "@fluidframework/runtime-utils": "^2.0.0-internal.1.2.0",
+    "@fluidframework/telemetry-utils": "^2.0.0-internal.1.2.0",
     "lodash": "^4.17.21",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.3.1000",
+    "@fluidframework/build-common": "^1.0.0",
+    "@fluidframework/build-tools": "^0.4.4000",
     "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@^1.0.0",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^2.0.0-internal.1.1.3",
-    "@fluidframework/test-runtime-utils": "^2.0.0-internal.1.1.3",
+    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluidframework/mocha-test-setup": "^2.0.0-internal.1.2.0",
+    "@fluidframework/test-runtime-utils": "^2.0.0-internal.1.2.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",

package/src/dataStoreRuntime.ts

@@ -273,10 +273,12 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
         /**
          * If existing flag is false, this is a new data store and is not visible. The existing flag can be true in two
          * conditions:
+         *
          * 1. It's a local data store that is created when a detached container is rehydrated. In this case, the data
-         *    store is locally visible because the snapshot it is loaded from contains locally visible data stores only.
+         * store is locally visible because the snapshot it is loaded from contains locally visible data stores only.
+         *
          * 2. It's a remote data store that is created when an attached container is loaded is loaded from snapshot or
-         *    when an attach op comes in. In both these cases, the data store is already globally visible.
+         * 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
@@ -422,11 +424,14 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
 
     /**
      * This function is called when a data store becomes root. It does the following:
+     *
      * 1. Marks the data store locally visible in the container.
+     *
      * 2. Attaches the graph of all the handles bound to it.
+     *
      * 3. Calls into the data store context to mark it visible in the container too. If the container is globally
-     *    visible, it will mark us globally visible. Otherwise, it will mark us globally visible when it becomes
-     *    globally visible.
+     * visible, it will mark us globally visible. Otherwise, it will mark us globally visible when it becomes
+     * globally visible.
      */
     public makeVisibleAndAttachGraph() {
         if (this.visibilityState !== VisibilityState.NotVisible) {
@@ -619,11 +624,15 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
      * Generates data used for garbage collection. This includes a list of GC nodes that represent this channel
      * including any of its child channel contexts. Each node has a set of outbound routes to other GC nodes in the
      * document. It does the following:
+     *
      * 1. Calls into each child 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> {
@@ -735,21 +744,21 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
          * back-compat 0.59.1000 - getAttachSummary() is called when making a data store globally visible (previously
          * attaching state). Ideally, attachGraph() should have already be called making it locally visible. However,
          * before visibility state was added, this may not have been the case and getAttachSummary() could be called:
-         * 1) Before attaching the data store - When a detached container is attached.
-         * 2) After attaching the data store - When a data store is created and bound in an attached container.
+         *
+         * 1. Before attaching the data store - When a detached container is attached.
+         *
+         * 2. After attaching the data store - When a data store is created and bound in an attached container.
          *
          * The basic idea is that all local object should become locally visible before they are globally visible.
          */
         this.attachGraph();
 
-        /**
-         * This assert cannot be added now due to back-compat. To be uncommented when the following issue is fixed -
-         * https://github.com/microsoft/FluidFramework/issues/9688.
-         *
-         * assert(this.visibilityState === VisibilityState.LocallyVisible,
-         *   "The data store should be locally visible when generating attach summary",
-         * );
-         */
+        // This assert cannot be added now due to back-compat. To be uncommented when the following issue is fixed -
+        // https://github.com/microsoft/FluidFramework/issues/9688.
+        //
+        // assert(this.visibilityState === VisibilityState.LocallyVisible,
+        //  "The data store should be locally visible when generating attach summary",
+        // );
 
         const summaryBuilder = new SummaryTreeBuilder();
 

package/src/fluidHandle.ts

@@ -29,15 +29,19 @@ export class FluidObjectHandle<T extends FluidObject = FluidObject> implements I
          * should be enough for a handle. However, there are scenarios where the object becomes locally visible but the
          * handle does not know this - This will happen is attachGraph is never called on the handle. Couple of examples
          * where this can happen:
+         *
          * 1. Handles to DDS other than the default handle won't know if the DDS becomes visible after the handle was
-         *    created.
+         * created.
+         *
          * 2. Handles to root data stores will never know that it was visible because the handle will not be stores in
-         *    another DDS and so, attachGraph will never be called on it.
+         * another DDS and so, attachGraph will never be called on it.
          */
         return this.isAttached || this.locallyVisible;
     }
 
-    // Tracks whether this handle is locally visible in the container.
+    /**
+     * Tracks whether this handle is locally visible in the container.
+     */
     private locallyVisible: boolean = false;
 
     /**
@@ -47,7 +51,7 @@ export class FluidObjectHandle<T extends FluidObject = FluidObject> implements I
      * @param routeContext - The parent IFluidHandleContext that has a route to this handle.
      */
     constructor(
-        protected readonly value: T,
+        protected readonly value: T | Promise<T>,
         public readonly path: string,
         public readonly routeContext: IFluidHandleContext,
     ) {
@@ -55,6 +59,7 @@ export class FluidObjectHandle<T extends FluidObject = FluidObject> implements I
     }
 
     public async get(): Promise<any> {
+        // Note that this return works whether we received a T or a Promise<T> for this.value in the constructor.
         return this.value;
     }
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.0.0-internal.1.1.3";
+export const pkgVersion = "2.0.0-internal.1.2.0";