@fluidframework/datastore 2.0.0-dev.1.4.6.106135 → 2.0.0-dev.2.2.0.111723

package/src/dataStoreRuntime.ts

@@ -5,6 +5,7 @@
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import {
+    FluidObject,
     IFluidHandle,
     IFluidHandleContext,
     IRequest,
@@ -62,6 +63,7 @@ import {
     create404Response,
     createResponseError,
     exceptionToResponse,
+    requestFluidObject,
 } from "@fluidframework/runtime-utils";
 import {
     IChannel,
@@ -79,6 +81,7 @@ import { v4 as uuid } from "uuid";
 import { IChannelContext, summarizeChannel } from "./channelContext";
 import { LocalChannelContext, LocalChannelContextBase, RehydratedLocalChannelContext } from "./localChannelContext";
 import { RemoteChannelContext } from "./remoteChannelContext";
+import { FluidObjectHandle } from "./fluidHandle";
 
 export enum DataStoreMessageType {
     // Creates a new channel
@@ -99,6 +102,8 @@ export class FluidDataStoreRuntime extends
 TypedEventEmitter<IFluidDataStoreRuntimeEvents> implements
 IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
     /**
+     * @deprecated - Instantiate the class using its constructor instead.
+     *
      * Loads the data store runtime
      * @param context - The data store context
      * @param sharedObjectRegistry - The registry of shared objects used by this data store
@@ -109,9 +114,18 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
         sharedObjectRegistry: ISharedObjectRegistry,
         existing: boolean,
     ): FluidDataStoreRuntime {
-        return new FluidDataStoreRuntime(context, sharedObjectRegistry, existing);
+        return new FluidDataStoreRuntime(
+            context,
+            sharedObjectRegistry,
+            existing,
+            async (dataStoreRuntime) => requestFluidObject(dataStoreRuntime, "/"));
     }
 
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IFluidDataStoreRuntime.entryPoint}
+     */
+    public readonly entryPoint?: IFluidHandle<FluidObject>;
+
     public get IFluidRouter() { return this; }
 
     public get connected(): boolean {
@@ -176,10 +190,22 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
     // channel contexts.
     private readonly channelsBaseGCDetails: LazyPromise<Map<string, IGarbageCollectionDetailsBase>>;
 
+    /**
+     * 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.
+     */
     public constructor(
         private readonly dataStoreContext: IFluidDataStoreContext,
         private readonly sharedObjectRegistry: ISharedObjectRegistry,
         existing: boolean,
+        initializeEntryPoint?: (runtime: IFluidDataStoreRuntime) => Promise<FluidObject>,
     ) {
         super();
 
@@ -201,8 +227,7 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
         const tree = dataStoreContext.baseSnapshot;
 
         this.channelsBaseGCDetails = new LazyPromise(async () => {
-            const baseGCDetails = await
-                (this.dataStoreContext.getBaseGCDetails?.() ?? this.dataStoreContext.getInitialGCSummaryDetails());
+            const baseGCDetails = await this.dataStoreContext.getBaseGCDetails();
             return unpackChildNodesGCDetails(baseGCDetails);
         });
 
@@ -265,6 +290,11 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
             });
         }
 
+        if (initializeEntryPoint) {
+            const promise = new LazyPromise(async () => initializeEntryPoint(this));
+            this.entryPoint = new FluidObjectHandle<FluidObject>(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;
@@ -658,10 +688,8 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
      * After GC has run, called to notify this channel of routes that are used in it. It calls the child contexts to
      * update their used routes.
      * @param usedRoutes - The routes that are used in all contexts in this channel.
-     * @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.
      */
-    public updateUsedRoutes(usedRoutes: string[], gcTimestamp?: number) {
+    public updateUsedRoutes(usedRoutes: string[]) {
         // Get a map of channel ids to routes used in it.
         const usedContextRoutes = unpackChildNodesUsedRoutes(usedRoutes);
 
@@ -672,7 +700,7 @@ IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
 
         // Update the used routes in each context. Used routes is empty for unused context.
         for (const [contextId, context] of this.contexts) {
-            context.updateUsedRoutes(usedContextRoutes.get(contextId) ?? [], gcTimestamp);
+            context.updateUsedRoutes(usedContextRoutes.get(contextId) ?? []);
         }
     }
 

package/src/fluidHandle.ts

@@ -10,12 +10,27 @@ import {
 } from "@fluidframework/core-interfaces";
 import { generateHandleContextPath } from "@fluidframework/runtime-utils";
 
+/**
+ * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ */
 export class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
     private readonly pendingHandlesToMakeVisible: Set<IFluidHandle> = new Set();
+
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.absolutePath}
+     */
     public readonly absolutePath: string;
 
-    public get IFluidHandle(): IFluidHandle { return this; }
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}
+     */
+    public get IFluidHandle(): IFluidHandle {
+        return this;
+    }
 
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.isAttached}
+     */
     public get isAttached(): boolean {
         return this.routeContext.isAttached;
     }
@@ -45,10 +60,12 @@ export class FluidObjectHandle<T extends FluidObject = FluidObject> implements I
     private locallyVisible: boolean = false;
 
     /**
-     * Creates a new FluidObjectHandle.
-     * @param value - The FluidObject object this handle is for.
-     * @param path - The path to this handle relative to the routeContext.
-     * @param routeContext - The parent IFluidHandleContext that has a route to this handle.
+     * Creates a new `FluidObjectHandle`.
+     *
+     * @param value - The {@link @fluidframework/core-interfaces#FluidObject} object this handle is for.
+     * @param path - The path to this handle relative to the `routeContext`.
+     * @param routeContext - The parent {@link @fluidframework/core-interfaces#IFluidHandleContext} that has a route
+     * to this handle.
      */
     constructor(
         protected readonly value: T | Promise<T>,
@@ -58,11 +75,17 @@ export class FluidObjectHandle<T extends FluidObject = FluidObject> implements I
         this.absolutePath = generateHandleContextPath(path, this.routeContext);
     }
 
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.get}
+     */
     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;
     }
 
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.attachGraph }
+     */
     public attachGraph(): void {
         if (this.visible) {
             return;
@@ -76,6 +99,9 @@ export class FluidObjectHandle<T extends FluidObject = FluidObject> implements I
         this.routeContext.attachGraph();
     }
 
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.bind}
+     */
     public bind(handle: IFluidHandle) {
         // If this handle is visible, attach the graph of the incoming handle as well.
         if (this.visible) {

package/src/index.ts

@@ -3,5 +3,11 @@
  * Licensed under the MIT License.
  */
 
-export * from "./dataStoreRuntime";
-export * from "./fluidHandle";
+export { FluidObjectHandle } from "./fluidHandle";
+export {
+	DataStoreMessageType,
+	FluidDataStoreRuntime,
+	ISharedObjectRegistry,
+	mixinRequestHandler,
+	mixinSummaryHandler,
+} from "./dataStoreRuntime";

package/src/localChannelContext.ts

@@ -143,7 +143,7 @@ export abstract class LocalChannelContextBase implements IChannelContext {
         return this.channel.getGCData(fullGC);
     }
 
-    public updateUsedRoutes(usedRoutes: string[], gcTimestamp?: number) {
+    public updateUsedRoutes(usedRoutes: string[]) {
         /**
          * Currently, DDSes are always considered referenced and are not garbage collected.
          * Once we have GC at DDS level, this channel context's used routes will be updated as per the passed

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.0.0-dev.1.4.6.106135";
+export const pkgVersion = "2.0.0-dev.2.2.0.111723";

package/src/remoteChannelContext.ts

@@ -303,7 +303,7 @@ export class RemoteChannelContext implements IChannelContext {
         return channel.getGCData(fullGC);
     }
 
-    public updateUsedRoutes(usedRoutes: string[], gcTimestamp?: number) {
+    public updateUsedRoutes(usedRoutes: string[]) {
         /**
          * Currently, DDSes are always considered referenced and are not garbage collected. Update the summarizer node's
          * used routes to contain a route to this channel context.