@astrojs/cloudflare 0.4.0 → 0.5.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@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: 
+@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,11 @@
 # @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
@@ -44,7 +50,7 @@
   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.

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:
 
@@ -14,6 +14,29 @@ export default defineConfig({
 });
 ```
 
+## 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,10 +1,14 @@
 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"]
   };
 }
@@ -12,14 +16,15 @@ const SHIM = `globalThis.process = {
 	argv: [],
 	env: {},
 };`;
-function createIntegration() {
+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(`
@@ -30,8 +35,8 @@ function createIntegration() {
       },
       "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 }) => {
@@ -70,6 +75,12 @@ function createIntegration() {
         });
         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.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.4.0",
+  "version": "0.5.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -18,16 +18,17 @@
   "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",
-    "wrangler": "^2.0.23"
+    "esbuild": "^0.14.42"
   },
   "devDependencies": {
-    "astro": "1.0.0-rc.2",
-    "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",

package/src/index.ts

@@ -3,12 +3,22 @@ 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'],
+		  };
 }
 
 const SHIM = `globalThis.process = {
@@ -16,15 +26,16 @@ const SHIM = `globalThis.process = {
 	env: {},
 };`;
 
-export default function createIntegration(): AstroIntegration {
+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') {
@@ -36,8 +47,8 @@ export default function createIntegration(): AstroIntegration {
 			},
 			'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 }) => {
@@ -64,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',
@@ -82,6 +92,13 @@ export default function createIntegration(): AstroIntegration {
 				// 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.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

@@ -2,7 +2,7 @@ import { loadFixture, runCLI } from './test-utils.js';
 import { expect } from 'chai';
 import * as cheerio from 'cheerio';
 
-describe('Basic app', () => {
+describe.skip('Basic app', () => {
 	/** @type {import('./test-utils').Fixture} */
 	let fixture;
 
@@ -25,7 +25,7 @@ describe('Basic app', () => {
 			let $ = cheerio.load(html);
 			expect($('h1').text()).to.equal('Testing');
 		} finally {
-			await stop();
+			stop();
 		}
 	});
 });

package/test/test-utils.js

@@ -57,11 +57,6 @@ export function runCLI(basePath, { silent }) {
 		ready,
 		stop() {
 			p.kill();
-			return new Promise((resolve) => {
-				p.addListener('exit', () => {
-					resolve();
-				});
-			});
 		},
 	};
 }