wrangler 0.0.0-eab9542 → 0.0.0-eaf71b86c

package/src/tail/index.ts

@@ -1,299 +0,0 @@
-import WebSocket from "ws";
-import { version as packageVersion } from "../../package.json";
-import { fetchResult } from "../cfetch";
-import type { TailFilterMessage, Outcome } from "./filters";
-export type { TailCLIFilters } from "./filters";
-export { translateCLICommandToFilterMessage } from "./filters";
-export { jsonPrintLogs, prettyPrintLogs } from "./printing";
-import type { Request } from "undici";
-
-/**
- * When creating a Tail, the response from the API contains
- * - an ID used for identifying the tail
- * - a URL to a WebSocket connection available for the tail to connect to
- * - an expiration date when the tail is no longer guaranteed to be valid
- */
-type TailCreationApiResponse = {
-	id: string;
-	url: string;
-	expires_at: Date;
-};
-
-/**
- * Generate a URL that, when `cfetch`ed, creates a tail.
- *
- * https://api.cloudflare.com/#worker-tail-logs-start-tail
- *
- * @param accountId the account ID associated with the worker to tail
- * @param workerName the name of the worker to tail
- * @returns a `cfetch`-ready URL for creating a new tail
- */
-function makeCreateTailUrl(
-	accountId: string,
-	workerName: string,
-	env: string | undefined
-): string {
-	return env
-		? `/accounts/${accountId}/workers/services/${workerName}/environments/${env}/tails`
-		: `/accounts/${accountId}/workers/scripts/${workerName}/tails`;
-}
-
-/**
- * Generate a URL that, when `cfetch`ed, deletes a tail
- *
- * https://api.cloudflare.com/#worker-tail-logs-delete-tail
- *
- * @param accountId the account ID associated with the worker we're tailing
- * @param workerName the name of the worker we're tailing
- * @param tailId the ID of the tail we want to delete
- * @returns a `cfetch`-ready URL for deleting a tail
- */
-function makeDeleteTailUrl(
-	accountId: string,
-	workerName: string,
-	tailId: string,
-	env: string | undefined
-): string {
-	return env
-		? `/accounts/${accountId}/workers/services/${workerName}/environments/${env}/tails/${tailId}`
-		: `/accounts/${accountId}/workers/scripts/${workerName}/tails/${tailId}`;
-}
-
-/**
- * Create and connect to a tail.
- *
- * Under the hood, this function
- * - Registers a new Tail with the API
- * - Connects to the tail worker
- * - Sends any filters over the connection
- *
- * @param accountId the account ID associated with the worker to tail
- * @param workerName the name of the worker to tail
- * @param message a `TailFilterMessage` to send up to the tail worker
- * @returns a websocket connection, an expiration, and a function to call to delete the tail
- */
-export async function createTail(
-	accountId: string,
-	workerName: string,
-	message: TailFilterMessage,
-	env: string | undefined
-): Promise<{
-	tail: WebSocket;
-	expiration: Date;
-	deleteTail: () => Promise<void>;
-}> {
-	// create the tail
-	const createTailUrl = makeCreateTailUrl(accountId, workerName, env);
-	const {
-		id: tailId,
-		url: websocketUrl,
-		expires_at: expiration,
-	} = await fetchResult<TailCreationApiResponse>(createTailUrl, {
-		method: "POST",
-	});
-
-	// delete the tail (not yet!)
-	const deleteUrl = makeDeleteTailUrl(accountId, workerName, tailId, env);
-	async function deleteTail() {
-		await fetchResult(deleteUrl, { method: "DELETE" });
-	}
-
-	// connect to the tail
-	const tail = new WebSocket(websocketUrl, "trace-v1", {
-		headers: {
-			"Sec-WebSocket-Protocol": "trace-v1", // needs to be `trace-v1` to be accepted
-			"User-Agent": `wrangler-js/${packageVersion}`,
-		},
-	});
-
-	// send filters when we open up
-	tail.on("open", function () {
-		tail.send(
-			JSON.stringify(message),
-			{ binary: false, compress: false, mask: false, fin: true },
-			(err) => {
-				if (err) {
-					throw err;
-				}
-			}
-		);
-	});
-
-	return { tail, expiration, deleteTail };
-}
-
-/**
- * Everything captured by the trace worker and sent to us via
- * `wrangler tail` is structured JSON that deserializes to this type.
- */
-export type TailEventMessage = {
-	/**
-	 * Whether the execution of this worker succeeded or failed
-	 */
-	outcome: Outcome;
-
-	/**
-	 * The name of the script we're tailing
-	 */
-	scriptName?: string;
-
-	/**
-	 * Any exceptions raised by the worker
-	 */
-	exceptions: {
-		/**
-		 * The name of the exception.
-		 */
-		name: string;
-
-		/**
-		 * The error message
-		 */
-		message: unknown;
-
-		/**
-		 * When the exception was raised/thrown
-		 */
-		timestamp: number;
-	}[];
-
-	/**
-	 * Any logs sent out by the worker
-	 */
-	logs: {
-		message: unknown[];
-		level: string; // TODO: make this a union of possible values
-		timestamp: number;
-	}[];
-
-	/**
-	 * When the event was triggered
-	 */
-	eventTimestamp: number;
-
-	/**
-	 * The event that triggered the worker. In the case of an HTTP request,
-	 * this will be a RequestEvent. If it's a cron trigger, it'll be a
-	 * ScheduledEvent.
-	 *
-	 * Until workers-types exposes individual types for export, we'll have
-	 * to just re-define these types ourselves.
-	 */
-	event: RequestEvent | ScheduledEvent | undefined | null;
-};
-
-/**
- * A request that triggered worker execution
- */
-
-export type RequestEvent = {
-	request: Pick<Request, "url" | "method" | "headers"> & {
-		/**
-		 * Cloudflare-specific properties
-		 * https://developers.cloudflare.com/workers/runtime-apis/request#incomingrequestcfproperties
-		 */
-		cf: {
-			/**
-			 * How long (in ms) it took for the client's TCP connection to make a
-			 * round trip to the worker and back. For all my gamers out there,
-			 * this is the request's ping
-			 */
-			clientTcpRtt?: number;
-
-			/**
-			 * Longitude and Latitude of where the request originated from
-			 */
-			longitude?: string;
-			latitude?: string;
-
-			/**
-			 * What cipher was used to establish the TLS connection
-			 */
-			tlsCipher: string;
-
-			/**
-			 * Which continent the request came from.
-			 */
-			continent?: "NA";
-
-			/**
-			 * ASN of the incoming request
-			 */
-			asn: number;
-
-			/**
-			 * The country the incoming request is coming from
-			 */
-			country?: string;
-
-			/**
-			 * The TLS version the connection used
-			 */
-			tlsVersion: string;
-
-			/**
-			 * The colo that processed the request (i.e. the airport code
-			 * of the closest city to the server that spun up the worker)
-			 */
-			colo: string;
-
-			/**
-			 * The timezone where the request came from
-			 */
-			timezone?: string;
-
-			/**
-			 * The city where the request came from
-			 */
-			city?: string;
-
-			/**
-			 * The browser-requested prioritization information in the request object
-			 */
-			requestPriority?: string;
-
-			/**
-			 * Which version of HTTP the request came over e.g. "HTTP/2"
-			 */
-			httpProtocol: string;
-
-			/**
-			 * The region where the request originated from
-			 */
-			region?: string;
-			regionCode?: string;
-
-			/**
-			 * The organization which owns the ASN of the incoming request, for example, Google Cloud.
-			 */
-			asOrganization: string;
-
-			/**
-			 * Metro code (DMA) of the incoming request, for example, "635".
-			 */
-			metroCode?: string;
-
-			/**
-			 * Postal code of the incoming request, for example, "78701".
-			 */
-			postalCode?: string;
-		};
-	};
-};
-
-/**
- * An event that was triggered at a certain time
- */
-export type ScheduledEvent = {
-	/**
-	 * The cron pattern that matched when this event fired
-	 */
-	cron: string;
-
-	/**
-	 * The time this worker was scheduled to run.
-	 * For some reason, this doesn't...work correctly when we
-	 * do it directly as a Date. So parse it later on your own.
-	 */
-	scheduledTime: number;
-};

