Skip to content

Build your personal knowledge base with Trilium Notes

fix(relation_map): keep a late placement or paste off another map

Elian Doran62a53d2632ce
diff --git a/apps/client/src/widgets/type_widgets/relation_map/RelationMap.spec.tsx b/apps/client/src/widgets/type_widgets/relation_map/RelationMap.spec.tsx
index a17fbde09b..ed37633723 100644
--- a/apps/client/src/widgets/type_widgets/relation_map/RelationMap.spec.tsx
+++ b/apps/client/src/widgets/type_widgets/relation_map/RelationMap.spec.tsx
@@ -7,11 +7,13 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
// A stand-in for the zoom library, which needs real layout: it applies a transform at once and
// reports it, as the library does once an animation ends.
-const { wrapperProps, pasteNotes } = vi.hoisted(() => ({
+const { wrapperProps, pasteNotes, createNote } = vi.hoisted(() => ({
wrapperProps: { current: null as Record<string, unknown> | null },
- pasteNotes: vi.fn<(note: unknown, data?: DataTransfer | null) => Promise<string[]>>()
+ pasteNotes: vi.fn<(note: unknown, data?: DataTransfer | null) => Promise<string[]>>(),
+ createNote: vi.fn<(parentNotePath: string, options: object) => Promise<{ note: { noteId: string } | null }>>()
}));
vi.mock("../../../services/note_paste", () => ({ pasteNotes }));
+vi.mock("../../../services/note_create", () => ({ default: { createNote } }));
vi.mock("react-zoom-pan-pinch", () => ({
TransformWrapper: forwardRef((props: { children?: ComponentChildren; onTransform?(ref: unknown, state: object): void }, ref) => {
wrapperProps.current = props;
@@ -38,7 +40,7 @@ import { buildNote } from "../../../test/easy-froca";
import { ParentComponent } from "../../react/react_utils";
import type RelationMapApi from "./api";
import type { MapTransform } from "./api";
-import { MapViewport, useCanvasClicks, useMapPaste, useMapZoom, useRevealSelectedBox } from "./RelationMap";
+import { MapViewport, useCanvasClicks, useMapPaste, useMapZoom, useNotePlacement, useRevealSelectedBox } from "./RelationMap";
import { noteIdToId } from "./utils";
describe("relation map canvas clicks", () => {
@@ -345,6 +347,7 @@ describe("relation map paste", () => {
let mapNote: FNote;
const addMultipleNotes = vi.fn();
let pasteAt: ReturnType<typeof useMapPaste>["pasteAt"] | undefined;
+ let mapApiRef: { current: RelationMapApi | null } = { current: null };
beforeEach(() => {
addMultipleNotes.mockClear();
@@ -366,8 +369,9 @@ describe("relation map paste", () => {
function Harness({ isReadOnly }: { isReadOnly: boolean }) {
const [ viewport, setViewport ] = useState<HTMLDivElement | null>(null);
const containerRef = useRef<HTMLDivElement>(null);
- const mapApiRef = useRef({ addMultipleNotes } as unknown as RelationMapApi);
- const paste = useMapPaste({ note: mapNote, isReadOnly, viewport, containerRef, mapApiRef, getScale: () => 2 });
+ const apiRef = useRef({ addMultipleNotes } as unknown as RelationMapApi);
+ mapApiRef = apiRef;
+ const paste = useMapPaste({ note: mapNote, isReadOnly, viewport, containerRef, mapApiRef: apiRef, getScale: () => 2 });
pasteAt = paste.pasteAt;
return (
<div className="wrapper" onMouseMove={paste.followPointer} onMouseLeave={paste.forgetPointer}>
@@ -435,6 +439,20 @@ describe("relation map paste", () => {
expect(addMultipleNotes.mock.calls.at(-1)).toEqual(placed(20, 85));
});
+ it("drops a paste whose map was replaced by another while the clipboard was read", async () => {
+ const { viewport } = mount();
+ const otherMap = vi.fn();
+ let finish: (noteIds: string[]) => void = () => {};
+ pasteNotes.mockReturnValueOnce(new Promise((resolve) => { finish = resolve; }));
+
+ const pasted = paste(viewport);
+ mapApiRef.current = { addMultipleNotes: otherMap } as unknown as RelationMapApi;
+ finish([ "first" ]);
+ await pasted;
+
+ expect([ addMultipleNotes, otherMap ].map((mock) => mock.mock.calls.length)).toEqual([ 0, 0 ]);
+ });
+
it("leaves a paste into the note pane to it, and pastes nothing onto a read-only map or from an empty clipboard", async () => {
const { editor } = mount();
const event = await paste(editor);
@@ -453,3 +471,59 @@ describe("relation map paste", () => {
expect(pasteNotes).toHaveBeenCalledTimes(1);
});
});
+
+describe("relation map placement", () => {
+ let container: HTMLElement | undefined;
+ let placement: ReturnType<typeof useNotePlacement> | undefined;
+ let mapApiRef: { current: RelationMapApi | null } = { current: null };
+ const createItem = vi.fn();
+ const onCreated = vi.fn();
+
+ beforeEach(() => {
+ for (const mock of [ createItem, onCreated, createNote ]) mock.mockReset();
+ container = document.createElement("div");
+ document.body.appendChild(container);
+ const note = buildNote({ id: "map", title: "Map" });
+
+ function Harness() {
+ const containerRef = useRef<HTMLDivElement>(null);
+ const apiRef = useRef({ createItem } as unknown as RelationMapApi);
+ mapApiRef = apiRef;
+ placement = useNotePlacement({
+ ntxId: "map", note, containerRef, getScale: () => 1, mapApiRef: apiRef, onArm: () => {}, onCreated
+ });
+ return <div ref={containerRef} />;
+ }
+ act(() => render(<Harness />, container as HTMLElement));
+ });
+
+ afterEach(() => {
+ if (container) {
+ render(null, container);
+ container.remove();
+ container = undefined;
+ }
+ });
+
+ /** Places a note, with the map replaced by another while the note is created when `switchMap`. */
+ async function place(switchMap: boolean) {
+ let finish: (result: { note: { noteId: string } }) => void = () => {};
+ createNote.mockReturnValueOnce(new Promise((resolve) => { finish = resolve; }));
+ await act(async () => {
+ const placed = placement?.placeAt(new MouseEvent("click", { clientX: 200, clientY: 100 }));
+ if (switchMap) mapApiRef.current = { createItem: vi.fn() } as unknown as RelationMapApi;
+ finish({ note: { noteId: "created" } });
+ await placed;
+ });
+ }
+
+ it("puts the created note on the map, unless the map was replaced by another meanwhile", async () => {
+ await place(false);
+ expect(createItem).toHaveBeenCalledWith({ noteId: "created", x: 120, y: 85 });
+ expect(onCreated).toHaveBeenCalledWith("created");
+
+ await place(true);
+ expect(createItem).toHaveBeenCalledTimes(1);
+ expect(onCreated).toHaveBeenCalledTimes(1);
+ });
+});
diff --git a/apps/client/src/widgets/type_widgets/relation_map/RelationMap.tsx b/apps/client/src/widgets/type_widgets/relation_map/RelationMap.tsx
index bd9911f0f5..de6581e9e2 100644
--- a/apps/client/src/widgets/type_widgets/relation_map/RelationMap.tsx
+++ b/apps/client/src/widgets/type_widgets/relation_map/RelationMap.tsx
@@ -439,7 +439,7 @@ function useBoxes(notes: MapDataNoteEntry[] | undefined, dragged: MapDataNoteEnt
* the default title (or the map's `#titleTemplate`), and the pane opens on it with the title
* selected.
*/
-function useNotePlacement({ ntxId, note, containerRef, getScale, mapApiRef, onArm, onCreated }: {
+export function useNotePlacement({ ntxId, note, containerRef, getScale, mapApiRef, onArm, onCreated }: {
ntxId: string | null | undefined;
note: FNote;
containerRef: RefObject<HTMLDivElement | null>;
@@ -501,6 +501,8 @@ function useNotePlacement({ ntxId, note, containerRef, getScale, mapApiRef, onAr
// Leaves placement mode first, so the map does not stay in it if creating the note fails.
setPlacing(false);
const position = boxPositionAt(e, container, getScale());
+ // Another map loaded into this component while the note is created replaces the API.
+ const mapApi = mapApiRef.current;
const { note: created } = await note_create.createNote(note.noteId, {
content: "",
@@ -508,9 +510,9 @@ function useNotePlacement({ ntxId, note, containerRef, getScale, mapApiRef, onAr
activate: false,
isProtected: note.isProtected
});
- if (!created || !mapApiRef.current) return;
+ if (!created || !mapApi || mapApiRef.current !== mapApi) return;
- mapApiRef.current.createItem({ noteId: created.noteId, ...position });
+ mapApi.createItem({ noteId: created.noteId, ...position });
onCreated(created.noteId);
}, [ note, containerRef, getScale, mapApiRef, onCreated ]);
@@ -536,16 +538,17 @@ export function useMapPaste({ note, isReadOnly, viewport, containerRef, mapApiRe
const pointerRef = useRef<{ clientX: number; clientY: number }>(null);
const paste = useCallback(async (at: { clientX: number; clientY: number } | null, data?: DataTransfer | null) => {
+ const mapApi = mapApiRef.current;
const noteIds = await pasteNotes(note, data);
const container = containerRef.current;
- if (!noteIds.length || !container) return;
+ if (!noteIds.length || !container || !mapApi || mapApiRef.current !== mapApi) return;
const rect = viewport?.getBoundingClientRect();
const point = at ?? (rect ? { clientX: rect.left + rect.width / 2, clientY: rect.top + rect.height / 2 } : null);
if (!point) return;
const notes = froca.getNotesFromCache(noteIds, true);
- mapApiRef.current?.addMultipleNotes(layOutBoxes(notes, boxPositionAt(point, container, getScale())));
+ mapApi.addMultipleNotes(layOutBoxes(notes, boxPositionAt(point, container, getScale())));
}, [ note, viewport, containerRef, mapApiRef, getScale ]);
useEffect(() => {