houdini-react 2.0.0-next.4 → 2.0.0-next.40

package/runtime/routing/cache.ts

@@ -0,0 +1,57 @@
+// a suspense cache is an object that maintains a key-value store of
+// objects. If a value is missing when get() is called, a promise
+// is thrown that resolves when a value is passed to set()
+import { LRUCache } from 'houdini/runtime'
+
+export function suspense_cache<T>(initialData?: Record<string, T>): SuspenseCache<T> {
+	const cache = new SuspenseCache<T>()
+
+	for (const [key, value] of Object.entries(initialData ?? {})) {
+		cache.set(key, value)
+	}
+
+	return cache
+}
+
+export class SuspenseCache<_Data> extends LRUCache<_Data> {
+	// if get is called before set, we need to invoke a callback.
+	// that means we need a place to put our callbacks
+	#callbacks: Map<string, { resolve: () => void; reject: () => void }[]> = new Map()
+
+	get(key: string): _Data {
+		// if there is a value, use that
+		if (super.has(key)) {
+			return super.get(key)!
+		}
+
+		// we don't have a value, so we need to throw a promise
+		// that resolves when a value is passed to set()
+		throw new Promise<void>((resolve, reject) => {
+			this.#subscribe(key, resolve, reject)
+		})
+	}
+
+	override clear() {
+		super.clear()
+		this.#callbacks.clear()
+	}
+
+	set(key: string, value: _Data) {
+		// perform the set like normal
+		super.set(key, value)
+
+		// if there are subscribers, resolve them
+		if (this.#callbacks.has(key)) {
+			// resolve all of the callbacks
+			this.#callbacks.get(key)?.forEach(({ resolve }) => {
+				resolve()
+			})
+			// delete the key
+			this.#callbacks.delete(key)
+		}
+	}
+
+	#subscribe(key: string, resolve: () => void, reject: () => void) {
+		this.#callbacks.set(key, [...(this.#callbacks.get(key) || []), { resolve, reject }])
+	}
+}

package/runtime/routing/errors.tsx

@@ -0,0 +1,145 @@
+import type { GraphQLError } from 'houdini/runtime'
+import React from 'react'
+
+export class GraphQLErrors extends Error {
+	graphqlErrors: GraphQLError[]
+
+	constructor(errors: GraphQLError[]) {
+		super(errors.map((e) => e.message).join('\n'))
+		this.name = 'GraphQLErrors'
+		this.graphqlErrors = errors
+	}
+}
+
+let _currentSegment: string | undefined
+
+export function setCurrentSegment(id: string | undefined): void {
+	_currentSegment = id
+}
+
+function getCurrentSegment(): string | undefined {
+	return _currentSegment
+}
+
+export class RoutingError extends Error {
+	status: number
+	segment: string | undefined
+
+	constructor(status: number) {
+		super(`Routing error: ${status}`)
+		this.name = 'RoutingError'
+		this.status = status
+		this.segment = getCurrentSegment()
+	}
+}
+
+export class RedirectError extends Error {
+	status: number
+	location: string
+
+	constructor(status: number, location: string) {
+		super(`Redirect: ${status} ${location}`)
+		this.name = 'RedirectError'
+		this.status = status
+		this.location = location
+	}
+}
+
+export function isRoutingError(error: unknown): error is RoutingError {
+	return error instanceof RoutingError
+}
+
+export function isApiError(error: unknown): error is GraphQLErrors {
+	return error instanceof GraphQLErrors
+}
+
+export function notFound(): never {
+	throw new RoutingError(404)
+}
+
+export function unauthorized(): never {
+	throw new RoutingError(401)
+}
+
+export function forbidden(): never {
+	throw new RoutingError(403)
+}
+
+export function httpError(status: number): never {
+	throw new RoutingError(status)
+}
+
+export function redirect(status: 300 | 301 | 302 | 303 | 307 | 308, location: string): never {
+	throw new RedirectError(status, location)
+}
+
+// Mutable ref passed from the server renderer so that a synchronous RoutingError
+// or redirect() can propagate the correct HTTP status/location before streaming.
+export const StatusContext = React.createContext<{ status: number; location?: string } | null>(null)
+
+type HoudiniErrorBoundaryProps = {
+	errorView: React.ComponentType<{
+		errors: Array<Error | GraphQLError>
+		children: React.ReactNode
+	}>
+	children: React.ReactNode
+}
+
+type HoudiniErrorBoundaryState = {
+	hasError: boolean
+	errors: Array<Error | GraphQLError>
+}
+
+export class HoudiniErrorBoundary extends React.Component<
+	HoudiniErrorBoundaryProps,
+	HoudiniErrorBoundaryState
+> {
+	static contextType = StatusContext
+	declare context: React.ContextType<typeof StatusContext>
+
+	constructor(
+		props: HoudiniErrorBoundaryProps,
+		context: React.ContextType<typeof StatusContext>
+	) {
+		super(props, context)
+		// Second-pass SSR: statusRef is pre-set to an error status by on_render after the first
+		// render threw. Start in error state immediately so children never render (and never throw).
+		if (typeof window === 'undefined' && context && context.status >= 400) {
+			this.state = {
+				hasError: true,
+				errors: [new RoutingError(context.status)],
+			}
+		} else {
+			this.state = { hasError: false, errors: [] }
+		}
+	}
+
+	static getDerivedStateFromError(error: unknown): HoudiniErrorBoundaryState {
+		if (error instanceof GraphQLErrors) {
+			return { hasError: true, errors: error.graphqlErrors }
+		}
+		return {
+			hasError: true,
+			errors: [error instanceof Error ? error : new Error(String(error))],
+		}
+	}
+
+	componentDidCatch(error: Error): void {
+		if (this.context) {
+			if (error instanceof RoutingError) {
+				this.context.status = error.status
+			} else if (error instanceof RedirectError) {
+				this.context.status = error.status
+				this.context.location = error.location
+			}
+		}
+	}
+
+	render() {
+		if (this.state.hasError) {
+			const ErrorView = this.props.errorView
+			return <ErrorView errors={this.state.errors}>{this.props.children}</ErrorView>
+		}
+		return this.props.children
+	}
+}

