fix(scheduler): scheduling wait for all on server

Varixo · Varixo · commit 728d5b752aa9 · 2025-01-26T16:16:56.000+01:00
diff --git a/packages/qwik/src/core/shared/scheduler.ts b/packages/qwik/src/core/shared/scheduler.ts
@@ -80,7 +80,7 @@
  *   declaration order within component.
  */
 
-import { isDomContainer, type DomContainer } from '../client/dom-container';
+import { type DomContainer } from '../client/dom-container';
 import {
   ElementVNodeProps,
   VNodeFlags,
@@ -102,6 +102,7 @@ import type { OnRenderFn } from './component.public';
 import { assertEqual } from './error/assert';
 import type { Props } from './jsx/jsx-runtime';
 import type { JSXOutput } from './jsx/types/jsx-node';
+import { isServerPlatform } from './platform/platform';
 import { emitEvent, type QRLInternal } from './qrl/qrl-class';
 import { ssrNodeDocumentPosition, vnode_documentPosition } from './scheduler-document-position';
 import type { Container, HostElement } from './types';
@@ -178,7 +179,7 @@ export const createScheduler = (
   const choreQueue: Chore[] = [];
 
   let currentChore: Chore | null = null;
-  let journalFlushScheduled: boolean = false;
+  let drainScheduled: boolean = false;
 
   return schedule;
 
@@ -242,7 +243,7 @@ export const createScheduler = (
     targetOrQrl: ChoreTarget | string | null = null,
     payload: any = null
   ): ValueOrPromise<any> {
-    const isServer = !isDomContainer(container);
+    const isServer = isServerPlatform();
     const isComponentSsr = isServer && type === ChoreType.COMPONENT;
 
     const runLater: boolean =
@@ -254,7 +255,6 @@ export const createScheduler = (
       type === ChoreType.CLEANUP_VISIBLE;
     const isClientOnly =
       type === ChoreType.JOURNAL_FLUSH ||
-      type === ChoreType.RECOMPUTE_AND_SCHEDULE_EFFECTS ||
       type === ChoreType.NODE_DIFF ||
       type === ChoreType.NODE_PROP;
 
@@ -281,9 +281,9 @@ export const createScheduler = (
     if (!isServer || !isClientOnly) {
       chore = sortedInsert(choreQueue, chore, (container as DomContainer).rootVNode || null);
     }
-    if (!journalFlushScheduled && runLater) {
+    if (!drainScheduled && runLater) {
       // If we are not currently draining, we need to schedule a drain.
-      journalFlushScheduled = true;
+      drainScheduled = true;
       schedule(ChoreType.JOURNAL_FLUSH);
       scheduleDrain();
     }
@@ -336,37 +336,48 @@ export const createScheduler = (
     currentChore = chore;
     let returnValue: ValueOrPromise<unknown> | unknown = null;
     switch (chore.$type$) {
+      case ChoreType.WAIT_FOR_ALL:
+        {
+          if (isServer) {
+            drainScheduled = false;
+          }
+        }
+        break;
       case ChoreType.JOURNAL_FLUSH:
-        returnValue = journalFlush();
-        journalFlushScheduled = false;
+        {
+          returnValue = journalFlush();
+          drainScheduled = false;
+        }
         break;
       case ChoreType.COMPONENT:
-        returnValue = safeCall(
-          () =>
-            executeComponent(
-              container,
-              host,
-              host,
-              chore.$target$ as QRLInternal<OnRenderFn<unknown>>,
-              chore.$payload$ as Props | null
-            ),
-          (jsx) => {
-            if (isServer) {
-              return jsx;
-            } else {
-              const styleScopedId = container.getHostProp<string>(host, QScopedStyle);
-              return retryOnPromise(() =>
-                vnode_diff(
-                  container as ClientContainer,
-                  jsx,
-                  host as VirtualVNode,
-                  addComponentStylePrefix(styleScopedId)
-                )
-              );
-            }
-          },
-          (err: any) => container.handleError(err, host)
-        );
+        {
+          returnValue = safeCall(
+            () =>
+              executeComponent(
+                container,
+                host,
+                host,
+                chore.$target$ as QRLInternal<OnRenderFn<unknown>>,
+                chore.$payload$ as Props | null
+              ),
+            (jsx) => {
+              if (isServer) {
+                return jsx;
+              } else {
+                const styleScopedId = container.getHostProp<string>(host, QScopedStyle);
+                return retryOnPromise(() =>
+                  vnode_diff(
+                    container as ClientContainer,
+                    jsx,
+                    host as VirtualVNode,
+                    addComponentStylePrefix(styleScopedId)
+                  )
+                );
+              }
+            },
+            (err: any) => container.handleError(err, host)
+          );
+        }
         break;
       case ChoreType.RESOURCE:
         {
diff --git a/packages/qwik/src/core/signal/signal.ts b/packages/qwik/src/core/signal/signal.ts
@@ -32,6 +32,7 @@ import type { Props } from '../shared/jsx/jsx-runtime';
 import type { OnRenderFn } from '../shared/component.public';
 import { NEEDS_COMPUTATION } from './flags';
 import { QError, qError } from '../shared/error/error';
+import { isServerPlatform } from '../shared/platform/platform';
 
 const DEBUG = false;
 
@@ -318,6 +319,7 @@ export const triggerEffects = (
   signal: Signal | TargetType,
   effects: EffectSubscriptions[] | null
 ) => {
+  const isBrowser = !isServerPlatform();
   if (effects) {
     const scheduleEffect = (effectSubscriptions: EffectSubscriptions) => {
       const effect = effectSubscriptions[EffectSubscriptionsProp.EFFECT];
@@ -351,20 +353,22 @@ export const triggerEffects = (
         assertDefined(qrl, 'Component must have QRL');
         const props = container.getHostProp<Props>(host, ELEMENT_PROPS);
         container.$scheduler$(ChoreType.COMPONENT, host, qrl, props);
-      } else if (property === EffectProperty.VNODE) {
-        const host: HostElement = effect as any;
-        const target = host;
-        container.$scheduler$(ChoreType.NODE_DIFF, host, target, signal as Signal);
-      } else {
-        const host: HostElement = effect as any;
-        const effectData = effectSubscriptions[EffectSubscriptionsProp.FIRST_BACK_REF_OR_DATA];
-        if (effectData instanceof EffectPropData) {
-          const data = effectData.data;
-          const payload: NodePropPayload = {
-            ...data,
-            $value$: signal as Signal,
-          };
-          container.$scheduler$(ChoreType.NODE_PROP, host, property, payload);
+      } else if (isBrowser) {
+        if (property === EffectProperty.VNODE) {
+          const host: HostElement = effect as any;
+          const target = host;
+          container.$scheduler$(ChoreType.NODE_DIFF, host, target, signal as Signal);
+        } else {
+          const host: HostElement = effect as any;
+          const effectData = effectSubscriptions[EffectSubscriptionsProp.FIRST_BACK_REF_OR_DATA];
+          if (effectData instanceof EffectPropData) {
+            const data = effectData.data;
+            const payload: NodePropPayload = {
+              ...data,
+              $value$: signal as Signal,
+            };
+            container.$scheduler$(ChoreType.NODE_PROP, host, property, payload);
+          }
         }
       }
     };
diff --git a/packages/qwik/src/core/ssr/ssr-render-jsx.ts b/packages/qwik/src/core/ssr/ssr-render-jsx.ts
@@ -36,7 +36,6 @@ import { qInspector } from '../shared/utils/qdev';
 import { serializeAttribute } from '../shared/utils/styles';
 import { getFileLocationFromJsx } from '../shared/utils/jsx-filename';
 import { queueQRL } from '../client/queue-qrl';
-import { ChoreType } from '../shared/scheduler';
 
 class ParentComponentData {
   constructor(
@@ -79,10 +78,6 @@ export async function _walkJSX(
         styleScoped: options.currentStyleScoped,
         parentComponentFrame: options.parentComponentFrame,
       });
-      if (ssr.$hasChores$) {
-        ssr.$hasChores$ = false;
-        await ssr.$scheduler$(ChoreType.WAIT_FOR_ALL);
-      }
     }
   };
   await drain();
diff --git a/packages/qwik/src/core/ssr/ssr-types.ts b/packages/qwik/src/core/ssr/ssr-types.ts
@@ -55,7 +55,6 @@ export interface ISsrComponentFrame {
 export type SymbolToChunkResolver = (symbol: string) => string;
 
 export interface SSRContainer extends Container {
-  $hasChores$: boolean;
   readonly tag: string;
   readonly writer: StreamWriter;
   readonly prefetchResources: PrefetchResource[];
diff --git a/packages/qwik/src/server/qwik-copy.ts b/packages/qwik/src/server/qwik-copy.ts
@@ -58,3 +58,4 @@ export { VNodeDataSeparator } from '../core/shared/vnode-data-types';
 export { escapeHTML } from '../core/shared/utils/character-escaping';
 export { getValidManifest } from '../optimizer/src/manifest';
 export { QError, qError } from '../core/shared/error/error';
+export { ChoreType } from '../core/shared/scheduler';
diff --git a/packages/qwik/src/server/ssr-container.ts b/packages/qwik/src/server/ssr-container.ts
@@ -50,6 +50,7 @@ import {
   QSubscribers,
   QError,
   qError,
+  ChoreType,
 } from './qwik-copy';
 import {
   type ContextId,
@@ -218,11 +219,9 @@ class SSRContainer extends _SharedContainer implements ISSRContainer {
   public $instanceHash$ = hash();
   // Temporary flag to find missing roots after the state was serialized
   private $noMoreRoots$ = false;
-  /** True if there are scheduled tasks that need to be run */
-  public $hasChores$ = false;
   constructor(opts: Required<SSRRenderOptions>) {
     super(
-      () => (this.$hasChores$ = true),
+      () => this.$scheduler$(ChoreType.WAIT_FOR_ALL),
       () => null,
       opts.renderOptions.serverData ?? EMPTY_OBJ,
       opts.locale
