refactor(web): search people (#9082)

* refactor: search people

* fix: test

* fix: timeout

* fix: callbacks

* fix: simplify

* remove unused var

* refactor: rename file

* fix: focus when deleting last character

---------

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

web/src/lib/components/album-page/albums-controls.svelte

@@ -100,7 +100,7 @@
 
 <!-- Search Albums -->
 <div class="hidden xl:block h-10 xl:w-60 2xl:w-80">
-  <SearchBar placeholder="Search albums" bind:name={searchQuery} isSearching={false} />
+  <SearchBar placeholder="Search albums" bind:name={searchQuery} showLoadingSpinner={false} />
 </div>
 
 <!-- Create Album -->

web/src/lib/components/elements/search-bar.svelte

@@ -7,7 +7,7 @@
 
   export let name: string;
   export let roundedBottom = true;
-  export let isSearching: boolean;
+  export let showLoadingSpinner: boolean;
   export let placeholder: string;
 
   const dispatch = createEventDispatcher<{ search: SearchOptions; reset: void }>();
@@ -16,6 +16,12 @@
     name = '';
     dispatch('reset');
   };
+
+  const handleSearch = (event: KeyboardEvent) => {
+    if (event.key === 'Enter') {
+      dispatch('search', { force: true });
+    }
+  };
 </script>
 
 <div
@@ -33,9 +39,10 @@
     type="text"
     {placeholder}
     bind:value={name}
+    on:keydown={handleSearch}
     on:input={() => dispatch('search', { force: false })}
   />
