fix: RequestEventAction has missed a type resolveValue

.changeset/eight-garlics-deliver.md

@@ -0,0 +1,5 @@
+---
+'@builder.io/qwik-city': patch
+---
+
+FIX: add type for `routeAction$`'s `requestEvent.resolveValue`

packages/docs/src/routes/api/qwik-city-middleware-request-handler/api.json

@@ -299,7 +299,7 @@
         }
       ],
       "kind": "Interface",
-      "content": "```typescript\nexport interface RequestEventAction<PLATFORM = QwikCityPlatform> extends RequestEventCommon<PLATFORM> \n```\n**Extends:** [RequestEventCommon](#requesteventcommon)<!-- -->&lt;PLATFORM&gt;\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[fail](#)\n\n\n</td><td>\n\n\n</td><td>\n\n&lt;T extends Record&lt;string, any&gt;&gt;(status: number, returnData: T) =&gt; FailReturn&lt;T&gt;\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
+      "content": "```typescript\nexport interface RequestEventAction<PLATFORM = QwikCityPlatform> extends RequestEventCommon<PLATFORM> \n```\n**Extends:** [RequestEventCommon](#requesteventcommon)<!-- -->&lt;PLATFORM&gt;\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[fail](#)\n\n\n</td><td>\n\n\n</td><td>\n\n&lt;T extends Record&lt;string, any&gt;&gt;(status: number, returnData: T) =&gt; FailReturn&lt;T&gt;\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[resolveValue](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[ResolveValue](#resolvevalue)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/request-handler/types.ts",
       "mdFile": "qwik-city.requesteventaction.md"
     },

packages/docs/src/routes/api/qwik-city-middleware-request-handler/index.mdx

@@ -863,6 +863,19 @@ Description
 
 </td><td>
 
