Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Keep freezing headers of tables inside an Accordion (PRD-9328) (#6232)

Andrew Mikofalvy5b8a2e30b794
diff --git a/knip.config.ts b/knip.config.ts
index 0004a763a..69344114d 100644
--- a/knip.config.ts
+++ b/knip.config.ts
@@ -149,15 +149,11 @@ export default {
'packages/server': {
entry: ['src/**/*.test.ts', 'src/parse-worker.ts'],
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/src/editor/extensions/frozen-table-headers.ts b/packages/app/src/editor/extensions/frozen-table-headers.ts
index 3e3c63ad9..06e9a92a7 100644
--- a/packages/app/src/editor/extensions/frozen-table-headers.ts
+++ b/packages/app/src/editor/extensions/frozen-table-headers.ts
@@ -81,7 +81,7 @@ const appliedFreezes = new WeakMap<HTMLTableCellElement, AppliedFreeze>();
const skippedChunks = new WeakSet<Element>();
-const wrapperTimelines = new WeakMap<HTMLElement, { inset: number; timeline: ViewTimelineLike }>();
+const wrapperTimelines = new WeakMap<HTMLElement, ViewTimelineLike | 'scroll-events'>();
function cancelFreeze(cell: HTMLTableCellElement): void {
const prev = appliedFreezes.get(cell);
@@ -228,19 +228,18 @@ function applyInstantFreeze(cell: HTMLTableCellElement, shift: number): void {
appliedFreezes.set(cell, { key, animations: [animation, occluderAnimation] });
}
-let viewTimelineSourceMismatchWarned = false;
+let nestedScrollerWarned = false;
function wrapperTimeline(wrapper: HTMLElement, scrollEl: HTMLElement): ViewTimelineLike | null {
if (!ViewTimelineImpl || !viewTimelinesUsable) return null;
- const inset = editorToolbarOverlapPx();
const cached = wrapperTimelines.get(wrapper);
- if (cached?.inset === inset) return cached.timeline;
+ if (cached) return cached === 'scroll-events' ? null : cached;
let timeline: ViewTimelineLike;
try {
timeline = new ViewTimelineImpl({
subject: wrapper,
axis: 'block',
- inset: [CSS.px(inset), CSS.px(0)],
+ inset: [CSS.px(editorToolbarOverlapPx()), CSS.px(0)],
});
} catch (error) {
viewTimelinesUsable = false;
@@ -253,15 +252,16 @@ function wrapperTimeline(wrapper: HTMLElement, scrollEl: HTMLElement): ViewTimel
return null;
}
if (timeline.source !== scrollEl) {
- if (import.meta.env.DEV && !viewTimelineSourceMismatchWarned) {
- viewTimelineSourceMismatchWarned = true;
+ wrapperTimelines.set(wrapper, 'scroll-events');
+ if (import.meta.env.DEV && !nestedScrollerWarned) {
+ nestedScrollerWarned = true;
console.warn(
- '[frozen-table-headers] a table wrapper resolves to a scroll container other than editor-scroll-container; its header will not freeze',
+ '[frozen-table-headers] a table sits inside a scroll container other than editor-scroll-container; its header freezes from scroll events on the main thread',
);
}
return null;
}
- wrapperTimelines.set(wrapper, { inset, timeline });
+ wrapperTimelines.set(wrapper, timeline);
return timeline;
}
@@ -277,11 +277,12 @@ function computeAndApplyFrozenHeaders(
scrollEl: HTMLElement,
editorDom: HTMLElement,
isRenderingSkipped: (table: HTMLTableElement) => boolean,
-): void {
+): boolean {
const containerTop = scrollEl.getBoundingClientRect().top;
const scrollTop = scrollEl.scrollTop;
const scrollportHeight = scrollEl.clientHeight - editorToolbarOverlapPx();
const measured: MeasuredHeader[] = [];
+ let followsScrollEvents = false;
for (const table of editorDom.querySelectorAll<HTMLTableElement>('.tableWrapper > table')) {
const wrapper = table.parentElement;
const firstRow = table.querySelector('tbody')?.rows[0];
@@ -301,25 +302,24 @@ function computeAndApplyFrozenHeaders(
for (const { firstRow, wrapper, wrapperRect, tableRect, headerHeight } of measured) {
const cells = Array.from(firstRow.cells) as HTMLTableCellElement[];
- if (viewTimelinesUsable) {
- const freeze = computeWrapperFreeze(
- wrapperRect.top,
- wrapperRect.height,
- tableRect.top,
- tableRect.height,
- headerHeight,
- scrollportHeight,
- );
- const timeline = freeze ? wrapperTimeline(wrapper, scrollEl) : null;
- if (freeze && timeline) {
- for (const cell of cells) applyViewTimelineFreeze(cell, timeline, freeze);
- continue;
- }
- if (viewTimelinesUsable) {
- resetHeaderCells(firstRow);
- continue;
- }
+ const freeze = computeWrapperFreeze(
+ wrapperRect.top,
+ wrapperRect.height,
+ tableRect.top,
+ tableRect.height,
+ headerHeight,
+ scrollportHeight,
+ );
+ if (!freeze) {
+ resetHeaderCells(firstRow);
+ continue;
+ }
+ const timeline = wrapperTimeline(wrapper, scrollEl);
+ if (timeline) {
+ for (const cell of cells) applyViewTimelineFreeze(cell, timeline, freeze);
+ continue;
}
+ followsScrollEvents = true;
const range = computeFreezeRange(
scrollTop,
@@ -335,6 +335,7 @@ function computeAndApplyFrozenHeaders(
}
for (const cell of cells) applyInstantFreeze(cell, shift);
}
+ return followsScrollEvents;
}
export const FrozenTableHeaders = Extension.create({
@@ -351,6 +352,7 @@ export const FrozenTableHeaders = Extension.create({
let driftTimer: ReturnType<typeof setTimeout> | null = null;
let resizeObserver: ResizeObserver | null = null;
let destroyed = false;
+ let followsScrollEvents = false;
const editorDom = editorView.dom as HTMLElement;
const isRenderingSkipped = (table: HTMLTableElement): boolean => {
@@ -362,7 +364,11 @@ export const FrozenTableHeaders = Extension.create({
const run = (): void => {
if (destroyed || !scrollEl) return;
- computeAndApplyFrozenHeaders(scrollEl, editorDom, isRenderingSkipped);
+ followsScrollEvents = computeAndApplyFrozenHeaders(
+ scrollEl,
+ editorDom,
+ isRenderingSkipped,
+ );
};
const scheduleRun = (): void => {
@@ -388,7 +394,7 @@ export const FrozenTableHeaders = Extension.create({
});
const onScroll = (): void => {
- if (viewTimelinesUsable) {
+ if (!followsScrollEvents) {
if (driftTimer == null) scheduleRun();
if (driftTimer != null) clearTimeout(driftTimer);
driftTimer = setTimeout(() => {
diff --git a/packages/app/src/globals.css b/packages/app/src/globals.css
index 61af6dea9..311501ff7 100644
--- a/packages/app/src/globals.css
+++ b/packages/app/src/globals.css
@@ -5215,7 +5215,7 @@ html.electron-mode [data-slot="sidebar-inner"] {
border: 1px solid var(--border);
background: var(--background);
margin: 0.5rem 0;
- overflow: hidden;
+ overflow: clip;
@apply rounded-lg;
}
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 4549c74b3..a50b00123 100644
--- a/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
+++ b/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
@@ -1,4 +1,3 @@
-
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 4fc2c11f9..6fcdc23f2 100644
--- a/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
+++ b/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
@@ -1,4 +1,3 @@
-
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 9f2f6feb6..40b5cdfd6 100644
--- a/packages/app/tests/integration/interior-edit-freshness.test.ts
+++ b/packages/app/tests/integration/interior-edit-freshness.test.ts
@@ -1,4 +1,3 @@
-
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 2a085742b..93666af70 100644
--- a/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
+++ b/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
@@ -1,4 +1,3 @@
-
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 878d5196b..867598d34 100644
--- a/packages/app/tests/integration/producer-guard-wiring.test.ts
+++ b/packages/app/tests/integration/producer-guard-wiring.test.ts
@@ -1,4 +1,3 @@
-
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 4ada3cf26..0970ac12f 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,4 +1,3 @@
-
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 cbe2b705f..b632185e1 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,4 +1,3 @@
-
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 89bc9b4d9..c530ce4ba 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,4 +1,3 @@
-
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/undo-after-rollback.test.ts b/packages/app/tests/integration/undo-after-rollback.test.ts
index a78aeb0e4..d3767adc9 100644
--- a/packages/app/tests/integration/undo-after-rollback.test.ts
+++ b/packages/app/tests/integration/undo-after-rollback.test.ts
@@ -1,4 +1,3 @@
-
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 e7cc69c3f..b076f955c 100644
--- a/packages/app/tests/integration/undo-recycle-reset.test.ts
+++ b/packages/app/tests/integration/undo-recycle-reset.test.ts
@@ -1,4 +1,3 @@
-
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 9ddcd0730..7935e35f8 100644
--- a/packages/app/tests/integration/undo-rederive-survival.test.ts
+++ b/packages/app/tests/integration/undo-rederive-survival.test.ts
@@ -1,4 +1,3 @@
-
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/app/tests/stress/frozen-table-headers.e2e.ts b/packages/app/tests/stress/frozen-table-headers.e2e.ts
index feeed5251..2167d82f3 100644
--- a/packages/app/tests/stress/frozen-table-headers.e2e.ts
+++ b/packages/app/tests/stress/frozen-table-headers.e2e.ts
@@ -768,3 +768,69 @@ test('an editor width change lays out once, not once per table in a skipped chun
);
expect(misplacedBars).toEqual([]);
});
+
+const ACCORDION_TABLE_MARKDOWN = LONG_TABLE_MARKDOWN.replace(
+ '| Metric | Count |',
+ '<Accordion title="Metrics" defaultOpen>\n\n| Metric | Count |',
+).replace('\n\n## Notes', '\n\n</Accordion>\n\n## Notes');
+
+async function scrollIntoAccordionTable(
+ page: Parameters<typeof test>[1]['page'],
+): Promise<Awaited<ReturnType<typeof scrollAndReadFreeze>>> {
+ await page.locator('.accordion table').first().waitFor({ state: 'visible' });
+ await waitForQuiescence(page, SCROLL_SELECTOR);
+ const top = await page.evaluate((sel) => {
+ const scrollEl = document.querySelector(sel) as HTMLElement;
+ const table = document.querySelector('.ProseMirror .accordion .tableWrapper > table');
+ if (!table) return Number.NaN;
+ const offset = table.getBoundingClientRect().top - scrollEl.getBoundingClientRect().top;
+ return Math.round(scrollEl.scrollTop + offset + 200);
+ }, SCROLL_SELECTOR);
+ expect(top).not.toBeNaN();
+ return scrollAndReadFreeze(page, top);
+}
+
+const headerTimelineKinds = (page: Parameters<typeof test>[1]['page']) =>
+ page.evaluate(() => {
+ const cell = (
+ document.querySelector('.ProseMirror .tableWrapper > table > tbody tr') as HTMLTableRowElement
+ ).cells[0];
+ return cell.getAnimations().map((animation) => animation.timeline?.constructor.name ?? 'none');
+ });
+
+test('a table inside an accordion freezes on the compositor like any other', async ({
+ page,
+ api,
+ workerServer,
+}) => {
+ await api.seedDocs([{ name: 'frozen-hdr-accordion', markdown: ACCORDION_TABLE_MARKDOWN }]);
+ await page.goto(`${workerServer.baseURL}/#/frozen-hdr-accordion`);
+ await waitForActiveProviderSynced(page);
+ const state = await scrollIntoAccordionTable(page);
+ expect(state.frozen).toBe(true);
+ expect(state.pinErrorPx).toBeLessThan(2);
+ if (state.syncShiftErrorPx !== null) expect(state.syncShiftErrorPx).toBeLessThan(1.5);
+ expect(await headerTimelineKinds(page)).toEqual(['ViewTimeline', 'ViewTimeline']);
+});
+
+test('a table inside another scroll container still pins its header', async ({
+ page,
+ api,
+ workerServer,
+}) => {
+ await page.addInitScript(() => {
+ document.addEventListener('DOMContentLoaded', () => {
+ const style = document.createElement('style');
+ style.textContent = '.accordion { overflow: hidden !important; }';
+ document.head.append(style);
+ });
+ });
+ await api.seedDocs([{ name: 'frozen-hdr-nested-scroller', markdown: ACCORDION_TABLE_MARKDOWN }]);
+ await page.goto(`${workerServer.baseURL}/#/frozen-hdr-nested-scroller`);
+ await waitForActiveProviderSynced(page);
+ const state = await scrollIntoAccordionTable(page);
+ expect(state.frozen).toBe(true);
+ expect(state.pinErrorPx).toBeLessThan(2);
+ if (state.syncShiftErrorPx !== null) expect(state.syncShiftErrorPx).toBeLessThan(1.5);
+ expect(await headerTimelineKinds(page)).not.toContain('ViewTimeline');
+});
diff --git a/packages/core/src/bridge/compose.ts b/packages/core/src/bridge/compose.ts
index 2a597ec3d..f4cc8a286 100644
--- a/packages/core/src/bridge/compose.ts
+++ b/packages/core/src/bridge/compose.ts
@@ -1,4 +1,3 @@
-
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 ffd8fce06..e7e63f43d 100644
--- a/packages/core/src/bridge/doc-boundary-space.ts
+++ b/packages/core/src/bridge/doc-boundary-space.ts
@@ -1,4 +1,3 @@
-
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 fb0ba5a7c..fc267cbea 100644
--- a/packages/core/src/markdown/comment-promoter.ts
+++ b/packages/core/src/markdown/comment-promoter.ts
@@ -1,4 +1,3 @@
-
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 fa3cfcd86..bfd7e3109 100644
--- a/packages/core/src/markdown/merged-walker.ts
+++ b/packages/core/src/markdown/merged-walker.ts
@@ -1,4 +1,3 @@
-
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 8be632ba4..4d3250d3a 100644
--- a/packages/core/src/markdown/safe-url.ts
+++ b/packages/core/src/markdown/safe-url.ts
@@ -1,4 +1,3 @@
-
export const SAFE_URL_SCHEMES = ['https', 'http', 'mailto', 'tel', 'ftp', 'sms'] as const;
const SCHEME_ALT = SAFE_URL_SCHEMES.map((s) => `${s}:`).join('|');