Skip to content

internal: (studio) capture anonymous telemetry for studio initialization #31555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 56 commits into from
Apr 30, 2025

Conversation

astone123
Copy link
Contributor

@astone123 astone123 commented Apr 21, 2025

Related services PR https://github.com/cypress-io/cypress-services/pull/10689

Additional details

We'd like to know how many people are using Cypress Studio today. This PR adds logic on the app side to call a method that will record an event when a user opens up Studio. We will send their anonymous machineId, browser info, and Cloud user info if they are logged into Cypress Cloud.

Steps to test

Ensure that studio still loads correctly - the cloud studio panel should still load when you pass the correct environment variables, and it should not when these variables are not provided.

Check the tests that I added that verify that the cloud code to collect telemetry is always called when Studio loads even if AI is not enabled.

Run services with this branch, start the app with CYPRESS_INTERNAL_ENV=development CYPRESS_LOCAL_STUDIO_PA TH=../cypress-services/app/packages/studio/dist/development set (replace CYPRESS_LOCAL_STUDIO_PATH with where you have cypress-services cloned to)

See services PR for further testing instructions.

How has the user experience changed?

Users shouldn't notice any changes to how Studio works today - the external user experience should remain unchanged.

PR Tasks

@astone123 astone123 self-assigned this Apr 21, 2025
@astone123 astone123 changed the title add to test studio internal: (studio) capture anonymous telemetry for studio initialization Apr 21, 2025
@astone123 astone123 marked this pull request as ready for review April 28, 2025 17:47
Copy link

cypress bot commented Apr 28, 2025

cypress    Run #62040

Run Properties:  status check passed Passed #62040  •  git commit 9c8f004bdb: Merge branch 'develop' into studio-event-capture
Project cypress
Branch Review studio-event-capture
Run status status check passed Passed #62040
Run duration 19m 11s
Commit git commit 9c8f004bdb: Merge branch 'develop' into studio-event-capture
Committer astone123
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 9
Tests that did not run due to a developer annotating a test with .skip  Pending 1232
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 32149
View all changes introduced in this branch ↗︎
UI Coverage  46.2%
  Untested elements 186  
  Tested elements 164  
Accessibility  92.7%
  Failed rules  3 critical   8 serious   2 moderate   2 minor
  Failed elements 887  

Copy link
Collaborator

@ryanthemanuel ryanthemanuel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Nice work on this!

Base automatically changed from 10501-studio-telemetry to develop April 29, 2025 13:37
@astone123 astone123 merged commit 2a6e9fb into develop Apr 30, 2025
89 of 91 checks passed
@astone123 astone123 deleted the studio-event-capture branch April 30, 2025 13:19
@cypress-bot
Copy link
Contributor

cypress-bot bot commented May 6, 2025

Released in 14.3.3.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v14.3.3, please open a new issue.

@cypress-bot cypress-bot bot locked as resolved and limited conversation to collaborators May 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants