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

feat: IATR-M0 Debug Page #25067

Merged
merged 26 commits into from
Dec 13, 2022
Merged

Conversation

warrensplayer
Copy link
Contributor

@warrensplayer warrensplayer commented Dec 8, 2022

User facing changelog

NOT APPLICABLE This feature is being merged into a feature branch to be released with milestone 1.0 for the In App Test Results epic

Additional details

Background
This PR adds a new page to the Cypress called "Debug". This page will contain the features for the project known as In App Test Results [IATR]. This project will add the ability for a developer that is connected to the Cypress Cloud to view tests that have been recorded as failed to a Cloud run in the app. The goal of the milestone 0 of this feature will allow the developer to easily run the test locally to reproduce the error. Milestone 0 is not going to be released to users, but will remain held in a feature branch.

NOTE The code introduces some new GraphQL fields from the Cypress Cloud that are currently being held in a feature branch on the Cloud side. When running this branch for testing, you can still run the component tests that are introduced or updated in this branch. You will not be able to test the full functionality in the app itself yet without running a local Cypress Cloud instance. The Cloud team is working on setting up a "preview" environment that can be used for testing the app while we work through M1 (milestone 1) work and to use for acceptance testing before the Cloud code gets released to production.

What is new

  • A new page in the App called "Debug" that appears in the sidebar between "Runs" and "Settings"
  • The page has text only empty states that will be enhanced in M1 for:
    • Not logged in
    • Not connected
    • No runs
  • Uses the components for the run information and failed spec with tests added in these PRs: feat: IATR-M0 Page Header #24722 and feat: IATR-M0 Spec and Test Component #24877
  • New components added
    • packages/app/src/debug/DebugContainer.vue
    • packages/app/src/debug/DebugSpecList.vue
    • packages/app/src/pages/Debug.vue
  • Changes in the cloud graphql schema caused the need to update a few types and fill in new required fields. The main need for this was in RunStatusDots.vue and the e2e test packages/app/cypress/e2e/specs_list_latest_runs.cy.ts

Steps to test

The easiest way to test will just be to run the tests that were added or changed for this issue.

  • packages/app/src/debug/DebugContainer.cy.tsx
  • packages/app/cypress/e2e/sidebar_navigation.cy.ts
  • packages/app/src/debug/DebugPageHeader.cy.tsx
  • packages/app/src/debug/DebugSpec.cy.tsx
  • packages/app/src/navigation/SidebarNavigationRow.cy.tsx
  • packages/app/cypress/e2e/specs_list_latest_runs.cy.ts

How has the user experience changed?

New sidebar nav for "Debug"
Screen Shot 2022-12-08 at 11 28 24 AM

Basic empty states that will be enhanced later

  • Not logged in

Screen Shot 2022-12-08 at 11 28 56 AM

* Not connected

Screen Shot 2022-12-08 at 11 29 03 AM

* No runs

Screen Shot 2022-12-08 at 11 29 12 AM

Use new components to show runs and failed tests
Screen Shot 2022-12-09 at 2 06 52 PM

PR Tasks

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

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Dec 8, 2022

Thanks for taking the time to open a PR!

@warrensplayer warrensplayer changed the title feat:IATR-M0 Debug Page feat: IATR-M0 Debug Page Dec 8, 2022
@cypress
Copy link

cypress bot commented Dec 8, 2022



Test summary

25028 2 2490 0Flakiness 20


Run details

Project cypress
Status Failed
Commit 9d62ced
Started Dec 12, 2022 7:46 PM
Ended Dec 12, 2022 8:03 PM
Duration 17:21 💡
OS Linux Debian -
Browser Multiple

View run in Cypress Dashboard ➡️


Failures

commands/waiting.cy.ts Failed
1 cy.origin waiting > alias > waits for the route alias to have a response
user_agent_override.cy.ts Failed
1 user agent override > persists modified user agent after cy.go

Flakiness

cypress/e2e/e2e/origin/cookie_behavior.cy.ts Flakiness
1 ... > same site / cross origin > XMLHttpRequest > sets cookie on same-site request if withCredentials is true, and attaches to same-site request if withCredentials is true
2 ... > same site / cross origin > fetch > sets same-site cookies if "include" credentials option is specified from request, but does not attach same-site cookies to request by default (same-origin)
3 ... > same site / cross origin > XMLHttpRequest > sets cookie on same-site request if withCredentials is true, and attaches to same-site request if withCredentials is true
4 ... > same site / cross origin > fetch > sets same-site cookies if "include" credentials option is specified from request, but does not attach same-site cookies to request by default (same-origin)
5 ... > same site / cross origin > XMLHttpRequest > sets cookie on same-site request if withCredentials is true, and attaches to same-site request if withCredentials is true
This comment includes only the first 5 flaky tests. See all 20 flaky tests in the Cypress Dashboard.

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@warrensplayer warrensplayer marked this pull request as ready for review December 9, 2022 19:28
@warrensplayer warrensplayer requested a review from a team December 9, 2022 19:28
packages/app/src/debug/DebugPageHeader.vue Show resolved Hide resolved
packages/app/src/debug/DebugPageHeader.vue Outdated Show resolved Hide resolved
packages/app/src/debug/DebugPageHeader.vue Outdated Show resolved Hide resolved
packages/app/src/debug/DebugPageHeader.vue Outdated Show resolved Hide resolved
packages/app/src/debug/DebugContainer.vue Show resolved Hide resolved
packages/app/src/debug/DebugContainer.vue Show resolved Hide resolved
packages/app/src/debug/DebugContainer.vue Outdated Show resolved Hide resolved
packages/app/src/debug/DebugContainer.vue Outdated Show resolved Hide resolved
@lmiller1990 lmiller1990 requested a review from a team December 11, 2022 23:04
packages/app/src/debug/DebugContainer.cy.tsx Outdated Show resolved Hide resolved
packages/app/src/debug/DebugContainer.cy.tsx Outdated Show resolved Hide resolved
packages/app/src/debug/DebugContainer.vue Outdated Show resolved Hide resolved
packages/app/src/debug/DebugPageHeader.cy.tsx Show resolved Hide resolved
packages/app/src/debug/DebugSpec.vue Show resolved Hide resolved
packages/app/src/debug/DebugSpecList.vue Outdated Show resolved Hide resolved
packages/app/src/debug/utils/DebugMapping.ts Show resolved Hide resolved
@lmiller1990
Copy link
Contributor

It sure does look nice! Excited for this feature.

Copy link
Contributor

@ZachJW34 ZachJW34 left a comment

Choose a reason for hiding this comment

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

Few comments, nothing blocking. LGTM!

packages/app/src/debug/DebugContainer.cy.tsx Outdated Show resolved Hide resolved
packages/app/src/debug/DebugContainer.vue Outdated Show resolved Hide resolved
packages/app/src/debug/DebugPageHeader.vue Outdated Show resolved Hide resolved
Co-authored-by: Zachary Williams <ZachJW34@gmail.com>
Copy link
Contributor

@mike-plummer mike-plummer left a comment

Choose a reason for hiding this comment

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

Thanks for addressing my comments, no issues here

Copy link
Contributor

@lmiller1990 lmiller1990 left a comment

Choose a reason for hiding this comment

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

This is looking good to me.

@lmiller1990 lmiller1990 merged commit ee859f6 into feature/IATR-M0 Dec 13, 2022
@lmiller1990 lmiller1990 deleted the stokes/IATR-M0-debug-page-24441 branch December 13, 2022 02:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants