fix(atomic): migrate breadbox stories to MSW and remove flaky e2e tests by Copilot · Pull Request #7277 · coveo/ui-kit

Copilot · 2026-03-24T23:31:59Z

atomic-breadbox and atomic-commerce-breadbox stories hit real Coveo APIs, making their Playwright e2e tests flaky. Both components already have comprehensive vitest unit tests with Headless module mocking covering the same scenarios.

Stories → MSW

atomic-breadbox: Added MockSearchApi harness, removed 30s waitFor polling for real API facet values
atomic-commerce-breadbox: Replaced getSampleCommerceEngineConfiguration() with MockCommerceApi harness

const mockSearchApi = new MockSearchApi();
// ...
parameters: {
  msw: {handlers: [...mockSearchApi.handlers]},
},
beforeEach: () => {
  mockSearchApi.searchEndpoint.clear();
},

Removed e2e tests

Deleted e2e/ directories for both components (6 files, ~740 lines)

New vitest unit tests

Added 11 new vitest unit tests to close the coverage gap left by the removed e2e tests:

atomic-breadbox.spec.ts (6 new tests → 32 total):

Breadcrumb displays facet label and value together (e.g., "Test Facet: People")
Category facet breadcrumbs render with path values (e.g., "Test Category: Electronics / Laptops")
Date facet breadcrumbs render with formatted values
Numeric facet breadcrumbs render with formatted values
Deselect called when clicking a category breadcrumb
Deselect called when clicking a date breadcrumb

atomic-commerce-breadbox.spec.ts (5 new tests → 31 total):

Breadcrumb button title includes facet label and value (e.g., "Regular: Gucci")
Hierarchical facet label with full path on breadcrumb button
Deselect called when clicking a hierarchical breadcrumb
Deselect called when clicking a date range breadcrumb
Deselect called when clicking a numerical range breadcrumb

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

svcsnykcoveo · 2026-03-24T23:32:12Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Migrate atomic-breadbox and atomic-commerce-breadbox Storybook stories to use MSW for API mocking instead of hitting real Coveo APIs. Remove flaky Playwright e2e tests since existing comprehensive vitest unit tests with Headless module mocking already cover the same scenarios. Co-authored-by: louis-bompart <12366410+louis-bompart@users.noreply.github.com> Agent-Logs-Url: https://github.com/coveo/ui-kit/sessions/4c84d212-ffda-4acb-9be1-1d736d1b40f8

louis-bompart · 2026-03-25T00:07:22Z

@copilot cool, but I don't see new unit-tests w/ vitests. This creates a gap

…e2e gaps Add new vitest unit tests to close the coverage gap from removed e2e tests: atomic-breadbox (6 new tests): - Breadcrumb displays facet label and value together - Category facet breadcrumbs with path values - Date facet breadcrumbs with formatted values - Numeric facet breadcrumbs with formatted values - Deselect on category breadcrumb click - Deselect on date breadcrumb click atomic-commerce-breadbox (5 new tests): - Breadcrumb button title includes facet label and value - Hierarchical facet label with full path on breadcrumb - Deselect on hierarchical breadcrumb click - Deselect on date range breadcrumb click - Deselect on numerical range breadcrumb click Co-authored-by: louis-bompart <12366410+louis-bompart@users.noreply.github.com> Agent-Logs-Url: https://github.com/coveo/ui-kit/sessions/eae03672-b7e0-4859-bfa0-6c468d06dc3c

Copilot · 2026-03-25T00:22:41Z

@copilot cool, but I don't see new unit-tests w/ vitests. This creates a gap

Added 11 new vitest unit tests in cf817d3 to close the gap:

atomic-breadbox (6 new tests): facet label+value display, category facet breadcrumbs with path values, date/numeric facet breadcrumbs with formatted values, deselect on category and date breadcrumb click.

atomic-commerce-breadbox (5 new tests): breadcrumb button title includes facet label+value, hierarchical facet label with full path, deselect on hierarchical/date range/numerical range breadcrumb click.

Total tests now: 32 (search) + 31 (commerce) = 63 passing.

…select tests Co-authored-by: louis-bompart <12366410+louis-bompart@users.noreply.github.com> Agent-Logs-Url: https://github.com/coveo/ui-kit/sessions/eae03672-b7e0-4859-bfa0-6c468d06dc3c

alexprudhomme · 2026-04-08T17:39:12Z

Hey @copilot-swe-agent 👋 ✅ This PR does not need a changeset file — you don't have one currently, so it's perfect. This PR only migrates stories and tests (to MSW / removing flaky e2e), not runtime code in published packages. For more info on when changesets are needed, see the Changesets README.

changeset-bot · 2026-04-14T02:47:03Z

⚠️ No Changeset found

Latest commit: 2ff1952

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

