Virtual whiteboard for sketching hand-drawn like diagrams
fix: `withInternalFallback` leaking state in multi-instance scenarios (#6602)
David Luzara8f0a14610da
diff --git a/src/components/hoc/withInternalFallback.test.tsx b/src/components/hoc/withInternalFallback.test.tsxnew file mode 100644index 0000000000..af43db58ae--- /dev/null+++ b/src/components/hoc/withInternalFallback.test.tsx@@ -0,0 +1,100 @@+import { render, queryAllByTestId } from "../../tests/test-utils";+import { Excalidraw, MainMenu } from "../../packages/excalidraw/index";++describe("Test internal component fallback rendering", () => {+ it("should render only one menu per excalidraw instance (custom menu first scenario)", async () => {+ const { container } = await render(+ <div>+ <Excalidraw>+ <MainMenu>test</MainMenu>+ </Excalidraw>+ <Excalidraw />+ </div>,+ );++ expect(queryAllByTestId(container, "dropdown-menu-button")?.length).toBe(2);++ const excalContainers = container.querySelectorAll<HTMLDivElement>(+ ".excalidraw-container",+ );++ expect(+ queryAllByTestId(excalContainers[0], "dropdown-menu-button")?.length,+ ).toBe(1);+ expect(+ queryAllByTestId(excalContainers[1], "dropdown-menu-button")?.length,+ ).toBe(1);+ });++ it("should render only one menu per excalidraw instance (default menu first scenario)", async () => {+ const { container } = await render(+ <div>+ <Excalidraw />+ <Excalidraw>+ <MainMenu>test</MainMenu>+ </Excalidraw>+ </div>,+ );++ expect(queryAllByTestId(container, "dropdown-menu-button")?.length).toBe(2);++ const excalContainers = container.querySelectorAll<HTMLDivElement>(+ ".excalidraw-container",+ );++ expect(+ queryAllByTestId(excalContainers[0], "dropdown-menu-button")?.length,+ ).toBe(1);+ expect(+ queryAllByTestId(excalContainers[1], "dropdown-menu-button")?.length,+ ).toBe(1);+ });++ it("should render only one menu per excalidraw instance (two custom menus scenario)", async () => {+ const { container } = await render(+ <div>+ <Excalidraw>+ <MainMenu>test</MainMenu>+ </Excalidraw>+ <Excalidraw>+ <MainMenu>test</MainMenu>+ </Excalidraw>+ </div>,+ );++ expect(queryAllByTestId(container, "dropdown-menu-button")?.length).toBe(2);++ const excalContainers = container.querySelectorAll<HTMLDivElement>(+ ".excalidraw-container",+ );++ expect(+ queryAllByTestId(excalContainers[0], "dropdown-menu-button")?.length,+ ).toBe(1);+ expect(+ queryAllByTestId(excalContainers[1], "dropdown-menu-button")?.length,+ ).toBe(1);+ });++ it("should render only one menu per excalidraw instance (two default menus scenario)", async () => {+ const { container } = await render(+ <div>+ <Excalidraw />+ <Excalidraw />+ </div>,+ );++ expect(queryAllByTestId(container, "dropdown-menu-button")?.length).toBe(2);++ const excalContainers = container.querySelectorAll<HTMLDivElement>(+ ".excalidraw-container",+ );++ expect(+ queryAllByTestId(excalContainers[0], "dropdown-menu-button")?.length,+ ).toBe(1);+ expect(+ queryAllByTestId(excalContainers[1], "dropdown-menu-button")?.length,+ ).toBe(1);+ });+});diff --git a/src/components/hoc/withInternalFallback.tsx b/src/components/hoc/withInternalFallback.tsxindex 581a1874f5..4131c51ec9 100644--- a/src/components/hoc/withInternalFallback.tsx+++ b/src/components/hoc/withInternalFallback.tsx@@ -1,5 +1,5 @@import { atom, useAtom } from "jotai";-import React, { useLayoutEffect } from "react";+import React, { useLayoutEffect, useRef } from "react";import { useTunnels } from "../../context/tunnels";export const withInternalFallback = <P,>(@@ -7,13 +7,6 @@ export const withInternalFallback = <P,>(Component: React.FC<P>,) => {const renderAtom = atom(0);- // flag set on initial render to tell the fallback component to skip the- // render until mount counter are initialized. This is because the counter- // is initialized in an effect, and thus we could end rendering both- // components at the same time until counter is initialized.- let preferHost = false;-- let counter = 0;const WrapperComponent: React.FC<P & {@@ -21,38 +14,52 @@ export const withInternalFallback = <P,>(}> = (props) => {const { jotaiScope } = useTunnels();- const [, setRender] = useAtom(renderAtom, jotaiScope);+ // for rerenders+ const [, setCounter] = useAtom(renderAtom, jotaiScope);+ // for initial & subsequent renders. Tracked as component state+ // due to excalidraw multi-instance scanerios.+ const metaRef = useRef({+ // flag set on initial render to tell the fallback component to skip the+ // render until mount counter are initialized. This is because the counter+ // is initialized in an effect, and thus we could end rendering both+ // components at the same time until counter is initialized.+ preferHost: false,+ counter: 0,+ });useLayoutEffect(() => {- setRender((c) => {+ const meta = metaRef.current;+ setCounter((c) => {const next = c + 1;- counter = next;+ meta.counter = next;return next;});return () => {- setRender((c) => {+ setCounter((c) => {const next = c - 1;- counter = next;+ meta.counter = next;if (!next) {- preferHost = false;+ meta.preferHost = false;}return next;});};- }, [setRender]);+ }, [setCounter]);if (!props.__fallback) {- preferHost = true;+ metaRef.current.preferHost = true;}// ensure we don't render fallback and host components at the same timeif (// either before the counters are initialized- (!counter && props.__fallback && preferHost) ||+ (!metaRef.current.counter &&+ props.__fallback &&+ metaRef.current.preferHost) ||// or after the counters are initialized, and both are rendered// (this is the default when host renders as well)- (counter > 1 && props.__fallback)+ (metaRef.current.counter > 1 && props.__fallback)) {return null;}