mirror of
https://github.com/simplex-chat/simplex-chat.git
synced 2026-05-19 03:05:23 +00:00
5a3dfdd2b4
* plans: 20260207-support-bot.md * Update 20260207-support-bot.md * plans: 20260207-support-bot-implementation.md * plans: Update 20260207-support-bot-implementation.md * Relocate plans * apps: support bot code & tests * apps: support bot relocate * support-bot: Fix basic functionality * apps: support-bot /add command & fixes * apps: simplex-support-bot: Change Grok logo * Further usability improvements * simplex-support-bot: Update support plan to reflect current flow * simplex-support-bot: update product design plan * support-bot: update plan * support-bot: review and refine product spec * support-bot: update product spec — complete state, /join team-only, card debouncing - Group preferences applied once at creation, not on every startup - /join restricted to team group only - Team/Grok reply or reaction auto-completes conversation (✅) - Customer message reverts to incomplete - Card updates debounced globally with 15-minute batch flush * support-bot: update implementation plan * support-bot: implement stateless bot with cards, Grok, team flow, hardening Complete rewrite of the support bot to stateless architecture: - State derived from group composition + chat history (survives restarts) - Card dashboard in team group with live status, preview, /join commands - Two-profile architecture (main + Grok) with profileMutex serialization - Grok join race condition fix via bufferedGrokInvitations - Card preview: newest-first truncation, newline sanitization, sender prefixes - Best-effort startup (invite link, group profile update) - Team group preferences: directMessages, fullDelete, commands - 122 tests across 27 suites * support-bot: use apiCreateMemberContact and apiSendMemberContactInvitation instead of raw commands Replace sendChatCmd("/_create member contact ...") and sendChatCmd("/_invite member contact ...") with the typed API methods added in simplex-chat-nodejs. Update plans and build script accordingly. * plans: 20260207-support-bot.md * Update 20260207-support-bot.md * plans: 20260207-support-bot-implementation.md * plans: Update 20260207-support-bot-implementation.md * Relocate plans * apps: support bot code & tests * apps: support bot relocate * support-bot: Fix basic functionality * apps: support-bot /add command & fixes * apps: simplex-support-bot: Change Grok logo * Further usability improvements * simplex-support-bot: Update support plan to reflect current flow * simplex-support-bot: update product design plan * support-bot: update plan * support-bot: review and refine product spec * support-bot: update product spec — complete state, /join team-only, card debouncing - Group preferences applied once at creation, not on every startup - /join restricted to team group only - Team/Grok reply or reaction auto-completes conversation (✅) - Customer message reverts to incomplete - Card updates debounced globally with 15-minute batch flush * support-bot: update implementation plan * support-bot: implement stateless bot with cards, Grok, team flow, hardening Complete rewrite of the support bot to stateless architecture: - State derived from group composition + chat history (survives restarts) - Card dashboard in team group with live status, preview, /join commands - Two-profile architecture (main + Grok) with profileMutex serialization - Grok join race condition fix via bufferedGrokInvitations - Card preview: newest-first truncation, newline sanitization, sender prefixes - Best-effort startup (invite link, group profile update) - Team group preferences: directMessages, fullDelete, commands - 122 tests across 27 suites * support-bot: use apiCreateMemberContact and apiSendMemberContactInvitation instead of raw commands Replace sendChatCmd("/_create member contact ...") and sendChatCmd("/_invite member contact ...") with the typed API methods added in simplex-chat-nodejs. Update plans and build script accordingly. * support-bot: more improvemets * support-bot: add tests for Grok batch dedup and initial response gating 7 new tests covering the duplicate Grok reply fix: - batch dedup: only last customer message per group triggers API call - batch dedup: multi-group batches handled independently - batch dedup: non-customer messages filtered from batch - initial response gating: per-message responses suppressed during activateGrok - gating clears: per-message responses resume after activation completes Update implementation plan test catalog (122 → 129 tests). * support-bot: load context from context file * Rename Grok AI -> Grok * Remove unused strings.ts * support-bot: change messages * cardFlushMinutes 15 -> cardFlushSeconds 300 * support-bot: /team message when grok present * support-bot: correct messages * support-bot: update plans to reflect latest changes * Update plan for state derivation * support-bot: Update state machine plans * support-bot: implement customData state * Fix Grok revertStateOnFail race condition * support-bot: plans adversarial review * support-bot: /join ID part of card in plan * support-bot: implement /join ID inside card * support-bot: plans use params instead of regex in /join * support-bot: Implement adversarial review changes * support-bot: no re-invite if already invited * support-bot: /team should give owner to invited member * Don't change username for existing database * support-bot: update bot commands before sending commands * support-bot: adversarial review fixes * support-bot: implement postgresql (#6876) * support-bot: sqlite/postgres backend via typed DbConfig and parseArgs flags * support-bot: add README with setup and flags reference * support-bot: use published simplex-chat, drop build.sh/start.sh * support-bot: switch CLI to commander, add --help * support-bot: update README --------- Co-authored-by: shum <github.shum@liber.li> Co-authored-by: sh <37271604+shumvgolove@users.noreply.github.com>
145 lines
5.2 KiB
TypeScript
145 lines
5.2 KiB
TypeScript
import {Command} from "commander"
|
|
import {api} from "simplex-chat"
|
|
|
|
export interface IdName {
|
|
id: number
|
|
name: string
|
|
}
|
|
|
|
export type Backend = "sqlite" | "postgres"
|
|
|
|
export interface Config {
|
|
stateFile: string // local path to the bot's state JSON
|
|
db: api.DbConfig // passed to ChatApi.init / bot.run
|
|
teamGroup: IdName // name from CLI, id resolved at startup from state file
|
|
teamMembers: IdName[] // optional, empty if not provided
|
|
grokContactId: number | null // resolved at startup
|
|
timezone: string
|
|
completeHours: number
|
|
cardFlushSeconds: number
|
|
contextFile: string | null
|
|
grokApiKey: string | null
|
|
}
|
|
|
|
// Mirrors packages/simplex-chat-nodejs/src/download-libs.js so runtime detection
|
|
// matches what was used at install time. Works whether the user installed via
|
|
// SIMPLEX_BACKEND env var, .npmrc (→ npm_config_simplex_backend), or the
|
|
// --simplex_backend=postgres CLI flag (also surfaced as npm_config_*).
|
|
export function detectBackend(): Backend {
|
|
const raw = (process.env.SIMPLEX_BACKEND || process.env.npm_config_simplex_backend || "sqlite").toLowerCase()
|
|
if (raw !== "sqlite" && raw !== "postgres") {
|
|
throw new Error(`Invalid SIMPLEX_BACKEND: "${raw}". Must be "sqlite" or "postgres".`)
|
|
}
|
|
return raw
|
|
}
|
|
|
|
export function parseIdName(s: string): IdName {
|
|
const i = s.indexOf(":")
|
|
if (i < 1) throw new Error(`Invalid ID:name format: "${s}"`)
|
|
const id = parseInt(s.slice(0, i), 10)
|
|
if (isNaN(id)) throw new Error(`Invalid ID:name format (non-numeric ID): "${s}"`)
|
|
return {id, name: s.slice(i + 1)}
|
|
}
|
|
|
|
function parseNonNegativeInt(flag: string) {
|
|
return (raw: string): number => {
|
|
const n = parseInt(raw, 10)
|
|
if (!Number.isFinite(n) || n < 0) {
|
|
throw new Error(`${flag} must be a non-negative integer, got "${raw}"`)
|
|
}
|
|
return n
|
|
}
|
|
}
|
|
|
|
function buildCommand(): Command {
|
|
return new Command()
|
|
.name("simplex-chat-support-bot")
|
|
.description("business-address triage bot")
|
|
.requiredOption("--team-group <name>", "team group display name")
|
|
.option("--state-file <path>", "state JSON path", "./data/state.json")
|
|
.option("--sqlite-file-prefix <path>", "SQLite DB file prefix", "./data/simplex")
|
|
.option("--sqlite-key <key>", "SQLCipher encryption key (default: unencrypted)")
|
|
.option("--pg-conn <conn>", "PostgreSQL connection string (required for postgres)")
|
|
.option("--pg-schema <prefix>", "PostgreSQL schema prefix (default: simplex_v1)")
|
|
.option("-a, --auto-add-team-members <list>", "comma-separated ID:name pairs (e.g. 1:Alice,2:Bob)")
|
|
.option("--timezone <iana>", "IANA timezone for weekend detection", "UTC")
|
|
.option("--complete-hours <n>", "auto-complete chats after N hours idle (0 disables)", parseNonNegativeInt("--complete-hours"), 3)
|
|
.option("--card-flush-seconds <n>", "debounce card state writes", parseNonNegativeInt("--card-flush-seconds"), 300)
|
|
.option("--context-file <path>", "text file with Grok system context (required if GROK_API_KEY set)")
|
|
.addHelpText("after", "\nEnvironment:\n GROK_API_KEY xAI API key — enables Grok replies\n SIMPLEX_BACKEND sqlite | postgres — alternative to .npmrc for backend selection\n")
|
|
}
|
|
|
|
interface RawOpts {
|
|
teamGroup: string
|
|
stateFile: string
|
|
sqliteFilePrefix: string
|
|
sqliteKey?: string
|
|
pgConn?: string
|
|
pgSchema?: string
|
|
autoAddTeamMembers?: string
|
|
timezone: string
|
|
completeHours: number
|
|
cardFlushSeconds: number
|
|
contextFile?: string
|
|
}
|
|
|
|
export function parseConfig(args: string[]): Config {
|
|
const cmd = buildCommand().exitOverride()
|
|
try {
|
|
cmd.parse(args, {from: "user"})
|
|
} catch (err) {
|
|
const code = (err as {code?: string}).code
|
|
if (code === "commander.helpDisplayed" || code === "commander.version") process.exit(0)
|
|
throw err
|
|
}
|
|
const opts = cmd.opts<RawOpts>()
|
|
|
|
const grokApiKey = process.env.GROK_API_KEY || null
|
|
|
|
const backend = detectBackend()
|
|
let db: api.DbConfig
|
|
if (backend === "sqlite") {
|
|
db = opts.sqliteKey
|
|
? {type: "sqlite", filePrefix: opts.sqliteFilePrefix, encryptionKey: opts.sqliteKey}
|
|
: {type: "sqlite", filePrefix: opts.sqliteFilePrefix}
|
|
} else {
|
|
if (!opts.pgConn) {
|
|
throw new Error("--pg-conn is required when backend is postgres (PostgreSQL connection string)")
|
|
}
|
|
db = opts.pgSchema
|
|
? {type: "postgres", connectionString: opts.pgConn, schemaPrefix: opts.pgSchema}
|
|
: {type: "postgres", connectionString: opts.pgConn}
|
|
}
|
|
|
|
const teamGroup: IdName = {id: 0, name: opts.teamGroup}
|
|
|
|
const teamMembersRaw = opts.autoAddTeamMembers ?? ""
|
|
const teamMembers = teamMembersRaw
|
|
? teamMembersRaw.split(",").map(parseIdName)
|
|
: []
|
|
|
|
try {
|
|
new Intl.DateTimeFormat("en-US", {timeZone: opts.timezone, weekday: "short"})
|
|
} catch (err) {
|
|
throw new Error(`--timezone "${opts.timezone}" is not a valid IANA time zone: ${(err as Error).message}`)
|
|
}
|
|
|
|
const contextFile = opts.contextFile ?? null
|
|
if (grokApiKey && !contextFile) {
|
|
throw new Error("GROK_API_KEY is set but --context-file is not provided. Grok requires a context file.")
|
|
}
|
|
|
|
return {
|
|
stateFile: opts.stateFile,
|
|
db,
|
|
teamGroup,
|
|
teamMembers,
|
|
grokContactId: null,
|
|
timezone: opts.timezone,
|
|
completeHours: opts.completeHours,
|
|
cardFlushSeconds: opts.cardFlushSeconds,
|
|
contextFile,
|
|
grokApiKey,
|
|
}
|
|
}
|