@astrojs/cloudflare 0.2.3 → 0.4.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/cloudflare:build: cache hit, replaying output f28e120d799f877a
-@astrojs/cloudflare:build: 
-@astrojs/cloudflare:build: > @astrojs/cloudflare@0.2.3 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 709829411c5ced06
+@astrojs/cloudflare:build: 
+@astrojs/cloudflare:build: > @astrojs/cloudflare@0.4.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.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
+  <div>Your address { Astro.clientAddress }</div>
+  ```
+
+  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
+
+- [#3885](https://github.com/withastro/astro/pull/3885) [`bf5d1cc1e`](https://github.com/withastro/astro/commit/bf5d1cc1e71da38a14658c615e9481f2145cc6e7) Thanks [@delucis](https://github.com/delucis)! - Integration README fixes
+
 ## 0.2.3
 
 ### Patch Changes

package/README.md

@@ -2,13 +2,14 @@
 
 An SSR adapter for use with Cloudflare Pages Functions targets. Write your code in Astro/Node and deploy to Cloudflare Pages.
 
-In your astro.config.mjs use:
+In your `astro.config.mjs` use:
 
 ```js
 import { defineConfig } from 'astro/config';
 import cloudflare from '@astrojs/cloudflare';
 
 export default defineConfig({
+  output: 'server',
   adapter: cloudflare()
 });
 ```

package/dist/index.js

@@ -8,6 +8,10 @@ function getAdapter() {
     exports: ["default"]
   };
 }
+const SHIM = `globalThis.process = {
+	argv: [],
+	env: {},
+};`;
 function createIntegration() {
   let _config;
   let _buildConfig;
@@ -17,6 +21,12 @@ function createIntegration() {
       "astro:config:done": ({ setAdapter, config }) => {
         setAdapter(getAdapter());
         _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;
@@ -53,7 +63,10 @@ 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 });

package/dist/server.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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/cloudflare",
   "description": "Deploy your site to cloudflare pages functions",
-  "version": "0.2.3",
+  "version": "0.4.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -15,22 +15,24 @@
     "astro-adapter"
   ],
   "bugs": "https://github.com/withastro/astro/issues",
-  "homepage": "https://astro.build",
+  "homepage": "https://docs.astro.build/en/guides/integrations-guide/cloudflare/",
   "exports": {
     ".": "./dist/index.js",
     "./server.js": "./dist/server.js",
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "esbuild": "^0.14.42"
+    "esbuild": "^0.14.42",
+    "wrangler": "^2.0.23"
   },
   "devDependencies": {
-    "astro": "1.0.0-beta.65",
+    "astro": "1.0.0-rc.2",
     "astro-scripts": "0.0.6"
   },
   "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

@@ -11,6 +11,11 @@ export function getAdapter(): AstroAdapter {
 	};
 }
 
+const SHIM = `globalThis.process = {
+	argv: [],
+	env: {},
+};`;
+
 export default function createIntegration(): AstroIntegration {
 	let _config: AstroConfig;
 	let _buildConfig: BuildConfig;
@@ -21,6 +26,13 @@ export default function createIntegration(): AstroIntegration {
 			'astro:config:done': ({ setAdapter, config }) => {
 				setAdapter(getAdapter());
 				_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;
@@ -62,6 +74,9 @@ export default function createIntegration(): AstroIntegration {
 					format: 'esm',
 					bundle: true,
 					minify: true,
+					banner: {
+						js: SHIM,
+					},
 				});
 
 				// throw the server folder in the bin

package/src/server.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/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('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 {
+			await 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,67 @@
+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();
+			return new Promise((resolve) => {
+				p.addListener('exit', () => {
+					resolve();
+				});
+			});
+		},
+	};
+}