@astrojs/cloudflare 7.0.0-beta.1 → 7.0.0-rc.3

package/README.md

@@ -44,23 +44,37 @@ export default defineConfig({
 
 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.
+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 adapter default of `advanced` will be sufficient; the `dist` folder will contain your compiled project.
 
-For most projects the adapter default of `advanced` will be sufficient; the `dist` folder will contain your compiled project. Switching to directory mode allows you to use [pages plugins](https://developers.cloudflare.com/pages/platform/functions/plugins/) such as [Sentry](https://developers.cloudflare.com/pages/platform/functions/plugins/sentry/) or write custom code to enable logging.
+#### `mode:directory`
 
-In directory mode, the adapter will compile the client side part of your app the same way by default, but moves the worker script into a `functions` folder in the project root. In this case, the adapter will only ever place a `[[path]].js` in that folder, allowing you to add additional plugins and pages middleware which can be checked into version control.
-
-With the build configuration `split: true`, the adapter instead compiles a separate bundle for each page. This option requires some manual maintenance of the `functions` folder. Files emitted by Astro will overwrite existing `functions` files with identical names, so you must choose unique file names for each file you manually add. Additionally, the adapter will never empty the `functions` folder of outdated files, so you must clean up the folder manually when you remove pages.
-
-Note that this adapter does not support using [Cloudflare Pages Middleware](https://developers.cloudflare.com/pages/platform/functions/middleware/). Astro will bundle the [Astro middleware](https://docs.astro.build/en/guides/middleware/) into each page.
+Switching to directory mode allows you to use [pages plugins](https://developers.cloudflare.com/pages/platform/functions/plugins/) such as [Sentry](https://developers.cloudflare.com/pages/platform/functions/plugins/sentry/) or write custom code to enable logging.
 
 ```ts
-// directory mode
+// astro.config.mjs
 export default defineConfig({
   adapter: cloudflare({ mode: 'directory' }),
 });
 ```
 
+In `directory` mode, the adapter will compile the client-side part of your app the same way as in `advanced` mode by default, but moves the worker script into a `functions` folder in the project root. In this case, the adapter will only ever place a `[[path]].js` in that folder, allowing you to add additional plugins and pages middleware which can be checked into version control.
+
+To instead compile a separate bundle for each page, set the `functionPerPath` option in your Cloudflare adapter config. This option requires some manual maintenance of the `functions` folder. Files emitted by Astro will overwrite existing `functions` files with identical names, so you must choose unique file names for each file you manually add. Additionally, the adapter will never empty the `functions` folder of outdated files, so you must clean up the folder manually when you remove pages.
+
+```diff
+import {defineConfig} from "astro/config";
+import cloudflare from '@astrojs/cloudflare';
+
+export default defineConfig({
+     adapter: cloudflare({
+        mode: 'directory',
++       functionPerRoute: true
+    })
+})
+```
+
+Note that this adapter does not support using [Cloudflare Pages Middleware](https://developers.cloudflare.com/pages/platform/functions/middleware/). Astro will bundle the [Astro middleware](https://docs.astro.build/en/guides/middleware/) into each page.
+
 ## Enabling Preview
 
 In order for preview to work you must install `wrangler`
@@ -73,12 +87,10 @@ It's then possible to update the preview script in your `package.json` to `"prev
 
 ## Access to the Cloudflare runtime
 
-You can access all the Cloudflare bindings and environment variables from Astro components and API routes through the adapter API.
+You can access all the Cloudflare bindings and environment variables from Astro components and API routes through `Astro.locals`.
 
 ```js
-import { getRuntime } from '@astrojs/cloudflare/runtime';
-
-getRuntime(Astro.request);
+const env = Astro.locals.runtime.env;
 ```
 
 Depending on your adapter mode (advanced = worker, directory = pages), the runtime object will look a little different due to differences in the Cloudflare API.

package/dist/index.d.ts

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

package/dist/index.js

@@ -5,17 +5,24 @@ import * as os from "node:os";
 import { sep } from "node:path";
 import { fileURLToPath, pathToFileURL } from "node:url";
 import glob from "tiny-glob";
-function getAdapter(isModeDirectory) {
+function getAdapter({
+  isModeDirectory,
+  functionPerRoute
+}) {
   return isModeDirectory ? {
     name: "@astrojs/cloudflare",
     serverEntrypoint: "@astrojs/cloudflare/server.directory.js",
     exports: ["onRequest", "manifest"],
+    adapterFeatures: {
+      functionPerRoute,
+      edgeMiddleware: false
+    },
     supportedAstroFeatures: {
       hybridOutput: "stable",
       staticOutput: "unsupported",
       serverOutput: "stable",
       assets: {
-        supportKind: "unsupported",
+        supportKind: "stable",
         isSharpCompatible: false,
         isSquooshCompatible: false
       }
@@ -45,8 +52,9 @@ const potentialFunctionRouteTypes = ["endpoint", "page"];
 function createIntegration(args) {
   let _config;
   let _buildConfig;
-  const isModeDirectory = args?.mode === "directory";
   let _entryPoints = /* @__PURE__ */ new Map();
+  const isModeDirectory = args?.mode === "directory";
+  const functionPerRoute = args?.functionPerRoute ?? false;
   return {
     name: "@astrojs/cloudflare",
     hooks: {
@@ -61,7 +69,7 @@ function createIntegration(args) {
         });
       },
       "astro:config:done": ({ setAdapter, config }) => {
-        setAdapter(getAdapter(isModeDirectory));
+        setAdapter(getAdapter({ isModeDirectory, functionPerRoute }));
         _config = config;
         _buildConfig = config.build;
         if (config.output === "static") {
@@ -103,7 +111,7 @@ function createIntegration(args) {
         if (isModeDirectory) {
           await fs.promises.mkdir(functionsUrl, { recursive: true });
         }
-        if (isModeDirectory && _buildConfig.split) {
+        if (isModeDirectory && (_buildConfig.split || functionPerRoute)) {
           const entryPointsURL = [..._entryPoints.values()];
           const entryPaths = entryPointsURL.map((entry) => fileURLToPath(entry));
           const outputUrl = new URL("$astro", _buildConfig.server);

package/dist/runtime.d.ts

@@ -22,4 +22,14 @@ export type PagesRuntime<T = unknown, U = unknown> = {
     };
     cf?: IncomingRequestCfProperties;
 };
+/**
+ * @deprecated since version 6.8.0
+ * The `getRuntime` utility has been deprecated and should be updated to the new [`Astro.locals`](https://docs.astro.build/en/guides/middleware/#locals) API.
+ * ```diff
+ * - import { getRuntime } from '@astrojs/cloudflare/runtime';
+ * - getRuntime(Astro.request);
+ *
+ * + const runtime = Astro.locals.runtime;
+ * ```
+ */
 export declare function getRuntime<T = unknown, U = unknown>(request: Request): WorkerRuntime<T> | PagesRuntime<T, U>;

package/dist/server.advanced.js

@@ -28,7 +28,17 @@ function createExports(manifest) {
           context.waitUntil(promise);
         }
       });
-      let response = await app.render(request, routeData);
+      const locals = {
+        runtime: {
+          waitUntil: (promise) => {
+            context.waitUntil(promise);
+          },
+          env,
+          cf: request.cf,
+          caches
+        }
+      };
+      let response = await app.render(request, routeData, locals);
       if (app.setCookieHeaders) {
         for (const setCookieHeader of app.setCookieHeaders(response)) {
           response.headers.append("Set-Cookie", setCookieHeader);

package/dist/server.directory.d.ts

@@ -1,10 +1,6 @@
-import type { Request as CFRequest, EventContext } from '@cloudflare/workers-types';
+import type { EventContext } from '@cloudflare/workers-types';
 import type { SSRManifest } from 'astro';
 export declare function createExports(manifest: SSRManifest): {
-    onRequest: ({ request, next, ...runtimeEnv }: {
-        request: Request & CFRequest;
-        next: (request: Request) => void;
-        waitUntil: EventContext<unknown, any, unknown>['waitUntil'];
-    } & Record<string, unknown>) => Promise<import("@cloudflare/workers-types").Response | Response>;
+    onRequest: (context: EventContext<unknown, string, unknown>) => Promise<import("@cloudflare/workers-types").Response | Response>;
     manifest: SSRManifest;
 };

package/dist/server.directory.js

@@ -5,17 +5,13 @@ if (!isNode) {
 }
 function createExports(manifest) {
   const app = new App(manifest);
-  const onRequest = async ({
-    request,
-    next,
-    ...runtimeEnv
-  }) => {
-    process.env = runtimeEnv.env;
+  const onRequest = async (context) => {
+    const request = context.request;
+    const { next, env } = context;
+    process.env = env;
     const { pathname } = new URL(request.url);
     if (manifest.assets.has(pathname)) {
-      return runtimeEnv.env.ASSETS.fetch(
-        request
-      );
+      return env.ASSETS.fetch(request);
     }
     let routeData = app.match(request, { matchNotFound: true });
     if (routeData) {
@@ -25,16 +21,26 @@ function createExports(manifest) {
         request.headers.get("cf-connecting-ip")
       );
       Reflect.set(request, Symbol.for("runtime"), {
-        ...runtimeEnv,
+        ...context,
         waitUntil: (promise) => {
-          runtimeEnv.waitUntil(promise);
+          context.waitUntil(promise);
         },
         name: "cloudflare",
         next,
         caches,
         cf: request.cf
       });
-      let response = await app.render(request, routeData);
+      const locals = {
+        runtime: {
+          waitUntil: (promise) => {
+            context.waitUntil(promise);
+          },
+          env: context.env,
+          cf: request.cf,
+          caches
+        }
+      };
+      let response = await app.render(request, routeData, locals);
       if (app.setCookieHeaders) {
         for (const setCookieHeader of app.setCookieHeaders(response)) {
           response.headers.append("Set-Cookie", setCookieHeader);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/cloudflare",
   "description": "Deploy your site to Cloudflare Workers/Pages",
-  "version": "7.0.0-beta.1",
+  "version": "7.0.0-rc.3",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -35,17 +35,18 @@
     "@cloudflare/workers-types": "^4.20230518.0",
     "esbuild": "^0.18.16",
     "tiny-glob": "^0.2.9",
-    "@astrojs/underscore-redirects": "0.3.0-beta.0"
+    "@astrojs/underscore-redirects": "0.3.0-rc.1"
   },
   "peerDependencies": {
-    "astro": "^3.0.0-beta.1"
+    "astro": "^3.0.0-rc.5"
   },
   "devDependencies": {
     "chai": "^4.3.7",
     "cheerio": "1.0.0-rc.12",
+    "kill-port": "^2.0.1",
     "mocha": "^9.2.2",
-    "wrangler": "^2.0.23",
-    "astro": "3.0.0-beta.1",
+    "wrangler": "^3.5.0",
+    "astro": "3.0.0-rc.5",
     "astro-scripts": "0.0.14"
   },
   "scripts": {