Unify performanceIsometric implementation, simplify typing, and enable sha.js typing in client-utils and common-utils (#18253)

Author: ChumpChief

common/lib/common-utils/src/indexBrowser.ts

@@ -11,4 +11,4 @@ export {
 	Uint8ArrayToString,
 } from "./bufferBrowser";
 export { gitHashFile, hashFile } from "./hashFileBrowser";
-export { performance } from "./performanceBrowser";
+export { performance } from "./performanceIsomorphic";

common/lib/common-utils/src/indexNode.ts

@@ -11,4 +11,4 @@ export {
 	Uint8ArrayToString,
 } from "./bufferNode";
 export { gitHashFile, hashFile } from "./hashFileNode";
-export { performance } from "./performanceNode";
+export { performance } from "./performanceIsomorphic";

common/lib/common-utils/src/performanceBrowser.ts

@@ -11,3 +11,8 @@
  */
 export type IsomorphicPerformance = Partial<Performance> &
 	Pick<Performance, "clearMarks" | "mark" | "measure" | "now">;
+
+/**
+ * @deprecated Moved to the `@fluidframework-internal/client-utils` package.
+ */
+export const performance: IsomorphicPerformance = globalThis.performance;

common/lib/common-utils/src/performanceIsomorphic.ts

@@ -5,9 +5,6 @@
 		"rootDir": "./src",
 		"outDir": "./dist",
 		"baseUrl": ".",
-		"paths": {
-			"perf_hooks": ["types/perf_hooks.d.ts"],
-		},
 	},
 	"include": ["src/**/*"],
 	"exclude": ["src/test/**/*"],

common/lib/common-utils/src/performanceNode.ts

@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import { EventEmitter } from 'events';
 import { IDisposable } from '@fluidframework/core-interfaces';
 import { IEvent } from '@fluidframework/core-interfaces';
@@ -12,13 +14,14 @@ import { IEventTransformer } from '@fluidframework/core-interfaces';
 import { TransformedEvent } from '@fluidframework/core-interfaces';
 
 // @internal
