feat(cloudflare): Add KV Bindings

withastro · Sep 27, 2023 · 6dc85e7 · 6dc85e7
1 parent 263ccc7
commit 6dc85e7
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 1 deletion.
diff --git a/.changeset/funny-cobras-accept.md b/.changeset/funny-cobras-accept.md
@@ -0,0 +1,5 @@
+---
+'@astrojs/cloudflare': minor
+---
+
+Introduce support for local KV bindings. Enhance development experience by allowing direct integration with `astro dev`.
diff --git a/packages/integrations/cloudflare/README.md b/packages/integrations/cloudflare/README.md
@@ -214,6 +214,7 @@ Currently supported bindings:
 
 - [D1](https://developers.cloudflare.com/d1/)
 - [R2](https://developers.cloudflare.com/r2/)
+- [KV](https://developers.cloudflare.com/kv/)
 
 You can access the runtime from Astro components through `Astro.locals` inside any .astro` file.
 

diff --git a/packages/integrations/cloudflare/src/index.ts b/packages/integrations/cloudflare/src/index.ts
@@ -15,7 +15,7 @@ import glob from 'tiny-glob';
 import { getAdapter } from './getAdapter.js';
 import { deduplicatePatterns } from './utils/deduplicatePatterns.js';
 import { getCFObject } from './utils/getCFObject.js';
-import { getD1Bindings, getEnvVars, getR2Bindings } from './utils/parser.js';
+import { getD1Bindings, getEnvVars, getKVBindings, getR2Bindings } from './utils/parser.js';
 import { prependForwardSlash } from './utils/prependForwardSlash.js';
 import { rewriteWasmImportPath } from './utils/rewriteWasmImportPath.js';
 import { wasmModuleLoader } from './utils/wasm-module-loader.js';
@@ -126,6 +126,7 @@ export default function createIntegration(args?: Options): AstroIntegration {
 							const vars = await getEnvVars();
 							const D1Bindings = await getD1Bindings();
 							const R2Bindings = await getR2Bindings();
+							const KVBindings = await getKVBindings();
 
 							let bindingsEnv = new Object({});
 
@@ -143,6 +144,8 @@ export default function createIntegration(args?: Options): AstroIntegration {
 								d1Persist: true,
 								r2Buckets: R2Bindings,
 								r2Persist: true,
+								kvNamespaces: KVBindings,
+								kvPersist: true,
 							});
 							await _mf.ready;
 
@@ -154,6 +157,10 @@ export default function createIntegration(args?: Options): AstroIntegration {
 								const bucket = await _mf.getR2Bucket(R2Binding);
 								Reflect.set(bindingsEnv, R2Binding, bucket);
 							}
+							for (const KVBinding of KVBindings) {
+								const namespace = await _mf.getKVNamespace(KVBinding);
+								Reflect.set(bindingsEnv, KVBinding, namespace);
+							}
 
 							process.env.PWD = originalPWD;
 							const clientLocalsSymbol = Symbol.for('astro.locals');

diff --git a/packages/integrations/cloudflare/src/utils/parser.ts b/packages/integrations/cloudflare/src/utils/parser.ts
@@ -162,3 +162,13 @@ export async function getR2Bindings() {
 	);
 	return bindings;
 }
+
+export async function getKVBindings() {
+	const { rawConfig } = parseConfig();
+	if (!rawConfig) return [];
+	if (!rawConfig?.kv_namespaces) return [];
+	const bindings = (rawConfig?.kv_namespaces as []).map(
+		(binding: { binding: string }) => binding.binding
+	);
+	return bindings;
+}
diff --git a/packages/integrations/cloudflare/test/cf.test.js b/packages/integrations/cloudflare/test/cf.test.js
@@ -95,4 +95,16 @@ describe('Astro Cloudflare Runtime', () => {
 		expect($('#hasPRODBUCKET').text()).to.equal('true');
 		expect($('#hasACCESS').text()).to.equal('true');
 	});
+
+	it('adds KV mocking', async () => {
+		expect(await fixture.pathExists('../.mf/kv')).to.be.true;
+
+		let res = await fixture.fetch('/kv');
+		expect(res.status).to.equal(200);
+		let html = await res.text();
+		let $ = cheerio.load(html);
+		expect($('#hasKV').text()).to.equal('true');
+		expect($('#hasPRODKV').text()).to.equal('true');
+		expect($('#hasACCESS').text()).to.equal('true');
+	});
 });
diff --git a/packages/integrations/cloudflare/test/fixtures/cf/src/pages/kv.astro b/packages/integrations/cloudflare/test/fixtures/cf/src/pages/kv.astro
@@ -0,0 +1,20 @@
+---
+const runtime = Astro.locals.runtime;
+const kv = runtime.env?.KV;
+await kv.put("test", "true");
+const result = await kv.get("test")
+---
+
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>KV</title>
+</head>
+<body>
+  <pre id="hasKV">{!!runtime.env?.KV}</pre>
+  <pre id="hasPRODKV">{!!runtime.env?.KV_PROD}</pre>
+  <pre id="hasACCESS">{!!result}</pre>
+</body>
+</html>
diff --git a/packages/integrations/cloudflare/test/fixtures/cf/wrangler.toml b/packages/integrations/cloudflare/test/fixtures/cf/wrangler.toml
@@ -1,5 +1,10 @@
 name = "test"
 
+kv_namespaces = [
+    { binding = "KV", id = "<YOUR_ID>", preview_id = "<YOUR_ID>" },
+    { binding = "KV_PROD", id = "<YOUR_ID>", preview_id = "<YOUR_ID>" }
+]
+
 [vars]
 COOL = "ME"
 
@@ -22,3 +27,4 @@ bucket_name = '<YOUR_BUCKET_NAME>'
 [[r2_buckets]]
 binding = 'R2_PROD' # <~ valid JavaScript variable name
 bucket_name = '<YOUR_BUCKET_NAME>'
+