mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-04 19:28:46 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - The server has about 1,100 test and helper files in `server/src/__tests__` > - `server/tsconfig.json` excludes that directory, Vitest does not check types, and no script runs the tsconfig in that directory > - So a test can call a function with the wrong arguments and still pass, and no tool reports it > - This gap hid 2,168 real type errors, and some of them hid tests that did not test what they claim > - This pull request fixes all of these errors and adds the directory to the server layers from paperclipai/paperclip#18737 > - The benefit is that a type error in a server test now fails the typecheck, with no baseline and no backlog ## Linked Issues or Issue Description Refs paperclipai/paperclip#18737, which is merged and added the server layers. Refs paperclipai/paperclip#18738, which is merged and checks the test projects outside `pnpm -r`, so it is not a duplicate. Refs paperclipai/paperclip#18137, which records that this directory has no check. **What happened?** No tool checked the types of 1,074 of the 1,101 files in `server/src/__tests__`. I searched `package.json`, the workflows, and all tsconfig files. 27 files are in the program of another tsconfig, and these 27 have 0 errors. 11 of the 27 are in `helpers/maintenance/tsconfig.json`. No script ran that project when I measured this. paperclipai/paperclip#18738 now runs it. **Expected behavior** The server typecheck checks these files, and a type error fails the check. **Steps to reproduce** 1. On the base commit, run `tsc -p server/src/__tests__/tsconfig.json --noEmit`. It reports 6,536 errors and needs 12.3 GiB. 2. Add a type error to any file in `server/src/__tests__`. 3. Run `pnpm --filter @paperclipai/server typecheck`. It passes. **Paperclip version or commit** I measured the error breakdown below on commit `8dfd632452`, with TypeScript 7.0.2. The branch now includes master up to paperclipai/paperclip#18865. **Deployment mode** Not applicable. This issue applies to development and CI. No production source file in the server changes. ### Error breakdown Each row adds one change to the row above. | Step | Total errors | Change | Cause | | --- | --- | --- | --- | | Config as committed | 6,536 | | | | Add `src/types/*.d.ts` | 4,447 | -2,089 | Config. The Express request types were missing. | | Set `rootDir` to the repository root | 2,436 | -2,011 | Config. | | Set `allowImportingTsExtensions` | 2,181 | -255 | Config. Vitest accepts `.ts` imports. | | Add `ES2024.Promise` to `lib` | 2,138 | -43 | Config. Node 24 has `Promise.withResolvers`. | | Set `allowJs` for `.mjs` imports | 2,148 | +10 | Config. It removes 8 `TS7016` errors and shows new real errors. | | Set `declaration` to false | 2,142 | -6 | Config. Tests emit nothing. | | Count only files in `server/src` | 2,058 | -84 | Other packages: 53 Daytona, 29 Runner test, 2 UI. | So 4,478 of the 6,536 errors (69%) came from config or scope, and 2,058 are real type errors in 314 files. The 29 Runner test errors are also real, which gives 2,087 errors. Tests that master added after this measurement had 81 more errors, so this pull request fixes 2,168 errors. This table classifies the first 2,058 errors. | Kind of real error | Errors | | --- | --- | | Wrong argument or assignment type | 1,023 | | Stale or partial fixture objects | 525 | | Property that the type does not have | 317 | | Missing narrowing of null or unknown | 101 | | Implicit any | 60 | | Missing name or module | 16 | | Other | 16 | ### What the type errors hid Most errors were stale fixtures and loose mocks. These errors hid real test problems, and this pull request fixes them: - **A test that never ran.** `instrumentation.test.ts` required `sdk-trace-base`, which is not installed. So 3 span tests were skipped. They now run and pass. - **Assertions that could not fail.** - `issue-thread-interactions-service` used a company ID as an issue ID. - `status-card-evaluation-work` compared `[]` with `[]` in a rollback check. - `slack-conversation-lifecycle` read `item.issueId`, which does not exist. - `email-channels` used a permission key that does not exist. - `heartbeat-project-env` imported `LOW_TRUST_REVIEW_PRESET`, which is not exported. The value was undefined. - **Postgres processes that did not stop.** 11 test files called `stop` on the test database helper. That method does not exist, and the helper method is `cleanup`. - **Arguments that the service ignored.** - `methodKey` is now `connectionMethodKey` in the Daytona, Unikraft, 1Password, and Railway tests. - 108 calls passed `"owner-user"` to a parameter that expects an options object. - 9 chat wizard fixtures passed `managementContext` as `source`, so they ran `existing_app` and not `manifest`. - 2 tests passed a `{ userId }` actor that the function ignores. - Inserts into `environments` passed a `companyId` column that the table does not have. - **Problems in tests that master added during this work.** - `sandbox-creation-operations` read `database.connectionString` when an external test database was set. In that mode `database` is undefined, so the fixture would stop with a TypeError. It now uses the external URL. - `idle-completed-history` set a Dot operation to `dispatched`. That is a Muse status, and the Dot type does not have it. The fixture now uses `admitted`, which is a real in-flight Dot status. ### Possible product problems, not changed These may be real problems in production code or types. I did not change them, because this pull request does not change production behavior: - `decisions-service` `service.create` does not validate the lenient `cancel_issue_tree` input. - `createConnection` ignores `input.connectionPurpose`. - The `createConnection` route schema default stores `{}` for `transportConfig`. - `prepareManagedAiRuntime` accepted the invalid value `mode: "connection"`. - `createBinding` accepts invalid `projectionClass` strings outside class 3. - `ensureManagedProjectWorkspace` forwards an untyped `repoRef` by spread. - `routineVariableSchema.label` is optional, but `RoutineVariable.label` is required. - `ToolRunContext.projectId` may be too strict. - `withdrawInteraction` reads `issue.status`, which its type omits. - `issueService.list` and `reconcileNativeFinalizations` omit fields that they return at runtime. - `createGitHubExternalObjectProvider` handles `tokenProvider: null`, but its type forbids this value. ## What Changed - Fixed the 2,168 type errors. The diff changes 322 test and helper files. - Corrected `server/src/__tests__/tsconfig.json`. Editors and the typecheck now read the same options and report the same errors. - Added three `test-tree` layers to `server/scripts/typecheck-layers.mjs`. They read the server layers as declarations, and any error fails them. A hash of the path selects the shard, so a new file does not move other files. - Added `server/scripts/typecheck-stubs/daytona-sdk.d.ts`. Server tests reach Daytona plugin source, and the root install does not have `@daytonaio/sdk`. - Changed two imports in `ui/src/lib/issue-execution-policy.ts` to use `.js` extensions, because server tests import this file. - Made `declarationsConfig` and `--declarations-only` skip the `test-tree` layers, because these layers emit nothing. Other projects read only the source layers. Added a test for this. - Updated `doc/DEVELOPING.md`. ## Verification Run these commands: ```sh pnpm --filter @paperclipai/server typecheck pnpm exec vitest run server/scripts/typecheck-layers.test.mjs ``` Results on macOS (arm64), Node 24, 16 cores. Each check ran after the merge of paperclipai/paperclip#18738 unless the row says otherwise: | Check | Commit | Result | | --- | --- | --- | | Server typecheck, `PAPERCLIP_TYPECHECK_LOW_MEMORY=1`, all 7 layers | `6e45a08573` | Exit 0, 0 errors, 62 seconds, peak 3.52 GiB | | `node scripts/typecheck-test-projects.mjs --low-memory` | `a3306bd13e` | Exit 0, 0 errors, 42 seconds, peak 3.25 GiB | | The same script with `--reuse-declarations` | `1b878aabc0` | Exit 0, 0 errors | | `typecheck-layers.test.mjs` and `live-recovery-work.test.ts` | `01db5634e4` | 90 passed. These include real compiler runs for a pass, a type error, and an invalid tsconfig. | | `tsconfig.declarations.json` after a full server typecheck | `0fb1e4fb0a` | It references only `below`, `cycle`, and `above`. No generated config names a `tsconfig.layers.json` file. | | Owned runtime test in `idle-completed-history` | `e8f2f448ac` | Passed, with the fix that master later replaced | | `idle-incoming-wake`, `plugin-idle-manager`, and the changed `chat-channels` test | `6e45a08573` | 30 passed | | Runner `native-execution.test.ts` | `eab4dcc1f4` | 114 passed | | The 19 server test files that changed since `eab4dcc1f4`, and `typecheck-layers.test.mjs` | `259737b700` | 4,275 of 4,277 passed. The 2 failures are in `chat-channels` and are in the list of 7 below. | The peak is the largest single process, from `/usr/bin/time -l`. Peaks for the server typecheck were between 3.42 GiB and 3.56 GiB across 8 runs. Peaks for the test projects were 3.25 GiB and 3.37 GiB across 2 runs. I did not measure a cgroup. **Runtime check of the fixes.** Types do not prove that a test still works. So I ran all 309 changed server test files, 11,929 tests, before the rebase onto paperclipai/paperclip#18737: | Result | Tests | Detail | | --- | --- | --- | | Passed | 11,913 | Includes the 2 tests and the 54 `dot-runner` tests that passed in a later run, as described below. | | Failed | 7 | The same 7 tests also fail on the commit before the fixes. | | Skipped | 9 | These tests have their own skip conditions: `sentry` 5, and 1 each in `bundled-plugin-registration`, `customer-success-cloud`, `onepassword-connection`, and `workspace-runtime-https-live-exercise`. | The 7 tests that fail with and without this change, on my machine: - 3 tests in `chat-channels` and `email-channels` stop with `ENOENT` on a `SKILL.md` file. The path is in the parent checkout, above the git worktree that I used, so I expect that the worktree is the cause. I did not prove this. - `workspace-instance-cleanup` compares `/private/var/...` with `/var/...`. This is a macOS symlink difference. - 2 tests in `git-reproducible-managed-checkouts` get `unknown_base_git_files` and expect `unpushed_managed_checkout`. I did not find the cause. - 1 more test in `chat-channels`, `materializes direct external-chat finals once`, gets `undefined`. I did not find the cause. CI is the check for these 7 tests. `ci / verify` passed on `eab4dcc1f4`. Failures during this work: - My fix to `agent-runtime-connector-access` changed an invalid permission key in the setup, but not in the assertion. The runtime check found this. I corrected the assertion, and the file passes. - `heartbeat-plugin-environment` failed one wait in the full run. It passed three times alone, so I think that load caused the failure. It can fail again under load. - `dot-runner` skipped all 54 tests in the full run because `cargo` was not on my `PATH`. It then passed 54 of 54 with the toolchain on the `PATH`. - My first `lib` value removed the default DOM types, and the error count went up by 375. I added the DOM libraries. - My Daytona stub with bare `any` left 48 errors, because generic helpers then inferred `unknown`. I added shapes that return promises. - One fix to `agent-secrets-routes` used `class_3_static_lease`, and the test failed. That class allows only specific paths. I reverted to `unclassified`. - `ci / General tests (server (8/12))` failed on `259737b700` because of the flaky port in `idle-completed-history`. paperclipai/paperclip#18853 fixed this test on master, so this pull request keeps that fix. **Audit of the diff.** I counted these patterns in added and removed lines, to find fixes that only hide an error: | Pattern | Added | Removed | | --- | --- | --- | | `@ts-ignore` | 0 | 0 | | `@ts-expect-error` | 0 | 1 | | `.skip` | 0 | 0 | | `as any` | 9 | 9 | | `: any` | 11 | 2 | | `as never` | 8 | 2 | | `as unknown as` | 35 | 4 | | `Promise<unknown>` | 16 | 5 | | `expect(` | 128 | 113 | No hunk removes more `expect(` calls than it adds. Three removals of test content were intentional, and I checked each one: - `muse-control` removed `signalToken`. Line 1012 already asserts that it is absent. - `merged-pr-confirmation-sweep` removed legacy aliases. Other tests cover them. - `heartbeat-workspace-branch-containment` removed a `finalize` branch that no test row can reach. Some partial fixtures stay unchecked through `as unknown as` and `Promise<unknown>`, mostly in `issue-agent-mutation-ownership-routes` and `issue-comment-reopen-routes`. **Accuracy of the check.** One program over the tree and the three shards reported the same errors at the same positions. Memory, as the peak of the largest process on one thread, was 3.93 GiB for one program and 2.43 GiB for the largest shard. I measured these two values before the fixes. Not run or not proven: - I did not run the full `pnpm test:run`, or a root `pnpm build`. I expect CI to run the full suites. - I did not run the 4 GiB container check, or the full `scripts/typecheck-low-memory.mjs`. The peaks above come from macOS, so they are not a Linux cgroup measurement. - I did not run the UI typecheck after the merges. - `workspace-runtime-https-live-exercise` is skipped, so its `cleanup` fix did not run. ## Risks - **A large diff in test files.** 328 files change. A pull request that edits the same tests can get merge conflicts. New tests on master can also add type errors before this merges. Any such error fails this check and needs a fix here. - **A higher cost for changes to source types.** A change to a type can add errors in test files that the author did not touch. The author must then fix them. This is the purpose of the check, but it is new work. - **Changed test behavior.** Some tests now run paths that they did not run before, such as the 9 chat wizard fixtures and the 3 span tests. They pass here, but they can be more sensitive to timing or to the environment. - **The Daytona stub can go stale.** The stub is written by hand. If the plugin uses a new SDK member, the typecheck reports an error until someone updates the stub. - **The release path.** `release-verify.yml` and `scripts/release.sh` run `pnpm -r typecheck`, so they now run this check. - **The tsconfig change.** The test transform reads `server/src/__tests__/tsconfig.json`. The options that I changed are for type checks, and the runs above passed. - **A gap that remains.** Tsconfigs in `packages/paperclip-runner` and in most sandbox provider plugins exclude `*.test.ts`. This check does not read most of those test files, so they can still drift. That work is separate from this pull request. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used Anthropic Claude Opus 5.5 (`claude-opus-5-5`) through Claude Code, with reasoning, tool use, code execution, and subagents. The runtime does not show the context window size. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [ ] I have run tests locally and they pass (7 tests fail locally, with and without this change. See Verification.) - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
851 lines
32 KiB
JavaScript
851 lines
32 KiB
JavaScript
import { spawnSync } from "node:child_process";
|
|
import { existsSync, mkdirSync, mkdtempSync, readdirSync, readFileSync, realpathSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
|
|
import { afterEach, describe, expect, it } from "vitest";
|
|
|
|
import { emitOnlyTscArgs, lowMemoryTscArgs, runTsc } from "../../scripts/run-tsc.mjs";
|
|
import { STEPS, typecheckLowMemory } from "../../scripts/typecheck-low-memory.mjs";
|
|
import { findServerSource, PREPARE_STEPS, PROJECTS, typecheckTestProjects } from "../../scripts/typecheck-test-projects.mjs";
|
|
import { declarationsConfig, layerConfig, listSourceFiles, planLayers, readImports, typecheckLayers } from "./typecheck-layers.mjs";
|
|
|
|
const serverRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
|
|
const sourcesOf = (layers, name) => layers.find((layer) => layer.name === name)?.sourceFiles;
|
|
|
|
describe("readImports", () => {
|
|
it("resolves every import form that TypeScript follows", () => {
|
|
const files = new Map([
|
|
[
|
|
"src/a.ts",
|
|
[
|
|
`import { b } from "./b.js";`,
|
|
`export * from "./c.js";`,
|
|
`import "./d.js";`,
|
|
`const e = await import("./e.js");`,
|
|
`type F = typeof import("./f.js");`,
|
|
`import g from "./g/index.js";`,
|
|
`import h from "./h.js";`,
|
|
`import data from "./data.json" with { type: "json" };`,
|
|
`import { z } from "zod";`,
|
|
].join("\n"),
|
|
],
|
|
["src/b.ts", ""],
|
|
["src/c.ts", ""],
|
|
["src/d.ts", ""],
|
|
["src/e.ts", ""],
|
|
["src/f.ts", ""],
|
|
["src/g/index.ts", ""],
|
|
["src/h.tsx", ""],
|
|
]);
|
|
|
|
const { modules, json } = readImports(files).get("src/a.ts");
|
|
|
|
expect([...modules].sort()).toEqual([
|
|
"src/b.ts",
|
|
"src/c.ts",
|
|
"src/d.ts",
|
|
"src/e.ts",
|
|
"src/f.ts",
|
|
"src/g/index.ts",
|
|
"src/h.tsx",
|
|
]);
|
|
expect([...json]).toEqual(["src/data.json"]);
|
|
});
|
|
});
|
|
|
|
describe("planLayers", () => {
|
|
it("separates the largest cycle from what it depends on and what depends on it", () => {
|
|
const layers = planLayers(
|
|
new Map([
|
|
["src/leaf.ts", ""],
|
|
["src/unrelated.ts", ""],
|
|
["src/one.ts", `import "./two.js"; import "./leaf.js";`],
|
|
["src/two.ts", `import "./one.js";`],
|
|
["src/route.ts", `import "./one.js";`],
|
|
["src/route.test.ts", `import "./route.js";`],
|
|
["src/types/ambient.d.ts", ""],
|
|
]),
|
|
);
|
|
|
|
expect(sourcesOf(layers, "below")).toEqual(["src/leaf.ts", "src/unrelated.ts"]);
|
|
expect(sourcesOf(layers, "cycle")).toEqual(["src/one.ts", "src/two.ts"]);
|
|
expect(sourcesOf(layers, "above")).toEqual(["src/route.ts"]);
|
|
expect(sourcesOf(layers, "tests")).toEqual(["src/route.test.ts"]);
|
|
for (const layer of layers) expect(layer.files).toContain("src/types/ambient.d.ts");
|
|
});
|
|
|
|
it("keeps test support files in the test layer and shards src/__tests__ by a stable hash", () => {
|
|
const layers = planLayers(
|
|
new Map([
|
|
["src/a.ts", ""],
|
|
["src/services/__tests__/fixtures.ts", ""],
|
|
["src/__tests__/helpers/db.ts", ""],
|
|
["src/__tests__/big.test.ts", ""],
|
|
]),
|
|
);
|
|
|
|
expect(sourcesOf(layers, "below")).toEqual(["src/a.ts"]);
|
|
expect(sourcesOf(layers, "tests")).toEqual(["src/services/__tests__/fixtures.ts"]);
|
|
const shards = layers.filter((layer) => layer.testTree);
|
|
expect(shards.flatMap((layer) => layer.sourceFiles).sort()).toEqual([
|
|
"src/__tests__/big.test.ts",
|
|
"src/__tests__/helpers/db.ts",
|
|
]);
|
|
for (const shard of shards) expect(shard.references).toEqual(["below", "cycle", "above"]);
|
|
|
|
const withMore = planLayers(
|
|
new Map([
|
|
["src/a.ts", ""],
|
|
["src/__tests__/helpers/db.ts", ""],
|
|
["src/__tests__/big.test.ts", ""],
|
|
["src/__tests__/added-1.test.ts", ""],
|
|
["src/__tests__/added-2.test.ts", ""],
|
|
]),
|
|
);
|
|
for (const shard of shards) {
|
|
for (const file of shard.sourceFiles) expect(sourcesOf(withMore, shard.name)).toContain(file);
|
|
}
|
|
});
|
|
|
|
it("lists imported JSON in the layer that imports it", () => {
|
|
const layers = planLayers(
|
|
new Map([
|
|
["src/a.ts", `import data from "./data.json";`],
|
|
["src/one.ts", `import "./two.js"; import data from "./cycle.json";`],
|
|
["src/two.ts", `import "./one.js";`],
|
|
]),
|
|
);
|
|
|
|
expect(layers.find((layer) => layer.name === "below").files).toContain("src/data.json");
|
|
expect(layers.find((layer) => layer.name === "cycle").files).toContain("src/cycle.json");
|
|
});
|
|
|
|
it("omits layers with no files, as when the source has no cycle", () => {
|
|
const layers = planLayers(new Map([["src/a.ts", ""], ["src/b.ts", `import "./a.js";`]]));
|
|
|
|
expect(layers.map((layer) => layer.name)).toEqual(["below"]);
|
|
expect(sourcesOf(layers, "below")).toEqual(["src/a.ts", "src/b.ts"]);
|
|
});
|
|
|
|
it("covers the real server: one layer per file, and no import reaches a later layer", () => {
|
|
const sourceFiles = listSourceFiles(serverRoot);
|
|
const files = new Map(
|
|
sourceFiles.map((file) => [file, readFileSync(path.join(serverRoot, file), "utf8")]),
|
|
);
|
|
const layers = planLayers(files);
|
|
|
|
const planned = layers.flatMap((layer) => layer.sourceFiles);
|
|
expect(new Set(planned).size).toBe(planned.length);
|
|
expect(planned.sort()).toEqual(
|
|
sourceFiles.filter((file) => !file.endsWith(".d.ts")).sort(),
|
|
);
|
|
|
|
const position = new Map(
|
|
layers.flatMap((layer, index) => layer.sourceFiles.map((file) => [file, index])),
|
|
);
|
|
const imports = readImports(new Map([...files].filter(([file]) => !file.endsWith(".d.ts"))));
|
|
for (const layer of layers.filter((candidate) => candidate.name !== "tests" && !candidate.testTree)) {
|
|
for (const file of layer.sourceFiles) {
|
|
for (const target of imports.get(file).modules) {
|
|
if (position.has(target)) expect(position.get(target)).toBeLessThanOrEqual(position.get(file));
|
|
}
|
|
}
|
|
}
|
|
});
|
|
});
|
|
|
|
describe("layerConfig", () => {
|
|
const layer = { name: "cycle", files: ["src/a.ts"], references: ["below"] };
|
|
|
|
it("emits declarations for source layers and references earlier ones", () => {
|
|
const config = layerConfig(layer);
|
|
|
|
expect(config.compilerOptions).toMatchObject({ composite: true, emitDeclarationOnly: true, outDir: "./dts" });
|
|
expect(config.extends).toBe("../../../tsconfig.json");
|
|
expect(config.files).toEqual(["../../../src/a.ts"]);
|
|
expect(config.references).toEqual([{ path: "./tsconfig.below.json" }]);
|
|
});
|
|
|
|
it("emits nothing for tests and drops references to empty layers", () => {
|
|
const config = layerConfig(
|
|
{ name: "tests", files: [], references: ["below", "cycle"] },
|
|
{ emptyLayers: new Set(["cycle"]) },
|
|
);
|
|
|
|
expect(config.compilerOptions).toMatchObject({ composite: false, noEmit: true });
|
|
expect(config.references).toEqual([{ path: "./tsconfig.below.json" }]);
|
|
});
|
|
});
|
|
|
|
describe("layerConfig for the test tree", () => {
|
|
it("reads the options that editors read and emits nothing", () => {
|
|
const config = layerConfig({
|
|
name: "test-tree-0",
|
|
files: ["src/__tests__/a.test.ts"],
|
|
references: ["below"],
|
|
testTree: true,
|
|
});
|
|
|
|
expect(config.extends).toBe("../../../src/__tests__/tsconfig.json");
|
|
expect(config.compilerOptions).toBeUndefined();
|
|
expect(config.files).toEqual(["../../../src/__tests__/a.test.ts"]);
|
|
expect(config.references).toEqual([{ path: "./tsconfig.below.json" }]);
|
|
});
|
|
|
|
it("has a real tests tsconfig that cannot emit and sees the ambient types", () => {
|
|
const config = JSON.parse(readFileSync(path.join(serverRoot, "src/__tests__/tsconfig.json"), "utf8"));
|
|
|
|
expect(config.compilerOptions).toMatchObject({ noEmit: true, rootDir: "../../.." });
|
|
expect(config.include).toContain("../types/*.d.ts");
|
|
});
|
|
});
|
|
|
|
describe("declarationsConfig", () => {
|
|
it("references the source layers that exist, and no test layer", () => {
|
|
const config = declarationsConfig([
|
|
{ name: "below" },
|
|
{ name: "above" },
|
|
{ name: "tests" },
|
|
{ name: "test-tree-0", testTree: true },
|
|
]);
|
|
|
|
expect(config.compilerOptions.composite).toBe(true);
|
|
expect(config.files).toEqual([]);
|
|
expect(config.references).toEqual([{ path: "./tsconfig.below.json" }, { path: "./tsconfig.above.json" }]);
|
|
});
|
|
});
|
|
|
|
describe("typecheckLayers", () => {
|
|
const roots = [];
|
|
|
|
afterEach(() => {
|
|
for (const root of roots.splice(0)) rmSync(root, { recursive: true, force: true });
|
|
});
|
|
|
|
function serverFixture() {
|
|
const root = mkdtempSync(path.join(tmpdir(), "typecheck-layers-"));
|
|
roots.push(root);
|
|
mkdirSync(path.join(root, "src"));
|
|
writeFileSync(path.join(root, "src", "leaf.ts"), "");
|
|
writeFileSync(path.join(root, "src", "one.ts"), `import "./two.js"; import "./leaf.js";`);
|
|
writeFileSync(path.join(root, "src", "two.ts"), `import "./one.js";`);
|
|
writeFileSync(path.join(root, "src", "route.ts"), `import "./one.js";`);
|
|
writeFileSync(path.join(root, "src", "route.test.ts"), `import "./route.js";`);
|
|
return root;
|
|
}
|
|
|
|
it("runs the layers in order and marks the output directory as ESM", () => {
|
|
const root = serverFixture();
|
|
const configs = [];
|
|
|
|
const status = typecheckLayers({
|
|
serverRoot: root,
|
|
log: () => {},
|
|
run: (args) => {
|
|
configs.push(path.basename(args[1]));
|
|
return { status: 0, signal: null };
|
|
},
|
|
});
|
|
|
|
expect(status).toBe(0);
|
|
expect(configs).toEqual([
|
|
"tsconfig.below.json",
|
|
"tsconfig.cycle.json",
|
|
"tsconfig.above.json",
|
|
"tsconfig.tests.json",
|
|
]);
|
|
const output = path.join(root, "node_modules", ".cache", "paperclip-typecheck");
|
|
expect(JSON.parse(readFileSync(path.join(output, "package.json"), "utf8"))).toEqual({ type: "module" });
|
|
});
|
|
|
|
it("skips the test layers when only declarations are needed", () => {
|
|
const root = serverFixture();
|
|
mkdirSync(path.join(root, "src", "__tests__"));
|
|
writeFileSync(path.join(root, "src", "__tests__", "route.test.ts"), `import "../route.js";`);
|
|
const configs = [];
|
|
|
|
const status = typecheckLayers({
|
|
serverRoot: root,
|
|
declarationsOnly: true,
|
|
log: () => {},
|
|
run: (args) => {
|
|
configs.push(path.basename(args[1]));
|
|
return { status: 0, signal: null };
|
|
},
|
|
});
|
|
|
|
expect(status).toBe(0);
|
|
expect(configs).toEqual(["tsconfig.below.json", "tsconfig.cycle.json", "tsconfig.above.json"]);
|
|
const output = path.join(root, "node_modules", ".cache", "paperclip-typecheck");
|
|
expect(JSON.parse(readFileSync(path.join(output, "tsconfig.declarations.json"), "utf8")).references).toEqual([
|
|
{ path: "./tsconfig.below.json" },
|
|
{ path: "./tsconfig.cycle.json" },
|
|
{ path: "./tsconfig.above.json" },
|
|
]);
|
|
});
|
|
|
|
it("reports type errors from every layer", () => {
|
|
const root = serverFixture();
|
|
const configs = [];
|
|
|
|
const status = typecheckLayers({
|
|
serverRoot: root,
|
|
log: () => {},
|
|
run: (args) => {
|
|
configs.push(args[1]);
|
|
return { status: configs.length === 1 ? 2 : 0, signal: null };
|
|
},
|
|
});
|
|
|
|
expect(status).toBe(2);
|
|
expect(configs).toHaveLength(4);
|
|
});
|
|
|
|
it("stops when a process is killed, because later layers have no declarations", () => {
|
|
const root = serverFixture();
|
|
const configs = [];
|
|
|
|
const status = typecheckLayers({
|
|
serverRoot: root,
|
|
log: () => {},
|
|
run: (args) => {
|
|
configs.push(args[1]);
|
|
return { status: 1, signal: "SIGKILL" };
|
|
},
|
|
});
|
|
|
|
expect(status).toBe(1);
|
|
expect(configs).toHaveLength(1);
|
|
});
|
|
});
|
|
|
|
describe("typecheckLayers with the real compiler", () => {
|
|
const tsc = path.join(serverRoot, "node_modules", "typescript", "bin", "tsc");
|
|
const roots = [];
|
|
|
|
afterEach(() => {
|
|
for (const root of roots.splice(0)) rmSync(root, { recursive: true, force: true });
|
|
});
|
|
|
|
function compilerFixture() {
|
|
const root = mkdtempSync(path.join(tmpdir(), "typecheck-layers-real-"));
|
|
roots.push(root);
|
|
mkdirSync(path.join(root, "src"));
|
|
writeFileSync(path.join(root, "package.json"), `${JSON.stringify({ type: "module" })}\n`);
|
|
writeFileSync(
|
|
path.join(root, "tsconfig.json"),
|
|
`${JSON.stringify({
|
|
compilerOptions: {
|
|
target: "ES2023",
|
|
module: "NodeNext",
|
|
moduleResolution: "NodeNext",
|
|
strict: true,
|
|
types: [],
|
|
outDir: "dist",
|
|
rootDir: "src",
|
|
resolveJsonModule: true,
|
|
skipLibCheck: true,
|
|
},
|
|
include: ["src"],
|
|
})}\n`,
|
|
);
|
|
const sources = {
|
|
"leaf.ts": `export const leaf = 1;\n`,
|
|
"one.ts": `import { two } from "./two.js";\nimport { leaf } from "./leaf.js";\nexport const one = () => leaf + two();\n`,
|
|
"two.ts": `import { one } from "./one.js";\nexport const two = (): number => one.length;\n`,
|
|
"route.ts": `import { one } from "./one.js";\nexport const route = () => one();\n`,
|
|
"route.test.ts": `import { route } from "./route.js";\nexport const checked: number = route();\n`,
|
|
};
|
|
for (const [name, text] of Object.entries(sources)) {
|
|
writeFileSync(path.join(root, "src", name), text);
|
|
}
|
|
return root;
|
|
}
|
|
|
|
function check(root) {
|
|
const output = [];
|
|
const status = typecheckLayers({
|
|
serverRoot: root,
|
|
log: () => {},
|
|
run: (args, { cwd }) => {
|
|
const result = spawnSync(process.execPath, [tsc, ...args], { cwd, encoding: "utf8" });
|
|
output.push(result.stdout, result.stderr);
|
|
return { status: result.status ?? 1, signal: result.signal };
|
|
},
|
|
});
|
|
return { status, output: output.join("") };
|
|
}
|
|
|
|
it("emits declarations between layers and checks every layer", () => {
|
|
const root = compilerFixture();
|
|
|
|
const { status, output } = check(root);
|
|
|
|
expect(output).toBe("");
|
|
expect(status).toBe(0);
|
|
const declarations = path.join(root, "node_modules", ".cache", "paperclip-typecheck", "dts");
|
|
for (const name of ["leaf.d.ts", "one.d.ts", "two.d.ts", "route.d.ts"]) {
|
|
expect(existsSync(path.join(declarations, name))).toBe(true);
|
|
}
|
|
expect(existsSync(path.join(declarations, "route.test.d.ts"))).toBe(false);
|
|
}, 60_000);
|
|
|
|
it("lets a project outside the server read the source layers as declarations", () => {
|
|
const root = compilerFixture();
|
|
const outside = path.join(root, "outside");
|
|
mkdirSync(outside);
|
|
writeFileSync(path.join(outside, "use.ts"), `import { route } from "../src/route.js";\nexport const used: number = route();\n`);
|
|
const config = path.join(outside, "tsconfig.layers.json");
|
|
writeFileSync(
|
|
config,
|
|
`${JSON.stringify({
|
|
extends: "../tsconfig.json",
|
|
compilerOptions: { noEmit: true, rootDir: "..", outDir: null },
|
|
include: ["*.ts"],
|
|
references: [{ path: "../node_modules/.cache/paperclip-typecheck/tsconfig.declarations.json" }],
|
|
})}\n`,
|
|
);
|
|
const buildDeclarations = () =>
|
|
typecheckLayers({
|
|
serverRoot: root,
|
|
declarationsOnly: true,
|
|
log: () => {},
|
|
run: (args, { cwd }) => {
|
|
const result = spawnSync(process.execPath, [tsc, ...args], { cwd, encoding: "utf8" });
|
|
return { status: result.status ?? 1, signal: result.signal };
|
|
},
|
|
});
|
|
const tscOutside = (...args) => spawnSync(process.execPath, [tsc, "-p", config, ...args], { cwd: root, encoding: "utf8" });
|
|
|
|
expect(buildDeclarations()).toBe(0);
|
|
const passing = tscOutside();
|
|
expect(passing.stdout).toBe("");
|
|
expect(passing.status).toBe(0);
|
|
const loaded = tscOutside("--listFilesOnly").stdout;
|
|
expect(loaded).toContain("paperclip-typecheck/dts/route.d.ts");
|
|
expect(loaded).not.toContain("src/route.ts");
|
|
expect(findServerSource(loaded.split("\n").filter(Boolean), root)).toEqual([]);
|
|
|
|
const layered = readFileSync(config, "utf8");
|
|
const { references: _references, ...withoutReferences } = JSON.parse(layered);
|
|
writeFileSync(config, `${JSON.stringify(withoutReferences)}\n`);
|
|
const allSource = tscOutside("--listFilesOnly").stdout.split("\n").filter(Boolean);
|
|
expect(findServerSource(allSource, root)).toContain("src/route.ts");
|
|
writeFileSync(config, layered);
|
|
|
|
writeFileSync(path.join(root, "src", "route.ts"), `import { one } from "./one.js";\nexport const route = () => String(one());\n`);
|
|
expect(buildDeclarations()).toBe(0);
|
|
const failing = tscOutside();
|
|
expect(failing.stdout).toContain("outside/use.ts");
|
|
expect(failing.stdout).toContain("TS2322");
|
|
expect(failing.status).not.toBe(0);
|
|
}, 60_000);
|
|
|
|
it("reports a changed export in the layers that depend on it", () => {
|
|
const root = compilerFixture();
|
|
writeFileSync(path.join(root, "src", "leaf.ts"), `export const renamedLeaf = 1;\n`);
|
|
|
|
const { status, output } = check(root);
|
|
|
|
expect(status).not.toBe(0);
|
|
expect(output).toMatch(/src\/one\.ts\(\d+,\d+\): error TS\d+/);
|
|
expect(output).toContain("leaf");
|
|
}, 60_000);
|
|
|
|
function addTestTree(root, source) {
|
|
mkdirSync(path.join(root, "src", "__tests__"), { recursive: true });
|
|
writeFileSync(
|
|
path.join(root, "src", "__tests__", "tsconfig.json"),
|
|
`${JSON.stringify({
|
|
extends: "../../tsconfig.json",
|
|
compilerOptions: { noEmit: true, rootDir: "../.." },
|
|
include: ["."],
|
|
})}\n`,
|
|
);
|
|
writeFileSync(path.join(root, "src", "__tests__", "tree.test.ts"), source);
|
|
}
|
|
|
|
it("checks the test tree through declarations", () => {
|
|
const root = compilerFixture();
|
|
addTestTree(root, `import { route } from "../route.js";\nexport const checked: number = route();\n`);
|
|
|
|
const { status, output } = check(root);
|
|
|
|
expect(output).toBe("");
|
|
expect(status).toBe(0);
|
|
}, 60_000);
|
|
|
|
it("fails on a type error in the test tree", () => {
|
|
const root = compilerFixture();
|
|
addTestTree(root, `import { route } from "../route.js";\nexport const checked: string = route();\n`);
|
|
|
|
const { status, output } = check(root);
|
|
|
|
expect(status).not.toBe(0);
|
|
expect(output).toMatch(/tree\.test\.ts\(2,\d+\): error TS2322/);
|
|
}, 60_000);
|
|
|
|
it("fails when the test-tree tsconfig is invalid", () => {
|
|
const root = compilerFixture();
|
|
addTestTree(root, `export const checked = 1;\n`);
|
|
writeFileSync(
|
|
path.join(root, "src", "__tests__", "tsconfig.json"),
|
|
`${JSON.stringify({ extends: "../../tsconfig.json", compilerOptions: { noEmit: true, rootDir: "../..", target: "not-a-target" } })}\n`,
|
|
);
|
|
|
|
const { status, output } = check(root);
|
|
|
|
expect(status).not.toBe(0);
|
|
expect(output).toMatch(/error TS\d+/);
|
|
}, 60_000);
|
|
|
|
it("reports a type change through declarations in the test layer", () => {
|
|
const root = compilerFixture();
|
|
writeFileSync(
|
|
path.join(root, "src", "route.ts"),
|
|
`import { one } from "./one.js";\nexport const route = (): string => String(one());\n`,
|
|
);
|
|
|
|
const { status, output } = check(root);
|
|
|
|
expect(status).not.toBe(0);
|
|
expect(output).toMatch(/src\/route\.test\.ts\(\d+,\d+\): error TS2322/);
|
|
}, 60_000);
|
|
|
|
// Emitted declarations keep imports of .d.mts and JSON files, which tsc does not
|
|
// copy to the output directory. If those imports stopped resolving, skipLibCheck
|
|
// would hide it and the types would become `any`, so these errors would disappear.
|
|
it("keeps types from .d.mts and JSON imports in later layers", () => {
|
|
const root = compilerFixture();
|
|
mkdirSync(path.join(root, "src", "scripts"));
|
|
writeFileSync(path.join(root, "src", "scripts", "helper.mjs"), `export {};\n`);
|
|
writeFileSync(path.join(root, "src", "scripts", "helper.d.mts"), `export interface Manifest { version: number }\n`);
|
|
writeFileSync(path.join(root, "src", "catalog.json"), `${JSON.stringify({ tools: [{ name: "a" }] })}\n`);
|
|
writeFileSync(
|
|
path.join(root, "src", "leaf.ts"),
|
|
[
|
|
`import catalog from "./catalog.json" with { type: "json" };`,
|
|
`import type { Manifest } from "./scripts/helper.mjs";`,
|
|
`export type { Manifest };`,
|
|
`export type Tool = (typeof catalog.tools)[number];`,
|
|
`export const leaf = 1;`,
|
|
``,
|
|
].join("\n"),
|
|
);
|
|
const misuse = [
|
|
`import type { Manifest, Tool } from "./leaf.js";`,
|
|
`export const manifest: Manifest = { wrong: 1 };`,
|
|
`export const tool: Tool = { wrong: 1 };`,
|
|
``,
|
|
].join("\n");
|
|
writeFileSync(path.join(root, "src", "cycle-misuse.ts"), `import { one } from "./one.js";\nexport const used = one;\n${misuse}`);
|
|
writeFileSync(
|
|
path.join(root, "src", "two.ts"),
|
|
`import { one } from "./one.js";\nimport { used } from "./cycle-misuse.js";\nexport const two = (): number => one.length + used.length;\n`,
|
|
);
|
|
writeFileSync(path.join(root, "src", "misuse.test.ts"), misuse);
|
|
|
|
const { status, output } = check(root);
|
|
|
|
expect(status).not.toBe(0);
|
|
for (const file of ["cycle-misuse", "misuse\\.test"]) {
|
|
expect(output).toMatch(new RegExp(`src/${file}\\.ts\\(\\d+,\\d+\\): error TS2353.*'Manifest'`));
|
|
expect(output).toMatch(new RegExp(`src/${file}\\.ts\\(\\d+,\\d+\\): error TS2353.*'\\{ name: string; \\}'`));
|
|
}
|
|
}, 60_000);
|
|
});
|
|
|
|
describe("typecheckLowMemory", () => {
|
|
it("runs every step in low-memory mode and stops at a failure", () => {
|
|
const calls = [];
|
|
const run = (args, { env }) => {
|
|
calls.push([args, env.PAPERCLIP_TYPECHECK_LOW_MEMORY]);
|
|
return calls.length === 1 ? 0 : 3;
|
|
};
|
|
|
|
expect(typecheckLowMemory({ cwd: serverRoot, env: {}, run })).toBe(3);
|
|
expect(calls).toEqual(STEPS.map((args) => [args, "1"]));
|
|
});
|
|
|
|
it("does not run the typecheck after a failed preflight", () => {
|
|
const calls = [];
|
|
|
|
const status = typecheckLowMemory({
|
|
cwd: serverRoot,
|
|
env: {},
|
|
run: (args) => {
|
|
calls.push(args);
|
|
return 1;
|
|
},
|
|
});
|
|
|
|
expect(status).toBe(1);
|
|
expect(calls).toHaveLength(1);
|
|
});
|
|
});
|
|
|
|
describe("typecheckTestProjects", () => {
|
|
const roots = [];
|
|
|
|
afterEach(() => {
|
|
for (const root of roots.splice(0)) rmSync(root, { recursive: true, force: true });
|
|
});
|
|
|
|
function repositoryFixture() {
|
|
const root = mkdtempSync(path.join(tmpdir(), "typecheck-test-projects-"));
|
|
roots.push(root);
|
|
mkdirSync(path.join(root, "server", "src"), { recursive: true });
|
|
writeFileSync(path.join(root, "server", "src", "leaf.ts"), "");
|
|
writeFileSync(path.join(root, "server", "src", "one.ts"), `import "./two.js"; import "./leaf.js";`);
|
|
writeFileSync(path.join(root, "server", "src", "two.ts"), `import "./one.js";`);
|
|
writeFileSync(path.join(root, "server", "src", "route.ts"), `import "./one.js";`);
|
|
writeFileSync(path.join(root, "server", "src", "route.test.ts"), `import "./route.js";`);
|
|
return root;
|
|
}
|
|
|
|
function runWith(
|
|
root,
|
|
{
|
|
pnpmStatus = () => 0,
|
|
tscResult = () => ({ status: 0, signal: null }),
|
|
listFiles = () => ({ status: 0, files: [] }),
|
|
...options
|
|
} = {},
|
|
) {
|
|
const calls = [];
|
|
const errors = [];
|
|
const status = typecheckTestProjects({
|
|
root,
|
|
listFiles,
|
|
log: () => {},
|
|
logError: (message) => errors.push(message),
|
|
pnpm: (args, { env }) => {
|
|
calls.push({ tool: "pnpm", args, env });
|
|
return pnpmStatus(args);
|
|
},
|
|
run: (args, { env }) => {
|
|
const target = path.basename(path.dirname(args[1])) === "paperclip-typecheck" ? path.basename(args[1]) : args[1];
|
|
calls.push({ tool: "tsc", target, env });
|
|
return tscResult(target);
|
|
},
|
|
...options,
|
|
});
|
|
return { status, calls, errors };
|
|
}
|
|
|
|
it("prepares, builds declarations without the tests layer, and then checks the projects", () => {
|
|
const env = { MARKER: "1" };
|
|
|
|
const { status, calls } = runWith(repositoryFixture(), { projects: ["tests/a", "tests/b"], env });
|
|
|
|
expect(status).toBe(0);
|
|
expect(calls.filter((call) => call.tool === "pnpm").map((call) => call.args)).toEqual(PREPARE_STEPS);
|
|
expect(calls.filter((call) => call.tool === "tsc").map((call) => call.target)).toEqual([
|
|
"tsconfig.below.json",
|
|
"tsconfig.cycle.json",
|
|
"tsconfig.above.json",
|
|
"tests/a/tsconfig.layers.json",
|
|
"tests/b/tsconfig.layers.json",
|
|
]);
|
|
expect(calls.every((call) => call.env === env)).toBe(true);
|
|
});
|
|
|
|
it("stops when the preparation or the server layers fail", () => {
|
|
const prepare = runWith(repositoryFixture(), { pnpmStatus: () => 3 });
|
|
expect(prepare.status).toBe(3);
|
|
expect(prepare.calls).toHaveLength(1);
|
|
|
|
const layers = runWith(repositoryFixture(), {
|
|
projects: ["tests/a"],
|
|
tscResult: (target) => ({ status: target === "tsconfig.cycle.json" ? 2 : 0, signal: null }),
|
|
});
|
|
expect(layers.status).toBe(2);
|
|
expect(layers.calls.some((call) => call.target === "tests/a/tsconfig.layers.json")).toBe(false);
|
|
});
|
|
|
|
it("checks every project after a type error, and stops when a process is killed", () => {
|
|
const errors = runWith(repositoryFixture(), {
|
|
projects: ["tests/a", "tests/b"],
|
|
tscResult: (target) => ({ status: target === "tests/a/tsconfig.layers.json" ? 2 : 0, signal: null }),
|
|
});
|
|
expect(errors.status).toBe(2);
|
|
expect(errors.calls.at(-1).target).toBe("tests/b/tsconfig.layers.json");
|
|
|
|
const killed = runWith(repositoryFixture(), {
|
|
projects: ["tests/a", "tests/b"],
|
|
tscResult: (target) =>
|
|
target === "tests/a/tsconfig.layers.json" ? { status: 1, signal: "SIGKILL" } : { status: 0, signal: null },
|
|
});
|
|
expect(killed.status).toBe(1);
|
|
expect(killed.calls.at(-1).target).toBe("tests/a/tsconfig.layers.json");
|
|
});
|
|
|
|
it("reuses declarations without preparing or building layers", () => {
|
|
const { status, calls } = runWith(repositoryFixture(), { projects: ["tests/a"], reuseDeclarations: true });
|
|
|
|
expect(status).toBe(0);
|
|
expect(calls.map((call) => call.target ?? call.tool)).toEqual(["tests/a/tsconfig.layers.json"]);
|
|
});
|
|
|
|
it("fails when a project loads server source, even if its types pass", () => {
|
|
const root = repositoryFixture();
|
|
const server = path.join(root, "server");
|
|
|
|
const { status, errors } = runWith(root, {
|
|
projects: ["tests/a", "tests/b"],
|
|
reuseDeclarations: true,
|
|
listFiles: (config) => ({
|
|
status: 0,
|
|
files: config.startsWith("tests/a/") ? [path.join(server, "src", "route.ts")] : [],
|
|
}),
|
|
});
|
|
|
|
expect(status).toBe(1);
|
|
expect(errors).toHaveLength(1);
|
|
expect(errors[0]).toContain("tests/a loads 1 server source files");
|
|
expect(errors[0]).toContain("src/route.ts");
|
|
});
|
|
|
|
it("fails when a project's files cannot be listed, and keeps a type error's status", () => {
|
|
const listing = runWith(repositoryFixture(), {
|
|
projects: ["tests/a"],
|
|
reuseDeclarations: true,
|
|
listFiles: () => ({ status: 3, files: [], output: "TS6053" }),
|
|
});
|
|
expect(listing.status).toBe(3);
|
|
expect(listing.errors[0]).toContain("TS6053");
|
|
|
|
const both = runWith(repositoryFixture(), {
|
|
projects: ["tests/a"],
|
|
reuseDeclarations: true,
|
|
tscResult: () => ({ status: 2, signal: null }),
|
|
listFiles: () => ({ status: 3, files: [], output: "" }),
|
|
});
|
|
expect(both.status).toBe(2);
|
|
});
|
|
|
|
it("counts only source files that a layer should provide", () => {
|
|
const server = path.join(path.sep, "repo", "server");
|
|
const file = (relative) => path.join(server, ...relative.split("/"));
|
|
|
|
expect(
|
|
findServerSource(
|
|
[
|
|
file("src/route.ts"),
|
|
file("src/view.tsx"),
|
|
file("src/legacy.js"),
|
|
file("src/types/express.d.ts"),
|
|
file("src/data.json"),
|
|
file("src/route.test.ts"),
|
|
file("src/__tests__/helpers/home.ts"),
|
|
file("node_modules/.cache/paperclip-typecheck/dts/route.d.ts"),
|
|
file("test-baselines/lifecycle.test.ts"),
|
|
path.join(path.sep, "repo", "tests", "a.ts"),
|
|
],
|
|
server,
|
|
),
|
|
).toEqual(["src/route.ts", "src/view.tsx", "src/legacy.js"]);
|
|
});
|
|
|
|
it("covers every project under tests/, or names why it does not", () => {
|
|
// This project imports one small server file, so it stays one small program.
|
|
const singlePrograms = ["tests/runner-acceptance"];
|
|
const testsRoot = path.join(serverRoot, "..", "tests");
|
|
const projects = readdirSync(testsRoot, { withFileTypes: true })
|
|
.filter((entry) => entry.isDirectory() && existsSync(path.join(testsRoot, entry.name, "tsconfig.json")))
|
|
.map((entry) => `tests/${entry.name}`);
|
|
|
|
expect(projects.sort()).toEqual(
|
|
[...PROJECTS.filter((project) => project.startsWith("tests/")), ...singlePrograms].sort(),
|
|
);
|
|
});
|
|
|
|
it("prepares the same way as the server typecheck", () => {
|
|
const { scripts } = JSON.parse(readFileSync(path.join(serverRoot, "package.json"), "utf8"));
|
|
for (const step of PREPARE_STEPS) {
|
|
expect(scripts.typecheck).toContain(`pnpm ${step.join(" ")}`);
|
|
}
|
|
});
|
|
|
|
it.each(PROJECTS)("keeps the generated references out of the tsconfig.json of %s", (project) => {
|
|
const directory = path.join(serverRoot, "..", project);
|
|
const readConfig = (name) => JSON.parse(readFileSync(path.join(directory, name), "utf8"));
|
|
|
|
// Vitest reads tsconfig.json and fails when a referenced config does not exist yet.
|
|
expect(readConfig("tsconfig.json").references).toBeUndefined();
|
|
const layered = readConfig("tsconfig.layers.json");
|
|
expect(layered.extends).toBe("./tsconfig.json");
|
|
expect(layered.references.map((reference) => path.resolve(directory, reference.path))).toEqual([
|
|
path.join(serverRoot, "node_modules", ".cache", "paperclip-typecheck", "tsconfig.declarations.json"),
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe("runTsc", () => {
|
|
it("emits JavaScript without checks or declarations in emit-only mode", () => {
|
|
const root = mkdtempSync(path.join(tmpdir(), "run-tsc-emit-only-"));
|
|
try {
|
|
mkdirSync(path.join(root, "src"));
|
|
mkdirSync(path.join(root, "node_modules"));
|
|
symlinkSync(
|
|
realpathSync(path.join(serverRoot, "node_modules", "typescript")),
|
|
path.join(root, "node_modules", "typescript"),
|
|
);
|
|
writeFileSync(
|
|
path.join(root, "tsconfig.json"),
|
|
`${JSON.stringify({
|
|
compilerOptions: { declaration: true, declarationMap: true, types: [], outDir: "dist", rootDir: "src" },
|
|
include: ["src"],
|
|
})}\n`,
|
|
);
|
|
writeFileSync(path.join(root, "src", "a.ts"), `export const value: number = "not a number";\n`);
|
|
|
|
const { status } = runTsc([], { cwd: root, env: { ...process.env, PAPERCLIP_TSC_EMIT_ONLY: "1" } });
|
|
|
|
expect(status).toBe(0);
|
|
expect(existsSync(path.join(root, "dist", "a.js"))).toBe(true);
|
|
expect(existsSync(path.join(root, "dist", "a.d.ts"))).toBe(false);
|
|
} finally {
|
|
rmSync(root, { recursive: true, force: true });
|
|
}
|
|
}, 60_000);
|
|
|
|
it("accepts build mode with low-memory mode on", () => {
|
|
const { status } = runTsc(["-b", "--dry"], {
|
|
cwd: serverRoot,
|
|
env: { ...process.env, PAPERCLIP_TYPECHECK_LOW_MEMORY: "1" },
|
|
});
|
|
|
|
expect(status).toBe(0);
|
|
});
|
|
});
|
|
|
|
describe("emitOnlyTscArgs", () => {
|
|
it("removes checks and declarations only in emit-only mode", () => {
|
|
expect(emitOnlyTscArgs({ PAPERCLIP_TSC_EMIT_ONLY: "1" })).toEqual([
|
|
"--noCheck",
|
|
"--declaration",
|
|
"false",
|
|
"--declarationMap",
|
|
"false",
|
|
]);
|
|
expect(emitOnlyTscArgs({})).toEqual([]);
|
|
});
|
|
|
|
it("is what the Dockerfile selects for the server build", () => {
|
|
const dockerfile = readFileSync(path.join(serverRoot, "..", "Dockerfile"), "utf8");
|
|
|
|
expect(dockerfile).toContain("RUN PAPERCLIP_TSC_EMIT_ONLY=1 pnpm --filter @paperclipai/server build\n");
|
|
});
|
|
});
|
|
|
|
describe("lowMemoryTscArgs", () => {
|
|
it("uses one thread only when low-memory mode is on", () => {
|
|
expect(lowMemoryTscArgs({ PAPERCLIP_TYPECHECK_LOW_MEMORY: "1" })).toEqual(["--singleThreaded"]);
|
|
expect(lowMemoryTscArgs({ PAPERCLIP_TYPECHECK_LOW_MEMORY: "0" })).toEqual([]);
|
|
expect(lowMemoryTscArgs({})).toEqual([]);
|
|
});
|
|
});
|