Files
supabase/apps/docs/resources/globalSearch/globalSearchResolver.ts
Charis ce14f305ac feat: hybrid search (#37127)
Implement hybrid search for the /docs/api/graphql searchDocs endpoint. Prepend a more descriptive title and introduction to database advisor docs so they rank more highly when directly searched for.
2025-07-14 16:29:01 -04:00

77 lines
2.3 KiB
TypeScript

import * as Sentry from '@sentry/nextjs'
import {
GraphQLError,
GraphQLInt,
GraphQLNonNull,
GraphQLString,
type GraphQLResolveInfo,
} from 'graphql'
import {
type RootQueryTypeSearchDocsArgs,
type SearchResultCollection,
} from '~/__generated__/graphql'
import { convertUnknownToApiError, type ApiErrorGeneric } from '~/app/api/utils'
import { Result } from '~/features/helpers.fn'
import { createCollectionType, GraphQLCollectionBuilder } from '../utils/connections'
import { graphQLFields } from '../utils/fields'
import { SearchResultModel } from './globalSearchModel'
import { GRAPHQL_FIELD_SEARCH_GLOBAL, GraphQLInterfaceTypeSearchResult } from './globalSearchSchema'
async function resolveSearch(
parent: unknown,
args: RootQueryTypeSearchDocsArgs,
context: unknown,
info: GraphQLResolveInfo
): Promise<SearchResultCollection | GraphQLError> {
return (
await Result.tryCatchFlat(
resolveSearchImpl,
convertUnknownToApiError,
parent,
args,
context,
info
)
).match(
// Building a collection from an array is infallible
async (data) => (await GraphQLCollectionBuilder.create({ items: data })).unwrap(),
(error) => {
console.error(`Error resolving ${GRAPHQL_FIELD_SEARCH_GLOBAL}:`, error)
if (!error.isUserError()) {
Sentry.captureException(error)
}
return new GraphQLError(error.isPrivate() ? 'Internal Server Error' : error.message)
}
)
}
async function resolveSearchImpl(
_parent: unknown,
args: RootQueryTypeSearchDocsArgs,
_context: unknown,
info: GraphQLResolveInfo
): Promise<Result<Array<SearchResultModel>, ApiErrorGeneric>> {
const fieldsInfo = graphQLFields(info)
const requestedFields = Object.keys(fieldsInfo.nodes ?? fieldsInfo.edges?.node ?? {})
return await SearchResultModel.searchHybrid(args, requestedFields)
}
export const searchRoot = {
[GRAPHQL_FIELD_SEARCH_GLOBAL]: {
description: 'Search the Supabase docs for content matching a query string',
args: {
query: {
type: new GraphQLNonNull(GraphQLString),
},
limit: {
type: GraphQLInt,
},
},
type: createCollectionType(GraphQLInterfaceTypeSearchResult, {
skipPageInfo: true,
description: 'A collection of search results containing content from Supabase docs',
}),
resolve: resolveSearch,
},
}