Remove duplicate browser detector

[dyladan]

Fixes #5364

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.90%. Comparing base (afcc711) to head (28343ea).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5420      +/-   ##
==========================================
+ Coverage   94.80%   94.90%   +0.10%     
==========================================
  Files         309      308       -1     
  Lines        7989     7971      -18     
  Branches     1683     1677       -6     
==========================================
- Hits         7574     7565       -9     
+ Misses        415      406       -9     

Files with missing lines	Coverage Δ
...ges/opentelemetry-resources/src/detectors/index.ts	100.00% <ø> (ø)

[trentm]

The two BrowserDetectors are quite different in the attributes they provide. One is doing process.runtime.* attributes. The other browser.* attributes. I've no idea if either is commonly used anywhere.

--- packages/opentelemetry-resources/src/detectors/BrowserDetector.ts	2025-02-03 12:25:09
+++ experimental/packages/opentelemetry-browser-detector/src/BrowserDetector.ts	2025-02-03 12:25:09
@@ -16,55 +16,67 @@

 import { Attributes, diag } from '@opentelemetry/api';
 import {
-  SEMRESATTRS_PROCESS_RUNTIME_DESCRIPTION,
-  SEMRESATTRS_PROCESS_RUNTIME_NAME,
-  SEMRESATTRS_PROCESS_RUNTIME_VERSION,
-} from '@opentelemetry/semantic-conventions';
-import { ResourceDetectionConfig } from '../config';
-import { DetectedResource, ResourceDetector } from '../types';
+  DetectedResource,
+  ResourceDetector,
+  Resource,
+  ResourceDetectionConfig,
+} from '@opentelemetry/resources';
+import { BROWSER_ATTRIBUTES, UserAgentData } from './types';

 /**
  * BrowserDetector will be used to detect the resources related to browser.
  */
 class BrowserDetector implements ResourceDetector {
   detect(config?: ResourceDetectionConfig): DetectedResource {
-    const isBrowser =
-      typeof navigator !== 'undefined' &&
-      global.process?.versions?.node === undefined && // Node.js v21 adds `navigator`
-      // @ts-expect-error don't have Bun types
-      global.Bun?.version === undefined; // Bun (bun.sh) defines `navigator`
+    const isBrowser = typeof navigator !== 'undefined';
     if (!isBrowser) {
-      return { attributes: {} };
+      return Resource.EMPTY;
     }
-    const browserResource: Attributes = {
-      [SEMRESATTRS_PROCESS_RUNTIME_NAME]: 'browser',
-      [SEMRESATTRS_PROCESS_RUNTIME_DESCRIPTION]: 'Web Browser',
-      [SEMRESATTRS_PROCESS_RUNTIME_VERSION]: navigator.userAgent,
-    };
+    const browserResource: Attributes = getBrowserAttributes();
     return this._getResourceAttributes(browserResource, config);
   }
   /**
-   * Validates process resource attribute map from process variables
+   * Validates browser resource attribute map from browser variables
    *
-   * @param browserResource The un-sanitized resource attributes from process as key/value pairs.
+   * @param browserResource The un-sanitized resource attributes from browser as key/value pairs.
    * @param config: Config
    * @returns The sanitized resource attributes.
    */
   private _getResourceAttributes(
     browserResource: Attributes,
     _config?: ResourceDetectionConfig
+  ): DetectedResource {
+    if (
+      !browserResource[BROWSER_ATTRIBUTES.USER_AGENT] &&
+      !browserResource[BROWSER_ATTRIBUTES.PLATFORM]
   ) {
-    if (browserResource[SEMRESATTRS_PROCESS_RUNTIME_VERSION] === '') {
       diag.debug(
         'BrowserDetector failed: Unable to find required browser resources. '
       );
-      return { attributes: {} };
+      return Resource.EMPTY;
     } else {
-      return {
-        attributes: browserResource,
-      };
+      return { attributes: browserResource };
     }
   }
 }

+// Add Browser related attributes to resources
+function getBrowserAttributes(): Attributes {
+  const browserAttribs: Attributes = {};
+  const userAgentData = (
+    navigator as Navigator & { userAgentData?: UserAgentData }
+  ).userAgentData;
+  if (userAgentData) {
+    browserAttribs[BROWSER_ATTRIBUTES.PLATFORM] = userAgentData.platform;
+    browserAttribs[BROWSER_ATTRIBUTES.BRANDS] = userAgentData.brands.map(
+      b => `${b.brand} ${b.version}`
+    );
+    browserAttribs[BROWSER_ATTRIBUTES.MOBILE] = userAgentData.mobile;
+  } else {
+    browserAttribs[BROWSER_ATTRIBUTES.USER_AGENT] = navigator.userAgent;
+  }
+  browserAttribs[BROWSER_ATTRIBUTES.LANGUAGE] = navigator.language;
+  return browserAttribs;
+}
+
 export const browserDetector = new BrowserDetector();

[trentm]

nit:

Suggested change

	* chore(resources)!: Remove deprecated duplicate browser detector from `@opentelemetry/resource` in favor of `@opentelemetry/opentelemetry-browser-detector` [#5420](https://github.com/open-telemetry/opentelemetry-js/pull/5420)
	* chore(resources)!: Remove deprecated duplicate `browserDetector` from `@opentelemetry/resources` in favor of `@opentelemetry/opentelemetry-browser-detector` [#5420](https://github.com/open-telemetry/opentelemetry-js/pull/5420)

[trentm]

@legendecas mentioned that it was notified in Slack that we were going to remove the old browser detector. The one in the resource package is frozen because it is in the stable package, but its use of process.runtime.* semconv vars is obsolete.