wrangler 0.0.0-ece06ea → 0.0.0-ecfbb0c

package/src/whoami.tsx

@@ -0,0 +1,90 @@
+import { Text, render } from "ink";
+import Table from "ink-table";
+import React from "react";
+import { fetchListResult, fetchResult } from "./cfetch";
+import { logger } from "./logger";
+import { getAPIToken, getAuthFromEnv } from "./user";
+
+export async function whoami() {
+	logger.log("Getting User settings...");
+	const user = await getUserInfo();
+	render(<WhoAmI user={user}></WhoAmI>);
+}
+
+export function WhoAmI({ user }: { user: UserInfo | undefined }) {
+	return user ? (
+		<>
+			<Email tokenType={user.authType} email={user.email}></Email>
+			<Accounts accounts={user.accounts}></Accounts>
+		</>
+	) : (
+		<Text>You are not authenticated. Please run `wrangler login`.</Text>
+	);
+}
+
+function Email(props: { tokenType: string; email: string | undefined }) {
+	return props.email === undefined ? (
+		<Text>
+			👋 You are logged in with an {props.tokenType}. Unable to retrieve email
+			for this user. Are you missing the `User-&gt;User Details-&gt;Read`
+			permission?
+		</Text>
+	) : (
+		<Text>
+			👋 You are logged in with an {props.tokenType}, associated with the email
+			&apos;{props.email}&apos;!
+		</Text>
+	);
+}
+
+function Accounts(props: { accounts: AccountInfo[] }) {
+	const accounts = props.accounts.map((account) => ({
+		"Account Name": account.name,
+		"Account ID": account.id,
+	}));
+	return <Table data={accounts}></Table>;
+}
+
+export interface UserInfo {
+	apiToken: string;
+	authType: string;
+	email: string | undefined;
+	accounts: AccountInfo[];
+}
+
+export async function getUserInfo(): Promise<UserInfo | undefined> {
+	const apiToken = getAPIToken();
+	if (!apiToken) return;
+
+	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(),
+	};
+}
+
+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");
+}

package/src/worker.ts

@@ -0,0 +1,185 @@
+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: ApiCredentials;
+	/**
+	 * An account ID.
+	 */
+	accountId: string;
+}
+
+/**
+ * The type of Worker
+ */
+export type CfScriptFormat = "modules" | "service-worker";
+
+/**
+ * A module type.
+ */
+export type CfModuleType =
+	| "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;
+}
+
+/**
+ * A map of variable names to values.
+ */
+interface CfVars {
+	[key: string]: unknown;
+}
+
+/**
+ * A KV namespace.
+ */
+interface CfKvNamespace {
+	binding: string;
+	id: string;
+}
+
+/**
+ * A binding to a wasm module (in service-worker format)
+ */
+
+interface CfWasmModuleBindings {
+	[key: string]: string;
+}
+
+/**
+ * A binding to a text blob (in service-worker format)
+ */
+
+interface CfTextBlobBindings {
+	[key: string]: string;
+}
+
+/**
+ * A binding to a data blob (in service-worker format)
+ */
+
+interface CfDataBlobBindings {
+	[key: string]: string;
+}
+
+/**
+ * A Durable Object.
+ */
+interface CfDurableObject {
+	name: string;
+	class_name: string;
+	script_name?: string;
+	environment?: string;
+}
+
+interface CfR2Bucket {
+	binding: string;
+	bucket_name: string;
+}
+
+interface CfService {
+	binding: string;
+	service: string;
+	environment?: string;
+}
+
+interface CfUnsafeBinding {
+	name: string;
+	type: string;
+}
+
+export interface CfDurableObjectMigrations {
+	old_tag?: string;
+	new_tag: string;
+	steps: {
+		new_classes?: string[];
+		renamed_classes?: {
+			from: string;
+			to: string;
+		}[];
+		deleted_classes?: string[];
+	}[];
+}
+
+/**
+ * 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;
+}
+
+export interface CfWorkerContext {
+	env: string | undefined;
+	legacyEnv: boolean | undefined;
+	zone: string | undefined;
+	host: string | undefined;
+	routes: Route[] | undefined;
+}

package/src/zones.ts

@@ -0,0 +1,76 @@
+import { fetchListResult } from "./cfetch";
+import type { Route } from "./config/environment";
+
+/**
+ * An object holding information about a zone for publishing.
+ */
+export interface Zone {
+	id: string;
+	host: string;
+}
+
+export function getHostFromRoute(route: Route): string | undefined {
+	return typeof route === "string"
+		? getHostFromUrl(route)
+		: typeof route === "object"
+		? "zone_name" in route
+			? getHostFromUrl(route.zone_name)
+			: getHostFromUrl(route.pattern)
+		: undefined;
+}
+
+/**
+ * Try to compute the a zone ID and host name for one or more routes.
+ *
+ * When we're given a route, we do 2 things:
+ * - We try to extract a host from it
+ * - We try to get a zone id from the host
+ */
+export async function getZoneForRoute(route: Route): Promise<Zone | undefined> {
+	const host = getHostFromRoute(route);
+	const id =
+		typeof route === "object" && "zone_id" in route
+			? route.zone_id
+			: host
+			? await getZoneIdFromHost(host)
+			: undefined;
+	return id && host ? { id, host } : undefined;
+}
+
+/**
+ * Given something that resembles a URL, try to extract a host from it.
+ */
+function getHostFromUrl(urlLike: string): string | undefined {
+	// strip leading * / *.
+	urlLike = urlLike.replace(/^\*(\.)?/g, "");
+
+	if (!(urlLike.startsWith("http://") || urlLike.startsWith("https://"))) {
+		urlLike = "http://" + urlLike;
+	}
+	return new URL(urlLike).host;
+}
+
+/**
+ * Given something that resembles a host, try to infer a zone id from it.
+ *
+ * It's hard to get a 'valid' domain from a string, so we don't even try to validate TLDs, etc.
+ * For each domain-like part of the host (e.g. w.x.y.z) try to get a zone id for it by
+ * lopping off subdomains until we get a hit from the API.
+ */
+export async function getZoneIdFromHost(host: string): Promise<string> {
+	const hostPieces = host.split(".");
+
+	while (hostPieces.length > 1) {
+		const zones = await fetchListResult<{ id: string }>(
+			`/zones`,
+			{},
+			new URLSearchParams({ name: hostPieces.join(".") })
+		);
+		if (zones.length > 0) {
+			return zones[0].id;
+		}
+		hostPieces.shift();
+	}
+
+	throw new Error(`Could not find zone for ${host}`);
+}

