@fluid-internal/client-utils 2.0.0-dev.6.4.0.191258

package/src/trace.ts

@@ -0,0 +1,58 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { performance } from "./indexNode";
+
+/**
+ * Helper class for tracing performance of events
+ * Time measurements are in milliseconds as a floating point with a decimal
+ *
+ * @internal
+ */
+export class Trace {
+	public static start(): Trace {
+		const startTick = performance.now();
+		return new Trace(startTick);
+	}
+
+	protected lastTick: number;
+	protected constructor(public readonly startTick: number) {
+		this.lastTick = startTick;
+	}
+
+	public trace(): ITraceEvent {
+		const tick = performance.now();
+		const event = {
+			totalTimeElapsed: tick - this.startTick,
+			duration: tick - this.lastTick,
+			tick,
+		};
+		this.lastTick = tick;
+		return event;
+	}
+}
+
+/**
+ * Event in a performance trace including time elapsed.
+ *
+ * @internal
+ */
+export interface ITraceEvent {
+	/**
+	 * Total time elapsed since the start of the Trace.
+	 * Measured in milliseconds as a floating point with a decimal
+	 */
+	readonly totalTimeElapsed: number;
+	/**
+	 * Time elapsed since the last trace event.
+	 * Measured in milliseconds as a floating point with a decimal
+	 */
+	readonly duration: number;
+	/**
+	 * This number represents a relative time which should
+	 * be consistent for all trace ticks.
+	 */
+	readonly tick: number;
+}

package/src/typedEventEmitter.ts

@@ -0,0 +1,79 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { EventEmitter } from "events";
+import {
+	IEvent,
+	TransformedEvent,
+	IEventTransformer,
+	IEventProvider,
+} from "@fluidframework/core-interfaces";
+
+/**
+ * The event emitter polyfill and the node event emitter have different event types:
+ * string | symbol vs. string | number
+ *
+ * This type allow us to correctly handle either type
+ *
+ * @internal
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type EventEmitterEventType = EventEmitter extends { on(event: infer E, listener: any) }
+	? E
+	: never;
+
+/**
+ * @internal
+ */
+export type TypedEventTransform<TThis, TEvent> =
+	// Event emitter supports some special events for the emitter itself to use
+	// this exposes those events for the TypedEventEmitter.
+	// Since we know what the shape of these events are, we can describe them directly via a TransformedEvent
+	// which easier than trying to extend TEvent directly
+	TransformedEvent<
+		TThis,
+		"newListener" | "removeListener",
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
+		Parameters<(event: string, listener: (...args: any[]) => void) => void>
+	> &
+		// Expose all the events provides by TEvent
+		IEventTransformer<TThis, TEvent & IEvent> &
+		// Add the default overload so this is covertable to EventEmitter regardless of environment
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
+		TransformedEvent<TThis, EventEmitterEventType, any[]>;
+
+/**
+ * Event Emitter helper class the supports emitting typed events
+ *
+ * @internal
+ */
+export class TypedEventEmitter<TEvent>
+	extends EventEmitter
+	implements IEventProvider<TEvent & IEvent>
+{
+	constructor() {
+		super();
+		this.addListener = super.addListener.bind(this) as TypedEventTransform<this, TEvent>;
+		this.on = super.on.bind(this) as TypedEventTransform<this, TEvent>;
+		this.once = super.once.bind(this) as TypedEventTransform<this, TEvent>;
+		this.prependListener = super.prependListener.bind(this) as TypedEventTransform<
+			this,
+			TEvent
+		>;
+		this.prependOnceListener = super.prependOnceListener.bind(this) as TypedEventTransform<
+			this,
+			TEvent
+		>;
+		this.removeListener = super.removeListener.bind(this) as TypedEventTransform<this, TEvent>;
+		this.off = super.off.bind(this) as TypedEventTransform<this, TEvent>;
+	}
+	readonly addListener: TypedEventTransform<this, TEvent>;
+	readonly on: TypedEventTransform<this, TEvent>;
+	readonly once: TypedEventTransform<this, TEvent>;
+	readonly prependListener: TypedEventTransform<this, TEvent>;
+	readonly prependOnceListener: TypedEventTransform<this, TEvent>;
+	readonly removeListener: TypedEventTransform<this, TEvent>;
+	readonly off: TypedEventTransform<this, TEvent>;
+}

package/tsconfig.esnext.json

@@ -0,0 +1,7 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./lib",
+		"module": "esnext",
+	},
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"composite": true,
+		"baseUrl": ".",
+		"paths": {
+			"perf_hooks": ["types/perf_hooks.d.ts"],
+		},
+	},
+	"include": ["src/**/*"],
+	"exclude": ["src/test/**/*"],
+}

package/types/perf_hooks.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/* eslint-disable unicorn/filename-case */
+// This is needed instead of adding "node" to tsconfig types list.
+declare module "perf_hooks" {
+	export const performance: import("../src/performanceIsomorphic").IsomorphicPerformance;
+}