chore: move user-agents into a new module

Author: rowanmanning

packages/opentelemetry/lib/config/user-agents.js

@@ -0,0 +1,7 @@
+const appInfo = require('@dotcom-reliability-kit/app-info');
+const packageJson = require('../../package.json');
+const traceExporterPackageJson = require('@opentelemetry/exporter-trace-otlp-proto/package.json');
+
+const BASE_USER_AGENT = `FTSystem/${appInfo.systemCode} (${packageJson.name}/${packageJson.version})`;
+
+exports.TRACING_USER_AGENT = `${BASE_USER_AGENT} (${traceExporterPackageJson.name}/${traceExporterPackageJson.version})`;

packages/opentelemetry/lib/index.js

@@ -1,21 +1,16 @@
-const packageJson = require('../package.json');
 const { createInstrumentationConfig } = require('./config/instrumentations');
 const { createResourceConfig } = require('./config/resource');
 const { diag, DiagLogLevel } = require('@opentelemetry/api');
 const opentelemetrySDK = require('@opentelemetry/sdk-node');
-const appInfo = require('@dotcom-reliability-kit/app-info');
 const {
 	OTLPTraceExporter
 } = require('@opentelemetry/exporter-trace-otlp-proto');
-const traceExporterPackageJson = require('@opentelemetry/exporter-trace-otlp-proto/package.json');
 const {
 	NoopSpanProcessor,
 	TraceIdRatioBasedSampler
 } = require('@opentelemetry/sdk-trace-base');
 const logger = require('@dotcom-reliability-kit/logger');
-
-const USER_AGENT = `FTSystem/${appInfo.systemCode} (${packageJson.name}/${packageJson.version})`;
-const TRACING_USER_AGENT = `${USER_AGENT} (${traceExporterPackageJson.name}/${traceExporterPackageJson.version})`;
+const { TRACING_USER_AGENT } = require('./config/user-agents');
 
 const DEFAULT_SAMPLE_PERCENTAGE = 5;
 

packages/opentelemetry/test/unit/lib/config/user-agents.spec.js

@@ -0,0 +1,23 @@
+jest.mock('@dotcom-reliability-kit/app-info', () => ({
+	systemCode: 'mock-system-code'
+}));
+jest.mock('../../../../package.json', () => ({
+	name: 'mock-package',
+	version: '1.2.3'
+}));
+jest.mock('@opentelemetry/exporter-trace-otlp-proto/package.json', () => ({
+	name: 'mock-otel-tracing-package',
+	version: '3.4.5'
+}));
+
+const { TRACING_USER_AGENT } = require('../../../../lib/config/user-agents');
+
+describe('@dotcom-reliability-kit/opentelemetry/lib/config/resource', () => {
+	describe('.TRACING_USER_AGENT', () => {
+		it('is set based on app info and package versions', () => {
+			expect(TRACING_USER_AGENT).toStrictEqual(
+				'FTSystem/mock-system-code (mock-package/1.2.3) (mock-otel-tracing-package/3.4.5)'
+			);
+		});
+	});
+});

packages/opentelemetry/test/unit/lib/index.spec.js

@@ -1,15 +1,6 @@
-jest.mock('../../../package.json', () => ({
-	name: 'mock-package',
-	version: '1.2.3'
-}));
 jest.mock('@opentelemetry/exporter-trace-otlp-proto');
-jest.mock('@opentelemetry/exporter-trace-otlp-proto/package.json', () => ({
-	name: 'mock-otel-tracing-package',
-	version: '3.4.5'
-}));
 jest.mock('@opentelemetry/sdk-trace-base');
 jest.mock('@opentelemetry/sdk-node');
-jest.mock('@dotcom-reliability-kit/app-info');
 jest.mock('@opentelemetry/api');
 jest.mock('@dotcom-reliability-kit/logger');
 jest.mock('../../../lib/config/instrumentations', () => ({
@@ -20,6 +11,9 @@ jest.mock('../../../lib/config/instrumentations', () => ({
 jest.mock('../../../lib/config/resource', () => ({
 	createResourceConfig: jest.fn().mockReturnValue('mock-resource')
 }));
+jest.mock('../../../lib/config/user-agents', () => ({
+	TRACING_USER_AGENT: 'mock-tracing-user-agent'
+}));
 
 const {
 	createInstrumentationConfig
@@ -28,7 +22,6 @@ const { createResourceConfig } = require('../../../lib/config/resource');
 const { diag, DiagLogLevel } = require('@opentelemetry/api');
 const logger = require('@dotcom-reliability-kit/logger');
 const opentelemetrySDK = require('@opentelemetry/sdk-node');
-const appInfo = require('@dotcom-reliability-kit/app-info');
 const {
 	OTLPTraceExporter
 } = require('@opentelemetry/exporter-trace-otlp-proto');
@@ -37,13 +30,6 @@ const {
 	TraceIdRatioBasedSampler
 } = require('@opentelemetry/sdk-trace-base');
 
-// Set up the mock
-appInfo.systemCode = 'MOCK_SYSTEM_CODE';
-appInfo.releaseVersion = 'MOCK_RELEASE_VERSION';
-appInfo.cloudProvider = 'MOCK_CLOUD_PROVIDER';
-appInfo.region = 'MOCK_CLOUD_REGION';
-appInfo.environment = 'MOCK_ENVIRONMENT';
-
 logger.createChildLogger.mockReturnValue('mock child logger');
 DiagLogLevel.INFO = 'mock info log level';
 
@@ -99,8 +85,7 @@ describe('@dotcom-reliability-kit/opentelemetry', () => {
 			expect(OTLPTraceExporter).toHaveBeenCalledWith({
 				url: 'MOCK_TRACING_ENDPOINT',
 				headers: {
-					'user-agent':
-						'FTSystem/MOCK_SYSTEM_CODE (mock-package/1.2.3) (mock-otel-tracing-package/3.4.5)'
+					'user-agent': 'mock-tracing-user-agent'
 				}
 			});
 			expect(
@@ -147,8 +132,7 @@ describe('@dotcom-reliability-kit/opentelemetry', () => {
 				url: 'MOCK_TRACING_ENDPOINT',
 				headers: {
 					authorization: 'mock-authorization-header',
-					'user-agent':
-						'FTSystem/MOCK_SYSTEM_CODE (mock-package/1.2.3) (mock-otel-tracing-package/3.4.5)'
+					'user-agent': 'mock-tracing-user-agent'
 				}
 			});
 		});