wawesome 0.0.8 → 0.0.10

package/README.md

@@ -67,6 +67,13 @@ dlx`, `bun x`), so the types are there when you open the project and the bundler
 template's imports. Pass `--no-install` to do it yourself. A failed install never stops the flow;
 the command to re-run is printed.
 
+Before any of that is sent anywhere, the CLI shows you the **public URL your Function will have**
+and offers to change your workspace address — the part of that URL that is yours rather than this
+project's, and the same one `wawesome workspace show` prints. It is randomly minted at signup and
+stays changeable until your first deploy, at which point it locks for good, because live URLs carry
+it. Press enter to keep it. If it is already locked, the offer is not made and the reason is said
+plainly.
+
 Being logged in is checked **before** the first question, not at the deploy: an expired session
 offers you a login there and then, and declining still leaves you the project plus the two commands
 that finish it.
@@ -193,6 +200,21 @@ Every project directory includes a `wawesome-function.json` file generated durin
 `app` is the App this Function is deployed into, and it is client-facing — every deploy from this
 directory is scoped to it.
 
+### Reserved headers
+
+`x-wawesome-*` belongs to the platform in both directions. It is stripped off the request before your
+handler sees it, and off your response before the caller does — so **do not name a header of your own
+on that prefix**: it is dropped silently rather than rejected, and you will not get an error telling
+you why it vanished.
+
+Three headers arrive or leave on it, and the stripping is what makes them worth trusting:
+
+| Header | Direction | What it means |
+| --- | --- | --- |
+| `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. |
+
 ### Local Development / Gateway Overrides
 
 If you are running a local gateway or self-hosted instance, you can configure your CLI Gateway URL using any of the

package/dist/index.mjs

