@torchauth/vite-plugin-wrangler-spa

This plugin allows both the React SPA and Cloudflare functions to run with LiveReload locally, and at the same time.

This solves a major pain point that currently exists, where you cannot work locally with LiveReload for the React project, you are forced to use preview. This plugin allows both the React SPA and Cloudflare functions to run with LiveReload locally, and at the same time.

• Make requests from the React project directly to the miniflare endpoints
  • Frontend fetch requests are automatically proxied to the miniflare server
    • http://localhost/api/* is automatically routed from the frontend to the miniflare server, just like in production
• Write React code the same as any other Vite project, with LiveReload
• Cloudflare function code can be written within the configurable functions directory
  • This is served in parallel via miniflare along with the React SPA code
  • Any Cloudflare compatible router could also be used
• Full access to Cloudflare local services via wrangler configuration
  • D1
  • R2
  • KV
  • etc

Much of this plugin takes inspiration from @hono/vite-cloudflare-pages, so thank you to the Hono team.

Usage

A detailed example can be found in the examples directory, but a brief overview of installing and configuring this plugin is as follows

This plugin is intended to be used with a standard Vite React application, though other SPA frameworks may also work. This plugin presumes Typescript files as the input, and makes no guarantees about plain JS files.

## Create a new Vite React application
> create vite@latest my-react-app -- --template react-swc-ts
> cd my-react-app

## Create folder to hold Cloudflare Pages Functions code
> mkdir functions

## Install @torchauth/vite-plugin-wrangler-spa
> npm i -D @torchauth/vite-plugin-wrangler-spa

## Install Hono
> npm i hono

Alter your vite.config.ts file to include this plugin:

import { defineConfig } from 'vite';
import { viteWranglerSpa } from '@torchauth/vite-plugin-wrangler-spa';
import react from '@vitejs/plugin-react-swc';
import tsconfigPaths from 'vite-tsconfig-paths';

export default defineConfig(() => {
  return {
    plugins: [
      tsconfigPaths(), // if using paths
      react(),
      viteWranglerSpa(),
    ],
  };
});

Add an index.ts file to the functions directory:

import { Hono } from 'hono';

const app = new Hono().basePath('/api');

const route = app.get((c) => {
  return c.json({
    test: true,
  });
});

export type AppType = typeof route;

export default app;

Start development mode by running vite.

Vite Plugin Configuration

All settings are optional, with the default being used when no other value is set.

