From 3f1ec54fe99a6ebc26154c707bc8720a9e4c919c Mon Sep 17 00:00:00 2001
From: melohagan <101575380+melohagan@users.noreply.github.com>
Date: Wed, 6 Sep 2023 16:38:11 +0100
Subject: [PATCH] Relationship picker searching enhancement (#11639)

* Search for initially set value and add to options

* Only append option if needed

* Handle change

* Open dropdown on search

* Avoid duplicates

* Add client side search

* lint

* Offset popover

* refactor

* Refactor

* refactor
---
 .../bbui/src/Actions/position_dropdown.js     |   3 +-
 .../bbui/src/Form/Core/Multiselect.svelte     |   6 +
 packages/bbui/src/Form/Core/Picker.svelte     |   4 +
 packages/bbui/src/Form/Core/Select.svelte     |   8 +-
 packages/bbui/src/Popover/Popover.svelte      |   2 +
 packages/client/manifest.json                 |   4 +-
 .../app/forms/RelationshipField.svelte        | 195 ++++++++++++++++--
 packages/frontend-core/src/index.js           |   1 +
 8 files changed, 200 insertions(+), 23 deletions(-)

diff --git a/packages/bbui/src/Actions/position_dropdown.js b/packages/bbui/src/Actions/position_dropdown.js
index cc169eac09..f2018272f6 100644
--- a/packages/bbui/src/Actions/position_dropdown.js
+++ b/packages/bbui/src/Actions/position_dropdown.js
@@ -18,6 +18,7 @@ export default function positionDropdown(element, opts) {
       useAnchorWidth,
       offset = 5,
       customUpdate,
+      offsetBelow,
     } = opts
     if (!anchor) {
       return
@@ -47,7 +48,7 @@ export default function positionDropdown(element, opts) {
         styles.top = anchorBounds.top - elementBounds.height - offset
         styles.maxHeight = maxHeight || 240
       } else {
-        styles.top = anchorBounds.bottom + offset
+        styles.top = anchorBounds.bottom + (offsetBelow || offset)
         styles.maxHeight =
           maxHeight || window.innerHeight - anchorBounds.bottom - 20
       }
diff --git a/packages/bbui/src/Form/Core/Multiselect.svelte b/packages/bbui/src/Form/Core/Multiselect.svelte
index ea9b5858f5..8816da33c4 100644
--- a/packages/bbui/src/Form/Core/Multiselect.svelte
+++ b/packages/bbui/src/Form/Core/Multiselect.svelte
@@ -17,6 +17,9 @@
   export let fetchTerm = null
   export let useFetch = false
   export let customPopoverHeight
+  export let customPopoverOffsetBelow
+  export let customPopoverMaxHeight
+  export let open = false
 
   const dispatch = createEventDispatcher()
 
@@ -88,6 +91,7 @@
   isPlaceholder={!arrayValue.length}
   {autocomplete}
   bind:fetchTerm
+  bind:open
   {useFetch}
   {isOptionSelected}
   {getOptionLabel}
@@ -96,4 +100,6 @@
   {sort}
   {autoWidth}
   {customPopoverHeight}
+  {customPopoverOffsetBelow}
+  {customPopoverMaxHeight}
 />
diff --git a/packages/bbui/src/Form/Core/Picker.svelte b/packages/bbui/src/Form/Core/Picker.svelte
index c75a996cfe..9b90c1a865 100644
--- a/packages/bbui/src/Form/Core/Picker.svelte
+++ b/packages/bbui/src/Form/Core/Picker.svelte
@@ -38,6 +38,8 @@
   export let fetchTerm = null
   export let useFetch = false
   export let customPopoverHeight
+  export let customPopoverOffsetBelow
+  export let customPopoverMaxHeight
   export let align = "left"
   export let footer = null
   export let customAnchor = null
@@ -150,7 +152,9 @@
   on:close={() => (open = false)}
   useAnchorWidth={!autoWidth}
   maxWidth={autoWidth ? 400 : null}
+  maxHeight={customPopoverMaxHeight}
   customHeight={customPopoverHeight}
+  offsetBelow={customPopoverOffsetBelow}
 >
   <div
     class="popover-content"
diff --git a/packages/bbui/src/Form/Core/Select.svelte b/packages/bbui/src/Form/Core/Select.svelte
index e79ead7e8c..f843e2ccbd 100644
--- a/packages/bbui/src/Form/Core/Select.svelte
+++ b/packages/bbui/src/Form/Core/Select.svelte
@@ -21,10 +21,12 @@
   export let sort = false
   export let align
   export let footer = null
+  export let open = false
   export let tag = null
-  const dispatch = createEventDispatcher()
+  export let customPopoverOffsetBelow
+  export let customPopoverMaxHeight
 
-  let open = false
+  const dispatch = createEventDispatcher()
 
   $: fieldText = getFieldText(value, options, placeholder)
   $: fieldIcon = getFieldAttribute(getOptionIcon, value, options)
@@ -84,6 +86,8 @@
   {autocomplete}
   {sort}
   {tag}
+  {customPopoverOffsetBelow}
+  {customPopoverMaxHeight}
   isPlaceholder={value == null || value === ""}
   placeholderOption={placeholder === false ? null : placeholder}
   isOptionSelected={option => option === value}
diff --git a/packages/bbui/src/Popover/Popover.svelte b/packages/bbui/src/Popover/Popover.svelte
index 13a6822853..4c4b818440 100644
--- a/packages/bbui/src/Popover/Popover.svelte
+++ b/packages/bbui/src/Popover/Popover.svelte
@@ -19,6 +19,7 @@
   export let useAnchorWidth = false
   export let dismissible = true
   export let offset = 5
+  export let offsetBelow
   export let customHeight
   export let animate = true
   export let customZindex
@@ -89,6 +90,7 @@
         maxWidth,
         useAnchorWidth,
         offset,
+        offsetBelow,
         customUpdate: handlePostionUpdate,
       }}
       use:clickOutside={{
diff --git a/packages/client/manifest.json b/packages/client/manifest.json
index d91a71853e..229d344d55 100644
--- a/packages/client/manifest.json
+++ b/packages/client/manifest.json
@@ -3647,9 +3647,9 @@
       },
       {
         "type": "boolean",
-        "label": "Autocomplete",
+        "label": "Search",
         "key": "autocomplete",
-        "defaultValue": false
+        "defaultValue": true
       },
       {
         "type": "boolean",
diff --git a/packages/client/src/components/app/forms/RelationshipField.svelte b/packages/client/src/components/app/forms/RelationshipField.svelte
index 0c8b076a67..ecbbfcde6a 100644
--- a/packages/client/src/components/app/forms/RelationshipField.svelte
+++ b/packages/client/src/components/app/forms/RelationshipField.svelte
@@ -1,6 +1,11 @@
 <script>
-  import { CoreSelect, CoreMultiselect } from "@budibase/bbui"
-  import { fetchData } from "@budibase/frontend-core"
+  import {
+    CoreSelect,
+    CoreMultiselect,
+    Input,
+    ProgressCircle,
+  } from "@budibase/bbui"
+  import { fetchData, Utils } from "@budibase/frontend-core"
   import { getContext } from "svelte"
   import Field from "./Field.svelte"
   import { FieldTypes } from "../../../constants"
@@ -12,7 +17,7 @@
   export let placeholder
   export let disabled = false
   export let validation
-  export let autocomplete = false
+  export let autocomplete = true
   export let defaultValue
   export let onChange
   export let filter
@@ -21,6 +26,16 @@
   let fieldApi
   let fieldSchema
   let tableDefinition
+  let primaryDisplay
+  let options
+  let selectedOptions = []
+  let isOpen = false
+  let hasFilter
+
+  let searchResults
+  let searchString
+  let searching = false
+  let lastSearchId
 
   $: multiselect = fieldSchema?.relationshipType !== "one-to-many"
   $: linkedTableId = fieldSchema?.tableId
@@ -35,13 +50,57 @@
       limit: 100,
     },
   })
