fix bugs in observability plugins (#61)

Vadman97 · web-flow · commit 70a60183f030 · 2025-05-22T22:28:22.000Z
## Summary * fix plugins not exporting types * export plugin options correctly * fix session replay and observability plugin reporting to different sessions * fix span duplication happening due to an unnecessary export retry ## How did you test this change? https://www.loom.com/share/f2ed9cfe8acb44e496a85570d54ade3b testing with `offline` network throttling in chrome devtools before <img width="1313" alt="Screenshot 2025-05-22 at 14 39 21" src="https://github.com/user-attachments/assets/db287a12-66fc-4008-a85b-a1a301b3a87f" /> after <img width="1309" alt="Screenshot 2025-05-22 at 14 47 23" src="https://github.com/user-attachments/assets/9e413572-4d9a-46d8-9337-8b9e97465d25" /> confirming no span duplication is happening <img width="850" alt="Screenshot 2025-05-22 at 17 05 52" src="https://github.com/user-attachments/assets/dbb5f939-de80-4fa7-b511-f7f5faffe6e4" /> ## Are there any deployment considerations? changesets ## Does this work require review from our design team? no
diff --git a/e2e/react-router/src/routes/root.tsx b/e2e/react-router/src/routes/root.tsx
@@ -93,6 +93,13 @@ export default function Root() {
 			>
 				LDRecord.snapshot
 			</button>
+			<button
+				onClick={() => {
+					LDRecord.start({ forceNew: true })
+				}}
+			>
+				LDRecord.start(forceNew)
+			</button>
 			<button
 				onClick={async () => {
 					setFlags(
diff --git a/sdk/@launchdarkly/observability/CHANGELOG.md b/sdk/@launchdarkly/observability/CHANGELOG.md
@@ -1,5 +1,19 @@
 # @launchdarkly/observability
 
+## 0.1.14
+
+### Patch Changes
+
+- b22881f: fix plugins not exporting types
+- bcbb6f7: export plugin options correctly
+- 188357c: fix session replay and observability plugin reporting to different sessions
+- 18ff47a: fix span duplication happening due to an unnecessary export retry
+- Updated dependencies [b22881f]
+- Updated dependencies [bcbb6f7]
+- Updated dependencies [188357c]
+- Updated dependencies [18ff47a]
+    - highlight.run@9.18.10
+
 ## 0.1.13
 
 ### Patch Changes
diff --git a/sdk/@launchdarkly/observability/package.json b/sdk/@launchdarkly/observability/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@launchdarkly/observability",
-	"version": "0.1.13",
+	"version": "0.1.14",
 	"description": "Browser observability for your web app. Capture frontend metrics, errors, logs and traces.",
 	"keywords": [
 		"launchdarkly",
diff --git a/sdk/@launchdarkly/observability/src/index.ts b/sdk/@launchdarkly/observability/src/index.ts
@@ -1 +1,2 @@
 export { Observe as default, LDObserve } from 'highlight.run'
+export type { ObserveOptions } from 'highlight.run'
diff --git a/sdk/@launchdarkly/session-replay/CHANGELOG.md b/sdk/@launchdarkly/session-replay/CHANGELOG.md
@@ -1,5 +1,19 @@
 # @launchdarkly/session-replay
 
+## 0.1.14
+
+### Patch Changes
+
+- b22881f: fix plugins not exporting types
+- bcbb6f7: export plugin options correctly
+- 188357c: fix session replay and observability plugin reporting to different sessions
+- 18ff47a: fix span duplication happening due to an unnecessary export retry
+- Updated dependencies [b22881f]
+- Updated dependencies [bcbb6f7]
+- Updated dependencies [188357c]
+- Updated dependencies [18ff47a]
+    - highlight.run@9.18.10
+
 ## 0.1.13
 
 ### Patch Changes
diff --git a/sdk/@launchdarkly/session-replay/package.json b/sdk/@launchdarkly/session-replay/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@launchdarkly/session-replay",
-	"version": "0.1.13",
+	"version": "0.1.14",
 	"description": "Browser observability for your web app. Record session replays to visualize usage patterns.",
 	"keywords": [
 		"launchdarkly",
diff --git a/sdk/@launchdarkly/session-replay/src/index.ts b/sdk/@launchdarkly/session-replay/src/index.ts
@@ -1 +1,2 @@
 export { Record as default, LDRecord } from 'highlight.run'
+export type { RecordOptions } from 'highlight.run'
diff --git a/sdk/highlight-apollo/CHANGELOG.md b/sdk/highlight-apollo/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @highlight-run/apollo
 
+## 3.4.33
+
+### Patch Changes
+
+- @highlight-run/node@3.12.6
+
 ## 3.4.32
 
 ### Patch Changes
diff --git a/sdk/highlight-apollo/package.json b/sdk/highlight-apollo/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@highlight-run/apollo",
-	"version": "3.4.32",
+	"version": "3.4.33",
 	"license": "Apache-2.0",
 	"repository": {
 		"type": "git",
diff --git a/sdk/highlight-hono/CHANGELOG.md b/sdk/highlight-hono/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @highlight-run/hono
 
+## 1.0.9
+
+### Patch Changes
+
+- @highlight-run/node@3.12.6
+
 ## 1.0.8
 
 ### Patch Changes
diff --git a/sdk/highlight-hono/package.json b/sdk/highlight-hono/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@highlight-run/hono",
-	"version": "1.0.8",
+	"version": "1.0.9",
 	"description": "Highlight.io SDK for Hono applications",
 	"repository": {
 		"type": "git",
diff --git a/sdk/highlight-nest/CHANGELOG.md b/sdk/highlight-nest/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @highlight-run/nest
 
+## 3.6.18
+
+### Patch Changes
+
+- @highlight-run/node@3.12.6
+
 ## 3.6.17
 
 ### Patch Changes
diff --git a/sdk/highlight-nest/package.json b/sdk/highlight-nest/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@highlight-run/nest",
-	"version": "3.6.17",
+	"version": "3.6.18",
 	"description": "Client for interfacing with Highlight in nestjs",
 	"repository": {
 		"type": "git",
diff --git a/sdk/highlight-next/CHANGELOG.md b/sdk/highlight-next/CHANGELOG.md
@@ -1,5 +1,17 @@
 # @highlight-run/next
 
+## 7.9.22
+
+### Patch Changes
+
+- Updated dependencies [b22881f]
+- Updated dependencies [bcbb6f7]
+- Updated dependencies [188357c]
+- Updated dependencies [18ff47a]
+    - highlight.run@9.18.10
+    - @highlight-run/node@3.12.6
+    - @highlight-run/react@19.0.10
+
 ## 7.9.21
 
 ### Patch Changes
diff --git a/sdk/highlight-next/package.json b/sdk/highlight-next/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@highlight-run/next",
-	"version": "7.9.21",
+	"version": "7.9.22",
 	"description": "Client for interfacing with Highlight in next.js",
 	"repository": {
 		"type": "git",
diff --git a/sdk/highlight-node/CHANGELOG.md b/sdk/highlight-node/CHANGELOG.md
@@ -1,5 +1,15 @@
 # @highlight-run/node
 
+## 3.12.6
+
+### Patch Changes
+
+- Updated dependencies [b22881f]
+- Updated dependencies [bcbb6f7]
+- Updated dependencies [188357c]
+- Updated dependencies [18ff47a]
+    - highlight.run@9.18.10
+
 ## 3.12.5
 
 ### Patch Changes
diff --git a/sdk/highlight-node/package.json b/sdk/highlight-node/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@highlight-run/node",
-	"version": "3.12.5",
+	"version": "3.12.6",
 	"license": "Apache-2.0",
 	"repository": {
 		"type": "git",
diff --git a/sdk/highlight-react/CHANGELOG.md b/sdk/highlight-react/CHANGELOG.md
@@ -1,5 +1,15 @@
 # @highlight-run/react
 
+## 19.0.10
+
+### Patch Changes
+
+- Updated dependencies [b22881f]
+- Updated dependencies [bcbb6f7]
+- Updated dependencies [188357c]
+- Updated dependencies [18ff47a]
+    - highlight.run@9.18.10
+
 ## 19.0.9
 
 ### Patch Changes
diff --git a/sdk/highlight-react/package.json b/sdk/highlight-react/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@highlight-run/react",
-	"version": "19.0.9",
+	"version": "19.0.10",
 	"description": "The official Highlight SDK for React",
 	"license": "Apache-2.0",
 	"repository": {
diff --git a/sdk/highlight-remix/CHANGELOG.md b/sdk/highlight-remix/CHANGELOG.md
@@ -1,5 +1,17 @@
 # @highlight-run/remix
 
+## 2.0.105
+
+### Patch Changes
+
+- Updated dependencies [b22881f]
+- Updated dependencies [bcbb6f7]
+- Updated dependencies [188357c]
+- Updated dependencies [18ff47a]
+    - highlight.run@9.18.10
+    - @highlight-run/node@3.12.6
+    - @highlight-run/react@19.0.10
+
 ## 2.0.104
 
 ### Patch Changes
diff --git a/sdk/highlight-remix/package.json b/sdk/highlight-remix/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@highlight-run/remix",
-	"version": "2.0.104",
+	"version": "2.0.105",
 	"description": "Client for interfacing with Highlight in Remix",
 	"repository": {
 		"type": "git",
diff --git a/sdk/highlight-run/CHANGELOG.md b/sdk/highlight-run/CHANGELOG.md
@@ -1,5 +1,14 @@
 # highlight.run
 
+## 9.18.10
+
+### Patch Changes
+
+- b22881f: fix plugins not exporting types
+- bcbb6f7: export plugin options correctly
+- 188357c: fix session replay and observability plugin reporting to different sessions
+- 18ff47a: fix span duplication happening due to an unnecessary export retry
+
 ## 9.18.9
 
 ### Patch Changes
diff --git a/sdk/highlight-run/package.json b/sdk/highlight-run/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "highlight.run",
-	"version": "9.18.9",
+	"version": "9.18.10",
 	"description": "Open source, fullstack monitoring. Capture frontend errors, record server side logs, and visualize what broke with session replay.",
 	"keywords": [
 		"highlight",
diff --git a/sdk/highlight-run/src/client/index.tsx b/sdk/highlight-run/src/client/index.tsx
@@ -404,13 +404,7 @@ export class Highlight {
 		const client = new GraphQLClient(`${this._backendUrl}`, {
 			headers: {},
 		})
-		this.graphqlSDK = getSdk(
-			client,
-			getGraphQLRequestWrapper(
-				this.sessionData?.sessionSecureID ||
-					this.options?.sessionSecureID,
-			),
-		)
+		this.graphqlSDK = getSdk(client, getGraphQLRequestWrapper())
 		this.environment = options.environment ?? 'production'
 		this.appVersion = options.appVersion
 		this.serviceName = options.serviceName ?? ''
diff --git a/sdk/highlight-run/src/client/otel/exporter.ts b/sdk/highlight-run/src/client/otel/exporter.ts
@@ -47,13 +47,18 @@ export class OTLPTraceExporterBrowserWithXhrRetry extends OTLPTraceExporter {
 		}
 		let retries = 0
 		const retry = (result: ExportResult) => {
+			if (result.code === ExportResultCode.SUCCESS) {
+				return resultCallback({
+					code: ExportResultCode.SUCCESS,
+				})
+			}
 			retries++
 			if (retries > MAX_PUBLIC_GRAPH_RETRY_ATTEMPTS) {
 				console.error(
-					`[highlight.io] failed to export OTeL traces: ${result.error?.message}`,
+					`[@launchdarkly/observability] failed to export OTeL traces: ${result.error?.message}`,
 					result.error,
 				)
-				resultCallback({
+				return resultCallback({
 					code: ExportResultCode.FAILED,
 					error: result.error,
 				})
@@ -64,7 +69,11 @@ export class OTLPTraceExporterBrowserWithXhrRetry extends OTLPTraceExporter {
 						BASE_DELAY_MS + BACKOFF_DELAY_MS * Math.pow(2, retries),
 					),
 				).then(() => {
-					super.export(items, resultCallback)
+					console.warn(
+						`[@launchdarkly/observability] retry ${retries}, failed to export OTeL traces: ${result.error?.message}`,
+						result.error,
+					)
+					super.export(sampledItems, retry)
 				})
 			}
 		}
@@ -84,13 +93,18 @@ export class OTLPMetricExporterBrowser extends OTLPMetricExporter {
 	export(items: any, resultCallback: (result: ExportResult) => void) {
 		let retries = 0
 		const retry = (result: ExportResult) => {
+			if (result.code === ExportResultCode.SUCCESS) {
+				return resultCallback({
+					code: ExportResultCode.SUCCESS,
+				})
+			}
 			retries++
 			if (retries > MAX_PUBLIC_GRAPH_RETRY_ATTEMPTS) {
 				console.error(
-					`[highlight.io] failed to export OTeL metrics: ${result.error?.message}`,
+					`[@launchdarkly/observability] failed to export OTeL metrics: ${result.error?.message}`,
 					result.error,
 				)
-				resultCallback({
+				return resultCallback({
 					code: ExportResultCode.FAILED,
 					error: result.error,
 				})
@@ -101,7 +115,11 @@ export class OTLPMetricExporterBrowser extends OTLPMetricExporter {
 						BASE_DELAY_MS + BACKOFF_DELAY_MS * Math.pow(2, retries),
 					),
 				).then(() => {
-					super.export(items, resultCallback)
+					console.warn(
+						`[@launchdarkly/observability] retry ${retries}, failed to export OTeL metrics: ${result.error?.message}`,
+						result.error,
+					)
+					super.export(items, retry)
 				})
 			}
 		}
diff --git a/sdk/highlight-run/src/client/otel/index.ts b/sdk/highlight-run/src/client/otel/index.ts
@@ -1,5 +1,5 @@
 import * as api from '@opentelemetry/api'
-import { Span } from '@opentelemetry/api'
+import { Context, Span } from '@opentelemetry/api'
 import {
 	CompositePropagator,
 	W3CBaggagePropagator,
@@ -21,6 +21,7 @@ import {
 	SimpleSpanProcessor,
 	StackContextManager,
 	WebTracerProvider,
+	Span as SDKSpan,
 } from '@opentelemetry/sdk-trace-web'
 import * as SemanticAttributes from '@opentelemetry/semantic-conventions'
 import { parse } from 'graphql'
@@ -55,6 +56,7 @@ import { IntegrationClient } from '../../integrations'
 import { LD_METRIC_NAME_DOCUMENT_LOAD } from '../../integrations/launchdarkly'
 
 import { ExportSampler } from './sampling/ExportSampler'
+import { getPersistentSessionSecureID } from '../utils/sessionStorage/highlightSession'
 export type Callback = (span?: Span) => any
 
 export type BrowserTracingConfig = {
@@ -77,6 +79,7 @@ let providers: {
 } = {}
 let otelConfig: BrowserTracingConfig | undefined
 const RECORD_ATTRIBUTE = 'highlight.record'
+const SESSION_ID_ATTRIBUTE = 'highlight.session_id'
 export const LOG_SPAN_NAME = 'launchdarkly.js.log'
 
 export const setupBrowserTracing = (
@@ -131,7 +134,6 @@ export const setupBrowserTracing = (
 			config.serviceName ?? 'highlight-browser',
 		[SemanticAttributes.SEMRESATTRS_DEPLOYMENT_ENVIRONMENT]: environment,
 		'highlight.project_id': config.projectId,
-		'highlight.session_id': config.sessionSecureId,
 	})
 
 	providers.tracerProvider = new WebTracerProvider({
@@ -314,6 +316,11 @@ export const setupBrowserTracing = (
 }
 
 class CustomBatchSpanProcessor extends BatchSpanProcessor {
+	onStart(span: SDKSpan, parentContext: Context): void {
+		span.setAttribute(SESSION_ID_ATTRIBUTE, getPersistentSessionSecureID())
+		super.onStart(span, parentContext)
+	}
+
 	onEnd(span: ReadableSpan): void {
 		if (span.attributes[RECORD_ATTRIBUTE] === false) {
 			return // don't record spans that are marked as not to be recorded
diff --git a/sdk/highlight-run/src/client/types/client.ts b/sdk/highlight-run/src/client/types/client.ts
diff --git a/sdk/highlight-run/src/client/types/observe.ts b/sdk/highlight-run/src/client/types/observe.ts
diff --git a/sdk/highlight-run/src/client/types/record.ts b/sdk/highlight-run/src/client/types/record.ts
diff --git a/sdk/highlight-run/src/client/types/types.ts b/sdk/highlight-run/src/client/types/types.ts
diff --git a/sdk/highlight-run/src/client/utils/graph.ts b/sdk/highlight-run/src/client/utils/graph.ts
diff --git a/sdk/highlight-run/src/client/utils/sessionStorage/highlightSession.ts b/sdk/highlight-run/src/client/utils/sessionStorage/highlightSession.ts
diff --git a/sdk/highlight-run/src/client/workers/highlight-client-worker.ts b/sdk/highlight-run/src/client/workers/highlight-client-worker.ts
diff --git a/sdk/highlight-run/src/index.tsx b/sdk/highlight-run/src/index.tsx
diff --git a/sdk/highlight-run/src/integrations/launchdarkly/index.ts b/sdk/highlight-run/src/integrations/launchdarkly/index.ts
diff --git a/sdk/highlight-run/src/plugins/common.ts b/sdk/highlight-run/src/plugins/common.ts
diff --git a/sdk/highlight-run/src/sdk/observe.ts b/sdk/highlight-run/src/sdk/observe.ts
diff --git a/sdk/highlight-run/src/sdk/record.ts b/sdk/highlight-run/src/sdk/record.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@launchdarkly/observability",`
`3`		`- "version": "0.1.13",`
	`3`	`+ "version": "0.1.14",`
`4`	`4`	`"description": "Browser observability for your web app. Capture frontend metrics, errors, logs and traces.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"launchdarkly",`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`export { Observe as default, LDObserve } from 'highlight.run'`
	`2`	`+export type { ObserveOptions } from 'highlight.run'`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@launchdarkly/session-replay",`
`3`		`- "version": "0.1.13",`
	`3`	`+ "version": "0.1.14",`
`4`	`4`	`"description": "Browser observability for your web app. Record session replays to visualize usage patterns.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"launchdarkly",`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`export { Record as default, LDRecord } from 'highlight.run'`
	`2`	`+export type { RecordOptions } from 'highlight.run'`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@highlight-run/apollo",`
`3`		`- "version": "3.4.32",`
	`3`	`+ "version": "3.4.33",`
`4`	`4`	`"license": "Apache-2.0",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`