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.2.0 #366

Closed
wants to merge 13 commits into from
Closed

Version 1.2.0 #366

wants to merge 13 commits into from

Conversation

cea2aj
Copy link
Member

@cea2aj cea2aj commented May 9, 2023

Changes

yen-tt and others added 13 commits November 17, 2022 09:38
paired with the changes in this [PR](yext/slapshot-reusable-workflows#22) in WCAG workflow, this PR updates the WCAG github action in the repo to pass in the mapbox key. Also updated the wcag test to exclude checking elements coming from mapbox canvas container as any potential violations coming from there is outside of our repo's control.

WCAG github action also run on pull request to feature branch now.

J=SLAP-2458
TEST=auto

see that WCAG github action now passes
this pr mark LocationBias as deprecated in favor of the new Geolocation component.

I checked if storybook have some feature to inform user that a component is deprecated, there's an open feature request: storybookjs/storybook#9721 for displaying @deprecated props but nothing official yet. I did come across a custom addon: https://storybook.js.org/addons/@etchteam/storybook-addon-status which seems to work quite nicely.

Show "Deprecated" status for location bias stories:
<img width="782" alt="Screen Shot 2022-11-16 at 4 31 20 PM" src="https://user-images.githubusercontent.com/36055303/202298691-49bd8a5a-9332-4f93-8f42-0a7c408ae052.png">

J=SLAP-2448
TEST=none
In addition to the changes in the [workflow PR](yext/slapshot-reusable-workflows#24), this up updates run-tests github action and coverage github action to pass mapbox api key so visual coverage test works as expected.

J=SLAP-2467
TEST=auto

see that run-tests github action and coverage github action passed -- looked into the logs, no false positive / errors related to visual coverage.
This PR adds Geolocation component to the repo, with jest tests and storybook stories.

Note: waiting on product to get SVG design for the default geolocation icon. Edit: Will update in another PR

J=SLAP-2396,SLAP-2397,SLAP-2398
TEST=manual&auto

- tested manually through test site in Products page
- jest tests passed and storybook stories display component as expected
Update `useGeolocationHandler` so that it replaces all location filters with the new filter. In other words, filters on the `builtin.location`, `builtin.region`, and `address.countryCode` fields are all removed when a new filter is selected via the `Geolocation` component. This matches the behavior of `FilterSearch` and ensures the `State` doesn't end up with multiple location filters applied at the same time, which can have unpredictable results from the backend.

J=SLAP-2495
TEST=auto

See that the Jest tests still pass even when the mocked state includes other kinds of location filters besides those on `builtin.location`.
Currently tests are failing silently in Github actions. This PR adds checks to combined-coverage.sh script to exit if a test fails. The three tests currently failing on main will now be caught, I created this item to handle them separately, as it will require a change to make react versions to test programmable in reusable workflows

J=SLAP-2459
TEST=manual

ran actions with an intentional failure (log). Also commented out npm publish from the slap publish command and tested that it makes it passed the check there
Merge main (v1.1.0) into develop
Update the `sync_sites_branch` workflow to use the new reusable workflow.

J=SLAP-2507
TEST=manual

Test on a forked repo and see that a commit to `main` triggers a merge commit to the `storybook-site` and `test-site` branches.
This PR pins `react-collapsed` to the latest minor version (v3.6.0) that supports React 17. In v3.7.0 and v3.8.0, `react-collapsed` fixed a bug ([Slack thread](https://yext.slack.com/archives/C032CKFARGS/p1671130163844249), [GH issue](roginfarrer/collapsed#103)) that occurs when using it with React 18 by introducing a breaking change where they dropped compatibility with React 16 and 17. v3.7.0+ would break a search experience using collapsible facets with React <18. Since they are not able to support both React 17 and 18 together, it seems preferable to pin to a version that can be used with both, but is a little buggy with React 18, rather than fully functional with React 18, but breaks other React experiences.

J=SLAP-2521
TEST=manual

See that collapsible facets works as expected on a test-site running on React 17 and that the site running on React 18 still has most functionality, except for the bug described above.
Update the README to add notes about compatibility with Webpack in response to [this](#357) issue.
Create a facets component which renders any facets returned by the search. If any hierarchical facets are returned, they are rendered as standard facets.

J=BACK-2220
TEST=manual, auto

Manually tested this component on the test site and confirmed it rendered all types of facets. Also added a storybook page and automated tests and confirmed they passed.
This change updates @yext/search-headless-react to version 2.2.0-beta.0 which contains the EU endpoints change.
It also bumps @yext/search-ui-react to version 1.2.0-beta.0.

J=BACK-2270
TEST=auto,manual

Ran `npm run test`.
Ran `npx serve .` under test-site/.
Bump the search-headless-react version, add hierarchical facet to storybook

J=BACK-2237
TEST=manual

Ran storybook locally and confirmed the components worked including the new Facets component
@cea2aj cea2aj requested a review from a team as a code owner May 9, 2023 20:23
@coveralls
Copy link

Coverage Status

Coverage: 85.878% (+0.2%) from 85.72% when pulling 4245636 on develop into 65ae41d on main.

@github-actions
Copy link
Contributor

github-actions bot commented May 9, 2023

Current unit coverage is 89.07922912205568%
Current visual coverage is 77.92207792207792%
Current combined coverage is 89.72162740899357%

@benmcginnis
Copy link
Member

Connor can we cut a release from just our search core bump? I'm not sure if all of this is ready to go out

@cea2aj
Copy link
Member Author

cea2aj commented May 9, 2023

We are going to hold off on releasing Facets and these other changes until a later version, and just release the cloud choice changes now

@cea2aj cea2aj closed this May 9, 2023
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.

7 participants