Add options to update pipelines to remove CORS (#8829)

* Add options to update pipelines to remove CORS

* Update some help text for consistency

Co-authored-by: Pranshu Maheshwari <[email protected]>

---------

Co-authored-by: Pranshu Maheshwari <[email protected]>

Author: cmackenzie1

.changeset/slow-roses-create.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+Add option `--cors-origin none` to remove CORS settings on a pipeline

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

@@ -63,7 +63,7 @@ describe("wrangler", () => {
 				  wrangler dispatch-namespace     🏗️  Manage dispatch namespaces
 				  wrangler ai                     🤖 Manage AI models
 				  wrangler workflows              🔁 Manage Workflows [open-beta]
-				  wrangler pipelines              🚰 Manage Worker Pipelines [open beta]
+				  wrangler pipelines              🚰 Manage Cloudflare Pipelines [open beta]
 				  wrangler login                  🔓 Login to Cloudflare
 				  wrangler logout                 🚪 Logout from Cloudflare
 				  wrangler whoami                 🕵️  Retrieve your user information
@@ -123,7 +123,7 @@ describe("wrangler", () => {
 				  wrangler dispatch-namespace     🏗️  Manage dispatch namespaces
 				  wrangler ai                     🤖 Manage AI models
 				  wrangler workflows              🔁 Manage Workflows [open-beta]
-				  wrangler pipelines              🚰 Manage Worker Pipelines [open beta]
+				  wrangler pipelines              🚰 Manage Cloudflare Pipelines [open beta]
 				  wrangler login                  🔓 Login to Cloudflare
 				  wrangler logout                 🚪 Logout from Cloudflare
 				  wrangler whoami                 🕵️  Retrieve your user information

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

@@ -274,14 +274,14 @@ describe("pipelines", () => {
 		expect(std.out).toMatchInlineSnapshot(`
 			"wrangler pipelines
 
-			🚰 Manage Worker Pipelines [open beta]
+			🚰 Manage Cloudflare Pipelines [open beta]
 
 			COMMANDS
-			  wrangler pipelines create <pipeline>  Create a new Pipeline
-			  wrangler pipelines list               List current Pipelines
-			  wrangler pipelines get <pipeline>     Get a Pipeline configuration
-			  wrangler pipelines update <pipeline>  Update a Pipeline
-			  wrangler pipelines delete <pipeline>  Delete a Pipeline
+			  wrangler pipelines create <pipeline>  Create a new pipeline
+			  wrangler pipelines list               List all pipelines
+			  wrangler pipelines get <pipeline>     Get a pipeline's configuration
+			  wrangler pipelines update <pipeline>  Update a pipeline
+			  wrangler pipelines delete <pipeline>  Delete a pipeline
 
 			GLOBAL FLAGS
 			  -c, --config   Path to Wrangler configuration file  [string]
@@ -301,7 +301,7 @@ describe("pipelines", () => {
 			expect(std.out).toMatchInlineSnapshot(`
 				"wrangler pipelines create <pipeline>
 
-				Create a new Pipeline
+				Create a new pipeline
 
 				POSITIONALS
 				  pipeline  The name of the new pipeline  [string] [required]
@@ -324,7 +324,7 @@ describe("pipelines", () => {
 				      --compression           Compression format for output files  [string] [choices: \\"none\\", \\"gzip\\", \\"deflate\\"] [default: \\"gzip\\"]
 
 				Pipeline settings
-				      --shard-count  Number of pipeline shards. More shards handle higher request volume; fewer shards produce larger output files. Defaults to 2 if unset. Minimum: 1, Maximum: 15  [number]
+				      --shard-count  Number of shards for the pipeline. More shards handle higher request volume; fewer shards produce larger output files. Defaults to 2 if unset. Minimum: 1, Maximum: 15  [number]
 
 				GLOBAL FLAGS
 				  -c, --config   Path to Wrangler configuration file  [string]
@@ -342,8 +342,8 @@ describe("pipelines", () => {
 			);
 			expect(requests.count).toEqual(1);
 			expect(std.out).toMatchInlineSnapshot(`
-				"🌀 Creating Pipeline named \\"my-pipeline\\"
-				✅ Successfully created Pipeline \\"my-pipeline\\" with ID 0001
+				"🌀 Creating pipeline named \\"my-pipeline\\"
+				✅ Successfully created pipeline \\"my-pipeline\\" with ID 0001
 
 				Id:    0001
 				Name:  my-pipeline
@@ -364,7 +364,7 @@ describe("pipelines", () => {
 				    Max duration:  300 seconds
 				    Max records:   10,000,000
 
-				🎉 You can now send data to your Pipeline!
+				🎉 You can now send data to your pipeline!
 
 				To send data to your pipeline from a Worker, add the following to your wrangler config file:
 
@@ -377,7 +377,7 @@ describe("pipelines", () => {
 				  ]
 				}
 
-				Send data to your Pipeline's HTTP endpoint:
+				Send data to your pipeline's HTTP endpoint:
 
 				curl \\"foo\\" -d '[{\\"foo\\": \\"bar\\"}]'
 				"
@@ -654,6 +654,42 @@ describe("pipelines", () => {
 			]);
 		});
 
+		it("should update remove cors headers", async () => {
+			const pipeline: Pipeline = samplePipeline;
+			mockGetRequest(pipeline.name, pipeline);
+
+			const update = JSON.parse(JSON.stringify(pipeline));
+			update.source = [
+				{
+					type: "http",
+					format: "json",
+					authenticated: true,
+				},
+			];
+			const updateReq = mockUpdateRequest(update.name, update);
+
+			await runWrangler(
+				"pipelines update my-pipeline --cors-origins http://localhost:8787"
+			);
+
+			expect(updateReq.count).toEqual(1);
+			expect(updateReq.body?.source.length).toEqual(2);
+			expect(updateReq.body?.source[1].type).toEqual("http");
+			expect((updateReq.body?.source[1] as HttpSource).cors?.origins).toEqual([
+				"http://localhost:8787",
+			]);
+
+			mockGetRequest(pipeline.name, pipeline);
+			const secondUpdateReq = mockUpdateRequest(update.name, update);
+			await runWrangler("pipelines update my-pipeline --cors-origins none");
+			expect(secondUpdateReq.count).toEqual(1);
+			expect(secondUpdateReq.body?.source.length).toEqual(2);
+			expect(secondUpdateReq.body?.source[1].type).toEqual("http");
+			expect(
+				(secondUpdateReq.body?.source[1] as HttpSource).cors?.origins
+			).toEqual([]);
+		});
+
 		it("should fail a missing pipeline", async () => {
 			const requests = mockGetRequest("bad-pipeline", null, 404, {
 				code: 1000,
@@ -704,8 +740,8 @@ describe("pipelines", () => {
 
 			expect(std.err).toMatchInlineSnapshot(`""`);
 			expect(std.out).toMatchInlineSnapshot(`
-				"Deleting Pipeline foo.
-				Deleted Pipeline foo."
+				"Deleting pipeline foo.
+				Deleted pipeline foo."
 			`);
 			expect(requests.count).toEqual(1);
 		});
@@ -723,7 +759,7 @@ describe("pipelines", () => {
 
 			expect(std.err).toMatchInlineSnapshot(`""`);
 			expect(normalizeOutput(std.out)).toMatchInlineSnapshot(`
-				"Deleting Pipeline bad-pipeline.
+				"Deleting pipeline bad-pipeline.
 				X [ERROR] A request to the Cloudflare API (/accounts/some-account-id/pipelines/bad-pipeline) failed.
 				  Pipeline does not exist [code: 1000]
 				  If you think this is a bug, please open an issue at:

packages/wrangler/src/index.ts

@@ -958,7 +958,7 @@ export function createCLIParser(argv: string[]) {
 	// [OPEN BETA] pipelines
 	wrangler.command(
 		"pipelines",
-		`🚰 Manage Worker Pipelines ${chalk.hex(betaCmdColor)("[open beta]")}`,
+		`🚰 Manage Cloudflare Pipelines ${chalk.hex(betaCmdColor)("[open beta]")}`,
 		(pipelinesYargs) => {
 			return pipelines(pipelinesYargs.command(subHelp));
 		}

packages/wrangler/src/pipelines/cli/create.ts

@@ -161,7 +161,7 @@ export function addCreateOptions(yargs: Argv<CommonYargsOptions>) {
 			.option("shard-count", {
 				type: "number",
 				describe:
-					"Number of pipeline shards. More shards handle higher request volume; fewer shards produce larger output files. Defaults to 2 if unset. Minimum: 1, Maximum: 15",
+					"Number of shards for the pipeline. More shards handle higher request volume; fewer shards produce larger output files. Defaults to 2 if unset. Minimum: 1, Maximum: 15",
 				demandOption: false,
 			})
 	);
@@ -277,14 +277,14 @@ export async function createPipelineHandler(
 		pipelineConfig.metadata.shards = args.shardCount;
 	}
 
-	logger.log(`🌀 Creating Pipeline named "${name}"`);
+	logger.log(`🌀 Creating pipeline named "${name}"`);
 	const pipeline = await createPipeline(accountId, pipelineConfig);
 
 	logger.log(
-		`✅ Successfully created Pipeline "${pipeline.name}" with ID ${pipeline.id}\n`
+		`✅ Successfully created pipeline "${pipeline.name}" with ID ${pipeline.id}\n`
 	);
 	logger.log(formatPipelinePretty(pipeline));
-	logger.log("🎉 You can now send data to your Pipeline!");
+	logger.log("🎉 You can now send data to your pipeline!");
 
 	if (args.source.includes("worker")) {
 		logger.log(
@@ -306,7 +306,7 @@ export async function createPipelineHandler(
 	}
 
 	if (args.source.includes("http")) {
-		logger.log(`\nSend data to your Pipeline's HTTP endpoint:\n`);
+		logger.log(`\nSend data to your pipeline's HTTP endpoint:\n`);
 		logger.log(`curl "${pipeline.endpoint}" -d '[{"foo": "bar"}]'\n`);
 	}
 }

packages/wrangler/src/pipelines/cli/delete.ts

@@ -13,7 +13,7 @@ import type { Argv } from "yargs";
 export function addDeleteOptions(yargs: Argv<CommonYargsOptions>) {
 	return yargs.positional("pipeline", {
 		type: "string",
-		describe: "The name of the Pipeline to show",
+		describe: "The name of the pipeline to delete",
 		demandOption: true,
 	});
 }
@@ -28,8 +28,8 @@ export async function deletePipelineHandler(
 
 	validateName("pipeline name", name);
 
-	logger.log(`Deleting Pipeline ${name}.`);
+	logger.log(`Deleting pipeline ${name}.`);
 	await deletePipeline(accountId, name);
 
-	logger.log(`Deleted Pipeline ${name}.`);
+	logger.log(`Deleted pipeline ${name}.`);
 }

packages/wrangler/src/pipelines/cli/get.ts

@@ -16,7 +16,7 @@ export function addGetOptions(yargs: Argv<CommonYargsOptions>) {
 	return yargs
 		.positional("pipeline", {
 			type: "string",
-			describe: "The name of the Pipeline to show",
+			describe: "The name of the pipeline to inspect",
 			demandOption: true,
 		})
 		.option("format", {

packages/wrangler/src/pipelines/cli/update.ts

@@ -26,13 +26,13 @@ import type { Argv } from "yargs";
  */
 export function addUpdateOptions(yargs: Argv<CommonYargsOptions>) {
 	/* These arguments are nearly identical to the option used for creating a pipeline, with some notable differences.
-		 Particularly, not all options are available for updating, and the default values have been removed. In this case, 
+		 Particularly, not all options are available for updating, and the default values have been removed. In this case,
 		 `undefined` is used to determine if the user provided that flag at all with the intent to change the value.
 	 */
 	return (
 		yargs
 			.positional("pipeline", {
-				describe: "The name of the Pipeline to update",
+				describe: "The name of the pipeline to update",
 				type: "string",
 				demandOption: true,
 			})
@@ -49,7 +49,7 @@ export function addUpdateOptions(yargs: Argv<CommonYargsOptions>) {
 			.option("source", {
 				type: "array",
 				describe:
-					"Space separated list of allowed sources. Options are 'http' or 'worker'. Setting this will remove all other existing sources.",
+					"Space separated list of allowed sources. Options are 'http' or 'worker'",
 				demandOption: false,
 			})
 			.option("require-http-auth", {
@@ -157,7 +157,7 @@ export function addUpdateOptions(yargs: Argv<CommonYargsOptions>) {
 			.option("shard-count", {
 				type: "number",
 				describe:
-					"Number of pipeline shards. More shards handle higher request volume; fewer shards produce larger output files",
+					"Number of shards for the pipeline. More shards handle higher request volume; fewer shards produce larger output files",
 				demandOption: false,
 			})
 	);
@@ -227,18 +227,12 @@ export async function updatePipelineHandler(
 			http: (): HttpSource => {
 				const existing = existingSources.find((s: Source) => s.type === "http");
 
-				const http: HttpSource = {
+				return {
 					...existing, // Copy over existing properties for forwards compatibility
 					type: "http",
 					format: "json",
 					...(args.requireHttpAuth && { authentication: args.requireHttpAuth }), // Include only if defined
 				};
-
-				if (args.corsOrigins && args.corsOrigins.length > 0) {
-					http.cors = { origins: args.corsOrigins };
-				}
-
-				return http;
 			},
 			worker: (): BindingSource => {
 				const existing = existingSources.find(
@@ -293,15 +287,15 @@ export async function updatePipelineHandler(
 		if (args.requireHttpAuth) {
 			httpSource.authentication = args.requireHttpAuth;
 		}
-		if (args.corsOrigins && args.corsOrigins.length > 0) {
+		if (args.corsOrigins) {
 			httpSource.cors = { origins: args.corsOrigins };
 		}
 	}
 
-	logger.log(`🌀 Updating Pipeline "${name}"`);
+	logger.log(`🌀 Updating pipeline "${name}"`);
 	const pipeline = await updatePipeline(accountId, name, pipelineConfig);
 
 	logger.log(
-		`✅ Successfully updated Pipeline "${pipeline.name}" with ID ${pipeline.id}\n`
+		`✅ Successfully updated pipeline "${pipeline.name}" with ID ${pipeline.id}\n`
 	);
 }

packages/wrangler/src/pipelines/index.ts

@@ -125,31 +125,31 @@ export function pipelines(pipelineYargs: CommonYargsArgv) {
 	return pipelineYargs
 		.command(
 			"create <pipeline>",
-			"Create a new Pipeline",
+			"Create a new pipeline",
 			addCreateOptions,
 			createPipelineHandler
 		)
 		.command(
 			"list",
-			"List current Pipelines",
+			"List all pipelines",
 			(yargs) => yargs,
 			listPipelinesHandler
 		)
 		.command(
 			"get <pipeline>",
-			"Get a Pipeline configuration",
+			"Get a pipeline's configuration",
 			addGetOptions,
 			getPipelineHandler
 		)
 		.command(
 			"update <pipeline>",
-			"Update a Pipeline",
+			"Update a pipeline",
 			addUpdateOptions,
 			updatePipelineHandler
 		)
 		.command(
 			"delete <pipeline>",
-			"Delete a Pipeline",
+			"Delete a pipeline",
 			addDeleteOptions,
 			deletePipelineHandler
 		);

packages/wrangler/src/pipelines/validate.ts

@@ -11,12 +11,22 @@ export function validateCorsOrigins(values: string[] | undefined) {
 		return values;
 	}
 
+	// If none provided, ignore other options
+	if (values.includes("none")) {
+		if (values.length > 1) {
+			throw new UserError(
+				"When specifying 'none', only one value is permitted."
+			);
+		}
+		return [];
+	}
+
 	// If wildcard provided, ignore other options
 	if (values.includes("*")) {
 		if (values.length > 1) {
 			throw new UserError("When specifying '*', only one value is permitted.");
 		}
-		return values;
+		return values; // ["*"]
 	}
 
 	// Ensure any value matches the format for a CORS origin