Aqueduct: Add props object based constructor for DataObject Factories (#24527)

The current argument-based constructors for DataObjectFactory, and
PureDataObjectFactory do not scale. They already have multiple optional
arguments which leads to hard to read and understand code like:
```
	private static readonly factory = new DataObjectFactory(
		DataObjectGrid.ComponentName,
		DataObjectGrid,
		[],
		{},
		[...registryEntries],
	);
```
Adding further argument would further increase the problems of the
current approach. To allow for easier additions, i've added a property
object base constructor to both DataObjectFactory, and
PureDataObjectFactory:
```
private static readonly factory = new DataObjectFactory({
		type: DataObjectGrid.ComponentName,
		ctor: DataObjectGrid,
		registryEntries: [...registryEntries],
	});
```

I've also updated all existing usages. I primarily used co-pilot to do
this in agentic mode with the follow prompts:
- `you must search for the regex `new DataObjectFactory\([^{}]` and
complete all those files. you should convert from the multiple
parameters constructor to the single props based constructor. keep the
same values when converting. `
- `you must search for the regex `new DataObjectFactory\($` and complete
all those files. you should convert from the multiple parameters
constructor to the single props based constructor. keep the same values
when converting.`

Author: anthony-murphy

examples/apps/attributable-map/src/dataObject.ts

@@ -53,12 +53,11 @@ export class HitCounter extends DataObject implements IHitCounter {
 
 	public static readonly Name = "@fluid-example/attributable-map";
 
-	private static readonly factory = new DataObjectFactory(
-		HitCounter.Name,
-		HitCounter,
-		[AttributableMap.getFactory()],
-		{},
-	);
+	private static readonly factory = new DataObjectFactory({
+		type: HitCounter.Name,
+		ctor: HitCounter,
+		sharedObjects: [AttributableMap.getFactory()],
+	});
 
 	public static getFactory(): DataObjectFactory<HitCounter> {
 		return this.factory;

examples/apps/collaborative-textarea/src/fluid-object/index.ts

@@ -24,12 +24,11 @@ export class CollaborativeText extends DataObject {
 
 	public static readonly Name = "@fluid-example/collaborative-textarea";
 
-	private static readonly factory = new DataObjectFactory(
-		CollaborativeText.Name,
-		CollaborativeText,
-		[SharedString.getFactory()],
-		{},
-	);
+	private static readonly factory = new DataObjectFactory({
+		type: CollaborativeText.Name,
+		ctor: CollaborativeText,
+		sharedObjects: [SharedString.getFactory()],
+	});
 
 	public static getFactory(): DataObjectFactory<CollaborativeText> {
 		return this.factory;

examples/apps/contact-collection/src/dataObject.ts

@@ -103,9 +103,7 @@ export class ContactCollection extends DataObject implements IContactCollection
  * The DataObjectFactory is used by Fluid Framework to instantiate our DataObject.  We provide it with a unique name
  * and the constructor it will call.  In this scenario, the third and fourth arguments are not used.
  */
-export const ContactCollectionInstantiationFactory = new DataObjectFactory(
-	"contact-collection",
-	ContactCollection,
-	[],
-	{},
-);
+export const ContactCollectionInstantiationFactory = new DataObjectFactory({
+	type: "contact-collection",
+	ctor: ContactCollection,
+});

examples/apps/data-object-grid/src/dataObjectGrid.ts

@@ -73,13 +73,11 @@ export interface IDataObjectGridItem {
 export class DataObjectGrid extends DataObject implements IDataObjectGrid {
 	public static readonly ComponentName = "@fluid-example/data-object-grid";
 
-	private static readonly factory = new DataObjectFactory(
-		DataObjectGrid.ComponentName,
-		DataObjectGrid,
-		[],
-		{},
-		[...registryEntries],
-	);
+	private static readonly factory = new DataObjectFactory({
+		type: DataObjectGrid.ComponentName,
+		ctor: DataObjectGrid,
+		registryEntries: [...registryEntries],
+	});
 
 	public static getFactory() {
 		return DataObjectGrid.factory;

examples/apps/task-selection/src/oldestClientDiceRoller.ts

@@ -106,9 +106,7 @@ export class OldestClientDiceRoller extends DataObject implements IDiceRoller {
  * The DataObjectFactory is used by Fluid Framework to instantiate our DataObject.  We provide it with a unique name
  * and the constructor it will call.  In this scenario, the third and fourth arguments are not used.
  */
-export const OldestClientDiceRollerInstantiationFactory = new DataObjectFactory(
-	"@fluid-example/oldest-client-dice-roller",
-	OldestClientDiceRoller,
-	[],
-	{},
-);
+export const OldestClientDiceRollerInstantiationFactory = new DataObjectFactory({
+	type: "@fluid-example/oldest-client-dice-roller",
+	ctor: OldestClientDiceRoller,
+});

examples/apps/task-selection/src/taskManagerDiceRoller.ts

@@ -115,10 +115,8 @@ export class TaskManagerDiceRoller extends DataObject implements IDiceRoller {
  * The DataObjectFactory is used by Fluid Framework to instantiate our DataObject.  We provide it with a unique name
  * and the constructor it will call.  In this scenario, the third and fourth arguments are not used.
  */
-export const TaskManagerDiceRollerInstantiationFactory = new DataObjectFactory(
-	"@fluid-example/task-manager-dice-roller",
-	TaskManagerDiceRoller,
-	// Since TaskManager is a DDS, we need to register it for creation.
-	[TaskManager.getFactory()],
-	{},
-);
+export const TaskManagerDiceRollerInstantiationFactory = new DataObjectFactory({
+	type: "@fluid-example/task-manager-dice-roller",
+	ctor: TaskManagerDiceRoller,
+	sharedObjects: [TaskManager.getFactory()],
+});

examples/benchmarks/bubblebench/baseline/src/main.ts

@@ -35,9 +35,7 @@ export class Bubblebench extends DataObject {
  * To add a SharedSequence, SharedMap, or any other structure, put it in the array below.
  * @internal
  */
-export const BubblebenchInstantiationFactory = new DataObjectFactory(
-	Bubblebench.Name,
-	Bubblebench,
-	[],
-	{},
-);
+export const BubblebenchInstantiationFactory = new DataObjectFactory({
+	type: Bubblebench.Name,
+	ctor: Bubblebench,
+});

examples/benchmarks/bubblebench/experimental-tree/src/main.tsx

@@ -80,9 +80,8 @@ export class Bubblebench extends DataObject {
  * To add a SharedSequence, SharedMap, or any other structure, put it in the array below.
  * @internal
  */
-export const BubblebenchInstantiationFactory = new DataObjectFactory(
-	Bubblebench.Name,
-	Bubblebench,
-	[SharedTree.getFactory(WriteFormat.v0_1_1)],
-	{},
-);
+export const BubblebenchInstantiationFactory = new DataObjectFactory({
+	type: Bubblebench.Name,
+	ctor: Bubblebench,
+	sharedObjects: [SharedTree.getFactory(WriteFormat.v0_1_1)],
+});

examples/benchmarks/bubblebench/ot/src/main.ts

@@ -74,9 +74,8 @@ export class Bubblebench extends DataObject {
  * To add a SharedSequence, SharedMap, or any other structure, put it in the array below.
  * @internal
  */
-export const BubblebenchInstantiationFactory = new DataObjectFactory(
-	Bubblebench.Name,
-	Bubblebench,
-	[SharedJson1.getFactory()],
-	{},
-);
+export const BubblebenchInstantiationFactory = new DataObjectFactory({
+	type: Bubblebench.Name,
+	ctor: Bubblebench,
+	sharedObjects: [SharedJson1.getFactory()],
+});

examples/benchmarks/bubblebench/shared-tree/src/bubblebench.ts

@@ -85,9 +85,8 @@ export class Bubblebench extends DataObject {
  * To add a SharedSequence, SharedMap, or any other structure, put it in the array below.
  * @internal
  */
-export const BubblebenchInstantiationFactory = new DataObjectFactory(
-	Bubblebench.Name,
-	Bubblebench,
-	[SharedTree.getFactory()], // This is fine for now  but we will have to adjust this API later to allow control of write format
-	{},
-);
+export const BubblebenchInstantiationFactory = new DataObjectFactory({
+	type: Bubblebench.Name,
+	ctor: Bubblebench,
+	sharedObjects: [SharedTree.getFactory()],
+});

examples/data-objects/canvas/src/index.ts

@@ -14,12 +14,11 @@ import { CanvasView } from "./view.js";
 /**
  * @internal
  */
-export const CanvasInstantiationFactory = new DataObjectFactory(
-	"Canvas",
-	Canvas,
-	[Ink.getFactory()],
-	{},
-);
+export const CanvasInstantiationFactory = new DataObjectFactory({
+	type: "Canvas",
+	ctor: Canvas,
+	sharedObjects: [Ink.getFactory()],
+});
 
 const canvasViewCallback = (canvas: Canvas): React.ReactElement =>
 	React.createElement(CanvasView, { canvas });

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

@@ -140,12 +140,11 @@ export class ClickerReactView extends React.Component<ClickerProps, ClickerState
 
 // ----- FACTORY SETUP -----
 
-export const ClickerInstantiationFactory = new DataObjectFactory(
-	ClickerName,
-	Clicker,
-	[SharedCounter.getFactory(), TaskManager.getFactory()],
-	{},
-);
+export const ClickerInstantiationFactory = new DataObjectFactory({
+	type: ClickerName,
+	ctor: Clicker,
+	sharedObjects: [SharedCounter.getFactory(), TaskManager.getFactory()],
+});
 
 const clickerViewCallback = (clicker: Clicker) => <ClickerReactView clicker={clicker} />;
 

examples/data-objects/diceroller/src/main.tsx

@@ -67,7 +67,10 @@ export const DiceRollerView: React.FC<IDiceRollerViewProps> = (
 export class DiceRoller extends DataObject implements IDiceRoller {
 	public static readonly Name = "@fluid-example/dice-roller";
 
-	public static readonly factory = new DataObjectFactory(DiceRoller.Name, DiceRoller, [], {});
+	public static readonly factory = new DataObjectFactory({
+		type: DiceRoller.Name,
+		ctor: DiceRoller,
+	});
 
 	/**
 	 * initializingFirstTime is called only once, it is executed only by the first client to open the

examples/data-objects/monaco/src/index.ts

@@ -13,12 +13,11 @@ import { MonacoView } from "./view.js";
 
 const monacoName = "@fluid-example/monaco";
 
-const componentFactory = new DataObjectFactory(
-	monacoName,
-	MonacoRunner,
-	[sequence.SharedString.getFactory()],
-	{},
-);
+const componentFactory = new DataObjectFactory({
+	type: monacoName,
+	ctor: MonacoRunner,
+	sharedObjects: [sequence.SharedString.getFactory()],
+});
 
 const monacoViewCallback = (model: MonacoRunner): React.ReactElement =>
 	React.createElement(MonacoView, { sharedString: model.text });

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

@@ -23,13 +23,11 @@ export class Constellation extends DataObject implements IConstellation {
 		return Constellation.factory;
 	}
 
-	private static readonly factory = new DataObjectFactory(
-		constellationName,
-		Constellation,
-		[],
-		{},
-		new Map([Coordinate.getFactory().registryEntry]),
-	);
+	private static readonly factory = new DataObjectFactory({
+		type: constellationName,
+		ctor: Constellation,
+		registryEntries: new Map([Coordinate.getFactory().registryEntry]),
+	});
 
 	protected async initializingFirstTime(): Promise<void> {
 		this.root.set(starListKey, []);

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

@@ -21,12 +21,10 @@ export class Coordinate extends DataObject implements ICoordinate {
 		return Coordinate.factory;
 	}
 
-	private static readonly factory = new DataObjectFactory(
-		Coordinate.ComponentName,
-		Coordinate,
-		[],
-		{},
-	);
+	private static readonly factory = new DataObjectFactory({
+		type: Coordinate.ComponentName,
+		ctor: Coordinate,
+	});
 
 	protected async initializingFirstTime(): Promise<void> {
 		this.root.set(xKey, 0);

examples/data-objects/table-document/src/document.ts

@@ -61,13 +61,12 @@ export class TableDocument
 		return TableDocument.factory;
 	}
 
-	private static readonly factory = new DataObjectFactory(
-		TableDocumentType,
-		TableDocument,
-		[SparseMatrix.getFactory(), SharedNumberSequence.getFactory()],
-		{},
-		[TableSlice.getFactory().registryEntry],
-	);
+	private static readonly factory = new DataObjectFactory({
+		type: TableDocumentType,
+		ctor: TableDocument,
+		sharedObjects: [SparseMatrix.getFactory(), SharedNumberSequence.getFactory()],
+		registryEntries: [TableSlice.getFactory().registryEntry],
+	});
 
 	public get numCols() {
 		return this.cols.getLength();

examples/data-objects/table-document/src/slice.ts

@@ -33,7 +33,10 @@ export class TableSlice
 		return TableSlice.factory;
 	}
 
-	private static readonly factory = new DataObjectFactory(TableSliceType, TableSlice, [], {});
+	private static readonly factory = new DataObjectFactory({
+		type: TableSliceType,
+		ctor: TableSlice,
+	});
 
 	public get name() {
 		return this.root.get(ConfigKey.name);

examples/data-objects/webflow/src/document/index.ts

@@ -141,12 +141,11 @@ const textId = "text";
  * @internal
  */
 export class FlowDocument extends DataObject {
-	private static readonly factory = new DataObjectFactory<FlowDocument>(
-		documentType,
-		FlowDocument,
-		[SharedString.getFactory()],
-		{},
-	);
+	private static readonly factory = new DataObjectFactory({
+		type: documentType,
+		ctor: FlowDocument,
+		sharedObjects: [SharedString.getFactory()],
+	});
 
 	public static getFactory() {
 		return FlowDocument.factory;

examples/data-objects/webflow/src/host/webFlow.ts

@@ -11,13 +11,11 @@ import { FlowDocument } from "../document/index.js";
 import { hostType } from "../package.js";
 
 export class WebFlow extends DataObject {
-	private static readonly factory = new DataObjectFactory<WebFlow>(
-		hostType,
-		WebFlow,
-		[],
-		{},
-		new Map([FlowDocument.getFactory().registryEntry]),
-	);
+	private static readonly factory = new DataObjectFactory({
+		type: hostType,
+		ctor: WebFlow,
+		registryEntries: new Map([FlowDocument.getFactory().registryEntry]),
+	});
 
 	public static getFactory(): IFluidDataStoreFactory {
 		return WebFlow.factory;

examples/utils/bundle-size-tests/src/aqueduct.ts

@@ -14,12 +14,11 @@ import { SharedString } from "@fluidframework/sequence/internal";
 
 export function apisToBundle() {
 	class BundleTestDo extends DataObject {}
-	const defaultFactory = new DataObjectFactory(
-		"BundleTestDo",
-		BundleTestDo,
-		[SharedString.getFactory(), new DirectoryFactory()],
-		{},
-	);
+	const defaultFactory = new DataObjectFactory({
+		type: "BundleTestDo",
+		ctor: BundleTestDo,
+		sharedObjects: [SharedString.getFactory(), new DirectoryFactory()],
+	});
 
 	new ContainerRuntimeFactoryWithDefaultDataStore({
 		defaultFactory,

examples/utils/example-utils/src/migrationTool/sameContainerMigrationTool.ts

@@ -430,10 +430,8 @@ export class SameContainerMigrationTool
  * scenario, the fourth argument is not used.
  * @internal
  */
-export const SameContainerMigrationToolInstantiationFactory =
-	new DataObjectFactory<SameContainerMigrationTool>(
-		"migration-tool",
-		SameContainerMigrationTool,
-		[PactMap.getFactory()],
-		{},
-	);
+export const SameContainerMigrationToolInstantiationFactory = new DataObjectFactory({
+	type: "migration-tool",
+	ctor: SameContainerMigrationTool,
+	sharedObjects: [PactMap.getFactory()],
+});

examples/version-migration/live-schema-upgrade/src/modelVersion1/diceRoller.ts

@@ -78,9 +78,7 @@ export class DiceRoller extends DataObject implements IDiceRoller {
  * The DataObjectFactory is used by Fluid Framework to instantiate our DataObject.  We provide it with a unique name
  * and the constructor it will call.  In this scenario, the third and fourth arguments are not used.
  */
-export const DiceRollerInstantiationFactory = new DataObjectFactory(
-	"dice-roller",
-	DiceRoller,
-	[],
-	{},
-);
+export const DiceRollerInstantiationFactory = new DataObjectFactory({
+	type: "dice-roller",
+	ctor: DiceRoller,
+});

examples/version-migration/live-schema-upgrade/src/modelVersion2/diceCounter.ts

@@ -79,9 +79,8 @@ export class DiceCounter extends DataObject implements IDiceCounter {
  * The DataObjectFactory is used by Fluid Framework to instantiate our DataObject.  We provide it with a unique name
  * and the constructor it will call.  In this scenario, the third and fourth arguments are not used.
  */
-export const DiceCounterInstantiationFactory = new DataObjectFactory(
-	"dice-counter",
-	DiceCounter,
-	[SharedCounter.getFactory()],
-	{},
-);
+export const DiceCounterInstantiationFactory = new DataObjectFactory({
+	type: "dice-counter",
+	ctor: DiceCounter,
+	sharedObjects: [SharedCounter.getFactory()],
+});