chore: Pass telemetry resources from the node process to the browser #26468

mjhenkes · 2023-04-10T14:31:05Z

Closes

Additional details

I noticed that resource information like 'ci.branch' were not getting applied to spans logged from the browser, this change passes resources declared in the node process up to the browser process to ensure they also get logged.

Steps to test

Check for the presence of ci.branch on spans logged from the browser in honeycomb.

How has the user experience changed?

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in cypress-documentation?
Have API changes been updated in the type definitions?

packages/telemetry/test/browser.spec.ts

AtofStryker · 2023-04-10T14:48:05Z

packages/telemetry/src/index.ts

@@ -30,6 +30,7 @@ export interface TelemetryApi {
  findActiveSpan(fn: findActiveSpanOptions): Span | undefined
  endActiveSpanAndChildren (span?: Span | undefined): void
  getActiveContextObject (): contextObject
+  getResources (): {}


is it always a key value pair of strings in this case kinda similar to the tests?

Suggested change

getResources (): {}

getResources (): {[key: string]: string}

I know it's always serializable, but it might be numbers too

maybe getResources (): {[key: string]: string | number}?

lol, i tried that it's more complex (how about booleans? how about arrays of strings?). I'm going to try to reuse an opentelmetry type.

worse case I feel like {[key: string]: string} is acceptable since it sounds like it could be any serializable type. Or it is always a primitive we could do something like {[key: string]: string | number | boolean | undefined | null} (assuming no symbols or bigint)?

The otel type appears to be working for us.

Co-authored-by: Bill Glesias <[email protected]>

mjhenkes · 2023-04-10T15:08:29Z

packages/frontend-shared/src/graphql/urqlClient.ts

@@ -103,7 +103,6 @@ declare global {
    __RUN_MODE_SPECS__: SpecFile[]
    __CYPRESS_TESTING_TYPE__: 'e2e' | 'component'
    __CYPRESS_BROWSER__: Partial<Browser> & {majorVersion: string | number}
-    __CYPRESS_TELEMETRY__?: {context: {traceparent: string}}


removed duplicative typing, at least as far as i can tell we don't need it with the type defined in browsers.ts

cypress · 2023-04-10T15:09:17Z

30 flaky tests on run #45399 ↗︎

0	26909	1281	0	30

Details:

Update packages/telemetry/src/index.ts
Project: cypress	Commit: `da1e217abc`
Status: Passed	Duration: 18:17 💡
Started: Apr 10, 2023 6:41 PM	Ended: Apr 10, 2023 6:59 PM

create-from-component.cy.ts • 2 flaky tests • app-e2e

View Output Video

Test		Artifacts
... > runs generated spec		`Output` `Screenshots` `Video`
... > runs generated spec		`Output` `Screenshots` `Video`

runs.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
App: Runs > Runs - Create Project > when a project is created, injects new projectId into the config file, and sends expected UTM params		`Output` `Screenshots` `Video`

specs_list_latest_runs.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
App/Cloud Integration - Latest runs and Average duration > when no runs are recorded > shows placeholders for all visible specs		`Output` `Screenshots` `Video`

cypress-in-cypress.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
Cypress in Cypress > scales the AUT correctly in e2e		`Output` `Screenshots` `Video`

cypress-origin-communicator.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
Cypress In Cypress Origin Communicator > cy.origin passivity with app interactions > passes upon test reload mid test execution		`Output` `Screenshots` `Video`

The first 5 flaky specs are shown, see all 17 specs in Cypress Cloud.

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

packages/telemetry/src/index.ts

mschile · 2023-04-10T18:23:43Z

packages/telemetry/src/span-exporters/cloud-span-exporter.ts

@@ -51,8 +53,10 @@ export class OTLPTraceExporter extends OTLPTraceExporterHttp {
      return
    }

+    // Continue to send this header for passivity until the cloud is released.


Is there an issue logged to remove this one the cloud is updated?

Nope, I was just planning to do it myself once i was notified that cloud had released.

Co-authored-by: Matt Schile <[email protected]>

…ypress-io#26468) * chore: pass resources from the node process to the browser * don't check version * Apply suggestions from code review Co-authored-by: Bill Glesias <[email protected]> * reuse type for attributes * use auth header * ts? * Update packages/telemetry/src/index.ts Co-authored-by: Matt Schile <[email protected]> --------- Co-authored-by: Bill Glesias <[email protected]> Co-authored-by: Matt Schile <[email protected]>

* feat/protocol: (45 commits) chore: adding support for url:changed (#26519) chore: adding viewport:changed to protocol (#26508) chore: Reduce dependencies and binary size, add circle ci detector (#26522) chore: 12.10.0 release (#26517) test: fix flaky tests (#26505) chore: Check project dependencies for CT compatibility (#26497) chore: update vm2 to 3.9.16 (#26489) chore: enable builds on feat/protocol branch (#26506) chore: [skip ci] update to labels looked at by stalebot (#26496) chore: connecting to electron browser (#26471) chore: [skip ci] turning on stale bot (#26488) chore: fix issue with logs without wallClockUpdatedAt (#26473) Update triage_add_to_project.yml chore: Update Chrome (stable) to 112.0.5615.49 and Chrome (beta) to 113.0.5672.24 (#26434) feat: display framework definition errors (#26183) fix: correctly resolve dependencies for CT onboarding when using Yarn Plug n Play (#26452) fix: Subscribe to framework detection changes in wizard (#26437) fix: make clicks on type('{enter}') composed (#26395) chore: update add-to-project workflow (#26439) chore: Pass telemetry resources from the node process to the browser (#26468) ...

chore: pass resources from the node process to the browser

bc4d842

mjhenkes requested review from mschile and AtofStryker April 10, 2023 14:34

don't check version

341577d

AtofStryker reviewed Apr 10, 2023

View reviewed changes

mjhenkes and others added 2 commits April 10, 2023 09:52

Apply suggestions from code review

e34f0f8

Co-authored-by: Bill Glesias <[email protected]>

reuse type for attributes

73b4c05

mjhenkes commented Apr 10, 2023

View reviewed changes

Merge branch 'develop' into matth/chore/pass-resources-to-browser

be4f03e

AtofStryker approved these changes Apr 10, 2023

View reviewed changes

mjhenkes added 2 commits April 10, 2023 12:28

use auth header

cea73a0

ts?

31c4a08

mschile reviewed Apr 10, 2023

View reviewed changes

packages/telemetry/src/index.ts Outdated Show resolved Hide resolved

mschile reviewed Apr 10, 2023

View reviewed changes

mschile approved these changes Apr 10, 2023

View reviewed changes

Update packages/telemetry/src/index.ts

da1e217

Co-authored-by: Matt Schile <[email protected]>

mjhenkes merged commit b4622ee into develop Apr 10, 2023

mjhenkes deleted the matth/chore/pass-resources-to-browser branch April 10, 2023 19:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Pass telemetry resources from the node process to the browser #26468

chore: Pass telemetry resources from the node process to the browser #26468

mjhenkes commented Apr 10, 2023

AtofStryker Apr 10, 2023 •

edited

Loading

mjhenkes Apr 10, 2023

AtofStryker Apr 10, 2023

mjhenkes Apr 10, 2023

AtofStryker Apr 10, 2023

mjhenkes Apr 10, 2023

mjhenkes Apr 10, 2023

cypress bot commented Apr 10, 2023 •

edited

Loading

mschile Apr 10, 2023

mjhenkes Apr 10, 2023

chore: Pass telemetry resources from the node process to the browser #26468

chore: Pass telemetry resources from the node process to the browser #26468

Conversation

mjhenkes commented Apr 10, 2023

Additional details

Steps to test

How has the user experience changed?

PR Tasks

AtofStryker Apr 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cypress bot commented Apr 10, 2023 • edited Loading

30 flaky tests on run #45399 ↗︎

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AtofStryker Apr 10, 2023 •

edited

Loading

cypress bot commented Apr 10, 2023 •

edited

Loading