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-M1.0 Debug page Header Update #25072

Merged
merged 12 commits into from
Dec 15, 2022

Conversation

amehta265
Copy link
Contributor

User facing changelog

This PR aims to update the Debug Page Header to provide more information. It accomplishes the following:

  1. Removal of the run Number from the first row so that the "commits Ahead" message is the only element visible in the top section.
  2. Adding a run status component in the bottom section. This section contains a status icon and the run number with matching colors depending on the status returned from the cloud. This takes into account all current run statuses (Passed, Failed, Errored, Cancelled, Running)
  3. Removing the status icon and status name from the test counts
  4. Adding a flaky badge which comprises of the total flaky tests number and the "Flaky" text separated by a vertical border. This is only visible when the total number of flaky tests is > 0 and the value is not null
  • Refer to the images below. Each numbered point above has a corresponding visual queue in the pictures attached below

Additional details

  • A color mapping has been added to debugPageHeader.vue. The design for the run status requires matching colors for the text (run number) and icon. In order to render a specific color depending on the status I have created a simple mapping for each possible status and the respective color

Steps to test

This issue has 2 component tests. Checkout to this branch to run the tests
Both DebugPageHeader.vue and DebugResults.vue exist in the packages/app/ folder. To run these tests:

  1. Change directory to packages/app
  2. Run yarn dev
  3. Navigate to Component Testing and run DebugPageHeader.cy.tsx and DebugResults.cy.tsx

How has the user experience changed?

Updated Page Header:
Screenshot 2022-12-08 at 12 15 47 PM

Old Page Header:
205516772-cb9ec9c3-950e-4a92-988e-99bcfb4d98a4

PR Tasks

  • Have tests been added/updated?
  • [na] Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
  • [na] Has a PR for user-facing changes been opened in cypress-documentation?
  • [na] 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!

@amehta265 amehta265 changed the title completed initial UI updates and tests for the changes feat: IATR-M1.0 Debug page Header Update Dec 13, 2022
@cypress
Copy link

cypress bot commented Dec 13, 2022

@warrensplayer warrensplayer marked this pull request as ready for review December 13, 2022 21:10
@warrensplayer warrensplayer requested a review from a team December 14, 2022 14:35
@marktnoonan marktnoonan self-requested a review December 14, 2022 14:50
Copy link
Contributor

@astone123 astone123 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 👍🏻 I left some minor comments

packages/app/src/debug/DebugPageHeader.cy.tsx Outdated Show resolved Hide resolved
packages/app/src/debug/DebugPageHeader.cy.tsx Show resolved Hide resolved
packages/app/src/debug/DebugPageHeader.vue Outdated Show resolved Hide resolved
packages/app/src/debug/DebugResults.vue Outdated Show resolved Hide resolved
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. I'm definitely interested in making things as type safe as possible, but not obvious issues with the implementation.

@@ -21,6 +21,7 @@
"dependencies": {},
"devDependencies": {
"@cypress-design/vue-icon": "^0.12.1",
"@cypress-design/vue-statusicon": "0.1.4",
Copy link
Contributor

Choose a reason for hiding this comment

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

Not really your wheelhouse, but I wonder why they don't just publish a single package, cypress-design/core, with everything we need.

Copy link
Contributor

Choose a reason for hiding this comment

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

@lmiller1990 That is because of versioning.
Upgrading a package should not risk breaking the rest of the platform.
It is a way of minimizing the surface risk while still mutualizing the components.

We might create a @cypress-design/core at some point once it stabilizes.

@warrensplayer warrensplayer merged commit d37581e into feature/IATR-M0 Dec 15, 2022
@warrensplayer warrensplayer deleted the ankit/IATR-M1.0-Header-Update branch December 15, 2022 18:24
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.

6 participants