@astrojs/cloudflare 0.2.4 → 0.5.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/cloudflare:build: cache hit, replaying output af6a8235acaf44a1
-@astrojs/cloudflare:build: 
-@astrojs/cloudflare:build: > @astrojs/cloudflare@0.2.4 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 6b7581791e59c114
+@astrojs/cloudflare:build: 
+@astrojs/cloudflare:build: > @astrojs/cloudflare@0.5.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,60 @@
 # @astrojs/cloudflare
 
+## 0.5.0
+
+### Minor Changes
+
+- [#3806](https://github.com/withastro/astro/pull/3806) [`f4c571bdb`](https://github.com/withastro/astro/commit/f4c571bdb0bbcd0dfed68a484dfbfe274f8a5f45) Thanks [@nrgnrg](https://github.com/nrgnrg)! - add support for compiling functions to a functions directory rather than `_worker.js`
+
+## 0.4.0
+
+### Minor Changes
+
+- [#4068](https://github.com/withastro/astro/pull/4068) [`54b33d50f`](https://github.com/withastro/astro/commit/54b33d50fdb995ac056461be7e2128d911624f2d) Thanks [@matthewp](https://github.com/matthewp)! - Add explicit errors when omitting output config
+
+### Patch Changes
+
+- [#4072](https://github.com/withastro/astro/pull/4072) [`a198028b0`](https://github.com/withastro/astro/commit/a198028b04234d0b8dcb0b6bcb47c5831d7a15f9) Thanks [@matthewp](https://github.com/matthewp)! - Fixes Cloudflare throwing an error for process
+
+## 0.3.0
+
+### Minor Changes
+
+- [#4015](https://github.com/withastro/astro/pull/4015) [`6fd161d76`](https://github.com/withastro/astro/commit/6fd161d7691cbf9d3ffa4646e46059dfd0940010) Thanks [@matthewp](https://github.com/matthewp)! - New `output` configuration option
+
+  This change introduces a new "output target" configuration option (`output`). Setting the output target lets you decide the format of your final build, either:
+
+  - `"static"` (default): A static site. Your final build will be a collection of static assets (HTML, CSS, JS) that you can deploy to any static site host.
+  - `"server"`: A dynamic server application. Your final build will be an application that will run in a hosted server environment, generating HTML dynamically for different requests.
+
+  If `output` is omitted from your config, the default value `"static"` will be used.
+
+  When using the `"server"` output target, you must also include a runtime adapter via the `adapter` configuration. An adapter will _adapt_ your final build to run on the deployed platform of your choice (Netlify, Vercel, Node.js, Deno, etc).
+
+  To migrate: No action is required for most users. If you currently define an `adapter`, you will need to also add `output: 'server'` to your config file to make it explicit that you are building a server. Here is an example of what that change would look like for someone deploying to Netlify:
+
+  ```diff
+  import { defineConfig } from 'astro/config';
+  import netlify from '@astrojs/netlify/functions';
+
+  export default defineConfig({
+    adapter: netlify(),
+  + output: 'server',
+  });
+  ```
+
+* [#4018](https://github.com/withastro/astro/pull/4018) [`0cc6ede36`](https://github.com/withastro/astro/commit/0cc6ede362996b9faba57481a790d6eb7fba2045) Thanks [@okikio](https://github.com/okikio)! - Support for 404 and 500 pages in SSR
+
+- [#3973](https://github.com/withastro/astro/pull/3973) [`5a23483ef`](https://github.com/withastro/astro/commit/5a23483efb3ba614b05a00064f84415620605204) Thanks [@matthewp](https://github.com/matthewp)! - Adds support for Astro.clientAddress
+
+  The new `Astro.clientAddress` property allows you to get the IP address of the requested user.
+
+  ```astro
+
+  ```
+
+  This property is only available when building for SSR, and only if the adapter you are using supports providing the IP address. If you attempt to access the property in a SSG app it will throw an error.
+
 ## 0.2.4
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # @astrojs/cloudflare
 
-An SSR adapter for use with Cloudflare Pages Functions targets. Write your code in Astro/Node and deploy to Cloudflare Pages.
+An SSR adapter for use with Cloudflare Pages Functions targets. Write your code in Astro/Javascript and deploy to Cloudflare Pages.
 
 In your `astro.config.mjs` use:
 
@@ -9,10 +9,34 @@ import { defineConfig } from 'astro/config';
 import cloudflare from '@astrojs/cloudflare';
 
 export default defineConfig({
+  output: 'server',
   adapter: cloudflare()
 });
 ```
 
+## Options
+
+
+### Mode
+
+`mode: "advanced" | "directory"`
+
+default `"advanced"`
+
+Cloudflare Pages has 2 different modes for deploying functions, `advanced` mode which picks up the `_worker.js` in `dist`, or a directory mode where pages will compile the worker out of a functions folder in the project root.
+
+For most projects the adaptor default of `advanced` will be sufficiant, when in this mode the `dist` folder will contain your compiled project. However if you'd like to use [pages plugins](https://developers.cloudflare.com/pages/platform/functions/plugins/) such as [Sentry](https://developers.cloudflare.com/pages/platform/functions/plugins/sentry/) for example to enable logging, you'll need to use directory mode.
+
+In directory mode the adaptor will compile the client side part of you app the same way, but it will move the worker script into a `functions` folder in the project root. The adaptor will only ever place a `[[path]].js` in that folder, allowing you to add additional plugins and pages middlewhere which can be checked into version control  .
+
+```ts
+// directory mode
+export default defineConfig({
+  adapter: cloudflare({ mode: "directory" }),
+});
+
+```
+
 ## Enabling Preview
 
 In order for preview to work you must install `wrangler`

package/dist/index.d.ts

@@ -1,3 +1,7 @@
 import type { AstroAdapter, AstroIntegration } from 'astro';
-export declare function getAdapter(): AstroAdapter;
-export default function createIntegration(): AstroIntegration;
+declare type Options = {
+    mode: 'directory' | 'advanced';
+};
+export declare function getAdapter(isModeDirectory: boolean): AstroAdapter;
+export default function createIntegration(args?: Options): AstroIntegration;
+export {};

package/dist/index.js

@@ -1,27 +1,42 @@
 import esbuild from "esbuild";
 import * as fs from "fs";
 import { fileURLToPath } from "url";
-function getAdapter() {
-  return {
+function getAdapter(isModeDirectory) {
+  return isModeDirectory ? {
+    name: "@astrojs/cloudflare",
+    serverEntrypoint: "@astrojs/cloudflare/server.directory.js",
+    exports: ["onRequest"]
+  } : {
     name: "@astrojs/cloudflare",
-    serverEntrypoint: "@astrojs/cloudflare/server.js",
+    serverEntrypoint: "@astrojs/cloudflare/server.advanced.js",
     exports: ["default"]
   };
 }
-function createIntegration() {
+const SHIM = `globalThis.process = {
+	argv: [],
+	env: {},
+};`;
+function createIntegration(args) {
   let _config;
   let _buildConfig;
+  const isModeDirectory = (args == null ? void 0 : args.mode) === "directory";
   return {
     name: "@astrojs/cloudflare",
     hooks: {
       "astro:config:done": ({ setAdapter, config }) => {
-        setAdapter(getAdapter());
+        setAdapter(getAdapter(isModeDirectory));
         _config = config;
+        if (config.output === "static") {
+          throw new Error(`
+  [@astrojs/cloudflare] \`output: "server"\` is required to use this adapter. Otherwise, this adapter is not necessary to deploy a static site to Cloudflare.
+
+`);
+        }
       },
       "astro:build:start": ({ buildConfig }) => {
         _buildConfig = buildConfig;
-        buildConfig.serverEntry = "_worker.js";
         buildConfig.client = new URL("./static/", _config.outDir);
+        buildConfig.serverEntry = "_worker.js";
         buildConfig.server = new URL("./", _config.outDir);
       },
       "astro:build:setup": ({ vite, target }) => {
@@ -53,10 +68,19 @@ function createIntegration() {
           allowOverwrite: true,
           format: "esm",
           bundle: true,
-          minify: true
+          minify: true,
+          banner: {
+            js: SHIM
+          }
         });
         const chunksUrl = new URL("./chunks", _buildConfig.server);
         await fs.promises.rm(chunksUrl, { recursive: true, force: true });
+        if (isModeDirectory) {
+          const functionsUrl = new URL(`file://${process.cwd()}/functions/`);
+          await fs.promises.mkdir(functionsUrl, { recursive: true });
+          const directoryUrl = new URL("[[path]].js", functionsUrl);
+          await fs.promises.rename(entryUrl, directoryUrl);
+        }
       }
     }
   };

