@fluidframework/telemetry-utils 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.4.1.0.148229

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/telemetry-utils",
-  "version": "2.0.0-dev.2.3.0.115467",
+  "version": "2.0.0-dev.4.1.0.148229",
   "description": "Collection of telemetry relates utilities for Fluid",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -18,35 +18,6 @@
     "./lib/indexNode.js": "./lib/indexBrowser.js"
   },
   "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
-    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-    "build:esnext": "tsc --project ./tsconfig.esnext.json",
-    "build:full": "npm run build",
-    "build:full:compile": "npm run build:compile",
-    "build:genver": "gen-version",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "bump-version": "npm version minor --no-push --no-git-tag-version && npm run build:genver",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "npm run prettier:fix",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-    "test": "npm run test:mocha",
-    "test:coverage": "nyc npm run test:report",
-    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
-    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "test:report": "npm test -- -- --reporter xunit --reporter-option output=nyc/mocha-junit-report.xml",
-    "tsc": "tsc",
-    "typetests:gen": "flub generate typetests --generate --dir .",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
-  },
   "nyc": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -69,39 +40,69 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^1.0.0",
+    "@fluidframework/common-utils": "^1.1.1",
     "debug": "^4.1.1",
     "events": "^3.1.0",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.7.0",
+    "@fluid-tools/build-cli": "^0.13.1",
     "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.7.0",
-    "@fluidframework/eslint-config-fluid": "^1.2.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/telemetry-utils-previous": "npm:@fluidframework/telemetry-utils@2.0.0-internal.2.2.0",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@fluidframework/build-tools": "^0.13.1",
+    "@fluidframework/eslint-config-fluid": "^2.0.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/telemetry-utils-previous": "npm:@fluidframework/telemetry-utils@2.0.0-internal.4.0.0",
+    "@microsoft/api-extractor": "^7.34.4",
     "@types/debug": "^4.1.5",
     "@types/events": "^3.0.0",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.0",
-    "concurrently": "^6.2.0",
+    "@types/node": "^14.18.38",
+    "@types/uuid": "^8.3.0",
+    "concurrently": "^7.6.0",
     "copyfiles": "^2.4.1",
-    "cross-env": "^7.0.2",
+    "cross-env": "^7.0.3",
     "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "nyc": "^15.1.0",
     "prettier": "~2.6.2",
-    "rimraf": "^2.6.2",
+    "rimraf": "^4.4.0",
     "sinon": "^7.4.2",
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.3.0",
-    "baselineRange": ">=2.0.0-internal.2.2.0 <2.0.0-internal.2.3.0",
-    "baselineVersion": "2.0.0-internal.2.2.0",
     "broken": {}
+  },
+  "scripts": {
+    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
+    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
+    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:esnext": "tsc --project ./tsconfig.esnext.json",
+    "build:full": "npm run build",
+    "build:full:compile": "npm run build:compile",
+    "build:genver": "gen-version",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "bump-version": "npm version minor --no-push --no-git-tag-version && npm run build:genver",
+    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "test": "npm run test:mocha",
+    "test:coverage": "nyc npm run test:report",
+    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha:multireport": "cross-env FLUID_TEST_MULTIREPORT=1 npm run test:mocha",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "test:report": "npm test -- -- --reporter xunit --reporter-option output=nyc/mocha-junit-report.xml",
+    "tsc": "tsc",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
   }
-}
+}

package/prettier.config.cjs

@@ -4,5 +4,5 @@
  */
 
 module.exports = {
-    ...require("@fluidframework/build-common/prettier.config.cjs"),
+	...require("@fluidframework/build-common/prettier.config.cjs"),
 };

package/src/config.ts

@@ -11,30 +11,31 @@ export type ConfigTypes = string | number | boolean | number[] | string[] | bool
  * Base interface for providing configurations to enable/disable/control features
  */
 export interface IConfigProviderBase {
-    getRawConfig(name: string): ConfigTypes;
+	getRawConfig(name: string): ConfigTypes;
 }
 
 /**
  * Explicitly typed interface for reading configurations
  */
