@W-18759755 - Creating tests and a server for open telemetry within the pwa-kit-rea… by larnelleankunda · Pull Request #2617 · SalesforceCommerceCloud/pwa-kit

larnelleankunda · 2025-06-20T23:32:10Z

Creating tests and a server for open telemetry within the pwa-kit-react-sdk folder acting as a service provider

Description

<!
Implemented the functions to initialize and shutdown OTel tracing
Implemented initializeServerTracing and shutdownServerTracing functions into the open telemetry server
B3 propagation is properly set up for tracing
Error handling is implemented to catch and log failures
Wrote unit tests with 100% coverage of new code>

Types of Changes

Bug fix (non-breaking change that fixes an issue)
New feature (non-breaking change that adds functionality)
Documentation update
Breaking change (could cause existing functionality to not work as expected)
Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

Removing a public function or component or prop

Adding a required argument to a function

Changing the data type of a function parameter or return value

Adding a new peer dependency to package.json

Changes

(step1)

How to Test-Drive This PR

Start your PWA Kit application
Check console logs for any OpenTelemetry initialization messages
No errors related to OpenTelemetry initialization should be received
-To verify B3 Propagation you have make a request to the PWA Kit app locally.
Check response headers for B3 trace context headers:
b3 header (single header format)
Or X-B3-SpanId, X-B3-TracenId, X-B3-Sampled
-The B3 headers should be present in responses
-In Verifying its Shutdown you should stop the application and no OpenTelemetry-related errors during shutdown should be seen.

Checklists

General

Changes are covered by test cases
CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

There are no changes to UI

or...

Changes were tested with a Screen Reader (iOS VoiceOver or Android Talkback) and had no issues
Changes comply with WCAG 2.0 guidelines levels A and AA
Changes to common UI patterns and interactions comply with WAI-ARIA best practices

Localization

Changes include a UI text update in the Retail React App (which requires translation)

…ct-sdk folder acting as a service provider

cc-prodsec · 2025-06-20T23:32:22Z

🎉 Snyk checks have passed. No issues have been found so far.

✅ security/snyk check is complete. No issues have been found. (View Details)

✅ license/snyk check is complete. No issues have been found. (View Details)

…ct-sdk folder acting as a service provider

…ith open telemetry dependencies

yunakim714 · 2025-06-24T18:11:23Z

@larnelleankunda Hey Larnelle! I would create a feature branch that we can merge into, so that we are not merging an incomplete feature into the develop branch.

Could you also update the PR description - I see this at the top not sure if it cut something off! "…ct-sdk folder acting as a service provider"

yunakim714 · 2025-06-25T15:35:15Z

packages/pwa-kit-react-sdk/src/ssr/server/opentelemetry-server.js

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2024, Salesforce, Inc.


Suggested change

* Copyright (c) 2024, Salesforce, Inc.

* Copyright (c) 2025, Salesforce, Inc.

yunakim714 · 2025-06-25T15:36:11Z

packages/pwa-kit-react-sdk/package.json

    "@loadable/server": "^5.15.3",
    "@loadable/webpack-plugin": "^5.15.2",
+    "@opentelemetry/api": "^1.4.1",
+    "@opentelemetry/core": "^1.15.1",


Do we need to include the @opentelemetry/core package here? We are not importing anything from this package in the new opentelemetry-server.js file

I was migrating all the packages from the POC branch into this package.json but I can remove the core package.

yunakim714 · 2025-06-25T15:36:25Z

packages/pwa-kit-react-sdk/src/ssr/server/opentelemetry-server.test.js

