fix: polish Google Chat plugin (#1635) (thanks @iHildy)

Co-authored-by: Ian Hildebrand <ian@jedi.net>

extensions/googlechat/src/api.test.ts

@@ -0,0 +1,62 @@
+import { afterEach, describe, expect, it, vi } from "vitest";
+
+import type { ResolvedGoogleChatAccount } from "./accounts.js";
+import { downloadGoogleChatMedia } from "./api.js";
+
+vi.mock("./auth.js", () => ({
+  getGoogleChatAccessToken: vi.fn().mockResolvedValue("token"),
+}));
+
+const account = {
+  accountId: "default",
+  enabled: true,
+  credentialSource: "inline",
+  config: {},
+} as ResolvedGoogleChatAccount;
+
+describe("downloadGoogleChatMedia", () => {
+  afterEach(() => {
+    vi.unstubAllGlobals();
+  });
+
+  it("rejects when content-length exceeds max bytes", async () => {
+    const body = new ReadableStream({
+      start(controller) {
+        controller.enqueue(new Uint8Array([1, 2, 3]));
+        controller.close();
+      },
+    });
+    const response = new Response(body, {
+      status: 200,
+      headers: { "content-length": "50", "content-type": "application/octet-stream" },
+    });
+    vi.stubGlobal("fetch", vi.fn().mockResolvedValue(response));
+
+    await expect(
+      downloadGoogleChatMedia({ account, resourceName: "media/123", maxBytes: 10 }),
+    ).rejects.toThrow(/max bytes/i);
+  });
+
+  it("rejects when streamed payload exceeds max bytes", async () => {
+    const chunks = [new Uint8Array(6), new Uint8Array(6)];
+    let index = 0;
+    const body = new ReadableStream({
+      pull(controller) {
+        if (index < chunks.length) {
+          controller.enqueue(chunks[index++]);
+        } else {
+          controller.close();
+        }
+      },
+    });
+    const response = new Response(body, {
+      status: 200,
+      headers: { "content-type": "application/octet-stream" },
+    });
+    vi.stubGlobal("fetch", vi.fn().mockResolvedValue(response));
+
+    await expect(
+      downloadGoogleChatMedia({ account, resourceName: "media/123", maxBytes: 10 }),
+    ).rejects.toThrow(/max bytes/i);
+  });
+});

extensions/googlechat/src/api.ts

@@ -51,6 +51,7 @@ async function fetchBuffer(
   account: ResolvedGoogleChatAccount,
   url: string,
   init?: RequestInit,
+  options?: { maxBytes?: number },
 ): Promise<{ buffer: Buffer; contentType?: string }> {
   const token = await getGoogleChatAccessToken(account);
   const res = await fetch(url, {
@@ -64,7 +65,34 @@ async function fetchBuffer(
     const text = await res.text().catch(() => "");
     throw new Error(`Google Chat API ${res.status}: ${text || res.statusText}`);
   }
-  const buffer = Buffer.from(await res.arrayBuffer());
+  const maxBytes = options?.maxBytes;
+  const lengthHeader = res.headers.get("content-length");
+  if (maxBytes && lengthHeader) {
+    const length = Number(lengthHeader);
+    if (Number.isFinite(length) && length > maxBytes) {
+      throw new Error(`Google Chat media exceeds max bytes (${maxBytes})`);
+    }
+  }
+  if (!maxBytes || !res.body) {
+    const buffer = Buffer.from(await res.arrayBuffer());
+    const contentType = res.headers.get("content-type") ?? undefined;
+    return { buffer, contentType };
+  }
+  const reader = res.body.getReader();
+  const chunks: Buffer[] = [];
+  let total = 0;
+  while (true) {
+    const { done, value } = await reader.read();
+    if (done) break;
+    if (!value) continue;
+    total += value.length;
+    if (total > maxBytes) {
+      await reader.cancel();
+      throw new Error(`Google Chat media exceeds max bytes (${maxBytes})`);
+    }
+    chunks.push(Buffer.from(value));
+  }
+  const buffer = Buffer.concat(chunks, total);
   const contentType = res.headers.get("content-type") ?? undefined;
   return { buffer, contentType };
 }
@@ -108,6 +136,15 @@ export async function updateGoogleChatMessage(params: {
   return { messageName: result.name };
 }
 
+export async function deleteGoogleChatMessage(params: {
+  account: ResolvedGoogleChatAccount;
+  messageName: string;
+}): Promise<void> {
+  const { account, messageName } = params;
+  const url = `${CHAT_API_BASE}/${messageName}`;
+  await fetchOk(account, url, { method: "DELETE" });
+}
+
 export async function uploadGoogleChatAttachment(params: {
   account: ResolvedGoogleChatAccount;
   space: string;
@@ -151,10 +188,11 @@ export async function uploadGoogleChatAttachment(params: {
 export async function downloadGoogleChatMedia(params: {
   account: ResolvedGoogleChatAccount;
   resourceName: string;
+  maxBytes?: number;
 }): Promise<{ buffer: Buffer; contentType?: string }> {
-  const { account, resourceName } = params;
+  const { account, resourceName, maxBytes } = params;
   const url = `${CHAT_API_BASE}/media/${resourceName}?alt=media`;
-  return await fetchBuffer(account, url);
+  return await fetchBuffer(account, url, undefined, { maxBytes });
 }
 
 export async function createGoogleChatReaction(params: {

extensions/googlechat/src/channel.ts

@@ -42,7 +42,8 @@ const meta = getChatChannelMeta("googlechat");
 const formatAllowFromEntry = (entry: string) =>
   entry
     .trim()
-    .replace(/^(googlechat|gchat):/i, "")
+    .replace(/^(googlechat|google-chat|gchat):/i, "")
+    .replace(/^user:/i, "")
     .replace(/^users\//i, "")
     .toLowerCase();
 

extensions/googlechat/src/monitor.test.ts

@@ -0,0 +1,27 @@
+import { describe, expect, it } from "vitest";
+
+import { isSenderAllowed } from "./monitor.js";
+
+describe("isSenderAllowed", () => {
+  it("matches allowlist entries with users/<email>", () => {
+    expect(
+      isSenderAllowed("users/123", "Jane@Example.com", ["users/jane@example.com"]),
+    ).toBe(true);
+  });
+
+  it("matches allowlist entries with raw email", () => {
+    expect(isSenderAllowed("users/123", "Jane@Example.com", ["jane@example.com"])).toBe(
+      true,
+    );
+  });
+
+  it("still matches user id entries", () => {
+    expect(isSenderAllowed("users/abc", "jane@example.com", ["users/abc"])).toBe(true);
+  });
+
+  it("rejects non-matching emails", () => {
+    expect(isSenderAllowed("users/123", "jane@example.com", ["users/other@example.com"])).toBe(
+      false,
+    );
+  });
+});

extensions/googlechat/src/monitor.ts

@@ -8,6 +8,7 @@ import {
 } from "./accounts.js";
 import {
   downloadGoogleChatMedia,
+  deleteGoogleChatMessage,
   sendGoogleChatMessage,
   updateGoogleChatMessage,
 } from "./api.js";
@@ -296,7 +297,11 @@ function normalizeUserId(raw?: string | null): string {
   return trimmed.replace(/^users\//i, "").toLowerCase();
 }
 
-function isSenderAllowed(senderId: string, senderEmail: string | undefined, allowFrom: string[]) {
+export function isSenderAllowed(
+  senderId: string,
+  senderEmail: string | undefined,
+  allowFrom: string[],
+) {
   if (allowFrom.includes("*")) return true;
   const normalizedSenderId = normalizeUserId(senderId);
   const normalizedEmail = senderEmail?.trim().toLowerCase() ?? "";
@@ -305,8 +310,11 @@ function isSenderAllowed(senderId: string, senderEmail: string | undefined, allo
     if (!normalized) return false;
     if (normalized === normalizedSenderId) return true;
     if (normalizedEmail && normalized === normalizedEmail) return true;
+    if (normalizedEmail && normalized.replace(/^users\//i, "") === normalizedEmail) return true;
     if (normalized.replace(/^users\//i, "") === normalizedSenderId) return true;
-    if (normalized.replace(/^(googlechat|gchat):/i, "") === normalizedSenderId) return true;
+    if (normalized.replace(/^(googlechat|google-chat|gchat):/i, "") === normalizedSenderId) {
+      return true;
+    }
     return false;
   });
 }
@@ -700,7 +708,7 @@ async function downloadAttachment(
   const resourceName = attachment.attachmentDataRef?.resourceName;
   if (!resourceName) return null;
   const maxBytes = Math.max(1, mediaMaxMb) * 1024 * 1024;
-  const downloaded = await downloadGoogleChatMedia({ account, resourceName });
+  const downloaded = await downloadGoogleChatMedia({ account, resourceName, maxBytes });
   const saved = await core.channel.media.saveMediaBuffer(
     downloaded.buffer,
     downloaded.contentType ?? attachment.contentType,
@@ -728,9 +736,35 @@ async function deliverGoogleChatReply(params: {
       : [];
 
   if (mediaList.length > 0) {
+    let suppressCaption = false;
+    if (typingMessageName) {
+      try {
+        await deleteGoogleChatMessage({
+          account,
+          messageName: typingMessageName,
+        });
+      } catch (err) {
+        runtime.error?.(`Google Chat typing cleanup failed: ${String(err)}`);
+        const fallbackText = payload.text?.trim()
+          ? payload.text
+          : mediaList.length > 1
+            ? "Sent attachments."
+            : "Sent attachment.";
+        try {
+          await updateGoogleChatMessage({
+            account,
+            messageName: typingMessageName,
+            text: fallbackText,
+          });
+          suppressCaption = Boolean(payload.text?.trim());
+        } catch (updateErr) {
+          runtime.error?.(`Google Chat typing update failed: ${String(updateErr)}`);
+        }
+      }
+    }
     let first = true;
     for (const mediaUrl of mediaList) {
-      const caption = first ? payload.text : undefined;
+      const caption = first && !suppressCaption ? payload.text : undefined;
       first = false;
       try {
         const loaded = await core.channel.media.fetchRemoteMedia(mediaUrl, {

extensions/googlechat/src/onboarding.ts

@@ -136,7 +136,9 @@ async function promptCredentials(params: {
 }): Promise<ClawdbotConfig> {
   const { cfg, prompter, accountId } = params;
   const envReady =
-    Boolean(process.env[ENV_SERVICE_ACCOUNT]) || Boolean(process.env[ENV_SERVICE_ACCOUNT_FILE]);
+    accountId === DEFAULT_ACCOUNT_ID &&
+    (Boolean(process.env[ENV_SERVICE_ACCOUNT]) ||
+      Boolean(process.env[ENV_SERVICE_ACCOUNT_FILE]));
   if (envReady) {
     const useEnv = await prompter.confirm({
       message: "Use GOOGLE_CHAT_SERVICE_ACCOUNT env vars?",

extensions/googlechat/src/targets.test.ts

@@ -0,0 +1,35 @@
+import { describe, expect, it } from "vitest";
+
+import {
+  isGoogleChatSpaceTarget,
+  isGoogleChatUserTarget,
+  normalizeGoogleChatTarget,
+} from "./targets.js";
+
+describe("normalizeGoogleChatTarget", () => {
+  it("normalizes provider prefixes", () => {
+    expect(normalizeGoogleChatTarget("googlechat:users/123")).toBe("users/123");
+    expect(normalizeGoogleChatTarget("google-chat:spaces/AAA")).toBe("spaces/AAA");
+    expect(normalizeGoogleChatTarget("gchat:user:User@Example.com")).toBe(
+      "users/user@example.com",
+    );
+  });
+
+  it("normalizes email targets to users/<email>", () => {
+    expect(normalizeGoogleChatTarget("User@Example.com")).toBe("users/user@example.com");
+    expect(normalizeGoogleChatTarget("users/User@Example.com")).toBe("users/user@example.com");
+  });
+
+  it("preserves space targets", () => {
+    expect(normalizeGoogleChatTarget("space:spaces/BBB")).toBe("spaces/BBB");
+    expect(normalizeGoogleChatTarget("spaces/CCC")).toBe("spaces/CCC");
+  });
+});
+
+describe("target helpers", () => {
+  it("detects user and space targets", () => {
+    expect(isGoogleChatUserTarget("users/abc")).toBe(true);
+    expect(isGoogleChatSpaceTarget("spaces/abc")).toBe(true);
+    expect(isGoogleChatUserTarget("spaces/abc")).toBe(false);
+  });
+});

extensions/googlechat/src/targets.ts

@@ -4,10 +4,16 @@ import { findGoogleChatDirectMessage } from "./api.js";
 export function normalizeGoogleChatTarget(raw?: string | null): string | undefined {
   const trimmed = raw?.trim();
   if (!trimmed) return undefined;
-  const withoutPrefix = trimmed.replace(/^(googlechat|gchat):/i, "");
+  const withoutPrefix = trimmed.replace(/^(googlechat|google-chat|gchat):/i, "");
   const normalized = withoutPrefix
     .replace(/^user:/i, "users/")
     .replace(/^space:/i, "spaces/");
+  if (isGoogleChatUserTarget(normalized)) {
+    const suffix = normalized.slice("users/".length);
+    return suffix.includes("@") ? `users/${suffix.toLowerCase()}` : normalized;
+  }
+  if (isGoogleChatSpaceTarget(normalized)) return normalized;
+  if (normalized.includes("@")) return `users/${normalized.toLowerCase()}`;
   return normalized;
 }