- export interface IConfigProvider extends IConfigProviderBase {
-    getBoolean(name: string): boolean | undefined;
-    getNumber(name: string): number | undefined;
-    getString(name: string): string | undefined;
-    getBooleanArray(name: string): boolean[] | undefined;
-    getNumberArray(name: string): number[] | undefined;
-    getStringArray(name: string): string[] | undefined;
- }
+export interface IConfigProvider extends IConfigProviderBase {
+	getBoolean(name: string): boolean | undefined;
+	getNumber(name: string): number | undefined;
+	getString(name: string): string | undefined;
+	getBooleanArray(name: string): boolean[] | undefined;
+	getNumberArray(name: string): number[] | undefined;
+	getStringArray(name: string): string[] | undefined;
+}
 /**
  * Creates a base configuration provider based on `sessionStorage`
  *
  * @returns A lazy initialized base configuration provider with `sessionStorage` as the underlying config store
  */
-export const sessionStorageConfigProvider =
-    new Lazy<IConfigProviderBase>(() => inMemoryConfigProvider(safeSessionStorage()));
+export const sessionStorageConfigProvider = new Lazy<IConfigProviderBase>(() =>
+	inMemoryConfigProvider(safeSessionStorage()),
+);
 
 const NullConfigProvider: IConfigProviderBase = {
-    getRawConfig: () => undefined,
+	getRawConfig: () => undefined,
 };
 
 /**
@@ -44,45 +45,44 @@ const NullConfigProvider: IConfigProviderBase = {
  * @returns A base configuration provider with
  * the supplied `Storage` instance as the underlying config store
  */