+ * @jest-environment node
+ */
+/*
+ * Copyright (c) 2024, Salesforce, Inc.


Suggested change

* Copyright (c) 2024, Salesforce, Inc.

* Copyright (c) 2025, Salesforce, Inc.

…rver.js

adamraya · 2025-06-26T20:10:30Z

packages/pwa-kit-react-sdk/src/ssr/server/opentelemetry-server.js

+ * Initialize OpenTelemetry tracing for server-side rendering
+ * @returns {NodeTracerProvider|null} The initialized provider or null if initialization failed
+ */
+export const initializeServerTracing = () => {


Would you consider making the telemetry configurable by passing options to the initializeServerTracing?

Something like this:

Suggested change

export const initializeServerTracing = () => {

export const initializeServerTracing = (options={}) => {

const {

serviceName = process.env.OTEL_SERVICE_NAME || DEFAULT_SERVICE_NAME,

serviceVersion = process.env.npm_package_version,

enabled = process.env.OTEL_SDK_ENABLED=== 'true'

} = options

...

adamraya · 2025-06-26T21:06:46Z

packages/pwa-kit-react-sdk/src/ssr/server/opentelemetry-server.js

+        return provider
+    } catch (error) {
+        // Log errors from OpenTelemetry initialization
+        console.warn('Failed to initialize OpenTelemetry provider:', error.message)


Let's emit the log warnings using the PWAKitLogger to add a namespace.

E.g.

pwa-kit/packages/pwa-kit-react-sdk/src/ssr/server/react-rendering.js

Line 73 in 2c1e74d

logger.error(cause, {namespace: 'react-rendering.render'})

adamraya · 2025-06-26T21:07:24Z

packages/pwa-kit-react-sdk/src/ssr/server/opentelemetry-server.js

+            await provider.shutdown()
+            provider = null // Clean up after successful shutdown
+        } catch (error) {
+            console.warn('Failed to shutdown OpenTelemetry provider:', error.message)


Same, let's use logger instead of directly using console.

adamraya · 2025-06-26T21:11:58Z

packages/pwa-kit-react-sdk/src/ssr/server/opentelemetry-server.js

+        // Initialize the tracer provider
+        provider = new NodeTracerProvider({
+            resource: new Resource({
+                [SemanticResourceAttributes.SERVICE_NAME]: SERVICE_NAME


Did you look into the deprecation warnings?

It looks like SemanticResourceAttributes is deprecated an we should instead SEMRESATTRS_SERVICE_NAME

adamraya · 2025-06-30T19:27:52Z

packages/pwa-kit-react-sdk/src/ssr/server/opentelemetry-server.js

+export const initializeServerTracing = (options = {}) => {
+    const {
+        serviceName = process.env.OTEL_SERVICE_NAME || DEFAULT_SERVICE_NAME,
+        serviceVersion = process.env.npm_package_version,


@larnelleankunda Thanks for adding the telemetry options! It was my bad for not clarifying the code I shared was just an example of possible configuration options. Since process.env.npm_package_version will always be undefined, let’s remove it for now. We can explore a better way to include it later if needed.

Suggested change

serviceVersion = process.env.npm_package_version,

Creating tests and a server for open telemetry within the pwa-kit-rea…

ae56f79

…ct-sdk folder acting as a service provider

larnelleankunda requested a review from a team as a code owner June 20, 2025 23:32

larnelleankunda changed the title ~~Creating tests and a server for open telemetry within the pwa-kit-rea…~~ W-18759755 - Creating tests and a server for open telemetry within the pwa-kit-rea… Jun 20, 2025

larnelleankunda changed the title ~~W-18759755 - Creating tests and a server for open telemetry within the pwa-kit-rea…~~ @W-18759755 - Creating tests and a server for open telemetry within the pwa-kit-rea… Jun 20, 2025

larnelleankunda added 6 commits June 20, 2025 16:57

Creating tests and a server for open telemetry within the pwa-kit-rea…

b442012

…ct-sdk folder acting as a service provider

Updating my package lock.json file for the pwa-kit-react-sdk folder w…

6f50178

…ith open telemetry dependencies

Updated the open telemetry tests

c6c1d89

Linted open telemetry files

f03ca23

Linted open telemetry files

245f60d

Linted open telemetry files

a6d0bb7

larnelleankunda changed the base branch from develop to feature/opentelemetry-clean June 24, 2025 21:35

larnelleankunda changed the base branch from feature/opentelemetry-clean to feature/opentelemetry June 24, 2025 21:41

yunakim714 requested review from adamraya, jeremy-jung1 and yunakim714 June 25, 2025 15:33

yunakim714 reviewed Jun 25, 2025

View reviewed changes

larnelleankunda added 2 commits June 25, 2025 10:37

updated open telemetry files

dc48667

Merge branch 'feature/opentelemetry' into W-18759755-opentelemetry-se…

e246905

…rver.js

adamraya reviewed Jun 26, 2025

View reviewed changes

larnelleankunda added 4 commits June 26, 2025 16:47

made changes to server and test files

40c3da9

made changes to server and test files

8095da0

made changes to server and test files

6cc769a

made changes to test files

c2f1b91

adamraya reviewed Jun 30, 2025

View reviewed changes

adamraya approved these changes Jun 30, 2025

View reviewed changes

made changes to test and server files

9130b9a

jeremy-jung1 approved these changes Jul 1, 2025

View reviewed changes

larnelleankunda merged commit cb22899 into feature/opentelemetry Jul 1, 2025
35 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

@W-18759755 - Creating tests and a server for open telemetry within the pwa-kit-rea…#2617

@W-18759755 - Creating tests and a server for open telemetry within the pwa-kit-rea…#2617
larnelleankunda merged 14 commits intofeature/opentelemetryfrom
W-18759755-opentelemetry-server.js

larnelleankunda commented Jun 20, 2025 •

edited

Loading

Uh oh!

cc-prodsec commented Jun 20, 2025 •

edited

Loading

Uh oh!

yunakim714 commented Jun 24, 2025

Uh oh!

yunakim714 Jun 25, 2025

Uh oh!

yunakim714 Jun 25, 2025

Uh oh!

larnelleankunda Jun 25, 2025

Uh oh!

yunakim714 Jun 25, 2025

Uh oh!

adamraya Jun 26, 2025

Uh oh!

adamraya Jun 26, 2025

Uh oh!

adamraya Jun 26, 2025

Uh oh!

adamraya Jun 26, 2025

Uh oh!

adamraya Jun 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	* Copyright (c) 2024, Salesforce, Inc.
	* Copyright (c) 2025, Salesforce, Inc.

Conversation

larnelleankunda commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of Changes

Changes

How to Test-Drive This PR

Checklists

General

Accessibility Compliance

Localization

Uh oh!

cc-prodsec commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎉 Snyk checks have passed. No issues have been found so far.

Uh oh!

yunakim714 commented Jun 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

larnelleankunda commented Jun 20, 2025 •

edited

Loading

cc-prodsec commented Jun 20, 2025 •

edited

Loading