Add ~330 tests across server (Jest), client (Vitest), editor-ext (Vitest)
and packages/mcp (node:test) for the gitmost features added since
053a9c0d: AI chat, AI agent roles, public-share assistant, MCP per-user
auth, HTML embed, page templates/embed, realtime tree, tree
expand/collapse, and the AI-settings UI.
Test-tooling fixes (prerequisite, were silently hiding coverage):
- Repair 3 page-template specs broken by the 11-arg TransclusionService
constructor; they never compiled, so template access-control / content
-leak / unsync-strip coverage was fictitious.
- Build @docmost/editor-ext before server tests via a `pretest` hook;
the stale dist omitted the new HtmlEmbed/PageEmbed exports (TS2305).
- Let jest resolve the .tsx email templates: add `tsx` to
moduleFileExtensions and widen the ts-jest transform to (t|j)sx?.
Behaviour-preserving "extract pure core" refactors that the tests drive:
- server: resolveShareAssistantRequest + uiMessageTextLength
(public-share controller), decideBasicGate + mapAuthResultToResponse
(mcp), buildErrorAssistantRecord (ai-chat), jsonbObject export (roles).
- client: render-raw-html + shouldExecute/canEdit, decide-embed-state,
page-embed picker utils, tree-socket reducers, open/close branch maps,
isEndpointConfigured/resolveKeyField; buildTreeWithChildren now treats
a permission-trimmed orphan as a root instead of crashing.
Deferred (need a test DB or HTTP harness, documented in the specs):
repo-level Postgres integration tests and the public-share XFF E2E.
Pre-existing DI/lib0-ESM suite failures are untouched and out of scope.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
161 lines
5.9 KiB
TypeScript
161 lines
5.9 KiB
TypeScript
import { NodeViewProps, NodeViewWrapper } from "@tiptap/react";
|
|
import React, { useCallback, useEffect, useRef, useState } from "react";
|
|
import clsx from "clsx";
|
|
import {
|
|
ActionIcon,
|
|
Button,
|
|
Group,
|
|
Modal,
|
|
Text,
|
|
Textarea,
|
|
} from "@mantine/core";
|
|
import { IconCode, IconEdit } from "@tabler/icons-react";
|
|
import { useTranslation } from "react-i18next";
|
|
import { useAtomValue } from "jotai";
|
|
import useUserRole from "@/hooks/use-user-role.tsx";
|
|
import { workspaceAtom } from "@/features/user/atoms/current-user-atom.ts";
|
|
import classes from "./html-embed-view.module.css";
|
|
import {
|
|
canEdit as computeCanEdit,
|
|
renderRawHtml,
|
|
shouldExecute as computeShouldExecute,
|
|
} from "./render-raw-html.ts";
|
|
|
|
export default function HtmlEmbedView(props: NodeViewProps) {
|
|
const { t } = useTranslation();
|
|
const { node, selected, updateAttributes, editor } = props;
|
|
const { source } = node.attrs as { source: string };
|
|
const { isAdmin } = useUserRole();
|
|
|
|
// Defense in depth: only execute the raw HTML/JS when the workspace HTML embed
|
|
// feature toggle is ON. When OFF (the default), we render a neutral disabled
|
|
// placeholder and inject nothing — so turning the feature off neutralizes
|
|
// existing embeds at render time as well as on the next server-side save.
|
|
const workspace = useAtomValue(workspaceAtom);
|
|
const htmlEmbedEnabled = workspace?.settings?.htmlEmbed === true;
|
|
|
|
// Execution policy split by editor mode:
|
|
// - READ-ONLY / public-share view: the SERVER already decided whether to
|
|
// include the embed (it strips htmlEmbed from shared content when the
|
|
// workspace toggle is OFF). An anonymous viewer has no workspace and thus
|
|
// reads `htmlEmbedEnabled` as false, so we must NOT gate execution on it
|
|
// here — we execute exactly the `source` the server chose to serve.
|
|
// - EDITABLE editor (admin authoring): keep gating on the per-workspace
|
|
// toggle so an admin sees the inert placeholder when the feature is OFF.
|
|
const shouldExecute = computeShouldExecute(
|
|
editor.isEditable,
|
|
htmlEmbedEnabled,
|
|
);
|
|
|
|
const contentRef = useRef<HTMLDivElement | null>(null);
|
|
const [modalOpen, setModalOpen] = useState(false);
|
|
const [draft, setDraft] = useState<string>(source || "");
|
|
|
|
// (Re)render the raw source whenever it changes. This runs in BOTH the
|
|
// editable editor and the read-only / public-share editor (same NodeView),
|
|
// so trackers fire for readers too — that is the intended behaviour. When the
|
|
// feature toggle is OFF we clear the container and inject/execute nothing.
|
|
useEffect(() => {
|
|
if (!contentRef.current) return;
|
|
if (shouldExecute) {
|
|
renderRawHtml(contentRef.current, source || "");
|
|
} else {
|
|
contentRef.current.innerHTML = "";
|
|
}
|
|
}, [source, shouldExecute]);
|
|
|
|
const openEditor = useCallback(() => {
|
|
setDraft(source || "");
|
|
setModalOpen(true);
|
|
}, [source]);
|
|
|
|
const onSave = useCallback(() => {
|
|
if (editor.isEditable) {
|
|
updateAttributes({ source: draft });
|
|
}
|
|
setModalOpen(false);
|
|
}, [draft, editor.isEditable, updateAttributes]);
|
|
|
|
// The edit affordance is only meaningful in edit mode, is restricted to admins
|
|
// (the server strips the node for non-admins anyway), and is offered only when
|
|
// the workspace feature toggle is ON.
|
|
const canEdit = computeCanEdit(editor.isEditable, isAdmin, htmlEmbedEnabled);
|
|
|
|
return (
|
|
<NodeViewWrapper
|
|
data-drag-handle
|
|
className={clsx(classes.htmlEmbedNodeView, {
|
|
[classes.htmlEmbedSelected]: selected,
|
|
})}
|
|
>
|
|
{canEdit && (
|
|
<div className={classes.htmlEmbedToolbar}>
|
|
<ActionIcon
|
|
variant="default"
|
|
size="sm"
|
|
aria-label={t("Edit HTML embed")}
|
|
onClick={openEditor}
|
|
>
|
|
<IconEdit size={16} />
|
|
</ActionIcon>
|
|
</div>
|
|
)}
|
|
|
|
{!shouldExecute ? (
|
|
// Feature disabled for this workspace AND we're in the editable editor:
|
|
// never inject/execute the source. Show a neutral placeholder so an
|
|
// existing embed is visibly inert for the authoring admin. Read-only /
|
|
// share viewers never hit this branch (`shouldExecute` is always true
|
|
// there) — they execute exactly the source the server chose to serve.
|
|
<div className={classes.htmlEmbedPlaceholder}>
|
|
<IconCode size={18} />
|
|
<Text size="sm">
|
|
{t("HTML embed is disabled in this workspace")}
|
|
</Text>
|
|
</div>
|
|
) : source ? (
|
|
// Raw HTML/CSS/JS rendered into the wiki origin. Scripts are re-created
|
|
// in renderRawHtml so they execute.
|
|
<div ref={contentRef} className={classes.htmlEmbedContent} />
|
|
) : canEdit ? (
|
|
<div className={classes.htmlEmbedPlaceholder} onClick={openEditor}>
|
|
<IconCode size={18} />
|
|
<Text size="sm">{t("Click to add HTML / CSS / JS")}</Text>
|
|
</div>
|
|
) : (
|
|
// Empty source, non-editor: render nothing visible.
|
|
<div ref={contentRef} className={classes.htmlEmbedContent} />
|
|
)}
|
|
|
|
<Modal
|
|
opened={modalOpen}
|
|
onClose={() => setModalOpen(false)}
|
|
title={t("Edit HTML embed")}
|
|
size="lg"
|
|
>
|
|
<Text size="xs" c="dimmed" mb="xs">
|
|
{t(
|
|
"This HTML/CSS/JS runs in the page origin for everyone who views it. Admins only.",
|
|
)}
|
|
</Text>
|
|
<Textarea
|
|
autosize
|
|
minRows={10}
|
|
maxRows={24}
|
|
value={draft}
|
|
onChange={(e) => setDraft(e.currentTarget.value)}
|
|
placeholder={t("<script>...</script>")}
|
|
styles={{ input: { fontFamily: "monospace" } }}
|
|
data-autofocus
|
|
/>
|
|
<Group justify="flex-end" mt="md">
|
|
<Button variant="default" onClick={() => setModalOpen(false)}>
|
|
{t("Cancel")}
|
|
</Button>
|
|
<Button onClick={onSave}>{t("Save")}</Button>
|
|
</Group>
|
|
</Modal>
|
|
</NodeViewWrapper>
|
|
);
|
|
}
|