ADR 009: Guidelines for interaction tests in primer-react

[pksjce]

Describe your changes here.

This ADR proposes some instructions for how we should write interaction tests. Feedback welcome!

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 3a99ca02c9b960c2c52ae123d347197db595dbeb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions[bot]]

size-limit report 📦

Path	Size
dist/browser.esm.js	75.62 KB (0%)
dist/browser.umd.js	76.23 KB (0%)

[lesliecdubs]

Thanks for contributing this ADR, @pksjce!

In order to help move a decision forward, I'm assigning the following:

ADR decision maker: @colebemis
Decision deadline: EOD Monday, 22 August

Your role as decision maker is to gather feedback, probe for discussion and disagreement, and then make an informed decision based on the feedback, identified risks, and trade-offs about whether to adopt the ADR or not. Your role is not to decide based on your own personally preferred approach.

Keep in mind that ADR decisions can be reversed or changed in the future if new information is exposed that make the ADR worth revisiting.

You can fulfill your decision maker role by doing the following:

• review the ADR, comments, and feedback closely
• seek additional feedback from any necessary parties, as needed; for example, request a review from any individuals or teams that you know would be unduly affected by this ADR, or who have extensive experience in using either the preferred or non-preferred approach and may have perspective to share about it
• follow up on any remaining concerns, questions, or unexamined risks around accepting the proposed approach
• on or before the deadline, make a decision as to whether the ADR is accepted ✅ , which you should signal by approving this PR, or rejected 🚫 , which you should signal by closing this PR with a comment explaining the reason(s)

[broccolinisoup]

Thanks so much for putting this ADR together @pksjce ! It helped me understand where we are at testing and what our options are. I haven't used Storybook's interaction tests before but I like the approach. Are we thinking them as an alternative to E2E testing or are we thinking starting with Storybook play functions and down the road, we can introduce a more comprehensive tool for E2E and integrate into our CI/CD?

[pksjce]

@siddharthkp - Thanks so much for your comments.

Re- Deep storybook integration. We are already pretty deep into storybooks. We use them for all primer properties, most people are familiar with them, chromatic runs on top of it etc. Also Storybook is a pretty active project with pretty responsive maintainers. So we know they are going to evolve pretty fast with the general javascript ecosystem. eg - They are working on vitejs integration which could make the storybook build itself super fast. There's been no pushback or nobody has really proposed an alternative to storybook in our team or in the general community so far IMO. Most component libs use storybooks too. So, I kinda feel like its in our benefit to grow with them and make use of all their new features eg play functions. You can see that they are really working on it and some exciting updates are coming in 7.0.0 too.

Re- Test Coverage - I've been looking into this since the last time you mentioned it in chat. I'm having a slightly hard time coming up with a solution for this. Maybe we could pair sometime next week and brainstorm what to do for this?

[siddharthkp]

Re- Test Coverage - I've been looking into this since the last time you mentioned it in chat. I'm having a slightly hard time coming up with a solution for this. Maybe we could pair sometime next week and brainstorm what to do for this?

Yep, I'm pretty clueless as well, let's do that :)