GitNexus/gitnexus/test/unit/native-check-probe.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

162 lines
5.7 KiB
TypeScript

import path from 'node:path';
import { describe, it, expect, vi, beforeEach } from 'vitest';
/**
* Unit coverage for probeFtsExtensionLoad (#2374, PR #2375): the doctor FTS
* probe's outcomes without the real native module or network. @ladybugdb/core
* is mocked so query behavior (resolve / reject / never-settle) is controlled
* per test, and the timeout is exercised with a tiny injected budget.
*/
const h = vi.hoisted(() => ({
query: vi.fn<(sql: string) => Promise<unknown>>(),
connCtor: vi.fn<() => void>(),
connClose: vi.fn<() => Promise<void>>(async () => undefined),
dbClose: vi.fn<() => Promise<void>>(async () => undefined),
}));
vi.mock('@ladybugdb/core', () => {
class Database {
constructor(_path: string) {}
close = h.dbClose;
}
class Connection {
constructor(_db: unknown) {
h.connCtor();
}
query = h.query;
close = h.connClose;
}
return { default: { Database, Connection } };
});
import {
ftsAvailabilityLabel,
probeFtsExtensionLoad,
probeVectorExtensionLoad,
} from '../../src/core/lbug/native-check.js';
const closeable = () => ({ close: vi.fn() });
beforeEach(() => {
h.query.mockReset();
h.connCtor.mockReset();
h.connClose.mockClear();
h.dbClose.mockClear();
});
describe('probeFtsExtensionLoad (#2374)', () => {
it('reports loaded and closes every result when LOAD succeeds (array result)', async () => {
const results = [closeable(), closeable()];
h.query.mockResolvedValue(results);
await expect(probeFtsExtensionLoad()).resolves.toEqual({ loaded: true });
expect(results.map((r) => r.close.mock.calls.length)).toEqual([1, 1]);
expect(h.connClose).toHaveBeenCalled();
expect(h.dbClose).toHaveBeenCalled();
});
it('reports loaded for a single (non-array) result', async () => {
h.query.mockResolvedValue(closeable());
await expect(probeFtsExtensionLoad()).resolves.toEqual({ loaded: true });
});
it('reports the collapsed reason when LOAD fails', async () => {
h.query.mockRejectedValue(new Error('IO exception:\n invalid ELF header'));
await expect(probeFtsExtensionLoad()).resolves.toMatchObject({
loaded: false,
reason: 'IO exception: invalid ELF header',
});
});
it('times out instead of hanging when the native call never settles', async () => {
h.query.mockReturnValue(new Promise<unknown>(() => undefined));
await expect(probeFtsExtensionLoad(20)).resolves.toMatchObject({
loaded: false,
reason: expect.stringContaining('timed out'),
});
});
it('still closes the db when the Connection ctor throws', async () => {
h.connCtor.mockImplementation(() => {
throw new Error('connection ctor failed');
});
await expect(probeFtsExtensionLoad()).resolves.toMatchObject({ loaded: false });
expect(h.dbClose).toHaveBeenCalled();
});
it('reports loaded even when a result close() throws', async () => {
h.query.mockResolvedValue({
close: () => {
throw new Error('close boom');
},
});
await expect(probeFtsExtensionLoad()).resolves.toEqual({ loaded: true });
});
it('reports suppressed-by-policy under never without issuing LOAD', async () => {
await expect(probeFtsExtensionLoad(undefined, { policy: 'never' })).resolves.toEqual({
loaded: false,
suppressed: true,
reason: 'suppressed by policy GITNEXUS_LBUG_EXTENSION_INSTALL=never',
});
expect(h.query).not.toHaveBeenCalled();
expect(ftsAvailabilityLabel({ loaded: false, suppressed: true })).toBe('suppressed');
});
it('tries a vendored path LOAD before the name-only LOAD', async () => {
h.query.mockResolvedValue(closeable());
const vendoredPath = '/tmp/gn-fts-vendor/libfts.lbug_extension';
await expect(
probeFtsExtensionLoad(undefined, { vendoredPath, policy: 'load-only' }),
).resolves.toEqual({ loaded: true });
expect(h.query).toHaveBeenCalledWith(`LOAD EXTENSION '${path.resolve(vendoredPath)}'`);
expect(h.query).not.toHaveBeenCalledWith('LOAD EXTENSION fts');
});
it('falls back to name-only LOAD when the vendored path LOAD fails', async () => {
const vendoredPath = '/tmp/gn-fts-vendor/libfts.lbug_extension';
h.query
.mockRejectedValueOnce(new Error('IO exception: missing vendored file'))
.mockResolvedValueOnce(closeable());
await expect(
probeFtsExtensionLoad(undefined, {
vendoredPath,
policy: 'load-only',
}),
).resolves.toEqual({ loaded: true });
expect(h.query).toHaveBeenNthCalledWith(1, `LOAD EXTENSION '${path.resolve(vendoredPath)}'`);
expect(h.query).toHaveBeenNthCalledWith(2, 'LOAD EXTENSION fts');
});
});
describe('probeVectorExtensionLoad (#2623 follow-up)', () => {
it('issues LOAD EXTENSION vector and reports loaded on success — no platform short-circuit', async () => {
h.query.mockResolvedValue(closeable());
await expect(probeVectorExtensionLoad()).resolves.toEqual({ loaded: true });
// The probe must really attempt the LOAD (the old code refused Windows
// before ever touching the engine; the artifact ships for win_amd64 too).
expect(h.query).toHaveBeenCalledWith('LOAD EXTENSION vector');
});
it('reports the collapsed reason when LOAD fails', async () => {
h.query.mockRejectedValue(new Error('IO exception:\n extension file not found'));
await expect(probeVectorExtensionLoad()).resolves.toMatchObject({
loaded: false,
reason: 'IO exception: extension file not found',
});
});
it('times out instead of hanging when the native call never settles', async () => {
h.query.mockReturnValue(new Promise<unknown>(() => undefined));
await expect(probeVectorExtensionLoad(20)).resolves.toMatchObject({
loaded: false,
reason: expect.stringContaining('timed out'),
});
});
});