-  {#if isSearching}
+  {#if showLoadingSpinner}
     <div class="flex place-items-center">
       <LoadingSpinner />
     </div>

web/src/lib/components/faces-page/assign-face-side-panel.svelte

@@ -1,16 +1,9 @@
 <script lang="ts">
-  import { maximumLengthSearchPeople, timeBeforeShowLoadingSpinner } from '$lib/constants';
+  import { timeBeforeShowLoadingSpinner } from '$lib/constants';
   import { photoViewer } from '$lib/stores/assets.store';
   import { getAssetThumbnailUrl, getPeopleThumbnailUrl } from '$lib/utils';
-  import { handleError } from '$lib/utils/handle-error';
-  import { getPersonNameWithHiddenValue, searchNameLocal } from '$lib/utils/person';
-  import {
-    AssetTypeEnum,
-    ThumbnailFormat,
-    searchPerson,
-    type AssetFaceResponseDto,
-    type PersonResponseDto,
-  } from '@immich/sdk';
+  import { getPersonNameWithHiddenValue } from '$lib/utils/person';
+  import { AssetTypeEnum, ThumbnailFormat, type AssetFaceResponseDto, type PersonResponseDto } from '@immich/sdk';
   import { mdiArrowLeftThin, mdiClose, mdiMagnify, mdiPlus } from '@mdi/js';
   import { createEventDispatcher } from 'svelte';
   import { linear } from 'svelte/easing';
@@ -18,6 +11,7 @@
   import ImageThumbnail from '../assets/thumbnail/image-thumbnail.svelte';
   import Icon from '../elements/icon.svelte';
   import LoadingSpinner from '../shared-components/loading-spinner.svelte';
+  import SearchPeople from '$lib/components/faces-page/people-search.svelte';
 
   export let peopleWithFaces: AssetFaceResponseDto[];
   export let allPeople: PersonResponseDto[];
@@ -31,11 +25,11 @@
 
   // search people
   let searchedPeople: PersonResponseDto[] = [];
-  let searchedPeopleCopy: PersonResponseDto[] = [];
-  let searchWord: string;
   let searchFaces = false;
   let searchName = '';
 
+  $: showPeople = searchName ? searchedPeople : allPeople.filter((person) => !person.isHidden);
+
   const dispatch = createEventDispatcher<{
     close: void;
     createPerson: string | null;
@@ -116,33 +110,6 @@
     isShowLoadingNewPerson = false;
     dispatch('createPerson', newFeaturePhoto);
   };
-
-  const searchPeople = async () => {
-    if ((searchedPeople.length < maximumLengthSearchPeople && searchName.startsWith(searchWord)) || searchName === '') {
-      return;
-    }
-    const timeout = setTimeout(() => (isShowLoadingSearch = true), timeBeforeShowLoadingSpinner);
-    try {
-      const data = await searchPerson({ name: searchName });
-      searchedPeople = data;
-      searchedPeopleCopy = data;
-      searchWord = searchName;
-    } catch (error) {
-      handleError(error, "Can't search people");
-    } finally {
-      clearTimeout(timeout);
-    }
-
-    isShowLoadingSearch = false;
-  };
-
-  $: {
-    searchedPeople = searchNameLocal(searchName, searchedPeopleCopy, 20);
-  }
-
-  const initInput = (element: HTMLInputElement) => {
-    element.focus();
-  };
 </script>
 
 <section
@@ -200,13 +167,11 @@
         </div>
       </button>
       <div class="w-full flex">
-        <input
-          class="w-full gap-2 bg-immich-bg dark:bg-immich-dark-bg"
-          type="text"
-          placeholder="Name or nickname"
-          bind:value={searchName}
-          on:input={searchPeople}
-          use:initInput
+        <SearchPeople
+          type="input"
+          bind:searchName
+          bind:showLoadingSpinner={isShowLoadingSearch}
+          bind:searchedPeopleLocal={searchedPeople}
         />
         {#if isShowLoadingSearch}
           <div>
@@ -227,56 +192,31 @@
   <div class="px-4 py-4 text-sm">
     <h2 class="mb-8 mt-4 uppercase">All people</h2>
     <div class="immich-scrollbar mt-4 flex flex-wrap gap-2 overflow-y-auto">
-      {#if searchName == ''}
-        {#each allPeople as person (person.id)}
-          {#if person.id !== editedPerson.id}
-            <div class="w-fit">
-              <button class="w-[90px]" on:click={() => dispatch('reassign', person)}>
-                <div class="relative">
-                  <ImageThumbnail
-                    curve
-                    shadow
-                    url={getPeopleThumbnailUrl(person.id)}
-                    altText={getPersonNameWithHiddenValue(person.name, person.isHidden)}
-                    title={getPersonNameWithHiddenValue(person.name, person.isHidden)}
-                    widthStyle="90px"
-                    heightStyle="90px"
-                    thumbhash={null}
-                    hidden={person.isHidden}
-                  />
-                </div>
+      {#each showPeople as person (person.id)}
+        {#if person.id !== editedPerson.id}
+          <div class="w-fit">
+            <button class="w-[90px]" on:click={() => dispatch('reassign', person)}>
+              <div class="relative">
+                <ImageThumbnail
+                  curve
+                  shadow
+                  url={getPeopleThumbnailUrl(person.id)}
+                  altText={getPersonNameWithHiddenValue(person.name, person.isHidden)}
+                  title={getPersonNameWithHiddenValue(person.name, person.isHidden)}
+                  widthStyle="90px"
+                  heightStyle="90px"
+                  thumbhash={null}
+                  hidden={person.isHidden}
+                />
+              </div>
 
-                <p class="mt-1 truncate font-medium" title={getPersonNameWithHiddenValue(person.name, person.isHidden)}>
-                  {person.name}
-                </p>
-              </button>
-            </div>
-          {/if}
-        {/each}
-      {:else}
-        {#each searchedPeople as person (person.id)}
-          {#if person.id !== editedPerson.id}
-            <div class="w-fit">
-              <button class="w-[90px]" on:click={() => dispatch('reassign', person)}>
-                <div class="relative">
-                  <ImageThumbnail
-                    curve
-                    shadow
-                    url={getPeopleThumbnailUrl(person.id)}
-                    altText={getPersonNameWithHiddenValue(person.name, person.isHidden)}
-                    title={getPersonNameWithHiddenValue(person.name, person.isHidden)}
-                    widthStyle="90px"
-                    heightStyle="90px"
-                    thumbhash={null}
-                    hidden={person.isHidden}
-                  />
-                </div>
-                <p class="mt-1 truncate font-medium" title={person.name}>{person.name}</p>
-              </button>
-            </div>
-          {/if}
-        {/each}
-      {/if}
+              <p class="mt-1 truncate font-medium" title={getPersonNameWithHiddenValue(person.name, person.isHidden)}>
+                {person.name}
+              </p>
+            </button>
+          </div>
+        {/if}
+      {/each}
     </div>
   </div>
 </section>

web/src/lib/components/faces-page/edit-name-input.svelte

@@ -1,29 +1,23 @@
 <script lang="ts">
   import { type PersonResponseDto } from '@immich/sdk';
-  import { createEventDispatcher, onMount } from 'svelte';
+  import { createEventDispatcher } from 'svelte';
   import ImageThumbnail from '../assets/thumbnail/image-thumbnail.svelte';
   import Button from '../elements/buttons/button.svelte';
+  import SearchPeople from '$lib/components/faces-page/people-search.svelte';
 
   export let person: PersonResponseDto;
   export let name: string;
-  export let suggestedPeople = false;
+  export let suggestedPeople: PersonResponseDto[];
   export let thumbnailData: string;
-
-  let inputElement: HTMLInputElement;
+  export let isSearchingPeople: boolean;
 
   const dispatch = createEventDispatcher<{
     change: string;
-    cancel: void;
-    input: void;
   }>();
-
-  onMount(() => {
-    inputElement.focus();
-  });
 </script>
 
 <div
-  class="flex w-full h-14 place-items-center {suggestedPeople
+  class="flex w-full h-14 place-items-center {suggestedPeople.length > 0
     ? 'rounded-t-lg dark:border-immich-dark-gray'
     : 'rounded-lg'}  bg-gray-100 p-2 dark:bg-gray-700"
 >
@@ -33,13 +27,13 @@
     autocomplete="off"
     on:submit|preventDefault={() => dispatch('change', name)}
   >
-    <input
-      class="w-full gap-2 bg-gray-100 dark:bg-gray-700 dark:text-white"
-      type="text"
-      placeholder="New name or nickname"
-      bind:value={name}
-      bind:this={inputElement}
-      on:input={() => dispatch('input')}
+    <SearchPeople
+      bind:searchName={name}
+      bind:searchedPeopleLocal={suggestedPeople}
+      type="input"
+      numberPeopleToSearch={5}
+      inputClass="w-full gap-2 bg-gray-100 dark:bg-gray-700 dark:text-white"
+      bind:showLoadingSpinner={isSearchingPeople}
     />
     <Button size="sm" type="submit">Done</Button>
   </form>

web/src/lib/components/faces-page/people-list.svelte

@@ -1,11 +1,8 @@
 <script lang="ts">
-  import { maximumLengthSearchPeople, timeBeforeShowLoadingSpinner } from '$lib/constants';
-  import { handleError } from '$lib/utils/handle-error';
-  import { searchNameLocal } from '$lib/utils/person';
-  import { searchPerson, type PersonResponseDto } from '@immich/sdk';
+  import { type PersonResponseDto } from '@immich/sdk';
   import { createEventDispatcher } from 'svelte';
   import FaceThumbnail from './face-thumbnail.svelte';
-  import SearchBar from '../elements/search-bar.svelte';
+  import SearchPeople from '$lib/components/faces-page/people-search.svelte';
 
   export let screenHeight: number;
   export let people: PersonResponseDto[];
@@ -13,54 +10,26 @@
   export let unselectedPeople: PersonResponseDto[];
 
   let name = '';
-  let searchWord: string;
-  let isSearchingPeople = false;
+  let showPeople: PersonResponseDto[];
 
   let dispatch = createEventDispatcher<{
     select: PersonResponseDto;
   }>();
 
   $: {
-    people = peopleCopy.filter(
+    showPeople = people.filter(
       (person) => !unselectedPeople.some((unselectedPerson) => unselectedPerson.id === person.id),
     );
-    if (name) {
-      people = searchNameLocal(name, people, maximumLengthSearchPeople);
-    }
   }
-
-  const searchPeople = async (force: boolean) => {
-    if (name === '') {
-      people = peopleCopy;
-      return;
-    }
-    if (!force && people.length < maximumLengthSearchPeople && name.startsWith(searchWord)) {
-      return;
-    }
-
-    const timeout = setTimeout(() => (isSearchingPeople = true), timeBeforeShowLoadingSpinner);
-    try {
-      people = await searchPerson({ name });
-      searchWord = name;
-    } catch (error) {
-      handleError(error, "Can't search people");
-    } finally {
-      clearTimeout(timeout);
-    }
-
-    isSearchingPeople = false;
-  };
 </script>
 
 <div class=" w-40 sm:w-48 md:w-96 h-14 mb-8">
-  <SearchBar
-    bind:name
-    isSearching={isSearchingPeople}
+  <SearchPeople
+    type="searchBar"
     placeholder="Search people"
-    on:reset={() => {
-      people = peopleCopy;
-    }}
-    on:search={({ detail }) => searchPeople(detail.force ?? false)}
+    bind:searchName={name}
+    bind:searchedPeopleLocal={people}
+    onReset={() => (people = peopleCopy)}
   />
 </div>
 
@@ -69,7 +38,7 @@
   style:max-height={screenHeight - 400 + 'px'}
 >
   <div class="grid-col-2 grid gap-8 md:grid-cols-3 lg:grid-cols-6 xl:grid-cols-8 2xl:grid-cols-10">
-    {#each people as person (person.id)}
+    {#each showPeople as person (person.id)}
       <FaceThumbnail
         {person}
         on:click={() => {

web/src/lib/components/faces-page/people-search.svelte

@@ -0,0 +1,100 @@
+<script lang="ts">
+  import SearchBar from '$lib/components/elements/search-bar.svelte';
+  import { maximumLengthSearchPeople, timeBeforeShowLoadingSpinner } from '$lib/constants';
+  import { handleError } from '$lib/utils/handle-error';
+  import { searchNameLocal } from '$lib/utils/person';
+  import { searchPerson, type PersonResponseDto } from '@immich/sdk';
+
+  export let searchName: string;
+  export let searchedPeopleLocal: PersonResponseDto[];
+  export let type: 'searchBar' | 'input';
+  export let numberPeopleToSearch: number = maximumLengthSearchPeople;
+  export let inputClass: string = 'w-full gap-2 bg-immich-bg dark:bg-immich-dark-bg';
+  export let showLoadingSpinner: boolean = false;
+  export let placeholder: string = 'Name or nickname';
+  export let onReset = () => {};
+  export let onSearch = () => {};
+
+  let searchedPeople: PersonResponseDto[] = [];
+  let searchWord: string;
+  let abortController: AbortController | null = null;
+  let timeout: NodeJS.Timeout | null = null;
+
+  const search = () => {
+    searchedPeopleLocal = searchNameLocal(searchName, searchedPeople, numberPeopleToSearch);
+  };
+
+  const reset = () => {
+    searchedPeopleLocal = [];
+    cancelPreviousRequest();
+    onReset();
+  };
+
+  const cancelPreviousRequest = () => {
+    if (abortController) {
+      abortController.abort();
+      abortController = null;
+    }
+    if (timeout) {
+      clearTimeout(timeout);
+      timeout = null;
+    }
+  };
+
+  export let handleSearch = async (force?: boolean, name?: string) => {
+    searchName = name ?? searchName;
+    onSearch();
+    if (searchName === '') {
+      reset();
+      return;
+    }
+    if (!force && searchedPeople.length < maximumLengthSearchPeople && searchName.startsWith(searchWord)) {
+      search();
+      return;
+    }
+    cancelPreviousRequest();
+    abortController = new AbortController();
+    timeout = setTimeout(() => (showLoadingSpinner = true), timeBeforeShowLoadingSpinner);
+    try {
+      const data = await searchPerson({ name: searchName }, { signal: abortController?.signal });
+      searchedPeople = data;
+      searchWord = searchName;
+    } catch (error) {
+      handleError(error, "Can't search people");
+    } finally {
+      clearTimeout(timeout);
+      timeout = null;
+      abortController = null;
+      showLoadingSpinner = false;
+      search();
+    }
+  };
+
+  const initInput = (element: HTMLInputElement) => {
+    element.focus();
+  };
+
+  const handleReset = () => {
+    reset();
+    onReset();
+  };
+</script>
+
+{#if type === 'searchBar'}
+  <SearchBar
+    bind:name={searchName}
+    {showLoadingSpinner}
+    {placeholder}
+    on:reset={handleReset}
+    on:search={({ detail }) => handleSearch(detail.force ?? false)}
+  />
+{:else}
+  <input
+    class={inputClass}
+    type="text"
+    {placeholder}
+    bind:value={searchName}
+    on:input={() => handleSearch(false)}
+    use:initInput
+  />
+{/if}

web/src/lib/components/shared-components/change-location.svelte

@@ -23,7 +23,7 @@
   let suggestedPlaces: PlacesResponseDto[] = [];
   let searchWord: string;
   let latestSearchTimeout: number;
-  let showSpinner = false;
+  let showLoadingSpinner = false;
   let suggestionContainer: HTMLDivElement;
   let hideSuggestion = false;
   let addClipMapMarker: (long: number, lat: number) => void;
@@ -74,14 +74,14 @@
     if (latestSearchTimeout) {
       clearTimeout(latestSearchTimeout);
     }
-    showSpinner = true;
+    showLoadingSpinner = true;
     const searchTimeout = window.setTimeout(() => {
       searchPlaces({ name: searchWord })
         .then((searchResult) => {
           // skip result when a newer search is happening
           if (latestSearchTimeout === searchTimeout) {
             places = searchResult;
-            showSpinner = false;
+            showLoadingSpinner = false;
           }
         })
         .catch((error) => {
@@ -89,7 +89,7 @@
           if (latestSearchTimeout === searchTimeout) {
             places = [];
             handleError(error, "Can't search places");
-            showSpinner = false;
+            showLoadingSpinner = false;
           }
         });
     }, timeDebounceOnSearch);
@@ -121,7 +121,7 @@
         <SearchBar
           placeholder="Search places"
           bind:name={searchWord}
-          isSearching={showSpinner}
+          {showLoadingSpinner}
           on:reset={() => {
             suggestedPlaces = [];
           }}

web/src/lib/components/shared-components/search-bar/search-people-section.svelte

@@ -56,7 +56,7 @@
     <div id="people-selection" class="-mb-4">
       <div class="flex items-center w-full justify-between gap-6">
         <p class="immich-form-label py-3">PEOPLE</p>
-        <SearchBar bind:name placeholder="Filter people" isSearching={false} />
+        <SearchBar bind:name placeholder="Filter people" showLoadingSpinner={false} />
       </div>
 
       <div class="flex -mx-1 max-h-64 gap-1 mt-2 flex-wrap overflow-y-auto immich-scrollbar">