Enhance friendly name

Author: kinyoklion

sdk/@launchdarkly/observability-react-native/src/api/Options.ts

@@ -87,13 +87,17 @@ export interface ReactNativeOptions {
 	 * ```ts
 	 * contextFriendlyName: (context: LDContext) => {
 	 *   if(context.kind === 'multi' && context.user?.email) {
-	 *     return `context.user.email`;
+	 *     return context.user.email;
+	 *   } else if(context.kind === 'user') {
+	 *     return context.key;
 	 *   }
-	 *   return context.key;
+	 *   // Use the default identifier for contexts which don't contain a user.
+	 *   return undefined;
 	 * }
 	 * ```
 	 * @param context The context to get a friendly name for.
-	 * @returns The friendly name for the context.
+	 * @returns The friendly name for the context, or undefined to use the
+	 * default identifier.
 	 */
-	contextFriendlyName?: (context: LDContext) => string
+	contextFriendlyName?: (context: LDContext) => string | undefined
 }

sdk/@launchdarkly/observability-react-native/src/plugin/observability.ts

@@ -40,7 +40,10 @@ import {
 class TracingHook implements Hook {
 	private metaAttributes: Attributes = {}
 
-	constructor(private metadata: LDPluginEnvironmentMetadata) {
+	constructor(
+		private metadata: LDPluginEnvironmentMetadata,
+		private readonly _options: ReactNativeOptions,
+	) {
 		this.metaAttributes = {
 			[ATTR_TELEMETRY_SDK_NAME]:
 				'@launchdarkly/observability-react-native',
@@ -66,7 +69,7 @@ class TracingHook implements Hook {
 				...this.metaAttributes,
 				...getCanonicalObj(hookContext.context),
 				key:
-					this.options?.contextFriendlyName?.(hookContext.context) ??
+					this._options?.contextFriendlyName?.(hookContext.context) ??
 					getCanonicalKey(hookContext.context),
 				canonicalKey: getCanonicalKey(hookContext.context),
 				timeout: hookContext.timeout,
@@ -163,6 +166,6 @@ export class Observability implements LDPlugin {
 	}
 
 	getHooks?(metadata: LDPluginEnvironmentMetadata): Hook[] {
-		return [new TracingHook(metadata)]
+		return [new TracingHook(metadata, this._options)]
 	}
 }

sdk/highlight-run/src/client/types/observe.ts

@@ -75,13 +75,17 @@ export type ObserveOptions = CommonOptions & {
 	 * ```ts
 	 * contextFriendlyName: (context: LDContext) => {
 	 *   if(context.kind === 'multi' && context.user?.email) {
-	 *     return `context.user.email`;
+	 *     return context.user.email;
+	 *   } else if(context.kind === 'user') {
+	 *     return context.key;
 	 *   }
-	 *   return context.key;
+	 *   // Use the default identifier for contexts which don't contain a user.
+	 *   return undefined;
 	 * }
 	 * ```
 	 * @param context The context to get a friendly name for.
-	 * @returns The friendly name for the context.
+	 * @returns The friendly name for the context, or undefined to use the
+	 * default identifier.
 	 */
-	contextFriendlyName?: (context: LDContext) => string
+	contextFriendlyName?: (context: LDContext) => string | undefined
 }