@wtfalch/foundry 0.37.0 → 0.38.0

package/dist/plan/uptime-worker.js

@@ -1,7 +1,7 @@
 import { randomBytes, randomUUID } from 'node:crypto';
 import { EdgeApiError } from '@wtfalch/edge';
 import { uptimeArtifactUrl } from '../platform.js';
-import { PLATFORM_EDGE_INTERNAL_URL_SCOPE_KEY, PLATFORM_UPTIME_ACCESS_CLIENT_ID_REF, PLATFORM_UPTIME_ACCESS_CLIENT_SECRET_REF, PLATFORM_UPTIME_ACCESS_TOKEN_ID_SCOPE_KEY, PLATFORM_UPTIME_ACCESS_TOKEN_NAME, PLATFORM_UPTIME_ACCESS_UNDELIVERED_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_HOSTNAME_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_SECRETS_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_SHA256_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_TAG_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_VARS_SCOPE_KEY, PLATFORM_UPTIME_HEARTBEAT_URL_REF, PLATFORM_UPTIME_KEY, PLATFORM_UPTIME_KV_TITLE, PLATFORM_UPTIME_OPTIONAL_SECRETS, PLATFORM_UPTIME_REMOVED_SCOPE_KEY, PLATFORM_UPTIME_SCRIPT_NAME, PLATFORM_UPTIME_TOKEN_ID_SCOPE_KEY, PLATFORM_UPTIME_TOKEN_REF, PLATFORM_UPTIME_TOKEN_UNDELIVERED_SCOPE_KEY, uptimeAccessTokenConflict, uptimeSecretNames, uptimeVarsDigest, } from './platform-diff.js';
+import { PLATFORM_EDGE_INTERNAL_URL_SCOPE_KEY, PLATFORM_UPTIME_ACCESS_CLIENT_ID_REF, PLATFORM_UPTIME_ACCESS_CLIENT_SECRET_REF, PLATFORM_UPTIME_ACCESS_TOKEN_ID_SCOPE_KEY, PLATFORM_UPTIME_ACCESS_TOKEN_NAME, PLATFORM_UPTIME_ACCESS_UNDELIVERED_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_HOSTNAME_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_SECRETS_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_SHA256_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_TAG_SCOPE_KEY, PLATFORM_UPTIME_APPLIED_VARS_SCOPE_KEY, PLATFORM_UPTIME_CHAT_ROOM_ID_SCOPE_KEY, PLATFORM_UPTIME_CHAT_TOKEN_REF, PLATFORM_UPTIME_CHAT_UNDELIVERED_SCOPE_KEY, PLATFORM_UPTIME_HEARTBEAT_URL_REF, PLATFORM_UPTIME_KEY, PLATFORM_UPTIME_KV_TITLE, PLATFORM_UPTIME_OPTIONAL_SECRETS, PLATFORM_UPTIME_REMOVED_SCOPE_KEY, PLATFORM_UPTIME_SCRIPT_NAME, PLATFORM_UPTIME_TOKEN_ID_SCOPE_KEY, PLATFORM_UPTIME_TOKEN_REF, PLATFORM_UPTIME_TOKEN_UNDELIVERED_SCOPE_KEY, uptimeAccessTokenConflict, uptimeEffectiveVars, uptimeSecretNames, uptimeVarsDigest, } from './platform-diff.js';
 /** The Worker's cron trigger, from Archon's `workers/uptime/manifest.json`. */
 const UPTIME_CRONS = ['* * * * *'];
 /** The date Archon's own Worker config used. */
@@ -15,6 +15,84 @@ export const UPTIME_OPTIONAL_VARS = [
     'ALERT_EMAIL_FROM',
     'ALERT_EMAIL_TO',
 ];
