wrangler 0.0.0-e64812e → 0.0.0-e6c71262

package/src/utils/collectKeyValues.ts

@@ -0,0 +1,14 @@
+/**
+ * a function that takes an array of strings in `key:value` format
+ * (typically from yargs or config) and returns back
+ * a neat object with the keys and values
+ */
+export function collectKeyValues(array?: string[]) {
+	return (
+		array?.reduce<Record<string, string>>((recordsToCollect, v) => {
+			const [key, ...value] = v.split(":");
+			recordsToCollect[key] = value.join(":");
+			return recordsToCollect;
+		}, {}) || {}
+	);
+}

package/src/utils/render.ts

@@ -0,0 +1,93 @@
+import { EventEmitter } from "events";
+import { render as inkRender } from "ink";
+import type { ReactElement } from "react";
+import type { WriteStream } from "tty";
+
+export function renderToString(tree: ReactElement): string {
+	const { output, cleanup } = render(tree);
+	cleanup();
+	return output;
+}
+
+// The code below is mostly copied from ink-render-string.
+// See https://github.com/zhanwang626/ink-render-string.git.
+
+// MIT License
+
+// Copyright (c) 2021 Zhan Wang
+
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+interface Instance {
+	output: string;
+	unmount: () => void;
+	cleanup: () => void;
+	stdout: OutputStream;
+	stderr: OutputStream;
+	frames: string[];
+}
+
+const LASTFRAME_UNDEFINED = "value of stdout.lastframe() is undefined";
+
+export class OutputStream extends EventEmitter {
+	readonly frames: string[] = [];
+	private _lastFrame?: string;
+
+	get columns(): number {
+		return this._originalStream.columns;
+	}
+	get rows(): number {
+		return this._originalStream.rows;
+	}
+
+	constructor(private _originalStream: WriteStream) {
+		super();
+	}
+
+	write = (frame: string) => {
+		this.frames.push(frame);
+		this._lastFrame = frame;
+	};
+
+	lastFrame = () => {
+		return this._lastFrame;
+	};
+}
+
+export const render = (tree: ReactElement): Instance => {
+	const stdout = new OutputStream(process.stdout);
+	const stderr = new OutputStream(process.stderr);
+
+	const instance = inkRender(tree, {
+		stdout: stdout as unknown as WriteStream,
+		stderr: stderr as unknown as WriteStream,
+		debug: true,
+		exitOnCtrlC: false,
+		patchConsole: false,
+	});
+
+	return {
+		output: stdout.lastFrame() ?? LASTFRAME_UNDEFINED,
+		stdout,
+		stderr,
+		cleanup: instance.cleanup,
+		unmount: instance.unmount,
+		frames: stdout.frames,
+	};
+};

package/src/whoami.ts

