feat(sanity): adopt bundlePerspective for listing documents

sanity-io · Sep 6, 2024 · da3f744 · da3f744
1 parent c82fb68
commit da3f744
Show file tree

Hide file tree

Showing 12 changed files with 77 additions and 83 deletions.
diff --git a/packages/sanity/src/core/search/common/types.ts b/packages/sanity/src/core/search/common/types.ts
@@ -107,6 +107,7 @@ export type SearchOptions = {
   cursor?: string
   limit?: number
   perspective?: string
+  bundlePerspective?: string
   isCrossDataset?: boolean
   queryType?: 'prefixLast' | 'prefixNone'
 }
@@ -190,6 +191,7 @@ export type TextSearchParams = {
    */
   order?: TextSearchOrder[]
   perspective?: string
+  bundlePerspective?: string
 }
 
 export type TextSearchResponse<Attributes = Record<string, unknown>> = {

diff --git a/packages/sanity/src/core/search/text-search/createTextSearch.ts b/packages/sanity/src/core/search/text-search/createTextSearch.ts
@@ -142,10 +142,14 @@ export const createTextSearch: SearchStrategyFactory<TextSearchResults> = (
       searchOptions.includeDrafts === false && "!(_id in path('drafts.**'))",
       factoryOptions.filter ? `(${factoryOptions.filter})` : false,
       searchTerms.filter ? `(${searchTerms.filter})` : false,
+      // Versions are collated server-side using the `bundlePerspective` option. Therefore, they
+      // must not be fetched individually.
+      '!(_id in path("versions.**"))',
     ].filter((baseFilter): baseFilter is string => Boolean(baseFilter))
 
     const textSearchParams: TextSearchParams = {
       perspective: searchOptions.perspective,
+      bundlePerspective: searchOptions.bundlePerspective,
       query: {
         string: getQueryString(searchTerms.query, searchOptions),
       },

diff --git a/packages/sanity/src/core/search/weighted/createSearchQuery.test.ts b/packages/sanity/src/core/search/weighted/createSearchQuery.test.ts
@@ -46,7 +46,7 @@ describe('createSearchQuery', () => {
 
       expect(query).toEqual(
         `// findability-mvi:${FINDABILITY_MVI}\n` +
-          '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0)]' +
+          '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0) && !(_id in path("versions.**"))]' +
           '| order(_id asc)' +
           '[0...$__limit]' +
           '{_type, _id, _version, ...select(_type == "basic-schema-test" => { "w0": _id,"w1": _type,"w2": title })}',
@@ -106,7 +106,7 @@ describe('createSearchQuery', () => {
       })
 
       expect(query).toContain(
-        '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0 || object.field match $t0)]',
+        '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0 || object.field match $t0) && !(_id in path("versions.**"))]',
       )
     })
 
@@ -117,7 +117,7 @@ describe('createSearchQuery', () => {
       })
 
       expect(query).toContain(
-        '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0) && (_id match $t1 || _type match $t1 || title match $t1)]',
+        '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0) && (_id match $t1 || _type match $t1 || title match $t1) && !(_id in path("versions.**"))]',
       )
       expect(params.t0).toEqual('term0*')
       expect(params.t1).toEqual('term1*')
@@ -147,7 +147,7 @@ describe('createSearchQuery', () => {
 
       const result = [
         `// findability-mvi:${FINDABILITY_MVI}\n` +
-          '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0)]{_type, _id, _version, object{field}}',
+          '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0) && !(_id in path("versions.**"))]{_type, _id, _version, object{field}}',
         '|order(_id asc)[0...$__limit]',
         '{_type, _id, _version, ...select(_type == "basic-schema-test" => { "w0": _id,"w1": _type,"w2": title })}',
       ].join('')
@@ -193,7 +193,7 @@ describe('createSearchQuery', () => {
       )
 
       expect(query).toContain(
-        '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0) && (randomCondition == $customParam)]',
+        '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0) && (randomCondition == $customParam) && !(_id in path("versions.**"))]',
       )
       expect(params.customParam).toEqual('custom')
     })
@@ -241,7 +241,7 @@ describe('createSearchQuery', () => {
 
       expect(query).toEqual(
         `// findability-mvi:${FINDABILITY_MVI}\n` +
-          '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0)]' +
+          '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0) && !(_id in path("versions.**"))]' +
           '| order(exampleField desc)' +
           '[0...$__limit]' +
           '{_type, _id, _version, ...select(_type == "basic-schema-test" => { "w0": _id,"w1": _type,"w2": title })}',
@@ -275,7 +275,7 @@ describe('createSearchQuery', () => {
 
       const result = [
         `// findability-mvi:${FINDABILITY_MVI}\n`,
-        '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0)]| ',
+        '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0) && !(_id in path("versions.**"))]| ',
         'order(exampleField desc,anotherExampleField asc,lower(mapWithField) asc)',
         '[0...$__limit]{_type, _id, _version, ...select(_type == "basic-schema-test" => { "w0": _id,"w1": _type,"w2": title })}',
       ].join('')
@@ -291,7 +291,7 @@ describe('createSearchQuery', () => {
 
       expect(query).toEqual(
         `// findability-mvi:${FINDABILITY_MVI}\n` +
-          '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0)]' +
+          '*[_type in $__types && (_id match $t0 || _type match $t0 || title match $t0) && !(_id in path("versions.**"))]' +
           '| order(_id asc)' +
           '[0...$__limit]' +
           '{_type, _id, _version, ...select(_type == "basic-schema-test" => { "w0": _id,"w1": _type,"w2": title })}',
@@ -403,7 +403,7 @@ describe('createSearchQuery', () => {
          * This is an improvement over before, where an illegal term was used (number-as-string, ala ["0"]),
          * which lead to no hits at all. */
         `// findability-mvi:${FINDABILITY_MVI}\n` +
-          '*[_type in $__types && (_id match $t0 || _type match $t0 || cover[].cards[].title match $t0) && (_id match $t1 || _type match $t1 || cover[].cards[].title match $t1)]' +
+          '*[_type in $__types && (_id match $t0 || _type match $t0 || cover[].cards[].title match $t0) && (_id match $t1 || _type match $t1 || cover[].cards[].title match $t1) && !(_id in path("versions.**"))]' +
           '| order(_id asc)' +
           '[0...$__limit]' +
           // at this point we could refilter using cover[0].cards[0].title.

diff --git a/packages/sanity/src/core/search/weighted/createSearchQuery.ts b/packages/sanity/src/core/search/weighted/createSearchQuery.ts
@@ -135,6 +135,9 @@ export function createSearchQuery(
     ...createConstraints(terms, specs),
     filter ? `(${filter})` : '',
     searchTerms.filter ? `(${searchTerms.filter})` : '',
+    // Versions are collated server-side using the `bundlePerspective` option. Therefore, they must
+    // not be fetched individually.
+    '!(_id in path("versions.**"))',
   ].filter(Boolean)
 
   const selections = specs.map((spec) => {
@@ -186,7 +189,11 @@ export function createSearchQuery(
       __limit: limit,
       ...(params || {}),
     },
-    options: {tag, perspective: searchOpts.perspective},
+    options: {
+      tag,
+      perspective: searchOpts.perspective,
+      bundlePerspective: searchOpts.bundlePerspective,
+    },
     searchSpec: specs,
     terms,
   }

diff --git a/...c/core/studio/components/navbar/search/components/searchResults/item/SearchResultItem.tsx b/...c/core/studio/components/navbar/search/components/searchResults/item/SearchResultItem.tsx
@@ -1,7 +1,7 @@
 import {type SanityDocumentLike} from '@sanity/types'
 import {Box, type ResponsiveMarginProps, type ResponsivePaddingProps} from '@sanity/ui'
 import {type MouseEvent, useCallback, useMemo} from 'react'
-import {useIntentLink} from 'sanity/router'
+import {useIntentLink, useRouter} from 'sanity/router'
 
 import {type GeneralPreviewLayoutKey, PreviewCard} from '../../../../../../../components'
 import {useSchema} from '../../../../../../../hooks'
@@ -31,7 +31,7 @@ export function SearchResultItem({
   const schema = useSchema()
   const type = schema.get(documentType)
   const documentPresence = useDocumentPresence(documentId)
-
+  const perspective = useRouter().stickyParams.perspective
   const params = useMemo(() => ({id: documentId, type: type?.name}), [documentId, type?.name])
   const {onClick: onIntentClick, href} = useIntentLink({
     intent: 'edit',
@@ -65,6 +65,7 @@ export function SearchResultItem({
         <SearchResultItemPreview
           documentId={documentId}
           layout={layout}
+          perspective={perspective}
           presence={documentPresence}
           schemaType={type}
         />

diff --git a/...studio/components/navbar/search/components/searchResults/item/SearchResultItemPreview.tsx b/...studio/components/navbar/search/components/searchResults/item/SearchResultItemPreview.tsx
@@ -3,7 +3,7 @@ import {type SchemaType} from '@sanity/types'
 import {Badge, Box, Flex} from '@sanity/ui'
 import {useMemo} from 'react'
 import {useObservable} from 'react-rx'
-import {getPublishedId, getVersionFromId, isVersionId} from 'sanity'
+import {getPublishedId} from 'sanity'
 import {styled} from 'styled-components'
 
 import {type GeneralPreviewLayoutKey} from '../../../../../../../components'
@@ -19,6 +19,7 @@ import {type DocumentPresence, useDocumentPreviewStore} from '../../../../../../
 
 interface SearchResultItemPreviewProps {
   documentId: string
+  perspective?: string
   layout?: GeneralPreviewLayoutKey
   presence?: DocumentPresence[]
   schemaType: SchemaType
@@ -29,7 +30,8 @@ interface SearchResultItemPreviewProps {
  * Temporary workaround: force all nested boxes on iOS to use `background-attachment: scroll`
  * to allow <Skeleton> components to render correctly within virtual lists.
  */
-const SearchResultItemPreviewBox = styled(Box)`
+const SearchResultItemPreviewBox = styled(Box)<{$isInPerspective: boolean}>`
+  opacity: ${(props) => (props.$isInPerspective ? 1 : 0.5)};
   @supports (-webkit-overflow-scrolling: touch) {
     * [data-ui='Box'] {
       background-attachment: scroll;
@@ -43,6 +45,7 @@ const SearchResultItemPreviewBox = styled(Box)`
 export function SearchResultItemPreview({
   documentId,
   layout,
+  perspective,
   presence,
   schemaType,
   showBadge = true,
@@ -56,15 +59,16 @@ export function SearchResultItemPreview({
         schemaType,
         getPublishedId(documentId),
         '',
-        getVersionFromId(documentId),
+        perspective?.startsWith('bundle.') ? perspective.split('bundle.').at(1) : undefined,
       ),
-    [documentId, documentPreviewStore, schemaType],
+    [documentId, documentPreviewStore, perspective, schemaType],
   )
 
   const {draft, published, isLoading, version} = useObservable(observable, {
     draft: null,
     isLoading: true,
     published: null,
+    version: null,
   })
 
   const sanityDocument = useMemo(() => {
@@ -80,24 +84,22 @@ export function SearchResultItemPreview({
       <Flex align="center" gap={3}>
         {presence && presence.length > 0 && <DocumentPreviewPresence presence={presence} />}
         {showBadge && <Badge>{schemaType.title}</Badge>}
-        <DocumentStatusIndicator draft={draft} published={published} />
+        <DocumentStatusIndicator draft={draft} published={published} version={version} />
       </Flex>
     )
-  }, [draft, isLoading, presence, published, schemaType.title, showBadge])
+  }, [draft, isLoading, presence, published, schemaType.title, showBadge, version])
 
-  const tooltip = <DocumentStatus draft={draft} published={published} />
+  const tooltip = <DocumentStatus draft={draft} published={published} version={version} />
 
   return (
-    <SearchResultItemPreviewBox>
+    <SearchResultItemPreviewBox $isInPerspective={!perspective || Boolean(version)}>
       <SanityDefaultPreview
         {...getPreviewValueWithFallback({
           draft,
           published,
           version,
           value: sanityDocument,
-          perspective: isVersionId(documentId)
-            ? `bundle.${getVersionFromId(documentId)}`
-            : undefined,
+          perspective,
         })}
         isPlaceholder={isLoading ?? true}
         layout={layout || 'default'}

diff --git a/packages/sanity/src/core/studio/components/navbar/search/contexts/search/SearchProvider.tsx b/packages/sanity/src/core/studio/components/navbar/search/contexts/search/SearchProvider.tsx
@@ -1,6 +1,8 @@
 import {isEqual} from 'lodash'
 import {type ReactNode, useEffect, useMemo, useReducer, useRef, useState} from 'react'
+import {DRAFTS_FOLDER} from 'sanity'
 import {SearchContext} from 'sanity/_singletons'
+import {useRouter} from 'sanity/router'
 
 import {type CommandListHandle} from '../../../../../../components'
 import {useSchema} from '../../../../../../hooks'
@@ -30,7 +32,7 @@ interface SearchProviderProps {
 export function SearchProvider({children, fullscreen}: SearchProviderProps) {
   const [onClose, setOnClose] = useState<(() => void) | null>(null)
   const [searchCommandList, setSearchCommandList] = useState<CommandListHandle | null>(null)
-
+  const perspective = useRouter().stickyParams.perspective
   const schema = useSchema()
   const currentUser = useCurrentUser()
   const {
@@ -140,6 +142,10 @@ export function SearchProvider({children, fullscreen}: SearchProviderProps) {
           skipSortByScore: ordering.ignoreScore,
           ...(ordering.sort ? {sort: [ordering.sort]} : {}),
           cursor: cursor || undefined,
+          perspective: omitBundlePerspective(perspective),
+          bundlePerspective: perspective?.startsWith('bundle.')
+            ? [perspective.split('bundle.').at(1), DRAFTS_FOLDER].join(',')
+            : undefined,
         },
         terms: {
           ...terms,
@@ -165,6 +171,7 @@ export function SearchProvider({children, fullscreen}: SearchProviderProps) {
     searchState.terms,
     terms,
     cursor,
+    perspective,
   ])
 
   /**
@@ -197,3 +204,11 @@ export function SearchProvider({children, fullscreen}: SearchProviderProps) {
 
   return <SearchContext.Provider value={value}>{children}</SearchContext.Provider>
 }
+
+function omitBundlePerspective(perspective: string | undefined): string | undefined {
+  if (perspective?.startsWith('bundle.')) {
+    return undefined
+  }
+
+  return perspective
+}
diff --git a/packages/sanity/src/core/util/draftUtils.ts b/packages/sanity/src/core/util/draftUtils.ts
@@ -177,57 +177,23 @@ export interface CollatedHit<T extends {_id: string} = {_id: string}> {
   type: string
   draft?: T
   published?: T
-  version?: T
-}
-
-interface CollateOptions {
-  bundlePerspective?: string
 }
 
 /** @internal */
-export function collate<
-  T extends {
-    _id: string
-    _type: string
-  },
->(documents: T[], {bundlePerspective}: CollateOptions = {}): CollatedHit<T>[] {
+export function collate<T extends {_id: string; _type: string}>(documents: T[]): CollatedHit<T>[] {
   const byId = documents.reduce((res, doc) => {
     const publishedId = getPublishedId(doc._id)
-    const isVersion = isVersionId(doc._id)
-    const bundle = getVersionFromId(doc._id)
-
     let entry = res.get(publishedId)
     if (!entry) {
-      entry = {
-        id: publishedId,
-        type: doc._type,
-        published: undefined,
-        draft: undefined,
-        version: undefined,
-      }
+      entry = {id: publishedId, type: doc._type, published: undefined, draft: undefined}
       res.set(publishedId, entry)
     }
 
-    if (bundlePerspective && bundle === bundlePerspective) {
-      entry.version = doc
-    }
-
-    if (!isVersion) {
-      entry[publishedId === doc._id ? 'published' : 'draft'] = doc
-    }
-
+    entry[publishedId === doc._id ? 'published' : 'draft'] = doc
     return res
   }, new Map())
 
-  return (
-    Array.from(byId.values())
-      // Remove entries that have no data, because all the following conditions are true:
-      //
-      // 1. They have no published version.
-      // 2. They have no draft version.
-      // 3. They have a version, but not the one that is currently checked out.
-      .filter((entry) => entry.published ?? entry.version ?? entry.draft)
-  )
+  return Array.from(byId.values())
 }
 
 /** @internal */

diff --git a/packages/sanity/src/structure/components/paneItem/PaneItemPreview.tsx b/packages/sanity/src/structure/components/paneItem/PaneItemPreview.tsx
@@ -10,7 +10,6 @@ import {
   DocumentStatus,
   DocumentStatusIndicator,
   type GeneralPreviewLayoutKey,
-  getDocumentIsInPerspective,
   getPreviewStateObservable,
   getPreviewValueWithFallback,
   isRecord,
@@ -66,13 +65,10 @@ export function PaneItemPreview(props: PaneItemPreviewProps) {
     draft: null,
     isLoading: true,
     published: null,
+    version: null,
+    perspective,
   })
 
-  const isInPerspective = useMemo(
-    () => getDocumentIsInPerspective(value._id, perspective),
-    [perspective, value._id],
-  )
-
   const status = isLoading ? null : (
     <TooltipDelayGroupProvider>
       <Flex align="center" gap={3}>
@@ -85,7 +81,7 @@ export function PaneItemPreview(props: PaneItemPreviewProps) {
   const tooltip = <DocumentStatus draft={draft} published={published} version={version} />
 
   return (
-    <Root $isInPerspective={isInPerspective}>
+    <Root $isInPerspective={!perspective || Boolean(version)}>
       <SanityDefaultPreview
         {...getPreviewValueWithFallback({value, draft, published, version, perspective})}
         isPlaceholder={isLoading}