Handle identify status in hooks. (#60)

## Summary

Context data from identify should only be set when the identify
completed successfully.

<!--
Ideally, there is an attached GitHub issue that will describe the "why".

If relevant, use this section to call out any additional information
you'd like to _highlight_ to the reviewer.
-->

## How did you test this change?

<!--
Frontend - Leave a screencast or a screenshot to visually describe the
changes.
-->

## Are there any deployment considerations?

<!--
 Backend - Do we need to consider migrations or backfilling data?
-->

## Does this work require review from our design team?

<!--
 Request review from julian-highlight / our design team
-->

Author: kinyoklion

.changeset/purple-needles-sing.md

@@ -0,0 +1,5 @@
+---
+'highlight.run': patch
+---
+
+Only add context data for successful identify operations.

sdk/highlight-run/src/integrations/launchdarkly/index.ts

@@ -41,6 +41,8 @@ export const LD_METRIC_EVENT = '$ld:telemetry:metric'
 
 export const LD_METRIC_NAME_DOCUMENT_LOAD = 'document_load'
 
+export const LD_IDENTIFY_RESULT_STATUS = 'result.status'
+
 function encodeKey(key: string): string {
 	if (key.includes('%') || key.includes(':')) {
 		return key.replace(/%/g, '%25').replace(/:/g, '%3A')
@@ -94,20 +96,23 @@ export function setupLaunchDarklyIntegration(
 				name: 'highlight.run',
 			}
 		},
-		afterIdentify: (hookContext, data, _result) => {
+		afterIdentify: (hookContext, data, result) => {
 			hClient.log('LD.identify', 'INFO', {
 				key: getCanonicalKey(hookContext.context),
 				context: JSON.stringify(getCanonicalObj(hookContext.context)),
 				timeout: hookContext.timeout,
+				[LD_IDENTIFY_RESULT_STATUS]: result.status,
 			})
-			hClient.identify(
-				getCanonicalKey(hookContext.context),
-				{
-					key: getCanonicalKey(hookContext.context),
-					timeout: hookContext.timeout,
-				},
-				'LaunchDarkly',
-			)
+			if (result.status === 'completed') {
+				hClient.identify(
+					getCanonicalKey(hookContext.context),
+					{
+						key: getCanonicalKey(hookContext.context),
+						timeout: hookContext.timeout,
+					},
+					'LaunchDarkly',
+				)
+			}
 			return data
 		},
 		afterEvaluation: (hookContext, data, detail) => {

sdk/highlight-run/src/plugins/observe.ts

@@ -15,6 +15,7 @@ import {
 	getCanonicalKey,
 	getCanonicalObj,
 	Hook,
+	LD_IDENTIFY_RESULT_STATUS,
 	LDClient,
 } from '../integrations/launchdarkly'
 import { Observe as ObserveAPI } from '../api/observe'
@@ -115,10 +116,10 @@ export class Observe extends Plugin<ObserveOptions> implements LDPlugin {
 						name: '@launchdarkly/observability/hooks',
 					}
 				},
-				afterIdentify: (hookContext, data, _result) => {
+				afterIdentify: (hookContext, data, result) => {
 					for (const hook of this.observe?.getHooks?.(metadata) ??
 						[]) {
-						hook.afterIdentify?.(hookContext, data, _result)
+						hook.afterIdentify?.(hookContext, data, result)
 					}
 
 					this.observe?.recordLog('LD.identify', 'info', {
@@ -128,6 +129,7 @@ export class Observe extends Plugin<ObserveOptions> implements LDPlugin {
 							getCanonicalObj(hookContext.context),
 						),
 						timeout: hookContext.timeout,
+						[LD_IDENTIFY_RESULT_STATUS]: result.status,
 					})
 					return data
 				},

sdk/highlight-run/src/plugins/record.ts

@@ -102,24 +102,26 @@ export class Record extends Plugin<RecordOptions> implements LDPlugin {
 						name: '@launchdarkly/session-replay/hooks',
 					}
 				},
-				afterIdentify: (hookContext, data, _result) => {
+				afterIdentify: (hookContext, data, result) => {
 					for (const hook of this.record?.getHooks?.(metadata) ??
 						[]) {
-						hook.afterIdentify?.(hookContext, data, _result)
+						hook.afterIdentify?.(hookContext, data, result)
+					}
+					if (result.status === 'completed') {
+						const key = getCanonicalKey(hookContext.context)
+						const obj = getCanonicalObj(hookContext.context)
+						this.record?.identify(
+							typeof obj === 'string'
+								? obj
+								: (obj['user']?.toString() ?? key),
+							{
+								key,
+								...(typeof obj === 'object' ? obj : {}),
+								timeout: hookContext.timeout,
+							},
+							'LaunchDarkly',
+						)
 					}
-					const key = getCanonicalKey(hookContext.context)
-					const obj = getCanonicalObj(hookContext.context)
-					this.record?.identify(
-						typeof obj === 'string'
-							? obj
-							: (obj['user']?.toString() ?? key),
-						{
-							key,
-							...(typeof obj === 'object' ? obj : {}),
-							timeout: hookContext.timeout,
-						},
-						'LaunchDarkly',
-					)
 					return data
 				},
 				afterEvaluation: (hookContext, data, detail) => {