refactor: update ISsrNode structure and related serialization logic

Author: Varixo

.changeset/honest-pears-sniff.md

@@ -0,0 +1,5 @@
+---
+'@qwik.dev/core': patch
+---
+
+fix: serialize less vnode data

packages/qwik/src/core/qwik.core.api.md

@@ -892,12 +892,11 @@ export abstract class _SharedContainer implements Container {
     // (undocumented)
     serializationCtxFactory(NodeConstructor: {
         new (...rest: any[]): {
-            nodeType: number;
-            id: string;
+            __brand__: 'SsrNode';
         };
     } | null, DomRefConstructor: {
         new (...rest: any[]): {
-            $ssrNode$: ISsrNode;
+            __brand__: 'DomRef';
         };
     } | null, symbolToChunkResolver: SymbolToChunkResolver, writer?: StreamWriter): SerializationContext;
     // (undocumented)

packages/qwik/src/core/reactive-primitives/subscriber.ts

@@ -30,5 +30,5 @@ export function getSubscriber(
 }
 
 function isSsrNode(value: any): value is ISsrNode {
-  return '__brand__' in value && 'currentComponentNode' in value;
+  return '__brand__' in value && value.__brand__ === 'SsrNode';
 }

packages/qwik/src/core/shared/scheduler-document-position.ts

@@ -96,11 +96,11 @@ export const ssrNodeDocumentPosition = (a: ISsrNode, b: ISsrNode): -1 | 0 | 1 =>
   let bDepth = -1;
   while (a) {
     const ssrNode = (aSsrNodePath[++aDepth] = a);
-    a = ssrNode.currentComponentNode!;
+    a = ssrNode.parentSsrNode!;
   }
   while (b) {
     const ssrNode = (bSsrNodePath[++bDepth] = b);
-    b = ssrNode.currentComponentNode!;
+    b = ssrNode.parentSsrNode!;
   }
 
   while (aDepth >= 0 && bDepth >= 0) {

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

@@ -3,7 +3,7 @@ import { trackSignalAndAssignHost } from '../use/use-core';
 import { version } from '../version';
 import type { SubscriptionData } from '../reactive-primitives/subscription-data';
 import type { Signal } from '../reactive-primitives/signal.public';
-import type { ISsrNode, StreamWriter, SymbolToChunkResolver } from '../ssr/ssr-types';
+import type { StreamWriter, SymbolToChunkResolver } from '../ssr/ssr-types';
 import type { Scheduler } from './scheduler';
 import { createScheduler } from './scheduler';
 import { createSerializationContext, type SerializationContext } from './shared-serialization';
@@ -51,10 +51,10 @@ export abstract class _SharedContainer implements Container {
 
   serializationCtxFactory(
     NodeConstructor: {
-      new (...rest: any[]): { nodeType: number; id: string };
+      new (...rest: any[]): { __brand__: 'SsrNode' };
     } | null,
     DomRefConstructor: {
-      new (...rest: any[]): { $ssrNode$: ISsrNode };
+      new (...rest: any[]): { __brand__: 'DomRef' };
     } | null,
     symbolToChunkResolver: SymbolToChunkResolver,
     writer?: StreamWriter

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

@@ -601,7 +601,6 @@ export function inflateQRL(container: DeserializeContainer, qrl: QRLInternal<any
 
 /** A selection of attributes of the real thing */
 type SsrNode = {
-  nodeType: number;
   id: string;
   children: ISsrNode[] | null;
   vnodeData: VNodeData;
@@ -689,11 +688,11 @@ export const createSerializationContext = (
    * server will not know what to do with them.
    */
   NodeConstructor: {
-    new (...rest: any[]): { nodeType: number; id: string };
+    new (...rest: any[]): { __brand__: 'SsrNode' };
   } | null,
   /** DomRef constructor, for instanceof checks. */
   DomRefConstructor: {
-    new (...rest: any[]): { $ssrNode$: ISsrNode };
+    new (...rest: any[]): { __brand__: 'DomRef' };
   } | null,
   symbolToChunkResolver: SymbolToChunkResolver,
   getProp: (obj: any, prop: string) => any,
@@ -760,9 +759,10 @@ export const createSerializationContext = (
     return seen.$rootIndex$;
   };
 
-  const isSsrNode = (NodeConstructor ? (obj) => obj instanceof NodeConstructor : () => false) as (
-    obj: unknown
-  ) => obj is SsrNode;
+  const isSsrNode = (
+    NodeConstructor ? (obj) => obj instanceof NodeConstructor : ((() => false) as any)
+  ) as (obj: unknown) => obj is SsrNode;
+
   isDomRef = (
     DomRefConstructor ? (obj) => obj instanceof DomRefConstructor : ((() => false) as any)
   ) as (obj: unknown) => obj is DomRef;

packages/qwik/src/core/shared/types.ts

@@ -45,10 +45,10 @@ export interface Container {
   ensureProjectionResolved(host: HostElement): void;
   serializationCtxFactory(
     NodeConstructor: {
-      new (...rest: any[]): { nodeType: number; id: string };
+      new (...rest: any[]): { __brand__: 'SsrNode' };
     } | null,
     DomRefConstructor: {
-      new (...rest: any[]): { $ssrNode$: ISsrNode };
+      new (...rest: any[]): { __brand__: 'DomRef' };
     } | null,
     symbolToChunkResolver: SymbolToChunkResolver,
     writer?: StreamWriter

packages/qwik/src/core/ssr/ssr-types.ts

@@ -25,7 +25,7 @@ export interface StreamWriter {
 
 export interface ISsrNode {
   id: string;
-  currentComponentNode: ISsrNode | null;
+  parentSsrNode: ISsrNode | null;
   vnodeData?: VNodeData;
   setProp(name: string, value: any): void;
   getProp(name: string): any;

packages/qwik/src/core/tests/container.spec.tsx

@@ -512,7 +512,7 @@ describe('serializer v2', () => {
 
     describe('DocumentSerializer, //////', () => {
       it('should serialize and deserialize', async () => {
-        const obj = new SsrNode(null, SsrNode.DOCUMENT_NODE, '', [], [], [] as any);
+        const obj = new SsrNode(null, '', [], [], [] as any);
         const container = await withContainer((ssr) => ssr.addRoot(obj));
         expect(container.$getObjectById$(0)).toEqual(container.element.ownerDocument);
       });

packages/qwik/src/server/ssr-container.ts

@@ -296,14 +296,14 @@ class SSRContainer extends _SharedContainer implements ISSRContainer {
           return value;
         }
       }
-      ssrNode = ssrNode.currentComponentNode;
+      ssrNode = ssrNode.parentSsrNode;
     }
     return undefined;
   }
 
   getParentHost(host: HostElement): HostElement | null {
     const ssrNode: ISsrNode = host as any;
-    return ssrNode.currentComponentNode as ISsrNode | null;
+    return ssrNode.parentSsrNode as ISsrNode | null;
   }
 
   setHostProp<T>(host: ISsrNode, name: string, value: T): void {
@@ -510,7 +510,7 @@ class SSRContainer extends _SharedContainer implements ISSRContainer {
     const componentFrame = this.componentStack.pop()!;
     componentFrame.releaseUnclaimedProjections(this.unclaimedProjections);
     this.closeFragment();
-    this.currentComponentNode = this.currentComponentNode?.currentComponentNode || null;
+    this.currentComponentNode = this.currentComponentNode?.parentSsrNode || null;
   }
 
   /** Write a text node with correct escaping. Save the length of the text node in the vNodeData. */
@@ -726,7 +726,6 @@ class SSRContainer extends _SharedContainer implements ISSRContainer {
           }
           value = String(rootId);
         }
-        let skip = false;
         switch (key) {
           case QScopedStyle:
             write(VNodeDataChar.SCOPED_STYLE_CHAR);
@@ -741,11 +740,7 @@ class SSRContainer extends _SharedContainer implements ISSRContainer {
             write(VNodeDataChar.PROPS_CHAR);
             break;
           case ELEMENT_KEY:
-            if (Object.keys(value).length === 0) {
-              skip = true;
-            } else {
-              write(VNodeDataChar.KEY_CHAR);
-            }
+            write(VNodeDataChar.KEY_CHAR);
             break;
           case ELEMENT_SEQ:
             write(VNodeDataChar.SEQ_CHAR);
@@ -771,9 +766,7 @@ class SSRContainer extends _SharedContainer implements ISSRContainer {
             write(key);
             write(VNodeDataChar.SEPARATOR_CHAR);
         }
-        if (!skip) {
-          write(value);
-        }
+        write(value);
       }
     }