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.

Author: AtofStryker

guides/esm-migration.md

@@ -64,7 +64,7 @@ When migrating some of these projects away from the `ts-node` entry [see `@packa
 - [ ] packages/server **PARTIAL** - many source/test files in JS. highest priority
 - [ ] packages/socket **PARTIAL** - entry point is JS. Tests are JS
 - [x] packages/stderr-filtering ✅ **COMPLETED**
-- [ ] packages/telemetry **PARTIAL** - entry point is JS
+- [x] packages/telemetry ✅ **COMPLETED**
 - [ ] packages/ts **PARTIAL** - ultimate goal is removal and likely not worth the effort to convert
 - [x] packages/types ✅ **COMPLETED**
 - [x] packages/v8-snapshot-require

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()

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'
 import { usePromptStore } from '../store/prompt-store'

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) => {

packages/driver/src/cypress.ts

@@ -48,7 +48,7 @@ import type { CachedTestState, ReporterRunState, RunState } from '@packages/type
 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')
 

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.

packages/proxy/lib/network-proxy.ts

@@ -55,7 +55,7 @@ export class NetworkProxy {
       isVerbose: true,
     })
 
-    await this.http.handleHttpRequest(req, res, span).finally(() => {
+    await this.http.handleHttpRequest(req, res, span || undefined).finally(() => {
       span?.end()
     })
   }

packages/telemetry/.gitignore

@@ -0,0 +1,4 @@
+cjs/
+esm/
+browser/
+!src/browser

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
@@ -290,4 +290,12 @@ The metrics api is tbd.
 ## Open Telemetry Links
 
 * [otel docs](https://opentelemetry.io/docs/)
-* [otel sdk](https://open-telemetry.github.io/opentelemetry-js/index.html)
+* [otel sdk](https://open-telemetry.github.io/opentelemetry-js/index.html)
+
+###  Bundling
+
+For the frontend telemetry collector, we use `rollup` to bundle the telemetry collector for frontend consumption. This DOES ship with the binary.
+
+For the server, we bundle a CommonJS version to be used in the Node.js context. 
+
+We also build an ESM version of `@packages/scaffold-config` for the `node` client but it isn't currently in use as the consumption server-side is CommonJS currently.