fix: Enhance route matching to return isPage flag and add tests for… (#1927)

Author: dennev

.changeset/slow-eagles-wear.md

@@ -0,0 +1,5 @@
+---
+"@solidjs/start": patch
+---
+
+Enhance route matching to return `isPage` flag and add tests for plain text API response and Missing page handling that has both api/file routes.

packages/start/src/router/routes.ts

@@ -60,14 +60,27 @@ function defineRoutes(fileRoutes: Route[]) {
 export function matchAPIRoute(path: string, method: string) {
   const match = router.lookup(path);
   if (match && match.route) {
-    const handler =
-      method === "HEAD" ? match.route["$HEAD"] || match.route["$GET"] : match.route[`$${method}`];
+    const route = match.route;
+
+    // Find the appropriate handler for the HTTP method
+    const handler = method === "HEAD"
+      ? route.$HEAD || route.$GET
+      : route[`$${method}`];
+
     if (handler === undefined) return;
+
+    // Check if this is a page route
+    const isPage = route.page === true && route.$component !== undefined;
+
+    // Return comprehensive route information
     return {
       handler,
-      params: match.params
+      params: match.params,
+      isPage
     };
   }
+
+  return undefined;
 }
 
 function containsHTTP(route: Route) {

packages/start/src/server/handler.ts

@@ -59,6 +59,7 @@ export function createBaseHandler(
               `API handler for ${event.request.method} "${event.request.url}" did not return a response.`
             );
           }
+          if (!match.isPage) return;
         }
 
         // render

packages/tests/src/app.tsx

@@ -50,6 +50,12 @@ export default function App() {
             <li>
               <a href="/generator-server-function">generator server function</a>
             </li>
+            <li>
+              <a href="/not-found">Not Found</a>
+            </li>
+            <li>
+              <a href="/text-plain-response">Text Plain Response</a>
+            </li>
             <li>
               <a href="/referencing-multiple-export-named-functions-in-the-same-file">referencing multiple export named functions in the same file</a>
             </li>

packages/tests/src/routes/[...404].tsx

@@ -0,0 +1,21 @@
+import { Title } from "@solidjs/meta";
+import { HttpStatusCode } from "@solidjs/start";
+import type { APIEvent } from "@solidjs/start/server";
+
+export const GET = (event: APIEvent) => {
+  if (event.request.headers.get("accept") !== "application/json") return;
+  return { notFound: "API" };
+};
+
+export default function NotFound() {
+  return (
+    <main>
+      <Title>Not Found</Title>
+      <HttpStatusCode code={404} />
+      <h1>Page Not Found</h1>
+      <p>
+        {"Your page cannot be found... >_<"}
+      </p>
+    </main>
+  );
+}

packages/tests/src/routes/api/text-plain.tsx

@@ -0,0 +1,3 @@
+export function GET(e: { nativeEvent: { respondWith: (arg0: Response) => void; }; }) {
+  e.nativeEvent.respondWith(new Response("test"));
+}

packages/tests/src/routes/text-plain-response.tsx

@@ -0,0 +1,15 @@
+export default function App() {
+  const handleClick = (e: Event) => {
+    // e.preventDefault();
+
+    window.location.href = "/api/text-plain";
+  };
+
+  return (
+    <main>
+      <a href="/api/text-plain" onClick={handleClick}>
+        Text Plain Response
+      </a>
+    </main>
+  );
+};