@fluidframework/shared-object-base 2.10.0 → 2.12.0

package/src/remoteObjectHandle.ts

@@ -20,10 +20,6 @@ import { FluidHandleBase, responseToException } from "@fluidframework/runtime-ut
  * IFluidHandle can be retrieved by calling `get` on it.
  */
 export class RemoteFluidObjectHandle extends FluidHandleBase<FluidObject> {
-	public get IFluidHandleContext() {
-		return this;
-	}
-
 	public readonly isAttached = true;
 	private objectP: Promise<FluidObject> | undefined;
 
@@ -52,7 +48,7 @@ export class RemoteFluidObjectHandle extends FluidHandleBase<FluidObject> {
 			};
 			this.objectP = this.routeContext.resolveHandle(request).then<FluidObject>((response) => {
 				if (response.mimeType === "fluid/object") {
-					const fluidObject: FluidObject = response.value;
+					const fluidObject: FluidObject = response.value as FluidObject;
 					return fluidObject;
 				}
 				throw responseToException(response, request);

package/src/serializer.ts

@@ -3,19 +3,18 @@
  * Licensed under the MIT License.
  */
 
-// RATIONALE: Many methods consume and return 'any' by necessity.
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 import {
 	IFluidHandleContext,
 	type IFluidHandleInternal,
 } from "@fluidframework/core-interfaces/internal";
+import { assert } from "@fluidframework/core-utils/internal";
 import {
 	generateHandleContextPath,
 	isSerializedHandle,
 	isFluidHandle,
 	toFluidHandleInternal,
+	type ISerializedHandle,
 } from "@fluidframework/runtime-utils/internal";
 
 import { RemoteFluidObjectHandle } from "./remoteObjectHandle.js";
@@ -32,6 +31,7 @@ export interface IFluidSerializer {
 	 * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
 	 * the root to any replaced handles.  (If no handles are found, returns the original object.)
 	 */
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
 	encode(value: any, bind: IFluidHandle): any;
 
 	/**
@@ -43,17 +43,20 @@ export interface IFluidSerializer {
 	 *
 	 * The decoded handles are implicitly bound to the handle context of this serializer.
 	 */
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
 	decode(input: any): any;
 
 	/**
 	 * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
 	 */
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
 	stringify(value: any, bind: IFluidHandle): string;
 
 	/**
 	 * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid
 	 * handles will be realized as part of the parse
 	 */
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
 	parse(value: string): any;
 }
 
@@ -71,7 +74,7 @@ export class FluidSerializer implements IFluidSerializer {
 		}
 	}
 
-	public get IFluidSerializer() {
+	public get IFluidSerializer(): IFluidSerializer {
 		return this;
 	}
 
@@ -84,12 +87,14 @@ export class FluidSerializer implements IFluidSerializer {
 	 *
 	 * Any unbound handles encountered are bound to the provided IFluidHandle.
 	 */
-	public encode(input: any, bind: IFluidHandle) {
+	// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any -- TODO: AB#26129 ddsFuzzHarness breaks when we update any->unknown
+	public encode(input: any, bind: IFluidHandleInternal): any {
 		// If the given 'input' cannot contain handles, return it immediately.  Otherwise,
 		// return the result of 'recursivelyReplace()'.
 		// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
 		return !!input && typeof input === "object"
-			? this.recursivelyReplace(input, this.encodeValue, bind)
+			? // eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- TODO: AB#26129 ddsFuzzHarness breaks when we update any->unknown
+				this.recursivelyReplace(input, this.encodeValue, bind)
 			: input;
 	}
 
@@ -102,7 +107,8 @@ export class FluidSerializer implements IFluidSerializer {
 	 *
 	 * The decoded handles are implicitly bound to the handle context of this serializer.
 	 */
-	public decode(input: any) {
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 ddsFuzzHarness breaks when we update any->unknown
+	public decode(input: unknown): any {
 		// If the given 'input' cannot contain handles, return it immediately.  Otherwise,
 		// return the result of 'recursivelyReplace()'.
 		// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
@@ -111,28 +117,30 @@ export class FluidSerializer implements IFluidSerializer {
 			: input;
 	}
 
-	public stringify(input: unknown, bind: IFluidHandle) {
+	public stringify(input: unknown, bind: IFluidHandle): string {
 		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
-	public parse(input: string) {
+	public parse(input: string): unknown {
 		return JSON.parse(input, (key, value) => this.decodeValue(value));
 	}
 
 	// 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: unknown, bind: IFluidHandleInternal) => {
+	private readonly encodeValue = (value: unknown, bind?: IFluidHandleInternal): unknown => {
 		// If 'value' is an IFluidHandle return its encoded form.
-		return isFluidHandle(value)
-			? this.serializeHandle(toFluidHandleInternal(value), bind)
-			: value;
+		if (isFluidHandle(value)) {
+			assert(bind !== undefined, 0xa93 /* Cannot encode a handle without a bind context */);
+			return this.serializeHandle(toFluidHandleInternal(value), bind);
+		}
+		return value;
 	};
 
 	// If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.
 	// Otherwise returns the original 'value'.  Used by 'decode()' and 'parse()'.
-	private readonly decodeValue = (value: any) => {
+	private readonly decodeValue = (value: unknown): unknown => {
 		// If 'value' is a serialized IFluidHandle return the deserialized result.
 		if (isSerializedHandle(value)) {
 			// Old documents may have handles with relative path in their summaries. Convert these to absolute
@@ -150,11 +158,11 @@ export class FluidSerializer implements IFluidSerializer {
 	// Invoked for non-null objects to recursively replace references to IFluidHandles.
 	// Clones as-needed to avoid mutating the `input` object.  If no IFluidHandes are present,
 	// returns the original `input`.
-	private recursivelyReplace(
-		input: any,
-		replacer: (input: any, context: any) => any,
-		context?: any,
-	) {
+	private recursivelyReplace<TContext = unknown>(
+		input: object,
+		replacer: (input: unknown, context?: TContext) => unknown,
+		context?: TContext,
+	): unknown {
 		// Note: Caller is responsible for ensuring that `input` is defined / non-null.
 		//       (Required for Object.keys() below.)
 
@@ -171,7 +179,7 @@ export class FluidSerializer implements IFluidSerializer {
 		// Otherwise descend into the object graph looking for IFluidHandle instances.
 		let clone: object | undefined;
 		for (const key of Object.keys(input)) {
-			const value = input[key];
+			const value: unknown = input[key];
 			// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
 			if (!!value && typeof value === "object") {
 				// Note: Except for IFluidHandle, `input` must not contain circular references (as object must
@@ -184,18 +192,21 @@ export class FluidSerializer implements IFluidSerializer {
 				// current property is replaced by the `replaced` value.
 				if (replaced !== value) {
 					// Lazily create a shallow clone of the `input` object if we haven't done so already.
+					// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- TODO: not sure if there's a good solution
 					clone = clone ?? (Array.isArray(input) ? [...input] : { ...input });
 
 					// Overwrite the current property `key` in the clone with the `replaced` value.
-					// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-					clone![key] = replaced;
+					clone[key] = replaced;
 				}
 			}
 		}
 		return clone ?? input;
 	}
 
-	protected serializeHandle(handle: IFluidHandleInternal, bind: IFluidHandleInternal) {
+	protected serializeHandle(
+		handle: IFluidHandleInternal,
+		bind: IFluidHandleInternal,
+	): ISerializedHandle {
 		bind.bind(handle);
 		return {
 			type: "__fluid_handle__",

package/src/sharedObject.ts

@@ -48,6 +48,7 @@ import {
 	loggerToMonitoringContext,
 	tagCodeArtifacts,
 	type ICustomData,
+	type IFluidErrorBase,
 } from "@fluidframework/telemetry-utils/internal";
 import { v4 as uuid } from "uuid";
 
@@ -77,7 +78,7 @@ export abstract class SharedObjectCore<
 	extends EventEmitterWithErrorHandling<TEvent>
 	implements ISharedObject<TEvent>
 {
-	public get IFluidLoadable() {
+	public get IFluidLoadable(): this {
 		return this;
 	}
 
@@ -136,7 +137,9 @@ export abstract class SharedObjectCore<
 		protected runtime: IFluidDataStoreRuntime,
 		public readonly attributes: IChannelAttributes,
 	) {
-		super((event: EventEmitterEventType, e: any) => this.eventListenerErrorHandler(event, e));
+		super((event: EventEmitterEventType, e: unknown) =>
+			this.eventListenerErrorHandler(event, e),
+		);
 
 		assert(!id.includes("/"), 0x304 /* Id cannot contain slashes */);
 
@@ -217,7 +220,7 @@ export abstract class SharedObjectCore<
 	 * would result in same error thrown. If called multiple times, only first error is remembered.
 	 * @param error - error object that is thrown whenever an attempt is made to modify this object
 	 */
-	private closeWithError(error: any) {
+	private closeWithError(error: IFluidErrorBase | undefined): void {
 		if (this.closeError === undefined) {
 			this.closeError = error;
 		}
@@ -226,7 +229,7 @@ export abstract class SharedObjectCore<
 	/**
 	 * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.
 	 */
-	private verifyNotClosed() {
+	private verifyNotClosed(): void {
 		if (this.closeError !== undefined) {
 			throw this.closeError;
 		}
@@ -242,7 +245,7 @@ export abstract class SharedObjectCore<
 	 * DDS state does not match what user sees. Because of it DDS moves to "corrupted state" and does not
 	 * allow processing of ops or local changes, which very quickly results in container closure.
 	 */
-	private eventListenerErrorHandler(event: EventEmitterEventType, e: any) {
+	private eventListenerErrorHandler(event: EventEmitterEventType, e: unknown): void {
 		const error = DataProcessingError.wrapIfUnrecognized(
 			e,
 			"SharedObjectEventListenerException",
@@ -253,13 +256,14 @@ export abstract class SharedObjectCore<
 		throw error;
 	}
 
-	private setBoundAndHandleAttach() {
+	private setBoundAndHandleAttach(): void {
 		// Ensure didAttach is only called once, and we only register a single event
 		// but we still call setConnectionState as our existing mocks don't
 		// always propagate connection state
 		this.setBoundAndHandleAttach = () => this.setConnectionState(this.runtime.connected);
 		this._isBoundToContext = true;
-		const runDidAttach = () => {
+		// eslint-disable-next-line unicorn/consistent-function-scoping
+		const runDidAttach: () => void = () => {
 			// Allows objects to do any custom processing if it is attached.
 			this.didAttach();
 			this.setConnectionState(this.runtime.connected);
@@ -312,7 +316,7 @@ export abstract class SharedObjectCore<
 	/**
 	 * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).connect}
 	 */
-	public connect(services: IChannelServices) {
+	public connect(services: IChannelServices): void {
 		// handle the case where load is called
 		// before connect; loading detached data stores
 		if (this.services === undefined) {
@@ -362,7 +366,7 @@ export abstract class SharedObjectCore<
 	/**
 	 * Allows the distributed data type to perform custom local loading.
 	 */
-	protected initializeLocalCore() {
+	protected initializeLocalCore(): void {
 		return;
 	}
 
@@ -370,7 +374,7 @@ export abstract class SharedObjectCore<
 	 * Allows the distributive data type the ability to perform custom processing once an attach has happened.
 	 * Also called after non-local data type get loaded.
 	 */
-	protected didAttach() {
+	protected didAttach(): void {
 		return;
 	}
 
@@ -385,12 +389,15 @@ export abstract class SharedObjectCore<
 		message: ISequencedDocumentMessage,
 		local: boolean,
 		localOpMetadata: unknown,
-	);
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 use void instead of any (legacy breaking)
+	): any;
 
 	/**
 	 * Called when the object has disconnected from the delta stream.
 	 */
-	protected abstract onDisconnect();
+
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 change return type to void (legacy breaking)
+	protected abstract onDisconnect(): any;
 
 	/**
 	 * The serializer to serialize / parse handles.
@@ -405,6 +412,7 @@ export abstract class SharedObjectCore<
 	 * and not sent to the server. This will be sent back when this message is received back from the server. This is
 	 * also sent if we are asked to resubmit the message.
 	 */
+	// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
 	protected submitLocalMessage(content: any, localOpMetadata: unknown = undefined): void {
 		this.verifyNotClosed();
 		if (this.isAttached()) {
@@ -433,7 +441,7 @@ export abstract class SharedObjectCore<
 	 * Called when the object has fully connected to the delta stream
 	 * Default implementation for DDS, override if different behavior is required.
 	 */
-	protected onConnect() {}
+	protected onConnect(): void {}
 
 	/**
 	 * Called when a message has to be resubmitted. This typically happens after a reconnection for unacked messages.
@@ -443,7 +451,8 @@ export abstract class SharedObjectCore<
 	 * @param content - The content of the original message.
 	 * @param localOpMetadata - The local metadata associated with the original message.
 	 */
-	protected reSubmitCore(content: any, localOpMetadata: unknown) {
+	// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
+	protected reSubmitCore(content: any, localOpMetadata: unknown): void {
 		this.submitLocalMessage(content, localOpMetadata);
 	}
 
@@ -456,6 +465,7 @@ export abstract class SharedObjectCore<
 	protected async newAckBasedPromise<T>(
 		executor: (
 			resolve: (value: T | PromiseLike<T>) => void,
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
 			reject: (reason?: any) => void,
 		) => void,
 	): Promise<T> {
@@ -479,7 +489,7 @@ export abstract class SharedObjectCore<
 		});
 	}
 
-	private attachDeltaHandler() {
+	private attachDeltaHandler(): void {
 		// Services should already be there in case we are attaching delta handler.
 		assert(
 			this.services !== undefined,
@@ -504,13 +514,13 @@ export abstract class SharedObjectCore<
 			setConnectionState: (connected: boolean) => {
 				this.setConnectionState(connected);
 			},
-			reSubmit: (content: any, localOpMetadata: unknown) => {
+			reSubmit: (content: unknown, localOpMetadata: unknown) => {
 				this.reSubmit(content, localOpMetadata);
 			},
-			applyStashedOp: (content: any): void => {
+			applyStashedOp: (content: unknown): void => {
 				this.applyStashedOp(parseHandles(content, this.serializer));
 			},
-			rollback: (content: any, localOpMetadata: unknown) => {
+			rollback: (content: unknown, localOpMetadata: unknown) => {
 				this.rollback(content, localOpMetadata);
 			},
 		} satisfies IDeltaHandler);
@@ -520,7 +530,7 @@ export abstract class SharedObjectCore<
 	 * Set the state of connection to services.
 	 * @param connected - true if connected, false otherwise.
 	 */
-	private setConnectionState(connected: boolean) {
+	private setConnectionState(connected: boolean): void {
 		// only an attached shared object can transition its
 		// connected state. This is defensive, as some
 		// of our test harnesses don't handle this correctly
@@ -532,17 +542,17 @@ export abstract class SharedObjectCore<
 		// Should I change the state at the end? So that we *can't* send new stuff before we send old?
 		this._connected = connected;
 
-		if (!connected) {
+		if (connected) {
+			// Call this for now so that DDSes like ConsensusOrderedCollection that maintain their own pending
+			// messages will work.
+			this.onConnect();
+		} else {
 			// Things that are true now...
 			// - if we had a connection we can no longer send messages over it
 			// - if we had outbound messages some may or may not be ACK'd. Won't know until next message
 			//
 			// - nack could get a new msn - but might as well do it in the join?
 			this.onDisconnect();
-		} else {
-			// Call this for now so that DDSes like ConsensusOrderedCollection that maintain their own pending
-			// messages will work.
-			this.onConnect();
 		}
 	}
 
@@ -557,7 +567,7 @@ export abstract class SharedObjectCore<
 		message: ISequencedDocumentMessage,
 		local: boolean,
 		localOpMetadata: unknown,
-	) {
+	): void {
 		this.verifyNotClosed(); // This will result in container closure.
 		this.emitInternal("pre-op", message, local, this);
 
@@ -581,7 +591,7 @@ export abstract class SharedObjectCore<
 	 * Process messages for this shared object. The messages here are contiguous messages for this object in a batch.
 	 * @param messageCollection - The collection of messages to process.
 	 */
-	private processMessages(messagesCollection: IRuntimeMessageCollection) {
+	private processMessages(messagesCollection: IRuntimeMessageCollection): void {
 		const { envelope, messagesContent, local } = messagesCollection;
 		for (const { contents, localOpMetadata, clientSequenceNumber } of messagesContent) {
 			this.process(
@@ -602,14 +612,15 @@ export abstract class SharedObjectCore<
 	 * @param content - The content of the original message.
 	 * @param localOpMetadata - The local metadata associated with the original message.
 	 */
-	private reSubmit(content: any, localOpMetadata: unknown) {
+	private reSubmit(content: unknown, localOpMetadata: unknown): void {
 		this.reSubmitCore(content, localOpMetadata);
 	}
 
 	/**
 	 * Revert an op
 	 */
-	protected rollback(content: any, localOpMetadata: unknown) {
+	// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
+	protected rollback(content: any, localOpMetadata: unknown): void {
 		throw new Error("rollback not supported");
 	}
 
@@ -630,6 +641,7 @@ export abstract class SharedObjectCore<
 	 *
 	 * @param content - Contents of a stashed op.
 	 */
+	// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
 	protected abstract applyStashedOp(content: any): void;
 
 	/**
@@ -644,6 +656,7 @@ export abstract class SharedObjectCore<
 	 */
 	public emit(event: EventEmitterEventType, ...args: any[]): boolean {
 		return this.callbacksHelper.measure(() => {
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
 			return super.emit(event, ...args);
 		});
 	}
@@ -655,7 +668,7 @@ export abstract class SharedObjectCore<
 	 * @param args - Arguments for the event
 	 * @returns Whatever `super.emit()` returns.
 	 */
-	private emitInternal(event: EventEmitterEventType, ...args: any[]): boolean {
+	private emitInternal(event: EventEmitterEventType, ...args: unknown[]): boolean {
 		return super.emit(event, ...args);
 	}
 }
@@ -793,7 +806,7 @@ export abstract class SharedObject<
 	 * Calls the serializer over all data in this object that reference other GC nodes.
 	 * Derived classes must override this to provide custom list of references to other GC nodes.
 	 */
-	protected processGCDataCore(serializer: IFluidSerializer) {
+	protected processGCDataCore(serializer: IFluidSerializer): void {
 		// We run the full summarize logic to get the list of outbound routes from this object. This is a little
 		// expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.
 		// See: https://github.com/microsoft/FluidFramework/issues/4547
@@ -814,7 +827,7 @@ export abstract class SharedObject<
 		propertyName: string,
 		incrementBy: number,
 		telemetryContext?: ITelemetryContext,
-	) {
+	): void {
 		if (telemetryContext !== undefined) {
 			// TelemetryContext needs to implment a get function
 			assert(

package/src/summarySerializer.ts

@@ -4,6 +4,7 @@
  */
 
 import { type IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
+import type { ISerializedHandle } from "@fluidframework/runtime-utils/internal";
 
 import { FluidSerializer } from "./serializer.js";
 
@@ -14,10 +15,13 @@ import { FluidSerializer } from "./serializer.js";
 export class SummarySerializer extends FluidSerializer {
 	private readonly serializedRoutes: Set<string> = new Set();
 	public getSerializedRoutes(): string[] {
-		return Array.from(this.serializedRoutes);
+		return [...this.serializedRoutes];
 	}
 
-	protected serializeHandle(handle: IFluidHandleInternal, bind: IFluidHandleInternal) {
+	protected serializeHandle(
+		handle: IFluidHandleInternal,
+		bind: IFluidHandleInternal,
+	): ISerializedHandle {
 		this.serializedRoutes.add(handle.absolutePath);
 		return super.serializeHandle(handle, bind);
 	}

package/src/utils.ts

@@ -20,12 +20,11 @@ import { IFluidSerializer } from "./serializer.js";
  * @internal
  */
 export function serializeHandles(
-	value: any,
+	value: unknown,
 	serializer: IFluidSerializer,
 	bind: IFluidHandle,
 ): string | undefined {
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
-	return value !== undefined ? serializer.stringify(value, bind) : value;
+	return value === undefined ? value : serializer.stringify(value, bind);
 }
 
 /**
@@ -43,11 +42,11 @@ export function serializeHandles(
  * @alpha
  */
 export function makeHandlesSerializable(
-	value: any,
+	value: unknown,
 	serializer: IFluidSerializer,
 	bind: IFluidHandle,
-) {
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
+): any {
 	return serializer.encode(value, bind);
 }
 
@@ -62,8 +61,8 @@ export function makeHandlesSerializable(
  * @legacy
  * @alpha
  */
-export function parseHandles(value: any, serializer: IFluidSerializer) {
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO: AB#26129 use unknown instead of any (legacy breaking)
+export function parseHandles(value: unknown, serializer: IFluidSerializer): any {
 	return serializer.decode(value);
 }
 
@@ -89,7 +88,7 @@ export function createSingleBlobSummary(
  * @internal
  */
 export function bindHandles(
-	value: any,
+	value: unknown,
 	serializer: IFluidSerializer,
 	bind: IFluidHandle,
 ): void {