+</td></tr>
+<tr><td>
+
+[resolveValue](#)
+
+</td><td>
+
+</td><td>
+
+[ResolveValue](#resolvevalue)
+
+</td><td>
+
 </td></tr>
 </tbody></table>
 

packages/qwik-city/src/middleware/request-handler/middleware.request-handler.api.md

@@ -100,6 +100,8 @@ export interface RequestEvent<PLATFORM = QwikCityPlatform> extends RequestEventC
 export interface RequestEventAction<PLATFORM = QwikCityPlatform> extends RequestEventCommon<PLATFORM> {
     // (undocumented)
     fail: <T extends Record<string, any>>(status: number, returnData: T) => FailReturn<T>;
+    // (undocumented)
+    resolveValue: ResolveValue;
 }
 
 // @public (undocumented)

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

@@ -127,7 +127,6 @@ export function createRequestEvent(
     routeModuleIndex = ABORT_INDEX;
     return new AbortMessage();
   };
-
   const loaders: Record<string, Promise<any>> = {};
   const requestEv: RequestEventInternal = {
     [RequestEvLoaders]: loaders,

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

@@ -173,6 +173,7 @@ export function actionsMiddleware(routeActions: ActionInternal[], routeLoaders:
       requestEv.exit();
       return;
     }
+    let isAction = false;
     const { method } = requestEv;
     const loaders = getRequestLoaders(requestEv);
     const isDev = getRequestMode(requestEv) === 'dev';
@@ -184,6 +185,48 @@ export function actionsMiddleware(routeActions: ActionInternal[], routeLoaders:
         );
       }
     }
+
+    if (routeLoaders.length > 0) {
+      await Promise.all(routeLoaders.map(loader));
+    }
+    function loader(loader: LoaderInternal) {
+      const loaderId = loader.__id;
+      loaders[loaderId] = runValidators(
+        requestEv,
+        loader.__validators,
+        undefined, // data
+        isDev
+      )
+        .then((res) => {
+          if (res.success) {
+            if (isDev) {
+              return measure<Promise<unknown>>(
+                requestEv,
+                loader.__qrl.getSymbol().split('_', 1)[0],
+                () => loader.__qrl.call(requestEv, requestEv)
+              );
+            } else {
+              return loader.__qrl.call(requestEv, requestEv);
+            }
+          } else {
+            return requestEv.fail(res.status ?? 500, res.error);
+          }
+        })
+        .then((resolvedLoader) => {
+          if (typeof resolvedLoader === 'function') {
+            loaders[loaderId] = resolvedLoader();
+          } else {
+            if (isDev) {
+              verifySerializable(qwikSerializer, resolvedLoader, loader.__qrl);
+            }
+            loaders[loaderId] = resolvedLoader;
+          }
+          return resolvedLoader;
+        });
+
+      return loaders[loaderId];
+    }
+
     if (method === 'POST') {
       const selectedActionId = requestEv.query.get(QACTION_KEY);
       if (selectedActionId) {
@@ -205,6 +248,7 @@ export function actionsMiddleware(routeActions: ActionInternal[], routeLoaders:
           if (!result.success) {
             loaders[selectedActionId] = requestEv.fail(result.status ?? 500, result.error);
           } else {
+            //@ts-ignore
             const actionResolved = isDev
               ? await measure(requestEv, action.__qrl.getSymbol().split('_', 1)[0], () =>
                   action.__qrl.call(requestEv, result.data as JSONObject, requestEv)
@@ -213,53 +257,17 @@ export function actionsMiddleware(routeActions: ActionInternal[], routeLoaders:
             if (isDev) {
               verifySerializable(qwikSerializer, actionResolved, action.__qrl);
             }
+
             loaders[selectedActionId] = actionResolved;
+            isAction = true;
           }
         }
       }
     }
-
-    if (routeLoaders.length > 0) {
-      const resolvedLoadersPromises = routeLoaders.map((loader) => {
-        const loaderId = loader.__id;
-        loaders[loaderId] = runValidators(
-          requestEv,
-          loader.__validators,
-          undefined, // data
-          isDev
-        )
-          .then((res) => {
-            if (res.success) {
-              if (isDev) {
-                return measure<Promise<unknown>>(
-                  requestEv,
-                  loader.__qrl.getSymbol().split('_', 1)[0],
-                  () => loader.__qrl.call(requestEv, requestEv)
-                );
-              } else {
-                return loader.__qrl.call(requestEv, requestEv);
-              }
-            } else {
-              return requestEv.fail(res.status ?? 500, res.error);
-            }
-          })
-          .then((resolvedLoader) => {
-            if (typeof resolvedLoader === 'function') {
-              loaders[loaderId] = resolvedLoader();
-            } else {
-              if (isDev) {
-                verifySerializable(qwikSerializer, resolvedLoader, loader.__qrl);
-              }
-              loaders[loaderId] = resolvedLoader;
-            }
-            return resolvedLoader;
-          });
-
-        return loaders[loaderId];
-      });
-
-      await Promise.all(resolvedLoadersPromises);
+    if (routeLoaders.length > 0 && isAction) {
+      await Promise.all(routeLoaders.map(loader));
     }
+    isAction = false;
   };
 }
 

packages/qwik-city/src/middleware/request-handler/types.ts

@@ -459,6 +459,7 @@ declare global {
 /** @public */
 export interface RequestEventAction<PLATFORM = QwikCityPlatform>
   extends RequestEventCommon<PLATFORM> {
+  resolveValue: ResolveValue;
   fail: <T extends Record<string, any>>(status: number, returnData: T) => FailReturn<T>;
 }
 

starters/apps/qwikcity-test/src/routes/(common)/resolve-value/index.tsx

@@ -0,0 +1,102 @@
+import { component$ } from "@builder.io/qwik";
+import {
+  routeAction$,
+  Form,
+  routeLoader$,
+  zod$,
+  z,
+  globalAction$,
+} from "@builder.io/qwik-city";
+
+const useUser = routeLoader$(() => {
+  const user = {
+    firstName: "",
+    lastName: "",
+    test: 11,
+  };
+
+  return user;
+});
+
+const useUserGlobal = routeLoader$(() => {
+  const user = {
+    firstName: "",
+    lastName: "",
+    test: 11,
+  };
+
+  return user;
+});
+
+export const useAddUser = routeAction$(
+  async (data, requestEvent) => {
+    const res = await requestEvent.resolveValue(useUser);
+    res.firstName = data.firstName;
+    res.lastName = data.lastName;
+    return {
+      success: true,
+      userID: res,
+    };
+  },
+  zod$({
+    firstName: z.string(),
+    lastName: z.string(),
+  }),
+);
+
+export const globalAction = globalAction$(
+  async (data, requestEvent) => {
+    const res = await requestEvent.resolveValue(useUserGlobal);
+    res.firstName = data.globalfirstName;
+    res.lastName = data.globallastName;
+    return {
+      success: true,
+      userID: res,
+    };
+  },
+  zod$({
+    globalfirstName: z.string(),
+    globallastName: z.string(),
+  }),
+);
+
+export default component$(() => {
+  const action = useAddUser();
+  const globalstate = globalAction();
+  return (
+    <>
+      <div id="action">
+        <Form action={action}>
+          <input name="firstName" />
+          <input name="lastName" />
+          <button type="submit" id="actionButton">
+            Add user
+          </button>
+        </Form>
+        {action.value?.success && (
+          <>
+            <p>User {action.value.userID.firstName} added successfully</p>
+            <p>User {action.value.userID.lastName} added successfully</p>
+            <p>User {action.value.userID.test} added successfully</p>
+          </>
+        )}
+      </div>
+      <div id="global">
+        <Form action={globalstate}>
+          <input name="globalfirstName" />
+          <input name="globallastName" />
+          <button type="submit" id="globalButton">
+            Add user
+          </button>
+        </Form>
+        {globalstate.value?.success && (
+          <>
+            <p>User {globalstate.value.userID.firstName} added successfully</p>
+            <p>User {globalstate.value.userID.lastName} added successfully</p>
+            <p>User {globalstate.value.userID.test} added successfully</p>
+          </>
+        )}
+      </div>
+    </>
+  );
+});

starters/e2e/qwikcity/resolve-value.spec.ts

@@ -0,0 +1,57 @@
+import { expect, test } from "@playwright/test";
+
+test.describe("revolve value", () => {
+  test.describe("mpa", () => {
+    test.use({ javaScriptEnabled: false });
+    tests();
+  });
+
+  test.describe("spa", () => {
+    test.use({ javaScriptEnabled: true });
+    tests();
+  });
+
+  function tests() {
+    test("should submit valid form data", async ({ page }) => {
+      await page.goto("/qwikcity-test/resolve-value");
+
+      await page.fill('input[name="firstName"]', "NewFirstName");
+      await page.fill('input[name="lastName"]', "NewLastName");
+      await page.click('button[id="actionButton"]');
+
+      const successMessage = page.locator(
+        'p:has-text("User NewFirstName added successfully")',
+      );
+      const lastNameSuccess = page.locator(
+        'p:has-text("User NewLastName added successfully")',
+      );
+      const userIdDisplay = page.locator(
+        'p:has-text("User 11 added successfully")',
+      );
+      await expect(successMessage).toBeVisible();
+      await expect(lastNameSuccess).toBeVisible();
+      await expect(userIdDisplay).toBeVisible();
+    });
+
+    test("should submit global form data", async ({ page }) => {
+      await page.goto("/qwikcity-test/resolve-value");
+
+      await page.fill('input[name="globalfirstName"]', "GlobalFirstName");
+      await page.fill('input[name="globallastName"]', "GlobalLastName");
+      await page.click('button[id="globalButton"]');
+
+      const globalSuccess = page.locator(
+        'p:has-text("User GlobalFirstName added successfully")',
+      );
+      const globalLastName = page.locator(
+        'p:has-text("User GlobalLastName added successfully")',
+      );
+      const globalUserId = page.locator(
+        'p:has-text("User 11 added successfully")',
+      );
+      await expect(globalSuccess).toBeVisible();
+      await expect(globalLastName).toBeVisible();
+      await expect(globalUserId).toBeVisible();
+    });
+  }
+});