wrangler 0.0.0-ea8f8d7 → 0.0.0-eab9542

package/README.md

@@ -1,4 +1,10 @@
-## ⛅️ wrangler
+<h1 align="center"> ⛅️ wrangler </h1>
+<section align="center" id="shieldio-badges">
+<a href="https://www.npmjs.com/package/wrangler"><img alt="npm"  src="https://img.shields.io/npm/dw/wrangler?style=flat-square"></a>
+<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/cloudflare/wrangler2?style=flat-square">
+<img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/w/cloudflare/wrangler2/main?style=flat-square">
+<a href="https://discord.gg/CloudflareDev"><img alt="Discord" src="https://img.shields.io/discord/595317990191398933?color=%23F48120&style=flat-square"></a>
+</section>
 
 > This package is for wrangler v2.x, released first in May 2022. If you're looking for v1.x of the `@cloudflare/wrangler` package, visit https://www.npmjs.com/package/@cloudflare/wrangler / https://github.com/cloudflare/wrangler.
 

package/bin/wrangler.js

@@ -6,75 +6,132 @@ const os = require("os");
 const semiver = require("semiver");
 
 const MIN_NODE_VERSION = "16.7.0";
+const debug =
+	process.env["WRANGLER_LOG"] === "debug"
+		? (...args) => console.log(...args)
+		: () => {};
 
 let wranglerProcess;
 
-async function main() {
-  if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
-    // Note Volta and nvm are also recommended in the official docs:
-    // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
-    console.error(
-      `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
+/**
+ * Executes ../wrangler-dist/cli.js
+ */
+function runWrangler() {
+	if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
+		// Note Volta and nvm are also recommended in the official docs:
+		// https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
+		console.error(
+			`Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
 You should use the latest Node.js version if possible, as Cloudflare Workers use a very up-to-date version of V8.
 Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
-    );
-    process.exitCode = 1;
-    return;
-  }
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	let pathToCACerts = process.env.NODE_EXTRA_CA_CERTS;
+	if (pathToCACerts) {
+		// TODO:
+		// - should we log a warning here?
+		// - maybe we can generate a certificate that concatenates with ours?
+		//
+		//  I do think it'll be rare that someone wants to add a cert AND
+		//  use cloudflare WARP, but let's wait till the situation actually
+		//  arises before we do anything about it
+	} else {
+		const osTempDir = os.tmpdir();
+		const certDir = path.join(osTempDir, "wrangler-cert");
+		const certPath = path.join(certDir, "Cloudflare_CA.pem");
+		// copy cert to the system temp dir if needed
+		if (!fs.existsSync(certPath)) {
+			fs.mkdirSync(certDir, { recursive: true });
+			fs.writeFileSync(
+				certPath,
+				fs.readFileSync(path.join(__dirname, "../Cloudflare_CA.pem"), "utf-8")
+			);
+		}
+		pathToCACerts = certPath;
+	}
+
+	return spawn(
+		process.execPath,
+		[
+			"--no-warnings",
+			"--experimental-vm-modules",
+			...process.execArgv,
+			path.join(__dirname, "../wrangler-dist/cli.js"),
+			...process.argv.slice(2),
+		],
+		{
+			stdio: "inherit",
+			env: {
+				...process.env,
+				NODE_EXTRA_CA_CERTS: pathToCACerts,
+			},
+		}
+	).on("exit", (code) =>
+		process.exit(code === undefined || code === null ? 0 : code)
+	);
+}
+
+/**
+ * Runs a locally-installed version of wrangler, delegating from this version.
+ * @throws {MODULE_NOT_FOUND} if there isn't a locally installed version of wrangler.
+ */
+function runDelegatedWrangler() {
+	const packageJsonPath = require.resolve("wrangler/package.json", {
+		paths: [process.cwd()],
+	});
+	const {
+		bin: { wrangler: binaryPath },
+		version,
+	} = JSON.parse(fs.readFileSync(packageJsonPath));
+	const resolvedBinaryPath = path.resolve(packageJsonPath, "..", binaryPath);
 
-  let pathToCACerts = process.env.NODE_EXTRA_CA_CERTS;
-  if (pathToCACerts) {
-    // TODO:
-    // - should we log a warning here?
-    // - maybe we can generate a certificate that concatenates with ours?
-    //
-    //  I do think it'll be rare that someone wants to add a cert AND
-    //  use cloudflare WARP, but let's wait till the situation actually
-    //  arises before we do anything about it
-  } else {
-    const osTempDir = os.tmpdir();
-    const certDir = path.join(osTempDir, "wrangler-cert");
-    const certPath = path.join(certDir, "Cloudflare_CA.pem");
-    // copy cert to the system temp dir if needed
-    if (!fs.existsSync(certPath)) {
-      fs.mkdirSync(certDir, { recursive: true });
-      fs.writeFileSync(
-        certPath,
-        fs.readFileSync(path.join(__dirname, "../Cloudflare_CA.pem"), "utf-8")
-      );
-    }
-    pathToCACerts = certPath;
-  }
+	debug(`Delegating to locally-installed version of wrangler @ v${version}`);
 
-  wranglerProcess = spawn(
-    process.execPath,
-    [
-      ...(semiver(process.versions.node, "18.0.0") >= 0
-        ? ["--no-experimental-fetch"] // TODO: remove this when https://github.com/cloudflare/wrangler2/issues/834 is properly fixed
-        : []),
-      "--no-warnings",
-      "--experimental-vm-modules",
-      ...process.execArgv,
-      path.join(__dirname, "../wrangler-dist/cli.js"),
-      ...process.argv.slice(2),
-    ],
-    {
-      stdio: "inherit",
-      env: {
-        ...process.env,
-        NODE_EXTRA_CA_CERTS: pathToCACerts,
-      },
-    }
-  ).on("exit", (code) =>
-    process.exit(code === undefined || code === null ? 0 : code)
-  );
+	// this call to `spawn` is simpler because the delegated version will do all
+	// of the other work.
+	return spawn(
+		process.execPath,
+		[resolvedBinaryPath, ...process.argv.slice(2)],
+		{
+			stdio: "inherit",
+		}
+	).on("exit", (code) =>
+		process.exit(code === undefined || code === null ? 0 : code)
+	);
+}
+
+/**
+ * Indicates if this invocation of `wrangler` should delegate
+ * to a locally-installed version.
+ */
+function shouldDelegate() {
+	try {
+		// `require.resolve` will throw if it can't find
+		// a locally-installed version of `wrangler`
+		const delegatedPackageJson = require.resolve("wrangler/package.json", {
+			paths: [process.cwd()],
+		});
+		const thisPackageJson = path.resolve(__dirname, "..", "package.json");
+		// if it's the same path, then we're already a local install -- no need to delegate
+		return thisPackageJson !== delegatedPackageJson;
+	} catch (e) {
+		// there's no local version to delegate to -- `require.resolve` threw
+		return false;
+	}
+}
+
+async function main() {
+	wranglerProcess = shouldDelegate() ? runDelegatedWrangler() : runWrangler();
 }
 
 process.on("SIGINT", () => {
-  wranglerProcess.kill();
+	wranglerProcess?.kill();
 });
 process.on("SIGTERM", () => {
-  wranglerProcess.kill();
+	wranglerProcess?.kill();
 });
 
 void main();

