test(solid-start): serialization-adapters suite

e2e/solid-start/serialization-adapters/.gitignore

@@ -0,0 +1,20 @@
+node_modules
+package-lock.json
+yarn.lock
+
+.DS_Store
+.cache
+.env
+.vercel
+.output
+/build/
+/api/
+/server/build
+/public/build# Sentry Config File
+.env.sentry-build-plugin
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+
+count.txt

e2e/solid-start/serialization-adapters/.prettierignore

@@ -0,0 +1,4 @@
+**/build
+**/public
+pnpm-lock.yaml
+routeTree.gen.ts

e2e/solid-start/serialization-adapters/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "tanstack-solid-start-e2e-serialization-adapters",
+  "private": true,
+  "sideEffects": false,
+  "type": "module",
+  "scripts": {
+    "dev": "vite dev --port 3000",
+    "dev:e2e": "vite dev",
+    "build": "vite build && tsc --noEmit",
+    "start": "pnpx srvx --prod -s ../client dist/server/server.js",
+    "test:e2e": "rm -rf port*.txt; playwright test --project=chromium"
+  },
+  "dependencies": {
+    "@tanstack/solid-router": "workspace:^",
+    "@tanstack/solid-router-devtools": "workspace:^",
+    "@tanstack/solid-start": "workspace:^",
+    "solid-js": "^1.9.10",
+    "vite": "^7.1.7",
+    "vite-tsconfig-paths": "^5.1.4",
+    "zod": "^3.24.2"
+  },
+  "devDependencies": {
+    "@tailwindcss/postcss": "^4.1.15",
+    "@tanstack/router-e2e-utils": "workspace:^",
+    "@types/node": "^22.10.2",
+    "postcss": "^8.5.1",
+    "seroval": "^1.3.2",
+    "srvx": "^0.8.6",
+    "tailwindcss": "^4.1.15",
+    "typescript": "^5.7.2",
+    "vite-plugin-solid": "^2.11.9"
+  }
+}

e2e/solid-start/serialization-adapters/playwright.config.ts

@@ -0,0 +1,34 @@
+import { defineConfig, devices } from '@playwright/test'
+import { getTestServerPort } from '@tanstack/router-e2e-utils'
+import packageJson from './package.json' with { type: 'json' }
+
+const PORT = await getTestServerPort(packageJson.name)
+const baseURL = `http://localhost:${PORT}`
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './tests',
+  workers: 1,
+
+  reporter: [['line']],
+
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL,
+  },
+
+  webServer: {
+    command: `VITE_SERVER_PORT=${PORT} pnpm build && NODE_ENV=production PORT=${PORT} VITE_SERVER_PORT=${PORT} pnpm start`,
+    url: baseURL,
+    reuseExistingServer: !process.env.CI,
+    stdout: 'pipe',
+  },
+
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+  ],
+})

e2e/solid-start/serialization-adapters/postcss.config.mjs

@@ -0,0 +1,5 @@
+export default {
+  plugins: {
+    '@tailwindcss/postcss': {},
+  },
+}

e2e/solid-start/serialization-adapters/src/CustomError.ts

@@ -0,0 +1,31 @@
+import { createSerializationAdapter } from '@tanstack/solid-router'
+
+export class CustomError extends Error {
+  public foo: string
+  public bar: bigint
+
+  constructor(message: string, options: { foo: string; bar: bigint }) {
+    super(message)
+
+    Object.setPrototypeOf(this, new.target.prototype)
+
+    this.name = this.constructor.name
+    this.foo = options.foo
+    this.bar = options.bar
+  }
+}
+
+export const customErrorAdapter = createSerializationAdapter({
+  key: 'custom-error',
+  test: (v) => v instanceof CustomError,
+  toSerializable: ({ message, foo, bar }) => {
+    return {
+      message,
+      foo,
+      bar,
+    }
+  },
+  fromSerializable: ({ message, foo, bar }) => {
+    return new CustomError(message, { foo, bar })
+  },
+})

e2e/solid-start/serialization-adapters/src/data.tsx

