feat: Debug page [IATR] #25488

warrensplayer · 2023-01-17T18:35:22Z

Closes N/A

This is a feature branch for all IATR M0 and M1.0 stories

User facing changelog

See cli/CHANGELOG.md

Additional details

See information and issues linked in the cli/CHANGELOG.md

Steps to test

Tested in all PRs merged to this feature branch.

How has the user experience changed?

See PRs for the commits to this feature branch for details.

PR Tasks

Have tests been added/updated?
Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
Has a PR for user-facing changes been opened in cypress-documentation?
Have API changes been updated in the type definitions?

Closes #24442

Closes #24443 and #24444

* adding debug page * Fixing sidebar e2e tests * Adding more content to the Debug page and header updates * Starting to wire up child components * created util function for debug specs mapping and wrote tests * update to debug page graphql extension parsing and tests for utility function * Fix header test * Type fixes * Fix test * Setting hash to same as feature branch * New test for DebugContainer * Test Ids needed for test * Updates to fix type linting * Update to cloud schema and types * Fixing tests * Minor test fix * Updates from review comments * Make use of existing computed value Co-authored-by: Zachary Williams <ZachJW34@gmail.com> * Improve test * Adding descriptions to cloud fields * Encapsulate duration format in composable * Making changes to align with latest cloud update Co-authored-by: Ankit <ankit@cypress.io> Co-authored-by: Zachary Williams <ZachJW34@gmail.com>

Co-authored-by: Stokes Player <stokes.player@gmail.com> Co-authored-by: elevatebart <bart@cypress.io> Closes #24851

* feat: debug status badge * remove unused code * add debug icon * fix e2e test * address feedback

Co-authored-by: Rocky <25568640+rockindahizzy@users.noreply.github.com>

Closes #24853

Co-authored-by: Stokes Player <stokes.player@gmail.com> Closes #24849

Closes undefined

Co-authored-by: Stokes Player <stokes@cypress.io>

Closes #25418

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Mark Noonan <mark@cypress.io> Co-authored-by: Mike Plummer <mikep@cypress.io> Closes #24855

Closes #24440

Closes #25487

cypress · 2023-01-18T13:26:18Z

2 failed and 5 flaky tests on run #43629 ↗︎

2	197	23	0	5

Details:

Reverting CI workflows
Project: cypress	Commit: `c09086b813`
Status: Failed	Duration: 18:36 💡
Started: Jan 31, 2023 2:47 AM	Ended: Jan 31, 2023 3:06 AM

cypress\e2e\migration.cy.ts • 1 failed test • launchpad-e2e

View Output Video

Test
global mode > migrates 2 projects in global mode		`Screenshot`

cypress\e2e\project-setup.cy.ts • 1 failed test • launchpad-e2e

View Output Video

Test
Launchpad: Setup Project > Command for package managers > makes the right command for yarn		`Screenshot`

cypress\e2e\migration.cy.ts • 1 flaky test • launchpad-e2e

View Output Video

Test
Full migration flow for each project > completes journey for migration-e2e-coffeescript		`Screenshot`

cypress\e2e\scaffold-component-testing.cy.ts • 3 flaky tests • launchpad-e2e

View Output Video

Test
scaffolding component testing > vuecli4vue2 > scaffolds component testing for Vue CLI 4 w/ Vue 2 project		`Screenshot`
scaffolding component testing > create-react-app > scaffolds component testing for Create React App v5 project		`Screenshot`
scaffolding component testing > angular-cli-unconfigured > scaffolds component testing for Angular		`Screenshot`

cypress\e2e\config-warning.cy.ts • 1 flaky test • launchpad-e2e

View Output Video

Test
component testing dependency warnings > warns against outdated @vue/cli dependency		`Screenshot`

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

Co-authored-by: Stokes Player <stokes.player@gmail.com>

marktnoonan · 2023-01-30T22:44:14Z

