wawesome 0.0.12 → 0.0.14

package/README.md

@@ -213,7 +213,7 @@ Three headers arrive or leave on it, and the stripping is what makes them worth
 | --- | --- | --- |
 | `x-wawesome-forwarded-prefix` | inbound | The mount that was stripped from the path. Join it to the path you observe to rebuild the caller's URL. |
 | `x-wawesome-invocation-id` | outbound | The id of this run — the key to fetch its logs with `npx wawesome logs --invocation <id>`. |
-| `x-wawesome-error` | outbound | Present only when the platform failed, never when your Function did. Its *absence* means the status on the wire is yours. |
+| `x-wawesome-error` | outbound | Present only when the platform failed, never when your Function did. Its *absence* means the status on the wire is yours — up to the moment your response is committed, and no further. |
 
 ### Local Development / Gateway Overrides
 

package/dist/index.mjs

@@ -31,25 +31,40 @@ function readSettings() {
 		return {};
 	}
 }
+const GATEWAY_ENV_NAMES = ["GATEWAY_URL", "WAWESOME_GATEWAY_URL"];
+const DASHBOARD_ENV_NAMES = ["DASHBOARD_URL", "WAWESOME_DASHBOARD_URL"];
+const GATEWAY_URL_FALLBACK = "https://api.wawesome.io";
+const DASHBOARD_URL_FALLBACK = "https://dashboard.wawesome.io";
+function resolveAddress(overrideUrl, envNames, settingsKey, stored, fallback) {
+	if (overrideUrl) return overrideUrl;
+	for (const name of envNames) {
+		const fromEnv = process.env[name];
+		if (fromEnv) return fromEnv;
+	}
+	const configured = readSettings()[settingsKey];
+	if (configured && typeof configured === "string") return configured;
+	return stored || fallback;
+}
+function getGatewayUrl(overrideUrl) {
+	return resolveAddress(overrideUrl, GATEWAY_ENV_NAMES, "gateway_url", readCredentials()?.gateway_url, GATEWAY_URL_FALLBACK);
+}
+getGatewayUrl();
+function getDashboardUrl(overrideUrl) {
+	return resolveAddress(overrideUrl, DASHBOARD_ENV_NAMES, "dashboard_url", readCredentials()?.dashboard_url, DASHBOARD_URL_FALLBACK);
+}
 /**
-* Resolve gateway URL with resolution hierarchy:
-* 1. Explicit override argument (CLI flag --gateway / --api)
-* 2. Environment variables GATEWAY_URL or WAWESOME_GATEWAY_URL
-* 3. User settings file ~/.wawesome/settings.json (gateway_url)
-* 4. Stored login credentials (~/.wawesome/credentials.json)
-* 5. Default fallback: "https://api.wawesome.io"
+* The dashboard for the environment this login is going to.
+*
+* The two addresses describe one environment, so the stored rung is read only
+* where the gateway being logged into is the one the credentials already name.
+* Carrying a dashboard across a change of gateway is the wrong workspace, and
+* so is dropping one where the gateway did not change at all.
 */
