[Test] onUrlUpdate callback not being called in React test environment

[uniqueeest]

Description

I'm trying to test a component that uses useQueryStates with withNuqsTestingAdapter, but the onUrlUpdate callback is not being called when updating the URL parameters.

Reproduction

it('should increment the count when clicked', async () => {
  const user = userEvent.setup();
  const onUrlUpdate = vi.fn<OnUrlUpdateFunction>();
  
  const CounterButton = () => {
    const [searchParam, setSearchParam] = useQueryStates({
      count: parseAsInteger.withDefault(42),
    });
    return (
      <button onClick={() => setSearchParam({ count: searchParam.count + 1 })}>
        count is {searchParam.count}
      </button>
    );
  };

  render(<CounterButton />, {
    wrapper: withNuqsTestingAdapter({
      searchParams: '?count=42',
      onUrlUpdate
    })
  });

  const button = screen.getByRole('button');
  await user.click(button);

  expect(button).toHaveTextContent('count is 43');
  expect(onUrlUpdate).toHaveBeenCalledOnce(); // This fails
});

Expected Behavior

The onUrlUpdate callback should be called once when the button is clicked and the URL parameters are updated.

Actual Behavior

The onUrlUpdate callback is never called, causing the test to fail with:
AssertionError: expected "spy" to be called once, but got 0 times

[franky47]

The URL update is deferred, so you need to await all pending promises. You can do so with act:

https://github.com/47ng/nuqs/blob/next/packages/nuqs/src/useQueryState.test.ts#L58-L63

[uniqueeest]

@franky47 Thank you so much! The test was successful

[franky47]

I tried replicating your issue (in case the docs were wrong) but the test passes without act on my end, what's your testing setup?

[uniqueeest]

// vitest.setup.ts
import 'reflect-metadata';
// import '@testing-library/jest-dom';
// ReferenceError: expect is not defined "vitest"
// https://github.com/vitest-dev/vitest/issues/1504
import matchers from '@testing-library/jest-dom/matchers';
import { configure } from '@testing-library/react';
import { expect } from 'vitest';

expect.extend(matchers);

"nuqs": "^2.4.0",

"vitest": "^2.1.5"
"@testing-library/react": "^13.1.1",
"@testing-library/user-event": "^14.5.2",

It's set up like this

[franky47]

Thanks, even with those versions and setup I still have the original test pass.. Oh well, if act solved your issue, that's all that matters I guess.