| Name | Description | Default | | ------------------ | :--------------------------------------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------: | | allowedApiPaths | These are url paths that should be directed to the Cloudflare function, and not the SPA. | ["^/api/*] | | excludedApiPaths | These are url paths that should not be directed to the Cloudflare function, and will always route to the SPA | [] | | functionEntrypoint | The file (/tsx?/) that will be used as the entry point for the Cloudflare Pages functions. | functions/index.ts | | wranglerConfig | Pass through for Wrangler configuration objects | see Wrangler documentation | | wranglerConfigPath | Location of your wrangler.toml file for usage in setting up Wrangler local services | wrangler.toml | | external | Any Function packages that should not be bundled | [] | | swcConfig | Pass through for SWC configuration objects | See SWC documentation |

API Endpoints

By default we presume Hono as the router, but any other Cloudflare Functions compatible router could be used as well.

API endpoints are ran via Pages Functions. Cloudflare services should be available on the Context object with the router.

const app = new Hono().basePath('/api');

const route = app.get('/hello', (c) => {
  // Hono's context.env property will contain references to any services bound to the Pages
  console.log(c.env);

  return c.json({
    test: true,
  });
});

Any updates to the API will trigger a full refresh in the browser window, as well as print a console message in the browser.

Allowed/Excluded Api Paths

excludedApiPaths are not utilized in local development and are only used in _routes.json as an escape hatch

| Path | Result | | --------------- | :---------------------------------: | | ^/some | exact match | | ^/some/* | match all routes with /some/ | | ^/some/path | exact match | | ^/some/path/* | match all routes with /some/path/ |

The allowedApiPaths and excludedApiPaths plugin settings will determine which routes get routed to the frontend or backend.

• Paths can either be RegEx, or plain. See Vite documentation for specific usage.
• In most cases, you will want to utilize a start-of-line caret and a astrix suffix.
• These strings are applied to the generated _routes.json file with carets removed.

See Cloudflare _routes.json documentation for more information.

Hono HTML Endpoints

You can also return HTML directly to facilitate HTMX applications:

const app = new Hono().basePath('/api');

const route = app.get('/page', (c) => {
  return c.html(<div>My HTMX content!</div>);
});

Beware when importing types from backend /functions into your frontend application. Depending on how they are exported, it could pull your entire Function bundle into your frontend code. Always double-check the final bundle to ensure you haven't accidentally imported more than you wanted.

Optional: Add Hono/jsx types to functions directory

Using Hono JSX can cause typing errors due to collisions with standard JSX types. Add a tsconfig.json file to the functions directory to fix type issues that may occur. These settings may need to be altered to fit your specific environment.

{
  "compilerOptions": {
    "target": "ESNext",
    "module": "ESNext",
    "moduleResolution": "Bundler",
    "strict": true,
    "lib": ["ESNext"],
    "jsx": "react-jsx",
    "jsxImportSource": "hono/jsx",
    "types": ["hono"]
  }
}

Build & Deploy to Cloudflare

To produce a prodution bundle, two build steps are required. This is to ensure code separation between the static frontend and the Function backend code.

## Build production bundle
> vite build && vite build --mode page-function

Your React app will be packaged as normal and the functions code will be packaged into a _worker.js file.

The final package will be placed into /dist and it can be uploaded directly to Cloudflare via wrangler, CI/CD, or the UI.

## Upload via wrangler
> npx wrangler pages deploy ./dist

Additionally, a _routes.json file will also be created to prevent the functions from intercepting requests that should go to the frontend. Route file contents are dictated by the allowedApiPaths and excludedApiPaths configuration options.

Final distribution bundles should be inspected to make sure server-side packages aren't making their way into your frontend code, and frontend packages aren't making their way into your Function bundle. While they probably won't cause issues, they will increase bundle size.

Also, don't forget to update your wrangler.toml file to include any compatibility_flags, if you require them.

Library Resoluton, Externals, and Conditions

Depending on the modules you use in your function, you may need to make use of none, one, or both of viteWranglerSpa.external and resolve.conditions. Deployment failures are difficult to troubleshoot on Cloudflare, so if it is failing inexplicably you may be improperly importing a particular library. This all stems from the fact that Cloudflare functions run on the workerd runtime and not node.

• viteWranglerSpa.external
  • Allow packing of CommonJS modules
• resolve.conditions
  • For multi-modules, this ensures you get the correct version for you platform. This depends on the libraries you are using.
    • browser or workerd should both work
  • NodeJS Conditions Definitions

import { defineConfig } from 'vite';
import { viteWranglerSpa } from '@torchauth/vite-plugin-wrangler-spa';
import react from '@vitejs/plugin-react-swc';
import tsconfigPaths from 'vite-tsconfig-paths';

export default defineConfig(() => {
  return {
    resolve: {
      conditions: ['browser'], // safe way to ensure most libraries work
    },
    plugins: [
      tsconfigPaths(),
      react(),
      viteWranglerSpa({
        allowedApiPaths: ['/api/*', '/oauth/*'],
        external: ['scrypt-js', '@asteasolutions/zod-to-openapi'], // this will be specific to your application
      }),
    ],
  };
});

Function Source Maps

sourceMaps are automatically created for your compiled functions and placed into ./dist. It is your choice if you want to upload these with your bundle. Often the source map can be much larger than the code that generated it.