Skip to content

Build your personal knowledge base with Trilium Notes

fix(render): keep script modals above app chrome (closes #11847)

tollenceld93f431c68a3e
diff --git a/apps/client/src/services/frontend_script_api_preact.spec.ts b/apps/client/src/services/frontend_script_api_preact.spec.ts
index 1280112273..a918c74cc8 100644
--- a/apps/client/src/services/frontend_script_api_preact.spec.ts
+++ b/apps/client/src/services/frontend_script_api_preact.spec.ts
@@ -1,6 +1,7 @@
import { Fragment, h, render as renderPreact } from "preact";
import { describe, expect, it } from "vitest";
+import { ScriptModal } from "../widgets/react/Modal.js";
import { preactAPI } from "./frontend_script_api_preact.js";
describe("preactAPI", () => {
@@ -19,6 +20,7 @@ describe("preactAPI", () => {
// Spread preact hooks land directly on the object.
expect(typeof (preactAPI as Record<string, unknown>).useState).toBe("function");
expect(typeof (preactAPI as Record<string, unknown>).useEffect).toBe("function");
+ expect(preactAPI.Modal).toBe(ScriptModal);
});
it("applies compat's `defaultProps` and `px` units to what scripts render through `h`", () => {
diff --git a/apps/client/src/services/frontend_script_api_preact.ts b/apps/client/src/services/frontend_script_api_preact.ts
index 0a999d84e5..2069cc6aae 100644
--- a/apps/client/src/services/frontend_script_api_preact.ts
+++ b/apps/client/src/services/frontend_script_api_preact.ts
@@ -29,7 +29,7 @@ import * as triliumHooks from "../widgets/react/hooks";
import Icon from "../widgets/react/Icon";
import LinkButton from "../widgets/react/LinkButton";
import LoadingSpinner from "../widgets/react/LoadingSpinner";
-import Modal from "../widgets/react/Modal";
+import { ScriptModal } from "../widgets/react/Modal";
import NoteAutocomplete from "../widgets/react/NoteAutocomplete";
import NoteLink from "../widgets/react/NoteLink";
import RawHtml from "../widgets/react/RawHtml";
@@ -99,7 +99,7 @@ export const preactAPI = Object.freeze({
Icon,
LinkButton,
LoadingSpinner,
- Modal,
+ Modal: ScriptModal,
NoteAutocomplete,
NoteColorPicker,
NoteLink,
diff --git a/apps/client/src/services/render.spec.tsx b/apps/client/src/services/render.spec.tsx
index ff7f2b09b0..c4e3e98cbd 100644
--- a/apps/client/src/services/render.spec.tsx
+++ b/apps/client/src/services/render.spec.tsx
@@ -9,8 +9,10 @@ vi.mock("./bundle.js", () => ({
// Spy on the actual JSX rendering so we don't depend on Preact mounting.
const renderAtElementMock = vi.fn();
+const disposeMock = vi.fn();
vi.mock("../widgets/react/react_utils.jsx", () => ({
- renderReactWidgetAtElement: (...args: unknown[]) => renderAtElementMock(...args)
+ renderReactWidgetAtElement: (...args: unknown[]) => renderAtElementMock(...args),
+ disposeReactWidget: (...args: unknown[]) => disposeMock(...args)
}));
import FAttribute from "../entities/fattribute.js";
@@ -72,6 +74,7 @@ describe("render", () => {
expect(result).toBe(false);
expect($el.children().length).toBe(0);
+ expect(disposeMock).toHaveBeenCalledWith($el[0]);
expect($el.css("display")).toBe("none");
expect(server.postWithSilentInternalServerError).not.toHaveBeenCalled();
});
@@ -261,6 +264,24 @@ describe("render", () => {
expect(renderAtElementMock.mock.calls[0][0]).toBe(closest);
expect(renderAtElementMock.mock.calls[0][2]).toBe($el[0]);
});
+
+ it("does not mount a script modal after its render note was cancelled", async () => {
+ const target = buildNote({ title: "Target", type: "code" });
+ target.mime = "text/jsx";
+ const note = buildNote({ title: "Host", "~renderNote": target.noteId });
+ let finishExecution: ((value: unknown) => void) | undefined;
+ executeMock.mockReturnValue(new Promise(resolve => { finishExecution = resolve; }));
+ const controller = new AbortController();
+ const $el = $("<div class='component'>");
+ Object.assign(glob, { getComponentByEl: vi.fn(() => ({ fake: "component" })) });
+
+ await render(note, $el, vi.fn(), controller.signal);
+ controller.abort();
+ finishExecution?.(() => null);
+ await flush();
+
+ expect(renderAtElementMock).not.toHaveBeenCalled();
+ });
});
describe("renderIfJsx", () => {
diff --git a/apps/client/src/services/render.tsx b/apps/client/src/services/render.tsx
index b5d07abe3b..73dbbd9102 100644
--- a/apps/client/src/services/render.tsx
+++ b/apps/client/src/services/render.tsx
@@ -1,7 +1,7 @@
import { Component, h, VNode } from "preact";
import type FNote from "../entities/fnote.js";
-import { renderReactWidgetAtElement } from "../widgets/react/react_utils.jsx";
+import { disposeReactWidget, renderReactWidgetAtElement } from "../widgets/react/react_utils.jsx";
import { type Bundle, executeBundleWithoutErrorHandling } from "./bundle.js";
import froca from "./froca.js";
import { keepStylesScoped, RENDER_SCOPE_CLASS } from "./render_css_scope.js";
@@ -12,10 +12,11 @@ import server from "./server.js";
*/
type ErrorHandler = (e: unknown, noteId?: string) => void;
-export async function render(note: FNote, $el: JQuery<HTMLElement>, onError?: ErrorHandler) {
+export async function render(note: FNote, $el: JQuery<HTMLElement>, onError?: ErrorHandler, signal?: AbortSignal) {
const relations = note.getRelations("renderNote");
const renderNoteIds = relations.map((rel) => rel.value).filter((noteId) => noteId);
+ disposeReactWidget($el[0]);
$el.empty().toggle(renderNoteIds.length > 0);
let currentRenderNoteId: string | undefined;
@@ -23,6 +24,7 @@ export async function render(note: FNote, $el: JQuery<HTMLElement>, onError?: Er
for (const renderNoteId of renderNoteIds) {
currentRenderNoteId = renderNoteId;
const bundle = await server.postWithSilentInternalServerError<Bundle>(`script/bundle/${renderNoteId}`);
+ if (signal?.aborted) return;
if (!bundle) {
throw new Error(`Script note '${renderNoteId}' could not be loaded. It may be protected and require an active protected session.`);
@@ -35,18 +37,20 @@ export async function render(note: FNote, $el: JQuery<HTMLElement>, onError?: Er
keepStylesScoped($scriptContainer[0]);
// async so that scripts cannot block trilium execution
- executeBundleWithoutErrorHandling(bundle, note, $scriptContainer)
- .catch((e) => onError?.(e, renderNoteId))
+ void executeBundleWithoutErrorHandling(bundle, note, $scriptContainer)
+ .catch((e) => { if (!signal?.aborted) onError?.(e, renderNoteId); })
.then(result => {
+ if (signal?.aborted) return;
// Render JSX
if (bundle.html === "") {
- renderIfJsx(bundle, result, $el, onError).catch((e) => onError?.(e, bundle.noteId));
+ renderIfJsx(bundle, result, $el, onError, signal).catch((e) => { if (!signal?.aborted) onError?.(e, bundle.noteId); });
}
});
}
return renderNoteIds.length > 0;
} catch (e) {
+ if (signal?.aborted) return;
if (typeof e === "string" && e.startsWith("{") && e.endsWith("}")) {
try {
onError?.(JSON.parse(e), currentRenderNoteId);
@@ -59,9 +63,10 @@ export async function render(note: FNote, $el: JQuery<HTMLElement>, onError?: Er
}
}
-export async function renderIfJsx(bundle: Bundle, result: unknown, $el: JQuery<HTMLElement>, onError?: ErrorHandler) {
+export async function renderIfJsx(bundle: Bundle, result: unknown, $el: JQuery<HTMLElement>, onError?: ErrorHandler, signal?: AbortSignal) {
// Ensure the root script note is actually a JSX.
const rootScriptNoteId = await froca.getNote(bundle.noteId);
+ if (signal?.aborted) return;
if (rootScriptNoteId?.mime !== "text/jsx") return;
// Ensure the output is a valid el.
diff --git a/apps/client/src/widgets/react/Modal.spec.tsx b/apps/client/src/widgets/react/Modal.spec.tsx
index b5a82d8f6f..2ba5c894dc 100644
--- a/apps/client/src/widgets/react/Modal.spec.tsx
+++ b/apps/client/src/widgets/react/Modal.spec.tsx
@@ -1,5 +1,5 @@
-import { render } from "preact";
-import { useState } from "preact/hooks";
+import { createContext, render } from "preact";
+import { useContext, useState } from "preact/hooks";
import { act } from "preact/test-utils";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
@@ -46,7 +46,7 @@ vi.mock("./modal_focustrap", () => ({
suspendModalFocusTraps: mocks.suspendModalFocusTraps
}));
-import Modal from "./Modal";
+import Modal, { ScriptModal } from "./Modal";
let container: HTMLDivElement;
@@ -80,6 +80,39 @@ function DialogWithTypedInto({ show, onHidden }: { show: boolean; onHidden(): vo
}
describe("Modal", () => {
+ it("mounts a script modal above a contained render note while preserving context and cleanup", async () => {
+ const Context = createContext("missing");
+ const onClick = vi.fn();
+
+ function Content() {
+ return <button onClick={onClick}>{useContext(Context)}</button>;
+ }
+
+ container.style.contain = "size";
+ container.style.overflow = "auto";
+ await act(async () => {
+ render(<Context.Provider value="from render note">
+ <ScriptModal className="script-dialog" size="md" show onHidden={() => {}}>
+ <Content />
+ </ScriptModal>
+ </Context.Provider>, container);
+ });
+
+ const dialog = document.querySelector<HTMLElement>(".script-dialog");
+ expect(dialog?.parentElement).toBe(document.body);
+ expect(container.contains(dialog)).toBe(false);
+ expect(mocks.openDialog).toHaveBeenCalledWith(expect.anything(), true, { focus: true }, undefined);
+
+ const button = dialog?.querySelector<HTMLButtonElement>(".modal-body button");
+ expect(button?.textContent).toBe("from render note");
+ await act(async () => button?.click());
+ expect(onClick).toHaveBeenCalledOnce();
+
+ await act(async () => render(null, container));
+ expect(document.querySelector(".script-dialog")).toBeNull();
+ expect(mocks.hide).toHaveBeenCalled();
+ });
+
/**
* The bug this pins: `modalRef.current` stood among the effect's dependencies, and a ref holds
* nothing while the render that names them runs and the element by the time the effect does —
diff --git a/apps/client/src/widgets/react/Modal.tsx b/apps/client/src/widgets/react/Modal.tsx
index 2bddd14327..3f00a2719c 100644
--- a/apps/client/src/widgets/react/Modal.tsx
+++ b/apps/client/src/widgets/react/Modal.tsx
@@ -2,7 +2,7 @@ import "./Modal.css";
import { Modal as BootstrapModal } from "bootstrap";
import clsx from "clsx";
-import { ComponentChildren, CSSProperties, RefObject } from "preact";
+import { ComponentChildren, createPortal, CSSProperties, RefObject } from "preact";
import { useEffect, useLayoutEffect, useMemo, useRef } from "preact/hooks";
import appContext from "../../components/app_context";
@@ -107,6 +107,11 @@ export interface ModalProps {
ariaLabel?: string;
}
+/** Mounts a modal opened by a script alongside Bootstrap's body-level backdrop. */
+export function ScriptModal(props: ModalProps) {
+ return createPortal(<Modal {...props} />, document.body);
+}
+
export default function Modal({ children, className, size, title, customTitleBarButtons: titleBarButtons, header, footer, footerStyle, footerAlignment, onShown, onSubmit, helpPageId, minWidth, maxWidth, zIndex, scrollable, onHidden, modalRef: externalModalRef, formRef, bodyStyle, show, stackable, keepInDom, noFocus, sidebar, hideSidebarHeader, isFullPageOnMobile, ariaLabel }: ModalProps) {
const modalRef = useSyncedRef<HTMLDivElement>(externalModalRef);
const modalInstanceRef = useRef<BootstrapModal | undefined>(undefined);
diff --git a/apps/client/src/widgets/type_widgets/Render.tsx b/apps/client/src/widgets/type_widgets/Render.tsx
index c25b8da43a..217b9d53a4 100644
--- a/apps/client/src/widgets/type_widgets/Render.tsx
+++ b/apps/client/src/widgets/type_widgets/Render.tsx
@@ -1,6 +1,6 @@
import "./Render.css";
-import { useEffect, useRef, useState } from "preact/hooks";
+import { useCallback, useEffect, useRef, useState } from "preact/hooks";
import FNote from "../../entities/fnote";
import attributes from "../../services/attributes";
@@ -13,7 +13,7 @@ import FormGroup from "../react/FormGroup";
import { FormListItem } from "../react/FormList";
import { useNoteRelation, useTriliumEvent } from "../react/hooks";
import NoteAutocomplete from "../react/NoteAutocomplete";
-import { refToJQuerySelector } from "../react/react_utils";
+import { disposeReactWidget, refToJQuerySelector } from "../react/react_utils";
import RenderErrorCard from "../react/RenderErrorCard";
import SetupForm from "./helpers/SetupForm";
import { TypeWidgetProps } from "./type_widget";
@@ -48,15 +48,26 @@ export default function Render(props: TypeWidgetProps) {
function RenderContent({ note, noteContext, ntxId }: TypeWidgetProps) {
const contentRef = useRef<HTMLDivElement>(null);
+ const renderController = useRef<AbortController | null>(null);
const [ error, setError ] = useState<{ error: unknown; noteId?: string } | null>(null);
- function refresh() {
- if (!contentRef) return;
+ const refresh = useCallback(() => {
+ if (!contentRef.current) return;
+ renderController.current?.abort();
+ const controller = new AbortController();
+ renderController.current = controller;
setError(null);
- render.render(note, refToJQuerySelector(contentRef), (e, noteId) => setError({ error: e, noteId }));
- }
+ void render.render(note, refToJQuerySelector(contentRef), (e, noteId) => setError({ error: e, noteId }), controller.signal);
+ }, [ note ]);
- useEffect(refresh, [ note ]);
+ useEffect(() => {
+ refresh();
+ const container = contentRef.current;
+ return () => {
+ renderController.current?.abort();
+ if (container) disposeReactWidget(container);
+ };
+ }, [ refresh ]);
// Keyboard shortcut.
useTriliumEvent("renderActiveNote", () => {