From 57ca5d9a67dc6ffbc3cc0aedea48df553c82d9d6 Mon Sep 17 00:00:00 2001
From: David Walsh <davidwalsh83@gmail.com>
Date: Fri, 28 Jul 2023 11:25:48 -0500
Subject: [PATCH] Implement Network Menu Search (#19985)

* WIP: Implement Network Menu Search

* Maintain order, add tests

* Remove unwanted locale

* Fix duplicate import, better focus and item autofocus
---
 app/_locales/en/messages.json                 |  3 +
 .../network-list-item/network-list-item.js    |  9 ++-
 .../network-list-menu/network-list-menu.js    | 66 ++++++++++++++++++-
 .../network-list-menu.test.js                 | 14 +++-
 4 files changed, 87 insertions(+), 5 deletions(-)

diff --git a/app/_locales/en/messages.json b/app/_locales/en/messages.json
index ea628a029..fdd3a614d 100644
--- a/app/_locales/en/messages.json
+++ b/app/_locales/en/messages.json
@@ -2538,6 +2538,9 @@
   "noNFTs": {
     "message": "No NFTs yet"
   },
+  "noNetworksFound": {
+    "message": "No networks found for the given search query"
+  },
   "noSnaps": {
     "message": "You don't have any snaps installed."
   },
diff --git a/ui/components/multichain/network-list-item/network-list-item.js b/ui/components/multichain/network-list-item/network-list-item.js
index 442568a69..2ff07e9b2 100644
--- a/ui/components/multichain/network-list-item/network-list-item.js
+++ b/ui/components/multichain/network-list-item/network-list-item.js
@@ -47,6 +47,7 @@ export const NetworkListItem = ({
   name,
   iconSrc,
   selected = false,
+  focus = true,
   onClick,
   onDeleteClick,
 }) => {
@@ -54,10 +55,10 @@ export const NetworkListItem = ({
   const networkRef = useRef();
 
   useEffect(() => {
-    if (networkRef.current && selected) {
+    if (networkRef.current && focus) {
       networkRef.current.focus();
     }
-  }, [networkRef, selected]);
+  }, [networkRef, focus]);
 
   return (
     <Box
@@ -148,4 +149,8 @@ NetworkListItem.propTypes = {
    * Executes when the delete icon is clicked
    */
   onDeleteClick: PropTypes.func,
+  /**
+   * Represents if the network item should be keyboard selected
+   */
+  focus: PropTypes.bool,
 };
diff --git a/ui/components/multichain/network-list-menu/network-list-menu.js b/ui/components/multichain/network-list-menu/network-list-menu.js
index d89a4e9d2..9fd49b9bd 100644
--- a/ui/components/multichain/network-list-menu/network-list-menu.js
+++ b/ui/components/multichain/network-list-menu/network-list-menu.js
@@ -1,7 +1,8 @@
-import React, { useContext, useEffect } from 'react';
+import React, { useContext, useEffect, useState } from 'react';
 import PropTypes from 'prop-types';
 import { useDispatch, useSelector } from 'react-redux';
 import { useHistory } from 'react-router-dom';
+import Fuse from 'fuse.js';
 import { useI18nContext } from '../../../hooks/useI18nContext';
 import { NetworkListItem } from '../network-list-item';
 import {
@@ -21,8 +22,11 @@ import {
 } from '../../../selectors';
 import ToggleButton from '../../ui/toggle-button';
 import {
+  BlockSize,
   Display,
   JustifyContent,
+  Size,
+  TextColor,
 } from '../../../helpers/constants/design-system';
 import {
   BUTTON_SECONDARY_SIZES,
@@ -33,6 +37,7 @@ import {
   ModalOverlay,
   Box,
   Text,
+  TextFieldSearch,
 } from '../../component-library';
 import { ADD_POPULAR_CUSTOM_NETWORK } from '../../../helpers/constants/routes';
 import { getEnvironmentType } from '../../../../app/scripts/lib/util';
@@ -75,11 +80,35 @@ export const NetworkListMenu = ({ onClose }) => {
 
   const lineaMainnetReleased = useSelector(isLineaMainnetNetworkReleased);
 
+  const showSearch = nonTestNetworks.length > 3;
+
   useEffect(() => {
     if (currentlyOnTestNetwork) {
       dispatch(setShowTestNetworks(currentlyOnTestNetwork));
     }
   }, [dispatch, currentlyOnTestNetwork]);
+  const [searchQuery, setSearchQuery] = useState('');
+
+  let searchResults = [...nonTestNetworks];
+  const isSearching = searchQuery !== '';
+
+  if (isSearching) {
+    const fuse = new Fuse(searchResults, {
+      threshold: 0.2,
+      location: 0,
+      distance: 100,
+      maxPatternLength: 32,
+      minMatchCharLength: 1,
+      shouldSort: true,
+      keys: ['nickname', 'chainId', 'ticker'],
+    });
+    fuse.setCollection(searchResults);
+    const fuseResults = fuse.search(searchQuery);
+    // Ensure order integrity with original list
+    searchResults = searchResults.filter((network) =>
+      fuseResults.includes(network),
+    );
+  }
 
   const generateMenuItems = (desiredNetworks) => {
     return desiredNetworks.map((network, index) => {
@@ -98,6 +127,7 @@ export const NetworkListMenu = ({ onClose }) => {
           iconSrc={network?.rpcPrefs?.imageUrl}
           key={`${network.id || network.chainId}-${index}`}
           selected={isCurrentNetwork}
+          focus={isCurrentNetwork && !showSearch}
           onClick={() => {
             dispatch(toggleNetworkMenu());
             if (network.providerType) {
@@ -162,8 +192,40 @@ export const NetworkListMenu = ({ onClose }) => {
           {t('networkMenuHeading')}
         </ModalHeader>
         <>
+          {showSearch ? (
+            <Box
+              paddingLeft={4}
+              paddingRight={4}
+              paddingBottom={4}
+              paddingTop={0}
+            >
+              <TextFieldSearch
+                size={Size.SM}
+                width={BlockSize.Full}
+                placeholder={t('search')}
+                value={searchQuery}
+                onChange={(e) => setSearchQuery(e.target.value)}
+                clearButtonOnClick={() => setSearchQuery('')}
+                clearButtonProps={{
+                  size: Size.SM,
+                }}
+                inputProps={{ autoFocus: true }}
+              />
+            </Box>
+          ) : null}
           <Box className="multichain-network-list-menu">
-            {generateMenuItems(nonTestNetworks)}
+            {searchResults.length === 0 && isSearching ? (
+              <Text
+                paddingLeft={4}
+                paddingRight={4}
+                color={TextColor.textMuted}
+                data-testid="multichain-network-menu-popover-no-results"
+              >
+                {t('noNetworksFound')}
+              </Text>
+            ) : (
+              generateMenuItems(searchResults)
+            )}
           </Box>
           <Box
             padding={4}
diff --git a/ui/components/multichain/network-list-menu/network-list-menu.test.js b/ui/components/multichain/network-list-menu/network-list-menu.test.js
index 9ef01f599..ba91a979d 100644
--- a/ui/components/multichain/network-list-menu/network-list-menu.test.js
+++ b/ui/components/multichain/network-list-menu/network-list-menu.test.js
@@ -44,10 +44,11 @@ const render = (
 
 describe('NetworkListMenu', () => {
   it('displays important controls', () => {
-    const { getByText } = render();
+    const { getByText, getByPlaceholderText } = render();
 
     expect(getByText('Add network')).toBeInTheDocument();
     expect(getByText('Show test networks')).toBeInTheDocument();
+    expect(getByPlaceholderText('Search')).toBeInTheDocument();
   });
 
   it('renders mainnet item', () => {
@@ -99,4 +100,15 @@ describe('NetworkListMenu', () => {
     ).textContent;
     expect(selectedNodeText).toStrictEqual('Custom Mainnet RPC');
   });
+
+  it('narrows down search results', () => {
+    const { queryByText, getByPlaceholderText } = render();
+
+    expect(queryByText('Chain 5')).toBeInTheDocument();
+
+    const searchBox = getByPlaceholderText('Search');
+    fireEvent.change(searchBox, { target: { value: 'Main' } });
+
+    expect(queryByText('Chain 5')).not.toBeInTheDocument();
+  });
 });