wrangler 0.0.0-e7a0cd5b → 0.0.0-e7cf0caa

package/src/__tests__/helpers/msw/index.ts

@@ -1,15 +1,44 @@
 import { setupServer } from "msw/node";
 import { default as mswAccessHandlers } from "./handlers/access";
-import { mswSuccessDeployments } from "./handlers/deployments";
+import {
+	mswSuccessDeployments,
+	mswSuccessDeploymentScriptMetadata,
+	mswSuccessDeploymentDetails,
+} from "./handlers/deployments";
 import { mswSuccessNamespacesHandlers } from "./handlers/namespaces";
 import { mswSuccessOauthHandlers } from "./handlers/oauth";
 import { mswSuccessR2handlers } from "./handlers/r2";
 import { default as mswSucessScriptHandlers } from "./handlers/script";
 import { mswSuccessUserHandlers } from "./handlers/user";
 import { default as mswZoneHandlers } from "./handlers/zones";
+
 export const msw = setupServer();
 
+function createFetchResult(
+	result: unknown,
+	success = true,
+	errors: unknown[] = [],
+	messages: unknown[] = [],
+	result_info?: Record<string, unknown>
+) {
+	return result_info
+		? {
+				result,
+				success,
+				errors,
+				messages,
+				result_info,
+		  }
+		: {
+				result,
+				success,
+				errors,
+				messages,
+		  };
+}
+
 export {
+	createFetchResult,
 	mswSuccessUserHandlers,
 	mswSuccessR2handlers,
 	mswSuccessOauthHandlers,
@@ -17,5 +46,7 @@ export {
 	mswSucessScriptHandlers,
 	mswZoneHandlers,
 	mswSuccessDeployments,
+	mswSuccessDeploymentDetails,
 	mswAccessHandlers,
+	mswSuccessDeploymentScriptMetadata,
 };

package/src/__tests__/helpers/msw/read-file-sync.js

@@ -0,0 +1,61 @@
+/*! Read blob sync in NodeJS. MIT License. Jimmy Wärting <https://jimmy.warting.se/opensource>
+ * Special Thanks to Jimmy Wärting helping in https://github.com/nodejs/undici/issues/1830
+ */
+const { join } = require("path");
+const {
+	Worker,
+	receiveMessageOnPort,
+	MessageChannel,
+} = require("worker_threads");
+
+/**
+ * blob-worker & read-file-sync are part of a polyfill to synchronously read a blob in NodeJS
+ * this is needed for MSW FormData patching to work and support Blobs, serializing them to a string before recreating the FormData.
+ */
+function read(blob) {
+	const subChannel = new MessageChannel();
+	const signal = new Int32Array(new SharedArrayBuffer(4));
+	signal[0] = 0;
+
+	const path = join(__dirname, "blob-worker.cjs");
+
+	const worker = new Worker(path, {
+		transferList: [subChannel.port1],
+		workerData: {
+			signal,
+			port: subChannel.port1,
+			blob,
+		},
+	});
+
+	// Sleep until the other thread sets signal[0] to 1
+	Atomics.wait(signal, 0, 0);
+
+	// Close the worker thread
+	worker.terminate();
+
+	return receiveMessageOnPort(subChannel.port2)?.message;
+}
+
+class FileReaderSync {
+	readAsArrayBuffer(blob) {
+		this.result = read(blob);
+	}
+
+	readAsDataURL(blob) {
+		const ab = read(blob);
+		this.result = `data:${blob.type};base64,${Buffer.from(ab).toString(
+			"base64"
+		)}`;
+	}
+
+	readAsText(blob) {
+		const ab = read(blob);
+		this.result = new TextDecoder().decode(ab);
+	}
+
+	// Should not be used, use readAsArrayBuffer instead
+	// readAsBinaryString(blob) { ... }
+}
+
+exports.FileReaderSync = FileReaderSync;

package/src/__tests__/helpers/string-dynamic-values-matcher.ts

@@ -0,0 +1,28 @@
+export type PatternReplacementPair = [string | RegExp, string];
+
+/**
+ * Sometimes, we might need to test strings that contain dynamic |
+ * random | generated data (such as file hashes, IDs, etc.).
+ *
+ * This helper function replaces the dynamic parts of such strings with
+ * static values, thus enabling us to properly test the contents of the
+ * string.
+ *
+ * see https://jestjs.io/docs/snapshot-testing#property-matchers
+ */
+export function replaceRandomWithConstantData(
+	stringWithRandomData: string,
+	patternReplacementPairs: Array<PatternReplacementPair>
+) {
+	let stringWithConstantData = stringWithRandomData;
+
+	patternReplacementPairs.forEach(
+		(pair) =>
+			(stringWithConstantData = stringWithConstantData.replace(
+				pair[0], // pattern
+				pair[1] // replacement
+			))
+	);
+
+	return stringWithConstantData;
+}

package/src/__tests__/helpers/worker-scripts/parent-worker.js

@@ -2,7 +2,10 @@ export default {
 	async fetch(req, env) {
 		const resp = await env.CHILD.fetch(req);
 		const text = await resp.text();
-		console.log("text: ", text);
+		// TODO: we should capture console logs when running `dev` programmatically
+		// (and locally) and expose it on the DevWorker object instead of allowing
+		// the log to appear in the output of the test runner.
+		// console.log("text: ", text);
 		return new Response(`Parent worker sees: ${text}`);
 	},
 };

package/src/__tests__/index.test.ts

@@ -1,4 +1,5 @@
 import { getPackageManager } from "../package-manager";
+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";
@@ -31,32 +32,40 @@ describe("wrangler", () => {
 			"wrangler
 
 			Commands:
-			  wrangler init [name]         📥 Create a wrangler.toml configuration file
-			  wrangler dev [script]        👂 Start a local server for developing your worker
-			  wrangler publish [script]    🆙 Publish your Worker to Cloudflare.
-			  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 pubsub              📮 Interact and manage Pub/Sub Brokers
-			  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 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 publish [script]            🆙 Publish your Worker to Cloudflare.
+			  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 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
 
 			Flags:
-			  -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]"
+			  -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]
+
+			🚧\`wrangler rollback\` is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose"
 		`);
 
 			expect(std.err).toMatchInlineSnapshot(`""`);
