@astrojs/cloudflare 4.0.0 → 4.1.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/cloudflare:build: cache hit, replaying output 90a638f6bf8ef71a
-@astrojs/cloudflare:build: 
-@astrojs/cloudflare:build: > @astrojs/cloudflare@4.0.0 build /home/runner/work/astro/astro/packages/integrations/cloudflare
-@astrojs/cloudflare:build: > astro-scripts build "src/**/*.ts" && tsc
-@astrojs/cloudflare:build: 
+@astrojs/cloudflare:build: cache hit, replaying output 5b4d4f8481cf8489
+@astrojs/cloudflare:build: 
+@astrojs/cloudflare:build: > @astrojs/cloudflare@4.1.0 build /home/runner/work/astro/astro/packages/integrations/cloudflare
+@astrojs/cloudflare:build: > astro-scripts build "src/**/*.ts" && tsc
+@astrojs/cloudflare:build: 

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @astrojs/cloudflare
 
+## 4.1.0
+
+### Minor Changes
+
+- [#5347](https://github.com/withastro/astro/pull/5347) [`743000cc7`](https://github.com/withastro/astro/commit/743000cc70274a2d2fed01c72e2ac51aa6b876a6) Thanks [@AirBorne04](https://github.com/AirBorne04)! - Now building for Cloudflare directory mode takes advantage of the standard asset handling from Cloudflare Pages, and therefore does not call a function script to deliver static assets anymore.
+  Also supports the use of `_routes.json`, `_redirects` and `_headers` files when placed into the `public` folder.
+
+### Patch Changes
+
+- Updated dependencies [[`936c1e411`](https://github.com/withastro/astro/commit/936c1e411d77c69b2b60a061c54704200716800a), [`4b188132e`](https://github.com/withastro/astro/commit/4b188132ef68f8d9951cec86418ef50bb4df4a96), [`f5ed630bc`](https://github.com/withastro/astro/commit/f5ed630bca05ebbfcc6ac994ced3911e41daedcc)]:
+  - astro@1.6.11
+
+## 4.0.1
+
+### Patch Changes
+
+- [#5301](https://github.com/withastro/astro/pull/5301) [`a79a37cad`](https://github.com/withastro/astro/commit/a79a37cad549b21f91599ff86899e456d9dcc7df) Thanks [@bluwy](https://github.com/bluwy)! - Fix environment variables usage in worker output and warn if environment variables are accessedd too early
+
+- Updated dependencies [[`88c1bbe3a`](https://github.com/withastro/astro/commit/88c1bbe3a71f85e92f42f13d0f310c6b2a264ade), [`a79a37cad`](https://github.com/withastro/astro/commit/a79a37cad549b21f91599ff86899e456d9dcc7df)]:
+  - astro@1.6.5
+
 ## 4.0.0
 
 ### Major Changes

package/README.md

@@ -25,7 +25,8 @@ npm install @astrojs/cloudflare
 
 2. Add the following to your `astro.config.mjs` file:
 
-```js title="astro.config.mjs" ins={2, 5-6}
+```js ins={3, 6-7}
+// astro.config.mjs
 import { defineConfig } from 'astro/config';
 import cloudflare from '@astrojs/cloudflare';
 
@@ -66,7 +67,7 @@ In order for preview to work you must install `wrangler`
 $ pnpm install wrangler --save-dev
 ```
 
-It's then possible to update the preview script in your `package.json` to `"preview": "wrangler pages dev ./dist"`.This will allow you run your entire application locally with [Wrangler](https://github.com/cloudflare/wrangler2), which supports secrets, environment variables, KV namespaces, Durable Objects and [all other supported Cloudflare bindings](https://developers.cloudflare.com/pages/platform/functions/#adding-bindings).
+It's then possible to update the preview script in your `package.json` to `"preview": "wrangler pages dev ./dist"`. This will allow you run your entire application locally with [Wrangler](https://github.com/cloudflare/wrangler2), which supports secrets, environment variables, KV namespaces, Durable Objects and [all other supported Cloudflare bindings](https://developers.cloudflare.com/pages/platform/functions/#adding-bindings).
 
 ## Access to the Cloudflare runtime
 
@@ -92,19 +93,29 @@ To do this:
 
 ## Environment Variables
 
-As Cloudflare Pages Functions [provides environment variables differently](https://developers.cloudflare.com/pages/platform/functions/#adding-environment-variables-locally), private environment variables needs to be set through [`vite.define`](https://vitejs.dev/config/shared-options.html#define) to work in builds.
+As Cloudflare Pages Functions [provides environment variables per request](https://developers.cloudflare.com/pages/platform/functions/#adding-environment-variables-locally), you can only access private environment variables when a request has happened. Usually, this means moving environment variable access inside a function.
 
 ```js
-// astro.config.mjs
-export default {
-  vite: {
-    define: {
-      'process.env.MY_SECRET': JSON.stringify(process.env.MY_SECRET),
-    },
-  },
+// pages/[id].json.js
+
+export function get({ params }) {
+  // Access environment variables per request inside a function
+  const serverUrl = import.meta.env.SERVER_URL;
+  const result = await fetch(serverUrl + "/user/" + params.id);
+  return {
+    body: await result.text(),
+  };
 }
 ```
 
+## Headers, Redirects and function invocation routes
+
+Cloudflare has support for adding custom [headers](https://developers.cloudflare.com/pages/platform/headers/), configuring static [redirects](https://developers.cloudflare.com/pages/platform/redirects/) and defining which routes should [invoke functions](https://developers.cloudflare.com/pages/platform/functions/routing/#function-invocation-routes). Cloudflare looks for `_headers`, `_redirects`, and `_routes.json` files in your build output directory to configure these features. This means they should be placed in your Astro project’s `public/` directory.
+
+### Custom `_routes.json`
+
+By default, `@astrojs/cloudflare` will generate a `_routes.json` file that lists all files from your `dist/` folder and redirects from the `_redirects` file in the `exclude` array. This will enable Cloudflare to serve files and process static redirects without a function invocation. Creating a custom `_routes.json` will override this automatic optimization and, if not configured manually, cause function invocations that will count against the request limits of your Cloudflare plan.
+
 ## Troubleshooting
 
 For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!

package/dist/index.js

@@ -1,5 +1,7 @@
 import esbuild from "esbuild";
 import * as fs from "fs";
+import * as os from "os";
+import glob from "tiny-glob";
 import { fileURLToPath } from "url";
 function getAdapter(isModeDirectory) {
   return isModeDirectory ? {
@@ -16,6 +18,7 @@ const SHIM = `globalThis.process = {
 	argv: [],
 	env: {},
 };`;
+const SERVER_BUILD_FOLDER = "/$server_build/";
 function createIntegration(args) {
   let _config;
   let _buildConfig;
@@ -28,8 +31,8 @@ function createIntegration(args) {
         needsBuildConfig = !config.build.client;
         updateConfig({
           build: {
-            client: new URL("./static/", config.outDir),
-            server: new URL("./", config.outDir),
+            client: new URL(`.${config.base}`, config.outDir),
+            server: new URL(`.${SERVER_BUILD_FOLDER}`, config.outDir),
             serverEntry: "_worker.js"
           }
         });
@@ -44,6 +47,10 @@ function createIntegration(args) {
 
 `);
         }
+        if (config.base === SERVER_BUILD_FOLDER) {
+          throw new Error(`
+  [@astrojs/cloudflare] \`base: "${SERVER_BUILD_FOLDER}"\` is not allowed. Please change your \`base\` config to something else.`);
+        }
       },
       "astro:build:setup": ({ vite, target }) => {
         if (target === "server") {
@@ -63,19 +70,18 @@ function createIntegration(args) {
       },
       "astro:build:start": ({ buildConfig }) => {
         if (needsBuildConfig) {
-          buildConfig.client = new URL("./static/", _config.outDir);
-          buildConfig.server = new URL("./", _config.outDir);
+          buildConfig.client = new URL(`.${_config.base}`, _config.outDir);
+          buildConfig.server = new URL(`.${SERVER_BUILD_FOLDER}`, _config.outDir);
           buildConfig.serverEntry = "_worker.js";
         }
       },
       "astro:build:done": async () => {
-        const entryUrl = new URL(_buildConfig.serverEntry, _buildConfig.server);
-        const pkg = fileURLToPath(entryUrl);
+        const entryPath = fileURLToPath(new URL(_buildConfig.serverEntry, _buildConfig.server)), entryUrl = new URL(_buildConfig.serverEntry, _config.outDir), buildPath = fileURLToPath(entryUrl);
         await esbuild.build({
           target: "es2020",
           platform: "browser",
-          entryPoints: [pkg],
-          outfile: pkg,
+          entryPoints: [entryPath],
+          outfile: buildPath,
           allowOverwrite: true,
           format: "esm",
           bundle: true,
@@ -84,8 +90,55 @@ function createIntegration(args) {
             js: SHIM
           }
         });
-        const chunksUrl = new URL("./chunks", _buildConfig.server);
-        await fs.promises.rm(chunksUrl, { recursive: true, force: true });
+        const serverUrl = new URL(_buildConfig.server);
+        await fs.promises.rm(serverUrl, { recursive: true, force: true });
+        const cloudflareSpecialFiles = ["_headers", "_redirects", "_routes.json"];
+        if (_config.base !== "/") {
+          for (const file of cloudflareSpecialFiles) {
+            try {
+              await fs.promises.rename(
+                new URL(file, _buildConfig.client),
+                new URL(file, _config.outDir)
+              );
+            } catch (e) {
+            }
+          }
+        }
+        const routesExists = await fs.promises.stat(new URL("./_routes.json", _config.outDir)).then((stat) => stat.isFile()).catch(() => false);
+        if (!routesExists) {
+          const staticPathList = (await glob(`${fileURLToPath(_buildConfig.client)}/**/*`, {
+            cwd: fileURLToPath(_config.outDir),
+            filesOnly: true
+          })).filter((file) => cloudflareSpecialFiles.indexOf(file) < 0).map((file) => `/${file}`);
+          const redirectsExists = await fs.promises.stat(new URL("./_redirects", _config.outDir)).then((stat) => stat.isFile()).catch(() => false);
+          if (redirectsExists) {
+            const redirects = (await fs.promises.readFile(new URL("./_redirects", _config.outDir), "utf-8")).split(os.EOL).map((line) => {
+              const parts = line.split(" ");
+              if (parts.length < 2) {
+                return null;
+              } else {
+                return parts[0].replace(/\/:.*?(?=\/|$)/g, "/*").replace(/\?.*$/, "");
+              }
+            }).filter(
+              (line, index, arr) => line !== null && arr.indexOf(line) === index
+            );
+            if (redirects.length > 0) {
+              staticPathList.push(...redirects);
+            }
+          }
+          await fs.promises.writeFile(
+            new URL("./_routes.json", _config.outDir),
+            JSON.stringify(
+              {
+                version: 1,
+                include: ["/*"],
+                exclude: staticPathList
+              },
+              null,
+              2
+            )
+          );
+        }
         if (isModeDirectory) {
           const functionsUrl = new URL(`file://${process.cwd()}/functions/`);
           await fs.promises.mkdir(functionsUrl, { recursive: true });

package/dist/server.advanced.d.ts

@@ -1,4 +1,3 @@
-import './shim.js';
 import type { SSRManifest } from 'astro';
 declare type Env = {
     ASSETS: {

package/dist/server.advanced.js

@@ -1,12 +1,13 @@
-import "./shim.js";
 import { App } from "astro/app";
+import { getProcessEnvProxy } from "./util.js";
+process.env = getProcessEnvProxy();
 function createExports(manifest) {
   const app = new App(manifest, false);
   const fetch = async (request, env, context) => {
-    const { origin, pathname } = new URL(request.url);
+    process.env = env;
+    const { pathname } = new URL(request.url);
     if (manifest.assets.has(pathname)) {
-      const assetRequest = new Request(`${origin}/static/${app.removeBase(pathname)}`, request);
-      return env.ASSETS.fetch(assetRequest);
+      return env.ASSETS.fetch(request);
     }
     let routeData = app.match(request, { matchNotFound: true });
     if (routeData) {

package/dist/server.directory.d.ts

@@ -1,4 +1,3 @@
-import './shim.js';
 import type { SSRManifest } from 'astro';
 export declare function createExports(manifest: SSRManifest): {
     onRequest: ({ request, next, ...runtimeEnv }: {

package/dist/server.directory.js

@@ -1,5 +1,6 @@
-import "./shim.js";
 import { App } from "astro/app";
+import { getProcessEnvProxy } from "./util.js";
+process.env = getProcessEnvProxy();
 function createExports(manifest) {
   const app = new App(manifest, false);
   const onRequest = async ({
@@ -7,10 +8,10 @@ function createExports(manifest) {
     next,
     ...runtimeEnv
   }) => {
-    const { origin, pathname } = new URL(request.url);
+    process.env = runtimeEnv.env;
+    const { pathname } = new URL(request.url);
     if (manifest.assets.has(pathname)) {
-      const assetRequest = new Request(`${origin}/static/${app.removeBase(pathname)}`, request);
-      return next(assetRequest);
+      return next(request);
     }
     let routeData = app.match(request, { matchNotFound: true });
     if (routeData) {

package/dist/util.d.ts

@@ -0,0 +1 @@
+export declare function getProcessEnvProxy(): {};

package/dist/util.js

@@ -0,0 +1,15 @@
+function getProcessEnvProxy() {
+  return new Proxy(
+    {},
+    {
+      get: (target, prop) => {
+        console.warn(
+          `Unable to access \`import.meta\0.env.${prop.toString()}\` on initialization as the Cloudflare platform only provides the environment variables per request. Please move the environment variable access inside a function that's only called after a request has been received.`
+        );
+      }
+    }
+  );
+}
+export {
+  getProcessEnvProxy
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/cloudflare",
   "description": "Deploy your site to cloudflare workers or cloudflare pages",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -28,13 +28,14 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "esbuild": "^0.14.42"
+    "esbuild": "^0.14.42",
+    "tiny-glob": "^0.2.9"
   },
   "peerDependencies": {
-    "astro": "^1.6.4"
+    "astro": "^1.6.11"
   },
   "devDependencies": {
-    "astro": "1.6.4",
+    "astro": "1.6.11",
     "astro-scripts": "0.0.9",
     "chai": "^4.3.6",
     "cheerio": "^1.0.0-rc.11",

package/src/index.ts

@@ -1,6 +1,8 @@
 import type { AstroAdapter, AstroConfig, AstroIntegration } from 'astro';
 import esbuild from 'esbuild';
 import * as fs from 'fs';
+import * as os from 'os';
+import glob from 'tiny-glob';
 import { fileURLToPath } from 'url';
 
 type Options = {
@@ -32,6 +34,8 @@ const SHIM = `globalThis.process = {
 	env: {},
 };`;
 
+const SERVER_BUILD_FOLDER = '/$server_build/';
+
 export default function createIntegration(args?: Options): AstroIntegration {
 	let _config: AstroConfig;
 	let _buildConfig: BuildConfig;
@@ -45,8 +49,8 @@ export default function createIntegration(args?: Options): AstroIntegration {
 				needsBuildConfig = !config.build.client;
 				updateConfig({
 					build: {
-						client: new URL('./static/', config.outDir),
-						server: new URL('./', config.outDir),
+						client: new URL(`.${config.base}`, config.outDir),
+						server: new URL(`.${SERVER_BUILD_FOLDER}`, config.outDir),
 						serverEntry: '_worker.js',
 					},
 				});
@@ -62,6 +66,11 @@ export default function createIntegration(args?: Options): AstroIntegration {
 
 `);
 				}
+
+				if (config.base === SERVER_BUILD_FOLDER) {
+					throw new Error(`
+  [@astrojs/cloudflare] \`base: "${SERVER_BUILD_FOLDER}"\` is not allowed. Please change your \`base\` config to something else.`);
+				}
 			},
 			'astro:build:setup': ({ vite, target }) => {
 				if (target === 'server') {
@@ -84,19 +93,20 @@ export default function createIntegration(args?: Options): AstroIntegration {
 			'astro:build:start': ({ buildConfig }) => {
 				// Backwards compat
 				if (needsBuildConfig) {
-					buildConfig.client = new URL('./static/', _config.outDir);
-					buildConfig.server = new URL('./', _config.outDir);
+					buildConfig.client = new URL(`.${_config.base}`, _config.outDir);
+					buildConfig.server = new URL(`.${SERVER_BUILD_FOLDER}`, _config.outDir);
 					buildConfig.serverEntry = '_worker.js';
 				}
 			},
 			'astro:build:done': async () => {
-				const entryUrl = new URL(_buildConfig.serverEntry, _buildConfig.server);
-				const pkg = fileURLToPath(entryUrl);
+				const entryPath = fileURLToPath(new URL(_buildConfig.serverEntry, _buildConfig.server)),
+					entryUrl = new URL(_buildConfig.serverEntry, _config.outDir),
+					buildPath = fileURLToPath(entryUrl);
 				await esbuild.build({
 					target: 'es2020',
 					platform: 'browser',
-					entryPoints: [pkg],
-					outfile: pkg,
+					entryPoints: [entryPath],
+					outfile: buildPath,
 					allowOverwrite: true,
 					format: 'esm',
 					bundle: true,
@@ -107,8 +117,90 @@ export default function createIntegration(args?: Options): AstroIntegration {
 				});
 
 				// throw the server folder in the bin
-				const chunksUrl = new URL('./chunks', _buildConfig.server);
-				await fs.promises.rm(chunksUrl, { recursive: true, force: true });
+				const serverUrl = new URL(_buildConfig.server);
+				await fs.promises.rm(serverUrl, { recursive: true, force: true });
+
+				// move cloudflare specific files to the root
+				const cloudflareSpecialFiles = ['_headers', '_redirects', '_routes.json'];
+				if (_config.base !== '/') {
+					for (const file of cloudflareSpecialFiles) {
+						try {
+							await fs.promises.rename(
+								new URL(file, _buildConfig.client),
+								new URL(file, _config.outDir)
+							);
+						} catch (e) {
+							// ignore
+						}
+					}
+				}
+
+				const routesExists = await fs.promises
+					.stat(new URL('./_routes.json', _config.outDir))
+					.then((stat) => stat.isFile())
+					.catch(() => false);
+
+				// this creates a _routes.json, in case there is none present to enable
+				// cloudflare to handle static files and support _redirects configuration
+				// (without calling the function)
+				if (!routesExists) {
+					const staticPathList: Array<string> = (
+						await glob(`${fileURLToPath(_buildConfig.client)}/**/*`, {
+							cwd: fileURLToPath(_config.outDir),
+							filesOnly: true,
+						})
+					)
+						.filter((file: string) => cloudflareSpecialFiles.indexOf(file) < 0)
+						.map((file: string) => `/${file}`);
+
+					const redirectsExists = await fs.promises
+						.stat(new URL('./_redirects', _config.outDir))
+						.then((stat) => stat.isFile())
+						.catch(() => false);
+
+					// convert all redirect source paths into a list of routes
+					// and add them to the static path
+					if (redirectsExists) {
+						const redirects = (
+							await fs.promises.readFile(new URL('./_redirects', _config.outDir), 'utf-8')
+						)
+							.split(os.EOL)
+							.map((line) => {
+								const parts = line.split(' ');
+								if (parts.length < 2) {
+									return null;
+								} else {
+									// convert /products/:id to /products/*
+									return (
+										parts[0]
+											.replace(/\/:.*?(?=\/|$)/g, '/*')
+											// remove query params as they are not supported by cloudflare
+											.replace(/\?.*$/, '')
+									);
+								}
+							})
+							.filter(
+								(line, index, arr) => line !== null && arr.indexOf(line) === index
+							) as string[];
+
+						if (redirects.length > 0) {
+							staticPathList.push(...redirects);
+						}
+					}
+
+					await fs.promises.writeFile(
+						new URL('./_routes.json', _config.outDir),
+						JSON.stringify(
+							{
+								version: 1,
+								include: ['/*'],
+								exclude: staticPathList,
+							},
+							null,
+							2
+						)
+					);
+				}
 
 				if (isModeDirectory) {
 					const functionsUrl = new URL(`file://${process.cwd()}/functions/`);

package/src/server.advanced.ts

@@ -1,7 +1,8 @@
-import './shim.js';
-
 import type { SSRManifest } from 'astro';
 import { App } from 'astro/app';
+import { getProcessEnvProxy } from './util.js';
+
+process.env = getProcessEnvProxy();
 
 type Env = {
 	ASSETS: { fetch: (req: Request) => Promise<Response> };
@@ -12,12 +13,13 @@ export function createExports(manifest: SSRManifest) {
 	const app = new App(manifest, false);
 
 	const fetch = async (request: Request, env: Env, context: any) => {
-		const { origin, pathname } = new URL(request.url);
+		process.env = env as any;
+
+		const { pathname } = new URL(request.url);
 
-		// static assets
+		// static assets fallback, in case default _routes.json is not used
 		if (manifest.assets.has(pathname)) {
-			const assetRequest = new Request(`${origin}/static/${app.removeBase(pathname)}`, request);
-			return env.ASSETS.fetch(assetRequest);
+			return env.ASSETS.fetch(request);
 		}
 
 		let routeData = app.match(request, { matchNotFound: true });

package/src/server.directory.ts

@@ -1,7 +1,8 @@
-import './shim.js';
-
 import type { SSRManifest } from 'astro';
 import { App } from 'astro/app';
+import { getProcessEnvProxy } from './util.js';
+
+process.env = getProcessEnvProxy();
 
 export function createExports(manifest: SSRManifest) {
 	const app = new App(manifest, false);
@@ -14,11 +15,12 @@ export function createExports(manifest: SSRManifest) {
 		request: Request;
 		next: (request: Request) => void;
 	} & Record<string, unknown>) => {
-		const { origin, pathname } = new URL(request.url);
-		// static assets
+		process.env = runtimeEnv.env as any;
+
+		const { pathname } = new URL(request.url);
+		// static assets fallback, in case default _routes.json is not used
 		if (manifest.assets.has(pathname)) {
-			const assetRequest = new Request(`${origin}/static/${app.removeBase(pathname)}`, request);
-			return next(assetRequest);
+			return next(request);
 		}
 
 		let routeData = app.match(request, { matchNotFound: true });

package/src/util.ts

@@ -0,0 +1,16 @@
+export function getProcessEnvProxy() {
+	return new Proxy(
+		{},
+		{
+			get: (target, prop) => {
+				console.warn(
+					// NOTE: \0 prevents Vite replacement
+					`Unable to access \`import.meta\0.env.${prop.toString()}\` on initialization ` +
+						`as the Cloudflare platform only provides the environment variables per request. ` +
+						`Please move the environment variable access inside a function ` +
+						`that's only called after a request has been received.`
+				);
+			},
+		}
+	);
+}

package/test/basics.test.js

@@ -24,6 +24,7 @@ describe.skip('Basic app', () => {
 			let html = await res.text();
 			let $ = cheerio.load(html);
 			expect($('h1').text()).to.equal('Testing');
+			expect($('#env').text()).to.equal('secret');
 		} finally {
 			stop();
 		}

package/test/fixtures/basics/astro.config.mjs

@@ -1,6 +1,9 @@
 import { defineConfig } from 'astro/config';
 import cloudflare from '@astrojs/cloudflare';
 
+// test env var
+process.env.SECRET_STUFF = 'secret'
+
 export default defineConfig({
 	adapter: cloudflare(),
 	output: 'server',

package/test/fixtures/basics/src/pages/index.astro

@@ -4,5 +4,6 @@
 	</head>
 	<body>
 		<h1>Testing</h1>
+		<div id="env">{import.meta.env.SECRET_STUFF}</div>
 	</body>
 </html>

package/test/wrangler.toml

@@ -0,0 +1,4 @@
+# for tests only
+
+[vars]
+SECRET_STUFF = "secret"

package/dist/shim.js

@@ -1,4 +0,0 @@
-globalThis.process = {
-  argv: [],
-  env: {}
-};

package/src/shim.ts

@@ -1,4 +0,0 @@
-(globalThis as any).process = {
-	argv: [],
-	env: {},
-};