Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Keep template import from overwriting an existing template (PRD-9405) (#6410)

Andrew Mikofalvy76f075669ce3
diff --git a/.changeset/template-import-never-overwrites.md b/.changeset/template-import-never-overwrites.md
new file mode 100644
index 000000000..b92c13e11
--- /dev/null
+++ b/.changeset/template-import-never-overwrites.md
@@ -0,0 +1,5 @@
+---
+"@inkeep/open-knowledge": patch
+---
+
+Converting a page to a template no longer overwrites an existing template with the same generated name; it picks the next free name such as `imported-template-2`. Importing under an explicit name that is already taken is refused.
diff --git a/knip.config.ts b/knip.config.ts
index e43118957..eb9727af8 100644
--- a/knip.config.ts
+++ b/knip.config.ts
@@ -155,11 +155,15 @@ export default {
'src/shadow-fixture-launch.test-helper.mjs',
],
project: 'src/**',
- ignoreDependencies: ['@types/shell-quote'],
+ ignoreDependencies: [
+ '@types/shell-quote',
+ ],
},
'packages/cli': {
entry: ['src/**/*.test.ts', 'scripts/*.ts', 'tests/**/*.ts', 'src/parse-worker.ts'],
- ignoreDependencies: ['yjs'],
+ ignoreDependencies: [
+ 'yjs',
+ ],
},
'packages/desktop': {
entry: [
diff --git a/packages/app/tests/integration/bug3-source-mode-writeback.test.ts b/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
index a50b00123..4549c74b3 100644
--- a/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
+++ b/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
@@ -1,3 +1,4 @@
+
import { readFileSync } from 'node:fs';
import { join } from 'node:path';
import { setTimeout as wait } from 'node:timers/promises';
diff --git a/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts b/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
index 6fcdc23f2..4fc2c11f9 100644
--- a/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
+++ b/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { normalizeBridge } from '@inkeep/open-knowledge-core';
import { updateYFragment } from '@tiptap/y-tiptap';
diff --git a/packages/app/tests/integration/interior-edit-freshness.test.ts b/packages/app/tests/integration/interior-edit-freshness.test.ts
index 40b5cdfd6..9f2f6feb6 100644
--- a/packages/app/tests/integration/interior-edit-freshness.test.ts
+++ b/packages/app/tests/integration/interior-edit-freshness.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts b/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
index 93666af70..2a085742b 100644
--- a/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
+++ b/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/producer-guard-wiring.test.ts b/packages/app/tests/integration/producer-guard-wiring.test.ts
index 867598d34..878d5196b 100644
--- a/packages/app/tests/integration/producer-guard-wiring.test.ts
+++ b/packages/app/tests/integration/producer-guard-wiring.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts b/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
index 0970ac12f..4ada3cf26 100644
--- a/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
+++ b/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
@@ -1,3 +1,4 @@
+
import { randomUUID } from 'node:crypto';
import { afterEach, describe, expect, test } from 'vitest';
import { agentWriteMd, createTestServer, type TestServer } from './test-harness';
diff --git a/packages/app/tests/integration/qa-045-restore-after-gc.test.ts b/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
index b632185e1..cbe2b705f 100644
--- a/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
+++ b/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
@@ -1,3 +1,4 @@
+
import { execFileSync } from 'node:child_process';
import { randomUUID } from 'node:crypto';
import { join } from 'node:path';
diff --git a/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts b/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
index c530ce4ba..89bc9b4d9 100644
--- a/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
+++ b/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
@@ -1,3 +1,4 @@
+
import { randomUUID } from 'node:crypto';
import { afterAll, afterEach, beforeAll, describe, expect, test } from 'vitest';
import type * as Y from 'yjs';
diff --git a/packages/app/tests/integration/template-import-collision.test.ts b/packages/app/tests/integration/template-import-collision.test.ts
new file mode 100644
index 000000000..f54454e18
--- /dev/null
+++ b/packages/app/tests/integration/template-import-collision.test.ts
@@ -0,0 +1,176 @@
+import { randomUUID } from 'node:crypto';
+import { existsSync, readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { ProblemDetailsSchema, TemplateImportSuccessSchema } from '@inkeep/open-knowledge-core';
+import { afterAll, beforeAll, describe, expect, test } from 'vitest';
+import {
+ createTestServer,
+ HARNESS_BOOT_TIMEOUT_MS,
+ type TestServer,
+ wait,
+} from './test-harness.ts';
+
+let server: TestServer;
+
+beforeAll(async () => {
+ server = await createTestServer();
+}, HARNESS_BOOT_TIMEOUT_MS);
+
+afterAll(async () => {
+ await server.cleanup();
+});
+
+async function writeSource(docName: string, markdown: string): Promise<void> {
+ const res = await fetch(`http://127.0.0.1:${server.port}/api/agent-write-md`, {
+ method: 'POST',
+ headers: { 'Content-Type': 'application/json' },
+ body: JSON.stringify({ markdown, position: 'replace', docName }),
+ });
+ expect(res.status).toBe(200);
+ const filePath = join(server.contentDir, `${docName}.md`);
+ for (let i = 0; i < 100; i++) {
+ if (existsSync(filePath)) return;
+ await wait(50);
+ }
+ throw new Error(`source ${docName}.md never flushed to disk`);
+}
+
+function importTemplate(body: Record<string, unknown>): Promise<Response> {
+ return fetch(`http://127.0.0.1:${server.port}/api/template/import`, {
+ method: 'POST',
+ headers: { 'Content-Type': 'application/json' },
+ body: JSON.stringify(body),
+ });
+}
+
+async function importedPath(res: Response): Promise<string> {
+ expect(res.status).toBe(200);
+ const parsed = TemplateImportSuccessSchema.parse(await res.json());
+ expect(parsed.created).toBe(true);
+ return parsed.path;
+}
+
+function templateBytes(folder: string, name: string): string {
+ return readFileSync(join(server.contentDir, folder, '.ok', 'templates', `${name}.md`), 'utf-8');
+}
+
+async function waitForRemoval(docName: string): Promise<void> {
+ const filePath = join(server.contentDir, `${docName}.md`);
+ for (let i = 0; i < 100; i++) {
+ if (!existsSync(filePath)) return;
+ await wait(50);
+ }
+}
+
+describe('template import never overwrites an existing template', () => {
+ test('two pages named only in non-Latin script land as separate templates', async () => {
+ const folder = `jp-${randomUUID().slice(0, 8)}`;
+ const firstMarker = `minutes-${randomUUID().slice(0, 8)}`;
+ const secondMarker = `daily-${randomUUID().slice(0, 8)}`;
+ await writeSource(`${folder}/議事録`, `# 議事録\n\n${firstMarker}\n`);
+ await writeSource(`${folder}/日報`, `# 日報\n\n${secondMarker}\n`);
+
+ const firstPath = await importedPath(
+ await importTemplate({ sourcePath: `${folder}/議事録`, targetFolder: folder }),
+ );
+ const secondPath = await importedPath(
+ await importTemplate({
+ sourcePath: `${folder}/日報`,
+ targetFolder: folder,
+ deleteSource: true,
+ }),
+ );
+
+ expect(firstPath).toBe(`${folder}/.ok/templates/imported-template.md`);
+ expect(secondPath).toBe(`${folder}/.ok/templates/imported-template-2.md`);
+ expect(templateBytes(folder, 'imported-template')).toContain(firstMarker);
+ expect(templateBytes(folder, 'imported-template')).not.toContain(secondMarker);
+ expect(templateBytes(folder, 'imported-template-2')).toContain(secondMarker);
+
+ await waitForRemoval(`${folder}/日報`);
+ expect(existsSync(join(server.contentDir, folder, '日報.md'))).toBe(false);
+ expect(existsSync(join(server.contentDir, folder, '議事録.md'))).toBe(true);
+ });
+
+ test('ASCII names that derive the same slug walk to the next free suffix', async () => {
+ const folder = `slug-${randomUUID().slice(0, 8)}`;
+ const markers = [0, 1, 2].map((i) => `m${i}-${randomUUID().slice(0, 8)}`);
+ await writeSource(`${folder}/Team Notes`, `# A\n\n${markers[0]}\n`);
+ await writeSource(`${folder}/team-notes`, `# B\n\n${markers[1]}\n`);
+ await writeSource(`${folder}/-team-notes-`, `# C\n\n${markers[2]}\n`);
+
+ const paths = [
+ await importedPath(
+ await importTemplate({ sourcePath: `${folder}/Team Notes`, targetFolder: folder }),
+ ),
+ await importedPath(
+ await importTemplate({ sourcePath: `${folder}/team-notes`, targetFolder: folder }),
+ ),
+ await importedPath(
+ await importTemplate({ sourcePath: `${folder}/-team-notes-`, targetFolder: folder }),
+ ),
+ ];
+
+ expect(paths).toEqual([
+ `${folder}/.ok/templates/team-notes.md`,
+ `${folder}/.ok/templates/team-notes-2.md`,
+ `${folder}/.ok/templates/team-notes-3.md`,
+ ]);
+ expect(templateBytes(folder, 'team-notes')).toContain(markers[0]);
+ expect(templateBytes(folder, 'team-notes-2')).toContain(markers[1]);
+ expect(templateBytes(folder, 'team-notes-3')).toContain(markers[2]);
+ });
+
+ test('concurrent unnamed imports of colliding pages each get their own template', async () => {
+ const folder = `race-${randomUUID().slice(0, 8)}`;
+ const names = ['Привет', 'Мир', 'Тест'];
+ for (const name of names) {
+ await writeSource(`${folder}/${name}`, `# ${name}\n\nbody-${name}\n`);
+ }
+
+ const paths = await Promise.all(
+ names.map(async (name) =>
+ importedPath(
+ await importTemplate({ sourcePath: `${folder}/${name}`, targetFolder: folder }),
+ ),
+ ),
+ );
+
+ expect(new Set(paths).size).toBe(names.length);
+ const contents = paths.map((p) => readFileSync(join(server.contentDir, p), 'utf-8'));
+ for (const name of names) {
+ expect(contents.filter((c) => c.includes(`body-${name}`))).toHaveLength(1);
+ }
+ });
+
+ test('an explicit name that is already taken is refused and nothing is written or deleted', async () => {
+ const folder = `named-${randomUUID().slice(0, 8)}`;
+ const keepMarker = `keep-${randomUUID().slice(0, 8)}`;
+ await writeSource(`${folder}/first`, `# First\n\n${keepMarker}\n`);
+ await writeSource(`${folder}/second`, '# Second\n\nreplacement\n');
+
+ await importedPath(
+ await importTemplate({
+ sourcePath: `${folder}/first`,
+ targetFolder: folder,
+ name: 'standup',
+ }),
+ );
+ const before = templateBytes(folder, 'standup');
+
+ const res = await importTemplate({
+ sourcePath: `${folder}/second`,
+ targetFolder: folder,
+ name: 'standup',
+ deleteSource: true,
+ });
+ expect(res.status).toBe(409);
+ expect(res.headers.get('content-type')).toBe('application/problem+json');
+ const problem = ProblemDetailsSchema.parse(await res.json());
+ expect(problem.type).toBe('urn:ok:error:doc-already-exists');
+
+ expect(templateBytes(folder, 'standup')).toBe(before);
+ expect(before).toContain(keepMarker);
+ expect(existsSync(join(server.contentDir, folder, 'second.md'))).toBe(true);
+ });
+});
diff --git a/packages/app/tests/integration/undo-after-rollback.test.ts b/packages/app/tests/integration/undo-after-rollback.test.ts
index d3767adc9..a78aeb0e4 100644
--- a/packages/app/tests/integration/undo-after-rollback.test.ts
+++ b/packages/app/tests/integration/undo-after-rollback.test.ts
@@ -1,3 +1,4 @@
+
import { ROLLBACK_ORIGIN } from '@inkeep/open-knowledge-server';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
import * as Y from 'yjs';
diff --git a/packages/app/tests/integration/undo-recycle-reset.test.ts b/packages/app/tests/integration/undo-recycle-reset.test.ts
index b076f955c..e7cc69c3f 100644
--- a/packages/app/tests/integration/undo-recycle-reset.test.ts
+++ b/packages/app/tests/integration/undo-recycle-reset.test.ts
@@ -1,3 +1,4 @@
+
import { writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { setTimeout as wait } from 'node:timers/promises';
diff --git a/packages/app/tests/integration/undo-rederive-survival.test.ts b/packages/app/tests/integration/undo-rederive-survival.test.ts
index 7935e35f8..9ddcd0730 100644
--- a/packages/app/tests/integration/undo-rederive-survival.test.ts
+++ b/packages/app/tests/integration/undo-rederive-survival.test.ts
@@ -1,3 +1,4 @@
+
import { prependFrontmatter } from '@inkeep/open-knowledge-core';
import { Plugin, PluginKey } from '@tiptap/pm/state';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
diff --git a/packages/core/src/bridge/compose.ts b/packages/core/src/bridge/compose.ts
index f4cc8a286..2a597ec3d 100644
--- a/packages/core/src/bridge/compose.ts
+++ b/packages/core/src/bridge/compose.ts
@@ -1,3 +1,4 @@
+
import { prependFrontmatter, stripFrontmatter } from '../extensions/frontmatter.ts';
export type ComposeAdjustment = 'none' | 'body' | 'frontmatter' | 'unresolved';
diff --git a/packages/core/src/bridge/doc-boundary-space.ts b/packages/core/src/bridge/doc-boundary-space.ts
index e7e63f43d..ffd8fce06 100644
--- a/packages/core/src/bridge/doc-boundary-space.ts
+++ b/packages/core/src/bridge/doc-boundary-space.ts
@@ -1,3 +1,4 @@
+
import { FRONTMATTER_RE, stripFrontmatter } from '../extensions/frontmatter.ts';
import { carriedEdgeEmpties, type DocEdgeEmpties } from '../markdown/doc-edge-blank-runs.ts';
diff --git a/packages/core/src/markdown/comment-promoter.ts b/packages/core/src/markdown/comment-promoter.ts
index fc267cbea..fb0ba5a7c 100644
--- a/packages/core/src/markdown/comment-promoter.ts
+++ b/packages/core/src/markdown/comment-promoter.ts
@@ -1,3 +1,4 @@
+
import type { Nodes, Paragraph, PhrasingContent, Root, RootContent, Text } from 'mdast';
import { SKIP, visit } from 'unist-util-visit';
import type { VFile } from 'vfile';
diff --git a/packages/core/src/markdown/merged-walker.ts b/packages/core/src/markdown/merged-walker.ts
index 861003fb4..ae8cb390b 100644
--- a/packages/core/src/markdown/merged-walker.ts
+++ b/packages/core/src/markdown/merged-walker.ts
@@ -1,3 +1,4 @@
+
import type { Nodes, Parent, Root } from 'mdast';
import { SKIP, visit } from 'unist-util-visit';
import type { VFile } from 'vfile';
diff --git a/packages/core/src/markdown/safe-url.ts b/packages/core/src/markdown/safe-url.ts
index 4d3250d3a..8be632ba4 100644
--- a/packages/core/src/markdown/safe-url.ts
+++ b/packages/core/src/markdown/safe-url.ts
@@ -1,3 +1,4 @@
+
export const SAFE_URL_SCHEMES = ['https', 'http', 'mailto', 'tel', 'ftp', 'sms'] as const;
const SCHEME_ALT = SAFE_URL_SCHEMES.map((s) => `${s}:`).join('|');
diff --git a/packages/server/src/http/folder-template-routes.ts b/packages/server/src/http/folder-template-routes.ts
index e67ab36be..b1e5ecd81 100644
--- a/packages/server/src/http/folder-template-routes.ts
+++ b/packages/server/src/http/folder-template-routes.ts
@@ -258,6 +258,13 @@ export function createFolderTemplateRoutes(deps: FolderTemplateRouteDeps): ApiRo
return templateContentDocName(folderRel, name);
}
+ const reservedImportTargets = new Set<string>();
+
+ function isTemplateNameTaken(templatesDir: string, name: string): boolean {
+ const filePath = resolve(templatesDir, `${name}.md`);
+ return reservedImportTargets.has(filePath) || existsSync(filePath);
+ }
+
const handleFolderConfigGet = withValidation(
EmptyRequestSchema,
async (req, res) => {
@@ -1079,6 +1086,7 @@ export function createFolderTemplateRoutes(deps: FolderTemplateRouteDeps): ApiRo
const handleTemplateImport = withValidation(
TemplateImportRequestSchema,
async (_req, res, body) => {
+ let reservedTarget: string | undefined;
try {
if (ephemeral) {
errorResponse(
@@ -1195,13 +1203,20 @@ export function createFolderTemplateRoutes(deps: FolderTemplateRouteDeps): ApiRo
);
if (!validated) return;
- const templateFilePath = resolve(
+ const templatesDir = resolve(
validated.resolvedContentDir,
validated.folderRel,
'.ok',
'templates',
- `${name}.md`,
);
+ if (!body.name) {
+ const baseName = name;
+ for (let suffix = 2; isTemplateNameTaken(templatesDir, name); suffix++) {
+ name = `${baseName}-${suffix}`;
+ }
+ }
+
+ const templateFilePath = resolve(templatesDir, `${name}.md`);
if (checkSymlinkLeaf(templateFilePath).kind === 'symlink') {
errorResponse(
res,
@@ -1222,6 +1237,19 @@ export function createFolderTemplateRoutes(deps: FolderTemplateRouteDeps): ApiRo
)
return;
+ if (isTemplateNameTaken(templatesDir, name)) {
+ errorResponse(
+ res,
+ 409,
+ 'urn:ok:error:doc-already-exists',
+ `Template "${name}" already exists in "${validated.folderRel || '(root)'}". Choose another name, or edit the existing template instead.`,
+ { handler: 'template-import', detail: 'TEMPLATE_EXISTS' },
+ );
+ return;
+ }
+ reservedImportTargets.add(templateFilePath);
+ reservedTarget = templateFilePath;
+
const { frontmatter: sourceFmText, body: sourceBody } = stripFrontmatter(sourceContent);
const cleanFmText = unwrapFrontmatterFences(sourceFmText);
let sourceFmObj: Record<string, unknown> = {};
@@ -1346,6 +1374,8 @@ export function createFolderTemplateRoutes(deps: FolderTemplateRouteDeps): ApiRo
cause: e,
},
);
+ } finally {
+ if (reservedTarget !== undefined) reservedImportTargets.delete(reservedTarget);
}
},
{ handler: 'template-import', method: 'POST' },