indifferentketchup
952b22ac12
Mongoose 6 entered maintenance/EOL in 2023; current major is 8.x. No source
changes required — every API the codebase uses is identical between v6 and
v8:
- models.js schema DSL (Schema, default: Date.now function refs, enum,
unique, required, index) is unchanged.
- db-connection.js connect options (serverSelectionTimeoutMS,
socketTimeoutMS) and connection event names (error/disconnected/
reconnected) are unchanged.
- All queries already use the v7+-required APIs: countDocuments (not the
removed count()), updateOne/findOneAndUpdate (not the removed update()),
bulkWrite, .lean() — no callback-based queries, no Model.remove(),
no findOneAndRemove.
- findOneAndUpdate sites all explicitly pass { new: true } so the v7
default-flip from old-doc to new-doc doesn't change behavior.
- strictQuery default flipped to false in v7+; codebase only filters on
schema-defined fields, so the change is a no-op.
Verification on this commit:
- node -e "require('./db-connection')" loads cleanly; modelNames() returns
the expected six models.
- Every source file under handlers/, services/, routes/, gmail-poll.js,
broccolini-discord.js requires cleanly.
- new Ticket(...).validateSync() accepts valid docs, rejects invalid enum
values, and Date defaults still fire.
- vitest run still passes (87/87) — pure-function suite is unaffected by
the upgrade but confirms no regression in the dependency-shared modules.
Production verification (live DB CRUD: create/find/updateOne/deleteOne/
bulkWrite) still owed via docker compose up --build -d on the homelab.
Broccolini Bot
A Node.js Discord bot that bridges Gmail ↔ Discord for support ticketing, with MongoDB for state. Built for Indifferent Broccoli (game-server hosting).
- Inbound email → Discord ticket channel.
- Staff messages in that channel → Gmail reply (threaded).
- Discord-originated tickets (panel / context menu) live entirely in Discord.
For an architectural overview, see HOWITWORKS.md. For agent/contributor conventions, see CLAUDE.md.
Quick start
git clone <repo-url>
cd broccolini-bot
npm install
cp .env.example .env
# fill DISCORD_TOKEN, DISCORD_APPLICATION_ID, DISCORD_GUILD_ID, TICKET_CATEGORY_ID,
# ROLE_ID_TO_PING, MONGODB_URI, GOOGLE_CLIENT_ID/SECRET, REFRESH_TOKEN, MY_EMAIL
npm start
Need a Gmail refresh token? node get-refresh-token.js (redirect URI http://localhost:3000/oauth2callback). Probe Mongo with npm run test-mongodb.
Restart the bot after any .env change. Restart also re-registers slash commands.
Deploy (Docker)
docker compose up --build -d
docker logs broccolini --tail 50 -f
Host port 8892 → container 5000 (DISCORD_ONLY_PORT).
Configuration
All config is environment variables loaded by config.js into CONFIG. The full list — with descriptions and defaults — lives in .env.example. Highlights:
| Variable | Notes |
|---|---|
DISCORD_TOKEN / DISCORD_BOT_TOKEN |
Bot token. First non-empty after trim wins. |
DISCORD_APPLICATION_ID, DISCORD_GUILD_ID |
Required for slash command registration. |
TICKET_CATEGORY_ID |
Default category for email tickets. Validated at startup. |
DISCORD_TICKET_CATEGORY_ID |
Category for Discord panel/context tickets (falls back to TICKET_CATEGORY_ID). |
ROLE_ID_TO_PING |
Support role pinged on new tickets. |
MONGODB_URI |
Mongo connection string. |
GOOGLE_CLIENT_ID / GOOGLE_CLIENT_SECRET / REFRESH_TOKEN / MY_EMAIL |
Gmail OAuth + canonical inbox address. |
RENAMER_BOT |
Optional secondary token used for channel renames. |
INTERNAL_API_SECRET / INTERNAL_API_PORT |
Enable the internal config API used by the settings UI. |
Slash commands
| Command | Purpose |
|---|---|
/escalate, /deescalate |
Move ticket between tier 2/3 categories. |
/add, /remove |
Add/remove user from current ticket channel. |
/transfer |
Hand the claim to another staff member. |
/move |
Reparent the channel to another category. |
/force-close, /cancel-close, /closetimer |
Force-close flow with cancellable countdown. |
/topic |
Set channel topic. |
/response |
Saved reply templates (send, create, edit, delete, list). |
/panel |
Post an "Open ticket" panel button (thread / category / both). |
/notifydm |
Toggle DM alerts when a customer replies in your claimed ticket. |
/signature |
Personal email signature (valediction, display name, tagline). |
/staffthread |
Toggle / configure staff-only threads on tickets. |
/pinmessages |
Auto-pin welcome / escalation messages. |
/gmailpoll |
Set the Gmail poll interval at runtime. |
/help |
In-bot summary. |
Plus context menus: Create Ticket From Message, View User Tickets.
Settings UI (optional)
settings-site/ is a separate Express app that talks to the bot's internal config API over the broccoli-net Docker network using INTERNAL_API_SECRET. It is not part of this bot's process. See settings-site/CLAUDE.md.
Troubleshooting
| Symptom | Check |
|---|---|
| Slash commands missing | Correct DISCORD_APPLICATION_ID + DISCORD_GUILD_ID; restart; Discord can take a minute to sync. |
| Gmail not ingesting | REFRESH_TOKEN valid? Auth failure halts polling — re-auth and restart. |
| Mongo errors at startup | MONGODB_URI reachable? npm run test-mongodb to confirm. |
| Channel rename "too quickly" | Discord limit is 2 renames/10 min per channel — the queue serializes; wait it out. |
| Modal/button no response | Bot online + intents enabled; check DEBUGGING_CHANNEL_ID / container logs. |
License
ISC