feat(extraction): add Nix language support with module-system option wiring (#324, #332 via #648 — carries #1084) (#1190)
Carries @TyceHerrman's #1084 as the functional base. Extraction + file wiring (imports/modules lists, callPackage), module-system option-path synthesizer, lexical-scope resolution gates, ABI-15 wasm rebuilt from upstream source. Validated on agenix, nix-darwin, home-manager, and nixpkgs (44,368 files, 3m49s, 1.30M nodes). Co-authored-by: Tyce Herrman <Tyce.Herrman@pm.me> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Tyce Herrman
Claude Fable 5
parent
99152212a9
commit
7f325134e0
@@ -0,0 +1,269 @@
|
||||
/**
|
||||
* Nix module-system option wiring (nix-option-path synthesizer).
|
||||
*
|
||||
* An option is DECLARED in one module (`options.launchd.user.agents =
|
||||
* mkOption { ... }`) and SET in others (`launchd.user.agents.yabai = { ... }`)
|
||||
* — the module-system evaluator unifies them by option path, so there is no
|
||||
* static edge to follow. The synthesizer links each config write to the
|
||||
* declaration whose path is the longest plain-segment prefix of the write
|
||||
* path, and these tests pin its precision gates: ambiguous declarations bail,
|
||||
* dynamic path heads never match, 1-segment paths never register (a package's
|
||||
* `meta = { ... }` must not link to `options.meta`), and submodule-internal
|
||||
* `options` blocks are quarantined.
|
||||
*/
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import * as fs from 'node:fs';
|
||||
import * as path from 'node:path';
|
||||
import * as os from 'node:os';
|
||||
import { CodeGraph } from '../src';
|
||||
|
||||
describe('nix-option-path synthesizer', () => {
|
||||
let dir: string;
|
||||
beforeEach(() => { dir = fs.mkdtempSync(path.join(os.tmpdir(), 'nix-option-')); });
|
||||
afterEach(() => { fs.rmSync(dir, { recursive: true, force: true }); });
|
||||
|
||||
async function synthEdges(d: string): Promise<any[]> {
|
||||
const cg = await CodeGraph.init(d, { silent: true });
|
||||
await cg.indexAll();
|
||||
const db = (cg as any).db.db;
|
||||
const rows = db
|
||||
.prepare(
|
||||
`SELECT s.name source, s.file_path sf, t.name target, t.file_path tf,
|
||||
json_extract(e.metadata,'$.optionPath') optionPath
|
||||
FROM edges e JOIN nodes s ON s.id = e.source JOIN nodes t ON t.id = e.target
|
||||
WHERE json_extract(e.metadata,'$.synthesizedBy') = 'nix-option-path'`
|
||||
)
|
||||
.all();
|
||||
cg.destroy();
|
||||
return rows;
|
||||
}
|
||||
|
||||
it('links a cross-file config write to its flat option declaration', async () => {
|
||||
fs.mkdirSync(path.join(dir, 'modules'), { recursive: true });
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'modules', 'launchd.nix'),
|
||||
`{ config, lib, ... }:
|
||||
{
|
||||
options.launchd.user.agents = lib.mkOption {
|
||||
type = lib.types.attrsOf (lib.types.submodule {});
|
||||
default = {};
|
||||
description = "launchd agents";
|
||||
};
|
||||
}
|
||||
`
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'modules', 'yabai.nix'),
|
||||
`{ config, lib, ... }:
|
||||
{
|
||||
config = lib.mkIf config.services.yabai.enable {
|
||||
launchd.user.agents.yabai = {
|
||||
command = "yabai";
|
||||
keepAlive = true;
|
||||
};
|
||||
};
|
||||
}
|
||||
`
|
||||
);
|
||||
|
||||
const edges = await synthEdges(dir);
|
||||
const hit = edges.find((e) => e.source === 'launchd.user.agents.yabai');
|
||||
expect(hit).toBeDefined();
|
||||
expect(hit.target).toBe('options.launchd.user.agents');
|
||||
expect(hit.tf).toBe('modules/launchd.nix');
|
||||
expect(hit.optionPath).toBe('launchd.user.agents');
|
||||
});
|
||||
|
||||
it('composes nested declaration spellings and prefers the longest declared prefix', async () => {
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'git-module.nix'),
|
||||
`{ lib, ... }:
|
||||
{
|
||||
options = {
|
||||
programs.git = {
|
||||
enable = lib.mkOption {
|
||||
type = lib.types.bool;
|
||||
default = false;
|
||||
};
|
||||
signing.key = lib.mkOption {
|
||||
type = lib.types.str;
|
||||
default = "";
|
||||
};
|
||||
};
|
||||
};
|
||||
}
|
||||
`
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'user-config.nix'),
|
||||
`{ ... }:
|
||||
{
|
||||
programs.git.enable = true;
|
||||
programs.git.signing.key = "ABCD1234";
|
||||
}
|
||||
`
|
||||
);
|
||||
|
||||
const edges = await synthEdges(dir);
|
||||
const enable = edges.find((e) => e.source === 'programs.git.enable');
|
||||
const key = edges.find((e) => e.source === 'programs.git.signing.key');
|
||||
expect(enable).toBeDefined();
|
||||
// Longest declared prefix wins: the leaf `enable` declaration, not `programs.git`.
|
||||
expect(enable.optionPath).toBe('programs.git.enable');
|
||||
expect(enable.target).toBe('enable');
|
||||
expect(key).toBeDefined();
|
||||
expect(key.optionPath).toBe('programs.git.signing.key');
|
||||
expect(key.target).toBe('signing.key');
|
||||
});
|
||||
|
||||
it('matches through a quoted segment only up to the static prefix', async () => {
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'xdg.nix'),
|
||||
`{ lib, ... }:
|
||||
{
|
||||
options.xdg.configFile = lib.mkOption {
|
||||
type = lib.types.attrsOf (lib.types.anything);
|
||||
default = {};
|
||||
};
|
||||
}
|
||||
`
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'writer.nix'),
|
||||
`{ ... }:
|
||||
{
|
||||
xdg.configFile."git/config".text = "[user]";
|
||||
}
|
||||
`
|
||||
);
|
||||
|
||||
const edges = await synthEdges(dir);
|
||||
const hit = edges.find((e) => e.sf === 'writer.nix');
|
||||
expect(hit).toBeDefined();
|
||||
expect(hit.optionPath).toBe('xdg.configFile');
|
||||
expect(hit.target).toBe('options.xdg.configFile');
|
||||
});
|
||||
|
||||
it('anchors quoted writes to their own quoted declaration, never a sibling', async () => {
|
||||
// NSGlobalDomain-style enumerated quoted options: each quoted write must
|
||||
// hit ITS declaration; an undeclared quoted write must not fall back to a
|
||||
// same-prefix sibling.
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'domain.nix'),
|
||||
`{ lib, ... }:
|
||||
{
|
||||
options = {
|
||||
system.defaults.NSGlobalDomain."com.apple.keyboard.fnState" = lib.mkOption {
|
||||
type = lib.types.nullOr lib.types.bool;
|
||||
default = null;
|
||||
};
|
||||
system.defaults.NSGlobalDomain."com.apple.mouse.tapBehavior" = lib.mkOption {
|
||||
type = lib.types.nullOr lib.types.int;
|
||||
default = null;
|
||||
};
|
||||
};
|
||||
}
|
||||
`
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'writer.nix'),
|
||||
`{ ... }:
|
||||
{
|
||||
system.defaults.NSGlobalDomain."com.apple.mouse.tapBehavior" = 1;
|
||||
system.defaults.NSGlobalDomain."com.apple.undeclared.domain" = 2;
|
||||
}
|
||||
`
|
||||
);
|
||||
|
||||
const edges = await synthEdges(dir);
|
||||
const tap = edges.filter((e) => e.sf === 'writer.nix' && e.source.includes('tapBehavior'));
|
||||
expect(tap).toHaveLength(1);
|
||||
expect(tap[0].target).toContain('tapBehavior');
|
||||
expect(tap[0].optionPath).toBe('system.defaults.NSGlobalDomain."com.apple.mouse.tapBehavior"');
|
||||
// No parent declaration exists, so the undeclared quoted write stays silent.
|
||||
expect(edges.filter((e) => e.source.includes('undeclared'))).toEqual([]);
|
||||
});
|
||||
|
||||
it('bails on ambiguous declarations and dynamic path heads; never registers 1-segment paths', async () => {
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'dup-a.nix'),
|
||||
`{ lib, ... }: { options.services.dup = lib.mkOption { default = {}; }; }
|
||||
`
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'dup-b.nix'),
|
||||
`{ lib, ... }:
|
||||
{
|
||||
options.services.dup = lib.mkOption {
|
||||
default = {};
|
||||
};
|
||||
}
|
||||
`
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'meta-decl.nix'),
|
||||
`{ lib, ... }:
|
||||
{
|
||||
options.meta = lib.mkOption {
|
||||
default = {};
|
||||
};
|
||||
}
|
||||
`
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'writers.nix'),
|
||||
`{ name, ... }:
|
||||
{
|
||||
services.dup.enable = true;
|
||||
services.\${name}.enable = true;
|
||||
meta.maintainers = [ "someone" ];
|
||||
}
|
||||
`
|
||||
);
|
||||
|
||||
const edges = await synthEdges(dir);
|
||||
// services.dup is declared in two files → ambiguous → no edge at all.
|
||||
expect(edges.filter((e) => e.source === 'services.dup.enable')).toEqual([]);
|
||||
// The interpolated head leaves <2 static segments → no edge.
|
||||
expect(edges.filter((e) => e.sf === 'writers.nix' && e.optionPath?.startsWith('services'))).toEqual([]);
|
||||
// `options.meta` is a 1-segment path → never registered, `meta.*` writes stay unlinked.
|
||||
expect(edges.filter((e) => e.source?.startsWith('meta.'))).toEqual([]);
|
||||
});
|
||||
|
||||
it('quarantines submodule-internal options blocks', async () => {
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'agents.nix'),
|
||||
`{ lib, ... }:
|
||||
{
|
||||
options.launchd.agents = lib.mkOption {
|
||||
type = lib.types.attrsOf (lib.types.submodule {
|
||||
options = {
|
||||
command.text = lib.mkOption {
|
||||
type = lib.types.str;
|
||||
default = "";
|
||||
};
|
||||
};
|
||||
});
|
||||
};
|
||||
}
|
||||
`
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(dir, 'writer.nix'),
|
||||
`{ ... }:
|
||||
{
|
||||
command.text = "not an option write";
|
||||
launchd.agents.myapp = { };
|
||||
}
|
||||
`
|
||||
);
|
||||
|
||||
const edges = await synthEdges(dir);
|
||||
// The submodule's own `command.text` namespace is not globally addressable.
|
||||
expect(edges.filter((e) => e.source === 'command.text')).toEqual([]);
|
||||
// The outer attrsOf declaration still anchors writes into the attr set.
|
||||
const hit = edges.find((e) => e.source === 'launchd.agents.myapp');
|
||||
expect(hit).toBeDefined();
|
||||
expect(hit.optionPath).toBe('launchd.agents');
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user