refactor(experimental): Add missing function return types (#26006)

In preparation for globally enabling an eslint rule that will require
them.

Author: Josmithr

experimental/dds/ot/ot/src/ot.ts

@@ -67,7 +67,7 @@ export abstract class SharedOT<TState, TOp> extends SharedObject {
 		this.global = this.local = initialValue;
 	}
 
-	protected apply(op: TOp) {
+	protected apply(op: TOp): void {
 		this.local = this.applyCore(this.state, op);
 
 		// If we are not attached, don't submit the op.
@@ -105,7 +105,7 @@ export abstract class SharedOT<TState, TOp> extends SharedObject {
 		this.global = this.local = this.serializer.parse(rawContent) as TState;
 	}
 
-	protected onDisconnect() {}
+	protected onDisconnect(): void {}
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processMessagesCore}
@@ -121,7 +121,7 @@ export abstract class SharedOT<TState, TOp> extends SharedObject {
 		messageEnvelope: ISequencedMessageEnvelope,
 		messagesContent: IRuntimeMessagesContent,
 		local: boolean,
-	) {
+	): void {
 		// Discard any sequenced ops that are now below the minimum sequence number.
 		const minSeq = this.deltaManager.minimumSequenceNumber;
 		while (this.sequencedOps[0]?.seq < minSeq) {
@@ -171,7 +171,7 @@ export abstract class SharedOT<TState, TOp> extends SharedObject {
 		}
 	}
 
-	protected get state() {
+	protected get state(): TState {
 		// If the locally cached state is dirty, reset it to the global state and reapply our
 		// pending ops to bring it up to date.
 		if (this.localDirty) {

experimental/dds/ot/ot/src/test/delta.ts

@@ -18,7 +18,7 @@ export class SharedDelta extends SharedOT<Delta, Delta> {
 		return runtime.createChannel(id, DeltaFactory.Type) as SharedDelta;
 	}
 
-	public static getFactory() {
+	public static getFactory(): DeltaFactory {
 		return new DeltaFactory();
 	}
 
@@ -30,14 +30,14 @@ export class SharedDelta extends SharedOT<Delta, Delta> {
 		return this.state;
 	}
 
-	public get text() {
+	public get text(): string {
 		return this.state.reduce((s, delta) => {
 			// eslint-disable-next-line @typescript-eslint/no-base-to-string
 			return `${s}${delta.insert?.toString()}`;
 		}, "");
 	}
 
-	public get length() {
+	public get length(): number {
 		return this.text.length;
 	}
 
@@ -49,11 +49,11 @@ export class SharedDelta extends SharedOT<Delta, Delta> {
 		return state.compose(op);
 	}
 
-	public insert(position: number, text: string) {
+	public insert(position: number, text: string): void {
 		this.apply(new Delta().retain(position).insert(text));
 	}
 
-	public delete(start: number, end: number) {
+	public delete(start: number, end: number): void {
 		this.apply(new Delta().retain(start).delete(end - start));
 	}
 }
@@ -67,10 +67,10 @@ export class DeltaFactory implements IChannelFactory {
 		packageVersion: "test",
 	};
 
-	public get type() {
+	public get type(): string {
 		return DeltaFactory.Type;
 	}
-	public get attributes() {
+	public get attributes(): IChannelAttributes {
 		return DeltaFactory.Attributes;
 	}
 
@@ -82,13 +82,13 @@ export class DeltaFactory implements IChannelFactory {
 		id: string,
 		services: IChannelServices,
 		attributes: IChannelAttributes,
-	) {
+	): Promise<SharedDelta> {
 		const instance = new SharedDelta(id, runtime, attributes);
 		await instance.load(services);
 		return instance;
 	}
 
-	public create(runtime: IFluidDataStoreRuntime, id: string) {
+	public create(runtime: IFluidDataStoreRuntime, id: string): SharedDelta {
 		const instance = new SharedDelta(id, runtime, this.attributes);
 		instance.initializeLocal();
 		return instance;

experimental/dds/ot/ot/src/test/ot.spec.ts

@@ -13,12 +13,15 @@ import {
 
 import { DeltaFactory, SharedDelta } from "./delta.js";
 
-const createLocalOT = (id: string) => {
+const createLocalOT = (id: string): SharedDelta => {
 	const factory = SharedDelta.getFactory();
 	return factory.create(new MockFluidDataStoreRuntime(), id);
 };
 
-function createConnectedOT(id: string, runtimeFactory: MockContainerRuntimeFactory) {
+function createConnectedOT(
+	id: string,
+	runtimeFactory: MockContainerRuntimeFactory,
+): SharedDelta {
 	// Create and connect a second SharedCell.
 	const dataStoreRuntime = new MockFluidDataStoreRuntime();
 	runtimeFactory.createContainerRuntime(dataStoreRuntime);
@@ -40,7 +43,7 @@ describe("SharedDelta", () => {
 			delta = createLocalOT("OT");
 		});
 
-		const expect = (expected: string) => {
+		const expect = (expected: string): void => {
 			assert.deepEqual(delta.text, expected);
 		};
 
@@ -115,7 +118,7 @@ describe("SharedDelta", () => {
 				expect();
 			});
 
-			const expect = (expected?: string) => {
+			const expect = (expected?: string): void => {
 				containerRuntimeFactory.processAllMessages();
 
 				const actual1 = doc1.text;

experimental/dds/ot/ot/src/test/ot.stress.spec.ts

@@ -23,14 +23,14 @@ describe("SharedOT", () => {
 		let runtimes: MockContainerRuntimeForReconnection[] = [];
 		let trace: string[]; // Repro steps to be printed if a failure is encountered.
 
-		const extract = (doc: SharedDelta) => {
+		const extract = (doc: SharedDelta): string => {
 			return doc.text;
 		};
 
 		/**
 		 * Drains the queue of pending ops for each client and vets that all docs converged on the same state.
 		 */
-		const expect = async () => {
+		const expect = async (): Promise<void> => {
 			// Reconnect any disconnected clients before processing pending ops.
 			{
 				for (let i = 0; i < runtimes.length; i++) {
@@ -76,7 +76,7 @@ describe("SharedOT", () => {
 			syncProbability: number,
 			disconnectProbability: number,
 			seed: number,
-		) {
+		): Promise<void> {
 			try {
 				docs = [];
 				runtimes = [];
@@ -108,11 +108,10 @@ describe("SharedOT", () => {
 
 				// Returns a pseudorandom 32b integer in the range [0 .. max).
 				// eslint-disable-next-line no-bitwise
-				const int32 = (max = 0x7fffffff) => (float64() * max) | 0;
+				const int32 = (max = 0x7fffffff): number => (float64() * max) | 0;
+				const randomText = (): string => `${float64().toString(36).substr(0, int32(12))}`;
 
-				const randomText = () => `${float64().toString(36).substr(0, int32(12))}`;
-
-				const insert = (docIndex: number, position: number, text: string) => {
+				const insert = (docIndex: number, position: number, text: string): void => {
 					trace?.push(
 						`doc${
 							docIndex + 1
@@ -121,7 +120,7 @@ describe("SharedOT", () => {
 					docs[docIndex].insert(position, text);
 				};
 
-				const del = (docIndex: number, start: number, end: number) => {
+				const del = (docIndex: number, start: number, end: number): void => {
 					trace?.push(`doc${docIndex + 1}.delete(/* start: */ ${start}, /* end: */ ${end});`);
 					docs[docIndex].delete(start, end);
 				};

experimental/dds/ot/sharejs/json1/src/factory.ts

@@ -26,10 +26,10 @@ export class Json1Factory implements IChannelFactory {
 		packageVersion: pkgVersion,
 	};
 
-	public get type() {
+	public get type(): string {
 		return Json1Factory.Type;
 	}
-	public get attributes() {
+	public get attributes(): IChannelAttributes {
 		return Json1Factory.Attributes;
 	}
 

experimental/dds/ot/sharejs/json1/src/json1.ts

@@ -30,7 +30,7 @@ export class SharedJson1 extends SharedOT<Doc, JSONOp> {
 		return runtime.createChannel(id, Json1Factory.Type) as SharedJson1;
 	}
 
-	public static getFactory() {
+	public static getFactory(): Json1Factory {
 		return new Json1Factory();
 	}
 
@@ -43,31 +43,35 @@ export class SharedJson1 extends SharedOT<Doc, JSONOp> {
 		return this.state;
 	}
 
-	public apply(op: JSONOp) {
+	public apply(op: JSONOp): void {
 		super.apply(op);
 	}
 
 	protected transform(input: JSONOp, transform: JSONOp): JSONOp {
 		return Json1OTType.transformNoConflict(input, transform, "left");
 	}
 
-	protected applyCore(state: Doc, op: JSONOp) {
+	protected applyCore(state: Doc, op: JSONOp): Doc {
 		return Json1OTType.apply(state, op) as Doc;
 	}
 
-	public insert<T>(path: Path, value: Serializable<T>) {
+	public insert<T>(path: Path, value: Serializable<T>): void {
 		this.apply(insertOp(path, value as Doc));
 	}
 
-	public move(from: Path, to: Path) {
+	public move(from: Path, to: Path): void {
 		this.apply(moveOp(from, to));
 	}
 
-	public remove(path: Path, value?: boolean) {
+	public remove(path: Path, value?: boolean): void {
 		this.apply(removeOp(path, value));
 	}
 
-	public replace<T, U>(path: Path, oldValue: Serializable<T>, newValue: Serializable<U>) {
+	public replace<T, U>(
+		path: Path,
+		oldValue: Serializable<T>,
+		newValue: Serializable<U>,
+	): void {
 		this.apply(replaceOp(path, oldValue as Doc, newValue as Doc));
 	}
 }

experimental/dds/ot/sharejs/json1/src/test/json1.spec.ts

@@ -14,12 +14,15 @@ import {
 
 import { Json1Factory, SharedJson1 } from "../index.js";
 
-const createLocalOT = (id: string) => {
+const createLocalOT = (id: string): SharedJson1 => {
 	const factory = SharedJson1.getFactory();
 	return factory.create(new MockFluidDataStoreRuntime(), id) as SharedJson1;
 };
 
-function createConnectedOT(id: string, runtimeFactory: MockContainerRuntimeFactory) {
+function createConnectedOT(
+	id: string,
+	runtimeFactory: MockContainerRuntimeFactory,
+): SharedJson1 {
 	// Create and connect a second SharedCell.
 	const dataStoreRuntime = new MockFluidDataStoreRuntime();
 	runtimeFactory.createContainerRuntime(dataStoreRuntime);
@@ -47,7 +50,7 @@ describe("SharedJson1", () => {
 			ot.replace([], null, {});
 		});
 
-		const expect = <T>(expected: Jsonable<T>) => {
+		const expect = <T>(expected: Jsonable<T>): void => {
 			assert.deepEqual(ot.get(), expected);
 		};
 
@@ -122,7 +125,7 @@ describe("SharedJson1", () => {
 				expect([]);
 			});
 
-			const expect = <T>(expected?: Jsonable<T>) => {
+			const expect = <T>(expected?: Jsonable<T>): void => {
 				containerRuntimeFactory.processAllMessages();
 
 				const actual1 = doc1.get();

experimental/dds/sequence-deprecated/src/sequenceFactory.ts

@@ -59,15 +59,15 @@ export class SharedObjectSequenceFactory implements IChannelFactory {
 	 * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
 	 * For more info, please see {@link https://github.com/microsoft/FluidFramework/issues/8526 | Github issue 8526}
 	 */
-	public get type() {
+	public get type(): string {
 		return SharedObjectSequenceFactory.Type;
 	}
 
 	/**
 	 * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
 	 * For more info, please see {@link https://github.com/microsoft/FluidFramework/issues/8526 | Github issue 8526}
 	 */
-	public get attributes() {
+	public get attributes(): IChannelAttributes {
 		return SharedObjectSequenceFactory.Attributes;
 	}
 
@@ -138,15 +138,15 @@ export class SharedNumberSequenceFactory implements IChannelFactory {
 	 * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
 	 * For more info, please see {@link https://github.com/microsoft/FluidFramework/issues/8526 | Github issue 8526}
 	 */
-	public get type() {
+	public get type(): string {
 		return SharedNumberSequenceFactory.Type;
 	}
 
 	/**
 	 * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
 	 * For more info, please see {@link https://github.com/microsoft/FluidFramework/issues/8526 | Github issue 8526}
 	 */
-	public get attributes() {
+	public get attributes(): IChannelAttributes {
 		return SharedNumberSequenceFactory.Attributes;
 	}
 

experimental/dds/sequence-deprecated/src/sharedNumberSequence.ts

@@ -44,7 +44,7 @@ export class SharedNumberSequenceClass extends SharedSequence<number> {
 	 * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
 	 * For more info, please see {@link https://github.com/microsoft/FluidFramework/issues/8526 | Github issue 8526}.
 	 */
-	public getRange(start: number, end?: number) {
+	public getRange(start: number, end?: number): number[] {
 		return this.getItems(start, end);
 	}
 }