Routeloader split by wmertens · Pull Request #8501 · QwikDev/qwik

wmertens · 2026-03-28T14:53:14Z

opening for visibility

changeset-bot · 2026-03-28T14:53:21Z

🦋 Changeset detected

Latest commit: 9cca76c

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Varixo

Great work! Added some comments/questions

Varixo · 2026-04-04T18:22:42Z

.changeset/green-experts-turn.md

@@ -0,0 +1,3 @@
+'@qwik.dev/router': minor
+
+Refactor route loaders to be backed by shared async signals across SSR, client refresh, and action invalidation.


format here is wrong

Varixo · 2026-04-04T18:33:08Z

packages/qwik-router/src/buildtime/runtime-generation/generate-routes.ts

+    const routeFiles = node._files
+      .filter((f) => f.type === 'route' || f.type === 'layout')
+      .map((f) => f.filePath);


how much performance matters here?

not much, it's build time, so a few ms won't matter

Varixo · 2026-04-04T18:43:08Z

packages/qwik-router/src/middleware/request-handler/handlers/action-handler.ts

+      const result = await runValidators(requestEv, action.__validators, data, devMode);
+      if (!result.success) {
+        actionError = requestEv.fail(result.status ?? 500, result.error);
+      } else {
+        const actionResolved = devMode
+          ? await measure(requestEv, action.__qrl.getHash(), () =>
+              action!.__qrl.call(requestEv, result.data as JSONObject, requestEv)
+            )
+          : await action.__qrl.call(requestEv, result.data as JSONObject, requestEv);
+        if (devMode) {
+          verifySerializable(actionResolved, action.__qrl);
+        }
+        if (actionResolved instanceof ServerError) {
+          actionError = actionResolved;
+        } else {
+          actionData = actionResolved;
+        }
+      }
+    } catch (err) {
+      if (err instanceof ServerError) {
+        actionError = err;
+      } else if (err instanceof Error) {
+        console.error('Action error:', err);
+        actionError = new ServerError(500, 'Internal Server Error');
+      } else {
+        // RedirectMessage, AbortMessage, etc. — re-throw for middleware
+        throw err;
+      }
+    }


maybe wrap with something like executeAction?

packages/qwik-router/src/middleware/request-handler/handlers/action-handler.ts

Varixo · 2026-04-04T18:45:35Z

packages/qwik-router/src/middleware/request-handler/handlers/action-handler.ts

+function now() {
+  return typeof performance !== 'undefined' ? performance.now() : 0;
+}


this should be moved to some utils

Varixo · 2026-04-04T19:15:08Z

packages/qwik-router/src/runtime/src/route-loaders.ts

