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,72 @@ 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.
 /**
  * Initializes modules related to error monitoring, performance monitoring, and tracing.
- * @param opts - Initialization options. See underlying implementations for more details.
+ *
+ * IMPORTANT: This function must be called as early as possible during server startup, before
+ * any server framework (e.g. Hapi, Express) registers its own instrumentation. Calling it
+ * after framework initialization may result in incomplete or broken tracing.
+ *
+ * Initialization is guarded so that calling this function more than once is a no-op (a
+ * warning is emitted on subsequent calls).
+ *
+ * @param opts - Monitoring initialization options, including an optional logger and a config
+ *   object that may contain both Sentry and tracing settings.
  */
 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, Sentry must be initialized after OTEL.
   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

@@ -5,10 +5,10 @@
 import { ErrorEvent } from '@sentry/core';
 
 export type SentryConfigOpts = {
-  /** Name of release */
+  /** The release name/version string passed to Sentry (e.g. a semver tag or git SHA). */
   release?: string;
 
-  /** Fall back for name of release */
+  /** Fallback release identifier used when `release` is not provided. */
   version?: string;
 
   /** Sentry specific settings */
@@ -24,12 +24,15 @@ export type SentryConfigOpts = {
     /** The name of the active server. */
     serverName?: string;
 
-    /** When set to true, building a configuration will throw an error critical fields are missing. */
+    /** When true, `buildSentryConfig` will throw a `SentryConfigurationBuildError` if any required fields are missing, rather than emitting a warning. */
     strict?: boolean;
 
-    /** The tracing sample rate. Setting this above 0 will aso result in performance metrics being captured. */
+    /** The tracing sample rate (0–1). Setting this above 0 also enables performance metrics capture. */
     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;
 
@@ -38,10 +41,25 @@ export type SentryConfigOpts = {
   };
 };
 
+/** Additional runtime options that extend the base Sentry configuration. */
 export type ExtraOpts = {
+  /**
+   * A predicate called with each captured error. Return `true` to suppress the
+   * error (prevent it from being sent to Sentry), or `undefined`/`false` to
+   * allow it through.
+   */
   ignoreErrors?: (error: any) => boolean | undefined;
+
+  /** Additional Sentry integrations to register beyond the defaults. */
   integrations?: any[];
+
+  /**
+   * An ordered list of event-filter functions applied in `beforeSend`. Each
+   * filter receives the current event and the Sentry hint, and must return the
+   * (possibly mutated) event.
+   */
   eventFilters?: Array<(event: ErrorEvent, hint: any) => ErrorEvent>;
 };
 
+/** Combined options accepted by `initSentry` functions across all platforms. */
 export type InitSentryOpts = SentryConfigOpts & ExtraOpts;

package.json

@@ -329,6 +329,7 @@
     "@fxa/vendored/crypto-relier/esm": "./dist/libs/vendored/crypto-relier/main.js",
     "@fxa/shared/pem-jwk": "./dist/libs/shared/pem-jwk/main.cjs",
     "@fxa/shared/l10n": "./dist/libs/shared/l10n/main.cjs",
-    "@fxa/shared/otel": "./dist/libs/shared/otel/main.cjs"
+    "@fxa/shared/otel": "./dist/libs/shared/otel/main.cjs",
+    "@fxa/shared/monitoring": "./dist/libs/shared/monitoring/main.cjs"
   }
 }

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');
@@ -93,7 +93,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',
@@ -19,11 +22,9 @@ module.exports = {
     '/node_modules/(?!(@fxa|fxa-shared|p-queue|p-timeout|eventemitter3)/)',
   ],
   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>/../../',
+    }),
   },
   testTimeout: 10000,
   maxWorkers: 4,

packages/fxa-auth-server/lib/server.in.spec.ts

@@ -6,7 +6,7 @@ import sinon from 'sinon';
 import { Account } from 'fxa-shared/db/models/auth/account';
 
 const mockReportValidationError = jest.fn();
-jest.mock('fxa-shared/sentry/report-validation-error', () => ({
+jest.mock('@fxa/shared/sentry-node', () => ({
   reportValidationError: mockReportValidationError,
 }));
 

packages/fxa-customs-server/package.json

@@ -21,8 +21,6 @@
     "audit": "npm audit --json | audit-filter --nsp-config=.nsprc --audit=-",
     "lint": "eslint .",
     "test": "scripts/test-local.sh",
-    "test-unit": "yarn make-artifacts-dir && tap test/local --node-arg=-r --node-arg=esbuild-register --jobs=1 | tap-xunit > ../../artifacts/tests/$npm_package_name/fxa-customs-server-tap-unit-results.xml",
-    "test-integration": "yarn make-artifacts-dir && tap test/remote --jobs=1 | tap-xunit > ../../artifacts/tests/$npm_package_name/fxa-customs-server-tap-integration-results.xml",
     "format": "prettier --write --config ../../_dev/.prettierrc '**'",
     "make-artifacts-dir": "mkdir -p ../../artifacts/tests/$npm_package_name"
   },

packages/fxa-profile-server/scripts/mocha-coverage.js

@@ -27,6 +27,8 @@ const argv = [
   '--reporter=lcov',
   '--reporter=text',
   '--report-dir=coverage',
+  '--require',
+  'module-alias/register',
   MOCHA_BIN,
   '--require',
   'module-alias/register',

packages/fxa-settings/package.json

@@ -82,6 +82,8 @@
       "^@fxa/shared/assets(.*)$": "<rootDir>/../../libs/shared/assets/src$1",
       "@fxa/accounts/errors": "<rootDir>/../../libs/accounts/errors/src/index.ts",
       "@fxa/accounts/oauth": "<rootDir>/../../libs/accounts/oauth/src/index.ts",
+      "@fxa/shared/sentry-browser": "<rootDir>/../../libs/shared/sentry-browser/src/index.ts",
+      "@fxa/shared/sentry-utils": "<rootDir>/../../libs/shared/sentry-utils/src/index.ts",
       "@fxa/vendored/common-password-list": "<rootDir>/../../libs/vendored/common-password-list/src/index.ts",
       "@fxa/vendored/incremental-encoder": "<rootDir>/../../libs/vendored/incremental-encoder/src/index.ts"
     },