GitNexus/gitnexus/test/unit/fts-degraded-warning.test.ts
Gergő Magyar 21a52af1d4
fix(lbug): ship FTS per-platform and recover in-place native aborts (#3274)
* fix(lbug): pin Ladybug core so Dependabot cannot ship a skewed FTS artifact

The extension version is a separate upstream constant. Ignore daily core bumps and fail the pairing gate when the committed manifest does not name the installed core.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): make doctor and CI FTS gates resolve the packaged artifact

Doctor and the REQUIRE_FTS file gates still treated an empty ~/.lbdb as
unavailable, which would turn three CI jobs red once analyze stops
installing into that tree.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): name native-abort and tuple-missing so analyze cannot mis-advise

The CLI summary's trailing else treated every unknown skip reason as a
missing extension. New crash and platform causes must get their own
remedies, not a network-install hint.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): delete the dead read-path FTS index create

ensureFTSIndex had no production callers and swallowed read-only
CREATE_FTS_INDEX failures, which hid the only signal that a reader
tried to write.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): vendor per-platform FTS artifacts so analyze needs no host install

Keyword search depended on a CDN fetch into ~/.lbdb. Shipping the five
published tuples inside the package makes air-gapped and ignore-scripts
installs load the same artifact the publish gate checksums.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): load the packaged FTS artifact before any network install

Analyze still required a CDN fetch into ~/.lbdb even when the package
already shipped the file. FTS now path-loads the vendored tuple first
and records source labels so a later truncated home copy cannot steal
the diagnosis.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): diagnose a core/extension version skew instead of a missing runtime

A structurally valid FTS artifact whose path version disagrees with the
packaged pin must name both versions, not prescribe VC++ or OpenSSL.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): stamp an FTS phase so repair stays usable after an in-place abort

A native CREATE_FTS_INDEX abort leaves no skip reason; the next run infers
it from the dirty flag, and --repair-fts must not treat that phase as a
half-written graph.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): park an in-place FTS crash WAL without wiping the graph

An FTS abort after a successful checkpoint must reopen the live index on
macOS, Windows, and Linux. Staging never parks the live WAL; readers keep
today's large-WAL refusal.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): refuse read-only opens of an FTS-poisoned WAL

MCP and serve cannot repair a leftover in-place abort. Fail before the
native open and name --repair-fts, on macOS, Windows, and Linux.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): name a vendor-neutral Windows OpenSSL prerequisite

OQ1 is unanswered here so GitNexus does not ship OpenSSL DLLs. Windows
FTS now asks for a system OpenSSL 3 runtime instead of Git Bash PATH.

Co-authored-by: Cursor <cursoragent@cursor.com>

* test(lbug): inject the FTS vendor root and redact it on HTTP and MCP

Path-loaded artifacts no longer vary with HOME. Tests pass an injected
vendor tree and assert search warnings never leak a filesystem path.

Co-authored-by: Cursor <cursoragent@cursor.com>

* docs(lbug): document load-only as the global FTS install default

Analyze still overrides to auto. Packaged per-platform artifacts load
before any network install on macOS, Windows, and Linux.

Co-authored-by: Cursor <cursoragent@cursor.com>

* docs(lbug): format the FTS install-policy README table

Prettier does not run on Markdown in pre-commit, so the U10 table wrap
needs its own formatting commit.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): skip FTS CREATE after a persisted native abort

A recovered analyze run was retrying CREATE_FTS_INDEX from skipReason
alone. Keep that skip until --repair-fts, fail closed on unsupported
tuples, and honor the checkpoint warrant for park/repair.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): honor checkpoint flushed warrant and align FTS tests with packaged vendor

A no-op CHECKPOINT must not satisfy the FTS park warrant, and CI still asserted HOME-only FTS isolation after analyze started path-LOADing the packaged artifact.

Co-authored-by: Cursor <cursoragent@cursor.com>

* test(lbug): accept a nonempty incremental write set in the #2790 recovery check

FTS-phase recovery can incremental-add files (changed=0, added=1). That is not the #2790 empty-diff wipe skip.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): compare FTS home versions to the core pin and tighten the publish filename gate

Ladybug's ~/.lbdb/extension directory is the runtime/core version; treating it as the artifact version false-diagnosed skew. The publish guard now rejects a path-escaping filename the same way the fetch script does.

Co-authored-by: Cursor <cursoragent@cursor.com>

* test(lbug): seed FTS e2e fixtures from the packaged vendor artifact