+/** @public */
+export const routeLoader$: LoaderConstructor = /*#__PURE__*/ implicit$FirstArg(routeLoaderQrl);
+
+async function runValidators(


similar function in action-handler.ts

Varixo · 2026-04-04T19:15:31Z

packages/qwik-router/src/runtime/src/routing.ts

+    if (g._R && loaderHashes) {
+      loaderHashes.push(...g._R);
+      if (loaderPathsByHash) {
+        for (const hash of g._R) {


avoid for of

Varixo · 2026-04-04T19:15:41Z

packages/qwik-router/src/runtime/src/routing.ts

+  if (node._R && loaderHashes) {
+    loaderHashes.push(...node._R);
+    if (loaderPathsByHash) {
+      for (const hash of node._R) {


and here too. I wont make more comments about for of, maybe we should enable the eslint rule for qwik router too

Varixo · 2026-04-04T19:18:14Z

packages/qwik-router/src/runtime/src/types.ts

  params: PathParams;
  response: EndpointResponse;
  loadedRoute: LoadedRoute;
+  routeLoaderCtx: import('./route-loaders').RouteLoaderCtx;


we we cant import this type normally?

Varixo · 2026-04-04T19:19:20Z

packages/qwik-router/src/runtime/src/utils.unit.ts

-[
-  { pathname: '/', expect: '/q-data.json' },
-  { pathname: '/about', expect: '/about/q-data.json' },
-  { pathname: '/about/', expect: '/about/q-data.json' },
-].forEach((t) => {
-  test(`getClientEndpointUrl("${t.pathname}")`, () => {
-    const endpointPath = getClientDataPath(t.pathname);
-    assert.equal(endpointPath, t.expect);
-  });
-});
-
-[
-  { pathname: '/', search: '?foo=bar', expect: '/q-data.json?foo=bar' },
-  { pathname: '/about', search: '?foo=bar', expect: '/about/q-data.json?foo=bar' },
-  { pathname: '/about/', search: '?foo=bar', expect: '/about/q-data.json?foo=bar' },
-  { pathname: '/about/', search: '?foo=bar&baz=qux', expect: '/about/q-data.json?foo=bar&baz=qux' },
-].forEach((t) => {
-  test(`getClientEndpointUrl("${t.pathname}", "${t.search}")`, () => {
-    const endpointPath = getClientDataPath(t.pathname, t.search);
-    assert.equal(endpointPath, t.expect);
-  });
-});
-


should we move these tests?

github-actions · 2026-04-08T13:53:00Z

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name	Status	Preview	Last Commit
qwik-docs	✅ Ready (View Log)	Visit Preview	`8f666d8`

Replace the monolithic q-data.json endpoint with per-loader q-loader-{id}.{manifestHash}.json endpoints. Each routeLoader$ gets its own cacheable JSON endpoint. Key changes: - Route trie includes loader hashes per route segment - New loaderHandler returns individual loader data as {d, r, e} envelope - New jsonRequestWrapper captures middleware redirects/errors for JSON requests - Action handler split into separate handlers/action-handler.ts - Route loader signals use AsyncSignal with reactive tracking of route paths - SPA navigation awaits loader promises with navCount-based redirect detection - SSG updated for per-loader endpoints - Core: export additional internals needed by router spec tests Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…ng, unify wire format - ActionStore gains .error (ServerError with data spread directly) and .loading - .value now contains only success data (Exclude<RETURN, ServerError>) - fail() returns ServerError instead of { failed: true, ...data } - Action wire format unified to {d, e, s, h, l} envelope - Non-ServerError throws caught with console.error, sent as generic 500 - Action type gains ERROR type parameter for typed validator errors - FailReturn deprecated (alias for ServerError<T> & T) - RedirectMessage/AbortMessage re-thrown (not Error instances) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add jsonRequestWrapper handler that wraps next() in try/catch for q-loader and q-action JSON requests. Middleware redirects/errors are captured into JSON envelopes ({r} for loaders, {e,s} for actions) instead of propagating as HTTP redirects/error pages. - Loader redirects: returned as {r: url} in LoaderResponse envelope - Action redirects: re-thrown (client handles via response.redirected) - Errors: wrapped as ServerError in both loader and action envelopes - Dev mode: error messages include original error text - SSR loadersMiddleware: unchanged, errors propagate for middleware

routeLoader$ now accepts an `eTag` option for ETag-based caching of q-loader-*.json responses: - `eTag: true` — auto-hash serialized data (loader runs, then checks) - `eTag: "version"` — static eTag (304 returned before loader runs) - `eTag: (ev) => string|null` — dynamic from request context (params, URL, etc.), 304 returned before loader runs For string/function eTags, the loader is skipped entirely on cache hit. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

routeLoader$ now accepts a `search` option — an allowlist of URL search parameter names the loader depends on. When set: - Only re-fetches when the listed search params change - Other param changes are ignored (returns previous value) - Only the listed params are sent in the loader JSON request URL When not set: all params sent, any change triggers re-fetch (current behavior). Example: `routeLoader$(fn, { search: ['sort', 'page'] })` Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

- Use page.waitForURL() after SPA navigation clicks before asserting content. URL changes complete before loader data renders, providing a stable synchronization point. - Assert loader-dependent values first (they change between routes) before checking static values (same title on both routes). - Increase timeout for loader redirect test (multi-step: fetch → {r} envelope → goto). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add strictLoaders Vite plugin option (default: true) that makes loaders default to search:[] and actions default to invalidate:[]. This maximizes cacheability. Add allowStale option to LoaderOptions, passed through to the AsyncSignal. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

node 24 compat

maiieul assigned wmertens Mar 28, 2026

maiieul added this to Qwik Development Mar 28, 2026

maiieul moved this to In progress in Qwik Development Mar 28, 2026

wmertens added Router V2 labels Mar 28, 2026

wmertens changed the base branch from main to build/v2 March 28, 2026 14:53

wmertens force-pushed the routeloader-split branch 3 times, most recently from 07ecc7d to 042e959 Compare March 30, 2026 22:11

wmertens mentioned this pull request Mar 31, 2026

[🐞] q-data should be split into separate loaders #8509

Open

wmertens force-pushed the routeloader-split branch 2 times, most recently from 822296f to 627914d Compare April 1, 2026 22:43

Varixo reviewed Apr 4, 2026

View reviewed changes

wmertens force-pushed the routeloader-split branch 3 times, most recently from 4dd423a to d296b44 Compare April 8, 2026 13:40

wmertens force-pushed the routeloader-split branch 2 times, most recently from 0c064d3 to bea64ae Compare April 8, 2026 17:37

wmertens and others added 7 commits April 8, 2026 21:22

wmertens force-pushed the routeloader-split branch from bea64ae to 016112d Compare April 8, 2026 19:22

wmertens added 2 commits April 9, 2026 08:14

fix(router): don't use mangled qwik method

9e85b56

fix(e2e): more robust tests

03acfaf

wmertens added 2 commits April 9, 2026 08:14

chore(ci): fix e2e test results, bump action versions

4d11701

node 24 compat

chore: adjust docs size, not sure which commit caused it

9cca76c

wmertens force-pushed the routeloader-split branch from 8f666d8 to 9cca76c Compare April 9, 2026 06:14

		@@ -0,0 +1,3 @@
		'@qwik.dev/router': minor

		Refactor route loaders to be backed by shared async signals across SSR, client refresh, and action invalidation.

Conversation

wmertens commented Mar 28, 2026

Uh oh!

changeset-bot bot commented Mar 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Varixo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

changeset-bot bot commented Mar 28, 2026 •

edited

Loading

github-actions bot commented Apr 8, 2026 •

edited

Loading