wrangler 0.0.0-e95e5a0 → 0.0.0-e978986

package/src/inspect.ts

@@ -1,7 +1,9 @@
 import assert from "node:assert";
 import { createServer } from "node:http";
+import os from "node:os";
 import { URL } from "node:url";
 
+import open from "open";
 import { useEffect, useRef, useState } from "react";
 import WebSocket, { WebSocketServer } from "ws";
 import { version } from "../package.json";
@@ -621,3 +623,40 @@ function logConsoleMessage(evt: Protocol.Runtime.ConsoleAPICalledEvent): void {
     logger.warn("console event:", evt);
   }
 }
+
+/**
+ * Opens the chrome debugger
+ */
+export const openInspector = async (inspectorPort: number) => {
+  const url = `https://built-devtools.pages.dev/js_app?experiments=true&v8only=true&ws=localhost:${inspectorPort}/ws`;
+  const errorMessage =
+    "Failed to open inspector.\nInspector depends on having a Chromium-based browser installed, maybe you need to install one?";
+
+  // see: https://github.com/sindresorhus/open/issues/177#issue-610016699
+  let braveBrowser: string;
+  switch (os.platform()) {
+    case "darwin":
+    case "win32":
+      braveBrowser = "Brave";
+      break;
+    default:
+      braveBrowser = "brave";
+  }
+
+  const childProcess = await open(url, {
+    app: [
+      {
+        name: open.apps.chrome,
+      },
+      {
+        name: braveBrowser,
+      },
+      {
+        name: open.apps.edge,
+      },
+    ],
+  });
+  childProcess.on("error", () => {
+    logger.warn(errorMessage);
+  });
+};

package/src/kv.ts

@@ -1,5 +1,6 @@
 import { URLSearchParams } from "node:url";
 import { fetchListResult, fetchResult, fetchKVGetValue } from "./cfetch";
+import { logger } from "./logger";
 import type { Config } from "./config";
 
 /** The largest number of kv items we can pass to the API in a single request. */
