feat: use custom serialization

Author: Varixo

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

@@ -1,12 +1,13 @@
 import type { ValueOrPromise } from '@qwik.dev/core';
 import type { QwikManifest, ResolvedManifest } from '@qwik.dev/core/optimizer';
 import { QDATA_KEY } from '../../runtime/src/constants';
-import type {
-  ActionInternal,
-  FailReturn,
-  JSONValue,
-  LoadedRoute,
-  LoaderInternal,
+import {
+  LoadedRouteProp,
+  type ActionInternal,
+  type FailReturn,
+  type JSONValue,
+  type LoadedRoute,
+  type LoaderInternal,
 } from '../../runtime/src/types';
 import { isPromise } from '../../runtime/src/utils';
 import { createCacheControl } from './cache-control';
@@ -149,7 +150,7 @@ export function createRequestEvent(
     env,
     method: request.method,
     signal: request.signal,
-    params: loadedRoute?.[1] ?? {},
+    params: loadedRoute?.[LoadedRouteProp.Params] ?? {},
     pathname: url.pathname,
     platform,
     query: url.searchParams,

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

@@ -1,4 +1,5 @@
-import type { QRL } from '@qwik.dev/core';
+import { type QRL } from '@qwik.dev/core';
+import { SerializerSymbol, _UNINITIALIZED } from '@qwik.dev/core/internal';
 import type { Render, RenderToStringResult } from '@qwik.dev/core/server';
 import { QACTION_KEY, QFN_KEY, QLOADER_KEY } from '../../runtime/src/constants';
 import {
@@ -30,7 +31,6 @@ import {
 import { getQwikRouterServerData } from './response-page';
 import type { QwikSerializer, RequestEvent, RequestEventBase, RequestHandler } from './types';
 import { IsQData, QDATA_JSON } from './user-response';
-import { _UNINITIALIZED } from '@qwik.dev/core/internal';
 
 export const resolveRequestHandlers = (
   serverPlugins: RouteModule[] | undefined,
@@ -595,6 +595,9 @@ export async function renderQData(requestEv: RequestEvent) {
   const loaders: Record<string, unknown> = {};
   for (const loaderId in allLoaders) {
     const loader = allLoaders[loaderId];
+    if (typeof loader === 'object' && loader !== null && SerializerSymbol in loader) {
+      delete (loader as any)[SerializerSymbol];
+    }
     if (loader !== _UNINITIALIZED) {
       loaders[loaderId] = loader;
     }

packages/qwik-router/src/middleware/request-handler/response-page.ts

@@ -1,3 +1,5 @@
+import { SerializerSymbol } from '@qwik.dev/core';
+import { _UNINITIALIZED } from '@qwik.dev/core/internal';
 import type { QwikRouterEnvData } from '../../runtime/src/types';
 import {
   getRequestLoaders,
@@ -8,6 +10,7 @@ import {
   RequestRouteName,
 } from './request-event';
 import type { RequestEvent } from './types';
+import { Q_ROUTE } from '../../runtime/src/constants';
 
 export function getQwikRouterServerData(requestEv: RequestEvent) {
   const { url, params, request, status, locale } = requestEv;
@@ -30,13 +33,28 @@ export function getQwikRouterServerData(requestEv: RequestEvent) {
     reconstructedUrl.protocol = protocol;
   }
 
+  const loaders = getRequestLoaders(requestEv);
+
+  // shallow serialize loaders data
+  (loaders as any)[SerializerSymbol] = (loaders: Record<string, unknown>) => {
+    const result: Record<string, unknown> = {};
+    for (const key in loaders) {
+      const loader = loaders[key];
+      if (typeof loader === 'object' && loader !== null) {
+        (loader as any)[SerializerSymbol] = () => _UNINITIALIZED;
+      }
+      result[key] = _UNINITIALIZED;
+    }
+    return result;
+  };
+
   return {
     url: reconstructedUrl.href,
     requestHeaders,
     locale: locale(),
     nonce,
     containerAttributes: {
-      'q:route': routeName,
+      [Q_ROUTE]: routeName,
     },
     qwikrouter: {
       routeName,
@@ -45,7 +63,7 @@ export function getQwikRouterServerData(requestEv: RequestEvent) {
       loadedRoute: getRequestRoute(requestEv),
       response: {
         status: status(),
-        loaders: getRequestLoaders(requestEv),
+        loaders,
         action,
         formData,
       },

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

@@ -13,3 +13,5 @@ export const QLOADER_KEY = 'qloader';
 export const QFN_KEY = 'qfunc';
 
 export const QDATA_KEY = 'qdata';
+
+export const Q_ROUTE = 'q:route';

packages/qwik-router/src/runtime/src/qwik-router-component.tsx

@@ -20,11 +20,10 @@ import {
   _getContextElement,
   _getQContainerElement,
   _waitUntilRendered,
-  _weakSerialize,
   type _ElementVNode,
 } from '@qwik.dev/core/internal';
 import { clientNavigate } from './client-navigate';
-import { CLIENT_DATA_CACHE } from './constants';
+import { CLIENT_DATA_CACHE, Q_ROUTE } from './constants';
 import {
   ContentContext,
   ContentInternalContext,
@@ -146,7 +145,7 @@ export const QwikRouterProvider = component$<QwikRouterProps>((props) => {
     { deep: false }
   );
   const navResolver: { r?: () => void } = {};
-  const loaderState = useStore(_weakSerialize(env.response.loaders), { deep: false });
+  const loaderState = useStore(env.response.loaders, { deep: false });
   const routeInternal = useSignal<RouteStateInternal>({
     type: 'initial',
     dest: url,
@@ -641,7 +640,7 @@ export const QwikRouterProvider = component$<QwikRouterProps>((props) => {
           clientNavigate(window, navType, prevUrl, trackUrl, replaceState);
           _waitUntilRendered(elm as Element).then(() => {
             const container = _getQContainerElement(elm as _ElementVNode)!;
-            container.setAttribute('q:route', routeName);
+            container.setAttribute(Q_ROUTE, routeName);
             const scrollState = currentScrollState(scroller);
             saveScrollHistory(scrollState);
             win._qRouterScrollEnabled = true;

packages/qwik-router/src/runtime/src/server-functions.ts

@@ -7,13 +7,16 @@ import {
   type ValueOrPromise,
   untrack,
   isBrowser,
+  isDev,
+  isServer,
 } from '@qwik.dev/core';
 import {
   _deserialize,
   _getContextElement,
   _getContextEvent,
   _serialize,
   _wrapStore,
+  _useInvokeContext,
   _UNINITIALIZED,
 } from '@qwik.dev/core/internal';
 
@@ -54,9 +57,6 @@ import type {
 } from './types';
 import { useAction, useLocation, useQwikRouterEnv } from './use-functions';
 
-import { isDev, isServer } from '@qwik.dev/core';
-import { _useInvokeContext } from '@qwik.dev/core/internal';
-
 import type { FormSubmitCompletedDetail } from './form-component';
 import { deepFreeze } from './utils';
 import { loadClientData } from './use-endpoint';

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

@@ -36,21 +36,16 @@ export const getClientDataPath = (
     loaderIds?: string[];
   }
 ) => {
-  const search = new URLSearchParams(pageSearch);
+  let search = pageSearch ?? '';
   if (options?.actionId) {
-    search.set(QACTION_KEY, options.actionId);
-  } else if (options?.loaderIds) {
-    for (const id of options.loaderIds) {
-      search.append(QLOADER_KEY, id);
+    search += (search ? '&' : '?') + QACTION_KEY + '=' + encodeURIComponent(options.actionId);
+  }
+  if (options?.loaderIds) {
+    for (const loaderId of options.loaderIds) {
+      search += (search ? '&' : '?') + QLOADER_KEY + '=' + encodeURIComponent(loaderId);
     }
   }
-  const searchString = search.toString();
-  return (
-    pathname +
-    (pathname.endsWith('/') ? '' : '/') +
-    'q-data.json' +
-    (searchString.length ? '?' + searchString : '')
-  );
+  return pathname + (pathname.endsWith('/') ? '' : '/') + 'q-data.json' + search;
 };
 
 export const getClientNavPath = (props: Record<string, any>, baseUrl: { url: URL }) => {

packages/qwik/src/core/api.md

@@ -244,11 +244,9 @@ export class _EffectData {
     data: NodePropData;
 }
 
-// Warning: (ae-forgotten-export) The symbol "VNodeFlags" needs to be exported by the entry point index.d.ts
-//
 // @internal (undocumented)
 export type _ElementVNode = [
-VNodeFlags.Element,
+_VNodeFlags.Element,
 ////////////// 0 - Flags
 _VNode | null,
 /////////////// 1 - Parent
@@ -1568,7 +1566,7 @@ export type TaskFn = (ctx: TaskCtx) => ValueOrPromise<void | (() => void)>;
 
 // @internal (undocumented)
 export type _TextVNode = [
-VNodeFlags.Text | VNodeFlags.Inflated,
+_VNodeFlags.Text | _VNodeFlags.Inflated,
 // 0 - Flags
 _VNode | null,
 ///////////////// 1 - Parent
@@ -1740,7 +1738,7 @@ export const version: string;
 
 // @internal (undocumented)
 export type _VirtualVNode = [
-VNodeFlags.Virtual,
+_VNodeFlags.Virtual,
 ///////////// 0 - Flags
 _VNode | null,
 /////////////// 1 - Parent
@@ -1762,6 +1760,40 @@ export type VisibleTaskStrategy = 'intersection-observer' | 'document-ready' | '
 // @internal (undocumented)
 export type _VNode = _ElementVNode | _TextVNode | _VirtualVNode;
 
+// @internal
+export const enum _VNodeFlags {
+    // (undocumented)
+    Deleted = 32,
+    // (undocumented)
+    Element = 1,
+    // (undocumented)
+    ELEMENT_OR_TEXT_MASK = 5,
+    // (undocumented)
+    ELEMENT_OR_VIRTUAL_MASK = 3,
+    // (undocumented)
+    Inflated = 8,
+    // (undocumented)
+    INFLATED_TYPE_MASK = 15,
+    // (undocumented)
+    NAMESPACE_MASK = 192,
+    // (undocumented)
+    NEGATED_NAMESPACE_MASK = -193,
+    // (undocumented)
+    NS_html = 0,
+    // (undocumented)
+    NS_math = 128,
+    // (undocumented)
+    NS_svg = 64,
+    // (undocumented)
+    Resolved = 16,
+    // (undocumented)
+    Text = 4,// http://www.w3.org/1999/xhtml
+    // (undocumented)
+    TYPE_MASK = 7,// http://www.w3.org/2000/svg
+    // (undocumented)
+    Virtual = 2
+}
+
 // @internal (undocumented)
 export const _waitUntilRendered: (elm: Element) => Promise<void>;
 
@@ -1773,9 +1805,6 @@ export function _walkJSX(ssr: SSRContainer, value: JSXOutput, options: {
     parentComponentFrame: ISsrComponentFrame | null;
 }): Promise<void>;
 
-// @internal (undocumented)
-export const _weakSerialize: <T extends object>(input: T) => Partial<T>;
-
 // @public
 export function withLocale<T>(locale: string, fn: () => T): T;
 

packages/qwik/src/core/internal.ts

@@ -7,7 +7,6 @@ export { _wrapSignal, _wrapProp, _wrapStore } from './signal/signal-utils';
 export { _restProps } from './shared/utils/prop';
 export { _IMMUTABLE, _UNINITIALIZED } from './shared/utils/constants';
 export { _CONST_PROPS, _VAR_PROPS } from './shared/utils/constants';
-export { _weakSerialize } from './shared/utils/serialize-utils';
 export { verifySerializable as _verifySerializable } from './shared/utils/serialize-utils';
 export {
   _getContextElement,
@@ -21,6 +20,7 @@ export { _fnSignal } from './shared/qrl/inlined-fn';
 export type {
   ContainerElement as _ContainerElement,
   VNode as _VNode,
+  VNodeFlags as _VNodeFlags,
   VirtualVNode as _VirtualVNode,
   TextVNode as _TextVNode,
   QDocument as _QDocument,

packages/qwik/src/core/shared/shared-serialization.ts

@@ -56,7 +56,7 @@ import { isElement, isNode } from './utils/element';
 import { EMPTY_ARRAY, EMPTY_OBJ } from './utils/flyweight';
 import { ELEMENT_ID } from './utils/markers';
 import { isPromise } from './utils/promises';
-import { SerializerSymbol, fastSkipSerialize, fastWeakSerialize } from './utils/serialize-utils';
+import { SerializerSymbol, fastSkipSerialize } from './utils/serialize-utils';
 import { type ValueOrPromise } from './utils/types';
 
 const deserializedProxyMap = new WeakMap<object, unknown[]>();
@@ -400,16 +400,6 @@ const inflate = (
       effectData.data.$isConst$ = (data as any[])[1];
       break;
     }
-    case TypeIds.WeakObject: {
-      const objectKeys = data as string[];
-      target = Object.fromEntries(
-        objectKeys.map((v) =>
-          // initialize values with null
-          [v, _UNINITIALIZED]
-        )
-      );
-      break;
-    }
     default:
       throw qError(QError.serializeErrorNotImplemented, [typeId]);
   }
@@ -472,7 +462,6 @@ const allocate = (container: DeserializeContainer, typeId: number, value: unknow
     case TypeIds.Array:
       return wrapDeserializerProxy(container as any, value as any[]);
     case TypeIds.Object:
-    case TypeIds.WeakObject:
       return {};
     case TypeIds.QRL:
       const qrl = container.$getObjectById$(value as number);
@@ -827,20 +816,15 @@ export const createSerializationContext = (
         vnode_isVNode(obj) ||
         (typeof FormData !== 'undefined' && obj instanceof FormData) ||
         // Ignore the no serialize objects
-        fastSkipSerialize(obj as object) ||
-        // only keys will be serialized
-        fastWeakSerialize(obj)
+        fastSkipSerialize(obj as object)
       ) {
         // ignore
       } else if (obj instanceof Error) {
         discoveredValues.push(...Object.values(obj));
       } else if (isStore(obj)) {
         const target = getStoreTarget(obj)!;
         const effects = getStoreHandler(obj)!.$effects$;
-        if (!fastWeakSerialize(target)) {
-          discoveredValues.push(target);
-        }
-        discoveredValues.push(effects);
+        discoveredValues.push(target, effects);
 
         for (const prop in target) {
           const propValue = (target as any)[prop];
@@ -936,8 +920,6 @@ export const createSerializationContext = (
           }
         );
         promises.push(obj);
-      } else if (obj instanceof SubscriptionData) {
-        discoveredValues.push(obj.data);
       } else if (Array.isArray(obj)) {
         discoveredValues.push(...obj);
       } else if (isSerializerObj(obj)) {
@@ -1225,8 +1207,6 @@ function serialize(serializationContext: SerializationContext): void {
     } else if (isObjectLiteral(value)) {
       if (Array.isArray(value)) {
         output(TypeIds.Array, value);
-      } else if (fastWeakSerialize(value)) {
-        output(TypeIds.WeakObject, Object.keys(value));
       } else {
         const out: any[] = [];
         for (const key in value) {
@@ -1744,7 +1724,6 @@ export const enum TypeIds {
   JSXNode,
   PropsProxy,
   SubscriptionData,
-  WeakObject,
 }
 export const _typeIdNames = [
   'RootRef',
@@ -1779,7 +1758,6 @@ export const _typeIdNames = [
   'JSXNode',
   'PropsProxy',
   'SubscriptionData',
-  'WeakObject',
 ];
 
 export const enum Constants {