fix(react-router): lazyRouteComponent reload guard key fallsback to importer's import.meta.url on Safari

[Sheraff]

Fixes #3327

This PR might be easier to review as commit-by-commit (because there are many changes in generated files packages/router-plugin/tests/code-splitter/snapshots/...).

• e2e/react-router/basic-file-based-code-splitting
  Add an E2E playwright spec for validating the reload behavior of pages where a lazy import fails to load
• packages/react-router/src/lazyRouteComponent.tsx
  Accept a 4th parameter to provide a unique key to the sessionStorage entry used as a reload guard on a failed lazy load
• packages/router-generator/src/generator.ts and packages/router-plugin/src/core/code-splitter/compilers.ts
  Provide 4th parameter to lazyRouteComponent calls as import.meta.url. This is native in browsers, so should be "bundler independant" (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import.meta).

Note

The playwright spec added by this PR tests a behavior that might be browser-specific. However, the E2E tests run on chromium only. Maybe it might be worth it to enable multiple "projects" in playwright?

See implementation:

router/packages/react-router/src/lazyRouteComponent.tsx

Lines 10 to 20 in adcdde4

	function isModuleNotFoundError(error: any): boolean {
	// chrome: "Failed to fetch dynamically imported module: http://localhost:5173/src/routes/posts.index.tsx?tsr-split"
	// firefox: "error loading dynamically imported module: http://localhost:5173/src/routes/posts.index.tsx?tsr-split"
	// safari: "Importing a module script failed."
	if (typeof error?.message !== 'string') return false
	return (
	error.message.startsWith('Failed to fetch dynamically imported module') ||
	error.message.startsWith('error loading dynamically imported module') ||
	error.message.startsWith('Importing a module script failed')
	)
	}

---

In a future PR, it might be a good idea to apply the same (or similar) behavior on import fail to the lazyFn since it's used in a way that feels similar to lazyRouteComponent, but has no error handling.

router/packages/react-router/src/router.ts

Lines 3060 to 3073 in adcdde4

	// A function that takes an import() argument which is a function and returns a new function that will
	// proxy arguments from the caller to the imported function, retaining all type
	// information along the way
	export function lazyFn<
	T extends Record<string, (...args: Array<any>) => any>,
	TKey extends keyof T = 'default',
	>(fn: () => Promise<T>, key?: TKey) {
	return async (
	...args: Parameters<T[TKey]>
	): Promise<Awaited<ReturnType<T[TKey]>>> => {
	const imported = await fn()
	return imported[key || 'default'](...args)
	}
	}

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 5ffcb02.

Command	Status	Duration	Result
nx affected --targets=test:eslint,test:unit,tes...	✅ Succeeded	4m 22s	View ↗
nx run-many --target=build --exclude=examples/*...	✅ Succeeded	1m 23s	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-02-16 11:59:54 UTC

[pkg-pr-new]

Open in Stackblitz

More templates

• tanstack-router-react-example-authenticated-routes
• tanstack-router-react-example-basic
• tanstack-router-react-example-basic-default-search-params
• tanstack-router-react-example-basic-file-based
• tanstack-router-react-example-basic-file-based-codesplitting
• tanstack-router-react-example-react-query
• tanstack-router-react-example-basic-ssr-file-based
• tanstack-router-react-example-basic-react-query-file-based
• tanstack-router-react-example-basic-ssr-streaming-file-based
• tanstack-router-react-example-basic-virtual-file-based
• tanstack-router-react-example-basic-virtual-inside-file-based
• tanstack-router-react-example-deferred-data
• tanstack-router-react-example-kitchen-sink
• tanstack-router-react-example-kitchen-sink-file-based
• tanstack-router-react-example-kitchen-sink-react-query
• tanstack-router-react-example-kitchen-sink-react-query-file-based
• tanstack-router-react-example-large-file-based
• tanstack-router-react-example-location-masking
• tanstack-router-react-example-navigation-blocking
• tanstack-router-react-example-quickstart
• tanstack-router-react-example-quickstart-esbuild-file-based
• tanstack-router-react-example-quickstart-file-based
• tanstack-router-react-example-quickstart-rspack-file-based
• tanstack-router-react-example-quickstart-webpack-file-based
• router-mono-simple-lazy
• router-mono-simple
• router-monorepo-react-query
• tanstack-router-react-example-scroll-restoration
• tanstack-start-example-basic
• tanstack-search-validator-adapters
• tanstack-start-example-basic-react-query
• tanstack-start-example-basic-auth
• tanstack-start-example-basic-rsc
• tanstack-start-example-basic-static
• tanstack-start-example-clerk-basic
• tanstack-start-example-convex-trellaux
• tanstack-start-example-counter
• tanstack-start-example-large
• tanstack-start-example-supabase-basic
• tanstack-router-react-example-with-framer-motion
• tanstack-start-example-trellaux
• tanstack-router-react-example-with-trpc-react-query
• tanstack-router-react-example-with-trpc

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3450

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3450

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3450

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3450

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3450

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3450

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3450

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3450

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3450

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3450

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3450

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3450

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3450

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3450

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3450

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3450

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3450

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3450

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3450

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3450

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3450

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3450

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3450

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3450

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3450

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3450

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3450

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3450

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3450

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3450

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3450

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3450

commit: 5ffcb02