chore: make the @packages/telemetry an independent bundle without needed ts-node to register entrypoint. Both ESM and CJS distributions are built and types are used as source to be compatible with older styles of commonjs bundling. Types are not shipped with the package.

AtofStryker · AtofStryker · commit 4253e06f9eef · 2025-09-23T15:03:13.000-04:00
diff --git a/packages/app/src/main.ts b/packages/app/src/main.ts
@@ -13,7 +13,7 @@ import Toast, { POSITION } from 'vue-toastification'
 import 'vue-toastification/dist/index.css'
 import { createWebsocket } from './runner'
 import { getRunnerConfigFromWindow } from './runner/get-runner-config-from-window'
-import { telemetry } from '@packages/telemetry/src/browser'
+import { telemetry } from '@packages/telemetry/browser/client'
 
 // Grab the time just before loading config to include that in the cypress:app span
 const now = performance.now()
diff --git a/packages/app/src/runner/event-manager.ts b/packages/app/src/runner/event-manager.ts
@@ -14,7 +14,7 @@ import { useStudioStore } from '../store/studio-store'
 import { getAutIframeModel } from '.'
 import { handlePausing } from './events/pausing'
 import { addTelemetryListeners } from './events/telemetry'
-import { telemetry } from '@packages/telemetry/src/browser'
+import { telemetry } from '@packages/telemetry/browser/client'
 import { addCaptureProtocolListeners } from './events/capture-protocol'
 import { getRunnerConfigFromWindow } from './get-runner-config-from-window'
 