@@ -0,0 +1,135 @@
+import chalk from "chalk";
+import { fetchListResult, fetchResult } from "./cfetch";
+import { logger } from "./logger";
+import { getAPIToken, getAuthFromEnv, getScopes } from "./user";
+
+export async function whoami() {
+	logger.log("Getting User settings...");
+	const user = await getUserInfo();
+	if (user === undefined) {
+		return void logger.log(
+			"You are not authenticated. Please run `wrangler login`."
+		);
+	}
+
+	if (user.email !== undefined) {
+		logger.log(
+			`👋 You are logged in with an ${
+				user.authType
+			}, associated with the email ${chalk.blue(user.email)}!`
+		);
+	} else {
+		logger.log(
+			`👋 You are logged in with an ${user.authType}. Unable to retrieve email for this user. Are you missing the \`User->User Details->Read\` permission?`
+		);
+	}
+	logger.table(
+		user.accounts.map((account) => ({
+			"Account Name": account.name,
+			"Account ID": account.id,
+		}))
+	);
+	const permissions =
+		user.tokenPermissions?.map((scope) => scope.split(":")) ?? [];
+
+	if (user.authType !== "OAuth Token") {
+		return void logger.log(
+			`🔓 To see token permissions visit https://dash.cloudflare.com/profile/api-tokens`
+		);
+	}
+	logger.log(
+		`🔓 Token Permissions: If scopes are missing, you may need to logout and re-login.`
+	);
+	logger.log(`Scope (Access)`);
+	for (const [scope, access] of permissions) {
+		logger.log(`- ${scope} ${access ? `(${access})` : ``}`);
+	}
+}
+
+type AuthType = "Global API Key" | "API Token" | "OAuth Token";
+export interface UserInfo {
+	apiToken: string;
+	authType: AuthType;
+	email: string | undefined;
+	accounts: AccountInfo[];
+	tokenPermissions: string[] | undefined;
+}
+
+export async function getUserInfo(): Promise<UserInfo | undefined> {
+	const apiToken = getAPIToken();
+	if (!apiToken) return;
+
+	const tokenPermissions = await getTokenPermissions();
+
+	const usingEnvAuth = !!getAuthFromEnv();
+	const usingGlobalAuthKey = "authKey" in apiToken;
+	return {
+		apiToken: usingGlobalAuthKey ? apiToken.authKey : apiToken.apiToken,
+		authType: usingGlobalAuthKey
+			? "Global API Key"
+			: usingEnvAuth
+			? "API Token"
+			: "OAuth Token",
+		email: "authEmail" in apiToken ? apiToken.authEmail : await getEmail(),
+		accounts: await getAccounts(),
+		tokenPermissions,
+	};
+}
+
+async function getEmail(): Promise<string | undefined> {
+	try {
+		const { email } = await fetchResult<{ email: string }>("/user");
+		return email;
+	} catch (e) {
+		if ((e as { code?: number }).code === 9109) {
+			return undefined;
+		} else {
+			throw e;
+		}
+	}
+}
+
+type AccountInfo = { name: string; id: string };
+
+async function getAccounts(): Promise<AccountInfo[]> {
+	return await fetchListResult<AccountInfo>("/accounts");
+}
+
+async function getTokenPermissions(): Promise<string[] | undefined> {
+	// Tokens can either be API tokens or Oauth tokens.
+	// Here we only extract permissions from OAuth tokens.
+
+	return getScopes() as string[];
+
+	// In future we may be able to get the token permissions on an API token,
+	// but currently we cannot as that permission is not able to be added to
+	// an API token.
+
+	// try {
+	// 	// First we get the token identifier (only returned on API tokens)
+	// 	const { id } = await fetchResult<{ id: string }>("/user/tokens/verify");
+
+	// 	// Get the token permissions for the current token
+	// 	const { policies } = await fetchResult<{
+	// 		policies: { id: string; name: string }[];
+	// 	}>(`/user/tokens/${id}`);
+
+	// 	return policies.map((p) => p.name);
+	// } catch (e) {
+	// 	if ((e as { code?: number }).code === 1000) {
+	// 		// Invalid token - Oauth token
+
+	// 		// Get scopes
+	// 		const scopes = getScopes() as string[];
+	// 		// We may not get scopes back if they are not currently cached,
+	// 		// however next time an access token is requested,
+	// 		// the scopes will be added to the cache.
+	// 		return scopes;
+	// 	} else if ((e as { code?: number }).code === 9109) {
+	// 		// Token cannot view its permissions
+	// 		return undefined;
+	// 	} else {
+	// 		throw e;
+	// 	}
+	// }
+}

package/src/worker.ts

@@ -1,17 +1,22 @@
+import type { Environment } from "./config";
+import type { Route } from "./config/environment";
+import type { ApiCredentials } from "./user";
+
 /**
  * A Cloudflare account.
  */
+
 export interface CfAccount {
-  /**
-   * An API token.
-   *
-   * @link https://api.cloudflare.com/#user-api-tokens-properties
-   */
-  apiToken: string;
-  /**
-   * An account ID.
-   */
-  accountId: string;
+	/**
+	 * An API token.
+	 *
+	 * @link https://api.cloudflare.com/#user-api-tokens-properties
+	 */
+	apiToken: ApiCredentials;
+	/**
+	 * An account ID.
+	 */
+	accountId: string;
 }
 
 /**
@@ -23,158 +28,267 @@ export type CfScriptFormat = "modules" | "service-worker";
  * A module type.
  */
 export type CfModuleType =
-  | "esm"
-  | "commonjs"
-  | "compiled-wasm"
-  | "text"
-  | "buffer";
+	| "esm"
+	| "commonjs"
+	| "compiled-wasm"
+	| "text"
+	| "buffer";
 
 /**
  * An imported module.
  */
 export interface CfModule {
-  /**
-   * The module name.
-   *
-   * @example
-   * './src/index.js'
-   */
-  name: string;
-  /**
-   * The module content, usually JavaScript or WASM code.
-   *
-   * @example
-   * export default {
-   *   async fetch(request) {
-   *     return new Response('Ok')
-   *   }
-   * }
-   */
-  content: string | Buffer;
-  /**
-   * The module type.
-   *
-   * If absent, will default to the main module's type.
-   */
-  type?: CfModuleType;
+	/**
+	 * The module name.
+	 *
+	 * @example
+	 * './src/index.js'
+	 */
+	name: string;
+	/**
+	 * The module content, usually JavaScript or WASM code.
+	 *
+	 * @example
+	 * export default {
+	 *   async fetch(request) {
+	 *     return new Response('Ok')
+	 *   }
+	 * }
+	 */
+	content: string | Buffer;
+	/**
+	 * The module type.
+	 *
+	 * If absent, will default to the main module's type.
+	 */
+	type?: CfModuleType;
 }
 
 /**
  * A map of variable names to values.
  */
