Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 8 additions & 27 deletions src/provider/ModalProvider.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
import { assertTrue, isDefined } from "@okyrychenko-dev/type-utils";
import { useEffect, useMemo, useRef, useState } from "react";
import { confirmModal as defaultConfirmModal } from "../confirm";
import { ModalLifecycleContext, createModalLifecycle } from "../lifecycle";
import { useMemo } from "react";
import { confirmModal as defaultConfirmModal } from "../confirm/builtInConfirmModal";
import { ModalLifecycleContext } from "../lifecycle/ModalLifecycleContext";
import { isModalRegistryAttachable } from "../registry/createModalRegistry";
import { ModalRuntimeConfigContext } from "../runtime";
import { ModalViewport } from "../viewport";
import { ModalRuntimeConfigContext } from "../runtime/ModalRuntimeConfigContext";
import { ModalViewport } from "../viewport/ModalViewport";
import { ModalRegistryBinder } from "./ModalRegistryBinder";
import { useModalLifecycleOwner } from "./useModalLifecycleOwner";
import type { ReactNode } from "react";
import type { ModalRuntimeConfig } from "../runtime";
import type { ModalRuntimeConfig } from "../runtime/ModalRuntimeConfigContext.types";
import type { ModalProviderProps } from "./ModalProvider.types";

export function ModalProvider(props: ModalProviderProps): ReactNode {
Expand All @@ -31,27 +32,7 @@ export function ModalProvider(props: ModalProviderProps): ReactNode {
[closeDelayMs, confirmModal],
);

const [lifecycle] = useState(() => createModalLifecycle({ closeDelayMs }));
const lifecycleEffectGeneration = useRef(0);

useEffect(() => {
lifecycle.setCloseDelayMs(closeDelayMs);
}, [closeDelayMs, lifecycle]);

useEffect(() => {
lifecycleEffectGeneration.current += 1;

return () => {
lifecycleEffectGeneration.current += 1;
const cleanupGeneration = lifecycleEffectGeneration.current;

globalThis.queueMicrotask(() => {
if (lifecycleEffectGeneration.current === cleanupGeneration) {
lifecycle.dispose();
}
});
};
}, [lifecycle]);
const lifecycle = useModalLifecycleOwner(closeDelayMs);

return (
<ModalLifecycleContext.Provider value={lifecycle}>
Expand Down
95 changes: 95 additions & 0 deletions src/provider/__tests__/useModalLifecycleOwner.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import { act, renderHook } from "@testing-library/react";
import { StrictMode } from "react";
import { describe, expect, it, vi } from "vitest";
import { ModalDismissError } from "../../errors/ModalDismissError";
import { useModalLifecycleOwner } from "../useModalLifecycleOwner";
import { renameReportModal } from "./ModalProvider.fixtures";
import type { ReactNode } from "react";

describe("useModalLifecycleOwner", () => {
it("should preserve lifecycle work through Strict Mode effect replay", async () => {
const wrapper = ({ children }: { children: ReactNode }): ReactNode => (
<StrictMode>{children}</StrictMode>
);
const { result } = renderHook(() => useModalLifecycleOwner(0), {
wrapper,
});

const handle = result.current.open(renameReportModal, {
currentName: "Strict Mode",
reportId: "strict-mode",
});

await act(async () => undefined);

expect(result.current.getSnapshot().instances).toHaveLength(1);

act(() => {
handle.dismiss();
});

await expect(handle).rejects.toMatchObject({ reason: "dismiss" });
});

it("should apply runtime updates without recreating lifecycle state", () => {
vi.useFakeTimers();

const { rerender, result } = renderHook(
({ closeDelayMs }) => useModalLifecycleOwner(closeDelayMs),
{ initialProps: { closeDelayMs: 0 } },
);

const lifecycle = result.current;
const handle = lifecycle.open(renameReportModal, {
currentName: "Runtime update",
reportId: "runtime-update",
});

void handle.catch(() => undefined);

rerender({ closeDelayMs: 200 });

act(() => {
handle.dismiss();
});

expect(result.current).toBe(lifecycle);
expect(result.current.getSnapshot().instances[0]?.status).toBe("closing");

act(() => {
vi.advanceTimersByTime(200);
});

expect(result.current.getSnapshot().instances).toHaveLength(0);
vi.useRealTimers();
});

it("should dispose pending work once after final unmount", async () => {
const { result, unmount } = renderHook(() => useModalLifecycleOwner(0));

const lifecycle = result.current;
const observer = vi.fn();

lifecycle.subscribe(observer);

const handle = lifecycle.open(renameReportModal, {
currentName: "Unmount",
reportId: "unmount",
});

const rejection = expect(handle).rejects.toEqual(
new ModalDismissError("provider-unmount"),
);

unmount();

await act(async () => undefined);

await rejection;
expect(lifecycle.getSnapshot().instances).toHaveLength(0);

lifecycle.closeAll();

expect(observer).toHaveBeenCalledTimes(2);
});
});
29 changes: 29 additions & 0 deletions src/provider/useModalLifecycleOwner.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { useEffect, useRef, useState } from "react";
import { createModalLifecycle } from "../lifecycle/modalLifecycle";
import type { ModalLifecycle } from "../lifecycle/modalLifecycle.types";

export function useModalLifecycleOwner(closeDelayMs: number): ModalLifecycle {
const [lifecycle] = useState(() => createModalLifecycle({ closeDelayMs }));
const mountGeneration = useRef(0);

useEffect(() => {
lifecycle.setCloseDelayMs(closeDelayMs);
}, [closeDelayMs, lifecycle]);

useEffect(() => {
mountGeneration.current += 1;

return () => {
mountGeneration.current += 1;
const cleanupGeneration = mountGeneration.current;

globalThis.queueMicrotask(() => {
if (mountGeneration.current === cleanupGeneration) {
lifecycle.dispose();
}
});
};
}, [lifecycle]);

return lifecycle;
}
Loading