wrangler 0.0.0-e6733a3 → 0.0.0-e9307365

package/src/pages/index.tsx

@@ -0,0 +1,84 @@
+/* eslint-disable no-shadow */
+
+import * as Build from "./build";
+import * as Deployments from "./deployments";
+import * as Dev from "./dev";
+import * as Projects from "./projects";
+import * as Publish from "./publish";
+import * as Upload from "./upload";
+import { CLEANUP, pagesBetaWarning } from "./utils";
+import type { BuilderCallback } from "yargs";
+
+process.on("SIGINT", () => {
+	CLEANUP();
+	process.exit();
+});
+process.on("SIGTERM", () => {
+	CLEANUP();
+	process.exit();
+});
+
+export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
+	return yargs
+		.command(
+			"dev [directory] [-- command..]",
+			"🧑‍💻 Develop your full-stack Pages application locally",
+			Dev.Options,
+			Dev.Handler
+		)
+		.command("functions", false, (yargs) =>
+			// we hide this command from help output because
+			// it's not meant to be used directly right now
+			{
+				return yargs.command(
+					"build [directory]",
+					"Compile a folder of Cloudflare Pages Functions into a single Worker",
+					Build.Options,
+					Build.Handler
+				);
+			}
+		)
+		.command("project", "⚡️ Interact with your Pages projects", (yargs) =>
+			yargs
+				.command(
+					"list",
+					"List your Cloudflare Pages projects",
+					Projects.ListOptions,
+					Projects.ListHandler
+				)
+				.command(
+					"create [project-name]",
+					"Create a new Cloudflare Pages project",
+					Projects.CreateOptions,
+					Projects.CreateHandler
+				)
+				.command("upload [directory]", false, Upload.Options, Upload.Handler)
+				.epilogue(pagesBetaWarning)
+		)
+		.command(
+			"deployment",
+			"🚀 Interact with the deployments of a project",
+			(yargs) =>
+				yargs
+					.command(
+						"list",
+						"List deployments in your Cloudflare Pages project",
+						Deployments.ListOptions,
+						Deployments.ListHandler
+					)
+					.command(
+						"create [directory]",
+						"🆙 Publish a directory of static assets as a Pages deployment",
+						Publish.Options,
+						Publish.Handler
+					)
+					.epilogue(pagesBetaWarning)
+		)
+		.command(
+			"publish [directory]",
+			"🆙 Publish a directory of static assets as a Pages deployment",
+			Publish.Options,
+			Publish.Handler
+		)
+		.epilogue(pagesBetaWarning);
+};

package/src/pages/projects.tsx

