wrangler: some additions

.changeset/good-ads-fold.md

@@ -0,0 +1,8 @@
+---
+"wrangler": minor
+---
+
+Adds wrangler support for Vectorize, Cloudflare's new vector database, with
+`wrangler vectorize`. Visit the developer documentation
+(https://developers.cloudflare.com/vectorize/) to learn more and create your
+first vector database with `wrangler vectorize create my-first-index`.

packages/wrangler/package.json

@@ -116,11 +116,11 @@
 		"xxhash-wasm": "^1.0.1"
 	},
 	"devDependencies": {
-		"@cloudflare/pages-shared": "workspace:^",
 		"@cloudflare/eslint-config-worker": "*",
+		"@cloudflare/pages-shared": "workspace:^",
 		"@cloudflare/types": "^6.18.4",
 		"@cloudflare/workers-tsconfig": "workspace:*",
-		"@cloudflare/workers-types": "^4.20230724.0",
+		"@cloudflare/workers-types": "^4.20230914.0",
 		"@iarna/toml": "^3.0.0",
 		"@microsoft/api-extractor": "^7.28.3",
 		"@types/body-parser": "^1.19.2",
@@ -130,6 +130,7 @@
 		"@types/glob-to-regexp": "0.4.1",
 		"@types/is-ci": "^3.0.0",
 		"@types/javascript-time-ago": "^2.0.3",
+		"@types/jest": "^29.5.5",
 		"@types/mime": "^2.0.3",
 		"@types/minimatch": "^5.1.2",
 		"@types/prompts": "^2.0.14",
@@ -141,9 +142,6 @@
 		"@types/ws": "^8.5.3",
 		"@types/yargs": "^17.0.10",
 		"@webcontainer/env": "^1.1.0",
-		"@types/jest": "^29.5.5",
-		"esbuild-jest": "0.5.0",
-		"jest": "^29.7.0",
 		"body-parser": "^1.20.0",
 		"chalk": "^2.4.2",
 		"cli-table3": "^0.6.3",
@@ -153,6 +151,7 @@
 		"concurrently": "^7.2.2",
 		"devtools-protocol": "^0.0.955664",
 		"dotenv": "^16.0.0",
+		"esbuild-jest": "0.5.0",
 		"execa": "^6.1.0",
 		"express": "^4.18.1",
 		"finalhandler": "^1.2.0",
@@ -169,6 +168,7 @@
 		"ink-text-input": "^4.0.3",
 		"is-ci": "^3.0.1",
 		"javascript-time-ago": "^2.5.4",
+		"jest": "^29.7.0",
 		"jest-fetch-mock": "^3.0.3",
 		"jest-websocket-mock": "^2.5.0",
 		"mime": "^3.0.0",

packages/wrangler/src/__tests__/configuration.test.ts

@@ -26,6 +26,7 @@ describe("normalizeAndValidateConfig()", () => {
 			compatibility_flags: [],
 			configPath: undefined,
 			d1_databases: [],
+			vectorize: [],
 			constellation: [],
 			dev: {
 				ip: "0.0.0.0",

packages/wrangler/src/__tests__/index.test.ts

@@ -51,6 +51,7 @@ describe("wrangler", () => {
 			  wrangler d1                          🗄  Interact with a D1 database
 			  wrangler ai                          🤖 Interact with AI models
 			  wrangler constellation               🤖 Interact with Constellation models
+			  wrangler vectorize                   🧮 Interact with Vectorize indexes
 			  wrangler pubsub                      📮 Interact and manage Pub/Sub Brokers
 			  wrangler mtls-certificate            🪪 Manage certificates used for mTLS connections
 			  wrangler login                       🔓 Login to Cloudflare
@@ -104,6 +105,7 @@ describe("wrangler", () => {
 			  wrangler d1                          🗄  Interact with a D1 database
 			  wrangler ai                          🤖 Interact with AI models
 			  wrangler constellation               🤖 Interact with Constellation models
+			  wrangler vectorize                   🧮 Interact with Vectorize indexes
 			  wrangler pubsub                      📮 Interact and manage Pub/Sub Brokers
 			  wrangler mtls-certificate            🪪 Manage certificates used for mTLS connections
 			  wrangler login                       🔓 Login to Cloudflare

packages/wrangler/src/__tests__/mtls-certificates.test.ts

@@ -356,39 +356,17 @@ describe("wrangler", () => {
 		describe("commands", () => {
 			describe("help", () => {
 				it("should show the correct help text", async () => {
-					await runWrangler("mtls-certifiate --help");
+					await runWrangler("mtls-certificate --help");
 					expect(std.err).toMatchInlineSnapshot(`""`);
 					expect(std.out).toMatchInlineSnapshot(`
-				"wrangler
+				"wrangler mtls-certificate
+
+				🪪 Manage certificates used for mTLS connections
 
 				Commands:
-				  wrangler docs [command..]            📚 Open wrangler's docs in your browser
-				  wrangler init [name]                 📥 Initialize a basic Worker project, including a wrangler.toml file
-				  wrangler generate [name] [template]  ✨ Generate a new Worker project from an existing Worker template. See https://github.com/cloudflare/templates
-				  wrangler dev [script]                👂 Start a local server for developing your worker
-				  wrangler deploy [script]             🆙 Deploy your Worker to Cloudflare.  [aliases: publish]
-				  wrangler delete [script]             🗑  Delete your Worker from Cloudflare.
-				  wrangler tail [worker]               🦚 Starts a log tailing session for a published Worker.
-				  wrangler secret                      🤫 Generate a secret that can be referenced in a Worker
-				  wrangler secret:bulk [json]          🗄️  Bulk upload secrets for a Worker
-				  wrangler kv:namespace                🗂️  Interact with your Workers KV Namespaces
-				  wrangler kv:key                      🔑 Individually manage Workers KV key-value pairs
-				  wrangler kv:bulk                     💪 Interact with multiple Workers KV key-value pairs at once
-				  wrangler pages                       ⚡️ Configure Cloudflare Pages
-				  wrangler queues                      🇶 Configure Workers Queues
-				  wrangler r2                          📦 Interact with an R2 store
-				  wrangler dispatch-namespace          📦 Interact with a dispatch namespace
-				  wrangler d1                          🗄  Interact with a D1 database
-				  wrangler ai                          🤖 Interact with AI models
-				  wrangler constellation               🤖 Interact with Constellation models
-				  wrangler pubsub                      📮 Interact and manage Pub/Sub Brokers
-				  wrangler mtls-certificate            🪪 Manage certificates used for mTLS connections
-				  wrangler login                       🔓 Login to Cloudflare
-				  wrangler logout                      🚪 Logout from Cloudflare
-				  wrangler whoami                      🕵️  Retrieve your user info and test your auth config
-				  wrangler types                       📝 Generate types from bindings & module rules in config
-				  wrangler deployments                 🚢 List and view details for deployments
-				  wrangler rollback [deployment-id]    🔙 Rollback a deployment
+				  wrangler mtls-certificate upload  Upload an mTLS certificate
+				  wrangler mtls-certificate list    List uploaded mTLS certificates
+				  wrangler mtls-certificate delete  Delete an mTLS certificate
 
 				Flags:
 				  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]

packages/wrangler/src/__tests__/vectorize/vectorize.test.ts

@@ -0,0 +1,116 @@
+import { endEventLoop } from "../helpers/end-event-loop";
+import { mockConsoleMethods } from "../helpers/mock-console";
+import { runInTempDir } from "../helpers/run-in-tmp";
+import { runWrangler } from "../helpers/run-wrangler";
+
+describe("vectorize", () => {
+	const std = mockConsoleMethods();
+	runInTempDir();
+
+	it("should show help when no argument is passed", async () => {
+		await runWrangler("vectorize");
+		await endEventLoop();
+
+		expect(std.out).toMatchInlineSnapshot(`
+		"wrangler vectorize
+
+		🧮 Interact with Vectorize indexes
+
+		Commands:
+		  wrangler vectorize create <name>  Create a Vectorize index
+		  wrangler vectorize delete <name>  Delete a Vectorize index
+		  wrangler vectorize get <name>     Get a Vectorize index by name
+		  wrangler vectorize list           List your Vectorize indexes
+
+		Flags:
+		  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+		  -c, --config                    Path to .toml configuration file  [string]
+		  -e, --env                       Environment to use for operations and .env files  [string]
+		  -h, --help                      Show help  [boolean]
+		  -v, --version                   Show version number  [boolean]
+
+		--------------------
+		📣 Vectorize is currently in open beta
+		📣 See the Vectorize docs for how to get started and known issues: https://developers.cloudflare.com/vectorize
+		📣 Please report any bugs to https://github.com/cloudflare/workers-sdk/issues/new/choose
+		📣 To give feedback, visit https://discord.cloudflare.com/
+		--------------------"
+	`);
+	});
+
+	it("should show help when an invalid argument is passed", async () => {
+		await expect(() => runWrangler("vectorize foobarfofum")).rejects.toThrow(
+			"Unknown argument: foobarfofum"
+		);
+
+		expect(std.err).toMatchInlineSnapshot(`
+		"X [ERROR] Unknown argument: foobarfofum
+
+		"
+	`);
+		expect(std.out).toMatchInlineSnapshot(`
+		"
+		wrangler vectorize
+
+		🧮 Interact with Vectorize indexes
+
+		Commands:
+		  wrangler vectorize create <name>  Create a Vectorize index
+		  wrangler vectorize delete <name>  Delete a Vectorize index
+		  wrangler vectorize get <name>     Get a Vectorize index by name
+		  wrangler vectorize list           List your Vectorize indexes
+
+		Flags:
+		  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+		  -c, --config                    Path to .toml configuration file  [string]
+		  -e, --env                       Environment to use for operations and .env files  [string]
+		  -h, --help                      Show help  [boolean]
+		  -v, --version                   Show version number  [boolean]
+
+		--------------------
+		📣 Vectorize is currently in open beta
+		📣 See the Vectorize docs for how to get started and known issues: https://developers.cloudflare.com/vectorize
+		📣 Please report any bugs to https://github.com/cloudflare/workers-sdk/issues/new/choose
+		📣 To give feedback, visit https://discord.cloudflare.com/
+		--------------------"
+	`);
+	});
+
+	it("should show help when the get command is passed without an index", async () => {
+		await expect(() => runWrangler("vectorize get")).rejects.toThrow(
+			"Not enough non-option arguments: got 0, need at least 1"
+		);
+
+		expect(std.err).toMatchInlineSnapshot(`
+		"X [ERROR] Not enough non-option arguments: got 0, need at least 1
+
+		"
+	`);
+		expect(std.out).toMatchInlineSnapshot(`
+		"
+		wrangler vectorize get <name>
+
+		Get a Vectorize index by name
+
+		Positionals:
+		  name  The name of the Vectorize index.  [string] [required]
+
+		Flags:
+		  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+		  -c, --config                    Path to .toml configuration file  [string]
+		  -e, --env                       Environment to use for operations and .env files  [string]
+		  -h, --help                      Show help  [boolean]
+		  -v, --version                   Show version number  [boolean]
+
+		Options:
+		      --json  return output as clean JSON  [boolean] [default: false]
+
+		--------------------
+		📣 Vectorize is currently in open beta
+		📣 See the Vectorize docs for how to get started and known issues: https://developers.cloudflare.com/vectorize
+		📣 Please report any bugs to https://github.com/cloudflare/workers-sdk/issues/new/choose
+		📣 To give feedback, visit https://discord.cloudflare.com/
+		--------------------"
+	`);
+	});
+});

packages/wrangler/src/api/pages/create-worker-bundle-contents.ts

@@ -60,6 +60,7 @@ function createWorkerBundleFormData(workerBundle: BundleResult): FormData {
 			queues: undefined,
 			r2_buckets: undefined,
 			d1_databases: undefined,
+			vectorize: undefined,
 			constellation: undefined,
 			services: undefined,
 			analytics_engine_datasets: undefined,

packages/wrangler/src/cfetch/internal.ts

@@ -86,6 +86,11 @@
 	logger.debug("RESPONSE:", jsonText);
 	logger.debug("-- END CF API RESPONSE");
 
+	if (!jsonText && (response.status === 204 || response.status === 205)) {
+		const emptyBody = `{"result": {}, "success": true, "errors": [], "messages": []}`;
+		return parseJSON<ResponseType>(emptyBody);
+	}
+
 	try {
 		return parseJSON<ResponseType>(jsonText);
 	} catch (err) {

packages/wrangler/src/config/environment.ts

@@ -458,6 +458,22 @@ interface EnvironmentNonInheritable {
 		database_internal_env?: string;
 	}[];
 
+	/**
+	 * Specifies Vectorize indexes that are bound to this Worker environment.
+	 *
+	 * NOTE: This field is not automatically inherited from the top level environment,
+	 * and so must be specified in every named environment.
+	 *
+	 * @default `[]`
+	 * @nonInheritable
+	 */
+	vectorize: {
+		/** The binding name used to refer to the Vectorize index in the worker. */
+		binding: string;
+		/** The name of the index. */
+		index_name: string;
+	}[];
+
 	/**
 	 * Specifies Constellation projects that are bound to this Worker environment.
 	 *

packages/wrangler/src/config/index.ts

@@ -99,6 +99,7 @@
 		send_email,
 		queues,
 		d1_databases,
+		vectorize,
 		constellation,
 		r2_buckets,
 		logfwdr,
@@ -209,6 +210,18 @@
 		});
 	}
 
+	if (vectorize !== undefined && vectorize.length > 0) {
+		output.push({
+			type: "Vectorize Indexes",
+			entries: vectorize.map(({ binding, index_name }) => {
+				return {
+					key: binding,
+					value: index_name,
+				};
+			}),
+		});
+	}
+
 	if (constellation !== undefined && constellation.length > 0) {
 		output.push({
 			type: "Constellation Projects",

packages/wrangler/src/config/validation.ts

@@ -1234,6 +1234,16 @@
 			validateBindingArray(envName, validateD1Binding),
 			[]
 		),
+		vectorize: notInheritable(
+			diagnostics,
+			topLevelEnv,
+			rawConfig,
+			rawEnv,
+			envName,
+			"vectorize",
+			validateBindingArray(envName, validateVectorizeBinding),
+			[]
+		),
 		constellation: notInheritable(
 			diagnostics,
 			topLevelEnv,
@@ -2253,6 +2263,34 @@
 	return isValid;
 };
 
+const validateVectorizeBinding: ValidatorFn = (diagnostics, field, value) => {
+	if (typeof value !== "object" || value === null) {
+		diagnostics.errors.push(
+			`"vectorize" bindings should be objects, but got ${JSON.stringify(value)}`
+		);
+		return false;
+	}
+	let isValid = true;
+	// Vectorize bindings must have a binding and a project.
+	if (!isRequiredProperty(value, "binding", "string")) {
+		diagnostics.errors.push(
+			`"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
+				value
+			)}.`
+		);
+		isValid = false;
+	}
+	if (!isRequiredProperty(value, "index_name", "string")) {
+		diagnostics.errors.push(
+			`"${field}" bindings must have an "index_name" field but got ${JSON.stringify(
+				value
+			)}.`
+		);
+		isValid = false;
+	}
+	return isValid;
+};
+
 const validateConstellationBinding: ValidatorFn = (
 	diagnostics,
 	field,

packages/wrangler/src/deploy/deploy.ts

@@ -544,6 +544,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			}),
 			r2_buckets: config.r2_buckets,
 			d1_databases: config.d1_databases,
+			vectorize: config.vectorize,
 			constellation: config.constellation,
 			services: config.services,
 			analytics_engine_datasets: config.analytics_engine_datasets,