@@ -161,7 +161,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.8";
+const CLI_VERSION = "0.0.10";
 //#endregion
 //#region src/prompt.ts
 /**
@@ -284,6 +284,34 @@ async function resolveWorkspace(creds) {
 	};
 }
 /**
+* What a refused rename means for whoever asked for it.
+*
+* Shared by the two places that offer a rename, so they cannot drift into
+* telling a user different things about the same reason — and `retryable` is
+* what separates a name worth retyping from one that no name would fix.
+*/
+function renameAdvice(reason) {
+	switch (reason) {
+		case "taken":
+		case "reserved": return {
+			text: "Pick a different name.",
+			retryable: true
+		};
+		case "malformed": return {
+			text: "Use lowercase letters, numbers and single hyphens.",
+			retryable: true
+		};
+		case "locked": return {
+			text: "A deploy landed while this was running, which fixed the address for good.",
+			retryable: false
+		};
+		default: return {
+			text: "",
+			retryable: false
+		};
+	}
+}
+/**
 * Ask for the workspace's public address to become `slug`.
 *
 * The slug is sent exactly as typed. Sanitizing it the way an App slug is
@@ -301,17 +329,12 @@ async function renameTenantSlug(creds, slug) {
 	});
 	if (!res.ok) throw await asGatewayError(res, `Rename failed (HTTP ${res.status}).`);
 	const result = await res.json();
-	const stored = readCredentials();
-	if (stored) writeCredentials({
-		...stored,
+	writeCredentials({
+		...readCredentials() ?? creds,
 		tenant_slug: result.tenant_slug
 	});
 	return result;
 }
-/** The address a deployed Function answers on, for a workspace and app. */
-function publicInvokeUrl(gatewayUrl, tenantSlug, appSlug, functionName) {
-	return `${gatewayUrl}/v1/s/${encodeURIComponent(tenantSlug)}/apps/${encodeURIComponent(appSlug)}/functions/${encodeURIComponent(functionName)}/invoke`;
-}
 //#endregion
 //#region src/auth.ts
 /**
@@ -521,6 +544,20 @@ async function whoami() {
 	console.log(`  Gateway:   ${creds.gateway_url}\n`);
 }
 //#endregion
+//#region ../shared/public-address.ts
+const INVOCATION_PREFIX = "/x";
+const SUBTREE_NOTE = "Every path beneath this address reaches the Function.";
+function mountBase(origin, tenantSlug) {
+	return `${origin.replace(/\/+$/, "")}${INVOCATION_PREFIX}/${encodeURIComponent(tenantSlug)}`;
+}
+function publicAddress(origin, tenantSlug, appSlug, functionSlug) {
+	return `${mountBase(origin, tenantSlug)}/${encodeURIComponent(appSlug)}/${encodeURIComponent(functionSlug)}`;
+}
+/** The same address with the app and function still to be chosen. */
+function publicAddressTemplate(origin, tenantSlug) {
+	return `${mountBase(origin, tenantSlug)}/<app>/<function>`;
+}
+//#endregion
 //#region src/deploy.ts
 /**
 * Deploy a function: build → upload JS to gateway → promote.
@@ -617,10 +654,10 @@ async function deploy(entryInput, options) {
 		}
 		process.exit(1);
 	}
-	let invokeUrl = null;
+	let address = null;
 	try {
 		const { slug } = await resolveWorkspace(creds);
-		invokeUrl = publicInvokeUrl(creds.gateway_url, slug, app, funcName);
+		address = publicAddress(creds.gateway_url, slug, app, funcName);
 	} catch (err) {
 		if (isVerbose) console.log(`[wawesome:verbose] Could not resolve the workspace address: ${err instanceof Error ? err.message : err}`);
 	}
@@ -630,13 +667,16 @@ async function deploy(entryInput, options) {
 	console.log(`\n  App:      ${app}`);
 	console.log(`  Function: ${funcName}`);
 	if (version !== void 0) console.log(`  Version:  ${version}`);
-	if (invokeUrl) console.log(`\n  URL:      \x1b[36m${invokeUrl}\x1b[0m`);
+	if (address) {
+		console.log(`\n  URL:      \x1b[36m${address}\x1b[0m`);
+		console.log(`            ${SUBTREE_NOTE}`);
+	}
 	console.log("======================================================\n");
 	return {
 		app,
 		functionName: funcName,
 		version,
-		invokeUrl
+		address
 	};
 }
 //#endregion
@@ -987,11 +1027,9 @@ function alignCliDependency(dir, version) {
 	const file = path.join(dir, PACKAGE_FILE);
 	const pkg = readJson(file);
 	const wanted = `^${version}`;
-	for (const field of ["dependencies", "devDependencies"]) {
+	for (const { field, range } of declaredCliRanges(pkg)) {
+		if (range === wanted) continue;
 		const deps = pkg[field];
-		if (!isRecord(deps)) continue;
-		const current = deps[CLI_PACKAGE];
-		if (typeof current !== "string" || current === wanted) continue;
 		writeJson(file, {
 			...pkg,
 			[field]: {
@@ -1000,12 +1038,22 @@ function alignCliDependency(dir, version) {
 			}
 		});
 		return {
-			from: current,
+			from: range,
 			to: wanted
 		};
 	}
 	return null;
 }
+/** Where a template declares the CLI, and at which range. */
+function declaredCliRanges(pkg) {
+	return ["dependencies", "devDependencies"].flatMap((field) => {
+		const deps = pkg[field];
+		return isRecord(deps) && typeof deps[CLI_PACKAGE] === "string" ? [{
+			field,
+			range: deps[CLI_PACKAGE]
+		}] : [];
+	});
+}
 function isRecord(value) {
 	return typeof value === "object" && value !== null && !Array.isArray(value);
 }