+/** How long one call to read chat-service's token or to ask it for the bot may take. */
+const CHAT_CALL_TIMEOUT_MS = 10_000;
+/** The bot's localpart in chat-service (`@uptime-bot:<server>`). */
+const CHAT_BOT_LOCALPART = 'uptime-bot';
+/** Runs `work` and gives up after `ms`; the error names `what` only. */
+async function withinMs(ms, what, work) {
+    let timer;
+    try {
+        return await Promise.race([
+            work,
+            new Promise((_, reject) => {
+                timer = setTimeout(() => reject(new Error(`platform:uptime: ${what} did not answer within ${ms / 1000}s`)), ms);
+            }),
+        ]);
+    }
+    finally {
+        clearTimeout(timer);
+    }
+}
+/**
+ * `PUT /_chat/internal/bots/uptime-bot` on the company's Agora host. Idempotent on the chat-service
+ * side: a repeat returns the room and no token unless `rotate` is set, so calling with `rotate` again
+ * revokes the previous token. Every message here is fixed text: the response body, the bearer and the
+ * token never reach an error.
+ */
+async function callChatBot(chat, owner, rotate) {
+    const timeoutMs = chat.timeoutMs ?? CHAT_CALL_TIMEOUT_MS;
+    let envs;
+    try {
+        envs = await withinMs(timeoutMs, 'reading the chat-service app', chat.coolify.listEnvs(owner.appId));
+    }
+    catch {
+        // The cause can carry a response body.
+        throw new Error('platform:uptime: the chat-service app could not be read');
+    }
+    const bearer = envs.find((e) => e.key === 'CHAT_INTERNAL_TOKEN' && !e.is_preview)?.value;
+    if (typeof bearer !== 'string' || !/^\S{32,}$/.test(bearer)) {
+        throw new Error('platform:uptime: chat-service holds no usable CHAT_INTERNAL_TOKEN');
+    }
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), timeoutMs);
+    try {
+        const response = await (chat.fetch ?? fetch)(`https://${owner.agoraHost}/_chat/internal/bots/${CHAT_BOT_LOCALPART}`, {
+            method: 'PUT',
+            headers: { authorization: `Bearer ${bearer}`, 'content-type': 'application/json' },
+            body: JSON.stringify({
+                displayName: 'Platform alerts',
+                room: { name: 'platform-alerts' },
+                members: [...owner.subjects],
+                ...(rotate ? { rotate: true } : {}),
+            }),
+            redirect: 'error',
+            signal: controller.signal,
+        });
+        if (response.status !== 200) {
+            throw new Error(`platform:uptime: chat-service refused the bot request (HTTP ${response.status})`);
+        }
+        const body = (await response.json());
+        const { userId, roomId, accessToken } = body ?? {};
+        if (typeof userId !== 'string' ||
+            !userId ||
+            typeof roomId !== 'string' ||
+            !roomId ||
+            (accessToken !== undefined && (typeof accessToken !== 'string' || !accessToken))) {
+            throw new Error('platform:uptime: chat-service answered the bot request with an unusable body');
+        }
+        return { userId, roomId, ...(accessToken ? { accessToken } : {}) };
+    }
+    catch (error) {
+        // Our own messages pass; anything else (a network error, a bad JSON body) is replaced.
+        if (error instanceof Error && error.message.startsWith('platform:uptime: '))
+            throw error;
+        throw new Error('platform:uptime: chat-service did not answer the bot request');
+    }
+    finally {
+        clearTimeout(timer);
+    }
+}
 /**
  * What is held now: the optional secrets, and `UPTIME_HEARTBEAT_URL` (a ping
  * URL that works as a capability, so a secret too), name to value. Callers
@@ -108,11 +186,51 @@ export async function provisionPlatformUptime(context, deps) {
     }
     const hostname = platform.archon.hostname;
     const held = await heldUptimeValues(deps);
+    // The chat bot comes before the upload: its room is one of the Worker's variables. A call that fails
+    // stops the step here, and the next apply makes it again (the marker below says whether a token may
+    // already have been minted).
+    const ownerChat = context.owner?.chat ?? null;
+    let chatRoomId = recorded[PLATFORM_UPTIME_CHAT_ROOM_ID_SCOPE_KEY] || '';
+    if (deps.chat && ownerChat && ownerChat.subjects.length > 0) {
+        const lost = recorded[PLATFORM_UPTIME_CHAT_UNDELIVERED_SCOPE_KEY];
+        if (held.CHAT_ACCESS_TOKEN) {
+            if (lost) {
+                context.recordScopeId(PLATFORM_UPTIME_CHAT_UNDELIVERED_SCOPE_KEY, '');
+                await context.persist?.();
+            }
+        }
+        else {
+            // Recorded and persisted before the route is called, because the call is what mints the token.
+            if (!lost) {
+                context.recordScopeId(PLATFORM_UPTIME_CHAT_UNDELIVERED_SCOPE_KEY, randomUUID());
+                await context.persist?.();
+            }
+            // A marker, or a room already made, means the bot exists and its token is not held: rotate.
+            const rotate = Boolean(lost) || Boolean(chatRoomId);
+            let bot = await callChatBot(deps.chat, ownerChat, rotate);
+            if (!bot.accessToken && !rotate)
+                bot = await callChatBot(deps.chat, ownerChat, true);
+            const chatToken = bot.accessToken;
+            if (!chatToken) {
+                throw new Error('platform:uptime: chat-service returned no token for the bot, even when asked to rotate it');
+            }
+            chatRoomId = bot.roomId;
+            context.recordScopeId(PLATFORM_UPTIME_CHAT_ROOM_ID_SCOPE_KEY, chatRoomId);
+            await context.persist?.();
+            await attempt('holding the chat bot token', () => deps.deliverSecret(PLATFORM_UPTIME_CHAT_TOKEN_REF, chatToken));
+            context.recordScopeId(PLATFORM_UPTIME_CHAT_UNDELIVERED_SCOPE_KEY, '');
+            await context.persist?.();
+            held.CHAT_ACCESS_TOKEN = chatToken;
+        }
+    }
+    const workerVars = uptimeEffectiveVars(deps.vars, deps.chat && ownerChat && chatRoomId
+        ? { homeserverUrl: `https://${ownerChat.agoraHost}`, roomId: chatRoomId }
+        : null);
     const bindings = [
         { type: 'kv_namespace', name: 'UPTIME_KV', title: PLATFORM_UPTIME_KV_TITLE },
         { type: 'plain_text', name: 'ARCHON_BASE_URL', text: `https://${hostname}` },
         ...UPTIME_OPTIONAL_VARS.flatMap((name) => {
-            const text = deps.vars?.[name];
+            const text = workerVars[name];
             return text ? [{ type: 'plain_text', name, text }] : [];
         }),
     ];
@@ -223,7 +341,7 @@ export async function provisionPlatformUptime(context, deps) {
     context.recordScopeId(PLATFORM_UPTIME_APPLIED_TAG_SCOPE_KEY, uptime.tag);
     context.recordScopeId(PLATFORM_UPTIME_APPLIED_SHA256_SCOPE_KEY, uptime.sha256);
     context.recordScopeId(PLATFORM_UPTIME_APPLIED_HOSTNAME_SCOPE_KEY, hostname);
-    context.recordScopeId(PLATFORM_UPTIME_APPLIED_VARS_SCOPE_KEY, uptimeVarsDigest(deps.vars));
+    context.recordScopeId(PLATFORM_UPTIME_APPLIED_VARS_SCOPE_KEY, uptimeVarsDigest(workerVars));
     context.recordScopeId(PLATFORM_UPTIME_APPLIED_SECRETS_SCOPE_KEY, uptimeSecretNames(Object.keys(held)));
     return { resourceId: PLATFORM_UPTIME_SCRIPT_NAME };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wtfalch/foundry",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "description": "Foundry's SDK: the declared org's types, the plan and apply contracts, and the state store's interface.",
   "repository": {
     "type": "git",