fix: server functions inclusivity + runtime exports (#2127)

Co-authored-by: Katja Lutz <mail@katjalutz.ch>

Author: lxsmnsyc

.changeset/eight-pears-kiss.md

@@ -0,0 +1,5 @@
+---
+"@solidjs/start": patch
+---
+
+The server function directives runtime is now internally accessed via package.json exports instead of relative paths, fixing inconsistencies in the file resolution. Also the server functions file inclusion/exclusion patterns can now be configured in the start plugin options via `serverFunctions`.

packages/start/package.json

@@ -19,7 +19,9 @@
     "./client/spa": "./src/client/spa/index.tsx",
     "./middleware": "./src/middleware/index.ts",
     "./http": "./src/http/index.ts",
-    "./env": "./env.d.ts"
+    "./env": "./env.d.ts",
+    "./fns/server": "./src/fns/server.ts",
+    "./fns/client": "./src/fns/client.ts"
   },
   "publishConfig": {
     "access": "public",
@@ -33,7 +35,9 @@
       "./client/spa": "./dist/client/spa/index.jsx",
       "./middleware": "./dist/middleware/index.js",
       "./http": "./dist/http/index.js",
-      "./env": "./env.d.ts"
+      "./env": "./env.d.ts",
+      "./fns/server": "./dist/fns/server.js",
+      "./fns/client": "./dist/fns/client.js"
     }
   },
   "dependencies": {

packages/start/src/config/index.ts

@@ -1,13 +1,12 @@
 import { defu } from "defu";
 import { globSync } from "node:fs";
 import { extname, isAbsolute, join } from "node:path";
-import { fileURLToPath } from "node:url";
-import { normalizePath, type PluginOption } from "vite";
+import type { PluginOption } from "vite";
 import solid, { type Options as SolidOptions } from "vite-plugin-solid";
-import { serverFunctionsPlugin } from "../directives/index.ts";
+import { type ServerFunctionsOptions, serverFunctionsPlugin } from "../directives/index.ts";
 import { DEFAULT_EXTENSIONS, VIRTUAL_MODULES, VITE_ENVIRONMENTS } from "./constants.ts";
 import { devServer } from "./dev-server.ts";
-import { type EnvPluginOptions, envPlugin } from "./env.ts";
+import { envPlugin, type EnvPluginOptions } from "./env.ts";
 import { SolidStartClientFileRouter, SolidStartServerFileRouter } from "./fs-router.ts";
 import { fsRoutes } from "./fs-routes/index.ts";
 import type { BaseFileSystemRouter } from "./fs-routes/router.ts";
@@ -33,6 +32,7 @@ export interface SolidStartOptions {
     mode?: "js" | "json";
   };
   env?: EnvPluginOptions;
+  serverFunctions?: Pick<ServerFunctionsOptions, "filter">;
 }
 
 const absolute = (path: string, root: string) =>
@@ -144,6 +144,9 @@ export function solidStart(options?: SolidStartOptions): Array<PluginOption> {
                   }
                 : {}),
             },
+            // Depending on the package manager and dependency structure Vite externalizes @solidjs/start
+            // This makes sure that @solidjs/start goes through the Vite build process
+            noExternal: ["@solidjs/start"],
           },
           define: {
             "import.meta.env.MANIFEST": `globalThis.MANIFEST`,
@@ -192,13 +195,10 @@ export function solidStart(options?: SolidStartOptions): Array<PluginOption> {
     serverFunctionsPlugin({
       manifest: VIRTUAL_MODULES.serverFnManifest,
       runtime: {
-        server: normalizePath(
-          fileURLToPath(new URL("../server/server-fns-runtime.ts", import.meta.url)),
-        ),
-        client: normalizePath(
-          fileURLToPath(new URL("../server/server-runtime.ts", import.meta.url)),
-        ),
+        server: '@solidjs/start/fns/server',
+        client: '@solidjs/start/fns/client',
       },
+      filter: options?.serverFunctions?.filter,
     }),
     {
       name: "solid-start:virtual-modules",

packages/start/src/directives/index.ts

@@ -113,6 +113,7 @@ function invalidateModules(
   }
 }
 
+
 export function serverFunctionsPlugin(options: ServerFunctionsOptions): Plugin[] {
   const filter = createFilter(
     options.filter?.include || DEFAULT_INCLUDE,

…kages/start/src/server/server-runtime.ts packages/start/src/fns/client.tspackages/start/src/server/server-runtime.ts renamed to packages/start/src/fns/client.ts packages/start/src/server/server-runtime.ts renamed to packages/start/src/fns/client.ts

@@ -8,7 +8,7 @@ import {
   BodyFormat,
   extractBody,
   getHeadersAndBody,
-} from "./server-functions-shared.ts";
+} from "./shared.ts";
 
 let INSTANCE = 0;
 

…/server/server-functions-handler.spec.ts packages/start/src/fns/handler.spec.tspackages/start/src/server/server-functions-handler.spec.ts renamed to packages/start/src/fns/handler.spec.ts packages/start/src/server/server-functions-handler.spec.ts renamed to packages/start/src/fns/handler.spec.ts

@@ -4,8 +4,8 @@ import { sharedConfig } from "solid-js";
 import { renderToString } from "solid-js/web";
 import { provideRequestEvent } from "solid-js/web/storage";
 
-import { getFetchEvent, mergeResponseHeaders } from "./fetchEvent.ts";
-import { createPageEvent } from "./handler.ts";
+import { getFetchEvent, mergeResponseHeaders } from "../server/fetchEvent.ts";
+import { createPageEvent } from "../server/handler.ts";
 import {
   deserializeFromJSONString,
   serializeToJSONStream,
@@ -16,12 +16,12 @@ import {
   BodyFormat,
   extractBody,
   getHeadersAndBody,
-} from "./server-functions-shared.ts";
+} from "./shared.ts";
 import "solid-start:server-fn-manifest";
 
-import { getServerFunction } from "./server-fns.ts";
-import type { FetchEvent, PageEvent } from "./types.ts";
-import { getExpectedRedirectStatus } from "./util.ts";
+import { getServerFunction } from "./registration.ts";
+import type { FetchEvent, PageEvent } from "../server/types.ts";
+import { getExpectedRedirectStatus } from "../server/util.ts";
 
 export async function handleServerFunction(h3Event: H3Event) {
   const event = getFetchEvent(h3Event);

…t/src/server/server-functions-handler.ts packages/start/src/fns/handler.tspackages/start/src/server/server-functions-handler.ts renamed to packages/start/src/fns/handler.ts packages/start/src/server/server-functions-handler.ts renamed to packages/start/src/fns/handler.ts

@@ -1,6 +1,6 @@
 import { getRequestEvent } from "solid-js/web";
 import { provideRequestEvent } from "solid-js/web/storage";
-import { registerServerFunction } from "./server-fns.ts";
+import { registerServerFunction } from "./registration.ts";
 
 interface Registration<T extends any[], R> {
   id: string;