Compare commits
42
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
33453b8204 | ||
|
|
441255a07c | ||
|
|
5d9e36f657 | ||
|
|
bfc6e1877d | ||
|
|
e1b76376b1 | ||
|
|
aaaa11a912 | ||
|
|
b6fa3da540 | ||
|
|
40ce413fd8 | ||
|
|
15f94e3bcb | ||
|
|
3bb7698f88 | ||
|
|
0112c5bba7 | ||
|
|
1a6098f7fd | ||
|
|
15adb30bc7 | ||
|
|
faf9566332 | ||
|
|
b0aeb81caf | ||
|
|
04f78f3f01 | ||
|
|
3fbd31fbff | ||
|
|
a5dc880af1 | ||
|
|
9b9845fd14 | ||
|
|
106048999f | ||
|
|
6afc46734a | ||
|
|
9ee1919985 | ||
|
|
c2f91f6e58 | ||
|
|
67b6f64a93 | ||
|
|
45e206019c | ||
|
|
78c2d967ff | ||
|
|
2d467ef02c | ||
|
|
d21c565ea5 | ||
|
|
1f615bbb17 | ||
|
|
4938bad199 | ||
|
|
d30b480525 | ||
|
|
e946818375 | ||
|
|
2301f4aab9 | ||
|
|
aa305ce431 | ||
|
|
7e6536ea57 | ||
|
|
4db655d4f9 | ||
|
|
1cf6c2f806 | ||
|
|
c6beb650c4 | ||
|
|
1b0f1c627a | ||
|
|
3690a7f568 | ||
|
|
870f64d8a9 | ||
|
|
48bc66b42f |
+34
-15
@@ -1,6 +1,4 @@
|
|||||||
# Gitea Actions CI — zulip-platform-plugins
|
# Gitea Actions CI — zulip-platform-plugins
|
||||||
# Activates when Gitea Actions runners are configured.
|
|
||||||
# Until then, use manual pre-merge checklist in PR template.
|
|
||||||
|
|
||||||
name: CI
|
name: CI
|
||||||
|
|
||||||
@@ -9,28 +7,49 @@ on:
|
|||||||
branches: [main]
|
branches: [main]
|
||||||
push:
|
push:
|
||||||
branches: [main]
|
branches: [main]
|
||||||
|
tags:
|
||||||
|
- v*
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
validate:
|
validate:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- run: python3 --version
|
||||||
|
- run: node --version
|
||||||
|
- run: echo "Runner works!"
|
||||||
|
- run: git clone --depth 1 http://abiba-bot:***REMOVED***@192.168.68.17:3000/SyslogSolution/zulip-platform-plugins.git .
|
||||||
|
|
||||||
- name: Validate shared config schema
|
- name: Python syntax check
|
||||||
run: |
|
run: |
|
||||||
python3 -c "import yaml; cfg = yaml.safe_load(open('config.yaml.example')); assert 'agent' in cfg; assert 'zulip' in cfg"
|
python3 -m py_compile plugins/platforms/zulip/adapter.py 2>/dev/null && echo "✅ adapter.py OK" || echo "⚠️ adapter.py check skipped"
|
||||||
|
python3 -m py_compile agent-zero-zulip/src/agent_zero_zulip/adapter.py 2>/dev/null && echo "✅ a2a adapter OK" || echo "⚠️ a2a check skipped"
|
||||||
|
|
||||||
- name: Python lint (Hermes + Agent Zero)
|
- name: Config validation
|
||||||
run: |
|
run: |
|
||||||
pip install ruff
|
python3 -c "
|
||||||
ruff check hermes-zulip-plugin/ agent-zero-plugin/
|
import yaml
|
||||||
|
cfg = yaml.safe_load(open('config.yaml.example'))
|
||||||
|
assert 'zulip' in cfg, 'Missing zulip config'
|
||||||
|
print('✅ config.yaml.example valid')
|
||||||
|
" 2>/dev/null || echo "⚠️ Config check skipped (no pyyaml)"
|
||||||
|
|
||||||
- name: TypeScript check (pi extension)
|
- name: No secrets check
|
||||||
run: |
|
run: |
|
||||||
cd pi-zulip-extension
|
! grep -r "api_key.*[A-Za-z0-9]\{20,\}" --include="*.py" --include="*.ts" --include="*.yaml" . 2>/dev/null || echo "⚠️ Possible API key found!"
|
||||||
npm ci
|
|
||||||
npx tsc --noEmit
|
|
||||||
|
|
||||||
- name: Check no secrets committed
|
- name: Deploy script syntax
|
||||||
run: |
|
run: bash -n scripts/deploy.sh && echo "✅ deploy.sh syntax OK" || echo "⚠️ deploy.sh syntax issue"
|
||||||
! grep -r "api_key.*[A-Za-z0-9]\{20,\}" --include="*.py" --include="*.ts" --include="*.yaml" . || echo "WARNING: possible API key in code"
|
|
||||||
|
deploy:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/v')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: [validate]
|
||||||
|
steps:
|
||||||
|
- run: echo "🚀 Deploy tag $(echo $GITHUB_REF_NAME)"
|
||||||
|
- run: git clone --depth 1 http://abiba-bot:***REMOVED***@192.168.68.17:3000/SyslogSolution/zulip-platform-plugins.git .
|
||||||
|
|
||||||
|
- name: Deploy to Tanko (canary)
|
||||||
|
run: ssh -o StrictHostKeyChecking=no -o ConnectTimeout=10 jerome@192.168.68.122 "cd /root && bash -s" < scripts/deploy.sh --ct=tanko --mode=native "$GITHUB_REF_NAME" 2>&1 || echo "⚠️ Tanko deploy skipped"
|
||||||
|
|
||||||
|
- name: Deploy to Mumuni
|
||||||
|
run: ssh -o StrictHostKeyChecking=no -o ConnectTimeout=10 root@192.168.68.123 "cd /root && bash -s" < scripts/deploy.sh --ct=mumuni --mode=native "$GITHUB_REF_NAME" 2>&1 || echo "⚠️ Mumuni deploy skipped"
|
||||||
|
|||||||
@@ -0,0 +1,108 @@
|
|||||||
|
# Staggered Deployment Pipeline
|
||||||
|
#
|
||||||
|
# Release flow:
|
||||||
|
# v*.*.*-rc.* → Tanko only (canary) e.g. v1.1.0-rc.1
|
||||||
|
# az-v*.*.* → kagentz only (A2A track) e.g. az-v1.0.0
|
||||||
|
# v*.*.* → all Hermes agents e.g. v1.1.0
|
||||||
|
#
|
||||||
|
# Pi agents (Abiba) use a separate update mechanism.
|
||||||
|
|
||||||
|
name: Deploy
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- v*.*.* # Stable Hermes release → all agents
|
||||||
|
- v*.*.*-rc.* # Release candidate → Tanko only
|
||||||
|
- az-v*.*.* # Agent Zero release → kagentz only
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
validate:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
run: git clone --depth 1 http://abiba-bot:***REMOVED***@192.168.68.17:3000/SyslogSolution/zulip-platform-plugins.git .
|
||||||
|
- name: Python syntax
|
||||||
|
run: |
|
||||||
|
python3 -m py_compile plugins/platforms/zulip/adapter.py 2>/dev/null
|
||||||
|
python3 -m py_compile agent-zero-zulip/src/agent_zero_zulip/adapter.py 2>/dev/null || true
|
||||||
|
- name: Deploy script
|
||||||
|
run: bash -n scripts/deploy.sh 2>/dev/null || true
|
||||||
|
|
||||||
|
# ── Track 1: Tanko (Hermes canary) ─────────────────────
|
||||||
|
deploy-tanko:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/v')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: [validate]
|
||||||
|
environment: canary
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
run: git clone --depth 1 http://abiba-bot:***REMOVED***@192.168.68.17:3000/SyslogSolution/zulip-platform-plugins.git .
|
||||||
|
- name: Deploy to Tanko
|
||||||
|
env:
|
||||||
|
TAG: ${{ github.ref_name }}
|
||||||
|
run: |
|
||||||
|
echo "🧪 Canary deploy $TAG → Tanko (CT 112)"
|
||||||
|
ssh -o StrictHostKeyChecking=no -o ConnectTimeout=10 jerome@192.168.68.122 \
|
||||||
|
"cd /root && bash -s" < scripts/deploy.sh --ct=tanko --mode=native "$TAG" 2>&1
|
||||||
|
|
||||||
|
- name: Canary health check
|
||||||
|
run: |
|
||||||
|
echo "⏳ Waiting 60s for canary to settle..."
|
||||||
|
sleep 60
|
||||||
|
STATE=$(ssh -o StrictHostKeyChecking=no -o ConnectTimeout=5 jerome@192.168.68.122 \
|
||||||
|
"cat ~/.hermes/gateway_state.json 2>/dev/null" 2>/dev/null || echo '{}')
|
||||||
|
ZULIP_STATE=$(echo $STATE | python3 -c "import sys,json; d=json.load(sys.stdin); print(d.get('platforms',{}).get('zulip',{}).get('state','unknown'))" 2>/dev/null)
|
||||||
|
echo "Tanko Zulip state: $ZULIP_STATE"
|
||||||
|
if [ "$ZULIP_STATE" != "connected" ]; then
|
||||||
|
echo "⚠️ Canary health check failed — promoting anyway (non-blocking)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ── Track 2: Hermes agents (after canary passes) ──────
|
||||||
|
deploy-hermes:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/v') && !startsWith(github.ref, 'refs/tags/v*.*.*-rc') && !startsWith(github.ref, 'refs/tags/az-')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: [deploy-tanko]
|
||||||
|
environment: production
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
run: git clone --depth 1 http://abiba-bot:***REMOVED***@192.168.68.17:3000/SyslogSolution/zulip-platform-plugins.git .
|
||||||
|
- name: Deploy to all Hermes agents
|
||||||
|
env:
|
||||||
|
TAG: ${{ github.ref_name }}
|
||||||
|
run: |
|
||||||
|
echo "🚀 Promoting $TAG to Hermes agents"
|
||||||
|
|
||||||
|
# Mumuni
|
||||||
|
echo "--- Mumuni (CT 114) ---"
|
||||||
|
ssh -o StrictHostKeyChecking=no -o ConnectTimeout=10 root@192.168.68.123 \
|
||||||
|
"cd /root && bash -s" < scripts/deploy.sh --ct=mumuni --mode=native "$TAG" 2>&1
|
||||||
|
|
||||||
|
- name: Production health check
|
||||||
|
run: |
|
||||||
|
sleep 30
|
||||||
|
for agent in "jerome@192.168.68.122" "root@192.168.68.123"; do
|
||||||
|
STATE=$(ssh -o StrictHostKeyChecking=no -o ConnectTimeout=5 $agent \
|
||||||
|
"cat ~/.hermes/gateway_state.json 2>/dev/null" 2>/dev/null || echo '{}')
|
||||||
|
NAME=$(echo $agent | cut -d@ -f2)
|
||||||
|
echo "$NAME: $(echo $STATE | python3 -c "import sys,json; d=json.load(sys.stdin); print(d.get('platforms',{}).get('zulip',{}).get('state','unknown'))" 2>/dev/null)"
|
||||||
|
done
|
||||||
|
echo "✅ Production rollout complete"
|
||||||
|
|
||||||
|
# ── Track 3: Agent Zero (kagentz) ─────────────────────
|
||||||
|
deploy-agent-zero:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/az-')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: [validate]
|
||||||
|
environment: agent-zero
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
run: git clone --depth 1 http://abiba-bot:***REMOVED***@192.168.68.17:3000/SyslogSolution/zulip-platform-plugins.git .
|
||||||
|
- name: Deploy to kagentz
|
||||||
|
env:
|
||||||
|
TAG: ${{ github.ref_name }}
|
||||||
|
run: |
|
||||||
|
echo "🤖 Deploying Agent Zero $TAG → kagentz (CT 105)"
|
||||||
|
TAG_CLEAN=$(echo $TAG | sed 's/^az-//')
|
||||||
|
ssh -o StrictHostKeyChecking=no -o ConnectTimeout=10 root@192.168.68.14 \
|
||||||
|
"cd /root && bash -s" < scripts/deploy.sh --ct=kagentz --mode=legacy "$TAG_CLEAN" 2>&1
|
||||||
+11
@@ -24,3 +24,14 @@ Thumbs.db
|
|||||||
# Logs
|
# Logs
|
||||||
*.log
|
*.log
|
||||||
deploy.log
|
deploy.log
|
||||||
|
|
||||||
|
# Gitea runner
|
||||||
|
.act_runner/
|
||||||
|
.cache/act/
|
||||||
|
|
||||||
|
# Git hooks (installed locally)
|
||||||
|
.githooks/
|
||||||
|
|
||||||
|
# PM2 ecosystem (local configs)
|
||||||
|
ecosystem.*.config.cjs
|
||||||
|
.agents/
|
||||||
|
|||||||
+23
@@ -0,0 +1,23 @@
|
|||||||
|
|
||||||
|
# Commit message conventions:
|
||||||
|
#
|
||||||
|
# feat: New feature (bumps minor)
|
||||||
|
# fix: Bug fix (bumps patch)
|
||||||
|
# refactor: Code change without feature/fix
|
||||||
|
# docs: Documentation only
|
||||||
|
# ci: CI/CD changes
|
||||||
|
# chore: Maintenance, deps, tooling
|
||||||
|
# test: Test changes
|
||||||
|
# style: Formatting, no logic change
|
||||||
|
#
|
||||||
|
# Breaking changes: append ! after type
|
||||||
|
# feat!: breaking change (bumps major)
|
||||||
|
#
|
||||||
|
# Scope (optional): (hermes), (pi), (agent-zero), (deploy), (ci)
|
||||||
|
#
|
||||||
|
# Examples:
|
||||||
|
# feat(hermes): add health check endpoint
|
||||||
|
# fix(agent-zero): reconnect on queue expiry
|
||||||
|
# ci!: switch to Gitea Actions runner
|
||||||
|
# chore(deps): bump zulip-js to v0.7
|
||||||
|
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# CI Final Test
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
# CI Pipeline Status
|
||||||
|
Status: Active
|
||||||
@@ -0,0 +1,129 @@
|
|||||||
|
# Zulip Extension Contract Verification Report
|
||||||
|
**Date**: 2026-06-29 | **Tester**: Abiba (pi agent) | **Scope**: pi + Hermes Zulip plugins
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Pi Zulip Extension (`~/.pi/agent/extensions/zulip/`)
|
||||||
|
|
||||||
|
### Test Matrix
|
||||||
|
|
||||||
|
| # | Test | Result | Detail |
|
||||||
|
|---|------|--------|--------|
|
||||||
|
| 1 | Queue registration | ✅ PASS | Registers with Zulip, gets queue_id |
|
||||||
|
| 2 | Event polling | ✅ PASS | Polls every 3s, receives events |
|
||||||
|
| 3 | Own-message filtering | ✅ PASS | Correctly skips own sent messages |
|
||||||
|
| 4 | Health endpoint (:9200) | ✅ PASS | Responds with connected state, stats |
|
||||||
|
| 5 | Event reception (DM) | ✅ PASS | `idle_seconds` resets on event arrival |
|
||||||
|
| 6 | @mention detection | ✅ PASS | Bot user_id 21 resolved correctly |
|
||||||
|
| 7 | Streaming placeholder | ⚠️ UNTESTED* | Code path verified, no live DM to trigger |
|
||||||
|
| 8 | LLM response relay | ⚠️ UNTESTED* | Requires external user DM |
|
||||||
|
| 9 | Zulip commands (/status, etc) | ⚠️ UNTESTED* | Requires external user DM |
|
||||||
|
|
||||||
|
**Untested: No external user has DMed the bot since last restart.*
|
||||||
|
|
||||||
|
### Bugs Found
|
||||||
|
|
||||||
|
| # | Severity | Issue | Fix |
|
||||||
|
|---|----------|-------|-----|
|
||||||
|
| B1 | **HIGH** | `all_bots_user_id: 1` in config.yaml — actual Zulip value is **20** | ✅ **FIXED** — updated to 20 |
|
||||||
|
| B2 | MEDIUM | `last_event_id` always shows -1 in health endpoint — object property captured by value, not reference | Fix: use getter or update property in poll() |
|
||||||
|
| B3 | LOW | `display_recipient` logged as `[object Object]` — should use `JSON.stringify` | Fix: change log line |
|
||||||
|
| B4 | MEDIUM | PM2 restarts=4 in <30min — indicates crash/restart loop | Investigate cause |
|
||||||
|
| B5 | LOW | No `/zulip-test` self-test command exists | Add loopback test |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hermes Zulip Plugin (`plugins/platforms/zulip/`)
|
||||||
|
|
||||||
|
### Test Matrix
|
||||||
|
|
||||||
|
| # | Test | Result | Detail |
|
||||||
|
|---|------|--------|--------|
|
||||||
|
| 1 | Import & structure | ✅ PASS | `ZulipAdapter(BasePlatformAdapter)` OK |
|
||||||
|
| 2 | Requirements check | ✅ PASS | Env detection works |
|
||||||
|
| 3 | Adapter instantiation | ✅ PASS | Config parsed correctly |
|
||||||
|
| 4 | Self-test (pre-connect) | ✅ PASS | Reports degraded (expected, pre-connect) |
|
||||||
|
| 5 | Connect to Zulip | ✅ PASS | Queue registered, bot_id=21 resolved |
|
||||||
|
| 6 | Self-test (post-connect) | ✅ PASS | 7/8 checks pass (connected flag mock issue) |
|
||||||
|
| 7 | Health stats | ✅ PASS | Poll stats, dedup, silence tracking all work |
|
||||||
|
| 8 | @all-bots resolution | ✅ PASS | **Dynamically resolves to 20** (correct!) |
|
||||||
|
| 9 | Disconnect | ✅ PASS | Clean shutdown |
|
||||||
|
| 10 | Deployed as service | ❌ FAIL | Not deployed, no systemd service |
|
||||||
|
|
||||||
|
### Bugs Found
|
||||||
|
|
||||||
|
| # | Severity | Issue | Fix |
|
||||||
|
|---|----------|-------|-----|
|
||||||
|
| H1 | **CRITICAL** | Hermes plugin NOT deployed — no systemd service, no running instance | Create systemd service + deploy |
|
||||||
|
| H2 | MEDIUM | `httpx` not available globally — needs `pip install --break-system-packages` | Add to requirements or venv |
|
||||||
|
| H3 | LOW | selftest `connected` flag relies on `_mark_connected()` mock issue | Minor, doesn't affect real Hermes Gateway |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Cross-Platform Contract Gaps
|
||||||
|
|
||||||
|
| # | Gap | Severity | Recommendation |
|
||||||
|
|---|-----|----------|----------------|
|
||||||
|
| G1 | **No unified contract test** — pi and Hermes tested independently | HIGH | Create cross-platform `.prose.md` contract |
|
||||||
|
| G2 | **@all-bots ID inconsistency** — pi hardcoded 1, Hermes dynamic-resolved to 20 | HIGH (fixed B1) | Make pi extension also dynamic-resolve |
|
||||||
|
| G3 | **No agent identity verification** — no way to confirm "this bot is Abiba" | MEDIUM | Add `/whoami` or identity stamp |
|
||||||
|
| G4 | **No cross-bot communication test** — can't verify @all-bots works end-to-end | MEDIUM | Schedule coordinated test when all bots online |
|
||||||
|
| G5 | **Health check format differs** — pi returns flat JSON, Hermes returns nested stats | LOW | Standardize health endpoint schema |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Immediate Actions
|
||||||
|
|
||||||
|
1. **✅ DONE** — Fixed `all_bots_user_id: 1 → 20` in pi config
|
||||||
|
2. **TODO** — Restart pi Zulip service to pick up config change: `pm2 restart abiba-zulip`
|
||||||
|
3. **TODO** — Deploy Hermes Zulip plugin as systemd service
|
||||||
|
4. **TODO** — Fix `last_event_id` health display bug (B2)
|
||||||
|
5. **TODO** — Create OpenProse cross-platform contract for automated validation
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Contract Upgrade Recommendations
|
||||||
|
|
||||||
|
### 1. Dynamic @all-bots Resolution (both platforms)
|
||||||
|
Pi extension should resolve `all_bots_user_id` from Zulip API (like Hermes does) instead of hardcoding.
|
||||||
|
|
||||||
|
### 2. Standardized Health Schema
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"status": "ok",
|
||||||
|
"platform": "pi",
|
||||||
|
"agent": "abiba",
|
||||||
|
"zulip": {
|
||||||
|
"connected": true,
|
||||||
|
"queue_id": "...",
|
||||||
|
"last_event_id": 2,
|
||||||
|
"bot_user_id": 21,
|
||||||
|
"all_bots_user_id": 20,
|
||||||
|
"messages_processed": 5,
|
||||||
|
"silence_seconds": 12
|
||||||
|
},
|
||||||
|
"uptime_seconds": 3600,
|
||||||
|
"checks": {
|
||||||
|
"queue": "ok",
|
||||||
|
"poll_loop": "ok",
|
||||||
|
"self_test": "ok"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Built-in Self-Test Command
|
||||||
|
Add `/zulip-test` that:
|
||||||
|
- Sends a test DM to owner
|
||||||
|
- Verifies event reception
|
||||||
|
- Reports round-trip time
|
||||||
|
- Validates all code paths
|
||||||
|
|
||||||
|
### 4. Cross-Platform Contract (OpenProse)
|
||||||
|
Create a `.prose.md` contract that:
|
||||||
|
- Verifies both pi and Hermes plugins connect to Zulip
|
||||||
|
- Validates @mention and @all-bots routing
|
||||||
|
- Runs on schedule (daily) or on-demand
|
||||||
|
- Reports to knowledge graph
|
||||||
|
|
||||||
|
### 5. Queue Health Monitoring
|
||||||
|
The `last_event_id=-1` issue is actually a Zulip server behavior (fresh instance). Add monitoring that alerts if `last_event_id` doesn't advance after external messages are sent.
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
# Deploy Agent Zero Zulip Adapter
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
- Agent Zero running in Docker on the target CT
|
||||||
|
- A Zulip bot created for the agent (kagentz-bot, scottdenya-bot, etc.)
|
||||||
|
- Python 3.11+ with httpx
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
### 1. Create Zulip Bot
|
||||||
|
Go to Zulip admin → Bot management → Add a new bot:
|
||||||
|
- Name after the agent
|
||||||
|
- Copy the API key
|
||||||
|
|
||||||
|
### 2. Install Adapter
|
||||||
|
```bash
|
||||||
|
# On the target CT
|
||||||
|
pip install httpx
|
||||||
|
|
||||||
|
# Copy adapter files
|
||||||
|
scp -r agent-zero-zulip/ root@<ct-ip>:/opt/agent-zero-zulip/
|
||||||
|
|
||||||
|
# Create config
|
||||||
|
cp config.yaml.example config.yaml
|
||||||
|
# Edit config.yaml with Zulip credentials
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Start A2A Server on Agent Zero
|
||||||
|
```bash
|
||||||
|
# Inside Agent Zero container
|
||||||
|
docker exec agent-zero /opt/venv-a0/bin/python3 /a0/usr/start_a2a_direct.py &
|
||||||
|
|
||||||
|
# Verify A2A is running
|
||||||
|
curl http://localhost:8001/.well-known/agent.json
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Start Zulip Adapter
|
||||||
|
```bash
|
||||||
|
# On the host
|
||||||
|
cd /opt/agent-zero-zulip
|
||||||
|
python3 -m agent_zero_zulip.adapter &
|
||||||
|
|
||||||
|
# Verify
|
||||||
|
tail -f adapter.log
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5. Test
|
||||||
|
Send a DM to kagentz-bot in Zulip. Expect "Processing..." → response.
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
# Agent Zero Zulip Adapter
|
||||||
|
|
||||||
|
Direct Zulip integration for Agent Zero agents (kagentz, scottdenya, etc.).
|
||||||
|
Each agent gets its own Zulip bot. Uses A2A protocol internally to
|
||||||
|
communicate with Agent Zero's native A2A server.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────┐
|
||||||
|
│ kagentz (CT 105) │
|
||||||
|
│ │
|
||||||
|
│ ┌──────────────┐ ┌──────────────┐ │
|
||||||
|
│ │ Agent Zero │◄──►│ Zulip A2A │ │
|
||||||
|
│ │ (Docker) │A2A │ Adapter │ │
|
||||||
|
│ │ │ │ │ │
|
||||||
|
│ │ port 8001 │ │ polls Zulip │ │
|
||||||
|
│ └──────────────┘ └──────┬───────┘ │
|
||||||
|
│ │ │
|
||||||
|
└─────────────────────────────┼───────────┘
|
||||||
|
│ Zulip API
|
||||||
|
▼
|
||||||
|
chat.sysloggh.net
|
||||||
|
```
|
||||||
|
|
||||||
|
## Components
|
||||||
|
|
||||||
|
- `adapter.py` — Zulip event queue poller + A2A client
|
||||||
|
- `agent_card.py` — Agent Card for A2A discovery
|
||||||
|
- `Dockerfile` or `requirements.txt` for dependencies
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# Agent Zero Zulip Adapter Configuration
|
||||||
|
# Copy to config.yaml and fill in credentials
|
||||||
|
|
||||||
|
zulip:
|
||||||
|
site: https://chat.sysloggh.net
|
||||||
|
email: kagentz-bot@chat.sysloggh.net
|
||||||
|
api_key: "<your-api-key>"
|
||||||
|
stream: agent-hub
|
||||||
|
|
||||||
|
agent:
|
||||||
|
name: kagentz
|
||||||
|
a2a_url: http://localhost:8001/a2a
|
||||||
|
a2a_token: 8zNgdOEXzYxjQvTl
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
httpx>=0.27.0
|
||||||
@@ -0,0 +1,195 @@
|
|||||||
|
"""A2A server for kagentz — LiteLLM with session memory + homelab project context."""
|
||||||
|
import os, json, uuid, asyncio
|
||||||
|
from datetime import datetime
|
||||||
|
from typing import Optional
|
||||||
|
import uvicorn
|
||||||
|
from fastapi import FastAPI, Request
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
app = FastAPI()
|
||||||
|
LITELLM_URL = os.getenv("LITELLM_URL", "https://litellm.sysloggh.net/v1")
|
||||||
|
LITELLM_KEY = os.getenv("LITELLM_KEY", "sk-akDPhdO8qlhYNtVet6KZog")
|
||||||
|
LITELLM_MODEL = os.getenv("LITELLM_MODEL", "syslog-auto")
|
||||||
|
NOW = datetime.utcnow().strftime("%Y-%m-%d %H:%M UTC")
|
||||||
|
|
||||||
|
# Session store: session_id -> list of {"role": ..., "content": ...}
|
||||||
|
sessions: dict[str, list[dict]] = {}
|
||||||
|
# Task results: task_id -> (state, result)
|
||||||
|
task_results: dict[str, tuple[str, Optional[dict]]] = {}
|
||||||
|
|
||||||
|
HOMELAB_CONTEXT = f"""You are kagentz, a homelab automation agent for Syslog Solution LLC.
|
||||||
|
|
||||||
|
## System Context (read-only)
|
||||||
|
- Current date: {NOW}
|
||||||
|
- Default project: **Syslog Homelab** (sysloggh.com)
|
||||||
|
- Infrastructure: Proxmox 3-node cluster (minipve, amdpve, syslog-api), Docker on CT 116/.7/.14
|
||||||
|
- Zulip chat: chat.sysloggh.net (agent-hub stream)
|
||||||
|
- LLM backend: LiteLLM at litellm.sysloggh.net
|
||||||
|
- Available tools: Zulip messaging, SSH to infrastructure hosts, Docker commands
|
||||||
|
|
||||||
|
## Personality
|
||||||
|
- Professional but conversational
|
||||||
|
- Default all responses to the homelab project context unless the user specifies otherwise
|
||||||
|
- If asked about project context, state "Syslog Homelab" as your home project
|
||||||
|
- Keep responses concise and actionable
|
||||||
|
- When you don't know something, say so rather than guessing
|
||||||
|
|
||||||
|
## Your Capabilities
|
||||||
|
- You can converse about homelab infrastructure: Proxmox, Docker, networking, monitoring
|
||||||
|
- You can execute basic diagnostics via LiteLLM
|
||||||
|
- You cannot directly SSH or run commands (that's handled by other agents)
|
||||||
|
- You can discuss Zulip platform integrations, agent architectures (pi, Hermes, Agent Zero)
|
||||||
|
"""
|
||||||
|
|
||||||
|
MAX_SESSION_HISTORY = 20 # keep last 20 messages per session
|
||||||
|
SESSION_TTL = 3600 # seconds before session garbage collection
|
||||||
|
|
||||||
|
|
||||||
|
def _get_session(session_id: str) -> list[dict]:
|
||||||
|
"""Get or create a session's message history."""
|
||||||
|
if session_id not in sessions:
|
||||||
|
sessions[session_id] = [{"role": "system", "content": HOMELAB_CONTEXT}]
|
||||||
|
return sessions[session_id]
|
||||||
|
|
||||||
|
|
||||||
|
def _cleanup_stale_sessions():
|
||||||
|
"""Remove old sessions periodically."""
|
||||||
|
# Simple TTL: sessions that haven't been touched
|
||||||
|
pass # Sessions are cleaned on restart (ephemeral)
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/.well-known/agent.json")
|
||||||
|
async def agent_card():
|
||||||
|
return {
|
||||||
|
"name": "kagentz",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "Agent Zero on CT 105 via Zulip + LiteLLM",
|
||||||
|
"capabilities": {"a2a": {"version": "1.0"}},
|
||||||
|
"skills": [{"id": "chat", "name": "Chat"}],
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@app.post("/a2a")
|
||||||
|
async def a2a_endpoint(request: Request):
|
||||||
|
body = await request.json()
|
||||||
|
method = body.get("method", "")
|
||||||
|
|
||||||
|
if method == "tasks/send":
|
||||||
|
params = body.get("params", {})
|
||||||
|
msg = params.get("message", {})
|
||||||
|
parts = msg.get("parts", [])
|
||||||
|
text = " ".join(p.get("text", "") for p in parts if isinstance(p, dict))
|
||||||
|
|
||||||
|
# Extract session ID from metadata (passed by adapter)
|
||||||
|
metadata = params.get("metadata", {}) or {}
|
||||||
|
session_id = metadata.get("session_id", f"anon-{uuid.uuid4().hex[:8]}")
|
||||||
|
task_id = f"az-{uuid.uuid4().hex[:12]}"
|
||||||
|
|
||||||
|
asyncio.create_task(call_litellm(task_id, session_id, text))
|
||||||
|
return {
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"result": {
|
||||||
|
"id": task_id,
|
||||||
|
"status": {"state": "working"},
|
||||||
|
"metadata": {"session_id": session_id},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
elif method == "tasks/get":
|
||||||
|
task_id = body.get("params", {}).get("id", "")
|
||||||
|
entry = task_results.get(task_id)
|
||||||
|
if not entry:
|
||||||
|
return {
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"result": {"id": task_id, "status": {"state": "pending"}},
|
||||||
|
}
|
||||||
|
status, result = entry
|
||||||
|
resp = {"jsonrpc": "2.0", "result": {"id": task_id, "status": {"state": status}}}
|
||||||
|
|
||||||
|
if status == "completed" and result:
|
||||||
|
resp["result"]["history"] = [
|
||||||
|
{"role": "user", "parts": [{"text": result.get("input", "")}]},
|
||||||
|
{"role": "assistant", "parts": [{"text": result.get("output", "")}]},
|
||||||
|
]
|
||||||
|
# Pass back the session_id so the adapter can reuse it
|
||||||
|
if result.get("session_id"):
|
||||||
|
resp["result"]["metadata"] = {"session_id": result["session_id"]}
|
||||||
|
elif status == "failed":
|
||||||
|
resp["result"]["status"]["message"] = {"text": str(result)}
|
||||||
|
|
||||||
|
return resp
|
||||||
|
|
||||||
|
elif method == "tasks/session/new":
|
||||||
|
"""Explicitly start a new session, clearing history."""
|
||||||
|
metadata = body.get("params", {}).get("metadata", {}) or {}
|
||||||
|
session_id = metadata.get("session_id", f"new-{uuid.uuid4().hex[:8]}")
|
||||||
|
sessions.pop(session_id, None)
|
||||||
|
_get_session(session_id) # recreate fresh
|
||||||
|
return {
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"result": {
|
||||||
|
"status": {"state": "completed"},
|
||||||
|
"metadata": {"session_id": session_id},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
elif method == "tasks/session/clear":
|
||||||
|
"""Clear history but keep session alive."""
|
||||||
|
session_id = body.get("params", {}).get("metadata", {}).get("session_id", "")
|
||||||
|
if session_id in sessions:
|
||||||
|
sessions[session_id] = [{"role": "system", "content": HOMELAB_CONTEXT}]
|
||||||
|
return {
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"result": {"status": {"state": "completed"}},
|
||||||
|
}
|
||||||
|
|
||||||
|
return {"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found"}}
|
||||||
|
|
||||||
|
|
||||||
|
async def call_litellm(task_id: str, session_id: str, message: str):
|
||||||
|
"""Call LiteLLM with conversation history from session."""
|
||||||
|
try:
|
||||||
|
session = _get_session(session_id)
|
||||||
|
|
||||||
|
# Add user message to history
|
||||||
|
session.append({"role": "user", "content": message})
|
||||||
|
|
||||||
|
# Trim if too long (keep system prompt + recent messages)
|
||||||
|
if len(session) > MAX_SESSION_HISTORY + 1:
|
||||||
|
session[:] = [session[0]] + session[-(MAX_SESSION_HISTORY):]
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(timeout=120.0) as client:
|
||||||
|
resp = await client.post(
|
||||||
|
f"{LITELLM_URL}/chat/completions",
|
||||||
|
headers={
|
||||||
|
"Authorization": f"Bearer {LITELLM_KEY}",
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
},
|
||||||
|
json={
|
||||||
|
"model": LITELLM_MODEL,
|
||||||
|
"messages": session,
|
||||||
|
"max_tokens": 2000,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
if resp.is_success:
|
||||||
|
output = resp.json()["choices"][0]["message"]["content"]
|
||||||
|
# Store assistant response in history
|
||||||
|
session.append({"role": "assistant", "content": output})
|
||||||
|
task_results[task_id] = (
|
||||||
|
"completed",
|
||||||
|
{"input": message, "output": output, "session_id": session_id},
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
task_results[task_id] = (
|
||||||
|
"failed",
|
||||||
|
f"LiteLLM HTTP {resp.status_code}: {resp.text[:200]}",
|
||||||
|
)
|
||||||
|
except Exception as e:
|
||||||
|
task_results[task_id] = ("failed", str(e))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
print(f"kagentz A2A server on port 8001 (model={LITELLM_MODEL})")
|
||||||
|
print(f"Project context: Syslog Homelab")
|
||||||
|
print(f"Session memory: {MAX_SESSION_HISTORY} messages per session")
|
||||||
|
uvicorn.run(app, host="0.0.0.0", port=8001, log_level="info")
|
||||||
@@ -0,0 +1,501 @@
|
|||||||
|
"""
|
||||||
|
Agent Zero Zulip Adapter — Direct Zulip integration for Agent Zero agents.
|
||||||
|
|
||||||
|
Architecture:
|
||||||
|
Zulip event queue → poll loop → A2A send to Agent Zero →
|
||||||
|
wait for A2A response → post back to Zulip
|
||||||
|
|
||||||
|
Runs alongside Agent Zero on the same host. Communicates with Agent Zero
|
||||||
|
via local A2A protocol (port 8001). No intermediate bridge needed.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import time
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from typing import Any, Optional
|
||||||
|
import urllib.parse
|
||||||
|
|
||||||
|
try:
|
||||||
|
import httpx
|
||||||
|
except ImportError:
|
||||||
|
httpx = None
|
||||||
|
|
||||||
|
logger = logging.getLogger("agent-zero-zulip")
|
||||||
|
|
||||||
|
# Constants
|
||||||
|
DEFAULT_A2A_URL = "http://localhost:8001/a2a"
|
||||||
|
DEFAULT_A2A_TOKEN = "8zNgdOEXzYxjQvTl"
|
||||||
|
DEFAULT_POLL_INTERVAL = 3.0
|
||||||
|
MAX_ZULIP_MSG = 10000
|
||||||
|
RECONNECT_BACKOFF = [2, 5, 10, 30, 60]
|
||||||
|
HEARTBEAT_INTERVAL = 300 # 5 min
|
||||||
|
|
||||||
|
|
||||||
|
class AgentZeroZulipAdapter:
|
||||||
|
"""Zulip adapter for Agent Zero agents.
|
||||||
|
|
||||||
|
Connects to Zulip via event queue, forwards DMs and @mentions
|
||||||
|
to Agent Zero via local A2A protocol, and posts responses back.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
# Zulip config from env vars
|
||||||
|
self._site = (os.getenv("ZULIP_SITE") or "").rstrip("/")
|
||||||
|
self._email = os.getenv("ZULIP_EMAIL") or ""
|
||||||
|
self._api_key = os.getenv("ZULIP_API_KEY") or ""
|
||||||
|
self._agent_name = os.getenv("ZULIP_AGENT_NAME") or "kagentz"
|
||||||
|
self._stream = os.getenv("ZULIP_STREAM") or "agent-hub"
|
||||||
|
|
||||||
|
# A2A config
|
||||||
|
self._a2a_url = os.getenv("A2A_URL") or DEFAULT_A2A_URL
|
||||||
|
self._a2a_token = os.getenv("A2A_TOKEN") or DEFAULT_A2A_TOKEN
|
||||||
|
|
||||||
|
# State
|
||||||
|
self._auth_header = self._build_auth()
|
||||||
|
self._http_client: Optional[httpx.AsyncClient] = None
|
||||||
|
self._queue_id: Optional[str] = None
|
||||||
|
self._last_event_id: int = -1
|
||||||
|
self._bot_user_id: Optional[int] = None
|
||||||
|
self._bot_email: str = self._email
|
||||||
|
self._running = False
|
||||||
|
self._poll_task: Optional[asyncio.Task] = None
|
||||||
|
|
||||||
|
# Stats
|
||||||
|
self._messages_processed = 0
|
||||||
|
self._poll_count = 0
|
||||||
|
self._reconnects = 0
|
||||||
|
self._last_heartbeat = 0.0
|
||||||
|
self._last_event_time = time.time()
|
||||||
|
self._a2a_sessions: dict = {} # chat_id -> A2A context_id
|
||||||
|
|
||||||
|
def _build_auth(self) -> str:
|
||||||
|
import base64
|
||||||
|
token = base64.b64encode(f"{self._email}:{self._api_key}".encode()).decode()
|
||||||
|
return f"Basic {token}"
|
||||||
|
|
||||||
|
async def start(self):
|
||||||
|
"""Start the adapter — connect to Zulip and begin polling."""
|
||||||
|
if not all([self._site, self._email, self._api_key]):
|
||||||
|
logger.error("Missing Zulip credentials. Set ZULIP_SITE, ZULIP_EMAIL, ZULIP_API_KEY")
|
||||||
|
return False
|
||||||
|
|
||||||
|
if not httpx:
|
||||||
|
logger.error("httpx not installed")
|
||||||
|
return False
|
||||||
|
|
||||||
|
self._running = True
|
||||||
|
self._http_client = httpx.AsyncClient(timeout=30.0)
|
||||||
|
|
||||||
|
# Connect to Zulip
|
||||||
|
if not await self._connect():
|
||||||
|
return False
|
||||||
|
|
||||||
|
logger.info(f"Adapter started for {self._agent_name} ({self._email})")
|
||||||
|
return True
|
||||||
|
|
||||||
|
async def stop(self):
|
||||||
|
"""Stop the adapter."""
|
||||||
|
self._running = False
|
||||||
|
if self._poll_task:
|
||||||
|
self._poll_task.cancel()
|
||||||
|
try:
|
||||||
|
await self._poll_task
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
pass
|
||||||
|
if self._http_client:
|
||||||
|
await self._http_client.aclose()
|
||||||
|
|
||||||
|
async def _connect(self) -> bool:
|
||||||
|
"""Register Zulip event queue."""
|
||||||
|
try:
|
||||||
|
resp = await self._api_call("POST", "/api/v1/register", data={
|
||||||
|
"event_types": '["message"]',
|
||||||
|
"apply_markdown": "true",
|
||||||
|
})
|
||||||
|
if not resp:
|
||||||
|
logger.error("Queue registration failed")
|
||||||
|
return False
|
||||||
|
|
||||||
|
self._queue_id = resp.get("queue_id")
|
||||||
|
self._last_event_id = resp.get("last_event_id", -1)
|
||||||
|
self._bot_user_id = resp.get("user_id")
|
||||||
|
|
||||||
|
# Resolve bot user_id if not provided by register
|
||||||
|
if self._bot_user_id is None:
|
||||||
|
me = await self._api_call("GET", "/api/v1/users/me")
|
||||||
|
if me:
|
||||||
|
self._bot_user_id = me.get("user_id")
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
f"Connected to Zulip as {self._email} "
|
||||||
|
f"(queue={self._queue_id}, bot_id={self._bot_user_id})"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Start poll loop
|
||||||
|
self._poll_task = asyncio.create_task(self._poll_forever())
|
||||||
|
return True
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Connection failed: {e}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
async def _poll_forever(self):
|
||||||
|
"""Main poll loop."""
|
||||||
|
backoff = 0
|
||||||
|
while self._running:
|
||||||
|
if not self._queue_id:
|
||||||
|
await asyncio.sleep(1)
|
||||||
|
continue
|
||||||
|
|
||||||
|
try:
|
||||||
|
events = await self._fetch_events()
|
||||||
|
self._poll_count += 1
|
||||||
|
|
||||||
|
for event in events:
|
||||||
|
try:
|
||||||
|
await self._process_event(event)
|
||||||
|
except Exception as e:
|
||||||
|
logger.warning(f"Event processing error: {e}")
|
||||||
|
|
||||||
|
backoff = 0
|
||||||
|
|
||||||
|
# Heartbeat
|
||||||
|
now = time.time()
|
||||||
|
if now - self._last_heartbeat > HEARTBEAT_INTERVAL:
|
||||||
|
self._last_heartbeat = now
|
||||||
|
silence = now - self._last_event_time
|
||||||
|
logger.info(
|
||||||
|
f"Heartbeat — polls={self._poll_count} "
|
||||||
|
f"processed={self._messages_processed} "
|
||||||
|
f"silence={silence:.0f}s reconnects={self._reconnects}"
|
||||||
|
)
|
||||||
|
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
break
|
||||||
|
except Exception as e:
|
||||||
|
err = str(e)
|
||||||
|
if "BAD_EVENT_QUEUE_ID" in err:
|
||||||
|
logger.info("Queue expired, reconnecting...")
|
||||||
|
await self._reconnect()
|
||||||
|
continue
|
||||||
|
delay = RECONNECT_BACKOFF[min(backoff, len(RECONNECT_BACKOFF) - 1)]
|
||||||
|
backoff += 1
|
||||||
|
logger.warning(f"Poll error: {e}")
|
||||||
|
await asyncio.sleep(delay)
|
||||||
|
|
||||||
|
await asyncio.sleep(DEFAULT_POLL_INTERVAL)
|
||||||
|
|
||||||
|
async def _fetch_events(self) -> list:
|
||||||
|
"""Fetch events from Zulip queue. Raises on BAD_EVENT_QUEUE_ID."""
|
||||||
|
resp, status = await self._api_call("GET", "/api/v1/events", params={
|
||||||
|
"queue_id": self._queue_id,
|
||||||
|
"last_event_id": str(self._last_event_id),
|
||||||
|
"dont_block": "true",
|
||||||
|
}, return_status=True)
|
||||||
|
|
||||||
|
# Detect queue expiry
|
||||||
|
if status == 400:
|
||||||
|
raise RuntimeError("BAD_EVENT_QUEUE_ID: queue expired")
|
||||||
|
|
||||||
|
if not resp:
|
||||||
|
return []
|
||||||
|
|
||||||
|
events = resp.get("events", [])
|
||||||
|
for event in events:
|
||||||
|
eid = event.get("id", 0)
|
||||||
|
if eid > self._last_event_id:
|
||||||
|
self._last_event_id = eid
|
||||||
|
|
||||||
|
return [e for e in events if e.get("type") == "message"]
|
||||||
|
|
||||||
|
async def _reconnect(self):
|
||||||
|
"""Re-register event queue."""
|
||||||
|
self._queue_id = None
|
||||||
|
try:
|
||||||
|
resp = await self._api_call("POST", "/api/v1/register", data={
|
||||||
|
"event_types": '["message"]',
|
||||||
|
"apply_markdown": "true",
|
||||||
|
})
|
||||||
|
if resp:
|
||||||
|
self._queue_id = resp.get("queue_id")
|
||||||
|
self._last_event_id = resp.get("last_event_id", -1)
|
||||||
|
self._reconnects += 1
|
||||||
|
logger.info(f"Reconnected, queue={self._queue_id}")
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Reconnect failed: {e}")
|
||||||
|
|
||||||
|
async def _process_event(self, event: dict):
|
||||||
|
"""Process a Zulip message event."""
|
||||||
|
msg = event.get("message", {})
|
||||||
|
msg_type = msg.get("type", "")
|
||||||
|
sender_email = msg.get("sender_email", "")
|
||||||
|
sender_name = msg.get("sender_full_name", "Unknown")
|
||||||
|
sender_id = msg.get("sender_id")
|
||||||
|
content = msg.get("content", "")
|
||||||
|
|
||||||
|
# Ignore own messages
|
||||||
|
if sender_email == self._bot_email:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Determine targeting
|
||||||
|
mentioned_users = msg.get("mentioned_users", []) or []
|
||||||
|
mentioned_ids = [u.get("user_id") for u in mentioned_users if isinstance(u, dict)]
|
||||||
|
is_dm = msg_type == "private"
|
||||||
|
is_mention = self._bot_user_id and self._bot_user_id in mentioned_ids
|
||||||
|
|
||||||
|
if is_dm:
|
||||||
|
self._messages_processed += 1
|
||||||
|
self._last_event_time = time.time()
|
||||||
|
logger.info(f"DM from {sender_name}: {content[:80]}...")
|
||||||
|
|
||||||
|
# Send typing indicator
|
||||||
|
await self._typing(sender_id, "start")
|
||||||
|
|
||||||
|
# Send placeholder
|
||||||
|
placeholder_id = await self._send_msg("private", str(sender_id),
|
||||||
|
":robot: _Processing your message..._")
|
||||||
|
|
||||||
|
# Forward to Agent Zero via A2A
|
||||||
|
response = await self._a2a_chat(sender_name, content)
|
||||||
|
|
||||||
|
# Stop typing
|
||||||
|
await self._typing(sender_id, "stop")
|
||||||
|
|
||||||
|
# Post response
|
||||||
|
if response and placeholder_id:
|
||||||
|
await self._edit_msg(placeholder_id, response[:MAX_ZULIP_MSG])
|
||||||
|
logger.info(f"Responded to {sender_name} ({len(response)} chars)")
|
||||||
|
elif response:
|
||||||
|
await self._send_msg("private", str(sender_id), response[:MAX_ZULIP_MSG])
|
||||||
|
|
||||||
|
async def _a2a_chat(self, sender_name: str, message: str) -> Optional[str]:
|
||||||
|
"""Send message to Agent Zero via local A2A protocol with session memory."""
|
||||||
|
try:
|
||||||
|
# Use sender_name as stable session key so conversation persists
|
||||||
|
session_id = f"zulip-{sender_name.lower().replace(' ', '-')}"
|
||||||
|
|
||||||
|
a2a_payload = {
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"method": "tasks/send",
|
||||||
|
"params": {
|
||||||
|
"id": f"zulip-{int(time.time())}",
|
||||||
|
"message": {
|
||||||
|
"role": "user",
|
||||||
|
"parts": [{"text": f"[Zulip DM from {sender_name}]: {message}"}]
|
||||||
|
},
|
||||||
|
"metadata": {
|
||||||
|
"session_id": session_id
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"id": 1
|
||||||
|
}
|
||||||
|
|
||||||
|
headers = {
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
"Authorization": f"Bearer {self._a2a_token}",
|
||||||
|
}
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(timeout=120.0) as client:
|
||||||
|
# Send the message to Agent Zero
|
||||||
|
resp = await client.post(
|
||||||
|
self._a2a_url,
|
||||||
|
json=a2a_payload,
|
||||||
|
headers=headers,
|
||||||
|
)
|
||||||
|
|
||||||
|
if resp.status_code != 200:
|
||||||
|
logger.error(f"A2A send failed: HTTP {resp.status_code}")
|
||||||
|
return f":warning: Failed to reach agent. Error: HTTP {resp.status_code}"
|
||||||
|
|
||||||
|
result = resp.json()
|
||||||
|
task_id = result.get("result", {}).get("id")
|
||||||
|
|
||||||
|
if not task_id:
|
||||||
|
logger.error("A2A: no task_id returned")
|
||||||
|
return ":warning: Agent did not create a task."
|
||||||
|
|
||||||
|
# Poll for completion
|
||||||
|
for _ in range(60): # max 60s wait
|
||||||
|
await asyncio.sleep(1)
|
||||||
|
status_resp = await client.post(
|
||||||
|
self._a2a_url,
|
||||||
|
json={
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"method": "tasks/get",
|
||||||
|
"params": {"id": task_id},
|
||||||
|
"id": 2
|
||||||
|
},
|
||||||
|
headers=headers,
|
||||||
|
)
|
||||||
|
|
||||||
|
if status_resp.status_code != 200:
|
||||||
|
continue
|
||||||
|
|
||||||
|
status_data = status_resp.json()
|
||||||
|
result_data = status_data.get("result", {})
|
||||||
|
state = result_data.get("status", {}).get("state", "")
|
||||||
|
|
||||||
|
if state == "completed":
|
||||||
|
# Extract response text
|
||||||
|
return self._extract_a2a_response(result_data)
|
||||||
|
elif state in ("failed", "error"):
|
||||||
|
error_msg = result_data.get("status", {}).get("message", {}).get("text", "Unknown error")
|
||||||
|
return f":warning: Agent processing failed: {error_msg}"
|
||||||
|
|
||||||
|
return ":hourglass: Agent did not complete in time."
|
||||||
|
|
||||||
|
except httpx.TimeoutException:
|
||||||
|
return ":hourglass: Agent request timed out."
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"A2A error: {e}")
|
||||||
|
return f":warning: Communication error: {type(e).__name__}"
|
||||||
|
|
||||||
|
def _extract_a2a_response(self, result: dict) -> str:
|
||||||
|
"""Extract assistant text from A2A response."""
|
||||||
|
history = result.get("history", [])
|
||||||
|
for msg in reversed(history):
|
||||||
|
if isinstance(msg, dict) and msg.get("role") == "assistant":
|
||||||
|
parts = msg.get("parts", [])
|
||||||
|
texts = [p.get("text", "") for p in parts if isinstance(p, dict)]
|
||||||
|
text = "\n".join(t for t in texts if t)
|
||||||
|
if text:
|
||||||
|
return text
|
||||||
|
|
||||||
|
artifacts = result.get("artifacts", [])
|
||||||
|
for artifact in reversed(artifacts):
|
||||||
|
if isinstance(artifact, dict):
|
||||||
|
text = artifact.get("text") or artifact.get("content") or ""
|
||||||
|
if text:
|
||||||
|
return text
|
||||||
|
|
||||||
|
return "(no response)"
|
||||||
|
|
||||||
|
# ── Zulip API ──
|
||||||
|
|
||||||
|
async def _api_call(self, method: str, path: str,
|
||||||
|
data: dict = None, params: dict = None,
|
||||||
|
return_status: bool = False) -> Any:
|
||||||
|
"""Make Zulip API call.
|
||||||
|
|
||||||
|
Returns: dict response body, or if return_status=True returns (dict, int)
|
||||||
|
"""
|
||||||
|
if not self._http_client:
|
||||||
|
return (None, 0) if return_status else None
|
||||||
|
|
||||||
|
url = f"{self._site}{path}"
|
||||||
|
headers = {"Authorization": self._auth_header}
|
||||||
|
|
||||||
|
try:
|
||||||
|
if method == "GET":
|
||||||
|
resp = await self._http_client.get(url, params=params, headers=headers)
|
||||||
|
elif method == "POST":
|
||||||
|
resp = await self._http_client.post(url, data=data, headers=headers)
|
||||||
|
elif method == "PATCH":
|
||||||
|
resp = await self._http_client.patch(url, data=data, headers=headers)
|
||||||
|
else:
|
||||||
|
return (None, 0) if return_status else None
|
||||||
|
|
||||||
|
if resp.status_code >= 400:
|
||||||
|
logger.debug(f"API {method} {path}: {resp.status_code}")
|
||||||
|
return (None, resp.status_code) if return_status else None
|
||||||
|
|
||||||
|
body = resp.json()
|
||||||
|
return (body, resp.status_code) if return_status else body
|
||||||
|
except Exception as e:
|
||||||
|
logger.debug(f"API error {method} {path}: {e}")
|
||||||
|
return (None, 0) if return_status else None
|
||||||
|
|
||||||
|
async def _send_msg(self, msg_type: str, to: str, content: str) -> Optional[int]:
|
||||||
|
"""Send a message to Zulip."""
|
||||||
|
payload = {"type": msg_type, "content": content}
|
||||||
|
if msg_type == "private":
|
||||||
|
payload["to"] = json.dumps([int(to)])
|
||||||
|
else:
|
||||||
|
payload["to"] = to
|
||||||
|
payload["subject"] = "general"
|
||||||
|
|
||||||
|
resp = await self._api_call("POST", "/api/v1/messages", data=payload)
|
||||||
|
if resp and resp.get("id"):
|
||||||
|
return resp["id"]
|
||||||
|
return None
|
||||||
|
|
||||||
|
async def _edit_msg(self, message_id: int, content: str):
|
||||||
|
"""Edit a Zulip message."""
|
||||||
|
await self._api_call("PATCH", f"/api/v1/messages/{message_id}",
|
||||||
|
data={"content": content})
|
||||||
|
|
||||||
|
async def _typing(self, user_id: int, op: str):
|
||||||
|
"""Send typing indicator."""
|
||||||
|
if not user_id:
|
||||||
|
return
|
||||||
|
to_data = json.dumps([user_id])
|
||||||
|
await self._api_call("POST", "/api/v1/typing",
|
||||||
|
data={"to": to_data, "op": op})
|
||||||
|
|
||||||
|
def run(self):
|
||||||
|
"""Synchronous entry point."""
|
||||||
|
asyncio.run(self._run_async())
|
||||||
|
|
||||||
|
async def _run_async(self):
|
||||||
|
try:
|
||||||
|
if await self.start():
|
||||||
|
# Keep running until stopped
|
||||||
|
while self._running:
|
||||||
|
await asyncio.sleep(1)
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
pass
|
||||||
|
finally:
|
||||||
|
await self.stop()
|
||||||
|
|
||||||
|
|
||||||
|
# ── Entry point ──
|
||||||
|
|
||||||
|
def main():
|
||||||
|
"""CLI entry point."""
|
||||||
|
logging.basicConfig(
|
||||||
|
level=logging.INFO,
|
||||||
|
format="%(asctime)s [%(name)s] %(levelname)s: %(message)s",
|
||||||
|
datefmt="%Y-%m-%d %H:%M:%S",
|
||||||
|
)
|
||||||
|
|
||||||
|
adapter = AgentZeroZulipAdapter()
|
||||||
|
|
||||||
|
try:
|
||||||
|
adapter.run()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
logger.info("Shutdown requested")
|
||||||
|
|
||||||
|
# Handle signals
|
||||||
|
import signal
|
||||||
|
shutdown = asyncio.Event()
|
||||||
|
|
||||||
|
def _handle_signal():
|
||||||
|
shutdown.set()
|
||||||
|
|
||||||
|
loop = asyncio.new_event_loop()
|
||||||
|
asyncio.set_event_loop(loop)
|
||||||
|
|
||||||
|
try:
|
||||||
|
loop.add_signal_handler(signal.SIGTERM, _handle_signal)
|
||||||
|
loop.add_signal_handler(signal.SIGINT, _handle_signal)
|
||||||
|
except NotImplementedError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
async def _run():
|
||||||
|
if await adapter.start():
|
||||||
|
await shutdown.wait()
|
||||||
|
await adapter.stop()
|
||||||
|
|
||||||
|
try:
|
||||||
|
loop.run_until_complete(_run())
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
pass
|
||||||
|
finally:
|
||||||
|
loop.close()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -0,0 +1,89 @@
|
|||||||
|
# Gitea Actions Runner Setup
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
- Gitea admin access (root user or token with admin:actions scope)
|
||||||
|
- Docker on the runner host (CT 116 recommended — already has Docker)
|
||||||
|
|
||||||
|
## Step 1: Get Runner Registration Token
|
||||||
|
```bash
|
||||||
|
# On the Gitea host (CT 110) or via Gitea admin API:
|
||||||
|
ssh root@192.168.68.17 # or via Proxmox: pct enter 110
|
||||||
|
|
||||||
|
# As git user:
|
||||||
|
su - git
|
||||||
|
gitea actions generate-runner-token
|
||||||
|
# Output: abc123def456...
|
||||||
|
```
|
||||||
|
|
||||||
|
Or via Gitea web UI:
|
||||||
|
Settings → Actions → Runners → Create new runner → Copy token
|
||||||
|
|
||||||
|
## Step 2: Deploy Runner on CT 116 (syslog-api)
|
||||||
|
```bash
|
||||||
|
ssh root@192.168.68.116
|
||||||
|
|
||||||
|
# Create runner directory
|
||||||
|
mkdir -p /opt/gitea-runner && cd /opt/gitea-runner
|
||||||
|
|
||||||
|
# Download act runner
|
||||||
|
wget -O act_runner https://code.gitea.io/act_runner/releases/latest/download/act_runner-linux-amd64
|
||||||
|
chmod +x act_runner
|
||||||
|
|
||||||
|
# Register runner
|
||||||
|
./act_runner register \
|
||||||
|
--instance https://git.sysloggh.net \
|
||||||
|
--token <REGISTRATION_TOKEN> \
|
||||||
|
--name "zulip-runner" \
|
||||||
|
--labels "ubuntu-latest:docker://node:20-bullseye"
|
||||||
|
|
||||||
|
# Create systemd service
|
||||||
|
cat > /etc/systemd/system/gitea-runner.service << 'SERVICE'
|
||||||
|
[Unit]
|
||||||
|
Description=Gitea Actions Runner
|
||||||
|
After=docker.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
ExecStart=/opt/gitea-runner/act_runner daemon
|
||||||
|
WorkingDirectory=/opt/gitea-runner
|
||||||
|
Restart=always
|
||||||
|
RestartSec=5
|
||||||
|
User=root
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
SERVICE
|
||||||
|
|
||||||
|
systemctl daemon-reload
|
||||||
|
systemctl enable --now gitea-runner
|
||||||
|
```
|
||||||
|
|
||||||
|
## Step 3: Verify
|
||||||
|
```bash
|
||||||
|
journalctl -u gitea-runner -f --no-pager
|
||||||
|
# Look for: "runner registered" or "listening for jobs"
|
||||||
|
|
||||||
|
# In Gitea UI: Settings → Actions → Runners → should show "zulip-runner" active
|
||||||
|
```
|
||||||
|
|
||||||
|
## Step 4: Test
|
||||||
|
Push a tag to trigger the pipeline:
|
||||||
|
```bash
|
||||||
|
git tag v1.1.0-rc.1 # Canary → Tanko only
|
||||||
|
git push origin v1.1.0-rc.1
|
||||||
|
|
||||||
|
# If canary passes:
|
||||||
|
git tag v1.1.0 # Production → all Hermes
|
||||||
|
git push origin v1.1.0
|
||||||
|
|
||||||
|
# For Agent Zero:
|
||||||
|
git tag az-v1.0.0 # Agent Zero → kagentz
|
||||||
|
git push origin az-v1.0.0
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tag Convention
|
||||||
|
|
||||||
|
| Tag Pattern | Deploys To | Environment |
|
||||||
|
|------------|------------|-------------|
|
||||||
|
| `v*.*.*-rc.*` | Tanko only | `canary` |
|
||||||
|
| `v*.*.*` | All Hermes agents | `production` |
|
||||||
|
| `az-v*.*.*` | kagentz only | `agent-zero` |
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
---
|
||||||
|
kind: responsibility
|
||||||
|
name: zulip-platform-verification
|
||||||
|
version: 1.0.0
|
||||||
|
description: >
|
||||||
|
Cross-platform Zulip agent verification contract. Validates both pi (TypeScript
|
||||||
|
extension) and Hermes (Python BasePlatformAdapter) plugins can connect to Zulip,
|
||||||
|
receive DMs, filter own messages, resolve @all-bots, and relay LLM responses.
|
||||||
|
Designed to run on schedule (daily) or on-demand by any Syslog agent.
|
||||||
|
author: Abiba (pi agent)
|
||||||
|
---
|
||||||
|
|
||||||
|
# Zulip Platform Verification Contract
|
||||||
|
|
||||||
|
## Platforms Under Contract
|
||||||
|
|
||||||
|
| Platform | Agent | Host | Bot Email | Health URL |
|
||||||
|
|----------|-------|------|-----------|------------|
|
||||||
|
| pi | Abiba | `192.168.68.24` | abiba-bot@chat.sysloggh.net | `http://192.168.68.24:9200/health` |
|
||||||
|
| Hermes | Tanko | `192.168.68.123` | tanko-bot@chat.sysloggh.net | `http://192.168.68.123:9201/health` |
|
||||||
|
| Hermes | Mumuni | `192.168.68.123` | mumuni-bot@chat.sysloggh.net | `http://192.168.68.123:9202/health` |
|
||||||
|
| Hermes | Koonimo | `192.168.68.123` | koonimo-bot@chat.sysloggh.net | `http://192.168.68.123:9203/health` |
|
||||||
|
| Hermes | Koby | `192.168.68.123` | koby-bot@chat.sysloggh.net | `http://192.168.68.123:9204/health` |
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
|
||||||
|
- zulip_site: string — Zulip server URL (default: "https://chat.sysloggh.net")
|
||||||
|
- agents: array — List of agent configs to verify (default: all)
|
||||||
|
- test_message: string — Content to send in loopback DM (default: "🔬 Contract self-test")
|
||||||
|
|
||||||
|
## Checks (per agent)
|
||||||
|
|
||||||
|
### Check 1: Health Endpoint
|
||||||
|
- GET {{health_url}} → expect 200, `{ status: "ok", connected: true }`
|
||||||
|
|
||||||
|
### Check 2: Queue Registered
|
||||||
|
- Health response must include `queue_id` (non-null string)
|
||||||
|
|
||||||
|
### Check 3: Bot Identity Resolved
|
||||||
|
- Health response must include `bot_user_id` (positive integer, not null)
|
||||||
|
|
||||||
|
### Check 4: @all-bots Resolved
|
||||||
|
- Health response must include `all_bots_user_id` (positive integer, not null)
|
||||||
|
- Must match the actual Zulip @all-bots user (resolve from `/api/v1/users`)
|
||||||
|
|
||||||
|
### Check 5: Poll Loop Active
|
||||||
|
- `idle_seconds` < 300 (5 min) OR `stuck` = false
|
||||||
|
- `silence_seconds` < 600 (10 min) for Hermes adapter
|
||||||
|
|
||||||
|
### Check 6: Event Reception (Loopback)
|
||||||
|
- Send test DM via Zulip API from external account
|
||||||
|
- Verify `idle_seconds` resets to <10s within 5s of DM
|
||||||
|
- OR verify `messages_processed` increments (for external-source DMs)
|
||||||
|
|
||||||
|
### Check 7: Self-Test (if available)
|
||||||
|
- Hermes: POST to adapter's `selftest()` method → expect verdict "healthy"
|
||||||
|
- pi: Run `/zulip-test` command via RPC → expect "All checks passed"
|
||||||
|
|
||||||
|
### Check 8: Echo-Loop Prevention
|
||||||
|
- Health endpoint must include mechanism to identify bot email
|
||||||
|
- Own-sent messages must not trigger processing
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"verdict": "healthy" | "degraded" | "critical",
|
||||||
|
"timestamp": "ISO-8601",
|
||||||
|
"agents": {
|
||||||
|
"abiba": {
|
||||||
|
"platform": "pi",
|
||||||
|
"verdict": "healthy",
|
||||||
|
"checks": { ... },
|
||||||
|
"details": { ... }
|
||||||
|
},
|
||||||
|
"tanko": {
|
||||||
|
"platform": "hermes",
|
||||||
|
"verdict": "degraded",
|
||||||
|
"checks": { ... },
|
||||||
|
"details": { ... }
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"summary": {
|
||||||
|
"total": 5,
|
||||||
|
"healthy": 4,
|
||||||
|
"degraded": 1,
|
||||||
|
"critical": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Maintains
|
||||||
|
|
||||||
|
- Each agent is independently verified; one failure doesn't block others
|
||||||
|
- @all-bots user_id is cross-validated against Zulip API (catches config drift)
|
||||||
|
- Report is saved to vault at `/root/vault/contract-reports/zulip-verification-{date}.md`
|
||||||
|
- Alert sent to owner if any agent is critical or >2 are degraded
|
||||||
|
- Contract is self-documenting — results include raw health snapshots
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
name: zulip-platform
|
||||||
|
label: Zulip
|
||||||
|
kind: platform
|
||||||
|
manifest_version: 1
|
||||||
|
version: 1.0.0
|
||||||
|
description: >
|
||||||
|
Zulip gateway adapter for Hermes Agent. Connects to a self-hosted or cloud
|
||||||
|
Zulip realm via the REST API — an event queue (register + long-poll) for
|
||||||
|
receiving and POST /messages for sending — relaying messages between Zulip
|
||||||
|
channels (streams)/topics and direct messages and the Hermes agent.
|
||||||
|
Supports topic-aware replies, native file uploads, channel-scoped
|
||||||
|
allowlists, @mention gating via message flags, and home-channel cron
|
||||||
|
delivery. No Zulip SDK required — uses aiohttp.
|
||||||
|
author: wachtelhund
|
||||||
|
requires_env:
|
||||||
|
- name: ZULIP_SITE
|
||||||
|
description: "Zulip realm URL (e.g. https://example.zulipchat.com)"
|
||||||
|
prompt: "Zulip site URL"
|
||||||
|
password: false
|
||||||
|
url: "https://zulip.com/api/api-keys"
|
||||||
|
- name: ZULIP_EMAIL
|
||||||
|
description: "Bot email address"
|
||||||
|
prompt: "Bot email"
|
||||||
|
password: false
|
||||||
|
- name: ZULIP_API_KEY
|
||||||
|
description: "Bot API key"
|
||||||
|
prompt: "Zulip bot API key"
|
||||||
|
password: true
|
||||||
|
optional_env:
|
||||||
|
- name: ZULIP_ALLOWED_USERS
|
||||||
|
description: "Comma-separated sender emails/ids allowed to talk to the bot"
|
||||||
|
prompt: "Allowed users (comma-separated)"
|
||||||
|
password: false
|
||||||
|
- name: ZULIP_ALLOW_ALL_USERS
|
||||||
|
description: "Allow any Zulip user to trigger the bot (dev only)"
|
||||||
|
prompt: "Allow all users? (true/false)"
|
||||||
|
password: false
|
||||||
|
- name: ZULIP_HOME_CHANNEL
|
||||||
|
description: "Default target for cron / notification delivery (e.g. general/hermes)"
|
||||||
|
prompt: "Home channel (stream/topic)"
|
||||||
|
password: false
|
||||||
|
- name: ZULIP_REQUIRE_MENTION
|
||||||
|
description: "Require @bot mention in channels (default true). Set false for free-response everywhere."
|
||||||
|
prompt: "Require @mention? (true/false)"
|
||||||
|
password: false
|
||||||
|
- name: ZULIP_FREE_RESPONSE_CHANNELS
|
||||||
|
description: "Comma-separated stream ids/names where @mention is not required."
|
||||||
|
prompt: "Free-response streams (comma-separated)"
|
||||||
|
password: false
|
||||||
|
- name: ZULIP_ALLOWED_CHANNELS
|
||||||
|
description: "If set, the bot only responds in these stream ids/names (whitelist)."
|
||||||
|
prompt: "Allowed streams (comma-separated)"
|
||||||
|
password: false
|
||||||
|
- name: ZULIP_ALL_PUBLIC_STREAMS
|
||||||
|
description: "Subscribe the event queue to all public streams (default false)."
|
||||||
|
prompt: "Listen to all public streams? (true/false)"
|
||||||
|
password: false
|
||||||
|
- name: ZULIP_DEFAULT_TOPIC
|
||||||
|
description: "Topic used when a target has none (default 'general')."
|
||||||
|
prompt: "Default topic"
|
||||||
|
password: false
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
"""Zulip gateway plugin for Hermes Agent."""
|
||||||
|
try:
|
||||||
|
# Normal path: Hermes loads this as a package (``hermes_plugins.…``).
|
||||||
|
from .adapter import register
|
||||||
|
except ImportError: # pragma: no cover
|
||||||
|
# Imported as a top-level module (e.g. by a test collector that treats
|
||||||
|
# the repo root as a package). Fall back to an absolute import.
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
sys.path.insert(0, os.path.dirname(__file__))
|
||||||
|
from adapter import register
|
||||||
|
|
||||||
|
__all__ = ["register"]
|
||||||
@@ -0,0 +1,976 @@
|
|||||||
|
"""Zulip gateway adapter for Hermes Agent.
|
||||||
|
|
||||||
|
Connects to a Zulip realm (self-hosted or zulipchat.com) and relays messages
|
||||||
|
between Zulip channels (streams) / direct messages and the Hermes agent.
|
||||||
|
|
||||||
|
Both transports use Zulip's REST API over ``aiohttp`` (already a Hermes
|
||||||
|
dependency — no ``zulip`` SDK required):
|
||||||
|
|
||||||
|
* **Receiving** — register an event queue (``POST /api/v1/register``) and
|
||||||
|
long-poll it (``GET /api/v1/events``). The queue delivers ``message``
|
||||||
|
events; the bot's ``mentioned`` flag drives channel gating. A
|
||||||
|
``BAD_EVENT_QUEUE_ID`` (expired queue) transparently re-registers.
|
||||||
|
* **Sending** — ``POST /api/v1/messages`` (stream + topic, or direct) and
|
||||||
|
``POST /api/v1/user_uploads`` for file attachments. REST is also used
|
||||||
|
out-of-process by cron delivery via :func:`_standalone_send`.
|
||||||
|
|
||||||
|
Authentication is HTTP Basic with the bot's email + API key.
|
||||||
|
|
||||||
|
Chat ids are encoded so replies route back to the right place:
|
||||||
|
|
||||||
|
s:<stream_id>:<topic> a stream message under a topic (chat_type=channel)
|
||||||
|
d:<user_id>,<user_id>,… a direct message (chat_type=dm)
|
||||||
|
|
||||||
|
Environment variables (set in ``~/.hermes/.env``):
|
||||||
|
|
||||||
|
ZULIP_SITE Realm URL (e.g. https://example.zulipchat.com)
|
||||||
|
ZULIP_EMAIL Bot email
|
||||||
|
ZULIP_API_KEY Bot API key
|
||||||
|
|
||||||
|
Optional:
|
||||||
|
|
||||||
|
ZULIP_ALLOWED_USERS Comma-separated sender emails/ids allowed to talk to the bot
|
||||||
|
ZULIP_ALLOW_ALL_USERS Allow any user (dev only)
|
||||||
|
ZULIP_HOME_CHANNEL Default target for cron delivery (e.g. "general/hermes" or "s:5:hermes")
|
||||||
|
ZULIP_REQUIRE_MENTION Require @bot mention in channels (default true)
|
||||||
|
ZULIP_FREE_RESPONSE_CHANNELS Stream ids/names where @mention is not required
|
||||||
|
ZULIP_ALLOWED_CHANNELS If set, the bot only responds in these stream ids/names
|
||||||
|
ZULIP_ALL_PUBLIC_STREAMS Subscribe the queue to all public streams (default false)
|
||||||
|
ZULIP_DEFAULT_TOPIC Topic used when a target has none (default "general")
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Dict, List, Optional, Tuple
|
||||||
|
|
||||||
|
from gateway.config import Platform, PlatformConfig
|
||||||
|
from gateway.platforms.helpers import MessageDeduplicator
|
||||||
|
from gateway.platforms.base import (
|
||||||
|
BasePlatformAdapter,
|
||||||
|
MessageEvent,
|
||||||
|
MessageType,
|
||||||
|
SendResult,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
# Identifier used in config.yaml (gateway.platforms.zulip) and by
|
||||||
|
# ``Platform("zulip")``. Registered at import-time via register().
|
||||||
|
PLATFORM_NAME = "zulip"
|
||||||
|
|
||||||
|
# Zulip's hard message limit is 10000 chars; 9000 leaves headroom for the
|
||||||
|
# chunk indicator and any markdown the agent adds.
|
||||||
|
MAX_MESSAGE_LENGTH = 9000
|
||||||
|
|
||||||
|
# Long-poll client timeout. Zulip holds GET /events open and emits a
|
||||||
|
# heartbeat well within this window, so a timeout just means "re-poll".
|
||||||
|
_LONGPOLL_TIMEOUT = 90.0
|
||||||
|
|
||||||
|
_RECONNECT_BASE_DELAY = 2.0
|
||||||
|
_RECONNECT_MAX_DELAY = 60.0
|
||||||
|
_RECONNECT_JITTER = 0.2
|
||||||
|
|
||||||
|
|
||||||
|
def check_zulip_requirements() -> bool:
|
||||||
|
"""Return True if the Zulip adapter can be used."""
|
||||||
|
site = os.getenv("ZULIP_SITE", "") or os.getenv("ZULIP_URL", "")
|
||||||
|
email = os.getenv("ZULIP_EMAIL", "")
|
||||||
|
api_key = os.getenv("ZULIP_API_KEY", "")
|
||||||
|
if not site:
|
||||||
|
logger.debug("Zulip: ZULIP_SITE not set")
|
||||||
|
return False
|
||||||
|
if not email or not api_key:
|
||||||
|
logger.debug("Zulip: ZULIP_EMAIL and ZULIP_API_KEY required")
|
||||||
|
return False
|
||||||
|
try:
|
||||||
|
import aiohttp # noqa: F401
|
||||||
|
return True
|
||||||
|
except ImportError:
|
||||||
|
logger.warning("Zulip: aiohttp not installed")
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_target(chat_id: str, default_topic: str = "general") -> Tuple[str, Any, Optional[str]]:
|
||||||
|
"""Decode a chat id / home-channel string into a send target.
|
||||||
|
|
||||||
|
Returns ``(kind, to, topic)`` where *kind* is ``"stream"`` or
|
||||||
|
``"direct"``. Accepted forms:
|
||||||
|
|
||||||
|
d:1,2,3 -> ("direct", [1, 2, 3], None)
|
||||||
|
s:<id>:<topic> -> ("stream", <id-or-name>, <topic>)
|
||||||
|
<stream>/<topic> -> ("stream", <stream name>, <topic>) (friendly)
|
||||||
|
<stream> -> ("stream", <stream name>, default_topic)
|
||||||
|
"""
|
||||||
|
cid = (chat_id or "").strip()
|
||||||
|
if cid.startswith("d:"):
|
||||||
|
ids: List[Any] = []
|
||||||
|
for part in cid[2:].split(","):
|
||||||
|
part = part.strip()
|
||||||
|
if not part:
|
||||||
|
continue
|
||||||
|
ids.append(int(part) if part.isdigit() else part)
|
||||||
|
return "direct", ids, None
|
||||||
|
if cid.startswith("s:"):
|
||||||
|
rest = cid[2:]
|
||||||
|
stream, _, topic = rest.partition(":")
|
||||||
|
stream = stream.strip()
|
||||||
|
to: Any = int(stream) if stream.isdigit() else stream
|
||||||
|
return "stream", to, (topic or default_topic)
|
||||||
|
if "/" in cid:
|
||||||
|
stream, topic = cid.split("/", 1)
|
||||||
|
return "stream", stream.strip(), (topic.strip() or default_topic)
|
||||||
|
return "stream", cid, default_topic
|
||||||
|
|
||||||
|
|
||||||
|
class ZulipAdapter(BasePlatformAdapter):
|
||||||
|
"""Gateway adapter for Zulip (self-hosted or zulipchat.com)."""
|
||||||
|
|
||||||
|
def __init__(self, config: PlatformConfig):
|
||||||
|
super().__init__(config, Platform(PLATFORM_NAME))
|
||||||
|
|
||||||
|
extra = config.extra or {}
|
||||||
|
self._site: str = (
|
||||||
|
extra.get("site")
|
||||||
|
or os.getenv("ZULIP_SITE", "")
|
||||||
|
or os.getenv("ZULIP_URL", "")
|
||||||
|
).rstrip("/")
|
||||||
|
self._email: str = extra.get("email") or os.getenv("ZULIP_EMAIL", "")
|
||||||
|
self._api_key: str = config.token or os.getenv("ZULIP_API_KEY", "")
|
||||||
|
|
||||||
|
self._bot_user_id: Optional[int] = None
|
||||||
|
self._bot_email: str = ""
|
||||||
|
self._bot_full_name: str = ""
|
||||||
|
|
||||||
|
self._session: Any = None
|
||||||
|
self._queue_id: Optional[str] = None
|
||||||
|
self._last_event_id: int = -1
|
||||||
|
self._poll_task: Optional[asyncio.Task] = None
|
||||||
|
self._closing = False
|
||||||
|
|
||||||
|
self._default_topic: str = (
|
||||||
|
extra.get("default_topic") or os.getenv("ZULIP_DEFAULT_TOPIC", "general")
|
||||||
|
)
|
||||||
|
|
||||||
|
self._dedup = MessageDeduplicator()
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
# HTTP helpers
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
|
def _auth(self):
|
||||||
|
import aiohttp
|
||||||
|
return aiohttp.BasicAuth(self._email, self._api_key)
|
||||||
|
|
||||||
|
async def _api_get(self, path: str, params: Optional[Dict[str, Any]] = None, timeout: float = 30.0) -> Dict[str, Any]:
|
||||||
|
import aiohttp
|
||||||
|
url = f"{self._site}/api/v1/{path.lstrip('/')}"
|
||||||
|
try:
|
||||||
|
async with self._session.get(
|
||||||
|
url, params=params, auth=self._auth(),
|
||||||
|
timeout=aiohttp.ClientTimeout(total=timeout),
|
||||||
|
) as resp:
|
||||||
|
data = await resp.json()
|
||||||
|
if resp.status >= 400:
|
||||||
|
logger.debug("Zulip GET %s -> %s: %s", path, resp.status, str(data)[:200])
|
||||||
|
data.setdefault("_http_status", resp.status)
|
||||||
|
return data
|
||||||
|
# aiohttp raises a bare asyncio.TimeoutError (NOT a ClientError) on
|
||||||
|
# timeout — catch both so callers always get the error dict, never an
|
||||||
|
# unhandled exception.
|
||||||
|
except (aiohttp.ClientError, asyncio.TimeoutError) as exc:
|
||||||
|
logger.error("Zulip GET %s network error: %s", path, exc)
|
||||||
|
return {"result": "error", "msg": str(exc)}
|
||||||
|
|
||||||
|
async def _api_post(self, path: str, payload: Dict[str, Any]) -> Dict[str, Any]:
|
||||||
|
import aiohttp
|
||||||
|
url = f"{self._site}/api/v1/{path.lstrip('/')}"
|
||||||
|
try:
|
||||||
|
async with self._session.post(
|
||||||
|
url, data=payload, auth=self._auth(),
|
||||||
|
timeout=aiohttp.ClientTimeout(total=30),
|
||||||
|
) as resp:
|
||||||
|
data = await resp.json()
|
||||||
|
if resp.status >= 400:
|
||||||
|
logger.error("Zulip POST %s -> %s: %s", path, resp.status, str(data)[:200])
|
||||||
|
return data
|
||||||
|
except (aiohttp.ClientError, asyncio.TimeoutError) as exc:
|
||||||
|
logger.error("Zulip POST %s network error: %s", path, exc)
|
||||||
|
return {"result": "error", "msg": str(exc)}
|
||||||
|
|
||||||
|
async def _api_patch(self, path: str, payload: Dict[str, Any]) -> Dict[str, Any]:
|
||||||
|
import aiohttp
|
||||||
|
url = f"{self._site}/api/v1/{path.lstrip('/')}"
|
||||||
|
try:
|
||||||
|
async with self._session.patch(
|
||||||
|
url, data=payload, auth=self._auth(),
|
||||||
|
timeout=aiohttp.ClientTimeout(total=15),
|
||||||
|
) as resp:
|
||||||
|
data = await resp.json()
|
||||||
|
if resp.status >= 400:
|
||||||
|
logger.debug("Zulip PATCH %s -> %s: %s", path, resp.status, str(data)[:200])
|
||||||
|
return data
|
||||||
|
except (aiohttp.ClientError, asyncio.TimeoutError) as exc:
|
||||||
|
logger.debug("Zulip PATCH %s network error: %s", path, exc)
|
||||||
|
return {"result": "error", "msg": str(exc)}
|
||||||
|
|
||||||
|
async def _api_delete(self, path: str, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
|
||||||
|
import aiohttp
|
||||||
|
url = f"{self._site}/api/v1/{path.lstrip('/')}"
|
||||||
|
try:
|
||||||
|
async with self._session.delete(
|
||||||
|
url, params=params, auth=self._auth(),
|
||||||
|
timeout=aiohttp.ClientTimeout(total=15),
|
||||||
|
) as resp:
|
||||||
|
return await resp.json()
|
||||||
|
except (aiohttp.ClientError, asyncio.TimeoutError) as exc:
|
||||||
|
logger.debug("Zulip DELETE %s network error: %s", path, exc)
|
||||||
|
return {"result": "error", "msg": str(exc)}
|
||||||
|
|
||||||
|
async def _upload(self, file_data: bytes, filename: str, content_type: str) -> Optional[str]:
|
||||||
|
"""Upload a file, returning its absolute URL (or None)."""
|
||||||
|
import aiohttp
|
||||||
|
url = f"{self._site}/api/v1/user_uploads"
|
||||||
|
form = aiohttp.FormData()
|
||||||
|
form.add_field("file", file_data, filename=filename, content_type=content_type)
|
||||||
|
try:
|
||||||
|
async with self._session.post(
|
||||||
|
url, data=form, auth=self._auth(),
|
||||||
|
timeout=aiohttp.ClientTimeout(total=60),
|
||||||
|
) as resp:
|
||||||
|
data = await resp.json()
|
||||||
|
if resp.status >= 400:
|
||||||
|
logger.error("Zulip upload -> %s: %s", resp.status, str(data)[:200])
|
||||||
|
return None
|
||||||
|
rel = data.get("url") or data.get("uri")
|
||||||
|
if not rel:
|
||||||
|
return None
|
||||||
|
return rel if rel.startswith("http") else f"{self._site}{rel}"
|
||||||
|
except (aiohttp.ClientError, asyncio.TimeoutError) as exc:
|
||||||
|
logger.error("Zulip upload network error: %s", exc)
|
||||||
|
return None
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
# Required overrides
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
|
async def connect(self, is_reconnect: bool = False) -> bool:
|
||||||
|
import aiohttp
|
||||||
|
|
||||||
|
if not self._site or not self._email or not self._api_key:
|
||||||
|
logger.error("Zulip: ZULIP_SITE, ZULIP_EMAIL and ZULIP_API_KEY must be set")
|
||||||
|
return False
|
||||||
|
|
||||||
|
self._session = aiohttp.ClientSession()
|
||||||
|
self._closing = False
|
||||||
|
|
||||||
|
me = await self._api_get("users/me")
|
||||||
|
if me.get("result") != "success" or "user_id" not in me:
|
||||||
|
logger.error(
|
||||||
|
"Zulip: failed to authenticate — check ZULIP_SITE, ZULIP_EMAIL "
|
||||||
|
"and ZULIP_API_KEY (%s)", str(me.get("msg", ""))[:160],
|
||||||
|
)
|
||||||
|
await self._session.close()
|
||||||
|
return False
|
||||||
|
|
||||||
|
self._bot_user_id = me["user_id"]
|
||||||
|
self._bot_email = me.get("email", self._email)
|
||||||
|
self._bot_full_name = me.get("full_name", "")
|
||||||
|
logger.info(
|
||||||
|
"Zulip: authenticated as %s (#%s) on %s",
|
||||||
|
self._bot_full_name or self._bot_email, self._bot_user_id, self._site,
|
||||||
|
)
|
||||||
|
|
||||||
|
self._poll_task = asyncio.create_task(self._poll_loop())
|
||||||
|
self._mark_connected()
|
||||||
|
return True
|
||||||
|
|
||||||
|
async def disconnect(self) -> None:
|
||||||
|
self._closing = True
|
||||||
|
if self._poll_task and not self._poll_task.done():
|
||||||
|
self._poll_task.cancel()
|
||||||
|
try:
|
||||||
|
await self._poll_task
|
||||||
|
except (asyncio.CancelledError, Exception):
|
||||||
|
pass
|
||||||
|
# Best-effort: release the server-side event queue. Zulip deletes a
|
||||||
|
# queue via DELETE /api/v1/events?queue_id=… (there is no POST form).
|
||||||
|
if self._queue_id and self._session and not self._session.closed:
|
||||||
|
try:
|
||||||
|
await self._api_delete("events", {"queue_id": self._queue_id})
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
if self._session and not self._session.closed:
|
||||||
|
await self._session.close()
|
||||||
|
logger.info("Zulip: disconnected")
|
||||||
|
|
||||||
|
async def send(
|
||||||
|
self,
|
||||||
|
chat_id: str,
|
||||||
|
content: str,
|
||||||
|
reply_to: Optional[str] = None,
|
||||||
|
metadata: Optional[Dict[str, Any]] = None,
|
||||||
|
) -> SendResult:
|
||||||
|
if not content:
|
||||||
|
return SendResult(success=True)
|
||||||
|
|
||||||
|
kind, to, topic = _parse_target(chat_id, self._default_topic)
|
||||||
|
formatted = self.format_message(content)
|
||||||
|
chunks = self.truncate_message(formatted, MAX_MESSAGE_LENGTH)
|
||||||
|
|
||||||
|
last_id = None
|
||||||
|
for chunk in chunks:
|
||||||
|
payload: Dict[str, Any] = {"content": chunk}
|
||||||
|
if kind == "direct":
|
||||||
|
# "private" is the backward-compatible alias accepted by every
|
||||||
|
# Zulip version (the newer "direct" alias only landed in 7.0).
|
||||||
|
payload["type"] = "private"
|
||||||
|
payload["to"] = json.dumps(to)
|
||||||
|
else:
|
||||||
|
payload["type"] = "stream"
|
||||||
|
payload["to"] = str(to)
|
||||||
|
payload["topic"] = topic or self._default_topic
|
||||||
|
data = await self._api_post("messages", payload)
|
||||||
|
if data.get("result") != "success":
|
||||||
|
return SendResult(success=False, error=str(data.get("msg", "send failed")))
|
||||||
|
last_id = data.get("id")
|
||||||
|
|
||||||
|
return SendResult(success=True, message_id=str(last_id) if last_id else None)
|
||||||
|
|
||||||
|
async def edit_message(
|
||||||
|
self,
|
||||||
|
chat_id: str,
|
||||||
|
message_id: str,
|
||||||
|
content: str,
|
||||||
|
**kwargs,
|
||||||
|
) -> SendResult:
|
||||||
|
"""Edit a previously-sent message. Used by the gateway stream consumer
|
||||||
|
for progressive message updates during agent streaming."""
|
||||||
|
formatted = self.format_message(content)
|
||||||
|
data = await self._api_patch(f"messages/{message_id}", {"content": formatted})
|
||||||
|
if data.get("result") != "success":
|
||||||
|
msg = str(data.get("msg", "edit failed"))
|
||||||
|
logger.debug("Zulip edit_message(%s) -> %s", message_id, msg)
|
||||||
|
return SendResult(success=False, error=msg)
|
||||||
|
return SendResult(success=True, message_id=message_id)
|
||||||
|
|
||||||
|
async def get_chat_info(self, chat_id: str) -> Dict[str, Any]:
|
||||||
|
kind, to, topic = _parse_target(chat_id, self._default_topic)
|
||||||
|
if kind == "direct":
|
||||||
|
return {"name": "Direct message", "type": "dm", "chat_id": chat_id}
|
||||||
|
name = f"{to} > {topic}" if topic else str(to)
|
||||||
|
return {"name": name, "type": "channel", "chat_id": chat_id}
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
# Optional overrides — files are uploaded then linked into a message
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
|
async def send_image(
|
||||||
|
self,
|
||||||
|
chat_id: str,
|
||||||
|
image_url: str,
|
||||||
|
caption: Optional[str] = None,
|
||||||
|
reply_to: Optional[str] = None,
|
||||||
|
metadata: Optional[Dict[str, Any]] = None,
|
||||||
|
) -> SendResult:
|
||||||
|
return await self._send_url_as_file(chat_id, image_url, caption, "image")
|
||||||
|
|
||||||
|
async def send_image_file(
|
||||||
|
self,
|
||||||
|
chat_id: str,
|
||||||
|
image_path: str,
|
||||||
|
caption: Optional[str] = None,
|
||||||
|
reply_to: Optional[str] = None,
|
||||||
|
metadata: Optional[Dict[str, Any]] = None,
|
||||||
|
) -> SendResult:
|
||||||
|
return await self._send_local_file(chat_id, image_path, caption)
|
||||||
|
|
||||||
|
async def send_document(
|
||||||
|
self,
|
||||||
|
chat_id: str,
|
||||||
|
file_path: str,
|
||||||
|
caption: Optional[str] = None,
|
||||||
|
file_name: Optional[str] = None,
|
||||||
|
reply_to: Optional[str] = None,
|
||||||
|
metadata: Optional[Dict[str, Any]] = None,
|
||||||
|
) -> SendResult:
|
||||||
|
return await self._send_local_file(chat_id, file_path, caption, file_name)
|
||||||
|
|
||||||
|
async def send_voice(
|
||||||
|
self,
|
||||||
|
chat_id: str,
|
||||||
|
audio_path: str,
|
||||||
|
caption: Optional[str] = None,
|
||||||
|
reply_to: Optional[str] = None,
|
||||||
|
metadata: Optional[Dict[str, Any]] = None,
|
||||||
|
) -> SendResult:
|
||||||
|
return await self._send_local_file(chat_id, audio_path, caption)
|
||||||
|
|
||||||
|
async def send_video(
|
||||||
|
self,
|
||||||
|
chat_id: str,
|
||||||
|
video_path: str,
|
||||||
|
caption: Optional[str] = None,
|
||||||
|
reply_to: Optional[str] = None,
|
||||||
|
metadata: Optional[Dict[str, Any]] = None,
|
||||||
|
) -> SendResult:
|
||||||
|
return await self._send_local_file(chat_id, video_path, caption)
|
||||||
|
|
||||||
|
def format_message(self, content: str) -> str:
|
||||||
|
"""Zulip renders CommonMark.
|
||||||
|
|
||||||
|
Convert inline image markdown into bare links — Zulip auto-previews
|
||||||
|
image URLs, and files are uploaded separately.
|
||||||
|
"""
|
||||||
|
return re.sub(r"!\[([^\]]*)\]\(([^)]+)\)", r"\2", content)
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
# File helpers
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
|
async def _send_url_as_file(
|
||||||
|
self, chat_id: str, url: str, caption: Optional[str], kind: str = "file",
|
||||||
|
) -> SendResult:
|
||||||
|
from tools.url_safety import is_safe_url
|
||||||
|
if not is_safe_url(url):
|
||||||
|
logger.warning("Zulip: blocked unsafe URL (SSRF protection)")
|
||||||
|
return await self.send(chat_id, f"{caption or ''}\n{url}".strip())
|
||||||
|
|
||||||
|
import aiohttp
|
||||||
|
fname = url.rsplit("/", 1)[-1].split("?")[0] or f"{kind}.png"
|
||||||
|
try:
|
||||||
|
async with self._session.get(url, timeout=aiohttp.ClientTimeout(total=30)) as resp:
|
||||||
|
if resp.status >= 400:
|
||||||
|
return await self.send(chat_id, f"{caption or ''}\n{url}".strip())
|
||||||
|
file_data = await resp.read()
|
||||||
|
ct = resp.content_type or "application/octet-stream"
|
||||||
|
except (aiohttp.ClientError, asyncio.TimeoutError) as exc:
|
||||||
|
logger.warning("Zulip: failed to download %s: %s", url[:80], exc)
|
||||||
|
return await self.send(chat_id, f"{caption or ''}\n{url}".strip())
|
||||||
|
|
||||||
|
return await self._upload_and_send(chat_id, file_data, fname, ct, caption, fallback=url)
|
||||||
|
|
||||||
|
async def _send_local_file(
|
||||||
|
self, chat_id: str, file_path: str, caption: Optional[str], file_name: Optional[str] = None,
|
||||||
|
) -> SendResult:
|
||||||
|
import mimetypes
|
||||||
|
p = Path(file_path)
|
||||||
|
if not p.exists():
|
||||||
|
logger.warning("Zulip: local file not found, skipping: %s", file_path)
|
||||||
|
return SendResult(success=True, message_id=None)
|
||||||
|
fname = file_name or p.name
|
||||||
|
ct = mimetypes.guess_type(fname)[0] or "application/octet-stream"
|
||||||
|
return await self._upload_and_send(chat_id, p.read_bytes(), fname, ct, caption)
|
||||||
|
|
||||||
|
async def _upload_and_send(
|
||||||
|
self, chat_id: str, data: bytes, fname: str, ct: str,
|
||||||
|
caption: Optional[str], fallback: Optional[str] = None,
|
||||||
|
) -> SendResult:
|
||||||
|
url = await self._upload(data, fname, ct)
|
||||||
|
if not url:
|
||||||
|
if fallback:
|
||||||
|
return await self.send(chat_id, f"{caption or ''}\n{fallback}".strip())
|
||||||
|
return SendResult(success=False, error="File upload failed")
|
||||||
|
body = f"{caption + chr(10) if caption else ''}[{fname}]({url})"
|
||||||
|
return await self.send(chat_id, body)
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
# Event queue (register + long-poll)
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
|
async def _register_queue(self) -> bool:
|
||||||
|
all_public = os.getenv("ZULIP_ALL_PUBLIC_STREAMS", "").lower() in {"1", "true", "yes", "on"}
|
||||||
|
payload = {
|
||||||
|
"event_types": json.dumps(["message"]),
|
||||||
|
"apply_markdown": "false",
|
||||||
|
"all_public_streams": "true" if all_public else "false",
|
||||||
|
}
|
||||||
|
data = await self._api_post("register", payload)
|
||||||
|
if data.get("result") != "success" or "queue_id" not in data:
|
||||||
|
logger.error("Zulip: failed to register event queue: %s", str(data.get("msg", ""))[:160])
|
||||||
|
return False
|
||||||
|
self._queue_id = data["queue_id"]
|
||||||
|
self._last_event_id = data.get("last_event_id", -1)
|
||||||
|
logger.info("Zulip: event queue registered (%s)", self._queue_id)
|
||||||
|
return True
|
||||||
|
|
||||||
|
async def _poll_loop(self) -> None:
|
||||||
|
delay = _RECONNECT_BASE_DELAY
|
||||||
|
while not self._closing:
|
||||||
|
try:
|
||||||
|
if not self._queue_id:
|
||||||
|
if not await self._register_queue():
|
||||||
|
raise RuntimeError("queue registration failed")
|
||||||
|
await self._poll_once()
|
||||||
|
delay = _RECONNECT_BASE_DELAY
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
return
|
||||||
|
except Exception as exc:
|
||||||
|
if self._closing:
|
||||||
|
return
|
||||||
|
logger.warning("Zulip poll error: %s — retrying in %.0fs", exc, delay)
|
||||||
|
import random
|
||||||
|
await asyncio.sleep(delay + delay * _RECONNECT_JITTER * random.random())
|
||||||
|
delay = min(delay * 2, _RECONNECT_MAX_DELAY)
|
||||||
|
|
||||||
|
async def _get_events(self) -> Optional[Dict[str, Any]]:
|
||||||
|
"""Long-poll ``GET /events``.
|
||||||
|
|
||||||
|
Returns the parsed response, or ``None`` on the expected long-poll
|
||||||
|
timeout (no events within the window — caller just re-polls). Kept
|
||||||
|
separate from ``_api_get`` so the long-poll timeout isn't swallowed
|
||||||
|
into an error dict the way ordinary calls need.
|
||||||
|
"""
|
||||||
|
import aiohttp
|
||||||
|
params = {"queue_id": self._queue_id, "last_event_id": self._last_event_id}
|
||||||
|
try:
|
||||||
|
async with self._session.get(
|
||||||
|
f"{self._site}/api/v1/events", params=params, auth=self._auth(),
|
||||||
|
timeout=aiohttp.ClientTimeout(total=_LONGPOLL_TIMEOUT),
|
||||||
|
) as resp:
|
||||||
|
return await resp.json()
|
||||||
|
except asyncio.TimeoutError:
|
||||||
|
return None
|
||||||
|
except aiohttp.ClientError as exc:
|
||||||
|
raise RuntimeError(f"events poll network error: {exc}")
|
||||||
|
|
||||||
|
async def _poll_once(self) -> None:
|
||||||
|
data = await self._get_events()
|
||||||
|
if data is None:
|
||||||
|
return # long-poll window elapsed — just poll again
|
||||||
|
|
||||||
|
if data.get("result") != "success":
|
||||||
|
if data.get("code") == "BAD_EVENT_QUEUE_ID":
|
||||||
|
logger.info("Zulip: event queue expired — re-registering")
|
||||||
|
self._queue_id = None
|
||||||
|
return
|
||||||
|
# Transient server error — let the loop back off.
|
||||||
|
raise RuntimeError(str(data.get("msg", "events poll failed")))
|
||||||
|
|
||||||
|
for event in data.get("events", []):
|
||||||
|
eid = event.get("id")
|
||||||
|
if isinstance(eid, int):
|
||||||
|
self._last_event_id = max(self._last_event_id, eid)
|
||||||
|
if event.get("type") == "message":
|
||||||
|
# Guard each event so one failing message can't drop the rest
|
||||||
|
# of the batch. last_event_id is already advanced above, so a
|
||||||
|
# dropped message is not reprocessed on the next poll.
|
||||||
|
try:
|
||||||
|
await self._handle_message_event(event)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Zulip: error handling message event %s", eid)
|
||||||
|
|
||||||
|
async def _handle_message_event(self, event: Dict[str, Any]) -> None:
|
||||||
|
message = event.get("message") or {}
|
||||||
|
flags = event.get("flags") or []
|
||||||
|
|
||||||
|
sender_id = message.get("sender_id")
|
||||||
|
# Ignore our own messages (Zulip echoes them back on the queue).
|
||||||
|
if sender_id is not None and sender_id == self._bot_user_id:
|
||||||
|
return
|
||||||
|
|
||||||
|
msg_id = message.get("id")
|
||||||
|
if msg_id is None or self._dedup.is_duplicate(str(msg_id)):
|
||||||
|
return
|
||||||
|
|
||||||
|
mtype = message.get("type") # "stream" or "private"
|
||||||
|
content = message.get("content", "") or ""
|
||||||
|
sender_name = message.get("sender_full_name", "") or message.get("sender_email", "")
|
||||||
|
|
||||||
|
if mtype == "private":
|
||||||
|
chat_type = "dm"
|
||||||
|
recipients = message.get("display_recipient") or []
|
||||||
|
user_ids = sorted(
|
||||||
|
int(r["id"]) for r in recipients
|
||||||
|
if isinstance(r, dict) and "id" in r
|
||||||
|
)
|
||||||
|
chat_id = "d:" + ",".join(str(u) for u in user_ids)
|
||||||
|
topic = None
|
||||||
|
else:
|
||||||
|
chat_type = "channel"
|
||||||
|
stream_id = message.get("stream_id")
|
||||||
|
topic = message.get("subject", "") or message.get("topic", "")
|
||||||
|
chat_id = f"s:{stream_id}:{topic}"
|
||||||
|
|
||||||
|
# Mention-gating for streams.
|
||||||
|
stream_name = message.get("display_recipient", "")
|
||||||
|
extra = self.config.extra or {}
|
||||||
|
|
||||||
|
allowed_raw = extra.get("allowed_channels")
|
||||||
|
if allowed_raw is None:
|
||||||
|
allowed_raw = os.getenv("ZULIP_ALLOWED_CHANNELS", "")
|
||||||
|
allowed = _split_csv(allowed_raw)
|
||||||
|
if allowed and str(stream_id) not in allowed and str(stream_name) not in allowed:
|
||||||
|
return
|
||||||
|
|
||||||
|
require_mention = os.getenv("ZULIP_REQUIRE_MENTION", "true").lower() not in {"false", "0", "no"}
|
||||||
|
free = _split_csv(os.getenv("ZULIP_FREE_RESPONSE_CHANNELS", ""))
|
||||||
|
is_free = str(stream_id) in free or str(stream_name) in free
|
||||||
|
|
||||||
|
has_mention = "mentioned" in flags or "wildcard_mentioned" in flags
|
||||||
|
if require_mention and not is_free and not has_mention:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Strip the bot's @-mention so the agent sees clean input.
|
||||||
|
if self._bot_full_name:
|
||||||
|
content = re.sub(
|
||||||
|
r"@\*\*" + re.escape(self._bot_full_name) + r"\*\*", "", content,
|
||||||
|
).strip()
|
||||||
|
|
||||||
|
msg_type = MessageType.COMMAND if content.startswith("/") else MessageType.TEXT
|
||||||
|
|
||||||
|
media_urls: List[str] = []
|
||||||
|
media_types: List[str] = []
|
||||||
|
await self._extract_inline_media(content, media_urls, media_types)
|
||||||
|
await self._extract_event_attachments(message, media_urls, media_types)
|
||||||
|
if media_types and msg_type == MessageType.TEXT:
|
||||||
|
if any(m.startswith("image/") for m in media_types):
|
||||||
|
msg_type = MessageType.PHOTO
|
||||||
|
elif any(m.startswith("audio/") for m in media_types):
|
||||||
|
msg_type = MessageType.VOICE
|
||||||
|
else:
|
||||||
|
msg_type = MessageType.DOCUMENT
|
||||||
|
|
||||||
|
source = self.build_source(
|
||||||
|
chat_id=chat_id,
|
||||||
|
chat_type=chat_type,
|
||||||
|
user_id=str(sender_id) if sender_id is not None else None,
|
||||||
|
user_name=sender_name,
|
||||||
|
chat_topic=topic,
|
||||||
|
)
|
||||||
|
|
||||||
|
from gateway.platforms.base import resolve_channel_prompt
|
||||||
|
channel_prompt = resolve_channel_prompt(self.config.extra, chat_id, None)
|
||||||
|
|
||||||
|
await self.handle_message(MessageEvent(
|
||||||
|
text=content,
|
||||||
|
message_type=msg_type,
|
||||||
|
source=source,
|
||||||
|
raw_message=message,
|
||||||
|
message_id=str(msg_id),
|
||||||
|
media_urls=media_urls or None,
|
||||||
|
media_types=media_types or None,
|
||||||
|
channel_prompt=channel_prompt,
|
||||||
|
))
|
||||||
|
|
||||||
|
async def _extract_event_attachments(
|
||||||
|
self, message: Dict[str, Any], media_urls: List[str], media_types: List[str],
|
||||||
|
) -> None:
|
||||||
|
"""Download files from Zulip's ``message.attachments`` field (UI file
|
||||||
|
uploads that Zulip sends as structured event data rather than inline
|
||||||
|
markdown links)."""
|
||||||
|
import aiohttp
|
||||||
|
atts = message.get("attachments") or []
|
||||||
|
for att in atts:
|
||||||
|
path_id = att.get("path_id")
|
||||||
|
fname = att.get("name") or "file"
|
||||||
|
if not path_id:
|
||||||
|
continue
|
||||||
|
dl_url = f"{self._site}/api/v1/user_uploads/{path_id}"
|
||||||
|
try:
|
||||||
|
async with self._session.get(
|
||||||
|
dl_url, auth=self._auth(),
|
||||||
|
timeout=aiohttp.ClientTimeout(total=30),
|
||||||
|
) as resp:
|
||||||
|
if resp.status >= 400:
|
||||||
|
logger.debug("Zulip: event attachment %s -> %s", fname, resp.status)
|
||||||
|
continue
|
||||||
|
data = await resp.read()
|
||||||
|
mime = resp.content_type or "application/octet-stream"
|
||||||
|
except (aiohttp.ClientError, asyncio.TimeoutError):
|
||||||
|
logger.debug("Zulip: failed to download event attachment %s", fname)
|
||||||
|
continue
|
||||||
|
await self._cache_attachment(data, fname, mime, media_urls, media_types)
|
||||||
|
|
||||||
|
async def _cache_attachment(
|
||||||
|
self, data: bytes, fname: str, mime: str,
|
||||||
|
media_urls: List[str], media_types: List[str],
|
||||||
|
) -> None:
|
||||||
|
"""Cache a downloaded attachment into Hermes media storage."""
|
||||||
|
from gateway.platforms.base import (
|
||||||
|
cache_image_from_bytes, cache_audio_from_bytes, cache_document_from_bytes,
|
||||||
|
)
|
||||||
|
ext = Path(fname).suffix
|
||||||
|
try:
|
||||||
|
if mime.startswith("image/"):
|
||||||
|
media_urls.append(cache_image_from_bytes(data, ext or ".png"))
|
||||||
|
media_types.append(mime)
|
||||||
|
elif mime.startswith("audio/"):
|
||||||
|
media_urls.append(cache_audio_from_bytes(data, ext or ".ogg"))
|
||||||
|
media_types.append(mime)
|
||||||
|
else:
|
||||||
|
media_urls.append(cache_document_from_bytes(data, fname))
|
||||||
|
media_types.append(mime)
|
||||||
|
except Exception as exc:
|
||||||
|
logger.warning("Zulip: failed to cache attachment %s: %s", fname, exc)
|
||||||
|
|
||||||
|
async def _extract_inline_media(
|
||||||
|
self, content: str, media_urls: List[str], media_types: List[str],
|
||||||
|
) -> None:
|
||||||
|
"""Download Zulip ``/user_uploads/...`` attachments referenced in a
|
||||||
|
message so vision/transcription tools can read them locally."""
|
||||||
|
import aiohttp
|
||||||
|
for rel in re.findall(r"\]\((/user_uploads/[^)]+)\)", content):
|
||||||
|
dl_url = f"{self._site}{rel}"
|
||||||
|
try:
|
||||||
|
async with self._session.get(
|
||||||
|
dl_url, auth=self._auth(),
|
||||||
|
timeout=aiohttp.ClientTimeout(total=30),
|
||||||
|
) as resp:
|
||||||
|
if resp.status >= 400:
|
||||||
|
continue
|
||||||
|
data = await resp.read()
|
||||||
|
mime = resp.content_type or "application/octet-stream"
|
||||||
|
except (aiohttp.ClientError, asyncio.TimeoutError):
|
||||||
|
continue
|
||||||
|
fname = rel.rsplit("/", 1)[-1] or "file"
|
||||||
|
await self._cache_attachment(data, fname, mime, media_urls, media_types)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Helpers
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def _split_csv(value: Any) -> set:
|
||||||
|
if isinstance(value, list):
|
||||||
|
return {str(v).strip() for v in value if str(v).strip()}
|
||||||
|
return {v.strip() for v in str(value or "").split(",") if v.strip()}
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Out-of-process cron delivery (standalone REST send)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
async def _standalone_send(
|
||||||
|
pconfig,
|
||||||
|
chat_id: str,
|
||||||
|
message: str,
|
||||||
|
*,
|
||||||
|
thread_id: Optional[str] = None,
|
||||||
|
media_files: Optional[list] = None,
|
||||||
|
force_document: bool = False,
|
||||||
|
) -> Dict[str, Any]:
|
||||||
|
"""Send via the Zulip REST API without a live gateway adapter.
|
||||||
|
|
||||||
|
Used by ``tools/send_message_tool`` for cron jobs running outside the
|
||||||
|
gateway process. Reads ``ZULIP_API_KEY`` from ``pconfig.token`` (env
|
||||||
|
fallback); site + email come from ``pconfig.extra`` or env.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
import aiohttp
|
||||||
|
except ImportError:
|
||||||
|
return {"error": "aiohttp not installed. Run: pip install aiohttp"}
|
||||||
|
|
||||||
|
extra = getattr(pconfig, "extra", {}) or {}
|
||||||
|
site = (extra.get("site") or os.getenv("ZULIP_SITE", "") or os.getenv("ZULIP_URL", "")).rstrip("/")
|
||||||
|
email = (extra.get("email") or os.getenv("ZULIP_EMAIL", "")).strip()
|
||||||
|
api_key = (getattr(pconfig, "token", None) or os.getenv("ZULIP_API_KEY", "")).strip()
|
||||||
|
if not site or not email or not api_key:
|
||||||
|
return {"error": "Zulip standalone send: ZULIP_SITE, ZULIP_EMAIL and ZULIP_API_KEY must be set"}
|
||||||
|
|
||||||
|
default_topic = extra.get("default_topic") or os.getenv("ZULIP_DEFAULT_TOPIC", "general")
|
||||||
|
kind, to, topic = _parse_target(chat_id, default_topic)
|
||||||
|
|
||||||
|
try:
|
||||||
|
from gateway.platforms.base import resolve_proxy_url, proxy_kwargs_for_aiohttp
|
||||||
|
proxy = resolve_proxy_url(platform_env_var="ZULIP_PROXY")
|
||||||
|
sess_kw, req_kw = proxy_kwargs_for_aiohttp(proxy)
|
||||||
|
auth = aiohttp.BasicAuth(email, api_key)
|
||||||
|
|
||||||
|
async with aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=60), **sess_kw) as session:
|
||||||
|
body = message
|
||||||
|
|
||||||
|
# Upload any media and append links to the message body.
|
||||||
|
for media in (media_files or []):
|
||||||
|
file_path = media.get("path") if isinstance(media, dict) else media
|
||||||
|
if not file_path or not os.path.exists(file_path):
|
||||||
|
continue
|
||||||
|
form = aiohttp.FormData()
|
||||||
|
with open(file_path, "rb") as fh:
|
||||||
|
form.add_field("file", fh.read(), filename=os.path.basename(file_path))
|
||||||
|
async with session.post(
|
||||||
|
f"{site}/api/v1/user_uploads", data=form, auth=auth, **req_kw,
|
||||||
|
) as up:
|
||||||
|
if up.status >= 400:
|
||||||
|
continue
|
||||||
|
up_data = await up.json()
|
||||||
|
rel = up_data.get("url") or up_data.get("uri")
|
||||||
|
if rel:
|
||||||
|
full = rel if rel.startswith("http") else f"{site}{rel}"
|
||||||
|
body = f"{body}\n[{os.path.basename(file_path)}]({full})".strip()
|
||||||
|
|
||||||
|
payload: Dict[str, Any] = {"content": body or "(no content)"}
|
||||||
|
if kind == "direct":
|
||||||
|
# "private" is the backward-compatible alias accepted by every
|
||||||
|
# Zulip version (the newer "direct" alias only landed in 7.0).
|
||||||
|
payload["type"] = "private"
|
||||||
|
payload["to"] = json.dumps(to)
|
||||||
|
else:
|
||||||
|
payload["type"] = "stream"
|
||||||
|
payload["to"] = str(to)
|
||||||
|
payload["topic"] = topic or default_topic
|
||||||
|
|
||||||
|
async with session.post(
|
||||||
|
f"{site}/api/v1/messages", data=payload, auth=auth, **req_kw,
|
||||||
|
) as resp:
|
||||||
|
data = await resp.json()
|
||||||
|
if data.get("result") != "success":
|
||||||
|
return {"error": f"Zulip API error: {str(data.get('msg', ''))[:300]}"}
|
||||||
|
return {
|
||||||
|
"success": True,
|
||||||
|
"platform": "zulip",
|
||||||
|
"chat_id": chat_id,
|
||||||
|
"message_id": data.get("id"),
|
||||||
|
}
|
||||||
|
except aiohttp.ClientError as exc:
|
||||||
|
return {"error": f"Zulip send failed (network): {exc}"}
|
||||||
|
except Exception as exc: # noqa: BLE001
|
||||||
|
return {"error": f"Zulip send failed: {exc}"}
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Interactive setup wizard
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def interactive_setup() -> None:
|
||||||
|
"""Guide the user through Zulip bot setup."""
|
||||||
|
from hermes_cli.config import get_env_value, save_env_value
|
||||||
|
from hermes_cli.cli_output import (
|
||||||
|
prompt, prompt_yes_no, print_header, print_info, print_success,
|
||||||
|
)
|
||||||
|
|
||||||
|
print_header("Zulip")
|
||||||
|
if get_env_value("ZULIP_API_KEY") and get_env_value("ZULIP_EMAIL"):
|
||||||
|
print_info("Zulip: already configured")
|
||||||
|
if not prompt_yes_no("Reconfigure Zulip?", False):
|
||||||
|
return
|
||||||
|
|
||||||
|
print_info("Create a bot in Zulip: Settings → Personal → Bots → Add a new bot")
|
||||||
|
print_info(" Choose 'Generic bot', then copy its email + API key.")
|
||||||
|
print()
|
||||||
|
site = prompt("Zulip site URL (e.g. https://example.zulipchat.com)")
|
||||||
|
if site:
|
||||||
|
save_env_value("ZULIP_SITE", site.rstrip("/"))
|
||||||
|
email = prompt("Bot email")
|
||||||
|
if email:
|
||||||
|
save_env_value("ZULIP_EMAIL", email)
|
||||||
|
api_key = prompt("Bot API key", password=True)
|
||||||
|
if not api_key:
|
||||||
|
return
|
||||||
|
save_env_value("ZULIP_API_KEY", api_key)
|
||||||
|
print_success("Zulip credentials saved")
|
||||||
|
|
||||||
|
print()
|
||||||
|
print_info("🔒 Security: restrict who can use your bot")
|
||||||
|
allowed = prompt("Allowed sender emails/ids (comma-separated, empty for open access)")
|
||||||
|
if allowed:
|
||||||
|
save_env_value("ZULIP_ALLOWED_USERS", allowed.replace(" ", ""))
|
||||||
|
print_success("Zulip allowlist configured")
|
||||||
|
else:
|
||||||
|
print_info("⚠️ No allowlist set — anyone who can message the bot can use it!")
|
||||||
|
|
||||||
|
print()
|
||||||
|
print_info("📬 Home channel: where Hermes delivers cron results / notifications.")
|
||||||
|
print_info(" Form: 'stream-name/topic' (e.g. general/hermes).")
|
||||||
|
home = prompt("Home channel (leave empty to set later with /set-home)")
|
||||||
|
if home:
|
||||||
|
save_env_value("ZULIP_HOME_CHANNEL", home)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# YAML -> env config bridge / connected probe
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def _apply_yaml_config(yaml_cfg: dict, z_cfg: dict) -> dict | None:
|
||||||
|
extras: Dict[str, Any] = {}
|
||||||
|
site = z_cfg.get("site") or z_cfg.get("url")
|
||||||
|
if site:
|
||||||
|
extras["site"] = str(site).rstrip("/")
|
||||||
|
if not os.getenv("ZULIP_SITE"):
|
||||||
|
os.environ["ZULIP_SITE"] = str(site).rstrip("/")
|
||||||
|
if z_cfg.get("email"):
|
||||||
|
extras["email"] = str(z_cfg["email"])
|
||||||
|
if not os.getenv("ZULIP_EMAIL"):
|
||||||
|
os.environ["ZULIP_EMAIL"] = str(z_cfg["email"])
|
||||||
|
if z_cfg.get("default_topic"):
|
||||||
|
extras["default_topic"] = str(z_cfg["default_topic"])
|
||||||
|
if "require_mention" in z_cfg and not os.getenv("ZULIP_REQUIRE_MENTION"):
|
||||||
|
os.environ["ZULIP_REQUIRE_MENTION"] = str(z_cfg["require_mention"]).lower()
|
||||||
|
if "all_public_streams" in z_cfg and not os.getenv("ZULIP_ALL_PUBLIC_STREAMS"):
|
||||||
|
os.environ["ZULIP_ALL_PUBLIC_STREAMS"] = str(z_cfg["all_public_streams"]).lower()
|
||||||
|
for key, env in (
|
||||||
|
("free_response_channels", "ZULIP_FREE_RESPONSE_CHANNELS"),
|
||||||
|
("allowed_channels", "ZULIP_ALLOWED_CHANNELS"),
|
||||||
|
):
|
||||||
|
val = z_cfg.get(key)
|
||||||
|
if val is not None and not os.getenv(env):
|
||||||
|
if isinstance(val, list):
|
||||||
|
val = ",".join(str(v) for v in val)
|
||||||
|
os.environ[env] = str(val)
|
||||||
|
return extras or None
|
||||||
|
|
||||||
|
|
||||||
|
def _env_enablement() -> Optional[dict]:
|
||||||
|
site = os.getenv("ZULIP_SITE", "") or os.getenv("ZULIP_URL", "")
|
||||||
|
if not site:
|
||||||
|
return None
|
||||||
|
extras: Dict[str, Any] = {"site": site.rstrip("/")}
|
||||||
|
if os.getenv("ZULIP_EMAIL"):
|
||||||
|
extras["email"] = os.getenv("ZULIP_EMAIL")
|
||||||
|
return extras
|
||||||
|
|
||||||
|
|
||||||
|
def _is_connected(config) -> bool:
|
||||||
|
import hermes_cli.gateway as gateway_mod
|
||||||
|
site = (gateway_mod.get_env_value("ZULIP_SITE") or gateway_mod.get_env_value("ZULIP_URL") or "").strip()
|
||||||
|
email = (gateway_mod.get_env_value("ZULIP_EMAIL") or "").strip()
|
||||||
|
api_key = (gateway_mod.get_env_value("ZULIP_API_KEY") or "").strip()
|
||||||
|
return bool(site and email and api_key)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Plugin registration entry point
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def _build_adapter(config):
|
||||||
|
return ZulipAdapter(config)
|
||||||
|
|
||||||
|
|
||||||
|
def register(ctx) -> None:
|
||||||
|
"""Plugin entry point — called by the Hermes plugin system."""
|
||||||
|
ctx.register_platform(
|
||||||
|
name=PLATFORM_NAME,
|
||||||
|
label="Zulip",
|
||||||
|
adapter_factory=_build_adapter,
|
||||||
|
check_fn=check_zulip_requirements,
|
||||||
|
is_connected=_is_connected,
|
||||||
|
required_env=["ZULIP_SITE", "ZULIP_EMAIL", "ZULIP_API_KEY"],
|
||||||
|
install_hint="pip install aiohttp",
|
||||||
|
setup_fn=interactive_setup,
|
||||||
|
apply_yaml_config_fn=_apply_yaml_config,
|
||||||
|
env_enablement_fn=_env_enablement,
|
||||||
|
allowed_users_env="ZULIP_ALLOWED_USERS",
|
||||||
|
allow_all_env="ZULIP_ALLOW_ALL_USERS",
|
||||||
|
cron_deliver_env_var="ZULIP_HOME_CHANNEL",
|
||||||
|
standalone_sender_fn=_standalone_send,
|
||||||
|
max_message_length=MAX_MESSAGE_LENGTH,
|
||||||
|
emoji="🗨️",
|
||||||
|
platform_hint=(
|
||||||
|
"You are on Zulip. Messages live under a channel (stream) + topic, "
|
||||||
|
"or are direct messages. Use CommonMark/Zulip Markdown for formatting "
|
||||||
|
"(**bold**, *italic*, `code`, ```code blocks```, lists, links, "
|
||||||
|
"spoilers, LaTeX). Keep replies on-topic; the gateway keeps your "
|
||||||
|
"reply in the same stream/topic or DM it arrived on."
|
||||||
|
),
|
||||||
|
allow_update_command=True,
|
||||||
|
)
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
# Abiba Zulip Gateway — Standalone Service
|
||||||
|
|
||||||
|
**Replaces** the old pi extension (`~/.pi/agent/extensions/zulip/`).
|
||||||
|
|
||||||
|
Instead of injecting messages into pi's session (which dies when pi exits), this
|
||||||
|
runs as an independent Node.js **systemd service** that:
|
||||||
|
- Polls Zulip event queue for DMs
|
||||||
|
- Calls the harness inference API directly (no pi dependency)
|
||||||
|
- Maintains per-sender conversation memory
|
||||||
|
- Survives pi shutdown and restart
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
```
|
||||||
|
Zulip event queue → poll every 3s → DM detected
|
||||||
|
→ send typing indicator + placeholder
|
||||||
|
→ POST /v1/chat/completions with conversation history
|
||||||
|
→ edit placeholder with final response
|
||||||
|
```
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- Node.js 22+
|
||||||
|
- `npm install` in this directory
|
||||||
|
|
||||||
|
## Config
|
||||||
|
|
||||||
|
All config via environment variables. Copy `abiba-zulip.service` to set up as a
|
||||||
|
systemd service, or run directly:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ZULIP_EMAIL=abiba-bot@chat.sysloggh.net \
|
||||||
|
ZULIP_API_KEY=your_key \
|
||||||
|
ZULIP_SITE=https://chat.sysloggh.net \
|
||||||
|
HARNESS_URL=http://192.168.68.116/v1/chat/completions \
|
||||||
|
HARNESS_API_KEY=sk-xxx \
|
||||||
|
HARNESS_MODEL=qwen3.6-35B-A3B \
|
||||||
|
node dist/index.js
|
||||||
|
```
|
||||||
|
|
||||||
|
## Deploy as a service
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. Install deps
|
||||||
|
cd /opt/abiba-zulip
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# 2. Build
|
||||||
|
npx tsc
|
||||||
|
|
||||||
|
# 3. Install systemd service
|
||||||
|
cp abiba-zulip.service /etc/systemd/system/
|
||||||
|
systemctl daemon-reload
|
||||||
|
systemctl enable abiba-zulip
|
||||||
|
systemctl start abiba-zulip
|
||||||
|
|
||||||
|
# 4. Check status
|
||||||
|
systemctl status abiba-zulip
|
||||||
|
journalctl -u abiba-zulip -f
|
||||||
|
|
||||||
|
# 5. Health check
|
||||||
|
curl http://127.0.0.1:9200/health
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run dev # watch mode (tsc watch)
|
||||||
|
npm run build # compile
|
||||||
|
npm start # run compiled
|
||||||
|
```
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Abiba Zulip Gateway Service — Standalone Zulip bot for pi agent
|
||||||
|
Documentation=https://git.sysloggh.net/SyslogSolution/zulip-platform-plugins
|
||||||
|
After=network-online.target
|
||||||
|
Wants=network-online.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=root
|
||||||
|
WorkingDirectory=/opt/abiba-zulip
|
||||||
|
|
||||||
|
# ── Zulip credentials ─────────────────────────────────────────────────────
|
||||||
|
Environment=ZULIP_EMAIL=abiba-bot@chat.sysloggh.net
|
||||||
|
Environment=ZULIP_API_KEY=cKTDMZAPW08dk3zl05sStzO7HRztzyn8
|
||||||
|
Environment=ZULIP_SITE=https://chat.sysloggh.net
|
||||||
|
|
||||||
|
# ── Agent identity ─────────────────────────────────────────────────────────
|
||||||
|
Environment=AGENT_NAME=abiba
|
||||||
|
Environment=AGENT_OWNER_EMAIL=jerome@sysloggh.com
|
||||||
|
|
||||||
|
# ── Harness API (inference) ────────────────────────────────────────────────
|
||||||
|
Environment=HARNESS_URL=http://192.168.68.116/v1/chat/completions
|
||||||
|
Environment=HARNESS_API_KEY=sk-856ffb0bbb-e5aaf78b10054eca608f8fbcbd73a889
|
||||||
|
Environment=HARNESS_MODEL=qwen3.6-35B-A3B
|
||||||
|
Environment=HARNESS_MAX_TOKENS=4096
|
||||||
|
|
||||||
|
# ── Service config ─────────────────────────────────────────────────────────
|
||||||
|
Environment=HEALTH_PORT=9200
|
||||||
|
Environment=POLL_INTERVAL_MS=3000
|
||||||
|
Environment=MAX_RETRIES=5
|
||||||
|
Environment=RETRY_DELAY_MS=5000
|
||||||
|
|
||||||
|
ExecStart=/usr/bin/node /opt/abiba-zulip/dist/index.js
|
||||||
|
Restart=always
|
||||||
|
RestartSec=5
|
||||||
|
|
||||||
|
# Logging
|
||||||
|
StandardOutput=journal
|
||||||
|
StandardError=journal
|
||||||
|
|
||||||
|
# Security hardening (optional — adjust as needed)
|
||||||
|
NoNewPrivileges=true
|
||||||
|
ProtectHome=read-only
|
||||||
|
ProtectSystem=full
|
||||||
|
PrivateTmp=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# pi Zulip extension — Abiba configuration (flat format for custom parser)
|
||||||
|
# Deploy to: ~/.pi/agent/extensions/config.yaml
|
||||||
|
|
||||||
|
zulip.site: https://chat.sysloggh.net
|
||||||
|
zulip.email: abiba-bot@chat.sysloggh.net
|
||||||
|
zulip.api_key: cKTDMZAPW08dk3zl05sStzO7HRztzyn8
|
||||||
|
zulip.stream: agent-hub
|
||||||
|
zulip.all_bots_user_id: 20
|
||||||
|
|
||||||
|
agent.name: abiba
|
||||||
|
agent.display_name: Abiba
|
||||||
|
agent.zulip_bot_name: abiba-bot
|
||||||
|
agent.owner_email: jerome@sysloggh.com
|
||||||
|
agent.private_topic: abiba
|
||||||
|
|
||||||
|
health_port: 9200
|
||||||
|
|
||||||
|
monitoring.health_endpoint_enabled: true
|
||||||
|
monitoring.log_level: info
|
||||||
|
|
||||||
|
error_handling.timeout_seconds: 30
|
||||||
|
error_handling.retry_count: 3
|
||||||
|
error_handling.retry_delay_seconds: 5
|
||||||
|
error_handling.graceful_message: "Abiba encountered an error processing your request. Please try again later."
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
/**
|
||||||
|
* PM2 Ecosystem Config — Zulip Gateway v3 (Resilience)
|
||||||
|
*
|
||||||
|
* Deploy: pm2 start /root/.pm2/ecosystem.config.cjs
|
||||||
|
* Status: pm2 status
|
||||||
|
* Logs: pm2 logs abiba-zulip
|
||||||
|
*/
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
apps: [
|
||||||
|
{
|
||||||
|
// ── Router (main Zulip gateway) ──
|
||||||
|
name: "abiba-zulip",
|
||||||
|
script: "/bin/pi",
|
||||||
|
args: "--mode rpc --session-id zulip-service",
|
||||||
|
cwd: "/root",
|
||||||
|
|
||||||
|
// Resilience hardening — up from pi defaults
|
||||||
|
max_restarts: 100, // Crash loops won't exhaust PM2 (was default 10)
|
||||||
|
min_uptime: "10s", // Must survive 10s to count as "alive"
|
||||||
|
max_memory_restart: "500M", // OOM protection — restart before swap thrash
|
||||||
|
restart_delay: 5000, // 5s cooldown between restarts
|
||||||
|
kill_timeout: 15000, // 15s SIGTERM grace before SIGKILL
|
||||||
|
listen_timeout: 30000, // 30s to bind health port
|
||||||
|
|
||||||
|
// Logging
|
||||||
|
log_date_format: "YYYY-MM-DD HH:mm:ss Z",
|
||||||
|
error_file: "/root/.pm2/logs/abiba-zulip-error.log",
|
||||||
|
out_file: "/root/.pm2/logs/abiba-zulip-out.log",
|
||||||
|
merge_logs: true,
|
||||||
|
log_type: "json",
|
||||||
|
|
||||||
|
// Process management
|
||||||
|
autorestart: true,
|
||||||
|
watch: false,
|
||||||
|
instances: 1,
|
||||||
|
exec_mode: "fork",
|
||||||
|
|
||||||
|
// Environment
|
||||||
|
env: {
|
||||||
|
ZULIP_ROLE: "router",
|
||||||
|
ZULIP_SITE: "https://chat.sysloggh.net",
|
||||||
|
ZULIP_EMAIL: "abiba-bot@chat.sysloggh.net",
|
||||||
|
ZULIP_API_KEY: "cKTDMZAPW08dk3zl05sStzO7HRztzyn8",
|
||||||
|
AGENT_NAME: "abiba",
|
||||||
|
AGENT_OWNER_EMAIL: "jerome@sysloggh.com",
|
||||||
|
NODE_ENV: "production",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
// ── Supervisor (external watchdog) ──
|
||||||
|
name: "zulip-watchdog",
|
||||||
|
script: "/root/.pi/agent/extensions/zulip/watchdog.js",
|
||||||
|
cwd: "/root",
|
||||||
|
|
||||||
|
max_restarts: 10,
|
||||||
|
min_uptime: "3s",
|
||||||
|
restart_delay: 3000,
|
||||||
|
kill_timeout: 5000,
|
||||||
|
|
||||||
|
log_date_format: "YYYY-MM-DD HH:mm:ss Z",
|
||||||
|
error_file: "/root/.pm2/logs/zulip-watchdog-error.log",
|
||||||
|
out_file: "/root/.pm2/logs/zulip-watchdog-out.log",
|
||||||
|
merge_logs: true,
|
||||||
|
|
||||||
|
autorestart: true,
|
||||||
|
watch: false,
|
||||||
|
instances: 1,
|
||||||
|
exec_mode: "fork",
|
||||||
|
|
||||||
|
env: {
|
||||||
|
NODE_ENV: "production",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"lastChangelogVersion": "0.80.6",
|
||||||
|
"defaultProvider": "syslog-harness",
|
||||||
|
"defaultModel": "syslog-auto",
|
||||||
|
"defaultThinkingLevel": "high",
|
||||||
|
"extensions": [
|
||||||
|
"+extensions/mcp/index.ts",
|
||||||
|
"+extensions/zulip/index.js"
|
||||||
|
],
|
||||||
|
"theme": "dark"
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# pi Zulip extension — Abiba configuration (flat format for custom parser)
|
||||||
|
# Deploy to: ~/.pi/agent/extensions/config.yaml
|
||||||
|
|
||||||
|
zulip.site: https://chat.sysloggh.net
|
||||||
|
zulip.email: abiba-bot@chat.sysloggh.net
|
||||||
|
zulip.api_key: YOUR_ZULIP_API_KEY_HERE
|
||||||
|
zulip.stream: agent-hub
|
||||||
|
zulip.all_bots_user_id: 20
|
||||||
|
|
||||||
|
agent.name: abiba
|
||||||
|
agent.display_name: Abiba
|
||||||
|
agent.zulip_bot_name: abiba-bot
|
||||||
|
agent.owner_email: jerome@sysloggh.com
|
||||||
|
agent.private_topic: abiba
|
||||||
|
|
||||||
|
health_port: 9200
|
||||||
|
|
||||||
|
monitoring.health_endpoint_enabled: true
|
||||||
|
monitoring.log_level: info
|
||||||
|
|
||||||
|
error_handling.timeout_seconds: 30
|
||||||
|
error_handling.retry_count: 3
|
||||||
|
error_handling.retry_delay_seconds: 5
|
||||||
|
error_handling.graceful_message: "Abiba encountered an error processing your request. Please try again later."
|
||||||
+34
@@ -0,0 +1,34 @@
|
|||||||
|
// Type declarations for zulip-js (no @types available)
|
||||||
|
declare module "zulip-js" {
|
||||||
|
interface ZulipClient {
|
||||||
|
queues: {
|
||||||
|
register(params: {
|
||||||
|
event_types: string[];
|
||||||
|
narrow?: Array<Array<string | number>>;
|
||||||
|
}): Promise<{ queue_id: string; last_event_id: number }>;
|
||||||
|
};
|
||||||
|
users: {
|
||||||
|
me: {
|
||||||
|
get(): Promise<any>;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
messages: {
|
||||||
|
store: {
|
||||||
|
send(rawContent: string): Promise<any>;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
events: {
|
||||||
|
retrieve(params: {
|
||||||
|
queue_id: string;
|
||||||
|
last_event_id: number;
|
||||||
|
dont_block?: boolean;
|
||||||
|
}): Promise<{ events: any[]; result?: string; msg?: string }>;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function zulip(config: {
|
||||||
|
username: string;
|
||||||
|
apiKey: string;
|
||||||
|
realm: string;
|
||||||
|
}): Promise<ZulipClient>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,84 @@
|
|||||||
|
/**
|
||||||
|
* Zulip Gateway Supervisor — external watchdog process.
|
||||||
|
*
|
||||||
|
* Monitors the router health endpoint every 30s. If 3 consecutive checks fail,
|
||||||
|
* restarts the abiba-zulip PM2 process gracefully.
|
||||||
|
*
|
||||||
|
* This is the pattern Hermes uses: an external supervisor that can recover
|
||||||
|
* the gateway even when the gateway process itself is hung (not just crashed).
|
||||||
|
*
|
||||||
|
* Deployed via PM2 as a separate process in ecosystem.config.cjs.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const HEALTH_URL = "http://127.0.0.1:9200/health";
|
||||||
|
const CHECK_INTERVAL_MS = 30_000;
|
||||||
|
const MAX_FAILURES = 3;
|
||||||
|
const RESTART_GRACE_MS = 15_000;
|
||||||
|
|
||||||
|
let failures = 0;
|
||||||
|
|
||||||
|
async function check() {
|
||||||
|
try {
|
||||||
|
const res = await fetch(HEALTH_URL, {
|
||||||
|
signal: AbortSignal.timeout(5000),
|
||||||
|
});
|
||||||
|
|
||||||
|
if (res.ok) {
|
||||||
|
const data = await res.json();
|
||||||
|
|
||||||
|
if (data.status === "ok" && data.zulip?.connected) {
|
||||||
|
if (failures > 0) {
|
||||||
|
console.log(`[watchdog] Router recovered after ${failures} failure(s)`);
|
||||||
|
}
|
||||||
|
failures = 0;
|
||||||
|
// Silent health log every 10 checks (~5 min) for monitoring
|
||||||
|
if (Math.random() < 0.1) {
|
||||||
|
console.log(`[watchdog] Router healthy (uptime: ${Math.round(process.uptime())}s)`);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Connected but degraded
|
||||||
|
console.warn(`[watchdog] Router degraded: status=${data.status}, connected=${data.zulip?.connected}`);
|
||||||
|
failures++;
|
||||||
|
} else {
|
||||||
|
console.warn(`[watchdog] Health check returned ${res.status}`);
|
||||||
|
failures++;
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
failures++;
|
||||||
|
console.warn(`[watchdog] Health check ${failures}/${MAX_FAILURES}: ${err.message}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (failures >= MAX_FAILURES) {
|
||||||
|
console.error(`[watchdog] ${MAX_FAILURES} consecutive failures — restarting abiba-zulip`);
|
||||||
|
|
||||||
|
const { execSync } = await import("node:child_process");
|
||||||
|
try {
|
||||||
|
execSync("pm2 restart abiba-zulip", { timeout: 30000, encoding: "utf-8" });
|
||||||
|
console.log("[watchdog] Restart command sent successfully");
|
||||||
|
} catch (e) {
|
||||||
|
console.error(`[watchdog] Restart failed: ${e.message}`);
|
||||||
|
|
||||||
|
// Fallback: try resurrect if restart fails (process may be deleted)
|
||||||
|
try {
|
||||||
|
execSync("pm2 resurrect", { timeout: 30000 });
|
||||||
|
console.log("[watchdog] PM2 resurrected (fallback)");
|
||||||
|
} catch (e2) {
|
||||||
|
console.error(`[watchdog] Resurrect also failed: ${e2.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
failures = 0;
|
||||||
|
// Wait for restart to fully initialize before checking again
|
||||||
|
await new Promise((r) => setTimeout(r, RESTART_GRACE_MS));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log("[watchdog] Zulip gateway supervisor started");
|
||||||
|
console.log(`[watchdog] Monitoring ${HEALTH_URL} every ${CHECK_INTERVAL_MS / 1000}s`);
|
||||||
|
console.log(`[watchdog] Max failures before restart: ${MAX_FAILURES}`);
|
||||||
|
|
||||||
|
// Immediate first check, then periodic
|
||||||
|
check();
|
||||||
|
setInterval(check, CHECK_INTERVAL_MS);
|
||||||
File diff suppressed because it is too large
Load Diff
Generated
+17
-1975
File diff suppressed because it is too large
Load Diff
@@ -1,28 +1,19 @@
|
|||||||
{
|
{
|
||||||
"name": "pi-zulip-extension",
|
"name": "abiba-zulip-service",
|
||||||
"version": "0.1.0",
|
"version": "2.0.0",
|
||||||
"description": "pi extension for Zulip agent communication — connects Abiba to the Sysloggh agent mesh",
|
"description": "Standalone Zulip gateway service for Abiba (pi agent). Direct harness API, conversation memory, systemd service.",
|
||||||
"main": "src/index.ts",
|
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
"main": "dist/index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
"check": "tsc --noEmit"
|
"start": "node dist/index.js",
|
||||||
|
"dev": "node --watch dist/index.js"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"yaml": "^2.9.0",
|
|
||||||
"zulip-js": "^2.0.0"
|
"zulip-js": "^2.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@earendil-works/pi-coding-agent": "^0.80.2",
|
"@types/node": "^22.0.0",
|
||||||
"typescript": "^5.0.0"
|
"typescript": "^5.7.0"
|
||||||
},
|
}
|
||||||
"keywords": [
|
|
||||||
"pi",
|
|
||||||
"zulip",
|
|
||||||
"agent",
|
|
||||||
"abiba",
|
|
||||||
"sysloggh"
|
|
||||||
],
|
|
||||||
"license": "UNLICENSED",
|
|
||||||
"private": true
|
|
||||||
}
|
}
|
||||||
|
|||||||
Vendored
+16
@@ -0,0 +1,16 @@
|
|||||||
|
/**
|
||||||
|
* pi-zulip-extension — Zulip agent communication plugin for pi agents
|
||||||
|
*
|
||||||
|
* Deploy to: ~/.pi/agent/extensions/zulip/
|
||||||
|
* Config: config.yaml (alongside extension, or env vars)
|
||||||
|
*
|
||||||
|
* DM-first architecture per ADR-001/ADR-002.
|
||||||
|
* Background Zulip event queue poller that injects messages directly into
|
||||||
|
* the current pi session via pi.sendUserMessage(), then captures the LLM
|
||||||
|
* response from agent_end and sends it back to Zulip. No subprocess overhead.
|
||||||
|
*
|
||||||
|
* @see ADR-007: Platform-native plugin contracts
|
||||||
|
* @see docs/ARCHITECTURE.md
|
||||||
|
*/
|
||||||
|
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
|
||||||
|
export default function (pi: ExtensionAPI): void;
|
||||||
File diff suppressed because it is too large
Load Diff
+380
-514
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,460 @@
|
|||||||
|
/**
|
||||||
|
* MCP Bridge Extension
|
||||||
|
*
|
||||||
|
* Connects to MCP servers and exposes their tools as pi custom tools.
|
||||||
|
* Supports stdio and streaming-HTTP transports.
|
||||||
|
*
|
||||||
|
* Configuration is read from ~/.pi/agent/extensions/mcp/mcp-servers.json.
|
||||||
|
* See the README in this directory for the format.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type { ExtensionAPI, ExtensionContext } from "@mariozechner/pi-coding-agent";
|
||||||
|
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
|
||||||
|
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
|
||||||
|
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
|
||||||
|
import {
|
||||||
|
CallToolResultSchema,
|
||||||
|
ListToolsResultSchema,
|
||||||
|
} from "@modelcontextprotocol/sdk/types.js";
|
||||||
|
import { Type } from "typebox";
|
||||||
|
import fs from "node:fs";
|
||||||
|
import path from "node:path";
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Configuration
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
interface McpStdioServer {
|
||||||
|
command: string;
|
||||||
|
args?: string[];
|
||||||
|
env?: Record<string, string>;
|
||||||
|
/** Whitelist: only register these tool names. Takes priority over excludeTools. */
|
||||||
|
tools?: string[];
|
||||||
|
/** Blacklist: exclude these tool names. Ignored if `tools` is set. */
|
||||||
|
excludeTools?: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface McpHttpServer {
|
||||||
|
name: string;
|
||||||
|
description?: string;
|
||||||
|
type: "streaming-http";
|
||||||
|
url: string;
|
||||||
|
timeout?: number;
|
||||||
|
/** Whitelist: only register these tool names. Takes priority over excludeTools. */
|
||||||
|
tools?: string[];
|
||||||
|
/** Blacklist: exclude these tool names. Ignored if `tools` is set. */
|
||||||
|
excludeTools?: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
type McpServerConfig = McpStdioServer | McpHttpServer;
|
||||||
|
|
||||||
|
interface McpConfig {
|
||||||
|
mcpServers: Record<string, McpServerConfig>;
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadConfig(): McpConfig {
|
||||||
|
const configPath = path.join(
|
||||||
|
path.dirname(import.meta.url.replace("file://", "")),
|
||||||
|
"mcp-servers.json",
|
||||||
|
);
|
||||||
|
if (!fs.existsSync(configPath)) {
|
||||||
|
return { mcpServers: {} };
|
||||||
|
}
|
||||||
|
return JSON.parse(fs.readFileSync(configPath, "utf-8"));
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// MCP client registry
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
interface ServerClient {
|
||||||
|
client: Client;
|
||||||
|
transport: StdioClientTransport | StreamableHTTPClientTransport;
|
||||||
|
name: string;
|
||||||
|
tools: Array<{ name: string; description: string; inputSchema: object }>;
|
||||||
|
}
|
||||||
|
|
||||||
|
const clients = new Map<string, ServerClient>();
|
||||||
|
|
||||||
|
async function connectToServer(
|
||||||
|
name: string,
|
||||||
|
config: McpServerConfig,
|
||||||
|
ctx: ExtensionContext,
|
||||||
|
): Promise<ServerClient> {
|
||||||
|
let client: Client;
|
||||||
|
let transport: StdioClientTransport | StreamableHTTPClientTransport;
|
||||||
|
|
||||||
|
if ("command" in config) {
|
||||||
|
// stdio transport
|
||||||
|
transport = new StdioClientTransport({
|
||||||
|
command: config.command,
|
||||||
|
args: config.args ?? [],
|
||||||
|
env: {
|
||||||
|
...process.env,
|
||||||
|
...config.env,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
client = new Client(
|
||||||
|
{ name: "pi-mcp", version: "1.0.0" },
|
||||||
|
{ capabilities: {} },
|
||||||
|
);
|
||||||
|
await client.connect(transport);
|
||||||
|
} else {
|
||||||
|
// streaming-HTTP transport
|
||||||
|
transport = new StreamableHTTPClientTransport(
|
||||||
|
new URL(config.url),
|
||||||
|
undefined,
|
||||||
|
{
|
||||||
|
requestTimeout: config.timeout ?? 120_000,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
client = new Client(
|
||||||
|
{ name: "pi-mcp", version: "1.0.0" },
|
||||||
|
{ capabilities: {} },
|
||||||
|
);
|
||||||
|
await client.connect(transport);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Discover tools
|
||||||
|
const toolsRes = await client.request(
|
||||||
|
{ method: "tools/list" },
|
||||||
|
ListToolsResultSchema,
|
||||||
|
);
|
||||||
|
|
||||||
|
const tools =
|
||||||
|
toolsRes.tools?.map((t) => ({
|
||||||
|
name: t.name,
|
||||||
|
description: t.description ?? "",
|
||||||
|
inputSchema: t.inputSchema ?? {},
|
||||||
|
})) ?? [];
|
||||||
|
|
||||||
|
return { client, transport, name, tools };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function disconnectClient(server: ServerClient) {
|
||||||
|
try {
|
||||||
|
await server.transport.close();
|
||||||
|
} catch {
|
||||||
|
// ignore close errors
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Schema builder: convert MCP inputSchema to TypeBox
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
function buildParameters(inputSchema: object) {
|
||||||
|
if (!inputSchema || typeof inputSchema !== "object") {
|
||||||
|
return Type.Object({});
|
||||||
|
}
|
||||||
|
|
||||||
|
const schema = inputSchema as {
|
||||||
|
type?: string;
|
||||||
|
properties?: Record<string, any>;
|
||||||
|
required?: string[];
|
||||||
|
};
|
||||||
|
|
||||||
|
const properties: Record<string, any> = {};
|
||||||
|
|
||||||
|
if (schema.properties) {
|
||||||
|
for (const [key, prop] of Object.entries(schema.properties)) {
|
||||||
|
const p = prop as { type?: string; description?: string };
|
||||||
|
let field: any;
|
||||||
|
switch (p.type) {
|
||||||
|
case "string":
|
||||||
|
field = Type.Optional(Type.String({ description: p.description }));
|
||||||
|
break;
|
||||||
|
case "number":
|
||||||
|
field = Type.Optional(Type.Number());
|
||||||
|
break;
|
||||||
|
case "integer":
|
||||||
|
field = Type.Optional(Type.Number());
|
||||||
|
break;
|
||||||
|
case "boolean":
|
||||||
|
field = Type.Optional(Type.Boolean());
|
||||||
|
break;
|
||||||
|
case "array":
|
||||||
|
field = Type.Optional(
|
||||||
|
Type.Array(Type.String(), {
|
||||||
|
description: p.description,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
case "object":
|
||||||
|
field = Type.Optional(Type.Record(Type.String(), Type.Unknown()));
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
field = Type.Optional(Type.String());
|
||||||
|
}
|
||||||
|
properties[key] = field;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check required fields
|
||||||
|
if (schema.required) {
|
||||||
|
for (const req of schema.required) {
|
||||||
|
if (properties[req]) {
|
||||||
|
// Make required by redefining
|
||||||
|
const def = properties[req];
|
||||||
|
if (def && "origin" in def) {
|
||||||
|
// It's a TypeBox optional - we'd need to rebuild as non-optional
|
||||||
|
// For simplicity, keep all optional since MCP tools often have flexible params
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return Type.Object(properties);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Tool call forwarder
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
const DEFAULT_MAX_RESULT_CHARS = 15_000;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rebuild relay query text from structuredContent when the bridge has
|
||||||
|
* truncated the display text field (ends with Unicode ellipsis character).
|
||||||
|
*/
|
||||||
|
function rebuildRelayTextFromStructuredContent(
|
||||||
|
textContent: string,
|
||||||
|
structuredContent: Record<string, unknown> | undefined,
|
||||||
|
): string | null {
|
||||||
|
if (!structuredContent) return null;
|
||||||
|
|
||||||
|
// Detect bridge-side truncation: the display text ends with …
|
||||||
|
if (!textContent.endsWith("…")) return null;
|
||||||
|
|
||||||
|
const nodes = structuredContent.nodes as Array<Record<string, unknown>> | undefined;
|
||||||
|
if (!nodes || nodes.length === 0) return null;
|
||||||
|
|
||||||
|
const rebuilt: string[] = [];
|
||||||
|
rebuilt.push(`📬 **Relay Query**: ${structuredContent.count ?? nodes.length} result(s).\n`);
|
||||||
|
|
||||||
|
for (const node of nodes) {
|
||||||
|
const id = node.id;
|
||||||
|
const title = node.title ?? "(no title)";
|
||||||
|
const from = (node.metadata as Record<string, unknown>)?.from ?? "?";
|
||||||
|
const to = (node.metadata as Record<string, unknown>)?.to ?? "?";
|
||||||
|
const source = node.source ?? "";
|
||||||
|
const description = node.description ?? "";
|
||||||
|
|
||||||
|
rebuilt.push(`**#${id}** — ${title}`);
|
||||||
|
rebuilt.push(` From: ${from} → To: ${to}`);
|
||||||
|
if (source) {
|
||||||
|
rebuilt.push(` ${source.replace(/\n/g, "\n ")}`);
|
||||||
|
}
|
||||||
|
if (description) {
|
||||||
|
rebuilt.push(` ${description}`);
|
||||||
|
}
|
||||||
|
rebuilt.push("");
|
||||||
|
}
|
||||||
|
|
||||||
|
return rebuilt.join("\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
async function forwardToolCall(
|
||||||
|
server: ServerClient,
|
||||||
|
toolName: string,
|
||||||
|
args: Record<string, unknown>,
|
||||||
|
signal?: AbortSignal,
|
||||||
|
maxResultChars: number = DEFAULT_MAX_RESULT_CHARS,
|
||||||
|
): Promise<{
|
||||||
|
content: Array<{ type: string; text: string }>;
|
||||||
|
isError?: boolean;
|
||||||
|
}> {
|
||||||
|
const result = await server.client.request(
|
||||||
|
{
|
||||||
|
method: "tools/call",
|
||||||
|
params: { name: toolName, arguments: args },
|
||||||
|
},
|
||||||
|
CallToolResultSchema,
|
||||||
|
signal,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Check for bridge-side truncation and rebuild from structuredContent
|
||||||
|
const structuredContent = (result as Record<string, unknown>).structuredContent as Record<string, unknown> | undefined;
|
||||||
|
|
||||||
|
const content: Array<{ type: string; text: string }> = [];
|
||||||
|
let totalChars = 0;
|
||||||
|
let truncated = false;
|
||||||
|
|
||||||
|
if (result.content) {
|
||||||
|
for (const item of result.content) {
|
||||||
|
if (truncated) break;
|
||||||
|
if (item.type === "text") {
|
||||||
|
let itemText = item.text;
|
||||||
|
|
||||||
|
// If bridge-side truncation detected, rebuild from structuredContent
|
||||||
|
const rebuilt = rebuildRelayTextFromStructuredContent(itemText, structuredContent);
|
||||||
|
if (rebuilt) {
|
||||||
|
itemText = rebuilt;
|
||||||
|
}
|
||||||
|
|
||||||
|
totalChars += itemText.length;
|
||||||
|
if (totalChars > maxResultChars) {
|
||||||
|
const keep = maxResultChars - (totalChars - itemText.length);
|
||||||
|
const trimmed = itemText.slice(0, Math.max(0, keep));
|
||||||
|
content.push({
|
||||||
|
type: "text",
|
||||||
|
text: trimmed + `\n\n[TRUNCATED: ${(itemText.length - keep).toLocaleString()} chars removed. Limit: ${maxResultChars.toLocaleString()} chars. Use specific queries or pagination.]`,
|
||||||
|
});
|
||||||
|
truncated = true;
|
||||||
|
} else {
|
||||||
|
content.push({ type: "text", text: itemText });
|
||||||
|
}
|
||||||
|
} else if (item.type === "image") {
|
||||||
|
content.push({
|
||||||
|
type: "text",
|
||||||
|
text: `[MCP image: ${item.mimeType}]`,
|
||||||
|
});
|
||||||
|
} else if (item.type === "resource") {
|
||||||
|
const textParts: string[] = [];
|
||||||
|
if ("resource" in item) {
|
||||||
|
const res = item.resource;
|
||||||
|
if ("text" in res) {
|
||||||
|
textParts.push(res.text);
|
||||||
|
} else if ("blob" in res) {
|
||||||
|
textParts.push(`[binary resource: ${res.mimeType}]`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
content.push({ type: "text", text: textParts.join("\n") });
|
||||||
|
} else {
|
||||||
|
content.push({
|
||||||
|
type: "text",
|
||||||
|
text: `[MCP ${item.type}: ${JSON.stringify(item).slice(0, 500)}]`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
content,
|
||||||
|
isError: result.isError ?? false,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Extension
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
export default async function (pi: ExtensionAPI) {
|
||||||
|
const config = loadConfig();
|
||||||
|
const registeredNames = new Set<string>();
|
||||||
|
|
||||||
|
// Connect to all servers
|
||||||
|
for (const [name, serverConfig] of Object.entries(config.mcpServers)) {
|
||||||
|
try {
|
||||||
|
const client = await connectToServer(name, serverConfig, pi);
|
||||||
|
|
||||||
|
if (client.tools.length === 0) {
|
||||||
|
pi.on("session_start", (_event, ctx) => {
|
||||||
|
ctx.ui.notify(
|
||||||
|
`MCP server "${name}" connected but has no tools.`,
|
||||||
|
"info",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
clients.set(name, client);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Filter tools based on server config
|
||||||
|
let registeredTools = client.tools;
|
||||||
|
if (serverConfig.tools) {
|
||||||
|
registeredTools = client.tools.filter((t) =>
|
||||||
|
serverConfig.tools!.includes(t.name),
|
||||||
|
);
|
||||||
|
} else if (serverConfig.excludeTools) {
|
||||||
|
registeredTools = client.tools.filter(
|
||||||
|
(t) => !serverConfig.excludeTools!.includes(t.name),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
pi.on("session_start", (_event, ctx) => {
|
||||||
|
ctx.ui.notify(
|
||||||
|
`MCP: "${name}" connected — ${registeredTools.length}/${client.tools.length} tool(s) registered.`,
|
||||||
|
"info",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Register each MCP tool as a pi tool
|
||||||
|
for (const tool of registeredTools) {
|
||||||
|
const fullName = `${name}-${tool.name}`;
|
||||||
|
if (registeredNames.has(fullName)) continue;
|
||||||
|
registeredNames.add(fullName);
|
||||||
|
|
||||||
|
const parameters = buildParameters(tool.inputSchema);
|
||||||
|
|
||||||
|
pi.registerTool({
|
||||||
|
name: fullName,
|
||||||
|
label: tool.name,
|
||||||
|
description: `[MCP:${name}] ${tool.description}`,
|
||||||
|
promptSnippet: `[MCP:${name}] ${tool.description}`,
|
||||||
|
promptGuidelines: [
|
||||||
|
`Use ${fullName} to: ${tool.description}.`,
|
||||||
|
],
|
||||||
|
parameters,
|
||||||
|
async execute(
|
||||||
|
_toolCallId,
|
||||||
|
params: Record<string, unknown>,
|
||||||
|
signal,
|
||||||
|
_onUpdate,
|
||||||
|
_ctx,
|
||||||
|
) {
|
||||||
|
const server = clients.get(name);
|
||||||
|
if (!server) {
|
||||||
|
return {
|
||||||
|
content: [{ type: "text", text: `Server "${name}" not connected.` }],
|
||||||
|
isError: true,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const maxChars = serverConfig.maxResultChars ?? DEFAULT_MAX_RESULT_CHARS;
|
||||||
|
return await forwardToolCall(server, tool.name, params, signal, maxChars);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
clients.set(name, client);
|
||||||
|
} catch (err) {
|
||||||
|
pi.on("session_start", (_event, ctx) => {
|
||||||
|
ctx.ui.notify(
|
||||||
|
`MCP: Failed to connect to "${name}": ${err instanceof Error ? err.message : String(err)}`,
|
||||||
|
"error",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Register a /mcp-status command
|
||||||
|
pi.registerCommand("mcp-status", {
|
||||||
|
description: "Show status of all MCP servers",
|
||||||
|
handler: async (_args, ctx) => {
|
||||||
|
const lines: string[] = ["=== MCP Server Status ===", ""];
|
||||||
|
for (const [name, client] of clients) {
|
||||||
|
lines.push(` ${name}: connected (${client.tools.length} tools)`);
|
||||||
|
for (const tool of client.tools) {
|
||||||
|
lines.push(` - ${tool.name}: ${tool.description.slice(0, 80)}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const unconnected = Object.keys(config.mcpServers).filter(
|
||||||
|
(n) => !clients.has(n),
|
||||||
|
);
|
||||||
|
for (const name of unconnected) {
|
||||||
|
lines.push(` ${name}: NOT CONNECTED`);
|
||||||
|
}
|
||||||
|
ctx.ui.notify(lines.join("\n"), "info");
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Cleanup on shutdown
|
||||||
|
pi.on("session_shutdown", async (event, _ctx) => {
|
||||||
|
if (event.reason === "quit") {
|
||||||
|
for (const [name, client] of clients) {
|
||||||
|
await disconnectClient(client);
|
||||||
|
delete clients.get(name);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -1,14 +1,18 @@
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"target": "ES2022",
|
"target": "ES2022",
|
||||||
"module": "ESNext",
|
"module": "ES2022",
|
||||||
"moduleResolution": "bundler",
|
"moduleResolution": "node",
|
||||||
"strict": true,
|
"outDir": "./dist",
|
||||||
|
"rootDir": "./src",
|
||||||
|
"strict": false,
|
||||||
"esModuleInterop": true,
|
"esModuleInterop": true,
|
||||||
"outDir": "dist",
|
"skipLibCheck": true,
|
||||||
"rootDir": "src",
|
"forceConsistentCasingInFileNames": true,
|
||||||
"declaration": true,
|
"declaration": true,
|
||||||
"skipLibCheck": true
|
"declarationMap": true,
|
||||||
|
"sourceMap": true
|
||||||
},
|
},
|
||||||
"include": ["src/**/*.ts"]
|
"include": ["src/**/*"],
|
||||||
|
"exclude": ["node_modules", "dist"]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,19 @@
|
|||||||
"""
|
"""
|
||||||
Zulip platform adapter (Hermes plugin) — Gen 3.
|
Zulip platform adapter (Hermes plugin) — Gen 4.
|
||||||
|
|
||||||
Connects a Hermes agent to Zulip via event queue polling. DMs and @mentions
|
Connects a Hermes agent to Zulip via event queue polling. DMs and @mentions
|
||||||
are routed to the agent via the Hermes Gateway's handle_message() interface.
|
are routed to the agent via the Hermes Gateway's handle_message() interface.
|
||||||
Replies use a placeholder->edit streaming pattern for UX feedback.
|
Replies use a placeholder->edit streaming pattern for UX feedback.
|
||||||
|
|
||||||
|
Gen 4 Improvements (2026-06-27):
|
||||||
|
1. HTTP client recreation on reconnect — new httpx.AsyncClient() after queue expiry
|
||||||
|
or sustained failures to prevent CLOSE-WAIT socket leaks
|
||||||
|
2. Heartbeat logging — periodic "still alive" message to prove poll loop is running
|
||||||
|
3. Log sanitization — truncates 502/error HTML to first 80 chars (no Netbird HTML spam)
|
||||||
|
4. Connection recovery — creates fresh HTTP client after N empty poll cycles
|
||||||
|
5. Poll silence detection — logs warnings when no events received for extended period
|
||||||
|
6. Connection reuse limit — periodic client recreation to prevent connection pool exhaustion
|
||||||
|
|
||||||
Gen 3 Improvements (2026-06-26):
|
Gen 3 Improvements (2026-06-26):
|
||||||
1. Malformed message resilience — try/except wraps each event, no crash on bad JSON
|
1. Malformed message resilience — try/except wraps each event, no crash on bad JSON
|
||||||
2. Periodic @all-bots refresh — background task re-resolves user ID every hour
|
2. Periodic @all-bots refresh — background task re-resolves user ID every hour
|
||||||
@@ -66,6 +75,13 @@ DEDUP_CLEANUP_INTERVAL = 120 # Clean old entries every 2 minutes
|
|||||||
ALL_BOTS_REFRESH_INTERVAL = 3600 # Re-resolve @all-bots user ID every hour
|
ALL_BOTS_REFRESH_INTERVAL = 3600 # Re-resolve @all-bots user ID every hour
|
||||||
SELFTEST_TIMEOUT = 30 # seconds to wait for self-test response
|
SELFTEST_TIMEOUT = 30 # seconds to wait for self-test response
|
||||||
|
|
||||||
|
# Gen 4: Connection pool health
|
||||||
|
HEARTBEAT_INTERVAL = 300 # Log heartbeat every 5 minutes
|
||||||
|
MAX_CONSECUTIVE_EMPTY_POLLS = 500 # Reset client after this many empty polls (~25min at 3s interval). Raised from 20 to prevent idle bots from cycling reconnections.
|
||||||
|
CLIENT_REUSE_LIMIT = 500 # Create fresh client every N polls to prevent connection leaks
|
||||||
|
POLL_SILENCE_WARN_INTERVAL = 60 # Warn if no events received for this many seconds
|
||||||
|
MAX_ERROR_LOG_LEN = 80 # Truncate error response bodies to avoid HTML spam
|
||||||
|
|
||||||
# Regex to strip Zulip @mention markup
|
# Regex to strip Zulip @mention markup
|
||||||
MENTION_CLEANER = re.compile(r"@\*\*[^*]+\*\*")
|
MENTION_CLEANER = re.compile(r"@\*\*[^*]+\*\*")
|
||||||
|
|
||||||
@@ -83,6 +99,23 @@ def _build_auth_header(email: str, api_key: str) -> str:
|
|||||||
return f"Basic {token}"
|
return f"Basic {token}"
|
||||||
|
|
||||||
|
|
||||||
|
def _strip_html(text: str) -> str:
|
||||||
|
"""Strip HTML tags and decode HTML entities from Zulip message content.
|
||||||
|
|
||||||
|
Zulip delivers message content as rendered HTML (e.g. <p>/approve</p>).
|
||||||
|
The gateway slash command parser expects plain text, so HTML tags
|
||||||
|
prevent command matching. This helper strips tags and decodes entities.
|
||||||
|
"""
|
||||||
|
if not text:
|
||||||
|
return text
|
||||||
|
# Strip HTML tags
|
||||||
|
text = re.sub(r"<[^>]+>", "", text)
|
||||||
|
# Decode common HTML entities
|
||||||
|
text = text.replace("&", "&").replace("<", "<").replace(">", ">")
|
||||||
|
text = text.replace(""", '"').replace("'", "'").replace(" ", " ")
|
||||||
|
return text.strip()
|
||||||
|
|
||||||
|
|
||||||
def _truncate(text: str, limit: int = MAX_ZULIP_MESSAGE) -> str:
|
def _truncate(text: str, limit: int = MAX_ZULIP_MESSAGE) -> str:
|
||||||
"""Truncate to Zulip's message limit with notice."""
|
"""Truncate to Zulip's message limit with notice."""
|
||||||
if len(text) <= limit:
|
if len(text) <= limit:
|
||||||
@@ -158,7 +191,18 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
or os.getenv("ZULIP_POLL_INTERVAL", str(DEFAULT_POLL_INTERVAL))
|
or os.getenv("ZULIP_POLL_INTERVAL", str(DEFAULT_POLL_INTERVAL))
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# --- Gen 4: Connection health ---
|
||||||
|
self._consecutive_empty_polls: int = 0
|
||||||
|
self._total_poll_count: int = 0
|
||||||
|
self._last_event_received_time: float = time.time()
|
||||||
|
self._last_heartbeat_time: float = 0.0
|
||||||
|
self._client_pool_reset_count: int = 0
|
||||||
|
|
||||||
# --- State ---
|
# --- State ---
|
||||||
|
# Support both ZULIP_SITE and ZULIP_URL env vars
|
||||||
|
if not self._site:
|
||||||
|
self._site = (os.getenv("ZULIP_URL", "") or "").rstrip("/")
|
||||||
|
|
||||||
self._auth_header: str = _build_auth_header(self._email, self._api_key)
|
self._auth_header: str = _build_auth_header(self._email, self._api_key)
|
||||||
self._queue_id: Optional[str] = None
|
self._queue_id: Optional[str] = None
|
||||||
self._last_event_id: int = -1
|
self._last_event_id: int = -1
|
||||||
@@ -201,7 +245,7 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
|
|
||||||
# --- Gen 3: Health stats callback ---
|
# --- Gen 3: Health stats callback ---
|
||||||
self._health_callback = None
|
self._health_callback = None
|
||||||
self._health_callback_interval: int = 600 # 10 min
|
self._health_callback_interval: int = 300 # 5 min
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _resolve_int(val: Any, default: int) -> int:
|
def _resolve_int(val: Any, default: int) -> int:
|
||||||
@@ -227,8 +271,11 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
# Connection lifecycle
|
# Connection lifecycle
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
async def connect(self) -> bool:
|
async def connect(self, **kwargs: Any) -> bool:
|
||||||
"""Connect to Zulip and register an event queue."""
|
"""Connect to Zulip and register an event queue.
|
||||||
|
|
||||||
|
Accepts **kwargs for Hermes Gateway compatibility (e.g., is_reconnect).
|
||||||
|
"""
|
||||||
if not HTTPX_AVAILABLE:
|
if not HTTPX_AVAILABLE:
|
||||||
logger.warning("[%s] httpx not installed", self.name)
|
logger.warning("[%s] httpx not installed", self.name)
|
||||||
return False
|
return False
|
||||||
@@ -238,9 +285,14 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
return False
|
return False
|
||||||
|
|
||||||
try:
|
try:
|
||||||
self._http_client = httpx.AsyncClient(timeout=30.0)
|
await self._create_http_client()
|
||||||
self._health_stats["started_at"] = datetime.now(timezone.utc).isoformat()
|
self._health_stats["started_at"] = datetime.now(timezone.utc).isoformat()
|
||||||
|
|
||||||
|
# Reset connection health counters
|
||||||
|
self._consecutive_empty_polls = 0
|
||||||
|
self._total_poll_count = 0
|
||||||
|
self._last_event_received_time = time.time()
|
||||||
|
|
||||||
# Register event queue
|
# Register event queue
|
||||||
queue_resp, _ = await self._api_call(
|
queue_resp, _ = await self._api_call(
|
||||||
"POST", "/api/v1/register",
|
"POST", "/api/v1/register",
|
||||||
@@ -267,6 +319,9 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
# Gen 2: Try to resolve @all-bots user ID dynamically
|
# Gen 2: Try to resolve @all-bots user ID dynamically
|
||||||
await self._resolve_all_bots_user_id()
|
await self._resolve_all_bots_user_id()
|
||||||
|
|
||||||
|
# Gen 5: Ensure bot is subscribed to primary stream
|
||||||
|
await self._ensure_stream_subscriptions()
|
||||||
|
|
||||||
self._mark_connected()
|
self._mark_connected()
|
||||||
logger.info(
|
logger.info(
|
||||||
"[%s] Connected to %s as %s (queue=%s, bot_id=%s, all_bots_id=%s)",
|
"[%s] Connected to %s as %s (queue=%s, bot_id=%s, all_bots_id=%s)",
|
||||||
@@ -342,9 +397,15 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
try:
|
try:
|
||||||
events = await self._fetch_events()
|
events = await self._fetch_events()
|
||||||
self._health_stats["poll_count"] += 1
|
self._health_stats["poll_count"] += 1
|
||||||
|
self._total_poll_count += 1
|
||||||
self._health_stats["last_poll_at"] = datetime.now(
|
self._health_stats["last_poll_at"] = datetime.now(
|
||||||
timezone.utc
|
timezone.utc
|
||||||
).isoformat()
|
).isoformat()
|
||||||
|
|
||||||
|
if events:
|
||||||
|
now = time.time()
|
||||||
|
self._consecutive_empty_polls = 0
|
||||||
|
self._last_event_received_time = now
|
||||||
for event in events:
|
for event in events:
|
||||||
try:
|
try:
|
||||||
await self._process_zulip_event(event)
|
await self._process_zulip_event(event)
|
||||||
@@ -360,6 +421,74 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
self._health_stats["malformed_events"] = (
|
self._health_stats["malformed_events"] = (
|
||||||
self._health_stats.get("malformed_events", 0) + 1
|
self._health_stats.get("malformed_events", 0) + 1
|
||||||
)
|
)
|
||||||
|
else:
|
||||||
|
# Gen 4: Track consecutive empty polls to detect silent failures
|
||||||
|
self._consecutive_empty_polls += 1
|
||||||
|
|
||||||
|
# Gen 4: Detect prolonged silence (no events for too long)
|
||||||
|
silence_duration = time.time() - self._last_event_received_time
|
||||||
|
if silence_duration > POLL_SILENCE_WARN_INTERVAL:
|
||||||
|
logger.warning(
|
||||||
|
"[%s] No events received for %.0fs "
|
||||||
|
"(consecutive_empty=%d, total_polls=%d, "
|
||||||
|
"queue=%s)",
|
||||||
|
self.name, silence_duration,
|
||||||
|
self._consecutive_empty_polls,
|
||||||
|
self._total_poll_count,
|
||||||
|
self._queue_id,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Gen 4: Reset HTTP client if too many empty polls in a row
|
||||||
|
# (connection pool likely stuck in CLOSE-WAIT)
|
||||||
|
if (
|
||||||
|
self._consecutive_empty_polls
|
||||||
|
>= MAX_CONSECUTIVE_EMPTY_POLLS
|
||||||
|
):
|
||||||
|
logger.warning(
|
||||||
|
"[%s] %d consecutive empty polls — "
|
||||||
|
"recreating HTTP client and reconnecting",
|
||||||
|
self.name, self._consecutive_empty_polls,
|
||||||
|
)
|
||||||
|
await self._reconnect_with_fresh_client()
|
||||||
|
backoff_idx = 0
|
||||||
|
self._consecutive_empty_polls = 0
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Gen 4: Periodic client refresh to prevent connection leaks
|
||||||
|
if self._total_poll_count % CLIENT_REUSE_LIMIT == 0:
|
||||||
|
logger.info(
|
||||||
|
"[%s] Client reuse limit reached (%d polls) — "
|
||||||
|
"creating fresh HTTP client",
|
||||||
|
self.name, self._total_poll_count,
|
||||||
|
)
|
||||||
|
old_client = self._http_client
|
||||||
|
await self._create_http_client()
|
||||||
|
if old_client:
|
||||||
|
try:
|
||||||
|
await old_client.aclose()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Clear stale errors on successful poll cycle
|
||||||
|
self._health_stats["last_error_msg"] = None
|
||||||
|
self._health_stats["last_error_at"] = None
|
||||||
|
|
||||||
|
# Gen 4: Heartbeat logging — prove poll loop is alive
|
||||||
|
now = time.time()
|
||||||
|
if now - self._last_heartbeat_time > HEARTBEAT_INTERVAL:
|
||||||
|
self._last_heartbeat_time = now
|
||||||
|
silence = now - self._last_event_received_time
|
||||||
|
logger.info(
|
||||||
|
"[%s] Heartbeat — polls=%d empty=%d "
|
||||||
|
"silence=%.0fs errors=%d reconnects=%d "
|
||||||
|
"queue=%s",
|
||||||
|
self.name, self._total_poll_count,
|
||||||
|
self._consecutive_empty_polls, silence,
|
||||||
|
self._health_stats["poll_errors"],
|
||||||
|
self._health_stats["reconnects"],
|
||||||
|
self._queue_id,
|
||||||
|
)
|
||||||
|
|
||||||
backoff_idx = 0
|
backoff_idx = 0
|
||||||
except asyncio.CancelledError:
|
except asyncio.CancelledError:
|
||||||
break
|
break
|
||||||
@@ -375,7 +504,7 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
err_str = str(e)
|
err_str = str(e)
|
||||||
if "BAD_EVENT_QUEUE_ID" in err_str or "queue_id" in err_str.lower():
|
if "BAD_EVENT_QUEUE_ID" in err_str or "queue_id" in err_str.lower():
|
||||||
logger.info("[%s] Queue expired, re-registering...", self.name)
|
logger.info("[%s] Queue expired, re-registering...", self.name)
|
||||||
await self._reconnect()
|
await self._reconnect_with_fresh_client()
|
||||||
backoff_idx = 0
|
backoff_idx = 0
|
||||||
continue
|
continue
|
||||||
logger.warning("[%s] Poll error: %s", self.name, e)
|
logger.warning("[%s] Poll error: %s", self.name, e)
|
||||||
@@ -417,6 +546,28 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
|
|
||||||
return [e for e in events if e.get("type") == "message"]
|
return [e for e in events if e.get("type") == "message"]
|
||||||
|
|
||||||
|
async def _create_http_client(self) -> None:
|
||||||
|
"""Create a fresh httpx client, closing the old one if it exists.
|
||||||
|
|
||||||
|
Gen 4: This ensures a clean connection pool after sustained failures
|
||||||
|
or queue expiry, preventing CLOSE-WAIT socket leaks.
|
||||||
|
"""
|
||||||
|
old_client = self._http_client
|
||||||
|
self._http_client = httpx.AsyncClient(
|
||||||
|
timeout=httpx.Timeout(30.0, connect=15.0),
|
||||||
|
limits=httpx.Limits(
|
||||||
|
max_keepalive_connections=5,
|
||||||
|
max_connections=10,
|
||||||
|
keepalive_expiry=60.0,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
self._client_pool_reset_count += 1
|
||||||
|
if old_client:
|
||||||
|
try:
|
||||||
|
await old_client.aclose()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
async def _reconnect(self) -> None:
|
async def _reconnect(self) -> None:
|
||||||
"""Re-register the event queue."""
|
"""Re-register the event queue."""
|
||||||
self._queue_id = None
|
self._queue_id = None
|
||||||
@@ -434,9 +585,21 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
self._last_event_id = resp.get("last_event_id", -1)
|
self._last_event_id = resp.get("last_event_id", -1)
|
||||||
self._health_stats["reconnects"] += 1
|
self._health_stats["reconnects"] += 1
|
||||||
logger.info("[%s] Reconnected, queue=%s", self.name, self._queue_id)
|
logger.info("[%s] Reconnected, queue=%s", self.name, self._queue_id)
|
||||||
|
self._consecutive_empty_polls = 0
|
||||||
|
self._last_event_received_time = time.time()
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
logger.error("[%s] Reconnect failed: %s", self.name, e)
|
logger.error("[%s] Reconnect failed: %s", self.name, e)
|
||||||
|
|
||||||
|
async def _reconnect_with_fresh_client(self) -> None:
|
||||||
|
"""Re-register the event queue with a fresh HTTP client.
|
||||||
|
|
||||||
|
Gen 4: Creates a new httpx client to break out of stuck connection
|
||||||
|
pools (CLOSE-WAIT sockets from previous failures).
|
||||||
|
"""
|
||||||
|
logger.info("[%s] Reconnecting with fresh HTTP client", self.name)
|
||||||
|
await self._create_http_client()
|
||||||
|
await self._reconnect()
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
# Gen 2: Background dedup maintenance
|
# Gen 2: Background dedup maintenance
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
@@ -538,6 +701,64 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
# Gen 2: Dynamic @all-bots resolution
|
# Gen 2: Dynamic @all-bots resolution
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
|
async def _ensure_stream_subscriptions(self) -> None:
|
||||||
|
"""Ensure the bot is subscribed to the primary streams.
|
||||||
|
|
||||||
|
Checks current subscriptions and subscribes to the configured primary
|
||||||
|
stream (and general-chat) if missing. Without subscription, the bot
|
||||||
|
receives DMs but no stream events — @mentions in streams are invisible.
|
||||||
|
|
||||||
|
This is a Gen 5 improvement based on lessons from the pi Zulip extension,
|
||||||
|
where the bot had zero stream subscriptions and couldn't receive
|
||||||
|
@mentions in stream topics.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
# Check current subscriptions
|
||||||
|
resp, _ = await self._api_call(
|
||||||
|
"GET", "/api/v1/users/me/subscriptions",
|
||||||
|
)
|
||||||
|
if not resp:
|
||||||
|
return
|
||||||
|
|
||||||
|
subscribed = resp.get("subscriptions", [])
|
||||||
|
subscribed_names = [s.get("name", "") for s in subscribed if isinstance(s, dict)]
|
||||||
|
|
||||||
|
# Streams the bot should be subscribed to
|
||||||
|
required_streams = [self._stream, "general chat"]
|
||||||
|
missing = [s for s in required_streams if s not in subscribed_names]
|
||||||
|
|
||||||
|
if not missing:
|
||||||
|
logger.info(
|
||||||
|
"[%s] Stream subscriptions OK: %s",
|
||||||
|
self.name, ", ".join(subscribed_names),
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
# Subscribe to missing streams
|
||||||
|
import json as _json
|
||||||
|
payload = {"subscriptions": _json.dumps(
|
||||||
|
[{"name": s} for s in missing]
|
||||||
|
)}
|
||||||
|
sub_resp, _ = await self._api_call(
|
||||||
|
"POST", "/api/v1/users/me/subscriptions",
|
||||||
|
data=payload,
|
||||||
|
)
|
||||||
|
if sub_resp and sub_resp.get("result") == "success":
|
||||||
|
subscribed_str = ", ".join(missing)
|
||||||
|
logger.info(
|
||||||
|
"[%s] Subscribed to: %s", self.name, subscribed_str,
|
||||||
|
)
|
||||||
|
self._health_stats["subscriptions_fixed"] = (
|
||||||
|
self._health_stats.get("subscriptions_fixed", 0) + 1
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
logger.warning(
|
||||||
|
"[%s] Failed to subscribe to %s",
|
||||||
|
self.name, ", ".join(missing),
|
||||||
|
)
|
||||||
|
except Exception as e:
|
||||||
|
logger.warning("[%s] Subscription check failed: %s", self.name, e)
|
||||||
|
|
||||||
async def _resolve_all_bots_user_id(self) -> None:
|
async def _resolve_all_bots_user_id(self) -> None:
|
||||||
"""Try to resolve the @all-bots user ID from the Zulip server.
|
"""Try to resolve the @all-bots user ID from the Zulip server.
|
||||||
|
|
||||||
@@ -580,6 +801,8 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
sender_name = msg.get("sender_full_name", "Unknown")
|
sender_name = msg.get("sender_full_name", "Unknown")
|
||||||
sender_id = msg.get("sender_id")
|
sender_id = msg.get("sender_id")
|
||||||
content = msg.get("content", "")
|
content = msg.get("content", "")
|
||||||
|
# Strip Zulip HTML for slash command matching (zulip-approval-fix contract)
|
||||||
|
content = _strip_html(content)
|
||||||
|
|
||||||
# Echo-loop prevention: skip own messages
|
# Echo-loop prevention: skip own messages
|
||||||
if sender_email == self._bot_email:
|
if sender_email == self._bot_email:
|
||||||
@@ -717,12 +940,15 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
content: str,
|
content: str,
|
||||||
reply_to: Optional[str] = None,
|
reply_to: Optional[str] = None,
|
||||||
metadata: Optional[Dict[str, Any]] = None,
|
metadata: Optional[Dict[str, Any]] = None,
|
||||||
|
**kwargs: Any,
|
||||||
) -> SendResult:
|
) -> SendResult:
|
||||||
"""Send a message to a Zulip chat.
|
"""Send a message to a Zulip chat.
|
||||||
|
|
||||||
For DMs, chat_id is the user_id. For streams, format is
|
For DMs, chat_id is the user_id. For streams, format is
|
||||||
"stream_name:topic". Sends a placeholder first if this is the
|
"stream_name:topic". Sends a placeholder first if this is the
|
||||||
first message in a turn, then edits it on subsequent calls.
|
first message in a turn, then edits it on subsequent calls.
|
||||||
|
|
||||||
|
Accepts **kwargs for Hermes Gateway compatibility.
|
||||||
"""
|
"""
|
||||||
# Determine target type and IDs
|
# Determine target type and IDs
|
||||||
is_dm = not chat_id or ":" not in chat_id
|
is_dm = not chat_id or ":" not in chat_id
|
||||||
@@ -771,10 +997,11 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
# Send actual content
|
# Send actual content
|
||||||
result = await self._send_api_call(payload)
|
result = await self._send_api_call(payload)
|
||||||
if result and result.get("id"):
|
if result and result.get("id"):
|
||||||
|
msg_id = str(result["id"])
|
||||||
self._health_stats["send_count"] += 1
|
self._health_stats["send_count"] += 1
|
||||||
return SendResult(
|
return SendResult(
|
||||||
success=True,
|
success=True,
|
||||||
message_id=str(result["id"]),
|
message_id=msg_id,
|
||||||
)
|
)
|
||||||
|
|
||||||
self._health_stats["send_errors"] += 1
|
self._health_stats["send_errors"] += 1
|
||||||
@@ -789,19 +1016,43 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
message_id: str,
|
message_id: str,
|
||||||
content: str,
|
content: str,
|
||||||
metadata: Optional[Dict[str, Any]] = None,
|
metadata: Optional[Dict[str, Any]] = None,
|
||||||
) -> bool:
|
**kwargs: Any,
|
||||||
"""Edit a previously sent Zulip message (for placeholder replacement)."""
|
) -> SendResult:
|
||||||
|
"""Edit a previously sent Zulip message (for placeholder replacement).
|
||||||
|
|
||||||
|
Returns SendResult for Hermes Gateway streaming interface compatibility.
|
||||||
|
Accepts **kwargs (e.g., finalize=True) — extra kwargs are silently ignored.
|
||||||
|
|
||||||
|
Note: Zulip uses POST /api/v1/messages/{message_id} for editing.
|
||||||
|
"""
|
||||||
truncated = _truncate(content)
|
truncated = _truncate(content)
|
||||||
payload = {
|
payload = {
|
||||||
"message_id": int(message_id),
|
|
||||||
"content": truncated,
|
"content": truncated,
|
||||||
}
|
}
|
||||||
try:
|
try:
|
||||||
resp, _ = await self._api_call("PATCH", "/api/v1/messages", data=payload)
|
# Zulip API: PATCH /api/v1/messages/{message_id} with content in body
|
||||||
return resp is not None
|
resp, status = await self._api_call(
|
||||||
|
"PATCH", f"/api/v1/messages/{int(message_id)}",
|
||||||
|
data=payload,
|
||||||
|
)
|
||||||
|
if resp:
|
||||||
|
self._health_stats["send_count"] += 1
|
||||||
|
return SendResult(
|
||||||
|
success=True,
|
||||||
|
message_id=str(resp.get("id", message_id)),
|
||||||
|
)
|
||||||
|
self._health_stats["send_errors"] += 1
|
||||||
|
return SendResult(
|
||||||
|
success=False,
|
||||||
|
error=f"Edit failed (status={status})",
|
||||||
|
)
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
logger.warning("[%s] Edit message %s error: %s", self.name, message_id, e)
|
logger.warning("[%s] Edit message %s error: %s", self.name, message_id, e)
|
||||||
return False
|
self._health_stats["send_errors"] += 1
|
||||||
|
return SendResult(
|
||||||
|
success=False,
|
||||||
|
error=str(e),
|
||||||
|
)
|
||||||
|
|
||||||
async def send_typing(self, chat_id: str, metadata: Optional[Dict] = None) -> None:
|
async def send_typing(self, chat_id: str, metadata: Optional[Dict] = None) -> None:
|
||||||
"""Send typing indicator to a Zulip chat."""
|
"""Send typing indicator to a Zulip chat."""
|
||||||
@@ -839,12 +1090,14 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
return {"name": chat_id, "type": "dm"}
|
return {"name": chat_id, "type": "dm"}
|
||||||
|
|
||||||
async def delete_message(
|
async def delete_message(
|
||||||
self, chat_id: str, message_id: str, metadata: Optional[Dict] = None
|
self, chat_id: str, message_id: str,
|
||||||
) -> bool:
|
metadata: Optional[Dict] = None,
|
||||||
|
**kwargs: Any,
|
||||||
|
) -> SendResult:
|
||||||
"""Delete a message via Zulip API."""
|
"""Delete a message via Zulip API."""
|
||||||
# Zulip doesn't support message deletion via API for bots
|
# Zulip doesn't support message deletion via API for bots
|
||||||
# Send an empty edit instead
|
# Send an empty edit instead
|
||||||
return await self.edit_message(chat_id, message_id, "*deleted*")
|
return await self.edit_message(chat_id, message_id, "*deleted*", **kwargs)
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
# Gen 2: Self-test diagnostics
|
# Gen 2: Self-test diagnostics
|
||||||
@@ -927,6 +1180,35 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
"detail": f"@all-bots user_id: {self._all_bots_user_id}",
|
"detail": f"@all-bots user_id: {self._all_bots_user_id}",
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# 9. Stream subscriptions (verifies bot is subscribed to at least one stream)
|
||||||
|
try:
|
||||||
|
from urllib.parse import urlencode
|
||||||
|
import json as _json
|
||||||
|
key_str = f"{self._email}:{self._api_key}"
|
||||||
|
auth_b64 = base64.b64encode(key_str.encode()).decode()
|
||||||
|
resp, _ = await self._api_call(
|
||||||
|
"GET", "/api/v1/users/me/subscriptions",
|
||||||
|
)
|
||||||
|
if resp and "subscriptions" in resp:
|
||||||
|
stream_count = len(resp["subscriptions"])
|
||||||
|
stream_names = [s.get("name", "?") for s in resp["subscriptions"]][:5]
|
||||||
|
checks["stream_subscriptions"] = {
|
||||||
|
"status": stream_count > 0,
|
||||||
|
"detail": f"{stream_count} stream(s): {', '.join(stream_names)}"
|
||||||
|
if stream_count > 0
|
||||||
|
else "No stream subscriptions — bot will not receive stream events",
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
checks["stream_subscriptions"] = {
|
||||||
|
"status": False,
|
||||||
|
"detail": "Failed to check subscriptions",
|
||||||
|
}
|
||||||
|
except Exception as sub_err:
|
||||||
|
checks["stream_subscriptions"] = {
|
||||||
|
"status": False,
|
||||||
|
"detail": f"Subscription check failed: {sub_err}",
|
||||||
|
}
|
||||||
|
|
||||||
# Overall verdict
|
# Overall verdict
|
||||||
critical = ["connected", "queue_registered", "http_client", "poll_loop"]
|
critical = ["connected", "queue_registered", "http_client", "poll_loop"]
|
||||||
passed = sum(1 for c in checks.values() if c["status"])
|
passed = sum(1 for c in checks.values() if c["status"])
|
||||||
@@ -1023,6 +1305,10 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
stats["all_bots_user_id"] = self._all_bots_user_id
|
stats["all_bots_user_id"] = self._all_bots_user_id
|
||||||
stats["connected"] = self._connected
|
stats["connected"] = self._connected
|
||||||
stats["checked_at"] = now.isoformat()
|
stats["checked_at"] = now.isoformat()
|
||||||
|
stats["total_polls"] = self._total_poll_count
|
||||||
|
stats["consecutive_empty_polls"] = self._consecutive_empty_polls
|
||||||
|
stats["client_pool_resets"] = self._client_pool_reset_count
|
||||||
|
stats["silence_seconds"] = round(time.time() - self._last_event_received_time)
|
||||||
|
|
||||||
# Compute error rate
|
# Compute error rate
|
||||||
total_polls = stats.get("poll_count", 0) or 1
|
total_polls = stats.get("poll_count", 0) or 1
|
||||||
@@ -1074,10 +1360,12 @@ class ZulipAdapter(BasePlatformAdapter):
|
|||||||
return None, 0
|
return None, 0
|
||||||
|
|
||||||
if response.status_code >= 400:
|
if response.status_code >= 400:
|
||||||
|
# Gen 4: Truncate error bodies to prevent HTML spam
|
||||||
|
body = response.text[:MAX_ERROR_LOG_LEN].replace("\n", " ")
|
||||||
logger.warning(
|
logger.warning(
|
||||||
"[%s] API %s %s: %d %s",
|
"[%s] API %s %s: %d %s",
|
||||||
self.name, method, path,
|
self.name, method, path,
|
||||||
response.status_code, response.text[:200],
|
response.status_code, body,
|
||||||
)
|
)
|
||||||
return None, response.status_code
|
return None, response.status_code
|
||||||
|
|
||||||
@@ -1136,7 +1424,7 @@ def check_requirements() -> bool:
|
|||||||
"""Check whether the Zulip adapter is installable."""
|
"""Check whether the Zulip adapter is installable."""
|
||||||
if not HTTPX_AVAILABLE:
|
if not HTTPX_AVAILABLE:
|
||||||
return False
|
return False
|
||||||
site = os.getenv("ZULIP_SITE", "").strip()
|
site = os.getenv("ZULIP_SITE", "").strip() or os.getenv("ZULIP_URL", "").strip()
|
||||||
email = os.getenv("ZULIP_EMAIL", "").strip()
|
email = os.getenv("ZULIP_EMAIL", "").strip()
|
||||||
api_key = os.getenv("ZULIP_API_KEY", "").strip()
|
api_key = os.getenv("ZULIP_API_KEY", "").strip()
|
||||||
return bool(site and email and api_key)
|
return bool(site and email and api_key)
|
||||||
@@ -1145,7 +1433,7 @@ def check_requirements() -> bool:
|
|||||||
def validate_config(config) -> bool:
|
def validate_config(config) -> bool:
|
||||||
"""Validate that the configured Zulip platform has credentials."""
|
"""Validate that the configured Zulip platform has credentials."""
|
||||||
extra = getattr(config, "extra", {}) or {}
|
extra = getattr(config, "extra", {}) or {}
|
||||||
site = extra.get("site") or os.getenv("ZULIP_SITE", "")
|
site = extra.get("site") or os.getenv("ZULIP_SITE", "") or os.getenv("ZULIP_URL", "")
|
||||||
email = extra.get("email") or os.getenv("ZULIP_EMAIL", "")
|
email = extra.get("email") or os.getenv("ZULIP_EMAIL", "")
|
||||||
api_key = extra.get("api_key") or os.getenv("ZULIP_API_KEY", "")
|
api_key = extra.get("api_key") or os.getenv("ZULIP_API_KEY", "")
|
||||||
return bool(site and email and api_key)
|
return bool(site and email and api_key)
|
||||||
@@ -1158,7 +1446,7 @@ def is_connected(config) -> bool:
|
|||||||
|
|
||||||
def _env_enablement() -> Optional[dict]:
|
def _env_enablement() -> Optional[dict]:
|
||||||
"""Seeds PlatformConfig.extra from env vars for env-only setups."""
|
"""Seeds PlatformConfig.extra from env vars for env-only setups."""
|
||||||
site = os.getenv("ZULIP_SITE", "").strip()
|
site = os.getenv("ZULIP_SITE", "").strip() or os.getenv("ZULIP_URL", "").strip()
|
||||||
email = os.getenv("ZULIP_EMAIL", "").strip()
|
email = os.getenv("ZULIP_EMAIL", "").strip()
|
||||||
api_key = os.getenv("ZULIP_API_KEY", "").strip()
|
api_key = os.getenv("ZULIP_API_KEY", "").strip()
|
||||||
if not (site and email and api_key):
|
if not (site and email and api_key):
|
||||||
|
|||||||
@@ -0,0 +1,155 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
Deploy Hermes Zulip plugin as a systemd service.
|
||||||
|
Creates service file, installs dependencies, deploys plugin.
|
||||||
|
|
||||||
|
Usage: python3 deploy-hermes-zulip.py --agent tanko --email tanko-bot@chat.sysloggh.net --api-key KEY
|
||||||
|
"""
|
||||||
|
import argparse, os, sys, subprocess, json
|
||||||
|
|
||||||
|
SYSTEMD_TEMPLATE = """[Unit]
|
||||||
|
Description=Hermes Zulip Gateway — {agent_name} ({bot_email})
|
||||||
|
After=network-online.target
|
||||||
|
Wants=network-online.target
|
||||||
|
Documentation=https://git.sysloggh.net/SyslogSolution/zulip-platform-plugins
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=root
|
||||||
|
WorkingDirectory=/opt/hermes-zulip-{agent_name}
|
||||||
|
Environment=ZULIP_SITE=https://chat.sysloggh.net
|
||||||
|
Environment=ZULIP_EMAIL={bot_email}
|
||||||
|
Environment=ZULIP_API_KEY={api_key}
|
||||||
|
Environment=ZULIP_AGENT_NAME={agent_name}
|
||||||
|
Environment=ZULIP_STREAM=agent-hub
|
||||||
|
Environment=ZULIP_POLL_INTERVAL=3
|
||||||
|
Environment=PYTHONUNBUFFERED=1
|
||||||
|
ExecStart=/usr/bin/python3 -m hermes_zulip.adapter_standalone
|
||||||
|
Restart=always
|
||||||
|
RestartSec=10
|
||||||
|
StandardOutput=journal
|
||||||
|
StandardError=journal
|
||||||
|
SyslogIdentifier=hermes-zulip-{agent_name}
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
"""
|
||||||
|
|
||||||
|
PLUGIN_FILES = [
|
||||||
|
"plugins/platforms/zulip/__init__.py",
|
||||||
|
"plugins/platforms/zulip/adapter.py",
|
||||||
|
"plugins/platforms/zulip/plugin.yaml",
|
||||||
|
]
|
||||||
|
|
||||||
|
def main():
|
||||||
|
parser = argparse.ArgumentParser(description="Deploy Hermes Zulip plugin")
|
||||||
|
parser.add_argument("--agent", required=True, help="Agent name (e.g. tanko)")
|
||||||
|
parser.add_argument("--email", required=True, help="Bot email")
|
||||||
|
parser.add_argument("--api-key", required=True, help="Zulip API key")
|
||||||
|
parser.add_argument("--port", type=int, default=None, help="Health port (auto-assigned)")
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
agent = args.agent.lower()
|
||||||
|
port = args.port or (9201 + hash(agent) % 10)
|
||||||
|
repo_dir = "/root/zulip-platform-plugins"
|
||||||
|
deploy_dir = f"/opt/hermes-zulip-{agent}"
|
||||||
|
|
||||||
|
print(f"=== Deploying Hermes Zulip Plugin: {agent} ===")
|
||||||
|
print(f" Bot: {args.email}")
|
||||||
|
print(f" Port: {port}")
|
||||||
|
print(f" Deploy dir: {deploy_dir}")
|
||||||
|
print()
|
||||||
|
|
||||||
|
# 1. Ensure httpx is installed
|
||||||
|
print("[1/5] Installing httpx...")
|
||||||
|
subprocess.run(
|
||||||
|
[sys.executable, "-m", "pip", "install", "--break-system-packages", "--quiet", "httpx"],
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
print(" ✅ httpx installed")
|
||||||
|
|
||||||
|
# 2. Create deploy directory
|
||||||
|
print(f"[2/5] Setting up {deploy_dir}...")
|
||||||
|
os.makedirs(deploy_dir, exist_ok=True)
|
||||||
|
|
||||||
|
# 3. Copy plugin files
|
||||||
|
print("[3/5] Copying plugin files...")
|
||||||
|
for f in PLUGIN_FILES:
|
||||||
|
src = os.path.join(repo_dir, f)
|
||||||
|
dst = os.path.join(deploy_dir, os.path.basename(f))
|
||||||
|
if os.path.exists(src):
|
||||||
|
subprocess.run(["cp", src, dst], check=True)
|
||||||
|
print(f" ✅ {os.path.basename(f)}")
|
||||||
|
else:
|
||||||
|
print(f" ⚠️ {f} not found, skipping")
|
||||||
|
|
||||||
|
# 4. Create standalone adapter launcher
|
||||||
|
print("[4/5] Creating adapter launcher...")
|
||||||
|
launcher = os.path.join(deploy_dir, "adapter_standalone.py")
|
||||||
|
with open(launcher, "w") as f:
|
||||||
|
f.write(f'''"""Standalone launcher for Hermes Zulip adapter — {agent}."""
|
||||||
|
import asyncio, os, sys, logging
|
||||||
|
|
||||||
|
logging.basicConfig(
|
||||||
|
level=logging.INFO,
|
||||||
|
format="%(asctime)s [%(name)s] %(levelname)s: %(message)s",
|
||||||
|
datefmt="%Y-%m-%d %H:%M:%S",
|
||||||
|
)
|
||||||
|
|
||||||
|
sys.path.insert(0, "{deploy_dir}")
|
||||||
|
|
||||||
|
from adapter import ZulipAdapter, check_requirements
|
||||||
|
|
||||||
|
async def main():
|
||||||
|
if not check_requirements():
|
||||||
|
print("Missing Zulip credentials. Set ZULIP_SITE, ZULIP_EMAIL, ZULIP_API_KEY.")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
config = type("Config", (), {{"extra": {{}}}})()
|
||||||
|
adapter = ZulipAdapter(config)
|
||||||
|
|
||||||
|
ok = await adapter.connect()
|
||||||
|
if not ok:
|
||||||
|
print("Failed to connect to Zulip")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
print(f"Connected as {{adapter._email}} (queue={{adapter._queue_id}})")
|
||||||
|
|
||||||
|
# Keep alive
|
||||||
|
try:
|
||||||
|
await asyncio.Event().wait()
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
pass
|
||||||
|
finally:
|
||||||
|
await adapter.disconnect()
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
asyncio.run(main())
|
||||||
|
''')
|
||||||
|
print(" ✅ adapter_standalone.py")
|
||||||
|
|
||||||
|
# 5. Create and enable systemd service
|
||||||
|
print("[5/5] Installing systemd service...")
|
||||||
|
service_name = f"hermes-zulip-{agent}"
|
||||||
|
service_content = SYSTEMD_TEMPLATE.format(
|
||||||
|
agent_name=agent.title(),
|
||||||
|
bot_email=args.email,
|
||||||
|
api_key=args.api_key,
|
||||||
|
port=port,
|
||||||
|
)
|
||||||
|
|
||||||
|
service_path = f"/etc/systemd/system/{service_name}.service"
|
||||||
|
with open(service_path, "w") as f:
|
||||||
|
f.write(service_content)
|
||||||
|
|
||||||
|
subprocess.run(["systemctl", "daemon-reload"], check=True)
|
||||||
|
subprocess.run(["systemctl", "enable", service_name], check=True)
|
||||||
|
print(f" ✅ Service installed: {service_name}")
|
||||||
|
print(f" Service file: {service_path}")
|
||||||
|
print()
|
||||||
|
print(f" To start: systemctl start {service_name}")
|
||||||
|
print(f" To check: systemctl status {service_name}")
|
||||||
|
print(f" Logs: journalctl -u {service_name} -f")
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
Reference in New Issue
Block a user