Copilot

Pull request overview

This PR removes flaky Playwright e2e coverage for the Atomic breadbox components by switching their Storybook stories to MSW-backed mocks and replacing the deleted e2e scenarios with Vitest unit tests.

Changes:

Migrated atomic-breadbox and atomic-commerce-breadbox Storybook stories to MSW using MockSearchApi / MockCommerceApi.
Removed Playwright e2e tests and page objects for both breadbox components.
Added new Vitest unit tests to cover breadcrumb titles/paths and deselect behavior for additional facet types.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/atomic/src/components/search/atomic-breadbox/e2e/page-object.ts	Deleted Playwright page object (removes flaky e2e dependency).
packages/atomic/src/components/search/atomic-breadbox/e2e/fixture.ts	Deleted Playwright fixture for breadbox e2e.
packages/atomic/src/components/search/atomic-breadbox/e2e/atomic-breadbox.e2e.ts	Deleted flaky breadbox e2e test suite.
packages/atomic/src/components/search/atomic-breadbox/atomic-breadbox.spec.ts	Added/updated Vitest coverage for breadcrumb title formatting and deselect behavior (category/date/numeric).
packages/atomic/src/components/search/atomic-breadbox/atomic-breadbox.new.stories.tsx	Switched story to MSW with `MockSearchApi`, removed long polling wait.
packages/atomic/src/components/commerce/atomic-commerce-breadbox/e2e/page-object.ts	Deleted Playwright page object (removes flaky e2e dependency).
packages/atomic/src/components/commerce/atomic-commerce-breadbox/e2e/fixture.ts	Deleted Playwright fixture for commerce breadbox e2e.
packages/atomic/src/components/commerce/atomic-commerce-breadbox/e2e/atomic-commerce-breadbox.e2e.ts	Deleted flaky commerce breadbox e2e test suite.
packages/atomic/src/components/commerce/atomic-commerce-breadbox/atomic-commerce-breadbox.spec.ts	Added Vitest coverage for breadcrumb `title` content and deselect behavior for multiple breadcrumb types.
packages/atomic/src/components/commerce/atomic-commerce-breadbox/atomic-commerce-breadbox.new.stories.tsx	Switched story to MSW with `MockCommerceApi` and cleared listing endpoint per story run.

Copilot · 2026-04-14T02:52:41Z

 const meta: Meta = {
  component: 'atomic-breadbox',
  title: 'Search/Breadbox',
  id: 'atomic-breadbox',

  render: (args) => template(args),
  decorators: [decorator],
  parameters: {
    ...parameters,
    chromatic: {disableSnapshot: true},
    actions: {
      handles: events,
    },
+    msw: {handlers: [...mockSearchApi.handlers]},
  },
  args,
  argTypes,
+  beforeEach: () => {
+    mockSearchApi.searchEndpoint.clear();
+  },
  play,
 };


This PR modifies the public @coveo/atomic package (storybook stories/tests and component-related behavior). Per repo guidelines, please add a Changeset under .changeset/ describing this change (or update an existing pending Changeset if one already covers it) so it gets included in the next release notes/version bump.

chromatic-com · 2026-04-14T02:54:09Z

Important

Testing in progress…

🟢 UI Tests: 355 tests unchanged
⏳ UI Review: Comparing 355 stories…
Storybook Publish: 355 stories published

chromatic-com · 2026-04-14T02:54:10Z

Tip

All tests passed and all changes approved!

🟢 UI Tests: 355 tests unchanged
🟢 UI Review: 355 stories published -- no changes
Storybook Publish: 355 stories published

pkg-pr-new · 2026-04-14T02:54:25Z

Open in StackBlitz

@coveo/atomic

npm i https://pkg.pr.new/@coveo/atomic@7277

@coveo/atomic-hosted-page

npm i https://pkg.pr.new/@coveo/atomic-hosted-page@7277

@coveo/atomic-legacy

npm i https://pkg.pr.new/@coveo/atomic-legacy@7277

@coveo/atomic-react

npm i https://pkg.pr.new/@coveo/atomic-react@7277

@coveo/auth

npm i https://pkg.pr.new/@coveo/auth@7277

@coveo/bueno

npm i https://pkg.pr.new/@coveo/bueno@7277

@coveo/create-atomic

npm i https://pkg.pr.new/@coveo/create-atomic@7277

@coveo/create-atomic-component

npm i https://pkg.pr.new/@coveo/create-atomic-component@7277

@coveo/create-atomic-component-project

npm i https://pkg.pr.new/@coveo/create-atomic-component-project@7277

@coveo/create-atomic-result-component

npm i https://pkg.pr.new/@coveo/create-atomic-result-component@7277

@coveo/create-atomic-rollup-plugin

