Skip to content

fix(GlFilteredSearch): Stop component mutating `value` prop

Coung Ngo requested to merge cngo-fix-filtered-search-mutation into main

What does this MR do?

This MR stops GlFilteredSearch from mutating the value prop.

If the value prop is used by the parent component to reactively trigger API requests, then modifying the GlFilteredSearch tokens and text triggers a lot of unnecessary requests. This MR stops GlFilteredSearch from mutating the prop so that an API request is triggered only when the user submits the search query (by pressing Enter or clicking the search button).

Note: This MR was previously merged in !2289 (merged), then reverted in !2307 (merged) due to a problem in the Jira issues list gitlab#335805 (closed). The Jira issues list problem was fixed in gitlab!65817 (merged) so we can un-revert the GlFilteredSearch MR.

Local testing

  1. In the gitlab project, checkout the master branch
  2. In package.json, change the @gitlab/ui dependency version to https://gitlab.com/gitlab-org/gitlab-ui/-/jobs/1476209640/artifacts/raw/gitlab-ui.cngo-fix-filtered-search-mutation.tgz
  3. Do yarn install and start the GDK
  4. Test pages that have a GlFilteredSearch component

The following pages were tested with no apparent issues with the GlFilteredSearch search bar

Screenshots

GlFilteredSearch:

Before After
Screen_Recording_2021-07-06_at_3.25.11_pm Screen_Recording_2021-07-06_at_3.24.35_pm

Using GlFilteredSearch in the issues page refactor:

Before After
Screen_Recording_2021-07-06_at_5.46.52_pm Screen_Recording_2021-07-06_at_5.54.41_pm

Does this MR meet the acceptance criteria?

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidlines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Tom Quirk

Merge request reports