mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-10 00:33:31 +00:00
feat: Twitch Plugin (#1612)
* wip * copy polugin files * wip type changes * refactor: improve Twitch plugin code quality and fix all tests - Extract client manager registry for centralized lifecycle management - Refactor to use early returns and reduce mutations - Fix status check logic for clientId detection - Add comprehensive test coverage for new modules - Remove tests for unimplemented features (index.test.ts, resolver.test.ts) - Fix mock setup issues in test suite (149 tests now passing) - Improve error handling with errorResponse helper in actions.ts - Normalize token handling to eliminate duplication Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * use accountId * delete md file * delte tsconfig * adjust log level * fix probe logic * format * fix monitor * code review fixes * format * no mutation * less mutation * chain debug log * await authProvider setup * use uuid * use spread * fix tests * update docs and remove bot channel fallback * more readme fixes * remove comments + fromat * fix tests * adjust access control logic * format * install * simplify config object * remove duplicate log tags + log received messages * update docs * update tests * format * strip markdown in monitor * remove strip markdown config, enabled by default * default requireMention to true * fix store path arg * fix multi account id + add unit test * fix multi account id + add unit test * make channel required and update docs * remove whisper functionality * remove duplicate connect log * update docs with convert twitch link * make twitch message processing non blocking * schema consistent casing * remove noisy ignore log * use coreLogger --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
jaydenfyi
277
extensions/twitch/src/twitch-client.ts
Normal file
277
extensions/twitch/src/twitch-client.ts
Normal file
@@ -0,0 +1,277 @@
|
||||
import { RefreshingAuthProvider, StaticAuthProvider } from "@twurple/auth";
|
||||
import { ChatClient, LogLevel } from "@twurple/chat";
|
||||
import type { ClawdbotConfig } from "clawdbot/plugin-sdk";
|
||||
import type { ChannelLogSink, TwitchAccountConfig, TwitchChatMessage } from "./types.js";
|
||||
import { resolveTwitchToken } from "./token.js";
|
||||
import { normalizeToken } from "./utils/twitch.js";
|
||||
|
||||
/**
|
||||
* Manages Twitch chat client connections
|
||||
*/
|
||||
export class TwitchClientManager {
|
||||
private clients = new Map<string, ChatClient>();
|
||||
private messageHandlers = new Map<string, (message: TwitchChatMessage) => void>();
|
||||
|
||||
constructor(private logger: ChannelLogSink) {}
|
||||
|
||||
/**
|
||||
* Create an auth provider for the account.
|
||||
*/
|
||||
private async createAuthProvider(
|
||||
account: TwitchAccountConfig,
|
||||
normalizedToken: string,
|
||||
): Promise<StaticAuthProvider | RefreshingAuthProvider> {
|
||||
if (!account.clientId) {
|
||||
throw new Error("Missing Twitch client ID");
|
||||
}
|
||||
|
||||
if (account.clientSecret) {
|
||||
const authProvider = new RefreshingAuthProvider({
|
||||
clientId: account.clientId,
|
||||
clientSecret: account.clientSecret,
|
||||
});
|
||||
|
||||
await authProvider
|
||||
.addUserForToken({
|
||||
accessToken: normalizedToken,
|
||||
refreshToken: account.refreshToken ?? null,
|
||||
expiresIn: account.expiresIn ?? null,
|
||||
obtainmentTimestamp: account.obtainmentTimestamp ?? Date.now(),
|
||||
})
|
||||
.then((userId) => {
|
||||
this.logger.info(
|
||||
`Added user ${userId} to RefreshingAuthProvider for ${account.username}`,
|
||||
);
|
||||
})
|
||||
.catch((err) => {
|
||||
this.logger.error(
|
||||
`Failed to add user to RefreshingAuthProvider: ${err instanceof Error ? err.message : String(err)}`,
|
||||
);
|
||||
});
|
||||
|
||||
authProvider.onRefresh((userId, token) => {
|
||||
this.logger.info(
|
||||
`Access token refreshed for user ${userId} (expires in ${token.expiresIn ? `${token.expiresIn}s` : "unknown"})`,
|
||||
);
|
||||
});
|
||||
|
||||
authProvider.onRefreshFailure((userId, error) => {
|
||||
this.logger.error(`Failed to refresh access token for user ${userId}: ${error.message}`);
|
||||
});
|
||||
|
||||
const refreshStatus = account.refreshToken
|
||||
? "automatic token refresh enabled"
|
||||
: "token refresh disabled (no refresh token)";
|
||||
this.logger.info(`Using RefreshingAuthProvider for ${account.username} (${refreshStatus})`);
|
||||
|
||||
return authProvider;
|
||||
}
|
||||
|
||||
this.logger.info(`Using StaticAuthProvider for ${account.username} (no clientSecret provided)`);
|
||||
return new StaticAuthProvider(account.clientId, normalizedToken);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get or create a chat client for an account
|
||||
*/
|
||||
async getClient(
|
||||
account: TwitchAccountConfig,
|
||||
cfg?: ClawdbotConfig,
|
||||
accountId?: string,
|
||||
): Promise<ChatClient> {
|
||||
const key = this.getAccountKey(account);
|
||||
|
||||
const existing = this.clients.get(key);
|
||||
if (existing) {
|
||||
return existing;
|
||||
}
|
||||
|
||||
const tokenResolution = resolveTwitchToken(cfg, {
|
||||
accountId,
|
||||
});
|
||||
|
||||
if (!tokenResolution.token) {
|
||||
this.logger.error(
|
||||
`Missing Twitch token for account ${account.username} (set channels.twitch.accounts.${account.username}.token or CLAWDBOT_TWITCH_ACCESS_TOKEN for default)`,
|
||||
);
|
||||
throw new Error("Missing Twitch token");
|
||||
}
|
||||
|
||||
this.logger.debug?.(`Using ${tokenResolution.source} token source for ${account.username}`);
|
||||
|
||||
if (!account.clientId) {
|
||||
this.logger.error(`Missing Twitch client ID for account ${account.username}`);
|
||||
throw new Error("Missing Twitch client ID");
|
||||
}
|
||||
|
||||
const normalizedToken = normalizeToken(tokenResolution.token);
|
||||
|
||||
const authProvider = await this.createAuthProvider(account, normalizedToken);
|
||||
|
||||
const client = new ChatClient({
|
||||
authProvider,
|
||||
channels: [account.channel],
|
||||
rejoinChannelsOnReconnect: true,
|
||||
requestMembershipEvents: true,
|
||||
logger: {
|
||||
minLevel: LogLevel.WARNING,
|
||||
custom: {
|
||||
log: (level, message) => {
|
||||
switch (level) {
|
||||
case LogLevel.CRITICAL:
|
||||
this.logger.error(`${message}`);
|
||||
break;
|
||||
case LogLevel.ERROR:
|
||||
this.logger.error(`${message}`);
|
||||
break;
|
||||
case LogLevel.WARNING:
|
||||
this.logger.warn(`${message}`);
|
||||
break;
|
||||
case LogLevel.INFO:
|
||||
this.logger.info(`${message}`);
|
||||
break;
|
||||
case LogLevel.DEBUG:
|
||||
this.logger.debug?.(`${message}`);
|
||||
break;
|
||||
case LogLevel.TRACE:
|
||||
this.logger.debug?.(`${message}`);
|
||||
break;
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
this.setupClientHandlers(client, account);
|
||||
|
||||
client.connect();
|
||||
|
||||
this.clients.set(key, client);
|
||||
this.logger.info(`Connected to Twitch as ${account.username}`);
|
||||
|
||||
return client;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set up message and event handlers for a client
|
||||
*/
|
||||
private setupClientHandlers(client: ChatClient, account: TwitchAccountConfig): void {
|
||||
const key = this.getAccountKey(account);
|
||||
|
||||
// Handle incoming messages
|
||||
client.onMessage((channelName, _user, messageText, msg) => {
|
||||
const handler = this.messageHandlers.get(key);
|
||||
if (handler) {
|
||||
const normalizedChannel = channelName.startsWith("#") ? channelName.slice(1) : channelName;
|
||||
const from = `twitch:${msg.userInfo.userName}`;
|
||||
const preview = messageText.slice(0, 100).replace(/\n/g, "\\n");
|
||||
this.logger.debug?.(
|
||||
`twitch inbound: channel=${normalizedChannel} from=${from} len=${messageText.length} preview="${preview}"`,
|
||||
);
|
||||
|
||||
handler({
|
||||
username: msg.userInfo.userName,
|
||||
displayName: msg.userInfo.displayName,
|
||||
userId: msg.userInfo.userId,
|
||||
message: messageText,
|
||||
channel: normalizedChannel,
|
||||
id: msg.id,
|
||||
timestamp: new Date(),
|
||||
isMod: msg.userInfo.isMod,
|
||||
isOwner: msg.userInfo.isBroadcaster,
|
||||
isVip: msg.userInfo.isVip,
|
||||
isSub: msg.userInfo.isSubscriber,
|
||||
chatType: "group",
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
this.logger.info(`Set up handlers for ${key}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a message handler for an account
|
||||
* @returns A function that removes the handler when called
|
||||
*/
|
||||
onMessage(
|
||||
account: TwitchAccountConfig,
|
||||
handler: (message: TwitchChatMessage) => void,
|
||||
): () => void {
|
||||
const key = this.getAccountKey(account);
|
||||
this.messageHandlers.set(key, handler);
|
||||
return () => {
|
||||
this.messageHandlers.delete(key);
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Disconnect a client
|
||||
*/
|
||||
async disconnect(account: TwitchAccountConfig): Promise<void> {
|
||||
const key = this.getAccountKey(account);
|
||||
const client = this.clients.get(key);
|
||||
|
||||
if (client) {
|
||||
client.quit();
|
||||
this.clients.delete(key);
|
||||
this.messageHandlers.delete(key);
|
||||
this.logger.info(`Disconnected ${key}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Disconnect all clients
|
||||
*/
|
||||
async disconnectAll(): Promise<void> {
|
||||
this.clients.forEach((client) => client.quit());
|
||||
this.clients.clear();
|
||||
this.messageHandlers.clear();
|
||||
this.logger.info(" Disconnected all clients");
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a message to a channel
|
||||
*/
|
||||
async sendMessage(
|
||||
account: TwitchAccountConfig,
|
||||
channel: string,
|
||||
message: string,
|
||||
cfg?: ClawdbotConfig,
|
||||
accountId?: string,
|
||||
): Promise<{ ok: boolean; error?: string; messageId?: string }> {
|
||||
try {
|
||||
const client = await this.getClient(account, cfg, accountId);
|
||||
|
||||
// Generate a message ID (Twurple's say() doesn't return the message ID, so we generate one)
|
||||
const messageId = crypto.randomUUID();
|
||||
|
||||
// Send message (Twurple handles rate limiting)
|
||||
await client.say(channel, message);
|
||||
|
||||
return { ok: true, messageId };
|
||||
} catch (error) {
|
||||
this.logger.error(
|
||||
`Failed to send message: ${error instanceof Error ? error.message : String(error)}`,
|
||||
);
|
||||
return {
|
||||
ok: false,
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a unique key for an account
|
||||
*/
|
||||
public getAccountKey(account: TwitchAccountConfig): string {
|
||||
return `${account.username}:${account.channel}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all clients and handlers (for testing)
|
||||
*/
|
||||
_clearForTest(): void {
|
||||
this.clients.clear();
|
||||
this.messageHandlers.clear();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user