wawesome 0.17.0 → 0.18.0

package/README.md

@@ -648,6 +648,36 @@ Function, so a page your root Function carries at `about/index.html` is shadowed
 named `about`. The deploy says so and names both addresses. It refuses nothing — the two Functions are
 versioned independently, and either one may deploy first.
 
+### A page for an address nothing claims
+
+A site with no handler answers an address none of its pages claim with the platform's not-found. Add
+`"fallback"` and it answers with a page of your own instead:
+
+```json
+{
+  "app": "my-app",
+  "function": "root",
+  "assets": "dist",
+  "fallback": { "path": "404.html", "status": 404 }
+}
+```
+
+Two values rather than a mode. `404.html` at `404` is your own not-found page; `index.html` at `200`
+is a single-page application's shell, which is what puts a client-routed path in front of your router
+instead of a 404. Anything between those two shapes is yours to choose — the platform serves the pair
+it was given.
+
+Both halves have to be there, or the deploy stops before it uploads anything. The path names a file
+this deploy carries, relative to your assets directory; the status has to be one a document can be
+sent with, so `204` and `304` are refused. A fallback naming a file the deploy does not carry is
+refused too, before anything is compiled or stored.
+
+It is part of what identifies the deploy, so changing which page answers a miss, or the number it
+answers with, is a new version like any other change. Where the Function carries a handler, the
+handler answers that address and the fallback is never reached — and a miss beneath `assets/` stays a
+404 either way, since a page served where a browser asked for a build chunk is markup answering a
+request for script.
+
 ### Static files
 
 Add `"assets"` to deploy static files beside your code:

package/dist/index.mjs

