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

Version 1.4.0 #411

Merged
merged 9 commits into from
Dec 8, 2023
Merged

Version 1.4.0 #411

merged 9 commits into from
Dec 8, 2023

Conversation

nmanu1
Copy link
Contributor

@nmanu1 nmanu1 commented Dec 8, 2023

Changes

Fixes

github-actions bot and others added 9 commits September 13, 2023 15:39
### Bug fixes
- Revert the introduction of "type": "module" from the package.json file due to issues with various integrations

Co-authored-by: cea2aj <42848445+cea2aj@users.noreply.github.com>
Introduce tsup and improve the package.json file in order to support PagesJS.

This works in both dev and prod mode of pagesJS. Currently the storybook tests are failing, however we will address that in a future PR.

This changes updates our esm files to created in a bundle in the dist folder. The esm files now end with .mjs rather than .js which may be a breaking change for some build tools. I struggled to get `type: module` to work in many situations, whereas using .mjs files worked better across the board. Regardless, these changes caused a lot of different issues, so I think this should go in the next major version

J=BACK-2545
TEST=manual

Publish an alpha version and test it with @yext/pages@1.0.0-rc.3. Add several search components to the page and confirm they work as expected.

Currently the storybook tests are failing and need to be fixed.
A few of the imports slipped through the cracks. This change fixes them

J=BACK-2545
TEST=manual

Confirmed this still works with the latest version of pages
Bump the search-headless-react version in order to revert the rawData type change

J=BACK-2523
TEST=compile
Make updates to the Storybook setup and stories to fix the visual coverage and WCAG checks that have been failing since the Storybook version was upgraded. These changes include
- updating all Storybook files to use TS instead of JS
- removal of the hardcoded CJS entrypoints for `@reach` package imports from the Storybook preview
- removal/updating usage of deprecated Storybook types
- exclusion of more components provided by `mapbox-gl`, over which we have no control in terms of WCAG violations
- removal of Tailwind since the CSS bundle from `dist` is directly imported now instead of a Storybook-specific `index.css`

J=BACK-2831
TEST=auto

See that the `WCAG tests`, `Code Coverage`, and `Run Tests` checks are now all passing.

Note: the Semgrep check is failing because of the license of the `store2` package, which was not updated in this PR.
Update the visual regression snapshots to use the Storybook add-on `jest-image-snapshot` rather than Percy. We can now remove Percy from the repo entirely. The workflow now checks snapshots and commits any that have changed. Also, the play functions for stories are fixed so async actions are properly awaited. 

The loading state for the `Geolocation` component includes animation, so the snapshot doesn't match perfectly each time. To account for this, the threshold for failure for this story is increased to a 0.005% difference in the image rather than an exact match. We also use this threshold for `MapboxMap` stories because the map canvas can have slight changes.

The `MapboxMap` component takes some time to load. I wasn't able to find a good way to detect the correct time to take a snapshot, so I added a 7500ms wait for these stories to give the map time to load before taking the snapshot. Adding more robust detection logic will be part of another [item](https://yexttest.atlassian.net/browse/BACK-2843). This item will also address the snapshot for the loading story for `LocationBias`. Right now, we skip taking a snapshot for this story because the snapshot is blank. This is likely because geolocation permissions are disabled for the test runner, so the request for the location is automatically denied.

J=BACK-2832
TEST=auto
Upgrade `@babel/traverse` from v7.23.0 (in top-level package-lock) and v7.20.1 (in the test site's package-lock) to 7.23.5 to address a critical vulnerability in the package.

Also, add some changes from running ESLint locally, since the linting PR check doesn't currently work.

J=VULN-38476, VULN-38477
TEST=auto
Bump package.json to v1.4.0 and search-headless-react to v2.4.0.
@coveralls
Copy link

Coverage Status

coverage: 85.159% (-0.8%) from 85.921%
when pulling f0a695a on develop
into bab403a on main.

Copy link
Contributor

github-actions bot commented Dec 8, 2023

Current unit coverage is 92.18045112781955%
Current visual coverage is 78.34757834757835%
Current combined coverage is 92.68537074148297%

@nmanu1 nmanu1 marked this pull request as ready for review December 8, 2023 21:11
@nmanu1 nmanu1 requested a review from a team as a code owner December 8, 2023 21:12
@nmanu1 nmanu1 merged commit a5e8a64 into main Dec 8, 2023
20 of 22 checks passed
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.

4 participants