refactor(gateway): share gmail watcher startup flow

This commit is contained in:
Peter Steinberger
2026-02-18 17:41:13 +00:00
parent e702a9eb52
commit 6187e2afbd
4 changed files with 144 additions and 36 deletions

View File

@@ -3,7 +3,8 @@ import { getTotalPendingReplies } from "../auto-reply/reply/dispatcher-registry.
import type { CliDeps } from "../cli/deps.js";
import { resolveAgentMaxConcurrent, resolveSubagentMaxConcurrent } from "../config/agent-limits.js";
import type { loadConfig } from "../config/config.js";
import { startGmailWatcher, stopGmailWatcher } from "../hooks/gmail-watcher.js";
import { startGmailWatcherWithLogs } from "../hooks/gmail-watcher-lifecycle.js";
import { stopGmailWatcher } from "../hooks/gmail-watcher.js";
import { isTruthyEnvValue } from "../infra/env.js";
import type { HeartbeatRunner } from "../infra/heartbeat-runner.js";
import { resetDirectoryCache } from "../infra/outbound/target-resolver.js";
@@ -90,24 +91,12 @@ export function createGatewayReloadHandlers(params: {
if (plan.restartGmailWatcher) {
await stopGmailWatcher().catch(() => {});
if (!isTruthyEnvValue(process.env.OPENCLAW_SKIP_GMAIL_WATCHER)) {
try {
const gmailResult = await startGmailWatcher(nextConfig);
if (gmailResult.started) {
params.logHooks.info("gmail watcher started");
} else if (
gmailResult.reason &&
gmailResult.reason !== "hooks not enabled" &&
gmailResult.reason !== "no gmail account configured"
) {
params.logHooks.warn(`gmail watcher not started: ${gmailResult.reason}`);
}
} catch (err) {
params.logHooks.error(`gmail watcher failed to start: ${String(err)}`);
}
} else {
params.logHooks.info("skipping gmail watcher restart (OPENCLAW_SKIP_GMAIL_WATCHER=1)");
}
await startGmailWatcherWithLogs({
cfg: nextConfig,
log: params.logHooks,
onSkipped: () =>
params.logHooks.info("skipping gmail watcher restart (OPENCLAW_SKIP_GMAIL_WATCHER=1)"),
});
}
if (plan.restartChannels.size > 0) {

View File

@@ -10,7 +10,7 @@ import { cleanStaleLockFiles } from "../agents/session-write-lock.js";
import type { CliDeps } from "../cli/deps.js";
import type { loadConfig } from "../config/config.js";
import { resolveStateDir } from "../config/paths.js";
import { startGmailWatcher } from "../hooks/gmail-watcher.js";
import { startGmailWatcherWithLogs } from "../hooks/gmail-watcher-lifecycle.js";
import {
clearInternalHooks,
createInternalHookEvent,
@@ -68,22 +68,10 @@ export async function startGatewaySidecars(params: {
}
// Start Gmail watcher if configured (hooks.gmail.account).
if (!isTruthyEnvValue(process.env.OPENCLAW_SKIP_GMAIL_WATCHER)) {
try {
const gmailResult = await startGmailWatcher(params.cfg);
if (gmailResult.started) {
params.logHooks.info("gmail watcher started");
} else if (
gmailResult.reason &&
gmailResult.reason !== "hooks not enabled" &&
gmailResult.reason !== "no gmail account configured"
) {
params.logHooks.warn(`gmail watcher not started: ${gmailResult.reason}`);
}
} catch (err) {
params.logHooks.error(`gmail watcher failed to start: ${String(err)}`);
}
}
await startGmailWatcherWithLogs({
cfg: params.cfg,
log: params.logHooks,
});
// Validate hooks.gmail.model if configured.
if (params.cfg.hooks?.gmail?.model) {

View File

@@ -0,0 +1,94 @@
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
const { startGmailWatcherMock } = vi.hoisted(() => ({
startGmailWatcherMock: vi.fn(),
}));
vi.mock("./gmail-watcher.js", () => ({
startGmailWatcher: startGmailWatcherMock,
}));
import { startGmailWatcherWithLogs } from "./gmail-watcher-lifecycle.js";
describe("startGmailWatcherWithLogs", () => {
const log = {
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
};
beforeEach(() => {
startGmailWatcherMock.mockReset();
log.info.mockReset();
log.warn.mockReset();
log.error.mockReset();
delete process.env.OPENCLAW_SKIP_GMAIL_WATCHER;
});
afterEach(() => {
delete process.env.OPENCLAW_SKIP_GMAIL_WATCHER;
});
it("logs startup success", async () => {
startGmailWatcherMock.mockResolvedValue({ started: true, reason: undefined });
await startGmailWatcherWithLogs({
cfg: {},
log,
});
expect(log.info).toHaveBeenCalledWith("gmail watcher started");
expect(log.warn).not.toHaveBeenCalled();
expect(log.error).not.toHaveBeenCalled();
});
it("logs actionable non-start reason", async () => {
startGmailWatcherMock.mockResolvedValue({ started: false, reason: "auth failed" });
await startGmailWatcherWithLogs({
cfg: {},
log,
});
expect(log.warn).toHaveBeenCalledWith("gmail watcher not started: auth failed");
});
it("suppresses expected non-start reasons", async () => {
startGmailWatcherMock.mockResolvedValue({
started: false,
reason: "hooks not enabled",
});
await startGmailWatcherWithLogs({
cfg: {},
log,
});
expect(log.warn).not.toHaveBeenCalled();
});
it("supports skip callback when watcher is disabled", async () => {
process.env.OPENCLAW_SKIP_GMAIL_WATCHER = "1";
const onSkipped = vi.fn();
await startGmailWatcherWithLogs({
cfg: {},
log,
onSkipped,
});
expect(startGmailWatcherMock).not.toHaveBeenCalled();
expect(onSkipped).toHaveBeenCalledTimes(1);
});
it("logs startup errors", async () => {
startGmailWatcherMock.mockRejectedValue(new Error("boom"));
await startGmailWatcherWithLogs({
cfg: {},
log,
});
expect(log.error).toHaveBeenCalledWith("gmail watcher failed to start: Error: boom");
});
});

View File

@@ -0,0 +1,37 @@
import type { OpenClawConfig } from "../config/config.js";
import { isTruthyEnvValue } from "../infra/env.js";
import { startGmailWatcher } from "./gmail-watcher.js";
export type GMailWatcherLog = {
info: (msg: string) => void;
warn: (msg: string) => void;
error: (msg: string) => void;
};
export async function startGmailWatcherWithLogs(params: {
cfg: OpenClawConfig;
log: GMailWatcherLog;
onSkipped?: () => void;
}) {
if (isTruthyEnvValue(process.env.OPENCLAW_SKIP_GMAIL_WATCHER)) {
params.onSkipped?.();
return;
}
try {
const gmailResult = await startGmailWatcher(params.cfg);
if (gmailResult.started) {
params.log.info("gmail watcher started");
return;
}
if (
gmailResult.reason &&
gmailResult.reason !== "hooks not enabled" &&
gmailResult.reason !== "no gmail account configured"
) {
params.log.warn(`gmail watcher not started: ${gmailResult.reason}`);
}
} catch (err) {
params.log.error(`gmail watcher failed to start: ${String(err)}`);
}
}