@astrojs/cloudflare 3.1.0 → 3.1.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/cloudflare:build: cache hit, replaying output bb5a25392613b0d2
-@astrojs/cloudflare:build: 
-@astrojs/cloudflare:build: > @astrojs/cloudflare@3.1.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 5d20b41ab47023ca
+@astrojs/cloudflare:build: 
+@astrojs/cloudflare:build: > @astrojs/cloudflare@3.1.1 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,12 @@
 # @astrojs/cloudflare
 
+## 3.1.1
+
+### Patch Changes
+
+- [#5103](https://github.com/withastro/astro/pull/5103) [`d151d9f3f`](https://github.com/withastro/astro/commit/d151d9f3f29c0a57c59b8029a18717808ccc7f8f) Thanks [@AirBorne04](https://github.com/AirBorne04)! - enable access to Cloudflare runtime [KV, R2, Durable Objects]
+  - access native Cloudflare runtime through `import { getRuntime } from "@astrojs/cloudflare/runtime"`; now you can call `getRuntime(Astro.request)` and get access to the runtime environment.
+
 ## 3.1.0
 
 ### Minor Changes

package/README.md

@@ -68,13 +68,27 @@ $ pnpm install wrangler --save-dev
 
 It's then possible to update the preview script in your `package.json` to `"preview": "wrangler pages dev ./dist"`.This will allow you run your entire application locally with [Wrangler](https://github.com/cloudflare/wrangler2), which supports secrets, environment variables, KV namespaces, Durable Objects and [all other supported Cloudflare bindings](https://developers.cloudflare.com/pages/platform/functions/#adding-bindings).
 
+## 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.
+
+```
+import { getRuntime } from "@astrojs/cloudflare/runtime";
+
+getRuntime(Astro.request);
+```
+
+Depending on your adapter mode (advanced = worker, directory = pages), the runtime object will look a little different due to differences in the Cloudflare API.
+
 ## Streams
 
-Some integrations such as [React](https://github.com/withastro/astro/tree/main/packages/integrations/react) rely on web streams. Currently Cloudflare Pages functions are in beta and don't support the `streams_enable_constructors` feature flag.
+Some integrations such as [React](https://github.com/withastro/astro/tree/main/packages/integrations/react) rely on web streams. Currently Cloudflare Pages Functions require enabling a flag to support Streams.
 
-In order to work around this:
-- install the `"web-streams-polyfill"` package
-- add `import "web-streams-polyfill/es2018";` to the top of the front matter of every page which requires streams, such as server rendering a React component.
+To do this:
+- go to the Cloudflare Pages project
+- click on Settings in the top bar, then Functions in the sidebar
+- scroll down to Compatibility Flags, click Configure Production Compatibility Flags, and add `streams_enable_constructors`
+- do this for both the Production Compatibility Flags and Preview Compatibility Flags
 
 ## Environment Variables
 

package/dist/runtime.d.ts

@@ -0,0 +1,16 @@
+export declare type WorkerRuntime<T = unknown> = {
+    name: 'cloudflare';
+    env: T;
+    waitUntil(promise: Promise<any>): void;
+    passThroughOnException(): void;
+};
+export declare type PagesRuntime<T = unknown, U = unknown> = {
+    name: 'cloudflare';
+    env: T;
+    functionPath: string;
+    params: Record<string, string>;
+    data: U;
+    waitUntil(promise: Promise<any>): void;
+    next(request: Request): void;
+};
+export declare function getRuntime<T = unknown, U = unknown>(request: Request): WorkerRuntime<T> | PagesRuntime<T, U>;

package/dist/runtime.js

@@ -0,0 +1,12 @@
+function getRuntime(request) {
+  if (!!request) {
+    return Reflect.get(request, Symbol.for("runtime"));
+  } else {
+    throw new Error(
+      "To retrieve the current cloudflare runtime you need to pass in the Astro request object"
+    );
+  }
+}
+export {
+  getRuntime
+};

package/dist/server.advanced.d.ts

@@ -4,10 +4,11 @@ declare type Env = {
     ASSETS: {
         fetch: (req: Request) => Promise<Response>;
     };
+    name: string;
 };
 export declare function createExports(manifest: SSRManifest): {
     default: {
-        fetch: (request: Request, env: Env) => Promise<Response>;
+        fetch: (request: Request, env: Env, context: any) => Promise<Response>;
     };
 };
 export {};

package/dist/server.advanced.js

@@ -2,7 +2,7 @@ import "./shim.js";
 import { App } from "astro/app";
 function createExports(manifest) {
   const app = new App(manifest, false);
-  const fetch = async (request, env) => {
+  const fetch = async (request, env, context) => {
     const { origin, pathname } = new URL(request.url);
     if (manifest.assets.has(pathname)) {
       const assetRequest = new Request(`${origin}/static${pathname}`, request);
@@ -15,6 +15,7 @@ function createExports(manifest) {
         Symbol.for("astro.clientAddress"),
         request.headers.get("cf-connecting-ip")
       );
+      Reflect.set(request, Symbol.for("runtime"), { env, name: "cloudflare", ...context });
       let response = await app.render(request, routeData);
       if (app.setCookieHeaders) {
         for (const setCookieHeader of app.setCookieHeaders(response)) {

package/dist/server.directory.d.ts

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

package/dist/server.directory.js

@@ -4,7 +4,8 @@ function createExports(manifest) {
   const app = new App(manifest, false);
   const onRequest = async ({
     request,
-    next
+    next,
+    ...runtimeEnv
   }) => {
     const { origin, pathname } = new URL(request.url);
     if (manifest.assets.has(pathname)) {
@@ -18,6 +19,11 @@ function createExports(manifest) {
         Symbol.for("astro.clientAddress"),
         request.headers.get("cf-connecting-ip")
       );
+      Reflect.set(request, Symbol.for("runtime"), {
+        ...runtimeEnv,
+        name: "cloudflare",
+        next
+      });
       let response = await app.render(request, routeData);
       if (app.setCookieHeaders) {
         for (const setCookieHeader of app.setCookieHeaders(response)) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/cloudflare",
-  "description": "Deploy your site to cloudflare pages functions",
-  "version": "3.1.0",
+  "description": "Deploy your site to cloudflare workers or cloudflare pages",
+  "version": "3.1.1",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -19,6 +19,7 @@
   "homepage": "https://docs.astro.build/en/guides/integrations-guide/cloudflare/",
   "exports": {
     ".": "./dist/index.js",
+    "./runtime": "./dist/runtime.js",
     "./server.advanced.js": "./dist/server.advanced.js",
     "./server.directory.js": "./dist/server.directory.js",
     "./package.json": "./package.json"
@@ -27,7 +28,7 @@
     "esbuild": "^0.14.42"
   },
   "devDependencies": {
-    "astro": "1.5.0",
+    "astro": "1.6.0",
     "astro-scripts": "0.0.8",
     "chai": "^4.3.6",
     "cheerio": "^1.0.0-rc.11",

package/src/runtime.ts

@@ -0,0 +1,28 @@
+export type WorkerRuntime<T = unknown> = {
+	name: 'cloudflare';
+	env: T;
+	waitUntil(promise: Promise<any>): void;
+	passThroughOnException(): void;
+};
+
+export type PagesRuntime<T = unknown, U = unknown> = {
+	name: 'cloudflare';
+	env: T;
+	functionPath: string;
+	params: Record<string, string>;
+	data: U;
+	waitUntil(promise: Promise<any>): void;
+	next(request: Request): void;
+};
+
+export function getRuntime<T = unknown, U = unknown>(
+	request: Request
+): WorkerRuntime<T> | PagesRuntime<T, U> {
+	if (!!request) {
+		return Reflect.get(request, Symbol.for('runtime'));
+	} else {
+		throw new Error(
+			'To retrieve the current cloudflare runtime you need to pass in the Astro request object'
+		);
+	}
+}

package/src/server.advanced.ts

@@ -5,12 +5,13 @@ import { App } from 'astro/app';
 
 type Env = {
 	ASSETS: { fetch: (req: Request) => Promise<Response> };
+	name: string;
 };
 
 export function createExports(manifest: SSRManifest) {
 	const app = new App(manifest, false);
 
-	const fetch = async (request: Request, env: Env) => {
+	const fetch = async (request: Request, env: Env, context: any) => {
 		const { origin, pathname } = new URL(request.url);
 
 		// static assets
@@ -26,6 +27,7 @@ export function createExports(manifest: SSRManifest) {
 				Symbol.for('astro.clientAddress'),
 				request.headers.get('cf-connecting-ip')
 			);
+			Reflect.set(request, Symbol.for('runtime'), { env, name: 'cloudflare', ...context });
 			let response = await app.render(request, routeData);
 
 			if (app.setCookieHeaders) {

package/src/server.directory.ts

@@ -9,12 +9,12 @@ export function createExports(manifest: SSRManifest) {
 	const onRequest = async ({
 		request,
 		next,
+		...runtimeEnv
 	}: {
 		request: Request;
 		next: (request: Request) => void;
-	}) => {
+	} & Record<string, unknown>) => {
 		const { origin, pathname } = new URL(request.url);
-
 		// static assets
 		if (manifest.assets.has(pathname)) {
 			const assetRequest = new Request(`${origin}/static${pathname}`, request);
@@ -28,6 +28,11 @@ export function createExports(manifest: SSRManifest) {
 				Symbol.for('astro.clientAddress'),
 				request.headers.get('cf-connecting-ip')
 			);
+			Reflect.set(request, Symbol.for('runtime'), {
+				...runtimeEnv,
+				name: 'cloudflare',
+				next,
+			});
 			let response = await app.render(request, routeData);
 
 			if (app.setCookieHeaders) {