refactor(scheduler): remove COMPONENT_SSR type

Author: Varixo

packages/docs/src/routes/api/qwik/api.json

@@ -277,20 +277,6 @@
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-attributes.ts",
       "mdFile": "core.domattributes.md"
     },
-    {
-      "name": "EagernessOptions",
-      "id": "eagernessoptions",
-      "hierarchy": [
-        {
-          "name": "EagernessOptions",
-          "id": "eagernessoptions"
-        }
-      ],
-      "kind": "TypeAlias",
-      "content": "```typescript\nexport type EagernessOptions = 'visible' | 'load' | 'idle';\n```",
-      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/use/use-task.ts",
-      "mdFile": "core.eagernessoptions.md"
-    },
     {
       "name": "Element",
       "id": "qwikjsx-element",
@@ -2125,24 +2111,10 @@
         }
       ],
       "kind": "Function",
-      "content": "Reruns the `taskFn` when the observed inputs change.\n\nUse `useTask` to observe changes on a set of inputs, and then re-execute the `taskFn` when those inputs change.\n\nThe `taskFn` only executes if the observed inputs change. To observe the inputs, use the `obs` function to wrap property reads. This creates subscriptions that will trigger the `taskFn` to rerun.\n\n\n```typescript\nuseTask$: (qrl: import(\"./use-task\").TaskFn, opts?: import(\"./use-task\").UseTaskOptions | undefined) => void\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nqrl\n\n\n</td><td>\n\nimport(\"./use-task\").[TaskFn](#taskfn)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\nopts\n\n\n</td><td>\n\nimport(\"./use-task\").[UseTaskOptions](#usetaskoptions) \\| undefined\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nvoid",
+      "content": "Reruns the `taskFn` when the observed inputs change.\n\nUse `useTask` to observe changes on a set of inputs, and then re-execute the `taskFn` when those inputs change.\n\nThe `taskFn` only executes if the observed inputs change. To observe the inputs, use the `obs` function to wrap property reads. This creates subscriptions that will trigger the `taskFn` to rerun.\n\n\n```typescript\nuseTask$: (qrl: import(\"./use-task\").TaskFn) => void\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nqrl\n\n\n</td><td>\n\nimport(\"./use-task\").[TaskFn](#taskfn)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nvoid",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/use/use-task-dollar.ts",
       "mdFile": "core.usetask_.md"
     },
-    {
-      "name": "UseTaskOptions",
-      "id": "usetaskoptions",
-      "hierarchy": [
-        {
-          "name": "UseTaskOptions",
-          "id": "usetaskoptions"
-        }
-      ],
-      "kind": "Interface",
-      "content": "```typescript\nexport interface UseTaskOptions \n```\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[eagerness?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[EagernessOptions](#eagernessoptions)\n\n\n</td><td>\n\n_(Optional)_ - `visible`<!-- -->: run the effect when the element is visible. - `load`<!-- -->: eagerly run the effect when the application resumes.\n\n\n</td></tr>\n</tbody></table>",
-      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/use/use-task.ts",
-      "mdFile": "core.usetaskoptions.md"
-    },
     {
       "name": "useVisibleTask$",
       "id": "usevisibletask_",

packages/docs/src/routes/api/qwik/index.md

@@ -873,14 +873,6 @@ _(Optional)_
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-attributes.ts)
 
-## EagernessOptions
-
-```typescript
-export type EagernessOptions = "visible" | "load" | "idle";
-```
-
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/use/use-task.ts)
-
 ## Element
 
 ```typescript
@@ -5252,7 +5244,7 @@ Use `useTask` to observe changes on a set of inputs, and then re-execute the `ta
 The `taskFn` only executes if the observed inputs change. To observe the inputs, use the `obs` function to wrap property reads. This creates subscriptions that will trigger the `taskFn` to rerun.
 
 ```typescript
-useTask$: (qrl: import("./use-task").TaskFn, opts?: import("./use-task").UseTaskOptions | undefined) => void
+useTask$: (qrl: import("./use-task").TaskFn) => void
 ```
 
 <table><thead><tr><th>
