Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Fix red sibling links in History diffs (PRD-9206) (#6019)

Andrew Mikofalvy984e29d31f51
diff --git a/.changeset/history-diff-relative-links.md b/.changeset/history-diff-relative-links.md
new file mode 100644
index 000000000..280ec9b72
--- /dev/null
+++ b/.changeset/history-diff-relative-links.md
@@ -0,0 +1,5 @@
+---
+"@inkeep/open-knowledge": patch
+---
+
+History and agent-change diffs now resolve relative links and inline images against the document's folder, so links to existing pages beside it no longer show as broken.
diff --git a/packages/app/src/components/AgentDiffPane.tsx b/packages/app/src/components/AgentDiffPane.tsx
index 8fe6aad5d..ea32bcda1 100644
--- a/packages/app/src/components/AgentDiffPane.tsx
+++ b/packages/app/src/components/AgentDiffPane.tsx
@@ -310,7 +310,7 @@ export function AgentDiffPane({ view, isPanelCollapsed, onTogglePanel }: AgentDi
{result.status === 'ready' && <PropertyDiffBlock delta={result.properties} />}
{result.status === 'ready' &&
(renderMode === 'rendered' && rendered?.ok ? (
- <RenderedDiffView diff={rendered} />
+ <RenderedDiffView diff={rendered} docName={docName} />
) : result.diff === '' ? (
<>
<p className="border-b border-border px-4 py-2 text-xs text-muted-foreground italic">
diff --git a/packages/app/src/components/RenderedDiffView.dom.test.tsx b/packages/app/src/components/RenderedDiffView.dom.test.tsx
index 55ea699c1..687aa9f78 100644
--- a/packages/app/src/components/RenderedDiffView.dom.test.tsx
+++ b/packages/app/src/components/RenderedDiffView.dom.test.tsx
@@ -1,5 +1,6 @@
import { cleanup, render, waitFor } from '@testing-library/react';
import { afterEach, describe, expect, test } from 'vitest';
+import { __resetPageListCacheForTests, setPageListCache } from '@/editor/page-list-cache';
import {
countRenderedDiffAnchors,
RENDERED_DIFF_CHANGE_SELECTOR,
@@ -8,12 +9,13 @@ import { computeRenderedDiff, RenderedDiffView } from './RenderedDiffView';
afterEach(() => {
cleanup();
+ __resetPageListCacheForTests();
});
-async function mountDiff(before: string, after: string): Promise<HTMLElement> {
+async function mountDiff(before: string, after: string, docName = 'notes'): Promise<HTMLElement> {
const diff = computeRenderedDiff(before, after);
if (!diff.ok) throw new Error(`engine returned not-ok: ${diff.reason}`);
- render(<RenderedDiffView diff={diff} />);
+ render(<RenderedDiffView diff={diff} docName={docName} />);
const pane = await waitFor(() => {
const el = document.querySelector<HTMLElement>('[data-testid="rendered-diff-view"]');
if (!el?.querySelector('.ProseMirror')) throw new Error('editor not mounted yet');
@@ -65,6 +67,38 @@ describe('RenderedDiffView', () => {
expect(marked).not.toContain('Spec');
});
+ test('a relative link resolves against the changed document, not the project root', async () => {
+ setPageListCache({
+ pages: new Set(['projects/ok-cloud/log', 'projects/ok-cloud/launch-scope', 'launch-dev']),
+ folderPaths: new Set(['projects', 'projects/ok-cloud']),
+ pagesBySlug: new Map(),
+ });
+ const pane = await mountDiff(
+ 'Intro.',
+ 'Intro.\n\nSee [scope](launch-scope.md) and [dev](launch-dev.md).',
+ 'projects/ok-cloud/log',
+ );
+
+ const stateOf = (text: string) =>
+ Array.from(pane.querySelectorAll<HTMLElement>('[data-resolution-state]'))
+ .find((el) => el.textContent === text)
+ ?.getAttribute('data-resolution-state');
+ await waitFor(() => expect(stateOf('scope')).toBe('resolved'));
+ expect(stateOf('dev')).toBe('unresolved');
+ });
+
+ test('a relative inline image resolves against the changed document folder', async () => {
+ const pane = await mountDiff(
+ 'Intro.',
+ 'Intro.\n\nSee ![diagram](diagram.png) here.',
+ 'projects/ok-cloud/log',
+ );
+
+ await waitFor(() =>
+ expect(pane.querySelector('img')?.getAttribute('src')).toBe('/projects/ok-cloud/diagram.png'),
+ );
+ });
+
test('a formatting-only change (bold removed) renders without content churn', async () => {
const pane = await mountDiff('one **two three** four', 'one two three four');
expect(pane.querySelector('.ProseMirror')).toBeTruthy();
@@ -80,7 +114,7 @@ describe('RenderedDiffView', () => {
const diff = computeRenderedDiff(before, after);
if (!diff.ok) throw new Error(`engine not-ok: ${diff.reason}`);
cleanup();
- render(<RenderedDiffView diff={diff} />);
+ render(<RenderedDiffView diff={diff} docName="notes" />);
const pane = await waitFor(() => {
const el = document.querySelector<HTMLElement>('[data-testid="rendered-diff-view"]');
if (!el?.querySelector('.ProseMirror')) throw new Error('not mounted');
diff --git a/packages/app/src/components/RenderedDiffView.tsx b/packages/app/src/components/RenderedDiffView.tsx
index 862d30d71..7595895ed 100644
--- a/packages/app/src/components/RenderedDiffView.tsx
+++ b/packages/app/src/components/RenderedDiffView.tsx
@@ -4,6 +4,8 @@ import { DecorationSet } from '@tiptap/pm/view';
import { EditorContent, useEditor } from '@tiptap/react';
import { useLayoutEffect, useRef, useState } from 'react';
import { createPortal } from 'react-dom';
+import { setEditorDocName } from '@/editor/extensions/doc-context';
+import { scopeExtensionsToDocument } from '@/editor/extensions/shared';
import { getSharedMarkdownManager } from '@/editor/utils/md-singleton';
import {
buildRenderedDiff,
@@ -35,7 +37,7 @@ const DiffDecorations = Extension.create<{ decorations: DecorationSet }>({
},
});
-export function RenderedDiffView({ diff }: { diff: RenderedDiff }) {
+export function RenderedDiffView({ diff, docName }: { diff: RenderedDiff; docName: string }) {
const decorations = buildDiffDecorations(
diff.afterDoc,
diff.beforeDoc,
@@ -47,13 +49,17 @@ export function RenderedDiffView({ diff }: { diff: RenderedDiff }) {
const editor = useEditor(
{
editable: false,
- extensions: [...diffExtensions, DiffDecorations.configure({ decorations })],
+ extensions: [
+ ...scopeExtensionsToDocument(diffExtensions, docName),
+ DiffDecorations.configure({ decorations }),
+ ],
content: diff.afterDoc.toJSON(),
+ onBeforeCreate: ({ editor }) => setEditorDocName(editor, docName),
editorProps: {
attributes: { class: 'pt-4' },
},
},
- [diff],
+ [diff, docName],
);
const [portalTarget] = useState(() => {
diff --git a/packages/app/src/components/TimelineDiffPane.tsx b/packages/app/src/components/TimelineDiffPane.tsx
index 8b67ec44d..c908e2863 100644
--- a/packages/app/src/components/TimelineDiffPane.tsx
+++ b/packages/app/src/components/TimelineDiffPane.tsx
@@ -417,7 +417,7 @@ export function TimelineDiffPane({ view, isPanelCollapsed, onTogglePanel }: Time
)}
{result.status === 'ready' &&
(renderMode === 'rendered' && rendered?.ok ? (
- <RenderedDiffView diff={rendered} />
+ <RenderedDiffView diff={rendered} docName={docName} />
) : result.diff === '' ? (
<>
<p className="border-b border-border px-4 py-2 text-xs text-muted-foreground italic">
diff --git a/packages/app/src/editor/TiptapEditor.tsx b/packages/app/src/editor/TiptapEditor.tsx
index 73e5e2a95..e80cef98e 100644
--- a/packages/app/src/editor/TiptapEditor.tsx
+++ b/packages/app/src/editor/TiptapEditor.tsx
@@ -71,7 +71,7 @@ import { setEditorDocName } from './extensions/doc-context.ts';
import { setEditorSingleFileMode, setEditorSourceMode } from './extensions/editor-mode-context.ts';
import { FrozenTableHeaders } from './extensions/frozen-table-headers.ts';
import { MarkdownLintDecorations } from './extensions/markdown-lint-decorations.ts';
-import { sharedExtensions } from './extensions/shared.ts';
+import { scopeExtensionsToDocument, sharedExtensions } from './extensions/shared.ts';
import { SkillPathLinks } from './extensions/skill-path-links';
import { uploadDecorationPlugin } from './image-upload/index.ts';
import type { LandingHandle } from './landing-controller';
@@ -251,18 +251,7 @@ export function buildExtensionList(args: BuildEditorOptionsArgs): AnyExtension[]
const { provider, placeholder, prebuiltMapping, onWedged } = args;
const { collaboration, guard } = buildPrewarmBoundCollaboration(provider, prebuiltMapping);
return [
- ...sharedExtensions.map((ext) => {
- if (
- ext.name === 'link' ||
- ext.name === 'wikiLink' ||
- ext.name === 'jsxComponent' ||
- ext.name === 'jsxInline' ||
- ext.name === 'imageReference'
- ) {
- return ext.configure({ docName: provider.configuration.name ?? '' });
- }
- return ext;
- }),
+ ...scopeExtensionsToDocument(sharedExtensions, provider.configuration.name ?? ''),
createBareHtmlImageDecoration(provider.configuration.name ?? ''),
Placeholder.configure({
placeholder: () => placeholder ?? t`Type '/' for commands`,
diff --git a/packages/app/src/editor/extensions/shared.ts b/packages/app/src/editor/extensions/shared.ts
index 4648a1f5c..08bf7eff6 100644
--- a/packages/app/src/editor/extensions/shared.ts
+++ b/packages/app/src/editor/extensions/shared.ts
@@ -1,5 +1,5 @@
import { sharedExtensions as coreExtensions } from '@inkeep/open-knowledge-core/extensions/shared';
-import { Extension } from '@tiptap/core';
+import { type AnyExtension, Extension } from '@tiptap/core';
import FileHandler from '@tiptap/extension-file-handler';
import { KeyboardNav } from '../block-ux/keyboard-nav';
import { TiptapFindReplace } from '../find-replace/tiptap-find-replace-extension';
@@ -118,3 +118,20 @@ export const sharedExtensions = [
},
}),
];
+
+const DOCUMENT_SCOPED_EXTENSION_NAMES: ReadonlySet<string> = new Set([
+ 'link',
+ 'wikiLink',
+ 'jsxComponent',
+ 'jsxInline',
+ 'imageReference',
+]);
+
+export function scopeExtensionsToDocument(
+ extensions: readonly AnyExtension[],
+ docName: string,
+): AnyExtension[] {
+ return extensions.map((ext) =>
+ DOCUMENT_SCOPED_EXTENSION_NAMES.has(ext.name) ? ext.configure({ docName }) : ext,
+ );
+}
diff --git a/packages/app/tests/meta/link-audit-seams.manifest.ts b/packages/app/tests/meta/link-audit-seams.manifest.ts
index f3d3cbbf4..5b4e6dafe 100644
--- a/packages/app/tests/meta/link-audit-seams.manifest.ts
+++ b/packages/app/tests/meta/link-audit-seams.manifest.ts
@@ -242,6 +242,14 @@ export const LINK_AUDIT_COMPOSITION_ROOTS: readonly LinkAuditCompositionRoot[] =
},
{
path: 'packages/app/src/editor/TiptapEditor.tsx',
- requiredText: "ext.name === 'imageReference'",
+ requiredText: 'scopeExtensionsToDocument(sharedExtensions,',
+ },
+ {
+ path: 'packages/app/src/components/RenderedDiffView.tsx',
+ requiredText: 'scopeExtensionsToDocument(diffExtensions, docName)',
+ },
+ {
+ path: 'packages/app/src/editor/extensions/shared.ts',
+ requiredText: " 'imageReference',",
},
];