feat(1.0): seroval json

.changeset/icy-rings-exist.md

@@ -0,0 +1,5 @@
+---
+"@solidjs/start": minor
+---
+
+seroval json mode

apps/fixtures/serialization-modes/README.md

@@ -0,0 +1,19 @@
+# Serialization checks
+
+This fixture is designed to point out the differences between Seroval 2 modes.
+
+```ts
+export default defineConfig({
+  middleware: "./src/middleware.ts",
+  serialization: {
+    mode: "js" // "json"
+  }
+});
+```
+
+On JS mode, seroval will use a custom serializer, while this improves performance and reduces payload size, it runs an `eval()` on client-side,
+so a strict CSP will block deserialization. On JSON mode, the payload will be slightly larger, but deserialization happens via `JSON.parse` and thus CSP will not block it.
+
+> [!IMPORTANT]
+> For backwards compatibility, `v1` has "js" as the default.
+> On `v2`, "json" is the new default.

apps/fixtures/serialization-modes/app.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from "@solidjs/start/config";
+
+export default defineConfig({
+  middleware: "./src/middleware.ts",
+  serialization: {
+    mode: "js"
+  }
+});

apps/fixtures/serialization-modes/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "fixture-serialization-modes",
+  "type": "module",
+  "scripts": {
+    "dev": "vinxi dev",
+    "build": "vinxi build",
+    "start": "vinxi start",
+    "version": "vinxi version"
+  },
+  "dependencies": {
+    "@solidjs/meta": "^0.29.4",
+    "@solidjs/router": "^0.15.0",
+    "@solidjs/start": "workspace:*",
+    "shieldwall": "^0.4.0",
+    "solid-js": "^1.9.5",
+    "vinxi": "^0.5.7"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}

apps/fixtures/serialization-modes/src/app.css

@@ -0,0 +1,39 @@
+body {
+  font-family: Gordita, Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif;
+}
+
+a {
+  margin-right: 1rem;
+}
+
+main {
+  text-align: center;
+  padding: 1em;
+  margin: 0 auto;
+}
+
+h1 {
+  color: #335d92;
+  text-transform: uppercase;
+  font-size: 4rem;
+  font-weight: 100;
+  line-height: 1.1;
+  margin: 4rem auto;
+  max-width: 14rem;
+}
+
+p {
+  max-width: 14rem;
+  margin: 2rem auto;
+  line-height: 1.35;
+}
+
+@media (min-width: 480px) {
+  h1 {
+    max-width: none;
+  }
+
+  p {
+    max-width: none;
+  }
+}

apps/fixtures/serialization-modes/src/app.tsx

@@ -0,0 +1,22 @@
+import { MetaProvider, Title } from "@solidjs/meta";
+import { Router } from "@solidjs/router";
+import { FileRoutes } from "@solidjs/start/router";
+import { Suspense } from "solid-js";
+import "./app.css";
+
+export default function App() {
+  return (
+    <Router
+      root={props => (
+        <MetaProvider>
+          <Title>SolidStart - Basic</Title>
+          <a href="/">Index</a>
+          <a href="/about">About</a>
+          <Suspense>{props.children}</Suspense>
+        </MetaProvider>
+      )}
+    >
+      <FileRoutes />
+    </Router>
+  );
+}

apps/fixtures/serialization-modes/src/components/Counter.css

@@ -0,0 +1,21 @@
+.increment {
+  font-family: inherit;
+  font-size: inherit;
+  padding: 1em 2em;
+  color: #335d92;
+  background-color: rgba(68, 107, 158, 0.1);
+  border-radius: 2em;
+  border: 2px solid rgba(68, 107, 158, 0);
+  outline: none;
+  width: 200px;
+  font-variant-numeric: tabular-nums;
+  cursor: pointer;
+}
+
+.increment:focus {
+  border: 2px solid #335d92;
+}
+
+.increment:active {
+  background-color: rgba(68, 107, 158, 0.2);
+}

