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

packages/pwa-kit-react-sdk/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## v3.11.0-dev.0 (May 23, 2025)
 - Fix the performance logging so that it'll capture all SSR queries, even those that result in errors [#2486](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2486)
+- Created an opentelemetry server for SSR tracer intialization [#2617](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2617)
 
 ## v3.10.0 (May 22, 2025)
 - Fix the performance logging util to use the correct delimiter for the server-timing header. [#2225](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2295)

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

@@ -37,6 +37,12 @@
     "@loadable/babel-plugin": "^5.15.3",
     "@loadable/server": "^5.15.3",
     "@loadable/webpack-plugin": "^5.15.2",
+    "@opentelemetry/api": "^1.4.1",
+    "@opentelemetry/propagator-b3": "^1.15.1",
+    "@opentelemetry/resources": "^1.15.1",
+    "@opentelemetry/sdk-trace-base": "^1.15.1",
+    "@opentelemetry/sdk-trace-node": "^1.15.1",
+    "@opentelemetry/semantic-conventions": "^1.15.1",
     "@salesforce/pwa-kit-runtime": "3.11.0-dev.0",
     "@tanstack/react-query": "^4.28.0",
     "cross-env": "^5.2.1",

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

@@ -0,0 +1,103 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import {NodeTracerProvider} from '@opentelemetry/sdk-trace-node'
+import {SimpleSpanProcessor} from '@opentelemetry/sdk-trace-base'
+import {B3Propagator} from '@opentelemetry/propagator-b3'
+import {Resource} from '@opentelemetry/resources'
+import {propagation} from '@opentelemetry/api'
+import logger from '../../utils/logger-instance'
+
+const DEFAULT_SERVICE_NAME = 'pwa-kit-react-sdk'
+
+let provider = null
+
+/**
+ * Initialize OpenTelemetry tracing for server-side rendering
+ * @param {Object} options
+ * @param {string} [options.serviceName]
+ * @param {string} [options.serviceVersion]
+ * @param {boolean} [options.enabled]
+ * @returns {NodeTracerProvider|null}
+ */
+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
+
+    // If tracing is disabled, return null without initializing
+    if (!enabled) {
+        return null
+    }
+
+    try {
+        // Build resource attributes
+        const resourceAttributes = {
+            'service.name': serviceName
+        }
+
+        // Add service version if provided
+        if (serviceVersion) {
+            resourceAttributes['service.version'] = serviceVersion
+        }
+
+        // Initialize the tracer provider
+        provider = new NodeTracerProvider({
+            resource: new Resource(resourceAttributes),
+            spanProcessor: new SimpleSpanProcessor()
+        })
+
+        // Add B3 propagator
+        propagation.setGlobalPropagator(new B3Propagator())
+        provider.register()
+
+        return provider
+    } catch (error) {
+        // Log errors from OpenTelemetry initialization
+        logger.error('Failed to initialize OpenTelemetry provider', {
+            namespace: 'opentelemetry-server.initializeServerTracing',
+            additionalProperties: {error: error.message}
+        })
+        return null
+    }
+}
+
+/**
+ * Shutdown OpenTelemetry tracing and clean up resources
+ * @returns {Promise<void>}
+ */
+export const shutdownServerTracing = async () => {
+    if (provider) {
+        try {
+            await provider.shutdown()
+            provider = null // Clean up after successful shutdown
+        } catch (error) {
+            logger.warn('Failed to shutdown OpenTelemetry provider', {
+                namespace: 'opentelemetry-server.shutdownServerTracing',
+                additionalProperties: {error: error.message}
+            })
+        }
+    }
+}
+
+/**
+ * Get the current OpenTelemetry provider instance
+ * @returns {NodeTracerProvider|null} The current provider or null if not initialized
+ */
+export const getServerTracingProvider = () => {
+    return provider
+}
+
+/**
+ * Check if OpenTelemetry tracing is currently initialized
+ * @returns {boolean} True if tracing is initialized, false otherwise
+ */
+export const isServerTracingInitialized = () => {
+    return provider !== null
+}