package/src/tail/printing.ts

@@ -1,67 +0,0 @@
-import { logger } from "../logger";
-import type { RequestEvent, ScheduledEvent, TailEventMessage } from ".";
-import type { Outcome } from "./filters";
-import type WebSocket from "ws";
-
-export function prettyPrintLogs(data: WebSocket.RawData): void {
-	const eventMessage: TailEventMessage = JSON.parse(data.toString());
-
-	if (isScheduledEvent(eventMessage.event)) {
-		const cronPattern = eventMessage.event.cron;
-		const datetime = new Date(
-			eventMessage.event.scheduledTime
-		).toLocaleString();
-		const outcome = prettifyOutcome(eventMessage.outcome);
-
-		logger.log(`"${cronPattern}" @ ${datetime} - ${outcome}`);
-	} else {
-		const requestMethod = eventMessage.event?.request.method.toUpperCase();
-		const url = eventMessage.event?.request.url;
-		const outcome = prettifyOutcome(eventMessage.outcome);
-		const datetime = new Date(eventMessage.eventTimestamp).toLocaleString();
-
-		logger.log(
-			url
-				? `${requestMethod} ${url} - ${outcome} @ ${datetime}`
-				: `[missing request] - ${outcome} @ ${datetime}`
-		);
-	}
-
-	if (eventMessage.logs.length > 0) {
-		eventMessage.logs.forEach(({ level, message }) => {
-			logger.log(`  (${level})`, ...message);
-		});
-	}
-
-	if (eventMessage.exceptions.length > 0) {
-		eventMessage.exceptions.forEach(({ name, message }) => {
-			logger.error(`  ${name}:`, message);
-		});
-	}
-}
-
-export function jsonPrintLogs(data: WebSocket.RawData): void {
-	console.log(JSON.stringify(JSON.parse(data.toString()), null, 2));
-}
-
-function isScheduledEvent(
-	event: RequestEvent | ScheduledEvent | undefined | null
-): event is ScheduledEvent {
-	return Boolean(event && "cron" in event);
-}
-
-function prettifyOutcome(outcome: Outcome): string {
-	switch (outcome) {
-		case "ok":
-			return "Ok";
-		case "canceled":
-			return "Canceled";
-		case "exceededCpu":
-			return "Exceeded CPU Limit";
-		case "exception":
-			return "Exception Thrown";
-		case "unknown":
-		default:
-			return "Unknown";
-	}
-}