package/runtime/routing/index.ts

@@ -0,0 +1,17 @@
+export * from './Router.js'
+export { type SuspenseCache, suspense_cache } from './cache.js'
+export {
+	HoudiniErrorBoundary,
+	GraphQLErrors,
+	RoutingError,
+	RedirectError,
+	notFound,
+	unauthorized,
+	forbidden,
+	httpError,
+	redirect,
+	isRoutingError,
+	isApiError,
+	StatusContext,
+	setCurrentSegment,
+} from './errors.js'

package/runtime/tsconfig.json

@@ -0,0 +1,39 @@
+{
+    "compilerOptions": {
+        "baseUrl": ".",
+        "paths": {
+            "$houdini": ["."],
+            "$houdini/*": ["./*"],
+            "~": ["../src"],
+            "~/*": ["../src/*"]
+        },
+        "rootDirs": ["..", "./types"],
+        "target": "ESNext",
+        "useDefineForClassFields": true,
+        "lib": ["DOM", "DOM.Iterable", "ESNext"],
+        "allowJs": true,
+        "skipLibCheck": true,
+        "esModuleInterop": false,
+        "allowSyntheticDefaultImports": true,
+        "strict": true,
+        "forceConsistentCasingInFileNames": true,
+        "module": "ESNext",
+        "moduleResolution": "Bundler",
+        "allowImportingTsExtensions": true,
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "noEmit": true,
+        "jsx": "react-jsx"
+    },
+    "include": [
+        "ambient.d.ts",
+        "./types/**/$types.d.ts",
+        "../vite.config.ts",
+        "../src/**/*.js",
+        "../src/**/*.ts",
+        "../src/**/*.jsx",
+        "../src/**/*.tsx",
+        "../src/+app.d.ts"
+    ],
+    "exclude": ["../node_modules/**", "./[!ambient.d.ts]**"]
+}

package/server/index.d.ts

@@ -0,0 +1 @@
+export { renderToStream } from 'react-streaming/server';

package/server/index.js

@@ -0,0 +1,4 @@
+import { renderToStream } from "react-streaming/server";
+export {
+  renderToStream
+};

package/vite/index.d.ts

@@ -0,0 +1,3 @@
+import { VitePluginContext } from 'houdini/vite';
+import { PluginOption } from 'vite';
+export default function (ctx: VitePluginContext): PluginOption;

package/vite/index.js

