@astrojs/cloudflare 6.6.2 → 6.8.0

package/README.md

@@ -73,12 +73,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.
@@ -106,7 +104,10 @@ Cloudflare has support for adding custom [headers](https://developers.cloudflare
 
 ### 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.
+By default, `@astrojs/cloudflare` will generate a `_routes.json` file with `include` and `exclude` rules based on your applications's dynamic and static routes.
+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.
+
+See [Cloudflare's documentation](https://developers.cloudflare.com/pages/platform/functions/routing/#create-a-_routesjson-file) for more details.
 
 ## Troubleshooting
 

package/dist/index.js

@@ -21,6 +21,7 @@ const SHIM = `globalThis.process = {
 	env: {},
 };`;
 const SERVER_BUILD_FOLDER = "/$server_build/";
+const potentialFunctionRouteTypes = ["endpoint", "page"];
 function createIntegration(args) {
   let _config;
   let _buildConfig;
@@ -173,10 +174,20 @@ function createIntegration(args) {
         }
         const routesExists = await fs.promises.stat(new URL("./_routes.json", _config.outDir)).then((stat) => stat.isFile()).catch(() => false);
         if (!routesExists) {
+          const functionEndpoints = routes.filter((route) => potentialFunctionRouteTypes.includes(route.type) && !route.prerender).map((route) => {
+            const includePattern = "/" + route.segments.flat().map((segment) => segment.dynamic ? "*" : segment.content).join("/");
+            const regexp = new RegExp(
+              "^\\/" + route.segments.flat().map((segment) => segment.dynamic ? "(.*)" : segment.content).join("\\/") + "$"
+            );
+            return {
+              includePattern,
+              regexp
+            };
+          });
           const staticPathList = (await glob(`${fileURLToPath(_buildConfig.client)}/**/*`, {
             cwd: fileURLToPath(_config.outDir),
             filesOnly: true
-          })).filter((file) => cloudflareSpecialFiles.indexOf(file) < 0).map((file) => `/${file}`);
+          })).filter((file) => cloudflareSpecialFiles.indexOf(file) < 0).map((file) => `/${file.replace(/\\/g, "/")}`);
           for (let page of pages) {
             let pagePath = prependForwardSlash(page.pathname);
             if (_config.base !== "/") {
@@ -215,13 +226,30 @@ function createIntegration(args) {
               trueRedirects.print()
             );
           }
+          staticPathList.push(...routes.filter((r) => r.type === "redirect").map((r) => r.route));
+          let include = deduplicatePatterns(
+            functionEndpoints.map((endpoint) => endpoint.includePattern)
+          );
+          let exclude = deduplicatePatterns(
+            staticPathList.filter(
+              (file) => functionEndpoints.some((endpoint) => endpoint.regexp.test(file))
+            )
+          );
+          if (include.length === 0) {
+            include = ["/"];
+            exclude = ["/"];
+          }
+          if (include.length + exclude.length > staticPathList.length) {
+            include = ["/*"];
+            exclude = deduplicatePatterns(staticPathList);
+          }
           await fs.promises.writeFile(
             new URL("./_routes.json", _config.outDir),
             JSON.stringify(
               {
                 version: 1,
-                include: ["/*"],
-                exclude: staticPathList
+                include,
+                exclude
               },
               null,
               2
@@ -235,6 +263,18 @@ function createIntegration(args) {
 function prependForwardSlash(path) {
   return path[0] === "/" ? path : "/" + path;
 }
+function deduplicatePatterns(patterns) {
+  const openPatterns = [];
+  return [...new Set(patterns)].sort((a, b) => a.length - b.length).filter((pattern) => {
+    if (openPatterns.some((p) => p.test(pattern))) {
+      return false;
+    }
+    if (pattern.endsWith("*")) {
+      openPatterns.push(new RegExp(`^${pattern.replace(/(\*\/)*\*$/g, ".*")}`));
+    }
+    return true;
+  });
+}
 export {
   createIntegration as default,
   getAdapter

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.d.ts

@@ -1,4 +1,4 @@
-import type { ExecutionContext, Request as CFRequest } from '@cloudflare/workers-types';
+import type { Request as CFRequest, ExecutionContext } from '@cloudflare/workers-types';
 import type { SSRManifest } from 'astro';
 type Env = {
     ASSETS: {

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 { EventContext, Request as CFRequest } 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": "6.6.2",
+  "version": "6.8.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -38,14 +38,14 @@
     "tiny-glob": "^0.2.9"
   },
   "peerDependencies": {
-    "astro": "^2.8.4"
+    "astro": "^2.10.6"
   },
   "devDependencies": {
     "chai": "^4.3.7",
     "cheerio": "1.0.0-rc.12",
     "mocha": "^9.2.2",
     "wrangler": "^2.0.23",
-    "astro": "2.8.4",
+    "astro": "2.10.6",
     "astro-scripts": "0.0.14"
   },
   "scripts": {