mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-07 07:55:47 +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>
479 lines
29 KiB
TypeScript
479 lines
29 KiB
TypeScript
import { finishServiceShutdown } from "../shutdown.js";
|
|
import { EventEmitter } from "node:events";
|
|
import { randomUUID } from "node:crypto";
|
|
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { eq, sql } from "drizzle-orm";
|
|
import { createDb, plugins, pluginJobs, pluginJobRuns } from "@paperclipai/db";
|
|
import { getEmbeddedPostgresTestSupport, startEmbeddedPostgresTestDatabase } from "./helpers/embedded-postgres.js";
|
|
import { resolveExternalTestDatabaseUrl } from "./helpers/external-test-database.js";
|
|
import { createPluginJobScheduler } from "../services/plugin-job-scheduler.js";
|
|
import { pluginJobStore } from "../services/plugin-job-store.js";
|
|
import { pluginRegistryService } from "../services/plugin-registry.js";
|
|
import type { PluginWorkerManager } from "../services/plugin-worker-manager.js";
|
|
import { createDeliveryWorkCoordinator } from "../services/delivery-work-coordinator.js";
|
|
import { idleWorkSnapshot } from "../services/task-admission.js";
|
|
|
|
const external = resolveExternalTestDatabaseUrl("PAPERCLIP_PLUGIN_SCHEDULE_TEST_DATABASE_URL");
|
|
const support = external ? { supported: true } : await getEmbeddedPostgresTestSupport();
|
|
(support.supported ? describe : describe.skip)("plugin job scheduling without idle polling", () => {
|
|
let temporary: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>> | undefined;
|
|
let db: ReturnType<typeof createDb>, pluginId: string;
|
|
let scheduler: ReturnType<typeof createPluginJobScheduler> | undefined;
|
|
let coordinator: ReturnType<typeof createDeliveryWorkCoordinator> | undefined;
|
|
let available = true, draining = false;
|
|
let events: EventEmitter;
|
|
const rpc = vi.fn<(...args: unknown[]) => Promise<unknown>>();
|
|
const errors: unknown[] = [];
|
|
beforeAll(async () => {
|
|
if (!external) temporary = await startEmbeddedPostgresTestDatabase("plugin-schedule-");
|
|
db = createDb(external ?? temporary!.connectionString, { maxConnections: 6, idleTimeoutSeconds: 0, maxLifetimeSeconds: 0 });
|
|
}, 30_000);
|
|
beforeEach(async () => {
|
|
pluginId = randomUUID(); available = true; draining = false; events = new EventEmitter(); errors.length = 0;
|
|
rpc.mockReset(); rpc.mockResolvedValue({});
|
|
await db.insert(plugins).values({ id: pluginId, pluginKey: pluginId, packageName: pluginId, version: "1.0.0", manifestJson: {} as never });
|
|
await Promise.all(Array.from({ length: 6 }, () => db.execute(sql`select pg_sleep(0.01)`)));
|
|
vi.useFakeTimers({ toFake: ["Date", "setTimeout", "clearTimeout", "setInterval", "clearInterval"], shouldAdvanceTime: true });
|
|
// Retry tests must not accidentally cross the next real hourly cron tick.
|
|
vi.setSystemTime(new Date("2026-10-27T12:05:00Z"));
|
|
});
|
|
afterEach(async () => {
|
|
await scheduler?.stop(); await coordinator?.stop(); scheduler = undefined; coordinator = undefined;
|
|
vi.useRealTimers(); vi.restoreAllMocks();
|
|
await db.execute(sql`drop trigger if exists plugin_settlement_failure on plugin_job_runs`);
|
|
await db.execute(sql`drop function if exists plugin_settlement_failure()`);
|
|
await db.delete(plugins).where(eq(plugins.id, pluginId));
|
|
expect(errors).toEqual([]);
|
|
});
|
|
afterAll(async () => { await db?.$client.end({ timeout: 1 }); await temporary?.cleanup(); });
|
|
async function start(maxConcurrentJobs = 10, settlementTimeoutMs = 30_000) {
|
|
const workerManager = { isRunning: () => available, call: rpc, getWorker: () => events } as unknown as PluginWorkerManager;
|
|
scheduler = createPluginJobScheduler({ db, jobStore: pluginJobStore(db), workerManager,
|
|
isBackgroundWorkEnabled: () => !draining, maxConcurrentJobs, settlementTimeoutMs });
|
|
coordinator = createDeliveryWorkCoordinator({ owner: db, canRun: () => !draining, canReconcile: () => true,
|
|
onError: error => errors.push(error) });
|
|
await scheduler.start(coordinator);
|
|
await scheduler.registerPlugin(pluginId);
|
|
}
|
|
const job = (key = "hourly", schedule = "0 * * * *") => pluginRegistryService(db).upsertJob(pluginId, key, { schedule });
|
|
const runs = () => db.select().from(pluginJobRuns).where(eq(pluginJobRuns.pluginId, pluginId));
|
|
async function settled() {
|
|
await vi.waitFor(async () => {
|
|
await vi.advanceTimersByTimeAsync(1000);
|
|
expect(idleWorkSnapshot().active).toBe(0);
|
|
}, { timeout: 5000 });
|
|
}
|
|
async function quiet() {
|
|
await vi.waitFor(async () => {
|
|
await vi.advanceTimersByTimeAsync(1000);
|
|
expect(idleWorkSnapshot().active).toBe(0);
|
|
expect(coordinator!.nextWakeAt()).toBeNull();
|
|
}, { timeout: 5000 });
|
|
const reads = vi.spyOn(db, "select"), writes = vi.spyOn(db, "transaction"), executes = vi.spyOn(db, "execute");
|
|
await vi.advanceTimersByTimeAsync(180_000);
|
|
expect(reads).not.toHaveBeenCalled(); expect(writes).not.toHaveBeenCalled(); expect(executes).not.toHaveBeenCalled();
|
|
reads.mockRestore(); writes.mockRestore(); executes.mockRestore();
|
|
}
|
|
async function due(key = "hourly") {
|
|
const row = await job(key);
|
|
await pluginJobStore(db).updateRunTimestamps(row.id, new Date(0), new Date(Date.now() - 1000));
|
|
return row;
|
|
}
|
|
async function completed(count = 1) {
|
|
await vi.waitFor(async () => {
|
|
await vi.advanceTimersByTimeAsync(1000);
|
|
expect((await runs()).filter(run => run.status === "succeeded" || run.status === "failed")).toHaveLength(count);
|
|
}, { timeout: 5000 });
|
|
}
|
|
|
|
it("does not query repeatedly after an empty startup reconciliation", async () => { await start(); await quiet(); });
|
|
it("bounds full refreshes while many job status writes arrive sequentially", async () => {
|
|
await pluginJobStore(db).syncJobDeclarations(pluginId, Array.from({ length: 40 }, (_, i) => ({ jobKey: `manual-${i}`, displayName: `Manual ${i}`, schedule: "" })));
|
|
const jobs = await db.select().from(pluginJobs).where(eq(pluginJobs.pluginId, pluginId));
|
|
await start(); await quiet();
|
|
const reads = vi.spyOn(db, "select");
|
|
for (const job of jobs.slice(0, 15)) {
|
|
const run = await pluginJobStore(db).createRun({ jobId: job.id, pluginId, trigger: "manual" });
|
|
await pluginJobStore(db).markRunning(run.id);
|
|
await pluginJobStore(db).completeRun(run.id, { status: "succeeded" });
|
|
await vi.advanceTimersByTimeAsync(1100);
|
|
}
|
|
expect(reads.mock.calls.length).toBeLessThanOrEqual(1);
|
|
reads.mockRestore();
|
|
await quiet();
|
|
expect(await runs()).toHaveLength(15);
|
|
expect(rpc).not.toHaveBeenCalled();
|
|
});
|
|
it("honors a saved deadline inside the notification batching window", async () => {
|
|
const row = await job();
|
|
const deadline = new Date(Date.now() + 10_000);
|
|
await pluginJobStore(db).updateRunTimestamps(row.id, new Date(0), deadline);
|
|
await start();
|
|
// registerPlugin produces a local wake immediately after startup. It may
|
|
// batch the reload but must not replace the known ten-second deadline.
|
|
await settled();
|
|
expect(coordinator!.nextWakeAt()).toBe(deadline.getTime());
|
|
expect(rpc).not.toHaveBeenCalled();
|
|
await vi.advanceTimersByTimeAsync(Math.max(0, deadline.getTime() - Date.now()));
|
|
await completed();
|
|
expect(rpc).toHaveBeenCalledOnce();
|
|
expect(rpc.mock.calls[0][2]).toMatchObject({ job: { scheduledAt: deadline.toISOString() } });
|
|
});
|
|
it("keeps configured manual-only and invalid schedules quiet", async () => {
|
|
await job("manual", ""); await job("invalid", "not cron"); await start(); await quiet(); expect(rpc).not.toHaveBeenCalled();
|
|
});
|
|
it("initializes a first declaration after empty startup and runs only at its deadline", async () => {
|
|
await start(); await quiet(); const row = await job(); await settled();
|
|
const current = await pluginJobStore(db).getJobById(row.id);
|
|
expect(current?.nextRunAt!.getTime()).toBeGreaterThan(Date.now());
|
|
expect(rpc).not.toHaveBeenCalled();
|
|
await vi.advanceTimersByTimeAsync(current!.nextRunAt!.getTime() - Date.now()); await completed(); expect(rpc).toHaveBeenCalledTimes(1);
|
|
});
|
|
it("catches up an overdue startup job without moving its owed timestamp", async () => {
|
|
const row = await due(); const at = (await pluginJobStore(db).getJobById(row.id))!.nextRunAt!;
|
|
await start(); await completed();
|
|
expect(rpc.mock.calls[0][2]).toMatchObject({ job: { scheduledAt: at.toISOString(), trigger: "schedule" } });
|
|
expect((await pluginJobStore(db).getJobById(row.id))!.nextRunAt!.getTime()).toBeGreaterThan(Date.now());
|
|
});
|
|
it("pauses a due schedule and reactivates from the real status producer", async () => {
|
|
const row = await due(); await pluginJobStore(db).updateJobStatus(row.id, "paused"); await start(); await quiet();
|
|
await pluginJobStore(db).updateJobStatus(row.id, "active"); await completed(); expect(rpc).toHaveBeenCalledTimes(1);
|
|
});
|
|
it("parks an unavailable worker and wakes overdue work from its lifecycle event", async () => {
|
|
await due(); available = false; await start(); await quiet();
|
|
available = true; events.emit("status", { status: "ready" }); await completed(); expect(rpc).toHaveBeenCalledTimes(1);
|
|
});
|
|
it("retains a worker-availability wake received during drain", async () => {
|
|
await due(); available = false; await start(); await quiet();
|
|
draining = true; available = true; events.emit("status", { status: "ready" });
|
|
await vi.advanceTimersByTimeAsync(10_000); expect(rpc).not.toHaveBeenCalled();
|
|
draining = false; await completed();
|
|
});
|
|
it("retains the first committed job created during drain", async () => {
|
|
await start(); await quiet(); draining = true; await due();
|
|
const reads = vi.spyOn(db, "select"); await vi.advanceTimersByTimeAsync(10_000); expect(reads).not.toHaveBeenCalled(); reads.mockRestore();
|
|
expect(rpc).not.toHaveBeenCalled(); draining = false; await completed();
|
|
});
|
|
it("does not dispatch a nested write until the outer transaction commits", async () => {
|
|
await start(); await quiet();
|
|
await db.transaction(async tx => {
|
|
await pluginJobStore(tx).syncJobDeclarations(pluginId, [{ jobKey: "outer", displayName: "Outer", schedule: "0 * * * *" }]);
|
|
const row = await pluginJobStore(tx).getJobByKey(pluginId, "outer");
|
|
await pluginJobStore(tx).updateRunTimestamps(row!.id, new Date(0), new Date(Date.now() - 1000));
|
|
await vi.advanceTimersByTimeAsync(5000); expect(rpc).not.toHaveBeenCalled();
|
|
});
|
|
await completed();
|
|
});
|
|
it("disarms after a rolled-back declaration", async () => {
|
|
await start(); await quiet();
|
|
await expect(db.transaction(async tx => {
|
|
await pluginJobStore(tx).syncJobDeclarations(pluginId, [{ jobKey: "rollback", displayName: "Rollback", schedule: "* * * * *" }]);
|
|
throw new Error("abort");
|
|
})).rejects.toThrow("abort");
|
|
await quiet(); expect(rpc).not.toHaveBeenCalled();
|
|
});
|
|
it("parks removed declarations while retaining their history", async () => {
|
|
await due(); await start(); await completed();
|
|
await pluginJobStore(db).syncJobDeclarations(pluginId, []); await quiet(); expect(await runs()).toHaveLength(1);
|
|
});
|
|
it("recomputes a changed cron schedule", async () => {
|
|
await job("changed", "0 0 1 1 *"); await start(); await settled();
|
|
await job("changed", "* * * * *"); await settled();
|
|
expect(coordinator!.nextWakeAt()! - Date.now()).toBeLessThanOrEqual(60_000);
|
|
await vi.advanceTimersByTimeAsync(60_000); await completed();
|
|
});
|
|
it("retries failed completion persistence without repeating the plugin side effect", async () => {
|
|
await db.execute(sql`create function plugin_settlement_failure() returns trigger language plpgsql as $$ begin if new.status in ('succeeded', 'failed') then raise exception 'settlement unavailable'; end if; return new; end $$`);
|
|
await db.execute(sql`create trigger plugin_settlement_failure before update on plugin_job_runs for each row execute function plugin_settlement_failure()`);
|
|
await due(); await start();
|
|
await vi.waitFor(async () => { await vi.advanceTimersByTimeAsync(1000); expect(errors.length).toBeGreaterThan(0); }, { timeout: 5000 }); expect(rpc).toHaveBeenCalledTimes(1);
|
|
await db.execute(sql`drop trigger plugin_settlement_failure on plugin_job_runs`); errors.length = 0;
|
|
await completed(); expect(rpc).toHaveBeenCalledTimes(1);
|
|
});
|
|
it("flushes a retained completion before graceful shutdown finishes", async () => {
|
|
await db.execute(sql`create function plugin_settlement_failure() returns trigger language plpgsql as $$ begin if new.status in ('succeeded', 'failed') then raise exception 'settlement unavailable'; end if; return new; end $$`);
|
|
await db.execute(sql`create trigger plugin_settlement_failure before update on plugin_job_runs for each row execute function plugin_settlement_failure()`);
|
|
await due(); await start();
|
|
await vi.waitFor(async () => { await vi.advanceTimersByTimeAsync(1000); expect(errors.length).toBeGreaterThan(0); }, { timeout: 5000 });
|
|
draining = true;
|
|
await coordinator!.stop();
|
|
await db.execute(sql`drop trigger plugin_settlement_failure on plugin_job_runs`); errors.length = 0;
|
|
await scheduler!.stop();
|
|
expect((await runs())[0].status).toBe("succeeded");
|
|
expect(rpc).toHaveBeenCalledTimes(1);
|
|
});
|
|
it("finishes service cleanup and retries a failed settlement before closing the pool", async () => {
|
|
await db.execute(sql`create function plugin_settlement_failure() returns trigger language plpgsql as $$ begin if new.status in ('succeeded', 'failed') then raise exception 'settlement unavailable'; end if; return new; end $$`);
|
|
await db.execute(sql`create trigger plugin_settlement_failure before update on plugin_job_runs for each row execute function plugin_settlement_failure()`);
|
|
await due(); await start();
|
|
await vi.waitFor(async () => { await vi.advanceTimersByTimeAsync(1000); expect(errors.length).toBeGreaterThan(0); }, { timeout: 5000 });
|
|
draining = true; await coordinator!.stop(); errors.length = 0;
|
|
const cleanup = vi.fn(async () => {
|
|
expect((await runs())[0].status).toBe("running");
|
|
await db.execute(sql`drop trigger plugin_settlement_failure on plugin_job_runs`);
|
|
});
|
|
const stop = vi.fn(() => scheduler!.stop());
|
|
await finishServiceShutdown(stop, cleanup);
|
|
expect(cleanup).toHaveBeenCalledOnce();
|
|
expect(stop).toHaveBeenCalledTimes(2);
|
|
expect((await runs())[0].status).toBe("succeeded");
|
|
expect(rpc).toHaveBeenCalledTimes(1);
|
|
});
|
|
it("reports shutdown persistence failure and retains the result for another stop attempt", async () => {
|
|
await db.execute(sql`create function plugin_settlement_failure() returns trigger language plpgsql as $$ begin if new.status in ('succeeded', 'failed') then raise exception 'settlement unavailable'; end if; return new; end $$`);
|
|
await db.execute(sql`create trigger plugin_settlement_failure before update on plugin_job_runs for each row execute function plugin_settlement_failure()`);
|
|
await due(); await start();
|
|
await vi.waitFor(async () => { await vi.advanceTimersByTimeAsync(1000); expect(errors.length).toBeGreaterThan(0); }, { timeout: 5000 });
|
|
draining = true; await coordinator!.stop(); errors.length = 0;
|
|
try {
|
|
await expect(scheduler!.stop()).rejects.toThrow("Plugin job completion persistence failed during shutdown");
|
|
expect((await runs())[0].status).toBe("running");
|
|
} finally { await db.execute(sql`drop trigger plugin_settlement_failure on plugin_job_runs`); }
|
|
await scheduler!.stop();
|
|
expect((await runs())[0].status).toBe("succeeded");
|
|
expect(rpc).toHaveBeenCalledTimes(1);
|
|
});
|
|
it("dispatches independent jobs while one completion remains unwritable", async () => {
|
|
const blocked = await due("blocked");
|
|
await db.execute(sql`create function plugin_settlement_failure() returns trigger language plpgsql as $$ begin if new.status in ('succeeded', 'failed') and new.job_id::text = TG_ARGV[0] then raise exception 'settlement unavailable'; end if; return new; end $$`);
|
|
await db.execute(sql`create trigger plugin_settlement_failure before update on plugin_job_runs for each row execute function plugin_settlement_failure(${sql.raw("'" + blocked.id + "'")})`);
|
|
try {
|
|
await start();
|
|
await vi.waitFor(async () => { await vi.advanceTimersByTimeAsync(1000); expect(errors.length).toBeGreaterThan(0); }, { timeout: 5000 });
|
|
const independent = await due("independent");
|
|
await vi.waitFor(async () => {
|
|
await vi.advanceTimersByTimeAsync(1000);
|
|
expect(await runs()).toEqual(expect.arrayContaining([expect.objectContaining({ jobId: independent.id, status: "succeeded" })]));
|
|
}, { timeout: 5000 });
|
|
expect(rpc).toHaveBeenCalledTimes(2);
|
|
} finally {
|
|
await db.execute(sql`drop trigger plugin_settlement_failure on plugin_job_runs`); errors.length = 0;
|
|
await completed(2); await settled(); errors.length = 0;
|
|
}
|
|
});
|
|
it.each(["succeeded", "failed"] as const)("retains a completed %s result when unregistering during a settlement failure", async outcome => {
|
|
await db.execute(sql`create function plugin_settlement_failure() returns trigger language plpgsql as $$ begin if new.status in ('succeeded', 'failed') then raise exception 'settlement unavailable'; end if; return new; end $$`);
|
|
await db.execute(sql`create trigger plugin_settlement_failure before update on plugin_job_runs for each row execute function plugin_settlement_failure()`);
|
|
if (outcome === "failed") rpc.mockRejectedValueOnce(new Error("Plugin failed before unregister"));
|
|
await due(); await start();
|
|
await vi.waitFor(async () => {
|
|
await vi.advanceTimersByTimeAsync(1000);
|
|
expect(errors.length).toBeGreaterThan(0);
|
|
expect(scheduler!.diagnostics().activeJobCount).toBe(0);
|
|
}, { timeout: 5000 });
|
|
try {
|
|
await scheduler!.unregisterPlugin(pluginId);
|
|
expect((await runs())[0].status).toBe("running");
|
|
} finally {
|
|
await db.execute(sql`drop trigger plugin_settlement_failure on plugin_job_runs`);
|
|
errors.length = 0;
|
|
await scheduler!.tick(); await settled(); errors.length = 0;
|
|
}
|
|
expect((await runs())[0].status).toBe(outcome);
|
|
expect(rpc).toHaveBeenCalledOnce();
|
|
await quiet();
|
|
});
|
|
|
|
it("preserves a completion committed while unregister waits on the discovered run", async () => {
|
|
const row = await job("finishing", "");
|
|
const run = await pluginJobStore(db).createRun({ jobId: row.id, pluginId, trigger: "manual" });
|
|
await pluginJobStore(db).markRunning(run.id);
|
|
await start(); await quiet();
|
|
let release!: () => void, locked!: () => void;
|
|
const gate = new Promise<void>(resolve => { release = resolve; });
|
|
const acquired = new Promise<void>(resolve => { locked = resolve; });
|
|
const finishing = db.transaction(async tx => {
|
|
await pluginJobStore(tx).completeRun(run.id, { status: "succeeded" });
|
|
locked(); await gate;
|
|
});
|
|
await acquired;
|
|
const unregistering = scheduler!.unregisterPlugin(pluginId);
|
|
try {
|
|
await vi.waitFor(async () => {
|
|
const [waiting] = await db.execute<{ count: number }>(sql`select count(*)::int as count from pg_stat_activity
|
|
where datname = current_database() and state = 'active' and wait_event_type = 'Lock'
|
|
and query like '%plugin_job_runs%'`);
|
|
expect(waiting.count).toBeGreaterThan(0);
|
|
});
|
|
} finally { release(); await finishing; await unregistering; }
|
|
expect((await runs())[0].status).toBe("succeeded");
|
|
expect(rpc).not.toHaveBeenCalled();
|
|
await quiet();
|
|
});
|
|
|
|
it("retains the manual reservation when a refresh read finishes after manual dispatch", async () => {
|
|
await start(2); await quiet();
|
|
// Creating due work also wakes the scheduler. Keep dispatch paused until
|
|
// the snapshot barrier is installed, regardless of notification timing.
|
|
draining = true;
|
|
const row = await due("raced");
|
|
let resumeRead!: () => void, enteredRead!: () => void, releaseCall!: () => void;
|
|
const readGate = new Promise<void>(resolve => { resumeRead = resolve; });
|
|
const readEntered = new Promise<void>(resolve => { enteredRead = resolve; });
|
|
const callGate = new Promise<void>(resolve => { releaseCall = resolve; });
|
|
rpc.mockImplementation(() => callGate);
|
|
const select = db.select.bind(db);
|
|
let held = false;
|
|
// Hold delivery of one real outstanding-run query result. The manual run
|
|
// commits after this snapshot, before the scheduled dispatch resumes.
|
|
const readSpy = vi.spyOn(db, "select").mockImplementation((fields) => {
|
|
const builder = select(fields);
|
|
if (fields?.jobId !== pluginJobRuns.jobId || held) return builder;
|
|
held = true;
|
|
const from = builder.from.bind(builder);
|
|
vi.spyOn(builder, "from").mockImplementation((table) => {
|
|
const query = from(table);
|
|
const then = query.then.bind(query);
|
|
query.then = ((fulfilled, rejected) => then(async rows => {
|
|
enteredRead(); await readGate; return rows;
|
|
}).then(fulfilled, rejected)) as typeof query.then;
|
|
return query;
|
|
});
|
|
return builder;
|
|
});
|
|
draining = false;
|
|
const refreshing = scheduler!.tick();
|
|
try {
|
|
await readEntered;
|
|
await scheduler!.triggerJob(row.id);
|
|
await vi.waitFor(() => expect(rpc).toHaveBeenCalledOnce());
|
|
resumeRead(); await refreshing;
|
|
expect(scheduler!.diagnostics().activeJobIds).toEqual([row.id]);
|
|
await due("waiting-one"); await due("waiting-two"); await scheduler!.tick();
|
|
await vi.waitFor(() => expect(rpc).toHaveBeenCalledTimes(2));
|
|
expect(scheduler!.diagnostics().activeJobCount).toBe(2);
|
|
} finally {
|
|
resumeRead(); readSpy.mockRestore();
|
|
await pluginJobStore(db).updateJobStatus(row.id, "paused");
|
|
releaseCall(); await refreshing; await settled();
|
|
}
|
|
await completed(3);
|
|
expect(rpc).toHaveBeenCalledTimes(3);
|
|
});
|
|
|
|
it("preserves a deadline advanced during a concurrent unchanged declaration update", async () => {
|
|
const row = await due();
|
|
const advanced = new Date(Date.now() + 600_000);
|
|
let release!: () => void, locked!: () => void;
|
|
const barrier = new Promise<void>(resolve => { release = resolve; });
|
|
const acquired = new Promise<void>(resolve => { locked = resolve; });
|
|
const advancing = db.transaction(async tx => {
|
|
await pluginJobStore(tx).updateRunTimestamps(row.id, new Date(), advanced);
|
|
locked(); await barrier;
|
|
});
|
|
await acquired;
|
|
const updating = pluginRegistryService(db).upsertJob(pluginId, row.jobKey, { schedule: row.schedule });
|
|
try {
|
|
await vi.waitFor(async () => {
|
|
const [waiting] = await db.execute<{ count: number }>(sql`select count(*)::int as count from pg_stat_activity
|
|
where datname = current_database() and state = 'active' and wait_event_type = 'Lock'`);
|
|
expect(waiting.count).toBeGreaterThan(0);
|
|
});
|
|
} finally { release(); await advancing; await updating; }
|
|
expect((await pluginJobStore(db).getJobById(row.id))!.nextRunAt).toEqual(advanced);
|
|
});
|
|
it("records provider failure and advances the cron obligation", async () => {
|
|
rpc.mockRejectedValueOnce(new Error("plugin rejected job")); await due(); await start(); await completed();
|
|
expect((await runs())[0]).toMatchObject({ status: "failed", error: "plugin rejected job" });
|
|
await settled(); expect(coordinator!.nextWakeAt()! > Date.now()).toBe(true);
|
|
});
|
|
it("does not replay an unresolved run left by another process", async () => {
|
|
const row = await due(); await pluginJobStore(db).createRun({ jobId: row.id, pluginId, trigger: "schedule" });
|
|
await start(); await quiet(); expect(rpc).not.toHaveBeenCalled();
|
|
const [run] = await runs(); await pluginJobStore(db).completeRun(run.id, { status: "cancelled" }); await completed();
|
|
});
|
|
it("fills released capacity from completion without a poll", async () => {
|
|
await due("one"); await due("two"); let release!: () => void;
|
|
rpc.mockImplementationOnce(() => new Promise<void>(resolve => { release = resolve; }));
|
|
const starting = start(1); await vi.waitFor(() => expect(rpc).toHaveBeenCalledTimes(1));
|
|
release(); await starting; await completed(2); expect(rpc).toHaveBeenCalledTimes(2);
|
|
});
|
|
it("tracks manual work and waits for admitted calls during shutdown", async () => {
|
|
const row = await job("manual", ""); await start(); await quiet(); let release!: () => void;
|
|
rpc.mockImplementationOnce(() => new Promise<void>(resolve => { release = resolve; }));
|
|
await scheduler!.triggerJob(row.id); await vi.waitFor(() => expect(rpc).toHaveBeenCalledTimes(1));
|
|
expect(idleWorkSnapshot().active).toBeGreaterThan(0);
|
|
let stopped = false; const stopping = scheduler!.stop().then(() => { stopped = true; });
|
|
await vi.advanceTimersByTimeAsync(1000); expect(stopped).toBe(false);
|
|
release(); await stopping; expect((await runs())[0].status).toBe("succeeded");
|
|
});
|
|
it("does no SQL while waiting for a future configured deadline", async () => {
|
|
const row = await job(); const at = new Date(Date.now() + 600_000);
|
|
await pluginJobStore(db).updateRunTimestamps(row.id, new Date(0), at);
|
|
await start();
|
|
await vi.waitFor(async () => {
|
|
await vi.advanceTimersByTimeAsync(1000);
|
|
expect(coordinator!.nextWakeAt()).toBe(at.getTime());
|
|
}, { timeout: 5000 });
|
|
const reads = vi.spyOn(db, "select"), writes = vi.spyOn(db, "transaction");
|
|
await vi.advanceTimersByTimeAsync(180_000);
|
|
expect(reads).not.toHaveBeenCalled(); expect(writes).not.toHaveBeenCalled();
|
|
reads.mockRestore(); writes.mockRestore(); expect(rpc).not.toHaveBeenCalled();
|
|
});
|
|
it("reconstructs the saved deadline after scheduler restart", async () => {
|
|
const row = await job(); const at = new Date(Date.now() + 600_000);
|
|
await pluginJobStore(db).updateRunTimestamps(row.id, new Date(0), at);
|
|
await start(); await settled(); await scheduler!.stop(); await coordinator!.stop();
|
|
await start();
|
|
await vi.waitFor(async () => {
|
|
await vi.advanceTimersByTimeAsync(1000);
|
|
expect(coordinator!.nextWakeAt()).toBe(at.getTime());
|
|
}, { timeout: 5000 });
|
|
await vi.advanceTimersByTimeAsync(at.getTime() - Date.now()); await completed(); expect(rpc).toHaveBeenCalledTimes(1);
|
|
});
|
|
it("rechecks a paused definition after waiting for its lock", async () => {
|
|
const row = await due(); let startup!: Promise<void>;
|
|
await db.transaction(async tx => {
|
|
await pluginJobStore(tx).updateJobStatus(row.id, "paused");
|
|
startup = start(); await vi.advanceTimersByTimeAsync(1000); expect(rpc).not.toHaveBeenCalled();
|
|
});
|
|
await startup; await quiet(); expect(rpc).not.toHaveBeenCalled();
|
|
});
|
|
it("prevents overlapping concurrent manual triggers", async () => {
|
|
const row = await job("manual", ""); await start(); await quiet(); let release!: () => void;
|
|
rpc.mockImplementation(() => new Promise<void>(resolve => { release = resolve; }));
|
|
const attempts = await Promise.allSettled([scheduler!.triggerJob(row.id), scheduler!.triggerJob(row.id)]);
|
|
await vi.waitFor(() => expect(rpc).toHaveBeenCalledTimes(1));
|
|
release(); await completed(); expect(attempts.filter(result => result.status === "fulfilled")).toHaveLength(1);
|
|
});
|
|
it("bounds a locked completion write through shutdown and retries without rerunning the plugin", async () => {
|
|
const row = await job("manual", ""); await start(10, 250); await quiet();
|
|
let finishRpc!: () => void;
|
|
rpc.mockImplementation(() => new Promise<void>(resolve => { finishRpc = resolve; }));
|
|
const { runId } = await scheduler!.triggerJob(row.id);
|
|
await vi.waitFor(() => expect(rpc).toHaveBeenCalledOnce());
|
|
let unlock!: () => void, acquired!: () => void;
|
|
const gate = new Promise<void>(resolve => { unlock = resolve; });
|
|
const admitted = new Promise<void>(resolve => { acquired = resolve; });
|
|
const holder = db.transaction(async tx => {
|
|
await tx.select().from(pluginJobRuns).where(eq(pluginJobRuns.id, runId)).for("update");
|
|
acquired(); await gate;
|
|
});
|
|
await admitted;
|
|
let stop: Promise<void> | undefined, stopped = false, failure: unknown;
|
|
try {
|
|
draining = true; finishRpc();
|
|
await vi.waitFor(async () => {
|
|
const waits = await db.execute(sql`select 1 from pg_stat_activity where datname = current_database()
|
|
and pid <> pg_backend_pid() and wait_event_type = 'Lock' and query like 'update "plugin_job_runs"%'`);
|
|
expect(waits.length).toBe(1);
|
|
});
|
|
stop = scheduler!.stop().then(() => { stopped = true; }, error => { failure = error; stopped = true; });
|
|
await vi.waitFor(() => expect(stopped).toBe(true), { timeout: 5000 });
|
|
expect(failure).toBeInstanceOf(AggregateError);
|
|
expect((failure as AggregateError).errors).toEqual([expect.objectContaining({ cause: expect.objectContaining({ code: "57014" }) })]);
|
|
expect(await runs()).toMatchObject([{ id: runId, status: "running" }]);
|
|
} finally {
|
|
unlock(); await holder; await stop;
|
|
}
|
|
await scheduler!.stop();
|
|
expect(await runs()).toMatchObject([{ id: runId, status: "succeeded" }]);
|
|
expect(rpc).toHaveBeenCalledOnce();
|
|
expect(errors).toEqual([]);
|
|
});
|
|
|
|
it("deleting the last job cancels its future deadline", async () => {
|
|
await job(); await start(); await settled(); await pluginJobStore(db).deleteAllJobs(pluginId); await quiet();
|
|
});
|
|
});
|