@@ -19,7 +20,7 @@ type KvArgs = {
  *
  * @returns the generated id of the created namespace.
  */
-export async function createNamespace(
+export async function createKVNamespace(
   accountId: string,
   title: string
 ): Promise<string> {
@@ -51,7 +52,7 @@ export interface KVNamespaceInfo {
 /**
  * Fetch a list of all the namespaces under the given `accountId`.
  */
-export async function listNamespaces(
+export async function listKVNamespaces(
   accountId: string
 ): Promise<KVNamespaceInfo[]> {
   const pageSize = 100;
@@ -83,7 +84,7 @@ export interface NamespaceKeyInfo {
   metadata?: { [key: string]: unknown };
 }
 
-export async function listNamespaceKeys(
+export async function listKVNamespaceKeys(
   accountId: string,
   namespaceId: string,
   prefix = ""
@@ -95,6 +96,16 @@ export async function listNamespaceKeys(
   );
 }
 
+export async function deleteKVNamespace(
+  accountId: string,
+  namespaceId: string
+) {
+  return await fetchResult<{ id: string }>(
+    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}`,
+    { method: "DELETE" }
+  );
+}
+
 /**
  * Information about a key-value pair, including its "metadata" fields.
  */
@@ -116,12 +127,52 @@ const KeyValueKeys = new Set([
   "base64",
 ]);
 
+/**
+ * The object has the specified property.
+ */
+function hasProperty<T extends object>(
+  obj: object,
+  property: keyof T
+): obj is T {
+  return property in obj;
+}
+
+/**
+ * The object has a required property of the specified type.
+ */
+function hasTypedProperty<T extends object>(
+  obj: object,
+  property: keyof T,
+  type: string
+): obj is T {
+  return hasProperty(obj, property) && typeof obj[property] === type;
+}
+
+/**
+ * The object an optional property, of the specified type.
+ */
+function hasOptionalTypedProperty<T extends object>(
+  obj: object,
+  property: keyof T,
+  type: string
+): obj is Omit<T, typeof property> | T {
+  return !hasProperty(obj, property) || typeof obj[property] === type;
+}
+
 /**
  * Is the given object a valid `KeyValue` type?
  */
-export function isKeyValue(keyValue: object): keyValue is KeyValue {
-  const props = Object.keys(keyValue);
-  if (!props.includes("key") || !props.includes("value")) {
+export function isKVKeyValue(keyValue: unknown): keyValue is KeyValue {
+  if (
+    keyValue === null ||
+    typeof keyValue !== "object" ||
+    !hasTypedProperty(keyValue, "key", "string") ||
+    !hasTypedProperty(keyValue, "value", "string") ||
+    !hasOptionalTypedProperty(keyValue, "expiration", "number") ||
+    !hasOptionalTypedProperty(keyValue, "expiration_ttl", "number") ||
+    !hasOptionalTypedProperty(keyValue, "base64", "boolean") ||
+    !hasOptionalTypedProperty(keyValue, "metadata", "object")
+  ) {
     return false;
   }
   return true;
@@ -130,12 +181,12 @@ export function isKeyValue(keyValue: object): keyValue is KeyValue {
 /**
  * Get all the properties on the `keyValue` that are not expected.
  */
-export function unexpectedKeyValueProps(keyValue: KeyValue): string[] {
+export function unexpectedKVKeyValueProps(keyValue: KeyValue): string[] {
   const props = Object.keys(keyValue);
   return props.filter((prop) => !KeyValueKeys.has(prop));
 }
 
-export async function putKeyValue(
+export async function putKVKeyValue(
   accountId: string,
   namespaceId: string,
   keyValue: KeyValue
@@ -151,29 +202,66 @@ export async function putKeyValue(
     }
   }
   return await fetchResult(
-    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${keyValue.key}`,
+    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
+      keyValue.key
+    )}`,
     { method: "PUT", body: keyValue.value },
     searchParams
   );
 }
 
-export async function getKeyValue(
+export async function getKVKeyValue(
   accountId: string,
   namespaceId: string,
   key: string
 ): Promise<string> {
-  return await fetchKVGetValue(accountId, namespaceId, key);
+  return await fetchKVGetValue(accountId, namespaceId, encodeURIComponent(key));
 }
 
-export async function putBulkKeyValue(
+export async function deleteKVKeyValue(
+  accountId: string,
+  namespaceId: string,
+  key: string
+) {
+  return await fetchResult(
+    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
+      key
+    )}`,
+    { method: "DELETE" }
+  );
+}
+
+/**
+ * Formatter for converting e.g. 5328 --> 5,328
+ */
+const formatNumber = new Intl.NumberFormat("en-US", {
+  notation: "standard",
+}).format;
+
+/**
+ * Helper function for bulk requests, logs ongoing output to console.
+ */
+function logBulkProgress(
+  operation: "put" | "delete",
+  index: number,
+  total: number
+) {
+  logger.log(
+    `${operation === "put" ? "Uploaded" : "Deleted"} ${Math.floor(
+      (100 * index) / total
+    )}% (${formatNumber(index)} out of ${formatNumber(total)})`
+  );
+}
+
+export async function putKVBulkKeyValue(
   accountId: string,
   namespaceId: string,
   keyValues: KeyValue[],
-  progressCallback: (index: number, total: number) => void
+  quiet = false
 ) {
   for (let index = 0; index < keyValues.length; index += BATCH_KEY_MAX) {
-    if (progressCallback && keyValues.length > BATCH_KEY_MAX) {
-      progressCallback(index, keyValues.length);
+    if (!quiet && keyValues.length > BATCH_KEY_MAX) {
+      logBulkProgress("put", index, keyValues.length);
     }
 
     await fetchResult(
@@ -185,20 +273,21 @@ export async function putBulkKeyValue(
       }
     );
   }
-  if (progressCallback && keyValues.length > BATCH_KEY_MAX) {
-    progressCallback(keyValues.length, keyValues.length);
+
+  if (!quiet && keyValues.length > BATCH_KEY_MAX) {
+    logBulkProgress("put", keyValues.length, keyValues.length);
   }
 }
 
-export async function deleteBulkKeyValue(
+export async function deleteKVBulkKeyValue(
   accountId: string,
   namespaceId: string,
   keys: string[],
-  progressCallback: (index: number, total: number) => void
+  quiet = false
 ) {
   for (let index = 0; index < keys.length; index += BATCH_KEY_MAX) {
-    if (progressCallback && keys.length > BATCH_KEY_MAX) {
-      progressCallback(index, keys.length);
+    if (!quiet && keys.length > BATCH_KEY_MAX) {
+      logBulkProgress("delete", index, keys.length);
     }
 
     await fetchResult(
@@ -210,12 +299,12 @@ export async function deleteBulkKeyValue(
       }
     );
   }
-  if (progressCallback && keys.length > BATCH_KEY_MAX) {
-    progressCallback(keys.length, keys.length);
+  if (!quiet && keys.length > BATCH_KEY_MAX) {
+    logBulkProgress("delete", keys.length, keys.length);
   }
 }
 
-export function getNamespaceId(
+export function getKVNamespaceId(
   { preview, binding, "namespace-id": namespaceId }: KvArgs,
   config: Config
 ): string {
@@ -310,7 +399,7 @@ export function getNamespaceId(
 /**
  * KV namespace binding names must be valid JS identifiers.
  */
-export function isValidNamespaceBinding(
+export function isValidKVNamespaceBinding(
   binding: string | undefined
 ): binding is string {
   return (

package/src/open-in-browser.ts

@@ -8,19 +8,12 @@ import { logger } from "./logger";
  * StackBlitz, remote servers), it doesn't just crash the process.
  *
  * @param url the URL to point the browser at
- * @param options open a Chromium-based browser instead of the default
  */
-export default async function openInBrowser(
-  url: string,
-  { forceChromium }: { forceChromium: boolean } = { forceChromium: false }
-): Promise<void> {
-  const options: open.Options | undefined = forceChromium
-    ? {
-        app: [{ name: open.apps.chrome }, { name: open.apps.edge }],
-      }
-    : undefined;
-  const childProcess = await open(url, options);
+export default async function openInBrowser(url: string): Promise<void> {
+  const errorMessage = `Failed to open ${url} in a browser`;
+
+  const childProcess = await open(url);
   childProcess.on("error", () => {
-    logger.warn(`Failed to open ${url} in a browser.`);
+    logger.warn(errorMessage);
   });
 }

package/src/package-manager.ts

@@ -5,15 +5,20 @@ import { logger } from "./logger";
 
 export interface PackageManager {
   cwd: string;
-  type: "npm" | "yarn";
+  type: "npm" | "yarn" | "pnpm";
   addDevDeps(...packages: string[]): Promise<void>;
   install(): Promise<void>;
 }
 
 export async function getPackageManager(cwd: string): Promise<PackageManager> {
-  const [hasYarn, hasNpm] = await Promise.all([supportsYarn(), supportsNpm()]);
+  const [hasYarn, hasNpm, hasPnpm] = await Promise.all([
+    supportsYarn(),
+    supportsNpm(),
+    supportsPnpm(),
+  ]);
   const hasYarnLock = existsSync(join(cwd, "yarn.lock"));
   const hasNpmLock = existsSync(join(cwd, "package-lock.json"));
+  const hasPnpmLock = existsSync(join(cwd, "pnpm-lock.yaml"));
 
   if (hasNpmLock) {
     if (hasNpm) {
@@ -28,6 +33,18 @@ export async function getPackageManager(cwd: string): Promise<PackageManager> {
       );
       return { ...YarnPackageManager, cwd };
     }
+  } else if (hasPnpmLock) {
+    if (hasPnpm) {
+      logger.log(
+        "Using pnpm as package manager, as there is already a pnpm-lock.yaml file."
+      );
+      return { ...PnpmPackageManager, cwd };
+    } else {
+      logger.warn(
+        "There is already a pnpm-lock.yaml file but could not find pnpm on the PATH."
+      );
+      // will simply fallback to the first found of [npm, yaml, pnpm] in the next if round.
+    }
   } else if (hasYarnLock) {
     if (hasYarn) {
       logger.log(
@@ -49,9 +66,12 @@ export async function getPackageManager(cwd: string): Promise<PackageManager> {
   } else if (hasYarn) {
     logger.log("Using yarn as package manager.");
     return { ...YarnPackageManager, cwd };
+  } else if (hasPnpm) {
+    logger.log("Using pnpm as package manager.");
+    return { ...PnpmPackageManager, cwd };
   } else {
     throw new Error(
-      "Unable to find a package manager. Supported managers are: npm and yarn."
+      "Unable to find a package manager. Supported managers are: npm, yarn, and pnpm."
     );
   }
 }
@@ -86,6 +106,29 @@ const NpmPackageManager: PackageManager = {
   },
 };
 
+/**
+ * Manage packages using pnpm
+ */
+const PnpmPackageManager: PackageManager = {
+  cwd: process.cwd(),
+  type: "pnpm",
+  /** Add and install a new devDependency into the local package.json. */
+  async addDevDeps(...packages: string[]): Promise<void> {
+    await execa("pnpm", ["install", ...packages, "--save-dev"], {
+      stdio: "inherit",
+      cwd: this.cwd,
+    });
+  },
+
+  /** Install all the dependencies in the local package.json. */
+  async install(): Promise<void> {
+    await execa("pnpm", ["install"], {
+      stdio: "inherit",
+      cwd: this.cwd,
+    });
+  },
+};
+
 /**
  * Manage packages using yarn
  */
@@ -125,3 +168,7 @@ function supportsYarn(): Promise<boolean> {
 function supportsNpm(): Promise<boolean> {
   return supports("npm");
 }
+
+function supportsPnpm(): Promise<boolean> {
+  return supports("pnpm");
+}