@@ -0,0 +1,163 @@
+import { execSync } from "node:child_process";
+import { render } from "ink";
+import Table from "ink-table";
+import React from "react";
+import { format as timeagoFormat } from "timeago.js";
+import { fetchResult } from "../cfetch";
+import { getConfigCache, saveToConfigCache } from "../config-cache";
+import { prompt } from "../dialogs";
+import { FatalError } from "../errors";
+import { logger } from "../logger";
+import * as metrics from "../metrics";
+import { requireAuth } from "../user";
+import { PAGES_CONFIG_CACHE_FILENAME } from "./constants";
+import { pagesBetaWarning } from "./utils";
+import type { PagesConfigCache, Project } from "./types";
+import type { ArgumentsCamelCase, Argv } from "yargs";
+
+// Empty object, as per eslint
+type ListArgs = Record<string, never>;
+
+export function ListOptions(yargs: Argv): Argv<ListArgs> {
+	return yargs.epilogue(pagesBetaWarning);
+}
+
+export async function ListHandler() {
+	const config = getConfigCache<PagesConfigCache>(PAGES_CONFIG_CACHE_FILENAME);
+
+	const accountId = await requireAuth(config);
+
+	const projects: Array<Project> = await listProjects({ accountId });
+
+	const data = projects.map((project) => {
+		return {
+			"Project Name": project.name,
+			"Project Domains": `${project.domains.join(", ")}`,
+			"Git Provider": project.source ? "Yes" : "No",
+			"Last Modified": project.latest_deployment
+				? timeagoFormat(project.latest_deployment.modified_on)
+				: timeagoFormat(project.created_on),
+		};
+	});
+
+	saveToConfigCache<PagesConfigCache>(PAGES_CONFIG_CACHE_FILENAME, {
+		account_id: accountId,
+	});
+
+	const { unmount } = render(<Table data={data}></Table>, {
+		patchConsole: false,
+	});
+	unmount();
+	await metrics.sendMetricsEvent("list pages projects");
+}
+
+export const listProjects = async ({
+	accountId,
+}: {
+	accountId: string;
+}): Promise<Array<Project>> => {
+	const pageSize = 10;
+	let page = 1;
+	const results = [];
+	while (results.length % pageSize === 0) {
+		const json: Array<Project> = await fetchResult(
+			`/accounts/${accountId}/pages/projects`,
+			{},
+			new URLSearchParams({
+				per_page: pageSize.toString(),
+				page: page.toString(),
+			})
+		);
+		page++;
+		results.push(...json);
+		if (json.length < pageSize) {
+			break;
+		}
+	}
+	return results;
+};
+
+type CreateArgs = {
+	"project-name": string;
+	"production-branch"?: string;
+};
+
+export function CreateOptions(yargs: Argv): Argv<CreateArgs> {
+	return yargs
+		.positional("project-name", {
+			type: "string",
+			demandOption: true,
+			description: "The name of your Pages project",
+		})
+		.options({
+			"production-branch": {
+				type: "string",
+				description: "The name of the production branch of your project",
+			},
+		})
+		.epilogue(pagesBetaWarning);
+}
+
+export async function CreateHandler({
+	productionBranch,
+	projectName,
+}: ArgumentsCamelCase<CreateArgs>) {
+	const config = getConfigCache<PagesConfigCache>(PAGES_CONFIG_CACHE_FILENAME);
+	const accountId = await requireAuth(config);
+
+	const isInteractive = process.stdin.isTTY;
+	if (!projectName && isInteractive) {
+		projectName = await prompt("Enter the name of your new project:");
+	}
+
+	if (!projectName) {
+		throw new FatalError("Must specify a project name.", 1);
+	}
+
+	if (!productionBranch && isInteractive) {
+		let isGitDir = true;
+		try {
+			execSync(`git rev-parse --is-inside-work-tree`, {
+				stdio: "ignore",
+			});
+		} catch (err) {
+			isGitDir = false;
+		}
+
+		productionBranch = await prompt(
+			"Enter the production branch name:",
+			"text",
+			isGitDir
+				? execSync(`git rev-parse --abbrev-ref HEAD`).toString().trim()
+				: "production"
+		);
+	}
+
+	if (!productionBranch) {
+		throw new FatalError("Must specify a production branch.", 1);
+	}
+
+	const { subdomain } = await fetchResult<Project>(
+		`/accounts/${accountId}/pages/projects`,
+		{
+			method: "POST",
+			body: JSON.stringify({
+				name: projectName,
+				production_branch: productionBranch,
+			}),
+		}
+	);
+
+	saveToConfigCache<PagesConfigCache>(PAGES_CONFIG_CACHE_FILENAME, {
+		account_id: accountId,
+		project_name: projectName,
+	});
+
+	logger.log(
+		`✨ Successfully created the '${projectName}' project. It will be available at https://${subdomain}/ once you create your first deployment.`
+	);
+	logger.log(
+		`To deploy a folder of assets, run 'wrangler pages publish [directory]'.`
+	);
+	await metrics.sendMetricsEvent("create pages project");
+}

package/src/pages/publish.tsx