-export class Buffer extends Uint8Array {
+class Buffer_2 extends Uint8Array {
     static from(value: unknown, encodingOrOffset?: unknown, length?: unknown): IsoBuffer;
     // (undocumented)
-    static isBuffer(obj: unknown): obj is Buffer;
+    static isBuffer(obj: unknown): obj is Buffer_2;
     // (undocumented)
     toString(encoding?: "utf8" | "utf-8" | "base64"): string;
 }
+export { Buffer_2 as Buffer }
 
 // @internal
 export const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
@@ -56,10 +59,10 @@ export function gitHashFile(file: IsoBuffer): Promise<string>;
 export function hashFile(file: IsoBuffer, algorithm?: "SHA-1" | "SHA-256", hashEncoding?: "hex" | "base64"): Promise<string>;
 
 // @internal (undocumented)
-export const IsoBuffer: typeof Buffer;
+export const IsoBuffer: typeof Buffer_2;
 
 // @internal (undocumented)
-export type IsoBuffer = Buffer;
+export type IsoBuffer = Buffer_2;
 
 // @internal
 export type IsomorphicPerformance = Partial<Performance> & Pick<Performance, "clearMarks" | "mark" | "measure" | "now">;
@@ -71,7 +74,7 @@ export interface ITraceEvent {
     readonly totalTimeElapsed: number;
 }
 
-// @internal (undocumented)
+// @internal
 const performance_2: IsomorphicPerformance;
 export { performance_2 as performance }
 

common/lib/common-utils/tsconfig.json

@@ -92,7 +92,7 @@
 		"@types/node": "^16.18.38",
 		"@types/puppeteer": "1.3.0",
 		"@types/rewire": "^2.5.28",
-		"@types/sha.js": "^2.4.0",
+		"@types/sha.js": "^2.4.4",
 		"@types/sinon": "^7.0.13",
 		"c8": "^7.7.1",
 		"concurrently": "^8.2.1",

common/lib/common-utils/types/perf_hooks.d.ts

@@ -3,10 +3,7 @@
  * Licensed under the MIT License.
  */
 
-// eslint-disable-next-line import/no-internal-modules
-import sha1 from "sha.js/sha1";
-// eslint-disable-next-line import/no-internal-modules
-import sha256 from "sha.js/sha256";
+import { sha1, sha256 } from "sha.js";
 
 import type { IsoBuffer } from "./bufferNode";
 
@@ -32,12 +29,10 @@ export async function hashFile(
 	// eslint-disable-next-line default-case
 	switch (algorithm) {
 		case "SHA-1": {
-			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
 			engine = new sha1();
 			break;
 		}
 		case "SHA-256": {
-			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
 			engine = new sha256();
 			break;
 		}
@@ -59,8 +54,6 @@ export async function gitHashFile(file: IsoBuffer): Promise<string> {
 	const size = file.byteLength;
 	// eslint-disable-next-line unicorn/prefer-code-point
 	const filePrefix = `blob ${size.toString()}${String.fromCharCode(0)}`;
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
 	const engine = new sha1();
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-	return engine.update(filePrefix).update(file).digest("hex") as string;
+	return engine.update(filePrefix).update(file).digest("hex");
 }

packages/common/client-utils/api-report/client-utils.api.md

@@ -11,4 +11,4 @@ export {
 	Uint8ArrayToString,
 } from "./bufferBrowser";
 export { gitHashFile, hashFile } from "./hashFileBrowser";
-export { performance } from "./performanceBrowser";
+export { performance } from "./performanceIsomorphic";

packages/common/client-utils/package.json

@@ -11,4 +11,4 @@ export {
 	Uint8ArrayToString,
 } from "./bufferNode";
 export { gitHashFile, hashFile } from "./hashFileNode";
-export { performance } from "./performanceNode";
+export { performance } from "./performanceIsomorphic";

packages/common/client-utils/src/hashFileNode.ts

@@ -11,3 +11,13 @@
  */
 export type IsomorphicPerformance = Partial<Performance> &
 	Pick<Performance, "clearMarks" | "mark" | "measure" | "now">;
+
+/**
+ * This exported "performance" member masks the built-in globalThis.performance object
+ * as an IsomorphicPerformance, which hides all of its features that aren't compatible
+ * between Node and browser implementations.  Anything exposed on this performance object
+ * is considered safe to use regarless of the environment it runs in.
+ *
+ * @internal
+ */
+export const performance: IsomorphicPerformance = globalThis.performance;

packages/common/client-utils/src/indexBrowser.ts

@@ -78,7 +78,6 @@ async function evaluateBrowserHash(
 	)) as string;
 
 	// reconstruct the Uint8Array from the string
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 	const charCodes = Array.prototype.map.call([...hashCharCodeString], (char: string) => {
 		return char.charCodeAt(0);
 	}) as number[];

packages/common/client-utils/src/indexNode.ts

@@ -30,7 +30,6 @@ describe("TypedEventEmitter", () => {
 		const tee = new TypedEventEmitter<IErrorEvent>();
 		let newListenerCalls = 0;
 		let removeListenerCalls = 0;
-		// eslint-disable-next-line unicorn/consistent-function-scoping
 		const errListener = (): void => {};
 		tee.on("removeListener", (event, listener) => {
 			assert.equal(event, "error");

packages/common/client-utils/src/performanceBrowser.ts

@@ -9,9 +9,5 @@
 		"rootDir": "./src",
 		"outDir": "./dist",
 		"baseUrl": ".",
-		"paths": {
-			"perf_hooks": ["types/perf_hooks.d.ts"],
-		},
-		"types": ["events"],
 	},
 }

packages/common/client-utils/src/performanceIsomorphic.ts

@@ -74,7 +74,7 @@ export class DocumentDeltaConnection
 
 	private _details: IConnected | undefined;
 
-	private trackLatencyTimeout: number | undefined;
+	private trackLatencyTimeout: ReturnType<typeof setTimeout> | undefined;
 
 	// Listeners only needed while the connection is in progress
 	private readonly connectionListeners: Map<string, (...args: any[]) => void> = new Map();
@@ -132,7 +132,7 @@ export class DocumentDeltaConnection
 			logger.sendErrorEvent(
 				{
 					eventName: "DeltaConnection:EventException",
-					name,
+					name: name as string,
 				},
 				error,
 			);

packages/common/client-utils/src/performanceNode.ts

@@ -86,7 +86,6 @@
 		"@types/mocha": "^9.1.1",
 		"@types/node": "^16.18.38",
 		"@types/node-fetch": "^2.5.10",
-		"@types/sha.js": "^2.4.0",
 		"@types/sinon": "^7.0.13",
 		"c8": "^7.7.1",
 		"cross-env": "^7.0.3",

packages/common/client-utils/src/test/jest/gitHash.spec.ts

@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import { EventEmitter } from 'events';
 import { EventEmitterEventType } from '@fluid-internal/client-utils';
 import { IDisposable } from '@fluidframework/core-interfaces';