chore(admin): Delete unused code from fxa-shared

Because:
- Cleaning up code duplication, in favor of code ported to libs

This Commit:
- Deletes unreferenced code

Author: dschom

libs/shared/monitoring/src/index.ts

@@ -15,24 +15,68 @@ export type MonitoringConfig = {
 
 let initialized = false;
 
-// IMPORTANT! This initialization function must be called first thing when a server starts. If it's called after server
-// frameworks initialized instrumentation might not work properly.
+/**
+ *  IMPORTANT! This initialization function must be called first thing when a server starts. If it's called after server
+ *  frameworks initialized instrumentation might not work properly.
+ */
+
 /**
  * Initializes modules related to error monitoring, performance monitoring, and tracing.
  * @param opts - Initialization options. See underlying implementations for more details.
  */
 export function initMonitoring(opts: MonitoringConfig) {
-  const { log, config } = opts;
+  const { log: logger, config } = opts;
+  const log = logger || console;
+
   if (initialized) {
-    opts.log?.warn('monitoring', 'Monitoring can only be initialized once');
+    log.warn('monitoring', 'Monitoring can only be initialized once');
     return;
   }
   initialized = true;
 
+  /**
+   * IMPORTANT!
+   *
+   * Sentry also uses OTEL under the hood. Which means:
+   *   - Mind the order of initialization. Otel should be first, if configured!
+   *   - Mind the config.tracing.sentry.enabled flag
+   *   - Mind the config.sentry.skipOpenTelemetrySetup flag
+   *
+   * If the order or flags aren't correct the following could happen:
+   *   - Traces disappear
+   *   - Sentry errors don't get recorded
+   *   - Sentry context bleeds between requests (ie breadcrumbs, stack traces, etc. seem off)
+   */
+
+  let nodeTracingInitialized = false;
   if (config.tracing) {
-    initTracing(config.tracing, log || console);
+    // Important! Sentry also uses OTEL under the hood. Flip this flag so the two can co-exist!
+    // If you start seeing funny stack traces, or cross pollinating bread crumbs, something went
+    // sideways here.
+    if (config.sentry?.dsn) {
+      config.tracing.sentry = { enabled: true };
+    }
+
+    log.info('monitoring', {
+      msg: `Initialize Tracing with: ${JSON.stringify(config.tracing)}`,
+    });
+    nodeTracingInitialized = !!initTracing(config.tracing, log);
   }
+
+  // Important! Order matters here. If otel is configured, this shoudl be done after OTEL initialization!
   if (config && config.sentry) {
-    initSentry(config, log || console);
+    if (nodeTracingInitialized) {
+      config.sentry.skipOpenTelemetrySetup = true;
+    }
+
+    log.info('monitoring', {
+      msg: `Initializing Sentry: ${JSON.stringify({
+        env: config.sentry?.env,
+        clientName: config.sentry.clientName,
+        serverName: config.sentry.serverName,
+        hasDsn: !!config.sentry?.dsn,
+      })}`,
+    });
+    initSentry(config, log);
   }
 }

libs/shared/sentry-utils/src/lib/models/sentry-config-opts.ts

@@ -30,6 +30,9 @@ export type SentryConfigOpts = {
     /** The tracing sample rate. Setting this above 0 will aso result in performance metrics being captured. */
     tracesSampleRate?: number;
 
+    /** Flag indicating that otel should not be setup. */
+    skipOpenTelemetrySetup?: boolean;
+
     /** A function that determines the sample rate for a given event. Setting this will override tracesSampleRate. */
     tracesSampler?: (context: { name?: string }) => number;
 

packages/fxa-admin-panel/server/jest.config.js

@@ -20,6 +20,15 @@ module.exports = {
   moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, {
     prefix: '<rootDir>/../../../',
   }),
+  moduleNameMapper: {
+    ...pathsToModuleNameMapper(compilerOptions.paths, {
+      prefix: '<rootDir>/../../../',
+    }),
+    '^@opentelemetry/otlp-exporter-base/node-http$':
+      '@opentelemetry/otlp-exporter-base/build/src/index-node-http.js',
+    '^@opentelemetry/otlp-exporter-base/browser-http$':
+      '@opentelemetry/otlp-exporter-base/build/src/index-browser-http.js',
+  },
   coveragePathIgnorePatterns: ['<rootDir>'],
   coverageThreshold: {
     global: {

packages/fxa-auth-server/bin/key_server.js

@@ -21,7 +21,7 @@ const {
   ProductConfigurationManager,
   StrapiClient,
 } = require('@fxa/shared/cms');
-const { TracingProvider } = require('@fxa/shared/otel');
+const { getCurrent: getCurrentTracingProvider } = require('@fxa/shared/otel');
 
 const { AppError: error } = require('@fxa/accounts/errors');
 const { JWTool } = require('@fxa/vendored/jwtool');
@@ -87,7 +87,7 @@ async function run(config) {
   const log = require('../lib/log')({
     ...config.log,
     statsd,
-    nodeTracer: TracingProvider.getCurrent(),
+    nodeTracer: getCurrentTracingProvider(),
   });
   Container.set(AuthLogger, log);
 

packages/fxa-auth-server/jest.config.js

@@ -2,6 +2,9 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+const { pathsToModuleNameMapper } = require('ts-jest');
+const { compilerOptions } = require('../../tsconfig.base.json');
+
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
@@ -13,11 +16,13 @@ module.exports = {
   },
   transformIgnorePatterns: ['/node_modules/(?!(@fxa|fxa-shared)/)'],
   moduleNameMapper: {
-    '^@fxa/shared/(.*)$': '<rootDir>/../../libs/shared/$1/src',
-    '^@fxa/accounts/(.*)$': '<rootDir>/../../libs/accounts/$1/src',
-    '^@fxa/payments/(.*)$': '<rootDir>/../../libs/payments/$1/src',
-    '^@fxa/profile/(.*)$': '<rootDir>/../../libs/profile/$1/src',
-    '^fxa-shared/(.*)$': '<rootDir>/../fxa-shared/$1',
+    ...pathsToModuleNameMapper(compilerOptions.paths, {
+      prefix: '<rootDir>/../../../',
+    }),
+    '^@opentelemetry/otlp-exporter-base/node-http$':
+      '@opentelemetry/otlp-exporter-base/build/src/index-node-http.js',
+    '^@opentelemetry/otlp-exporter-base/browser-http$':
+      '@opentelemetry/otlp-exporter-base/build/src/index-browser-http.js',
   },
   testTimeout: 10000,
   clearMocks: true,

packages/fxa-auth-server/lib/log.js

@@ -68,10 +68,11 @@ Lug.prototype.getTraceId = function (data) {
 
   if (this.nodeTracer) {
     try {
-      result = { traceId: this.nodeTracer.getTraceId() };
-    } catch {
+      result = { traceId: this.nodeTracer.getTraceParentId() };
+    } catch (err) {
       // don't let a tracing issue break logging
-      this.debug('log', { msg: 'could not get trace id' });
+      console.warn('Could not get trace id');
+      console.error(err);
     }
   }
   return result;

packages/fxa-auth-server/test/local/server.js

@@ -18,7 +18,7 @@ const customs = mocks.mockCustoms();
 const sandbox = sinon.createSandbox();
 const mockReportValidationError = sandbox.stub();
 const server = proxyquire(`../../lib/server`, {
-  'fxa-shared/sentry/report-validation-error': {
+  '@fxa/shared/sentry-node': {
     reportValidationError: mockReportValidationError,
   },
 });

packages/fxa-shared/README.md

@@ -93,15 +93,15 @@ Or by building up the new set in place:
 
 This utility allows for easy configuration of tracing. To use this in a service:
 
-- Add the config chunk in fxa-shared/tracing/config to your packages's config.
+- Add the config chunk in @fxa/shared/otel to your packages's config.
 
 - Then initialize as follows. This invocation should happen as early as possible in the service's or app's lifecycle. Ideally it's
   the first thing done, even before importing other modules.
 
 ```
 // For services
 const config = require('../config');
-require('fxa-shared/tracing/node-tracing').initTracing(config.get('tracing'));
+require('@fxa/shared/otel').initTracing(config.get('tracing'));
 ```
 
 To see traces on your local system, set the following environment variables:
@@ -122,7 +122,7 @@ TRACING_OTEL_COLLECTOR_JAEGER_ENABLED=true
 
 ```
 
-The default config for tracing found at fxa-shared/tracing/config.ts will pick up these variables and result in traces showing up in Jaeger which runs locally at `localhost:16686`.
+The default config for tracing found at @fxa/shared/otel will pick up these variables and result in traces showing up in Jaeger which runs locally at `localhost:16686`.
 
 It's important to note that sentry also supports tracing integration. So we typically let a call to 'initSentry', a function located in the sentry/node.ts module do the work of initializing tracing.
 

packages/fxa-shared/monitoring/index.ts

@@ -121,10 +121,6 @@
       "import": "./dist/esm/packages/fxa-shared/log/*.js",
       "require": "./dist/cjs/packages/fxa-shared/log/*.js"
     },
-    "./monitoring": {
-      "import": "./dist/esm/packages/fxa-shared/monitoring/index.js",
-      "require": "./dist/cjs/packages/fxa-shared/monitoring/index.js"
-    },
     "./metrics/*": {
       "import": "./dist/esm/packages/fxa-shared/metrics/*.js",
       "require": "./dist/cjs/packages/fxa-shared/metrics/*.js"
@@ -169,14 +165,6 @@
       "import": "./dist/esm/packages/fxa-shared/scripts/*.js",
       "require": "./dist/cjs/packages/fxa-shared/scripts/*.js"
     },
-    "./sentry": {
-      "import": "./dist/esm/packages/fxa-shared/sentry/index.js",
-      "require": "./dist/cjs/packages/fxa-shared/sentry/index.js"
-    },
-    "./sentry/*": {
-      "import": "./dist/esm/packages/fxa-shared/sentry/*.js",
-      "require": "./dist/cjs/packages/fxa-shared/sentry/*.js"
-    },
     "./speed-trap/*": {
       "import": "./dist/esm/packages/fxa-shared/speed-trap/*.js",
       "require": "./dist/cjs/packages/fxa-shared/speed-trap/*.js"
@@ -185,10 +173,6 @@
       "import": "./dist/esm/packages/fxa-shared/subscriptions/*.js",
       "require": "./dist/cjs/packages/fxa-shared/subscriptions/*.js"
     },
-    "./tracing/*": {
-      "import": "./dist/esm/packages/fxa-shared/tracing/*.js",
-      "require": "./dist/cjs/packages/fxa-shared/tracing/*.js"
-    },
     "./test/db/models/auth/*": {
       "import": "./dist/esm/packages/fxa-shared/test/db/models/auth/*.js",
       "require": "./dist/cjs/packages/fxa-shared/test/db/models/auth/*.js"