feat: global config for loader serialization strategy

Author: Varixo

packages/docs/src/routes/docs/(qwikrouter)/route-loader/index.mdx

@@ -193,6 +193,28 @@ export const Child = component$(() => {
 });
 ```
 
+### Global default serialization strategy
+It is possible to set a global default serialization strategy for all `routeLoader$`s in your application. This can be done by configuring the `qwikRouter` Vite plugin.
+Default value is `never`.
+
+```ts title="vite.config.ts"
+import { qwikRouter } from '@qwik.dev/vite-plugin-qwik-router';
+
+export default () => {
+  return {
+    //...
+    plugins: [
+      //...
+      qwikRouter({
+        // Set the default serialization strategy for all route loaders
+        defaultSerializationStrategy: 'always', // 'never' | 'always' | 'auto'
+      }),
+      //...
+    ],
+  }
+};
+```
+
 ## RequestEvent
 
 Just like [middleware](/docs/middleware/) or [endpoint](/docs/endpoints/) `onRequest` and `onGet`, `routeLoader$`s have access to the [`RequestEvent`](/docs/middleware#requestevent) API which includes information about the current HTTP request.

packages/qwik-router/global.d.ts

@@ -4,6 +4,7 @@
 type RequestEventInternal =
   import('./middleware/request-handler/request-event').RequestEventInternal;
 type AsyncStore = import('node:async_hooks').AsyncLocalStorage<RequestEventInternal>;
+type SerializationStrategy = import('@qwik.dev/core/internal').SerializationStrategy;
 
 declare var qcAsyncRequestStore: AsyncStore | undefined;
 declare var _qwikActionsMap: Map<string, ActionInternal> | undefined;
@@ -18,3 +19,5 @@ type ExperimentalFeatures = import('@qwik.dev/core/optimizer').ExperimentalFeatu
 declare var __EXPERIMENTAL__: {
   [K in ExperimentalFeatures]: boolean;
 };
+
+declare var __DEFAULT_LOADERS_SERIALIZATION_STRATEGY__: SerializationStrategy;

packages/qwik-router/src/buildtime/markdown/markdown-url.unit.ts

@@ -80,6 +80,7 @@ const menuFilePath = join(routesDir, 'docs', 'menu.md');
       mdx: {},
       platform: {},
       rewriteRoutes: [],
+      defaultLoadersSerializationStrategy: 'never',
     };
     assert.equal(getMarkdownRelativeUrl(opts, menuFilePath, t.href), t.expect);
   });

packages/qwik-router/src/buildtime/routing/resolve-source-file.unit.ts

@@ -49,6 +49,7 @@ test('resolveLayout', () => {
       mdx: {},
       platform: {},
       rewriteRoutes: [],
+      defaultLoadersSerializationStrategy: 'never',
     };
     const sourceFile: RouteSourceFile = {
       ...getSourceFile(c.fileName)!,

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

@@ -1,3 +1,5 @@
+import type { SerializationStrategy } from '@qwik.dev/core/internal';
+
 export interface BuildContext {
   rootDir: string;
   opts: NormalizedPluginOptions;
@@ -133,6 +135,8 @@ export interface PluginOptions {
   platform?: Record<string, unknown>;
   /** Configuration to rewrite url paths */
   rewriteRoutes?: RewriteRouteOption[];
+  /** The serialization strategy for route loaders. Defaults to `never`. */
+  defaultLoadersSerializationStrategy?: SerializationStrategy;
 }
 
 export interface MdxPlugins {

packages/qwik-router/src/buildtime/vite/plugin.ts

@@ -78,6 +78,11 @@ function qwikRouterPlugin(userOpts?: QwikRouterVitePluginOptions): any {
 
     async config() {
       const updatedViteConfig: UserConfig = {
+        define: {
+          'globalThis.__DEFAULT_LOADERS_SERIALIZATION_STRATEGY__': JSON.stringify(
+            userOpts?.defaultLoadersSerializationStrategy || 'never'
+          ),
+        },
         appType: 'custom',
         resolve: {
           alias: [

packages/qwik-router/src/buildtime/vite/plugin.unit.ts

@@ -0,0 +1,28 @@
+import { describe, expect, it } from 'vitest';
+import { qwikRouter } from './plugin';
+
+describe('qwikRouter plugin', () => {
+  describe('defaultLoadersSerializationStrategy', () => {
+    it('should set the defaultLoadersSerializationStrategy to "never" when not provided', async () => {
+      const plugins = qwikRouter();
+
+      await expect((plugins[0] as any)?.config?.()).resolves.toMatchObject({
+        define: {
+          'globalThis.__DEFAULT_LOADERS_SERIALIZATION_STRATEGY__': '"never"',
+        },
+      });
+    });
+
+    it('should set the defaultLoadersSerializationStrategy to "always" when provided', async () => {
+      const plugins = qwikRouter({
+        defaultLoadersSerializationStrategy: 'always',
+      });
+
+      await expect((plugins[0] as any)?.config?.()).resolves.toMatchObject({
+        define: {
+          'globalThis.__DEFAULT_LOADERS_SERIALIZATION_STRATEGY__': '"always"',
+        },
+      });
+    });
+  });
+});

packages/qwik-router/src/buildtime/vite/qwik-router.buildtime.api.md

@@ -10,6 +10,7 @@ import type { Config } from 'svgo';
 import { ConfigEnv } from 'vite';
 import type { Plugin as Plugin_2 } from 'vite';
 import type { PluginOption } from 'vite';
+import type { SerializationStrategy } from '@qwik.dev/core/internal';
 import { UserConfigExport } from 'vite';
 
 // @public (undocumented)

packages/qwik-router/src/middleware/request-handler/request-event.ts

@@ -34,8 +34,8 @@ const RequestEvLoaders = Symbol('RequestEvLoaders');
 const RequestEvMode = Symbol('RequestEvMode');
 const RequestEvRoute = Symbol('RequestEvRoute');
 export const RequestEvQwikSerializer = Symbol('RequestEvQwikSerializer');
-export const RequestEvLoadersSerializationStrategy = Symbol(
-  'RequestEvLoadersSerializationStrategy'
+export const RequestEvLoaderSerializationStrategyMap = Symbol(
+  'RequestEvLoaderSerializationStrategyMap'
 );
 export const RequestEvTrailingSlash = Symbol('RequestEvTrailingSlash');
 export const RequestRouteName = '@routeName';
@@ -153,7 +153,7 @@ export function createRequestEvent(
   const loaders: Record<string, Promise<any>> = {};
   const requestEv: RequestEventInternal = {
     [RequestEvLoaders]: loaders,
-    [RequestEvLoadersSerializationStrategy]: new Map(),
+    [RequestEvLoaderSerializationStrategyMap]: new Map(),
     [RequestEvMode]: serverRequestEv.mode,
     [RequestEvTrailingSlash]: trailingSlash,
     get [RequestEvRoute]() {
@@ -333,7 +333,7 @@ export function createRequestEvent(
 
 export interface RequestEventInternal extends RequestEvent, RequestEventLoader {
   [RequestEvLoaders]: Record<string, ValueOrPromise<unknown> | undefined>;
-  [RequestEvLoadersSerializationStrategy]: Map<string, SerializationStrategy>;
+  [RequestEvLoaderSerializationStrategyMap]: Map<string, SerializationStrategy>;
   [RequestEvMode]: ServerRequestMode;
   [RequestEvTrailingSlash]: boolean;
   [RequestEvRoute]: LoadedRoute | null;
@@ -364,8 +364,8 @@ export function getRequestLoaders(requestEv: RequestEventCommon) {
   return (requestEv as RequestEventInternal)[RequestEvLoaders];
 }
 
-export function getRequestLoadersSerializationStrategy(requestEv: RequestEventCommon) {
-  return (requestEv as RequestEventInternal)[RequestEvLoadersSerializationStrategy];
+export function getRequestLoaderSerializationStrategyMap(requestEv: RequestEventCommon) {
+  return (requestEv as RequestEventInternal)[RequestEvLoaderSerializationStrategyMap];
 }
 
 export function getRequestTrailingSlash(requestEv: RequestEventCommon) {

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

@@ -24,7 +24,7 @@ import {
   RequestEvSharedActionId,
   RequestRouteName,
   getRequestLoaders,
-  getRequestLoadersSerializationStrategy,
+  getRequestLoaderSerializationStrategyMap,
   getRequestMode,
   getRequestTrailingSlash,
   type RequestEventInternal,
@@ -301,7 +301,7 @@ async function getRouteLoaderPromise(
       }
       return resolvedLoader;
     });
-  const loadersSerializationStrategy = getRequestLoadersSerializationStrategy(requestEv);
+  const loadersSerializationStrategy = getRequestLoaderSerializationStrategyMap(requestEv);
   loadersSerializationStrategy.set(loaderId, loader.__serializationStrategy);
   return loaders[loaderId];
 }