wawesome 0.0.9 → 0.0.10

package/README.md

@@ -200,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.9";
+const CLI_VERSION = "0.0.10";
 //#endregion
 //#region src/prompt.ts
 /**
@@ -335,10 +335,6 @@ async function renameTenantSlug(creds, 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
 /**
@@ -548,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.
@@ -644,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}`);
 	}
@@ -657,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
@@ -1014,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]: {
@@ -1027,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);
 }
@@ -1066,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
@@ -1509,7 +1530,8 @@ 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${publicInvokeUrl(creds.gateway_url, slug, appSlug, functionName)}\x1b[0m\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.
@@ -1697,7 +1719,7 @@ async function initFromTemplate(templateName, options) {
 		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("");
 	}
 }
@@ -2465,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");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wawesome",
-  "version": "0.0.9",
+  "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"
   },