wrangler 0.0.0-e64812e → 0.0.0-e6c71262

package/src/__tests__/helpers/msw/handlers/user.ts

@@ -0,0 +1,52 @@
+import { rest } from "msw";
+import { createFetchResult } from "../index";
+
+export const mswSuccessUserHandlers = [
+	rest.get("*/user", (_, response, cxt) => {
+		return response.once(
+			cxt.json(
+				createFetchResult({
+					id: "7c5dae5552338874e5053f2534d2767a",
+					email: "user@example.com",
+					first_name: "John",
+					last_name: "Appleseed",
+					username: "cfuser12345",
+					telephone: "+1 123-123-1234",
+					country: "US",
+					zipcode: "12345",
+					created_on: "2014-01-01T05:20:00Z",
+					modified_on: "2014-01-01T05:20:00Z",
+					two_factor_authentication_enabled: false,
+					suspended: false,
+				})
+			)
+		);
+	}),
+	rest.get("*/accounts", (_, response, cxt) => {
+		return response.once(
+			cxt.json(
+				createFetchResult([
+					{ name: "Account One", id: "account-1" },
+					{ name: "Account Two", id: "account-2" },
+					{ name: "Account Three", id: "account-3" },
+				])
+			)
+		);
+	}),
+	rest.get("*/memberships", (_, response, context) => {
+		return response.once(
+			context.json(
+				createFetchResult([
+					{
+						id: "membership-id-1",
+						account: { id: "account-id-1", name: "My Personal Account" },
+					},
+					{
+						id: "membership-id-2",
+						account: { id: "account-id-2", name: "Enterprise Account" },
+					},
+				])
+			)
+		);
+	}),
+];

package/src/__tests__/helpers/msw/handlers/zones.ts

@@ -0,0 +1,20 @@
+import { rest } from "msw";
+import { createFetchResult } from "../index";
+
+export default [
+	rest.get("*/zones", ({ url: { searchParams } }, res, context) => {
+		return res(
+			context.json(
+				createFetchResult(
+					searchParams.get("name") === "exists.com"
+						? [
+								{
+									id: "exists-com",
+								},
+						  ]
+						: []
+				)
+			)
+		);
+	}),
+];

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

@@ -0,0 +1,52 @@
+import { setupServer } from "msw/node";
+import { default as mswAccessHandlers } from "./handlers/access";
+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,
+	mswSuccessNamespacesHandlers,
+	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/run-in-tmp.ts

@@ -5,35 +5,34 @@ import { reinitialiseAuthTokens } from "../../user";
 
 const originalCwd = process.cwd();
 
-export function runInTempDir({ homedir }: { homedir?: string } = {}) {
-  let tmpDir: string;
+export function runInTempDir({ homedir } = { homedir: "./home" }) {
+	let tmpDir: string;
 
-  beforeAll(() => {
-    if (tmpDir !== undefined) {
-      process.chdir(originalCwd);
-      fs.rmSync(tmpDir, { recursive: true });
-    }
-  });
+	beforeEach(() => {
+		// Use realpath because the temporary path can point to a symlink rather than the actual path.
+		tmpDir = fs.realpathSync(
+			fs.mkdtempSync(path.join(os.tmpdir(), "wrangler-tests"))
+		);
 
-  beforeEach(() => {
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "wrangler-tests"));
-    process.chdir(tmpDir);
-    if (homedir !== undefined) {
-      // Override where the home directory is so that we can write our own user config,
-      // without destroying the real thing.
-      fs.mkdirSync(homedir);
-      // Note it is very important that we use the "default" value from "node:os" (e.g. `import os from "node:os";`)
-      // rather than an alias to the module (e.g. `import * as os from "node:os";`).
-      // This is because the module gets transpiled so that the "method" `homedir()` gets converted to a
-      // getter that is not configurable (and so cannot be spied upon).
-      jest.spyOn(os, "homedir").mockReturnValue(homedir);
-      // Now that we have changed the home directory location, we must reinitialize the user auth state
-      reinitialiseAuthTokens();
-    }
-  });
+		process.chdir(tmpDir);
+		// The path that is returned from `homedir()` should be absolute.
+		const absHomedir = path.resolve(tmpDir, homedir);
+		// Override where the home directory is so that we can write our own user config,
+		// without destroying the real thing.
+		fs.mkdirSync(absHomedir, { recursive: true });
+		// Note it is very important that we use the "default" value from "node:os" (e.g. `import os from "node:os";`)
+		// rather than an alias to the module (e.g. `import * as os from "node:os";`).
+		// This is because the module gets transpiled so that the "method" `homedir()` gets converted to a
+		// getter that is not configurable (and so cannot be spied upon).
+		jest.spyOn(os, "homedir")?.mockReturnValue(absHomedir);
+		// Now that we have changed the home directory location, we must reinitialize the user auth state
+		reinitialiseAuthTokens();
+	});
 
