Skip to content
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

ACI - Updated Git related messages for Runs and Debug page #26680

Closed
warrensplayer opened this issue May 5, 2023 · 2 comments · Fixed by #26758
Closed

ACI - Updated Git related messages for Runs and Debug page #26680

warrensplayer opened this issue May 5, 2023 · 2 comments · Fixed by #26758
Assignees

Comments

@warrensplayer
Copy link
Contributor

warrensplayer commented May 5, 2023

ClickUp

There are two scenarios related to Git that the Runs and Debug pages are not currently warning about:

  1. The local developer environment is running Cypress without Git
  2. The App is sending the list of Git hashes to the Cloud to fetch relevant runs in RelevantRunsDatasource, but no runs are returned from the Cloud.

The Runs and Debug page will add appropriate warnings to let the user know and give them help in correcting the situation.

No Git data in local project

The frontend should determine if Git is setup locally and the Cypress app can read the Git data. One possible way to do this is to see if the Git branch is available. [In GQL under currentProject.branch]

If Git is not setup, then show the following messages:

Debug page
The <DebugError /> component was created when the Debug page was released but never wired up correctly. Confirm this component aligns with the current designs and show instead of the empty state for recording runs.

image

Figma - https://www.figma.com/file/pY9VgDO8ZWye0qDeVpp49r/Debug%2C-v1.2-%40latest?type=design&node-id=621-135888&t=jlOWOWDS3rcYu56y-0

Runs Page

On the runs page, the warning about not detecting local git information will be shown as an alert at the top of the page. The new algorithm implemented with [Insert GH link here] will show the latest 10 runs associated with the local Git tree. If no Git information is detected, then the original page behavior of just returning the 10 most recent runs for the entire project will be used as a fallback so that the page still shows some information.

If the alert is closed via the "X" button, the app should record that it has been closed for this project and not show it again. Moved to separate issue: #26808

image

Figma - https://www.figma.com/file/2OOJAfoCGBUct1RRImottI/Runs-Page-v1.0-%40latest?type=design&node-id=436%3A49883&t=Vw50UhmgtuZHFKYe-1

No runs returned from the Cloud for a list of Git hashes

This scenario could happen for more than one reason:

  • CI for the project is not sending Git information to Cypress Cloud, so the recorded runs do not contain Git hashes to look up
  • There are no recorded runs found in the last 100 Git hashes of the developer's local environment (most likely scenario is that this is a new project without many recorded runs or CI is not run on the "base" branch as configured in Cypress cloud)

The App will show a warning message on the Debug and Runs page indicating that there may be an issue that the developer needs to correct in order to show the expected information for these pages.

The logic for showing these messages should be:

  • Git information can be detected locally
  • the Cloud returns no runs for the set of Git hashes it sends
  • there is at least 1 run for the project overall

Debug page

Show same layout as <DebugError /> with different copy. Learn more link should be https://on.cypress.io/git-info with UTM params:

  • source = Binary: App
  • medium = Debug Tab
  • campaign = 'No Runs Found`
image

Figma - https://www.figma.com/file/pY9VgDO8ZWye0qDeVpp49r/Debug%2C-v1.2-%40latest?type=design&node-id=621%3A135886&t=TuOsQ3aKMC9tjXv0-1

Runs page

The Runs page will show a similar alert at the top of the page as above. Learn more link should be https://on.cypress.io/git-info with UTM params:

  • source = Binary: App
  • medium = Runs Tab
  • campaign = 'No Runs Found`

If the alert is closed via the "X" button, the app should record that it has been closed for this project and not show it again. Moved to separate issue: #26808

image

Figma - https://www.figma.com/file/2OOJAfoCGBUct1RRImottI/Runs-Page-v1.0-%40latest?type=design&node-id=463%3A31650&t=Vw50UhmgtuZHFKYe-1

@warrensplayer warrensplayer changed the title ACI - Updated Git related messages for Runs and Debug page [WRITE UP IN PROGRESS] ACI - Updated Git related messages for Runs and Debug page May 5, 2023
@warrensplayer warrensplayer changed the title [WRITE UP IN PROGRESS] ACI - Updated Git related messages for Runs and Debug page ACI - Updated Git related messages for Runs and Debug page May 8, 2023
@warrensplayer
Copy link
Contributor Author

@cypress-bot
Copy link
Contributor

cypress-bot bot commented May 23, 2023

Released in 12.13.0.

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

@cypress-bot cypress-bot bot locked as resolved and limited conversation to collaborators May 23, 2023
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 a pull request may close this issue.

2 participants