apps/fixtures/serialization-modes/src/components/Counter.tsx

@@ -0,0 +1,11 @@
+import { createSignal } from "solid-js";
+import "./Counter.css";
+
+export default function Counter() {
+  const [count, setCount] = createSignal(0);
+  return (
+    <button class="increment" onClick={() => setCount(count() + 1)} type="button">
+      Clicks: {count()}
+    </button>
+  );
+}

apps/fixtures/serialization-modes/src/entry-client.tsx

@@ -0,0 +1,4 @@
+// @refresh reload
+import { mount, StartClient } from "@solidjs/start/client";
+
+mount(() => <StartClient />, document.getElementById("app")!);

apps/fixtures/serialization-modes/src/entry-server.tsx

@@ -0,0 +1,21 @@
+// @refresh reload
+import { createHandler, StartServer } from "@solidjs/start/server";
+
+export default createHandler(() => (
+  <StartServer
+    document={({ assets, children, scripts }) => (
+      <html lang="en">
+        <head>
+          <meta charset="utf-8" />
+          <meta name="viewport" content="width=device-width, initial-scale=1" />
+          <link rel="icon" href="/favicon.ico" />
+          {assets}
+        </head>
+        <body>
+          <div id="app">{children}</div>
+          {scripts}
+        </body>
+      </html>
+    )}
+  />
+));

apps/fixtures/serialization-modes/src/global.d.ts

@@ -0,0 +1 @@
+/// <reference types="@solidjs/start/env" />

apps/fixtures/serialization-modes/src/middleware.ts

@@ -0,0 +1,26 @@
+import { createMiddleware } from "@solidjs/start/middleware";
+import { csp } from "shieldwall/start";
+import { UNSAFE_INLINE } from "shieldwall/start/csp";
+
+export default createMiddleware({
+  onRequest: [
+    csp({
+      extend: "production_basic",
+      config: {
+        withNonce: false,
+        reportOnly: false,
+        value: {
+          "default-src": ["self"],
+          "script-src": ["self", UNSAFE_INLINE, "http:"],
+          "style-src": ["self", UNSAFE_INLINE],
+          "img-src": ["self", "data:", "https:", "http:"],
+          "font-src": ["self"],
+          "connect-src": ["self", "ws://localhost:*", "http://localhost:*"],
+          "frame-src": ["self"],
+          "base-uri": ["self"]
+          // "form-action": ["self"]
+        }
+      }
+    })
+  ]
+});

apps/fixtures/serialization-modes/src/routes/[...404].tsx

@@ -0,0 +1,19 @@
+import { Title } from "@solidjs/meta";
+import { HttpStatusCode } from "@solidjs/start";
+
+export default function NotFound() {
+  return (
+    <main>
+      <Title>Not Found</Title>
+      <HttpStatusCode code={404} />
+      <h1>Page Not Found</h1>
+      <p>
+        Visit{" "}
+        <a href="https://start.solidjs.com" target="_blank">
+          start.solidjs.com
+        </a>{" "}
+        to learn how to build SolidStart apps.
+      </p>
+    </main>
+  );
+}

apps/fixtures/serialization-modes/src/routes/index.tsx

@@ -0,0 +1,30 @@
+import { Title } from "@solidjs/meta";
+import { createEffect } from "solid-js";
+import Counter from "~/components/Counter";
+
+const breakval = () => {
+  "use server";
+
+  return new Date();
+};
+
+export default function Home() {
+  createEffect(() => {
+    console.log(breakval());
+  });
+
+  return (
+    <main>
+      <Title>Hello World</Title>
+      <h1>Hello world!</h1>
+      <Counter />
+      <p>
+        Visit{" "}
+        <a href="https://start.solidjs.com" target="_blank">
+          start.solidjs.com
+        </a>{" "}
+        to learn how to build SolidStart apps.
+      </p>
+    </main>
+  );
+}

