@samebase/alchemy-convex 0.17.0 → 0.18.0

package/NOTICE

@@ -8,6 +8,9 @@ packages/alchemy, under the ISC license:
 - the Convex CLI runner in src/Push.ts (internal/CommandRunner.ts),
 - the deployment lookup rules in src/Deployment.ts and the project listing in src/Project.ts.
 
+The Workers and R2 icons in assets/stack-comment are by Cloudflare, under CC BY 4.0
+(https://creativecommons.org/licenses/by/4.0/), with Cloudflare orange fill.
+
 ISC License
 
 Copyright 2024 RJ Dellecese

package/README.md

@@ -292,6 +292,33 @@ of the app, before the first push: it registers the deployment of that directory
 npx alchemy-convex hub-client --team my-team --app scout --callback-path /auth/hub/callback
 ```
 
+## Pull request comment
+
+`alchemy-convex stack-comment` keeps one comment on a pull request. The comment has a card for each
+stack of the repository at the stage `pr-<number>`: the folder, the address, the last run, and the
+Convex deployments, Workers, and R2 buckets. A stack sees only itself, so a comment that a stack
+declares cannot show this.
+
+Run it after every deploy of the workflow. The run record gives the repository and the pull request,
+so the command needs no argument with a team access token:
+
+```yaml
+permissions:
+  pull-requests: write
+
+steps:
+  # The deploy steps of each stack.
+  - name: Update the stack comment
+    if: github.event_name == 'pull_request'
+    run: pnpm exec alchemy-convex stack-comment
+    env:
+      CONVEX_ACCESS_TOKEN: ${{ secrets.CONVEX_ACCESS_TOKEN }}
+      GITHUB_TOKEN: ${{ github.token }}
+```
+
+A stack named `owner/name`, or `owner/name/<folder>` for a stack in a folder, belongs to the
+repository `owner/name`. A stack without the stage of the pull request has no card.
+
 ## Data safety
 
 - `Convex.Project` and `Convex.Deployment` have the removal policy `retain`. `alchemy destroy`

package/lib/cli.js

@@ -1,9 +1,207 @@
 #!/usr/bin/env node
-import { I as ManagementApiLive, M as installedCli, V as fromConfig, a as registerDevelopmentClient } from "./HubClient-BZKweNfD.js";
+import { I as ManagementApiLive, M as installedCli, V as fromConfig, a as registerDevelopmentClient, c as RUN_RECORD_KEY, s as state, u as runRecord } from "./HubClient-BZKweNfD.js";
 import * as Effect from "effect/Effect";
+import * as Schema from "effect/Schema";
 import * as Layer from "effect/Layer";
 import { parseArgs } from "node:util";
+import { State } from "alchemy/State";
 import { execFileSync } from "node:child_process";
+import * as NodeServices from "@effect/platform-node/NodeServices";
+//#region src/StackComment.ts
+/** The first text of the comment, which finds it again. */
+const MARKER = "<!-- samebase-stacks -->";
+/** GitHub does not proxy this host, so a new icon needs no purge of its image cache. */
+const ICONS = "https://raw.githubusercontent.com/samebase/alchemy-convex/main/assets/stack-comment";
+const GITHUB_API = "https://api.github.com";
+/** The resources that a card shows. A row of any other type, or without `attr` from an interrupted deploy, is left out. */
+const Resource = Schema.Union([
+	Schema.Struct({
+		resourceType: Schema.Literal("Convex.Deployment"),
+		attr: Schema.Struct({
+			name: Schema.String,
+			siteUrl: Schema.String
+		})
+	}),
+	Schema.Struct({
+		resourceType: Schema.Literal("Cloudflare.Worker"),
+		attr: Schema.Struct({
+			workerName: Schema.String,
+			url: Schema.optional(Schema.String)
+		})
+	}),
+	Schema.Struct({
+		resourceType: Schema.Literal("Cloudflare.R2.Bucket"),
+		attr: Schema.Struct({
+			bucketName: Schema.String,
+			accountId: Schema.String,
+			jurisdiction: Schema.String
+		})
+	})
+]);
+/** The fields of the run record that a card shows. */
+const StageOutput = Schema.Struct({ [RUN_RECORD_KEY]: Schema.Struct({
+	headCommit: Schema.String,
+	runUrl: Schema.NullOr(Schema.String),
+	recordedAt: Schema.String
+}) });
+var StackCommentError = class extends Schema.TaggedError()("StackCommentError", { reason: Schema.String }) {
+	get message() {
+		return `The stack comment cannot be updated: ${this.reason}`;
+	}
+};
+/** The cards of the stacks of `repository` that have `stage`, in name order. */
+const readStackCards = ({ repository, stage }) => Effect.gen(function* () {
+	const state = yield* yield* State;
+	const names = (yield* state.listStacks()).filter((name) => name === repository || name.startsWith(`${repository}/`));
+	const cards = [];
+	for (const name of names) {
+		if (!(yield* state.listStages(name)).includes(stage)) continue;
+		const request = {
+			stack: name,
+			stage
+		};
+		const rows = yield* Effect.forEach(yield* state.list(request), (fqn) => state.get({
+			...request,
+			fqn
+		}));
+		const output = yield* state.getOutput(request);
+		cards.push({
+			name,
+			stage,
+			resources: rows.filter(Schema.is(Resource)),
+			run: Schema.is(StageOutput)(output) ? output : null
+		});
+	}
+	return cards;
+});
+/** A stack can create a deployment in one resource and push to it in another: a card shows it once. */
+const withoutRepeats = (resources) => {
+	const deployments = /* @__PURE__ */ new Set();
+	return resources.filter((resource) => {
+		if (resource.resourceType !== "Convex.Deployment") return true;
+		const repeated = deployments.has(resource.attr.name);
+		deployments.add(resource.attr.name);
+		return !repeated;
+	});
+};
+const escapeHtml = (text) => text.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;").replaceAll("\"", "&quot;");
+const link = (href, text) => `<a href="${escapeHtml(href)}">${text}</a>`;
+const named = (href, icon, alt, name) => {
+	const image = `<img src="${ICONS}/${icon}.svg" width="16" align="absmiddle" alt="${alt}">`;
+	return `${link(href, image)} ${link(href, escapeHtml(name))}`;
+};
+const hostOf = (url) => escapeHtml(new URL(url).host);
+/** Where a stack serves: its Convex deployment, else its first Worker with a URL. */
+const addressOf = (resources) => {
+	for (const resource of resources) if (resource.resourceType === "Convex.Deployment") return resource.attr.siteUrl;
+	for (const resource of resources) if (resource.resourceType === "Cloudflare.Worker" && resource.attr.url !== void 0) return resource.attr.url;
+	return null;
+};
+const resourceRow = (resource, address) => {
+	switch (resource.resourceType) {
+		case "Convex.Deployment": {
+			const { name } = resource.attr;
+			return named(`https://dashboard.convex.dev/d/${encodeURIComponent(name)}`, "convex", "Convex", name);
+		}
+		case "Cloudflare.Worker": {
+			const { url, workerName } = resource.attr;
+			const row = named(`https://dash.cloudflare.com/?to=/:account/workers/services/view/${encodeURIComponent(workerName)}`, "worker", "Worker", workerName);
+			return url === void 0 || url === address ? row : `${row}<br><sub>${link(url, hostOf(url))}</sub>`;
+		}
+		case "Cloudflare.R2.Bucket": {
+			const { accountId, bucketName, jurisdiction } = resource.attr;
+			return named(`https://dash.cloudflare.com/${encodeURIComponent(accountId)}/r2/${encodeURIComponent(jurisdiction)}/buckets/${encodeURIComponent(bucketName)}`, "r2", "R2 bucket", bucketName);
+		}
+	}
+};
+const runLine = ({ run }) => {
+	if (run === null) return "";
+	const { headCommit, recordedAt, runUrl } = run[RUN_RECORD_KEY];
+	const commit = escapeHtml(headCommit.slice(0, 7));
+	const time = `${recordedAt.slice(0, 16).replace("T", " ")} UTC`;
+	return `<br><sub>${runUrl === null ? commit : link(runUrl, commit)} ${escapeHtml(time)}</sub>`;
+};
+const SPACER = `<div><img src="${ICONS}/spacer.svg" width="460" align="left" alt=""></div>`;
+/** `alone`: the one card of the repository. A card at the root then has no folder, as on the repository page. */
+const renderCard = (card, repository, alone) => {
+	const folder = card.name.slice(repository.length + 1);
+	const heading = [folder === "" && alone ? "" : `<b>${escapeHtml(folder || "/")}</b> `, `<sub>${escapeHtml(card.stage)}</sub>`].join("");
+	const resources = withoutRepeats(card.resources);
+	const address = addressOf(resources);
+	const addressLine = address === null ? "" : `<br>${link(address, hostOf(address))}`;
+	const rows = resources.map((resource) => `<tbody><tr><td>${resourceRow(resource, address)}</td></tr></tbody>`).join("\n");
+	return `<table>
+<tbody><tr><td>${SPACER}${heading}${addressLine}${runLine(card)}</td></tr></tbody>
+${rows}
+</table>`;
+};
+const renderStackComment = (cards, repository) => `${MARKER}
+${cards.map((card) => renderCard(card, repository, cards.length === 1)).join("\n\n")}
+`;
+const Comments = Schema.Array(Schema.Struct({
+	id: Schema.Number,
+	body: Schema.String
+}));
+const SavedComment = Schema.Struct({ html_url: Schema.String });
+const github = (token, path, init) => Effect.tryPromise({
+	try: async () => {
+		const response = await fetch(`${GITHUB_API}${path}`, {
+			...init,
+			headers: {
+				Accept: "application/vnd.github+json",
+				Authorization: `Bearer ${token}`,
+				"Content-Type": "application/json",
+				"X-GitHub-Api-Version": "2022-11-28"
+			}
+		});
+		if (!response.ok) throw new Error(`HTTP ${response.status}`);
+		return await response.json();
+	},
+	catch: (error) => new StackCommentError({ reason: `GitHub ${init.method} ${path} failed (${error instanceof Error ? error.message : String(error)})` })
+});
+const decode = (schema, what) => (value) => Schema.decodeUnknownEffect(schema)(value).pipe(Effect.mapError(() => new StackCommentError({ reason: `GitHub gave a bad ${what}` })));
+const findComment = (token, path) => Effect.gen(function* () {
+	for (let page = 1;; page += 1) {
+		const comments = yield* github(token, `${path}?per_page=100&page=${page}`, { method: "GET" }).pipe(Effect.flatMap(decode(Comments, "comment list")));
+		const comment = comments.find(({ body }) => body.startsWith(MARKER));
+		if (comment !== void 0 || comments.length < 100) return comment;
+	}
+});
+/** Replaces the body of the comment of this command, or posts it on the first run, and gives its URL. */
+const saveStackComment = (args) => Effect.gen(function* () {
+	const { body, pullRequest, repository, token } = args;
+	const comments = `/repos/${repository}/issues/${pullRequest}/comments`;
+	const comment = yield* findComment(token, comments);
+	const reply = yield* comment === void 0 ? github(token, comments, {
+		method: "POST",
+		body: JSON.stringify({ body })
+	}) : github(token, `/repos/${repository}/issues/comments/${comment.id}`, {
+		method: "PATCH",
+		body: JSON.stringify({ body })
+	});
+	return (yield* decode(SavedComment, "comment")(reply)).html_url;
+});
+/** The step of a workflow: the run record names the repository and the pull request of the run. */
+const updateStackComment = Effect.gen(function* () {
+	const { pullRequest, repository } = yield* runRecord({
+		cwd: process.cwd(),
+		env: process.env
+	});
+	if (pullRequest === null) return yield* new StackCommentError({ reason: "this run has no pull request" });
+	const token = process.env["GITHUB_TOKEN"];
+	if (token === void 0 || token === "") return yield* new StackCommentError({ reason: "GITHUB_TOKEN is not set" });
+	const cards = yield* readStackCards({
+		repository,
+		stage: `pr-${pullRequest}`
+	});
+	return yield* saveStackComment({
+		token,
+		repository,
+		pullRequest,
+		body: renderStackComment(cards, repository)
+	});
+});
+//#endregion
 //#region src/cli.ts
 const { positionals, values } = parseArgs({
 	allowPositionals: true,
@@ -14,16 +212,13 @@ const { positionals, values } = parseArgs({
 	}
 });
 const { team, app, "callback-path": callbackPath } = values;
-if (positionals.join(" ") !== "hub-client" || team === void 0 || app === void 0 || callbackPath === void 0) {
-	console.error("Usage: alchemy-convex hub-client --team <team> --app <app> --callback-path <path>");
-	process.exit(1);
-}
-const program = Effect.gen(function* () {
+const USAGE = `Usage:
+  alchemy-convex hub-client --team <team> --app <app> --callback-path <path>
+  alchemy-convex stack-comment [--team <team>]`;
+const hubClient = (hub) => Effect.gen(function* () {
 	const [command, ...prefix] = yield* installedCli(process.cwd());
 	const callbackUrl = yield* registerDevelopmentClient({
-		team,
-		app,
-		callbackPath,
+		...hub,
 		convex: (args, input) => execFileSync(command, [...prefix, ...args], {
 			encoding: "utf8",
 			input,
@@ -36,6 +231,17 @@ const program = Effect.gen(function* () {
 	});
 	console.log(callbackUrl === void 0 ? "Hub client already registered." : `Hub client registered for ${callbackUrl}.`);
 }).pipe(Effect.provide(ManagementApiLive().pipe(Layer.provide(fromConfig()))));
+const stackComment = (options) => updateStackComment.pipe(Effect.tap((url) => Effect.sync(() => console.log(url))), Effect.provide(state(options).pipe(Layer.provide(NodeServices.layer))));
+const subcommand = positionals.join(" ");
+const program = subcommand === "stack-comment" ? stackComment(team === void 0 ? {} : { team }) : subcommand === "hub-client" && team !== void 0 && app !== void 0 && callbackPath !== void 0 ? hubClient({
+	team,
+	app,
+	callbackPath
+}) : void 0;
+if (program === void 0) {
+	console.error(USAGE);
+	process.exit(1);
+}
 await Effect.runPromise(program).catch((error) => {
 	console.error(error instanceof Error ? error.message : String(error));
 	process.exit(1);

package/lib/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","names":[],"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env node\n// The command of the package:\n//\n//   alchemy-convex hub-client --team <team> --app <app> --callback-path <path>\n//\n// It runs in the directory of a Convex app, and gives the development deployment of that directory\n// a client of the identity hub of the team: see registerDevelopmentClient. It uses\n// CONVEX_ACCESS_TOKEN or the Convex CLI login.\nimport { execFileSync } from \"node:child_process\";\nimport { parseArgs } from \"node:util\";\nimport * as Effect from \"effect/Effect\";\nimport * as Layer from \"effect/Layer\";\nimport { fromConfig } from \"./Credentials.ts\";\nimport { registerDevelopmentClient } from \"./HubClient.ts\";\nimport { ManagementApiLive } from \"./ManagementApi.ts\";\nimport { installedCli } from \"./Push.ts\";\n\nconst { positionals, values } = parseArgs({\n  allowPositionals: true,\n  options: {\n    team: { type: \"string\" },\n    app: { type: \"string\" },\n    \"callback-path\": { type: \"string\" },\n  },\n});\nconst { team, app, \"callback-path\": callbackPath } = values;\nif (\n  positionals.join(\" \") !== \"hub-client\" ||\n  team === undefined ||\n  app === undefined ||\n  callbackPath === undefined\n) {\n  console.error(\n    \"Usage: alchemy-convex hub-client --team <team> --app <app> --callback-path <path>\",\n  );\n  process.exit(1);\n}\n\nconst program = Effect.gen(function* () {\n  const [command, ...prefix] = yield* installedCli(process.cwd());\n  const callbackUrl = yield* registerDevelopmentClient({\n    team,\n    app,\n    callbackPath,\n    convex: (args, input) =>\n      execFileSync(command, [...prefix, ...args], {\n        encoding: \"utf8\",\n        input,\n        stdio: [\"pipe\", \"pipe\", \"inherit\"],\n      }).trim(),\n  });\n  console.log(\n    callbackUrl === undefined\n      ? \"Hub client already registered.\"\n      : `Hub client registered for ${callbackUrl}.`,\n  );\n}).pipe(Effect.provide(ManagementApiLive().pipe(Layer.provide(fromConfig()))));\n\nawait Effect.runPromise(program).catch((error: unknown) => {\n  console.error(error instanceof Error ? error.message : String(error));\n  process.exit(1);\n});\n"],"mappings":";;;;;;;AAiBA,MAAM,EAAE,aAAa,WAAW,UAAU;CACxC,kBAAkB;CAClB,SAAS;EACP,MAAM,EAAE,MAAM,SAAS;EACvB,KAAK,EAAE,MAAM,SAAS;EACtB,iBAAiB,EAAE,MAAM,SAAS;CACpC;AACF,CAAC;AACD,MAAM,EAAE,MAAM,KAAK,iBAAiB,iBAAiB;AACrD,IACE,YAAY,KAAK,GAAG,MAAM,gBAC1B,SAAS,KAAA,KACT,QAAQ,KAAA,KACR,iBAAiB,KAAA,GACjB;CACA,QAAQ,MACN,mFACF;CACA,QAAQ,KAAK,CAAC;AAChB;AAEA,MAAM,UAAU,OAAO,IAAI,aAAa;CACtC,MAAM,CAAC,SAAS,GAAG,UAAU,OAAO,aAAa,QAAQ,IAAI,CAAC;CAC9D,MAAM,cAAc,OAAO,0BAA0B;EACnD;EACA;EACA;EACA,SAAS,MAAM,UACb,aAAa,SAAS,CAAC,GAAG,QAAQ,GAAG,IAAI,GAAG;GAC1C,UAAU;GACV;GACA,OAAO;IAAC;IAAQ;IAAQ;GAAS;EACnC,CAAC,CAAC,CAAC,KAAK;CACZ,CAAC;CACD,QAAQ,IACN,gBAAgB,KAAA,IACZ,mCACA,6BAA6B,YAAY,EAC/C;AACF,CAAC,CAAC,CAAC,KAAK,OAAO,QAAQ,kBAAkB,CAAC,CAAC,KAAK,MAAM,QAAQ,WAAW,CAAC,CAAC,CAAC,CAAC;AAE7E,MAAM,OAAO,WAAW,OAAO,CAAC,CAAC,OAAO,UAAmB;CACzD,QAAQ,MAAM,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,CAAC;CACpE,QAAQ,KAAK,CAAC;AAChB,CAAC"}
+{"version":3,"file":"cli.js","names":[],"sources":["../src/StackComment.ts","../src/cli.ts"],"sourcesContent":["// The command `alchemy-convex stack-comment`: one comment on a pull request with the stacks of the\n// repository, read from the state store after the deploys.\n//\n// A stack sees only itself, so a comment that a stack declares cannot show the other stacks of the\n// repository. This command runs as a step after them and reads each stack named `owner/name` or\n// `owner/name/<folder>` that has the stage `pr-<number>`. A stack without that stage has no card. A\n// run replaces the whole body, so the last run shows the newest state.\n//\n// It reads only the fields of the rows below, because Alchemy state holds secrets in clear text.\n//\n// GitHub keeps a fixed set of HTML in a comment and removes `style` and `class`, so every choice of\n// the markup is a fact about the sanitizer or the CSS of github.com:\n// - A table has `display: block` and `width: max-content`, so a `width` on it does nothing. The\n//   spacer, a floated image one pixel high in a block of its own, gives every card one width, and\n//   it shrinks on a narrow page.\n// - The CSS colors the even rows of a group, so each row has its own `tbody`.\n// - An HTML block ends at a blank line, so a table has none and is not indented.\n// - A bare image links to its raw file, and one link around an image and text underlines the space\n//   between them, so the icon and the name are two links to one place.\n// - An image with `height` gets a gray background, so each icon is square and has only `width`.\n// - `align=\"middle\"` is `-webkit-baseline-middle` in Chrome, which is below the text.\n//   `align=\"absmiddle\"` is the CSS value `middle`.\nimport { State } from \"alchemy/State\";\nimport * as Effect from \"effect/Effect\";\nimport * as Schema from \"effect/Schema\";\nimport { RUN_RECORD_KEY, runRecord } from \"./RunRecord.ts\";\n\n/** The first text of the comment, which finds it again. */\nconst MARKER = \"<!-- samebase-stacks -->\";\n\n/** GitHub does not proxy this host, so a new icon needs no purge of its image cache. */\nconst ICONS = \"https://raw.githubusercontent.com/samebase/alchemy-convex/main/assets/stack-comment\";\n\nconst GITHUB_API = \"https://api.github.com\";\n\n/** The resources that a card shows. A row of any other type, or without `attr` from an interrupted deploy, is left out. */\nconst Resource = Schema.Union([\n  Schema.Struct({\n    resourceType: Schema.Literal(\"Convex.Deployment\"),\n    attr: Schema.Struct({ name: Schema.String, siteUrl: Schema.String }),\n  }),\n  Schema.Struct({\n    resourceType: Schema.Literal(\"Cloudflare.Worker\"),\n    attr: Schema.Struct({ workerName: Schema.String, url: Schema.optional(Schema.String) }),\n  }),\n  Schema.Struct({\n    resourceType: Schema.Literal(\"Cloudflare.R2.Bucket\"),\n    attr: Schema.Struct({\n      bucketName: Schema.String,\n      accountId: Schema.String,\n      jurisdiction: Schema.String,\n    }),\n  }),\n]);\ntype Resource = typeof Resource.Type;\n\n/** The fields of the run record that a card shows. */\nconst StageOutput = Schema.Struct({\n  [RUN_RECORD_KEY]: Schema.Struct({\n    headCommit: Schema.String,\n    runUrl: Schema.NullOr(Schema.String),\n    recordedAt: Schema.String,\n  }),\n});\n\nexport interface StackCard {\n  readonly name: string;\n  readonly stage: string;\n  readonly resources: readonly Resource[];\n  readonly run: typeof StageOutput.Type | null;\n}\n\nexport class StackCommentError extends Schema.TaggedError<StackCommentError>()(\n  \"StackCommentError\",\n  { reason: Schema.String },\n) {\n  override get message() {\n    return `The stack comment cannot be updated: ${this.reason}`;\n  }\n}\n\n/** The cards of the stacks of `repository` that have `stage`, in name order. */\nexport const readStackCards = ({ repository, stage }: { repository: string; stage: string }) =>\n  Effect.gen(function* () {\n    const state = yield* yield* State;\n    const names = (yield* state.listStacks()).filter(\n      (name) => name === repository || name.startsWith(`${repository}/`),\n    );\n    const cards: StackCard[] = [];\n    for (const name of names) {\n      if (!(yield* state.listStages(name)).includes(stage)) {\n        continue;\n      }\n      const request = { stack: name, stage };\n      const rows = yield* Effect.forEach(yield* state.list(request), (fqn) =>\n        state.get({ ...request, fqn }),\n      );\n      const output = yield* state.getOutput(request);\n      cards.push({\n        name,\n        stage,\n        resources: rows.filter(Schema.is(Resource)),\n        run: Schema.is(StageOutput)(output) ? output : null,\n      });\n    }\n    return cards;\n  });\n\n/** A stack can create a deployment in one resource and push to it in another: a card shows it once. */\nconst withoutRepeats = (resources: readonly Resource[]) => {\n  const deployments = new Set<string>();\n  return resources.filter((resource) => {\n    if (resource.resourceType !== \"Convex.Deployment\") {\n      return true;\n    }\n    const repeated = deployments.has(resource.attr.name);\n    deployments.add(resource.attr.name);\n    return !repeated;\n  });\n};\n\nconst escapeHtml = (text: string) =>\n  text\n    .replaceAll(\"&\", \"&amp;\")\n    .replaceAll(\"<\", \"&lt;\")\n    .replaceAll(\">\", \"&gt;\")\n    .replaceAll('\"', \"&quot;\");\n\nconst link = (href: string, text: string) => `<a href=\"${escapeHtml(href)}\">${text}</a>`;\n\nconst named = (href: string, icon: string, alt: string, name: string) => {\n  const image = `<img src=\"${ICONS}/${icon}.svg\" width=\"16\" align=\"absmiddle\" alt=\"${alt}\">`;\n  return `${link(href, image)} ${link(href, escapeHtml(name))}`;\n};\n\nconst hostOf = (url: string) => escapeHtml(new URL(url).host);\n\n/** Where a stack serves: its Convex deployment, else its first Worker with a URL. */\nconst addressOf = (resources: readonly Resource[]) => {\n  for (const resource of resources) {\n    if (resource.resourceType === \"Convex.Deployment\") {\n      return resource.attr.siteUrl;\n    }\n  }\n  for (const resource of resources) {\n    if (resource.resourceType === \"Cloudflare.Worker\" && resource.attr.url !== undefined) {\n      return resource.attr.url;\n    }\n  }\n  return null;\n};\n\nconst resourceRow = (resource: Resource, address: string | null) => {\n  switch (resource.resourceType) {\n    case \"Convex.Deployment\": {\n      const { name } = resource.attr;\n      return named(\n        `https://dashboard.convex.dev/d/${encodeURIComponent(name)}`,\n        \"convex\",\n        \"Convex\",\n        name,\n      );\n    }\n    case \"Cloudflare.Worker\": {\n      const { url, workerName } = resource.attr;\n      const row = named(\n        `https://dash.cloudflare.com/?to=/:account/workers/services/view/${encodeURIComponent(workerName)}`,\n        \"worker\",\n        \"Worker\",\n        workerName,\n      );\n      return url === undefined || url === address\n        ? row\n        : `${row}<br><sub>${link(url, hostOf(url))}</sub>`;\n    }\n    case \"Cloudflare.R2.Bucket\": {\n      const { accountId, bucketName, jurisdiction } = resource.attr;\n      return named(\n        `https://dash.cloudflare.com/${encodeURIComponent(accountId)}/r2/${encodeURIComponent(jurisdiction)}/buckets/${encodeURIComponent(bucketName)}`,\n        \"r2\",\n        \"R2 bucket\",\n        bucketName,\n      );\n    }\n  }\n};\n\nconst runLine = ({ run }: StackCard) => {\n  if (run === null) {\n    return \"\";\n  }\n  const { headCommit, recordedAt, runUrl } = run[RUN_RECORD_KEY];\n  const commit = escapeHtml(headCommit.slice(0, 7));\n  const time = `${recordedAt.slice(0, 16).replace(\"T\", \" \")} UTC`;\n  return `<br><sub>${runUrl === null ? commit : link(runUrl, commit)} ${escapeHtml(time)}</sub>`;\n};\n\nconst SPACER = `<div><img src=\"${ICONS}/spacer.svg\" width=\"460\" align=\"left\" alt=\"\"></div>`;\n\n/** `alone`: the one card of the repository. A card at the root then has no folder, as on the repository page. */\nconst renderCard = (card: StackCard, repository: string, alone: boolean) => {\n  const folder = card.name.slice(repository.length + 1);\n  const heading = [\n    folder === \"\" && alone ? \"\" : `<b>${escapeHtml(folder || \"/\")}</b> `,\n    `<sub>${escapeHtml(card.stage)}</sub>`,\n  ].join(\"\");\n  const resources = withoutRepeats(card.resources);\n  const address = addressOf(resources);\n  const addressLine = address === null ? \"\" : `<br>${link(address, hostOf(address))}`;\n  const rows = resources\n    .map((resource) => `<tbody><tr><td>${resourceRow(resource, address)}</td></tr></tbody>`)\n    .join(\"\\n\");\n  return `<table>\n<tbody><tr><td>${SPACER}${heading}${addressLine}${runLine(card)}</td></tr></tbody>\n${rows}\n</table>`;\n};\n\nexport const renderStackComment = (cards: readonly StackCard[], repository: string) => `${MARKER}\n${cards.map((card) => renderCard(card, repository, cards.length === 1)).join(\"\\n\\n\")}\n`;\n\nconst Comments = Schema.Array(Schema.Struct({ id: Schema.Number, body: Schema.String }));\nconst SavedComment = Schema.Struct({ html_url: Schema.String });\n\nconst github = (token: string, path: string, init: { method: string; body?: string }) =>\n  Effect.tryPromise({\n    try: async (): Promise<unknown> => {\n      const response = await fetch(`${GITHUB_API}${path}`, {\n        ...init,\n        headers: {\n          Accept: \"application/vnd.github+json\",\n          Authorization: `Bearer ${token}`,\n          \"Content-Type\": \"application/json\",\n          \"X-GitHub-Api-Version\": \"2022-11-28\",\n        },\n      });\n      if (!response.ok) {\n        throw new Error(`HTTP ${response.status}`);\n      }\n      return await response.json();\n    },\n    catch: (error) =>\n      new StackCommentError({\n        reason: `GitHub ${init.method} ${path} failed (${error instanceof Error ? error.message : String(error)})`,\n      }),\n  });\n\nconst decode =\n  <S extends Schema.Codec<unknown, unknown>>(schema: S, what: string) =>\n  (value: unknown) =>\n    Schema.decodeUnknownEffect(schema)(value).pipe(\n      Effect.mapError(() => new StackCommentError({ reason: `GitHub gave a bad ${what}` })),\n    );\n\nconst findComment = (token: string, path: string) =>\n  Effect.gen(function* () {\n    for (let page = 1; ; page += 1) {\n      const comments = yield* github(token, `${path}?per_page=100&page=${page}`, {\n        method: \"GET\",\n      }).pipe(Effect.flatMap(decode(Comments, \"comment list\")));\n      const comment = comments.find(({ body }) => body.startsWith(MARKER));\n      if (comment !== undefined || comments.length < 100) {\n        return comment;\n      }\n    }\n  });\n\n/** Replaces the body of the comment of this command, or posts it on the first run, and gives its URL. */\nexport const saveStackComment = (args: {\n  readonly token: string;\n  readonly repository: string;\n  readonly pullRequest: number;\n  readonly body: string;\n}) =>\n  Effect.gen(function* () {\n    const { body, pullRequest, repository, token } = args;\n    const comments = `/repos/${repository}/issues/${pullRequest}/comments`;\n    const comment = yield* findComment(token, comments);\n    const reply = yield* comment === undefined\n      ? github(token, comments, { method: \"POST\", body: JSON.stringify({ body }) })\n      : github(token, `/repos/${repository}/issues/comments/${comment.id}`, {\n          method: \"PATCH\",\n          body: JSON.stringify({ body }),\n        });\n    const saved = yield* decode(SavedComment, \"comment\")(reply);\n    return saved.html_url;\n  });\n\n/** The step of a workflow: the run record names the repository and the pull request of the run. */\nexport const updateStackComment = Effect.gen(function* () {\n  const { pullRequest, repository } = yield* runRecord({ cwd: process.cwd(), env: process.env });\n  if (pullRequest === null) {\n    return yield* new StackCommentError({ reason: \"this run has no pull request\" });\n  }\n  const token = process.env[\"GITHUB_TOKEN\"];\n  if (token === undefined || token === \"\") {\n    return yield* new StackCommentError({ reason: \"GITHUB_TOKEN is not set\" });\n  }\n  const cards = yield* readStackCards({ repository, stage: `pr-${pullRequest}` });\n  return yield* saveStackComment({\n    token,\n    repository,\n    pullRequest,\n    body: renderStackComment(cards, repository),\n  });\n});\n","#!/usr/bin/env node\n// The commands of the package:\n//\n//   alchemy-convex hub-client --team <team> --app <app> --callback-path <path>\n//   alchemy-convex stack-comment [--team <team>]\n//\n// hub-client runs in the directory of a Convex app, and gives the development deployment of that\n// directory a client of the identity hub of the team: see registerDevelopmentClient. stack-comment\n// runs as a step of a pull request workflow after the deploys, and keeps one comment with the stacks\n// of the repository: see src/StackComment.ts. It needs GITHUB_TOKEN and, with a team access token,\n// no --team. Both use CONVEX_ACCESS_TOKEN or the Convex CLI login.\nimport { execFileSync } from \"node:child_process\";\nimport { parseArgs } from \"node:util\";\nimport * as NodeServices from \"@effect/platform-node/NodeServices\";\nimport * as Effect from \"effect/Effect\";\nimport * as Layer from \"effect/Layer\";\nimport { fromConfig } from \"./Credentials.ts\";\nimport { registerDevelopmentClient } from \"./HubClient.ts\";\nimport { ManagementApiLive } from \"./ManagementApi.ts\";\nimport { installedCli } from \"./Push.ts\";\nimport { updateStackComment } from \"./StackComment.ts\";\nimport { state } from \"./State.ts\";\n\nconst { positionals, values } = parseArgs({\n  allowPositionals: true,\n  options: {\n    team: { type: \"string\" },\n    app: { type: \"string\" },\n    \"callback-path\": { type: \"string\" },\n  },\n});\nconst { team, app, \"callback-path\": callbackPath } = values;\nconst USAGE = `Usage:\n  alchemy-convex hub-client --team <team> --app <app> --callback-path <path>\n  alchemy-convex stack-comment [--team <team>]`;\n\nconst hubClient = (hub: { team: string; app: string; callbackPath: string }) =>\n  Effect.gen(function* () {\n    const [command, ...prefix] = yield* installedCli(process.cwd());\n    const callbackUrl = yield* registerDevelopmentClient({\n      ...hub,\n      convex: (args, input) =>\n        execFileSync(command, [...prefix, ...args], {\n          encoding: \"utf8\",\n          input,\n          stdio: [\"pipe\", \"pipe\", \"inherit\"],\n        }).trim(),\n    });\n    console.log(\n      callbackUrl === undefined\n        ? \"Hub client already registered.\"\n        : `Hub client registered for ${callbackUrl}.`,\n    );\n  }).pipe(Effect.provide(ManagementApiLive().pipe(Layer.provide(fromConfig()))));\n\nconst stackComment = (options: { team?: string }) =>\n  updateStackComment.pipe(\n    Effect.tap((url) => Effect.sync(() => console.log(url))),\n    Effect.provide(state(options).pipe(Layer.provide(NodeServices.layer))),\n  );\n\nconst subcommand = positionals.join(\" \");\nconst program: Effect.Effect<unknown, unknown> | undefined =\n  subcommand === \"stack-comment\"\n    ? stackComment(team === undefined ? {} : { team })\n    : subcommand === \"hub-client\" &&\n        team !== undefined &&\n        app !== undefined &&\n        callbackPath !== undefined\n      ? hubClient({ team, app, callbackPath })\n      : undefined;\nif (program === undefined) {\n  console.error(USAGE);\n  process.exit(1);\n}\n\nawait Effect.runPromise(program).catch((error: unknown) => {\n  console.error(error instanceof Error ? error.message : String(error));\n  process.exit(1);\n});\n"],"mappings":";;;;;;;;;;;AA4BA,MAAM,SAAS;;AAGf,MAAM,QAAQ;AAEd,MAAM,aAAa;;AAGnB,MAAM,WAAW,OAAO,MAAM;CAC5B,OAAO,OAAO;EACZ,cAAc,OAAO,QAAQ,mBAAmB;EAChD,MAAM,OAAO,OAAO;GAAE,MAAM,OAAO;GAAQ,SAAS,OAAO;EAAO,CAAC;CACrE,CAAC;CACD,OAAO,OAAO;EACZ,cAAc,OAAO,QAAQ,mBAAmB;EAChD,MAAM,OAAO,OAAO;GAAE,YAAY,OAAO;GAAQ,KAAK,OAAO,SAAS,OAAO,MAAM;EAAE,CAAC;CACxF,CAAC;CACD,OAAO,OAAO;EACZ,cAAc,OAAO,QAAQ,sBAAsB;EACnD,MAAM,OAAO,OAAO;GAClB,YAAY,OAAO;GACnB,WAAW,OAAO;GAClB,cAAc,OAAO;EACvB,CAAC;CACH,CAAC;AACH,CAAC;;AAID,MAAM,cAAc,OAAO,OAAO,GAC/B,iBAAiB,OAAO,OAAO;CAC9B,YAAY,OAAO;CACnB,QAAQ,OAAO,OAAO,OAAO,MAAM;CACnC,YAAY,OAAO;AACrB,CAAC,EACH,CAAC;AASD,IAAa,oBAAb,cAAuC,OAAO,YAA+B,CAAC,CAC5E,qBACA,EAAE,QAAQ,OAAO,OAAO,CAC1B,CAAC,CAAC;CACA,IAAa,UAAU;EACrB,OAAO,wCAAwC,KAAK;CACtD;AACF;;AAGA,MAAa,kBAAkB,EAAE,YAAY,YAC3C,OAAO,IAAI,aAAa;CACtB,MAAM,QAAQ,OAAO,OAAO;CAC5B,MAAM,SAAS,OAAO,MAAM,WAAW,EAAA,CAAG,QACvC,SAAS,SAAS,cAAc,KAAK,WAAW,GAAG,WAAW,EAAE,CACnE;CACA,MAAM,QAAqB,CAAC;CAC5B,KAAK,MAAM,QAAQ,OAAO;EACxB,IAAI,EAAE,OAAO,MAAM,WAAW,IAAI,EAAA,CAAG,SAAS,KAAK,GACjD;EAEF,MAAM,UAAU;GAAE,OAAO;GAAM;EAAM;EACrC,MAAM,OAAO,OAAO,OAAO,QAAQ,OAAO,MAAM,KAAK,OAAO,IAAI,QAC9D,MAAM,IAAI;GAAE,GAAG;GAAS;EAAI,CAAC,CAC/B;EACA,MAAM,SAAS,OAAO,MAAM,UAAU,OAAO;EAC7C,MAAM,KAAK;GACT;GACA;GACA,WAAW,KAAK,OAAO,OAAO,GAAG,QAAQ,CAAC;GAC1C,KAAK,OAAO,GAAG,WAAW,CAAC,CAAC,MAAM,IAAI,SAAS;EACjD,CAAC;CACH;CACA,OAAO;AACT,CAAC;;AAGH,MAAM,kBAAkB,cAAmC;CACzD,MAAM,8BAAc,IAAI,IAAY;CACpC,OAAO,UAAU,QAAQ,aAAa;EACpC,IAAI,SAAS,iBAAiB,qBAC5B,OAAO;EAET,MAAM,WAAW,YAAY,IAAI,SAAS,KAAK,IAAI;EACnD,YAAY,IAAI,SAAS,KAAK,IAAI;EAClC,OAAO,CAAC;CACV,CAAC;AACH;AAEA,MAAM,cAAc,SAClB,KACG,WAAW,KAAK,OAAO,CAAC,CACxB,WAAW,KAAK,MAAM,CAAC,CACvB,WAAW,KAAK,MAAM,CAAC,CACvB,WAAW,MAAK,QAAQ;AAE7B,MAAM,QAAQ,MAAc,SAAiB,YAAY,WAAW,IAAI,EAAE,IAAI,KAAK;AAEnF,MAAM,SAAS,MAAc,MAAc,KAAa,SAAiB;CACvE,MAAM,QAAQ,aAAa,MAAM,GAAG,KAAK,0CAA0C,IAAI;CACvF,OAAO,GAAG,KAAK,MAAM,KAAK,EAAE,GAAG,KAAK,MAAM,WAAW,IAAI,CAAC;AAC5D;AAEA,MAAM,UAAU,QAAgB,WAAW,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI;;AAG5D,MAAM,aAAa,cAAmC;CACpD,KAAK,MAAM,YAAY,WACrB,IAAI,SAAS,iBAAiB,qBAC5B,OAAO,SAAS,KAAK;CAGzB,KAAK,MAAM,YAAY,WACrB,IAAI,SAAS,iBAAiB,uBAAuB,SAAS,KAAK,QAAQ,KAAA,GACzE,OAAO,SAAS,KAAK;CAGzB,OAAO;AACT;AAEA,MAAM,eAAe,UAAoB,YAA2B;CAClE,QAAQ,SAAS,cAAjB;EACE,KAAK,qBAAqB;GACxB,MAAM,EAAE,SAAS,SAAS;GAC1B,OAAO,MACL,kCAAkC,mBAAmB,IAAI,KACzD,UACA,UACA,IACF;EACF;EACA,KAAK,qBAAqB;GACxB,MAAM,EAAE,KAAK,eAAe,SAAS;GACrC,MAAM,MAAM,MACV,mEAAmE,mBAAmB,UAAU,KAChG,UACA,UACA,UACF;GACA,OAAO,QAAQ,KAAA,KAAa,QAAQ,UAChC,MACA,GAAG,IAAI,WAAW,KAAK,KAAK,OAAO,GAAG,CAAC,EAAE;EAC/C;EACA,KAAK,wBAAwB;GAC3B,MAAM,EAAE,WAAW,YAAY,iBAAiB,SAAS;GACzD,OAAO,MACL,+BAA+B,mBAAmB,SAAS,EAAE,MAAM,mBAAmB,YAAY,EAAE,WAAW,mBAAmB,UAAU,KAC5I,MACA,aACA,UACF;EACF;CACF;AACF;AAEA,MAAM,WAAW,EAAE,UAAqB;CACtC,IAAI,QAAQ,MACV,OAAO;CAET,MAAM,EAAE,YAAY,YAAY,WAAW,IAAI;CAC/C,MAAM,SAAS,WAAW,WAAW,MAAM,GAAG,CAAC,CAAC;CAChD,MAAM,OAAO,GAAG,WAAW,MAAM,GAAG,EAAE,CAAC,CAAC,QAAQ,KAAK,GAAG,EAAE;CAC1D,OAAO,YAAY,WAAW,OAAO,SAAS,KAAK,QAAQ,MAAM,EAAE,GAAG,WAAW,IAAI,EAAE;AACzF;AAEA,MAAM,SAAS,kBAAkB,MAAM;;AAGvC,MAAM,cAAc,MAAiB,YAAoB,UAAmB;CAC1E,MAAM,SAAS,KAAK,KAAK,MAAM,WAAW,SAAS,CAAC;CACpD,MAAM,UAAU,CACd,WAAW,MAAM,QAAQ,KAAK,MAAM,WAAW,UAAU,GAAG,EAAE,QAC9D,QAAQ,WAAW,KAAK,KAAK,EAAE,OACjC,CAAC,CAAC,KAAK,EAAE;CACT,MAAM,YAAY,eAAe,KAAK,SAAS;CAC/C,MAAM,UAAU,UAAU,SAAS;CACnC,MAAM,cAAc,YAAY,OAAO,KAAK,OAAO,KAAK,SAAS,OAAO,OAAO,CAAC;CAChF,MAAM,OAAO,UACV,KAAK,aAAa,kBAAkB,YAAY,UAAU,OAAO,EAAE,mBAAmB,CAAC,CACvF,KAAK,IAAI;CACZ,OAAO;iBACQ,SAAS,UAAU,cAAc,QAAQ,IAAI,EAAE;EAC9D,KAAK;;AAEP;AAEA,MAAa,sBAAsB,OAA6B,eAAuB,GAAG,OAAO;EAC/F,MAAM,KAAK,SAAS,WAAW,MAAM,YAAY,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;;AAGrF,MAAM,WAAW,OAAO,MAAM,OAAO,OAAO;CAAE,IAAI,OAAO;CAAQ,MAAM,OAAO;AAAO,CAAC,CAAC;AACvF,MAAM,eAAe,OAAO,OAAO,EAAE,UAAU,OAAO,OAAO,CAAC;AAE9D,MAAM,UAAU,OAAe,MAAc,SAC3C,OAAO,WAAW;CAChB,KAAK,YAA8B;EACjC,MAAM,WAAW,MAAM,MAAM,GAAG,aAAa,QAAQ;GACnD,GAAG;GACH,SAAS;IACP,QAAQ;IACR,eAAe,UAAU;IACzB,gBAAgB;IAChB,wBAAwB;GAC1B;EACF,CAAC;EACD,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,QAAQ,SAAS,QAAQ;EAE3C,OAAO,MAAM,SAAS,KAAK;CAC7B;CACA,QAAQ,UACN,IAAI,kBAAkB,EACpB,QAAQ,UAAU,KAAK,OAAO,GAAG,KAAK,WAAW,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EAAE,GAC1G,CAAC;AACL,CAAC;AAEH,MAAM,UACuC,QAAW,UACrD,UACC,OAAO,oBAAoB,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,KACxC,OAAO,eAAe,IAAI,kBAAkB,EAAE,QAAQ,qBAAqB,OAAO,CAAC,CAAC,CACtF;AAEJ,MAAM,eAAe,OAAe,SAClC,OAAO,IAAI,aAAa;CACtB,KAAK,IAAI,OAAO,IAAK,QAAQ,GAAG;EAC9B,MAAM,WAAW,OAAO,OAAO,OAAO,GAAG,KAAK,qBAAqB,QAAQ,EACzE,QAAQ,MACV,CAAC,CAAC,CAAC,KAAK,OAAO,QAAQ,OAAO,UAAU,cAAc,CAAC,CAAC;EACxD,MAAM,UAAU,SAAS,MAAM,EAAE,WAAW,KAAK,WAAW,MAAM,CAAC;EACnE,IAAI,YAAY,KAAA,KAAa,SAAS,SAAS,KAC7C,OAAO;CAEX;AACF,CAAC;;AAGH,MAAa,oBAAoB,SAM/B,OAAO,IAAI,aAAa;CACtB,MAAM,EAAE,MAAM,aAAa,YAAY,UAAU;CACjD,MAAM,WAAW,UAAU,WAAW,UAAU,YAAY;CAC5D,MAAM,UAAU,OAAO,YAAY,OAAO,QAAQ;CAClD,MAAM,QAAQ,OAAO,YAAY,KAAA,IAC7B,OAAO,OAAO,UAAU;EAAE,QAAQ;EAAQ,MAAM,KAAK,UAAU,EAAE,KAAK,CAAC;CAAE,CAAC,IAC1E,OAAO,OAAO,UAAU,WAAW,mBAAmB,QAAQ,MAAM;EAClE,QAAQ;EACR,MAAM,KAAK,UAAU,EAAE,KAAK,CAAC;CAC/B,CAAC;CAEL,QAAO,OADc,OAAO,cAAc,SAAS,CAAC,CAAC,KAAK,EAAA,CAC7C;AACf,CAAC;;AAGH,MAAa,qBAAqB,OAAO,IAAI,aAAa;CACxD,MAAM,EAAE,aAAa,eAAe,OAAO,UAAU;EAAE,KAAK,QAAQ,IAAI;EAAG,KAAK,QAAQ;CAAI,CAAC;CAC7F,IAAI,gBAAgB,MAClB,OAAO,OAAO,IAAI,kBAAkB,EAAE,QAAQ,+BAA+B,CAAC;CAEhF,MAAM,QAAQ,QAAQ,IAAI;CAC1B,IAAI,UAAU,KAAA,KAAa,UAAU,IACnC,OAAO,OAAO,IAAI,kBAAkB,EAAE,QAAQ,0BAA0B,CAAC;CAE3E,MAAM,QAAQ,OAAO,eAAe;EAAE;EAAY,OAAO,MAAM;CAAc,CAAC;CAC9E,OAAO,OAAO,iBAAiB;EAC7B;EACA;EACA;EACA,MAAM,mBAAmB,OAAO,UAAU;CAC5C,CAAC;AACH,CAAC;;;AC3RD,MAAM,EAAE,aAAa,WAAW,UAAU;CACxC,kBAAkB;CAClB,SAAS;EACP,MAAM,EAAE,MAAM,SAAS;EACvB,KAAK,EAAE,MAAM,SAAS;EACtB,iBAAiB,EAAE,MAAM,SAAS;CACpC;AACF,CAAC;AACD,MAAM,EAAE,MAAM,KAAK,iBAAiB,iBAAiB;AACrD,MAAM,QAAQ;;;AAId,MAAM,aAAa,QACjB,OAAO,IAAI,aAAa;CACtB,MAAM,CAAC,SAAS,GAAG,UAAU,OAAO,aAAa,QAAQ,IAAI,CAAC;CAC9D,MAAM,cAAc,OAAO,0BAA0B;EACnD,GAAG;EACH,SAAS,MAAM,UACb,aAAa,SAAS,CAAC,GAAG,QAAQ,GAAG,IAAI,GAAG;GAC1C,UAAU;GACV;GACA,OAAO;IAAC;IAAQ;IAAQ;GAAS;EACnC,CAAC,CAAC,CAAC,KAAK;CACZ,CAAC;CACD,QAAQ,IACN,gBAAgB,KAAA,IACZ,mCACA,6BAA6B,YAAY,EAC/C;AACF,CAAC,CAAC,CAAC,KAAK,OAAO,QAAQ,kBAAkB,CAAC,CAAC,KAAK,MAAM,QAAQ,WAAW,CAAC,CAAC,CAAC,CAAC;AAE/E,MAAM,gBAAgB,YACpB,mBAAmB,KACjB,OAAO,KAAK,QAAQ,OAAO,WAAW,QAAQ,IAAI,GAAG,CAAC,CAAC,GACvD,OAAO,QAAQ,MAAM,OAAO,CAAC,CAAC,KAAK,MAAM,QAAQ,aAAa,KAAK,CAAC,CAAC,CACvE;AAEF,MAAM,aAAa,YAAY,KAAK,GAAG;AACvC,MAAM,UACJ,eAAe,kBACX,aAAa,SAAS,KAAA,IAAY,CAAC,IAAI,EAAE,KAAK,CAAC,IAC/C,eAAe,gBACb,SAAS,KAAA,KACT,QAAQ,KAAA,KACR,iBAAiB,KAAA,IACjB,UAAU;CAAE;CAAM;CAAK;AAAa,CAAC,IACrC,KAAA;AACR,IAAI,YAAY,KAAA,GAAW;CACzB,QAAQ,MAAM,KAAK;CACnB,QAAQ,KAAK,CAAC;AAChB;AAEA,MAAM,OAAO,WAAW,OAAO,CAAC,CAAC,OAAO,UAAmB;CACzD,QAAQ,MAAM,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,CAAC;CACpE,QAAQ,KAAK,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samebase/alchemy-convex",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "The Convex plane for Alchemy v2: projects, deployments, environment variables, and the push of the functions",
   "keywords": [
     "alchemy",

package/src/StackComment.ts

@@ -0,0 +1,307 @@
+// The command `alchemy-convex stack-comment`: one comment on a pull request with the stacks of the
+// repository, read from the state store after the deploys.
+//
+// A stack sees only itself, so a comment that a stack declares cannot show the other stacks of the
+// repository. This command runs as a step after them and reads each stack named `owner/name` or
+// `owner/name/<folder>` that has the stage `pr-<number>`. A stack without that stage has no card. A
+// run replaces the whole body, so the last run shows the newest state.
+//
+// It reads only the fields of the rows below, because Alchemy state holds secrets in clear text.
+//
+// GitHub keeps a fixed set of HTML in a comment and removes `style` and `class`, so every choice of
+// the markup is a fact about the sanitizer or the CSS of github.com:
+// - A table has `display: block` and `width: max-content`, so a `width` on it does nothing. The
+//   spacer, a floated image one pixel high in a block of its own, gives every card one width, and
+//   it shrinks on a narrow page.
+// - The CSS colors the even rows of a group, so each row has its own `tbody`.
+// - An HTML block ends at a blank line, so a table has none and is not indented.
+// - A bare image links to its raw file, and one link around an image and text underlines the space
+//   between them, so the icon and the name are two links to one place.
+// - An image with `height` gets a gray background, so each icon is square and has only `width`.
+// - `align="middle"` is `-webkit-baseline-middle` in Chrome, which is below the text.
+//   `align="absmiddle"` is the CSS value `middle`.
+import { State } from "alchemy/State";
+import * as Effect from "effect/Effect";
+import * as Schema from "effect/Schema";
+import { RUN_RECORD_KEY, runRecord } from "./RunRecord.ts";
+
+/** The first text of the comment, which finds it again. */
+const MARKER = "<!-- samebase-stacks -->";
+
+/** GitHub does not proxy this host, so a new icon needs no purge of its image cache. */
+const ICONS = "https://raw.githubusercontent.com/samebase/alchemy-convex/main/assets/stack-comment";
+
+const GITHUB_API = "https://api.github.com";
+
+/** The resources that a card shows. A row of any other type, or without `attr` from an interrupted deploy, is left out. */
+const Resource = Schema.Union([
+  Schema.Struct({
+    resourceType: Schema.Literal("Convex.Deployment"),
+    attr: Schema.Struct({ name: Schema.String, siteUrl: Schema.String }),
+  }),
+  Schema.Struct({
+    resourceType: Schema.Literal("Cloudflare.Worker"),
+    attr: Schema.Struct({ workerName: Schema.String, url: Schema.optional(Schema.String) }),
+  }),
+  Schema.Struct({
+    resourceType: Schema.Literal("Cloudflare.R2.Bucket"),
+    attr: Schema.Struct({
+      bucketName: Schema.String,
+      accountId: Schema.String,
+      jurisdiction: Schema.String,
+    }),
+  }),
+]);
+type Resource = typeof Resource.Type;
+
+/** The fields of the run record that a card shows. */
+const StageOutput = Schema.Struct({
+  [RUN_RECORD_KEY]: Schema.Struct({
+    headCommit: Schema.String,
+    runUrl: Schema.NullOr(Schema.String),
+    recordedAt: Schema.String,
+  }),
+});
+
+export interface StackCard {
+  readonly name: string;
+  readonly stage: string;
+  readonly resources: readonly Resource[];
+  readonly run: typeof StageOutput.Type | null;
+}
+
+export class StackCommentError extends Schema.TaggedError<StackCommentError>()(
+  "StackCommentError",
+  { reason: Schema.String },
+) {
+  override get message() {
+    return `The stack comment cannot be updated: ${this.reason}`;
+  }
+}
+
+/** The cards of the stacks of `repository` that have `stage`, in name order. */
+export const readStackCards = ({ repository, stage }: { repository: string; stage: string }) =>
+  Effect.gen(function* () {
+    const state = yield* yield* State;
+    const names = (yield* state.listStacks()).filter(
+      (name) => name === repository || name.startsWith(`${repository}/`),
+    );
+    const cards: StackCard[] = [];
+    for (const name of names) {
+      if (!(yield* state.listStages(name)).includes(stage)) {
+        continue;
+      }
+      const request = { stack: name, stage };
+      const rows = yield* Effect.forEach(yield* state.list(request), (fqn) =>
+        state.get({ ...request, fqn }),
+      );
+      const output = yield* state.getOutput(request);
+      cards.push({
+        name,
+        stage,
+        resources: rows.filter(Schema.is(Resource)),
+        run: Schema.is(StageOutput)(output) ? output : null,
+      });
+    }
+    return cards;
+  });
+
+/** A stack can create a deployment in one resource and push to it in another: a card shows it once. */
+const withoutRepeats = (resources: readonly Resource[]) => {
+  const deployments = new Set<string>();
+  return resources.filter((resource) => {
+    if (resource.resourceType !== "Convex.Deployment") {
+      return true;
+    }
+    const repeated = deployments.has(resource.attr.name);
+    deployments.add(resource.attr.name);
+    return !repeated;
+  });
+};
+
+const escapeHtml = (text: string) =>
+  text
+    .replaceAll("&", "&amp;")
+    .replaceAll("<", "&lt;")
+    .replaceAll(">", "&gt;")
+    .replaceAll('"', "&quot;");
+
+const link = (href: string, text: string) => `<a href="${escapeHtml(href)}">${text}</a>`;
+
+const named = (href: string, icon: string, alt: string, name: string) => {
+  const image = `<img src="${ICONS}/${icon}.svg" width="16" align="absmiddle" alt="${alt}">`;
+  return `${link(href, image)} ${link(href, escapeHtml(name))}`;
+};
+
+const hostOf = (url: string) => escapeHtml(new URL(url).host);
+
+/** Where a stack serves: its Convex deployment, else its first Worker with a URL. */
+const addressOf = (resources: readonly Resource[]) => {
+  for (const resource of resources) {
+    if (resource.resourceType === "Convex.Deployment") {
+      return resource.attr.siteUrl;
+    }
+  }
+  for (const resource of resources) {
+    if (resource.resourceType === "Cloudflare.Worker" && resource.attr.url !== undefined) {
+      return resource.attr.url;
+    }
+  }
+  return null;
+};
+
+const resourceRow = (resource: Resource, address: string | null) => {
+  switch (resource.resourceType) {
+    case "Convex.Deployment": {
+      const { name } = resource.attr;
+      return named(
+        `https://dashboard.convex.dev/d/${encodeURIComponent(name)}`,
+        "convex",
+        "Convex",
+        name,
+      );
+    }
+    case "Cloudflare.Worker": {
+      const { url, workerName } = resource.attr;
+      const row = named(
+        `https://dash.cloudflare.com/?to=/:account/workers/services/view/${encodeURIComponent(workerName)}`,
+        "worker",
+        "Worker",
+        workerName,
+      );
+      return url === undefined || url === address
+        ? row
+        : `${row}<br><sub>${link(url, hostOf(url))}</sub>`;
+    }
+    case "Cloudflare.R2.Bucket": {
+      const { accountId, bucketName, jurisdiction } = resource.attr;
+      return named(
+        `https://dash.cloudflare.com/${encodeURIComponent(accountId)}/r2/${encodeURIComponent(jurisdiction)}/buckets/${encodeURIComponent(bucketName)}`,
+        "r2",
+        "R2 bucket",
+        bucketName,
+      );
+    }
+  }
+};
+
+const runLine = ({ run }: StackCard) => {
+  if (run === null) {
+    return "";
+  }
+  const { headCommit, recordedAt, runUrl } = run[RUN_RECORD_KEY];
+  const commit = escapeHtml(headCommit.slice(0, 7));
+  const time = `${recordedAt.slice(0, 16).replace("T", " ")} UTC`;
+  return `<br><sub>${runUrl === null ? commit : link(runUrl, commit)} ${escapeHtml(time)}</sub>`;
+};
+
+const SPACER = `<div><img src="${ICONS}/spacer.svg" width="460" align="left" alt=""></div>`;
+
+/** `alone`: the one card of the repository. A card at the root then has no folder, as on the repository page. */
+const renderCard = (card: StackCard, repository: string, alone: boolean) => {
+  const folder = card.name.slice(repository.length + 1);
+  const heading = [
+    folder === "" && alone ? "" : `<b>${escapeHtml(folder || "/")}</b> `,
+    `<sub>${escapeHtml(card.stage)}</sub>`,
+  ].join("");
+  const resources = withoutRepeats(card.resources);
+  const address = addressOf(resources);
+  const addressLine = address === null ? "" : `<br>${link(address, hostOf(address))}`;
+  const rows = resources
+    .map((resource) => `<tbody><tr><td>${resourceRow(resource, address)}</td></tr></tbody>`)
+    .join("\n");
+  return `<table>
+<tbody><tr><td>${SPACER}${heading}${addressLine}${runLine(card)}</td></tr></tbody>
+${rows}
+</table>`;
+};
+
+export const renderStackComment = (cards: readonly StackCard[], repository: string) => `${MARKER}
+${cards.map((card) => renderCard(card, repository, cards.length === 1)).join("\n\n")}
+`;
+
+const Comments = Schema.Array(Schema.Struct({ id: Schema.Number, body: Schema.String }));
+const SavedComment = Schema.Struct({ html_url: Schema.String });
+
+const github = (token: string, path: string, init: { method: string; body?: string }) =>
+  Effect.tryPromise({
+    try: async (): Promise<unknown> => {
+      const response = await fetch(`${GITHUB_API}${path}`, {
+        ...init,
+        headers: {
+          Accept: "application/vnd.github+json",
+          Authorization: `Bearer ${token}`,
+          "Content-Type": "application/json",
+          "X-GitHub-Api-Version": "2022-11-28",
+        },
+      });
+      if (!response.ok) {
+        throw new Error(`HTTP ${response.status}`);
+      }
+      return await response.json();
+    },
+    catch: (error) =>
+      new StackCommentError({
+        reason: `GitHub ${init.method} ${path} failed (${error instanceof Error ? error.message : String(error)})`,
+      }),
+  });
+
+const decode =
+  <S extends Schema.Codec<unknown, unknown>>(schema: S, what: string) =>
+  (value: unknown) =>
+    Schema.decodeUnknownEffect(schema)(value).pipe(
+      Effect.mapError(() => new StackCommentError({ reason: `GitHub gave a bad ${what}` })),
+    );
+
+const findComment = (token: string, path: string) =>
+  Effect.gen(function* () {
+    for (let page = 1; ; page += 1) {
+      const comments = yield* github(token, `${path}?per_page=100&page=${page}`, {
+        method: "GET",
+      }).pipe(Effect.flatMap(decode(Comments, "comment list")));
+      const comment = comments.find(({ body }) => body.startsWith(MARKER));
+      if (comment !== undefined || comments.length < 100) {
+        return comment;
+      }
+    }
+  });
+
+/** Replaces the body of the comment of this command, or posts it on the first run, and gives its URL. */
+export const saveStackComment = (args: {
+  readonly token: string;
+  readonly repository: string;
+  readonly pullRequest: number;
+  readonly body: string;
+}) =>
+  Effect.gen(function* () {
+    const { body, pullRequest, repository, token } = args;
+    const comments = `/repos/${repository}/issues/${pullRequest}/comments`;
+    const comment = yield* findComment(token, comments);
+    const reply = yield* comment === undefined
+      ? github(token, comments, { method: "POST", body: JSON.stringify({ body }) })
+      : github(token, `/repos/${repository}/issues/comments/${comment.id}`, {
+          method: "PATCH",
+          body: JSON.stringify({ body }),
+        });
+    const saved = yield* decode(SavedComment, "comment")(reply);
+    return saved.html_url;
+  });
+
+/** The step of a workflow: the run record names the repository and the pull request of the run. */
+export const updateStackComment = Effect.gen(function* () {
+  const { pullRequest, repository } = yield* runRecord({ cwd: process.cwd(), env: process.env });
+  if (pullRequest === null) {
+    return yield* new StackCommentError({ reason: "this run has no pull request" });
+  }
+  const token = process.env["GITHUB_TOKEN"];
+  if (token === undefined || token === "") {
+    return yield* new StackCommentError({ reason: "GITHUB_TOKEN is not set" });
+  }
+  const cards = yield* readStackCards({ repository, stage: `pr-${pullRequest}` });
+  return yield* saveStackComment({
+    token,
+    repository,
+    pullRequest,
+    body: renderStackComment(cards, repository),
+  });
+});

package/src/cli.ts

@@ -1,19 +1,25 @@
 #!/usr/bin/env node
-// The command of the package:
+// The commands of the package:
 //
 //   alchemy-convex hub-client --team <team> --app <app> --callback-path <path>
+//   alchemy-convex stack-comment [--team <team>]
 //
-// It runs in the directory of a Convex app, and gives the development deployment of that directory
-// a client of the identity hub of the team: see registerDevelopmentClient. It uses
-// CONVEX_ACCESS_TOKEN or the Convex CLI login.
+// hub-client runs in the directory of a Convex app, and gives the development deployment of that
+// directory a client of the identity hub of the team: see registerDevelopmentClient. stack-comment
+// runs as a step of a pull request workflow after the deploys, and keeps one comment with the stacks
+// of the repository: see src/StackComment.ts. It needs GITHUB_TOKEN and, with a team access token,
+// no --team. Both use CONVEX_ACCESS_TOKEN or the Convex CLI login.
 import { execFileSync } from "node:child_process";
 import { parseArgs } from "node:util";
+import * as NodeServices from "@effect/platform-node/NodeServices";
 import * as Effect from "effect/Effect";
 import * as Layer from "effect/Layer";
 import { fromConfig } from "./Credentials.ts";
 import { registerDevelopmentClient } from "./HubClient.ts";
 import { ManagementApiLive } from "./ManagementApi.ts";
 import { installedCli } from "./Push.ts";
+import { updateStackComment } from "./StackComment.ts";
+import { state } from "./State.ts";
 
 const { positionals, values } = parseArgs({
   allowPositionals: true,
@@ -24,38 +30,50 @@ const { positionals, values } = parseArgs({
   },
 });
 const { team, app, "callback-path": callbackPath } = values;
-if (
-  positionals.join(" ") !== "hub-client" ||
-  team === undefined ||
-  app === undefined ||
-  callbackPath === undefined
-) {
-  console.error(
-    "Usage: alchemy-convex hub-client --team <team> --app <app> --callback-path <path>",
+const USAGE = `Usage:
+  alchemy-convex hub-client --team <team> --app <app> --callback-path <path>
+  alchemy-convex stack-comment [--team <team>]`;
+
+const hubClient = (hub: { team: string; app: string; callbackPath: string }) =>
+  Effect.gen(function* () {
+    const [command, ...prefix] = yield* installedCli(process.cwd());
+    const callbackUrl = yield* registerDevelopmentClient({
+      ...hub,
+      convex: (args, input) =>
+        execFileSync(command, [...prefix, ...args], {
+          encoding: "utf8",
+          input,
+          stdio: ["pipe", "pipe", "inherit"],
+        }).trim(),
+    });
+    console.log(
+      callbackUrl === undefined
+        ? "Hub client already registered."
+        : `Hub client registered for ${callbackUrl}.`,
+    );
+  }).pipe(Effect.provide(ManagementApiLive().pipe(Layer.provide(fromConfig()))));
+
+const stackComment = (options: { team?: string }) =>
+  updateStackComment.pipe(
+    Effect.tap((url) => Effect.sync(() => console.log(url))),
+    Effect.provide(state(options).pipe(Layer.provide(NodeServices.layer))),
   );
+
+const subcommand = positionals.join(" ");
+const program: Effect.Effect<unknown, unknown> | undefined =
+  subcommand === "stack-comment"
+    ? stackComment(team === undefined ? {} : { team })
+    : subcommand === "hub-client" &&
+        team !== undefined &&
+        app !== undefined &&
+        callbackPath !== undefined
+      ? hubClient({ team, app, callbackPath })
+      : undefined;
+if (program === undefined) {
+  console.error(USAGE);
   process.exit(1);
 }
 
-const program = Effect.gen(function* () {
-  const [command, ...prefix] = yield* installedCli(process.cwd());
-  const callbackUrl = yield* registerDevelopmentClient({
-    team,
-    app,
-    callbackPath,
-    convex: (args, input) =>
-      execFileSync(command, [...prefix, ...args], {
-        encoding: "utf8",
-        input,
-        stdio: ["pipe", "pipe", "inherit"],
-      }).trim(),
-  });
-  console.log(
-    callbackUrl === undefined
-      ? "Hub client already registered."
-      : `Hub client registered for ${callbackUrl}.`,
-  );
-}).pipe(Effect.provide(ManagementApiLive().pipe(Layer.provide(fromConfig()))));
-
 await Effect.runPromise(program).catch((error: unknown) => {
   console.error(error instanceof Error ? error.message : String(error));
   process.exit(1);