@@ -1039,9 +1087,9 @@ function collidingPaths(dir, relativePaths) {
 * not be resolved the message still prints, with the placeholder left visible
 * rather than a confident "undefined".
 */
-function renderPostDeploy(postDeploy, invokeUrl) {
-	if (!invokeUrl) return postDeploy;
-	return postDeploy.split("{{url}}").join(invokeUrl);
+function renderPostDeploy(postDeploy, address) {
+	if (!address) return postDeploy;
+	return postDeploy.split("{{url}}").join(address);
 }
 /**
 * Normalise arbitrary input into a legal DNS label, returning an empty string
@@ -1410,18 +1458,25 @@ async function promptForDeclaredEnv(session, declared) {
 	return answers;
 }
 /**
-* Whether the stored session is one the platform still accepts.
+* The stored credentials, if the platform still accepts them, with whatever it
+* said about the Tenant while answering.
 *
-* Only a refusal counts as an answer. An unreachable gateway says nothing about
-* whether the credentials are good, and treating it as a dead session would send
-* a user who is merely offline through a login they do not need.
+* Only a refusal counts as an answer — that is the null. An unreachable gateway
+* says nothing about whether the credentials are good, and treating it as a dead
+* session would send a user who is merely offline through a login they do not
+* need, so it comes back as a session with nothing known about the Tenant.
 */
-async function sessionIsLive(creds) {
+async function probeSession(creds) {
 	try {
-		await fetchTenantDetails(creds);
-		return true;
+		return {
+			creds,
+			tenant: await fetchTenantDetails(creds)
+		};
 	} catch (err) {
-		return !(err instanceof GatewayError && (err.status === 401 || err.status === 403));
+		return err instanceof GatewayError && (err.status === 401 || err.status === 403) ? null : {
+			creds,
+			tenant: null
+		};
 	}
 }
 /**
@@ -1438,7 +1493,10 @@ async function sessionIsLive(creds) {
 */
 async function ensureSession(options) {
 	const stored = readCredentials();
-	if (stored && await sessionIsLive(stored)) return stored;
+	if (stored) {
+		const probed = await probeSession(stored);
+		if (probed) return probed;
+	}
 	console.log(stored ? "\n[wawesome] Your session has expired." : "\n[wawesome] You're not logged in yet — that's what a deploy needs.");
 	if (!isInteractive()) {
 		console.log("[wawesome] Run 'wawesome login', then 'wawesome deploy'.");
@@ -1464,7 +1522,69 @@ async function ensureSession(options) {
 		console.error(`[wawesome] Login failed: ${errorText(err)}`);
 		return null;
 	}
-	return readCredentials();
+	const fresh = readCredentials();
+	return fresh ? probeSession(fresh) : null;
+}
+/** Bound on the rename loop, so a name the gateway keeps refusing ends the offer. */
+const MAX_RENAME_ATTEMPTS = 3;
+/** Show the address the Function will answer on, once it is deployed. */
+function announceUrl(creds, slug, appSlug, functionName) {
+	console.log("\n[wawesome] Your Function will answer on:\n");
+	console.log(`    \x1b[36m${publicAddress(creds.gateway_url, slug, appSlug, functionName)}\x1b[0m`);
+	console.log(`    ${SUBTREE_NOTE}\n`);
+}
+/**
+* Show the URL, and offer to fix the workspace address while it can still be fixed.
+*
+* This is the last moment that address is free: it locks the first time a
+* version is promoted, which is what the deploy at the end of this flow does.
+* Asking here rather than at signup is the whole reason naming was deferred —
+* it is client-facing branding, and nobody chooses it well before seeing the
+* product work. The URL comes first so the offer is about something concrete.
+*
+* The lock is read from the gateway rather than guessed, so a user who cannot
+* rename is told why instead of being walked into a rejection. Nothing here can
+* fail the flow: the project is already on disk and the deploy still works under
+* the address the workspace has.
+*/
+async function offerWorkspaceAddress(session, creds, tenant, appSlug, functionName) {
+	const current = tenant?.tenant_slug ?? creds.tenant_slug;
+	if (!current) return;
+	announceUrl(creds, current, appSlug, functionName);
+	if (!tenant) {
+		console.log(`  '${current}' is your workspace address. Whether it can still be changed`);
+		console.log("  is a question for the gateway, which did not answer.\n");
+		return;
+	}
+	if (tenant.slug_locked) {
+		console.log(`  🔒 '${current}' is fixed — a Function version has been promoted, and live URLs already carry it.\n`);
+		return;
+	}
+	console.log(`  '${current}' is your workspace address — the part of that URL that is yours`);
+	console.log("  rather than this project's, and this is the moment to change it: it locks");
+	console.log("  for good the first time you deploy, because live URLs carry it.");
+	console.log("  Press enter to keep it.\n");
+	let refusal;
+	for (let attempt = 0; attempt < MAX_RENAME_ATTEMPTS; attempt++) {
+		const answer = await session.ask("  Workspace address?", current);
+		if (answer === current) {
+			console.log(`[wawesome] Keeping '${current}'.`);
+			return;
+		}
+		try {
+			const renamed = await renameTenantSlug(creds, answer);
+			console.log(`\n[wawesome] ✅ Workspace renamed to '${renamed.tenant_slug}'.`);
+			announceUrl(creds, renamed.tenant_slug, appSlug, functionName);
+			return;
+		} catch (err) {
+			console.log(`[wawesome] ${errorText(err)}`);
+			refusal = err instanceof GatewayError ? err.reason : void 0;
+			const { text, retryable } = renameAdvice(refusal);
+			if (text) console.log(`[wawesome] ${text}`);
+			if (!retryable) break;
+		}
+	}
+	console.log(refusal === "locked" ? `[wawesome] Keeping '${current}'.` : `[wawesome] Keeping '${current}'. Change it later with: wawesome workspace rename <name>`);
 }
 /**
 * Satisfy the template's declarations against the platform.
@@ -1538,7 +1658,7 @@ async function initFromTemplate(templateName, options) {
 	let functionName;
 	let appSlug;
 	let manifest;
-	let creds;
+	let tenantSession;
 	let answers = [];
 	try {
 		let files;
@@ -1553,7 +1673,7 @@ async function initFromTemplate(templateName, options) {
 		}
 		const collisions = collidingPaths(cwd, files);
 		if (collisions.length > 0) fail(`${collisions.join(", ")} already exist${collisions.length === 1 ? "s" : ""} here.`, "Run this in an empty directory, or move those files aside first. Nothing was written.");
-		creds = await ensureSession(options);
+		tenantSession = await ensureSession(options);
 		const session = openPromptSession();
 		try {
 			functionName = await promptForSlug(session, "Function name", readFunctionConfig(staging)?.function || dirName);
@@ -1572,7 +1692,8 @@ async function initFromTemplate(templateName, options) {
 			}
 			console.log(`\n[wawesome] ✅ Scaffolded ${files.length} files from '${template.name}'.`);
 			if (repinned) console.log(`[wawesome] Using wawesome ${repinned.to} — the template pinned ${repinned.from}.`);
-			answers = creds ? await promptForDeclaredEnv(session, manifest.env) : [];
+			if (tenantSession) await offerWorkspaceAddress(session, tenantSession.creds, tenantSession.tenant, appSlug, functionName);
+			answers = tenantSession ? await promptForDeclaredEnv(session, manifest.env) : [];
 		} finally {
 			session.close();
 		}
@@ -1580,7 +1701,7 @@ async function initFromTemplate(templateName, options) {
 		sweepStaging();
 		process.off("exit", sweepStaging);
 	}
-	if (!creds) {
+	if (!tenantSession) {
 		const installed = options.install === false ? null : installDependencies(cwd, { verbose: options.verbose });
 		console.log("\n[wawesome] 🎉 Project ready. Next steps:");
 		[
@@ -1591,14 +1712,14 @@ async function initFromTemplate(templateName, options) {
 		console.log("");
 		return;
 	}
-	await wireUp(creds, appSlug, manifest, answers);
+	await wireUp(tenantSession.creds, appSlug, manifest, answers);
 	if (options.install !== false) installDependencies(cwd, { verbose: options.verbose });
 	const result = await deploy(void 0, {
 		out: "dist/index.js",
 		verbose: options.verbose
 	});
 	if (manifest.post_deploy) {
-		console.log(renderPostDeploy(manifest.post_deploy, result.invokeUrl));
+		console.log(renderPostDeploy(manifest.post_deploy, result.address));
 		console.log("");
 	}
 }
@@ -2366,7 +2487,10 @@ async function showWorkspace(options) {
 	console.log(`  Name:     ${tenant.name}`);
 	console.log(`  Address:  ${tenant.tenant_slug}`);
 	console.log(`  Tenant:   ${tenant.id}`);
-	if (options.verbose) console.log(`  Invoke:   ${creds.gateway_url}/v1/s/${tenant.tenant_slug}/apps/<app>/functions/<function>/invoke`);
+	if (options.verbose) {
+		console.log(`  URLs:     ${publicAddressTemplate(creds.gateway_url, tenant.tenant_slug)}`);
+		console.log(`            ${SUBTREE_NOTE}`);
+	}
 	if (tenant.slug_locked) console.log("\n  🔒 The address is fixed — a Function version has been promoted and live URLs carry it.");
 	else {
 		console.log("\n  The address can still be changed: \x1B[36mwawesome workspace rename <name>\x1B[0m");
@@ -2408,20 +2532,8 @@ async function renameWorkspace(slug, options) {
 	} catch (err) {
 		if (err instanceof GatewayError) {
 			console.error(`\n[wawesome] \x1b[31m${err.message}\x1b[0m`);
-			switch (err.reason) {
-				case "taken":
-					console.error("[wawesome] Pick a different name.");
-					break;
-				case "reserved":
-					console.error("[wawesome] Pick a different name.");
-					break;
-				case "malformed":
-					console.error("[wawesome] Use lowercase letters, numbers and single hyphens.");
-					break;
-				case "locked":
-					console.error("[wawesome] A deploy landed while this was running, which fixed the address for good.");
-					break;
-			}
+			const { text } = renameAdvice(err.reason);
+			if (text) console.error(`[wawesome] ${text}`);
 			console.error("");
 			process.exit(1);
 			return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wawesome",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "CLI tool for building and deploying serverless functions on wawesome.io platform",
   "type": "module",
   "bin": {
@@ -16,6 +16,7 @@
     "build": "tsdown",
     "dev": "tsdown --watch",
     "test": "vitest run",
+    "test:templates": "vitest run --config vitest.live.config.ts",
     "check": "publint --pack npm",
     "changeset": "changeset"
   },