@astrojs/cloudflare 3.1.2 → 4.0.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/cloudflare:build: cache hit, replaying output 8f63fdc483fc35de
-@astrojs/cloudflare:build: 
-@astrojs/cloudflare:build: > @astrojs/cloudflare@3.1.2 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 17da9601b72c4888
+@astrojs/cloudflare:build: 
+@astrojs/cloudflare:build: > @astrojs/cloudflare@4.0.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,29 @@
 # @astrojs/cloudflare
 
+## 4.0.1
+
+### Patch Changes
+
+- [#5301](https://github.com/withastro/astro/pull/5301) [`a79a37cad`](https://github.com/withastro/astro/commit/a79a37cad549b21f91599ff86899e456d9dcc7df) Thanks [@bluwy](https://github.com/bluwy)! - Fix environment variables usage in worker output and warn if environment variables are accessedd too early
+
+- Updated dependencies [[`88c1bbe3a`](https://github.com/withastro/astro/commit/88c1bbe3a71f85e92f42f13d0f310c6b2a264ade), [`a79a37cad`](https://github.com/withastro/astro/commit/a79a37cad549b21f91599ff86899e456d9dcc7df)]:
+  - astro@1.6.5
+
+## 4.0.0
+
+### Major Changes
+
+- [#5290](https://github.com/withastro/astro/pull/5290) [`b2b291d29`](https://github.com/withastro/astro/commit/b2b291d29143703cece0d12c8e74b2e1151d2061) Thanks [@matthewp](https://github.com/matthewp)! - Handle base configuration in adapters
+
+  This allows adapters to correctly handle `base` configuration. Internally Astro now matches routes when the URL includes the `base`.
+
+  Adapters now also have access to the `removeBase` method which will remove the `base` from a pathname. This is useful to look up files for static assets.
+
+### Patch Changes
+
+- Updated dependencies [[`b2b291d29`](https://github.com/withastro/astro/commit/b2b291d29143703cece0d12c8e74b2e1151d2061), [`97e2b6ad7`](https://github.com/withastro/astro/commit/97e2b6ad7a6fa23e82be28b2f57cdf3f85fab112), [`4af4d8fa0`](https://github.com/withastro/astro/commit/4af4d8fa0035130fbf31c82d72777c3679bc1ca5), [`f6add3924`](https://github.com/withastro/astro/commit/f6add3924d5cd59925a6ea4bf7f2f731709bc893), [`247eb7411`](https://github.com/withastro/astro/commit/247eb7411f429317e5cd7d401a6660ee73641313)]:
+  - astro@1.6.4
+
 ## 3.1.2
 
 ### Patch Changes

package/README.md

@@ -46,9 +46,9 @@ 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.
+For most projects the adaptor 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.
 
-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 middleware which can be checked into version control.
+In directory mode the adaptor will compile the client side part of you app the same way, but moves 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 middleware which can be checked into version control. Cloudflare documentation contains more information about [writing custom functions](https://developers.cloudflare.com/pages/platform/functions/).
 
 ```ts
 // directory mode
@@ -92,16 +92,18 @@ To do this:
 
 ## Environment Variables
 
-As Cloudflare Pages Functions [provides environment variables differently](https://developers.cloudflare.com/pages/platform/functions/#adding-environment-variables-locally), private environment variables needs to be set through [`vite.define`](https://vitejs.dev/config/shared-options.html#define) to work in builds.
+As Cloudflare Pages Functions [provides environment variables per request](https://developers.cloudflare.com/pages/platform/functions/#adding-environment-variables-locally), you can only access private environment variables when a request has happened. Usually, this means moving environment variable access inside a function.
 
 ```js
-// astro.config.mjs
-export default {
-  vite: {
-    define: {
-      'process.env.MY_SECRET': JSON.stringify(process.env.MY_SECRET),
-    },
-  },
+// pages/[id].json.js
+
+export function get({ params }) {
+  // Access environment variables per request inside a function
+  const serverUrl = import.meta.env.SERVER_URL;
+  const result = await fetch(serverUrl + "/user/" + params.id);
+  return {
+    body: await result.text(),
+  };
 }
 ```
 

package/dist/server.advanced.d.ts

@@ -1,4 +1,3 @@
-import './shim.js';
 import type { SSRManifest } from 'astro';
 declare type Env = {
     ASSETS: {

package/dist/server.advanced.js

@@ -1,11 +1,13 @@
-import "./shim.js";
 import { App } from "astro/app";
+import { getProcessEnvProxy } from "./util.js";
+process.env = getProcessEnvProxy();
 function createExports(manifest) {
   const app = new App(manifest, false);
   const fetch = async (request, env, context) => {
+    process.env = env;
     const { origin, pathname } = new URL(request.url);
     if (manifest.assets.has(pathname)) {
-      const assetRequest = new Request(`${origin}/static${pathname}`, request);
+      const assetRequest = new Request(`${origin}/static/${app.removeBase(pathname)}`, request);
       return env.ASSETS.fetch(assetRequest);
     }
     let routeData = app.match(request, { matchNotFound: true });

package/dist/server.directory.d.ts

@@ -1,4 +1,3 @@
-import './shim.js';
 import type { SSRManifest } from 'astro';
 export declare function createExports(manifest: SSRManifest): {
     onRequest: ({ request, next, ...runtimeEnv }: {

package/dist/server.directory.js

@@ -1,5 +1,6 @@
-import "./shim.js";
 import { App } from "astro/app";
+import { getProcessEnvProxy } from "./util.js";
+process.env = getProcessEnvProxy();
 function createExports(manifest) {
   const app = new App(manifest, false);
   const onRequest = async ({
@@ -7,9 +8,10 @@ function createExports(manifest) {
     next,
     ...runtimeEnv
   }) => {
+    process.env = runtimeEnv.env;
     const { origin, pathname } = new URL(request.url);
     if (manifest.assets.has(pathname)) {
-      const assetRequest = new Request(`${origin}/static${pathname}`, request);
+      const assetRequest = new Request(`${origin}/static/${app.removeBase(pathname)}`, request);
       return next(assetRequest);
     }
     let routeData = app.match(request, { matchNotFound: true });

package/dist/util.d.ts

@@ -0,0 +1 @@
+export declare function getProcessEnvProxy(): {};

package/dist/util.js

@@ -0,0 +1,15 @@
+function getProcessEnvProxy() {
+  return new Proxy(
+    {},
+    {
+      get: (target, prop) => {
+        console.warn(
+          `Unable to access \`import.meta\0.env.${prop.toString()}\` on initialization as the Cloudflare platform only provides the environment variables per request. Please move the environment variable access inside a function that's only called after a request has been received.`
+        );
+      }
+    }
+  );
+}
+export {
+  getProcessEnvProxy
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/cloudflare",
   "description": "Deploy your site to cloudflare workers or cloudflare pages",
-  "version": "3.1.2",
+  "version": "4.0.1",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -30,9 +30,12 @@
   "dependencies": {
     "esbuild": "^0.14.42"
   },
+  "peerDependencies": {
+    "astro": "^1.6.5"
+  },
   "devDependencies": {
-    "astro": "1.6.1",
-    "astro-scripts": "0.0.8",
+    "astro": "1.6.5",
+    "astro-scripts": "0.0.9",
     "chai": "^4.3.6",
     "cheerio": "^1.0.0-rc.11",
     "mocha": "^9.2.2",

package/src/server.advanced.ts

@@ -1,7 +1,8 @@
-import './shim.js';
-
 import type { SSRManifest } from 'astro';
 import { App } from 'astro/app';
+import { getProcessEnvProxy } from './util.js';
+
+process.env = getProcessEnvProxy();
 
 type Env = {
 	ASSETS: { fetch: (req: Request) => Promise<Response> };
@@ -12,11 +13,13 @@ export function createExports(manifest: SSRManifest) {
 	const app = new App(manifest, false);
 
 	const fetch = async (request: Request, env: Env, context: any) => {
+		process.env = env as any;
+
 		const { origin, pathname } = new URL(request.url);
 
 		// static assets
 		if (manifest.assets.has(pathname)) {
-			const assetRequest = new Request(`${origin}/static${pathname}`, request);
+			const assetRequest = new Request(`${origin}/static/${app.removeBase(pathname)}`, request);
 			return env.ASSETS.fetch(assetRequest);
 		}
 

package/src/server.directory.ts

@@ -1,7 +1,8 @@
-import './shim.js';
-
 import type { SSRManifest } from 'astro';
 import { App } from 'astro/app';
+import { getProcessEnvProxy } from './util.js';
+
+process.env = getProcessEnvProxy();
 
 export function createExports(manifest: SSRManifest) {
 	const app = new App(manifest, false);
@@ -14,10 +15,12 @@ export function createExports(manifest: SSRManifest) {
 		request: Request;
 		next: (request: Request) => void;
 	} & Record<string, unknown>) => {
+		process.env = runtimeEnv.env as any;
+
 		const { origin, pathname } = new URL(request.url);
 		// static assets
 		if (manifest.assets.has(pathname)) {
-			const assetRequest = new Request(`${origin}/static${pathname}`, request);
+			const assetRequest = new Request(`${origin}/static/${app.removeBase(pathname)}`, request);
 			return next(assetRequest);
 		}
 

package/src/util.ts

@@ -0,0 +1,16 @@
+export function getProcessEnvProxy() {
+	return new Proxy(
+		{},
+		{
+			get: (target, prop) => {
+				console.warn(
+					// NOTE: \0 prevents Vite replacement
+					`Unable to access \`import.meta\0.env.${prop.toString()}\` on initialization ` +
+						`as the Cloudflare platform only provides the environment variables per request. ` +
+						`Please move the environment variable access inside a function ` +
+						`that's only called after a request has been received.`
+				);
+			},
+		}
+	);
+}

package/test/basics.test.js

@@ -24,6 +24,7 @@ describe.skip('Basic app', () => {
 			let html = await res.text();
 			let $ = cheerio.load(html);
 			expect($('h1').text()).to.equal('Testing');
+			expect($('#env').text()).to.equal('secret');
 		} finally {
 			stop();
 		}

package/test/fixtures/basics/astro.config.mjs

@@ -1,6 +1,9 @@
 import { defineConfig } from 'astro/config';
 import cloudflare from '@astrojs/cloudflare';
 
+// test env var
+process.env.SECRET_STUFF = 'secret'
+
 export default defineConfig({
 	adapter: cloudflare(),
 	output: 'server',

package/test/fixtures/basics/src/pages/index.astro

@@ -4,5 +4,6 @@
 	</head>
 	<body>
 		<h1>Testing</h1>
+		<div id="env">{import.meta.env.SECRET_STUFF}</div>
 	</body>
 </html>

package/test/wrangler.toml

@@ -0,0 +1,4 @@
+# for tests only
+
+[vars]
+SECRET_STUFF = "secret"

package/dist/shim.js

@@ -1,4 +0,0 @@
-globalThis.process = {
-  argv: [],
-  env: {}
-};

package/src/shim.ts

@@ -1,4 +0,0 @@
-(globalThis as any).process = {
-	argv: [],
-	env: {},
-};