@@ -0,0 +1,338 @@
+import { execSync } from "node:child_process";
+import { existsSync, readFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { dirname, join } from "node:path";
+import { cwd } from "node:process";
+import { render, Text } from "ink";
+import SelectInput from "ink-select-input";
+import React from "react";
+import { File, FormData } from "undici";
+import { fetchResult } from "../cfetch";
+import { getConfigCache, saveToConfigCache } from "../config-cache";
+import { prompt } from "../dialogs";
+import { FatalError } from "../errors";
+import { logger } from "../logger";
+import * as metrics from "../metrics";
+import { requireAuth } from "../user";
+import { buildFunctions } from "./build";
+import { PAGES_CONFIG_CACHE_FILENAME } from "./constants";
+import { listProjects } from "./projects";
+import { upload } from "./upload";
+import { pagesBetaWarning } from "./utils";
+import type { Deployment, PagesConfigCache, Project } from "./types";
+import type { ArgumentsCamelCase, Argv } from "yargs";
+
+type PublishArgs = {
+	directory: string;
+	"project-name"?: string;
+	branch?: string;
+	"commit-hash"?: string;
+	"commit-message"?: string;
+	"commit-dirty"?: boolean;
+};
+
+export function Options(yargs: Argv): Argv<PublishArgs> {
+	return yargs
+		.positional("directory", {
+			type: "string",
+			demandOption: true,
+			description: "The directory of static files to upload",
+		})
+		.options({
+			"project-name": {
+				type: "string",
+				description: "The name of the project you want to deploy to",
+			},
+			branch: {
+				type: "string",
+				description: "The name of the branch you want to deploy to",
+			},
+			"commit-hash": {
+				type: "string",
+				description: "The SHA to attach to this deployment",
+			},
+			"commit-message": {
+				type: "string",
+				description: "The commit message to attach to this deployment",
+			},
+			"commit-dirty": {
+				type: "boolean",
+				description:
+					"Whether or not the workspace should be considered dirty for this deployment",
+			},
+			config: {
+				describe: "Pages does not support wrangler.toml",
+				type: "string",
+				hidden: true,
+			},
+		})
+		.epilogue(pagesBetaWarning);
+}
+
+export const Handler = async ({
+	directory,
+	projectName,
+	branch,
+	commitHash,
+	commitMessage,
+	commitDirty,
+	config: wranglerConfig,
+}: ArgumentsCamelCase<PublishArgs>) => {
+	if (wranglerConfig) {
+		throw new FatalError("Pages does not support wrangler.toml", 1);
+	}
+
+	if (!directory) {
+		throw new FatalError("Must specify a directory.", 1);
+	}
+
+	const config = getConfigCache<PagesConfigCache>(PAGES_CONFIG_CACHE_FILENAME);
+	const accountId = await requireAuth(config);
+
+	projectName ??= config.project_name;
+
+	const isInteractive = process.stdin.isTTY;
+	if (!projectName && isInteractive) {
+		const projects = (await listProjects({ accountId })).filter(
+			(project) => !project.source
+		);
+
+		let existingOrNew: "existing" | "new" = "new";
+
+		if (projects.length > 0) {
+			existingOrNew = await new Promise<"new" | "existing">((resolve) => {
+				const { unmount } = render(
+					<>
+						<Text>
+							No project selected. Would you like to create one or use an
+							existing project?
+						</Text>
+						<SelectInput
+							items={[
+								{
+									key: "new",
+									label: "Create a new project",
+									value: "new",
+								},
+								{
+									key: "existing",
+									label: "Use an existing project",
+									value: "existing",
+								},
+							]}
+							onSelect={async (selected) => {
+								resolve(selected.value as "new" | "existing");
+								unmount();
+							}}
+						/>
+					</>
+				);
+			});
+		}
+
+		switch (existingOrNew) {
+			case "existing": {
+				projectName = await new Promise((resolve) => {
+					const { unmount } = render(
+						<>
+							<Text>Select a project:</Text>
+							<SelectInput
+								items={projects.map((project) => ({
+									key: project.name,
+									label: project.name,
+									value: project,
+								}))}
+								onSelect={async (selected) => {
+									resolve(selected.value.name);
+									unmount();
+								}}
+							/>
+						</>
+					);
+				});
+				break;
+			}
+			case "new": {
+				projectName = await prompt("Enter the name of your new project:");
+
+				if (!projectName) {
+					throw new FatalError("Must specify a project name.", 1);
+				}
+
+				let isGitDir = true;
+				try {
+					execSync(`git rev-parse --is-inside-work-tree`, {
+						stdio: "ignore",
+					});
+				} catch (err) {
+					isGitDir = false;
+				}
+
+				const productionBranch = await prompt(
+					"Enter the production branch name:",
+					"text",
+					isGitDir
+						? execSync(`git rev-parse --abbrev-ref HEAD`).toString().trim()
+						: "production"
+				);
+
+				if (!productionBranch) {
+					throw new FatalError("Must specify a production branch.", 1);
+				}
+
+				await fetchResult<Project>(`/accounts/${accountId}/pages/projects`, {
+					method: "POST",
+					body: JSON.stringify({
+						name: projectName,
+						production_branch: productionBranch,
+					}),
+				});
+
+				saveToConfigCache<PagesConfigCache>(PAGES_CONFIG_CACHE_FILENAME, {
+					account_id: accountId,
+					project_name: projectName,
+				});
+
+				logger.log(`✨ Successfully created the '${projectName}' project.`);
+				await metrics.sendMetricsEvent("create pages project");
+				break;
+			}
+		}
+	}
+
+	if (!projectName) {
+		throw new FatalError("Must specify a project name.", 1);
+	}
+
+	// We infer git info by default is not passed in
+
+	let isGitDir = true;
+	try {
+		execSync(`git rev-parse --is-inside-work-tree`, {
+			stdio: "ignore",
+		});
+	} catch (err) {
+		isGitDir = false;
+	}
+
+	let isGitDirty = false;
+
+	if (isGitDir) {
+		try {
+			isGitDirty = Boolean(
+				execSync(`git status --porcelain`).toString().length
+			);
+
+			if (!branch) {
+				branch = execSync(`git rev-parse --abbrev-ref HEAD`).toString().trim();
+			}
+
+			if (!commitHash) {
+				commitHash = execSync(`git rev-parse HEAD`).toString().trim();
+			}
+
+			if (!commitMessage) {
+				commitMessage = execSync(`git show -s --format=%B ${commitHash}`)
+					.toString()
+					.trim();
+			}
+		} catch (err) {}
+
+		if (isGitDirty && !commitDirty) {
+			logger.warn(
+				`Warning: Your working directory is a git repo and has uncommitted changes\nTo silence this warning, pass in --commit-dirty=true`
+			);
+		}
+
+		if (commitDirty === undefined) {
+			commitDirty = isGitDirty;
+		}
+	}
+
+	let builtFunctions: string | undefined = undefined;
+	const functionsDirectory = join(cwd(), "functions");
+	if (existsSync(functionsDirectory)) {
+		const outfile = join(tmpdir(), `./functionsWorker-${Math.random()}.js`);
+
+		await new Promise((resolve) =>
+			buildFunctions({
+				outfile,
+				functionsDirectory,
+				onEnd: () => resolve(null),
+				buildOutputDirectory: dirname(outfile),
+			})
+		);
+
+		builtFunctions = readFileSync(outfile, "utf-8");
+	}
+
+	const manifest = await upload({ directory, accountId, projectName });
+
+	const formData = new FormData();
+
+	formData.append("manifest", JSON.stringify(manifest));
+
+	if (branch) {
+		formData.append("branch", branch);
+	}
+
+	if (commitMessage) {
+		formData.append("commit_message", commitMessage);
+	}
+
+	if (commitHash) {
+		formData.append("commit_hash", commitHash);
+	}
+
+	if (commitDirty !== undefined) {
+		formData.append("commit_dirty", commitDirty);
+	}
+
+	let _headers: string | undefined,
+		_redirects: string | undefined,
+		_workerJS: string | undefined;
+
+	try {
+		_headers = readFileSync(join(directory, "_headers"), "utf-8");
+	} catch {}
+
+	try {
+		_redirects = readFileSync(join(directory, "_redirects"), "utf-8");
+	} catch {}
+
+	try {
+		_workerJS = readFileSync(join(directory, "_worker.js"), "utf-8");
+	} catch {}
+
+	if (_headers) {
+		formData.append("_headers", new File([_headers], "_headers"));
+	}
+
+	if (_redirects) {
+		formData.append("_redirects", new File([_redirects], "_redirects"));
+	}
+
+	if (builtFunctions) {
+		formData.append("_worker.js", new File([builtFunctions], "_worker.js"));
+	} else if (_workerJS) {
+		formData.append("_worker.js", new File([_workerJS], "_worker.js"));
+	}
+
+	const deploymentResponse = await fetchResult<Deployment>(
+		`/accounts/${accountId}/pages/projects/${projectName}/deployments`,
+		{
+			method: "POST",
+			body: formData,
+		}
+	);
+
+	saveToConfigCache<PagesConfigCache>(PAGES_CONFIG_CACHE_FILENAME, {
+		account_id: accountId,
+		project_name: projectName,
+	});
+
+	logger.log(
+		`✨ Deployment complete! Take a peek over at ${deploymentResponse.url}`
+	);
+	await metrics.sendMetricsEvent("create pages deployment");
+};

package/src/pages/types.ts

@@ -0,0 +1,40 @@
+export type Project = {
+	name: string;
+	subdomain: string;
+	domains: Array<string>;
+	source?: {
+		type: string;
+	};
+	latest_deployment?: {
+		modified_on: string;
+	};
+	created_on: string;
+	production_branch: string;
+};
+export type Deployment = {
+	id: string;
+	environment: string;
+	deployment_trigger: {
+		metadata: {
+			commit_hash: string;
+			branch: string;
+		};
+	};
+	url: string;
+	latest_stage: {
+		status: string;
+		ended_on: string;
+	};
+	project_name: string;
+};
+export type UploadPayloadFile = {
+	key: string;
+	value: string;
+	metadata: { contentType: string };
+	base64: boolean;
+};
+
+export interface PagesConfigCache {
+	account_id?: string;
+	project_name?: string;
+}