packages/app/src/debug/utils/DebugMapping.ts

+      const foundSpec = specs.find((spec) => spec.id === curr.specId)
+
+      if (!foundSpec) {
+        //TODO better handle error case


Any concerns with this todo? Is there a place that this would be handled?

@marktnoonan It would only happen if the Cloud gave back bad data. I did just test it and it would cause the page to hang on the loading skeleton. I will file a fast follow for this and update the comment.

emilyrohrbough · 2023-01-30T22:50:25Z

cli/CHANGELOG.md

+
+**Features:**
+
+- Easily debug failed CI test runs from within the Cypress app with the new "Debug" page. For more details, see the [Debug documentation](https://on.cypress.io/debug-page).


IMO Easily debug failed CI test runs is misleading because we only show data if the run was recorded to the cloud. anyway to expand to indicate this is for recorded run?

Will there be a blog post associated with this feature release?

@emilyrohrbough How about...

Suggested change

- Easily debug failed CI test runs from within the Cypress app with the new "Debug" page. For more details, see the [Debug documentation](https://on.cypress.io/debug-page).

- Easily debug failed CI test runs from Cypress Cloud within the Cypress app with the new "Debug" page. For more details, see the [Debug documentation](https://on.cypress.io/debug-page).

@warrensplayer Sounds good 👍🏻

Maybe something like this

Suggested change

- Easily debug failed CI test runs from within the Cypress app with the new "Debug" page. For more details, see the [Debug documentation](https://on.cypress.io/debug-page).

- Easily debug failed CI test runs right from your local Cypress app with the new Debug page, powered by Cypress Cloud. For more details, see the [Debug documentation](https://on.cypress.io/debug-page).

I went with Peter's copy, removed the sub-bullets and referenced the PR instead of all the separate issues.

emilyrohrbough · 2023-01-30T22:59:31Z

cli/CHANGELOG.md

+  - Added Debug to the sidebar which includes a dynamic badge that shows a count of failed tests that need to be fixed. Addresses [#24441](https://github.com/cypress-io/cypress/issues/24441) and [#24852](https://github.com/cypress-io/cypress/issues/24852).
+  - Added the "Debug" page. Addresses
+[#24442](https://github.com/cypress-io/cypress/issues/24442),
+[#24443](https://github.com/cypress-io/cypress/issues/24443),
+[#24444](https://github.com/cypress-io/cypress/issues/24444),
+[#24851](https://github.com/cypress-io/cypress/issues/24851),
+[#24852](https://github.com/cypress-io/cypress/issues/24852),
+[#24847](https://github.com/cypress-io/cypress/issues/24847),
+[#24854](https://github.com/cypress-io/cypress/issues/24854),
+[#24848](https://github.com/cypress-io/cypress/issues/24848),
+[#24853](https://github.com/cypress-io/cypress/issues/24853),
+[#24849](https://github.com/cypress-io/cypress/issues/24849),
+[#25352](https://github.com/cypress-io/cypress/issues/25352),
+[#25339](https://github.com/cypress-io/cypress/issues/25339),
+[#25319](https://github.com/cypress-io/cypress/issues/25319),
+[#25418](https://github.com/cypress-io/cypress/issues/25418),
+[#24440](https://github.com/cypress-io/cypress/issues/24440),
+[#25487](https://github.com/cypress-io/cypress/issues/25487),
+[#25543](https://github.com/cypress-io/cypress/issues/25543),
+[#25570](https://github.com/cypress-io/cypress/issues/25570) and
+[#25486](https://github.com/cypress-io/cypress/issues/25486).
+  - The test runner can be filtered to only run the tests that failed from the Cloud run being shown in the Debug page. Addresses [#24855](https://github.com/cypress-io/cypress/issues/24855).


This wasn't previously released, so these direct call out aren't needed IMO . We also don't need to link to each closed issue, just the Epic which tracked the initiative or we can reference this PR.

I will update to remove those and reference the PR

marktnoonan · 2023-01-30T23:15:09Z

I saw something a bit confusing, the pending run displayed 191 of 191 specs completed, but Cy Cloud showed 190 of 191 completed for that same run.

As I was trying to get a side-by-side screenshot, the run completed on the Cloud window and the app UI correctly flipped to the "View Run" state that is expected:

It seems like the local count was off by one and a spec was still pending in the cloud.

warrensplayer · 2023-01-30T23:51:24Z

I saw something a bit confusing, the pending run displayed 191 of 191 specs completed, but Cy Cloud showed 190 of 191 completed for that same run.

It seems like the local count was off by one and a spec was still pending in the cloud.

There is a known issue with the spec counts in this case that will be addressed by: https://cypress-io.atlassian.net/browse/CYCLOUD-860

lmiller1990 · 2023-01-31T04:56:05Z

I tested it a bunch locally, seems great. I found one edge case. Repro

have a repo with passing tests
it says "Nice job, you tests are passing"
push a commit with a failing test
it updates real time (correct)
it shows failed summary (correct)
but the "Nice job" it still showing until I refresh

This does not really seem like a major blocker, can be fast follow (it doesn't make the feature broken or anything) but worth noting.

Screenshot:

lmiller1990

I reviewed each PR before, so I jsut focused on testing - I left one edge case I found, but not really a major blocker. Glad to see this on the finish line!!

warrensplayer · 2023-01-31T12:29:04Z

@lmiller1990 This is expected behavior at this time. The "Well done" message is referring to build #2 in your screenshot. The only way currently that build #3 would be shown as the current build on the page is to click the "View run" link, refresh the page (like you did), or be on a different page (through at least one polling cycle) and then come back to the Debug page.

A future update will change this behavior.

mike-plummer

Looks good in my local testing, amazing work @warrensplayer ! 💯

* develop: chore: fix changlelog section parsing and reference right ENV (#25633) feat: Debug page [IATR] (#25488) fix(deps): update dependency underscore.string to v3.3.6 🌟 (#25574) chore: Use upstream cypress-testing-library again (#25548) fix: match alternate edge version string format (#25457) chore: update name for graphql batch operations (#25610) chore: clean up config for external contibutors (#25552) chore: fix childProcess.execSync encoding (#25625) chore: update next-version to handle using the next bump package.json… (#25599) chore: update packages/example deployment script and cleanup package/example (#25091) fix: allow version 9 of the babel-loader peer dependency (#25569) docs: remove cypress-example-todomvc-redux from release-process (#25613) chore: bump version and remove misleading changelog entry (#25612)

* fix: match alternate edge version string format (#25457) * fix: match alternate edge version string format * chore: add changelog entry * Apply suggestions from code review * Update cli/CHANGELOG.md * Update cli/CHANGELOG.md * chore: update changelog to release on Tuesday for 12.5 * [run ci] --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> * chore: Use upstream cypress-testing-library again (#25548) * chore: Use upstream cypress-testing-library again * Update cypress-example-kitchensink commit hash * Revert "Update cypress-example-kitchensink commit hash" This reverts commit 8de5d1f. --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * fix(deps): update dependency underscore.string to v3.3.6 🌟 (#25574) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> * feat: Debug page [IATR] (#25488) Co-authored-by: Zachary Williams <ZachJW34@gmail.com> Co-authored-by: Ankit <ankit@cypress.io> Co-authored-by: Stokes Player <stokes.player@gmail.com> Co-authored-by: elevatebart <bart@cypress.io> Co-authored-by: Rocky <25568640+rockindahizzy@users.noreply.github.com> Co-authored-by: Stokes Player <stokes@cypress.io> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Mark Noonan <mark@cypress.io> Co-authored-by: Mike Plummer <mikep@cypress.io> Co-authored-by: amehta265 <65267668+amehta265@users.noreply.github.com> Co-authored-by: Adam Stone-Lord <adams@cypress.io> Co-authored-by: Mike Plummer <mike-plummer@users.noreply.github.com> Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * chore: fix changlelog section parsing and reference right ENV (#25633) * test: skip flaky migration test (#25378) * chore: Update README to add Cloud badges (#25645) * perf: remove reporter logs for collapsed tests in run mode (#25632) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: 12.5.0 release (#25648) * dependency: update dependency simple-git to v3.16.0 [security] (#25603) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Zachary Williams <zachjw34@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: renovate semantic types and percy ci updates (#25651) --------- Co-authored-by: Steven Collins <steven@carboncollins.uk> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Stokes Player <stokes@cypress.io> Co-authored-by: Zachary Williams <ZachJW34@gmail.com> Co-authored-by: Ankit <ankit@cypress.io> Co-authored-by: Stokes Player <stokes.player@gmail.com> Co-authored-by: elevatebart <bart@cypress.io> Co-authored-by: Rocky <25568640+rockindahizzy@users.noreply.github.com> Co-authored-by: Mark Noonan <mark@cypress.io> Co-authored-by: Mike Plummer <mikep@cypress.io> Co-authored-by: amehta265 <65267668+amehta265@users.noreply.github.com> Co-authored-by: Adam Stone-Lord <adams@cypress.io> Co-authored-by: Mike Plummer <mike-plummer@users.noreply.github.com> Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> Co-authored-by: Matt Schile <mschile@cypress.io>

amehta265 and others added 28 commits November 22, 2022 09:45

feat: IATR-M0 Page Header (#24722)

5d44df4

Closes #24442

Merge branch 'develop' into feature/IATR-M0

7141e40

feat: IATR-M0 Spec and Test Component (#24877)

1c80741

Closes #24443 and #24444

Merge branch 'develop' into feature/IATR-M0

ad9d270

Merge branch 'develop' into feature/IATR-M0

c89cc92

feat: IATR-M1.0 Debug page Header Update (#25072)

d37581e

Co-authored-by: Stokes Player <stokes.player@gmail.com> Co-authored-by: elevatebart <bart@cypress.io> Closes #24851

feat: debug status badge (#25152)

05805e0

* feat: debug status badge * remove unused code * add debug icon * fix e2e test * address feedback

Merge branch 'develop' into feature/IATR-M0

3fd6a54

Merge branch 'develop' into feature/IATR-M0

68a02fc

feat: run failures enhancements (#25234)

216d4c5

feat: IATR empty states (#25219) [run ci]

552fe87

Merge branch 'develop' into feature/IATR-M0

9008365

feat: IATR non-failure run statuses (#25286)

bad5093

Co-authored-by: Rocky <25568640+rockindahizzy@users.noreply.github.com>

feat: IATR relevant run status banner (#25282)

031dd8b

Closes #24853

feat: IATR-M1.0 Debug Spec component update (#25263)

0a3ee16

Co-authored-by: Stokes Player <stokes.player@gmail.com> Closes #24849

feat: Add messaging for retention state exceeded (#25361)

19f76b3

feat: IATR-M0 Page Header (#24722) (#25360)

c33ba30

Closes undefined

fix: only render debug artifacts when info is available (#25362)

9e2bf5b

Co-authored-by: Stokes Player <stokes@cypress.io>

feat: Debug failed test limit (#25418) (#25434)

36a6eea

Closes #25418

Merge branch 'develop' into feature/IATR-M0

f9d81a8

feat: run filtered debug tests in runner (#25265)

7d1d6e5

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Mark Noonan <mark@cypress.io> Co-authored-by: Mike Plummer <mikep@cypress.io> Closes #24855

feat: IATR cloud data backend (#25316)

1c9d06f

Closes #24440

feat: wiring up test filters to the Debug page back end (#25492)

2a40aee

Closes #25487

Merge branch 'develop' into feature/IATR-M0

0322488

Quick whitespace fix

aa82ddf

Building windows and binaries

2b1fd83

Addinging windows

1a35da7

Fix for windows paths for debug filter

1a31dd5

Merge branch 'develop' into feature/IATR-M0

186d8c7

warrensplayer marked this pull request as ready for review January 30, 2023 20:47

warrensplayer marked this pull request as draft January 30, 2023 20:47

warrensplayer and others added 2 commits January 30, 2023 16:08

Final changelog copy update

a6a2baa

test: tweak simulated run mode and some other tests for flake (#25623)

dce4759

Co-authored-by: Stokes Player <stokes.player@gmail.com>

warrensplayer marked this pull request as ready for review January 30, 2023 21:30

warrensplayer requested a review from a team January 30, 2023 21:39

marktnoonan reviewed Jan 30, 2023

View reviewed changes

emilyrohrbough reviewed Jan 30, 2023

View reviewed changes

warrensplayer and others added 7 commits January 30, 2023 18:53

Changelog update

3431008

Updated TODO to reference issue that will address it

3ecdd59

Removing unexpected blank line

0b9913f

Changelog fix

7b74abc

Changelog fix

50e944b

Merge branch 'develop' into feature/IATR-M0

37344d7

Reverting CI workflows

c09086b

lmiller1990 self-requested a review January 31, 2023 05:07

lmiller1990 approved these changes Jan 31, 2023

View reviewed changes

marktnoonan approved these changes Jan 31, 2023

View reviewed changes

mike-plummer approved these changes Jan 31, 2023

View reviewed changes

warrensplayer merged commit 660ff67 into develop Jan 31, 2023

warrensplayer deleted the feature/IATR-M0 branch January 31, 2023 15:00

MikeMcC399 mentioned this pull request Sep 22, 2023

We detected that the Chromium Renderer process just crashed #27852

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Debug page [IATR] #25488

feat: Debug page [IATR] #25488

warrensplayer commented Jan 17, 2023 •

edited

Loading

cypress bot commented Jan 18, 2023 •

edited

Loading

marktnoonan Jan 30, 2023

warrensplayer Jan 30, 2023

emilyrohrbough Jan 30, 2023

warrensplayer Jan 30, 2023

emilyrohrbough Jan 30, 2023

pstakoun Jan 30, 2023

warrensplayer Jan 30, 2023

emilyrohrbough Jan 30, 2023

warrensplayer Jan 30, 2023

marktnoonan commented Jan 30, 2023

warrensplayer commented Jan 30, 2023

lmiller1990 commented Jan 31, 2023

lmiller1990 left a comment

warrensplayer commented Jan 31, 2023

mike-plummer left a comment


		Features:

		- Easily debug failed CI test runs from within the Cypress app with the new "Debug" page. For more details, see the [Debug documentation](https://on.cypress.io/debug-page).

	- Easily debug failed CI test runs from within the Cypress app with the new "Debug" page. For more details, see the [Debug documentation](https://on.cypress.io/debug-page).
	- Easily debug failed CI test runs right from your local Cypress app with the new Debug page, powered by Cypress Cloud. For more details, see the [Debug documentation](https://on.cypress.io/debug-page).

feat: Debug page [IATR] #25488

feat: Debug page [IATR] #25488

Conversation

warrensplayer commented Jan 17, 2023 • edited Loading

User facing changelog

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cypress bot commented Jan 18, 2023 • edited Loading

2 failed and 5 flaky tests on run #43629 ↗︎

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marktnoonan commented Jan 30, 2023

warrensplayer commented Jan 30, 2023

lmiller1990 commented Jan 31, 2023

lmiller1990 left a comment

Choose a reason for hiding this comment

warrensplayer commented Jan 31, 2023

mike-plummer left a comment

Choose a reason for hiding this comment

warrensplayer commented Jan 17, 2023 •

edited

Loading

cypress bot commented Jan 18, 2023 •

edited

Loading