@@ -76,32 +85,40 @@ describe("wrangler", () => {
 			wrangler
 
 			Commands:
-			  wrangler init [name]         📥 Create a wrangler.toml configuration file
-			  wrangler dev [script]        👂 Start a local server for developing your worker
-			  wrangler publish [script]    🆙 Publish your Worker to Cloudflare.
-			  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 pubsub              📮 Interact and manage Pub/Sub Brokers
-			  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 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 publish [script]            🆙 Publish your Worker to Cloudflare.
+			  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 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
 
 			Flags:
-			  -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]"
+			  -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]
+
+			🚧\`wrangler rollback\` is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose"
 		`);
 			expect(std.err).toMatchInlineSnapshot(`
 			        "X [ERROR] Unknown argument: invalid-command
@@ -145,10 +162,11 @@ describe("wrangler", () => {
 			  wrangler secret list          List all secrets for a Worker
 
 			Flags:
-			  -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]"
+			  -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]"
 		`);
 		});
 
@@ -166,10 +184,11 @@ describe("wrangler", () => {
 			  wrangler kv:namespace delete              Deletes a given namespace.
 
 			Flags:
-			  -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]"
+			  -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]"
 		`);
 		});
 
@@ -188,10 +207,11 @@ describe("wrangler", () => {
 			  wrangler kv:key delete <key>       Removes a single key value pair from the given namespace.
 
 			Flags:
-			  -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]"
+			  -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]"
 		`);
 		});
 
@@ -208,10 +228,11 @@ describe("wrangler", () => {
 			  wrangler kv:bulk delete <filename>  Delete multiple key-value pairs from a namespace
 
 			Flags:
-			  -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]"
+			  -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]"
 		`);
 		});
 
@@ -228,10 +249,11 @@ describe("wrangler", () => {
 			  wrangler r2 bucket  Manage R2 buckets
 
 			Flags:
-			  -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]"
+			  -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]"
 		`);
 		});
 	});
@@ -256,7 +278,3 @@ describe("wrangler", () => {
 	`);
 	});
 });
-
-function endEventLoop() {
-	return new Promise((resolve) => setImmediate(resolve));
-}