feat: simplify search strategy configuration (#7765)

packages/@sanity/types/src/index.ts

@@ -8,6 +8,7 @@ export * from './paths'
 export * from './portableText'
 export * from './reference'
 export * from './schema'
+export * from './search'
 export * from './slug'
 export * from './transactionLog'
 export * from './upload'

packages/@sanity/types/src/reference/types.ts

@@ -3,6 +3,7 @@ import {type SanityClient} from '@sanity/client'
 import {type SanityDocument} from '../documents'
 import {type Path} from '../paths'
 import {type BaseSchemaTypeOptions} from '../schema'
+import {type SearchStrategy} from '../search/types'
 
 /** @public */
 export interface Reference {
@@ -28,7 +29,7 @@ export type ReferenceFilterSearchOptions = {
   params?: Record<string, unknown>
   tag?: string
   maxFieldDepth?: number
-  enableLegacySearch?: boolean
+  strategy?: SearchStrategy
 }
 
 /** @public */

packages/@sanity/types/src/search/asserters.ts

@@ -0,0 +1,10 @@
+import {searchStrategies, type SearchStrategy} from './types'
+
+/**
+ * @internal
+ */
+export function isSearchStrategy(
+  maybeSearchStrategy: unknown,
+): maybeSearchStrategy is SearchStrategy {
+  return searchStrategies.includes(maybeSearchStrategy as SearchStrategy)
+}

packages/@sanity/types/src/search/index.ts

@@ -0,0 +1,2 @@
+export * from './asserters'
+export * from './types'

packages/@sanity/types/src/search/types.ts

@@ -0,0 +1,9 @@
+/**
+ * @public
+ */
+export const searchStrategies = ['groqLegacy', 'textSearch'] as const
+
+/**
+ * @public
+ */
+export type SearchStrategy = (typeof searchStrategies)[number]

packages/sanity/src/core/config/__tests__/resolveConfig.test.ts

@@ -6,6 +6,7 @@ import {describe, expect, it} from 'vitest'
 import {createMockAuthStore} from '../../store'
 import {definePlugin} from '../definePlugin'
 import {createSourceFromConfig, createWorkspaceFromConfig, resolveConfig} from '../resolveConfig'
+import {type PluginOptions} from '../types'
 
 describe('resolveConfig', () => {
   it('throws on invalid tools property', async () => {
@@ -288,3 +289,162 @@ describe('createSourceFromConfig', () => {
     })
   })
 })
+
+describe('search strategy selection', () => {
+  const projectId = 'ppsg7ml5'
+  const dataset = 'production'
+
+  it('sets a default strategy', async () => {
+    const workspace = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+    })
+
+    expect(workspace.search.strategy).toBeTypeOf('string')
+  })
+
+  it('infers strategy based on `enableLegacySearch`', async () => {
+    const workspaceA = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      search: {
+        enableLegacySearch: true,
+      },
+    })
+
+    expect(workspaceA.search.strategy).toBe('groqLegacy')
+
+    const workspaceB = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      search: {
+        enableLegacySearch: false,
+      },
+    })
+
+    expect(workspaceB.search.strategy).toBe('textSearch')
+  })
+
+  it('gives precedence to `strategy`', async () => {
+    const workspaceA = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      search: {
+        enableLegacySearch: true,
+        strategy: 'textSearch',
+      },
+    })
+
+    expect(workspaceA.search.strategy).toBe('textSearch')
+
+    const workspaceB = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      search: {
+        enableLegacySearch: false,
+        strategy: 'groqLegacy',
+      },
+    })
+
+    expect(workspaceB.search.strategy).toBe('groqLegacy')
+  })
+
+  it('can be composed with other configurations', async () => {
+    const workspaceA = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      plugins: [
+        getSearchOptionsPlugin({
+          enableLegacySearch: false,
+        }),
+      ],
+      search: {
+        enableLegacySearch: true,
+      },
+    })
+
+    expect(workspaceA.search.strategy).toBe('groqLegacy')
+
+    const workspaceB = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      plugins: [
+        getSearchOptionsPlugin({
+          enableLegacySearch: true,
+        }),
+      ],
+      search: {
+        enableLegacySearch: false,
+      },
+    })
+
+    expect(workspaceB.search.strategy).toBe('textSearch')
+
+    const workspaceC = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      plugins: [
+        getSearchOptionsPlugin({
+          enableLegacySearch: false,
+        }),
+      ],
+      search: {
+        strategy: 'groqLegacy',
+      },
+    })
+
+    expect(workspaceC.search.strategy).toBe('groqLegacy')
+
+    const workspaceD = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      plugins: [
+        getSearchOptionsPlugin({
+          strategy: 'textSearch',
+        }),
+      ],
+      search: {
+        strategy: 'groqLegacy',
+      },
+    })
+
+    expect(workspaceD.search.strategy).toBe('groqLegacy')
+
+    const workspaceE = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      plugins: [
+        getSearchOptionsPlugin({
+          strategy: 'textSearch',
+        }),
+      ],
+      search: {
+        enableLegacySearch: true,
+      },
+    })
+
+    expect(workspaceE.search.strategy).toBe('textSearch')
+
+    const workspaceF = await createWorkspaceFromConfig({
+      projectId,
+      dataset,
+      plugins: [
+        getSearchOptionsPlugin({
+          strategy: 'groqLegacy',
+        }),
+      ],
+      search: {
+        enableLegacySearch: false,
+      },
+    })
+
+    expect(workspaceF.search.strategy).toBe('groqLegacy')
+  })
+})
+
+function getSearchOptionsPlugin(options: PluginOptions['search']): PluginOptions {
+  return definePlugin({
+    name: 'sanity/search-options',
+    search: options,
+  })()
+}

