mirror of
https://github.com/murashit/codex-panel.git
synced 2026-07-22 06:57:10 +00:00
245 lines
10 KiB
TypeScript
245 lines
10 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import { mkdir, mkdtemp, readdir, readFile, rm, writeFile } from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
import { pathToFileURL } from "node:url";
|
|
import { afterEach, describe, expect, it } from "vitest";
|
|
|
|
const repoRoot = process.cwd();
|
|
const tempWorkspaces = new Set<string>();
|
|
|
|
afterEach(async () => {
|
|
await Promise.all([...tempWorkspaces].map((workspace) => rm(workspace, { recursive: true, force: true })));
|
|
tempWorkspaces.clear();
|
|
});
|
|
|
|
describe("development scripts", () => {
|
|
it("fails style builds when CSS files are missing from the style order file", async () => {
|
|
const cwd = await styleOrderFixture();
|
|
|
|
const result = runNodeScript("scripts/build-styles.mjs", [], cwd);
|
|
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain("CSS files missing from src/styles/order.json: 10-unlisted.css");
|
|
});
|
|
|
|
it("passes the expected codex generate-ts arguments", async () => {
|
|
const cwd = await tempWorkspace();
|
|
const calls: { command: string; args: string[]; cwd: string }[] = [];
|
|
const { generateAppServerTypes } = await import(pathToFileURL(path.join(repoRoot, "scripts", "generate-app-server-types.mjs")).href);
|
|
|
|
await generateAppServerTypes({
|
|
cwd,
|
|
async runCommand(command: string, args: string[], options: { cwd: string }) {
|
|
calls.push({ command, args, cwd: options.cwd });
|
|
const outIndex = args.indexOf("--out");
|
|
const outputDir = args[outIndex + 1];
|
|
if (!outputDir) throw new Error("Missing generated output directory");
|
|
await mkdir(path.join(options.cwd, outputDir, "v2"), { recursive: true });
|
|
await writeFile(
|
|
path.join(options.cwd, outputDir, "v2", "Example.ts"),
|
|
"// GENERATED CODE! DO NOT MODIFY BY HAND!\nexport type Example = string | null | null;\n",
|
|
);
|
|
},
|
|
});
|
|
|
|
expect(calls).toHaveLength(1);
|
|
expect(calls[0]).toMatchObject({ command: "codex", cwd });
|
|
expect(calls[0]?.args.slice(0, 4)).toEqual(["app-server", "generate-ts", "--experimental", "--out"]);
|
|
expect(calls[0]?.args[4]?.replaceAll("\\", "/")).toMatch(/^src\/generated\/\.app-server-/);
|
|
await expect(readFile(path.join(cwd, "src", "generated", "app-server", "v2", "Example.ts"), "utf8")).resolves.toContain(
|
|
"export type Example = string | null;",
|
|
);
|
|
});
|
|
|
|
it("preserves generated bindings when generation fails", async () => {
|
|
const cwd = await tempWorkspace();
|
|
const generatedDir = path.join(cwd, "src", "generated", "app-server");
|
|
await mkdir(generatedDir, { recursive: true });
|
|
await writeFile(path.join(generatedDir, "Existing.ts"), "export type Existing = true;\n");
|
|
const { generateAppServerTypes } = await import(pathToFileURL(path.join(repoRoot, "scripts", "generate-app-server-types.mjs")).href);
|
|
|
|
await expect(
|
|
generateAppServerTypes({
|
|
cwd,
|
|
runCommand: async () => {
|
|
throw new Error("generation failed");
|
|
},
|
|
}),
|
|
).rejects.toThrow("generation failed");
|
|
|
|
await expect(readFile(path.join(generatedDir, "Existing.ts"), "utf8")).resolves.toBe("export type Existing = true;\n");
|
|
await expect(readdir(path.join(cwd, "src", "generated"))).resolves.toEqual(["app-server"]);
|
|
});
|
|
|
|
it("reads app-server compatibility policy from the declared baseline in API baseline checks", async () => {
|
|
const cwd = await tempWorkspace();
|
|
await mkdir(path.join(cwd, "scripts"), { recursive: true });
|
|
await mkdir(path.join(cwd, "src", "app-server"), { recursive: true });
|
|
const { createApiBaselineReport } = await import(pathToFileURL(path.join(repoRoot, "scripts", "api-baseline.mjs")).href);
|
|
|
|
await writeJson(path.join(cwd, "package.json"), {
|
|
version: "1.0.0",
|
|
devDependencies: {
|
|
obsidian: "~1.12.3",
|
|
},
|
|
});
|
|
await writeJson(path.join(cwd, "package-lock.json"), {
|
|
packages: {
|
|
"node_modules/obsidian": {
|
|
version: "1.12.3",
|
|
},
|
|
},
|
|
});
|
|
await writeJson(path.join(cwd, "manifest.json"), {
|
|
minAppVersion: "1.12.0",
|
|
});
|
|
await writeJson(path.join(cwd, "versions.json"), {
|
|
"1.0.0": "1.12.0",
|
|
});
|
|
await writeFile(
|
|
path.join(cwd, "README.md"),
|
|
[
|
|
"## Compatibility",
|
|
"",
|
|
"| Key | Version | Notes |",
|
|
"| --- | --- | --- |",
|
|
"| `codex.testedCliVersion` | `0.139.0` | Tested CLI. |",
|
|
"| `manifest.minAppVersion` | `1.12.0` | Minimum app version. |",
|
|
"| `obsidian` API types | `1.12.3` | Compile-time API package. |",
|
|
].join("\n"),
|
|
);
|
|
await writeFile(
|
|
path.join(cwd, "scripts", "generate-app-server-types.mjs"),
|
|
'run("codex", ["app-server", "generate-ts", "--experimental"]);\n',
|
|
);
|
|
await mkdir(path.join(cwd, "src", "app-server", "connection"), { recursive: true });
|
|
await writeJson(path.join(cwd, "src", "app-server", "connection", "compatibility.json"), {
|
|
codexAppServer: {
|
|
typeGeneration: {
|
|
experimental: true,
|
|
},
|
|
initialize: {
|
|
capabilities: {
|
|
experimentalApi: true,
|
|
requestAttestation: false,
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
const report = await createApiBaselineReport({
|
|
cwd,
|
|
readCodexVersion: () => "0.139.0",
|
|
});
|
|
|
|
expect(report.codex.appServerGenerationExperimentalDeclared).toBe(true);
|
|
expect(report.codex.initializeExperimentalApi).toBe(true);
|
|
expect(report.codex.initializeRequestAttestationDisabled).toBe(true);
|
|
expect(report.failures).toEqual([]);
|
|
|
|
const recordedOnlyReport = await createApiBaselineReport({
|
|
cwd,
|
|
readCodexVersion: () => null,
|
|
skipLocalCodex: true,
|
|
});
|
|
expect(recordedOnlyReport.codex.localCliCheckSkipped).toBe(true);
|
|
expect(recordedOnlyReport.failures).toEqual([]);
|
|
});
|
|
|
|
it("reports representative CSS usage policy failures", async () => {
|
|
const cwd = await cssUsageFixture({
|
|
"src/styles/10-component.css": [
|
|
".codex-panel__used { display: block; }",
|
|
".codex-panel__test-only { display: block; }",
|
|
".codex-panel__unused { display: block; }",
|
|
].join("\n"),
|
|
"src/component.ts": [
|
|
'export const className = "codex-panel__used";',
|
|
"export const dynamicClassName = `codex-panel__task-step--$" + "{status}`;",
|
|
].join("\n"),
|
|
"tests/component.test.ts": 'expect("codex-panel__test-only").toBeTruthy();\n',
|
|
});
|
|
|
|
const result = runNodeScript("scripts/check-css-usage.mjs", [], cwd);
|
|
|
|
expect(result.status).toBe(1);
|
|
expect(result.stdout).toBe("");
|
|
expect(result.stderr).toContain("CSS usage check failed.");
|
|
expect(result.stderr).toContain("Dynamic CSS class prefixes are not allowed:");
|
|
expect(result.stderr).toContain("codex-panel__task-step--");
|
|
expect(result.stderr).toContain("codex-panel__test-only");
|
|
expect(result.stderr).toContain("codex-panel__unused");
|
|
});
|
|
|
|
it("fails release prepare before changing version files when release notes already exist", async () => {
|
|
const cwd = await tempWorkspace();
|
|
await mkdir(path.join(cwd, ".github", "release-notes"), { recursive: true });
|
|
|
|
const packageJson = { version: "2.3.2" };
|
|
const packageLockJson = { version: "2.3.2", packages: { "": { version: "2.3.2" } } };
|
|
const manifestJson = { version: "2.3.2", minAppVersion: "1.12.0" };
|
|
const versionsJson = { "2.3.2": "1.12.0" };
|
|
|
|
await writeJson(path.join(cwd, "package.json"), packageJson);
|
|
await writeJson(path.join(cwd, "package-lock.json"), packageLockJson);
|
|
await writeJson(path.join(cwd, "manifest.json"), manifestJson);
|
|
await writeJson(path.join(cwd, "versions.json"), versionsJson);
|
|
await writeFile(path.join(cwd, ".github", "release-notes", "2.3.3.md"), "## Changes\n\n- Existing\n");
|
|
|
|
const result = runNodeScript("scripts/release/prepare.mjs", ["2.3.3"], cwd);
|
|
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain(".github/release-notes/2.3.3.md already exists");
|
|
await expect(readJson(path.join(cwd, "package.json"))).resolves.toEqual(packageJson);
|
|
await expect(readJson(path.join(cwd, "package-lock.json"))).resolves.toEqual(packageLockJson);
|
|
await expect(readJson(path.join(cwd, "manifest.json"))).resolves.toEqual(manifestJson);
|
|
await expect(readJson(path.join(cwd, "versions.json"))).resolves.toEqual(versionsJson);
|
|
});
|
|
});
|
|
|
|
async function tempWorkspace(): Promise<string> {
|
|
const workspace = await mkdtemp(path.join(tmpdir(), "codex-panel-scripts-"));
|
|
tempWorkspaces.add(workspace);
|
|
return workspace;
|
|
}
|
|
|
|
async function styleOrderFixture(): Promise<string> {
|
|
const cwd = await tempWorkspace();
|
|
await mkdir(path.join(cwd, "src", "styles"), { recursive: true });
|
|
await writeJson(path.join(cwd, "src", "styles", "order.json"), ["00-tokens.css"]);
|
|
await writeFile(path.join(cwd, "src", "styles", "00-tokens.css"), ".codex-panel { color: var(--text-normal); }\n");
|
|
await writeFile(path.join(cwd, "src", "styles", "10-unlisted.css"), ".codex-panel__extra { display: block; }\n");
|
|
return cwd;
|
|
}
|
|
|
|
async function cssUsageFixture(files: Record<string, string>): Promise<string> {
|
|
const cwd = await tempWorkspace();
|
|
await mkdir(path.join(cwd, "src", "styles"), { recursive: true });
|
|
await mkdir(path.join(cwd, "tests"), { recursive: true });
|
|
await writeJson(path.join(cwd, "src", "styles", "order.json"), ["10-component.css"]);
|
|
|
|
for (const [file, source] of Object.entries(files)) {
|
|
await mkdir(path.dirname(path.join(cwd, file)), { recursive: true });
|
|
await writeFile(path.join(cwd, file), source);
|
|
}
|
|
|
|
return cwd;
|
|
}
|
|
|
|
function runNodeScript(script: string, args: string[] = [], cwd = repoRoot, env: NodeJS.ProcessEnv = {}) {
|
|
return spawnSync(process.execPath, [path.join(repoRoot, script), ...args], {
|
|
cwd,
|
|
encoding: "utf8",
|
|
env: { ...process.env, ...env },
|
|
shell: false,
|
|
});
|
|
}
|
|
|
|
async function writeJson(file: string, value: unknown): Promise<void> {
|
|
await writeFile(file, `${JSON.stringify(value, null, 2)}\n`);
|
|
}
|
|
|
|
async function readJson(file: string): Promise<unknown> {
|
|
return JSON.parse(await readFile(file, "utf8"));
|
|
}
|