apps/fixtures/serialization-modes/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "jsx": "preserve",
+    "jsxImportSource": "solid-js",
+    "allowJs": true,
+    "strict": true,
+    "noEmit": true,
+    "types": ["vinxi/types/client"],
+    "isolatedModules": true,
+    "paths": {
+      "~/*": ["./src/*"]
+    }
+  }
+}

apps/tests/src/middleware.ts

@@ -0,0 +1,5 @@
+import { createMiddleware } from "@solidjs/start/middleware";
+
+export default createMiddleware({
+  onRequest: []
+});

apps/tests/src/routes/actions/use-submission.tsx

@@ -0,0 +1,23 @@
+import { Title } from "@solidjs/meta";
+import { action, useSubmission } from "@solidjs/router";
+import { Show } from "solid-js";
+
+const actionStuff = action(async () => {
+  "use server";
+
+  return "Hello world!";
+}, "actionStuff");
+
+export default function Home() {
+  const actionData = useSubmission(actionStuff);
+  return (
+    <main>
+      <Title>Hello World</Title>
+      <form action={actionStuff} method="post">
+        <button type="submit">Click me</button>
+      </form>
+
+      <Show when={actionData}>{result => <p>{result().result}</p>}</Show>
+    </main>
+  );
+}

packages/start/config/index.d.ts

@@ -26,6 +26,19 @@ type SolidStartInlineConfig = {
   experimental?: {
     islands?: boolean;
   };
+  serialization?: {
+    /**
+     * The serialization mode to use for server functions.
+     * The "js" mode uses a custom binary format that is more efficient than JSON, but requires a custom deserializer (with `eval()`) on the client.
+     * A strong CSP should block `eval()` executions, which would prevent the "js" mode from working.
+     * The "json" mode uses JSON for serialization, which is less efficient but can be deserialized with `JSON.parse` on the client.
+     *
+     * @default "js"
+     * @
+     * @warning on v2, "json" will be the default.
+     */
+    mode?: "js" | "json";
+  };
   vite?:
     | ViteCustomizableConfig
     | ((options: { router: "server" | "client" | "server-function" }) => ViteCustomizableConfig);

packages/start/config/index.js

@@ -89,6 +89,7 @@ export function defineConfig(baseConfig = {}) {
       }
     }
   });
+
   const routeDir = join(start.appRoot, start.routeDir);
   let server = start.server;
   if (!start.ssr) {
@@ -99,6 +100,8 @@ export function defineConfig(baseConfig = {}) {
     entryExtension = ".jsx";
   }
 
+  const serializationMode = start.serialization?.mode || 'js'
+
   return createApp({
     server: {
       compressPublicAssets: {
@@ -167,6 +170,7 @@ export function defineConfig(baseConfig = {}) {
                 "import.meta.env.SSR": JSON.stringify(true),
                 "import.meta.env.START_SSR": JSON.stringify(start.ssr),
                 "import.meta.env.START_DEV_OVERLAY": JSON.stringify(start.devOverlay),
+                "import.meta.env.SEROVAL_MODE": JSON.stringify(serializationMode),
                 ...userConfig.define
               }
             })
@@ -234,6 +238,7 @@ export function defineConfig(baseConfig = {}) {
                 "import.meta.env.START_SSR": JSON.stringify(start.ssr),
                 "import.meta.env.START_DEV_OVERLAY": JSON.stringify(start.devOverlay),
                 "import.meta.env.SERVER_BASE_URL": JSON.stringify(server?.baseURL ?? ""),
+                "import.meta.env.SEROVAL_MODE": JSON.stringify(serializationMode),
                 ...userConfig.define
               }
             })
@@ -293,6 +298,7 @@ export function defineConfig(baseConfig = {}) {
                 "import.meta.env.SSR": JSON.stringify(true),
                 "import.meta.env.START_SSR": JSON.stringify(start.ssr),
                 "import.meta.env.START_DEV_OVERLAY": JSON.stringify(start.devOverlay),
+                "import.meta.env.SEROVAL_MODE": JSON.stringify(serializationMode),
                 ...userConfig.define
               }
             })