@@ -0,0 +1,205 @@
+import { createSerializationAdapter } from '@tanstack/solid-router'
+
+export class Foo {
+  constructor(public value: string) {}
+}
+
+export interface Car {
+  __type: 'car'
+  make: string
+  model: string
+  year: number
+  honk: () => { message: string; make: string; model: string; year: number }
+}
+
+export function makeCar(opts: {
+  make: string
+  model: string
+  year: number
+}): Car {
+  return {
+    ...opts,
+    __type: 'car',
+    honk: () => {
+      return { message: `Honk! Honk!`, ...opts }
+    },
+  }
+}
+
+export const fooAdapter = createSerializationAdapter({
+  key: 'foo',
+  test: (value: any) => value instanceof Foo,
+  toSerializable: (foo) => foo.value,
+  fromSerializable: (value) => new Foo(value),
+})
+
+export const carAdapter = createSerializationAdapter({
+  key: 'car',
+  test: (value: any): value is Car =>
+    '__type' in (value as Car) && value.__type === 'car',
+  toSerializable: (car) => ({
+    make: car.make,
+    model: car.model,
+    year: car.year,
+  }),
+  fromSerializable: (value: { make: string; model: string; year: number }) =>
+    makeCar(value),
+})
+
+export function makeData() {
+  function makeFoo(suffix: string = '') {
+    return new Foo(typeof window === 'undefined' ? 'server' : 'client' + suffix)
+  }
+  return {
+    foo: {
+      singleInstance: makeFoo(),
+      array: [makeFoo('0'), makeFoo('1'), makeFoo('2')],
+      map: new Map([
+        [0, makeFoo('0')],
+        [1, makeFoo('1')],
+        [2, makeFoo('2')],
+      ]),
+      mapOfArrays: new Map([
+        [0, [makeFoo('0-a'), makeFoo('0-b')]],
+        [1, [makeFoo('1-a'), makeFoo('1-b')]],
+        [2, [makeFoo('2-a'), makeFoo('2-b')]],
+      ]),
+    },
+    car: {
+      singleInstance: makeCar({
+        make: 'Toyota',
+        model: 'Camry',
+        year: 2020,
+      }),
+      array: [
+        makeCar({ make: 'Honda', model: 'Accord', year: 2019 }),
+        makeCar({ make: 'Ford', model: 'Mustang', year: 2021 }),
+      ],
+      map: new Map([
+        [0, makeCar({ make: 'Chevrolet', model: 'Malibu', year: 2018 })],
+        [1, makeCar({ make: 'Nissan', model: 'Altima', year: 2020 })],
+        [2, makeCar({ make: 'Hyundai', model: 'Sonata', year: 2021 })],
+      ]),
+      mapOfArrays: new Map([
+        [0, [makeCar({ make: 'Kia', model: 'Optima', year: 2019 })]],
+        [1, [makeCar({ make: 'Subaru', model: 'Legacy', year: 2020 })]],
+        [2, [makeCar({ make: 'Volkswagen', model: 'Passat', year: 2021 })]],
+      ]),
+    },
+  }
+}
+export class NestedOuter {
+  constructor(public inner: NestedInner) {}
+  whisper() {
+    return this.inner.value.toLowerCase()
+  }
+}
+
+export class NestedInner {
+  constructor(public value: string) {}
+  shout() {
+    return this.value.toUpperCase()
+  }
+}
+
+export const nestedInnerAdapter = createSerializationAdapter({
+  key: 'nestedInner',
+  test: (value): value is NestedInner => value instanceof NestedInner,
+  toSerializable: (inner) => inner.value,
+  fromSerializable: (value) => new NestedInner(value),
+})
+
+export const nestedOuterAdapter = createSerializationAdapter({
+  key: 'nestedOuter',
+  extends: [nestedInnerAdapter],
+  test: (value) => value instanceof NestedOuter,
+  toSerializable: (outer) => outer.inner,
+  fromSerializable: (value) => new NestedOuter(value),
+})
+
+export function makeNested() {
+  return new NestedOuter(new NestedInner('Hello World'))
+}
+
+export function RenderData({
+  id,
+  data,
+}: {
+  id: string
+  data: ReturnType<typeof makeData>
+}) {
+  const localData = makeData()
+  return (
+    <div data-testid={`${id}-container`}>
+      <h3>Car</h3>
+      <h4>expected</h4>
+      <div data-testid={`${id}-car-expected`}>
+        {JSON.stringify({
+          make: localData.car.singleInstance.make,
+          model: localData.car.singleInstance.model,
+          year: localData.car.singleInstance.year,
+        })}
+      </div>
+      <h4>actual</h4>
+      <div data-testid={`${id}-car-actual`}>
+        {JSON.stringify({
+          make: data.car.singleInstance.make,
+          model: data.car.singleInstance.model,
+          year: data.car.singleInstance.year,
+        })}
+      </div>
+      <b>Foo</b>
+      <div data-testid={`${id}-foo`}>
+        {JSON.stringify({
+          value: data.foo.singleInstance.value,
+        })}
+      </div>
+    </div>
+  )
+}
+
+export function RenderNestedData({ nested }: { nested: NestedOuter }) {
+  {
+    const localData = makeNested()
+    const expectedShoutState = localData.inner.shout()
+    const expectedWhisperState = localData.whisper()
+    const shoutState = nested.inner.shout()
+    const whisperState = nested.whisper()
+
+    return (
+      <div data-testid="data-only-container">
+        <h2 data-testid="data-only-heading">data-only</h2>
+        <div data-testid="shout-container">
+          <h3>shout</h3>
+          <div>
+            expected:{' '}
+            <div data-testid="shout-expected-state">
+              {JSON.stringify(expectedShoutState)}
+            </div>
+          </div>
+          <div>
+            actual:{' '}
+            <div data-testid="shout-actual-state">
+              {JSON.stringify(shoutState)}
+            </div>
+          </div>
+        </div>
+        <div data-testid="whisper-container">
+          <h3>whisper</h3>
+          <div>
+            expected:{' '}
+            <div data-testid="whisper-expected-state">
+              {JSON.stringify(expectedWhisperState)}
+            </div>
+          </div>
+          <div>
+            actual:{' '}
+            <div data-testid="whisper-actual-state">
+              {JSON.stringify(whisperState)}
+            </div>
+          </div>
+        </div>
+      </div>
+    )
+  }
+}