@@ -5278,19 +5270,6 @@ import("./use-task").[TaskFn](#taskfn)
 
 </td><td>
 
-</td></tr>
-<tr><td>
-
-opts
-
-</td><td>
-
-import("./use-task").[UseTaskOptions](#usetaskoptions) \| undefined
-
-</td><td>
-
-_(Optional)_
-
 </td></tr>
 </tbody></table>
 **Returns:**
@@ -5299,48 +5278,6 @@ void
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/use/use-task-dollar.ts)
 
-## UseTaskOptions
-
-```typescript
-export interface UseTaskOptions
-```
-
-<table><thead><tr><th>
-
-Property
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Type
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[eagerness?](#)
-
-</td><td>
-
-</td><td>
-
-[EagernessOptions](#eagernessoptions)
-
-</td><td>
-
-_(Optional)_ - `visible`: run the effect when the element is visible. - `load`: eagerly run the effect when the application resumes.
-
-</td></tr>
-</tbody></table>
-
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/use/use-task.ts)
-
 ## useVisibleTask$
 
 ```tsx

packages/qwik/src/core/api.md

@@ -217,9 +217,6 @@ class DomContainer extends _SharedContainer implements ClientContainer {
 export { DomContainer }
 export { DomContainer as _DomContainer }
 
-// @public (undocumented)
-export type EagernessOptions = 'visible' | 'load' | 'idle';
-
 // @internal (undocumented)
 export class _EffectData {
     constructor(data: NodePropData);
@@ -1140,17 +1137,12 @@ export interface UseStylesScoped {
 export const useStylesScopedQrl: (styles: QRL<string>) => UseStylesScoped;
 
 // @public
-export const useTask$: (qrl: TaskFn, opts?: UseTaskOptions | undefined) => void;
-
-// @public (undocumented)
-export interface UseTaskOptions {
-    eagerness?: EagernessOptions;
-}
+export const useTask$: (qrl: TaskFn) => void;
 
 // Warning: (ae-internal-missing-underscore) The name "useTaskQrl" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal (undocumented)
-export const useTaskQrl: (qrl: QRL<TaskFn>, opts?: UseTaskOptions) => void;
+export const useTaskQrl: (qrl: QRL<TaskFn>) => void;
 
 // @public
 export const useVisibleTask$: (qrl: TaskFn, opts?: OnVisibleTaskOptions | undefined) => void;
@@ -1237,17 +1229,9 @@ export const _waitUntilRendered: (elm: Element) => Promise<void>;
 //
 // @internal (undocumented)
 export function _walkJSX(ssr: SSRContainer, value: JSXOutput, options: {
-    allowPromises: true;
-    currentStyleScoped: string | null;
-    parentComponentFrame: ISsrComponentFrame | null;
-}): ValueOrPromise<void>;
-
-// @internal (undocumented)
-export function _walkJSX(ssr: SSRContainer, value: JSXOutput, options: {
-    allowPromises: false;
     currentStyleScoped: string | null;
     parentComponentFrame: ISsrComponentFrame | null;
-}): false;
+}): Promise<void>;
 
 // @internal (undocumented)
 export const _weakSerialize: <T extends object>(input: T) => Partial<T>;

packages/qwik/src/core/index.ts

@@ -112,7 +112,7 @@ export type { ComputedFn } from './use/use-computed';
 export { useComputedQrl } from './use/use-computed';
 export type { OnVisibleTaskOptions, VisibleTaskStrategy } from './use/use-visible-task';
 export { useVisibleTaskQrl } from './use/use-visible-task';
-export type { EagernessOptions, TaskCtx, TaskFn, Tracker, UseTaskOptions } from './use/use-task';
+export type { TaskCtx, TaskFn, Tracker } from './use/use-task';
 export type {
   ResourceProps,
   ResourceOptions,

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

@@ -102,7 +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 type { QRLInternal } from './qrl/qrl-class';
+import { emitEvent, type QRLInternal } from './qrl/qrl-class';
 import { ssrNodeDocumentPosition, vnode_documentPosition } from './scheduler-document-position';
 import type { Container, HostElement } from './types';
 import { logWarn } from './utils/log';
@@ -128,7 +128,6 @@ export const enum ChoreType {
   TASK,
   NODE_DIFF,
   NODE_PROP,
-  COMPONENT_SSR,
   COMPONENT,
   RECOMPUTE_AND_SCHEDULE_EFFECTS,
 
@@ -218,7 +217,7 @@ export const createScheduler = (
     args: unknown[]
   ): ValueOrPromise<void>;
   function schedule(
-    type: ChoreType.COMPONENT | ChoreType.COMPONENT_SSR,
+    type: ChoreType.COMPONENT,
     host: HostElement,
     qrl: QRLInternal<OnRenderFn<unknown>>,
     props: Props | null
@@ -243,15 +242,22 @@ export const createScheduler = (
     targetOrQrl: ChoreTarget | string | null = null,
     payload: any = null
   ): ValueOrPromise<any> {
+    const isServer = !isDomContainer(container);
+    const isComponentSsr = isServer && type === ChoreType.COMPONENT;
+
     const runLater: boolean =
-      type !== ChoreType.WAIT_FOR_ALL &&
-      type !== ChoreType.COMPONENT_SSR &&
-      type !== ChoreType.RUN_QRL;
+      type !== ChoreType.WAIT_FOR_ALL && !isComponentSsr && type !== ChoreType.RUN_QRL;
     const isTask =
       type === ChoreType.TASK ||
       type === ChoreType.VISIBLE ||
       type === ChoreType.RESOURCE ||
       type === ChoreType.CLEANUP_VISIBLE;
+    const isClientOnly =
+      type === ChoreType.JOURNAL_FLUSH ||
+      type === ChoreType.RECOMPUTE_AND_SCHEDULE_EFFECTS ||
+      type === ChoreType.NODE_DIFF ||
+      type === ChoreType.NODE_PROP;
+
     if (isTask) {
       (hostOrTask as Task).$flags$ |= TaskFlags.DIRTY;
     }
@@ -271,7 +277,10 @@ export const createScheduler = (
       $executed$: false,
     };
     DEBUG && debugTrace('schedule', chore, currentChore, choreQueue);
-    chore = sortedInsert(choreQueue, chore, (container as DomContainer).rootVNode || null);
+    // add only if client or server and is not client only chore
+    if (!isServer || !isClientOnly) {
+      chore = sortedInsert(choreQueue, chore, (container as DomContainer).rootVNode || null);
+    }
     if (!journalFlushScheduled && runLater) {
       // If we are not currently draining, we need to schedule a drain.
       journalFlushScheduled = true;
@@ -281,7 +290,7 @@ export const createScheduler = (
     if (runLater) {
       return getPromise(chore);
     } else {
-      return drainUpTo(chore);
+      return drainUpTo(chore, isServer);
     }
   }
 
@@ -290,11 +299,17 @@ export const createScheduler = (
    *
    * @param runUptoChore
    */
-  function drainUpTo(runUptoChore: Chore): ValueOrPromise<unknown> {
+  function drainUpTo(runUptoChore: Chore, isServer: boolean): ValueOrPromise<unknown> {
     while (choreQueue.length) {
       if (currentChore) {
         // Already running chore, which means we're waiting for async completion
-        return getPromise(currentChore).then(() => drainUpTo(runUptoChore));
+        return getPromise(currentChore)
+          .then(() => drainUpTo(runUptoChore, isServer))
+          .catch((error) => {
+            currentChore = null;
+            emitEvent('qerror', { error });
+            return drainUpTo(runUptoChore, isServer);
+          });
       }
       const nextChore = choreQueue.shift()!;
       const isDeletedVNode = vNodeAlreadyDeleted(nextChore);
@@ -306,15 +321,15 @@ export const createScheduler = (
         DEBUG && debugTrace('skip chore', nextChore, currentChore, choreQueue);
         continue;
       }
-      executeChore(nextChore);
+      executeChore(nextChore, isServer);
       if (nextChore === runUptoChore) {
         break;
       }
     }
     return runUptoChore.$executed$ ? runUptoChore.$returnValue$ : getPromise(runUptoChore);
   }
 
-  function executeChore(chore: Chore): ValueOrPromise<any> {
+  function executeChore(chore: Chore, isServer: boolean): ValueOrPromise<any> {
     const host = chore.$host$;
     DEBUG && debugTrace('execute', chore, currentChore, choreQueue);
     assertEqual(currentChore, null, 'Chore already running.');
@@ -326,7 +341,6 @@ export const createScheduler = (
         journalFlushScheduled = false;
         break;
       case ChoreType.COMPONENT:
-      case ChoreType.COMPONENT_SSR:
         returnValue = safeCall(
           () =>
             executeComponent(
@@ -337,7 +351,9 @@ export const createScheduler = (
               chore.$payload$ as Props | null
             ),
           (jsx) => {
-            if (chore.$type$ === ChoreType.COMPONENT) {
+            if (isServer) {
+              return jsx;
+            } else {
               const styleScopedId = container.getHostProp<string>(host, QScopedStyle);
               return retryOnPromise(() =>
                 vnode_diff(
@@ -347,8 +363,6 @@ export const createScheduler = (
                   addComponentStylePrefix(styleScopedId)
                 )
               );
-            } else {
-              return jsx;
             }
           },
           (err: any) => container.handleError(err, host)
@@ -365,7 +379,7 @@ export const createScheduler = (
             container,
             host
           );
-          returnValue = isDomContainer(container) ? null : result;
+          returnValue = isServer ? result : null;
         }
         break;
       case ChoreType.RUN_QRL:
@@ -595,7 +609,6 @@ function debugChoreToString(chore: Chore): string {
         [ChoreType.NODE_DIFF]: 'NODE_DIFF',
         [ChoreType.NODE_PROP]: 'NODE_PROP',
         [ChoreType.COMPONENT]: 'COMPONENT',
-        [ChoreType.COMPONENT_SSR]: 'COMPONENT_SSR',
         [ChoreType.RECOMPUTE_AND_SCHEDULE_EFFECTS]: 'RECOMPUTE_SIGNAL',
         [ChoreType.JOURNAL_FLUSH]: 'JOURNAL_FLUSH',
         [ChoreType.VISIBLE]: 'VISIBLE',

packages/qwik/src/core/signal/signal.ts

@@ -32,7 +32,6 @@ 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 { isDomContainer } from '../client/dom-container';
 
 const DEBUG = false;
 
@@ -351,12 +350,7 @@ export const triggerEffects = (
         const qrl = container.getHostProp<QRLInternal<OnRenderFn<unknown>>>(host, OnRenderProp);
         assertDefined(qrl, 'Component must have QRL');
         const props = container.getHostProp<Props>(host, ELEMENT_PROPS);
-        container.$scheduler$(
-          isDomContainer(container) ? ChoreType.COMPONENT : ChoreType.COMPONENT_SSR,
-          host,
-          qrl,
-          props
-        );
+        container.$scheduler$(ChoreType.COMPONENT, host, qrl, props);
       } else if (property === EffectProperty.VNODE) {
         const host: HostElement = effect as any;
         const target = host;

packages/qwik/src/core/ssr/ssr-render-component.ts

@@ -35,5 +35,5 @@ export const applyQwikComponentBody = (
   if (jsx.key !== null) {
     host.setProp(ELEMENT_KEY, jsx.key);
   }
-  return scheduler(ChoreType.COMPONENT_SSR, host, componentQrl, srcProps);
+  return scheduler(ChoreType.COMPONENT, host, componentQrl, srcProps);
 };