Improvements to PureDataObjectFactory & data store creation flows; introduction of detached data store context

BREAKING.md

@@ -7,7 +7,7 @@
 - [IComponentContextLegacy is removed](#IComponentContextLegacy-is-removed)
 - [IContainerRuntimeBase._createDataStoreWithProps() is removed](#IContainerRuntimeBase._createDataStoreWithProps-is-removed)
 - [_createDataStore() APIs are removed](#_createDataStore-APIs-are-removed)
-- [createDataStoreWithRealizationFn() APIs moved](#createDataStoreWithRealizationFn()-APIs-moved)
+- [createDataStoreWithRealizationFn() APIs are removed](#createDataStoreWithRealizationFn()-APIs-are-removed)
 - [getDataStore() APIs is removed](#getDataStore()-APIs-is-removed)
 - [Package Renames](#package-renames)
 - [IComponent and IComponent Interfaces Removed](#IComponent-and-IComponent-Interfaces-Removed)
@@ -40,9 +40,10 @@ Please switch to using one of the following APIs:
 1. `IContainerRuntime.createRootDataStore()` - data store created that way is automatically bound to container. It will immediately be visible to remote clients (when/if container is attached). Such data stores are never garbage collected. Note that this API is on `IContainerRuntime` interface, which is not directly accessible to data stores. The intention is that only container owners are creating roots.
 2. `IContainerRuntimeBase.createDataStore()` - creates data store that is not bound to container. In order for this store to be bound to container (and thus be observable on remote clients), ensure that handle to it (or any of its objects / DDS) is stored into any other DDS that is already bound to container. In other words, newly created data store has to be reachable (there has to be a path) from some root data store in container. If, in future, such data store becomes unreachable from one of the roots, it will be garbage collected (implementation pending).
 
-### createDataStoreWithRealizationFn() APIs moved
+### createDataStoreWithRealizationFn() APIs are removed
 Removed from IFluidDataStoreContext  & IContainerRuntime.
-Temporarily exposed on IContainerRuntimeBase. The intent is to remove it altogether in same release (more info to follow)
+Consider using (Pure)DataObject(Factory) for your objects - they support passing initial args.
+Otherwise consider implementing similar flow of exposing interface from your fluid object that is used to initialize object after creation.
 
 ## getDataStore() APIs is removed
 IContainerRuntime.getDataStore() is removed. Only IContainerRuntime.getRootDataStore() is available to retrieve root data stores.

examples/apps/spaces/src/fluid-object/index.tsx

@@ -9,6 +9,7 @@ import { Layout } from "react-grid-layout";
 import {
     DataObject,
     DataObjectFactory,
+    getFluidObjectFactoryFromInstance,
 } from "@fluidframework/aqueduct";
 import {
     IFluidHandle,
@@ -126,8 +127,7 @@ export class Spaces extends DataObject implements IFluidHTMLView {
     }
 
     protected async initializingFirstTime() {
-        const storageComponent =
-            await this.createFluidObject<SpacesStorage<ISpacesItem>>(SpacesStorage.ComponentName);
+        const storageComponent = await SpacesStorage.getFactory().createChildInstance(this.context);
         this.root.set(SpacesStorageKey, storageComponent.handle);
         // Set the saved template if there is a template query param
         const urlParams = new URLSearchParams(window.location.search);
@@ -184,8 +184,7 @@ export class Spaces extends DataObject implements IFluidHTMLView {
             throw new Error("Unknown item, can't add");
         }
 
-        // Don't really want to hand out createFluidObject here, see spacesItemMap.ts for more info.
-        const serializableObject = await itemMapEntry.create(this.createFluidObject.bind(this));
+        const serializableObject = await itemMapEntry.create(getFluidObjectFactoryFromInstance(this.context));
         return this.storageComponent.addItem(
             {
                 serializableObject,

examples/apps/spaces/src/fluid-object/spacesItemMap.ts

@@ -3,35 +3,34 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidObject, IFluidHandle, IFluidLoadable } from "@fluidframework/core-interfaces";
+import { IFluidHandle, IFluidLoadable } from "@fluidframework/core-interfaces";
 import { AsSerializable, Serializable } from "@fluidframework/datastore-definitions";
-import { NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
+import { NamedFluidDataStoreRegistryEntries, IFluidDataStoreFactory } from "@fluidframework/runtime-definitions";
 import { ReactViewAdapter } from "@fluidframework/view-adapters";
 import { fluidExport as cmfe } from "@fluid-example/codemirror/dist/codemirror";
 import { CollaborativeText } from "@fluid-example/collaborative-textarea";
 import { Coordinate } from "@fluid-example/multiview-coordinate-model";
 import { SliderCoordinateView } from "@fluid-example/multiview-slider-coordinate-view";
 import { fluidExport as pmfe } from "@fluid-example/prosemirror/dist/prosemirror";
 import { ClickerInstantiationFactory } from "@fluid-example/clicker";
+import { IFluidDataObjectFactory } from "@fluidframework/aqueduct";
 
 import * as React from "react";
 import { Layout } from "react-grid-layout";
 
-export type ICreateAndAttachComponentFunction =
-    <T extends IFluidObject & IFluidLoadable>(pkg: string, props?: any) => Promise<T>;
-
 interface ISingleHandleItem {
     handle: IFluidHandle;
 }
 
-const createSingleHandleItem = (type: string) => {
-    return async (createFluidObject: ICreateAndAttachComponentFunction): Promise<ISingleHandleItem> => {
-        const component = await createFluidObject(type);
+// eslint-disable-next-line @typescript-eslint/promise-function-async, prefer-arrow/prefer-arrow-functions
+function createSingleHandleItem(subFactory: IFluidDataStoreFactory) {
+    return async (dataObjectFactory: IFluidDataObjectFactory): Promise<ISingleHandleItem> => {
+        const component = await dataObjectFactory.createAnonymousChildInstance<IFluidLoadable>(subFactory);
         return {
             handle: component.handle,
         };
     };
-};
+}
 
 const getAdaptedViewForSingleHandleItem = async (serializableObject: ISingleHandleItem) => {
     const handle = serializableObject.handle;
@@ -51,42 +50,42 @@ const getSliderCoordinateView = async (serializableObject: ISingleHandleItem) =>
 export interface ISpacesItemEntry<T extends Serializable = AsSerializable<any>> {
     // Would be better if items to bring their own subregistries, and their own ability to create components
     // This might be done by integrating these items with the Spaces subcomponent registry?
-    create: (createFluidObject: ICreateAndAttachComponentFunction) => Promise<T>;
+    create: (createSubObject: IFluidDataObjectFactory) => Promise<T>;
     getView: (serializableObject: T) => Promise<JSX.Element>;
     friendlyName: string;
     fabricIconName: string;
 }
 
 const clickerItemEntry: ISpacesItemEntry<AsSerializable<ISingleHandleItem>> = {
-    create: createSingleHandleItem(ClickerInstantiationFactory.type),
+    create: createSingleHandleItem(ClickerInstantiationFactory),
     getView: getAdaptedViewForSingleHandleItem,
     friendlyName: "Clicker",
     fabricIconName: "Touch",
 };
 
 const codemirrorItemEntry: ISpacesItemEntry<AsSerializable<ISingleHandleItem>> = {
-    create: createSingleHandleItem(cmfe.type),
+    create: createSingleHandleItem(cmfe),
     getView: getAdaptedViewForSingleHandleItem,
     friendlyName: "Code",
     fabricIconName: "Code",
 };
 
 const textboxItemEntry: ISpacesItemEntry<AsSerializable<ISingleHandleItem>> = {
-    create: createSingleHandleItem(CollaborativeText.ComponentName),
+    create: createSingleHandleItem(CollaborativeText.getFactory()),
     getView: getAdaptedViewForSingleHandleItem,
     friendlyName: "Text Box",
     fabricIconName: "Edit",
 };
 
 const prosemirrorItemEntry: ISpacesItemEntry<AsSerializable<ISingleHandleItem>> = {
-    create: createSingleHandleItem(pmfe.type),
+    create: createSingleHandleItem(pmfe),
     getView: getAdaptedViewForSingleHandleItem,
     friendlyName: "Rich Text",
     fabricIconName: "FabricTextHighlight",
 };
 
 const sliderCoordinateItemEntry: ISpacesItemEntry<AsSerializable<ISingleHandleItem>> = {
-    create: createSingleHandleItem(Coordinate.getFactory().type),
+    create: createSingleHandleItem(Coordinate.getFactory()),
     getView: getSliderCoordinateView,
     friendlyName: "Coordinate",
     fabricIconName: "NumberSymbol",

examples/data-objects/codemirror/src/codemirror.ts

@@ -268,7 +268,7 @@ class SmdeFactory implements IFluidDataStoreFactory {
 
     public get IFluidDataStoreFactory() { return this; }
 
-    public instantiateDataStore(context: IFluidDataStoreContext): void {
+    public async instantiateDataStore(context: IFluidDataStoreContext) {
         const dataTypes = new Map<string, IChannelFactory>();
         const mapFactory = SharedMap.getFactory();
         const sequenceFactory = SharedString.getFactory();
@@ -285,6 +285,7 @@ class SmdeFactory implements IFluidDataStoreFactory {
             const progressCollection = await progressCollectionP;
             return progressCollection.request(request);
         });
+        return runtime;
     }
 }
 

examples/data-objects/external-component-loader/src/externalComponentLoader.tsx

@@ -35,7 +35,7 @@ export class ExternalComponentLoader extends DataObject {
      * @param componentUrl - the URL of the component to create, adding it to the registry if needed.
      */
     public async createComponentFromUrl(componentUrl: string): Promise<IFluidLoadable> {
-        const urlReg = await this.runtime.IFluidDataStoreRegistry?.get("url");
+        const urlReg = await this.context.IFluidDataStoreRegistry?.get("url");
         if (urlReg?.IFluidDataStoreRegistry === undefined) {
             throw new Error("Couldn't get url component registry");
         }

examples/data-objects/external-component-loader/src/urlRegistry.ts

@@ -9,16 +9,16 @@ import {
     IFluidCodeDetails,
 } from "@fluidframework/container-definitions";
 import {
+    IProvideFluidDataStoreRegistry,
     FluidDataStoreRegistryEntry,
-    IFluidDataStoreRegistry,
 } from "@fluidframework/runtime-definitions";
 import { IFluidObject } from "@fluidframework/core-interfaces";
 import { WebCodeLoader, SemVerCdnCodeResolver } from "@fluidframework/web-code-loader";
 
 /**
  * A component registry that can load component via their url
  */
-export class UrlRegistry implements IFluidDataStoreRegistry {
+export class UrlRegistry implements IProvideFluidDataStoreRegistry {
     private static readonly WindowKeyPrefix = "FluidExternalComponent";
 
     private readonly urlRegistryMap = new Map<string, Promise<FluidDataStoreRegistryEntry | undefined>>();

examples/data-objects/external-component-loader/src/waterPark.tsx

@@ -133,9 +133,9 @@ export class WaterPark extends DataObject implements IFluidHTMLView {
     }
 
     protected async initializingFirstTime() {
-        const storage = await this.createFluidObject(SpacesStorage.ComponentName);
+        const storage = await SpacesStorage.getFactory().createChildInstance(this.context);
         this.root.set(storageKey, storage.handle);
-        const loader = await this.createFluidObject(ExternalComponentLoader.ComponentName);
+        const loader = await ExternalComponentLoader.getFactory().createChildInstance(this.context);
         this.root.set(loaderKey, loader.handle);
     }
 

examples/data-objects/key-value-cache/src/index.ts

@@ -116,7 +116,7 @@ export class KeyValueFactoryComponent implements IRuntimeFactory, IFluidDataStor
     public get IRuntimeFactory() { return this; }
     public get IFluidDataStoreFactory() { return this; }
 
-    public instantiateDataStore(context: IFluidDataStoreContext): void {
+    public async instantiateDataStore(context: IFluidDataStoreContext) {
         const dataTypes = new Map<string, IChannelFactory>();
         const mapFactory = SharedMap.getFactory();
         dataTypes.set(mapFactory.type, mapFactory);
@@ -131,6 +131,8 @@ export class KeyValueFactoryComponent implements IRuntimeFactory, IFluidDataStor
             const keyValue = await keyValueP;
             return keyValue.request(request);
         });
+
+        return runtime;
     }
 
     public async instantiateRuntime(context: IContainerContext): Promise<IRuntime> {

examples/data-objects/multiview/constellation-model/src/model.ts

@@ -63,7 +63,7 @@ export class Constellation extends DataObject implements IConstellation {
 
     public async addStar(x: number, y: number): Promise<void> {
         const starHandles = this.root.get<IFluidHandle<ICoordinate>[]>(starListKey);
-        const newStar: Coordinate = (await Coordinate.getFactory().createInstance(this.context)) as Coordinate;
+        const newStar = await Coordinate.getFactory().createChildInstance(this.context);
         newStar.x = x;
         newStar.y = y;
         starHandles.push(newStar.handle);

examples/data-objects/pond/src/index.tsx

@@ -42,10 +42,11 @@ export class Pond extends DataObject implements IFluidHTMLView {
    * Do setup work here
    */
     protected async initializingFirstTime() {
-        const clickerComponent = await Clicker.getFactory().createInstance(this.context);
+        const clickerComponent = await Clicker.getFactory().createChildInstance(this.context);
         this.root.set(Clicker.ComponentName, clickerComponent.handle);
 
-        const clickerComponentUsingProvider = await ExampleUsingProviders.getFactory().createInstance(this.context);
+        const clickerComponentUsingProvider =
+            await ExampleUsingProviders.getFactory().createChildInstance(this.context);
         this.root.set(ExampleUsingProviders.ComponentName, clickerComponentUsingProvider.handle);
     }
 

examples/data-objects/progress-bars/src/progressBars.ts

@@ -230,7 +230,7 @@ class ProgressBarsFactory implements IFluidDataStoreFactory {
 
     public get IFluidDataStoreFactory() { return this; }
 
-    public instantiateDataStore(context: IFluidDataStoreContext): void {
+    public async instantiateDataStore(context: IFluidDataStoreContext) {
         const dataTypes = new Map<string, IChannelFactory>();
         const mapFactory = SharedMap.getFactory();
         dataTypes.set(mapFactory.type, mapFactory);
@@ -245,6 +245,8 @@ class ProgressBarsFactory implements IFluidDataStoreFactory {
             const progressCollection = await progressCollectionP;
             return progressCollection.request(request);
         });
+
+        return runtime;
     }
 }
 

examples/data-objects/prosemirror/src/prosemirror.ts

@@ -175,7 +175,7 @@ class ProseMirrorFactory implements IFluidDataStoreFactory {
 
     public get IFluidDataStoreFactory() { return this; }
 
-    public instantiateDataStore(context: IFluidDataStoreContext): void {
+    public async instantiateDataStore(context: IFluidDataStoreContext) {
         const dataTypes = new Map<string, IChannelFactory>();
         const mapFactory = SharedMap.getFactory();
         const sequenceFactory = SharedString.getFactory();
@@ -193,6 +193,8 @@ class ProseMirrorFactory implements IFluidDataStoreFactory {
             const proseMirror = await proseMirrorP;
             return proseMirror.request(request);
         });
+
+        return runtime;
     }
 }
 

examples/data-objects/scribe/src/scribe.ts

@@ -482,7 +482,7 @@ class ScribeFactory implements IFluidDataStoreFactory, IRuntimeFactory {
         return runtime;
     }
 
-    public instantiateDataStore(context: IFluidDataStoreContext): void {
+    public async instantiateDataStore(context: IFluidDataStoreContext) {
         const dataTypes = new Map<string, IChannelFactory>();
         const mapFactory = SharedMap.getFactory();
         dataTypes.set(mapFactory.type, mapFactory);
@@ -497,6 +497,8 @@ class ScribeFactory implements IFluidDataStoreFactory, IRuntimeFactory {
             const progressCollection = await progressCollectionP;
             return progressCollection.request(request);
         });
+
+        return runtime;
     }
 }
 

examples/data-objects/shared-text/src/component.ts

@@ -306,7 +306,7 @@ class TaskScheduler {
     }
 }
 
-export function instantiateDataStore(context: IFluidDataStoreContext): void {
+export function instantiateDataStore(context: IFluidDataStoreContext) {
     const modules = new Map<string, any>();
 
     // Create channel factories
@@ -335,4 +335,6 @@ export function instantiateDataStore(context: IFluidDataStoreContext): void {
         const runner = await runnerP;
         return runner.request(request);
     });
+
+    return runtime;
 }

examples/data-objects/shared-text/src/index.ts

@@ -7,12 +7,13 @@
 // eslint-disable-next-line import/no-unassigned-import
 import "./publicpath";
 
+import assert from "assert";
 import { IContainerContext, IRuntime, IRuntimeFactory } from "@fluidframework/container-definitions";
 import { ContainerRuntime } from "@fluidframework/container-runtime";
 import {
     IFluidDataStoreContext,
-    IFluidDataStoreFactory,
-    IFluidDataStoreRegistry,
+    IProvideFluidDataStoreFactory,
+    IProvideFluidDataStoreRegistry,
     NamedFluidDataStoreRegistryEntries,
 } from "@fluidframework/runtime-definitions";
 import {
@@ -56,15 +57,15 @@ const defaultRegistryEntries: NamedFluidDataStoreRegistryEntries = [
     ["@fluid-example/image-collection", images.then((m) => m.fluidExport)],
 ];
 
-class MyRegistry implements IFluidDataStoreRegistry {
+class MyRegistry implements IProvideFluidDataStoreRegistry {
     constructor(
         private readonly context: IContainerContext,
         private readonly defaultRegistry: string) {
     }
 
     public get IFluidDataStoreRegistry() { return this; }
 
-    public async get(name: string): Promise<IFluidDataStoreFactory> {
+    public async get(name: string): Promise<IProvideFluidDataStoreFactory | IProvideFluidDataStoreRegistry> {
         const scope = `${name.split("/")[0]}:cdn`;
         const config = {};
         config[scope] = this.defaultRegistry;
@@ -74,18 +75,21 @@ class MyRegistry implements IFluidDataStoreRegistry {
             config,
         };
         const fluidModule = await this.context.codeLoader.load(codeDetails);
-        return fluidModule.fluidExport.IFluidDataStoreFactory;
+        const moduleExport = fluidModule.fluidExport;
+        assert(moduleExport.IFluidDataStoreFactory !== undefined ||
+            moduleExport.IFluidDataStoreRegistry  !== undefined);
+        return moduleExport as IProvideFluidDataStoreFactory | IProvideFluidDataStoreRegistry;
     }
 }
 
-class SharedTextFactoryComponent implements IFluidDataStoreFactory, IRuntimeFactory {
+class SharedTextFactoryComponent implements IProvideFluidDataStoreFactory, IRuntimeFactory {
     public static readonly type = "@fluid-example/shared-text";
     public readonly type = SharedTextFactoryComponent.type;
 
     public get IFluidDataStoreFactory() { return this; }
     public get IRuntimeFactory() { return this; }
 
-    public instantiateDataStore(context: IFluidDataStoreContext): void {
+    public async instantiateDataStore(context: IFluidDataStoreContext) {
         return sharedTextComponent.instantiateDataStore(context);
     }
 

examples/data-objects/simple-component-embed/src/index.tsx

@@ -24,7 +24,7 @@ export class SimpleComponentEmbed extends DataObject implements IFluidHTMLView {
    * but in this scenario we only want it to be created once.
    */
     protected async initializingFirstTime() {
-        const component = await this.createFluidObject(ClickerInstantiationFactory.type);
+        const component = await ClickerInstantiationFactory.createChildInstance(this.context);
         this.root.set("myEmbeddedCounter", component.handle);
     }
 

examples/data-objects/smde/src/smde.ts

@@ -217,7 +217,7 @@ class SmdeFactory implements IFluidDataStoreFactory {
 
     public get IFluidDataStoreFactory() { return this; }
 
-    public instantiateDataStore(context: IFluidDataStoreContext): void {
+    public async instantiateDataStore(context: IFluidDataStoreContext) {
         const dataTypes = new Map<string, IChannelFactory>();
         const mapFactory = SharedMap.getFactory();
         const sequenceFactory = SharedString.getFactory();
@@ -235,6 +235,8 @@ class SmdeFactory implements IFluidDataStoreFactory {
             const progressCollection = await progressCollectionP;
             return progressCollection.request(request);
         });
+
+        return runtime;
     }
 }