refactor(client): Add explicit function return types (#26019)

Part of a multi-PR effort in preparation to add global eslint
enforcement

Author: Josmithr

packages/drivers/file-driver/src/fileDocumentDeltaConnection.ts

@@ -54,7 +54,7 @@ export class Replayer {
 		private readonly documentStorageService: FileDeltaStorageService,
 	) {}
 
-	public get currentReplayedOp() {
+	public get currentReplayedOp(): number {
 		return this.currentReplayOp;
 	}
 
@@ -70,7 +70,7 @@ export class Replayer {
 	 * Replay the ops upto a certain number.
 	 * @param replayTo - The last op number to be replayed.
 	 */
-	public replay(replayTo: number) {
+	public replay(replayTo: number): number {
 		let totalReplayedOps = 0;
 		let done: boolean;
 		do {
@@ -94,14 +94,14 @@ export class Replayer {
 		return totalReplayedOps;
 	}
 
-	private isDoneFetch(replayTo: number) {
+	private isDoneFetch(replayTo: number): boolean {
 		if (replayTo >= 0) {
 			return this.currentReplayOp >= replayTo;
 		}
 		return false;
 	}
 
-	private emit(ops: ISequencedDocumentMessage[]) {
+	private emit(ops: ISequencedDocumentMessage[]): void {
 		// Note: do not clone messages here!
 		// If Replay Tool fails due to one container patching message in-place,
 		// then same thing can happen in shipping product due to
@@ -162,7 +162,7 @@ export class ReplayFileDeltaConnection
 		this.replayer = new Replayer(this, documentDeltaStorageService);
 	}
 
-	public getReplayer() {
+	public getReplayer(): Replayer {
 		return this.replayer;
 	}
 
@@ -209,13 +209,13 @@ export class ReplayFileDeltaConnection
 	}
 
 	// eslint-disable-next-line @typescript-eslint/no-misused-promises
-	public async submitSignal(message: any) {}
+	public async submitSignal(message: any): Promise<void> {}
 
 	private _disposed = false;
-	public get disposed() {
+	public get disposed(): boolean {
 		return this._disposed;
 	}
-	public dispose() {
+	public dispose(): void {
 		this._disposed = true;
 	}
 }

packages/drivers/file-driver/src/fileDocumentService.ts

@@ -33,7 +33,7 @@ export class FileDocumentService
 		super();
 	}
 
-	public dispose() {}
+	public dispose(): void {}
 
 	public async connectToStorage(): Promise<IDocumentStorageService> {
 		return this.storage;

packages/drivers/file-driver/src/fileDocumentStorageService.ts

@@ -145,14 +145,16 @@ export type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
 /**
  * @internal
  */
-export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(Base: TBase) =>
+export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(
+	Base: TBase,
+): TBase & (new (...args: any[]) => ISnapshotWriterStorage) =>
 	class extends Base implements ISnapshotWriterStorage {
 		// Note: if variable name has same name as in base class, it overrides it!
 		public blobsWriter = new Map<string, ArrayBufferLike>();
 		public latestWriterTree?: ISnapshotTree;
 		public docId?: string;
 
-		public reset() {
+		public reset(): void {
 			this.blobsWriter = new Map<string, ArrayBufferLike>();
 			this.latestWriterTree = undefined;
 			this.docId = undefined;
@@ -245,7 +247,7 @@ export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(
 		}
 	};
 
-function removeNullTreeIds(tree: ITree) {
+function removeNullTreeIds(tree: ITree): void {
 	for (const node of tree.entries) {
 		if (node.type === TreeEntry.Tree) {
 			removeNullTreeIds(node.value);

packages/drivers/replay-driver/src/replayDocumentDeltaConnection.ts

@@ -21,6 +21,7 @@ import {
 	ScopeType,
 	ISequencedDocumentMessage,
 	ISignalMessage,
+	type ISnapshotTree,
 } from "@fluidframework/driver-definitions/internal";
 
 import { ReplayController } from "./replayController.js";
@@ -54,15 +55,15 @@ export class ReplayControllerStatic extends ReplayController {
 		}
 	}
 
-	public async initStorage(documentService: IDocumentService) {
+	public async initStorage(documentService: IDocumentService): Promise<boolean> {
 		return true;
 	}
 
 	public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
 		return [];
 	}
 
-	public async getSnapshotTree(version?: IVersion) {
+	public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
 		return version ? Promise.reject(new Error("Invalid operation")) : null;
 	}
 
@@ -74,14 +75,14 @@ export class ReplayControllerStatic extends ReplayController {
 		return 0;
 	}
 
-	public fetchTo(currentOp: number) {
+	public fetchTo(currentOp: number): number | undefined {
 		if (!(this.unitIsTime !== true && this.replayTo >= 0)) {
 			return undefined;
 		}
 		return this.replayTo;
 	}
 
-	public isDoneFetch(currentOp: number, lastTimeStamp?: number) {
+	public isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean {
 		if (this.replayTo >= 0) {
 			if (this.unitIsTime === true) {
 				return (
@@ -95,7 +96,7 @@ export class ReplayControllerStatic extends ReplayController {
 		return lastTimeStamp === undefined; // No more ops
 	}
 
-	public skipToIndex(fetchedOps: ISequencedDocumentMessage[]) {
+	public skipToIndex(fetchedOps: ISequencedDocumentMessage[]): number {
 		if (this.replayFrom <= 0) {
 			return 0;
 		}
@@ -123,7 +124,7 @@ export class ReplayControllerStatic extends ReplayController {
 		let current = this.skipToIndex(fetchedOps);
 
 		return new Promise((resolve) => {
-			const replayNextOps = () => {
+			const replayNextOps = (): void => {
 				// Emit the ops from replay to the end every "deltainterval" milliseconds
 				// to simulate the socket stream
 				const currentOp = fetchedOps[current];
@@ -171,7 +172,7 @@ export class ReplayControllerStatic extends ReplayController {
 				scheduleNext(nextInterval);
 				emitter(playbackOps);
 			};
-			const scheduleNext = (nextInterval: number) => {
+			const scheduleNext = (nextInterval: number): void => {
 				if (nextInterval >= 0 && current < fetchedOps.length) {
 					setTimeout(replayNextOps, nextInterval);
 				} else {
@@ -284,13 +285,13 @@ export class ReplayDocumentDeltaConnection
 	}
 
 	// eslint-disable-next-line @typescript-eslint/no-misused-promises
-	public async submitSignal(message: any) {}
+	public async submitSignal(message: unknown): Promise<void> {}
 
 	private _disposed = false;
-	public get disposed() {
+	public get disposed(): boolean {
 		return this._disposed;
 	}
-	public dispose() {
+	public dispose(): void {
 		this._disposed = true;
 	}
 

packages/drivers/replay-driver/src/replayDocumentService.ts

@@ -51,7 +51,7 @@ export class ReplayDocumentService
 		super();
 	}
 
-	public dispose() {}
+	public dispose(): void {}
 
 	// TODO: Issue-2109 Implement detach container api or put appropriate comment.
 	public get resolvedUrl(): IResolvedUrl {

packages/drivers/replay-driver/src/replayDocumentServiceFactory.ts

@@ -25,7 +25,7 @@ export class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
 		from: number,
 		to: number,
 		documentServiceFactory: IDocumentServiceFactory,
-	) {
+	): ReplayDocumentServiceFactory {
 		return new ReplayDocumentServiceFactory(
 			documentServiceFactory,
 			new ReplayControllerStatic(from, to),

packages/drivers/replay-driver/src/storageImplementations.ts

@@ -152,7 +152,7 @@ export class StaticStorageDocumentService
 		super();
 	}
 
-	public dispose() {}
+	public dispose(): void {}
 
 	public async connectToStorage(): Promise<IDocumentStorageService> {
 		return this.storage;

packages/test/local-server-tests/src/test/audience.spec.ts

@@ -44,17 +44,23 @@ describe("Audience correctness", () => {
 	/**
 	 * Function to wait for a client with the given clientId to be added to the audience of the given container.
 	 */
-	async function waitForClientAdd(container: IContainer, clientId: string, errorMsg: string) {
+	async function waitForClientAdd(
+		container: IContainer,
+		clientId: string,
+		errorMsg: string,
+	): Promise<void> {
 		if (container.audience.getMember(clientId) === undefined) {
 			return timeoutPromise(
 				(resolve) => {
-					const listener = (newClientId: string) => {
+					const listener = (newClientId: string): void => {
 						if (newClientId === clientId) {
 							container.audience.off("addMember", listener);
 							resolve();
 						}
 					};
-					container.audience.on("addMember", (newClientId: string) => listener(newClientId));
+					container.audience.on("addMember", (newClientId: string): void =>
+						listener(newClientId),
+					);
 				},
 				// Wait for 2 seconds to get the client in audience. This wait is needed for a client to get added to its
 				// own audience and 2 seconds should be enough time. It it takes longer than this, we might need to

packages/test/local-server-tests/src/test/connectionMode.spec.ts

@@ -9,6 +9,7 @@ import { ContainerRuntimeFactoryWithDefaultDataStore } from "@fluidframework/aqu
 import { IContainer, IFluidCodeDetails } from "@fluidframework/container-definitions/internal";
 import { ConnectionState } from "@fluidframework/container-loader";
 import { type ILoaderProps } from "@fluidframework/container-loader/internal";
+import type { ITelemetryBaseEvent } from "@fluidframework/core-interfaces";
 import {
 	LocalDocumentServiceFactory,
 	LocalResolver,
@@ -53,13 +54,13 @@ describe("Logging Last Connection Mode ", () => {
 
 	const logger = new MockLogger();
 
-	const getConnectedEvents = () =>
+	const getConnectedEvents = (): ITelemetryBaseEvent[] =>
 		logger.events.filter(
 			(event) =>
 				event.eventName === "fluid:telemetry:Container:ConnectionStateChange_Connected",
 		);
 
-	const getDisconnectedEvents = () =>
+	const getDisconnectedEvents = (): ITelemetryBaseEvent[] =>
 		logger.events.filter(
 			(event) =>
 				event.eventName === "fluid:telemetry:Container:ConnectionStateChange_Disconnected",

packages/test/local-server-tests/src/test/data-migration/basicMigration.spec.ts

@@ -41,7 +41,7 @@ const lstValue1 = 42;
 const lstValue2 = 38;
 const dirValue = "bar";
 
-function modifyOldFile(rootDataObject: RootDO) {
+function modifyOldFile(rootDataObject: RootDO): void {
 	setLSTQuantity(rootDataObject.doWithLST.tree, lstValue1);
 	setLSTQuantity(rootDataObject.doWithLSTAndDir.tree, lstValue2);
 	rootDataObject.doWithLSTAndDir.subDirectory.set("value", dirValue);
@@ -62,7 +62,7 @@ async function validateNewRoot(
 	provider: ITestObjectProvider,
 	runtimeFactory: IRuntimeFactory,
 	readContainer?: IContainer,
-) {
+): Promise<void> {
 	// Validate in memory objects
 	const view = rootDataObject.doWithST.view;
 	const view2 = rootDataObject.doWithST2.view;
@@ -165,7 +165,7 @@ class ExampleStrategy implements IMigrationStrategy {
 }
 
 const migrationStrategies: IMigrationStrategy[] = [new ExampleStrategy()];
-const createFluidEntryPoint = () => {
+const createFluidEntryPoint = (): never => {
 	throw new Error();
 };
 describe.skip("basicMigration", () => {