feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)#1098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
h30s wants to merge 2 commits into from
Closed

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504) #1098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1ea7f
feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)
h30s Apr 8, 2026
44a787a
fix(web): avoid bundling search API in client; address review
h30s Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Search results show an informational alert when a query may be incomplete (for example due to match limits, skipped index shards, or streaming flush), and non-exhaustive Zoekt searches are logged for operators. [#1098](https://github.com/sourcebot-dev/sourcebot/pull/1098)
- Linear issue links in chat responses now render as a rich card-style UI showing the Linear logo, issue identifier, and title instead of plain hyperlinks. [#1060](https://github.com/sourcebot-dev/sourcebot/pull/1060)

### Changed
Expand Down
27 changes: 26 additions & 1 deletion packages/web/src/app/(app)/search/components/searchResultsPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,9 @@ import {
} from "@/components/ui/resizable";
import { Separator } from "@/components/ui/separator";
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
import { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search";
import { getSearchLimitExplanation } from "@/features/search/searchLimitExplanation";
import type { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search/types";
import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
import useCaptureEvent from "@/hooks/useCaptureEvent";
import { useNonEmptyQueryParam } from "@/hooks/useNonEmptyQueryParam";
import { useSearchHistory } from "@/hooks/useSearchHistory";
Expand DownExpand Up@@ -205,6 +207,7 @@ export const SearchResultsPage = ({
searchStats={stats}
isMoreResultsButtonVisible={!isExhaustive}
isBranchFilteringEnabled={isBranchFilteringEnabled}
maxMatchDisplayCount={maxMatchCount}
/>
)}
</div>
Expand All@@ -221,6 +224,7 @@ interface PanelGroupProps {
searchDurationMs: number;
numMatches: number;
searchStats?: SearchStats;
maxMatchDisplayCount: number;
}

const PanelGroup = ({
Expand All@@ -233,6 +237,7 @@ const PanelGroup = ({
searchDurationMs: _searchDurationMs,
numMatches,
searchStats,
maxMatchDisplayCount,
}: PanelGroupProps) => {
const [previewedFile, setPreviewedFile] = useState<SearchResultFile | undefined>(undefined);
const filteredFileMatches = useFilteredMatches(fileMatches);
Expand All@@ -258,6 +263,13 @@ const PanelGroup = ({
return Math.round(_searchDurationMs);
}, [_searchDurationMs]);

const limitExplanation = useMemo(() => {
if (isStreaming || !isMoreResultsButtonVisible) {
return null;
}
return getSearchLimitExplanation(searchStats, maxMatchDisplayCount);
}, [isStreaming, isMoreResultsButtonVisible, searchStats, maxMatchDisplayCount]);

return (
<ResizablePanelGroup
direction="horizontal"
Expand DownExpand Up@@ -368,6 +380,19 @@ const PanelGroup = ({
</>
)}
</div>
{limitExplanation && (
<div className="px-2 pb-2 shrink-0">
<Alert variant="default" className="border-amber-200/80 bg-amber-50/80 dark:border-amber-900/50 dark:bg-amber-950/40">
<AlertTriangleIcon className="text-amber-700 dark:text-amber-500" />
<AlertTitle className="text-amber-950 dark:text-amber-100">{limitExplanation.summary}</AlertTitle>
{limitExplanation.detail && (
<AlertDescription className="text-amber-900/90 dark:text-amber-200/90">
{limitExplanation.detail}
</AlertDescription>
)}
</Alert>
</div>
)}
<div className="flex-1 min-h-0">
{filteredFileMatches.length > 0 ? (
<SearchResultsPanel
Expand Down
6 changes: 5 additions & 1 deletion packages/web/src/app/(app)/search/useStreamedSearch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
'use client';

import { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search';
import type { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search/types';
import { ServiceErrorException } from '@/lib/serviceError';
import { isServiceError } from '@/lib/utils';
import * as Sentry from '@sentry/nextjs';
Expand All@@ -14,6 +14,7 @@ interface CacheEntry {
timeToFirstSearchResultMs: number;
timestamp: number;
isExhaustive: boolean;
stats?: SearchStats;
}

const searchCache = new Map<string, CacheEntry>();
Expand DownExpand Up@@ -101,6 +102,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: cachedEntry.timeToSearchCompletionMs,
timeToFirstSearchResultMs: cachedEntry.timeToFirstSearchResultMs,
numMatches: cachedEntry.numMatches,
stats: cachedEntry.stats,
});
return;
}
Expand All@@ -114,6 +116,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: 0,
timeToFirstSearchResultMs: 0,
numMatches: 0,
stats: undefined,
});

try {
Expand DownExpand Up@@ -242,6 +245,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToFirstSearchResultMs: prev.timeToFirstSearchResultMs,
timeToSearchCompletionMs,
timestamp: Date.now(),
stats: prev.stats,
});
return {
...prev,
Expand Down
3 changes: 2 additions & 1 deletion packages/web/src/features/search/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,5 @@ export type {
StreamedSearchResponse,
SearchResultChunk,
SearchResponse,
} from './types';
} from './types';
export { getSearchLimitExplanation } from './searchLimitExplanation';
95 changes: 95 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
import { expect, test } from 'vitest';
import type { SearchStats } from './types';
import { getSearchLimitExplanation } from './searchLimitExplanation';

function stats(overrides: Partial<SearchStats>): SearchStats {
return {
actualMatchCount: 10,
totalMatchCount: 10,
duration: 0,
fileCount: 1,
filesSkipped: 0,
contentBytesLoaded: 0,
indexBytesLoaded: 0,
crashes: 0,
shardFilesConsidered: 0,
filesConsidered: 0,
filesLoaded: 0,
shardsScanned: 1,
shardsSkipped: 0,
shardsSkippedFilter: 0,
ngramMatches: 0,
ngramLookups: 0,
wait: 0,
matchTreeConstruction: 0,
matchTreeSearch: 0,
regexpsConsidered: 0,
flushReason: 'FLUSH_REASON_UNKNOWN_UNSPECIFIED',
...overrides,
};
}

test('missing stats yields generic incomplete message', () => {
const out = getSearchLimitExplanation(undefined, 100);
expect(out.summary).toContain('incomplete');
});

test('shardsSkipped takes precedence (time limit / partial scan)', () => {
const out = getSearchLimitExplanation(
stats({
shardsSkipped: 2,
totalMatchCount: 500,
filesSkipped: 99,
}),
100,
);
expect(out.summary).toContain('did not scan the entire index');
});

test('totalMatchCount above display cap explains match budget', () => {
const out = getSearchLimitExplanation(
stats({
actualMatchCount: 100,
totalMatchCount: 250,
}),
100,
);
expect(out.summary).toContain('More matches exist');
expect(out.detail).toContain('250');
});

test('filesSkipped without shard skip explains early stop', () => {
const out = getSearchLimitExplanation(
stats({
totalMatchCount: 50,
actualMatchCount: 50,
filesSkipped: 10,
}),
100,
);
expect(out.summary).toContain('candidate files');
});

test('flushReason timer when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_TIMER_EXPIRED',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('streaming timer');
});

test('flushReason max size when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_MAX_SIZE',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('size limit');
});
65 changes: 65 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import type { SearchStats } from './types';

/** Values from zoekt `FlushReason` (grpc string enum names). */
const FLUSH_REASON_TIMER_EXPIRED = 'FLUSH_REASON_TIMER_EXPIRED';
const FLUSH_REASON_MAX_SIZE = 'FLUSH_REASON_MAX_SIZE';

/**
* User-facing copy when Zoekt returned a non-exhaustive search (more matches may exist
* than were returned or scanned).
*
* @see https://github.com/sourcebot-dev/sourcebot/issues/504
*/
export function getSearchLimitExplanation(
stats: SearchStats | undefined,
maxMatchDisplayCount: number,
): { summary: string; detail?: string } {
if (!stats) {
return {
summary: 'Results may be incomplete.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}

if (stats.shardsSkipped > 0) {
return {
summary: 'Search did not scan the entire index.',
detail: 'One or more index shards were skipped (often because the search hit a time limit). Additional matches may exist.',
};
}

if (stats.flushReason === FLUSH_REASON_TIMER_EXPIRED) {
return {
summary: 'Results were flushed early due to a streaming timer.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.flushReason === FLUSH_REASON_MAX_SIZE) {
return {
summary: 'Intermediate result set reached its size limit.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.totalMatchCount > maxMatchDisplayCount) {
return {
summary: 'More matches exist than are shown.',
detail: `The index reported ${stats.totalMatchCount} matches, but this request only returns up to ${maxMatchDisplayCount}. Use “load more” or raise the match limit.`,
};
}

if (stats.filesSkipped > 0) {
return {
summary: 'Some candidate files were not fully searched.',
detail: 'The engine stopped after finding enough matches (per-shard or total limits). Additional matches may exist.',
};
}

// Defensive fallback: non-exhaustive searches should usually hit a branch above
// (e.g. totalMatchCount vs display cap, skipped shards/files, or flush reason).
return {
summary: 'More matches may exist than are shown.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}
24 changes: 22 additions & 2 deletions packages/web/src/features/search/zoektSearcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,11 +133,21 @@ export const zoektSearch = async (searchRequest: ZoektGrpcSearchRequest, prisma:
const reposMapCache = await createReposMapForChunk(response, new Map<string | number, Repo>(), prisma);
const { stats, files, repositoryInfo } = await transformZoektSearchResponse(response, reposMapCache);

const isSearchExhaustive = stats.totalMatchCount <= stats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: stats.totalMatchCount,
actualMatchCount: stats.actualMatchCount,
flushReason: stats.flushReason,
shardsSkipped: stats.shardsSkipped,
filesSkipped: stats.filesSkipped,
});
}
resolve({
stats,
files,
repositoryInfo,
isSearchExhaustive: stats.totalMatchCount <= stats.actualMatchCount,
isSearchExhaustive,
} satisfies SearchResponse);
} catch (err) {
reject(err);
Expand DownExpand Up@@ -180,10 +190,20 @@ export const zoektStreamSearch = async (searchRequest: ZoektGrpcSearchRequest, p
async start(controller) {
const tryCloseController = () => {
if (!isStreamActive && pendingChunks === 0) {
const isSearchExhaustive = accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: accumulatedStats.totalMatchCount,
actualMatchCount: accumulatedStats.actualMatchCount,
flushReason: accumulatedStats.flushReason,
shardsSkipped: accumulatedStats.shardsSkipped,
filesSkipped: accumulatedStats.filesSkipped,
});
}
const finalResponse: StreamedSearchResponse = {
type: 'final',
accumulatedStats,
isSearchExhaustive: accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount,
isSearchExhaustive,
}

controller.enqueue(encodeSSEREsponseChunk(finalResponse));
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)#1098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
h30s wants to merge 2 commits into from
Closed

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504) #1098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1ea7f
feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)
h30s Apr 8, 2026
44a787a
fix(web): avoid bundling search API in client; address review
h30s Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Search results show an informational alert when a query may be incomplete (for example due to match limits, skipped index shards, or streaming flush), and non-exhaustive Zoekt searches are logged for operators. [#1098](https://github.com/sourcebot-dev/sourcebot/pull/1098)
- Linear issue links in chat responses now render as a rich card-style UI showing the Linear logo, issue identifier, and title instead of plain hyperlinks. [#1060](https://github.com/sourcebot-dev/sourcebot/pull/1060)

### Changed
Expand Down
27 changes: 26 additions & 1 deletion packages/web/src/app/(app)/search/components/searchResultsPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,9 @@ import {
} from "@/components/ui/resizable";
import { Separator } from "@/components/ui/separator";
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
import { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search";
import { getSearchLimitExplanation } from "@/features/search/searchLimitExplanation";
import type { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search/types";
import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
import useCaptureEvent from "@/hooks/useCaptureEvent";
import { useNonEmptyQueryParam } from "@/hooks/useNonEmptyQueryParam";
import { useSearchHistory } from "@/hooks/useSearchHistory";
Expand DownExpand Up@@ -205,6 +207,7 @@ export const SearchResultsPage = ({
searchStats={stats}
isMoreResultsButtonVisible={!isExhaustive}
isBranchFilteringEnabled={isBranchFilteringEnabled}
maxMatchDisplayCount={maxMatchCount}
/>
)}
</div>
Expand All@@ -221,6 +224,7 @@ interface PanelGroupProps {
searchDurationMs: number;
numMatches: number;
searchStats?: SearchStats;
maxMatchDisplayCount: number;
}

const PanelGroup = ({
Expand All@@ -233,6 +237,7 @@ const PanelGroup = ({
searchDurationMs: _searchDurationMs,
numMatches,
searchStats,
maxMatchDisplayCount,
}: PanelGroupProps) => {
const [previewedFile, setPreviewedFile] = useState<SearchResultFile | undefined>(undefined);
const filteredFileMatches = useFilteredMatches(fileMatches);
Expand All@@ -258,6 +263,13 @@ const PanelGroup = ({
return Math.round(_searchDurationMs);
}, [_searchDurationMs]);

const limitExplanation = useMemo(() => {
if (isStreaming || !isMoreResultsButtonVisible) {
return null;
}
return getSearchLimitExplanation(searchStats, maxMatchDisplayCount);
}, [isStreaming, isMoreResultsButtonVisible, searchStats, maxMatchDisplayCount]);

return (
<ResizablePanelGroup
direction="horizontal"
Expand DownExpand Up@@ -368,6 +380,19 @@ const PanelGroup = ({
</>
)}
</div>
{limitExplanation && (
<div className="px-2 pb-2 shrink-0">
<Alert variant="default" className="border-amber-200/80 bg-amber-50/80 dark:border-amber-900/50 dark:bg-amber-950/40">
<AlertTriangleIcon className="text-amber-700 dark:text-amber-500" />
<AlertTitle className="text-amber-950 dark:text-amber-100">{limitExplanation.summary}</AlertTitle>
{limitExplanation.detail && (
<AlertDescription className="text-amber-900/90 dark:text-amber-200/90">
{limitExplanation.detail}
</AlertDescription>
)}
</Alert>
</div>
)}
<div className="flex-1 min-h-0">
{filteredFileMatches.length > 0 ? (
<SearchResultsPanel
Expand Down
6 changes: 5 additions & 1 deletion packages/web/src/app/(app)/search/useStreamedSearch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
'use client';

import { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search';
import type { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search/types';
import { ServiceErrorException } from '@/lib/serviceError';
import { isServiceError } from '@/lib/utils';
import * as Sentry from '@sentry/nextjs';
Expand All@@ -14,6 +14,7 @@ interface CacheEntry {
timeToFirstSearchResultMs: number;
timestamp: number;
isExhaustive: boolean;
stats?: SearchStats;
}

const searchCache = new Map<string, CacheEntry>();
Expand DownExpand Up@@ -101,6 +102,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: cachedEntry.timeToSearchCompletionMs,
timeToFirstSearchResultMs: cachedEntry.timeToFirstSearchResultMs,
numMatches: cachedEntry.numMatches,
stats: cachedEntry.stats,
});
return;
}
Expand All@@ -114,6 +116,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: 0,
timeToFirstSearchResultMs: 0,
numMatches: 0,
stats: undefined,
});

try {
Expand DownExpand Up@@ -242,6 +245,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToFirstSearchResultMs: prev.timeToFirstSearchResultMs,
timeToSearchCompletionMs,
timestamp: Date.now(),
stats: prev.stats,
});
return {
...prev,
Expand Down
3 changes: 2 additions & 1 deletion packages/web/src/features/search/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,5 @@ export type {
StreamedSearchResponse,
SearchResultChunk,
SearchResponse,
} from './types';
} from './types';
export { getSearchLimitExplanation } from './searchLimitExplanation';
95 changes: 95 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
import { expect, test } from 'vitest';
import type { SearchStats } from './types';
import { getSearchLimitExplanation } from './searchLimitExplanation';

function stats(overrides: Partial<SearchStats>): SearchStats {
return {
actualMatchCount: 10,
totalMatchCount: 10,
duration: 0,
fileCount: 1,
filesSkipped: 0,
contentBytesLoaded: 0,
indexBytesLoaded: 0,
crashes: 0,
shardFilesConsidered: 0,
filesConsidered: 0,
filesLoaded: 0,
shardsScanned: 1,
shardsSkipped: 0,
shardsSkippedFilter: 0,
ngramMatches: 0,
ngramLookups: 0,
wait: 0,
matchTreeConstruction: 0,
matchTreeSearch: 0,
regexpsConsidered: 0,
flushReason: 'FLUSH_REASON_UNKNOWN_UNSPECIFIED',
...overrides,
};
}

test('missing stats yields generic incomplete message', () => {
const out = getSearchLimitExplanation(undefined, 100);
expect(out.summary).toContain('incomplete');
});

test('shardsSkipped takes precedence (time limit / partial scan)', () => {
const out = getSearchLimitExplanation(
stats({
shardsSkipped: 2,
totalMatchCount: 500,
filesSkipped: 99,
}),
100,
);
expect(out.summary).toContain('did not scan the entire index');
});

test('totalMatchCount above display cap explains match budget', () => {
const out = getSearchLimitExplanation(
stats({
actualMatchCount: 100,
totalMatchCount: 250,
}),
100,
);
expect(out.summary).toContain('More matches exist');
expect(out.detail).toContain('250');
});

test('filesSkipped without shard skip explains early stop', () => {
const out = getSearchLimitExplanation(
stats({
totalMatchCount: 50,
actualMatchCount: 50,
filesSkipped: 10,
}),
100,
);
expect(out.summary).toContain('candidate files');
});

test('flushReason timer when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_TIMER_EXPIRED',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('streaming timer');
});

test('flushReason max size when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_MAX_SIZE',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('size limit');
});
65 changes: 65 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import type { SearchStats } from './types';

/** Values from zoekt `FlushReason` (grpc string enum names). */
const FLUSH_REASON_TIMER_EXPIRED = 'FLUSH_REASON_TIMER_EXPIRED';
const FLUSH_REASON_MAX_SIZE = 'FLUSH_REASON_MAX_SIZE';

/**
* User-facing copy when Zoekt returned a non-exhaustive search (more matches may exist
* than were returned or scanned).
*
* @see https://github.com/sourcebot-dev/sourcebot/issues/504
*/
export function getSearchLimitExplanation(
stats: SearchStats | undefined,
maxMatchDisplayCount: number,
): { summary: string; detail?: string } {
if (!stats) {
return {
summary: 'Results may be incomplete.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}

if (stats.shardsSkipped > 0) {
return {
summary: 'Search did not scan the entire index.',
detail: 'One or more index shards were skipped (often because the search hit a time limit). Additional matches may exist.',
};
}

if (stats.flushReason === FLUSH_REASON_TIMER_EXPIRED) {
return {
summary: 'Results were flushed early due to a streaming timer.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.flushReason === FLUSH_REASON_MAX_SIZE) {
return {
summary: 'Intermediate result set reached its size limit.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.totalMatchCount > maxMatchDisplayCount) {
return {
summary: 'More matches exist than are shown.',
detail: `The index reported ${stats.totalMatchCount} matches, but this request only returns up to ${maxMatchDisplayCount}. Use “load more” or raise the match limit.`,
};
}

if (stats.filesSkipped > 0) {
return {
summary: 'Some candidate files were not fully searched.',
detail: 'The engine stopped after finding enough matches (per-shard or total limits). Additional matches may exist.',
};
}

// Defensive fallback: non-exhaustive searches should usually hit a branch above
// (e.g. totalMatchCount vs display cap, skipped shards/files, or flush reason).
return {
summary: 'More matches may exist than are shown.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}
24 changes: 22 additions & 2 deletions packages/web/src/features/search/zoektSearcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,11 +133,21 @@ export const zoektSearch = async (searchRequest: ZoektGrpcSearchRequest, prisma:
const reposMapCache = await createReposMapForChunk(response, new Map<string | number, Repo>(), prisma);
const { stats, files, repositoryInfo } = await transformZoektSearchResponse(response, reposMapCache);

const isSearchExhaustive = stats.totalMatchCount <= stats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: stats.totalMatchCount,
actualMatchCount: stats.actualMatchCount,
flushReason: stats.flushReason,
shardsSkipped: stats.shardsSkipped,
filesSkipped: stats.filesSkipped,
});
}
resolve({
stats,
files,
repositoryInfo,
isSearchExhaustive: stats.totalMatchCount <= stats.actualMatchCount,
isSearchExhaustive,
} satisfies SearchResponse);
} catch (err) {
reject(err);
Expand DownExpand Up@@ -180,10 +190,20 @@ export const zoektStreamSearch = async (searchRequest: ZoektGrpcSearchRequest, p
async start(controller) {
const tryCloseController = () => {
if (!isStreamActive && pendingChunks === 0) {
const isSearchExhaustive = accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: accumulatedStats.totalMatchCount,
actualMatchCount: accumulatedStats.actualMatchCount,
flushReason: accumulatedStats.flushReason,
shardsSkipped: accumulatedStats.shardsSkipped,
filesSkipped: accumulatedStats.filesSkipped,
});
}
const finalResponse: StreamedSearchResponse = {
type: 'final',
accumulatedStats,
isSearchExhaustive: accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount,
isSearchExhaustive,
}

controller.enqueue(encodeSSEREsponseChunk(finalResponse));
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)#1098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
h30s wants to merge 2 commits into from
Closed

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504) #1098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1ea7f
feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)
h30s Apr 8, 2026
44a787a
fix(web): avoid bundling search API in client; address review
h30s Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Search results show an informational alert when a query may be incomplete (for example due to match limits, skipped index shards, or streaming flush), and non-exhaustive Zoekt searches are logged for operators. [#1098](https://github.com/sourcebot-dev/sourcebot/pull/1098)
- Linear issue links in chat responses now render as a rich card-style UI showing the Linear logo, issue identifier, and title instead of plain hyperlinks. [#1060](https://github.com/sourcebot-dev/sourcebot/pull/1060)

### Changed
Expand Down
27 changes: 26 additions & 1 deletion packages/web/src/app/(app)/search/components/searchResultsPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,9 @@ import {
} from "@/components/ui/resizable";
import { Separator } from "@/components/ui/separator";
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
import { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search";
import { getSearchLimitExplanation } from "@/features/search/searchLimitExplanation";
import type { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search/types";
import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
import useCaptureEvent from "@/hooks/useCaptureEvent";
import { useNonEmptyQueryParam } from "@/hooks/useNonEmptyQueryParam";
import { useSearchHistory } from "@/hooks/useSearchHistory";
Expand DownExpand Up@@ -205,6 +207,7 @@ export const SearchResultsPage = ({
searchStats={stats}
isMoreResultsButtonVisible={!isExhaustive}
isBranchFilteringEnabled={isBranchFilteringEnabled}
maxMatchDisplayCount={maxMatchCount}
/>
)}
</div>
Expand All@@ -221,6 +224,7 @@ interface PanelGroupProps {
searchDurationMs: number;
numMatches: number;
searchStats?: SearchStats;
maxMatchDisplayCount: number;
}

const PanelGroup = ({
Expand All@@ -233,6 +237,7 @@ const PanelGroup = ({
searchDurationMs: _searchDurationMs,
numMatches,
searchStats,
maxMatchDisplayCount,
}: PanelGroupProps) => {
const [previewedFile, setPreviewedFile] = useState<SearchResultFile | undefined>(undefined);
const filteredFileMatches = useFilteredMatches(fileMatches);
Expand All@@ -258,6 +263,13 @@ const PanelGroup = ({
return Math.round(_searchDurationMs);
}, [_searchDurationMs]);

const limitExplanation = useMemo(() => {
if (isStreaming || !isMoreResultsButtonVisible) {
return null;
}
return getSearchLimitExplanation(searchStats, maxMatchDisplayCount);
}, [isStreaming, isMoreResultsButtonVisible, searchStats, maxMatchDisplayCount]);

return (
<ResizablePanelGroup
direction="horizontal"
Expand DownExpand Up@@ -368,6 +380,19 @@ const PanelGroup = ({
</>
)}
</div>
{limitExplanation && (
<div className="px-2 pb-2 shrink-0">
<Alert variant="default" className="border-amber-200/80 bg-amber-50/80 dark:border-amber-900/50 dark:bg-amber-950/40">
<AlertTriangleIcon className="text-amber-700 dark:text-amber-500" />
<AlertTitle className="text-amber-950 dark:text-amber-100">{limitExplanation.summary}</AlertTitle>
{limitExplanation.detail && (
<AlertDescription className="text-amber-900/90 dark:text-amber-200/90">
{limitExplanation.detail}
</AlertDescription>
)}
</Alert>
</div>
)}
<div className="flex-1 min-h-0">
{filteredFileMatches.length > 0 ? (
<SearchResultsPanel
Expand Down
6 changes: 5 additions & 1 deletion packages/web/src/app/(app)/search/useStreamedSearch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
'use client';

import { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search';
import type { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search/types';
import { ServiceErrorException } from '@/lib/serviceError';
import { isServiceError } from '@/lib/utils';
import * as Sentry from '@sentry/nextjs';
Expand All@@ -14,6 +14,7 @@ interface CacheEntry {
timeToFirstSearchResultMs: number;
timestamp: number;
isExhaustive: boolean;
stats?: SearchStats;
}

const searchCache = new Map<string, CacheEntry>();
Expand DownExpand Up@@ -101,6 +102,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: cachedEntry.timeToSearchCompletionMs,
timeToFirstSearchResultMs: cachedEntry.timeToFirstSearchResultMs,
numMatches: cachedEntry.numMatches,
stats: cachedEntry.stats,
});
return;
}
Expand All@@ -114,6 +116,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: 0,
timeToFirstSearchResultMs: 0,
numMatches: 0,
stats: undefined,
});

try {
Expand DownExpand Up@@ -242,6 +245,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToFirstSearchResultMs: prev.timeToFirstSearchResultMs,
timeToSearchCompletionMs,
timestamp: Date.now(),
stats: prev.stats,
});
return {
...prev,
Expand Down
3 changes: 2 additions & 1 deletion packages/web/src/features/search/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,5 @@ export type {
StreamedSearchResponse,
SearchResultChunk,
SearchResponse,
} from './types';
} from './types';
export { getSearchLimitExplanation } from './searchLimitExplanation';
95 changes: 95 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
import { expect, test } from 'vitest';
import type { SearchStats } from './types';
import { getSearchLimitExplanation } from './searchLimitExplanation';

function stats(overrides: Partial<SearchStats>): SearchStats {
return {
actualMatchCount: 10,
totalMatchCount: 10,
duration: 0,
fileCount: 1,
filesSkipped: 0,
contentBytesLoaded: 0,
indexBytesLoaded: 0,
crashes: 0,
shardFilesConsidered: 0,
filesConsidered: 0,
filesLoaded: 0,
shardsScanned: 1,
shardsSkipped: 0,
shardsSkippedFilter: 0,
ngramMatches: 0,
ngramLookups: 0,
wait: 0,
matchTreeConstruction: 0,
matchTreeSearch: 0,
regexpsConsidered: 0,
flushReason: 'FLUSH_REASON_UNKNOWN_UNSPECIFIED',
...overrides,
};
}

test('missing stats yields generic incomplete message', () => {
const out = getSearchLimitExplanation(undefined, 100);
expect(out.summary).toContain('incomplete');
});

test('shardsSkipped takes precedence (time limit / partial scan)', () => {
const out = getSearchLimitExplanation(
stats({
shardsSkipped: 2,
totalMatchCount: 500,
filesSkipped: 99,
}),
100,
);
expect(out.summary).toContain('did not scan the entire index');
});

test('totalMatchCount above display cap explains match budget', () => {
const out = getSearchLimitExplanation(
stats({
actualMatchCount: 100,
totalMatchCount: 250,
}),
100,
);
expect(out.summary).toContain('More matches exist');
expect(out.detail).toContain('250');
});

test('filesSkipped without shard skip explains early stop', () => {
const out = getSearchLimitExplanation(
stats({
totalMatchCount: 50,
actualMatchCount: 50,
filesSkipped: 10,
}),
100,
);
expect(out.summary).toContain('candidate files');
});

test('flushReason timer when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_TIMER_EXPIRED',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('streaming timer');
});

test('flushReason max size when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_MAX_SIZE',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('size limit');
});
65 changes: 65 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import type { SearchStats } from './types';

/** Values from zoekt `FlushReason` (grpc string enum names). */
const FLUSH_REASON_TIMER_EXPIRED = 'FLUSH_REASON_TIMER_EXPIRED';
const FLUSH_REASON_MAX_SIZE = 'FLUSH_REASON_MAX_SIZE';

/**
* User-facing copy when Zoekt returned a non-exhaustive search (more matches may exist
* than were returned or scanned).
*
* @see https://github.com/sourcebot-dev/sourcebot/issues/504
*/
export function getSearchLimitExplanation(
stats: SearchStats | undefined,
maxMatchDisplayCount: number,
): { summary: string; detail?: string } {
if (!stats) {
return {
summary: 'Results may be incomplete.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}

if (stats.shardsSkipped > 0) {
return {
summary: 'Search did not scan the entire index.',
detail: 'One or more index shards were skipped (often because the search hit a time limit). Additional matches may exist.',
};
}

if (stats.flushReason === FLUSH_REASON_TIMER_EXPIRED) {
return {
summary: 'Results were flushed early due to a streaming timer.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.flushReason === FLUSH_REASON_MAX_SIZE) {
return {
summary: 'Intermediate result set reached its size limit.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.totalMatchCount > maxMatchDisplayCount) {
return {
summary: 'More matches exist than are shown.',
detail: `The index reported ${stats.totalMatchCount} matches, but this request only returns up to ${maxMatchDisplayCount}. Use “load more” or raise the match limit.`,
};
}

if (stats.filesSkipped > 0) {
return {
summary: 'Some candidate files were not fully searched.',
detail: 'The engine stopped after finding enough matches (per-shard or total limits). Additional matches may exist.',
};
}

// Defensive fallback: non-exhaustive searches should usually hit a branch above
// (e.g. totalMatchCount vs display cap, skipped shards/files, or flush reason).
return {
summary: 'More matches may exist than are shown.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}
24 changes: 22 additions & 2 deletions packages/web/src/features/search/zoektSearcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,11 +133,21 @@ export const zoektSearch = async (searchRequest: ZoektGrpcSearchRequest, prisma:
const reposMapCache = await createReposMapForChunk(response, new Map<string | number, Repo>(), prisma);
const { stats, files, repositoryInfo } = await transformZoektSearchResponse(response, reposMapCache);

const isSearchExhaustive = stats.totalMatchCount <= stats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: stats.totalMatchCount,
actualMatchCount: stats.actualMatchCount,
flushReason: stats.flushReason,
shardsSkipped: stats.shardsSkipped,
filesSkipped: stats.filesSkipped,
});
}
resolve({
stats,
files,
repositoryInfo,
isSearchExhaustive: stats.totalMatchCount <= stats.actualMatchCount,
isSearchExhaustive,
} satisfies SearchResponse);
} catch (err) {
reject(err);
Expand DownExpand Up@@ -180,10 +190,20 @@ export const zoektStreamSearch = async (searchRequest: ZoektGrpcSearchRequest, p
async start(controller) {
const tryCloseController = () => {
if (!isStreamActive && pendingChunks === 0) {
const isSearchExhaustive = accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: accumulatedStats.totalMatchCount,
actualMatchCount: accumulatedStats.actualMatchCount,
flushReason: accumulatedStats.flushReason,
shardsSkipped: accumulatedStats.shardsSkipped,
filesSkipped: accumulatedStats.filesSkipped,
});
}
const finalResponse: StreamedSearchResponse = {
type: 'final',
accumulatedStats,
isSearchExhaustive: accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount,
isSearchExhaustive,
}

controller.enqueue(encodeSSEREsponseChunk(finalResponse));
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)#1098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
h30s wants to merge 2 commits into from
Closed

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504) #1098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1ea7f
feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)
h30s Apr 8, 2026
44a787a
fix(web): avoid bundling search API in client; address review
h30s Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Search results show an informational alert when a query may be incomplete (for example due to match limits, skipped index shards, or streaming flush), and non-exhaustive Zoekt searches are logged for operators. [#1098](https://github.com/sourcebot-dev/sourcebot/pull/1098)
- Linear issue links in chat responses now render as a rich card-style UI showing the Linear logo, issue identifier, and title instead of plain hyperlinks. [#1060](https://github.com/sourcebot-dev/sourcebot/pull/1060)

### Changed
Expand Down
27 changes: 26 additions & 1 deletion packages/web/src/app/(app)/search/components/searchResultsPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,9 @@ import {
} from "@/components/ui/resizable";
import { Separator } from "@/components/ui/separator";
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
import { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search";
import { getSearchLimitExplanation } from "@/features/search/searchLimitExplanation";
import type { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search/types";
import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
import useCaptureEvent from "@/hooks/useCaptureEvent";
import { useNonEmptyQueryParam } from "@/hooks/useNonEmptyQueryParam";
import { useSearchHistory } from "@/hooks/useSearchHistory";
Expand DownExpand Up@@ -205,6 +207,7 @@ export const SearchResultsPage = ({
searchStats={stats}
isMoreResultsButtonVisible={!isExhaustive}
isBranchFilteringEnabled={isBranchFilteringEnabled}
maxMatchDisplayCount={maxMatchCount}
/>
)}
</div>
Expand All@@ -221,6 +224,7 @@ interface PanelGroupProps {
searchDurationMs: number;
numMatches: number;
searchStats?: SearchStats;
maxMatchDisplayCount: number;
}

const PanelGroup = ({
Expand All@@ -233,6 +237,7 @@ const PanelGroup = ({
searchDurationMs: _searchDurationMs,
numMatches,
searchStats,
maxMatchDisplayCount,
}: PanelGroupProps) => {
const [previewedFile, setPreviewedFile] = useState<SearchResultFile | undefined>(undefined);
const filteredFileMatches = useFilteredMatches(fileMatches);
Expand All@@ -258,6 +263,13 @@ const PanelGroup = ({
return Math.round(_searchDurationMs);
}, [_searchDurationMs]);

const limitExplanation = useMemo(() => {
if (isStreaming || !isMoreResultsButtonVisible) {
return null;
}
return getSearchLimitExplanation(searchStats, maxMatchDisplayCount);
}, [isStreaming, isMoreResultsButtonVisible, searchStats, maxMatchDisplayCount]);

return (
<ResizablePanelGroup
direction="horizontal"
Expand DownExpand Up@@ -368,6 +380,19 @@ const PanelGroup = ({
</>
)}
</div>
{limitExplanation && (
<div className="px-2 pb-2 shrink-0">
<Alert variant="default" className="border-amber-200/80 bg-amber-50/80 dark:border-amber-900/50 dark:bg-amber-950/40">
<AlertTriangleIcon className="text-amber-700 dark:text-amber-500" />
<AlertTitle className="text-amber-950 dark:text-amber-100">{limitExplanation.summary}</AlertTitle>
{limitExplanation.detail && (
<AlertDescription className="text-amber-900/90 dark:text-amber-200/90">
{limitExplanation.detail}
</AlertDescription>
)}
</Alert>
</div>
)}
<div className="flex-1 min-h-0">
{filteredFileMatches.length > 0 ? (
<SearchResultsPanel
Expand Down
6 changes: 5 additions & 1 deletion packages/web/src/app/(app)/search/useStreamedSearch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
'use client';

import { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search';
import type { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search/types';
import { ServiceErrorException } from '@/lib/serviceError';
import { isServiceError } from '@/lib/utils';
import * as Sentry from '@sentry/nextjs';
Expand All@@ -14,6 +14,7 @@ interface CacheEntry {
timeToFirstSearchResultMs: number;
timestamp: number;
isExhaustive: boolean;
stats?: SearchStats;
}

const searchCache = new Map<string, CacheEntry>();
Expand DownExpand Up@@ -101,6 +102,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: cachedEntry.timeToSearchCompletionMs,
timeToFirstSearchResultMs: cachedEntry.timeToFirstSearchResultMs,
numMatches: cachedEntry.numMatches,
stats: cachedEntry.stats,
});
return;
}
Expand All@@ -114,6 +116,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: 0,
timeToFirstSearchResultMs: 0,
numMatches: 0,
stats: undefined,
});

try {
Expand DownExpand Up@@ -242,6 +245,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToFirstSearchResultMs: prev.timeToFirstSearchResultMs,
timeToSearchCompletionMs,
timestamp: Date.now(),
stats: prev.stats,
});
return {
...prev,
Expand Down
3 changes: 2 additions & 1 deletion packages/web/src/features/search/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,5 @@ export type {
StreamedSearchResponse,
SearchResultChunk,
SearchResponse,
} from './types';
} from './types';
export { getSearchLimitExplanation } from './searchLimitExplanation';
95 changes: 95 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
import { expect, test } from 'vitest';
import type { SearchStats } from './types';
import { getSearchLimitExplanation } from './searchLimitExplanation';

function stats(overrides: Partial<SearchStats>): SearchStats {
return {
actualMatchCount: 10,
totalMatchCount: 10,
duration: 0,
fileCount: 1,
filesSkipped: 0,
contentBytesLoaded: 0,
indexBytesLoaded: 0,
crashes: 0,
shardFilesConsidered: 0,
filesConsidered: 0,
filesLoaded: 0,
shardsScanned: 1,
shardsSkipped: 0,
shardsSkippedFilter: 0,
ngramMatches: 0,
ngramLookups: 0,
wait: 0,
matchTreeConstruction: 0,
matchTreeSearch: 0,
regexpsConsidered: 0,
flushReason: 'FLUSH_REASON_UNKNOWN_UNSPECIFIED',
...overrides,
};
}

test('missing stats yields generic incomplete message', () => {
const out = getSearchLimitExplanation(undefined, 100);
expect(out.summary).toContain('incomplete');
});

test('shardsSkipped takes precedence (time limit / partial scan)', () => {
const out = getSearchLimitExplanation(
stats({
shardsSkipped: 2,
totalMatchCount: 500,
filesSkipped: 99,
}),
100,
);
expect(out.summary).toContain('did not scan the entire index');
});

test('totalMatchCount above display cap explains match budget', () => {
const out = getSearchLimitExplanation(
stats({
actualMatchCount: 100,
totalMatchCount: 250,
}),
100,
);
expect(out.summary).toContain('More matches exist');
expect(out.detail).toContain('250');
});

test('filesSkipped without shard skip explains early stop', () => {
const out = getSearchLimitExplanation(
stats({
totalMatchCount: 50,
actualMatchCount: 50,
filesSkipped: 10,
}),
100,
);
expect(out.summary).toContain('candidate files');
});

test('flushReason timer when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_TIMER_EXPIRED',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('streaming timer');
});

test('flushReason max size when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_MAX_SIZE',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('size limit');
});
65 changes: 65 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import type { SearchStats } from './types';

/** Values from zoekt `FlushReason` (grpc string enum names). */
const FLUSH_REASON_TIMER_EXPIRED = 'FLUSH_REASON_TIMER_EXPIRED';
const FLUSH_REASON_MAX_SIZE = 'FLUSH_REASON_MAX_SIZE';

/**
* User-facing copy when Zoekt returned a non-exhaustive search (more matches may exist
* than were returned or scanned).
*
* @see https://github.com/sourcebot-dev/sourcebot/issues/504
*/
export function getSearchLimitExplanation(
stats: SearchStats | undefined,
maxMatchDisplayCount: number,
): { summary: string; detail?: string } {
if (!stats) {
return {
summary: 'Results may be incomplete.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}

if (stats.shardsSkipped > 0) {
return {
summary: 'Search did not scan the entire index.',
detail: 'One or more index shards were skipped (often because the search hit a time limit). Additional matches may exist.',
};
}

if (stats.flushReason === FLUSH_REASON_TIMER_EXPIRED) {
return {
summary: 'Results were flushed early due to a streaming timer.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.flushReason === FLUSH_REASON_MAX_SIZE) {
return {
summary: 'Intermediate result set reached its size limit.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.totalMatchCount > maxMatchDisplayCount) {
return {
summary: 'More matches exist than are shown.',
detail: `The index reported ${stats.totalMatchCount} matches, but this request only returns up to ${maxMatchDisplayCount}. Use “load more” or raise the match limit.`,
};
}

if (stats.filesSkipped > 0) {
return {
summary: 'Some candidate files were not fully searched.',
detail: 'The engine stopped after finding enough matches (per-shard or total limits). Additional matches may exist.',
};
}

// Defensive fallback: non-exhaustive searches should usually hit a branch above
// (e.g. totalMatchCount vs display cap, skipped shards/files, or flush reason).
return {
summary: 'More matches may exist than are shown.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}
24 changes: 22 additions & 2 deletions packages/web/src/features/search/zoektSearcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,11 +133,21 @@ export const zoektSearch = async (searchRequest: ZoektGrpcSearchRequest, prisma:
const reposMapCache = await createReposMapForChunk(response, new Map<string | number, Repo>(), prisma);
const { stats, files, repositoryInfo } = await transformZoektSearchResponse(response, reposMapCache);

const isSearchExhaustive = stats.totalMatchCount <= stats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: stats.totalMatchCount,
actualMatchCount: stats.actualMatchCount,
flushReason: stats.flushReason,
shardsSkipped: stats.shardsSkipped,
filesSkipped: stats.filesSkipped,
});
}
resolve({
stats,
files,
repositoryInfo,
isSearchExhaustive: stats.totalMatchCount <= stats.actualMatchCount,
isSearchExhaustive,
} satisfies SearchResponse);
} catch (err) {
reject(err);
Expand DownExpand Up@@ -180,10 +190,20 @@ export const zoektStreamSearch = async (searchRequest: ZoektGrpcSearchRequest, p
async start(controller) {
const tryCloseController = () => {
if (!isStreamActive && pendingChunks === 0) {
const isSearchExhaustive = accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: accumulatedStats.totalMatchCount,
actualMatchCount: accumulatedStats.actualMatchCount,
flushReason: accumulatedStats.flushReason,
shardsSkipped: accumulatedStats.shardsSkipped,
filesSkipped: accumulatedStats.filesSkipped,
});
}
const finalResponse: StreamedSearchResponse = {
type: 'final',
accumulatedStats,
isSearchExhaustive: accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount,
isSearchExhaustive,
}

controller.enqueue(encodeSSEREsponseChunk(finalResponse));
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)#1098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
h30s wants to merge 2 commits into from
Closed

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504) #1098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1ea7f
feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)
h30s Apr 8, 2026
44a787a
fix(web): avoid bundling search API in client; address review
h30s Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Search results show an informational alert when a query may be incomplete (for example due to match limits, skipped index shards, or streaming flush), and non-exhaustive Zoekt searches are logged for operators. [#1098](https://github.com/sourcebot-dev/sourcebot/pull/1098)
- Linear issue links in chat responses now render as a rich card-style UI showing the Linear logo, issue identifier, and title instead of plain hyperlinks. [#1060](https://github.com/sourcebot-dev/sourcebot/pull/1060)

### Changed
Expand Down
27 changes: 26 additions & 1 deletion packages/web/src/app/(app)/search/components/searchResultsPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,9 @@ import {
} from "@/components/ui/resizable";
import { Separator } from "@/components/ui/separator";
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
import { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search";
import { getSearchLimitExplanation } from "@/features/search/searchLimitExplanation";
import type { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search/types";
import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
import useCaptureEvent from "@/hooks/useCaptureEvent";
import { useNonEmptyQueryParam } from "@/hooks/useNonEmptyQueryParam";
import { useSearchHistory } from "@/hooks/useSearchHistory";
Expand DownExpand Up@@ -205,6 +207,7 @@ export const SearchResultsPage = ({
searchStats={stats}
isMoreResultsButtonVisible={!isExhaustive}
isBranchFilteringEnabled={isBranchFilteringEnabled}
maxMatchDisplayCount={maxMatchCount}
/>
)}
</div>
Expand All@@ -221,6 +224,7 @@ interface PanelGroupProps {
searchDurationMs: number;
numMatches: number;
searchStats?: SearchStats;
maxMatchDisplayCount: number;
}

const PanelGroup = ({
Expand All@@ -233,6 +237,7 @@ const PanelGroup = ({
searchDurationMs: _searchDurationMs,
numMatches,
searchStats,
maxMatchDisplayCount,
}: PanelGroupProps) => {
const [previewedFile, setPreviewedFile] = useState<SearchResultFile | undefined>(undefined);
const filteredFileMatches = useFilteredMatches(fileMatches);
Expand All@@ -258,6 +263,13 @@ const PanelGroup = ({
return Math.round(_searchDurationMs);
}, [_searchDurationMs]);

const limitExplanation = useMemo(() => {
if (isStreaming || !isMoreResultsButtonVisible) {
return null;
}
return getSearchLimitExplanation(searchStats, maxMatchDisplayCount);
}, [isStreaming, isMoreResultsButtonVisible, searchStats, maxMatchDisplayCount]);

return (
<ResizablePanelGroup
direction="horizontal"
Expand DownExpand Up@@ -368,6 +380,19 @@ const PanelGroup = ({
</>
)}
</div>
{limitExplanation && (
<div className="px-2 pb-2 shrink-0">
<Alert variant="default" className="border-amber-200/80 bg-amber-50/80 dark:border-amber-900/50 dark:bg-amber-950/40">
<AlertTriangleIcon className="text-amber-700 dark:text-amber-500" />
<AlertTitle className="text-amber-950 dark:text-amber-100">{limitExplanation.summary}</AlertTitle>
{limitExplanation.detail && (
<AlertDescription className="text-amber-900/90 dark:text-amber-200/90">
{limitExplanation.detail}
</AlertDescription>
)}
</Alert>
</div>
)}
<div className="flex-1 min-h-0">
{filteredFileMatches.length > 0 ? (
<SearchResultsPanel
Expand Down
6 changes: 5 additions & 1 deletion packages/web/src/app/(app)/search/useStreamedSearch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
'use client';

import { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search';
import type { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search/types';
import { ServiceErrorException } from '@/lib/serviceError';
import { isServiceError } from '@/lib/utils';
import * as Sentry from '@sentry/nextjs';
Expand All@@ -14,6 +14,7 @@ interface CacheEntry {
timeToFirstSearchResultMs: number;
timestamp: number;
isExhaustive: boolean;
stats?: SearchStats;
}

const searchCache = new Map<string, CacheEntry>();
Expand DownExpand Up@@ -101,6 +102,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: cachedEntry.timeToSearchCompletionMs,
timeToFirstSearchResultMs: cachedEntry.timeToFirstSearchResultMs,
numMatches: cachedEntry.numMatches,
stats: cachedEntry.stats,
});
return;
}
Expand All@@ -114,6 +116,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: 0,
timeToFirstSearchResultMs: 0,
numMatches: 0,
stats: undefined,
});

try {
Expand DownExpand Up@@ -242,6 +245,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToFirstSearchResultMs: prev.timeToFirstSearchResultMs,
timeToSearchCompletionMs,
timestamp: Date.now(),
stats: prev.stats,
});
return {
...prev,
Expand Down
3 changes: 2 additions & 1 deletion packages/web/src/features/search/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,5 @@ export type {
StreamedSearchResponse,
SearchResultChunk,
SearchResponse,
} from './types';
} from './types';
export { getSearchLimitExplanation } from './searchLimitExplanation';
95 changes: 95 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
import { expect, test } from 'vitest';
import type { SearchStats } from './types';
import { getSearchLimitExplanation } from './searchLimitExplanation';

function stats(overrides: Partial<SearchStats>): SearchStats {
return {
actualMatchCount: 10,
totalMatchCount: 10,
duration: 0,
fileCount: 1,
filesSkipped: 0,
contentBytesLoaded: 0,
indexBytesLoaded: 0,
crashes: 0,
shardFilesConsidered: 0,
filesConsidered: 0,
filesLoaded: 0,
shardsScanned: 1,
shardsSkipped: 0,
shardsSkippedFilter: 0,
ngramMatches: 0,
ngramLookups: 0,
wait: 0,
matchTreeConstruction: 0,
matchTreeSearch: 0,
regexpsConsidered: 0,
flushReason: 'FLUSH_REASON_UNKNOWN_UNSPECIFIED',
...overrides,
};
}

test('missing stats yields generic incomplete message', () => {
const out = getSearchLimitExplanation(undefined, 100);
expect(out.summary).toContain('incomplete');
});

test('shardsSkipped takes precedence (time limit / partial scan)', () => {
const out = getSearchLimitExplanation(
stats({
shardsSkipped: 2,
totalMatchCount: 500,
filesSkipped: 99,
}),
100,
);
expect(out.summary).toContain('did not scan the entire index');
});

test('totalMatchCount above display cap explains match budget', () => {
const out = getSearchLimitExplanation(
stats({
actualMatchCount: 100,
totalMatchCount: 250,
}),
100,
);
expect(out.summary).toContain('More matches exist');
expect(out.detail).toContain('250');
});

test('filesSkipped without shard skip explains early stop', () => {
const out = getSearchLimitExplanation(
stats({
totalMatchCount: 50,
actualMatchCount: 50,
filesSkipped: 10,
}),
100,
);
expect(out.summary).toContain('candidate files');
});

test('flushReason timer when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_TIMER_EXPIRED',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('streaming timer');
});

test('flushReason max size when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_MAX_SIZE',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('size limit');
});
65 changes: 65 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import type { SearchStats } from './types';

/** Values from zoekt `FlushReason` (grpc string enum names). */
const FLUSH_REASON_TIMER_EXPIRED = 'FLUSH_REASON_TIMER_EXPIRED';
const FLUSH_REASON_MAX_SIZE = 'FLUSH_REASON_MAX_SIZE';

/**
* User-facing copy when Zoekt returned a non-exhaustive search (more matches may exist
* than were returned or scanned).
*
* @see https://github.com/sourcebot-dev/sourcebot/issues/504
*/
export function getSearchLimitExplanation(
stats: SearchStats | undefined,
maxMatchDisplayCount: number,
): { summary: string; detail?: string } {
if (!stats) {
return {
summary: 'Results may be incomplete.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}

if (stats.shardsSkipped > 0) {
return {
summary: 'Search did not scan the entire index.',
detail: 'One or more index shards were skipped (often because the search hit a time limit). Additional matches may exist.',
};
}

if (stats.flushReason === FLUSH_REASON_TIMER_EXPIRED) {
return {
summary: 'Results were flushed early due to a streaming timer.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.flushReason === FLUSH_REASON_MAX_SIZE) {
return {
summary: 'Intermediate result set reached its size limit.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.totalMatchCount > maxMatchDisplayCount) {
return {
summary: 'More matches exist than are shown.',
detail: `The index reported ${stats.totalMatchCount} matches, but this request only returns up to ${maxMatchDisplayCount}. Use “load more” or raise the match limit.`,
};
}

if (stats.filesSkipped > 0) {
return {
summary: 'Some candidate files were not fully searched.',
detail: 'The engine stopped after finding enough matches (per-shard or total limits). Additional matches may exist.',
};
}

// Defensive fallback: non-exhaustive searches should usually hit a branch above
// (e.g. totalMatchCount vs display cap, skipped shards/files, or flush reason).
return {
summary: 'More matches may exist than are shown.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}
24 changes: 22 additions & 2 deletions packages/web/src/features/search/zoektSearcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,11 +133,21 @@ export const zoektSearch = async (searchRequest: ZoektGrpcSearchRequest, prisma:
const reposMapCache = await createReposMapForChunk(response, new Map<string | number, Repo>(), prisma);
const { stats, files, repositoryInfo } = await transformZoektSearchResponse(response, reposMapCache);

const isSearchExhaustive = stats.totalMatchCount <= stats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: stats.totalMatchCount,
actualMatchCount: stats.actualMatchCount,
flushReason: stats.flushReason,
shardsSkipped: stats.shardsSkipped,
filesSkipped: stats.filesSkipped,
});
}
resolve({
stats,
files,
repositoryInfo,
isSearchExhaustive: stats.totalMatchCount <= stats.actualMatchCount,
isSearchExhaustive,
} satisfies SearchResponse);
} catch (err) {
reject(err);
Expand DownExpand Up@@ -180,10 +190,20 @@ export const zoektStreamSearch = async (searchRequest: ZoektGrpcSearchRequest, p
async start(controller) {
const tryCloseController = () => {
if (!isStreamActive && pendingChunks === 0) {
const isSearchExhaustive = accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: accumulatedStats.totalMatchCount,
actualMatchCount: accumulatedStats.actualMatchCount,
flushReason: accumulatedStats.flushReason,
shardsSkipped: accumulatedStats.shardsSkipped,
filesSkipped: accumulatedStats.filesSkipped,
});
}
const finalResponse: StreamedSearchResponse = {
type: 'final',
accumulatedStats,
isSearchExhaustive: accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount,
isSearchExhaustive,
}

controller.enqueue(encodeSSEREsponseChunk(finalResponse));
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)#1098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
h30s wants to merge 2 commits into from
Closed

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504) #1098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1ea7f
feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)
h30s Apr 8, 2026
44a787a
fix(web): avoid bundling search API in client; address review
h30s Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Search results show an informational alert when a query may be incomplete (for example due to match limits, skipped index shards, or streaming flush), and non-exhaustive Zoekt searches are logged for operators. [#1098](https://github.com/sourcebot-dev/sourcebot/pull/1098)
- Linear issue links in chat responses now render as a rich card-style UI showing the Linear logo, issue identifier, and title instead of plain hyperlinks. [#1060](https://github.com/sourcebot-dev/sourcebot/pull/1060)

### Changed
Expand Down
27 changes: 26 additions & 1 deletion packages/web/src/app/(app)/search/components/searchResultsPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,9 @@ import {
} from "@/components/ui/resizable";
import { Separator } from "@/components/ui/separator";
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
import { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search";
import { getSearchLimitExplanation } from "@/features/search/searchLimitExplanation";
import type { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search/types";
import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
import useCaptureEvent from "@/hooks/useCaptureEvent";
import { useNonEmptyQueryParam } from "@/hooks/useNonEmptyQueryParam";
import { useSearchHistory } from "@/hooks/useSearchHistory";
Expand DownExpand Up@@ -205,6 +207,7 @@ export const SearchResultsPage = ({
searchStats={stats}
isMoreResultsButtonVisible={!isExhaustive}
isBranchFilteringEnabled={isBranchFilteringEnabled}
maxMatchDisplayCount={maxMatchCount}
/>
)}
</div>
Expand All@@ -221,6 +224,7 @@ interface PanelGroupProps {
searchDurationMs: number;
numMatches: number;
searchStats?: SearchStats;
maxMatchDisplayCount: number;
}

const PanelGroup = ({
Expand All@@ -233,6 +237,7 @@ const PanelGroup = ({
searchDurationMs: _searchDurationMs,
numMatches,
searchStats,
maxMatchDisplayCount,
}: PanelGroupProps) => {
const [previewedFile, setPreviewedFile] = useState<SearchResultFile | undefined>(undefined);
const filteredFileMatches = useFilteredMatches(fileMatches);
Expand All@@ -258,6 +263,13 @@ const PanelGroup = ({
return Math.round(_searchDurationMs);
}, [_searchDurationMs]);

const limitExplanation = useMemo(() => {
if (isStreaming || !isMoreResultsButtonVisible) {
return null;
}
return getSearchLimitExplanation(searchStats, maxMatchDisplayCount);
}, [isStreaming, isMoreResultsButtonVisible, searchStats, maxMatchDisplayCount]);

return (
<ResizablePanelGroup
direction="horizontal"
Expand DownExpand Up@@ -368,6 +380,19 @@ const PanelGroup = ({
</>
)}
</div>
{limitExplanation && (
<div className="px-2 pb-2 shrink-0">
<Alert variant="default" className="border-amber-200/80 bg-amber-50/80 dark:border-amber-900/50 dark:bg-amber-950/40">
<AlertTriangleIcon className="text-amber-700 dark:text-amber-500" />
<AlertTitle className="text-amber-950 dark:text-amber-100">{limitExplanation.summary}</AlertTitle>
{limitExplanation.detail && (
<AlertDescription className="text-amber-900/90 dark:text-amber-200/90">
{limitExplanation.detail}
</AlertDescription>
)}
</Alert>
</div>
)}
<div className="flex-1 min-h-0">
{filteredFileMatches.length > 0 ? (
<SearchResultsPanel
Expand Down
6 changes: 5 additions & 1 deletion packages/web/src/app/(app)/search/useStreamedSearch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
'use client';

import { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search';
import type { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search/types';
import { ServiceErrorException } from '@/lib/serviceError';
import { isServiceError } from '@/lib/utils';
import * as Sentry from '@sentry/nextjs';
Expand All@@ -14,6 +14,7 @@ interface CacheEntry {
timeToFirstSearchResultMs: number;
timestamp: number;
isExhaustive: boolean;
stats?: SearchStats;
}

const searchCache = new Map<string, CacheEntry>();
Expand DownExpand Up@@ -101,6 +102,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: cachedEntry.timeToSearchCompletionMs,
timeToFirstSearchResultMs: cachedEntry.timeToFirstSearchResultMs,
numMatches: cachedEntry.numMatches,
stats: cachedEntry.stats,
});
return;
}
Expand All@@ -114,6 +116,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: 0,
timeToFirstSearchResultMs: 0,
numMatches: 0,
stats: undefined,
});

try {
Expand DownExpand Up@@ -242,6 +245,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToFirstSearchResultMs: prev.timeToFirstSearchResultMs,
timeToSearchCompletionMs,
timestamp: Date.now(),
stats: prev.stats,
});
return {
...prev,
Expand Down
3 changes: 2 additions & 1 deletion packages/web/src/features/search/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,5 @@ export type {
StreamedSearchResponse,
SearchResultChunk,
SearchResponse,
} from './types';
} from './types';
export { getSearchLimitExplanation } from './searchLimitExplanation';
95 changes: 95 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
import { expect, test } from 'vitest';
import type { SearchStats } from './types';
import { getSearchLimitExplanation } from './searchLimitExplanation';

function stats(overrides: Partial<SearchStats>): SearchStats {
return {
actualMatchCount: 10,
totalMatchCount: 10,
duration: 0,
fileCount: 1,
filesSkipped: 0,
contentBytesLoaded: 0,
indexBytesLoaded: 0,
crashes: 0,
shardFilesConsidered: 0,
filesConsidered: 0,
filesLoaded: 0,
shardsScanned: 1,
shardsSkipped: 0,
shardsSkippedFilter: 0,
ngramMatches: 0,
ngramLookups: 0,
wait: 0,
matchTreeConstruction: 0,
matchTreeSearch: 0,
regexpsConsidered: 0,
flushReason: 'FLUSH_REASON_UNKNOWN_UNSPECIFIED',
...overrides,
};
}

test('missing stats yields generic incomplete message', () => {
const out = getSearchLimitExplanation(undefined, 100);
expect(out.summary).toContain('incomplete');
});

test('shardsSkipped takes precedence (time limit / partial scan)', () => {
const out = getSearchLimitExplanation(
stats({
shardsSkipped: 2,
totalMatchCount: 500,
filesSkipped: 99,
}),
100,
);
expect(out.summary).toContain('did not scan the entire index');
});

test('totalMatchCount above display cap explains match budget', () => {
const out = getSearchLimitExplanation(
stats({
actualMatchCount: 100,
totalMatchCount: 250,
}),
100,
);
expect(out.summary).toContain('More matches exist');
expect(out.detail).toContain('250');
});

test('filesSkipped without shard skip explains early stop', () => {
const out = getSearchLimitExplanation(
stats({
totalMatchCount: 50,
actualMatchCount: 50,
filesSkipped: 10,
}),
100,
);
expect(out.summary).toContain('candidate files');
});

test('flushReason timer when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_TIMER_EXPIRED',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('streaming timer');
});

test('flushReason max size when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_MAX_SIZE',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('size limit');
});
65 changes: 65 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import type { SearchStats } from './types';

/** Values from zoekt `FlushReason` (grpc string enum names). */
const FLUSH_REASON_TIMER_EXPIRED = 'FLUSH_REASON_TIMER_EXPIRED';
const FLUSH_REASON_MAX_SIZE = 'FLUSH_REASON_MAX_SIZE';

/**
* User-facing copy when Zoekt returned a non-exhaustive search (more matches may exist
* than were returned or scanned).
*
* @see https://github.com/sourcebot-dev/sourcebot/issues/504
*/
export function getSearchLimitExplanation(
stats: SearchStats | undefined,
maxMatchDisplayCount: number,
): { summary: string; detail?: string } {
if (!stats) {
return {
summary: 'Results may be incomplete.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}

if (stats.shardsSkipped > 0) {
return {
summary: 'Search did not scan the entire index.',
detail: 'One or more index shards were skipped (often because the search hit a time limit). Additional matches may exist.',
};
}

if (stats.flushReason === FLUSH_REASON_TIMER_EXPIRED) {
return {
summary: 'Results were flushed early due to a streaming timer.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.flushReason === FLUSH_REASON_MAX_SIZE) {
return {
summary: 'Intermediate result set reached its size limit.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.totalMatchCount > maxMatchDisplayCount) {
return {
summary: 'More matches exist than are shown.',
detail: `The index reported ${stats.totalMatchCount} matches, but this request only returns up to ${maxMatchDisplayCount}. Use “load more” or raise the match limit.`,
};
}

if (stats.filesSkipped > 0) {
return {
summary: 'Some candidate files were not fully searched.',
detail: 'The engine stopped after finding enough matches (per-shard or total limits). Additional matches may exist.',
};
}

// Defensive fallback: non-exhaustive searches should usually hit a branch above
// (e.g. totalMatchCount vs display cap, skipped shards/files, or flush reason).
return {
summary: 'More matches may exist than are shown.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}
24 changes: 22 additions & 2 deletions packages/web/src/features/search/zoektSearcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,11 +133,21 @@ export const zoektSearch = async (searchRequest: ZoektGrpcSearchRequest, prisma:
const reposMapCache = await createReposMapForChunk(response, new Map<string | number, Repo>(), prisma);
const { stats, files, repositoryInfo } = await transformZoektSearchResponse(response, reposMapCache);

const isSearchExhaustive = stats.totalMatchCount <= stats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: stats.totalMatchCount,
actualMatchCount: stats.actualMatchCount,
flushReason: stats.flushReason,
shardsSkipped: stats.shardsSkipped,
filesSkipped: stats.filesSkipped,
});
}
resolve({
stats,
files,
repositoryInfo,
isSearchExhaustive: stats.totalMatchCount <= stats.actualMatchCount,
isSearchExhaustive,
} satisfies SearchResponse);
} catch (err) {
reject(err);
Expand DownExpand Up@@ -180,10 +190,20 @@ export const zoektStreamSearch = async (searchRequest: ZoektGrpcSearchRequest, p
async start(controller) {
const tryCloseController = () => {
if (!isStreamActive && pendingChunks === 0) {
const isSearchExhaustive = accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: accumulatedStats.totalMatchCount,
actualMatchCount: accumulatedStats.actualMatchCount,
flushReason: accumulatedStats.flushReason,
shardsSkipped: accumulatedStats.shardsSkipped,
filesSkipped: accumulatedStats.filesSkipped,
});
}
const finalResponse: StreamedSearchResponse = {
type: 'final',
accumulatedStats,
isSearchExhaustive: accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount,
isSearchExhaustive,
}

controller.enqueue(encodeSSEREsponseChunk(finalResponse));
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)#1098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
h30s wants to merge 2 commits into from
Closed

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504) #1098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1ea7f
feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)
h30s Apr 8, 2026
44a787a
fix(web): avoid bundling search API in client; address review
h30s Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Search results show an informational alert when a query may be incomplete (for example due to match limits, skipped index shards, or streaming flush), and non-exhaustive Zoekt searches are logged for operators. [#1098](https://github.com/sourcebot-dev/sourcebot/pull/1098)
- Linear issue links in chat responses now render as a rich card-style UI showing the Linear logo, issue identifier, and title instead of plain hyperlinks. [#1060](https://github.com/sourcebot-dev/sourcebot/pull/1060)

### Changed
Expand Down
27 changes: 26 additions & 1 deletion packages/web/src/app/(app)/search/components/searchResultsPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,9 @@ import {
} from "@/components/ui/resizable";
import { Separator } from "@/components/ui/separator";
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
import { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search";
import { getSearchLimitExplanation } from "@/features/search/searchLimitExplanation";
import type { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search/types";
import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
import useCaptureEvent from "@/hooks/useCaptureEvent";
import { useNonEmptyQueryParam } from "@/hooks/useNonEmptyQueryParam";
import { useSearchHistory } from "@/hooks/useSearchHistory";
Expand DownExpand Up@@ -205,6 +207,7 @@ export const SearchResultsPage = ({
searchStats={stats}
isMoreResultsButtonVisible={!isExhaustive}
isBranchFilteringEnabled={isBranchFilteringEnabled}
maxMatchDisplayCount={maxMatchCount}
/>
)}
</div>
Expand All@@ -221,6 +224,7 @@ interface PanelGroupProps {
searchDurationMs: number;
numMatches: number;
searchStats?: SearchStats;
maxMatchDisplayCount: number;
}

const PanelGroup = ({
Expand All@@ -233,6 +237,7 @@ const PanelGroup = ({
searchDurationMs: _searchDurationMs,
numMatches,
searchStats,
maxMatchDisplayCount,
}: PanelGroupProps) => {
const [previewedFile, setPreviewedFile] = useState<SearchResultFile | undefined>(undefined);
const filteredFileMatches = useFilteredMatches(fileMatches);
Expand All@@ -258,6 +263,13 @@ const PanelGroup = ({
return Math.round(_searchDurationMs);
}, [_searchDurationMs]);

const limitExplanation = useMemo(() => {
if (isStreaming || !isMoreResultsButtonVisible) {
return null;
}
return getSearchLimitExplanation(searchStats, maxMatchDisplayCount);
}, [isStreaming, isMoreResultsButtonVisible, searchStats, maxMatchDisplayCount]);

return (
<ResizablePanelGroup
direction="horizontal"
Expand DownExpand Up@@ -368,6 +380,19 @@ const PanelGroup = ({
</>
)}
</div>
{limitExplanation && (
<div className="px-2 pb-2 shrink-0">
<Alert variant="default" className="border-amber-200/80 bg-amber-50/80 dark:border-amber-900/50 dark:bg-amber-950/40">
<AlertTriangleIcon className="text-amber-700 dark:text-amber-500" />
<AlertTitle className="text-amber-950 dark:text-amber-100">{limitExplanation.summary}</AlertTitle>
{limitExplanation.detail && (
<AlertDescription className="text-amber-900/90 dark:text-amber-200/90">
{limitExplanation.detail}
</AlertDescription>
)}
</Alert>
</div>
)}
<div className="flex-1 min-h-0">
{filteredFileMatches.length > 0 ? (
<SearchResultsPanel
Expand Down
6 changes: 5 additions & 1 deletion packages/web/src/app/(app)/search/useStreamedSearch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
'use client';

import { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search';
import type { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search/types';
import { ServiceErrorException } from '@/lib/serviceError';
import { isServiceError } from '@/lib/utils';
import * as Sentry from '@sentry/nextjs';
Expand All@@ -14,6 +14,7 @@ interface CacheEntry {
timeToFirstSearchResultMs: number;
timestamp: number;
isExhaustive: boolean;
stats?: SearchStats;
}

const searchCache = new Map<string, CacheEntry>();
Expand DownExpand Up@@ -101,6 +102,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: cachedEntry.timeToSearchCompletionMs,
timeToFirstSearchResultMs: cachedEntry.timeToFirstSearchResultMs,
numMatches: cachedEntry.numMatches,
stats: cachedEntry.stats,
});
return;
}
Expand All@@ -114,6 +116,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: 0,
timeToFirstSearchResultMs: 0,
numMatches: 0,
stats: undefined,
});

try {
Expand DownExpand Up@@ -242,6 +245,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToFirstSearchResultMs: prev.timeToFirstSearchResultMs,
timeToSearchCompletionMs,
timestamp: Date.now(),
stats: prev.stats,
});
return {
...prev,
Expand Down
3 changes: 2 additions & 1 deletion packages/web/src/features/search/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,5 @@ export type {
StreamedSearchResponse,
SearchResultChunk,
SearchResponse,
} from './types';
} from './types';
export { getSearchLimitExplanation } from './searchLimitExplanation';
95 changes: 95 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
import { expect, test } from 'vitest';
import type { SearchStats } from './types';
import { getSearchLimitExplanation } from './searchLimitExplanation';

function stats(overrides: Partial<SearchStats>): SearchStats {
return {
actualMatchCount: 10,
totalMatchCount: 10,
duration: 0,
fileCount: 1,
filesSkipped: 0,
contentBytesLoaded: 0,
indexBytesLoaded: 0,
crashes: 0,
shardFilesConsidered: 0,
filesConsidered: 0,
filesLoaded: 0,
shardsScanned: 1,
shardsSkipped: 0,
shardsSkippedFilter: 0,
ngramMatches: 0,
ngramLookups: 0,
wait: 0,
matchTreeConstruction: 0,
matchTreeSearch: 0,
regexpsConsidered: 0,
flushReason: 'FLUSH_REASON_UNKNOWN_UNSPECIFIED',
...overrides,
};
}

test('missing stats yields generic incomplete message', () => {
const out = getSearchLimitExplanation(undefined, 100);
expect(out.summary).toContain('incomplete');
});

test('shardsSkipped takes precedence (time limit / partial scan)', () => {
const out = getSearchLimitExplanation(
stats({
shardsSkipped: 2,
totalMatchCount: 500,
filesSkipped: 99,
}),
100,
);
expect(out.summary).toContain('did not scan the entire index');
});

test('totalMatchCount above display cap explains match budget', () => {
const out = getSearchLimitExplanation(
stats({
actualMatchCount: 100,
totalMatchCount: 250,
}),
100,
);
expect(out.summary).toContain('More matches exist');
expect(out.detail).toContain('250');
});

test('filesSkipped without shard skip explains early stop', () => {
const out = getSearchLimitExplanation(
stats({
totalMatchCount: 50,
actualMatchCount: 50,
filesSkipped: 10,
}),
100,
);
expect(out.summary).toContain('candidate files');
});

test('flushReason timer when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_TIMER_EXPIRED',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('streaming timer');
});

test('flushReason max size when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_MAX_SIZE',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('size limit');
});
65 changes: 65 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import type { SearchStats } from './types';

/** Values from zoekt `FlushReason` (grpc string enum names). */
const FLUSH_REASON_TIMER_EXPIRED = 'FLUSH_REASON_TIMER_EXPIRED';
const FLUSH_REASON_MAX_SIZE = 'FLUSH_REASON_MAX_SIZE';

/**
* User-facing copy when Zoekt returned a non-exhaustive search (more matches may exist
* than were returned or scanned).
*
* @see https://github.com/sourcebot-dev/sourcebot/issues/504
*/
export function getSearchLimitExplanation(
stats: SearchStats | undefined,
maxMatchDisplayCount: number,
): { summary: string; detail?: string } {
if (!stats) {
return {
summary: 'Results may be incomplete.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}

if (stats.shardsSkipped > 0) {
return {
summary: 'Search did not scan the entire index.',
detail: 'One or more index shards were skipped (often because the search hit a time limit). Additional matches may exist.',
};
}

if (stats.flushReason === FLUSH_REASON_TIMER_EXPIRED) {
return {
summary: 'Results were flushed early due to a streaming timer.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.flushReason === FLUSH_REASON_MAX_SIZE) {
return {
summary: 'Intermediate result set reached its size limit.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.totalMatchCount > maxMatchDisplayCount) {
return {
summary: 'More matches exist than are shown.',
detail: `The index reported ${stats.totalMatchCount} matches, but this request only returns up to ${maxMatchDisplayCount}. Use “load more” or raise the match limit.`,
};
}

if (stats.filesSkipped > 0) {
return {
summary: 'Some candidate files were not fully searched.',
detail: 'The engine stopped after finding enough matches (per-shard or total limits). Additional matches may exist.',
};
}

// Defensive fallback: non-exhaustive searches should usually hit a branch above
// (e.g. totalMatchCount vs display cap, skipped shards/files, or flush reason).
return {
summary: 'More matches may exist than are shown.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}
24 changes: 22 additions & 2 deletions packages/web/src/features/search/zoektSearcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,11 +133,21 @@ export const zoektSearch = async (searchRequest: ZoektGrpcSearchRequest, prisma:
const reposMapCache = await createReposMapForChunk(response, new Map<string | number, Repo>(), prisma);
const { stats, files, repositoryInfo } = await transformZoektSearchResponse(response, reposMapCache);

const isSearchExhaustive = stats.totalMatchCount <= stats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: stats.totalMatchCount,
actualMatchCount: stats.actualMatchCount,
flushReason: stats.flushReason,
shardsSkipped: stats.shardsSkipped,
filesSkipped: stats.filesSkipped,
});
}
resolve({
stats,
files,
repositoryInfo,
isSearchExhaustive: stats.totalMatchCount <= stats.actualMatchCount,
isSearchExhaustive,
} satisfies SearchResponse);
} catch (err) {
reject(err);
Expand DownExpand Up@@ -180,10 +190,20 @@ export const zoektStreamSearch = async (searchRequest: ZoektGrpcSearchRequest, p
async start(controller) {
const tryCloseController = () => {
if (!isStreamActive && pendingChunks === 0) {
const isSearchExhaustive = accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: accumulatedStats.totalMatchCount,
actualMatchCount: accumulatedStats.actualMatchCount,
flushReason: accumulatedStats.flushReason,
shardsSkipped: accumulatedStats.shardsSkipped,
filesSkipped: accumulatedStats.filesSkipped,
});
}
const finalResponse: StreamedSearchResponse = {
type: 'final',
accumulatedStats,
isSearchExhaustive: accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount,
isSearchExhaustive,
}

controller.enqueue(encodeSSEREsponseChunk(finalResponse));
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)#1098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
h30s wants to merge 2 commits into from
Closed

feat(search): surface Zoekt non-exhaustive results in UI and logs (#504) #1098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1ea7f
feat(search): surface Zoekt non-exhaustive results in UI and logs (#504)
h30s Apr 8, 2026
44a787a
fix(web): avoid bundling search API in client; address review
h30s Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Search results show an informational alert when a query may be incomplete (for example due to match limits, skipped index shards, or streaming flush), and non-exhaustive Zoekt searches are logged for operators. [#1098](https://github.com/sourcebot-dev/sourcebot/pull/1098)
- Linear issue links in chat responses now render as a rich card-style UI showing the Linear logo, issue identifier, and title instead of plain hyperlinks. [#1060](https://github.com/sourcebot-dev/sourcebot/pull/1060)

### Changed
Expand Down
27 changes: 26 additions & 1 deletion packages/web/src/app/(app)/search/components/searchResultsPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,9 @@ import {
} from "@/components/ui/resizable";
import { Separator } from "@/components/ui/separator";
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
import { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search";
import { getSearchLimitExplanation } from "@/features/search/searchLimitExplanation";
import type { RepositoryInfo, SearchResultFile, SearchStats } from "@/features/search/types";
import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
import useCaptureEvent from "@/hooks/useCaptureEvent";
import { useNonEmptyQueryParam } from "@/hooks/useNonEmptyQueryParam";
import { useSearchHistory } from "@/hooks/useSearchHistory";
Expand DownExpand Up@@ -205,6 +207,7 @@ export const SearchResultsPage = ({
searchStats={stats}
isMoreResultsButtonVisible={!isExhaustive}
isBranchFilteringEnabled={isBranchFilteringEnabled}
maxMatchDisplayCount={maxMatchCount}
/>
)}
</div>
Expand All@@ -221,6 +224,7 @@ interface PanelGroupProps {
searchDurationMs: number;
numMatches: number;
searchStats?: SearchStats;
maxMatchDisplayCount: number;
}

const PanelGroup = ({
Expand All@@ -233,6 +237,7 @@ const PanelGroup = ({
searchDurationMs: _searchDurationMs,
numMatches,
searchStats,
maxMatchDisplayCount,
}: PanelGroupProps) => {
const [previewedFile, setPreviewedFile] = useState<SearchResultFile | undefined>(undefined);
const filteredFileMatches = useFilteredMatches(fileMatches);
Expand All@@ -258,6 +263,13 @@ const PanelGroup = ({
return Math.round(_searchDurationMs);
}, [_searchDurationMs]);

const limitExplanation = useMemo(() => {
if (isStreaming || !isMoreResultsButtonVisible) {
return null;
}
return getSearchLimitExplanation(searchStats, maxMatchDisplayCount);
}, [isStreaming, isMoreResultsButtonVisible, searchStats, maxMatchDisplayCount]);

return (
<ResizablePanelGroup
direction="horizontal"
Expand DownExpand Up@@ -368,6 +380,19 @@ const PanelGroup = ({
</>
)}
</div>
{limitExplanation && (
<div className="px-2 pb-2 shrink-0">
<Alert variant="default" className="border-amber-200/80 bg-amber-50/80 dark:border-amber-900/50 dark:bg-amber-950/40">
<AlertTriangleIcon className="text-amber-700 dark:text-amber-500" />
<AlertTitle className="text-amber-950 dark:text-amber-100">{limitExplanation.summary}</AlertTitle>
{limitExplanation.detail && (
<AlertDescription className="text-amber-900/90 dark:text-amber-200/90">
{limitExplanation.detail}
</AlertDescription>
)}
</Alert>
</div>
)}
<div className="flex-1 min-h-0">
{filteredFileMatches.length > 0 ? (
<SearchResultsPanel
Expand Down
6 changes: 5 additions & 1 deletion packages/web/src/app/(app)/search/useStreamedSearch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
'use client';

import { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search';
import type { RepositoryInfo, SearchRequest, SearchResultFile, SearchStats, StreamedSearchResponse } from '@/features/search/types';
import { ServiceErrorException } from '@/lib/serviceError';
import { isServiceError } from '@/lib/utils';
import * as Sentry from '@sentry/nextjs';
Expand All@@ -14,6 +14,7 @@ interface CacheEntry {
timeToFirstSearchResultMs: number;
timestamp: number;
isExhaustive: boolean;
stats?: SearchStats;
}

const searchCache = new Map<string, CacheEntry>();
Expand DownExpand Up@@ -101,6 +102,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: cachedEntry.timeToSearchCompletionMs,
timeToFirstSearchResultMs: cachedEntry.timeToFirstSearchResultMs,
numMatches: cachedEntry.numMatches,
stats: cachedEntry.stats,
});
return;
}
Expand All@@ -114,6 +116,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToSearchCompletionMs: 0,
timeToFirstSearchResultMs: 0,
numMatches: 0,
stats: undefined,
});

try {
Expand DownExpand Up@@ -242,6 +245,7 @@ export const useStreamedSearch = ({ query, matches, contextLines, whole, isRegex
timeToFirstSearchResultMs: prev.timeToFirstSearchResultMs,
timeToSearchCompletionMs,
timestamp: Date.now(),
stats: prev.stats,
});
return {
...prev,
Expand Down
3 changes: 2 additions & 1 deletion packages/web/src/features/search/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,5 @@ export type {
StreamedSearchResponse,
SearchResultChunk,
SearchResponse,
} from './types';
} from './types';
export { getSearchLimitExplanation } from './searchLimitExplanation';
95 changes: 95 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
import { expect, test } from 'vitest';
import type { SearchStats } from './types';
import { getSearchLimitExplanation } from './searchLimitExplanation';

function stats(overrides: Partial<SearchStats>): SearchStats {
return {
actualMatchCount: 10,
totalMatchCount: 10,
duration: 0,
fileCount: 1,
filesSkipped: 0,
contentBytesLoaded: 0,
indexBytesLoaded: 0,
crashes: 0,
shardFilesConsidered: 0,
filesConsidered: 0,
filesLoaded: 0,
shardsScanned: 1,
shardsSkipped: 0,
shardsSkippedFilter: 0,
ngramMatches: 0,
ngramLookups: 0,
wait: 0,
matchTreeConstruction: 0,
matchTreeSearch: 0,
regexpsConsidered: 0,
flushReason: 'FLUSH_REASON_UNKNOWN_UNSPECIFIED',
...overrides,
};
}

test('missing stats yields generic incomplete message', () => {
const out = getSearchLimitExplanation(undefined, 100);
expect(out.summary).toContain('incomplete');
});

test('shardsSkipped takes precedence (time limit / partial scan)', () => {
const out = getSearchLimitExplanation(
stats({
shardsSkipped: 2,
totalMatchCount: 500,
filesSkipped: 99,
}),
100,
);
expect(out.summary).toContain('did not scan the entire index');
});

test('totalMatchCount above display cap explains match budget', () => {
const out = getSearchLimitExplanation(
stats({
actualMatchCount: 100,
totalMatchCount: 250,
}),
100,
);
expect(out.summary).toContain('More matches exist');
expect(out.detail).toContain('250');
});

test('filesSkipped without shard skip explains early stop', () => {
const out = getSearchLimitExplanation(
stats({
totalMatchCount: 50,
actualMatchCount: 50,
filesSkipped: 10,
}),
100,
);
expect(out.summary).toContain('candidate files');
});

test('flushReason timer when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_TIMER_EXPIRED',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('streaming timer');
});

test('flushReason max size when no higher-priority signal', () => {
const out = getSearchLimitExplanation(
stats({
flushReason: 'FLUSH_REASON_MAX_SIZE',
totalMatchCount: 10,
actualMatchCount: 10,
}),
100,
);
expect(out.summary).toContain('size limit');
});
65 changes: 65 additions & 0 deletions packages/web/src/features/search/searchLimitExplanation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
import type { SearchStats } from './types';

/** Values from zoekt `FlushReason` (grpc string enum names). */
const FLUSH_REASON_TIMER_EXPIRED = 'FLUSH_REASON_TIMER_EXPIRED';
const FLUSH_REASON_MAX_SIZE = 'FLUSH_REASON_MAX_SIZE';

/**
* User-facing copy when Zoekt returned a non-exhaustive search (more matches may exist
* than were returned or scanned).
*
* @see https://github.com/sourcebot-dev/sourcebot/issues/504
*/
export function getSearchLimitExplanation(
stats: SearchStats | undefined,
maxMatchDisplayCount: number,
): { summary: string; detail?: string } {
if (!stats) {
return {
summary: 'Results may be incomplete.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}

if (stats.shardsSkipped > 0) {
return {
summary: 'Search did not scan the entire index.',
detail: 'One or more index shards were skipped (often because the search hit a time limit). Additional matches may exist.',
};
}

if (stats.flushReason === FLUSH_REASON_TIMER_EXPIRED) {
return {
summary: 'Results were flushed early due to a streaming timer.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.flushReason === FLUSH_REASON_MAX_SIZE) {
return {
summary: 'Intermediate result set reached its size limit.',
detail: 'Try narrowing your query or increasing limits.',
};
}

if (stats.totalMatchCount > maxMatchDisplayCount) {
return {
summary: 'More matches exist than are shown.',
detail: `The index reported ${stats.totalMatchCount} matches, but this request only returns up to ${maxMatchDisplayCount}. Use “load more” or raise the match limit.`,
};
}

if (stats.filesSkipped > 0) {
return {
summary: 'Some candidate files were not fully searched.',
detail: 'The engine stopped after finding enough matches (per-shard or total limits). Additional matches may exist.',
};
}

// Defensive fallback: non-exhaustive searches should usually hit a branch above
// (e.g. totalMatchCount vs display cap, skipped shards/files, or flush reason).
return {
summary: 'More matches may exist than are shown.',
detail: 'Increase the match limit, narrow your query, or scope to a repository.',
};
}
24 changes: 22 additions & 2 deletions packages/web/src/features/search/zoektSearcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,11 +133,21 @@ export const zoektSearch = async (searchRequest: ZoektGrpcSearchRequest, prisma:
const reposMapCache = await createReposMapForChunk(response, new Map<string | number, Repo>(), prisma);
const { stats, files, repositoryInfo } = await transformZoektSearchResponse(response, reposMapCache);

const isSearchExhaustive = stats.totalMatchCount <= stats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: stats.totalMatchCount,
actualMatchCount: stats.actualMatchCount,
flushReason: stats.flushReason,
shardsSkipped: stats.shardsSkipped,
filesSkipped: stats.filesSkipped,
});
}
resolve({
stats,
files,
repositoryInfo,
isSearchExhaustive: stats.totalMatchCount <= stats.actualMatchCount,
isSearchExhaustive,
} satisfies SearchResponse);
} catch (err) {
reject(err);
Expand DownExpand Up@@ -180,10 +190,20 @@ export const zoektStreamSearch = async (searchRequest: ZoektGrpcSearchRequest, p
async start(controller) {
const tryCloseController = () => {
if (!isStreamActive && pendingChunks === 0) {
const isSearchExhaustive = accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount;
if (!isSearchExhaustive) {
logger.info('Zoekt search finished with non-exhaustive results', {
totalMatchCount: accumulatedStats.totalMatchCount,
actualMatchCount: accumulatedStats.actualMatchCount,
flushReason: accumulatedStats.flushReason,
shardsSkipped: accumulatedStats.shardsSkipped,
filesSkipped: accumulatedStats.filesSkipped,
});
}
const finalResponse: StreamedSearchResponse = {
type: 'final',
accumulatedStats,
isSearchExhaustive: accumulatedStats.totalMatchCount <= accumulatedStats.actualMatchCount,
isSearchExhaustive,
}

controller.enqueue(encodeSSEREsponseChunk(finalResponse));
Expand Down
Loading