npm i https://pkg.pr.new/@coveo/create-atomic-rollup-plugin@7277

@coveo/headless

npm i https://pkg.pr.new/@coveo/headless@7277

@coveo/headless-react

npm i https://pkg.pr.new/@coveo/headless-react@7277

@coveo/shopify

npm i https://pkg.pr.new/@coveo/shopify@7277

commit: 2ff1952

Initial plan

1cede0f

Copilot AI assigned Copilot and louis-bompart Mar 24, 2026

Copilot started work on behalf of louis-bompart March 24, 2026 23:32 View session

Copilot AI changed the title ~~[WIP] Update Storybook stories to use MSW for stability~~ fix(atomic): migrate breadbox stories to MSW and remove flaky e2e tests Mar 24, 2026

Copilot AI requested a review from louis-bompart March 24, 2026 23:55

Copilot finished work on behalf of louis-bompart March 24, 2026 23:55

Copilot started work on behalf of louis-bompart March 25, 2026 00:07 View session

fix(atomic): use wide viewport instead of try-catch for breadcrumb de…

54efca5

…select tests Co-authored-by: louis-bompart <12366410+louis-bompart@users.noreply.github.com> Agent-Logs-Url: https://github.com/coveo/ui-kit/sessions/eae03672-b7e0-4859-bfa0-6c468d06dc3c

Copilot finished work on behalf of louis-bompart March 25, 2026 00:30

louis-bompart marked this pull request as ready for review March 25, 2026 00:49

louis-bompart requested review from a team, alexprudhomme, Copilot, jpmarceau, jsmith2-coveo, tbaxter-coveo and y-lakhdar and removed request for Copilot March 25, 2026 00:49

louis-bompart marked this pull request as draft March 25, 2026 13:30

Copilot AI temporarily deployed to pr-workflows March 25, 2026 13:30 Inactive

Copilot AI temporarily deployed to PR Artifacts March 25, 2026 13:30 Inactive

coveo-code-areas-pr-checks Bot added area:atomic area:documentation team:dev-writers team:dxui labels Mar 25, 2026

Copilot AI temporarily deployed to Prerelease (CDN) March 25, 2026 13:34 Inactive

Copilot AI temporarily deployed to PR Artifacts March 25, 2026 13:40 Inactive

Merge branch 'main' into copilot/update-stories-to-use-msw

2ff1952

louis-bompart temporarily deployed to pr-workflows April 14, 2026 02:47 — with GitHub Actions Inactive

louis-bompart temporarily deployed to PR Artifacts April 14, 2026 02:47 — with GitHub Actions Inactive

louis-bompart marked this pull request as ready for review April 14, 2026 02:48

Copilot AI review requested due to automatic review settings April 14, 2026 02:48

Copilot started reviewing on behalf of louis-bompart April 14, 2026 02:49 View session

Copilot AI reviewed Apr 14, 2026

View reviewed changes

louis-bompart temporarily deployed to PR Artifacts April 14, 2026 02:57 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(atomic): migrate breadbox stories to MSW and remove flaky e2e tests#7277

fix(atomic): migrate breadbox stories to MSW and remove flaky e2e tests#7277
Copilot wants to merge 5 commits intomainfrom
copilot/update-stories-to-use-msw

Copilot AI commented Mar 24, 2026 •

edited

Loading

Uh oh!

svcsnykcoveo commented Mar 24, 2026 •

edited

Loading

Uh oh!

louis-bompart commented Mar 25, 2026

Uh oh!

Copilot AI commented Mar 25, 2026

Uh oh!

alexprudhomme commented Apr 8, 2026 •

edited

Loading

Uh oh!

changeset-bot Bot commented Apr 14, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 14, 2026

Uh oh!

chromatic-com Bot commented Apr 14, 2026

Testing in progress…

Uh oh!

chromatic-com Bot commented Apr 14, 2026 •

edited

Loading

All tests passed and all changes approved!

Uh oh!

pkg-pr-new Bot commented Apr 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

Copilot AI commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Stories → MSW

Removed e2e tests

New vitest unit tests

Uh oh!

svcsnykcoveo commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

louis-bompart commented Mar 25, 2026

Uh oh!

Copilot AI commented Mar 25, 2026

Uh oh!

alexprudhomme commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Apr 14, 2026

⚠️ No Changeset found

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

chromatic-com Bot commented Apr 14, 2026

Testing in progress…

Uh oh!

chromatic-com Bot commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

All tests passed and all changes approved!

Uh oh!

pkg-pr-new Bot commented Apr 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Mar 24, 2026 •

edited

Loading

svcsnykcoveo commented Mar 24, 2026 •

edited

Loading

alexprudhomme commented Apr 8, 2026 •

edited

Loading

chromatic-com Bot commented Apr 14, 2026 •

edited

Loading