Files
PaperClipAI/server/src/__tests__/multilingual-issues-routes.test.ts
T
1477d1ecea test: remove the no-op sequential describe modifier (#15286)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Paperclip runs the server and runner test suites with Vitest.
> - Vitest 5 removes the deprecated `describe.sequential` property, so
the pending Vitest 5 upgrade fails the type-check and test jobs.
> - `describe.sequential` only changes behaviour inside a
`describe.concurrent` suite, or when `sequence.concurrent` is on.
> - This repository has neither, so the modifier changed nothing at run
time.
> - The benefit is that the Vitest 5 upgrade can land, and the test
files lose a modifier that did no work.

## Linked Issues or Issue Description

Refs: #12969

## What Changed

- Replace every `describe.sequential` use with a plain `describe` call.
- Drop the `{ concurrent: false }` suite option from the two runner test
files.
- Add a comment to `server/vitest.config.ts` that records why these
suites must run one test at a time.
- Leave the package manifests and the lockfile unchanged.

## Why the modifier did nothing

The Vitest documentation states that `describe.sequential` is useful to
run tests in sequence inside a `describe.concurrent` suite, or with the
`--sequence.concurrent` option. `sequence.concurrent` defaults to
`false`.

This repository satisfies neither condition:

- No test file uses `describe.concurrent`, `it.concurrent`, or
`test.concurrent`.
- `server/vitest.config.ts` sets `sequence.concurrent: false`, with
`maxWorkers: 1`, `maxConcurrency: 1`, and `isolate: true`.
- `packages/paperclip-runner/vitest.config.ts` sets no `sequence` block,
so the `false` default applies.

`packages/db` and `cli` already run the same embedded-Postgres suites
with a plain `describe`, and those jobs are green. The server package
was the only outlier.

The modifier did carry one real piece of knowledge: these suites need
their tests to run one at a time. The new comment in
`server/vitest.config.ts` records that reason next to the setting that
enforces it.

## Verification

- `git grep` for `describe.sequential` returns nothing outside
`node_modules`.
- The author ran the changed server test files under the installed
Vitest 4, and the results match the results without this change.
- Two very large embedded-Postgres test files exceeded the author's
local memory limit, so the CI test jobs cover those two.
- The two changed runner test files have pre-existing local failures
caused by a missing Rust toolchain and a missing global `pnpm` binary.
The failures are identical with and without this change.
- The author type-checked the changed files and found no new error.
- CI must pass the typecheck, build, server test, and runner verify
jobs.

## Risks

- Low risk. Suite execution stays serial, because the Vitest config
enforces it.
- The change adds no dependency and changes no package manifest or
lockfile.
- A future change that turns `sequence.concurrent` on would break these
suites. The new config comment warns against it.

## Model Used

- Claude Sonnet 5 — code edits and local verification.
- OpenAI Codex, GPT-5 — the earlier revision of this branch.

## Test plan

- [x] Every CI check reaches a terminal green state. A pending or queued
check is not a pass.
- [x] The `Typecheck + Release Registry` job passes. This change must
not introduce a type error.
- [x] The `Build` job passes.
- [x] The server test jobs and the runner verify jobs pass.
- [x] Greptile re-reviews this commit set and posts a passing verdict.
The dependabot waiver does not apply to this pull request.
- [x] `mergeable` reads `MERGEABLE` as a terminal value.

## 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 linked the related public issue with `Refs: #12969`
- [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 and contains no internal
Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [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
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

Co-Authored-By: Priya Raman <priya.raman@paperclip.ing>

---------

Co-authored-by: Priya Raman <priya.raman@paperclip.ing>
Co-authored-by: Paperclip <noreply@paperclip.ing>
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: nickyleach <331803+nickyleach@users.noreply.github.com>
2026-10-06 07:19:15 -07:00

193 lines
7.0 KiB
TypeScript

import { randomUUID } from "node:crypto";
import express from "express";
import request from "supertest";
import { afterAll, beforeAll, describe, expect, it, vi } from "vitest";
import { companies, companyMemberships, createDb } from "@paperclipai/db";
import {
getEmbeddedPostgresTestSupport,
startEmbeddedPostgresTestDatabase,
} from "./helpers/embedded-postgres.js";
import { errorHandler } from "../middleware/index.js";
import { issueRoutes } from "../routes/issues.js";
import type { StorageService } from "../storage/types.js";
const embeddedPostgresSupport = await getEmbeddedPostgresTestSupport();
const describeEmbeddedPostgres = embeddedPostgresSupport.supported ? describe : describe.skip;
if (!embeddedPostgresSupport.supported) {
console.warn(
`Skipping embedded Postgres multilingual issue route tests on this host: ${embeddedPostgresSupport.reason ?? "unsupported environment"}`,
);
}
describeEmbeddedPostgres("multilingual issue routes", () => {
let db!: ReturnType<typeof createDb>;
let tempDb: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>> | null = null;
let app!: ReturnType<typeof createApp>;
let companyId!: string;
const title = "验证中文任务";
const description = [
"请用中文回复并保留上下文。",
"日本語: 次の手順を書いてください。",
"हिन्दी: कृपया स्थिति बताएं।",
].join("\n");
const firstReply = [
"结果: 中文响应保留。",
"日本語の返信も保持。",
"हिन्दी उत्तर भी सुरक्षित है।",
].join("\n");
const completionNote = [
"完成: 已验证中文。",
"日本語: 完了しました。",
"हिन्दी: सत्यापन पूरा हुआ।",
].join("\n");
const documentBody = [
"# QA notes",
"",
"- 中文: 可以创建、读取、搜索、评论。",
"- 日本語: ドキュメント本文を保持します。",
"- हिन्दी: दस्तावेज़ पाठ सुरक्षित रहता है।",
].join("\n");
beforeAll(async () => {
tempDb = await startEmbeddedPostgresTestDatabase("paperclip-multilingual-issues-");
db = createDb(tempDb.connectionString);
companyId = randomUUID();
app = createApp(companyId);
await db.insert(companies).values({
id: companyId,
name: "Multilingual tenant",
issuePrefix: "LNG",
requireBoardApprovalForNewAgents: false,
});
await db.insert(companyMemberships).values({
companyId,
principalType: "user",
principalId: "cloud-user-1",
status: "active",
membershipRole: "owner",
updatedAt: new Date(),
});
}, 20_000);
afterAll(async () => {
await tempDb?.cleanup();
});
function createStorage(): StorageService {
return {
provider: "local_disk",
putFile: vi.fn(async () => {
throw new Error("Unexpected storage.putFile call in multilingual issue route test");
}),
getObject: vi.fn(async () => {
throw new Error("Unexpected storage.getObject call in multilingual issue route test");
}),
headObject: vi.fn(async () => ({ exists: false })),
deleteObject: vi.fn(async () => undefined),
};
}
function createApp(companyId: string) {
const app = express();
app.use(express.json());
app.use((req, _res, next) => {
(req as any).actor = {
type: "board",
userId: "cloud-user-1",
companyIds: [companyId],
memberships: [{ companyId, membershipRole: "owner", status: "active" }],
source: "cloud_tenant",
// cloud_tenant actors are never instance admins — reads flow through
// the active company membership seeded in beforeAll.
isInstanceAdmin: false,
};
next();
});
app.use("/api", issueRoutes(db, createStorage()));
app.use(errorHandler);
return app;
}
it("creates an issue with multilingual title and description", async () => {
const createRes = await request(app)
.post(`/api/companies/${companyId}/issues`)
.send({
title,
description,
status: "todo",
priority: "medium",
});
expect(createRes.status, JSON.stringify(createRes.body)).toBe(201);
expect(createRes.body).toMatchObject({
title,
description,
status: "todo",
priority: "medium",
identifier: "LNG-1",
});
});
it("reads the multilingual title and description unchanged", async () => {
const getRes = await request(app).get("/api/issues/LNG-1");
expect(getRes.status, JSON.stringify(getRes.body)).toBe(200);
expect(getRes.body.title).toBe(title);
expect(getRes.body.description).toBe(description);
});
it("finds the issue by Chinese search text", async () => {
const searchRes = await request(app).get(`/api/companies/${companyId}/issues`).query({ q: "中文" });
expect(searchRes.status, JSON.stringify(searchRes.body)).toBe(200);
expect(searchRes.body.map((issue: { identifier: string }) => issue.identifier)).toContain("LNG-1");
});
it("preserves multilingual comment bodies", async () => {
const commentRes = await request(app)
.post("/api/issues/LNG-1/comments")
.send({ body: firstReply });
expect(commentRes.status, JSON.stringify(commentRes.body)).toBe(201);
expect(commentRes.body.body).toBe(firstReply);
});
it("preserves multilingual document bodies", async () => {
const documentRes = await request(app)
.put("/api/issues/LNG-1/documents/qa-notes")
.send({
title: "Multilingual QA",
format: "markdown",
body: documentBody,
});
expect(documentRes.status, JSON.stringify(documentRes.body)).toBe(201);
expect(documentRes.body.body).toBe(documentBody);
});
it("preserves multilingual completion comments", async () => {
const completeRes = await request(app)
.patch("/api/issues/LNG-1")
.send({ status: "done", comment: completionNote });
expect(completeRes.status, JSON.stringify(completeRes.body)).toBe(200);
expect(completeRes.body.status).toBe("done");
expect(completeRes.body.comment.body).toBe(completionNote);
});
it("lists multilingual comments in write order", async () => {
const commentsRes = await request(app).get("/api/issues/LNG-1/comments").query({ order: "asc" });
expect(commentsRes.status, JSON.stringify(commentsRes.body)).toBe(200);
expect(commentsRes.body.map((comment: { body: string }) => comment.body)).toEqual([
firstReply,
completionNote,
]);
});
it("exposes multilingual issue text in heartbeat context", async () => {
const heartbeatContextRes = await request(app).get("/api/issues/LNG-1/heartbeat-context");
expect(heartbeatContextRes.status, JSON.stringify(heartbeatContextRes.body)).toBe(200);
expect(heartbeatContextRes.body.issue.title).toBe(title);
expect(heartbeatContextRes.body.issue.description).toBe(description);
expect(heartbeatContextRes.body.commentCursor.totalComments).toBe(2);
});
});