@@ -0,0 +1,384 @@
+import { fs, path } from "houdini";
+import {
+  app_component_path,
+  adapter_config_path,
+  plugin_dir,
+  client_build_directory
+} from "houdini/router/conventions";
+import { load_manifest } from "houdini/router/manifest";
+import { existsSync, mkdirSync, writeFileSync } from "node:fs";
+import { createRequire } from "node:module";
+import { build } from "vite";
+import { transform_file } from "./transform.js";
+const REACT_TSCONFIG_STUB = `{
+    "compilerOptions": {
+        "baseUrl": ".",
+        "paths": {
+            "$houdini": ["."],
+            "$houdini/*": ["./*"],
+            "~": ["../src"],
+            "~/*": ["../src/*"]
+        },
+        "rootDirs": ["..", "./types"],
+        "target": "ESNext",
+        "useDefineForClassFields": true,
+        "lib": ["DOM", "DOM.Iterable", "ESNext"],
+        "allowJs": true,
+        "skipLibCheck": true,
+        "esModuleInterop": false,
+        "allowSyntheticDefaultImports": true,
+        "strict": true,
+        "forceConsistentCasingInFileNames": true,
+        "module": "ESNext",
+        "moduleResolution": "Bundler",
+        "allowImportingTsExtensions": true,
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "noEmit": true,
+        "jsx": "react-jsx"
+    },
+    "include": [
+        "ambient.d.ts",
+        "./types/**/$types.d.ts",
+        "../vite.config.ts",
+        "../src/**/*.js",
+        "../src/**/*.ts",
+        "../src/**/*.jsx",
+        "../src/**/*.tsx",
+        "../src/+app.d.ts"
+    ],
+    "exclude": ["../node_modules/**", "./[!ambient.d.ts]**"]
+}
+`;
+const _require = createRequire(import.meta.url);
+let reactStreamingServerPath = "";
+try {
+  const main = _require.resolve("react-streaming");
+  const pkgDir = main.replace(/\/dist\/.*$/, "");
+  reactStreamingServerPath = path.join(pkgDir, "dist/server/index.node-and-web.js");
+} catch {
+}
+function index_default(ctx) {
+  let manifest;
+  let viteEnv;
+  let devServer = false;
+  let isSSRBuild = false;
+  let cfCache = null;
+  return {
+    name: "houdini-react",
+    configResolved(config) {
+      isSSRBuild = !!config.build.ssr;
+    },
+    async config(userConfig, env) {
+      viteEnv = env;
+      const runtimeDir = path.join(
+        ctx.config.root_dir,
+        ctx.config.config_file.runtimeDir ?? ".houdini"
+      );
+      try {
+        mkdirSync(runtimeDir, { recursive: true });
+        const tsconfigPath = path.join(runtimeDir, "tsconfig.json");
+        if (!existsSync(tsconfigPath)) {
+          writeFileSync(tsconfigPath, REACT_TSCONFIG_STUB);
+        }
+      } catch {
+      }
+      if (userConfig.build?.ssr) {
+        return reactStreamingServerPath ? { resolve: { alias: { "react-streaming/server": reactStreamingServerPath } } } : {};
+      }
+      try {
+        manifest = await load_manifest({ config: ctx.config });
+      } catch (e) {
+        console.log(
+          "something went wrong. please try again. \n error: " + e.message
+        );
+        manifest = {
+          pages: {},
+          layouts: {},
+          page_queries: {},
+          layout_queries: {},
+          artifacts: [],
+          local_schema: false,
+          local_yoga: false,
+          component_fields: {}
+        };
+      }
+      let conf = {
+        build: { rollupOptions: {} }
+      };
+      if (env.command === "build") {
+        conf.base = "/assets";
+      }
+      const compiledAssetsDir = client_build_directory(ctx.config);
+      await fs.mkdirp(compiledAssetsDir);
+      conf.build = {
+        outDir: compiledAssetsDir,
+        rollupOptions: {
+          output: {
+            assetFileNames: "assets/[name].js",
+            entryFileNames: "[name].js"
+          },
+          input: {
+            "entries/app": app_component_path(ctx.config),
+            ...ctx.adapter ? { "entries/adapter": adapter_config_path(ctx.config) } : {}
+          }
+        }
+      };
+      if (env.command === "build" && ctx.adapter && ctx.adapter.includePaths) {
+        const extra = typeof ctx.adapter.includePaths === "function" ? ctx.adapter.includePaths({ config: ctx.config }) : ctx.adapter.includePaths;
+        Object.assign(conf.build.rollupOptions.input ?? {}, extra);
+      }
+      for (const [id, page] of Object.entries(manifest.pages)) {
+        ;
+        conf.build.rollupOptions.input[`pages/${id}`] = `virtual:houdini/pages/${page.id}.jsx`;
+      }
+      return reactStreamingServerPath ? {
+        ...conf,
+        resolve: { alias: { "react-streaming/server": reactStreamingServerPath } }
+      } : conf;
+    },
+    resolveId(id) {
+      if (id.includes("virtual:houdini")) {
+        return id.substring(id.indexOf("virtual:houdini"));
+      }
+      return null;
+    },
+    hotUpdate() {
+      cfCache = null;
+    },
+    async transform(code, filepath) {
+      filepath = path.posixify(filepath);
+      if (filepath.startsWith("/src/")) {
+        filepath = path.join(process.cwd(), filepath);
+      }
+      if (!ctx.config.includeFile(filepath)) {
+        return;
+      }
+      if (cfCache === null) {
+        try {
+          cfCache = ctx.db.all(
+            "SELECT type, field, fragment FROM component_fields"
+          );
+        } catch {
+          cfCache = [];
+        }
+      }
+      return transform_file(
+        {
+          config: ctx.config,
+          content: code,
+          filepath: path.posixify(filepath),
+          watch_file: this.addWatchFile.bind(this)
+        },
+        cfCache
+      );
+    },
+    async closeBundle() {
+      if (viteEnv.mode !== "production" || devServer || isSSRBuild) {
+        return;
+      }
+      if (!ctx.adapter || ctx.adapter?.disableServer) {
+        return;
+      }
+      const compiledAssetsDir = client_build_directory(ctx.config);
+      await build({
+        build: {
+          ssr: true,
+          outDir: path.join(compiledAssetsDir, "ssr"),
+          rollupOptions: {
+            output: {
+              assetFileNames: "assets/[name].js",
+              entryFileNames: "[name].js"
+            },
+            input: {
+              "entries/adapter": adapter_config_path(ctx.config)
+            }
+          }
+        }
+      });
+    },
+    async load(id) {
+      if (!id.startsWith("virtual:houdini")) {
+        return;
+      }
+      if (!manifest) {
+        return;
+      }
+      let [, which, arg] = id.split("/");
+      const parsedPath = arg ? path.parse(arg) : "";
+      const pageName = parsedPath ? parsedPath.name : "";
+      if (which === "pages") {
+        let page = manifest.pages[pageName];
+        if (!page) {
+          try {
+            manifest = await load_manifest({ config: ctx.config });
+            page = manifest.pages[pageName];
+          } catch {
+          }
+        }
+        if (!page) {
+          throw new Error("unknown page" + pageName);
+        }
+        const pendingQueries = page.queries.filter((query) => {
+          const pg = Object.values(manifest.page_queries).find((q) => q.name === query);
+          if (pg) {
+            return pg.loading;
+          }
+          const layout = Object.values(manifest.layout_queries).find(
+            (q) => q.name === query
+          );
+          return layout?.loading;
+        });
+        return `
+import App from '$houdini/plugins/houdini-react/units/render/App'
+import Component from '$houdini/plugins/houdini-react/units/entries/${pageName}.jsx'
+import { hydrate_page } from '$houdini/plugins/houdini-react/runtime/hydration'
+hydrate_page(App, Component, '${pageName}', ${JSON.stringify(pendingQueries)})
+`;
+      }
+      if (which === "artifacts") {
+        return `
+import artifact from '$houdini/artifacts/${pageName}'
+import { register_artifact } from '$houdini/plugins/houdini-react/runtime/hydration'
+register_artifact('${pageName}', artifact)
+`;
+      }
+      if (which === "static-entry") {
+        return `
+import App from '$houdini/plugins/houdini-react/units/render/App'
+import manifest from '$houdini/plugins/houdini-react/runtime/manifest'
+import { mount_static_app } from '$houdini/plugins/houdini-react/runtime/hydration'
+mount_static_app(App, manifest)
+`;
+      }
+    },
+    async configureServer(server) {
+      devServer = true;
+      const onUnhandledRejection = (err) => {
+        console.error("\n[houdini] dev server error (server still running):\n", err, "\n");
+      };
+      process.on("unhandledRejection", onUnhandledRejection);
+      server.httpServer?.once(
+        "close",
+        () => process.off("unhandledRejection", onUnhandledRejection)
+      );
+      server.httpServer?.once("listening", () => {
+        const addr = server.httpServer?.address();
+        if (addr && typeof addr === "object") {
+          process.env.HOUDINI_PORT = String(addr.port);
+        }
+        const root = ctx.config.root_dir;
+        const entry = ["+index.tsx", "+index.jsx"].map((f) => path.join(root, "src", f)).find((f) => existsSync(f));
+        if (entry) {
+          server.ssrLoadModule(entry).catch(() => {
+          });
+        }
+      });
+      server.middlewares.use(async (req, res, next) => {
+        if (!req.url) {
+          next();
+          return;
+        }
+        const url = req.url.split("?")[0];
+        if (url.startsWith("/@") || url.startsWith("/virtual:") || url.startsWith("/node_modules/") || /\.[a-z]+$/i.test(url)) {
+          next();
+          return;
+        }
+        const { default: router_manifest } = await server.ssrLoadModule(
+          path.join(plugin_dir(ctx.config, "houdini-react"), "runtime", "manifest.ts")
+        );
+        const { createServerAdapter } = await server.ssrLoadModule(
+          adapter_config_path(ctx.config)
+        );
+        const requestHeaders = new Headers();
+        for (const header of Object.entries(req.headers ?? {})) {
+          requestHeaders.set(header[0], header[1]);
+        }
+        const port = server.config.server.port ?? 5173;
+        const request = new Request(
+          `http://localhost:${port}` + req.url,
+          req.method === "POST" ? {
+            method: req.method,
+            headers: requestHeaders,
+            body: await getBody(req)
+          } : void 0
+        );
+        let documentPremable = `<script type="module" src="/@vite/client" async=""></script>`;
+        try {
+          const transformed = await server.transformIndexHtml(
+            req.url,
+            "<!DOCTYPE html><html><head></head><body></body></html>"
+          );
+          const headMatch = transformed.match(/<head>([\s\S]*?)<\/head>/);
+          if (headMatch?.[1]?.trim()) {
+            documentPremable = headMatch[1].trim();
+          }
+        } catch {
+        }
+        const cssLinkSet = /* @__PURE__ */ new Set();
+        for (const [url2] of server.moduleGraph.urlToModuleMap) {
+          const cleanUrl = url2.split("?")[0];
+          if (!cleanUrl.includes("node_modules") && cleanUrl.endsWith(".css") && !cleanUrl.endsWith(".module.css")) {
+            cssLinkSet.add(cleanUrl);
+          }
+        }
+        const cssLinks = [...cssLinkSet];
+        res.setHeader("Content-Type", "text/html; charset=utf-8");
+        try {
+          const result = await createServerAdapter({
+            production: false,
+            manifest: router_manifest,
+            assetPrefix: "/virtual:houdini",
+            pipe: res,
+            documentPremable,
+            cssLinks
+          })(request);
+          if (result && result.status === 404) {
+            return next();
+          }
+          if (result && typeof result !== "boolean") {
+            if (res.closed) {
+              return;
+            }
+            for (const header of result.headers ?? []) {
+              res.setHeader(header[0], header[1]);
+            }
+            if (result.status >= 300 && result.status < 400) {
+              res.writeHead(result.status, {
+                Location: result.headers.get("Location") ?? "",
+                ...[...result.headers].reduce(
+                  (headers, [key, value]) => ({
+                    ...headers,
+                    [key]: value
+                  }),
+                  {}
+                )
+              });
+            } else {
+              res.write(await result.text());
+            }
+            res.end();
+          }
+        } catch (e) {
+          console.error(e);
+          res.end();
+        }
+      });
+    }
+  };
+}
+function getBody(request) {
+  return new Promise((resolve) => {
+    const bodyParts = [];
+    let body;
+    request.on("data", (chunk) => {
+      bodyParts.push(chunk);
+    }).on("end", () => {
+      body = Buffer.concat(bodyParts).toString();
+      resolve(body);
+    });
+  });
+}
+export {
+  index_default as default
+};

package/vite/transform.d.ts

@@ -0,0 +1,11 @@
+import type { TransformPage } from 'houdini';
+import type { SourceMapInput } from 'rollup';
+export type ComponentFieldRow = {
+    type: string;
+    field: string;
+    fragment: string;
+};
+export declare function transform_file(page: TransformPage, cfRows: ComponentFieldRow[]): Promise<{
+    code: string;
+    map?: SourceMapInput;
+}>;