Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
client: fix an issue
Adorian Doran2929c5497531
diff --git a/apps/client/src/services/content_renderer.spec.ts b/apps/client/src/services/content_renderer.spec.tsindex cb2e612cf0..29e1d95cb2 100644--- a/apps/client/src/services/content_renderer.spec.ts+++ b/apps/client/src/services/content_renderer.spec.ts@@ -133,6 +133,7 @@ import type { SaveState } from "../components/note_context.js";import FAttachment from "../entities/fattachment.js";import { buildNote } from "../test/easy-froca.js";import {+ addContentDisposer,CONTENT_RENDERERS,disposeInteractiveContent,getEmbedBoxSize,@@ -1167,6 +1168,21 @@ describe("interactive content disposal", () => {expect($renderedContent.find("[data-interactive-mount]").length).toBe(0);expect(() => disposeInteractiveContent($renderedContent)).not.toThrow();});++ it("runs every registered disposer once, the root's own included", () => {+ const $root = $("<div>");+ const child = $("<div>").appendTo($root)[0];+ const disposers = [ vi.fn(), vi.fn(), vi.fn() ];+ addContentDisposer($root[0], disposers[0]);+ addContentDisposer(child, disposers[1]);+ addContentDisposer(child, disposers[2]);++ disposeInteractiveContent($root);+ disposeInteractiveContent($root);+ for (const dispose of disposers) {+ expect(dispose).toHaveBeenCalledTimes(1);+ }+ });});describe("defensive guards for entities that are neither FNote nor FAttachment", () => {diff --git a/apps/client/src/services/content_renderer.ts b/apps/client/src/services/content_renderer.tsindex 6b341d89bd..ce482ceefa 100644--- a/apps/client/src/services/content_renderer.ts+++ b/apps/client/src/services/content_renderer.ts@@ -891,14 +891,38 @@ export async function mountInteractiveWidget(vnode: JSX.Element, container: HTML* into the given content, running their cleanup — `useTriliumEvent` unsubscribe, Bootstrap dropdown* disposal, map teardown. A caller embedding interactive content must call this when it replaces or* discards that content, otherwise the standalone Preact roots leak. Safe (no-op) for content with no- * interactive widgets.+ * interactive widgets. It also runs the disposers that {@link addContentDisposer} registered in the+ * content.*/export function disposeInteractiveContent($renderedContent: JQuery<HTMLElement>) {for (const el of $renderedContent.find(`[${INTERACTIVE_MOUNT_ATTR}]`).toArray()) {render(null, el);}++ const disposable = `[${DISPOSER_ATTR}]`;+ for (const el of $renderedContent.find(disposable).addBack(disposable).toArray()) {+ for (const dispose of contentDisposers.get(el) ?? []) {+ dispose();+ }+ contentDisposers.delete(el);+ el.removeAttribute(DISPOSER_ATTR);+ }}+/**+ * Registers `dispose` to run when {@link disposeInteractiveContent} discards the rendered content+ * that holds `element`, such as a pass that keeps observing the content.+ */+export function addContentDisposer(element: HTMLElement, dispose: () => void) {+ element.setAttribute(DISPOSER_ATTR, "");+ contentDisposers.set(element, [ ...(contentDisposers.get(element) ?? []), dispose ]);+}++/** Marks an element that holds disposers from {@link addContentDisposer}. */+const DISPOSER_ATTR = "data-content-disposer";++const contentDisposers = new WeakMap<Element, (() => void)[]>();+/*** Mounts a collection — a book or a saved search — as the live {@link EmbeddedNoteList}, the same* results widget used in the note detail (grid/list/table/board/calendar/map/presentation). Used bydiff --git a/apps/client/src/services/content_renderer_text.spec.ts b/apps/client/src/services/content_renderer_text.spec.tsindex 30e5e48ce9..8b55cd068b 100644--- a/apps/client/src/services/content_renderer_text.spec.ts+++ b/apps/client/src/services/content_renderer_text.spec.ts@@ -53,13 +53,15 @@ vi.mock("./math.js", async (importOriginal) => {};});-const applyStickyTableHeaders = vi.hoisted(() => vi.fn());+const disposeStickyTableHeaders = vi.hoisted(() => vi.fn());+const applyStickyTableHeaders = vi.hoisted(() => vi.fn(() => disposeStickyTableHeaders));vi.mock("@triliumnext/ckeditor5/src/plugins/table_sticky_header_read_only.js", () => ({applyStickyTableHeaders}));// jsdom has no `ResizeObserver`.-const watchScrollFade = vi.hoisted(() => vi.fn());+const scrollFade = vi.hoisted(() => ({ measure: vi.fn(), disconnect: vi.fn() }));+const watchScrollFade = vi.hoisted(() => vi.fn(() => scrollFade));vi.mock("@triliumnext/commons/src/lib/scroll_fade.js", async (importOriginal) => ({...await importOriginal<object>(),watchScrollFade@@ -295,6 +297,11 @@ describe("Text content renderer", () => {expect(watchScrollFade).toHaveBeenCalledWith(full.querySelector("figure.table"),expect.any(Function), { direction: "horizontal" });+ // Both passes stop with the rest of the rendered content.+ content_renderer.disposeInteractiveContent($(full));+ expect(scrollFade.disconnect).toHaveBeenCalledTimes(1);+ expect(disposeStickyTableHeaders).toHaveBeenCalledTimes(1);+// The excerpt of a table in one column of a layout has the table at its top level.const excerpt = document.createElement("div");const layout = `<div class="${MULTICOLUMN_LAYOUT_CLASS}">`diff --git a/apps/client/src/services/content_renderer_text.ts b/apps/client/src/services/content_renderer_text.tsindex 4d2123bc7e..12c5bd0cb9 100644--- a/apps/client/src/services/content_renderer_text.ts+++ b/apps/client/src/services/content_renderer_text.ts@@ -11,7 +11,9 @@ import {import FAttachment from "../entities/fattachment.js";import FNote from "../entities/fnote.js";import { highlightBlockReference } from "./block_reference.js";-import { default as content_renderer, type RenderOptions } from "./content_renderer.js";+import {+ addContentDisposer, default as content_renderer, type RenderOptions+} from "./content_renderer.js";import froca from "./froca.js";import { t } from "./i18n.js";import { applyNoteImageVersions, resolveContentImageUrls } from "./image_urls.js";@@ -50,8 +52,8 @@ export async function renderTextContent(.addClass("block-reference-broken").text(t("block_reference.broken")));} else if (hasContent) {- applyTableScroll($content[0]);- applyStickyTableHeaders($content[0]);+ addContentDisposer($content[0], applyTableScroll($content[0]));+ addContentDisposer($content[0], applyStickyTableHeaders($content[0]));// Runs before `postProcessRichContent()` renders embeds, so their blocks are not searched.if (options.highlightBlock) {highlightBlockReference($content[0], options.highlightBlock);diff --git a/apps/client/src/widgets/type_widgets/text/ReadOnlyText.spec.tsx b/apps/client/src/widgets/type_widgets/text/ReadOnlyText.spec.tsxindex 4bb80cb3f6..be1a3b9155 100644--- a/apps/client/src/widgets/type_widgets/text/ReadOnlyText.spec.tsx+++ b/apps/client/src/widgets/type_widgets/text/ReadOnlyText.spec.tsx@@ -47,7 +47,8 @@ vi.mock("./utils", async (importOriginal) => ({loadEmbeddedNote}));-const applyStickyTableHeaders = vi.hoisted(() => vi.fn());+const disposeStickyTableHeaders = vi.hoisted(() => vi.fn());+const applyStickyTableHeaders = vi.hoisted(() => vi.fn(() => disposeStickyTableHeaders));vi.mock("@triliumnext/ckeditor5/src/plugins/table_sticky_header_read_only.js", () => ({applyStickyTableHeaders}));@@ -454,7 +455,10 @@ describe("ReadOnlyText tables", () => {expect(figure?.style.getPropertyValue("--table-width")).toBe("calc(var(--table-reference-width, 100%) * 150 / 100)");expect(applyStickyTableHeaders).toHaveBeenCalledWith(figure?.parentElement);++ disposeStickyTableHeaders.mockClear();await act(async () => render(null, harness.container));+ expect(disposeStickyTableHeaders).toHaveBeenCalledTimes(1);harness.container.remove();});});diff --git a/apps/client/src/widgets/type_widgets/text/ReadOnlyText.tsx b/apps/client/src/widgets/type_widgets/text/ReadOnlyText.tsxindex bf4356d93c..88055e5db7 100644--- a/apps/client/src/widgets/type_widgets/text/ReadOnlyText.tsx+++ b/apps/client/src/widgets/type_widgets/text/ReadOnlyText.tsx@@ -151,11 +151,16 @@ export function ReadOnlyTextContent({]));applyNoteImageVersions(container);- applyTableScroll(container);- applyStickyTableHeaders(container);+ const disposeTableScroll = applyTableScroll(container);+ const disposeStickyTableHeaders = applyStickyTableHeaders(container);applyMath(container);applyTabs(container, { placeholder: t("text-editor.ck.tab-title") });setupImageOpening(container, true);++ return () => {+ disposeTableScroll();+ disposeStickyTableHeaders();+ };}, [ html, noteId, ntxId, contentRef ]);useEffect(() => {diff --git a/packages/ckeditor5/src/plugins/table_scroll_read_only.spec.ts b/packages/ckeditor5/src/plugins/table_scroll_read_only.spec.tsindex 22f48ebfd4..e0e1d8cfd1 100644--- a/packages/ckeditor5/src/plugins/table_scroll_read_only.spec.ts+++ b/packages/ckeditor5/src/plugins/table_scroll_read_only.spec.ts@@ -149,6 +149,22 @@ describe("applyTableScroll", () => {.toBe("to left");});+ it("stops fading once disposed, and fades again on a later pass", async () => {+ const container = renderContent("", 600);+ container.innerHTML = tableFigure("width:150%;");+ const dispose = applyTableScroll(container);+ const figure = firstFigure(container);+ expect(fadeClasses(figure)).toContain("scroll-fade-end");++ dispose();+ dispose();+ await scrollFigure(figure, 300);+ expect(fadeClasses(figure)).not.toContain("scroll-fade-start");++ applyTableScroll(container);+ expect(fadeClasses(figure)).toContain("scroll-fade-start");+ });+it("starts fading once detached content is attached", async () => {const container = document.createElement("div");container.className = "ck-content";diff --git a/packages/ckeditor5/src/plugins/table_scroll_read_only.ts b/packages/ckeditor5/src/plugins/table_scroll_read_only.tsindex 217c635cc2..8d2b7c0193 100644--- a/packages/ckeditor5/src/plugins/table_scroll_read_only.ts+++ b/packages/ckeditor5/src/plugins/table_scroll_read_only.ts@@ -1,5 +1,6 @@import {- getScrollFadeClasses, SCROLL_FADE_CLASSES, type ScrollFadeState, watchScrollFade+ getScrollFadeClasses, SCROLL_FADE_CLASSES, type ScrollFadeState, type ScrollFadeWatch,+ watchScrollFade} from "@triliumnext/commons/src/lib/scroll_fade.js";/**@@ -10,7 +11,8 @@ import {* on the figure, so a copied table keeps it. `scroll_fade.css` fades the edges that a scrolling* table continues past.*- * The module imports nothing from CKEditor, so pages that only display content can load it.+ * Returns a function that stops watching the tables for their fades. The module imports nothing+ * from CKEditor, so pages that only display content can load it.*/export function applyTableScroll(container: Element) {const selector = "figure.table:not(.layout-table)";@@ -19,10 +21,23 @@ export function applyTableScroll(container: Element) {for (const figure of figures) {figure.style.setProperty("--table-width", toReferenceWidth(figure.style.width));}+// After every width is set, so that only the first measurement lays out the page.+ const started: [HTMLElement, ScrollFadeWatch][] = [];for (const figure of figures) {- fadeEdges(figure);+ if (!fades.has(figure)) {+ const fade = fadeEdges(figure);+ fades.set(figure, fade);+ started.push([ figure, fade ]);+ }}++ return () => {+ for (const [ figure, fade ] of started.splice(0)) {+ fade.disconnect();+ fades.delete(figure);+ }+ };}/** The `scroll_fade.css` classes of a table in `state`, none while it fits. */@@ -30,15 +45,11 @@ export function getTableFadeClasses(state: ScrollFadeState) {return state.overflow > 0 ? getScrollFadeClasses("horizontal", state) : [];}-/** The figures whose edges fade, so that a second pass over the same content adds no watcher. */-const fadedFigures = new WeakSet<HTMLElement>();+/** The fade of each figure, so that a second pass over the same content adds no watcher. */+const fades = new WeakMap<HTMLElement, ScrollFadeWatch>();function fadeEdges(figure: HTMLElement) {- if (fadedFigures.has(figure)) {- return;- }- fadedFigures.add(figure);- watchScrollFade(figure, (state) => {+ return watchScrollFade(figure, (state) => {figure.classList.remove(...SCROLL_FADE_CLASSES);figure.classList.add(...getTableFadeClasses(state));}, { direction: "horizontal" });diff --git a/packages/ckeditor5/src/plugins/table_sticky_header_read_only.spec.ts b/packages/ckeditor5/src/plugins/table_sticky_header_read_only.spec.tsindex 721a496095..203589a9a6 100644--- a/packages/ckeditor5/src/plugins/table_sticky_header_read_only.spec.ts+++ b/packages/ckeditor5/src/plugins/table_sticky_header_read_only.spec.ts@@ -93,6 +93,20 @@ describe("applyStickyTableHeaders", () => {expect(topIn(scroller, thead)).toBeCloseTo(0, 0);});+ it("stops measuring the header rows once disposed", async () => {+ const { content } = renderContent(tableFigure(1, 20));+ const dispose = applyStickyTableHeaders(content);+ await settle();++ const { table, thead } = parts(content);+ const travel = lengthOf(thead, TRAVEL_PROPERTY);+ dispose();+ const row = table.tBodies[0].rows[0];+ row.after(row.cloneNode(true));+ await settle();+ expect(lengthOf(thead, TRAVEL_PROPERTY)).toBe(travel);+ });+it("sticks below the scroll padding of the scrolled area", async () => {const { scroller, content } = renderContent(tableFigure(1, 20));scroller.style.scrollPaddingTop = "30px";diff --git a/packages/ckeditor5/src/plugins/table_sticky_header_read_only.ts b/packages/ckeditor5/src/plugins/table_sticky_header_read_only.tsindex e28866f31c..1da5bfda15 100644--- a/packages/ckeditor5/src/plugins/table_sticky_header_read_only.ts+++ b/packages/ckeditor5/src/plugins/table_sticky_header_read_only.ts@@ -11,9 +11,14 @@ export const START_PROPERTY = "--table-header-start";/** The distance from the bottom of the header rows to the bottom of the table. */export const TRAVEL_PROPERTY = "--table-header-travel";-/** Keeps the header rows of the tables in `container` in view while it scrolls. */+/**+ * Keeps the header rows of the tables in `container` in view while it scrolls. Returns a function+ * that stops measuring them.+ */export function applyStickyTableHeaders(container: Element) {- new StickyTableHeaders().observe(container);+ const headers = new StickyTableHeaders();+ headers.observe(container);+ return () => headers.disconnect();}/** Measures header rows again whenever their figure or the rows themselves change size. */