Is it safe to create a memory router inside a component for testing?

[rayrw]

Hi! I'm currently migrating from v6.3 to v6.22.1, and would like to ask about memory router being used in the testing environment.

Since some of the code base has been migrated to use the useBlocker hook, I have to use new router API. However, it would be too much of work to migrate all existence of the previous MemoryRouter component API to the new router API.

I was thinking to wrap the new router API in a temporary small transitional component, where it calls createMemoryRouter only once when mounting the component, so that I could migrate with just a global replacement of MemoryRouter -> TemporaryMemoryRouter. Also, the code base is still relying on the Routes API.

Is there any concern with this approach? I would love to hear any comments on it.
Thank you very much for your time!

export function TemporaryMemoryRouter({
  initialEntries,
  initialIndex,
  children = <DefaultTestPageContent />,
}: TestRouterPageProps) {
  // Wrapping it in useState with lazy initialization to ensure it is created only once
  const [router] = useState(() =>
    createMemoryRouter(
      [
        {
          path: '*',
          element: children,
        },
      ],
      {
        initialEntries,
        initialIndex,
      }
    )
  );

  return <RouterProvider router={router} />;
}

// Sample usage
test('my test', async () => {
  render(
    <TemporaryMemoryRouter initialEntries={[`/my-url/`]}>
        <Routers>
          <Route path="/my-url/" element={<SomePageComponent />} />
        </Routes>
    </TemporaryMemoryRouter>
  )

  // ...
});