@fluidframework/shared-object-base 2.0.0-rc.3.0.3 → 2.0.0-rc.4.0.0

package/src/serializer.ts

@@ -6,10 +6,16 @@
 // RATIONALE: Many methods consume and return 'any' by necessity.
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 
-import { IFluidHandle, IFluidHandleContext } from "@fluidframework/core-interfaces";
+import {
+	IFluidHandle,
+	IFluidHandleContext,
+	type IFluidHandleInternal,
+} from "@fluidframework/core-interfaces/internal";
 import {
 	generateHandleContextPath,
 	isSerializedHandle,
+	isFluidHandle,
+	toFluidHandleInternal,
 } from "@fluidframework/runtime-utils/internal";
 
 import { RemoteFluidObjectHandle } from "./remoteObjectHandle.js";
@@ -108,8 +114,9 @@ export class FluidSerializer implements IFluidSerializer {
 			: input;
 	}
 
-	public stringify(input: any, bind: IFluidHandle) {
-		return JSON.stringify(input, (key, value) => this.encodeValue(value, bind));
+	public stringify(input: unknown, bind: IFluidHandle) {
+		const bindInternal = toFluidHandleInternal(bind);
+		return JSON.stringify(input, (key, value) => this.encodeValue(value, bindInternal));
 	}
 
 	// Parses the serialized data - context must match the context with which the JSON was stringified
@@ -119,12 +126,11 @@ export class FluidSerializer implements IFluidSerializer {
 
 	// If the given 'value' is an IFluidHandle, returns the encoded IFluidHandle.
 	// Otherwise returns the original 'value'.  Used by 'encode()' and 'stringify()'.
-	private readonly encodeValue = (value: any, bind: IFluidHandle) => {
-		// Detect if 'value' is an IFluidHandle.
-		const handle = value?.IFluidHandle;
-
+	private readonly encodeValue = (value: unknown, bind: IFluidHandleInternal) => {
 		// If 'value' is an IFluidHandle return its encoded form.
-		return handle !== undefined ? this.serializeHandle(handle, bind) : value;
+		return isFluidHandle(value)
+			? this.serializeHandle(toFluidHandleInternal(value), bind)
+			: value;
 	};
 
 	// If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.
@@ -194,7 +200,7 @@ export class FluidSerializer implements IFluidSerializer {
 		return clone ?? input;
 	}
 
-	protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {
+	protected serializeHandle(handle: IFluidHandleInternal, bind: IFluidHandleInternal) {
 		bind.bind(handle);
 		return {
 			type: "__fluid_handle__",

package/src/sharedObject.ts

@@ -5,7 +5,11 @@
 
 import { EventEmitterEventType } from "@fluid-internal/client-utils";
 import { AttachState } from "@fluidframework/container-definitions";
-import { IFluidHandle, ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
+import {
+	IFluidHandle,
+	type IFluidHandleInternal,
+	ITelemetryBaseProperties,
+} from "@fluidframework/core-interfaces/internal";
 import { assert } from "@fluidframework/core-utils/internal";
 import {
 	IChannelAttributes,
@@ -14,7 +18,10 @@ import {
 	IChannelStorageService,
 	IFluidDataStoreRuntime,
 } from "@fluidframework/datastore-definitions";
-import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import {
+	ISequencedDocumentMessage,
+	type IDocumentMessage,
+} from "@fluidframework/protocol-definitions";
 import {
 	IExperimentalIncrementalSummaryContext,
 	IGarbageCollectionData,
@@ -25,8 +32,8 @@ import {
 	blobCountPropertyName,
 	totalBlobSizePropertyName,
 } from "@fluidframework/runtime-definitions/internal";
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import {
+	ITelemetryLoggerExt,
 	DataProcessingError,
 	EventEmitterWithErrorHandling,
 	MonitoringContext,
@@ -36,6 +43,8 @@ import {
 	tagCodeArtifacts,
 } from "@fluidframework/telemetry-utils/internal";
 import { v4 as uuid } from "uuid";
+import { toDeltaManagerInternal } from "@fluidframework/runtime-utils/internal";
+import type { IDeltaManager } from "@fluidframework/container-definitions/internal";
 
 import { SharedObjectHandle } from "./handle.js";
 import { FluidSerializer, IFluidSerializer } from "./serializer.js";
@@ -61,7 +70,7 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
 	/**
 	 * The handle referring to this SharedObject
 	 */
-	public readonly handle: IFluidHandle;
+	public readonly handle: IFluidHandleInternal;
 
 	/**
 	 * Telemetry logger for the shared object
@@ -129,6 +138,13 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
 		[this.opProcessingHelper, this.callbacksHelper] = this.setUpSampledTelemetryHelpers();
 	}
 
+	/**
+	 * Accessor for `this.runtime`'s {@link @fluidframework/datastore-definitions#IFluidDataStoreRuntime.deltaManager} as a {@link @fluidframework/container-definitions/internal#IDeltaManager}
+	 */
+	protected get deltaManager(): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage> {
+		return toDeltaManagerInternal(this.runtime.deltaManager);
+	}
+
 	/**
 	 * This function is only supposed to be called from SharedObjectCore's constructor and
 	 * depends on a few things being set already. assert() calls make sure of it.
@@ -585,19 +601,7 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
 	 */
 	public emit(event: EventEmitterEventType, ...args: any[]): boolean {
 		return this.callbacksHelper.measure(() => {
-			// Creating ops while handling a DDS event can lead
-			// to undefined behavior and events observed in the wrong order.
-			// For example, we have two callbacks registered for a DDS, A and B.
-			// Then if on change #1 callback A creates change #2, the invocation flow will be:
-			//
-			// A because of #1
-			// A because of #2
-			// B because of #2
-			// B because of #1
-			//
-			// The runtime must enforce op coherence by not allowing any ops to be created during
-			// the event handler
-			return this.runtime.ensureNoDataModelChanges(() => super.emit(event, ...args));
+			return super.emit(event, ...args);
 		});
 	}
 
@@ -794,12 +798,6 @@ export interface ISharedObjectKind<TSharedObject> {
 	 * - {@link @fluidframework/fluid-static#IFluidContainer.create} if using `@fluidframework/fluid-static`, for example via `@fluidframework/azure-client`.
 	 *
 	 * - {@link ISharedObjectKind.create} if using a custom container definitions (and thus not using {@link @fluidframework/fluid-static#IFluidContainer}).
-	 *
-	 * @privateRemarks
-	 * TODO:
-	 * Many tests use this and can't use {@link ISharedObjectKind.create}.
-	 * The docs should make it clear why that's ok, and why {@link ISharedObjectKind.create} isn't in such a way that when reading non app code (like tests in this package)
-	 * someone can tell if the wrong one is being used without running it and seeing if it works.
 	 */
 	getFactory(): IChannelFactory<TSharedObject>;
 
@@ -816,14 +814,29 @@ export interface ISharedObjectKind<TSharedObject> {
 	 * const myTree = SharedTree.create(this.runtime, id);
 	 * ```
 	 * @remarks
+	 * The created object is local (detached): insert a handle to it into an attached object to share (attach) it.
 	 * If using `@fluidframework/fluid-static` (for example via `@fluidframework/azure-client`), use {@link @fluidframework/fluid-static#IFluidContainer.create} instead of calling this directly.
 	 *
 	 * @privateRemarks
-	 * TODO:
-	 * This returns null when used with MockFluidDataStoreRuntime, so its unclear how tests should create DDS instances unless using `RootDataObject.create` (which most tests shouldn't to minimize dependencies).
-	 * In practice tests either avoid mock runtimes, use getFactory(), or call the DDS constructor directly. It is unclear (from docs) how getFactory().create differs but it does not rely on runtime.createChannel so it works with mock runtimes.
-	 * TODO:
-	 * See note on ISharedObjectKind.getFactory.
+	 * This can only be used with a `MockFluidDataStoreRuntime` when that mock is created with a `registry` containing a factory for this shared object.
 	 */
 	create(runtime: IFluidDataStoreRuntime, id?: string): TSharedObject;
 }
+
+/**
+ * Utility for creating ISharedObjectKind instances.
+ * @internal
+ */
+export function createSharedObjectKind<TSharedObject>(
+	factory: (new () => IChannelFactory<TSharedObject>) & { Type: string },
+): ISharedObjectKind<TSharedObject> {
+	return {
+		getFactory(): IChannelFactory<TSharedObject> {
+			return new factory();
+		},
+
+		create(runtime: IFluidDataStoreRuntime, id?: string): TSharedObject {
+			return runtime.createChannel(id, factory.Type) as TSharedObject;
+		},
+	};
+}

package/src/summarySerializer.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { type IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
 
 import { FluidSerializer } from "./serializer.js";
 
@@ -17,7 +17,7 @@ export class SummarySerializer extends FluidSerializer {
 		return Array.from(this.serializedRoutes);
 	}
 
-	protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {
+	protected serializeHandle(handle: IFluidHandleInternal, bind: IFluidHandleInternal) {
 		this.serializedRoutes.add(handle.absolutePath);
 		return super.serializeHandle(handle, bind);
 	}