-interface CfVars {
-  [key: string]: unknown;
+export interface CfVars {
+	[key: string]: unknown;
 }
 
 /**
  * A KV namespace.
  */
-interface CfKvNamespace {
-  binding: string;
-  id: string;
+export interface CfKvNamespace {
+	binding: string;
+	id: string;
+}
+
+/**
+ * A binding to send email.
+ */
+export interface CfSendEmailBindings {
+	name: string;
+	destination_address?: string;
+	allowed_destination_addresses?: string[];
 }
 
 /**
  * A binding to a wasm module (in service-worker format)
  */
 
-interface CfWasmModuleBindings {
-  [key: string]: string;
+export interface CfWasmModuleBindings {
+	[key: string]: string;
 }
 
 /**
  * A binding to a text blob (in service-worker format)
  */
 
-interface CfTextBlobBindings {
-  [key: string]: string;
+export interface CfTextBlobBindings {
+	[key: string]: string;
+}
+
+/**
+ * A binding to a browser
+ */
+
+export interface CfBrowserBinding {
+	binding: string;
 }
 
 /**
  * A binding to a data blob (in service-worker format)
  */
 
-interface CfDataBlobBindings {
-  [key: string]: string;
+export interface CfDataBlobBindings {
+	[key: string]: string;
 }
 
 /**
  * A Durable Object.
  */
-interface CfDurableObject {
-  name: string;
-  class_name: string;
-  script_name?: string;
-  environment?: string;
+export interface CfDurableObject {
+	name: string;
+	class_name: string;
+	script_name?: string;
+	environment?: string;
+}
+
+export interface CfQueue {
+	binding: string;
+	queue_name: string;
 }
 
-interface CfR2Bucket {
-  binding: string;
-  bucket_name: string;
+export interface CfR2Bucket {
+	binding: string;
+	bucket_name: string;
+}
+
+export const D1_BETA_PREFIX = `__D1_BETA__` as const;
+export type D1PrefixedBinding = `${typeof D1_BETA_PREFIX}${string}`;
+
+// TODO: figure out if this is duplicated in packages/wrangler/src/config/environment.ts
+export interface CfD1Database {
+	// For now, all D1 bindings are alpha
+	binding: D1PrefixedBinding;
+	database_id: string;
+	database_name?: string;
+	preview_database_id?: string;
+	database_internal_env?: string;
+	migrations_table?: string;
+	migrations_dir?: string;
+}
+
+export interface CfConstellation {
+	binding: string;
+	project_id: string;
 }
 
 interface CfService {
-  binding: string;
-  service: string;
-  environment?: string;
+	binding: string;
+	service: string;
+	environment?: string;
+}
+
+interface CfAnalyticsEngineDataset {
+	binding: string;
+	dataset?: string;
+}
+
+interface CfDispatchNamespace {
+	binding: string;
+	namespace: string;
+}
+
+interface CfMTlsCertificate {
+	binding: string;
+	certificate_id: string;
+}
+
+interface CfLogfwdr {
+	schema: string | undefined;
+	bindings: CfLogfwdrBinding[];
+}
+
+interface CfLogfwdrBinding {
+	name: string;
+	destination: string;
 }
 
 interface CfUnsafeBinding {
-  name: string;
-  type: string;
+	name: string;
+	type: string;
+}
+
+type CfUnsafeMetadata = Record<string, unknown>;
+
+interface CfUnsafe {
+	bindings: CfUnsafeBinding[] | undefined;
+	metadata: CfUnsafeMetadata | undefined;
 }
 
 export interface CfDurableObjectMigrations {
-  old_tag?: string;
-  new_tag: string;
-  steps: {
-    new_classes?: string[];
-    renamed_classes?: {
-      from: string;
-      to: string;
-    }[];
-    deleted_classes?: string[];
-  }[];
+	old_tag?: string;
+	new_tag: string;
+	steps: {
+		new_classes?: string[];
+		renamed_classes?: {
+			from: string;
+			to: string;
+		}[];
+		deleted_classes?: string[];
+	}[];
+}
+
+export interface CfPlacement {
+	mode: "smart";
 }
 
 /**
  * Options for creating a `CfWorker`.
  */
 export interface CfWorkerInit {
-  /**
-   * The name of the worker.
-   */
-  name: string | undefined;
-  /**
-   * The entrypoint module.
-   */
-  main: CfModule;
-  /**
-   * The list of additional modules.
-   */
-  modules: CfModule[] | undefined;
-  /**
-   * All the bindings
-   */
-  bindings: {
-    vars: CfVars | undefined;
-    kv_namespaces: CfKvNamespace[] | undefined;
-    wasm_modules: CfWasmModuleBindings | undefined;
-    text_blobs: CfTextBlobBindings | undefined;
-    data_blobs: CfDataBlobBindings | undefined;
-    durable_objects: { bindings: CfDurableObject[] } | undefined;
-    r2_buckets: CfR2Bucket[] | undefined;
-    services: CfService[] | undefined;
-    unsafe: CfUnsafeBinding[] | undefined;
-  };
-  migrations: CfDurableObjectMigrations | undefined;
-  compatibility_date: string | undefined;
-  compatibility_flags: string[] | undefined;
-  usage_model: "bundled" | "unbound" | undefined;
+	/**
+	 * The name of the worker.
+	 */
+	name: string | undefined;
+	/**
+	 * The entrypoint module.
+	 */
+	main: CfModule;
+	/**
+	 * The list of additional modules.
+	 */
+	modules: CfModule[] | undefined;
+	/**
+	 * All the bindings
+	 */
+	bindings: {
+		vars: CfVars | undefined;
+		kv_namespaces: CfKvNamespace[] | undefined;
+		send_email: CfSendEmailBindings[] | undefined;
+		wasm_modules: CfWasmModuleBindings | undefined;
+		text_blobs: CfTextBlobBindings | undefined;
+		browser: CfBrowserBinding | undefined;
+		data_blobs: CfDataBlobBindings | undefined;
+		durable_objects: { bindings: CfDurableObject[] } | undefined;
+		queues: CfQueue[] | undefined;
+		r2_buckets: CfR2Bucket[] | undefined;
+		d1_databases: CfD1Database[] | undefined;
+		constellation: CfConstellation[] | undefined;
+		services: CfService[] | undefined;
+		analytics_engine_datasets: CfAnalyticsEngineDataset[] | undefined;
+		dispatch_namespaces: CfDispatchNamespace[] | undefined;
+		mtls_certificates: CfMTlsCertificate[] | undefined;
+		logfwdr: CfLogfwdr | undefined;
+		unsafe: CfUnsafe | undefined;
+	};
+	migrations: CfDurableObjectMigrations | undefined;
+	compatibility_date: string | undefined;
+	compatibility_flags: string[] | undefined;
+	usage_model: "bundled" | "unbound" | undefined;
+	keepVars: boolean | undefined;
+	logpush: boolean | undefined;
+	placement: CfPlacement | undefined;
 }
 
 export interface CfWorkerContext {
-  env: string | undefined;
-  legacyEnv: boolean | undefined;
-  zone: { id: string; host: string } | undefined;
+	env: string | undefined;
+	legacyEnv: boolean | undefined;
+	zone: string | undefined;
+	host: string | undefined;
+	routes: Route[] | undefined;
+	sendMetrics: boolean | undefined;
+}
+
+// Prefix binding with identifier which will then get picked up by the D1 shim.
+// Once the D1 Api is out of beta, this function can be removed.
+export function identifyD1BindingsAsBeta(
+	dbs: Environment["d1_databases"]
+): CfD1Database[] | undefined {
+	return dbs?.map((db) => ({
+		...db,
+		binding: `${D1_BETA_PREFIX}${db.binding}`,
+	}));
+}
+
+// Remove beta prefix
+export function removeD1BetaPrefix(binding: D1PrefixedBinding): string {
+	return binding.slice(D1_BETA_PREFIX.length);
 }

package/src/yargs-types.ts

@@ -0,0 +1,37 @@
+import type { OnlyCamelCase } from "./config/config";
+import type { ArgumentsCamelCase, Argv } from "yargs";
+
+/**
+ * Yargs options included in every wrangler command.
+ */
+export interface CommonYargsOptions {
+	v: boolean | undefined;
+	config: string | undefined;
+	env: string | undefined;
+	"experimental-json-config": boolean | undefined;
+}
+
+export type CommonYargsArgv = Argv<CommonYargsOptions>;
+
+export type YargvToInterface<T> = T extends Argv<infer P>
+	? ArgumentsCamelCase<P>
+	: never;
+
+// See http://stackoverflow.com/questions/51465182/how-to-remove-index-signature-using-mapped-types
+type RemoveIndex<T> = {
+	[K in keyof T as string extends K
+		? never
+		: number extends K
+		? never
+		: K]: T[K];
+};
+
+/**
+ * Given some Yargs Options function factory, extract the interface
+ * that corresponds to the yargs arguments, remove index types, and only allow camelCase
+ */
+export type StrictYargsOptionsToInterface<
+	T extends (yargs: CommonYargsArgv) => Argv
+> = T extends (yargs: CommonYargsArgv) => Argv<infer P>
+	? OnlyCamelCase<RemoveIndex<ArgumentsCamelCase<P>>>
+	: never;