@@ -905,7 +905,7 @@ async function buildHandler(entryInput, config, 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.17.0";
+const CLI_VERSION = "0.18.0";
 //#endregion
 //#region src/prompt.ts
 /**
@@ -2252,19 +2252,23 @@ function sha256(bytes) {
 }
 /**
 * What this deploy *is*: the server bundle together with the sorted set of
-* asset path and content-hash pairs.
+* asset path and content-hash pairs, and the **Fallback document** it declares.
 *
 * Computed here, before anything is uploaded, so a deploy that changed nothing
 * is refused before a byte moves. Mirrors `deploy_digest` in
 * `server/crates/core/src/features/assets/identity.rs` — the gateway recomputes
 * it from what actually arrives, so the two have to agree exactly.
+*
+* A deploy declaring no fallback contributes nothing here rather than a stated
+* absence, so every digest computed before fallbacks existed is unmoved.
 */
 const DEPLOY_DIGEST_DOMAIN = "wawesome-deploy-v1";
-function deployDigest(bundle, assets) {
+function deployDigest(bundle, assets, fallback) {
 	const digest = crypto.createHash("sha256");
 	digest.update(`${DEPLOY_DIGEST_DOMAIN}\n`);
 	digest.update(`${sha256(bundle)}\n`);
 	for (const asset of [...assets].sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0)) digest.update(`${asset.path}\0${asset.content_hash}\n`);
+	if (fallback) digest.update(`fallback\0${fallback.path}\0${fallback.status}\n`);
 	return digest.digest("hex");
 }
 /** The manifest as the gateway reads it — the bytes on disk are the CLI's business. */
@@ -2903,11 +2907,12 @@ async function cronCommand(action, target, subtarget, options = {}) {
 //#region src/mount-shadow.ts
 /**
 * The address a **Document** answers at, relative to its Function's mount: a
-* request path whose last segment carries no extension has `/index.html`
-* appended, so the Document at `about/index.html` is the address `about`.
+* request path whose last segment carries no extension resolves to that path,
+* to it with `.html` appended and to it with `/index.html` appended, so both
+* `about.html` and `about/index.html` are the address `about`.
 */
 function documentAddressPath(assetPath) {
-	return assetPath.replace(/(^|\/)index\.html$/, "");
+	return assetPath.replace(/(^|\/)index\.html$/, "").replace(/\.html$/, "");
 }
 /** See **Mount** in `CONTEXT.md` for why only the root Function's can be. */
 function mountsCanShadow(functionSlug) {
@@ -2975,6 +2980,53 @@ function shadowingLines(shadowed) {
 	];
 }
 //#endregion
+//#region src/document-collision.ts
+/**
+* The addresses this deploy carries more than one file for.
+*
+* An address resolves to an ordered set of keys and the first one the version
+* carries answers, so `about`, `about.html` and `about/index.html` all sit at
+* `/about` and the first of them wins. Nothing is refused: a build that emitted
+* two is a worse day when the deploy fails than when it says which one answers.
+*/
+function collidingDocuments(assetPaths) {
+	const byAddress = /* @__PURE__ */ new Map();
+	for (const assetPath of assetPaths) {
+		const address = documentAddressPath(assetPath);
+		byAddress.set(address, [...byAddress.get(address) ?? [], assetPath]);
+	}
+	return [...byAddress].filter(([, carried]) => carried.length > 1).map(([address, carried]) => {
+		const [answers, ...shadowed] = [...carried].sort((one, other) => preference(one) - preference(other));
+		return {
+			address,
+			answers,
+			shadowed
+		};
+	});
+}
+/** Where a file sits in the candidate order the platform resolves an address through. */
+function preference(assetPath) {
+	if (assetPath === documentAddressPath(assetPath)) return 1;
+	return /(^|\/)index\.html$/.test(assetPath) ? 3 : 2;
+}
+/** What the deploy says about an address it carries two pages for. */
+function collidingLines(colliding) {
+	if (colliding.length === 0) return [];
+	const lines = [];
+	for (const [index, collision] of colliding.entries()) {
+		const at = collision.address === "" ? "/" : `/${collision.address}`;
+		lines.push("", `  ${index === 0 ? "Collision: " : "           "} \x1b[33m${collision.answers}\x1b[0m`, ...indented(`This page and ${collision.shadowed.join(", ")} both answer ${at}. ${collision.answers} is the one served there, and ${listed(collision.shadowed)} still answer${collision.shadowed.length === 1 ? "s" : ""} at its own name.`));
+	}
+	return [
+		...lines,
+		`${VALUE_COLUMN}Nothing was refused — every file this deploy declared is`,
+		`${VALUE_COLUMN}stored and served.`
+	];
+}
+function listed(paths) {
+	return paths.length === 1 ? paths[0] : `${paths.slice(0, -1).join(", ")} and ${paths[paths.length - 1]}`;
+}
+//#endregion
 //#region src/deploy.ts
 function declaredFields(declared) {
 	return {
@@ -2984,6 +3036,28 @@ function declaredFields(declared) {
 	};
 }
 /**
+* The fallback this project declares.
+*
+* A declaration missing either half is refused here rather than at the gateway,
+* because the pair is part of what the deploy identifies itself by and that is
+* computed before anything is sent. Which statuses a document may be sent with,
+* and whether the path names a file the deploy carries, are the platform's to
+* judge: duplicating either rule here is two places for it to drift.
+*/
+function declaredFallback(value) {
+	if (value === void 0 || value === null) return void 0;
+	const declared = value;
+	if (typeof declared.path === "string" && declared.path.trim() && Number.isInteger(declared.status)) return {
+		path: declared.path.trim(),
+		status: declared.status
+	};
+	console.error("[wawesome] Error: 'fallback' in wawesome-function.json must name a document and the");
+	console.error("[wawesome] status it answers at.");
+	console.error("[wawesome] A not-found page is \x1B[36m{ \"path\": \"404.html\", \"status\": 404 }\x1B[0m and a");
+	console.error("[wawesome] single-page application's shell is \x1B[36m{ \"path\": \"index.html\", \"status\": 200 }\x1B[0m.");
+	process.exit(1);
+}
+/**
 * The visibility this project declares, refused here rather than at the gateway
 * so a typo is a message at the keyboard.
 */
@@ -3031,7 +3105,8 @@ async function deploy(entryInput, options) {
 	const declared = {
 		visibility: declaredVisibility(config.visibility),
 		confirmPublish: Boolean(options.publish),
-		confirmAssetDrop: Boolean(options.dropAssets)
+		confirmAssetDrop: Boolean(options.dropAssets),
+		fallback: declaredFallback(config.fallback)
 	};
 	const domainName = declaredDomain(config.domain);
 	if (isVerbose) {
@@ -3076,6 +3151,7 @@ async function deploy(entryInput, options) {
 		}
 	}
 	const declaresSchedules = config.schedules !== void 0;
+	const declaresFallback = declared.fallback !== void 0;
 	const assets = config.assets ? collectAssets(path.resolve(config.assets)) : [];
 	const documents = assets.filter((asset) => isDocument(asset.path));
 	if (jsCode === null && documents.length === 0) {
@@ -3090,7 +3166,7 @@ async function deploy(entryInput, options) {
 	const uploadUrl = `${creds.gateway_url}/v1/apps/${encodeURIComponent(app)}/functions/${encodeURIComponent(funcName)}/code`;
 	if (isVerbose) console.log(`[wawesome:verbose] POST ${uploadUrl}`);
 	const declaredOnTheWire = declaredFields(declared);
-	const uploadRes = assets.length > 0 || declaresSchedules || Object.keys(declaredOnTheWire).length > 0 || jsCode === null ? await authorizedFetch(uploadUrl, {
+	const uploadRes = assets.length > 0 || declaresSchedules || declaresFallback || Object.keys(declaredOnTheWire).length > 0 || jsCode === null ? await authorizedFetch(uploadUrl, {
 		method: "POST",
 		headers: {
 			Authorization: `Bearer ${creds.tenant_jwt}`,
@@ -3100,6 +3176,7 @@ async function deploy(entryInput, options) {
 			...jsCode !== null ? { code: jsCode } : {},
 			...assets.length > 0 ? { assets: manifestOf(assets) } : {},
 			...declaresSchedules ? { schedules: config.schedules } : {},
+			...declaresFallback ? { fallback: declared.fallback } : {},
 			...declaredOnTheWire
 		})
 	}) : await authorizedFetch(uploadUrl, {
@@ -3223,6 +3300,7 @@ async function deploy(entryInput, options) {
 	}
 	if (domain) for (const line of domainLines(domain)) console.log(line);
 	for (const line of shadowingLines(shadowed)) console.log(line);
+	for (const line of collidingLines(collidingDocuments(assets.map((asset) => asset.path)))) console.log(line);
 	if (headroom) {
 		console.log("");
 		for (const line of headroom) console.log(line);
@@ -3261,7 +3339,7 @@ async function uploadAssets(creds, app, funcName, bundle, assets, declared, isVe
 			"Content-Type": "application/json"
 		},
 		body: JSON.stringify({
-			deploy_digest: deployDigest(Buffer.from(bundle, "utf-8"), assets),
+			deploy_digest: deployDigest(Buffer.from(bundle, "utf-8"), assets, declared.fallback),
 			assets: manifestOf(assets),
 			...declaredFields(declared)
 		})
@@ -5623,6 +5701,16 @@ function isExpired(credential, now) {
 	const at = new Date(credential.expires_at).getTime();
 	return !Number.isNaN(at) && at <= now;
 }
+/**
+* Which rows somebody here minted and which they authorized a product to hold.
+*
+* The product is named beside the word rather than left to the label the token
+* endpoint writes: the label is a convention and this is the row's own answer.
+*/
+function kindOf(credential) {
+	if (credential.kind !== "oauth") return "minted";
+	return credential.client ? `connector (${credential.client.name})` : "connector";
+}
 function statusOf(credential, now) {
 	if (credential.revoked_at) return "revoked";
 	if (isExpired(credential, now)) return "expired";
@@ -5745,6 +5833,7 @@ function formatCredentials(credentials, now) {
 	const rows = credentials.map((credential) => ({
 		name: credential.name,
 		prefix: credential.prefix,
+		kind: kindOf(credential),
 		capabilities: credential.capabilities.join(", "),
 		apps: namedApps(credential.apps) ?? "every App",
 		lastUsed: asUtc(credential.last_used_at),
@@ -5760,6 +5849,10 @@ function formatCredentials(credentials, now) {
 			header: "PREFIX",
 			of: (row) => row.prefix
 		},
+		{
+			header: "KIND",
+			of: (row) => row.kind
+		},
 		{
 			header: "CAPABILITIES",
 			of: (row) => row.capabilities

package/package.json

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