Support experimental-vite-env-api (#85)

* support  `unstable_viteEnvironmentApi`
* use React Router future flag to adapt the config

examples/node/simple-future/.eslintrc.cjs

@@ -0,0 +1,80 @@
+/**
+ * This is intended to be a basic starting point for linting in your app.
+ * It relies on recommended configs out of the box for simplicity, but you can
+ * and should modify this configuration to best suit your team's needs.
+ */
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  root: true,
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+  env: {
+    browser: true,
+    commonjs: true,
+    es6: true,
+  },
+  ignorePatterns: ["!**/.server", "!**/.client"],
+
+  // Base config
+  extends: ["eslint:recommended"],
+
+  overrides: [
+    // React
+    {
+      files: ["**/*.{js,jsx,ts,tsx}"],
+      plugins: ["react", "jsx-a11y"],
+      extends: [
+        "plugin:react/recommended",
+        "plugin:react/jsx-runtime",
+        "plugin:react-hooks/recommended",
+        "plugin:jsx-a11y/recommended",
+      ],
+      settings: {
+        react: {
+          version: "detect",
+        },
+        formComponents: ["Form"],
+        linkComponents: [
+          { name: "Link", linkAttribute: "to" },
+          { name: "NavLink", linkAttribute: "to" },
+        ],
+        "import/resolver": {
+          typescript: {},
+        },
+      },
+    },
+
+    // Typescript
+    {
+      files: ["**/*.{ts,tsx}"],
+      plugins: ["@typescript-eslint", "import"],
+      parser: "@typescript-eslint/parser",
+      settings: {
+        "import/internal-regex": "^~/",
+        "import/resolver": {
+          node: {
+            extensions: [".ts", ".tsx"],
+          },
+          typescript: {
+            alwaysTryTypes: true,
+          },
+        },
+      },
+      extends: ["plugin:@typescript-eslint/recommended", "plugin:import/recommended", "plugin:import/typescript"],
+    },
+
+    // Node
+    {
+      files: [".eslintrc.cjs"],
+      env: {
+        node: true,
+      },
+    },
+  ],
+};

examples/node/simple-future/.gitignore

@@ -0,0 +1,5 @@
+node_modules
+
+/.cache
+/build
+.env

examples/node/simple-future/README.md