package/src/update-check.ts

@@ -1,19 +0,0 @@
-import chalk from "chalk";
-import checkForUpdate from "update-check";
-import pkg from "../package.json";
-
-export async function updateCheck(): Promise<string> {
-	let update = null;
-	try {
-		// default cache for update check is 1 day
-		update = await checkForUpdate(pkg, {
-			distTag: pkg.version.startsWith("0.0.0") ? "beta" : "latest",
-		});
-	} catch (err) {
-		// ignore error
-	}
-
-	if (update) return `(update available ${chalk.green(update.latest)})`;
-
-	return "";
-}

package/src/user/choose-account.tsx

@@ -1,60 +0,0 @@
-import { Text } from "ink";
-import SelectInput from "ink-select-input";
-import React from "react";
-import { fetchListResult } from "../cfetch";
-import { logger } from "../logger";
-import { getCloudflareAccountIdFromEnv } from "./env-vars";
-
-export type ChooseAccountItem = {
-	id: string;
-	name: string;
-};
-
-/**
- * A component that allows the user to select from a list of available accounts.
- */
-export function ChooseAccount(props: {
-	accounts: ChooseAccountItem[];
-	onSelect: (account: { name: string; id: string }) => void;
-	onError: (error: Error) => void;
-}) {
-	return (
-		<>
-			<Text bold>Select an account from below:</Text>
-			<SelectInput
-				items={props.accounts.map((item) => ({
-					key: item.id,
-					label: item.name,
-					value: item,
-				}))}
-				onSelect={(item) => {
-					logger.log(`Using account: "${item.value.name} - ${item.value.id}"`);
-					props.onSelect({ id: item.value.id, name: item.value.name });
-				}}
-			/>
-		</>
-	);
-}
-
-/**
- * Infer a list of available accounts for the current user.
- */
-export async function getAccountChoices(): Promise<ChooseAccountItem[]> {
-	const accountIdFromEnv = getCloudflareAccountIdFromEnv();
-	if (accountIdFromEnv) {
-		return [{ id: accountIdFromEnv, name: "" }];
-	} else {
-		const response = await fetchListResult<{
-			account: ChooseAccountItem;
-		}>(`/memberships`);
-		const accounts = response.map((r) => r.account);
-		if (accounts.length === 0) {
-			throw new Error(
-				"Failed to automatically retrieve account IDs for the logged in user.\n" +
-					"In a non-interactive environment, it is mandatory to specify an account ID, either by assigning its value to CLOUDFLARE_ACCOUNT_ID, or as `account_id` in your `wrangler.toml` file."
-			);
-		} else {
-			return accounts;
-		}
-	}
-}