-function getGatewayUrl(overrideUrl) {
-	if (overrideUrl) return overrideUrl;
-	if (process.env.GATEWAY_URL) return process.env.GATEWAY_URL;
-	if (process.env.WAWESOME_GATEWAY_URL) return process.env.WAWESOME_GATEWAY_URL;
-	const settings = readSettings();
-	if (settings.gateway_url && typeof settings.gateway_url === "string") return settings.gateway_url;
+function resolveDashboardUrlForLogin(overrideUrl, gatewayUrl) {
 	const creds = readCredentials();
-	if (creds?.gateway_url) return creds.gateway_url;
-	return "https://api.wawesome.io";
+	const sameEnvironment = creds?.gateway_url === gatewayUrl;
+	return resolveAddress(overrideUrl, DASHBOARD_ENV_NAMES, "dashboard_url", sameEnvironment ? creds?.dashboard_url : void 0, DASHBOARD_URL_FALLBACK);
 }
-getGatewayUrl();
 /** Localhost port used during OAuth callback */
 const OAUTH_CALLBACK_PORT = 9999;
 /** Path to the user-level credentials file */
@@ -166,7 +181,7 @@ async function buildJs(entryInput, options) {
 * that has to name this version — `--version`, the dependency a scaffolded
 * project pins — reads it here, so a release bumps one file.
 */
-const CLI_VERSION = "0.0.12";
+const CLI_VERSION = "0.0.14";
 //#endregion
 //#region src/prompt.ts
 /**
@@ -247,14 +262,21 @@ var GatewayError = class extends Error {
 * was doing, so callers handle it before reaching this.
 */
 async function asGatewayError(res, fallback) {
-	const body = await res.text().catch(() => "");
+	return rejectionOf(await res.text().catch(() => ""), res.status, fallback);
+}
+/** The same reading, for a caller that has already taken the body off the wire. */
+function rejectionOf(body, status, fallback) {
 	try {
 		const parsed = JSON.parse(body);
-		return new GatewayError(parsed.error || fallback, res.status, parsed.reason, body);
+		return new GatewayError(parsed.error || fallback, status, parsed.reason, body);
 	} catch {
-		return new GatewayError(fallback, res.status, void 0, body);
+		return new GatewayError(fallback, status, void 0, body);
 	}
 }
+/** Why the gateway refused, where what was thrown might not be a refusal at all. */
+function reasonOf(err) {
+	return err instanceof GatewayError ? err.reason : void 0;
+}
 /** What went wrong, as text, whatever was thrown. */
 function errorText(err) {
 	return err instanceof Error ? err.message : String(err);
@@ -306,6 +328,10 @@ function renameAdvice(reason) {
 			text: "Use lowercase letters, numbers and single hyphens.",
 			retryable: true
 		};
+		case "too-short": return {
+			text: "Use at least three characters.",
+			retryable: true
+		};
 		case "locked": return {
 			text: "A deploy landed while this was running, which fixed the address for good.",
 			retryable: false
@@ -377,6 +403,7 @@ async function promptForWorkspaceName(options) {
 */
 async function login(options) {
 	const gatewayUrl = getGatewayUrl(options.gateway || options.api);
+	const dashboardUrl = resolveDashboardUrlForLogin(options.dashboard, gatewayUrl);
 	const provider = options.provider || "github";
 	const isVerbose = Boolean(options.verbose);
 	const authUrl = `${SUPABASE_URL}/auth/v1/authorize?provider=${provider}&redirect_to=${encodeURIComponent(`http://localhost:${OAUTH_CALLBACK_PORT}/callback`)}`;
@@ -476,6 +503,7 @@ async function login(options) {
 					} catch {}
 					writeCredentials({
 						gateway_url: gatewayUrl,
+						dashboard_url: dashboardUrl,
 						tenant_jwt: exchangeData.tenant_jwt,
 						tenant_id: primaryTenantId,
 						user_email: userEmail,
@@ -549,6 +577,155 @@ async function whoami() {
 	console.log(`  Gateway:   ${creds.gateway_url}\n`);
 }
 //#endregion
+//#region src/usage.ts
+const USAGE_TIMEOUT_MS = 2e3;
+/**
+* Bounded by its own timeout: every caller treats this as an aside to something
+* that already succeeded, so a management API that hangs must not be able to
+* hold that something open.
+*/
+async function fetchTenantUsage(creds, timeoutMs = USAGE_TIMEOUT_MS) {
+	const controller = new AbortController();
+	const timer = setTimeout(() => controller.abort(), timeoutMs);
+	try {
+		const res = await fetch(`${creds.gateway_url}/v1/tenant/usage`, {
+			headers: { Authorization: `Bearer ${creds.tenant_jwt}` },
+			signal: controller.signal
+		});
+		if (!res.ok) throw await asGatewayError(res, `Failed to read usage (HTTP ${res.status}).`);
+		return asTenantUsage(await res.json());
+	} finally {
+		clearTimeout(timer);
+	}
+}
+/**
+* A payload that is missing any of this is one the plan could not be resolved
+* for, and is refused here rather than rendered as half a block.
+*/
+function asTenantUsage(value) {
+	const usage = value;
+	if (!(!!usage && typeof usage.plan?.name === "string" && typeof usage.plan?.limits?.app_slots === "number" && typeof usage.occupied_app_slots === "number" && !!usage.allowances && typeof usage.allowances === "object" && isInstant(usage.period?.start) && isInstant(usage.period?.end))) throw new Error("Usage payload does not carry a resolved plan.");
+	return usage;
+}
+function isInstant(value) {
+	return typeof value === "string" && !isNaN(new Date(value).getTime());
+}
+//#endregion
+//#region src/headroom.ts
+const KNOWN_LABELS = {
+	invocations: "Invocations",
+	caller_facing_bytes: "Caller-facing bytes"
+};
+const COUNT_UNITS = [
+	{
+		threshold: 1e9,
+		suffix: "B"
+	},
+	{
+		threshold: 1e6,
+		suffix: "M"
+	},
+	{
+		threshold: 1e3,
+		suffix: "k"
+	}
+];
+const BYTE_UNITS = [
+	"B",
+	"KiB",
+	"MiB",
+	"GiB",
+	"TiB"
+];
+const MONTHS = [
+	"January",
+	"February",
+	"March",
+	"April",
+	"May",
+	"June",
+	"July",
+	"August",
+	"September",
+	"October",
+	"November",
+	"December"
+];
+/** Indented to sit inside the receipt the deploy already prints. */
+function headroomLines(usage) {
+	const lines = [
+		`  Plan:     ${usage.plan.name} — this deploy does not change your bill.`,
+		`  Apps:     ${usage.occupied_app_slots} / ${usage.plan.limits.app_slots} slots`,
+		`  Usage:    ${periodLabel(usage.period.start, usage.period.end)}`
+	];
+	const entries = Object.entries(usage.allowances);
+	const labelWidth = widest(entries.map(([key]) => allowanceLabel(key)));
+	const amountWidth = widest(entries.map(([key, allowance]) => amount(key, allowance.used, allowance.limit)));
+	for (const [key, allowance] of entries) {
+		const percent = allowance.consumed_percent === null ? "" : `  (${allowance.consumed_percent}%)`;
+		const line = `            ${allowanceLabel(key).padEnd(labelWidth)}  ${amount(key, allowance.used, allowance.limit).padEnd(amountWidth)}${percent}`;
+		lines.push(line.trimEnd());
+	}
+	const refused = refusedAtShare(usage);
+	if (refused !== null) lines.push(`  Refused:  ${formatCount(refused)} request${refused === 1 ? "" : "s"} at your share`);
+	return lines;
+}
+function refusedAtShare(usage) {
+	const refused = usage.refusals?.at_granted_share;
+	if (typeof refused !== "number" || !Number.isFinite(refused) || refused <= 0) return null;
+	return refused;
+}
+function allowanceLabel(key) {
+	if (KNOWN_LABELS[key]) return KNOWN_LABELS[key];
+	const words = key.replace(/[_-]+/g, " ").trim();
+	return words.charAt(0).toUpperCase() + words.slice(1);
+}
+function formatCount(value) {
+	for (let i = 0; i < COUNT_UNITS.length; i++) {
+		const { threshold, suffix } = COUNT_UNITS[i];
+		if (value < threshold) continue;
+		const scaled = round(value / threshold, 1);
+		if (scaled >= 1e3 && i > 0) {
+			const bigger = COUNT_UNITS[i - 1];
+			return `${round(value / bigger.threshold, 1)}${bigger.suffix}`;
+		}
+		return `${scaled}${suffix}`;
+	}
+	return String(Math.round(value));
+}
+function formatBytes(value) {
+	let scaled = value;
+	let unit = 0;
+	while (scaled >= 1024 && unit < BYTE_UNITS.length - 1) {
+		scaled /= 1024;
+		unit++;
+	}
+	return `${unit === 0 ? Math.round(scaled) : round(scaled, 2)} ${BYTE_UNITS[unit]}`;
+}
+/**
+* Name the period rather than print its bounds. The end is exclusive, so a
+* partial period names the last day inside it and not the instant after it.
+*/
+function periodLabel(start, end) {
+	const from = new Date(start);
+	const to = new Date(end);
+	if (from.getTime() === Date.UTC(from.getUTCFullYear(), from.getUTCMonth(), 1) && to.getTime() === Date.UTC(from.getUTCFullYear(), from.getUTCMonth() + 1, 1)) return `${MONTHS[from.getUTCMonth()]} ${from.getUTCFullYear()} (UTC)`;
+	return `${dayLabel(from)} – ${dayLabel(/* @__PURE__ */ new Date(to.getTime() - 1))} (UTC)`;
+}
+function dayLabel(date) {
+	return `${date.getUTCDate()} ${MONTHS[date.getUTCMonth()].slice(0, 3)} ${date.getUTCFullYear()}`;
+}
+function amount(key, used, limit) {
+	const format = key.includes("bytes") ? formatBytes : formatCount;
+	return `${format(used)} / ${format(limit)}`;
+}
+function round(value, places) {
+	return Number(value.toFixed(places));
+}
+function widest(values) {
+	return values.reduce((longest, value) => Math.max(longest, value.length), 0);
+}
+//#endregion
 //#region ../shared/public-address.ts
 const INVOCATION_PREFIX = "/x";
 const SUBTREE_NOTE = "Every path beneath this address reaches the Function.";
@@ -623,12 +800,8 @@ async function deploy(entryInput, options) {
 		const errorBody = await uploadRes.text();
 		if (uploadRes.status === 401) console.error("[wawesome] Error: Authentication expired. Run 'wawesome login' again.");
 		else if (uploadRes.status === 409) {
-			let msg = "Version with this code bundle already exists.";
-			try {
-				const parsed = JSON.parse(errorBody);
-				if (parsed.error) msg = parsed.error;
-			} catch {}
-			console.error(`\n[wawesome] \x1b[31mError: ${msg}\x1b[0m`);
+			const refusal = rejectionOf(errorBody, uploadRes.status, "Version with this code bundle already exists.");
+			console.error(`\n[wawesome] \x1b[31mError: ${refusal.message}\x1b[0m`);
 			console.error("[wawesome] Code versions are immutable and cannot be overwritten.");
 			console.error("[wawesome] To switch active version, run: \x1B[36mwawesome version switch\x1B[0m\n");
 		} else {
@@ -668,6 +841,12 @@ async function deploy(entryInput, options) {
 	} catch (err) {
 		if (isVerbose) console.log(`[wawesome:verbose] Could not resolve the workspace address: ${err instanceof Error ? err.message : err}`);
 	}
+	let headroom = null;
+	try {
+		headroom = headroomLines(await fetchTenantUsage(creds));
+	} catch (err) {
+		if (isVerbose) console.log(`[wawesome:verbose] Could not read the plan's usage: ${errorText(err)}`);
+	}
 	console.log("\n======================================================");
 	console.log("🚀 \x1B[32mDEPLOYED SUCCESSFULLY!\x1B[0m");
 	console.log("======================================================");
@@ -678,6 +857,10 @@ async function deploy(entryInput, options) {
 		console.log(`\n  URL:      \x1b[36m${address}\x1b[0m`);
 		console.log(`            ${SUBTREE_NOTE}`);
 	}
+	if (headroom) {
+		console.log("");
+		for (const line of headroom) console.log(line);
+	}
 	console.log("======================================================\n");
 	return {
 		app,
@@ -687,6 +870,20 @@ async function deploy(entryInput, options) {
 	};
 }
 //#endregion
+//#region src/billing.ts
+function billingPageUrl() {
+	const base = getDashboardUrl().replace(/\/+$/, "");
+	try {
+		return new URL("billing", `${base}/`).toString();
+	} catch {
+		return `${base}/billing`;
+	}
+}
+function appSlotAdvice(reason) {
+	if (reason !== "app-slots-exhausted") return "";
+	return `Where to resolve it: ${billingPageUrl()}`;
+}
+//#endregion
 //#region src/env.ts
 const STANDARD_SECRET_MESSAGES = [
 	"Encrypted at rest using AES-256",
@@ -1523,6 +1720,7 @@ async function ensureSession(options) {
 	try {
 		await login({
 			api: options.api,
+			dashboard: options.dashboard,
 			verbose: options.verbose
 		});
 	} catch (err) {
@@ -1585,7 +1783,7 @@ async function offerWorkspaceAddress(session, creds, tenant, appSlug, functionNa
 			return;
 		} catch (err) {
 			console.log(`[wawesome] ${errorText(err)}`);
-			refusal = err instanceof GatewayError ? err.reason : void 0;
+			refusal = reasonOf(err);
 			const { text, retryable } = renameAdvice(refusal);
 			if (text) console.log(`[wawesome] ${text}`);
 			if (!retryable) break;
@@ -1605,7 +1803,7 @@ async function wireUp(creds, appSlug, manifest, answers) {
 	try {
 		await ensureApp(creds, appSlug);
 	} catch (err) {
-		fail(errorText(err), scaffolded);
+		fail(errorText(err), ...[appSlotAdvice(reasonOf(err)), scaffolded].filter(Boolean));
 	}
 	for (const { declared, value } of answers) {
 		if (!value) {
@@ -2595,12 +2793,12 @@ cli.command("env [action] [key] [value]", "Manage environment variables (set, li
 cli.command("env set <key> <value>", "Set or overwrite an environment variable on the current app").option("-s, --secret", "Flag variable as secret (write-only)").option("-v, --verbose", "Enable verbose debug output").action((key, value, options) => setEnvVar(key, value, options));
 cli.command("env list", "List environment variables for the current app").alias("env ls").option("-v, --verbose", "Enable verbose debug output").action((options) => listEnvVars(options));
 cli.command("env rm <key>", "Delete an environment variable from the current app").alias("env remove").alias("env delete").alias("env unset").option("-v, --verbose", "Enable verbose debug output").action((key, options) => removeEnvVar(key, options));
-cli.command("login", "Authenticate with the wawesome.io platform").option("--api <url>", "API URL (default: https://api.wawesome.io)").option("--gateway <url>", "Alias for --api <url>").option("--provider <name>", "OAuth provider (default: github)").option("--workspace <name>", "Name for the workspace, when signing up without a terminal to prompt").option("-v, --verbose", "Enable verbose debug output").action((options) => login(options));
+cli.command("login", "Authenticate with the wawesome.io platform").option("--api <url>", "API URL (default: https://api.wawesome.io)").option("--gateway <url>", "Alias for --api <url>").option("--dashboard <url>", "Dashboard URL (default: https://dashboard.wawesome.io)").option("--provider <name>", "OAuth provider (default: github)").option("--workspace <name>", "Name for the workspace, when signing up without a terminal to prompt").option("-v, --verbose", "Enable verbose debug output").action((options) => login(options));
 cli.command("logout", "Clear stored authentication credentials").action(() => logout());
 cli.command("whoami", "Show current login session info").action(() => whoami());
 cli.command("workspace [action] [name]", "Show the workspace, or rename its public address").usage("workspace <action> [name]\n\nActions:\n  show                Show the workspace name, address, and whether it can still change\n  rename <name>       Change the public address, while nothing live depends on it").example("wawesome workspace").example("wawesome workspace rename northwind").option("-v, --verbose", "Enable verbose debug output").action((action, name, options) => workspaceCommand(action, name, options));
 cli.command("templates [action]", "Browse the template catalog").usage("templates [action]\n\nActions:\n  list (ls)           Show every available template (default)").example("wawesome templates").example("wawesome templates list").option("--api <url>", "API URL (default: https://api.wawesome.io)").option("-v, --verbose", "Enable verbose debug output").action((action, options) => templatesCommand(action, options));
-cli.command("init", "Scaffold a new function project in the current directory").usage("init [options]\n\nWith --template, the project is fetched from the template catalog, wired up\nfrom what the template declares it needs, and deployed. Run 'wawesome templates'\nto see what is available.").example("wawesome init").example("wawesome init --template stripe-webhook").option("-t, --template <name>", "Scaffold from a catalog template and deploy it").option("--api <url>", "API URL (default: https://api.wawesome.io)").option("--no-install", "Skip installing dependencies after scaffolding").option("--root", "Generate a root function router template").option("-v, --verbose", "Enable verbose debug output").action((options) => init(options));
+cli.command("init", "Scaffold a new function project in the current directory").usage("init [options]\n\nWith --template, the project is fetched from the template catalog, wired up\nfrom what the template declares it needs, and deployed. Run 'wawesome templates'\nto see what is available.").example("wawesome init").example("wawesome init --template stripe-webhook").option("-t, --template <name>", "Scaffold from a catalog template and deploy it").option("--api <url>", "API URL (default: https://api.wawesome.io)").option("--dashboard <url>", "Dashboard URL (default: https://dashboard.wawesome.io)").option("--no-install", "Skip installing dependencies after scaffolding").option("--root", "Generate a root function router template").option("-v, --verbose", "Enable verbose debug output").action((options) => init(options));
 cli.command("logs [function-name-or-invocation-id]", "View invocation history, fetch log output, or follow live").usage(`logs [target] [options]
 
   The target argument determines what the command does:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wawesome",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "CLI tool for building and deploying serverless functions on wawesome.io platform",
   "type": "module",
   "bin": {