Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 134b627806 | |||
| 3267512ed9 | |||
| 48bd27b83c | |||
| 265b81c93d | |||
| ed808876be | |||
| a72ddbbe86 | |||
| d8fc724d90 | |||
| e4bfbcabaa | |||
| 4c1ee50dc9 | |||
| b8cce4f814 | |||
| a325ddbabd | |||
| bfcee6dddc | |||
| 36b940fdb8 | |||
| 0050ad7ebb | |||
| ce70fab1df | |||
| 7b4617db70 | |||
| b51dae16a6 | |||
| 39735afd73 | |||
| 9b4b38a611 | |||
| eebbe6717c | |||
| e348433a39 | |||
| 459d636ffb |
@@ -13,6 +13,49 @@ permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
# Guard against a long-lived branch adding a migration whose timestamped
|
||||
# filename sorts BEFORE migrations already applied on the target branch (and
|
||||
# thus in prod). The Kysely startup migrator rejects that as "corrupted
|
||||
# migrations" and crash-loops the app on boot (incident #361). This gate fails
|
||||
# the PR so the migration is renamed to a current timestamp before merge. Only
|
||||
# runs for pull_request events (needs a base branch to diff against).
|
||||
migration-order:
|
||||
if: github.event_name == 'pull_request'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
steps:
|
||||
- name: Checkout (full history for the base-branch diff)
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Added migrations must sort after the newest on the base branch
|
||||
env:
|
||||
TARGET_BRANCH: ${{ github.base_ref }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
MIG_DIR="apps/server/src/database/migrations"
|
||||
# checkout above already did fetch-depth:0 (full history). Fetch the base
|
||||
# WITHOUT --depth (a shallow graft would truncate the base history and
|
||||
# break the merge-base when the base has moved ahead of the PR merge —
|
||||
# exactly the long-branch-vs-moving-base case this gate guards, #361).
|
||||
git fetch --no-tags origin "$TARGET_BRANCH"
|
||||
newest_on_target=$(git ls-tree -r --name-only "origin/${TARGET_BRANCH}" "$MIG_DIR" | sort | tail -1)
|
||||
# NO `|| true`: a diff failure (e.g. an unresolved merge-base) must fail
|
||||
# the job CLOSED — a gate whose job is to BLOCK must never pass on error.
|
||||
# `set -e` above already aborts on a non-zero diff exit.
|
||||
added=$(git diff --diff-filter=A --name-only "origin/${TARGET_BRANCH}...HEAD" -- "$MIG_DIR")
|
||||
bad=0
|
||||
for f in $added; do
|
||||
if [[ "$f" < "$newest_on_target" || "$f" == "$newest_on_target" ]]; then
|
||||
echo "::error::Migration $f sorts at or before the newest on ${TARGET_BRANCH} ($newest_on_target) — rename it with a CURRENT timestamp before merge (do not change its contents). See incident #361."
|
||||
bad=1
|
||||
fi
|
||||
done
|
||||
if [ "$bad" -eq 0 ]; then
|
||||
echo "Migration order OK (added migrations all sort after $newest_on_target)."
|
||||
fi
|
||||
exit $bad
|
||||
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
|
||||
@@ -214,6 +214,12 @@ Run from the repo root unless noted. The dev workflow needs **Postgres (with the
|
||||
> server, `APP_SECRET` mismatch between processes, a stale `editor-ext` white-
|
||||
> screening the client, LAN exposure. See **[docs/dev-stand.md](docs/dev-stand.md)**
|
||||
> for the step-by-step and the traps.
|
||||
>
|
||||
> **Testing the app against a stand** (browser E2E + out-of-band verification) has
|
||||
> its own non-obvious traps — the page has two ProseMirror editors (only the body is
|
||||
> collab-bound), a ~10s store debounce, and API-seeding the thing under test is a
|
||||
> silent no-test. See **[docs/how-to-test.md](docs/how-to-test.md)** before writing
|
||||
> UI tests.
|
||||
|
||||
```bash
|
||||
pnpm install # install all workspaces (uses pnpm patches; see package.json `pnpm.patchedDependencies`)
|
||||
@@ -250,7 +256,10 @@ pnpm --filter server migration:codegen # regenerate src/databa
|
||||
```
|
||||
Migration files live in `apps/server/src/database/migrations/` and are named `YYYYMMDDThhmmss-description.ts`. Fork-specific migrations only **add** tables (`page_embeddings`, `ai_chats`, `ai_chat_messages`, `ai_provider_credentials`, `ai_mcp_servers`, `page_template_references`) and columns (e.g. `pages.is_template`, a `NOT NULL DEFAULT false` boolean) — never drop/rewrite Docmost data.
|
||||
|
||||
**Migration ordering — always check when merging branches/features.** Kysely runs migrations in **alphabetical (= timestamp) order** and refuses to start if a *new* migration sorts **before** one already applied to the DB (`corrupted migrations: ... must always have a name that comes alphabetically after the last executed migration`). When you merge a branch or land a feature, verify your migration's timestamp still sorts **after every migration that may already be applied on the target** (`/bin/ls -1 apps/server/src/database/migrations | sort | tail`). Branches developed in parallel routinely break this: a feature branch adds `…T130000-…`, `main` meanwhile ships and deploys `…T150000-…`, and after the merge the older-timestamped file is rejected at boot. **Fix = rename your migration to a timestamp after the latest one already in the target** (content unchanged — the filename is the ordering key), then rebuild so the compiled `dist/database/migrations/` picks up the new name.
|
||||
**Migration ordering — always check when merging branches/features.** Kysely runs migrations in **alphabetical (= timestamp) order**. A *new* migration that sorts **before** one already applied to the DB is a "back-dated" migration, which branches developed in parallel routinely produce: a feature branch adds `…T130000-…`, `develop` meanwhile ships and deploys `…T150000-…`, and after the merge the older-timestamped file has been skipped. Two layers guard this (both added for incident #361, where a back-dated migration crash-looped prod for ~11 min):
|
||||
|
||||
- **CI gate (primary):** the `migration-order` job in `.github/workflows/test.yml` fails a PR whose added migration sorts at/before the newest on the base branch. **So the fix is to rename your migration to a timestamp after the latest one already in the target** (`/bin/ls -1 apps/server/src/database/migrations | sort | tail`; content unchanged — the filename is the ordering key), then rebuild so the compiled `dist/database/migrations/` picks up the new name.
|
||||
- **Runtime safety net:** both Migrators (`migration.service.ts` startup auto-migrate + `migrate.ts` CLI) set `allowUnorderedMigrations: true`, so the app does **not** refuse to start on an out-of-order migration — it applies the skipped older one instead of crash-looping. Kysely's `#ensureNoMissingMigrations` guard is still on (a *removed* applied migration is still an error). Because apply order can then differ from lexicographic across instances, migrations must stay **independent** (each creates its own objects) — the CI gate remains the primary line; this net only covers a gate bypass (manual push / hotfix branch).
|
||||
|
||||
## Architecture — the big picture
|
||||
|
||||
@@ -294,7 +303,7 @@ Vite SPA. Code is organized by feature under `apps/client/src/features/*` (mirro
|
||||
- **Errors must never be swallowed or shown as generic messages.** Every caught error MUST (1) be logged in full to the console/logger — error name, message, stack, `cause`, and (for HTTP/provider failures) the status code and response body — and (2) be surfaced to the user with a *specific, human-readable explanation of what actually went wrong*, never a bare generic string like "Something went wrong" / "Could not start recording" / "Transcription failed". Include the real reason (the underlying error/provider message) in the user-facing text. On the server, wrap third-party/provider failures with `describeProviderError` (or equivalent) and rethrow as a meaningful HTTP status + message — never let them collapse into an opaque 500. On the client, `console.error(<context>, err)` the raw error AND show the extracted reason (e.g. `err.response?.data?.message`, or the error `name: message`) in the notification.
|
||||
- The version string shown in the UI comes from `APP_VERSION` (CI/Docker) or `git describe --tags --always` (local), resolved in `vite.config.ts` — not from `package.json`.
|
||||
- Server TS config is permissive (`noImplicitAny: false`, `strictNullChecks: false`, `no-explicit-any` lint disabled). Follow the existing relaxed style rather than tightening types broadly.
|
||||
- Dependency versions are heavily pinned via `pnpm.overrides` and `pnpm.patchedDependencies` (`scimmy`, `yjs`) in the root `package.json`. Don't bump pinned/patched deps casually; the patches and overrides exist for compatibility/security reasons.
|
||||
- Dependency versions are heavily pinned via `pnpm.overrides` and `pnpm.patchedDependencies` (`scimmy`, `yjs`, `ai`) in the root `package.json`. Don't bump pinned/patched deps casually; the patches and overrides exist for compatibility/security reasons. The `ai@6.0.134` patch disables the SDK's O(n²) cumulative `partialOutput` accumulation when no output strategy is requested (server heap OOM on long agent runs, #184; tripwire test: `apps/server/src/integrations/ai/ai-sdk-partial-output.patch.spec.ts`) — it MUST be re-created via `pnpm patch` when bumping `ai`.
|
||||
- **Adding/renaming/removing an MCP tool requires updating `SERVER_INSTRUCTIONS`** in `packages/mcp/src/index.ts` — the intent-routing guide MCP clients receive on initialize. This applies both to inline `server.registerTool(...)` calls in `index.ts` and to specs in `packages/mcp/src/tool-specs.ts`. Enforced by `packages/mcp/test/unit/server-instructions.test.mjs`, which fails when a registered tool is not mentioned in the guide (deliberate opt-outs go into its `EXCEPTIONS` list). `packages/mcp/build/` is gitignored and rebuilt in CI/Docker via `pnpm build` (same convention as `git-sync`/`prosemirror-markdown`) — never commit it; rebuild locally after editing to run the tests.
|
||||
|
||||
## CI / release
|
||||
|
||||
@@ -169,6 +169,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The server no longer runs out of heap during long autonomous agent runs.** A
|
||||
new pnpm patch on `ai@6.0.134` stops the SDK from building a cumulative
|
||||
snapshot of the ENTIRE turn text on every streamed text-delta when no output
|
||||
strategy was requested (our server never requests one). Unpatched, those
|
||||
O(n²) `partialOutput` snapshots piled up in a never-consumed internal
|
||||
`tee()` branch of the stream result — a ~20-step, ~28k-chunk agent run
|
||||
retained ~1.7 GB and OOM'd the 2 GB JS heap. Streaming granularity is
|
||||
unchanged; the patch must be re-created if `ai` is ever bumped. (#184)
|
||||
- **Internal links in exported Markdown no longer lose their visible text.** A
|
||||
link whose target page name had no file extension (e.g. a bare title) was
|
||||
collapsed to empty text during export, producing an unclickable, label-less
|
||||
|
||||
@@ -1373,6 +1373,39 @@
|
||||
"The role catalog is unavailable": "The role catalog is unavailable",
|
||||
"Please try again later.": "Please try again later.",
|
||||
"No bundles available": "No bundles available",
|
||||
"Content": "Content",
|
||||
"Content language of the roles": "Content language of the roles",
|
||||
"{{count}} updates available in {{bundles}} bundles": "{{count}} updates available in {{bundles}} bundles",
|
||||
"Update all ({{count}})": "Update all ({{count}})",
|
||||
"Updating {{current}}/{{total}}…": "Updating {{current}}/{{total}}…",
|
||||
"{{count}} roles are installed in another language. A different language installs separately and appears as new.": "{{count}} roles are installed in another language. A different language installs separately and appears as new.",
|
||||
"{{count}} roles": "{{count}} roles",
|
||||
"{{count}} new — none installed": "{{count}} new — none installed",
|
||||
"All installed · up to date": "All installed · up to date",
|
||||
"{{count}} updates · {{installed}} up to date": "{{count}} updates · {{installed}} up to date",
|
||||
"{{count}} new": "{{count}} new",
|
||||
"{{count}} installed": "{{count}} installed",
|
||||
"{{count}} updates": "{{count}} updates",
|
||||
"Install bundle": "Install bundle",
|
||||
"Install {{count}} selected": "Install {{count}} selected",
|
||||
"Install bundle ({{count}})": "Install bundle ({{count}})",
|
||||
"{{selected}} of {{total}} selected": "{{selected}} of {{total}} selected",
|
||||
"Select all": "Select all",
|
||||
"Deselect all": "Deselect all",
|
||||
"Skipped": "Skipped",
|
||||
"v{{version}}": "v{{version}}",
|
||||
"{{count}} roles installed": "{{count}} roles installed",
|
||||
"{{count}} roles installed · {{renamed}} renamed": "{{count}} roles installed · {{renamed}} renamed",
|
||||
"{{count}} roles updated": "{{count}} roles updated",
|
||||
"Installed {{installed}} · {{skipped}} skipped": "Installed {{installed}} · {{skipped}} skipped",
|
||||
"A role named \"{{name}}\" already exists in this workspace.": "A role named \"{{name}}\" already exists in this workspace.",
|
||||
"\"{{name}}\" is already installed.": "\"{{name}}\" is already installed.",
|
||||
"Rename & install": "Rename & install",
|
||||
"Couldn’t load the catalog": "Couldn’t load the catalog",
|
||||
"Check your connection and try again. Installed roles are not affected.": "Check your connection and try again. Installed roles are not affected.",
|
||||
"Retry": "Retry",
|
||||
"The catalog is empty": "The catalog is empty",
|
||||
"No role bundles are published for this language yet. Try switching the content language.": "No role bundles are published for this language yet. Try switching the content language.",
|
||||
"Already up to date": "Already up to date",
|
||||
"Updated to the latest version": "Updated to the latest version",
|
||||
"This role is no longer in the catalog": "This role is no longer in the catalog",
|
||||
|
||||
@@ -1235,6 +1235,39 @@
|
||||
"The role catalog is unavailable": "Каталог ролей недоступен",
|
||||
"Please try again later.": "Попробуйте позже.",
|
||||
"No bundles available": "Наборы недоступны",
|
||||
"Content": "Язык контента",
|
||||
"Content language of the roles": "Язык контента ролей",
|
||||
"{{count}} updates available in {{bundles}} bundles": "Доступно обновлений: {{count}} в наборах: {{bundles}}",
|
||||
"Update all ({{count}})": "Обновить все ({{count}})",
|
||||
"Updating {{current}}/{{total}}…": "Обновление {{current}}/{{total}}…",
|
||||
"{{count}} roles are installed in another language. A different language installs separately and appears as new.": "Ролей установлено на другом языке: {{count}}. Другой язык устанавливается отдельно и отображается как новый.",
|
||||
"{{count}} roles": "ролей: {{count}}",
|
||||
"{{count}} new — none installed": "новых: {{count}} — ничего не установлено",
|
||||
"All installed · up to date": "Все установлены · актуальны",
|
||||
"{{count}} updates · {{installed}} up to date": "обновлений: {{count}} · актуальны: {{installed}}",
|
||||
"{{count}} new": "новых: {{count}}",
|
||||
"{{count}} installed": "установлено: {{count}}",
|
||||
"{{count}} updates": "обновлений: {{count}}",
|
||||
"Install bundle": "Установить набор",
|
||||
"Install {{count}} selected": "Установить выбранные ({{count}})",
|
||||
"Install bundle ({{count}})": "Установить набор ({{count}})",
|
||||
"{{selected}} of {{total}} selected": "выбрано {{selected}} из {{total}}",
|
||||
"Select all": "Выбрать все",
|
||||
"Deselect all": "Снять выбор",
|
||||
"Skipped": "Пропущено",
|
||||
"v{{version}}": "v{{version}}",
|
||||
"{{count}} roles installed": "Установлено ролей: {{count}}",
|
||||
"{{count}} roles installed · {{renamed}} renamed": "Установлено ролей: {{count}} · переименовано: {{renamed}}",
|
||||
"{{count}} roles updated": "Обновлено ролей: {{count}}",
|
||||
"Installed {{installed}} · {{skipped}} skipped": "Установлено: {{installed}} · пропущено: {{skipped}}",
|
||||
"A role named \"{{name}}\" already exists in this workspace.": "Роль с именем «{{name}}» уже существует в этом рабочем пространстве.",
|
||||
"\"{{name}}\" is already installed.": "«{{name}}» уже установлена.",
|
||||
"Rename & install": "Переименовать и установить",
|
||||
"Couldn’t load the catalog": "Не удалось загрузить каталог",
|
||||
"Check your connection and try again. Installed roles are not affected.": "Проверьте подключение и попробуйте снова. Установленные роли не затронуты.",
|
||||
"Retry": "Повторить",
|
||||
"The catalog is empty": "Каталог пуст",
|
||||
"No role bundles are published for this language yet. Try switching the content language.": "Для этого языка ещё не опубликовано ни одного набора ролей. Попробуйте сменить язык контента.",
|
||||
"No roles configured": "Роли не настроены",
|
||||
"Already up to date": "Уже актуальна",
|
||||
"Updated to the latest version": "Обновлено до последней версии",
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import {
|
||||
useInfiniteQuery,
|
||||
useMutation,
|
||||
useQueries,
|
||||
useQuery,
|
||||
useQueryClient,
|
||||
} from "@tanstack/react-query";
|
||||
@@ -307,6 +308,29 @@ export function useAiRoleCatalogBundleQuery(
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Eagerly open EVERY listed bundle's content in parallel for one language. The
|
||||
* redesigned catalog shows each bundle's status summary in its COLLAPSED header,
|
||||
* which needs every role's install state up front — so contents can no longer be
|
||||
* lazy-loaded on expand. The catalog is small, so a fan-out of `useQueries` (one
|
||||
* cached read per bundle, sharing the same cache keys as
|
||||
* `useAiRoleCatalogBundleQuery`) is cheap. Gated by `enabled` (modal open + a
|
||||
* resolved language) so nothing fetches while the modal is closed.
|
||||
*/
|
||||
export function useAiRoleCatalogBundlesQueries(
|
||||
bundleIds: string[],
|
||||
language: string,
|
||||
enabled: boolean,
|
||||
) {
|
||||
return useQueries({
|
||||
queries: bundleIds.map((bundleId) => ({
|
||||
queryKey: AI_ROLE_CATALOG_BUNDLE_RQ_KEY(bundleId, language),
|
||||
queryFn: () => getAiRoleCatalogBundle(bundleId, language),
|
||||
enabled: enabled && !!language,
|
||||
})),
|
||||
});
|
||||
}
|
||||
|
||||
export function useImportAiRolesFromCatalogMutation() {
|
||||
const queryClient = useQueryClient();
|
||||
const { t } = useTranslation();
|
||||
|
||||
@@ -77,7 +77,14 @@ describe("useImportAiRolesFromCatalogMutation — success notifications", () =>
|
||||
});
|
||||
|
||||
it("errors:[] -> only the summary notification (counts interpolated)", async () => {
|
||||
await runMutation({ created: 3, renamed: 1, skipped: 2, errors: [] });
|
||||
await runMutation({
|
||||
created: 3,
|
||||
renamed: 1,
|
||||
skipped: 2,
|
||||
errors: [],
|
||||
createdRoles: [],
|
||||
skippedRoles: [],
|
||||
});
|
||||
expect(notificationsShowMock).toHaveBeenCalledTimes(1);
|
||||
expect(notificationsShowMock).toHaveBeenCalledWith({
|
||||
message: "Imported 3, renamed 1, skipped 2",
|
||||
@@ -93,6 +100,8 @@ describe("useImportAiRolesFromCatalogMutation — success notifications", () =>
|
||||
{ slug: "a", message: "name taken" },
|
||||
{ slug: "b", message: "name taken" },
|
||||
],
|
||||
createdRoles: [{ slug: "ok", name: "Ok" }],
|
||||
skippedRoles: [],
|
||||
});
|
||||
expect(notificationsShowMock).toHaveBeenCalledTimes(2);
|
||||
expect(notificationsShowMock).toHaveBeenNthCalledWith(1, {
|
||||
|
||||
@@ -108,12 +108,25 @@ export interface IAiRoleImportPayload {
|
||||
conflict: "skip" | "rename";
|
||||
}
|
||||
|
||||
/** Import result counts (mirrors `importFromCatalog()`). */
|
||||
/**
|
||||
* Import result (mirrors `importFromCatalog()`). The counters (`created`,
|
||||
* `skipped`, `renamed`) drive the summary notification; the per-role lists
|
||||
* (`createdRoles`, `skippedRoles`) drive the redesigned catalog modal's inline
|
||||
* result plaque — which roles were installed (and any rename) and which were
|
||||
* skipped and why (so the plaque can name the conflicting role and offer
|
||||
* "Rename & install").
|
||||
*/
|
||||
export interface IAiRoleImportResult {
|
||||
created: number;
|
||||
skipped: number;
|
||||
renamed: number;
|
||||
errors: { slug: string; message: string }[];
|
||||
createdRoles: { slug: string; name: string; renamedTo?: string }[];
|
||||
skippedRoles: {
|
||||
slug: string;
|
||||
name: string;
|
||||
reason: "name-conflict" | "already-installed";
|
||||
}[];
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -0,0 +1,234 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import {
|
||||
bundleCounts,
|
||||
bundlePhase,
|
||||
installedLangForRole,
|
||||
mapBundleRolesToView,
|
||||
mapCatalogRoleToView,
|
||||
nameConflictSlugs,
|
||||
partialOffersRename,
|
||||
type CatalogViewRole,
|
||||
} from "./catalog-bundle-model.ts";
|
||||
import type {
|
||||
IAiRole,
|
||||
IAiRoleCatalogRole,
|
||||
} from "@/features/ai-chat/types/ai-chat.types.ts";
|
||||
|
||||
function installedRole(
|
||||
source: { slug: string; language: string; version: number },
|
||||
overrides: Partial<IAiRole> = {},
|
||||
): IAiRole {
|
||||
return {
|
||||
id: `role-${source.slug}-${source.language}`,
|
||||
name: source.slug,
|
||||
emoji: null,
|
||||
description: null,
|
||||
enabled: true,
|
||||
autoStart: true,
|
||||
launchMessage: null,
|
||||
source,
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
function catalogRole(
|
||||
overrides: Partial<IAiRoleCatalogRole> = {},
|
||||
): IAiRoleCatalogRole {
|
||||
return {
|
||||
slug: "writer",
|
||||
emoji: "✍️",
|
||||
name: "Writer",
|
||||
description: "Drafts copy.",
|
||||
instructions: "be a writer",
|
||||
autoStart: true,
|
||||
launchMessage: null,
|
||||
version: 3,
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
// Build a minimal view role for bundlePhase tests.
|
||||
function viewRole(status: CatalogViewRole["status"]): CatalogViewRole {
|
||||
return { slug: `s-${status}`, name: status, description: "", version: 1, status };
|
||||
}
|
||||
|
||||
describe("bundlePhase", () => {
|
||||
it("empty bundle -> empty", () => {
|
||||
expect(bundlePhase([])).toBe("empty");
|
||||
});
|
||||
|
||||
it("all importable, none installed -> allNew", () => {
|
||||
expect(bundlePhase([viewRole("import"), viewRole("import")])).toBe(
|
||||
"allNew",
|
||||
);
|
||||
});
|
||||
|
||||
it("nothing to import or update -> allInstalled", () => {
|
||||
expect(bundlePhase([viewRole("installed"), viewRole("installed")])).toBe(
|
||||
"allInstalled",
|
||||
);
|
||||
});
|
||||
|
||||
it("updates present, nothing to import -> updates", () => {
|
||||
expect(bundlePhase([viewRole("update"), viewRole("installed")])).toBe(
|
||||
"updates",
|
||||
);
|
||||
});
|
||||
|
||||
it("import + installed (no updates) -> mixed", () => {
|
||||
expect(bundlePhase([viewRole("import"), viewRole("installed")])).toBe(
|
||||
"mixed",
|
||||
);
|
||||
});
|
||||
|
||||
it("import + update -> mixed", () => {
|
||||
expect(bundlePhase([viewRole("import"), viewRole("update")])).toBe("mixed");
|
||||
});
|
||||
|
||||
it("a skipped role with nothing installed -> mixed (NOT allInstalled)", () => {
|
||||
// F1: a bundle whose only non-installed role was skipped has 0 installed for
|
||||
// it, so the collapsed 'All installed · up to date' header would contradict
|
||||
// the open 'Installed 0 · 1 skipped' plaque. It must be mixed until resolved.
|
||||
expect(bundlePhase([viewRole("skipped")])).toBe("mixed");
|
||||
});
|
||||
|
||||
it("installed + a skipped role -> mixed (partial success is not allInstalled)", () => {
|
||||
expect(bundlePhase([viewRole("installed"), viewRole("skipped")])).toBe(
|
||||
"mixed",
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("bundleCounts", () => {
|
||||
it("tallies each status once", () => {
|
||||
expect(
|
||||
bundleCounts([
|
||||
viewRole("import"),
|
||||
viewRole("import"),
|
||||
viewRole("installed"),
|
||||
viewRole("update"),
|
||||
viewRole("skipped"),
|
||||
]),
|
||||
).toEqual({ importable: 2, installed: 1, update: 1, skipped: 1 });
|
||||
});
|
||||
});
|
||||
|
||||
describe("nameConflictSlugs / partialOffersRename (reason -> action)", () => {
|
||||
it("only name-conflict skips become the transient overlay / offer rename", () => {
|
||||
const skipped = [
|
||||
{ slug: "writer", name: "Writer", reason: "name-conflict" as const },
|
||||
{ slug: "editor", name: "Editor", reason: "already-installed" as const },
|
||||
];
|
||||
expect(nameConflictSlugs(skipped)).toEqual(["writer"]);
|
||||
expect(partialOffersRename(skipped)).toBe(true);
|
||||
});
|
||||
|
||||
it("an already-installed-only skip is informational: no overlay, no rename", () => {
|
||||
const skipped = [
|
||||
{ slug: "editor", name: "Editor", reason: "already-installed" as const },
|
||||
];
|
||||
expect(nameConflictSlugs(skipped)).toEqual([]);
|
||||
expect(partialOffersRename(skipped)).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("installedLangForRole", () => {
|
||||
it("returns the other language when the same slug is installed elsewhere", () => {
|
||||
const roles = [installedRole({ slug: "writer", language: "ru", version: 2 })];
|
||||
expect(installedLangForRole("writer", roles, "en")).toBe("ru");
|
||||
});
|
||||
|
||||
it("returns undefined when the same slug is installed in the SAME language", () => {
|
||||
const roles = [installedRole({ slug: "writer", language: "en", version: 2 })];
|
||||
expect(installedLangForRole("writer", roles, "en")).toBeUndefined();
|
||||
});
|
||||
|
||||
it("returns undefined when no install of the slug exists", () => {
|
||||
expect(installedLangForRole("writer", [], "en")).toBeUndefined();
|
||||
});
|
||||
|
||||
it("ignores manually-created roles (no source)", () => {
|
||||
const roles = [
|
||||
installedRole({ slug: "writer", language: "ru", version: 2 }, {
|
||||
source: null,
|
||||
}),
|
||||
];
|
||||
expect(installedLangForRole("writer", roles, "en")).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe("mapCatalogRoleToView", () => {
|
||||
it("no install -> import status, catalog version, emoji preserved", () => {
|
||||
const view = mapCatalogRoleToView(catalogRole(), [], "en");
|
||||
expect(view).toMatchObject({
|
||||
slug: "writer",
|
||||
emoji: "✍️",
|
||||
name: "Writer",
|
||||
description: "Drafts copy.",
|
||||
status: "import",
|
||||
version: 3,
|
||||
});
|
||||
expect(view.installedRoleId).toBeUndefined();
|
||||
expect(view.installedLang).toBeUndefined();
|
||||
});
|
||||
|
||||
it("import with the slug installed in another language -> installedLang set", () => {
|
||||
const roles = [installedRole({ slug: "writer", language: "ru", version: 9 })];
|
||||
const view = mapCatalogRoleToView(catalogRole(), roles, "en");
|
||||
expect(view.status).toBe("import");
|
||||
expect(view.installedLang).toBe("ru");
|
||||
});
|
||||
|
||||
it("installed (up to date) -> installed status, catalog version, installedRoleId", () => {
|
||||
const installed = installedRole({
|
||||
slug: "writer",
|
||||
language: "en",
|
||||
version: 3,
|
||||
});
|
||||
const view = mapCatalogRoleToView(catalogRole(), [installed], "en");
|
||||
expect(view).toMatchObject({
|
||||
status: "installed",
|
||||
version: 3,
|
||||
installedRoleId: installed.id,
|
||||
});
|
||||
});
|
||||
|
||||
it("update -> version=from, newVersion=to, installedRoleId", () => {
|
||||
const installed = installedRole({
|
||||
slug: "writer",
|
||||
language: "en",
|
||||
version: 1,
|
||||
});
|
||||
const view = mapCatalogRoleToView(catalogRole(), [installed], "en");
|
||||
expect(view).toMatchObject({
|
||||
status: "update",
|
||||
version: 1,
|
||||
newVersion: 3,
|
||||
installedRoleId: installed.id,
|
||||
});
|
||||
});
|
||||
|
||||
it("missing emoji -> emoji undefined; null description -> empty string", () => {
|
||||
const view = mapCatalogRoleToView(
|
||||
catalogRole({ emoji: null, description: null }),
|
||||
[],
|
||||
"en",
|
||||
);
|
||||
expect(view.emoji).toBeUndefined();
|
||||
expect(view.description).toBe("");
|
||||
});
|
||||
});
|
||||
|
||||
describe("mapBundleRolesToView", () => {
|
||||
it("maps a bundle's roles preserving order", () => {
|
||||
const roles = [
|
||||
catalogRole({ slug: "a", name: "A", version: 1 }),
|
||||
catalogRole({ slug: "b", name: "B", version: 1 }),
|
||||
];
|
||||
const installed = [installedRole({ slug: "a", language: "en", version: 1 })];
|
||||
const view = mapBundleRolesToView(roles, installed, "en");
|
||||
expect(view.map((r) => r.slug)).toEqual(["a", "b"]);
|
||||
expect(view[0].status).toBe("installed");
|
||||
expect(view[1].status).toBe("import");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,206 @@
|
||||
import type {
|
||||
IAiRole,
|
||||
IAiRoleCatalogRole,
|
||||
} from "@/features/ai-chat/types/ai-chat.types.ts";
|
||||
import { catalogRoleInstallState } from "@/features/ai-chat/utils/catalog-role-install-state.ts";
|
||||
|
||||
/**
|
||||
* The redesigned catalog modal renders bundles as cards with a summary status
|
||||
* (readable without expanding) and a single primary action. The per-role and
|
||||
* per-bundle view model that drives that UI is derived here as PURE functions so
|
||||
* the mapping, the "installed in another language" hint, and the bundle-phase
|
||||
* computation are unit-testable without mounting the component (mirrors the
|
||||
* `catalogRoleInstallState` precedent).
|
||||
*/
|
||||
|
||||
/**
|
||||
* A role's status in the catalog view model.
|
||||
* - `import` — not installed in the current content language.
|
||||
* - `installed` — installed and up to date.
|
||||
* - `update` — installed, but the catalog ships a newer version.
|
||||
* - `skipped` — TRANSIENT client-only status set after a conflicted import
|
||||
* (a name collision under `conflict:'skip'`); never from the
|
||||
* backend.
|
||||
*/
|
||||
export type RoleStatus = "import" | "installed" | "update" | "skipped";
|
||||
|
||||
/** A catalog role mapped into the modal's view model. */
|
||||
export interface CatalogViewRole {
|
||||
// Slug is the stable identity within a bundle; used as the row key and as the
|
||||
// `slugs[]` payload for import.
|
||||
slug: string;
|
||||
// Optional in the catalog — the row reserves space and renders nothing when
|
||||
// absent.
|
||||
emoji?: string;
|
||||
name: string;
|
||||
description: string;
|
||||
// For `installed`/`import`: the catalog version. For `update`: the installed
|
||||
// (from) version, with `newVersion` holding the catalog (to) version.
|
||||
version: number;
|
||||
newVersion?: number;
|
||||
status: RoleStatus;
|
||||
// The language a same-slug role is installed under, when it differs from the
|
||||
// current content language (drives the Р5 hint). Only set for `import` roles.
|
||||
installedLang?: string;
|
||||
// The workspace role id, present for `installed`/`update` — needed to call the
|
||||
// update-from-catalog mutation.
|
||||
installedRoleId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* The summary phase of a bundle, derived from its roles' statuses. Determines
|
||||
* the collapsed-header summary and the bundle's single primary action.
|
||||
* - `empty` — the bundle has no roles.
|
||||
* - `allNew` — everything is importable, nothing installed.
|
||||
* - `allInstalled` — everything installed & up to date; nothing else pending.
|
||||
* - `updates` — updates available and nothing left to import.
|
||||
* - `mixed` — any other combination.
|
||||
*/
|
||||
export type BundlePhase =
|
||||
| "empty"
|
||||
| "allNew"
|
||||
| "allInstalled"
|
||||
| "updates"
|
||||
| "mixed";
|
||||
|
||||
/** Per-status tallies for a bundle's roles (the single source of truth). */
|
||||
export interface BundleCounts {
|
||||
importable: number;
|
||||
installed: number;
|
||||
update: number;
|
||||
skipped: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Count a bundle's roles by status ONCE. Both `bundlePhase` and the panel derive
|
||||
* from this, so the tally logic lives in exactly one place (no rescans / drift).
|
||||
*/
|
||||
export function bundleCounts(roles: CatalogViewRole[]): BundleCounts {
|
||||
const counts: BundleCounts = {
|
||||
importable: 0,
|
||||
installed: 0,
|
||||
update: 0,
|
||||
skipped: 0,
|
||||
};
|
||||
for (const r of roles) {
|
||||
if (r.status === "import") counts.importable += 1;
|
||||
else if (r.status === "installed") counts.installed += 1;
|
||||
else if (r.status === "update") counts.update += 1;
|
||||
else if (r.status === "skipped") counts.skipped += 1;
|
||||
}
|
||||
return counts;
|
||||
}
|
||||
|
||||
export function bundlePhase(roles: CatalogViewRole[]): BundlePhase {
|
||||
if (roles.length === 0) return "empty";
|
||||
const { importable, installed, update, skipped } = bundleCounts(roles);
|
||||
// A `skipped` role is a pending post-import conflict (0 installed for it), so a
|
||||
// bundle that has ANY skipped role is NOT "all installed & up to date" — that
|
||||
// would make the collapsed green "up to date" header contradict the open
|
||||
// panel's "Installed 0 · 1 skipped" plaque. It is `mixed` until resolved.
|
||||
if (importable === 0 && update === 0 && skipped === 0) return "allInstalled";
|
||||
if (update > 0 && importable === 0 && skipped === 0) return "updates";
|
||||
if (importable > 0 && installed === 0 && update === 0 && skipped === 0)
|
||||
return "allNew";
|
||||
return "mixed";
|
||||
}
|
||||
|
||||
/**
|
||||
* The subset of a skip result that should be shown as a TRANSIENT `skipped`
|
||||
* overlay in the bundle (so the row offers a re-import path). Only NAME-CONFLICT
|
||||
* skips qualify: an `already-installed` skip (a concurrent-import race) has
|
||||
* nothing to act on — re-importing the same slug would just skip again — so it
|
||||
* must NOT be overlaid (else the row shows a misleading "Rename & install" that
|
||||
* self-heals into a false "installed"). Pure so both reason branches are tested.
|
||||
*/
|
||||
export function nameConflictSlugs(
|
||||
skipped: { slug: string; reason: "name-conflict" | "already-installed" }[],
|
||||
): string[] {
|
||||
return skipped
|
||||
.filter((s) => s.reason === "name-conflict")
|
||||
.map((s) => s.slug);
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a partial-import result should offer the "Rename & install" action:
|
||||
* only when at least one skip is a name conflict (renameable). An
|
||||
* `already-installed`-only partial is informational.
|
||||
*/
|
||||
export function partialOffersRename(
|
||||
skipped: { reason: "name-conflict" | "already-installed" }[],
|
||||
): boolean {
|
||||
return skipped.some((s) => s.reason === "name-conflict");
|
||||
}
|
||||
|
||||
/**
|
||||
* For a role NOT installed in the current `language`, find a workspace role with
|
||||
* the same catalog `slug` installed under a DIFFERENT language, and return that
|
||||
* language. Drives the "installed in another language" hint (Р5): a different
|
||||
* language of the same slug is a separate install and appears as `import`.
|
||||
*/
|
||||
export function installedLangForRole(
|
||||
slug: string,
|
||||
workspaceRoles: IAiRole[],
|
||||
language: string,
|
||||
): string | undefined {
|
||||
const other = workspaceRoles.find(
|
||||
(r) =>
|
||||
r.source?.slug === slug &&
|
||||
!!r.source?.language &&
|
||||
r.source.language !== language,
|
||||
);
|
||||
return other?.source?.language;
|
||||
}
|
||||
|
||||
/**
|
||||
* Map one catalog role to the view model, computing its install status against
|
||||
* the workspace roles (via `catalogRoleInstallState`) and, for importable roles,
|
||||
* the other-language hint.
|
||||
*/
|
||||
export function mapCatalogRoleToView(
|
||||
role: IAiRoleCatalogRole,
|
||||
workspaceRoles: IAiRole[],
|
||||
language: string,
|
||||
): CatalogViewRole {
|
||||
const state = catalogRoleInstallState(role, workspaceRoles, language);
|
||||
const base = {
|
||||
slug: role.slug,
|
||||
emoji: role.emoji ?? undefined,
|
||||
name: role.name,
|
||||
description: role.description ?? "",
|
||||
};
|
||||
if (state.state === "update") {
|
||||
return {
|
||||
...base,
|
||||
status: "update",
|
||||
version: state.fromVersion,
|
||||
newVersion: state.toVersion,
|
||||
installedRoleId: state.installed.id,
|
||||
};
|
||||
}
|
||||
if (state.state === "installed") {
|
||||
return {
|
||||
...base,
|
||||
status: "installed",
|
||||
version: role.version,
|
||||
installedRoleId: state.installed.id,
|
||||
};
|
||||
}
|
||||
return {
|
||||
...base,
|
||||
status: "import",
|
||||
version: role.version,
|
||||
installedLang: installedLangForRole(role.slug, workspaceRoles, language),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Map a whole bundle's catalog roles to the view model, preserving order.
|
||||
*/
|
||||
export function mapBundleRolesToView(
|
||||
roles: IAiRoleCatalogRole[],
|
||||
workspaceRoles: IAiRole[],
|
||||
language: string,
|
||||
): CatalogViewRole[] {
|
||||
return roles.map((r) => mapCatalogRoleToView(r, workspaceRoles, language));
|
||||
}
|
||||
+976
-275
File diff suppressed because it is too large
Load Diff
@@ -610,6 +610,63 @@ describe('AiAgentRolesService guards', () => {
|
||||
expect(repo.insert.mock.calls[0][0].name).toBe('Researcher (2)');
|
||||
});
|
||||
|
||||
it('createdRoles lists the installed role (no renamedTo when not renamed)', async () => {
|
||||
const { service } = makeImportService({});
|
||||
const res = await service.importFromCatalog('ws-1', 'u1', dto());
|
||||
expect(res.createdRoles).toEqual([
|
||||
{ slug: 'researcher', name: 'Researcher' },
|
||||
]);
|
||||
expect(res.skippedRoles).toEqual([]);
|
||||
});
|
||||
|
||||
it('createdRoles carries renamedTo on a rename', async () => {
|
||||
const existing = [makeRow({ id: 'r-x', name: 'Researcher' })];
|
||||
const { service } = makeImportService({ existing });
|
||||
const res = await service.importFromCatalog(
|
||||
'ws-1',
|
||||
'u1',
|
||||
dto({ conflict: 'rename' }),
|
||||
);
|
||||
expect(res.createdRoles).toEqual([
|
||||
{ slug: 'researcher', name: 'Researcher', renamedTo: 'Researcher (2)' },
|
||||
]);
|
||||
expect(res.skippedRoles).toEqual([]);
|
||||
});
|
||||
|
||||
it('skippedRoles: already-installed slug carries reason "already-installed"', async () => {
|
||||
const existing = [
|
||||
makeRow({
|
||||
id: 'r-existing',
|
||||
name: 'Old researcher',
|
||||
source: { slug: 'researcher', language: 'en', version: 1 } as never,
|
||||
}),
|
||||
];
|
||||
const { service } = makeImportService({ existing });
|
||||
const res = await service.importFromCatalog('ws-1', 'u1', dto());
|
||||
expect(res.skippedRoles).toEqual([
|
||||
{
|
||||
slug: 'researcher',
|
||||
name: 'Researcher',
|
||||
reason: 'already-installed',
|
||||
},
|
||||
]);
|
||||
expect(res.createdRoles).toEqual([]);
|
||||
});
|
||||
|
||||
it('skippedRoles: a name collision under conflict:skip carries reason "name-conflict"', async () => {
|
||||
const existing = [makeRow({ id: 'r-x', name: 'Researcher' })];
|
||||
const { service } = makeImportService({ existing });
|
||||
const res = await service.importFromCatalog(
|
||||
'ws-1',
|
||||
'u1',
|
||||
dto({ conflict: 'skip' }),
|
||||
);
|
||||
expect(res.skippedRoles).toEqual([
|
||||
{ slug: 'researcher', name: 'Researcher', reason: 'name-conflict' },
|
||||
]);
|
||||
expect(res.createdRoles).toEqual([]);
|
||||
});
|
||||
|
||||
it('dto.slugs filters; an unknown slug becomes an error entry', async () => {
|
||||
const { service, repo } = makeImportService({
|
||||
bundleRoles: [catalogRole()],
|
||||
@@ -677,6 +734,15 @@ describe('AiAgentRolesService guards', () => {
|
||||
// 'a' converged on the concurrent install (skip); 'b' imported; no errors.
|
||||
expect(res).toMatchObject({ created: 1, skipped: 1, renamed: 0 });
|
||||
expect(res.errors).toEqual([]);
|
||||
// The per-role list records 'a' as an already-installed skip (the UI reads
|
||||
// skippedRoles, not the counter, to render its plaque — assert the array,
|
||||
// not just the count).
|
||||
expect(res.skippedRoles).toContainEqual({
|
||||
slug: 'a',
|
||||
name: 'A',
|
||||
reason: 'already-installed',
|
||||
});
|
||||
expect(res.createdRoles.map((r) => r.slug)).toEqual(['b']);
|
||||
// Both inserts were attempted (the batch did not abort on the 23505).
|
||||
expect(repo.insert).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
@@ -305,6 +305,16 @@ export class AiAgentRolesService {
|
||||
skipped: number;
|
||||
renamed: number;
|
||||
errors: { slug: string; message: string }[];
|
||||
// Per-role lists alongside the counters (kept for back-compat). The redesigned
|
||||
// catalog UI needs the actual roles — which were created (and any rename) and
|
||||
// which were skipped and why — to render an inline result plaque with the
|
||||
// conflicting role's name and a "Rename & install" affordance.
|
||||
createdRoles: { slug: string; name: string; renamedTo?: string }[];
|
||||
skippedRoles: {
|
||||
slug: string;
|
||||
name: string;
|
||||
reason: 'name-conflict' | 'already-installed';
|
||||
}[];
|
||||
}> {
|
||||
const { file, versions } = await this.loadBundleById(
|
||||
dto.bundleId,
|
||||
@@ -312,6 +322,13 @@ export class AiAgentRolesService {
|
||||
);
|
||||
|
||||
const errors: { slug: string; message: string }[] = [];
|
||||
const createdRoles: { slug: string; name: string; renamedTo?: string }[] =
|
||||
[];
|
||||
const skippedRoles: {
|
||||
slug: string;
|
||||
name: string;
|
||||
reason: 'name-conflict' | 'already-installed';
|
||||
}[] = [];
|
||||
|
||||
// Resolve the selected catalog roles (honor dto.slugs; flag unknown ones).
|
||||
let selected = file.roles;
|
||||
@@ -351,16 +368,27 @@ export class AiAgentRolesService {
|
||||
// Already installed from the catalog in THIS language => skip (use
|
||||
// update-from-catalog). A different language of the same slug still imports.
|
||||
const installKey = `${role.slug}:${dto.language}`;
|
||||
const originalName = role.name.trim();
|
||||
if (installedKeys.has(installKey)) {
|
||||
skipped++;
|
||||
skippedRoles.push({
|
||||
slug: role.slug,
|
||||
name: originalName,
|
||||
reason: 'already-installed',
|
||||
});
|
||||
continue;
|
||||
}
|
||||
|
||||
let name = role.name.trim();
|
||||
let name = originalName;
|
||||
let didRename = false;
|
||||
if (takenNames.has(name.toLowerCase())) {
|
||||
if (dto.conflict === 'skip') {
|
||||
skipped++;
|
||||
skippedRoles.push({
|
||||
slug: role.slug,
|
||||
name: originalName,
|
||||
reason: 'name-conflict',
|
||||
});
|
||||
continue;
|
||||
}
|
||||
// conflict === 'rename': find a free " (N)" suffix.
|
||||
@@ -380,6 +408,11 @@ export class AiAgentRolesService {
|
||||
});
|
||||
created++;
|
||||
if (didRename) renamed++;
|
||||
createdRoles.push({
|
||||
slug: role.slug,
|
||||
name: originalName,
|
||||
...(didRename ? { renamedTo: name } : {}),
|
||||
});
|
||||
takenNames.add(name.toLowerCase());
|
||||
installedKeys.add(installKey);
|
||||
} catch (err) {
|
||||
@@ -391,6 +424,11 @@ export class AiAgentRolesService {
|
||||
// skipped (already installed) and continue; do NOT abort or error.
|
||||
if (isSourceUniqueViolation(err)) {
|
||||
skipped++;
|
||||
skippedRoles.push({
|
||||
slug: role.slug,
|
||||
name: originalName,
|
||||
reason: 'already-installed',
|
||||
});
|
||||
installedKeys.add(installKey);
|
||||
continue;
|
||||
}
|
||||
@@ -407,7 +445,7 @@ export class AiAgentRolesService {
|
||||
}
|
||||
}
|
||||
|
||||
return { created, skipped, renamed, errors };
|
||||
return { created, skipped, renamed, errors, createdRoles, skippedRoles };
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -539,3 +539,115 @@ describe('AiChatToolsService model-friendly input validation (#190)', () => {
|
||||
expect(result.error?.message).toContain('parameter "pageId": missing (required)');
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* #294 F1 — the contract-parity test introspects only the ADVERTISED schema keys
|
||||
* (buildShape), not the execute bodies. Most execs are unchanged pass-throughs,
|
||||
* but two wirings actually CHANGED in the migration and are otherwise untested:
|
||||
* - movePage now forwards the newly-added optional `position` field to the
|
||||
* client (client.movePage(pageId, parentPageId, position));
|
||||
* - the table trio unified its `tableRef` param to `table` and must forward it
|
||||
* positionally. A field destructured under the wrong name would silently pass
|
||||
* `undefined` to the client (execute is `any`-cast, so tsc won't catch it).
|
||||
*/
|
||||
describe('AiChatToolsService #294 changed execute wirings', () => {
|
||||
const calls: Record<string, unknown[][]> = {
|
||||
movePage: [],
|
||||
tableInsertRow: [],
|
||||
tableDeleteRow: [],
|
||||
tableUpdateCell: [],
|
||||
};
|
||||
const fakeClient: Partial<DocmostClientLike> = {
|
||||
movePage: (...args: unknown[]) => {
|
||||
calls.movePage.push(args);
|
||||
return Promise.resolve({ success: true });
|
||||
},
|
||||
tableInsertRow: (...args: unknown[]) => {
|
||||
calls.tableInsertRow.push(args);
|
||||
return Promise.resolve({ ok: true });
|
||||
},
|
||||
tableDeleteRow: (...args: unknown[]) => {
|
||||
calls.tableDeleteRow.push(args);
|
||||
return Promise.resolve({ ok: true });
|
||||
},
|
||||
tableUpdateCell: (...args: unknown[]) => {
|
||||
calls.tableUpdateCell.push(args);
|
||||
return Promise.resolve({ ok: true });
|
||||
},
|
||||
};
|
||||
const tokenServiceStub = {
|
||||
generateAccessToken: jest.fn().mockResolvedValue('access-token'),
|
||||
generateCollabToken: jest.fn().mockResolvedValue('collab-token'),
|
||||
};
|
||||
let service: AiChatToolsService;
|
||||
|
||||
beforeEach(() => {
|
||||
for (const k of Object.keys(calls)) calls[k].length = 0;
|
||||
jest.spyOn(loader, 'loadDocmostMcp').mockResolvedValue(
|
||||
mockLoaded(function () {
|
||||
return fakeClient as DocmostClientLike;
|
||||
} as unknown as loader.DocmostClientCtor),
|
||||
);
|
||||
service = new AiChatToolsService(
|
||||
tokenServiceStub as never,
|
||||
{} as never,
|
||||
{} as never,
|
||||
{} as never,
|
||||
{} as never,
|
||||
{
|
||||
asSink: () => ({ put: jest.fn(), has: jest.fn(), evict: jest.fn() }),
|
||||
} as never,
|
||||
);
|
||||
});
|
||||
afterEach(() => jest.restoreAllMocks());
|
||||
|
||||
const buildTools = () =>
|
||||
service.forUser(
|
||||
{ id: 'user-1', email: 'u@example.com', workspaceId: 'ws-1' } as never,
|
||||
'session-1',
|
||||
'ws-1',
|
||||
'chat-1',
|
||||
);
|
||||
|
||||
it('movePage forwards the optional position to the client', async () => {
|
||||
const tools = await buildTools();
|
||||
await tools.movePage.execute(
|
||||
{ pageId: 'p1', parentPageId: 'parent1', position: 'a5' } as never,
|
||||
{} as never,
|
||||
);
|
||||
expect(calls.movePage).toEqual([['p1', 'parent1', 'a5']]);
|
||||
});
|
||||
|
||||
it('movePage passes undefined position and null parent when omitted (unchanged behavior)', async () => {
|
||||
const tools = await buildTools();
|
||||
await tools.movePage.execute({ pageId: 'p2' } as never, {} as never);
|
||||
expect(calls.movePage).toEqual([['p2', null, undefined]]);
|
||||
});
|
||||
|
||||
it('tableInsertRow forwards the unified `table` param positionally', async () => {
|
||||
const tools = await buildTools();
|
||||
await tools.tableInsertRow.execute(
|
||||
{ pageId: 'p1', table: '#0', cells: ['a', 'b'], index: 2 } as never,
|
||||
{} as never,
|
||||
);
|
||||
expect(calls.tableInsertRow).toEqual([['p1', '#0', ['a', 'b'], 2]]);
|
||||
});
|
||||
|
||||
it('tableDeleteRow forwards `table` positionally', async () => {
|
||||
const tools = await buildTools();
|
||||
await tools.tableDeleteRow.execute(
|
||||
{ pageId: 'p1', table: '#0', index: 1 } as never,
|
||||
{} as never,
|
||||
);
|
||||
expect(calls.tableDeleteRow).toEqual([['p1', '#0', 1]]);
|
||||
});
|
||||
|
||||
it('tableUpdateCell forwards `table` positionally', async () => {
|
||||
const tools = await buildTools();
|
||||
await tools.tableUpdateCell.execute(
|
||||
{ pageId: 'p1', table: '#0', row: 1, col: 2, text: 'x' } as never,
|
||||
{} as never,
|
||||
);
|
||||
expect(calls.tableUpdateCell).toEqual([['p1', '#0', 1, 2, 'x']]);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -316,50 +316,27 @@ export class AiChatToolsService {
|
||||
execute: async () => resolveCurrentPageResult(openedPage),
|
||||
}),
|
||||
|
||||
getPage: tool({
|
||||
description:
|
||||
'Fetch a single page as Markdown by its page id. Returns the page ' +
|
||||
'title and its Markdown content. Inline <span data-comment-id> tags ' +
|
||||
'in the markdown are comment highlight anchors (also present for ' +
|
||||
'RESOLVED threads) — treat them as markup, not page text.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id (or slugId) of the page.'),
|
||||
}),
|
||||
execute: async ({ pageId }) => {
|
||||
// getPage(pageId) -> { data: filterPage(page, markdown), success }.
|
||||
const result = await client.getPage(pageId);
|
||||
const data = (result?.data ?? {}) as {
|
||||
title?: string;
|
||||
content?: string;
|
||||
};
|
||||
return {
|
||||
title: data.title ?? '',
|
||||
markdown: typeof data.content === 'string' ? data.content : '',
|
||||
};
|
||||
},
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
// The execute body keeps this layer's { title, markdown } projection.
|
||||
getPage: sharedTool(sharedToolSpecs.getPage, async ({ pageId }) => {
|
||||
// getPage(pageId) -> { data: filterPage(page, markdown), success }.
|
||||
const result = await client.getPage(pageId);
|
||||
const data = (result?.data ?? {}) as {
|
||||
title?: string;
|
||||
content?: string;
|
||||
};
|
||||
return {
|
||||
title: data.title ?? '',
|
||||
markdown: typeof data.content === 'string' ? data.content : '',
|
||||
};
|
||||
}),
|
||||
|
||||
// --- WRITE tools (all reversible — history/trash; §6.5 / D3) ---
|
||||
|
||||
createPage: tool({
|
||||
description:
|
||||
'Create a new page with a Markdown body in a space, optionally under ' +
|
||||
'a parent page. Returns the new page id and title. Reversible: a page ' +
|
||||
'can be moved to trash later.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
title: z.string().describe('The title of the new page.'),
|
||||
content: z
|
||||
.string()
|
||||
.describe('The page body as Markdown (may be empty).'),
|
||||
spaceId: z
|
||||
.string()
|
||||
.describe('The id of the space to create the page in.'),
|
||||
parentPageId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe('Optional parent page id to nest the new page under.'),
|
||||
}),
|
||||
execute: async ({ title, content, spaceId, parentPageId }) => {
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
createPage: sharedTool(
|
||||
sharedToolSpecs.createPage,
|
||||
async ({ title, content, spaceId, parentPageId }) => {
|
||||
// createPage(title, content, spaceId, parentPageId?) ->
|
||||
// { data: filterPage(page, markdown), success }.
|
||||
const result = await client.createPage(
|
||||
@@ -375,7 +352,7 @@ export class AiChatToolsService {
|
||||
};
|
||||
return { id: data.id ?? data.slugId, title: data.title ?? title };
|
||||
},
|
||||
}),
|
||||
),
|
||||
|
||||
updatePageContent: tool({
|
||||
description:
|
||||
@@ -399,115 +376,46 @@ export class AiChatToolsService {
|
||||
},
|
||||
}),
|
||||
|
||||
renamePage: tool({
|
||||
description:
|
||||
"Rename a page (change its title only; the body is untouched). " +
|
||||
'Reversible: rename back at any time.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page to rename.'),
|
||||
title: z.string().describe('The new title.'),
|
||||
}),
|
||||
execute: async ({ pageId, title }) => {
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
renamePage: sharedTool(
|
||||
sharedToolSpecs.renamePage,
|
||||
async ({ pageId, title }) => {
|
||||
// renamePage(pageId, title) -> { success, pageId, title }.
|
||||
await client.renamePage(pageId, title);
|
||||
return { pageId, title };
|
||||
},
|
||||
}),
|
||||
),
|
||||
|
||||
movePage: tool({
|
||||
description:
|
||||
'Move a page under a new parent page, or to the space root when no ' +
|
||||
'parent is given. Reversible: move it back at any time.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page to move.'),
|
||||
parentPageId: z
|
||||
.string()
|
||||
.nullable()
|
||||
.optional()
|
||||
.describe(
|
||||
'Target parent page id. Null/omitted moves the page to the ' +
|
||||
'space root.',
|
||||
),
|
||||
}),
|
||||
execute: async ({ pageId, parentPageId }) => {
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
// The shared schema adds the optional `position` field this layer lacked
|
||||
// before; the execute now forwards it (the client already accepted it).
|
||||
movePage: sharedTool(
|
||||
sharedToolSpecs.movePage,
|
||||
async ({ pageId, parentPageId, position }) => {
|
||||
// movePage(pageId, parentPageId, position?) -> raw move response.
|
||||
await client.movePage(pageId, parentPageId ?? null);
|
||||
await client.movePage(pageId, parentPageId ?? null, position);
|
||||
return { pageId, parentPageId: parentPageId ?? null, moved: true };
|
||||
},
|
||||
),
|
||||
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
// GUARDRAIL (§14 H4) preserved: the shared schema exposes ONLY pageId, so
|
||||
// permanentlyDelete/forceDelete are never part of the input and can never
|
||||
// be forwarded — the agent physically cannot permanently delete a page.
|
||||
deletePage: sharedTool(sharedToolSpecs.deletePage, async ({ pageId }) => {
|
||||
// deletePage(pageId) hits POST /pages/delete with { pageId } only,
|
||||
// which is the soft-delete (trash) path on the server.
|
||||
await client.deletePage(pageId);
|
||||
return { pageId, trashed: true };
|
||||
}),
|
||||
|
||||
deletePage: tool({
|
||||
description:
|
||||
'Move a page to the trash (SOFT delete only — fully reversible; the ' +
|
||||
'page can be restored from trash). This NEVER permanently deletes.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page to move to trash.'),
|
||||
}),
|
||||
// GUARDRAIL (§14 H4): the only field ever passed to the client is
|
||||
// pageId. permanentlyDelete/forceDelete are not part of the schema and
|
||||
// are never forwarded, so the agent physically cannot permanently
|
||||
// delete a page through this tool.
|
||||
execute: async ({ pageId }) => {
|
||||
// deletePage(pageId) hits POST /pages/delete with { pageId } only,
|
||||
// which is the soft-delete (trash) path on the server.
|
||||
await client.deletePage(pageId);
|
||||
return { pageId, trashed: true };
|
||||
},
|
||||
}),
|
||||
|
||||
// INTENTIONAL per-transport divergence (not shared): the description is
|
||||
// tuned for the in-app agent (e.g. "retry with a corrected EXACT selection"
|
||||
// and "Reversible via the comment UI"); the standalone MCP `create_comment`
|
||||
// keeps its own wording. Kept per-layer.
|
||||
createComment: tool({
|
||||
description:
|
||||
'Add an INLINE comment to a page, or reply to an existing top-level ' +
|
||||
'comment (one level only — the backend rejects replies to replies). ' +
|
||||
'The comment is anchored inline to the given exact `selection` text ' +
|
||||
'(which gets highlighted); page-level comments are NOT supported. A ' +
|
||||
"new top-level comment REQUIRES a `selection`. Replies inherit the " +
|
||||
"parent's anchor and take no selection. If the call fails with a " +
|
||||
'"selection not found" error, retry with a corrected EXACT selection ' +
|
||||
'copied verbatim from a single paragraph/block. You may also attach a ' +
|
||||
'`suggestedText` proposing a replacement for the `selection` (a human ' +
|
||||
'applies it from the UI); when set, the `selection` must occur exactly ' +
|
||||
'once in the page. Reversible via the comment UI.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page to comment on.'),
|
||||
content: z.string().describe('The comment body as Markdown.'),
|
||||
selection: z
|
||||
.string()
|
||||
.min(1)
|
||||
.max(250)
|
||||
.optional()
|
||||
.describe(
|
||||
'EXACT contiguous text from a SINGLE paragraph/block to anchor ' +
|
||||
'(highlight) the comment on (<=250 chars, avoid spanning across ' +
|
||||
'formatting boundaries). Required for a new top-level comment; ' +
|
||||
'omit only when replying via parentCommentId.',
|
||||
),
|
||||
parentCommentId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe(
|
||||
'Optional id of a TOP-LEVEL comment to reply to (one level ' +
|
||||
'of replies only).',
|
||||
),
|
||||
suggestedText: z
|
||||
.string()
|
||||
.min(1)
|
||||
.max(2000)
|
||||
.optional()
|
||||
.describe(
|
||||
'Optional proposed replacement (PLAIN TEXT) for the `selection`, ' +
|
||||
'applied by a human via the UI (never auto-applied). REQUIRES a ' +
|
||||
'`selection`; NOT allowed on a reply. When set, the `selection` ' +
|
||||
'must be UNIQUE in the page — expand it with surrounding context ' +
|
||||
'(still <=250 chars) if it occurs more than once, or the call is ' +
|
||||
'refused.',
|
||||
),
|
||||
}),
|
||||
execute: async ({
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
// This layer keeps only its own execute-side guards (require a selection
|
||||
// for a top-level comment; reject suggestedText on a reply / without a
|
||||
// selection) — the schema+description are shared.
|
||||
createComment: sharedTool(
|
||||
sharedToolSpecs.createComment,
|
||||
async ({
|
||||
pageId,
|
||||
content,
|
||||
selection,
|
||||
@@ -548,26 +456,17 @@ export class AiChatToolsService {
|
||||
const data = (result?.data ?? {}) as { id?: string };
|
||||
return { commentId: data.id, pageId };
|
||||
},
|
||||
}),
|
||||
),
|
||||
|
||||
resolveComment: tool({
|
||||
description:
|
||||
'Resolve or reopen a top-level comment thread (reversible — toggle ' +
|
||||
'the resolved flag). Only top-level comments can be resolved.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
commentId: z
|
||||
.string()
|
||||
.describe('The id of the top-level comment to resolve/reopen.'),
|
||||
resolved: z
|
||||
.boolean()
|
||||
.describe('true to resolve the thread, false to reopen it.'),
|
||||
}),
|
||||
execute: async ({ commentId, resolved }) => {
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
resolveComment: sharedTool(
|
||||
sharedToolSpecs.resolveComment,
|
||||
async ({ commentId, resolved }) => {
|
||||
// resolveComment(commentId, resolved) -> { success, commentId, resolved }.
|
||||
await client.resolveComment(commentId, resolved);
|
||||
return { commentId, resolved };
|
||||
},
|
||||
}),
|
||||
),
|
||||
|
||||
// --- READ tools (added) ---
|
||||
|
||||
@@ -585,33 +484,12 @@ export class AiChatToolsService {
|
||||
// hierarchy mode but is worded for the in-app agent; the standalone MCP
|
||||
// `list_pages` carries its own wording. Kept per-layer so each side tunes
|
||||
// its own guidance.
|
||||
listPages: tool({
|
||||
description:
|
||||
'List the most recent pages, optionally scoped to a single space. ' +
|
||||
'Returns a bounded list (default 50, max 100). Pass tree:true (with ' +
|
||||
"spaceId) to instead get the space's full page hierarchy as a nested tree.",
|
||||
inputSchema: modelFriendlyInput({
|
||||
spaceId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe('Optional space id to scope the listing to.'),
|
||||
limit: z
|
||||
.number()
|
||||
.int()
|
||||
.min(1)
|
||||
.max(100)
|
||||
.optional()
|
||||
.describe('Maximum number of pages (1-100).'),
|
||||
tree: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe(
|
||||
'When true, return the full page hierarchy of the given space as a nested tree (children arrays) instead of the recent-pages flat list. Requires spaceId; ignores limit.',
|
||||
),
|
||||
}),
|
||||
execute: async ({ spaceId, limit, tree }) =>
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
listPages: sharedTool(
|
||||
sharedToolSpecs.listPages,
|
||||
async ({ spaceId, limit, tree }) =>
|
||||
await client.listPages(spaceId, limit, tree),
|
||||
}),
|
||||
),
|
||||
|
||||
listSidebarPages: tool({
|
||||
description:
|
||||
@@ -656,41 +534,34 @@ export class AiChatToolsService {
|
||||
}),
|
||||
),
|
||||
|
||||
// NOT shared (kept inline): the MCP tool name `table_get` is noun-first
|
||||
// while this key is `getTable` (verb-first), breaking the
|
||||
// snake_case(inAppKey) convention the shared registry enforces. Its
|
||||
// reference parameter is still named `table` (was `tableRef`) so it matches
|
||||
// the migrated table row/cell tools below.
|
||||
getTable: tool({
|
||||
description:
|
||||
'Read a table as a matrix of cell texts (plus a parallel cellIds ' +
|
||||
'matrix so cells can be addressed for rich edits).',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page.'),
|
||||
tableRef: z
|
||||
table: z
|
||||
.string()
|
||||
.describe(
|
||||
'"#<index>" from getOutline, or a block id of any node inside ' +
|
||||
'the table.',
|
||||
'"#<index>" from the page outline, or a block id of any node ' +
|
||||
'inside the table.',
|
||||
),
|
||||
}),
|
||||
execute: async ({ pageId, tableRef }) =>
|
||||
await client.getTable(pageId, tableRef),
|
||||
execute: async ({ pageId, table }) =>
|
||||
await client.getTable(pageId, table),
|
||||
}),
|
||||
|
||||
listComments: tool({
|
||||
description:
|
||||
'List comments on a page in one call. By DEFAULT only ACTIVE ' +
|
||||
'threads are returned; resolved threads (a resolved top-level ' +
|
||||
'comment and all its replies) are hidden and their count reported ' +
|
||||
'as `resolvedThreadsHidden` so you can re-query with ' +
|
||||
'`includeResolved: true` to see everything. Returns ' +
|
||||
'`{ items, resolvedThreadsHidden }`. Content is returned as Markdown.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page.'),
|
||||
includeResolved: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe('default only active threads; true — include resolved'),
|
||||
}),
|
||||
execute: async ({ pageId, includeResolved }) =>
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
listComments: sharedTool(
|
||||
sharedToolSpecs.listComments,
|
||||
async ({ pageId, includeResolved }) =>
|
||||
await client.listComments(pageId, includeResolved),
|
||||
}),
|
||||
),
|
||||
|
||||
getComment: tool({
|
||||
description: 'Fetch a single comment by id (content as Markdown).',
|
||||
@@ -700,26 +571,12 @@ export class AiChatToolsService {
|
||||
execute: async ({ commentId }) => await client.getComment(commentId),
|
||||
}),
|
||||
|
||||
checkNewComments: tool({
|
||||
description:
|
||||
'Find new comments across a space (optionally scoped to a subtree) ' +
|
||||
'created after a given timestamp.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
spaceId: z.string().describe('The id of the space to scan.'),
|
||||
since: z
|
||||
.string()
|
||||
.describe('An ISO-8601 timestamp; only comments created after it.'),
|
||||
parentPageId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe(
|
||||
'Optional page id to scope the scan to that page and its ' +
|
||||
'descendants.',
|
||||
),
|
||||
}),
|
||||
execute: async ({ spaceId, since, parentPageId }) =>
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
checkNewComments: sharedTool(
|
||||
sharedToolSpecs.checkNewComments,
|
||||
async ({ spaceId, since, parentPageId }) =>
|
||||
await client.checkNewComments(spaceId, since, parentPageId),
|
||||
}),
|
||||
),
|
||||
|
||||
listShares: sharedTool(
|
||||
sharedToolSpecs.listShares,
|
||||
@@ -749,19 +606,14 @@ export class AiChatToolsService {
|
||||
await client.diffPageVersions(pageId, from, to),
|
||||
),
|
||||
|
||||
exportPageMarkdown: tool({
|
||||
description:
|
||||
'Export a page to a single self-contained Docmost-flavoured ' +
|
||||
'Markdown file (meta + body + comment threads). Lossless round-trip ' +
|
||||
'with importPageMarkdown.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page to export.'),
|
||||
}),
|
||||
execute: async ({ pageId }) => {
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
exportPageMarkdown: sharedTool(
|
||||
sharedToolSpecs.exportPageMarkdown,
|
||||
async ({ pageId }) => {
|
||||
const markdown = await client.exportPageMarkdown(pageId);
|
||||
return { markdown };
|
||||
},
|
||||
}),
|
||||
),
|
||||
|
||||
// --- WRITE tools (added; reversible via page history/trash) ---
|
||||
|
||||
@@ -811,28 +663,12 @@ export class AiChatToolsService {
|
||||
async ({ pageId, nodeId }) => await client.deleteNode(pageId, nodeId),
|
||||
),
|
||||
|
||||
updatePageJson: tool({
|
||||
description:
|
||||
"Replace a page's body with a full ProseMirror document — a full " +
|
||||
'overwrite — and/or update its title. Minimal example content: ' +
|
||||
'{"type":"doc","content":[{"type":"paragraph","content":' +
|
||||
'[{"type":"text","text":"Hi"}]}]}. The content arg may be a JSON ' +
|
||||
'object or a JSON string (both accepted). Omit content for a ' +
|
||||
'title-only update. Reversible: the previous version is kept in page ' +
|
||||
'history.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page to update.'),
|
||||
content: z
|
||||
.any()
|
||||
.optional()
|
||||
.describe(
|
||||
'Full ProseMirror doc {"type":"doc","content":[...]} (JSON ' +
|
||||
'object or JSON string); omit for a title-only update.',
|
||||
),
|
||||
title: z.string().optional().describe('Optional new title.'),
|
||||
}),
|
||||
execute: async ({ pageId, content, title }) => {
|
||||
// Parity with the standalone MCP server (index.ts update_page_json):
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
// The execute body keeps this layer's content normalization (parity with
|
||||
// the standalone MCP server, index.ts update_page_json).
|
||||
updatePageJson: sharedTool(
|
||||
sharedToolSpecs.updatePageJson,
|
||||
async ({ pageId, content, title }) => {
|
||||
// undefined/null pass through as undefined (title-only / no-op); any
|
||||
// string is JSON.parsed (so an empty string "" throws, matching the
|
||||
// MCP server); an object is passed through unchanged.
|
||||
@@ -845,66 +681,29 @@ export class AiChatToolsService {
|
||||
}
|
||||
return await client.updatePageJson(pageId, doc, title);
|
||||
},
|
||||
}),
|
||||
),
|
||||
|
||||
// NOT in the shared registry: this layer names the table argument
|
||||
// `tableRef`, while the standalone MCP tool names it `table` (index.ts).
|
||||
// Sharing one buildShape would rename a model-facing parameter on one
|
||||
// transport, so the table row/cell tools stay per-layer by design.
|
||||
tableInsertRow: tool({
|
||||
description:
|
||||
'Insert a row of plain-text cells into a table. Reversible via ' +
|
||||
'page history.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page.'),
|
||||
tableRef: z
|
||||
.string()
|
||||
.describe('"#<index>" from getOutline, or a block id in the table.'),
|
||||
cells: z.array(z.string()).describe('The cell texts for the row.'),
|
||||
index: z
|
||||
.number()
|
||||
.int()
|
||||
.optional()
|
||||
.describe('0-based insert position (omit/out-of-range to append).'),
|
||||
}),
|
||||
execute: async ({ pageId, tableRef, cells, index }) =>
|
||||
await client.tableInsertRow(pageId, tableRef, cells, index),
|
||||
}),
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
// The table reference parameter was unified to `table` (was `tableRef`).
|
||||
tableInsertRow: sharedTool(
|
||||
sharedToolSpecs.tableInsertRow,
|
||||
async ({ pageId, table, cells, index }) =>
|
||||
await client.tableInsertRow(pageId, table, cells, index),
|
||||
),
|
||||
|
||||
// NOT shared — same `tableRef` (here) vs `table` (MCP) parameter-name
|
||||
// divergence as tableInsertRow.
|
||||
tableDeleteRow: tool({
|
||||
description:
|
||||
'Delete a table row at a 0-based index. Reversible via page history.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page.'),
|
||||
tableRef: z
|
||||
.string()
|
||||
.describe('"#<index>" from getOutline, or a block id in the table.'),
|
||||
index: z.number().int().describe('0-based row index to delete.'),
|
||||
}),
|
||||
execute: async ({ pageId, tableRef, index }) =>
|
||||
await client.tableDeleteRow(pageId, tableRef, index),
|
||||
}),
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
tableDeleteRow: sharedTool(
|
||||
sharedToolSpecs.tableDeleteRow,
|
||||
async ({ pageId, table, index }) =>
|
||||
await client.tableDeleteRow(pageId, table, index),
|
||||
),
|
||||
|
||||
// NOT shared — same `tableRef` (here) vs `table` (MCP) parameter-name
|
||||
// divergence as tableInsertRow.
|
||||
tableUpdateCell: tool({
|
||||
description:
|
||||
'Set the plain-text content of a table cell at [row, col] (0-based). ' +
|
||||
'Reversible via page history.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page.'),
|
||||
tableRef: z
|
||||
.string()
|
||||
.describe('"#<index>" from getOutline, or a block id in the table.'),
|
||||
row: z.number().int().describe('0-based row index.'),
|
||||
col: z.number().int().describe('0-based column index.'),
|
||||
text: z.string().describe('The new cell text.'),
|
||||
}),
|
||||
execute: async ({ pageId, tableRef, row, col, text }) =>
|
||||
await client.tableUpdateCell(pageId, tableRef, row, col, text),
|
||||
}),
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
tableUpdateCell: sharedTool(
|
||||
sharedToolSpecs.tableUpdateCell,
|
||||
async ({ pageId, table, row, col, text }) =>
|
||||
await client.tableUpdateCell(pageId, table, row, col, text),
|
||||
),
|
||||
|
||||
copyPageContent: sharedTool(
|
||||
sharedToolSpecs.copyPageContent,
|
||||
@@ -918,25 +717,14 @@ export class AiChatToolsService {
|
||||
await client.importPageMarkdown(pageId, markdown),
|
||||
),
|
||||
|
||||
// INTENTIONAL per-transport divergence (not shared): adds a security
|
||||
// confirmation framing ("Only share when the user explicitly asked, since
|
||||
// this exposes the page to anyone with the link") for the in-app agent; the
|
||||
// standalone MCP `share_page` keeps the plain public-URL wording.
|
||||
sharePage: tool({
|
||||
description:
|
||||
'Make a page PUBLICLY accessible and return its public URL. ' +
|
||||
'Reversible via unsharePage. Only share when the user explicitly ' +
|
||||
'asked, since this exposes the page to anyone with the link.',
|
||||
inputSchema: modelFriendlyInput({
|
||||
pageId: z.string().describe('The id of the page to share.'),
|
||||
searchIndexing: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe('Allow public search engines to index it (default true).'),
|
||||
}),
|
||||
execute: async ({ pageId, searchIndexing }) =>
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294).
|
||||
// Both layers already carried the security-confirmation framing, so there
|
||||
// was no real divergence to preserve — only wording drift.
|
||||
sharePage: sharedTool(
|
||||
sharedToolSpecs.sharePage,
|
||||
async ({ pageId, searchIndexing }) =>
|
||||
await client.sharePage(pageId, searchIndexing),
|
||||
}),
|
||||
),
|
||||
|
||||
unsharePage: sharedTool(
|
||||
sharedToolSpecs.unsharePage,
|
||||
|
||||
@@ -100,54 +100,26 @@ export const INLINE_TOOL_TIERS: Record<
|
||||
tier: 'core',
|
||||
catalogLine: 'getCurrentPage — the page the user is currently viewing.',
|
||||
},
|
||||
getPage: {
|
||||
tier: 'core',
|
||||
catalogLine: 'getPage — fetch a page as Markdown by its id.',
|
||||
},
|
||||
listPages: {
|
||||
tier: 'core',
|
||||
catalogLine: "listPages — list recent pages, or a space's full page tree.",
|
||||
},
|
||||
listComments: {
|
||||
tier: 'core',
|
||||
catalogLine: 'listComments — list all comments on a page (including resolved).',
|
||||
},
|
||||
// NOTE: getPage and listPages moved to @docmost/mcp's SHARED_TOOL_SPECS
|
||||
// (#294); they carry their own tier ('core') + catalogLine there.
|
||||
// NOTE: createComment, listComments and resolveComment moved to
|
||||
// @docmost/mcp's SHARED_TOOL_SPECS (#294); they carry their own tier +
|
||||
// catalogLine there. getComment stays inline (MCP-only shape divergence is
|
||||
// n/a — it simply has no shared spec).
|
||||
getComment: {
|
||||
tier: 'core',
|
||||
catalogLine: 'getComment — fetch a single comment by id.',
|
||||
},
|
||||
createComment: {
|
||||
tier: 'core',
|
||||
catalogLine:
|
||||
'createComment — add an inline comment (optionally with a suggested edit).',
|
||||
},
|
||||
resolveComment: {
|
||||
tier: 'core',
|
||||
catalogLine: 'resolveComment — resolve or reopen a comment thread.',
|
||||
},
|
||||
|
||||
// --- deferred inline ---
|
||||
createPage: {
|
||||
tier: 'deferred',
|
||||
catalogLine: 'createPage — create a new page with a Markdown body in a space.',
|
||||
},
|
||||
// NOTE: createPage, renamePage, movePage, deletePage, updatePageJson and
|
||||
// exportPageMarkdown moved to @docmost/mcp's SHARED_TOOL_SPECS (#294); they
|
||||
// carry their own deferred tier + catalogLine there.
|
||||
updatePageContent: {
|
||||
tier: 'deferred',
|
||||
catalogLine:
|
||||
"updatePageContent — replace a page's body (and optionally title) with new Markdown.",
|
||||
},
|
||||
renamePage: {
|
||||
tier: 'deferred',
|
||||
catalogLine: "renamePage — change a page's title only (body untouched).",
|
||||
},
|
||||
movePage: {
|
||||
tier: 'deferred',
|
||||
catalogLine: 'movePage — move a page under a new parent or to the space root.',
|
||||
},
|
||||
deletePage: {
|
||||
tier: 'deferred',
|
||||
catalogLine: 'deletePage — move a page to trash (soft delete, reversible).',
|
||||
},
|
||||
listSidebarPages: {
|
||||
tier: 'deferred',
|
||||
catalogLine:
|
||||
@@ -157,42 +129,21 @@ export const INLINE_TOOL_TIERS: Record<
|
||||
tier: 'deferred',
|
||||
catalogLine: 'getTable — read a table as a matrix of cell texts and cell ids.',
|
||||
},
|
||||
checkNewComments: {
|
||||
tier: 'deferred',
|
||||
catalogLine:
|
||||
'checkNewComments — find comments in a space created after a timestamp.',
|
||||
},
|
||||
// NOTE: tableInsertRow, tableDeleteRow and tableUpdateCell moved to
|
||||
// @docmost/mcp's SHARED_TOOL_SPECS (#294); they carry their own deferred tier +
|
||||
// catalogLine there. getTable stays inline (its MCP name table_get breaks the
|
||||
// snake_case(inAppKey) convention, so it has no shared spec).
|
||||
// NOTE: checkNewComments moved to @docmost/mcp's SHARED_TOOL_SPECS (#294);
|
||||
// it carries its own deferred tier + catalogLine there.
|
||||
getPageHistory: {
|
||||
tier: 'deferred',
|
||||
catalogLine:
|
||||
'getPageHistory — fetch one page-history version with its ProseMirror content.',
|
||||
},
|
||||
exportPageMarkdown: {
|
||||
tier: 'deferred',
|
||||
catalogLine:
|
||||
'exportPageMarkdown — export a page to self-contained Markdown (body + comments).',
|
||||
},
|
||||
updatePageJson: {
|
||||
tier: 'deferred',
|
||||
catalogLine:
|
||||
"updatePageJson — overwrite a page's body with a full ProseMirror document.",
|
||||
},
|
||||
tableInsertRow: {
|
||||
tier: 'deferred',
|
||||
catalogLine: 'tableInsertRow — insert a row of plain-text cells into a table.',
|
||||
},
|
||||
tableDeleteRow: {
|
||||
tier: 'deferred',
|
||||
catalogLine: 'tableDeleteRow — delete a table row at a 0-based index.',
|
||||
},
|
||||
tableUpdateCell: {
|
||||
tier: 'deferred',
|
||||
catalogLine: 'tableUpdateCell — set the text of a table cell at [row, col].',
|
||||
},
|
||||
sharePage: {
|
||||
tier: 'deferred',
|
||||
catalogLine: 'sharePage — make a page publicly accessible and return its URL.',
|
||||
},
|
||||
// NOTE: sharePage moved to @docmost/mcp's SHARED_TOOL_SPECS (#294); it carries
|
||||
// its own deferred tier + catalogLine there. transformPage stays inline (its
|
||||
// schema deliberately diverges — it omits the deleteComments field the MCP
|
||||
// docmost_transform exposes, a comment-deletion guardrail).
|
||||
transformPage: {
|
||||
tier: 'deferred',
|
||||
catalogLine: "transformPage — run a sandboxed JS transform over a page's document.",
|
||||
|
||||
@@ -24,6 +24,10 @@ const migrator = new Migrator({
|
||||
path,
|
||||
migrationFolder,
|
||||
}),
|
||||
// Match the startup auto-migrator (migration.service.ts): a back-dated
|
||||
// migration from a long-lived branch must be applied, not rejected as
|
||||
// "corrupted migrations" (incident #361). See that file for the full rationale.
|
||||
allowUnorderedMigrations: true,
|
||||
});
|
||||
|
||||
run(db, migrator, migrationFolder);
|
||||
|
||||
@@ -19,6 +19,16 @@ export class MigrationService {
|
||||
path,
|
||||
migrationFolder: path.join(__dirname, '..', 'migrations'),
|
||||
}),
|
||||
// A long-lived branch can add a migration whose timestamped filename sorts
|
||||
// BEFORE migrations already applied in prod (e.g. #234's 20260627 landing
|
||||
// after 20260704 was live). With the default (ordered) setting the startup
|
||||
// migrator then sees "corrupted migrations" — the applied set is no longer a
|
||||
// prefix of the sorted list — throws, and the app crash-loops on boot
|
||||
// (incident #361: 502s for ~11 min). allowUnorderedMigrations runs any
|
||||
// not-yet-applied migration regardless of filename order, so a back-dated
|
||||
// migration is applied instead of bricking startup. A CI order-gate still
|
||||
// discourages back-dating; this is the runtime safety net.
|
||||
allowUnorderedMigrations: true,
|
||||
});
|
||||
|
||||
const { error, results } = await migrator.migrateToLatest();
|
||||
|
||||
@@ -0,0 +1,124 @@
|
||||
import { readFileSync } from 'fs';
|
||||
import { streamText, Output } from 'ai';
|
||||
import { MockLanguageModelV3, simulateReadableStream } from 'ai/test';
|
||||
|
||||
/**
|
||||
* Regression tests for patches/ai@6.0.134.patch (server heap OOM on long
|
||||
* autonomous agent runs, #184).
|
||||
*
|
||||
* Unpatched ai@6.0.134 substitutes the default text() output strategy even
|
||||
* when the caller passes NO `output` option. Its createOutputTransformStream
|
||||
* then accumulates the ENTIRE turn text and, on EVERY text-delta, enqueues a
|
||||
* flat snapshot of all text so far as `partialOutput` (O(n^2) memory). Those
|
||||
* snapshots pile up in the never-consumed leftover tee() branch of
|
||||
* DefaultStreamTextResult.baseStream, which is what OOM'd production during a
|
||||
* ~28k-chunk agent turn. The pnpm patch skips partialOutput production
|
||||
* entirely when no output strategy was requested, while keeping per-delta
|
||||
* streaming granularity.
|
||||
*/
|
||||
describe('ai@6.0.134 pnpm patch: no partialOutput accumulation without an output strategy', () => {
|
||||
const makeModel = () =>
|
||||
new MockLanguageModelV3({
|
||||
doStream: async () => ({
|
||||
stream: simulateReadableStream({
|
||||
chunks: [
|
||||
{ type: 'stream-start' as const, warnings: [] },
|
||||
{ type: 'text-start' as const, id: '1' },
|
||||
{ type: 'text-delta' as const, id: '1', delta: 'Hello' },
|
||||
{ type: 'text-delta' as const, id: '1', delta: ', ' },
|
||||
{ type: 'text-delta' as const, id: '1', delta: 'world!' },
|
||||
{ type: 'text-end' as const, id: '1' },
|
||||
{
|
||||
type: 'finish' as const,
|
||||
finishReason: { unified: 'stop' as const, raw: 'stop' },
|
||||
usage: {
|
||||
inputTokens: {
|
||||
total: 1,
|
||||
noCache: undefined,
|
||||
cacheRead: undefined,
|
||||
cacheWrite: undefined,
|
||||
},
|
||||
outputTokens: { total: 1, text: 1, reasoning: undefined },
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
}),
|
||||
});
|
||||
|
||||
it('preserves per-delta streaming granularity in textStream', async () => {
|
||||
const result = streamText({ model: makeModel(), prompt: 'hi' });
|
||||
|
||||
const deltas: string[] = [];
|
||||
for await (const delta of result.textStream) {
|
||||
deltas.push(delta);
|
||||
}
|
||||
|
||||
// The patch must NOT coalesce or drop deltas: three model deltas arrive
|
||||
// as three separate textStream chunks.
|
||||
expect(deltas).toEqual(['Hello', ', ', 'world!']);
|
||||
});
|
||||
|
||||
it('emits NO partialOutput values when the caller did not request an output strategy', async () => {
|
||||
const result = streamText({ model: makeModel(), prompt: 'hi' });
|
||||
|
||||
// Fully consume the primary stream first (mirrors production usage).
|
||||
for await (const _ of result.textStream) {
|
||||
// drain
|
||||
}
|
||||
|
||||
const partials: unknown[] = [];
|
||||
for await (const partial of result.experimental_partialOutputStream) {
|
||||
partials.push(partial);
|
||||
}
|
||||
|
||||
// TRIPWIRE: on unpatched ai@6.0.134 the default text() output strategy
|
||||
// yields one cumulative partial per text-delta here (['Hello', 'Hello, ',
|
||||
// 'Hello, world!']). An empty stream proves the patch is applied and no
|
||||
// cumulative snapshots are being produced (and thus none can pile up in
|
||||
// the leftover internal tee branch).
|
||||
expect(partials).toEqual([]);
|
||||
});
|
||||
|
||||
it('preserves cumulative partialOutput when the caller DOES request an output strategy', async () => {
|
||||
// PRESERVE-BRANCH GUARD: the patch only short-circuits partialOutput when
|
||||
// `output == null`. When an output strategy IS set (here Output.text()),
|
||||
// createOutputTransformStream must fall through to the ORIGINAL code path
|
||||
// and keep publishing cumulative snapshots, so object/text-output consumers
|
||||
// behave byte-identically to unpatched ai. A careless re-port that routed
|
||||
// output-set calls into the skip branch would leave partialOutput empty and
|
||||
// silently break those consumers — this test is the tripwire for that.
|
||||
const result = streamText({
|
||||
model: makeModel(),
|
||||
prompt: 'hi',
|
||||
experimental_output: Output.text(),
|
||||
});
|
||||
|
||||
// Drain the primary stream fully and accumulate the complete output text.
|
||||
let fullText = '';
|
||||
for await (const delta of result.textStream) {
|
||||
fullText += delta;
|
||||
}
|
||||
|
||||
const partials: string[] = [];
|
||||
for await (const partial of result.experimental_partialOutputStream) {
|
||||
partials.push(partial);
|
||||
}
|
||||
|
||||
// With a strategy set, partialOutput must be PRESERVED (non-empty) and
|
||||
// cumulative: the last emitted partial equals the full accumulated text.
|
||||
expect(partials.length).toBeGreaterThan(0);
|
||||
expect(partials[partials.length - 1]).toBe(fullText);
|
||||
expect(fullText).toBe('Hello, world!');
|
||||
});
|
||||
|
||||
it('both installed dist builds (CJS and ESM) carry the patch marker', () => {
|
||||
// Secondary guard: pins the patch to BOTH bundles the SDK ships, since
|
||||
// the NestJS server consumes CJS while other tooling may load ESM.
|
||||
const cjsPath = require.resolve('ai');
|
||||
const mjsPath = cjsPath.replace(/index\.js$/, 'index.mjs');
|
||||
expect(cjsPath).toMatch(/index\.js$/);
|
||||
expect(readFileSync(cjsPath, 'utf8')).toContain('PATCH(docmost');
|
||||
expect(readFileSync(mjsPath, 'utf8')).toContain('PATCH(docmost');
|
||||
});
|
||||
});
|
||||
@@ -131,5 +131,14 @@ const { Client } = require("pg");
|
||||
7. **Migrations don't auto-run in dev** — run `migration:latest` after every pull
|
||||
or branch switch.
|
||||
|
||||
8. **Automation (Playwright): type into the BODY editor, not the title.** A page has
|
||||
two `.ProseMirror` editors — `[aria-label='Page title']` (non-collab) and
|
||||
`[aria-label='Page content']` (the collab body). `document.querySelector('.ProseMirror')`
|
||||
returns the TITLE editor, so typing there never changes body content and `mod+S`
|
||||
versions nothing. Target `[aria-label='Page content']`, confirm it's collab-bound
|
||||
(`el.editor.extensionManager.extensions.some(e=>e.name==='collaboration')`), and
|
||||
wait ~10-12s for the store debounce before asserting `pages.content` changed. Full
|
||||
testing methodology + traps: **[how-to-test.md](how-to-test.md)**.
|
||||
|
||||
See also the **Commands** and **Architecture → Two server processes** sections in
|
||||
[`AGENTS.md`](../AGENTS.md).
|
||||
|
||||
@@ -0,0 +1,108 @@
|
||||
# How to test the application (browser E2E + out-of-band)
|
||||
|
||||
How to actually verify a feature end-to-end against a running stand — driving the
|
||||
**real app in a browser** and confirming results **out-of-band** in the DB/git, not
|
||||
through the same API you're supposed to be testing. Written from real false-positives
|
||||
that wasted hours (see **Traps** — read them before you write a test).
|
||||
|
||||
Prereq: a running stand — see **[dev-stand.md](dev-stand.md)**. Automation uses
|
||||
Playwright (`pip install playwright && python -m playwright install chromium`).
|
||||
|
||||
## Principles
|
||||
|
||||
1. **Drive the behaviour under test through the browser.** The stand exists so you
|
||||
exercise the real UI + realtime-collab + server path. Using `POST /api/pages/*` to
|
||||
perform the action you're validating tests the API, not the app — an e2e suite can
|
||||
do that. API calls are fine ONLY for one-time setup/fixtures, never for the
|
||||
interaction you're asserting on.
|
||||
2. **Evidence before claim.** Nothing "passes" without an artifact: a DB row, a git
|
||||
diff, a screenshot looked at as an image. If you can't show it, you didn't verify it.
|
||||
3. **Verify out-of-band.** Judge results from a source independent of the UI: `psql`
|
||||
against the DB, a fresh `git clone` of a synced repo, a hard reload. Optimistic UI
|
||||
lies about persistence.
|
||||
4. **Disconfirm by default.** For each feature, actively try to prove it's broken
|
||||
before concluding it works. Reload after every create/edit/save.
|
||||
5. **Recon actuatability FIRST.** Before building editor tests, confirm the
|
||||
interaction even works in your harness (does a typed edit reach the DB?). Skipping
|
||||
this is how you ship a pile of tests that all silently exercised the wrong thing.
|
||||
|
||||
## The editor: two ProseMirror instances (READ THIS)
|
||||
|
||||
A page has **two** `.ProseMirror` editors:
|
||||
|
||||
| index | selector | role | collab? |
|
||||
|---|---|---|---|
|
||||
| 0 | `[aria-label='Page title']` | title field | **NO** (16 exts, no `collaboration`) |
|
||||
| 1 | `[aria-label='Page content']` | body | **YES** (95 exts, has `collaboration`) |
|
||||
|
||||
`document.querySelector('.ProseMirror')` returns the **title** editor (first match).
|
||||
Type there and you edit the title only — body page content never changes, so `mod+S`
|
||||
"versions" unchanged content and every content test silently no-ops.
|
||||
|
||||
**Always target the body editor** and confirm it's collab-bound before typing:
|
||||
|
||||
```js
|
||||
const el = document.querySelector("[aria-label='Page content']");
|
||||
el.editor.extensionManager.extensions.some(e => e.name === 'collaboration'); // must be true
|
||||
```
|
||||
|
||||
Body edits emit ~20 `/collab` websocket frames while typing and land in
|
||||
`pages.content` after the **hocuspocus store debounce (~10s)** — so **wait ~12s**
|
||||
before asserting persistence (checking at 6–8s is a false negative). `mod+S` (the
|
||||
`save-version` stateless message) flushes immediately, so a version created right
|
||||
after a settled body edit holds the typed text.
|
||||
|
||||
## A known-good browser flow
|
||||
|
||||
```
|
||||
1. goto /s/<space-slug> # the "Create page" button lives in the space sidebar, not /home
|
||||
2. click button[aria-label='Create page'] # fully UI-driven page creation
|
||||
3. type into [aria-label='Page title'] # optional title
|
||||
4. click [aria-label='Page content'] → type body text
|
||||
5. wait ~12s (store debounce)
|
||||
6. assert pages.content changed (psql) # out-of-band
|
||||
7. mod+S / menu Save → assert page_history row (psql)
|
||||
8. reload / fresh context → re-assert (persistence round-trip)
|
||||
```
|
||||
|
||||
Auth: log in ONCE, save `storage_state.json`, reuse it across pages/agents (re-login
|
||||
per run trips shared rate-limits). Cookie-based session authorizes both REST and the
|
||||
collab websocket.
|
||||
|
||||
## Judging out-of-band
|
||||
|
||||
```bash
|
||||
# page content / history
|
||||
docker exec <db> psql -U docmost -d docmost -tAc \
|
||||
"select coalesce(kind,'null'), content::text from page_history where page_id='<id>' order by created_at;"
|
||||
# git-sync round-trip: clone the space repo and diff against what you pushed
|
||||
git clone http://<user>:<pass>@127.0.0.1:3000/git/<spaceId>.git /tmp/x
|
||||
```
|
||||
|
||||
`page_history.content` is full JSON — parse it, don't truncate the snippet, or a
|
||||
marker check misses. For sync/async features (autosave, git-sync, idle-flush) use an
|
||||
active probe: write a unique marker, wait past the debounce/poll window, re-read
|
||||
out-of-band, ≥2 iterations — never conclude "broken" from a single snapshot.
|
||||
|
||||
## Traps (each of these produced a false result in a real run)
|
||||
|
||||
- **Wrong editor.** Typed into `.ProseMirror` (= title). Edits never touched body
|
||||
content. → target `[aria-label='Page content']`.
|
||||
- **Checked persistence too early.** Store debounce ~10s; a 6–8s check reads stale.
|
||||
- **Truncated the DB snapshot** below where the test marker sits → false "content
|
||||
missing".
|
||||
- **API-seeded the content under test**, then "verified" the feature — that validated
|
||||
the API, not the app.
|
||||
- **Reused a fixed marker on a non-rebooted stand** → title/row collisions inflate
|
||||
counts (`count==2`). Use a unique per-run marker (timestamp).
|
||||
- **Idle/async read once** and called it "permanently broken" — it was mid-debounce.
|
||||
- **Concluded env-limitation without a cross-build control.** If unsure whether a
|
||||
failure is your harness or the product, run the SAME harness against a known-good
|
||||
build; a divergence localizes it.
|
||||
|
||||
## Scope note
|
||||
|
||||
Some paths genuinely need a human in a real browser (rich drag-drop, native file
|
||||
pickers, clipboard, and anything the harness can't actuate). Label those UNTESTED in
|
||||
the report — "handled gracefully" is not "works". Keep four states distinct:
|
||||
verified-working, defect, untested, env-limitation.
|
||||
+2
-1
@@ -96,7 +96,8 @@
|
||||
"pnpm": {
|
||||
"patchedDependencies": {
|
||||
"scimmy@1.3.5": "patches/scimmy@1.3.5.patch",
|
||||
"yjs@13.6.30": "patches/yjs@13.6.30.patch"
|
||||
"yjs@13.6.30": "patches/yjs@13.6.30.patch",
|
||||
"ai@6.0.134": "patches/ai@6.0.134.patch"
|
||||
},
|
||||
"overrides": {
|
||||
"prosemirror-changeset": "2.4.0",
|
||||
|
||||
+83
-355
@@ -118,56 +118,19 @@ export function createDocmostMcpServer(config: DocmostMcpConfig): McpServer {
|
||||
// transport exposes a `tree:true` mode that returns the full nested hierarchy;
|
||||
// the in-app copy keeps the same tree option but is worded for the in-app agent.
|
||||
// Kept per-layer so each side can tune its own guidance.
|
||||
server.registerTool(
|
||||
"list_pages",
|
||||
{
|
||||
description:
|
||||
"List most recent pages in a space ordered by updatedAt (descending). " +
|
||||
"Returns a bounded list (default 50, max 100) — use search for lookups " +
|
||||
"in large spaces. Pass tree:true (with spaceId) to instead get the " +
|
||||
"space's full page hierarchy as a nested tree.",
|
||||
inputSchema: {
|
||||
spaceId: z.string().optional(),
|
||||
limit: z
|
||||
.number()
|
||||
.int()
|
||||
.min(1)
|
||||
.max(100)
|
||||
.optional()
|
||||
.describe("Max pages to return (default 50, max 100)"),
|
||||
tree: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe(
|
||||
"When true, return the space's full page hierarchy as a nested tree (each node has a children array) instead of the recent-by-updatedAt flat list. Requires spaceId; ignores limit.",
|
||||
),
|
||||
},
|
||||
},
|
||||
async ({ spaceId, limit, tree }) => {
|
||||
const result = await docmostClient.listPages(spaceId, limit ?? 50, tree ?? false);
|
||||
return jsonContent(result);
|
||||
},
|
||||
);
|
||||
// Schema + description now live in @docmost/mcp's SHARED_TOOL_SPECS (#294). This
|
||||
// transport keeps applying its own defaults (limit=50, tree=false) in execute.
|
||||
registerShared(SHARED_TOOL_SPECS.listPages, async ({ spaceId, limit, tree }) => {
|
||||
const result = await docmostClient.listPages(spaceId, limit ?? 50, tree ?? false);
|
||||
return jsonContent(result);
|
||||
});
|
||||
|
||||
// Tool: get_page
|
||||
server.registerTool(
|
||||
"get_page",
|
||||
{
|
||||
description:
|
||||
"Get page details with content converted to Markdown. The conversion is " +
|
||||
"LOSSY (block ids, exact table/callout structure are approximated); for a " +
|
||||
"lossless representation use get_page_json. Inline <span data-comment-id> " +
|
||||
"tags in the markdown are comment highlight anchors (also present for " +
|
||||
"RESOLVED threads) — treat them as markup, not page text.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1),
|
||||
},
|
||||
},
|
||||
async ({ pageId }) => {
|
||||
const page = await docmostClient.getPage(pageId);
|
||||
return jsonContent(page);
|
||||
},
|
||||
);
|
||||
// Schema + description now live in the shared registry (#294).
|
||||
registerShared(SHARED_TOOL_SPECS.getPage, async ({ pageId }) => {
|
||||
const page = await docmostClient.getPage(pageId);
|
||||
return jsonContent(page);
|
||||
});
|
||||
|
||||
// Tool: get_page_json
|
||||
registerShared(SHARED_TOOL_SPECS.getPageJson, async ({ pageId }) => {
|
||||
@@ -201,6 +164,10 @@ registerShared(
|
||||
);
|
||||
|
||||
// Tool: table_get
|
||||
// NOT in the shared registry: the MCP tool name `table_get` is noun-first while
|
||||
// the in-app key is `getTable` (verb-first), breaking the snake_case(inAppKey)
|
||||
// convention the shared registry enforces (shared-tool-specs.contract.spec.ts).
|
||||
// Renaming the public MCP tool would break external clients, so it stays inline.
|
||||
server.registerTool(
|
||||
"table_get",
|
||||
{
|
||||
@@ -223,25 +190,10 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: table_insert_row
|
||||
// NOT in the shared registry: this transport names the table argument `table`,
|
||||
// while the in-app tool names it `tableRef` (ai-chat-tools.service.ts). Sharing
|
||||
// one buildShape would rename a public MCP parameter, so the table row/cell
|
||||
// tools stay per-transport by design.
|
||||
server.registerTool(
|
||||
"table_insert_row",
|
||||
{
|
||||
description:
|
||||
"Insert a row of plain-text cells into a table. `table` = `#<index>` or " +
|
||||
"a block id inside it. `cells` = text per column (padded to the table's " +
|
||||
"column count; error if more cells than columns). `index` = 0-based " +
|
||||
"insert position (0 inserts before the header); omit to append at the end.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1),
|
||||
table: z.string().min(1),
|
||||
cells: z.array(z.string()),
|
||||
index: z.number().int().optional(),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294); the `table`
|
||||
// parameter name is the canonical one (the in-app layer was unified to it).
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.tableInsertRow,
|
||||
async ({ pageId, table, cells, index }) => {
|
||||
const result = await docmostClient.tableInsertRow(
|
||||
pageId,
|
||||
@@ -254,22 +206,9 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: table_delete_row
|
||||
// NOT shared — same `table` (here) vs `tableRef` (in-app) parameter-name
|
||||
// divergence as table_insert_row.
|
||||
server.registerTool(
|
||||
"table_delete_row",
|
||||
{
|
||||
description:
|
||||
"Delete the row at 0-based `index` from a table (`table` = `#<index>` or " +
|
||||
"a block id inside it). Refuses to delete the table's only row. An " +
|
||||
"out-of-range `index` throws. Deleting `index` 0 removes the header row, " +
|
||||
"and the next row becomes the new header.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1),
|
||||
table: z.string().min(1),
|
||||
index: z.number().int(),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294).
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.tableDeleteRow,
|
||||
async ({ pageId, table, index }) => {
|
||||
const result = await docmostClient.tableDeleteRow(pageId, table, index);
|
||||
return jsonContent(result);
|
||||
@@ -277,24 +216,9 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: table_update_cell
|
||||
// NOT shared — same `table` (here) vs `tableRef` (in-app) parameter-name
|
||||
// divergence as table_insert_row.
|
||||
server.registerTool(
|
||||
"table_update_cell",
|
||||
{
|
||||
description:
|
||||
"Set the plain-text content of cell [row,col] (0-based) in a table " +
|
||||
"(`table` = `#<index>` or a block id inside it). Replaces the cell's " +
|
||||
"content with a single text paragraph; for rich formatting use patch_node " +
|
||||
"on the cell's paragraph id from table_get.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1),
|
||||
table: z.string().min(1),
|
||||
row: z.number().int(),
|
||||
col: z.number().int(),
|
||||
text: z.string(),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294).
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.tableUpdateCell,
|
||||
async ({ pageId, table, row, col, text }) => {
|
||||
const result = await docmostClient.tableUpdateCell(
|
||||
pageId,
|
||||
@@ -308,22 +232,9 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: create_page
|
||||
server.registerTool(
|
||||
"create_page",
|
||||
{
|
||||
description:
|
||||
"Create a new page from Markdown in a space. Pass parentPageId to nest " +
|
||||
"it under a parent; omit it to create at the space root.",
|
||||
inputSchema: {
|
||||
title: z.string().min(1).describe("Title of the page"),
|
||||
content: z.string().min(1).describe("Markdown content"),
|
||||
spaceId: z.string().min(1),
|
||||
parentPageId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("Optional parent page ID to nest under"),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294).
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.createPage,
|
||||
async ({ title, content, spaceId, parentPageId }) => {
|
||||
const result = await docmostClient.createPage(
|
||||
title,
|
||||
@@ -336,32 +247,11 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: update_page_json
|
||||
server.registerTool(
|
||||
"update_page_json",
|
||||
{
|
||||
description:
|
||||
"Replace a page's content with a raw ProseMirror JSON document " +
|
||||
"(lossless write: preserves the block ids, callouts, tables and " +
|
||||
"attributes you pass in). Typical flow: get_page_json -> modify the " +
|
||||
"JSON -> update_page_json. Keep existing node ids intact so heading " +
|
||||
"anchors and history stay stable. Minimal full-doc example: " +
|
||||
'{"type":"doc","content":[{"type":"paragraph","content":' +
|
||||
'[{"type":"text","text":"Hi"}]}]}. `content` may be a JSON object or a ' +
|
||||
"JSON string (both accepted), and is OPTIONAL: omit it to update only " +
|
||||
"the title (though prefer rename_page for a title-only change). " +
|
||||
"Supplying neither content nor title is an error.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1).describe("ID of the page to update"),
|
||||
content: z
|
||||
.any()
|
||||
.optional()
|
||||
.describe(
|
||||
'ProseMirror document {"type":"doc","content":[...]} (JSON object or ' +
|
||||
"JSON string). Omit to rename only.",
|
||||
),
|
||||
title: z.string().optional().describe("Optional new title"),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294). The execute body
|
||||
// keeps this transport's content normalization (parse a JSON-string content,
|
||||
// pass undefined/null through for a title-only/no-op update).
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.updatePageJson,
|
||||
async ({ pageId, content, title }) => {
|
||||
// Only parse/validate the document when it was actually supplied; when it
|
||||
// is omitted, pass it straight through so the client performs a title-only
|
||||
@@ -379,26 +269,11 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: export_page_markdown
|
||||
server.registerTool(
|
||||
"export_page_markdown",
|
||||
{
|
||||
description:
|
||||
"Export a page to a single self-contained, lossless Docmost-flavoured " +
|
||||
"Markdown file (custom extensions): YAML-free meta header, body with " +
|
||||
"inline comment anchors and diagrams, and a trailing comments-thread " +
|
||||
"block. Designed for a download -> edit body -> import_page_markdown " +
|
||||
"round-trip that preserves everything, including comment highlights. " +
|
||||
"Comment THREADS are preserved in the file but are not re-pushed to the " +
|
||||
"server on import.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1),
|
||||
},
|
||||
},
|
||||
async ({ pageId }) => {
|
||||
const md = await docmostClient.exportPageMarkdown(pageId);
|
||||
return { content: [{ type: "text" as const, text: md }] };
|
||||
},
|
||||
);
|
||||
// Schema + description now live in the shared registry (#294).
|
||||
registerShared(SHARED_TOOL_SPECS.exportPageMarkdown, async ({ pageId }) => {
|
||||
const md = await docmostClient.exportPageMarkdown(pageId);
|
||||
return { content: [{ type: "text" as const, text: md }] };
|
||||
});
|
||||
|
||||
// Tool: import_page_markdown
|
||||
registerShared(
|
||||
@@ -422,22 +297,11 @@ registerShared(
|
||||
);
|
||||
|
||||
// Tool: rename_page
|
||||
server.registerTool(
|
||||
"rename_page",
|
||||
{
|
||||
description:
|
||||
"Rename a page (change its title only) without touching or resending " +
|
||||
"its content.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1).describe("ID of the page to rename"),
|
||||
title: z.string().min(1).describe("New title"),
|
||||
},
|
||||
},
|
||||
async ({ pageId, title }) => {
|
||||
const result = await docmostClient.renamePage(pageId, title);
|
||||
return jsonContent(result);
|
||||
},
|
||||
);
|
||||
// Schema + description now live in the shared registry (#294).
|
||||
registerShared(SHARED_TOOL_SPECS.renamePage, async ({ pageId, title }) => {
|
||||
const result = await docmostClient.renamePage(pageId, title);
|
||||
return jsonContent(result);
|
||||
});
|
||||
|
||||
// Tool: edit_page_text
|
||||
registerShared(SHARED_TOOL_SPECS.editPageText, async ({ pageId, edits }) => {
|
||||
@@ -516,6 +380,10 @@ registerShared(SHARED_TOOL_SPECS.deleteNode, async ({ pageId, nodeId }) => {
|
||||
});
|
||||
|
||||
// Tool: insert_image
|
||||
// MCP-only by design (NOT in the shared registry): the in-app AI-chat agent
|
||||
// exposes no image tools (insert/replace), so there is no second layer to unify
|
||||
// — a SHARED_TOOL_SPECS entry's tier/catalogLine are in-app metadata and the
|
||||
// catalog-partition test forbids a spec without a live in-app tool (#294).
|
||||
server.registerTool(
|
||||
"insert_image",
|
||||
{
|
||||
@@ -561,6 +429,7 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: replace_image
|
||||
// MCP-only by design (see insert_image): no in-app equivalent, stays inline.
|
||||
server.registerTool(
|
||||
"replace_image",
|
||||
{
|
||||
@@ -603,25 +472,10 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: share_page
|
||||
// INTENTIONAL per-transport divergence (not shared): the in-app copy adds a
|
||||
// security-confirmation framing ("only share when the user explicitly asked,
|
||||
// since this exposes the page to anyone with the link") tuned for the in-app
|
||||
// agent; this transport keeps the plain public-URL wording.
|
||||
server.registerTool(
|
||||
"share_page",
|
||||
{
|
||||
description:
|
||||
"Make a page publicly accessible (idempotent) and return its public " +
|
||||
"URL. The URL format is <app>/share/<key>/p/<slugId>. This exposes the " +
|
||||
"page content to ANYONE with the URL — do it only when explicitly asked.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1).describe("ID of the page to share"),
|
||||
searchIndexing: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Allow search engines to index the page (default true)"),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294). The execute body
|
||||
// keeps this transport's own `searchIndexing ?? true` default.
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.sharePage,
|
||||
async ({ pageId, searchIndexing }) => {
|
||||
const result = await docmostClient.sharePage(pageId, searchIndexing ?? true);
|
||||
return jsonContent(result);
|
||||
@@ -641,29 +495,11 @@ registerShared(SHARED_TOOL_SPECS.listShares, async () => {
|
||||
});
|
||||
|
||||
// Tool: move_page
|
||||
server.registerTool(
|
||||
"move_page",
|
||||
{
|
||||
description:
|
||||
"Move a page under a new parent (nesting) or to the space root.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1),
|
||||
parentPageId: z
|
||||
.string()
|
||||
.nullable()
|
||||
.optional()
|
||||
.describe(
|
||||
"Target parent page ID. Pass 'null' or empty string to move to root.",
|
||||
),
|
||||
position: z
|
||||
.string()
|
||||
.min(5)
|
||||
.optional()
|
||||
.describe(
|
||||
"fractional-index position key; min 5 chars; omit to append at the end.",
|
||||
),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294). The execute body
|
||||
// keeps this transport's cycle guard, its 'null'/'' -> null string coercion, and
|
||||
// its positive-confirmation check on the move response.
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.movePage,
|
||||
async ({ pageId, parentPageId, position }) => {
|
||||
const finalParentId =
|
||||
parentPageId === "" || parentPageId === "null" ? null : parentPageId;
|
||||
@@ -698,49 +534,22 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: delete_page
|
||||
server.registerTool(
|
||||
"delete_page",
|
||||
{
|
||||
description:
|
||||
"Delete a single page by ID. SOFT delete only: the page is moved to " +
|
||||
"trash and can be restored; nothing is permanently deleted.",
|
||||
inputSchema: {
|
||||
pageId: z.string().min(1),
|
||||
},
|
||||
},
|
||||
async ({ pageId }) => {
|
||||
await docmostClient.deletePage(pageId);
|
||||
return {
|
||||
content: [
|
||||
{ type: "text" as const, text: `Successfully deleted page ${pageId}` },
|
||||
],
|
||||
};
|
||||
},
|
||||
);
|
||||
// Schema + description now live in the shared registry (#294). The shared schema
|
||||
// exposes ONLY pageId, so no permanent/force-delete flag can reach the client.
|
||||
registerShared(SHARED_TOOL_SPECS.deletePage, async ({ pageId }) => {
|
||||
await docmostClient.deletePage(pageId);
|
||||
return {
|
||||
content: [
|
||||
{ type: "text" as const, text: `Successfully deleted page ${pageId}` },
|
||||
],
|
||||
};
|
||||
});
|
||||
|
||||
// --- Comment tools (ported from upstream PR #3 by Max Nikitin) ---
|
||||
|
||||
// Tool: list_comments
|
||||
server.registerTool(
|
||||
"list_comments",
|
||||
{
|
||||
description:
|
||||
"List comments on a page in one call (pagination is handled " +
|
||||
"internally). By DEFAULT only ACTIVE threads are returned; resolved " +
|
||||
"threads (a resolved top-level comment and all its replies) are hidden " +
|
||||
"and their count reported as `resolvedThreadsHidden` so you can re-query " +
|
||||
"with `includeResolved: true` to see everything. Returns " +
|
||||
"`{ items, resolvedThreadsHidden }`. Content is returned as Markdown.",
|
||||
inputSchema: {
|
||||
pageId: z.string().describe("ID of the page"),
|
||||
includeResolved: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe(
|
||||
"default only active threads; true — include resolved",
|
||||
),
|
||||
},
|
||||
},
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.listComments,
|
||||
async ({ pageId, includeResolved }) => {
|
||||
const comments = await docmostClient.listComments(pageId, includeResolved);
|
||||
return jsonContent(comments);
|
||||
@@ -748,55 +557,11 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: create_comment
|
||||
// INTENTIONAL per-transport divergence (not shared): the in-app copy tunes the
|
||||
// guidance for the in-app agent (e.g. "retry with a corrected EXACT selection"
|
||||
// and "Reversible via the comment UI"); this transport keeps its own wording.
|
||||
server.registerTool(
|
||||
"create_comment",
|
||||
{
|
||||
description:
|
||||
"Create a new comment on a page. The comment is ALWAYS inline and is " +
|
||||
"anchored to (highlights) its `selection` text — there are no page-level " +
|
||||
"comments. Content is provided as Markdown and automatically converted. " +
|
||||
"A top-level comment REQUIRES an exact `selection`; if the selection " +
|
||||
"cannot be found in the page the call fails (no orphan comment is left). " +
|
||||
"Replies (parentCommentId set) inherit the parent's anchor and take no " +
|
||||
"selection. You may also attach a `suggestedText` proposing a replacement " +
|
||||
"for the `selection`; a human applies (or rejects) it from the UI. When " +
|
||||
"`suggestedText` is set the `selection` MUST occur exactly once in the " +
|
||||
"page — expand it with surrounding context if it is ambiguous.",
|
||||
inputSchema: {
|
||||
pageId: z.string().describe("ID of the page to comment on"),
|
||||
content: z.string().min(1).describe("Comment content in Markdown format"),
|
||||
selection: z
|
||||
.string()
|
||||
.min(1)
|
||||
// Enforce the documented 250-char cap to match the description above.
|
||||
.max(250)
|
||||
.optional()
|
||||
.describe(
|
||||
"EXACT contiguous text from a single paragraph/block to anchor the " +
|
||||
"comment on (<=250 chars). Required for a top-level comment; omit " +
|
||||
"only when replying via parentCommentId.",
|
||||
),
|
||||
parentCommentId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("Parent comment ID to create a reply (max 2 nesting levels)"),
|
||||
suggestedText: z
|
||||
.string()
|
||||
.min(1)
|
||||
.max(2000)
|
||||
.optional()
|
||||
.describe(
|
||||
"Optional proposed replacement (PLAIN TEXT) for the `selection`, " +
|
||||
"applied by a human via the UI (never auto-applied). REQUIRES a " +
|
||||
"`selection`; NOT allowed on a reply. When set, the `selection` must " +
|
||||
"be UNIQUE in the page — expand it with surrounding context (still " +
|
||||
"<=250 chars) if it occurs more than once, or the call is refused.",
|
||||
),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294). The execute body
|
||||
// keeps this transport's own guards (require a selection for a top-level
|
||||
// comment; reject suggestedText on a reply / without a selection).
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.createComment,
|
||||
async ({ pageId, content, selection, parentCommentId, suggestedText }) => {
|
||||
if (!parentCommentId && (!selection || !selection.trim())) {
|
||||
throw new Error(
|
||||
@@ -872,28 +637,9 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: resolve_comment
|
||||
server.registerTool(
|
||||
"resolve_comment",
|
||||
{
|
||||
description:
|
||||
"Resolve (close) or reopen a comment thread. Only top-level comments can " +
|
||||
"be resolved — the server rejects resolving a reply. Reversible: pass " +
|
||||
"resolved=false to reopen. Resolving keeps the thread and its replies " +
|
||||
"(unlike delete_comment, which permanently removes them).",
|
||||
inputSchema: {
|
||||
commentId: z
|
||||
.string()
|
||||
.min(1)
|
||||
.describe("ID of the top-level comment thread to resolve or reopen"),
|
||||
resolved: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.default(true)
|
||||
.describe(
|
||||
"true (default) marks the thread resolved/closed; false reopens it",
|
||||
),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294).
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.resolveComment,
|
||||
async ({ commentId, resolved }) => {
|
||||
const result = await docmostClient.resolveComment(commentId, resolved);
|
||||
return jsonContent(result);
|
||||
@@ -901,30 +647,10 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: check_new_comments
|
||||
server.registerTool(
|
||||
"check_new_comments",
|
||||
{
|
||||
description:
|
||||
"Check for new comments across pages in a space since a given timestamp. " +
|
||||
"Optionally scope to a page subtree (folder). Returns only comments " +
|
||||
"created after the specified time.",
|
||||
inputSchema: {
|
||||
spaceId: z.string().describe("Space ID to check for new comments"),
|
||||
since: z
|
||||
.string()
|
||||
.min(1)
|
||||
.describe(
|
||||
"ISO 8601 timestamp — only return comments created after this time (e.g. '2026-03-10T00:00:00Z')",
|
||||
),
|
||||
parentPageId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe(
|
||||
"Optional root page ID to scope the check to a subtree (folder). " +
|
||||
"Only pages under this parent will be checked.",
|
||||
),
|
||||
},
|
||||
},
|
||||
// Schema + description now live in the shared registry (#294). The execute body
|
||||
// keeps this transport's own guard rejecting an unparseable `since` timestamp.
|
||||
registerShared(
|
||||
SHARED_TOOL_SPECS.checkNewComments,
|
||||
async ({ spaceId, since, parentPageId }) => {
|
||||
// Reject an unparseable timestamp up front: otherwise the comparison
|
||||
// against NaN silently treats every comment as "not new" and the tool
|
||||
@@ -1053,6 +779,8 @@ server.registerTool(
|
||||
);
|
||||
|
||||
// Tool: insert_footnote
|
||||
// MCP-only by design (see insert_image): the in-app AI-chat agent exposes no
|
||||
// footnote tool, so there is no second layer to unify — stays inline (#294).
|
||||
server.registerTool(
|
||||
"insert_footnote",
|
||||
{
|
||||
|
||||
@@ -316,6 +316,34 @@ export const SHARED_TOOL_SPECS = {
|
||||
|
||||
// --- share management ---
|
||||
|
||||
// Unified from the per-layer inline definitions (#294). Both layers already
|
||||
// carried the "only share when explicitly asked" security framing (the
|
||||
// "per-transport divergence" note on the old inline copies was stale), so
|
||||
// there was no real behavioral divergence to preserve — only wording drift.
|
||||
sharePage: {
|
||||
mcpName: 'share_page',
|
||||
inAppKey: 'sharePage',
|
||||
// CANONICAL: merges the MCP copy's URL-format + idempotency detail with the
|
||||
// in-app copy's reversibility note; keeps the security framing both had.
|
||||
description:
|
||||
'Make a page PUBLICLY accessible (idempotent) and return its public URL ' +
|
||||
'(format: <app>/share/<key>/p/<slugId>). This exposes the page content ' +
|
||||
'to ANYONE with the URL — only share when the user explicitly asked. ' +
|
||||
'Reversible: unshare it later to revoke the public URL.',
|
||||
tier: 'deferred',
|
||||
catalogLine: 'sharePage — make a page publicly accessible and return its URL.',
|
||||
// Reconciled: MCP's stricter .min(1) on pageId kept; field descriptions from
|
||||
// the in-app copy. The MCP execute keeps its own `searchIndexing ?? true`
|
||||
// default (a per-layer concern, not part of the shared schema).
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('The id of the page to share.'),
|
||||
searchIndexing: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe('Allow public search engines to index it (default true).'),
|
||||
}),
|
||||
},
|
||||
|
||||
unsharePage: {
|
||||
mcpName: 'unshare_page',
|
||||
inAppKey: 'unsharePage',
|
||||
@@ -509,4 +537,470 @@ export const SHARED_TOOL_SPECS = {
|
||||
pageId: z.string().min(1),
|
||||
}),
|
||||
},
|
||||
|
||||
// --- page tools (unified from the per-layer inline definitions, #294) ---
|
||||
//
|
||||
// Descriptions merge both layers (the MCP copy's richer structural notes + the
|
||||
// in-app copy's "Reversible via history/trash" framing where it added one).
|
||||
// Field constraints keep the MCP copy's stricter .min(1) EXCEPT where the
|
||||
// in-app layer deliberately allowed a looser value (documented per field).
|
||||
|
||||
getPage: {
|
||||
mcpName: 'get_page',
|
||||
inAppKey: 'getPage',
|
||||
description:
|
||||
'Fetch a single page as Markdown by its id. Returns the page title and ' +
|
||||
'its Markdown content. The Markdown conversion is LOSSY (block ids, exact ' +
|
||||
'table/callout structure are approximated); for a lossless representation ' +
|
||||
'use the lossless page-JSON read tool. Inline <span data-comment-id> tags in the markdown ' +
|
||||
'are comment highlight anchors (also present for RESOLVED threads) — ' +
|
||||
'treat them as markup, not page text.',
|
||||
tier: 'core',
|
||||
catalogLine: 'getPage — fetch a page as Markdown by its id.',
|
||||
// Reconciled: MCP's stricter .min(1) kept; in-app's more-informative
|
||||
// "(or slugId)" describe kept.
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('The id (or slugId) of the page.'),
|
||||
}),
|
||||
},
|
||||
|
||||
listPages: {
|
||||
mcpName: 'list_pages',
|
||||
inAppKey: 'listPages',
|
||||
description:
|
||||
'List the most recent pages (ordered by updatedAt, descending), ' +
|
||||
'optionally scoped to a single space. Returns a bounded list (default ' +
|
||||
'50, max 100) — use search for lookups in large spaces. Pass tree:true ' +
|
||||
"(with spaceId) to instead get the space's full page hierarchy as a " +
|
||||
'nested tree.',
|
||||
tier: 'core',
|
||||
catalogLine: "listPages — list recent pages, or a space's full page tree.",
|
||||
buildShape: (z) => ({
|
||||
spaceId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe('Optional space id to scope the listing to.'),
|
||||
limit: z
|
||||
.number()
|
||||
.int()
|
||||
.min(1)
|
||||
.max(100)
|
||||
.optional()
|
||||
.describe('Maximum number of pages (default 50, max 100).'),
|
||||
tree: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe(
|
||||
"When true, return the space's full page hierarchy as a nested tree " +
|
||||
'(children arrays) instead of the recent-by-updatedAt flat list. ' +
|
||||
'Requires spaceId; ignores limit.',
|
||||
),
|
||||
}),
|
||||
},
|
||||
|
||||
createPage: {
|
||||
mcpName: 'create_page',
|
||||
inAppKey: 'createPage',
|
||||
description:
|
||||
'Create a new page with a Markdown body in a space, optionally under a ' +
|
||||
'parent page (omit parentPageId to create at the space root). Returns ' +
|
||||
'the new page id and title. Reversible: a page can be moved to trash ' +
|
||||
'later.',
|
||||
tier: 'deferred',
|
||||
catalogLine: 'createPage — create a new page with a Markdown body in a space.',
|
||||
// Reconciled schema DRIFT: the MCP copy pinned `content` to .min(1) while
|
||||
// the in-app copy left it unbounded and DOCUMENTS an empty body as valid
|
||||
// ("may be empty") — creating an empty page to fill in later is a real use
|
||||
// case. The looser (no-min) form is kept, so create_page now also accepts an
|
||||
// empty body (harmless — it creates an empty page) and no previously-valid
|
||||
// in-app input is ever rejected. `title`/`spaceId` keep the MCP .min(1)
|
||||
// (an empty title or space is never valid).
|
||||
buildShape: (z) => ({
|
||||
title: z.string().min(1).describe('The title of the new page.'),
|
||||
content: z.string().describe('The page body as Markdown (may be empty).'),
|
||||
spaceId: z.string().min(1).describe('The id of the space to create the page in.'),
|
||||
parentPageId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe('Optional parent page id to nest the new page under.'),
|
||||
}),
|
||||
},
|
||||
|
||||
movePage: {
|
||||
mcpName: 'move_page',
|
||||
inAppKey: 'movePage',
|
||||
description:
|
||||
'Move a page under a new parent page, or to the space root when no ' +
|
||||
'parent is given. Reversible: move it back at any time.',
|
||||
tier: 'deferred',
|
||||
catalogLine: 'movePage — move a page under a new parent or to the space root.',
|
||||
// Reconciled schema DRIFT: the MCP copy exposed a `position` field
|
||||
// (fractional-index ordering) that the in-app copy lacked. Unified by
|
||||
// KEEPING position (the in-app client already accepts an optional position
|
||||
// arg, so the in-app execute now forwards it) — it is optional, so no
|
||||
// previously-valid in-app call is rejected. `parentPageId` is `.nullable()`
|
||||
// on both, so a real JSON null moves to root on either transport; the MCP
|
||||
// execute additionally coerces the strings 'null'/'' to null as a robustness
|
||||
// fallback (kept in its execute body, not in the shared schema).
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('The id of the page to move.'),
|
||||
parentPageId: z
|
||||
.string()
|
||||
.nullable()
|
||||
.optional()
|
||||
.describe(
|
||||
'Target parent page id. Null or omitted moves the page to the space ' +
|
||||
'root.',
|
||||
),
|
||||
position: z
|
||||
.string()
|
||||
.min(5)
|
||||
.optional()
|
||||
.describe(
|
||||
'Optional fractional-index position key (min 5 chars); omit to ' +
|
||||
'append at the end.',
|
||||
),
|
||||
}),
|
||||
},
|
||||
|
||||
renamePage: {
|
||||
mcpName: 'rename_page',
|
||||
inAppKey: 'renamePage',
|
||||
description:
|
||||
'Rename a page (change its title only; the body is untouched, never ' +
|
||||
'resent). Reversible: rename back at any time.',
|
||||
tier: 'deferred',
|
||||
catalogLine: "renamePage — change a page's title only (body untouched).",
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('The id of the page to rename.'),
|
||||
title: z.string().min(1).describe('The new title.'),
|
||||
}),
|
||||
},
|
||||
|
||||
deletePage: {
|
||||
mcpName: 'delete_page',
|
||||
inAppKey: 'deletePage',
|
||||
description:
|
||||
'Move a page to the trash — SOFT delete only: the page can be restored ' +
|
||||
'from trash and nothing is ever permanently deleted.',
|
||||
tier: 'deferred',
|
||||
catalogLine: 'deletePage — move a page to trash (soft delete, reversible).',
|
||||
// GUARDRAIL preserved (§14 H4): the schema exposes ONLY pageId, so a
|
||||
// permanentlyDelete/forceDelete flag can never reach the client through this
|
||||
// tool (asserted by ai-chat-tools.service.spec.ts).
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('The id of the page to move to trash.'),
|
||||
}),
|
||||
},
|
||||
|
||||
updatePageJson: {
|
||||
mcpName: 'update_page_json',
|
||||
inAppKey: 'updatePageJson',
|
||||
description:
|
||||
"Replace a page's content with a raw ProseMirror JSON document (lossless " +
|
||||
'write: preserves the block ids, callouts, tables and attributes you pass ' +
|
||||
'in). Typical flow: read the page-JSON view -> modify the JSON -> write it back. ' +
|
||||
'Keep existing node ids intact so heading anchors and history stay ' +
|
||||
'stable. Minimal full-doc example: {"type":"doc","content":[{"type":' +
|
||||
'"paragraph","content":[{"type":"text","text":"Hi"}]}]}. `content` may be ' +
|
||||
'a JSON object or a JSON string (both accepted), and is OPTIONAL: omit it ' +
|
||||
'to update only the title (though prefer the rename-page tool for a title-only ' +
|
||||
'change). Supplying neither content nor title is an error. Reversible: ' +
|
||||
'the previous version is kept in page history.',
|
||||
tier: 'deferred',
|
||||
catalogLine:
|
||||
"updatePageJson — overwrite a page's body with a full ProseMirror document.",
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('ID of the page to update'),
|
||||
content: z
|
||||
.any()
|
||||
.optional()
|
||||
.describe(
|
||||
'ProseMirror document {"type":"doc","content":[...]} (JSON object or ' +
|
||||
'JSON string). Omit to update only the title.',
|
||||
),
|
||||
title: z.string().optional().describe('Optional new title'),
|
||||
}),
|
||||
},
|
||||
|
||||
exportPageMarkdown: {
|
||||
mcpName: 'export_page_markdown',
|
||||
inAppKey: 'exportPageMarkdown',
|
||||
// CANONICAL: the MCP copy (a strict superset of the terse in-app wording).
|
||||
description:
|
||||
'Export a page to a single self-contained, lossless Docmost-flavoured ' +
|
||||
'Markdown file (custom extensions): YAML-free meta header, body with ' +
|
||||
'inline comment anchors and diagrams, and a trailing comments-thread ' +
|
||||
'block. Designed for a download -> edit body -> page-Markdown import ' +
|
||||
'round-trip that preserves everything, including comment highlights. ' +
|
||||
'Comment THREADS are preserved in the file but are not re-pushed to the ' +
|
||||
'server on import.',
|
||||
tier: 'deferred',
|
||||
catalogLine:
|
||||
'exportPageMarkdown — export a page to self-contained Markdown (body + comments).',
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('The id of the page to export.'),
|
||||
}),
|
||||
},
|
||||
|
||||
// --- comment tools (unified from the per-layer inline definitions, #294) ---
|
||||
//
|
||||
// create_comment and resolve_comment previously carried a "per-transport
|
||||
// divergence" note in BOTH layers; #294 unifies their schema + description
|
||||
// here. Only the four tools that genuinely exist in BOTH layers live in the
|
||||
// registry: create/list/resolve comment and check_new_comments.
|
||||
//
|
||||
// update_comment and delete_comment are intentionally NOT here: they exist
|
||||
// ONLY on the standalone MCP server. The in-app agent deliberately exposes no
|
||||
// hard comment edit/delete tool (comment edits are irreversible / not
|
||||
// version-tracked; see the guardrail tests in ai-chat-tools.service.spec.ts),
|
||||
// so there is nothing to unify — they stay inline in index.ts.
|
||||
|
||||
createComment: {
|
||||
mcpName: 'create_comment',
|
||||
inAppKey: 'createComment',
|
||||
// CANONICAL: the in-app copy (the more-maintained one). It keeps the same
|
||||
// rules as the MCP copy — inline-only, top-level requires a `selection`, no
|
||||
// page-level comments, replies inherit the anchor, suggestedText must be
|
||||
// unique — and adds the "retry with a corrected EXACT selection" and reply-
|
||||
// to-reply-rejected guidance the MCP copy lacked. Execute-side validation
|
||||
// (reject suggestedText on a reply, require a selection) stays per-layer.
|
||||
description:
|
||||
'Add an INLINE comment to a page, or reply to an existing top-level ' +
|
||||
'comment (one level only — the backend rejects replies to replies). ' +
|
||||
'The comment is anchored inline to the given exact `selection` text ' +
|
||||
'(which gets highlighted); page-level comments are NOT supported. A ' +
|
||||
'new top-level comment REQUIRES a `selection`. Replies inherit the ' +
|
||||
"parent's anchor and take no selection. If the call fails with a " +
|
||||
'"selection not found" error, retry with a corrected EXACT selection ' +
|
||||
'copied verbatim from a single paragraph/block. You may also attach a ' +
|
||||
'`suggestedText` proposing a replacement for the `selection` (a human ' +
|
||||
'applies it from the UI); when set, the `selection` must occur exactly ' +
|
||||
'once in the page. Reversible via the comment UI.',
|
||||
tier: 'core',
|
||||
catalogLine:
|
||||
'createComment — add an inline comment (optionally with a suggested edit).',
|
||||
// Reconciled schema: the field set is identical across both layers; the
|
||||
// only constraint drift is `content`, which the MCP copy pinned to
|
||||
// .min(1) while the in-app copy left unbounded — the stricter MCP form is
|
||||
// kept (an empty comment body is never valid).
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().describe('The id of the page to comment on.'),
|
||||
content: z.string().min(1).describe('The comment body as Markdown.'),
|
||||
selection: z
|
||||
.string()
|
||||
.min(1)
|
||||
.max(250)
|
||||
.optional()
|
||||
.describe(
|
||||
'EXACT contiguous text from a SINGLE paragraph/block to anchor ' +
|
||||
'(highlight) the comment on (<=250 chars, avoid spanning across ' +
|
||||
'formatting boundaries). Required for a new top-level comment; ' +
|
||||
'omit only when replying via parentCommentId.',
|
||||
),
|
||||
parentCommentId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe(
|
||||
'Optional id of a TOP-LEVEL comment to reply to (one level ' +
|
||||
'of replies only).',
|
||||
),
|
||||
suggestedText: z
|
||||
.string()
|
||||
.min(1)
|
||||
.max(2000)
|
||||
.optional()
|
||||
.describe(
|
||||
'Optional proposed replacement (PLAIN TEXT) for the `selection`, ' +
|
||||
'applied by a human via the UI (never auto-applied). REQUIRES a ' +
|
||||
'`selection`; NOT allowed on a reply. When set, the `selection` ' +
|
||||
'must be UNIQUE in the page — expand it with surrounding context ' +
|
||||
'(still <=250 chars) if it occurs more than once, or the call is ' +
|
||||
'refused.',
|
||||
),
|
||||
}),
|
||||
},
|
||||
|
||||
listComments: {
|
||||
mcpName: 'list_comments',
|
||||
inAppKey: 'listComments',
|
||||
// CANONICAL: the two copies are near-identical; the MCP copy is the
|
||||
// superset (it keeps the "(pagination is handled internally)" note the
|
||||
// in-app copy dropped), so it is used verbatim.
|
||||
description:
|
||||
'List comments on a page in one call (pagination is handled ' +
|
||||
'internally). By DEFAULT only ACTIVE threads are returned; resolved ' +
|
||||
'threads (a resolved top-level comment and all its replies) are hidden ' +
|
||||
'and their count reported as `resolvedThreadsHidden` so you can re-query ' +
|
||||
'with `includeResolved: true` to see everything. Returns ' +
|
||||
'`{ items, resolvedThreadsHidden }`. Content is returned as Markdown.',
|
||||
tier: 'core',
|
||||
catalogLine:
|
||||
'listComments — list all comments on a page (including resolved).',
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().describe('ID of the page'),
|
||||
includeResolved: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe('default only active threads; true — include resolved'),
|
||||
}),
|
||||
},
|
||||
|
||||
resolveComment: {
|
||||
mcpName: 'resolve_comment',
|
||||
inAppKey: 'resolveComment',
|
||||
// CANONICAL: the MCP copy's richer wording, minus its snake_case reference
|
||||
// to `delete_comment` (a sibling tool that does NOT exist in the in-app
|
||||
// layer) — rephrased transport-neutrally per the registry convention.
|
||||
description:
|
||||
'Resolve (close) or reopen a top-level comment thread (reversible — ' +
|
||||
'pass resolved=false to reopen). Only top-level comments can be ' +
|
||||
'resolved; the server rejects resolving a reply. Resolving keeps the ' +
|
||||
'thread and its replies intact (it is not a deletion).',
|
||||
tier: 'core',
|
||||
catalogLine: 'resolveComment — resolve or reopen a comment thread.',
|
||||
// Reconciled schema: `resolved` drifted — the MCP copy made it optional
|
||||
// with .default(true) (resolve is the common case, documented), the in-app
|
||||
// copy made it required. The MCP form is kept (a strict superset: it never
|
||||
// rejects a previously-valid input and adds a sensible default), and
|
||||
// commentId keeps the MCP copy's stricter .min(1).
|
||||
buildShape: (z) => ({
|
||||
commentId: z
|
||||
.string()
|
||||
.min(1)
|
||||
.describe('ID of the top-level comment thread to resolve or reopen'),
|
||||
resolved: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.default(true)
|
||||
.describe(
|
||||
'true (default) marks the thread resolved/closed; false reopens it',
|
||||
),
|
||||
}),
|
||||
},
|
||||
|
||||
checkNewComments: {
|
||||
mcpName: 'check_new_comments',
|
||||
inAppKey: 'checkNewComments',
|
||||
// CANONICAL: the MCP copy (the more detailed of the two). The MCP layer's
|
||||
// execute-side guard that rejects an unparseable `since` timestamp stays in
|
||||
// its execute body (per-layer logic), not in the shared schema.
|
||||
description:
|
||||
'Check for new comments across pages in a space since a given ' +
|
||||
'timestamp. Optionally scope to a page subtree (folder). Returns only ' +
|
||||
'comments created after the specified time.',
|
||||
tier: 'deferred',
|
||||
catalogLine:
|
||||
'checkNewComments — find comments in a space created after a timestamp.',
|
||||
// Reconciled schema: `since` keeps the MCP copy's stricter .min(1) (the
|
||||
// in-app copy left it unbounded); field descriptions use the MCP copy's
|
||||
// more detailed wording (it carries an example timestamp).
|
||||
buildShape: (z) => ({
|
||||
spaceId: z.string().describe('Space ID to check for new comments'),
|
||||
since: z
|
||||
.string()
|
||||
.min(1)
|
||||
.describe(
|
||||
"ISO 8601 timestamp — only return comments created after this time " +
|
||||
"(e.g. '2026-03-10T00:00:00Z')",
|
||||
),
|
||||
parentPageId: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe(
|
||||
'Optional root page ID to scope the check to a subtree (folder). ' +
|
||||
'Only pages under this parent will be checked.',
|
||||
),
|
||||
}),
|
||||
},
|
||||
|
||||
// --- table tools (unified from the per-layer inline definitions, #294) ---
|
||||
//
|
||||
// These tools carried a "NOT shared" note in BOTH layers because of a single
|
||||
// parameter-NAME drift: the MCP layer named the table reference `table` while
|
||||
// the in-app layer named it `tableRef`. #294 reconciles that drift by unifying
|
||||
// on the MCP name `table` — renaming the MCP public parameter would break
|
||||
// external MCP clients, whereas the in-app parameter is model-facing
|
||||
// (prompt-only) and safe to rename. The in-app execute bodies now destructure
|
||||
// `table` instead of `tableRef` (nothing else changes). Descriptions take the
|
||||
// MCP copy's richer wording (it documented `#<index>`, padding, header-row
|
||||
// behavior) plus the in-app copy's "Reversible via page history" note; sibling
|
||||
// tool references are phrased transport-neutrally.
|
||||
//
|
||||
// NOT here (kept inline in index.ts): table_get / getTable. Its MCP tool name
|
||||
// is noun-first (`table_get`) while the in-app key is verb-first (`getTable`),
|
||||
// so it breaks the snake_case(inAppKey) naming convention the registry enforces
|
||||
// (shared-tool-specs.contract.spec.ts). Renaming the public MCP tool would
|
||||
// break external clients, so it stays per-transport (its in-app param was still
|
||||
// aligned to `table` for consistency with the migrated trio below).
|
||||
|
||||
tableInsertRow: {
|
||||
mcpName: 'table_insert_row',
|
||||
inAppKey: 'tableInsertRow',
|
||||
description:
|
||||
'Insert a row of plain-text cells into a table. `table` is `#<index>` ' +
|
||||
'from the page outline, or a block id inside it. `cells` is the text per ' +
|
||||
"column (padded to the table's column count; an error if more cells than " +
|
||||
'columns). `index` is the 0-based insert position (0 inserts before the ' +
|
||||
'header); omit to append at the end. Reversible via page history.',
|
||||
tier: 'deferred',
|
||||
catalogLine: 'tableInsertRow — insert a row of plain-text cells into a table.',
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('The id of the page.'),
|
||||
table: z
|
||||
.string()
|
||||
.min(1)
|
||||
.describe('"#<index>" from the page outline, or a block id in the table.'),
|
||||
cells: z.array(z.string()).describe('The cell texts for the row (one per column).'),
|
||||
index: z
|
||||
.number()
|
||||
.int()
|
||||
.optional()
|
||||
.describe('0-based insert position (0 inserts before the header); omit to append.'),
|
||||
}),
|
||||
},
|
||||
|
||||
tableDeleteRow: {
|
||||
mcpName: 'table_delete_row',
|
||||
inAppKey: 'tableDeleteRow',
|
||||
description:
|
||||
'Delete the row at 0-based `index` from a table (`table` is `#<index>` ' +
|
||||
'from the page outline, or a block id inside it). Refuses to delete the ' +
|
||||
"table's only row; an out-of-range `index` throws. Deleting `index` 0 " +
|
||||
'removes the header row, and the next row becomes the new header. ' +
|
||||
'Reversible via page history.',
|
||||
tier: 'deferred',
|
||||
catalogLine: 'tableDeleteRow — delete a table row at a 0-based index.',
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('The id of the page.'),
|
||||
table: z
|
||||
.string()
|
||||
.min(1)
|
||||
.describe('"#<index>" from the page outline, or a block id in the table.'),
|
||||
index: z.number().int().describe('0-based row index to delete.'),
|
||||
}),
|
||||
},
|
||||
|
||||
tableUpdateCell: {
|
||||
mcpName: 'table_update_cell',
|
||||
inAppKey: 'tableUpdateCell',
|
||||
description:
|
||||
'Set the plain-text content of cell [row, col] (0-based) in a table ' +
|
||||
'(`table` is `#<index>` from the page outline, or a block id inside it). ' +
|
||||
"Replaces the cell's content with a single text paragraph; for rich " +
|
||||
"formatting, patch the cell's paragraph id (obtained from reading the " +
|
||||
'table) instead. Reversible via page history.',
|
||||
tier: 'deferred',
|
||||
catalogLine: 'tableUpdateCell — set the text of a table cell at [row, col].',
|
||||
buildShape: (z) => ({
|
||||
pageId: z.string().min(1).describe('The id of the page.'),
|
||||
table: z
|
||||
.string()
|
||||
.min(1)
|
||||
.describe('"#<index>" from the page outline, or a block id in the table.'),
|
||||
row: z.number().int().describe('0-based row index.'),
|
||||
col: z.number().int().describe('0-based column index.'),
|
||||
text: z.string().describe('The new cell text.'),
|
||||
}),
|
||||
},
|
||||
} satisfies Record<string, SharedToolSpec>;
|
||||
|
||||
Vendored
+16
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"_bug": "BUG #351: a `column` whose `width` is a percentage string (e.g. \"50%\") is NOT byte-stable across export->import->export (violates P2). The `column` schema's parseHTML does `parseFloat(getAttribute('data-width'))`, which silently drops the '%' unit and returns the NUMBER 50. So the first export emits data-width=\"50%\" but the re-import stores width=50, and the second export emits data-width=\"50\": md2 !== md1, a permanent GS-EDIT-REVERT churn (every git-sync pull rewrites the column width). The editor authors column widths as percentages, so this is a real data/round-trip defect. Fix belongs in src/lib/docmost-schema.ts column.width parseHTML (preserve the unit / keep the string), which is OUT OF SCOPE for this test-only PR and must be a separate, maintainer-approved change. This flat generator therefore keeps `column.width` frozen (never generates a non-default width).",
|
||||
"doc": {
|
||||
"type": "doc",
|
||||
"content": [
|
||||
{
|
||||
"type": "columns",
|
||||
"attrs": { "layout": "two_equal", "widthMode": "normal" },
|
||||
"content": [
|
||||
{ "type": "column", "attrs": { "width": "50%" }, "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "L" }] }] },
|
||||
{ "type": "column", "attrs": { "width": "50%" }, "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "R" }] }] }
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"doc": {
|
||||
"type": "doc",
|
||||
"content": [
|
||||
{
|
||||
"type": "orderedList",
|
||||
"attrs": { "type": null, "start": 5 },
|
||||
"content": [
|
||||
{
|
||||
"type": "listItem",
|
||||
"content": [
|
||||
{ "type": "paragraph", "content": [{ "type": "text", "text": "alpha" }] }
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,325 @@
|
||||
/**
|
||||
* Schema-DERIVED attribute-state fast-check arbitraries (#351, PR 1).
|
||||
*
|
||||
* This GENERALIZES the #350 stability-matrix helper (roundtrip-stability.helper.ts)
|
||||
* to fast-check. Where that helper sweeps a HAND-WRITTEN 2-state matrix for one
|
||||
* node spec, this module reads the attribute list straight from
|
||||
* `schema.nodes[type].spec.attrs` (never a hand list) and, per attribute,
|
||||
* generates over the FOUR states the issue calls for:
|
||||
*
|
||||
* - `absent` : the attribute is OMITTED entirely (the empty-string-vs-
|
||||
* absent churn class the #350 fix targets).
|
||||
* - `default` : the schema default value, authored explicitly.
|
||||
* - `nonDefault` : a representative legal non-default value.
|
||||
* - `degenerate` : `""` for strings, `0`/negative for numbers, the flipped
|
||||
* value for booleans.
|
||||
*
|
||||
* ── Why a per-attribute override table ──────────────────────────────────────
|
||||
* Everything that CAN be derived generically from the default's runtime type is
|
||||
* (booleans flip; the degenerate value follows the runtime type). But two facts
|
||||
* force a small, DOCUMENTED override table:
|
||||
*
|
||||
* 1. CONSTRAINED domains the schema does not encode. `image.align ∈
|
||||
* {left,center,right}`, `heading.level ∈ 1..6`, `callout.type ∈
|
||||
* {info,success,warning,danger}`, `columns.layout`, table-cell `align`,
|
||||
* `status.color`, `orderedList.start ≥ 1`, etc. A generic "default + 1"
|
||||
* would emit an ILLEGAL value, so these get an explicit legal domain.
|
||||
* 2. ROUND-TRIP-safety, established EMPIRICALLY by probing the live converter
|
||||
* (the classification captured in flat-roundtrip.property.test.ts). A frozen
|
||||
* attribute falls into ONE of TWO explicitly-distinguished classes — never a
|
||||
* silent "it just doesn't round-trip":
|
||||
*
|
||||
* (a) ACCEPTED LIMITATION — the attribute has NO markdown representation,
|
||||
* so the loss is inherent to targeting markdown, not a converter
|
||||
* defect. These: `paragraph`/`heading` `indent`, `callout.icon`,
|
||||
* `orderedList.type` (a/A/i markers), table `colwidth` /
|
||||
* `backgroundColor(Name)` (dropped by the raw-<table> fallback). Each is
|
||||
* tagged `// ACCEPTED:` inline. Freezing them is correct — there is
|
||||
* nothing to preserve in the target format.
|
||||
*
|
||||
* (b) PINNED BUG — the attribute IS representable in markdown but the
|
||||
* converter drops it anyway (a real defect). These are NOT silently
|
||||
* frozen: each is captured as a LOUD `it.fails` counterexample in
|
||||
* test/fixtures/counterexamples/ + counterexamples.test.ts, and the
|
||||
* freeze here only keeps the P1/P2 union green until a MAINTAINER rules
|
||||
* on accept-vs-fix (the epic guardrail reserves that call). These:
|
||||
* `column.width` (parseFloat drops `%`), `orderedList.start` (non-1
|
||||
* start renders as `1.`). Tagged `// PINNED-BUG:` inline.
|
||||
*
|
||||
* (c) DEFERRED-BUG — representable AND round-trips, frozen only because the
|
||||
* flat generator can't yet build a valid instance. Table
|
||||
* `colspan`/`rowspan` round-trip via the raw-<table> fallback, but a
|
||||
* geometrically-valid spanned table is PR-2 structural work; the flat
|
||||
* generator hardcodes span = 1. Tagged `// DEFERRED-BUG:` inline so a
|
||||
* maintainer does not read them as an inherent limitation.
|
||||
* - Several non-null-default attrs are MATERIALIZED on import but are not
|
||||
* in canonicalize's KNOWN_DEFAULTS (`callout.type`, `status.color`,
|
||||
* table `colspan`/`rowspan`, `columns.layout`/`widthMode`,
|
||||
* `embed.width`/`height`, `heading.level`, `taskItem.checked`,
|
||||
* `details.open`, `subpages.recursive`, `orderedList.start`). If left
|
||||
* `absent` they re-materialize as a non-canonical default and diverge
|
||||
* under P1. We mark them `always` so they are authored explicitly.
|
||||
* - The documented numeric→string coercion set (`width height size
|
||||
* aspectRatio`) is generated as STRINGS for the media family (a stored
|
||||
* number re-parses as a string), EXCEPT `embed.width/height` which the
|
||||
* embed schema keeps numeric — handled per-attr.
|
||||
*
|
||||
* Both PINNED-BUG attrs (`column.width` P2 churn, `orderedList.start` P1 loss)
|
||||
* are captured as committed `it.fails` counterexamples — NOT hidden here.
|
||||
*/
|
||||
import fc from 'fast-check';
|
||||
import { getSchema } from '@tiptap/core';
|
||||
import { docmostExtensions } from '../../src/lib/index.js';
|
||||
import { phraseArb, letterPhraseArb, urlArb } from './text-arbitraries.js';
|
||||
|
||||
/** The exact ProseMirror schema the converter targets. */
|
||||
export const schema = getSchema(docmostExtensions as any);
|
||||
|
||||
/** Sentinel: this attribute is OMITTED (the `absent` state). */
|
||||
export const ABSENT = Symbol('ABSENT');
|
||||
|
||||
/** The documented numeric→string coercion set (issue + roundtrip-stability.helper). */
|
||||
export const NUMERIC_STRING_ATTRS = ['width', 'height', 'size', 'aspectRatio'];
|
||||
|
||||
/** Read the schema default for every attribute of a node type. */
|
||||
export function schemaAttrDefaults(type: string): Record<string, unknown> {
|
||||
const specAttrs = (schema.nodes[type]?.spec?.attrs ?? {}) as Record<
|
||||
string,
|
||||
{ default: unknown }
|
||||
>;
|
||||
const out: Record<string, unknown> = {};
|
||||
for (const [k, v] of Object.entries(specAttrs)) out[k] = v.default;
|
||||
return out;
|
||||
}
|
||||
|
||||
/** Attribute names for a node type, straight from the schema (never hand-listed). */
|
||||
export function schemaAttrNames(type: string): string[] {
|
||||
return Object.keys((schema.nodes[type]?.spec?.attrs ?? {}) as object);
|
||||
}
|
||||
|
||||
/**
|
||||
* Per-attribute policy. Everything unlisted falls back to a generic policy:
|
||||
* - a BOOLEAN default is fuzzable (its non-default is the flipped value);
|
||||
* - any other default is `frozen` (only `absent`/`default` are generated) so
|
||||
* we never invent an unverified non-default that might not round-trip.
|
||||
* Listed attrs override this with a legal `arb` domain and/or flags.
|
||||
*/
|
||||
interface AttrPolicy {
|
||||
/** Arbitrary for the `nonDefault` state's value. */
|
||||
arb?: fc.Arbitrary<unknown>;
|
||||
/** Value for the `degenerate` state (fuzz mode only). Omit to skip degenerate. */
|
||||
degen?: unknown;
|
||||
/** Never emit `absent` — the attr must be authored (materialized default class). */
|
||||
always?: boolean;
|
||||
/** Never emit the schema default value (required-ish attrs like `src`). Implies always. */
|
||||
noDefault?: boolean;
|
||||
/** Never emit non-default/degenerate — attr has no md representation or churns. */
|
||||
frozen?: boolean;
|
||||
}
|
||||
|
||||
const num = (...xs: number[]) => fc.constantFrom(...xs);
|
||||
const str = (...xs: string[]) => fc.constantFrom(...xs);
|
||||
const widthStr = str('120', '320', '640');
|
||||
|
||||
// The documented override table, keyed `type.attr`. Every entry is grounded in
|
||||
// the empirical converter probe (see flat-roundtrip.property.test.ts header).
|
||||
const OVERRIDES: Record<string, AttrPolicy> = {
|
||||
// ── block text containers ────────────────────────────────────────────────
|
||||
// 'left' is the IMPLICIT default alignment: the converter drops it on export
|
||||
// (empirically confirmed), so it never round-trips. Only center/right/justify
|
||||
// carry through the `<!--attrs {textAlign}-->` comment.
|
||||
'paragraph.textAlign': { arb: str('center', 'right', 'justify') },
|
||||
'paragraph.indent': { frozen: true }, // ACCEPTED: no md representation
|
||||
'heading.level': { always: true, arb: num(2, 3, 4, 5, 6) },
|
||||
'heading.textAlign': { arb: str('center', 'right', 'justify') },
|
||||
'heading.indent': { frozen: true }, // ACCEPTED: no md representation
|
||||
// ── lists ────────────────────────────────────────────────────────────────
|
||||
// PINNED-BUG: markdown CAN express a non-1 start ("5."), but the converter
|
||||
// renders "1." and drops it -> P1 loss. See counterexamples.test.ts
|
||||
// (ordered-list-start.json). Frozen only until the maintainer rules accept-vs-fix.
|
||||
'orderedList.start': { always: true, frozen: true },
|
||||
'orderedList.type': { frozen: true }, // ACCEPTED: a/A/i markers not expressible in GFM
|
||||
'taskItem.checked': { always: true, arb: fc.constant(true) }, // boolean, default false
|
||||
// ── codeBlock ────────────────────────────────────────────────────────────
|
||||
'codeBlock.language': { arb: str('js', 'ts', 'python', 'go', 'rust', 'bash') },
|
||||
// ── image / media (numeric→string width family) ──────────────────────────
|
||||
'image.src': { noDefault: true, arb: urlArb, degen: '' },
|
||||
'image.align': { arb: str('left', 'right') },
|
||||
'image.alt': { arb: letterPhraseArb, degen: '' },
|
||||
'image.title': { arb: letterPhraseArb },
|
||||
'image.width': { arb: widthStr, degen: '' },
|
||||
'image.height': { arb: widthStr, degen: '' },
|
||||
'video.src': { noDefault: true, arb: urlArb, degen: '' },
|
||||
'video.alt': { arb: letterPhraseArb },
|
||||
'video.width': { arb: widthStr },
|
||||
'video.height': { arb: widthStr },
|
||||
'audio.src': { noDefault: true, arb: urlArb, degen: '' },
|
||||
'youtube.src': { noDefault: true, arb: urlArb },
|
||||
'pdf.src': { noDefault: true, arb: urlArb },
|
||||
'pdf.name': { arb: phraseArb },
|
||||
'drawio.src': { noDefault: true, arb: urlArb },
|
||||
'excalidraw.src': { noDefault: true, arb: urlArb },
|
||||
'attachment.url': { noDefault: true, arb: urlArb },
|
||||
'attachment.name': { arb: phraseArb },
|
||||
// ── callout / status ─────────────────────────────────────────────────────
|
||||
'callout.type': { always: true, arb: str('success', 'warning', 'danger') },
|
||||
'callout.icon': { frozen: true }, // ACCEPTED: no md representation (dropped on export)
|
||||
'status.text': { noDefault: true, arb: phraseArb, degen: '' },
|
||||
'status.color': { always: true, arb: str('green', 'orange', 'red', 'blue', 'yellow', 'purple') },
|
||||
// ── table cells ────────────────────────────────────────────────────────────
|
||||
// DEFERRED-BUG (not ACCEPTED): colspan/rowspan ARE representable and round-trip
|
||||
// — a spanned cell makes the converter emit the whole table as a raw <table>
|
||||
// with colspan/rowspan attrs (markdown-converter.ts tableToHtml), which the
|
||||
// tiptap parser reads back. They are frozen only because generating a
|
||||
// geometrically-valid spanned table is deferred STRUCTURAL work (the flat
|
||||
// generator hardcodes colspan/rowspan = 1), NOT a markdown limitation.
|
||||
'tableCell.colspan': { always: true, frozen: true },
|
||||
'tableCell.rowspan': { always: true, frozen: true },
|
||||
// ACCEPTED: colwidth / backgroundColor(Name) have no representation — the
|
||||
// raw-<table> fallback (tableToHtml) drops them, so there is nothing to preserve.
|
||||
'tableCell.colwidth': { frozen: true },
|
||||
'tableCell.backgroundColor': { frozen: true },
|
||||
'tableCell.backgroundColorName': { frozen: true },
|
||||
'tableCell.align': { arb: str('left', 'center', 'right') },
|
||||
'tableHeader.colspan': { always: true, frozen: true }, // DEFERRED-BUG (see tableCell.colspan)
|
||||
'tableHeader.rowspan': { always: true, frozen: true }, // DEFERRED-BUG (see tableCell.rowspan)
|
||||
'tableHeader.colwidth': { frozen: true }, // ACCEPTED: no representation
|
||||
'tableHeader.backgroundColor': { frozen: true }, // ACCEPTED: no representation
|
||||
'tableHeader.backgroundColorName': { frozen: true }, // ACCEPTED: no representation
|
||||
'tableHeader.align': { arb: str('left', 'center', 'right') },
|
||||
// ── details ──────────────────────────────────────────────────────────────
|
||||
'details.open': { always: true, arb: fc.constant(true) }, // boolean, default false
|
||||
// ── columns ──────────────────────────────────────────────────────────────
|
||||
'columns.layout': { always: true, arb: str('three_equal', 'left_sidebar', 'right_sidebar') },
|
||||
// widthMode round-trips via the `data-width-mode` attribute (verified P1+P2),
|
||||
// so it is fuzzed, not frozen.
|
||||
'columns.widthMode': { always: true, arb: str('custom') },
|
||||
// PINNED-BUG: parseFloat import drops the `%` unit -> P2 churn. See
|
||||
// counterexamples.test.ts (columns-column-width-percent.json).
|
||||
'column.width': { frozen: true },
|
||||
// ── embed (schema keeps width/height NUMERIC, not string-coerced) ─────────
|
||||
'embed.src': { noDefault: true, arb: urlArb, degen: '' },
|
||||
'embed.provider': { noDefault: true, arb: str('iframe', 'youtube', 'vimeo') },
|
||||
'embed.width': { always: true, frozen: true },
|
||||
'embed.height': { always: true, frozen: true },
|
||||
// ── subpages / math / htmlEmbed ──────────────────────────────────────────
|
||||
'subpages.recursive': { always: true, arb: fc.constant(true) }, // boolean, default false
|
||||
'mathBlock.text': { noDefault: true, arb: str('x^2', 'a < b', '\\frac{1}{2}'), degen: '' },
|
||||
'mathInline.text': { noDefault: true, arb: str('x^2', 'a < b', '\\frac{1}{2}'), degen: '' },
|
||||
'htmlEmbed.source': { noDefault: true, arb: str('<b>hi</b>', '<i>x</i>', '<span>y</span>'), degen: '' },
|
||||
'htmlEmbed.height': { arb: num(200, 300, 400) },
|
||||
// ── footnotes / transclusion / pageEmbed / mention ───────────────────────
|
||||
'footnoteDefinition.id': { noDefault: true, arb: str('fn1', 'fn2', 'note') },
|
||||
'footnoteReference.id': { noDefault: true, arb: str('fn1', 'fn2', 'note') },
|
||||
'pageEmbed.sourcePageId': { noDefault: true, arb: fc.uuid() },
|
||||
'transclusionSource.id': { noDefault: true, arb: str('src1', 'src2') },
|
||||
'transclusionReference.sourcePageId': { noDefault: true, arb: fc.uuid() },
|
||||
'transclusionReference.transclusionId': { noDefault: true, arb: str('tr1', 'tr2') },
|
||||
'mention.id': { noDefault: true, arb: fc.uuid() },
|
||||
'mention.label': { noDefault: true, arb: phraseArb },
|
||||
'mention.entityType': { noDefault: true, arb: str('user') },
|
||||
'mention.entityId': { noDefault: true, arb: fc.uuid() },
|
||||
};
|
||||
|
||||
/** Resolve the effective policy for one attribute (override merged over generic). */
|
||||
function policyFor(type: string, attr: string, def: unknown): AttrPolicy {
|
||||
const override = OVERRIDES[`${type}.${attr}`];
|
||||
if (override) return override;
|
||||
// Generic: booleans are fuzzable via their flipped value; everything else is
|
||||
// frozen (only absent/default) so no unverified non-default is invented.
|
||||
if (typeof def === 'boolean') return { arb: fc.constant(!def) };
|
||||
return { frozen: true };
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether an attribute is actually exercised at a NON-DEFAULT value (i.e. its
|
||||
* policy has an `arb`, which the generic fallback does not). Used by the
|
||||
* attribute-coverage snapshot test to make the generic-frozen space VISIBLE: any
|
||||
* string/number attr not in OVERRIDES is silently only tested at absent/default,
|
||||
* so the snapshot pins exactly which attrs are NOT value-fuzzed and forces a
|
||||
* reviewer to look when a new attr lands in that invisible bucket.
|
||||
*/
|
||||
export function attrIsValueFuzzed(type: string, attr: string): boolean {
|
||||
const def = schemaAttrDefaults(type)[attr];
|
||||
return !!policyFor(type, attr, def).arb;
|
||||
}
|
||||
|
||||
/** Every node `type.attr` in the schema (excluding the auto `id`), sorted. */
|
||||
export function allSchemaAttrKeys(): string[] {
|
||||
const keys: string[] = [];
|
||||
for (const type of Object.keys(schema.nodes)) {
|
||||
for (const attr of schemaAttrNames(type)) {
|
||||
if (attr === 'id') continue;
|
||||
keys.push(`${type}.${attr}`);
|
||||
}
|
||||
}
|
||||
return keys.sort();
|
||||
}
|
||||
|
||||
/**
|
||||
* Every MARK attribute in the schema, keyed `mark:<name>.<attr>`, sorted. Marks
|
||||
* are not driven by the node OVERRIDES table (they are fuzzed by the text
|
||||
* generator, text-arbitraries.ts), so their value-fuzz coverage is tracked with a
|
||||
* separate snapshot (see flat-roundtrip.property.test.ts) — without this the
|
||||
* "no invisible coverage hole" guarantee would hold for node attrs only, letting a
|
||||
* new mark attr slip through unfuzzed and unallowlisted.
|
||||
*/
|
||||
export function allSchemaMarkAttrKeys(): string[] {
|
||||
const keys: string[] = [];
|
||||
for (const [name, mark] of Object.entries(schema.marks)) {
|
||||
const attrs = (mark.spec?.attrs ?? {}) as Record<string, unknown>;
|
||||
for (const attr of Object.keys(attrs)) keys.push(`mark:${name}.${attr}`);
|
||||
}
|
||||
return keys.sort();
|
||||
}
|
||||
|
||||
export type AttrMode = 'p1' | 'fuzz';
|
||||
|
||||
/**
|
||||
* Build an arbitrary for ONE attribute's value (or the ABSENT sentinel) across
|
||||
* the states legal for `mode`:
|
||||
* - p1 : absent / default / nonDefault (the round-trip-safe space).
|
||||
* - fuzz : the above PLUS degenerate (P2 tolerates the one-time
|
||||
* normalization; P3 only needs totality).
|
||||
*/
|
||||
export function attrValueArb(
|
||||
type: string,
|
||||
attr: string,
|
||||
mode: AttrMode,
|
||||
): fc.Arbitrary<unknown | typeof ABSENT> {
|
||||
const def = schemaAttrDefaults(type)[attr];
|
||||
const p = policyFor(type, attr, def);
|
||||
|
||||
const states: fc.Arbitrary<unknown | typeof ABSENT>[] = [];
|
||||
if (!p.always && !p.noDefault) states.push(fc.constant(ABSENT));
|
||||
if (!p.noDefault) states.push(fc.constant(def));
|
||||
if (!p.frozen && p.arb) states.push(p.arb);
|
||||
if (mode === 'fuzz' && !p.frozen && p.degen !== undefined) {
|
||||
states.push(fc.constant(p.degen));
|
||||
}
|
||||
if (states.length === 0) states.push(fc.constant(def));
|
||||
return fc.oneof(...states);
|
||||
}
|
||||
|
||||
/**
|
||||
* Build an arbitrary for a node's full `attrs` object over all schema attrs.
|
||||
* `base` pins caller-required attrs (e.g. a concrete `src`) verbatim; any attr
|
||||
* present in `base` is NOT re-generated. Omitted (ABSENT) attrs are dropped.
|
||||
*/
|
||||
export function nodeAttrsArb(
|
||||
type: string,
|
||||
mode: AttrMode,
|
||||
base: Record<string, unknown> = {},
|
||||
): fc.Arbitrary<Record<string, unknown>> {
|
||||
const names = schemaAttrNames(type).filter((n) => !(n in base) && n !== 'id');
|
||||
if (names.length === 0) return fc.constant({ ...base });
|
||||
return fc
|
||||
.tuple(...names.map((n) => attrValueArb(type, n, mode)))
|
||||
.map((vals) => {
|
||||
const attrs: Record<string, unknown> = { ...base };
|
||||
names.forEach((n, i) => {
|
||||
if (vals[i] !== ABSENT) attrs[n] = vals[i];
|
||||
});
|
||||
return attrs;
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,74 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { readFileSync } from 'node:fs';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import path from 'node:path';
|
||||
import { convertProseMirrorToMarkdown } from '../../src/lib/markdown-converter.js';
|
||||
import { markdownToProseMirror } from '../../src/lib/markdown-to-prosemirror.js';
|
||||
import { docsCanonicallyEqual } from '../../src/lib/canonicalize.js';
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// #351 committed counterexamples — REAL round-trip bugs surfaced by the flat
|
||||
// generative probing (attribute level). Each is pinned here as an `it.fails`
|
||||
// (vitest passes ONLY WHILE the assertion still fails), so that the day the
|
||||
// underlying src/ bug is fixed, the `it.fails` starts PASSING and vitest turns
|
||||
// this test RED — forcing us to delete the counterexample and (per the epic
|
||||
// guardrail) tighten the generator. A bare `it.fails` would ship silent
|
||||
// corruption, so every case below carries a loud `// BUG #351:` explanation.
|
||||
//
|
||||
// These bugs are NOT worked around by weakening any property: the offending
|
||||
// attribute is kept OUT of the P1/P2 generators (documented in
|
||||
// attr-arbitraries.ts), and the exact failing document lives here as the
|
||||
// regression pin. FIXING the bug is a separate, maintainer-approved src/ change.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const here = path.dirname(fileURLToPath(import.meta.url));
|
||||
const fixtureDir = path.resolve(here, '../fixtures/counterexamples');
|
||||
|
||||
function loadDoc(file: string): any {
|
||||
return JSON.parse(readFileSync(path.join(fixtureDir, file), 'utf8')).doc;
|
||||
}
|
||||
|
||||
describe('#351 counterexamples (known round-trip bugs, pinned as it.fails)', () => {
|
||||
// BUG #351: a `column` with a PERCENTAGE width ("50%") is not byte-stable.
|
||||
// The column schema parses `data-width` with parseFloat, dropping the '%':
|
||||
// md1 = '...data-width="50%"...' (first export)
|
||||
// re-import stores width = 50 (number)
|
||||
// md2 = '...data-width="50"...' (second export) => md2 !== md1
|
||||
// A permanent GS-EDIT-REVERT churn on every git-sync pull. The editor stores
|
||||
// column widths as percentages, so this is a genuine defect. The fix is in
|
||||
// src/lib/docmost-schema.ts (column.width parseHTML must preserve the unit)
|
||||
// and is out of scope for this test-only PR.
|
||||
it.fails('column percentage width is byte-stable (P2)', async () => {
|
||||
const doc = loadDoc('columns-column-width-percent.json');
|
||||
const md1 = convertProseMirrorToMarkdown(doc);
|
||||
const doc2 = await markdownToProseMirror(md1);
|
||||
const md2 = convertProseMirrorToMarkdown(doc2);
|
||||
// This assertion currently FAILS (md2 drops the '%'), which is exactly what
|
||||
// `it.fails` expects. When the schema is fixed, it will PASS and flip this
|
||||
// test red — our cue to remove the pin.
|
||||
expect(md2).toBe(md1);
|
||||
});
|
||||
|
||||
// BUG #351: an `orderedList` with a non-1 `start` loses its start number.
|
||||
// CommonMark CAN express this ("5." starts the list at 5), but the converter
|
||||
// always emits "1." and ignores `attrs.start` (markdown-converter.ts renders
|
||||
// `${index + 1}.`; the <ol> HTML path also omits `start`):
|
||||
// doc.start = 5 -> md1 = "1. alpha" (start dropped on export)
|
||||
// re-import stores start = 1 => docsCanonicallyEqual(rt, doc) === false
|
||||
// This is a P1 (semantic round-trip) loss of the SAME class as column.width:
|
||||
// representable in markdown, silently dropped by the converter. It is pinned
|
||||
// here as the LOUD counterexample rather than being masked as an "accepted
|
||||
// normalization" in the generator — per the epic guardrail, deciding
|
||||
// accept-vs-fix for a markdown-representable loss is a MAINTAINER call, so this
|
||||
// stays a visible known-bug until the maintainer rules on it. The fix would be
|
||||
// in src/lib/markdown-converter.ts (emit the start number on the first item)
|
||||
// and is out of scope for this test-only PR.
|
||||
it.fails('ordered list start number is preserved (P1)', async () => {
|
||||
const doc = loadDoc('ordered-list-start.json');
|
||||
const md1 = convertProseMirrorToMarkdown(doc);
|
||||
const doc2 = await markdownToProseMirror(md1);
|
||||
// Currently FAILS: doc2.start === 1 while doc.start === 5. When the converter
|
||||
// preserves `start`, this PASSES and flips the test red — remove the pin then.
|
||||
expect(docsCanonicallyEqual(doc2, doc)).toBe(true);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,284 @@
|
||||
import { describe, expect, it, vi } from 'vitest';
|
||||
import fc from 'fast-check';
|
||||
// Real converter, imported the same way the sibling property test does.
|
||||
import { convertProseMirrorToMarkdown } from '../../src/lib/markdown-converter.js';
|
||||
// Importing markdownToProseMirror mutates the global DOM via jsdom at module
|
||||
// load (expected, required for @tiptap/html's generateJSON under Node).
|
||||
import { markdownToProseMirror } from '../../src/lib/markdown-to-prosemirror.js';
|
||||
import { docsCanonicallyEqual, canonicalizeContent } from '../../src/lib/index.js';
|
||||
import { firstDivergence } from '../roundtrip-helpers.js';
|
||||
import {
|
||||
schema,
|
||||
allSchemaAttrKeys,
|
||||
allSchemaMarkAttrKeys,
|
||||
attrIsValueFuzzed,
|
||||
} from './attr-arbitraries.js';
|
||||
import {
|
||||
buildGenerators,
|
||||
coveredTypes,
|
||||
KNOWN_UNCOVERED,
|
||||
} from './node-generators.js';
|
||||
|
||||
// ── Attribute-value coverage allowlist ──────────────────────────────────────
|
||||
// The node/mark completeness contract guarantees every TYPE is generated, but
|
||||
// NOT that every attribute is exercised at a NON-DEFAULT value. An attribute
|
||||
// with no `arb` in attr-arbitraries.ts is only ever tested at absent/default —
|
||||
// an INVISIBLE coverage hole (the reviewer's concern). This allowlist makes that
|
||||
// hole EXPLICIT: it is the exact set of attrs deliberately not value-fuzzed, so
|
||||
// a NEW attribute (or a newly-frozen one) that lands in this bucket flips the
|
||||
// snapshot test red and forces a reviewer to classify it. Each belongs to one of:
|
||||
// - internal/opaque ids & placeholders (attachmentId, slugId, placeholder,
|
||||
// creatorId, anchorId) — no meaningful non-default to assert;
|
||||
// - dimensions/among the media family with no standalone md form here
|
||||
// (aspectRatio, size, caption, drawio/excalidraw/pdf/video/youtube w/h/align)
|
||||
// — round-trip candidates deferred to a later PR, not silently dropped;
|
||||
// - ACCEPTED limitations with no md representation (indent, callout.icon,
|
||||
// orderedList.type, table spans/bg/colwidth);
|
||||
// - PINNED bugs (column.width, orderedList.start) tracked in
|
||||
// counterexamples.test.ts.
|
||||
const ATTR_VALUE_FUZZ_ALLOWLIST = new Set<string>([
|
||||
'attachment.attachmentId', 'attachment.mime', 'attachment.placeholder', 'attachment.size',
|
||||
'audio.attachmentId', 'audio.placeholder', 'audio.size',
|
||||
'callout.icon', 'column.width',
|
||||
'drawio.align', 'drawio.alt', 'drawio.aspectRatio', 'drawio.attachmentId',
|
||||
'drawio.height', 'drawio.size', 'drawio.title', 'drawio.width',
|
||||
'embed.align', 'embed.height', 'embed.width',
|
||||
'excalidraw.align', 'excalidraw.alt', 'excalidraw.aspectRatio', 'excalidraw.attachmentId',
|
||||
'excalidraw.height', 'excalidraw.size', 'excalidraw.title', 'excalidraw.width',
|
||||
'heading.indent',
|
||||
'image.aspectRatio', 'image.attachmentId', 'image.caption', 'image.placeholder', 'image.size',
|
||||
'mention.anchorId', 'mention.creatorId', 'mention.slugId',
|
||||
'orderedList.start', 'orderedList.type', 'paragraph.indent',
|
||||
'pdf.attachmentId', 'pdf.height', 'pdf.placeholder', 'pdf.size', 'pdf.width',
|
||||
'tableCell.backgroundColor', 'tableCell.backgroundColorName', 'tableCell.colspan',
|
||||
'tableCell.colwidth', 'tableCell.rowspan',
|
||||
'tableHeader.backgroundColor', 'tableHeader.backgroundColorName', 'tableHeader.colspan',
|
||||
'tableHeader.colwidth', 'tableHeader.rowspan',
|
||||
'video.align', 'video.aspectRatio', 'video.attachmentId', 'video.placeholder', 'video.size',
|
||||
'youtube.align', 'youtube.height', 'youtube.width',
|
||||
]);
|
||||
|
||||
// ── MARK attribute-value coverage ───────────────────────────────────────────
|
||||
// Marks are fuzzed by the text generator (text-arbitraries.ts markedTextRunArb),
|
||||
// not the node OVERRIDES table, so their value-fuzz coverage is tracked with this
|
||||
// separate registry — otherwise the "no invisible coverage hole" guarantee would
|
||||
// hold for node attrs only, and a new mark attr (or a new attributed mark) would
|
||||
// silently escape the fuzz set. Every schema mark attr must be in exactly one of:
|
||||
// MARK_ATTR_FUZZED — actually driven at a non-default value by the generator;
|
||||
// MARK_ATTR_ALLOWLIST — deliberately not value-fuzzed, with a reason.
|
||||
const MARK_ATTR_FUZZED = new Set<string>([
|
||||
'mark:link.href', // markedTextRunArb sets a random webUrl href
|
||||
'mark:link.title', // ...and an optional letter-bearing title
|
||||
'mark:highlight.color', // highlight mark carries a generated color
|
||||
'mark:textStyle.color', // textStyle mark carries a generated color
|
||||
'mark:comment.commentId', // comment anchor id (alphanumeric token)
|
||||
'mark:comment.resolved', // comment resolved flag (rides only when true)
|
||||
]);
|
||||
const MARK_ATTR_ALLOWLIST = new Set<string>([
|
||||
// link presentational/routing attrs: not part of the markdown link surface the
|
||||
// converter emits (it round-trips href + title only), so there is no
|
||||
// non-default value to assert here — a deferred concern for a link-specific
|
||||
// fixture, not the flat generative pass.
|
||||
'mark:link.internal',
|
||||
'mark:link.target',
|
||||
'mark:link.rel',
|
||||
'mark:link.class',
|
||||
]);
|
||||
|
||||
// Each run does a real convert + marked + jsdom parse (~ms). Give ample headroom
|
||||
// so the suite is deterministic regardless of parallel worker load (like the
|
||||
// sibling property file).
|
||||
vi.setConfig({ testTimeout: 30000 });
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// #351 PR 1 — GENERATIVE (property-based) round-trip over FLAT (single-node)
|
||||
// documents at the ATTRIBUTE level.
|
||||
//
|
||||
// We assert three invariants for ANY generated valid flat document `d`
|
||||
// (pmToMd = convertProseMirrorToMarkdown, mdToPm = markdownToProseMirror):
|
||||
//
|
||||
// P1 — semantic round-trip (nothing lost):
|
||||
// docsCanonicallyEqual(await mdToPm(pmToMd(d)), d) === true
|
||||
// P2 — byte fixpoint (anti "GS-EDIT-REVERT" churn):
|
||||
// pmToMd(await mdToPm(pmToMd(d))) === pmToMd(d)
|
||||
// P3 — totality: neither converter throws; bounded.
|
||||
//
|
||||
// The generators are schema-DERIVED (attribute lists come from
|
||||
// schema.nodes[type].spec.attrs) and stay inside the round-trip-supported space
|
||||
// proven empirically by probing the live converter (see attr-arbitraries.ts and
|
||||
// text-arbitraries.ts). P1 runs over the safe attribute space; P2/P3 run over
|
||||
// the wider 'fuzz' space that also injects degenerate attribute states, which
|
||||
// P2 tolerates via a one-time first-pass normalization and P3 via totality only.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// Fixed seed so every failure is reproducible; fast-check also prints the
|
||||
// shrunk counterexample. numRuns starts modest to keep CI under budget — the
|
||||
// issue's CI target is ~300-500 per property; the nightly / PR 3 will crank
|
||||
// this up further. Each property runs over the UNION (fc.oneof) of all flat
|
||||
// node generators, so the runs are shared across node types (one test per
|
||||
// property keeps the jsdom import cost and memory bounded — a per-generator ×
|
||||
// per-property matrix is ~200 heavy tests that OOMs the worker).
|
||||
const SEED = 20250705;
|
||||
const NUM_RUNS = 300;
|
||||
|
||||
const P1_GENERATORS = buildGenerators('p1');
|
||||
const FUZZ_GENERATORS = buildGenerators('fuzz');
|
||||
|
||||
// Union arbitraries: a single draw picks one node generator, then a document
|
||||
// from it. On failure fast-check prints the shrunk counterexample doc, which
|
||||
// names the offending node type directly.
|
||||
const p1Union = fc.oneof(...P1_GENERATORS.map((g) => g.arb));
|
||||
const fuzzUnion = fc.oneof(...FUZZ_GENERATORS.map((g) => g.arb));
|
||||
|
||||
async function roundTrip(doc: unknown): Promise<{ md1: string; md2: string; doc2: any }> {
|
||||
const md1 = convertProseMirrorToMarkdown(doc);
|
||||
const doc2 = await markdownToProseMirror(md1);
|
||||
const md2 = convertProseMirrorToMarkdown(doc2);
|
||||
return { md1, md2, doc2 };
|
||||
}
|
||||
|
||||
describe('#351 flat generative round-trip — completeness contract', () => {
|
||||
it('every schema node and mark is covered by a generator or explicitly allowlisted', () => {
|
||||
const covered = coveredTypes();
|
||||
const uncovered: string[] = [];
|
||||
|
||||
for (const nodeType of Object.keys(schema.nodes)) {
|
||||
if (covered.has(nodeType)) continue;
|
||||
if (nodeType in KNOWN_UNCOVERED) continue;
|
||||
uncovered.push(`node:${nodeType}`);
|
||||
}
|
||||
for (const markType of Object.keys(schema.marks)) {
|
||||
if (covered.has(`mark:${markType}`)) continue;
|
||||
if (markType in KNOWN_UNCOVERED) continue;
|
||||
uncovered.push(`mark:${markType}`);
|
||||
}
|
||||
|
||||
// A new node/mark added to the schema with no generator AND no allowlist
|
||||
// entry MUST turn this test red — that is the whole point (no silent blind
|
||||
// spots).
|
||||
expect(
|
||||
uncovered,
|
||||
`these schema types have no generator and no KNOWN_UNCOVERED reason:\n ${uncovered.join(
|
||||
'\n ',
|
||||
)}`,
|
||||
).toEqual([]);
|
||||
});
|
||||
|
||||
it('every KNOWN_UNCOVERED entry is a real schema type (no stale allowlist rows)', () => {
|
||||
const all = new Set([...Object.keys(schema.nodes), ...Object.keys(schema.marks)]);
|
||||
for (const t of Object.keys(KNOWN_UNCOVERED)) {
|
||||
expect(all.has(t), `stale KNOWN_UNCOVERED entry: ${t}`).toBe(true);
|
||||
}
|
||||
});
|
||||
|
||||
it('every attribute is value-fuzzed OR explicitly allowlisted (no invisible hole)', () => {
|
||||
// Makes the "generic-frozen" coverage hole VISIBLE: any schema attr not
|
||||
// exercised at a non-default value must be a KNOWN entry in the allowlist.
|
||||
// A new attr (or one that loses its `arb`) that falls into the not-fuzzed
|
||||
// bucket without an allowlist row turns this red — no silent blind spots.
|
||||
const unaccounted: string[] = [];
|
||||
for (const key of allSchemaAttrKeys()) {
|
||||
const i = key.indexOf('.');
|
||||
const fuzzed = attrIsValueFuzzed(key.slice(0, i), key.slice(i + 1));
|
||||
if (!fuzzed && !ATTR_VALUE_FUZZ_ALLOWLIST.has(key)) unaccounted.push(key);
|
||||
}
|
||||
expect(
|
||||
unaccounted,
|
||||
`these attrs are not value-fuzzed and not in ATTR_VALUE_FUZZ_ALLOWLIST:\n ${unaccounted.join(
|
||||
'\n ',
|
||||
)}`,
|
||||
).toEqual([]);
|
||||
});
|
||||
|
||||
it('the attribute allowlist has no stale rows (every entry is really not-fuzzed)', () => {
|
||||
const notFuzzed = new Set(
|
||||
allSchemaAttrKeys().filter((key) => {
|
||||
const i = key.indexOf('.');
|
||||
return !attrIsValueFuzzed(key.slice(0, i), key.slice(i + 1));
|
||||
}),
|
||||
);
|
||||
for (const key of ATTR_VALUE_FUZZ_ALLOWLIST) {
|
||||
expect(
|
||||
notFuzzed.has(key),
|
||||
`stale allowlist row (attr is now value-fuzzed, remove it): ${key}`,
|
||||
).toBe(true);
|
||||
}
|
||||
});
|
||||
|
||||
it('every MARK attribute is value-fuzzed OR allowlisted (no invisible hole)', () => {
|
||||
// The node guard above covers node attrs; marks are fuzzed by the text
|
||||
// generator, so their coverage is tracked separately. A new mark attr (or a
|
||||
// newly-attributed mark) that lands in neither set turns this red.
|
||||
const unaccounted: string[] = [];
|
||||
for (const key of allSchemaMarkAttrKeys()) {
|
||||
if (!MARK_ATTR_FUZZED.has(key) && !MARK_ATTR_ALLOWLIST.has(key)) {
|
||||
unaccounted.push(key);
|
||||
}
|
||||
}
|
||||
expect(
|
||||
unaccounted,
|
||||
`these mark attrs are neither in MARK_ATTR_FUZZED nor MARK_ATTR_ALLOWLIST:\n ${unaccounted.join(
|
||||
'\n ',
|
||||
)}`,
|
||||
).toEqual([]);
|
||||
});
|
||||
|
||||
it('the MARK fuzz/allowlist sets have no stale rows (every entry is a real schema mark attr)', () => {
|
||||
const all = new Set(allSchemaMarkAttrKeys());
|
||||
for (const key of [...MARK_ATTR_FUZZED, ...MARK_ATTR_ALLOWLIST]) {
|
||||
expect(all.has(key), `stale mark-attr registry row: ${key}`).toBe(true);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('#351 flat generative round-trip — properties', () => {
|
||||
it('generator validity: every generated doc passes schema.check()', () => {
|
||||
// A generator that emits an invalid ProseMirror document is a GENERATOR bug.
|
||||
fc.assert(
|
||||
fc.property(fuzzUnion, (doc) => {
|
||||
schema.nodeFromJSON(doc).check(); // throws on an invalid doc
|
||||
return true;
|
||||
}),
|
||||
{ numRuns: NUM_RUNS, seed: SEED },
|
||||
);
|
||||
});
|
||||
|
||||
it('P1 — semantic round-trip: docsCanonicallyEqual(mdToPm(pmToMd(d)), d)', async () => {
|
||||
await fc.assert(
|
||||
fc.asyncProperty(p1Union, async (doc) => {
|
||||
const { doc2 } = await roundTrip(doc);
|
||||
if (!docsCanonicallyEqual(doc2, doc)) {
|
||||
// Surface the precise divergence in the failure message.
|
||||
const div = firstDivergence(
|
||||
JSON.parse(JSON.stringify(canonicalizeContent(doc2))),
|
||||
JSON.parse(JSON.stringify(canonicalizeContent(doc))),
|
||||
);
|
||||
throw new Error(
|
||||
`P1 divergence @ ${div?.path}: got=${JSON.stringify(div?.a)} want=${JSON.stringify(div?.b)}`,
|
||||
);
|
||||
}
|
||||
}),
|
||||
{ numRuns: NUM_RUNS, seed: SEED },
|
||||
);
|
||||
});
|
||||
|
||||
it('P2 — byte fixpoint: pmToMd(mdToPm(pmToMd(d))) === pmToMd(d)', async () => {
|
||||
await fc.assert(
|
||||
fc.asyncProperty(fuzzUnion, async (doc) => {
|
||||
const { md1, md2 } = await roundTrip(doc);
|
||||
expect(md2).toBe(md1);
|
||||
}),
|
||||
{ numRuns: NUM_RUNS, seed: SEED },
|
||||
);
|
||||
});
|
||||
|
||||
it('P3 — totality: neither converter throws', async () => {
|
||||
await fc.assert(
|
||||
fc.asyncProperty(fuzzUnion, async (doc) => {
|
||||
// Throwing here fails the property; fast-check shrinks to a minimal doc.
|
||||
await roundTrip(doc);
|
||||
}),
|
||||
{ numRuns: NUM_RUNS, seed: SEED },
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,310 @@
|
||||
/**
|
||||
* Flat single-node document generators (#351, PR 1).
|
||||
*
|
||||
* For every schema node type that can stand alone, a fast-check arbitrary
|
||||
* producing `{ type:'doc', content:[ <the target node> ] }` with generated attrs
|
||||
* (via nodeAttrsArb) and the minimal REQUIRED immediate children the schema
|
||||
* demands (a heading's inline text, a listItem's one paragraph, a table's
|
||||
* minimal rows, details' summary+content, a callout's one paragraph). Kept
|
||||
* FLAT: a single target node, no deep nesting — nested structural generation is
|
||||
* PR 2.
|
||||
*
|
||||
* The `mode` threads through to the attribute arbitraries:
|
||||
* - 'p1' : the round-trip-safe attribute space (P1 semantic round-trip).
|
||||
* - 'fuzz' : adds degenerate attribute states (P2 byte-fixpoint tolerates the
|
||||
* one-time normalization; P3 only needs totality).
|
||||
*
|
||||
* A COMPLETENESS CONTRACT (see flat-roundtrip.property.test.ts) enumerates the
|
||||
* whole schema and asserts every node/mark is EITHER produced by a generator
|
||||
* here OR listed in KNOWN_UNCOVERED with a reason — so a new schema type with no
|
||||
* generator turns the suite RED.
|
||||
*/
|
||||
import fc from 'fast-check';
|
||||
import { type AttrMode, nodeAttrsArb } from './attr-arbitraries.js';
|
||||
import {
|
||||
inlineContentArb,
|
||||
headingInlineContentArb,
|
||||
plainInlineContentArb,
|
||||
phraseArb,
|
||||
markedTextRunArb,
|
||||
} from './text-arbitraries.js';
|
||||
|
||||
const doc = (node: any) => ({ type: 'doc', content: [node] });
|
||||
const para = (content: any[]) => ({ type: 'paragraph', content });
|
||||
|
||||
/** A named flat-document generator. */
|
||||
export interface NamedGen {
|
||||
name: string;
|
||||
arb: fc.Arbitrary<any>;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Per-target generators, each a function of mode.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const gen = {
|
||||
paragraph: (m: AttrMode) =>
|
||||
fc.tuple(nodeAttrsArb('paragraph', m), inlineContentArb).map(([attrs, content]) =>
|
||||
doc({ type: 'paragraph', attrs, content }),
|
||||
),
|
||||
|
||||
heading: (m: AttrMode) =>
|
||||
fc.tuple(nodeAttrsArb('heading', m), headingInlineContentArb).map(([attrs, content]) =>
|
||||
doc({ type: 'heading', attrs, content }),
|
||||
),
|
||||
|
||||
blockquote: (_m: AttrMode) =>
|
||||
inlineContentArb.map((content) => doc({ type: 'blockquote', content: [para(content)] })),
|
||||
|
||||
bulletList: (_m: AttrMode) =>
|
||||
fc
|
||||
.array(inlineContentArb, { minLength: 1, maxLength: 3 })
|
||||
.map((items) =>
|
||||
doc({
|
||||
type: 'bulletList',
|
||||
content: items.map((c) => ({ type: 'listItem', content: [para(c)] })),
|
||||
}),
|
||||
),
|
||||
|
||||
orderedList: (m: AttrMode) =>
|
||||
fc
|
||||
.tuple(nodeAttrsArb('orderedList', m), fc.array(inlineContentArb, { minLength: 1, maxLength: 3 }))
|
||||
.map(([attrs, items]) =>
|
||||
doc({
|
||||
type: 'orderedList',
|
||||
attrs,
|
||||
content: items.map((c) => ({ type: 'listItem', content: [para(c)] })),
|
||||
}),
|
||||
),
|
||||
|
||||
taskList: (m: AttrMode) =>
|
||||
fc
|
||||
.array(fc.tuple(nodeAttrsArb('taskItem', m), inlineContentArb), { minLength: 1, maxLength: 3 })
|
||||
.map((items) =>
|
||||
doc({
|
||||
type: 'taskList',
|
||||
content: items.map(([attrs, c]) => ({ type: 'taskItem', attrs, content: [para(c)] })),
|
||||
}),
|
||||
),
|
||||
|
||||
codeBlock: (m: AttrMode) =>
|
||||
fc
|
||||
.tuple(
|
||||
nodeAttrsArb('codeBlock', m),
|
||||
// A fenced code block always re-imports with a TRAILING NEWLINE in its
|
||||
// text (empirically confirmed). Author the newline so the doc is already
|
||||
// at the round-trip fixpoint (supported-space shaping, not a masked bug).
|
||||
fc.array(phraseArb, { minLength: 1, maxLength: 3 }).map((lines) => lines.join('\n') + '\n'),
|
||||
)
|
||||
.map(([attrs, code]) =>
|
||||
doc({ type: 'codeBlock', attrs, content: [{ type: 'text', text: code }] }),
|
||||
),
|
||||
|
||||
horizontalRule: (_m: AttrMode) => fc.constant(doc({ type: 'horizontalRule' })),
|
||||
|
||||
pageBreak: (_m: AttrMode) => fc.constant(doc({ type: 'pageBreak' })),
|
||||
|
||||
image: (m: AttrMode) => nodeAttrsArb('image', m).map((attrs) => doc({ type: 'image', attrs })),
|
||||
|
||||
callout: (m: AttrMode) =>
|
||||
fc.tuple(nodeAttrsArb('callout', m), inlineContentArb).map(([attrs, content]) =>
|
||||
doc({ type: 'callout', attrs, content: [para(content)] }),
|
||||
),
|
||||
|
||||
mathBlock: (m: AttrMode) =>
|
||||
nodeAttrsArb('mathBlock', m).map((attrs) => doc({ type: 'mathBlock', attrs })),
|
||||
|
||||
details: (m: AttrMode) =>
|
||||
fc
|
||||
.tuple(nodeAttrsArb('details', m), plainInlineContentArb, inlineContentArb)
|
||||
.map(([attrs, summary, body]) =>
|
||||
doc({
|
||||
type: 'details',
|
||||
attrs,
|
||||
content: [
|
||||
{ type: 'detailsSummary', content: summary },
|
||||
{ type: 'detailsContent', content: [para(body)] },
|
||||
],
|
||||
}),
|
||||
),
|
||||
|
||||
table: (_m: AttrMode) =>
|
||||
fc.integer({ min: 1, max: 3 }).chain((cols) => {
|
||||
// GFM alignment is column-wide (encoded in the header separator), so a
|
||||
// column's alignment must be identical on the header and every body cell,
|
||||
// else the second export re-aligns and churns. Pick ONE align per column.
|
||||
const alignsArb = fc.array(fc.constantFrom(undefined, 'left', 'center', 'right'), {
|
||||
minLength: cols,
|
||||
maxLength: cols,
|
||||
});
|
||||
const cell = (header: boolean, align?: string) =>
|
||||
phraseArb.map((t) => ({
|
||||
type: header ? 'tableHeader' : 'tableCell',
|
||||
// colspan/rowspan pinned to 1 (GFM cannot express spans); optional
|
||||
// column-consistent align.
|
||||
attrs: { colspan: 1, rowspan: 1, ...(align ? { align } : {}) },
|
||||
content: [para([{ type: 'text', text: t }])],
|
||||
}));
|
||||
return alignsArb.chain((aligns) => {
|
||||
const headerRow = fc
|
||||
.tuple(...aligns.map((a) => cell(true, a)))
|
||||
.map((cells) => ({ type: 'tableRow', content: cells }));
|
||||
const bodyRow = fc
|
||||
.tuple(...aligns.map((a) => cell(false, a)))
|
||||
.map((cells) => ({ type: 'tableRow', content: cells }));
|
||||
return fc
|
||||
.tuple(headerRow, fc.array(bodyRow, { minLength: 1, maxLength: 2 }))
|
||||
.map(([h, body]) => doc({ type: 'table', content: [h, ...body] }));
|
||||
});
|
||||
}),
|
||||
|
||||
columns: (m: AttrMode) =>
|
||||
// Couple the column count to the layout so the two stay consistent
|
||||
// (two_equal/left_sidebar/right_sidebar -> 2, three_equal -> 3).
|
||||
fc
|
||||
.constantFrom('two_equal', 'three_equal', 'left_sidebar', 'right_sidebar')
|
||||
.chain((layout) => {
|
||||
const count = layout === 'three_equal' ? 3 : 2;
|
||||
return fc
|
||||
.tuple(
|
||||
nodeAttrsArb('columns', m, { layout, widthMode: 'normal' }),
|
||||
fc.array(inlineContentArb, { minLength: count, maxLength: count }),
|
||||
)
|
||||
.map(([attrs, bodies]) =>
|
||||
doc({
|
||||
type: 'columns',
|
||||
attrs,
|
||||
content: bodies.map((c) => ({ type: 'column', content: [para(c)] })),
|
||||
}),
|
||||
);
|
||||
}),
|
||||
|
||||
subpages: (m: AttrMode) =>
|
||||
nodeAttrsArb('subpages', m).map((attrs) => doc({ type: 'subpages', attrs })),
|
||||
|
||||
audio: (m: AttrMode) => nodeAttrsArb('audio', m).map((attrs) => doc({ type: 'audio', attrs })),
|
||||
video: (m: AttrMode) => nodeAttrsArb('video', m).map((attrs) => doc({ type: 'video', attrs })),
|
||||
pdf: (m: AttrMode) => nodeAttrsArb('pdf', m).map((attrs) => doc({ type: 'pdf', attrs })),
|
||||
youtube: (m: AttrMode) => nodeAttrsArb('youtube', m).map((attrs) => doc({ type: 'youtube', attrs })),
|
||||
embed: (m: AttrMode) => nodeAttrsArb('embed', m).map((attrs) => doc({ type: 'embed', attrs })),
|
||||
drawio: (m: AttrMode) => nodeAttrsArb('drawio', m).map((attrs) => doc({ type: 'drawio', attrs })),
|
||||
excalidraw: (m: AttrMode) =>
|
||||
nodeAttrsArb('excalidraw', m).map((attrs) => doc({ type: 'excalidraw', attrs })),
|
||||
attachment: (m: AttrMode) =>
|
||||
nodeAttrsArb('attachment', m).map((attrs) => doc({ type: 'attachment', attrs })),
|
||||
htmlEmbed: (m: AttrMode) =>
|
||||
nodeAttrsArb('htmlEmbed', m).map((attrs) => doc({ type: 'htmlEmbed', attrs })),
|
||||
pageEmbed: (m: AttrMode) =>
|
||||
nodeAttrsArb('pageEmbed', m).map((attrs) => doc({ type: 'pageEmbed', attrs })),
|
||||
transclusionReference: (m: AttrMode) =>
|
||||
nodeAttrsArb('transclusionReference', m).map((attrs) =>
|
||||
doc({ type: 'transclusionReference', attrs }),
|
||||
),
|
||||
|
||||
transclusionSource: (m: AttrMode) =>
|
||||
fc.tuple(nodeAttrsArb('transclusionSource', m), inlineContentArb).map(([attrs, content]) =>
|
||||
doc({ type: 'transclusionSource', attrs, content: [para(content)] }),
|
||||
),
|
||||
|
||||
// A footnote reference PLUS its definition (the reference has no standalone
|
||||
// markdown form without its definition — see KNOWN_UNCOVERED note for the
|
||||
// bare reference). Both carry the same id. The definition body uses
|
||||
// headingInlineContentArb (NO hard breaks): a footnote is serialized inline as
|
||||
// `^[...]`, so a hard break inside it collapses to a single space on re-parse
|
||||
// (empirically confirmed) — that is the container's markdown limitation, not
|
||||
// an attribute-level concern. The reference-bearing paragraph is a NORMAL
|
||||
// paragraph and keeps the full inline corpus.
|
||||
footnotes: (m: AttrMode) =>
|
||||
fc.tuple(fc.constantFrom('fn1', 'fn2', 'note'), inlineContentArb, headingInlineContentArb).map(
|
||||
([id, refText, noteBody]) => ({
|
||||
type: 'doc',
|
||||
content: [
|
||||
para([...refText, { type: 'footnoteReference', attrs: { id } }]),
|
||||
{
|
||||
type: 'footnotesList',
|
||||
content: [{ type: 'footnoteDefinition', attrs: { id }, content: [para(noteBody)] }],
|
||||
},
|
||||
],
|
||||
}),
|
||||
),
|
||||
|
||||
// ── inline targets wrapped in a paragraph ────────────────────────────────
|
||||
mention: (m: AttrMode) =>
|
||||
nodeAttrsArb('mention', m).map((attrs) => doc(para([{ type: 'mention', attrs }]))),
|
||||
|
||||
mathInline: (m: AttrMode) =>
|
||||
fc.tuple(phraseArb, nodeAttrsArb('mathInline', m)).map(([t, attrs]) =>
|
||||
doc(para([{ type: 'text', text: t }, { type: 'mathInline', attrs }])),
|
||||
),
|
||||
|
||||
status: (m: AttrMode) =>
|
||||
nodeAttrsArb('status', m).map((attrs) => doc(para([{ type: 'status', attrs }]))),
|
||||
|
||||
hardBreak: (_m: AttrMode) =>
|
||||
fc.tuple(phraseArb, phraseArb).map(([a, b]) =>
|
||||
doc(para([{ type: 'text', text: a }, { type: 'hardBreak' }, { type: 'text', text: b }])),
|
||||
),
|
||||
|
||||
// ── marks: a paragraph of marked runs (covers every mark type) ───────────
|
||||
marksOnText: (_m: AttrMode) =>
|
||||
fc.array(markedTextRunArb, { minLength: 1, maxLength: 5 }).map((runs) => {
|
||||
// Merge adjacent same-mark runs (see text-arbitraries.normalizeInline).
|
||||
const out: any[] = [];
|
||||
for (const r of runs) {
|
||||
const prev = out[out.length - 1];
|
||||
if (prev && JSON.stringify(prev.marks ?? []) === JSON.stringify(r.marks ?? [])) {
|
||||
prev.text += r.text;
|
||||
} else out.push({ ...r });
|
||||
}
|
||||
return doc(para(out));
|
||||
}),
|
||||
};
|
||||
|
||||
/** Build the full list of named generators for a given mode. */
|
||||
export function buildGenerators(mode: AttrMode): NamedGen[] {
|
||||
return Object.entries(gen).map(([name, f]) => ({ name, arb: f(mode) }));
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Completeness contract support.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Schema node/mark types deliberately NOT covered by a P1/P2 generator, each
|
||||
* with a one-line reason. Excluding a type means it is kept OUT of the round-
|
||||
* trip generators — it does NOT weaken any property.
|
||||
*
|
||||
* NOTE (empirical): the candidates the issue flagged for review — pageEmbed,
|
||||
* subpages, transclusionSource/Reference, mention, status — were PROBED against
|
||||
* the live converter and DO round-trip P1/P2 with placeholder ids, so they are
|
||||
* COVERED by real generators rather than allowlisted here. The allowlist below
|
||||
* holds only types with no standalone flat generator by construction.
|
||||
*/
|
||||
export const KNOWN_UNCOVERED: Record<string, string> = {
|
||||
// The root node; it is the wrapper every generated doc already is, never a
|
||||
// "target" content node, so it has no standalone generator of its own.
|
||||
doc: 'the document root wrapper, not a content node with a standalone generator',
|
||||
};
|
||||
|
||||
/** Recursively collect every node type and `mark:<type>` under a tree. */
|
||||
export function collectTypes(node: any, seen = new Set<string>()): Set<string> {
|
||||
if (!node || typeof node !== 'object') return seen;
|
||||
if (node.type) seen.add(node.type);
|
||||
for (const m of node.marks ?? []) if (m?.type) seen.add(`mark:${m.type}`);
|
||||
for (const c of node.content ?? []) collectTypes(c, seen);
|
||||
return seen;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sample every generator and return the union of node/mark types they produce.
|
||||
* Deterministic (fixed seed) so the completeness contract is stable.
|
||||
*/
|
||||
export function coveredTypes(seed = 12345, perGen = 60): Set<string> {
|
||||
const seen = new Set<string>();
|
||||
for (const { arb } of buildGenerators('p1')) {
|
||||
for (const sample of fc.sample(arb, { numRuns: perGen, seed })) {
|
||||
collectTypes(sample, seen);
|
||||
}
|
||||
}
|
||||
return seen;
|
||||
}
|
||||
@@ -0,0 +1,258 @@
|
||||
/**
|
||||
* Hostile inline-text corpus for the generative flat-document round-trip suite
|
||||
* (#351, PR 1).
|
||||
*
|
||||
* These arbitraries are a DIRECT PORT of the "supported space" guardrails that
|
||||
* `test/markdown-roundtrip.property.test.ts` proved empirically against the live
|
||||
* converter. That file's long header documents WHY each guardrail exists; rather
|
||||
* than re-derive them, we reuse the exact same shapes here so the attribute-level
|
||||
* generative suite inherits the same byte-stable text space. Each guardrail is
|
||||
* cited back to that file below.
|
||||
*
|
||||
* The corpus deliberately spans the CommonMark / canon hostile alphabet
|
||||
* (`* _ [ ] ( ) { } | < > & # ! ~ = + -`), unicode / emoji / RTL, and the legal
|
||||
* mark combinations on runs (including the `code` mark, which the schema's
|
||||
* `excludes: "_"` makes suppress every co-occurring mark — so it is never
|
||||
* combined with another mark in the byte-stable space).
|
||||
*/
|
||||
import fc from 'fast-check';
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Words and the hostile special-character alphabet.
|
||||
// (Ported from markdown-roundtrip.property.test.ts, "Inline text arbitraries".)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/** Alphanumeric "word" (no markdown-significant characters). Length 1..6. */
|
||||
export const wordArb = fc
|
||||
.stringMatching(/^[A-Za-z0-9]{1,6}$/)
|
||||
.filter((w) => w.length > 0);
|
||||
|
||||
/**
|
||||
* A SINGLE markdown-significant character, emitted only as an isolated,
|
||||
* space-flanked token. Every char the task calls out plus a few more; each was
|
||||
* verified byte-stable in this position by the sibling property test.
|
||||
*
|
||||
* NOTE: the backtick (`) is DELIBERATELY excluded from free-floating plain text
|
||||
* (it is a code-span delimiter that re-pairs globally). It is exercised only via
|
||||
* the `code` mark and code blocks — see markdown-roundtrip.property.test.ts.
|
||||
*/
|
||||
export const specialCharArb = fc.constantFrom(
|
||||
'*', '_', '[', ']', '(', ')', '{', '}', '|', '<', '>', '&', '#', '!', '~', '=', '+', '-',
|
||||
);
|
||||
|
||||
// A pinch of unicode / emoji / RTL, always word-like (no markdown specials) so
|
||||
// it stays inside the space-flanked corpus. Kept letter/emoji-bearing so it is
|
||||
// never coerced to a number (see letterPhraseArb rationale).
|
||||
export const unicodeWordArb = fc.constantFrom(
|
||||
'café', 'naïve', 'Zürich', 'Москва', 'こんにちは', '你好', '😀', '🚀x', 'مرحبا', 'שלום',
|
||||
);
|
||||
|
||||
/**
|
||||
* A "safe special" text string: a space-joined sequence of tokens that always
|
||||
* BEGINS and ENDS with an alphanumeric word, with any isolated special chars (or
|
||||
* unicode words) confined to the MIDDLE, each space-flanked by words.
|
||||
*
|
||||
* Both boundary guarantees matter (verbatim from the sibling test):
|
||||
* * Leading word: the line never opens with a block/inline trigger
|
||||
* (">", "*", "-", "#", "1." ...).
|
||||
* * Trailing word: adjacent text runs CONCATENATE with no separator, so a run
|
||||
* ending in a bare "<" beside a run starting with a letter would form a fake
|
||||
* HTML tag. Ending every run with a word keeps every special internal and
|
||||
* space-flanked even after concatenation.
|
||||
*/
|
||||
export const safeTextArb: fc.Arbitrary<string> = fc
|
||||
.tuple(
|
||||
wordArb,
|
||||
fc.array(fc.oneof(wordArb, specialCharArb, unicodeWordArb), {
|
||||
minLength: 0,
|
||||
maxLength: 3,
|
||||
}),
|
||||
wordArb,
|
||||
)
|
||||
.map(([first, middle, last]) => [first, ...middle, last].join(' '));
|
||||
|
||||
/**
|
||||
* A plain alphanumeric phrase (1..3 words) for places where even isolated
|
||||
* specials are not wanted (e.g. code-block language, mention labels, status
|
||||
* text, table cells rendered on the plain-markdown path).
|
||||
*/
|
||||
export const phraseArb: fc.Arbitrary<string> = fc
|
||||
.array(wordArb, { minLength: 1, maxLength: 3 })
|
||||
.map((ws) => ws.join(' '));
|
||||
|
||||
/**
|
||||
* A phrase guaranteed to contain at least one letter. Used for image/media alt
|
||||
* text and link titles: a PURELY numeric alt/title (e.g. "0") is parsed back as
|
||||
* a NUMBER and then dropped by the converter's `value || ""` coercion — not
|
||||
* byte-stable. A letter anywhere keeps it a string. (Ported verbatim.)
|
||||
*/
|
||||
export const letterPhraseArb: fc.Arbitrary<string> = fc
|
||||
.tuple(
|
||||
fc.stringMatching(/^[A-Za-z]{1,4}$/),
|
||||
fc.array(wordArb, { minLength: 0, maxLength: 2 }),
|
||||
)
|
||||
.map(([head, rest]) => [head, ...rest].join(' '));
|
||||
|
||||
/** A paren/space-free URL — safe inside markdown link/image `(...)` syntax. */
|
||||
export const urlArb: fc.Arbitrary<string> = fc
|
||||
.webUrl()
|
||||
.filter((u) => !/[()\s]/.test(u));
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Marked inline runs.
|
||||
// (Ported from markdown-roundtrip.property.test.ts "markedTextRunArb".)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* A text run with an OPTIONAL single non-code formatting mark (bold/italic/
|
||||
* strike/underline/superscript/subscript/spoiler), or a SOLE `code` mark, or a
|
||||
* link, or an inline comment anchor. `code` is NEVER combined with another mark
|
||||
* in the byte-stable space (that combination is a documented converter
|
||||
* limitation — the schema's `code` mark declares `excludes: "_"`). Marks wrap
|
||||
* `safeTextArb`, which stays stable even when it contains isolated specials.
|
||||
*
|
||||
* The mark set here is broadened past the sibling test's {bold,italic,strike}
|
||||
* to also cover underline / superscript / subscript / spoiler / textStyle /
|
||||
* highlight (all single, non-code marks), so the marks-on-text generator
|
||||
* exercises every mark the schema declares except the deliberately-excluded
|
||||
* `code`+other combination.
|
||||
*/
|
||||
export const markedTextRunArb: fc.Arbitrary<any> = fc.oneof(
|
||||
// Plain text.
|
||||
safeTextArb.map((t) => ({ type: 'text', text: t })),
|
||||
// Single formatting mark (attribute-free marks).
|
||||
fc
|
||||
.tuple(
|
||||
safeTextArb,
|
||||
fc.constantFrom('bold', 'italic', 'strike', 'underline', 'superscript', 'subscript', 'spoiler'),
|
||||
)
|
||||
.map(([t, m]) => ({ type: 'text', text: t, marks: [{ type: m }] })),
|
||||
// highlight with a color attr.
|
||||
fc
|
||||
.tuple(safeTextArb, fc.constantFrom('#ffcc00', '#a0e0ff', 'yellow'))
|
||||
.map(([t, color]) => ({ type: 'text', text: t, marks: [{ type: 'highlight', attrs: { color } }] })),
|
||||
// textStyle with a color attr.
|
||||
fc
|
||||
.tuple(safeTextArb, fc.constantFrom('#123456', '#ff0000', '#00aa88'))
|
||||
.map(([t, color]) => ({ type: 'text', text: t, marks: [{ type: 'textStyle', attrs: { color } }] })),
|
||||
// Sole code mark (backtick span). safeTextArb is backtick-free, so the span
|
||||
// content cannot contain an inner backtick.
|
||||
safeTextArb.map((t) => ({ type: 'text', text: t, marks: [{ type: 'code' }] })),
|
||||
// Link with safe text, a paren/space-free href, optionally a letter-bearing
|
||||
// title (a purely numeric title is coerced to a number and dropped).
|
||||
fc
|
||||
.tuple(phraseArb, urlArb, fc.option(letterPhraseArb, { nil: undefined }))
|
||||
.map(([t, href, title]) => ({
|
||||
type: 'text',
|
||||
text: t,
|
||||
marks: [{ type: 'link', attrs: title ? { href, title } : { href } }],
|
||||
})),
|
||||
// Inline comment anchor: a span[data-comment-id] that must survive byte-for-
|
||||
// byte. commentId is an alphanumeric token; `resolved` rides only when true.
|
||||
fc
|
||||
.tuple(safeTextArb, fc.stringMatching(/^[A-Za-z0-9]{4,10}$/), fc.boolean())
|
||||
.map(([t, commentId, resolved]) => ({
|
||||
type: 'text',
|
||||
text: t,
|
||||
marks: [
|
||||
{ type: 'comment', attrs: resolved ? { commentId, resolved: true } : { commentId } },
|
||||
],
|
||||
})),
|
||||
);
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Inline atoms and inline-content assembly.
|
||||
// (Ported from markdown-roundtrip.property.test.ts.)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/** Inline math node carrying LaTeX that includes the `a < b` the task asks for. */
|
||||
export const mathInlineArb: fc.Arbitrary<any> = fc
|
||||
.constantFrom('a < b', 'x^2 + y^2', 'a < b < c', '\\frac{1}{2}', 'E = mc^2')
|
||||
.map((text) => ({ type: 'mathInline', attrs: { text } }));
|
||||
|
||||
/** Mention node; label/id/entity are plain phrases / uuids. */
|
||||
export const mentionArb: fc.Arbitrary<any> = fc
|
||||
.tuple(phraseArb, fc.uuid(), fc.uuid())
|
||||
.map(([label, id, entityId]) => ({
|
||||
type: 'mention',
|
||||
attrs: { id, label, entityType: 'user', entityId },
|
||||
}));
|
||||
|
||||
export const hardBreakArb: fc.Arbitrary<any> = fc.constant({ type: 'hardBreak' });
|
||||
|
||||
const sameMarks = (a: any[] | undefined, b: any[] | undefined): boolean =>
|
||||
JSON.stringify(a ?? []) === JSON.stringify(b ?? []);
|
||||
|
||||
/**
|
||||
* Canonicalize a generated inline-content array the way ProseMirror stores it,
|
||||
* then trim the markdown-fragile edges. (Ported verbatim from
|
||||
* markdown-roundtrip.property.test.ts "normalizeInline":)
|
||||
* 1) MERGE adjacent text runs with IDENTICAL marks (the editor coalesces
|
||||
* them; split same-mark runs export to ambiguous "**a****b**").
|
||||
* 2) Collapse CONSECUTIVE hard breaks (two render a blank line marked eats).
|
||||
* 3) Drop a TRAILING hard break (removed by the converter's .trim()).
|
||||
*/
|
||||
export function normalizeInline(nodes: any[]): any[] {
|
||||
const out: any[] = [];
|
||||
for (const node of nodes) {
|
||||
const prev = out[out.length - 1];
|
||||
if (node.type === 'hardBreak' && prev && prev.type === 'hardBreak') continue;
|
||||
if (
|
||||
node.type === 'text' &&
|
||||
prev &&
|
||||
prev.type === 'text' &&
|
||||
sameMarks(prev.marks, node.marks)
|
||||
) {
|
||||
prev.text += node.text;
|
||||
continue;
|
||||
}
|
||||
out.push(node.type === 'text' ? { ...node } : node);
|
||||
}
|
||||
while (out.length > 1 && out[out.length - 1].type === 'hardBreak') out.pop();
|
||||
return out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Inline content for a paragraph: at least one marked text run, optionally with
|
||||
* inline atoms (math/mention) and hard breaks interspersed. Always starts with a
|
||||
* text run so the paragraph never opens with a block trigger. (Ported.)
|
||||
*/
|
||||
export const inlineContentArb: fc.Arbitrary<any[]> = fc
|
||||
.tuple(
|
||||
markedTextRunArb,
|
||||
fc.array(
|
||||
fc.oneof(
|
||||
{ weight: 5, arbitrary: markedTextRunArb },
|
||||
{ weight: 1, arbitrary: mathInlineArb },
|
||||
{ weight: 1, arbitrary: mentionArb },
|
||||
{ weight: 1, arbitrary: hardBreakArb },
|
||||
),
|
||||
{ minLength: 0, maxLength: 4 },
|
||||
),
|
||||
)
|
||||
.map(([first, rest]) => normalizeInline([first, ...rest]));
|
||||
|
||||
/**
|
||||
* Inline content for a HEADING — identical to a paragraph's, but WITHOUT hard
|
||||
* breaks. A hard break inside an ATX heading is not byte-stable (marked splits
|
||||
* the heading). (Ported.)
|
||||
*/
|
||||
export const headingInlineContentArb: fc.Arbitrary<any[]> = fc
|
||||
.tuple(
|
||||
markedTextRunArb,
|
||||
fc.array(
|
||||
fc.oneof(
|
||||
{ weight: 5, arbitrary: markedTextRunArb },
|
||||
{ weight: 1, arbitrary: mathInlineArb },
|
||||
{ weight: 1, arbitrary: mentionArb },
|
||||
),
|
||||
{ minLength: 0, maxLength: 4 },
|
||||
),
|
||||
)
|
||||
.map(([first, rest]) => normalizeInline([first, ...rest]));
|
||||
|
||||
/** Simple plain-text inline content (single run) for containers rendered on the
|
||||
* raw-HTML path (table cells / column bodies) where fancy inline is undesirable. */
|
||||
export const plainInlineContentArb: fc.Arbitrary<any[]> = phraseArb.map((t) => [
|
||||
{ type: 'text', text: t },
|
||||
]);
|
||||
@@ -0,0 +1,68 @@
|
||||
diff --git a/dist/index.js b/dist/index.js
|
||||
index ae447a12f7823ec0a00837ee9f0eb809a610d5f8..a3402b2c2d021ef432cfa76e35d370073d525135 100644
|
||||
--- a/dist/index.js
|
||||
+++ b/dist/index.js
|
||||
@@ -6578,9 +6578,19 @@ function createOutputTransformStream(output) {
|
||||
controller.enqueue({ part: chunk, partialOutput: void 0 });
|
||||
return;
|
||||
}
|
||||
- text2 += chunk.text;
|
||||
textChunk += chunk.text;
|
||||
textProviderMetadata = (_a21 = chunk.providerMetadata) != null ? _a21 : textProviderMetadata;
|
||||
+ if (output == null) {
|
||||
+ // PATCH(docmost #OOM): no output strategy requested -> publish each
|
||||
+ // text-delta immediately and do NOT build cumulative partialOutput
|
||||
+ // snapshots. Unpatched, the default text() output snapshots the ENTIRE
|
||||
+ // accumulated turn text on every delta (O(n^2) memory) and those
|
||||
+ // snapshots pile up in the never-consumed leftover tee branch of
|
||||
+ // DefaultStreamTextResult.baseStream -> heap OOM on long agent turns.
|
||||
+ publishTextChunk({ controller });
|
||||
+ return;
|
||||
+ }
|
||||
+ text2 += chunk.text;
|
||||
const result = await output.parsePartialOutput({ text: text2 });
|
||||
if (result !== void 0) {
|
||||
const currentJson = JSON.stringify(result.partial);
|
||||
@@ -6959,7 +6969,7 @@ var DefaultStreamTextResult = class {
|
||||
})
|
||||
);
|
||||
}
|
||||
- this.baseStream = stream.pipeThrough(createOutputTransformStream(output != null ? output : text())).pipeThrough(eventProcessor);
|
||||
+ this.baseStream = stream.pipeThrough(createOutputTransformStream(output)).pipeThrough(eventProcessor);
|
||||
const { maxRetries, retry } = prepareRetries({
|
||||
maxRetries: maxRetriesArg,
|
||||
abortSignal
|
||||
diff --git a/dist/index.mjs b/dist/index.mjs
|
||||
index 663875332e3f9a9bd167c25583c515876f42951b..b840b0502c9894df983e0154805abb80e70e6331 100644
|
||||
--- a/dist/index.mjs
|
||||
+++ b/dist/index.mjs
|
||||
@@ -6501,9 +6501,19 @@ function createOutputTransformStream(output) {
|
||||
controller.enqueue({ part: chunk, partialOutput: void 0 });
|
||||
return;
|
||||
}
|
||||
- text2 += chunk.text;
|
||||
textChunk += chunk.text;
|
||||
textProviderMetadata = (_a21 = chunk.providerMetadata) != null ? _a21 : textProviderMetadata;
|
||||
+ if (output == null) {
|
||||
+ // PATCH(docmost #OOM): no output strategy requested -> publish each
|
||||
+ // text-delta immediately and do NOT build cumulative partialOutput
|
||||
+ // snapshots. Unpatched, the default text() output snapshots the ENTIRE
|
||||
+ // accumulated turn text on every delta (O(n^2) memory) and those
|
||||
+ // snapshots pile up in the never-consumed leftover tee branch of
|
||||
+ // DefaultStreamTextResult.baseStream -> heap OOM on long agent turns.
|
||||
+ publishTextChunk({ controller });
|
||||
+ return;
|
||||
+ }
|
||||
+ text2 += chunk.text;
|
||||
const result = await output.parsePartialOutput({ text: text2 });
|
||||
if (result !== void 0) {
|
||||
const currentJson = JSON.stringify(result.partial);
|
||||
@@ -6882,7 +6892,7 @@ var DefaultStreamTextResult = class {
|
||||
})
|
||||
);
|
||||
}
|
||||
- this.baseStream = stream.pipeThrough(createOutputTransformStream(output != null ? output : text())).pipeThrough(eventProcessor);
|
||||
+ this.baseStream = stream.pipeThrough(createOutputTransformStream(output)).pipeThrough(eventProcessor);
|
||||
const { maxRetries, retry } = prepareRetries({
|
||||
maxRetries: maxRetriesArg,
|
||||
abortSignal
|
||||
Generated
+8
-5
@@ -44,6 +44,9 @@ overrides:
|
||||
ip-address: 10.1.1
|
||||
|
||||
patchedDependencies:
|
||||
ai@6.0.134:
|
||||
hash: f60bfc3357e01e1f3978c6c40fdd65aeb33fefaad7179cde8676465b6c5ff4d9
|
||||
path: patches/ai@6.0.134.patch
|
||||
scimmy@1.3.5:
|
||||
hash: 775d80f86830b2c5dd1a250c9802c10f8fc3da3c7898373de5aa0c23993d1673
|
||||
path: patches/scimmy@1.3.5.patch
|
||||
@@ -626,10 +629,10 @@ importers:
|
||||
version: 8.3.0(socket.io-adapter@2.5.4)
|
||||
ai:
|
||||
specifier: ^6.0.134
|
||||
version: 6.0.134(zod@4.3.6)
|
||||
version: 6.0.134(patch_hash=f60bfc3357e01e1f3978c6c40fdd65aeb33fefaad7179cde8676465b6c5ff4d9)(zod@4.3.6)
|
||||
ai-sdk-ollama:
|
||||
specifier: ^3.8.1
|
||||
version: 3.8.1(ai@6.0.134(zod@4.3.6))(zod@4.3.6)
|
||||
version: 3.8.1(ai@6.0.134(patch_hash=f60bfc3357e01e1f3978c6c40fdd65aeb33fefaad7179cde8676465b6c5ff4d9)(zod@4.3.6))(zod@4.3.6)
|
||||
bcrypt:
|
||||
specifier: ^6.0.0
|
||||
version: 6.0.0
|
||||
@@ -16358,17 +16361,17 @@ snapshots:
|
||||
|
||||
agent-base@7.1.4: {}
|
||||
|
||||
ai-sdk-ollama@3.8.1(ai@6.0.134(zod@4.3.6))(zod@4.3.6):
|
||||
ai-sdk-ollama@3.8.1(ai@6.0.134(patch_hash=f60bfc3357e01e1f3978c6c40fdd65aeb33fefaad7179cde8676465b6c5ff4d9)(zod@4.3.6))(zod@4.3.6):
|
||||
dependencies:
|
||||
'@ai-sdk/provider': 3.0.8
|
||||
'@ai-sdk/provider-utils': 4.0.21(zod@4.3.6)
|
||||
ai: 6.0.134(zod@4.3.6)
|
||||
ai: 6.0.134(patch_hash=f60bfc3357e01e1f3978c6c40fdd65aeb33fefaad7179cde8676465b6c5ff4d9)(zod@4.3.6)
|
||||
jsonrepair: 3.13.3
|
||||
ollama: 0.6.3
|
||||
transitivePeerDependencies:
|
||||
- zod
|
||||
|
||||
ai@6.0.134(zod@4.3.6):
|
||||
ai@6.0.134(patch_hash=f60bfc3357e01e1f3978c6c40fdd65aeb33fefaad7179cde8676465b6c5ff4d9)(zod@4.3.6):
|
||||
dependencies:
|
||||
'@ai-sdk/gateway': 3.0.77(zod@4.3.6)
|
||||
'@ai-sdk/provider': 3.0.8
|
||||
|
||||
Reference in New Issue
Block a user