@fluidframework/telemetry-utils 2.0.0-dev.3.1.0.125672 → 2.0.0-dev.4.2.0.153917

package/src/config.ts

@@ -4,6 +4,7 @@
  */
 import { ITelemetryBaseLogger, ITelemetryLogger } from "@fluidframework/common-definitions";
 import { Lazy } from "@fluidframework/common-utils";
+import { TelemetryDataTag } from "./logger";
 
 export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
 
@@ -47,7 +48,7 @@ const NullConfigProvider: IConfigProviderBase = {
  */
 export const inMemoryConfigProvider = (storage: Storage | undefined): IConfigProviderBase => {
 	if (storage !== undefined && storage !== null) {
-		return new CachedConfigProvider({
+		return new CachedConfigProvider(undefined, {
 			getRawConfig: (name: string) => {
 				try {
 					return stronglyTypedParse(storage.getItem(name) ?? undefined)?.raw;
@@ -142,9 +143,20 @@ function stronglyTypedParse(input: ConfigTypes): StronglyTypedValue | undefined
 	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;
+	}
 };
 
 /**
@@ -154,7 +166,10 @@ export class CachedConfigProvider implements IConfigProvider {
 	private readonly configCache = new Map<string, StronglyTypedValue>();
 	private readonly orderedBaseProviders: (IConfigProviderBase | undefined)[];
 
-	constructor(...orderedBaseProviders: (IConfigProviderBase | undefined)[]) {
+	constructor(
+		private readonly logger?: ITelemetryBaseLogger,
+		...orderedBaseProviders: (IConfigProviderBase | undefined)[]
+	) {
 		this.orderedBaseProviders = [];
 		const knownProviders = new Set<IConfigProviderBase>();
 		const candidateProviders = [...orderedBaseProviders];
@@ -203,6 +218,15 @@ export class CachedConfigProvider implements IConfigProvider {
 				const parsed = stronglyTypedParse(provider?.getRawConfig(name));
 				if (parsed !== undefined) {
 					this.configCache.set(name, parsed);
+					this.logger?.send({
+						category: "generic",
+						eventName: "ConfigRead",
+						configName: { tag: TelemetryDataTag.CodeArtifact, value: name },
+						configValue: {
+							tag: TelemetryDataTag.CodeArtifact,
+							value: JSON.stringify(parsed),
+						},
+					});
 					return parsed;
 				}
 			}
@@ -253,7 +277,7 @@ export function mixinMonitoringContext<L extends ITelemetryBaseLogger = ITelemet
 	 * of the MonitoringContext and get the config provider.
 	 */
 	const mc: L & Partial<MonitoringContext<L>> = logger;
-	mc.config = new CachedConfigProvider(...configs);
+	mc.config = new CachedConfigProvider(logger, ...configs);
 	mc.logger = logger;
 	return mc as MonitoringContext<L>;
 }

package/src/debugLogger.ts

@@ -34,8 +34,18 @@ export class DebugLogger extends TelemetryLogger {
 		// Setup base logger upfront, such that host can disable it (if needed)
 		const debug = registerDebug(namespace);
 
+		// Create one for errors that is always enabled
+		// It can be silenced by replacing console.error if the debug namespace is not enabled.
 		const debugErr = registerDebug(namespace);
-		debugErr.log = console.error.bind(console);
+		debugErr.log = function () {
+			if (debug.enabled) {
+				// if the namespace is enabled, just use the default logger
+				registerDebug.log(...arguments);
+			} else {
+				// other wise, use the console logger (which could be replaced and silenced)
+				console.error(...arguments);
+			}
+		};
 		debugErr.enabled = true;
 
 		return new DebugLogger(debug, debugErr, properties);

package/src/logger.ts

@@ -344,7 +344,7 @@ export class ChildLogger extends TelemetryLogger {
 
 		// propagate the monitoring context
 		if (loggerIsMonitoringContext(baseLogger)) {
-			mixinMonitoringContext(this, new CachedConfigProvider(baseLogger.config));
+			mixinMonitoringContext(this, new CachedConfigProvider(this, baseLogger.config));
 		}
 	}
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/telemetry-utils";
-export const pkgVersion = "2.0.0-dev.3.1.0.125672";
+export const pkgVersion = "2.0.0-dev.4.2.0.153917";