@@ -0,0 +1,36 @@
+# Welcome to Remix + Vite!
+
+📖 See the [Remix docs](https://remix.run/docs) and the [Remix Vite docs](https://remix.run/docs/en/main/guides/vite) for details on supported features.
+
+## Development
+
+Run the Vite dev server:
+
+```shellscript
+npm run dev
+```
+
+## Deployment
+
+First, build your app for production:
+
+```sh
+npm run build
+```
+
+Then run the app in production mode:
+
+```sh
+npm start
+```
+
+Now you'll need to pick a host to deploy it to.
+
+### DIY
+
+If you're familiar with deploying Node applications, the built-in Remix app server is production-ready.
+
+Make sure to deploy the output of `npm run build`
+
+- `build/server`
+- `build/client`

examples/node/simple-future/app/components/input.tsx

@@ -0,0 +1,3 @@
+export function Input(props: React.ComponentPropsWithoutRef<"input">) {
+  return <input type="text" placeholder="Input" {...props} />;
+}

examples/node/simple-future/app/entry.client.tsx

@@ -0,0 +1,12 @@
+import { StrictMode, startTransition } from "react";
+import { hydrateRoot } from "react-dom/client";
+import { HydratedRouter } from "react-router/dom";
+
+startTransition(() => {
+  hydrateRoot(
+    document,
+    <StrictMode>
+      <HydratedRouter />
+    </StrictMode>
+  );
+});

examples/node/simple-future/app/entry.server.tsx

@@ -0,0 +1,63 @@
+import { PassThrough } from "node:stream";
+
+import { createReadableStreamFromReadable } from "@react-router/node";
+import { isbot } from "isbot";
+import type { RenderToPipeableStreamOptions } from "react-dom/server";
+import { renderToPipeableStream } from "react-dom/server";
+import type { AppLoadContext, EntryContext } from "react-router";
+import { ServerRouter } from "react-router";
+
+export const streamTimeout = 5_000;
+
+export default function handleRequest(
+  request: Request,
+  responseStatusCode: number,
+  responseHeaders: Headers,
+  routerContext: EntryContext,
+  loadContext: AppLoadContext
+) {
+  return new Promise((resolve, reject) => {
+    let shellRendered = false;
+    let userAgent = request.headers.get("user-agent");
+
+    // Ensure requests from bots and SPA Mode renders wait for all content to load before responding
+    // https://react.dev/reference/react-dom/server/renderToPipeableStream#waiting-for-all-content-to-load-for-crawlers-and-static-generation
+    let readyOption: keyof RenderToPipeableStreamOptions =
+      (userAgent && isbot(userAgent)) || routerContext.isSpaMode ? "onAllReady" : "onShellReady";
+
+    const { pipe, abort } = renderToPipeableStream(<ServerRouter context={routerContext} url={request.url} />, {
+      [readyOption]() {
+        shellRendered = true;
+        const body = new PassThrough();
+        const stream = createReadableStreamFromReadable(body);
+
+        responseHeaders.set("Content-Type", "text/html");
+
+        resolve(
+          new Response(stream, {
+            headers: responseHeaders,
+            status: responseStatusCode,
+          })
+        );
+
+        pipe(body);
+      },
+      onShellError(error: unknown) {
+        reject(error);
+      },
+      onError(error: unknown) {
+        responseStatusCode = 500;
+        // Log streaming rendering errors from inside the shell.  Don't log
+        // errors encountered during initial shell rendering since they'll
+        // reject and get logged in handleDocumentRequest.
+        if (shellRendered) {
+          console.error(error);
+        }
+      },
+    });
+
+    // Abort the rendering stream after the `streamTimeout` so it has tine to
+    // flush down the rejected boundaries
+    setTimeout(abort, streamTimeout + 1000);
+  });
+}

examples/node/simple-future/app/root.tsx

@@ -0,0 +1,28 @@
+import type { LinksFunction } from "react-router";
+import { Links, Meta, Outlet, Scripts, ScrollRestoration } from "react-router";
+import styles from "~/styles/tailwind.css?url";
+
+export const links: LinksFunction = () => [{ rel: "stylesheet", href: styles }];
+
+export function Layout({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en">
+      <head>
+        <meta charSet="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <Meta />
+        <Links />
+        <link rel="stylesheet" href={styles} />
+      </head>
+      <body>
+        {children}
+        <ScrollRestoration />
+        <Scripts />
+      </body>
+    </html>
+  );
+}
+
+export default function App() {
+  return <Outlet />;
+}

examples/node/simple-future/app/routes.ts

@@ -0,0 +1,4 @@
+import type { RouteConfig } from "@react-router/dev/routes";
+import { flatRoutes } from "@react-router/fs-routes";
+
+export default flatRoutes() satisfies RouteConfig;

examples/node/simple-future/app/routes/_index.tsx

@@ -0,0 +1,60 @@
+import { useState } from "react";
+import { useRevalidator } from "react-router";
+import { Input } from "~/components/input";
+import { getPublic } from "~/utils/.client/public";
+import { getCommon } from "~/utils/.common/common";
+import { getSecret } from "~/utils/.server/secret";
+import { getEnv } from "~/utils/env.server";
+import dbLogo from "/images/database.svg";
+import type { Route } from "./+types/_index";
+
+export function loader() {
+  console.log(getSecret(), getCommon());
+  return {
+    env: getEnv(),
+  };
+}
+
+export async function clientLoader({ serverLoader }: Route.ClientLoaderArgs) {
+  console.log(getPublic(), getCommon());
+  return {
+    ...(await serverLoader()),
+  };
+}
+
+clientLoader.hydrate = true;
+
+export default function Index({ loaderData: data }: Route.ComponentProps) {
+  const [value, setValue] = useState("");
+  console.log("dbLogo", dbLogo);
+  console.log("value", value);
+  const { revalidate } = useRevalidator();
+  return (
+    <div className="min-h-screen bg-gray-100 flex flex-col items-center justify-center">
+      <button type="button" onClick={revalidate} className="flex items-center gap-2">
+        <img src={dbLogo} alt="Database" />
+        Revalidate
+      </button>
+      <input />
+      <Input value={value} onChange={(e) => setValue(e.target.value)} />
+      <div className="mt-8 w-full max-w-4xl overflow-x-auto">
+        <table className="w-full border-collapse bg-gray-100 shadow-md rounded-lg">
+          <thead>
+            <tr className="bg-gray-200">
+              <th className="px-6 py-3 text-left text-xs font-medium text-gray-600 uppercase tracking-wider">Key</th>
+              <th className="px-6 py-3 text-left text-xs font-medium text-gray-600 uppercase tracking-wider">Value</th>
+            </tr>
+          </thead>
+          <tbody className="bg-white divide-y divide-gray-200">
+            {Object.entries(data.env).map(([key, value]) => (
+              <tr key={key} className="hover:bg-gray-50">
+                <td className="px-6 py-4 whitespace-nowrap text-sm font-medium text-gray-900">{key}</td>
+                <td className="px-6 py-4 whitespace-nowrap text-sm text-gray-500">{value ?? "-"}</td>
+              </tr>
+            ))}
+          </tbody>
+        </table>
+      </div>
+    </div>
+  );
+}

examples/node/simple-future/app/routes/app_.sub.tsx

@@ -0,0 +1,60 @@
+import { useState } from "react";
+import { useRevalidator } from "react-router";
+import { Input } from "~/components/input";
+import { getPublic } from "~/utils/.client/public";
+import { getCommon } from "~/utils/.common/common";
+import { getSecret } from "~/utils/.server/secret";
+import { getEnv } from "~/utils/env.server";
+import dbLogo from "/images/database.svg";
+import type { Route } from "./+types/app_.sub";
+
+export function loader({ context }: Route.LoaderArgs) {
+  console.log(context, getSecret(), getCommon());
+  return {
+    env: getEnv(),
+  };
+}
+
+export async function clientLoader({ serverLoader }: Route.ClientLoaderArgs) {
+  console.log(getPublic(), getCommon());
+  return {
+    ...(await serverLoader()),
+  };
+}
+
+clientLoader.hydrate = true;
+
+export default function Index({ loaderData: data }: Route.ComponentProps) {
+  const [value, setValue] = useState("");
+  console.log("dbLogo", dbLogo);
+  console.log("value", value);
+  const { revalidate } = useRevalidator();
+  return (
+    <div className="min-h-screen bg-gray-100 flex flex-col items-center justify-center">
+      <button type="button" onClick={revalidate} className="flex items-center gap-2">
+        <img src={dbLogo} alt="Database" />
+        Revalidate
+      </button>
+      <input />
+      <Input value={value} onChange={(e) => setValue(e.target.value)} />
+      <div className="mt-8 w-full max-w-4xl overflow-x-auto">
+        <table className="w-full border-collapse bg-gray-100 shadow-md rounded-lg">
+          <thead>
+            <tr className="bg-gray-200">
+              <th className="px-6 py-3 text-left text-xs font-medium text-gray-600 uppercase tracking-wider">Key</th>
+              <th className="px-6 py-3 text-left text-xs font-medium text-gray-600 uppercase tracking-wider">Value</th>
+            </tr>
+          </thead>
+          <tbody className="bg-white divide-y divide-gray-200">
+            {Object.entries(data.env).map(([key, value]) => (
+              <tr key={key} className="hover:bg-gray-50">
+                <td className="px-6 py-4 whitespace-nowrap text-sm font-medium text-gray-900">{key}</td>
+                <td className="px-6 py-4 whitespace-nowrap text-sm text-gray-500">{value ?? "-"}</td>
+              </tr>
+            ))}
+          </tbody>
+        </table>
+      </div>
+    </div>
+  );
+}

examples/node/simple-future/app/routes/defer.tsx

@@ -0,0 +1,26 @@
+import React from "react";
+import { Await, useLoaderData } from "react-router";
+import { Route } from "./+types/defer";
+
+async function getProjectLocation() {
+  return new Promise((resolve) => setTimeout(() => resolve("user/project"), 2000)) as Promise<string>;
+}
+
+export async function loader() {
+  return {
+    project: getProjectLocation(),
+  };
+}
+
+export default function ProjectRoute({ loaderData }: Route.ComponentProps) {
+  return (
+    <main>
+      <h1>Let's locate your project</h1>
+      <React.Suspense fallback={<p>Loading project location...</p>}>
+        <Await resolve={loaderData.project} errorElement={<p>Error loading project location!</p>}>
+          {(location) => <p>Your project is at {location}.</p>}
+        </Await>
+      </React.Suspense>
+    </main>
+  );
+}