-  afterEach(() => {
-    process.chdir(originalCwd);
-    fs.rmSync(tmpDir, { recursive: true });
-  });
+	afterEach(() => {
+		if (fs.existsSync(tmpDir)) {
+			process.chdir(originalCwd);
+			fs.rmSync(tmpDir, { recursive: true });
+		}
+	});
 }

package/src/__tests__/helpers/run-wrangler.ts

@@ -5,12 +5,12 @@ import { normalizeSlashes, stripTimings } from "./mock-console";
  * A helper to 'run' wrangler commands for tests.
  */
 export async function runWrangler(cmd?: string) {
-  try {
-    await main(cmd?.split(" ") ?? []);
-  } catch (err) {
-    if (err instanceof Error) {
-      err.message = normalizeSlashes(stripTimings(err.message));
-    }
-    throw err;
-  }
+	try {
+		await main(cmd?.split(" ") ?? []);
+	} catch (err) {
+		if (err instanceof Error) {
+			err.message = normalizeSlashes(stripTimings(err.message));
+		}
+		throw err;
+	}
 }

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/child-wrangler.toml

@@ -0,0 +1 @@
+name = 'child'

package/src/__tests__/helpers/worker-scripts/hello-world-worker.js

@@ -0,0 +1,5 @@
+export default {
+	async fetch() {
+		return new Response("Hello World!");
+	},
+};

package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml

@@ -0,0 +1 @@
+name = 'hello-world'

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

@@ -0,0 +1,11 @@
+export default {
+	async fetch(req, env) {
+		const resp = await env.CHILD.fetch(req);
+		const text = await resp.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__/helpers/worker-scripts/parent-wrangler.toml

@@ -0,0 +1,5 @@
+name = 'parent'
+
+[[services]]
+binding = "CHILD"
+service = 'child'

package/src/__tests__/helpers/write-worker-source.ts

@@ -2,30 +2,30 @@ import fs from "node:fs";
 
 /** Write a mock Worker script to disk. */
 export function writeWorkerSource({
-  basePath = ".",
-  format = "js",
-  type = "esm",
+	basePath = ".",
+	format = "js",
+	type = "esm",
 }: {
-  basePath?: string;
-  format?: "js" | "ts" | "jsx" | "tsx" | "mjs";
-  type?: "esm" | "sw";
+	basePath?: string;
+	format?: "js" | "ts" | "jsx" | "tsx" | "mjs";
+	type?: "esm" | "sw";
 } = {}) {
-  if (basePath !== ".") {
-    fs.mkdirSync(basePath, { recursive: true });
-  }
-  fs.writeFileSync(
-    `${basePath}/index.${format}`,
-    type === "esm"
-      ? `import { foo } from "./another";
+	if (basePath !== ".") {
+		fs.mkdirSync(basePath, { recursive: true });
+	}
+	fs.writeFileSync(
+		`${basePath}/index.${format}`,
+		type === "esm"
+			? `import { foo } from "./another";
       export default {
         async fetch(request) {
           return new Response('Hello' + foo);
         },
       };`
-      : `import { foo } from "./another";
+			: `import { foo } from "./another";
       addEventListener('fetch', event => {
         event.respondWith(new Response('Hello' + foo));
       })`
-  );
-  fs.writeFileSync(`${basePath}/another.${format}`, `export const foo = 100;`);
+	);
+	fs.writeFileSync(`${basePath}/another.${format}`, `export const foo = 100;`);
 }

package/src/__tests__/helpers/write-wrangler-toml.ts

@@ -4,14 +4,14 @@ import type { RawConfig } from "../../config";
 
 /** Write a mock wrangler.toml file to disk. */
 export default function writeWranglerToml(config: RawConfig = {}) {
-  fs.writeFileSync(
-    "./wrangler.toml",
-    TOML.stringify({
-      compatibility_date: "2022-01-12",
-      name: "test-name",
-      ...(config as TOML.JsonMap),
-    }),
+	fs.writeFileSync(
+		"./wrangler.toml",
+		TOML.stringify({
+			compatibility_date: "2022-01-12",
+			name: "test-name",
+			...(config as TOML.JsonMap),
+		}),
 
-    "utf-8"
-  );
+		"utf-8"
+	);
 }