packages/sanity/src/core/config/configPropertyReducers.ts

@@ -1,4 +1,10 @@
-import {type AssetSource, type SchemaTypeDefinition} from '@sanity/types'
+import {
+  type AssetSource,
+  isSearchStrategy,
+  type SchemaTypeDefinition,
+  searchStrategies,
+  type SearchStrategy,
+} from '@sanity/types'
 import {type ErrorInfo, type ReactNode} from 'react'
 
 import {type LocaleConfigContext, type LocaleDefinition, type LocaleResourceBundle} from '../i18n'
@@ -392,6 +398,61 @@ export const legacySearchEnabledReducer: ConfigPropertyReducer<boolean, ConfigCo
   return prev
 }
 
+/**
+ * Some projects may already be using the `enableLegacySearch` option. In order to gracefully
+ * migrate to the `strategy` option, this reducer produces a value that respects any existing
+ * `enableLegacySearch` option.
+ *
+ * If the project currently enables the Text Search API search strategy by setting
+ * `enableLegacySearch` to `false`, this is mapped to the `textSearch` strategy.
+ *
+ * Any explicitly defined `strategy` value will take precedence over the value inferred from
+ * `enableLegacySearch`.
+ */
+export const searchStrategyReducer = ({
+  config,
+  initialValue,
+}: {
+  config: PluginOptions
+  initialValue: SearchStrategy
+}): SearchStrategy => {
+  const flattenedConfig = flattenConfig(config, [])
+
+  type SearchStrategyReducerState = [
+    implicit: SearchStrategy | undefined,
+    explicit: SearchStrategy | undefined,
+  ]
+
+  const [implicit, explicit] = flattenedConfig.reduce<SearchStrategyReducerState>(
+    ([currentImplicit, currentExplicit], entry) => {
+      const {enableLegacySearch, strategy} = entry.config.search ?? {}
+
+      // The strategy has been explicitly defined.
+      if (typeof strategy !== 'undefined') {
+        if (!isSearchStrategy(strategy)) {
+          const listFormatter = new Intl.ListFormat('en-US', {type: 'disjunction'})
+          const options = listFormatter.format(searchStrategies.map((value) => `"${value}"`))
+          const received =
+            typeof strategy === 'string' ? `"${strategy}"` : getPrintableType(strategy)
+          throw new Error(`Expected \`search.strategy\` to be ${options}, but received ${received}`)
+        }
+
+        return [currentImplicit, strategy]
+      }
+
+      // The strategy has been implicitly defined.
+      if (typeof enableLegacySearch === 'boolean') {
+        return [enableLegacySearch ? 'groqLegacy' : 'textSearch', currentExplicit]
+      }
+
+      return [currentImplicit, currentExplicit]
+    },
+    [undefined, undefined],
+  )
+
+  return explicit ?? implicit ?? initialValue
+}
+
 export const startInCreateEnabledReducer = (opts: {
   config: PluginOptions
   initialValue: boolean

packages/sanity/src/core/config/prepareConfig.ts

@@ -43,6 +43,7 @@ import {
   partialIndexingEnabledReducer,
   resolveProductionUrlReducer,
   schemaTemplatesReducer,
+  searchStrategyReducer,
   startInCreateEnabledReducer,
   toolsReducer,
 } from './configPropertyReducers'
@@ -608,6 +609,10 @@ function resolveSource({
           initialValue: config.search?.unstable_partialIndexing?.enabled ?? false,
         }),
       },
+      strategy: searchStrategyReducer({
+        config,
+        initialValue: 'groqLegacy',
+      }),
       enableLegacySearch: resolveConfigProperty({
         config,
         context,

packages/sanity/src/core/config/types.ts

@@ -8,6 +8,7 @@ import {
   type Schema,
   type SchemaType,
   type SchemaTypeDefinition,
+  type SearchStrategy,
 } from '@sanity/types'
 import {type i18n} from 'i18next'
 import {type ComponentType, type ErrorInfo, type ReactNode} from 'react'
@@ -383,8 +384,25 @@ export interface PluginOptions {
     unstable_partialIndexing?: {
       enabled: boolean
     }
+
+    /**
+     * Control the strategy used for searching documents. This should generally only be used if you
+     * wish to try experimental search strategies.
+     *
+     * This option takes precedence over the deprecated `search.enableLegacySearch` option.
+     *
+     * Can be one of:
+     *
+     * - `"groqLegacy"` (default): Use client-side tokenization and schema introspection to search
+     *   using the GROQ Query API.
+     * - `"textSearch"` (deprecated): Perform full text searching using the Text Search API.
+     */
+    strategy?: SearchStrategy
+
     /**
      * Enables the legacy Query API search strategy.
+     *
+     * @deprecated Use `search.strategy` instead.
      */
     enableLegacySearch?: boolean
   }
@@ -759,6 +777,7 @@ export interface Source {
     }
 
     enableLegacySearch?: boolean
+    strategy?: SearchStrategy
   }
 
   /** @internal */

packages/sanity/src/core/form/studio/inputs/client-adapters/reference.ts

@@ -179,11 +179,9 @@ export function referenceSearch(
   textTerm: string,
   type: ReferenceSchemaType,
   options: ReferenceFilterSearchOptions,
-  enableLegacySearch: boolean,
 ): Observable<ReferenceSearchHit[]> {
   const search = createSearch(type.to, client, {
     ...options,
-    enableLegacySearch,
     maxDepth: options.maxFieldDepth || DEFAULT_MAX_FIELD_DEPTH,
   })
   return search(textTerm, {includeDrafts: true}).pipe(