|
| 1 | +/* |
| 2 | + * Copyright (c) 2019-2026 by Brockmann Consult Development team |
| 3 | + * Permissions are hereby granted under the terms of the MIT License: |
| 4 | + * https://opensource.org/licenses/MIT. |
| 5 | + */ |
| 6 | + |
| 7 | +import { describe, it, expect, vi } from "vitest"; |
| 8 | +import { renderHook, act } from "@testing-library/react"; |
| 9 | +import type { Result as VegaEmbedResult } from "vega-embed"; |
| 10 | + |
| 11 | +import { useVegaSignalEmbed } from "./useVegaSignalEmbed"; |
| 12 | + |
| 13 | +type SignalHandler = (signalName: string, signalValue: unknown) => void; |
| 14 | + |
| 15 | +describe("useVegaSignalEmbed", () => { |
| 16 | + it("should register signal listeners on embed", () => { |
| 17 | + const signalListenerMap: Record<string, SignalHandler> = { |
| 18 | + sel_point: vi.fn(), |
| 19 | + sel_interval: vi.fn(), |
| 20 | + sel_point_a: vi.fn(), |
| 21 | + }; |
| 22 | + |
| 23 | + const { result } = renderHook(() => useVegaSignalEmbed(signalListenerMap)); |
| 24 | + |
| 25 | + const view = createMockView(); |
| 26 | + |
| 27 | + act(() => { |
| 28 | + result.current({ view } as unknown as VegaEmbedResult); |
| 29 | + }); |
| 30 | + |
| 31 | + expect(view.addSignalListener).toHaveBeenCalledTimes(3); |
| 32 | + |
| 33 | + const names = view.addSignalListener.mock.calls.map(([name]) => name); |
| 34 | + expect(names).toEqual( |
| 35 | + expect.arrayContaining(["sel_point", "sel_interval", "sel_point_a"]), |
| 36 | + ); |
| 37 | + }); |
| 38 | + |
| 39 | + it("should remove old listeners when embedding again", () => { |
| 40 | + const signalListenerMap: Record<string, SignalHandler> = { |
| 41 | + sel_point: vi.fn(), |
| 42 | + sel_interval: vi.fn(), |
| 43 | + }; |
| 44 | + |
| 45 | + const { result } = renderHook(() => useVegaSignalEmbed(signalListenerMap)); |
| 46 | + |
| 47 | + const view1 = createMockView(); |
| 48 | + const view2 = createMockView(); |
| 49 | + |
| 50 | + act(() => { |
| 51 | + result.current({ view: view1 } as unknown as VegaEmbedResult); |
| 52 | + }); |
| 53 | + |
| 54 | + const attachedToView1 = view1.addSignalListener.mock.calls.map( |
| 55 | + ([name, fn]) => ({ name, fn }), |
| 56 | + ); |
| 57 | + |
| 58 | + act(() => { |
| 59 | + result.current({ view: view2 } as unknown as VegaEmbedResult); |
| 60 | + }); |
| 61 | + |
| 62 | + expect(view1.removeSignalListener).toHaveBeenCalledTimes( |
| 63 | + attachedToView1.length, |
| 64 | + ); |
| 65 | + |
| 66 | + for (const { name, fn } of attachedToView1) { |
| 67 | + expect(view1.removeSignalListener).toHaveBeenCalledWith(name, fn); |
| 68 | + } |
| 69 | + |
| 70 | + expect(view2.addSignalListener).toHaveBeenCalledTimes(2); |
| 71 | + }); |
| 72 | + |
| 73 | + it("should cleanup listeners on unmount", () => { |
| 74 | + const signalListenerMap: Record<string, SignalHandler> = { |
| 75 | + sel_point: vi.fn(), |
| 76 | + sel_interval: vi.fn(), |
| 77 | + }; |
| 78 | + |
| 79 | + const { result, unmount } = renderHook(() => |
| 80 | + useVegaSignalEmbed(signalListenerMap), |
| 81 | + ); |
| 82 | + |
| 83 | + const view = createMockView(); |
| 84 | + |
| 85 | + act(() => { |
| 86 | + result.current({ view } as unknown as VegaEmbedResult); |
| 87 | + }); |
| 88 | + |
| 89 | + const attached = view.addSignalListener.mock.calls.map(([name, fn]) => ({ |
| 90 | + name, |
| 91 | + fn, |
| 92 | + })); |
| 93 | + |
| 94 | + unmount(); |
| 95 | + |
| 96 | + expect(view.removeSignalListener).toHaveBeenCalledTimes(attached.length); |
| 97 | + |
| 98 | + for (const { name, fn } of attached) { |
| 99 | + expect(view.removeSignalListener).toHaveBeenCalledWith(name, fn); |
| 100 | + } |
| 101 | + }); |
| 102 | + |
| 103 | + it("should do nothing if embed result has no view", () => { |
| 104 | + const signalListenerMap: Record<string, SignalHandler> = { |
| 105 | + sel_point: vi.fn(), |
| 106 | + }; |
| 107 | + |
| 108 | + const { result } = renderHook(() => useVegaSignalEmbed(signalListenerMap)); |
| 109 | + |
| 110 | + act(() => { |
| 111 | + result.current({} as VegaEmbedResult); |
| 112 | + }); |
| 113 | + }); |
| 114 | + |
| 115 | + it("should register no listeners if the signal listener map is empty", () => { |
| 116 | + const { result } = renderHook(() => useVegaSignalEmbed({})); |
| 117 | + |
| 118 | + const view = createMockView(); |
| 119 | + |
| 120 | + act(() => { |
| 121 | + result.current({ view } as unknown as VegaEmbedResult); |
| 122 | + }); |
| 123 | + |
| 124 | + expect(view.addSignalListener).not.toHaveBeenCalled(); |
| 125 | + expect(view.removeSignalListener).not.toHaveBeenCalled(); |
| 126 | + }); |
| 127 | +}); |
| 128 | + |
| 129 | +function createMockView() { |
| 130 | + return { |
| 131 | + addSignalListener: vi.fn(), |
| 132 | + removeSignalListener: vi.fn(), |
| 133 | + }; |
| 134 | +} |
0 commit comments