package/src/user/env-vars.ts

@@ -1,46 +0,0 @@
-import { getEnvironmentVariableFactory } from "../environment-variables";
-
-export type ApiCredentials =
-	| {
-			apiToken: string;
-	  }
-	| {
-			authKey: string;
-			authEmail: string;
-	  };
-
-const getCloudflareAPITokenFromEnv = getEnvironmentVariableFactory({
-	variableName: "CLOUDFLARE_API_TOKEN",
-	deprecatedName: "CF_API_TOKEN",
-});
-const getCloudflareGlobalAuthKeyFromEnv = getEnvironmentVariableFactory({
-	variableName: "CLOUDFLARE_API_KEY",
-	deprecatedName: "CF_API_KEY",
-});
-const getCloudflareGlobalAuthEmailFromEnv = getEnvironmentVariableFactory({
-	variableName: "CLOUDFLARE_EMAIL",
-	deprecatedName: "CF_EMAIL",
-});
-
-/**
- * Try to read an API token or Global Auth from the environment.
- */
-export function getAuthFromEnv(): ApiCredentials | undefined {
-	const globalApiKey = getCloudflareGlobalAuthKeyFromEnv();
-	const globalApiEmail = getCloudflareGlobalAuthEmailFromEnv();
-	const apiToken = getCloudflareAPITokenFromEnv();
-
-	if (globalApiKey && globalApiEmail) {
-		return { authKey: globalApiKey, authEmail: globalApiEmail };
-	} else if (apiToken) {
-		return { apiToken };
-	}
-}
-
-/**
- * Try to read the account ID from the environment.
- */
-export const getCloudflareAccountIdFromEnv = getEnvironmentVariableFactory({
-	variableName: "CLOUDFLARE_ACCOUNT_ID",
-	deprecatedName: "CF_ACCOUNT_ID",
-});

package/src/user/generate-auth-url.ts

@@ -1,33 +0,0 @@
-interface GenerateAuthUrlProps {
-	authUrl: string;
-	clientId: string;
-	callbackUrl: string;
-	scopes: string[];
-	stateQueryParam: string;
-	codeChallenge: string;
-}
-
-/**
- * generateAuthUrl was extracted from getAuthURL in user.tsx
- * to make it possible to mock the generated URL
- */
-export const generateAuthUrl = ({
-	authUrl,
-	clientId,
-	callbackUrl,
-	scopes,
-	stateQueryParam,
-	codeChallenge,
-}: GenerateAuthUrlProps) => {
-	return (
-		authUrl +
-		`?response_type=code&` +
-		`client_id=${encodeURIComponent(clientId)}&` +
-		`redirect_uri=${encodeURIComponent(callbackUrl)}&` +
-		// we add offline_access manually for every request
-		`scope=${encodeURIComponent([...scopes, "offline_access"].join(" "))}&` +
-		`state=${stateQueryParam}&` +
-		`code_challenge=${encodeURIComponent(codeChallenge)}&` +
-		`code_challenge_method=S256`
-	);
-};

package/src/user/generate-random-state.ts

@@ -1,16 +0,0 @@
-import { webcrypto as crypto } from "node:crypto";
-import { PKCE_CHARSET } from "../user";
-
-/**
- * Generates random state to be passed for anti-csrf.
- * extracted from  user.tsx to make it possible to
- * mock the generated URL
- */
-export function generateRandomState(lengthOfState: number): string {
-	const output = new Uint32Array(lengthOfState);
-	// @ts-expect-error crypto's types aren't there yet
-	crypto.getRandomValues(output);
-	return Array.from(output)
-		.map((num: number) => PKCE_CHARSET[num % PKCE_CHARSET.length])
-		.join("");
-}

package/src/user/index.ts

@@ -1,3 +0,0 @@
-export * from "./user";
-export * from "./env-vars";
-export * from "./choose-account";