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

Review Chromatic current state #270

Closed
MellyGray opened this issue Dec 21, 2023 · 5 comments
Closed

Review Chromatic current state #270

MellyGray opened this issue Dec 21, 2023 · 5 comments
Assignees
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours. UI Tasks related to the user interface (UI) or frontend development

Comments

@MellyGray
Copy link
Contributor

MellyGray commented Dec 21, 2023

Overview of the Feature Request

We need to review Chromatic current state as there are some pending changes. We need to bring it to a stable point so that the new changes applied in each new PR can be reviewed when they go through QA.

If there are some changes needed in the UI to approve the current state of Chromatic, we will create issues to assess those changes

What inspired the request?

There are pending changes in Chromatic
https://www.chromatic.com/reviews?appId=646f68aa9beb01b35c599acd

@MellyGray MellyGray added pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours. labels Dec 21, 2023
@M27Mangan M27Mangan self-assigned this Jan 31, 2024
@M27Mangan M27Mangan added the UI Tasks related to the user interface (UI) or frontend development label Feb 1, 2024
@M27Mangan
Copy link

Reviewed and set baselines per the Chromatic docs to hopefully reduce the number of changed elements that need reviews at each PR. If anything is not looking as-expected then please let me know and we should review as a team.

@M27Mangan M27Mangan assigned M27Mangan and unassigned M27Mangan Feb 7, 2024
@M27Mangan M27Mangan reopened this Feb 7, 2024
@ekraffmiller ekraffmiller self-assigned this Feb 8, 2024
@ekraffmiller
Copy link
Contributor

It's nice to have all the reviews up to date! I noticed that some changes are being flagged because we are using randomized test data, it might be useful to modify how the Stories are run for chromatic, so that randomized doesn't get interpreted in Chormatic as a change in the UI.
For example in this review-
https://www.chromatic.com/review?appId=646f68aa9beb01b35c599acd&number=296&type=linked&view=changes

In the files table, we randomize File Access and ingest state
Image

And in multiple stories, we have random faker data, for example
Image

We could use a faker.seed() to have reproducible results (https://fakerjs.dev/guide/usage.html#reproducible-results) and have conditional logic to only set the seed for a chromatic run https://www.chromatic.com/docs/ischromatic/#with-an-environment-variable.
It could be a bit involved to set the seed correctly and have it visible to all the stories, so it might be worth saving that as a separate ticket and keep doing a visual review for now. Would be good to discuss with the team.

@M27Mangan
Copy link

@ekraffmiller Based on todays call, I have opened #305 to address the Faker data differences. How should we proceed with this item?

@ekraffmiller
Copy link
Contributor

@M27Mangan there is one more thing I noticed...sometimes the snapshot of a Story is taken before the component finishes loading, for example https://www.chromatic.com/review?appId=646f68aa9beb01b35c599acd&number=296&type=linked&view=components&groupPrefix=Sections%2FDataset+Page

Image

Can we add this to #305? I think it can be solved by adding a delay https://www.chromatic.com/docs/delay/. Then I can close this ticket.

@ekraffmiller
Copy link
Contributor

Closing this issue, the follow up tasks are in #305

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours. UI Tasks related to the user interface (UI) or frontend development
Projects
None yet
Development

No branches or pull requests

3 participants