e4e788f151
MCP-сервером пользуются LLM-агенты; основной паттерн — lookup: найти страницу по обрывку технической строки и сразу понять, где она лежит и что в ней. Раньше на такой вопрос уходило 3–5 вызовов. Эта часть закрывает `search` (часть 1 из 3; get_tree и get_page_context — следующими PR стопкой). Только чтение. Серверная часть — opt-in, веб-UI байт-в-байт неизменен: - SearchDTO: опциональные substring/parentPageId/titleOnly (default-off; без флагов путь FTS не тронут — guard `if (substring) return searchPageLookup`). - searchPageLookup: один скан pages, WHERE = title LIKE '%q%' OR (если не titleOnly) text LIKE '%q%' OR (если tsquery непустой) tsv @@ ... . LIKE- метасимволы %/_/\ экранируются (escapeLikePattern, ESCAPE '\') — `%`/`_` не матчат всё; substring-ветка работает даже при пустом tsquery (кейс 10.0.12). - Ранжирование тирами (TITLE_EXACT > TITLE_SUBSTRING > TEXT), вторичный сигнал ts_rank / позиция; score∈(0,1] только для сортировки одной выдачи (формула в комментарии). 200-cap упорядочен по SQL-прокси тира ДО среза (иначе Postgres отдаёт произвольные 200 и сильный хит мог выпасть). Пермишен-фильтр к merged-набору ДО limit. path — одна рекурсивная CTE на все хиты (не N+1). - snippet оконный в SQL (~500 символов вокруг первого совпадения). Позиция и срез в ОДНОМ пространстве LOWER(f_unaccent(...)) — f_unaccent не length- preserving (ß→ss, лигатуры, …→...), иначе окно смещалось/пустело. titleOnly → пустой snippet. Компромисс задокументирован. - Миграция: GIN gin_trgm_ops по LOWER(f_unaccent(text_content)); title-trgm индекс #348 переиспользован (IF NOT EXISTS), down() дропает только новый. MCP: схема search (spaceId/parentPageId/titleOnly/limit 1–50, default 10), client.search прокидывает substring:true, filterSearchResult → {pageId, title, path, snippet, score}. Инвариант: наружу только pageId (UUID), slugId/id никогда. Комментарии про намеренное расхождение с in-app hybrid-RRF (не тронут) и про деградацию на stock-upstream/Typesense (substring→plain FTS, без path/ snippet). Проверка на реальном Postgres: server integration 16/16 (вся acceptance-таблица #443 + регрессии на смещение snippet и cap-200), server unit 27/27, mcp node --test 708/708, tsc чисто. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
148 lines
4.2 KiB
TypeScript
148 lines
4.2 KiB
TypeScript
import {
|
|
BadRequestException,
|
|
Body,
|
|
Controller,
|
|
ForbiddenException,
|
|
HttpCode,
|
|
HttpStatus,
|
|
Logger,
|
|
Post,
|
|
UseGuards,
|
|
} from '@nestjs/common';
|
|
import { SearchService } from './search.service';
|
|
import {
|
|
SearchDTO,
|
|
SearchShareDTO,
|
|
SearchSuggestionDTO,
|
|
} from './dto/search.dto';
|
|
import { AuthWorkspace } from '../../common/decorators/auth-workspace.decorator';
|
|
import { JwtAuthGuard } from '../../common/guards/jwt-auth.guard';
|
|
import { User, Workspace } from '@docmost/db/types/entity.types';
|
|
import SpaceAbilityFactory from '../casl/abilities/space-ability.factory';
|
|
import {
|
|
SpaceCaslAction,
|
|
SpaceCaslSubject,
|
|
} from '../casl/interfaces/space-ability.type';
|
|
import { AuthUser } from '../../common/decorators/auth-user.decorator';
|
|
import { Public } from 'src/common/decorators/public.decorator';
|
|
import { EnvironmentService } from '../../integrations/environment/environment.service';
|
|
import { ModuleRef } from '@nestjs/core';
|
|
|
|
@UseGuards(JwtAuthGuard)
|
|
@Controller('search')
|
|
export class SearchController {
|
|
private readonly logger = new Logger(SearchController.name);
|
|
|
|
constructor(
|
|
private readonly searchService: SearchService,
|
|
private readonly spaceAbility: SpaceAbilityFactory,
|
|
private readonly environmentService: EnvironmentService,
|
|
private moduleRef: ModuleRef,
|
|
) {}
|
|
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post()
|
|
async pageSearch(
|
|
@Body() searchDto: SearchDTO,
|
|
@AuthUser() user: User,
|
|
@AuthWorkspace() workspace: Workspace,
|
|
) {
|
|
delete searchDto.shareId;
|
|
|
|
if (searchDto.spaceId) {
|
|
const ability = await this.spaceAbility.createForUser(
|
|
user,
|
|
searchDto.spaceId,
|
|
);
|
|
|
|
if (ability.cannot(SpaceCaslAction.Read, SpaceCaslSubject.Page)) {
|
|
throw new ForbiddenException();
|
|
}
|
|
}
|
|
|
|
// #443 graceful degradation: on EE/Typesense instances the request routes to
|
|
// the Typesense backend, which does NOT implement the opt-in agent-lookup
|
|
// mode. The `substring`/`parentPageId`/`titleOnly` fields are silently ignored
|
|
// and the response carries no `path`/`snippet`/`score` and no substring/tier
|
|
// ranking — it degrades to plain Typesense FTS. The native lookup mode below
|
|
// is Postgres-search-driver only.
|
|
if (this.environmentService.getSearchDriver() === 'typesense') {
|
|
return this.searchTypesense(searchDto, {
|
|
userId: user.id,
|
|
workspaceId: workspace.id,
|
|
});
|
|
}
|
|
|
|
return this.searchService.searchPage(searchDto, {
|
|
userId: user.id,
|
|
workspaceId: workspace.id,
|
|
});
|
|
}
|
|
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post('suggest')
|
|
async searchSuggestions(
|
|
@Body() dto: SearchSuggestionDTO,
|
|
@AuthUser() user: User,
|
|
@AuthWorkspace() workspace: Workspace,
|
|
) {
|
|
return this.searchService.searchSuggestions(dto, user.id, workspace.id);
|
|
}
|
|
|
|
@Public()
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post('share-search')
|
|
async searchShare(
|
|
@Body() searchDto: SearchShareDTO,
|
|
@AuthWorkspace() workspace: Workspace,
|
|
) {
|
|
delete searchDto.spaceId;
|
|
if (!searchDto.shareId) {
|
|
throw new BadRequestException('shareId is required');
|
|
}
|
|
|
|
if (this.environmentService.getSearchDriver() === 'typesense') {
|
|
return this.searchTypesense(searchDto, {
|
|
workspaceId: workspace.id,
|
|
});
|
|
}
|
|
|
|
return this.searchService.searchPage(searchDto, {
|
|
workspaceId: workspace.id,
|
|
});
|
|
}
|
|
|
|
async searchTypesense(
|
|
searchParams: SearchDTO,
|
|
opts: {
|
|
userId?: string;
|
|
workspaceId: string;
|
|
},
|
|
) {
|
|
const { userId, workspaceId } = opts;
|
|
let TypesenseModule: any;
|
|
try {
|
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
TypesenseModule = require('./../../ee/typesense/services/page-search.service');
|
|
|
|
const PageSearchService = this.moduleRef.get(
|
|
TypesenseModule.PageSearchService,
|
|
{
|
|
strict: false,
|
|
},
|
|
);
|
|
|
|
return PageSearchService.searchPage(searchParams, {
|
|
userId: userId,
|
|
workspaceId,
|
|
});
|
|
} catch (err) {
|
|
this.logger.debug(
|
|
'Typesense module requested but enterprise module not bundled in this build',
|
|
);
|
|
}
|
|
|
|
throw new BadRequestException('Enterprise Typesense search module missing');
|
|
}
|
|
}
|