-export const inMemoryConfigProvider =
-    (storage: Storage | undefined): IConfigProviderBase => {
-    if (storage !== undefined && storage !== null) {
-        return new CachedConfigProvider({
-            getRawConfig: (name: string) => {
-                try {
-                    return stronglyTypedParse(storage.getItem(name) ?? undefined)?.raw;
-                } catch { }
-                return undefined;
-            },
-        });
-    }
-    return NullConfigProvider;
+export const inMemoryConfigProvider = (storage: Storage | undefined): IConfigProviderBase => {
+	if (storage !== undefined && storage !== null) {
+		return new CachedConfigProvider({
+			getRawConfig: (name: string) => {
+				try {
+					return stronglyTypedParse(storage.getItem(name) ?? undefined)?.raw;
+				} catch {}
+				return undefined;
+			},
+		});
+	}
+	return NullConfigProvider;
 };
 
 interface ConfigTypeStringToType {
-    number: number;
-    string: string;
-    boolean: boolean;
-    ["number[]"]: number[];
-    ["string[]"]: string[];
-    ["boolean[]"]: boolean[];
+	number: number;
+	string: string;
+	boolean: boolean;
+	["number[]"]: number[];
+	["string[]"]: string[];
+	["boolean[]"]: boolean[];
 }
 
 type PrimitiveTypeStrings = "number" | "string" | "boolean";
 
 function isPrimitiveType(type: string): type is PrimitiveTypeStrings {
-    switch (type) {
-        case "boolean":
-        case "number":
-        case "string":
-            return true;
-        default:
-            return false;
-    }
+	switch (type) {
+		case "boolean":
+		case "number":
+		case "string":
+			return true;
+		default:
+			return false;
+	}
 }
 
 interface StronglyTypedValue extends Partial<ConfigTypeStringToType> {
-    raw: ConfigTypes;
+	raw: ConfigTypes;
 }
 /**
  * Takes any supported config type, and returns the value with a strong type. If the type of
@@ -94,170 +94,182 @@ interface StronglyTypedValue extends Partial<ConfigTypeStringToType> {
  * will be return with a string type for the consumer to handle further if necessary.
  */
 function stronglyTypedParse(input: ConfigTypes): StronglyTypedValue | undefined {
-    let output: ConfigTypes = input;
-    let defaultReturn: Pick<StronglyTypedValue, "raw" | "string"> | undefined;
-    // we do special handling for strings to try and coerce
-    // them into a config type if we can. This makes it easy
-    // for config sources like sessionStorage which only
-    // holds strings
-    if (typeof input === "string") {
-        try {
-            output = JSON.parse(input);
-            // we succeeded in parsing, but we don't support parsing
-            // for any object as we can't do it type safely
-            // so in this case, the default return will be string
-            // rather than undefined, and the consumer
-            // can parse, as we don't want to provide
-            // a false sense of security by just
-            // casting.
-            defaultReturn = { raw: input, string: input };
-        } catch { }
-    }
+	let output: ConfigTypes = input;
+	let defaultReturn: Pick<StronglyTypedValue, "raw" | "string"> | undefined;
+	// we do special handling for strings to try and coerce
+	// them into a config type if we can. This makes it easy
+	// for config sources like sessionStorage which only
+	// holds strings
+	if (typeof input === "string") {
+		try {
+			output = JSON.parse(input);
+			// we succeeded in parsing, but we don't support parsing
+			// for any object as we can't do it type safely
+			// so in this case, the default return will be string
+			// rather than undefined, and the consumer
+			// can parse, as we don't want to provide
+			// a false sense of security by just
+			// casting.
+			defaultReturn = { raw: input, string: input };
+		} catch {}
+	}
 
-    if (output === undefined) {
-        return defaultReturn;
-    }
+	if (output === undefined) {
+		return defaultReturn;
+	}
 
-    const outputType = typeof output;
-    if (isPrimitiveType(outputType)) {
-        return { ...defaultReturn, raw: input, [outputType]: output };
-    }
+	const outputType = typeof output;
+	if (isPrimitiveType(outputType)) {
+		return { ...defaultReturn, raw: input, [outputType]: output };
+	}
 
-    if (Array.isArray(output)) {
-        const firstType = typeof output[0];
-        // ensure the first elements is a primitive type
-        if (!isPrimitiveType(firstType)) {
-            return defaultReturn;
-        }
-        // ensue all the elements types are homogeneous
-        // aka they all have the same type as the first
-        for (const v of output) {
-            if (typeof v !== firstType) {
-                return defaultReturn;
-            }
-        }
-        return { ...defaultReturn, raw: input, [`${firstType}[]`]: output };
-    }
+	if (Array.isArray(output)) {
+		const firstType = typeof output[0];
+		// ensure the first elements is a primitive type
+		if (!isPrimitiveType(firstType)) {
+			return defaultReturn;
+		}
+		// ensue all the elements types are homogeneous
+		// aka they all have the same type as the first
+		for (const v of output) {
+			if (typeof v !== firstType) {
+				return defaultReturn;
+			}
+		}
+		return { ...defaultReturn, raw: input, [`${firstType}[]`]: output };
+	}
 
-    return defaultReturn;
+	return defaultReturn;
 }
 
-/** `sessionStorage` is undefined in some environments such as Node */
+/** `sessionStorage` is undefined in some environments such as Node and web pages with session storage disabled */
 const safeSessionStorage = (): Storage | undefined => {
-    return globalThis.sessionStorage;
+	// For some configurations accessing "globalThis.sessionStorage" throws
+	// "'sessionStorage' property from 'Window': Access is denied for this document" rather than returning undefined.
+	// Therefor check for it before accessing.
+	try {
+		// Using globalThis and checking for undefined is preferred over just accessing global sessionStorage
+		// since it avoids an exception when running in node.
+		// In some cases this has returned null when disabled in the browser, so ensure its undefined in that case:
+		return globalThis.sessionStorage ?? undefined;
+	} catch {
+		// For browsers which error on the above when session storage is disabled:
+		return undefined;
+	}
 };
 
 /**
  * Implementation of {@link IConfigProvider} which contains nested {@link IConfigProviderBase} instances
  */
 export class CachedConfigProvider implements IConfigProvider {
-    private readonly configCache = new Map<string, StronglyTypedValue>();
-    private readonly orderedBaseProviders: (IConfigProviderBase | undefined)[];
+	private readonly configCache = new Map<string, StronglyTypedValue>();
+	private readonly orderedBaseProviders: (IConfigProviderBase | undefined)[];
 
-    constructor(
-        ... orderedBaseProviders: (IConfigProviderBase | undefined)[]
-    ) {
-        this.orderedBaseProviders = [];
-        const knownProviders = new Set<IConfigProviderBase>();
-        const candidateProviders = [...orderedBaseProviders];
-        while (candidateProviders.length > 0) {
-            const baseProvider = candidateProviders.shift()!;
-            if (baseProvider !== undefined
-                && isConfigProviderBase(baseProvider)
-                && !knownProviders.has(baseProvider)
-            ) {
-                knownProviders.add(baseProvider);
-                if (baseProvider instanceof CachedConfigProvider) {
-                    candidateProviders.push(...baseProvider.orderedBaseProviders);
-                } else {
-                    this.orderedBaseProviders.push(baseProvider);
-                }
-            }
-        }
-    }
-    getBoolean(name: string): boolean | undefined {
-        return this.getCacheEntry(name)?.boolean;
-    }
-    getNumber(name: string): number | undefined {
-        return this.getCacheEntry(name)?.number;
-    }
-    getString(name: string): string | undefined {
-        return this.getCacheEntry(name)?.string;
-    }
-    getBooleanArray(name: string): boolean[] | undefined {
-        return this.getCacheEntry(name)?.["boolean[]"];
-    }
-    getNumberArray(name: string): number[] | undefined {
-        return this.getCacheEntry(name)?.["number[]"];
-    }
-    getStringArray(name: string): string[] | undefined {
-        return this.getCacheEntry(name)?.["string[]"];
-    }
+	constructor(...orderedBaseProviders: (IConfigProviderBase | undefined)[]) {
+		this.orderedBaseProviders = [];
+		const knownProviders = new Set<IConfigProviderBase>();
+		const candidateProviders = [...orderedBaseProviders];
+		while (candidateProviders.length > 0) {
+			const baseProvider = candidateProviders.shift()!;
+			if (
+				baseProvider !== undefined &&
+				isConfigProviderBase(baseProvider) &&
+				!knownProviders.has(baseProvider)
+			) {
+				knownProviders.add(baseProvider);
+				if (baseProvider instanceof CachedConfigProvider) {
+					candidateProviders.push(...baseProvider.orderedBaseProviders);
+				} else {
+					this.orderedBaseProviders.push(baseProvider);
+				}
+			}
+		}
+	}
+	getBoolean(name: string): boolean | undefined {
+		return this.getCacheEntry(name)?.boolean;
+	}
+	getNumber(name: string): number | undefined {
+		return this.getCacheEntry(name)?.number;
+	}
+	getString(name: string): string | undefined {
+		return this.getCacheEntry(name)?.string;
+	}
+	getBooleanArray(name: string): boolean[] | undefined {
+		return this.getCacheEntry(name)?.["boolean[]"];
+	}
+	getNumberArray(name: string): number[] | undefined {
+		return this.getCacheEntry(name)?.["number[]"];
+	}
+	getStringArray(name: string): string[] | undefined {
+		return this.getCacheEntry(name)?.["string[]"];
+	}
 
-    getRawConfig(name: string): ConfigTypes {
-        return this.getCacheEntry(name)?.raw;
-    }
+	getRawConfig(name: string): ConfigTypes {
+		return this.getCacheEntry(name)?.raw;
+	}
 
-    private getCacheEntry(name: string): StronglyTypedValue | undefined {
-        if (!this.configCache.has(name)) {
-            for (const provider of this.orderedBaseProviders) {
-                const parsed = stronglyTypedParse(provider?.getRawConfig(name));
-                if (parsed !== undefined) {
-                    this.configCache.set(name, parsed);
-                    return parsed;
-                }
-            }
-            // configs are immutable, if the first lookup returned no results, all lookups should
-            this.configCache.set(name, { raw: undefined });
-        }
-        return this.configCache.get(name);
-    }
+	private getCacheEntry(name: string): StronglyTypedValue | undefined {
+		if (!this.configCache.has(name)) {
+			for (const provider of this.orderedBaseProviders) {
+				const parsed = stronglyTypedParse(provider?.getRawConfig(name));
+				if (parsed !== undefined) {
+					this.configCache.set(name, parsed);
+					return parsed;
+				}
+			}
+			// configs are immutable, if the first lookup returned no results, all lookups should
+			this.configCache.set(name, { raw: undefined });
+		}
+		return this.configCache.get(name);
+	}
 }
 
 /**
  * A type containing both a telemetry logger and a configuration provider
  */
-export interface MonitoringContext<
-    L extends ITelemetryBaseLogger = ITelemetryLogger,
-> {
-    config: IConfigProvider;
-    logger: L;
+export interface MonitoringContext<L extends ITelemetryBaseLogger = ITelemetryLogger> {
+	config: IConfigProvider;
+	logger: L;
 }
 
 export function loggerIsMonitoringContext<L extends ITelemetryBaseLogger = ITelemetryLogger>(
-    obj: L): obj is L & MonitoringContext<L> {
-    const maybeConfig = obj as Partial<MonitoringContext<L>> | undefined;
-    return isConfigProviderBase(maybeConfig?.config) && maybeConfig?.logger !== undefined;
+	obj: L,
+): obj is L & MonitoringContext<L> {
+	const maybeConfig = obj as Partial<MonitoringContext<L>> | undefined;
+	return isConfigProviderBase(maybeConfig?.config) && maybeConfig?.logger !== undefined;
 }
 
 export function loggerToMonitoringContext<L extends ITelemetryBaseLogger = ITelemetryLogger>(
-    logger: L): MonitoringContext<L> {
-    if (loggerIsMonitoringContext<L>(logger)) {
-        return logger;
-    }
-    return mixinMonitoringContext<L>(logger, sessionStorageConfigProvider.value);
+	logger: L,
+): MonitoringContext<L> {
+	if (loggerIsMonitoringContext<L>(logger)) {
+		return logger;
+	}
+	return mixinMonitoringContext<L>(logger, sessionStorageConfigProvider.value);
 }
 
 export function mixinMonitoringContext<L extends ITelemetryBaseLogger = ITelemetryLogger>(
-    logger: L, ... configs: (IConfigProviderBase | undefined)[]) {
-    if (loggerIsMonitoringContext<L>(logger)) {
-        throw new Error("Logger is already a monitoring context");
-    }
-    /**
-     * this is the tricky bit we use for now to smuggle monitoring context around.
-     * To the logger we mixin both config and  itself, so mc.logger === logger as it is self-referential.
-     * We then expose it as a Monitoring context, so via types we hide the outer logger methods.
-     * To layers that expect just a logger we can pass mc.logger, but this is still a MonitoringContext
-     * so if a deeper layer then converts that logger to a monitoring context it can find the smuggled properties
-     * of the MonitoringContext and get the config provider.
-     */
-    const mc: L & Partial<MonitoringContext<L>> = logger;
-    mc.config = new CachedConfigProvider(...configs);
-    mc.logger = logger;
-    return mc as MonitoringContext<L>;
+	logger: L,
+	...configs: (IConfigProviderBase | undefined)[]
+) {
+	if (loggerIsMonitoringContext<L>(logger)) {
+		throw new Error("Logger is already a monitoring context");
+	}
+	/**
+	 * this is the tricky bit we use for now to smuggle monitoring context around.
+	 * To the logger we mixin both config and  itself, so mc.logger === logger as it is self-referential.
+	 * We then expose it as a Monitoring context, so via types we hide the outer logger methods.
+	 * To layers that expect just a logger we can pass mc.logger, but this is still a MonitoringContext
+	 * so if a deeper layer then converts that logger to a monitoring context it can find the smuggled properties
+	 * of the MonitoringContext and get the config provider.
+	 */
+	const mc: L & Partial<MonitoringContext<L>> = logger;
+	mc.config = new CachedConfigProvider(...configs);
+	mc.logger = logger;
+	return mc as MonitoringContext<L>;
 }
 
 function isConfigProviderBase(obj: unknown): obj is IConfigProviderBase {
-    const maybeConfig = obj as Partial<IConfigProviderBase> | undefined;
-    return typeof (maybeConfig?.getRawConfig) === "function";
+	const maybeConfig = obj as Partial<IConfigProviderBase> | undefined;
+	return typeof maybeConfig?.getRawConfig === "function";
 }