package/dist/{server.js → server.advanced.js}

@@ -8,12 +8,14 @@ function createExports(manifest) {
       const assetRequest = new Request(`${origin}/static${pathname}`, request);
       return env.ASSETS.fetch(assetRequest);
     }
-    if (app.match(request)) {
-      return app.render(request);
-    }
-    const _404Request = new Request(`${origin}/404`, request);
-    if (app.match(_404Request)) {
-      return app.render(_404Request);
+    let routeData = app.match(request, { matchNotFound: true });
+    if (routeData) {
+      Reflect.set(
+        request,
+        Symbol.for("astro.clientAddress"),
+        request.headers.get("cf-connecting-ip")
+      );
+      return app.render(request, routeData);
     }
     return new Response(null, {
       status: 404,

package/dist/server.directory.d.ts

@@ -0,0 +1,8 @@
+import './shim.js';
+import type { SSRManifest } from 'astro';
+export declare function createExports(manifest: SSRManifest): {
+    onRequest: ({ request, next, }: {
+        request: Request;
+        next: (request: Request) => void;
+    }) => Promise<void | Response>;
+};

package/dist/server.directory.js

@@ -0,0 +1,32 @@
+import "./shim.js";
+import { App } from "astro/app";
+function createExports(manifest) {
+  const app = new App(manifest, false);
+  const onRequest = async ({
+    request,
+    next
+  }) => {
+    const { origin, pathname } = new URL(request.url);
+    if (manifest.assets.has(pathname)) {
+      const assetRequest = new Request(`${origin}/static${pathname}`, request);
+      return next(assetRequest);
+    }
+    let routeData = app.match(request, { matchNotFound: true });
+    if (routeData) {
+      Reflect.set(
+        request,
+        Symbol.for("astro.clientAddress"),
+        request.headers.get("cf-connecting-ip")
+      );
+      return app.render(request, routeData);
+    }
+    return new Response(null, {
+      status: 404,
+      statusText: "Not found"
+    });
+  };
+  return { onRequest };
+}
+export {
+  createExports
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/cloudflare",
   "description": "Deploy your site to cloudflare pages functions",
-  "version": "0.2.4",
+  "version": "0.5.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -18,19 +18,22 @@
   "homepage": "https://docs.astro.build/en/guides/integrations-guide/cloudflare/",
   "exports": {
     ".": "./dist/index.js",
-    "./server.js": "./dist/server.js",
+    "./server.advanced.js": "./dist/server.advanced.js",
+    "./server.directory.js": "./dist/server.directory.js",
     "./package.json": "./package.json"
   },
   "dependencies": {
     "esbuild": "^0.14.42"
   },
   "devDependencies": {
-    "astro": "1.0.0-beta.69",
-    "astro-scripts": "0.0.6"
+    "astro": "1.0.0-rc.8",
+    "astro-scripts": "0.0.6",
+    "wrangler": "^2.0.23"
   },
   "scripts": {
     "build": "astro-scripts build \"src/**/*.ts\" && tsc",
     "build:ci": "astro-scripts build \"src/**/*.ts\"",
-    "dev": "astro-scripts dev \"src/**/*.ts\""
+    "dev": "astro-scripts dev \"src/**/*.ts\"",
+    "test": "mocha --exit --timeout 30000 test/"
   }
 }

package/src/index.ts

@@ -3,29 +3,52 @@ import esbuild from 'esbuild';
 import * as fs from 'fs';
 import { fileURLToPath } from 'url';
 
-export function getAdapter(): AstroAdapter {
-	return {
-		name: '@astrojs/cloudflare',
-		serverEntrypoint: '@astrojs/cloudflare/server.js',
-		exports: ['default'],
-	};
+type Options = {
+	mode: 'directory' | 'advanced';
+};
+
+export function getAdapter(isModeDirectory: boolean): AstroAdapter {
+	return isModeDirectory
+		? {
+				name: '@astrojs/cloudflare',
+				serverEntrypoint: '@astrojs/cloudflare/server.directory.js',
+				exports: ['onRequest'],
+		  }
+		: {
+				name: '@astrojs/cloudflare',
+				serverEntrypoint: '@astrojs/cloudflare/server.advanced.js',
+				exports: ['default'],
+		  };
 }
 
-export default function createIntegration(): AstroIntegration {
+const SHIM = `globalThis.process = {
+	argv: [],
+	env: {},
+};`;
+
+export default function createIntegration(args?: Options): AstroIntegration {
 	let _config: AstroConfig;
 	let _buildConfig: BuildConfig;
+	const isModeDirectory = args?.mode === 'directory';
 
 	return {
 		name: '@astrojs/cloudflare',
 		hooks: {
 			'astro:config:done': ({ setAdapter, config }) => {
-				setAdapter(getAdapter());
+				setAdapter(getAdapter(isModeDirectory));
 				_config = config;
+
+				if (config.output === 'static') {
+					throw new Error(`
+  [@astrojs/cloudflare] \`output: "server"\` is required to use this adapter. Otherwise, this adapter is not necessary to deploy a static site to Cloudflare.
+
+`);
+				}
 			},
 			'astro:build:start': ({ buildConfig }) => {
 				_buildConfig = buildConfig;
-				buildConfig.serverEntry = '_worker.js';
 				buildConfig.client = new URL('./static/', _config.outDir);
+				buildConfig.serverEntry = '_worker.js';
 				buildConfig.server = new URL('./', _config.outDir);
 			},
 			'astro:build:setup': ({ vite, target }) => {
@@ -52,7 +75,6 @@ export default function createIntegration(): AstroIntegration {
 			'astro:build:done': async () => {
 				const entryUrl = new URL(_buildConfig.serverEntry, _buildConfig.server);
 				const pkg = fileURLToPath(entryUrl);
-
 				await esbuild.build({
 					target: 'es2020',
 					platform: 'browser',
@@ -62,11 +84,21 @@ export default function createIntegration(): AstroIntegration {
 					format: 'esm',
 					bundle: true,
 					minify: true,
+					banner: {
+						js: SHIM,
+					},
 				});
 
 				// throw the server folder in the bin
 				const chunksUrl = new URL('./chunks', _buildConfig.server);
 				await fs.promises.rm(chunksUrl, { recursive: true, force: true });
+
+				if (isModeDirectory) {
+					const functionsUrl = new URL(`file://${process.cwd()}/functions/`);
+					await fs.promises.mkdir(functionsUrl, { recursive: true });
+					const directoryUrl = new URL('[[path]].js', functionsUrl);
+					await fs.promises.rename(entryUrl, directoryUrl);
+				}
 			},
 		},
 	};

package/src/{server.ts → server.advanced.ts}

@@ -19,14 +19,14 @@ export function createExports(manifest: SSRManifest) {
 			return env.ASSETS.fetch(assetRequest);
 		}
 
-		if (app.match(request)) {
-			return app.render(request);
-		}
-
-		// 404
-		const _404Request = new Request(`${origin}/404`, request);
-		if (app.match(_404Request)) {
-			return app.render(_404Request);
+		let routeData = app.match(request, { matchNotFound: true });
+		if (routeData) {
+			Reflect.set(
+				request,
+				Symbol.for('astro.clientAddress'),
+				request.headers.get('cf-connecting-ip')
+			);
+			return app.render(request, routeData);
 		}
 
 		return new Response(null, {

package/src/server.directory.ts

@@ -0,0 +1,41 @@
+import './shim.js';
+
+import type { SSRManifest } from 'astro';
+import { App } from 'astro/app';
+
+export function createExports(manifest: SSRManifest) {
+	const app = new App(manifest, false);
+
+	const onRequest = async ({
+		request,
+		next,
+	}: {
+		request: Request;
+		next: (request: Request) => void;
+	}) => {
+		const { origin, pathname } = new URL(request.url);
+
+		// static assets
+		if (manifest.assets.has(pathname)) {
+			const assetRequest = new Request(`${origin}/static${pathname}`, request);
+			return next(assetRequest);
+		}
+
+		let routeData = app.match(request, { matchNotFound: true });
+		if (routeData) {
+			Reflect.set(
+				request,
+				Symbol.for('astro.clientAddress'),
+				request.headers.get('cf-connecting-ip')
+			);
+			return app.render(request, routeData);
+		}
+
+		return new Response(null, {
+			status: 404,
+			statusText: 'Not found',
+		});
+	};
+
+	return { onRequest };
+}

package/test/basics.test.js

@@ -0,0 +1,31 @@
+import { loadFixture, runCLI } from './test-utils.js';
+import { expect } from 'chai';
+import * as cheerio from 'cheerio';
+
+describe.skip('Basic app', () => {
+	/** @type {import('./test-utils').Fixture} */
+	let fixture;
+
+	before(async () => {
+		fixture = await loadFixture({
+			root: './fixtures/basics/',
+		});
+		await fixture.build();
+	});
+
+	it('can render', async () => {
+		const { ready, stop } = runCLI('./fixtures/basics/', { silent: true });
+
+		try {
+			await ready;
+
+			let res = await fetch(`http://localhost:8787/`);
+			expect(res.status).to.equal(200);
+			let html = await res.text();
+			let $ = cheerio.load(html);
+			expect($('h1').text()).to.equal('Testing');
+		} finally {
+			stop();
+		}
+	});
+});

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

@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import cloudflare from '@astrojs/cloudflare';
+
+export default defineConfig({
+	adapter: cloudflare(),
+	output: 'server',
+});

package/test/fixtures/basics/node_modules/.bin/astro

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/basics/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@test/astro-cloudflare-basics",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "@astrojs/cloudflare": "workspace:*",
+    "astro": "workspace:*"
+  }
+}

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

@@ -0,0 +1,8 @@
+<html>
+	<head>
+		<title>Testing</title>
+	</head>
+	<body>
+		<h1>Testing</h1>
+	</body>
+</html>

package/test/fixtures/no-output/astro.config.mjs

@@ -0,0 +1,6 @@
+import { defineConfig } from 'astro/config';
+import cloudflare from '@astrojs/cloudflare';
+
+export default defineConfig({
+	adapter: cloudflare()
+});

package/test/fixtures/no-output/node_modules/.bin/astro

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/no-output/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@test/astro-cloudflare-no-output",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "@astrojs/cloudflare": "workspace:*",
+    "astro": "workspace:*"
+  }
+}

package/test/no-output.test.js

@@ -0,0 +1,24 @@
+import { loadFixture } from './test-utils.js';
+import { expect } from 'chai';
+
+describe('Missing output config', () => {
+	/** @type {import('./test-utils').Fixture} */
+	let fixture;
+
+	before(async () => {
+		fixture = await loadFixture({
+			root: './fixtures/no-output/',
+		});
+	});
+
+	it('throws during the build', async () => {
+		let error = undefined;
+		try {
+			await fixture.build();
+		} catch (err) {
+			error = err;
+		}
+		expect(error).to.not.be.equal(undefined);
+		expect(error.message).to.include(`output: "server"`);
+	});
+});

package/test/test-utils.js

@@ -0,0 +1,62 @@
+import { loadFixture as baseLoadFixture } from '../../../astro/test/test-utils.js';
+import { spawn } from 'child_process';
+import { fileURLToPath } from 'url';
+
+export { fixLineEndings } from '../../../astro/test/test-utils.js';
+
+export function loadFixture(config) {
+	if (config?.root) {
+		config.root = new URL(config.root, import.meta.url);
+	}
+	return baseLoadFixture(config);
+}
+
+const wranglerPath = fileURLToPath(
+	new URL('../node_modules/wrangler/bin/wrangler.js', import.meta.url)
+);
+
+export function runCLI(basePath, { silent }) {
+	const script = fileURLToPath(new URL(`${basePath}/dist/_worker.js`, import.meta.url));
+	const p = spawn('node', [wranglerPath, 'dev', '-l', script]);
+
+	p.stderr.setEncoding('utf-8');
+	p.stdout.setEncoding('utf-8');
+
+	const timeout = 10000;
+
+	const ready = new Promise(async (resolve, reject) => {
+		const failed = setTimeout(
+			() => reject(new Error(`Timed out starting the wrangler CLI`)),
+			timeout
+		);
+
+		(async function () {
+			for (const msg of p.stderr) {
+				if (!silent) {
+					// eslint-disable-next-line
+					console.error(msg);
+				}
+			}
+		})();
+
+		for await (const msg of p.stdout) {
+			if (!silent) {
+				// eslint-disable-next-line
+				console.log(msg);
+			}
+			if (msg.includes(`Listening on`)) {
+				break;
+			}
+		}
+
+		clearTimeout(failed);
+		resolve();
+	});
+
+	return {
+		ready,
+		stop() {
+			p.kill();
+		},
+	};
+}