package/templates/checked-fetch.js

@@ -0,0 +1,17 @@
+const urls = new Set();
+
+export function checkedFetch(request, init) {
+	const url = new URL(
+		(typeof request === "string" ? new Request(request, init) : request).url
+	);
+	if (url.port && url.port !== "443" && url.protocol === "https:") {
+		if (!urls.has(url.toString())) {
+			urls.add(url.toString());
+			console.warn(
+				`WARNING: known issue with \`fetch()\` requests to custom HTTPS ports in published Workers:\n` +
+					` - ${url.toString()} - the custom port will be ignored when the Worker is published using the \`wrangler publish\` command.\n`
+			);
+		}
+	}
+	return globalThis.fetch(request, init);
+}

package/templates/gitignore

@@ -0,0 +1,171 @@
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*
+
+# wrangler project
+
+.dev.vars

package/templates/new-worker-scheduled.js

@@ -0,0 +1,17 @@
+/**
+ * Welcome to Cloudflare Workers! This is your first scheduled worker.
+ *
+ * - Run `wrangler dev --local` in your terminal to start a development server
+ * - Run `curl "http://localhost:8787/cdn-cgi/mf/scheduled"` to trigger the scheduled event
+ * - Go back to the console to see what your worker has logged
+ * - Update the Cron trigger in wrangler.toml (see https://developers.cloudflare.com/workers/wrangler/configuration/#triggers)
+ * - Run `wrangler publish --name my-worker` to publish your worker
+ *
+ * Learn more at https://developers.cloudflare.com/workers/runtime-apis/scheduled-event/
+ */
+
+export default {
+	async scheduled(controller, env, ctx) {
+		console.log(`Hello World!`);
+	},
+};

package/templates/new-worker-scheduled.ts

@@ -0,0 +1,32 @@
+/**
+ * Welcome to Cloudflare Workers! This is your first scheduled worker.
+ *
+ * - Run `wrangler dev --local` in your terminal to start a development server
+ * - Run `curl "http://localhost:8787/cdn-cgi/mf/scheduled"` to trigger the scheduled event
+ * - Go back to the console to see what your worker has logged
+ * - Update the Cron trigger in wrangler.toml (see https://developers.cloudflare.com/workers/wrangler/configuration/#triggers)
+ * - Run `wrangler publish --name my-worker` to publish your worker
+ *
+ * Learn more at https://developers.cloudflare.com/workers/runtime-apis/scheduled-event/
+ */
+
+export interface Env {
+	// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
+	// MY_KV_NAMESPACE: KVNamespace;
+	//
+	// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
+	// MY_DURABLE_OBJECT: DurableObjectNamespace;
+	//
+	// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
+	// MY_BUCKET: R2Bucket;
+}
+
+export default {
+	async scheduled(
+		controller: ScheduledController,
+		env: Env,
+		ctx: ExecutionContext
+	): Promise<void> {
+		console.log(`Hello World!`);
+	},
+};

package/templates/new-worker.js

@@ -0,0 +1,15 @@
+/**
+ * Welcome to Cloudflare Workers! This is your first worker.
+ *
+ * - Run `npx wrangler dev src/index.js` in your terminal to start a development server
+ * - Open a browser tab at http://localhost:8787/ to see your worker in action
+ * - Run `npx wrangler publish src/index.js --name my-worker` to publish your worker
+ *
+ * Learn more at https://developers.cloudflare.com/workers/
+ */
+
+export default {
+	async fetch(request) {
+		return new Response("Hello World!");
+	},
+};

package/templates/new-worker.ts

@@ -0,0 +1,30 @@
+/**
+ * Welcome to Cloudflare Workers! This is your first worker.
+ *
+ * - Run `wrangler dev src/index.ts` in your terminal to start a development server
+ * - Open a browser tab at http://localhost:8787/ to see your worker in action
+ * - Run `wrangler publish src/index.ts --name my-worker` to publish your worker
+ *
+ * Learn more at https://developers.cloudflare.com/workers/
+ */
+
+export interface Env {
+	// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
+	// MY_KV_NAMESPACE: KVNamespace;
+	//
+	// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
+	// MY_DURABLE_OBJECT: DurableObjectNamespace;
+	//
+	// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
+	// MY_BUCKET: R2Bucket;
+}
+
+export default {
+	async fetch(
+		request: Request,
+		env: Env,
+		ctx: ExecutionContext
+	): Promise<Response> {
+		return new Response("Hello World!");
+	},
+};

package/templates/no-op-worker.js

@@ -0,0 +1,10 @@
+export default {
+	fetch() {
+		return new Response("Not found", {
+			status: 404,
+			headers: {
+				"Content-Type": "text/html",
+			},
+		});
+	},
+};