diff --git a/packages/app/src/runner/events/telemetry.ts b/packages/app/src/runner/events/telemetry.ts
@@ -1,4 +1,4 @@
-import { telemetry } from '@packages/telemetry/src/browser'
+import { telemetry } from '@packages/telemetry/browser/client'
 
 export const addTelemetryListeners = (Cypress: Cypress.Cypress) => {
   Cypress.on('test:before:run', (attributes, test) => {
diff --git a/packages/driver/src/cypress.ts b/packages/driver/src/cypress.ts
@@ -48,7 +48,7 @@ import type { CachedTestState } from '@packages/types'
 import { DocumentDomainInjection } from '@packages/network/lib/document-domain-injection'
 import { setSpecContentSecurityPolicy } from './util/privileged_channel'
 
-import { telemetry } from '@packages/telemetry/src/browser'
+import { telemetry } from '@packages/telemetry/browser/client'
 
 const debug = debugFn('cypress:driver:cypress')
 
diff --git a/packages/driver/src/main.ts b/packages/driver/src/main.ts
@@ -4,7 +4,7 @@ import './config/bluebird'
 import './config/jquery'
 import './config/lodash'
 import $Cypress from './cypress'
-import { telemetry } from '@packages/telemetry/src/browser'
+import { telemetry } from '@packages/telemetry/browser/client'
 
 // Telemetry has already been initialized in the 'app' package
 // but since this is a different package we have to link up the instances.
diff --git a/packages/telemetry/.gitignore b/packages/telemetry/.gitignore
@@ -0,0 +1,4 @@
+cjs/
+esm/
+browser/
+!src/browser
diff --git a/packages/telemetry/README.md b/packages/telemetry/README.md
@@ -140,18 +140,18 @@ const { OTLPTraceExporterIPC } = require('@packages/telemetry')
 
 ### Browser
 
-To access the browser telemetry singleton use the browser export directly.
+To access the browser telemetry singleton use the browser export.
 
 ```js
-import { telemetry } from '@packages/telemetry/src/browser'
+import { telemetry } from '@packages/telemetry/browser/client'
 
 telemetry.init({options})
 ```
 
 The browser singleton is also stored on window, in some cases when the telemetry package is included in multiple packages you can use the `attach` method to retrieve and setup the singleton from the instance saved on window.
 
 ```js
-import { telemetry } from '@packages/telemetry/src/browser'
+import { telemetry } from '@packages/telemetry/browser/client'
 
 telemetry.attach()
 ```
@@ -198,7 +198,7 @@ const { telemetry } = require('@packages/telemetry')
 Browser:
 
 ```js
-import { telemetry } from '@packages/telemetry/src/browser'
+import { telemetry } from '@packages/telemetry/browser/client'
 ```
 
 ### Spans
diff --git a/packages/telemetry/index.js b/packages/telemetry/index.js
diff --git a/packages/telemetry/package.json b/packages/telemetry/package.json
@@ -3,12 +3,16 @@
   "version": "0.0.0-development",
   "description": "open telemetry wrapper used throughout the cypress monorepo to instrument the cypress app",
   "private": true,
-  "main": "dist/node.js",
-  "browser": "src/browser.ts",
+  "main": "cjs/node.js",
   "scripts": {
-    "build": "tsc",
-    "check-ts": "tsc --noEmit && yarn -s tslint",
-    "clean": "rimraf dist",
+    "build": "yarn build:esm && yarn build:cjs && yarn build:browser",
+    "build-prod": "yarn build",
+    "build:browser": "rimraf browser && rollup -c rollup.config.mjs",
+    "build:cjs": "rimraf cjs && tsc -p tsconfig.cjs.json",
+    "build:esm": "rimraf esm && tsc -p tsconfig.esm.json",
+    "check-ts": "tsc -p tsconfig.cjs.json --noEmit && yarn -s tslint -p tsconfig.cjs.json",
+    "clean": "rimraf esm cjs",
+    "clean-deps": "rimraf node_modules",
     "test": "yarn test-unit",
     "test-unit": "mocha --config ./test/.mocharc.js",
     "tslint": "tslint --config ../ts/tslint.json --project .",
@@ -27,12 +31,18 @@
   },
   "devDependencies": {
     "@packages/ts": "0.0.0-development",
-    "mocha": "7.0.1"
+    "@rollup/plugin-typescript": "12.0.0",
+    "mocha": "7.0.1",
+    "rimraf": "6.0.1",
+    "rollup": "4.52.0",
+    "typescript": "5.6.3"
   },
   "files": [
-    "dist",
-    "src"
+    "esm",
+    "cjs",
+    "browser"
   ],
-  "types": "src/node.ts",
+  "types": "cjs/node.d.ts",
+  "module": "esm/node.js",
   "nx": {}
 }
diff --git a/packages/telemetry/rollup.config.mjs b/packages/telemetry/rollup.config.mjs
@@ -0,0 +1,21 @@
+import typescript from '@rollup/plugin-typescript'
+
+// inline all the values/imports from the entry point client.ts into the browser/client.js bundle
+// and provides declarations for the browser/client.d.ts bundle
+const config = [
+  {
+    input: 'src/client.ts',
+    output: {
+      file: 'browser/client.js',
+      format: 'esm',
+      declaration: true,
+    },
+    plugins: [
+      typescript({
+        tsconfig: 'tsconfig.browser.json',
+      }),
+    ],
+  },
+]
+
+export default config
diff --git a/packages/telemetry/src/client.ts b/packages/telemetry/src/client.ts
@@ -1,6 +1,6 @@
 import type { Span, Attributes } from '@opentelemetry/api'
-import type { startSpanOptions, findActiveSpanOptions, contextObject } from './index'
-import { Telemetry as TelemetryClass, TelemetryNoop } from './index'
+import type { startSpanOptions, findActiveSpanOptions, contextObject } from './telemetry/index'
+import { Telemetry as TelemetryClass, TelemetryNoop } from './telemetry/index'
 import { WebTracerProvider } from '@opentelemetry/sdk-trace-web'
 import { browserDetectorSync } from '@opentelemetry/resources'
 import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base'
diff --git a/packages/telemetry/src/node.ts b/packages/telemetry/src/node.ts
@@ -1,12 +1,12 @@
 import type { Span } from '@opentelemetry/api'
-import type { startSpanOptions, findActiveSpanOptions, contextObject } from './index'
+import type { startSpanOptions, findActiveSpanOptions, contextObject } from './telemetry/index'
 import {
   envDetectorSync, hostDetectorSync, osDetectorSync, processDetectorSync,
 } from '@opentelemetry/resources'
 import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base'
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node'
 import { circleCiDetectorSync } from './detectors/circleCiDetectorSync'
-import { enabledValues, Telemetry as TelemetryClass, TelemetryNoop } from './index'
+import { enabledValues, Telemetry as TelemetryClass, TelemetryNoop } from './telemetry/index'
 import { OTLPTraceExporter as OTLPTraceExporterCloud } from './span-exporters/cloud-span-exporter'
 import { OTLPTraceExporter as OTLPTraceExporterIpc } from './span-exporters/ipc-span-exporter'
 
diff --git a/packages/telemetry/src/telemetry/index.ts b/packages/telemetry/src/telemetry/index.ts
@@ -1,8 +1,8 @@
 import openTelemetry from '@opentelemetry/api'
 import { detectResourcesSync, Resource } from '@opentelemetry/resources'
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'
-import { OnStartSpanProcessor } from './processors/on-start-span-processor'
-import { ConsoleTraceLinkExporter } from './span-exporters/console-trace-link-exporter'
+import { OnStartSpanProcessor } from '../processors/on-start-span-processor'
+import { ConsoleTraceLinkExporter } from '../span-exporters/console-trace-link-exporter'
 
 import type { Span, SpanOptions, Tracer, Context, Attributes } from '@opentelemetry/api'
 import type { BasicTracerProvider, SimpleSpanProcessor, BatchSpanProcessor, SpanExporter } from '@opentelemetry/sdk-trace-base'
@@ -350,29 +350,31 @@ export class Telemetry implements TelemetryApi {
  * all operations.
  */
 export class TelemetryNoop implements TelemetryApi {
-  startSpan () {
+  startSpan (arg: startSpanOptions): Span | undefined | void {
     return undefined
   }
-  getSpan () {
+  getSpan (name: string): Span | undefined {
     return undefined
   }
-  findActiveSpan () {
+  findActiveSpan (fn: findActiveSpanOptions): Span | undefined {
     return undefined
   }
-  endActiveSpanAndChildren () {
+  endActiveSpanAndChildren (span?: Span | undefined): void {
     return undefined
   }
   getActiveContextObject (): contextObject {
     return {}
   }
-  getResources () {
+  getResources (): Attributes {
     return {}
   }
-  shutdown () {
+  shutdown (): Promise<void> {
     return Promise.resolve()
   }
-  getExporter () {
+  getExporter (): SpanExporter | undefined {
+    return undefined
+  }
+  setRootContext (rootContextObject?: contextObject): void {
     return undefined
   }
-  setRootContext () {}
 }
diff --git a/packages/telemetry/test/browser.spec.ts b/packages/telemetry/test/browser.spec.ts
@@ -3,9 +3,9 @@ global.window = {}
 
 import { expect } from 'chai'
 
-import { telemetry } from '../src/browser'
+import { telemetry } from '../src/client'
 
-import { Telemetry as TelemetryClass } from '../src/index'
+import { Telemetry as TelemetryClass } from '../src/telemetry/index'
 
 describe('telemetry is disabled', () => {
   describe('init', () => {
diff --git a/packages/telemetry/test/index.spec.ts b/packages/telemetry/test/index.spec.ts
@@ -1,6 +1,6 @@
 import { expect } from 'chai'
 
-import { Telemetry } from '../src'
+import { Telemetry } from '../src/telemetry'
 
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node'
 import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base'
diff --git a/packages/telemetry/tsconfig.base.json b/packages/telemetry/tsconfig.base.json
@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "esnext",
+      "DOM"
+    ],
+    "allowJs": false,
+    "noImplicitAny": true,
+    "noUncheckedIndexedAccess": true,
+    "types": [
+      "cypress"
+    ],
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "declaration": true
+  }
+}
diff --git a/packages/telemetry/tsconfig.browser.json b/packages/telemetry/tsconfig.browser.json
@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.base.json",
+  "include": [
+    "src/client.ts"
+  ],
+  "compilerOptions": {
+    "outDir": "./browser",
+    "rootDir": "./src",
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "bundler"
+  }
+}
diff --git a/packages/telemetry/tsconfig.cjs.json b/packages/telemetry/tsconfig.cjs.json
@@ -0,0 +1,16 @@
+{
+  "extends": "./tsconfig.base.json",
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "src/client.ts"
+  ],
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./cjs",
+    "target": "ES2022",
+    "module": "CommonJS",
+    "moduleResolution": "node"
+  }
+}
diff --git a/packages/telemetry/tsconfig.esm.json b/packages/telemetry/tsconfig.esm.json
@@ -0,0 +1,16 @@
+{
+  "extends": "./tsconfig.base.json",
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "src/client.ts"
+  ],
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./esm",
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "node"
+  }
+}
diff --git a/packages/telemetry/tsconfig.json b/packages/telemetry/tsconfig.json
diff --git a/yarn.lock b/yarn.lock
@@ -6344,6 +6344,14 @@
     is-module "^1.0.0"
     resolve "^1.19.0"
 
+"@rollup/plugin-typescript@12.0.0":
+  version "12.0.0"
+  resolved "https://registry.yarnpkg.com/@rollup/plugin-typescript/-/plugin-typescript-12.0.0.tgz#e92dee7ac5a686864067e34daa5a7df1e3b82c55"
+  integrity sha512-w5PTCahNqP8bokY9/7DO+hjbJF7ru0yBuWM9QMNb9m+GQgwb7zYsOBbPxqdjDqYSVCgvvDprcNH2kevsev8IBg==
+  dependencies:
+    "@rollup/pluginutils" "^5.1.0"
+    resolve "^1.22.1"
+
 "@rollup/pluginutils@^3.0.4", "@rollup/pluginutils@^3.1.0":
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/@rollup/pluginutils/-/pluginutils-3.1.0.tgz#706b4524ee6dc8b103b3c995533e5ad680c02b9b"
@@ -27866,7 +27874,7 @@ rollup@3.29.5:
   optionalDependencies:
     fsevents "~2.3.2"
 
-rollup@^4.20.0, rollup@^4.24.4, rollup@^4.34.9, rollup@^4.43.0, rollup@^4.52.0:
+rollup@4.52.0, rollup@^4.20.0, rollup@^4.24.4, rollup@^4.34.9, rollup@^4.43.0, rollup@^4.52.0:
   version "4.52.0"
   resolved "https://registry.yarnpkg.com/rollup/-/rollup-4.52.0.tgz#5a906bf98f7c7a2c08d2b18fbfa52955552423d7"
   integrity sha512-+IuescNkTJQgX7AkIDtITipZdIGcWF0pnVvZTWStiazUmcGA2ag8dfg0urest2XlXUi9kuhfQ+qmdc5Stc3z7g==
@@ -31219,6 +31227,11 @@ typescript@5.4.5, typescript@~5.4.5:
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.4.5.tgz#42ccef2c571fdbd0f6718b1d1f5e6e5ef006f611"
   integrity sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==
 
+typescript@5.6.3:
+  version "5.6.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.6.3.tgz#5f3449e31c9d94febb17de03cc081dd56d81db5b"
+  integrity sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==
+
 "typescript@>=3 < 6", typescript@^5.4.3, typescript@^5.6.3, typescript@^5.8.2, typescript@~5.9.2:
   version "5.9.2"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.9.2.tgz#d93450cddec5154a2d5cabe3b8102b83316fb2a6"

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { telemetry } from '@packages/telemetry/src/browser'`
	`1`	`+import { telemetry } from '@packages/telemetry/browser/client'`
`2`	`2`
`3`	`3`	`export const addTelemetryListeners = (Cypress: Cypress.Cypress) => {`
`4`	`4`	`Cypress.on('test:before:run', (attributes, test) => {`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +cjs/
 +esm/
 +browser/
 +!src/browser