+  $: hasFilter = !!filter?.filter(f => !!f.field)?.length
   $: fetch.update({ filter })
-  $: options = $fetch.rows
+  $: {
+    options = searchResults ? searchResults : $fetch.rows
+    const nonMatchingOptions = selectedOptions.filter(
+      option => !options.map(opt => opt._id).includes(option._id)
+    )
+    // Append initially selected options if there is no filter
+    // and hasn't already been appended
+    if (!hasFilter) {
+      options = [...options, ...nonMatchingOptions]
+    }
+  }
   $: tableDefinition = $fetch.definition
+  $: primaryDisplay = tableDefinition?.primaryDisplay || "_id"
   $: singleValue = flatten(fieldState?.value)?.[0]
   $: multiValue = flatten(fieldState?.value) ?? []
   $: component = multiselect ? CoreMultiselect : CoreSelect
   $: expandedDefaultValue = expand(defaultValue)
+  $: debouncedSearch(searchString)
+  $: {
+    if (searching) {
+      isOpen = true
+    }
+  }
+
+  // Fetch the initially selected values
+  // as they may not be within the first 100 records
+  $: {
+    if (
+      primaryDisplay !== "_id" &&
+      fieldState?.value?.length &&
+      !selectedOptions?.length
+    ) {
+      API.searchTable({
+        paginate: false,
+        tableId: linkedTableId,
+        limit: 100,
+        query: {
+          oneOf: {
+            [`1:${primaryDisplay}`]: fieldState?.value?.map(
+              value => value.primaryDisplay
+            ),
+          },
+        },
+      }).then(response => {
+        const value = multiselect ? multiValue : singleValue
+        selectedOptions = response.rows.filter(row => value.includes(row._id))
+      })
+    }
+  }
 
   const flatten = values => {
     if (!values) {
@@ -77,10 +136,66 @@
 
   const handleChange = value => {
     const changed = fieldApi.setValue(value)
+    selectedOptions = value.map(val => ({
+      _id: val,
+      [primaryDisplay]: options.find(option => option._id === val)[
+        primaryDisplay
+      ],
+    }))
     if (onChange && changed) {
       onChange({ value })
     }
   }
+
+  // Search for rows based on the search string
+  const search = async searchString => {
+    // Reset state if this search is invalid
+    if (!linkedTableId || !searchString) {
+      searchResults = null
+      return
+    }
+
+    // If a filter exists, then do a client side search
+    if (hasFilter) {
+      searchResults = $fetch.rows.filter(option =>
+        option[primaryDisplay].startsWith(searchString)
+      )
+      isOpen = true
+      return
+    }
+
+    // Search for results, using IDs to track invocations and ensure we're
+    // handling the latest update
+    lastSearchId = Math.random()
+    searching = true
+    const thisSearchId = lastSearchId
+    const results = await API.searchTable({
+      paginate: false,
+      tableId: linkedTableId,
+      limit: 100,
+      query: {
+        string: {
+          [`1:${primaryDisplay}`]: searchString || "",
+        },
+      },
+    })
+    searching = false
+
+    // In case searching takes longer than our debounced update, abandon these
+    // results
+    if (thisSearchId !== lastSearchId) {
+      return
+    }
+
+    // Process results
+    searchResults = results.rows?.map(row => ({
+      ...row,
+      primaryDisplay: row[primaryDisplay],
+    }))
+  }
+
+  // Debounced version of searching
+  const debouncedSearch = Utils.debounce(search, 250)
 </script>
 
 <Field
@@ -95,19 +210,63 @@
   bind:fieldSchema
 >
   {#if fieldState}
-    <svelte:component
-      this={component}
-      {options}
-      {autocomplete}
-      value={multiselect ? multiValue : singleValue}
-      on:change={multiselect ? multiHandler : singleHandler}
-      id={fieldState.fieldId}
-      disabled={fieldState.disabled}
-      error={fieldState.error}
-      getOptionLabel={getDisplayName}
-      getOptionValue={option => option._id}
-      {placeholder}
-      sort={true}
-    />
+    <div class={autocomplete ? "field-with-search" : ""}>
+      <svelte:component
+        this={component}
+        bind:open={isOpen}
+        {options}
+        autocomplete={false}
+        value={multiselect ? multiValue : singleValue}
+        on:change={multiselect ? multiHandler : singleHandler}
+        id={fieldState.fieldId}
+        disabled={fieldState.disabled}
+        error={fieldState.error}
+        getOptionLabel={getDisplayName}
+        getOptionValue={option => option._id}
+        {placeholder}
+        customPopoverOffsetBelow={autocomplete ? 32 : null}
+        customPopoverMaxHeight={autocomplete ? 240 : null}
+        sort={true}
+      />
+      {#if autocomplete}
+        <div class="search">
+          <Input
+            autofocus
+            quiet
+            type="text"
+            bind:value={searchString}
+            placeholder={primaryDisplay ? `Search by ${primaryDisplay}` : null}
+          />
+          {#if searching}
+            <div>
+              <ProgressCircle size="S" />
+            </div>
+          {/if}
+        </div>
+      {/if}
+    </div>
   {/if}
 </Field>
+
+<style>
+  .search {
+    flex: 0 0 calc(var(--default-row-height) - 1px);
+    display: flex;
+    align-items: center;
+    margin: 4px var(--cell-padding);
+    width: calc(100% - 2 * var(--cell-padding));
+  }
+  .search :global(.spectrum-Textfield) {
+    min-width: 0;
+    width: 100%;
+  }
+  .search :global(.spectrum-Textfield-input) {
+    font-size: 13px;
+  }
+  .search :global(.spectrum-Form-item) {
+    flex: 1 1 auto;
+  }
+  .field-with-search {
+    min-height: 80px;
+  }
+</style>
diff --git a/packages/frontend-core/src/index.js b/packages/frontend-core/src/index.js
index 01bf05c69e..b0afc0c25d 100644
--- a/packages/frontend-core/src/index.js
+++ b/packages/frontend-core/src/index.js
@@ -1,5 +1,6 @@
 export { createAPIClient } from "./api"
 export { fetchData } from "./fetch/fetchData"
+export { Utils } from "./utils"
 export * as Constants from "./constants"
 export * from "./stores"
 export * from "./utils"