GitNexus/gitnexus/test/integration/external-storage-content-retention.test.ts
mengkaka 79543c8f83
feat(storage): add configurable index storage and content retention tiers (#3060)
* feat(storage): add configurable index storage and content retention tiers

Rebase #3060 onto current origin/main. Keep GITNEXUS_STORAGE_PATH,
GITNEXUS_STORAGE_ROOT, and GITNEXUS_CONTENT_RETENTION, and fold in
main's FTS skip, embed-session, and help-text updates.

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

* Address PR review feedback (#3060)

Keep legacy registry rows on the local storage fallback, resolve
symlinks before the destructive-path guard, and align hook lookup
with CLI branch slugs, branch-slot metadata, and longest-path match.

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

* Address PR review feedback (#3060)

Only list swept upload directories after a successful removal so
callers cannot treat a permission or transient rm failure as gone.

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

* Address PR review feedback (#3060)

Document that getStoragePath may consult registered storage while
this module still does not mutate the global registry.

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

* fix(storage): close review findings for external indexes and retention

Re-inspect ownership under the analyze lock, fail-closed when the
registry file is missing, and keep skip-git hook discovery plus
retention fields on HTTP/MCP list surfaces. /api/file stays 410
unless contentRetention is full.

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

* chore(autofix): apply prettier + eslint fixes via /autofix command

* Address PR review feedback (#3060)

Treat lock-only index dirs as empty, honor HTTP --force storage policy, and prefer registered plus branch-aware slots in hooks and augment.

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

* Address PR review feedback (#3060)

Keep hook fallbacks inside the current worktree, compare foreign-local slots canonically, and make storage fixtures survive ownership validation.

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

* Fix macOS hook test expecting realpath'd registry paths.

resolveHookRepo returns the written registry path, not a filesystem realpath, so the assertion must match that.

* Address gitnexus-check warnings on hook install docs and slot tests.

The Cursor troubleshooting list omitted registry-query.cjs, and the writable-slot test only checked that isDirectory exists instead of that the path is a directory.

* Align the HTTP catalog source-scan with skippable resolveRepo validation.

resolveRepo lists fresh repos with validate: options.validateStorage !== false so DELETE can skip prune; the test still required a literal validate: true.

* Harden storage path sinks so CodeQL path-injection and ReDoS alerts clear.

Contain every filesystem probe inside the resolved storage slot with the inline path.relative idiom, reject filesystem-root slots, and trim slot basenames in linear time.

* Settle bridge stamps before writing so CI size/mtime matches stay stable.

LadybugDB can still flush into bridge.lbug after close+rename; persist whole-millisecond mtimes and wait for consecutive stats to agree so a freshly written pair matches.

* Type the settled bridge stat as fs.Stats so tsc does not see bigint.

Awaited<ReturnType<typeof fsp.stat>> collapsed the bigint overload and broke prepare/typecheck on CI.

* Keep the bridge mtime stamp exact so same-size swaps still fail the pair check.

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

* Wrap the bridge stamp predicate so prettier --check stays green.

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

* Require a quiet interval before stamping a settled bridge file.

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

* Reuse shared storage and settle helpers instead of local copies.

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

---------

Co-authored-by: Gergo Magyar <gergomagyar0@gmail.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-09-12 20:31:55 +00:00

228 lines
8.6 KiB
TypeScript

import fs from 'fs/promises';
import os from 'os';
import path from 'path';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { runFullAnalysis } from '../../src/core/run-analyze.js';
import { LocalBackend } from '../../src/mcp/local/local-backend.js';
import { statusCommand } from '../../src/cli/status.js';
import { getStoragePaths, loadMeta } from '../../src/storage/repo-manager.js';
import {
STORAGE_PATH_ENV,
STORAGE_ROOT_ENV,
storagePathFromRoot,
} from '../../src/storage/storage-resolver.js';
const savedStoragePath = process.env[STORAGE_PATH_ENV];
const savedStorageRoot = process.env[STORAGE_ROOT_ENV];
const savedRetention = process.env.GITNEXUS_CONTENT_RETENTION;
const savedHome = process.env.GITNEXUS_HOME;
const temporaryPaths: string[] = [];
const makeTempDir = async (prefix: string): Promise<string> => {
const directory = await fs.mkdtemp(path.join(os.tmpdir(), prefix));
temporaryPaths.push(directory);
return directory;
};
const restoreEnvironment = () => {
if (savedStoragePath === undefined) delete process.env[STORAGE_PATH_ENV];
else process.env[STORAGE_PATH_ENV] = savedStoragePath;
if (savedStorageRoot === undefined) delete process.env[STORAGE_ROOT_ENV];
else process.env[STORAGE_ROOT_ENV] = savedStorageRoot;
if (savedRetention === undefined) delete process.env.GITNEXUS_CONTENT_RETENTION;
else process.env.GITNEXUS_CONTENT_RETENTION = savedRetention;
if (savedHome === undefined) delete process.env.GITNEXUS_HOME;
else process.env.GITNEXUS_HOME = savedHome;
};
afterEach(async () => {
restoreEnvironment();
await Promise.all(
temporaryPaths.splice(0).map((directory) => fs.rm(directory, { recursive: true, force: true })),
);
});
const recursiveSize = async (target: string): Promise<number> => {
const stat = await fs.lstat(target);
if (!stat.isDirectory()) return stat.size;
const entries = await fs.readdir(target);
return (
await Promise.all(entries.map((entry) => recursiveSize(path.join(target, entry))))
).reduce((total, size) => total + size, 0);
};
const readGraph = async (lbugPath: string) => {
const adapter = await import('../../src/core/lbug/lbug-adapter.js');
try {
return await adapter.withLbugDb(
lbugPath,
async () => {
const [nodes, edges, files, functions, basicBlocks, basicBlockCount] = await Promise.all([
adapter.executeQuery('MATCH (n) RETURN count(n) AS count'),
adapter.executeQuery(
'MATCH (source)-[r:CodeRelation]->(target) RETURN count(r) AS count',
),
adapter.executeQuery(
"MATCH (n:File) WHERE n.filePath = 'src/fixture.ts' RETURN n.content AS content",
),
adapter.executeQuery(
"MATCH (n:Function) WHERE n.name = 'retentionFixture' RETURN n.content AS content, n.description AS description",
),
adapter.executeQuery('MATCH (n:BasicBlock) RETURN n.text AS text LIMIT 1'),
adapter.executeQuery('MATCH (n:BasicBlock) RETURN count(n) AS count'),
]);
const count = (rows: any[]) => Number(rows[0]?.count ?? rows[0]?.[0] ?? 0);
return {
nodes: count(nodes),
edges: count(edges),
fileContent: files[0]?.content ?? files[0]?.[0],
functionContent: functions[0]?.content ?? functions[0]?.[0],
functionDescription: functions[0]?.description ?? functions[0]?.[1],
basicBlockText: basicBlocks[0]?.text ?? basicBlocks[0]?.[0],
basicBlockCount: count(basicBlockCount),
};
},
{ readOnly: true },
);
} finally {
await adapter.closeLbug();
}
};
describe('external storage and content retention', () => {
it('keeps the full index outside the checkout, rebuilds on retention changes, and remains queryable after checkout removal', async () => {
const repo = await makeTempDir('gitnexus-run-analyze-retention-repo-');
const storageRoot = await makeTempDir('gitnexus-run-analyze-retention-storage-');
const storage = storagePathFromRoot(storageRoot, repo);
const home = await makeTempDir('gitnexus-run-analyze-retention-home-');
await fs.mkdir(path.join(repo, 'src'));
await fs.writeFile(
path.join(repo, 'src/fixture.ts'),
`/** retention fixture documentation */\nexport function retentionFixture(enabled = true) {\n const payload = '${'fullRetentionPayload '.repeat(20_000)}';\n if (enabled) return payload;\n return '';\n}\n`,
);
process.env.GITNEXUS_HOME = home;
delete process.env[STORAGE_PATH_ENV];
process.env[STORAGE_ROOT_ENV] = storageRoot;
process.env.GITNEXUS_CONTENT_RETENTION = 'full';
const logs: string[] = [];
const options = {
force: true,
skipGit: true,
skipAgentsMd: true,
skipSkills: true,
workerPoolSize: 1,
pdg: true,
streamPdgEmit: true,
registryName: 'retention-fixture',
};
await runFullAnalysis(repo, options, {
onProgress: () => undefined,
onLog: (message) => logs.push(message),
});
const initialMeta = await loadMeta(storage);
const { lbugPath } = getStoragePaths(repo, undefined, storage);
const fullGraph = await readGraph(lbugPath);
const fullDatabaseSize = await recursiveSize(lbugPath);
expect(initialMeta).toMatchObject({
repoPath: repo,
storagePath: storage,
contentRetention: 'full',
contentRetentionSchemaVersion: 1,
ftsProfile: 'full',
});
await expect(fs.access(path.join(repo, '.gitnexus'))).rejects.toThrow();
expect(fullGraph.fileContent).toContain('fullRetentionPayload');
expect(fullGraph.functionContent).toContain('retentionFixture');
expect(fullGraph.basicBlockCount).toBeGreaterThan(0);
process.env.GITNEXUS_CONTENT_RETENTION = 'symbol';
await runFullAnalysis(
repo,
{ ...options, force: false },
{
onProgress: () => undefined,
onLog: (message) => logs.push(message),
},
);
const symbolMeta = await loadMeta(storage);
const symbolGraph = await readGraph(lbugPath);
const symbolDatabaseSize = await recursiveSize(lbugPath);
expect(logs.join('\n')).toContain('forcing a full rebuild');
expect(symbolMeta).toMatchObject({
contentRetention: 'symbol',
contentRetentionSchemaVersion: 1,
ftsProfile: 'symbol-no-file-content',
});
expect(symbolGraph).toMatchObject({ nodes: fullGraph.nodes, edges: fullGraph.edges });
expect(symbolGraph.fileContent).toBeUndefined();
expect(symbolGraph.functionContent).toContain('retentionFixture');
expect(symbolGraph.basicBlockCount).toBe(fullGraph.basicBlockCount);
expect(symbolGraph.basicBlockText).toBeUndefined();
expect(symbolDatabaseSize).toBeLessThan(fullDatabaseSize);
process.env.GITNEXUS_CONTENT_RETENTION = 'none';
await runFullAnalysis(
repo,
{ ...options, force: false },
{
onProgress: () => undefined,
onLog: (message) => logs.push(message),
},
);
const noneMeta = await loadMeta(storage);
expect(noneMeta).toMatchObject({
contentRetention: 'none',
contentRetentionSchemaVersion: 1,
ftsProfile: 'name-only',
});
await fs.rm(repo, { recursive: true, force: true });
const output: string[] = [];
const logSpy = vi
.spyOn(console, 'log')
.mockImplementation((value) => output.push(String(value)));
try {
await statusCommand({ repo: 'retention-fixture', json: true });
} finally {
logSpy.mockRestore();
}
expect(JSON.parse(output[0])).toMatchObject({
storagePath: storage,
sourceAvailable: false,
status: 'source-unavailable',
index: { contentRetention: 'none' },
});
const backend = new LocalBackend();
try {
await backend.init();
const context = await backend.callTool('context', {
name: 'retentionFixture',
repo: 'retention-fixture',
include_content: true,
});
expect(context).toMatchObject({
status: 'found',
contentAvailability: {
requested: true,
profile: 'none',
available: false,
scope: 'none',
},
});
expect(context.symbol.content).toBeUndefined();
} finally {
await backend.disconnect();
}
const noneGraph = await readGraph(lbugPath);
expect(noneGraph).toMatchObject({ nodes: fullGraph.nodes, edges: fullGraph.edges });
expect(noneGraph.fileContent).toBeUndefined();
expect(noneGraph.functionContent).toBeUndefined();
expect(noneGraph.functionDescription).toBeUndefined();
expect(noneGraph.basicBlockCount).toBe(fullGraph.basicBlockCount);
expect(noneGraph.basicBlockText).toBeUndefined();
}, 120_000);
});