Spaces:
Paused
Paused
File size: 10,398 Bytes
fb4d8fe | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 | import type { ChannelAccountSnapshot, ChannelPlugin } from "../../channels/plugins/types.js";
import type { OpenClawConfig } from "../../config/config.js";
import type { GatewayRequestContext, GatewayRequestHandlers } from "./types.js";
import { buildChannelUiCatalog } from "../../channels/plugins/catalog.js";
import { resolveChannelDefaultAccountId } from "../../channels/plugins/helpers.js";
import {
type ChannelId,
getChannelPlugin,
listChannelPlugins,
normalizeChannelId,
} from "../../channels/plugins/index.js";
import { buildChannelAccountSnapshot } from "../../channels/plugins/status.js";
import { loadConfig, readConfigFileSnapshot } from "../../config/config.js";
import { getChannelActivity } from "../../infra/channel-activity.js";
import { DEFAULT_ACCOUNT_ID } from "../../routing/session-key.js";
import { defaultRuntime } from "../../runtime.js";
import {
ErrorCodes,
errorShape,
formatValidationErrors,
validateChannelsLogoutParams,
validateChannelsStatusParams,
} from "../protocol/index.js";
import { formatForLog } from "../ws-log.js";
type ChannelLogoutPayload = {
channel: ChannelId;
accountId: string;
cleared: boolean;
[key: string]: unknown;
};
export async function logoutChannelAccount(params: {
channelId: ChannelId;
accountId?: string | null;
cfg: OpenClawConfig;
context: GatewayRequestContext;
plugin: ChannelPlugin;
}): Promise<ChannelLogoutPayload> {
const resolvedAccountId =
params.accountId?.trim() ||
params.plugin.config.defaultAccountId?.(params.cfg) ||
params.plugin.config.listAccountIds(params.cfg)[0] ||
DEFAULT_ACCOUNT_ID;
const account = params.plugin.config.resolveAccount(params.cfg, resolvedAccountId);
await params.context.stopChannel(params.channelId, resolvedAccountId);
const result = await params.plugin.gateway?.logoutAccount?.({
cfg: params.cfg,
accountId: resolvedAccountId,
account,
runtime: defaultRuntime,
});
if (!result) {
throw new Error(`Channel ${params.channelId} does not support logout`);
}
const cleared = Boolean(result.cleared);
const loggedOut = typeof result.loggedOut === "boolean" ? result.loggedOut : cleared;
if (loggedOut) {
params.context.markChannelLoggedOut(params.channelId, true, resolvedAccountId);
}
return {
channel: params.channelId,
accountId: resolvedAccountId,
...result,
cleared,
};
}
export const channelsHandlers: GatewayRequestHandlers = {
"channels.status": async ({ params, respond, context }) => {
if (!validateChannelsStatusParams(params)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid channels.status params: ${formatValidationErrors(validateChannelsStatusParams.errors)}`,
),
);
return;
}
const probe = (params as { probe?: boolean }).probe === true;
const timeoutMsRaw = (params as { timeoutMs?: unknown }).timeoutMs;
const timeoutMs = typeof timeoutMsRaw === "number" ? Math.max(1000, timeoutMsRaw) : 10_000;
const cfg = loadConfig();
const runtime = context.getRuntimeSnapshot();
const plugins = listChannelPlugins();
const pluginMap = new Map<ChannelId, ChannelPlugin>(
plugins.map((plugin) => [plugin.id, plugin]),
);
const resolveRuntimeSnapshot = (
channelId: ChannelId,
accountId: string,
defaultAccountId: string,
): ChannelAccountSnapshot | undefined => {
const accounts = runtime.channelAccounts[channelId];
const defaultRuntime = runtime.channels[channelId];
const raw =
accounts?.[accountId] ?? (accountId === defaultAccountId ? defaultRuntime : undefined);
if (!raw) {
return undefined;
}
return raw;
};
const isAccountEnabled = (plugin: ChannelPlugin, account: unknown) =>
plugin.config.isEnabled
? plugin.config.isEnabled(account, cfg)
: !account ||
typeof account !== "object" ||
(account as { enabled?: boolean }).enabled !== false;
const buildChannelAccounts = async (channelId: ChannelId) => {
const plugin = pluginMap.get(channelId);
if (!plugin) {
return {
accounts: [] as ChannelAccountSnapshot[],
defaultAccountId: DEFAULT_ACCOUNT_ID,
defaultAccount: undefined as ChannelAccountSnapshot | undefined,
resolvedAccounts: {} as Record<string, unknown>,
};
}
const accountIds = plugin.config.listAccountIds(cfg);
const defaultAccountId = resolveChannelDefaultAccountId({
plugin,
cfg,
accountIds,
});
const accounts: ChannelAccountSnapshot[] = [];
const resolvedAccounts: Record<string, unknown> = {};
for (const accountId of accountIds) {
const account = plugin.config.resolveAccount(cfg, accountId);
const enabled = isAccountEnabled(plugin, account);
resolvedAccounts[accountId] = account;
let probeResult: unknown;
let lastProbeAt: number | null = null;
if (probe && enabled && plugin.status?.probeAccount) {
let configured = true;
if (plugin.config.isConfigured) {
configured = await plugin.config.isConfigured(account, cfg);
}
if (configured) {
probeResult = await plugin.status.probeAccount({
account,
timeoutMs,
cfg,
});
lastProbeAt = Date.now();
}
}
let auditResult: unknown;
if (probe && enabled && plugin.status?.auditAccount) {
let configured = true;
if (plugin.config.isConfigured) {
configured = await plugin.config.isConfigured(account, cfg);
}
if (configured) {
auditResult = await plugin.status.auditAccount({
account,
timeoutMs,
cfg,
probe: probeResult,
});
}
}
const runtimeSnapshot = resolveRuntimeSnapshot(channelId, accountId, defaultAccountId);
const snapshot = await buildChannelAccountSnapshot({
plugin,
cfg,
accountId,
runtime: runtimeSnapshot,
probe: probeResult,
audit: auditResult,
});
if (lastProbeAt) {
snapshot.lastProbeAt = lastProbeAt;
}
const activity = getChannelActivity({
channel: channelId as never,
accountId,
});
if (snapshot.lastInboundAt == null) {
snapshot.lastInboundAt = activity.inboundAt;
}
if (snapshot.lastOutboundAt == null) {
snapshot.lastOutboundAt = activity.outboundAt;
}
accounts.push(snapshot);
}
const defaultAccount =
accounts.find((entry) => entry.accountId === defaultAccountId) ?? accounts[0];
return { accounts, defaultAccountId, defaultAccount, resolvedAccounts };
};
const uiCatalog = buildChannelUiCatalog(plugins);
const payload: Record<string, unknown> = {
ts: Date.now(),
channelOrder: uiCatalog.order,
channelLabels: uiCatalog.labels,
channelDetailLabels: uiCatalog.detailLabels,
channelSystemImages: uiCatalog.systemImages,
channelMeta: uiCatalog.entries,
channels: {} as Record<string, unknown>,
channelAccounts: {} as Record<string, unknown>,
channelDefaultAccountId: {} as Record<string, unknown>,
};
const channelsMap = payload.channels as Record<string, unknown>;
const accountsMap = payload.channelAccounts as Record<string, unknown>;
const defaultAccountIdMap = payload.channelDefaultAccountId as Record<string, unknown>;
for (const plugin of plugins) {
const { accounts, defaultAccountId, defaultAccount, resolvedAccounts } =
await buildChannelAccounts(plugin.id);
const fallbackAccount =
resolvedAccounts[defaultAccountId] ?? plugin.config.resolveAccount(cfg, defaultAccountId);
const summary = plugin.status?.buildChannelSummary
? await plugin.status.buildChannelSummary({
account: fallbackAccount,
cfg,
defaultAccountId,
snapshot:
defaultAccount ??
({
accountId: defaultAccountId,
} as ChannelAccountSnapshot),
})
: {
configured: defaultAccount?.configured ?? false,
};
channelsMap[plugin.id] = summary;
accountsMap[plugin.id] = accounts;
defaultAccountIdMap[plugin.id] = defaultAccountId;
}
respond(true, payload, undefined);
},
"channels.logout": async ({ params, respond, context }) => {
if (!validateChannelsLogoutParams(params)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid channels.logout params: ${formatValidationErrors(validateChannelsLogoutParams.errors)}`,
),
);
return;
}
const rawChannel = (params as { channel?: unknown }).channel;
const channelId = typeof rawChannel === "string" ? normalizeChannelId(rawChannel) : null;
if (!channelId) {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, "invalid channels.logout channel"),
);
return;
}
const plugin = getChannelPlugin(channelId);
if (!plugin?.gateway?.logoutAccount) {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, `channel ${channelId} does not support logout`),
);
return;
}
const accountIdRaw = (params as { accountId?: unknown }).accountId;
const accountId = typeof accountIdRaw === "string" ? accountIdRaw.trim() : undefined;
const snapshot = await readConfigFileSnapshot();
if (!snapshot.valid) {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, "config invalid; fix it before logging out"),
);
return;
}
try {
const payload = await logoutChannelAccount({
channelId,
accountId,
cfg: snapshot.config ?? {},
context,
plugin,
});
respond(true, payload, undefined);
} catch (err) {
respond(false, undefined, errorShape(ErrorCodes.UNAVAILABLE, formatForLog(err)));
}
},
};
|