| 1 | import { createMutationButton, useMutate } from "@clo/react-mutation"; |
| 2 | import { assertEquals } from "@std/assert"; |
| 3 | import { act, render, screen } from "@testing-library/react"; |
| 4 | import { userEvent } from "@testing-library/user-event"; |
| 5 | import type { FC, MouseEventHandler, ReactNode } from "react"; |
| 6 | import { test, vi } from "vitest"; |
| 7 | import { createTestMutationClient, IterableStream } from "./share.ts"; |
| 8 | |
| 9 | test("debounceMs: waits before first call", async () => { |
| 10 | vi.useFakeTimers({ shouldAdvanceTime: true }); |
| 11 | const user = userEvent.setup({ delay: null }); |
| 12 | |
| 13 | const { client, successMessages, errorMessages } = createTestMutationClient(); |
| 14 | const s = new IterableStream<string>(); |
| 15 | |
| 16 | const mutTest = client.define({ |
| 17 | id: "test-1", |
| 18 | mutate: async () => { |
| 19 | return (await s.next()).value; |
| 20 | }, |
| 21 | describe: "Test the action", |
| 22 | describeResult: "Tested the action", |
| 23 | optimistic: () => {}, |
| 24 | debounceMs: 500, |
| 25 | }); |
| 26 | |
| 27 | let renders: Array<{ isMutating: boolean; isPending: boolean; isOptimisticData: boolean; isDisabled: boolean }> = []; |
| 28 | function TestComponent() { |
| 29 | const { run, isMutating, isPending, isOptimisticData, isDisabled } = useMutate(mutTest); |
| 30 | renders.push({ isMutating, isPending, isOptimisticData, isDisabled }); |
| 31 | |
| 32 | return ( |
| 33 | <> |
| 34 | <button |
| 35 | data-testid="a" |
| 36 | onClick={() => { |
| 37 | run(); |
| 38 | }} |
| 39 | > |
| 40 | button |
| 41 | </button> |
| 42 | </> |
| 43 | ); |
| 44 | } |
| 45 | |
| 46 | render(<TestComponent />); |
| 47 | // initial state |
| 48 | assertEquals(renders, [{ isMutating: false, isPending: false, isOptimisticData: false, isDisabled: false }]); |
| 49 | assertEquals(successMessages, []); |
| 50 | assertEquals(errorMessages, []); |
| 51 | renders = []; |
| 52 | vi.runAllTimers(); |
| 53 | |
| 54 | // mutation 1 |
| 55 | await act(() => user.click(screen.getByTestId("a"))); |
| 56 | assertEquals(renders, [{ isMutating: false, isPending: false, isOptimisticData: true, isDisabled: false }]); |
| 57 | renders = []; |
| 58 | await act(() => vi.advanceTimersByTime(200)); |
| 59 | assertEquals(renders, []); |
| 60 | await act(() => vi.advanceTimersByTime(300)); |
| 61 | assertEquals(renders, [{ isMutating: true, isPending: false, isDisabled: false, isOptimisticData: true }]); |
| 62 | renders = []; |
| 63 | await act(() => vi.advanceTimersByTime(300)); |
| 64 | assertEquals(renders, []); |
| 65 | assertEquals(successMessages, []); |
| 66 | assertEquals(errorMessages, []); |
| 67 | await act(async () => { |
| 68 | s.push("ok"); |
| 69 | vi.advanceTimersByTime(100); |
| 70 | }); |
| 71 | assertEquals(successMessages, ["Tested the action"]); |
| 72 | assertEquals(errorMessages, []); |
| 73 | assertEquals(renders, [{ isMutating: false, isPending: false, isDisabled: false, isOptimisticData: false }]); |
| 74 | renders = []; |
| 75 | successMessages.splice(0, successMessages.length); |
| 76 | |
| 77 | vi.advanceTimersByTime(1000); |
| 78 | |
| 79 | // mutation 2 |
| 80 | await act(() => user.click(screen.getByTestId("a"))); |
| 81 | assertEquals(renders, [{ isMutating: false, isPending: false, isOptimisticData: true, isDisabled: false }]); |
| 82 | renders = []; |
| 83 | await act(() => vi.advanceTimersByTime(200)); |
| 84 | assertEquals(renders, []); |
| 85 | await act(() => vi.advanceTimersByTime(300)); |
| 86 | assertEquals(renders, [{ isMutating: true, isPending: false, isDisabled: false, isOptimisticData: true }]); |
| 87 | renders = []; |
| 88 | await act(() => vi.advanceTimersByTime(300)); |
| 89 | assertEquals(renders, []); |
| 90 | assertEquals(successMessages, []); |
| 91 | assertEquals(errorMessages, []); |
| 92 | const error1 = new Error("damn!"); |
| 93 | await act(async () => { |
| 94 | s.throw(error1); |
| 95 | vi.advanceTimersByTime(100); |
| 96 | }); |
| 97 | assertEquals(successMessages, []); |
| 98 | assertEquals(errorMessages, [ |
| 99 | { error: error1, message: "Could not test the action: damn!" }, |
| 100 | ]); |
| 101 | }); |
| 102 | |
| 103 | test("debounceMs: batch multiple calls together", async () => { |
| 104 | vi.useFakeTimers({ shouldAdvanceTime: true }); |
| 105 | const user = userEvent.setup({ delay: null }); |
| 106 | |
| 107 | const { client, successMessages, errorMessages } = createTestMutationClient(); |
| 108 | const s = new IterableStream<string>(); |
| 109 | |
| 110 | const mutations: number[] = []; |
| 111 | const mutTest = client.define({ |
| 112 | id: "test-2", |
| 113 | mutate: async (k: number) => { |
| 114 | mutations.push(k); |
| 115 | return (await s.next()).value; |
| 116 | }, |
| 117 | describe: "Test the action", |
| 118 | describeResult: "Tested the action", |
| 119 | optimistic: () => {}, |
| 120 | debounceMs: 500, |
| 121 | }); |
| 122 | |
| 123 | let i = 0; |
| 124 | |
| 125 | let renders: Array<{ isMutating: boolean; isPending: boolean; isOptimisticData: boolean; isDisabled: boolean }> = []; |
| 126 | function TestComponent() { |
| 127 | const { run, isMutating, isPending, isOptimisticData, isDisabled } = useMutate(mutTest); |
| 128 | renders.push({ isMutating, isPending, isOptimisticData, isDisabled }); |
| 129 | |
| 130 | return ( |
| 131 | <> |
| 132 | <button |
| 133 | data-testid="a" |
| 134 | onClick={() => { |
| 135 | run(i++); |
| 136 | }} |
| 137 | > |
| 138 | button |
| 139 | </button> |
| 140 | </> |
| 141 | ); |
| 142 | } |
| 143 | |
| 144 | render(<TestComponent />); |
| 145 | // initial state |
| 146 | assertEquals(renders, [{ isMutating: false, isPending: false, isOptimisticData: false, isDisabled: false }]); |
| 147 | assertEquals(successMessages, []); |
| 148 | assertEquals(errorMessages, []); |
| 149 | renders = []; |
| 150 | vi.runAllTimers(); |
| 151 | |
| 152 | // mutation 1 |
| 153 | await act(() => user.click(screen.getByTestId("a"))); |
| 154 | assertEquals(renders, [{ isMutating: false, isPending: false, isOptimisticData: true, isDisabled: false }]); |
| 155 | renders = []; |
| 156 | await act(() => user.click(screen.getByTestId("a"))); |
| 157 | await act(() => user.click(screen.getByTestId("a"))); |
| 158 | await act(() => user.click(screen.getByTestId("a"))); |
| 159 | await act(() => user.click(screen.getByTestId("a"))); |
| 160 | await act(() => vi.advanceTimersByTime(200)); |
| 161 | assertEquals(renders, []); |
| 162 | await act(() => vi.advanceTimersByTime(300)); |
| 163 | assertEquals(renders, [{ isMutating: true, isPending: false, isDisabled: false, isOptimisticData: true }]); |
| 164 | renders = []; |
| 165 | await act(() => vi.advanceTimersByTime(300)); |
| 166 | assertEquals(renders, []); |
| 167 | assertEquals(successMessages, []); |
| 168 | assertEquals(errorMessages, []); |
| 169 | await act(async () => { |
| 170 | assertEquals(mutations, [4]); |
| 171 | s.push("ok"); |
| 172 | vi.advanceTimersByTime(100); |
| 173 | }); |
| 174 | assertEquals(successMessages, ["Tested the action"]); |
| 175 | assertEquals(errorMessages, []); |
| 176 | assertEquals(renders, [{ isMutating: false, isPending: false, isDisabled: false, isOptimisticData: false }]); |
| 177 | renders = []; |
| 178 | successMessages.splice(0, successMessages.length); |
| 179 | |
| 180 | vi.advanceTimersByTime(1000); |
| 181 | assertEquals(renders, []); |
| 182 | renders = []; |
| 183 | }); |
| 184 | |
| 185 | test("debounceMs: a mutation button stays enabled and not pending while mutating", async () => { |
| 186 | vi.useFakeTimers({ shouldAdvanceTime: true }); |
| 187 | const user = userEvent.setup({ delay: null }); |
| 188 | |
| 189 | const { client } = createTestMutationClient(); |
| 190 | const s = new IterableStream<string>(); |
| 191 | |
| 192 | const mutTest = client.define({ |
| 193 | id: "test-button", |
| 194 | mutate: async () => { |
| 195 | return (await s.next()).value; |
| 196 | }, |
| 197 | describe: "Test the action", |
| 198 | describeResult: null, |
| 199 | optimistic: () => {}, |
| 200 | debounceMs: 500, |
| 201 | }); |
| 202 | |
| 203 | let last = {}; |
| 204 | const MutationButtonBase: FC<{ |
| 205 | children?: ReactNode; |
| 206 | disabled?: boolean; |
| 207 | isPending: boolean; |
| 208 | onClick: MouseEventHandler<HTMLElement> | undefined; |
| 209 | }> = function MutationButtonBase({ children, disabled, isPending, onClick }) { |
| 210 | last = { disabled, isPending }; |
| 211 | return ( |
| 212 | <button data-testid="a" onClick={onClick}> |
| 213 | {children} |
| 214 | </button> |
| 215 | ); |
| 216 | }; |
| 217 | const MutationButton = createMutationButton(MutationButtonBase); |
| 218 | |
| 219 | render(<MutationButton mutation={mutTest} args={[]}>button</MutationButton>); |
| 220 | await act(() => user.click(screen.getByTestId("a"))); |
| 221 | await act(() => vi.advanceTimersByTime(1000)); |
| 222 | assertEquals(last, { disabled: false, isPending: false }); |
| 223 | }); |
| 224 | |
| 225 | test.todo("debounceImmediate runs the first one right away", async () => { |
| 226 | vi.useFakeTimers({ shouldAdvanceTime: true }); |
| 227 | const user = userEvent.setup({ delay: null }); |
| 228 | |
| 229 | const { client, successMessages, errorMessages } = createTestMutationClient(); |
| 230 | const s = new IterableStream<string>(); |
| 231 | |
| 232 | const mutations: number[] = []; |
| 233 | const mutTest = client.define({ |
| 234 | id: "test-3", |
| 235 | mutate: async (k: number) => { |
| 236 | mutations.push(k); |
| 237 | return (await s.next()).value; |
| 238 | }, |
| 239 | describe: "Test the action", |
| 240 | describeResult: "Tested the action", |
| 241 | optimistic: () => {}, |
| 242 | debounceMs: 500, |
| 243 | debounceImmediate: true, |
| 244 | }); |
| 245 | |
| 246 | let i = 0; |
| 247 | |
| 248 | let renders: Array<{ isMutating: boolean; isPending: boolean; isOptimisticData: boolean; isDisabled: boolean }> = []; |
| 249 | function TestComponent() { |
| 250 | const { run, isMutating, isPending, isOptimisticData, isDisabled } = useMutate(mutTest); |
| 251 | renders.push({ isMutating, isPending, isOptimisticData, isDisabled }); |
| 252 | |
| 253 | return ( |
| 254 | <> |
| 255 | <button |
| 256 | data-testid="a" |
| 257 | onClick={() => { |
| 258 | run(i++); |
| 259 | }} |
| 260 | > |
| 261 | button |
| 262 | </button> |
| 263 | </> |
| 264 | ); |
| 265 | } |
| 266 | |
| 267 | render(<TestComponent />); |
| 268 | // initial state |
| 269 | assertEquals(renders, [{ isMutating: false, isPending: false, isOptimisticData: false, isDisabled: false }]); |
| 270 | assertEquals(successMessages, []); |
| 271 | assertEquals(errorMessages, []); |
| 272 | renders = []; |
| 273 | vi.runAllTimers(); |
| 274 | |
| 275 | // mutation 1 |
| 276 | await act(() => user.click(screen.getByTestId("a"))); |
| 277 | assertEquals(renders, [{ isMutating: true, isPending: false, isOptimisticData: true, isDisabled: false }]); |
| 278 | renders = []; |
| 279 | await act(async () => { |
| 280 | assertEquals(mutations, [0]); |
| 281 | s.push("ok"); |
| 282 | vi.advanceTimersByTime(100); |
| 283 | }); |
| 284 | assertEquals(renders, [{ isMutating: false, isPending: false, isDisabled: false, isOptimisticData: false }]); |
| 285 | renders = []; |
| 286 | |
| 287 | // mutation 2 |
| 288 | await act(() => user.click(screen.getByTestId("a"))); |
| 289 | assertEquals(renders, [{ isMutating: true, isPending: false, isDisabled: false, isOptimisticData: true }]); |
| 290 | renders = []; |
| 291 | |
| 292 | await act(() => user.click(screen.getByTestId("a"))); |
| 293 | await act(() => user.click(screen.getByTestId("a"))); |
| 294 | await act(() => user.click(screen.getByTestId("a"))); |
| 295 | await act(() => vi.advanceTimersByTime(200)); |
| 296 | assertEquals(renders, []); |
| 297 | await act(() => vi.advanceTimersByTime(300)); |
| 298 | assertEquals(renders, [{ isMutating: true, isPending: false, isDisabled: false, isOptimisticData: true }]); |
| 299 | renders = []; |
| 300 | await act(() => vi.advanceTimersByTime(300)); |
| 301 | assertEquals(renders, []); |
| 302 | assertEquals(successMessages, []); |
| 303 | assertEquals(errorMessages, []); |
| 304 | await act(async () => { |
| 305 | assertEquals(mutations, [1]); |
| 306 | s.push("ok"); |
| 307 | vi.advanceTimersByTime(100); |
| 308 | }); |
| 309 | assertEquals(successMessages, ["Tested the action"]); |
| 310 | assertEquals(errorMessages, []); |
| 311 | assertEquals(renders, [{ isMutating: false, isPending: false, isDisabled: false, isOptimisticData: false }]); |
| 312 | renders = []; |
| 313 | successMessages.splice(0, successMessages.length); |
| 314 | |
| 315 | vi.advanceTimersByTime(1000); |
| 316 | assertEquals(renders, []); |
| 317 | renders = []; |
| 318 | }); |