A machine with no ~/.lbdb copy should still run the vendor-survivorship cases; the seed no longer depends on HOME or a network install.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Address PR review feedback (#3274)

Keep in-place FTS abort evidence after persist so a second CREATE abort
cannot fail-open readers, and close the CLI, loader, embed, and e2e gaps
the review called out.

Note: full npm test hit Ladybug worker-pool startup failures under memory
pressure; tsc and 180 targeted unit tests passed.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Address PR review feedback (#3274)

Run the vendored-path symlink guard on the OS matrix, put e2e HOME
fixtures on Ladybug's real extension layout, pin the embed crash-WAL
gate before the writable open, and let analyze writers park through
missing-shadow recovery.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lbug): keep --repair-fts CI green after vendored-first FTS

Never-installed warning fixtures must not inspect a packaged vendor binary, and a failed dirty restamp must not abort an otherwise successful --repair-fts run.

Co-authored-by: Cursor <cursoragent@cursor.com>

* test(cli): give the #1169 analyze e2e the same 90s Windows budget as its sibling

The first #1169 persist-meta case was still on a 60s spawn/it budget and was killed banner-only on windows-latest after the FTS warning fixture no longer failed the shard first.

Co-authored-by: Cursor <cursoragent@cursor.com>

* test(ci): reweight Windows shards after the FTS e2e grew

Vendored-first HOME fixtures pushed fts-extension-e2e to ~6 minutes on windows-latest, so the old 146s weight packed it with skills-e2e and blew the 20-minute watchdog.

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Gergo Magyar <gergomagyar0@gmail.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-14 08:52:24 +01:00

238 lines
8.5 KiB
TypeScript

import { mkdtempSync, rmSync } from 'node:fs';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { afterEach, describe, expect, it, vi } from 'vitest';
import {
extensionManager,
getExtensionCapabilities,
resetExtensionState,
} from '../../src/core/lbug/extension-loader.js';
import { ftsDegradedWarning } from '../../src/core/search/fts-indexes.js';
afterEach(() => {
resetExtensionState();
});
describe('ftsDegradedWarning (#2374)', () => {
it('reports missing indexes when the FTS extension loaded fine', async () => {
await extensionManager.ensure(vi.fn().mockResolvedValue({}), 'fts', 'FTS', {
policy: 'load-only',
});
expect(ftsDegradedWarning()).toContain('FTS indexes missing');
});
it('reports the live load failure with its reason when the extension cannot load', async () => {
await extensionManager.ensure(
vi.fn().mockRejectedValue(new Error('invalid ELF header.')),
'fts',
'FTS',
{ policy: 'load-only' },
);
const warning = ftsDegradedWarning();
expect(warning).toContain('FTS extension failed to load');
expect(warning).toContain('invalid ELF header');
expect(warning).toContain('gitnexus doctor');
});
it('falls back to the indexes-missing message when no load was attempted in this process', () => {
expect(ftsDegradedWarning()).toContain('FTS indexes missing');
});
it('redacts the absolute extension path from the warning but keeps the error class', async () => {
await extensionManager.ensure(
vi
.fn()
.mockRejectedValue(
new Error(
"Failed to load library '/home/alice/.lbdb/extension/0.18.0/linux_amd64/fts/libfts.lbug_extension': invalid ELF header",
),
),
'fts',
'FTS',
{ policy: 'load-only' },
);
const warning = ftsDegradedWarning();
// The username / home dir / absolute path must not leak to HTTP or MCP clients.
expect(warning).not.toMatch(/\/home\/|\/Users\/|C:\\Users\\/);
// …but the actionable error class survives redaction.
expect(warning).toContain('FTS extension failed to load');
expect(warning).toContain('Failed to load library');
expect(warning).toContain('invalid ELF header');
});
it('redacts Windows-style extension paths too', async () => {
await extensionManager.ensure(
vi
.fn()
.mockRejectedValue(
new Error(
"Failed to load library 'C:\\Users\\bob\\.lbdb\\extension\\0.18.0\\win_amd64\\fts\\libfts.lbug_extension': not a valid Win32 application",
),
),
'fts',
'FTS',
{ policy: 'load-only' },
);
const warning = ftsDegradedWarning();
expect(warning).not.toMatch(/C:\\Users\\/);
expect(warning).toContain('not a valid Win32 application');
});
it('fully redacts a Windows path containing a space in the username (tri-review Residual-3, was only partially redacted)', async () => {
await extensionManager.ensure(
vi
.fn()
.mockRejectedValue(
new Error(
"Failed to load library 'C:\\Users\\alice smith\\.lbdb\\extension\\0.18.0\\win_amd64\\fts\\libfts.lbug_extension': not a valid Win32 application",
),
),
'fts',
'FTS',
{ policy: 'load-only' },
);
const warning = ftsDegradedWarning();
// Neither the drive-letter prefix NOR the tail after the space may leak.
expect(warning).not.toMatch(/C:\\Users\\/);
expect(warning).not.toContain('smith');
expect(warning).not.toContain('alice');
expect(warning).toContain('not a valid Win32 application');
});
it('surfaces the runtime-install remedy, not reinstall, for a Windows missing-dependency error', async () => {
await extensionManager.ensure(
vi
.fn()
.mockRejectedValue(
new Error(
"Failed to load library 'C:\\Users\\bob\\.lbdb\\extension\\0.18.0\\win_amd64\\fts\\libfts.lbug_extension' which is needed by extension: fts. Error: The specified module could not be found.",
),
),
'fts',
'FTS',
{ policy: 'load-only' },
);
const warning = ftsDegradedWarning();
expect(warning).toContain('FTS extension failed to load');
expect(warning).toMatch(/Visual C\+\+/);
expect(warning).toMatch(/vc_redist\.x64\.exe/);
// The old "reinstall with network access" tail must not appear for this class.
expect(warning).not.toMatch(/with network access to reinstall/);
// Absolute path still redacted from the client-facing warning.
expect(warning).not.toMatch(/C:\\Users\\/);
});
it('keeps the reinstall guidance for a never-installed extension', async () => {
// Empty vendor root so named "not installed" is not reclassified against
// a packaged, structurally valid artifact (that path is missing_dependency).
const vendorRoot = mkdtempSync(path.join(tmpdir(), 'gn-fts-empty-vendor-'));
try {
await extensionManager.ensure(
vi
.fn()
.mockRejectedValue(
new Error('Extension "fts" is an official extension and has not been installed.'),
),
'fts',
'FTS',
{ policy: 'load-only', vendorRoot },
);
expect(ftsDegradedWarning()).toContain('--repair-fts');
} finally {
rmSync(vendorRoot, { recursive: true, force: true });
}
});
it('caches the load diagnosis on the capability so the warning does no per-request I/O (#2383 F3)', async () => {
await extensionManager.ensure(
vi
.fn()
.mockRejectedValue(
new Error(
"Failed to load library '/home/alice/.lbdb/extension/0.18.0/linux_amd64/fts/libfts.lbug_extension': The specified module could not be found.",
),
),
'fts',
'FTS',
{ policy: 'load-only' },
);
// The diagnosis is computed ONCE at mark-unavailable time and cached on the
// capability, so ftsDegradedWarning (per-request on /api/search + MCP query)
// reads it instead of re-inspecting the extension file on every call.
const fts = getExtensionCapabilities().find((c) => c.name === 'fts');
expect(fts).toMatchObject({ loaded: false, diagnosis: { kind: 'missing_dependency' } });
expect(ftsDegradedWarning()).toMatch(/Visual C\+\+/);
});
});
describe('ftsDegradedWarning resolved-repo context (#2767)', () => {
it('omits the context suffix entirely when no context is passed (unchanged message)', async () => {
await extensionManager.ensure(vi.fn().mockResolvedValue({}), 'fts', 'FTS', {
policy: 'load-only',
});
expect(ftsDegradedWarning()).toBe(
'FTS indexes missing — keyword search degraded. Run: gitnexus analyze --repair-fts (or gitnexus analyze --force) to rebuild indexes.',
);
});
it('appends the resolved repo name and indexed-at on the indexes-missing branch', async () => {
await extensionManager.ensure(vi.fn().mockResolvedValue({}), 'fts', 'FTS', {
policy: 'load-only',
});
const warning = ftsDegradedWarning({
repoName: 'myrepo',
indexedAt: '2026-07-30T12:00:00.000Z',
});
expect(warning).toContain('FTS indexes missing');
expect(warning).toContain('resolved: myrepo');
expect(warning).toContain('indexed 2026-07-30T12:00:00.000Z');
});
it('includes the branch label when the resolved handle is branch-scoped', async () => {
await extensionManager.ensure(vi.fn().mockResolvedValue({}), 'fts', 'FTS', {
policy: 'load-only',
});
const warning = ftsDegradedWarning({ repoName: 'myrepo', branch: 'feature/x' });
expect(warning).toContain('branch:feature/x');
});
it('never leaks an absolute path via the context suffix', async () => {
await extensionManager.ensure(vi.fn().mockResolvedValue({}), 'fts', 'FTS', {
policy: 'load-only',
});
const warning = ftsDegradedWarning({
repoName: 'myrepo',
lastErrorRedacted: 'connection reset',
});
expect(warning).not.toMatch(/\/home\/|\/Users\/|C:\\Users\\/);
expect(warning).toContain('last error: connection reset');
});
it('also renders the context suffix on the extension-failed-to-load branch', async () => {
await extensionManager.ensure(
vi.fn().mockRejectedValue(new Error('invalid ELF header.')),
'fts',
'FTS',
{ policy: 'load-only' },
);
const warning = ftsDegradedWarning({
repoName: 'myrepo',
indexedAt: '2026-07-30T12:00:00.000Z',
});
expect(warning).toContain('FTS extension failed to load');
expect(warning).toContain('resolved: myrepo');
expect(warning).toContain('indexed 2026-07-30T12:00:00.000Z');
});
});