package/kv-asset-handler.js

@@ -0,0 +1 @@
+export * from "@cloudflare/kv-asset-handler";

package/miniflare-dist/index.mjs

@@ -4846,6 +4846,13 @@ var getRequestContextCheckOptions = async () => {
 };
 
 // src/miniflare-cli/index.ts
+var NoOpLog = class extends Log {
+  log() {
+  }
+  error(message) {
+    throw message;
+  }
+};
 async function main() {
   const args = await yargs_default(hideBin(process.argv)).help(false).version(false).option("log", {
     choices: enumKeys(LogLevel)
@@ -4854,9 +4861,9 @@ async function main() {
   const requestContextCheckOptions = await getRequestContextCheckOptions();
   const config = {
     ...JSON.parse(args._[0] ?? "{}"),
-    ...requestContextCheckOptions,
-    log: new Log(logLevel)
+    ...requestContextCheckOptions
   };
+  config.log = config.disableLogs ? new NoOpLog() : new Log(logLevel);
   if (logLevel > LogLevel.INFO) {
     console.log("OPTIONS:\n", JSON.stringify(config, null, 2));
   }
@@ -4864,6 +4871,7 @@ async function main() {
   try {
     await mf.startServer();
     await mf.startScheduler();
+    process.send && process.send("ready");
   } catch (e) {
     mf.log.error(e);
     process.exitCode = 1;

package/package.json

@@ -1,154 +1,158 @@
 {
-  "name": "wrangler",
-  "version": "0.0.0-ea8f8d7",
-  "author": "wrangler@cloudflare.com",
-  "description": "Command-line interface for all things Cloudflare Workers",
-  "bin": {
-    "wrangler": "./bin/wrangler.js",
-    "wrangler2": "./bin/wrangler.js"
-  },
-  "license": "MIT OR Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/cloudflare/wrangler2/issues"
-  },
-  "homepage": "https://github.com/cloudflare/wrangler2#readme",
-  "keywords": [
-    "wrangler",
-    "cloudflare",
-    "workers",
-    "cloudflare workers",
-    "edge",
-    "compute",
-    "serverless",
-    "serverless application",
-    "serverless module",
-    "wasm",
-    "web",
-    "assembly",
-    "webassembly",
-    "rust",
-    "emscripten",
-    "rust",
-    "typescript",
-    "graphql",
-    "router",
-    "http",
-    "cli"
-  ],
-  "dependencies": {
-    "@esbuild-plugins/node-globals-polyfill": "^0.1.1",
-    "@esbuild-plugins/node-modules-polyfill": "^0.1.4",
-    "blake3-wasm": "^2.1.5",
-    "esbuild": "0.14.34",
-    "miniflare": "^2.5.0",
-    "nanoid": "^3.3.3",
-    "path-to-regexp": "^6.2.0",
-    "selfsigned": "^2.0.1",
-    "semiver": "^1.1.0",
-    "xxhash-wasm": "^1.0.1"
-  },
-  "optionalDependencies": {
-    "fsevents": "~2.3.2"
-  },
-  "devDependencies": {
-    "@iarna/toml": "^3.0.0",
-    "@types/command-exists": "^1.2.0",
-    "@types/glob-to-regexp": "0.4.1",
-    "@types/mime": "^2.0.3",
-    "@types/prompts": "^2.0.14",
-    "@types/react": "^17.0.37",
-    "@types/serve-static": "^1.13.10",
-    "@types/signal-exit": "^3.0.1",
-    "@types/supports-color": "^8.1.1",
-    "@types/ws": "^8.5.3",
-    "@types/yargs": "^17.0.10",
-    "@webcontainer/env": "^1.0.1",
-    "chokidar": "^3.5.3",
-    "clipboardy": "^3.0.0",
-    "cmd-shim": "^4.1.0",
-    "command-exists": "^1.2.9",
-    "devtools-protocol": "^0.0.955664",
-    "dotenv": "^16.0.0",
-    "execa": "^6.1.0",
-    "faye-websocket": "^0.11.4",
-    "finalhandler": "^1.2.0",
-    "find-up": "^6.3.0",
-    "get-port": "^6.1.2",
-    "glob-to-regexp": "0.4.1",
-    "http-terminator": "^3.2.0",
-    "ignore": "^5.2.0",
-    "ink": "^3.2.0",
-    "ink-select-input": "^4.2.1",
-    "ink-spinner": "^4.0.3",
-    "ink-table": "^3.0.0",
-    "ink-testing-library": "^2.1.0",
-    "ink-text-input": "^4.0.3",
-    "jest-fetch-mock": "^3.0.3",
-    "jest-websocket-mock": "^2.3.0",
-    "mime": "^3.0.0",
-    "open": "^8.4.0",
-    "p-queue": "^7.2.0",
-    "pretty-bytes": "^6.0.0",
-    "prompts": "^2.4.2",
-    "react": "^17.0.2",
-    "react-error-boundary": "^3.1.4",
-    "serve-static": "^1.15.0",
-    "signal-exit": "^3.0.7",
-    "supports-color": "^9.2.2",
-    "timeago.js": "^4.0.2",
-    "tmp-promise": "^3.0.3",
-    "ts-dedent": "^2.2.0",
-    "undici": "^5.3.0",
-    "update-check": "^1.5.4",
-    "ws": "^8.5.0",
-    "yargs": "^17.4.1"
-  },
-  "files": [
-    "src",
-    "bin",
-    "pages",
-    "miniflare-config-stubs",
-    "miniflare-dist",
-    "wrangler-dist",
-    "templates",
-    "vendor",
-    "import_meta_url.js",
-    "Cloudflare_CA.pem"
-  ],
-  "scripts": {
-    "clean": "rm -rf wrangler-dist miniflare-dist",
-    "check:type": "tsc",
-    "bundle": "node -r esbuild-register scripts/bundle.ts",
-    "build": "npm run clean && npm run bundle",
-    "prepublishOnly": "SOURCEMAPS=false npm run build",
-    "start": "npm run bundle && NODE_OPTIONS=--enable-source-maps ./bin/wrangler.js",
-    "test": "jest --silent=false --verbose=true",
-    "test-watch": "npm run test -- --runInBand --testTimeout=50000 --watch"
-  },
-  "engines": {
-    "node": ">=16.7.0"
-  },
-  "jest": {
-    "restoreMocks": true,
-    "testTimeout": 30000,
-    "testRegex": ".*.(test|spec)\\.[jt]sx?$",
-    "transformIgnorePatterns": [
-      "node_modules/(?!find-up|locate-path|p-locate|p-limit|p-timeout|p-queue|yocto-queue|path-exists|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream|get-port|supports-color|pretty-bytes)"
-    ],
-    "moduleNameMapper": {
-      "clipboardy": "<rootDir>/src/__tests__/helpers/clipboardy-mock.js",
-      "miniflare/cli": "<rootDir>/../../node_modules/miniflare/dist/src/cli.js"
-    },
-    "transform": {
-      "^.+\\.c?(t|j)sx?$": [
-        "esbuild-jest",
-        {
-          "sourcemap": true
-        }
-      ]
-    },
-    "setupFilesAfterEnv": [
-      "<rootDir>/src/__tests__/jest.setup.ts"
-    ]
-  }
+	"name": "wrangler",
+	"version": "0.0.0-eab9542",
+	"author": "wrangler@cloudflare.com",
+	"description": "Command-line interface for all things Cloudflare Workers",
+	"bin": {
+		"wrangler": "./bin/wrangler.js",
+		"wrangler2": "./bin/wrangler.js"
+	},
+	"main": "wrangler-dist/cli.js",
+	"license": "MIT OR Apache-2.0",
+	"bugs": {
+		"url": "https://github.com/cloudflare/wrangler2/issues"
+	},
+	"homepage": "https://github.com/cloudflare/wrangler2#readme",
+	"keywords": [
+		"wrangler",
+		"cloudflare",
+		"workers",
+		"cloudflare workers",
+		"edge",
+		"compute",
+		"serverless",
+		"serverless application",
+		"serverless module",
+		"wasm",
+		"web",
+		"assembly",
+		"webassembly",
+		"rust",
+		"emscripten",
+		"rust",
+		"typescript",
+		"graphql",
+		"router",
+		"http",
+		"cli"
+	],
+	"dependencies": {
+		"@cloudflare/kv-asset-handler": "^0.2.0",
+		"@esbuild-plugins/node-globals-polyfill": "^0.1.1",
+		"@esbuild-plugins/node-modules-polyfill": "^0.1.4",
+		"blake3-wasm": "^2.1.5",
+		"esbuild": "0.14.47",
+		"miniflare": "^2.5.1",
+		"nanoid": "^3.3.3",
+		"path-to-regexp": "^6.2.0",
+		"selfsigned": "^2.0.1",
+		"semiver": "^1.1.0",
+		"xxhash-wasm": "^1.0.1"
+	},
+	"optionalDependencies": {
+		"fsevents": "~2.3.2"
+	},
+	"devDependencies": {
+		"@iarna/toml": "^3.0.0",
+		"@types/command-exists": "^1.2.0",
+		"@types/glob-to-regexp": "0.4.1",
+		"@types/mime": "^2.0.3",
+		"@types/prompts": "^2.0.14",
+		"@types/react": "^17.0.37",
+		"@types/serve-static": "^1.13.10",
+		"@types/signal-exit": "^3.0.1",
+		"@types/supports-color": "^8.1.1",
+		"@types/ws": "^8.5.3",
+		"@types/yargs": "^17.0.10",
+		"@webcontainer/env": "^1.0.1",
+		"chokidar": "^3.5.3",
+		"clipboardy": "^3.0.0",
+		"cmd-shim": "^4.1.0",
+		"command-exists": "^1.2.9",
+		"concurrently": "^7.2.2",
+		"devtools-protocol": "^0.0.955664",
+		"dotenv": "^16.0.0",
+		"execa": "^6.1.0",
+		"faye-websocket": "^0.11.4",
+		"finalhandler": "^1.2.0",
+		"find-up": "^6.3.0",
+		"get-port": "^6.1.2",
+		"glob-to-regexp": "0.4.1",
+		"http-terminator": "^3.2.0",
+		"ignore": "^5.2.0",
+		"ink": "^3.2.0",
+		"ink-select-input": "^4.2.1",
+		"ink-spinner": "^4.0.3",
+		"ink-table": "^3.0.0",
+		"ink-testing-library": "^2.1.0",
+		"ink-text-input": "^4.0.3",
+		"jest-fetch-mock": "^3.0.3",
+		"jest-websocket-mock": "^2.3.0",
+		"mime": "^3.0.0",
+		"open": "^8.4.0",
+		"p-queue": "^7.2.0",
+		"pretty-bytes": "^6.0.0",
+		"prompts": "^2.4.2",
+		"react": "^17.0.2",
+		"react-error-boundary": "^3.1.4",
+		"serve-static": "^1.15.0",
+		"signal-exit": "^3.0.7",
+		"supports-color": "^9.2.2",
+		"timeago.js": "^4.0.2",
+		"tmp-promise": "^3.0.3",
+		"ts-dedent": "^2.2.0",
+		"undici": "^5.5.1",
+		"update-check": "^1.5.4",
+		"ws": "^8.5.0",
+		"yargs": "^17.4.1"
+	},
+	"files": [
+		"src",
+		"bin",
+		"miniflare-config-stubs",
+		"miniflare-dist",
+		"wrangler-dist",
+		"templates",
+		"vendor",
+		"import_meta_url.js",
+		"kv-asset-handler.js",
+		"Cloudflare_CA.pem"
+	],
+	"scripts": {
+		"clean": "rm -rf wrangler-dist miniflare-dist",
+		"check:type": "tsc",
+		"bundle": "node -r esbuild-register scripts/bundle.ts",
+		"build": "npm run clean && npm run bundle",
+		"dev": "npm run clean && concurrently -c black,blue 'npm run bundle -- --watch' 'npm run check:type -- --watch --preserveWatchOutput'",
+		"prepublishOnly": "SOURCEMAPS=false npm run build",
+		"start": "npm run bundle && NODE_OPTIONS=--enable-source-maps ./bin/wrangler.js",
+		"test": "jest --silent=false --verbose=true",
+		"test-watch": "npm run test -- --runInBand --testTimeout=50000 --watch"
+	},
+	"engines": {
+		"node": ">=16.7.0"
+	},
+	"jest": {
+		"restoreMocks": true,
+		"testTimeout": 30000,
+		"testRegex": ".*.(test|spec)\\.[jt]sx?$",
+		"transformIgnorePatterns": [
+			"node_modules/(?!find-up|locate-path|p-locate|p-limit|p-timeout|p-queue|yocto-queue|path-exists|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream|get-port|supports-color|pretty-bytes)"
+		],
+		"moduleNameMapper": {
+			"clipboardy": "<rootDir>/src/__tests__/helpers/clipboardy-mock.js",
+			"miniflare/cli": "<rootDir>/../../node_modules/miniflare/dist/src/cli.js"
+		},
+		"transform": {
+			"^.+\\.c?(t|j)sx?$": [
+				"esbuild-jest",
+				{
+					"sourcemap": true
+				}
+			]
+		},
+		"setupFilesAfterEnv": [
+			"<rootDir>/src/__tests__/jest.setup.ts"
+		]
+	}
 }

package/src/__tests__/config-cache-without-cache-dir.test.ts

@@ -0,0 +1,38 @@
+import { getConfigCache, saveToConfigCache } from "../config-cache";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { runInTempDir } from "./helpers/run-in-tmp";
+
+interface PagesConfigCache {
+	account_id: string;
+	pages_project_name: string;
+}
+
+describe("config cache", () => {
+	runInTempDir();
+	mockConsoleMethods();
+	// In this set of tests, we don't create a node_modules folder
+	const pagesConfigCacheFilename = "pages-config-cache.json";
+
+	it("should return an empty config if no file exists", () => {
+		expect(
+			getConfigCache<PagesConfigCache>(pagesConfigCacheFilename)
+		).toMatchInlineSnapshot(`Object {}`);
+	});
+
+	it("should ignore attempts to cache values ", () => {
+		saveToConfigCache<PagesConfigCache>(pagesConfigCacheFilename, {
+			account_id: "some-account-id",
+			pages_project_name: "foo",
+		});
+		expect(getConfigCache<PagesConfigCache>(pagesConfigCacheFilename)).toEqual(
+			{}
+		);
+
+		saveToConfigCache<PagesConfigCache>(pagesConfigCacheFilename, {
+			pages_project_name: "bar",
+		});
+		expect(getConfigCache<PagesConfigCache>(pagesConfigCacheFilename)).toEqual(
+			{}
+		);
+	});
+});