Compare commits

...

18 Commits

Author SHA1 Message Date
Oleksandr Kozachuk 7753cc4a07 persona initiative: source-aware idle-impulse default (host configs carry luma/fjaerkroa quirks, opinions, memory callbacks, tasks-approval off, source-aware boreness) 2026-07-14 13:57:58 +02:00
Oleksandr Kozachuk df0bc94489 health monitor (ops-18/19): spend/disk/task-queue thresholds -> staff alerts, edge-triggered, opt-in 2026-07-14 13:36:25 +02:00
Oleksandr Kozachuk 6b61ed6175 tool clarity + luma is male: get_news preferred over web_search, sharper codex/websearch descriptions, luma he-pronouns 2026-07-14 12:43:01 +02:00
Oleksandr Kozachuk 80000528d3 news parser: handle rss 1.0/rdf (4gamer jp feed parsed 0 items -> #newsjp near-silent) 2026-07-14 12:21:36 +02:00
Oleksandr Kozachuk cdd5a4cd48 web search via exa (spec-015): web_search tool, sanitized results, per-user cap, host-config key 2026-07-14 12:08:48 +02:00
Oleksandr Kozachuk 5d01400638 news memory + get_news tool (news-07..12): feed summaries, deduped rolling store (schema v6), on-demand filtered retrieval 2026-07-14 11:34:23 +02:00
Oleksandr Kozachuk 891fbdc101 operator help: complete + context-aware (ops-17): !bot help full grouped list, !help for everyone per-channel 2026-07-14 11:09:33 +02:00
Oleksandr Kozachuk 09871b9b95 codex mechanicus search (spec-014): ground warhammer lore in binaric.tech via codex_search tool 2026-07-13 20:50:08 +02:00
Oleksandr Kozachuk a514ff652c url reader: follow html meta-refresh redirects (getnews shortlinks) with ssrf re-guard 2026-07-13 20:09:46 +02:00
Oleksandr Kozachuk 7628faf551 news webhook posting mode: replaces py3.8 getnews (bounded state, seed-on-first-run, ssrf-guarded) 2026-07-13 19:47:30 +02:00
Oleksandr Kozachuk 2caa18a17f igdb search + capped http reads: native fulltext, full-page fetch
search_games used `where name ~ "<q>"*`: prefix-only, diacritic- and
word-order-sensitive -- "MARVEL Tōkon" found nothing though IGDB has
it. Switch to IGDB's native `search` clause (relevance-ranked,
diacritic-insensitive).

fetch_url and image downloads read bodies with content.read(n), which
returns only the first buffered chunk (~7 KB): pages collapsed to
their <title>. httpread.read_capped collects chunks up to the byte
cap; image downloads read limit+1 so over-limit files are still
rejected instead of cached truncated (IMG-10).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-13 19:29:16 +02:00
Oleksandr Kozachuk d4eec4088d news digest (spec-013): rss/atom -> {news} file via cron
Replaces the broken pre-1.0-openai news_feed.py. Stdlib parsing with
defusedxml (feeds are untrusted XML), titles sanitized (SAF-03), feed
URLs SSRF-guarded. CLI: python -m fjerkroa_bot.news --config <cfg>.
2026-07-13 19:28:41 +02:00
Oleksandr Kozachuk 86e631926f igdb: auto-refresh twitch token; category -> game_type filter
Static app tokens expire after ~60 days -> every lookup failed with
401. With igdb-client-secret set, the bot fetches the token via
client-credentials OAuth itself, refreshes a day before expiry and
retries once on 401; a static igdb-access-token still works.

IGDB renamed games.category to game_type: the category = 0 filter in
search_games silently matched nothing even with a valid token.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-13 18:41:31 +02:00
Oleksandr Kozachuk 4166520923 ops: consistent rotated db backups + cron, consecutive-api-error staff alert 2026-07-13 18:25:01 +02:00
Oleksandr Kozachuk d0819c2683 url reading tool: fetch_url with ssrf guard, html->text, page images to vision cache 2026-07-13 18:10:54 +02:00
Oleksandr Kozachuk df1924bb80 self-tasking engine: persistent queue, idle-impulse + follow-up generators, approval mode 2026-07-13 17:49:39 +02:00
Oleksandr Kozachuk e7e51e4230 img-17: cache image-only posts; news pipeline notes 2026-07-13 16:50:58 +02:00
Oleksandr Kozachuk 5a3623f813 strengthen picture_edit hint: model must use edit for previously shared images 2026-07-13 16:45:15 +02:00
41 changed files with 3658 additions and 110 deletions
+41
View File
@@ -60,6 +60,47 @@ Decisions inside the set architecture. D-NNN, never renumbered.
broken classifier must never mute the bot; the budget gate already
bounds spend. Its verdict gates BEFORE the main call, the
envelope's answer_needed still gates after — two independent nets.
- **D-021** — Health monitoring (FDB-012, SPEC-012 OPS-18/19): a
separate `monitor_loop` (own cadence, default 300 s) rather than
folding checks into the 60 s task loop — monitoring is coarse and
should not run every minute. Checks are edge-triggered (alert on the
rising edge, re-arm on recovery) so a standing condition never spams;
they reuse the existing rate-limited staff-alert path. Metrics are
the cheap, high-signal ones (spend vs budget, free disk, task-queue
depth); each is independently skippable when it has no data, so a
deployment without a budget or store still runs the others. Opt-in
(`enable-monitoring`) like every other operational rollout.
- **D-020** — Web search via Exa (FDB-022, SPEC-015): a `web_search`
tool alongside fetch_url/IGDB/codex/get_news, filling the "look it up
on the open web" gap. Exa (not a raw search-engine scrape) because it
returns clean title+url+text in one call — no SSRF surface of our own
(we call one fixed API endpoint, not arbitrary hosts), and it pairs
with fetch_url for the full article. Key is a host secret
(`exa-api-key`, env `EXA_API_KEY` fallback), never repo-side; results
sanitized like every other external-text tool; off by default
(`enable-web-search`), metered per user.
- **D-019** — News memory + on-demand tool (SPEC-013 NEWS-07..12):
the news pipeline now carries item summaries (feed descriptions,
HTML-stripped) and persists every fetched item into a deduped `news`
table (schema v6), pruned to a rolling window (`news-keep`). Both the
kroa digest run and the ggg posting run write to it, so the store is
a single searchable source across both models. A `get_news` tool
reads that store (topic/source-filtered, metered, sanitized) rather
than re-fetching feeds live: the ambient `{news}` digest stays a
small always-on snapshot, while the tool gives unbounded on-demand
reach without a fresh network round-trip per call. The store is the
same `bot.db` (WAL) the bot uses; the cron process opens it
independently — concurrent reader/writer is what WAL is for.
- **D-018** — Codex Mechanicus search (FDB-019, SPEC-014): Luma's
lore is grounded in the priest's real archive at binaric.tech via a
`codex_search` tool over the site's public `search-index.json`, not
a bot-side copy — the index stays a single source of truth, refreshed
by the site's own publish rite, and the bot caches it in memory
(TTL). It reuses SPEC-011's `guard_url` + `read_capped` (fetch is
SSRF-guarded and byte-bounded) and sanitizes every returned field:
one's own web content is still untrusted by the time it reaches a
prompt. Luma-only (`enable-codex`, off elsewhere) — the Adeptus
Mechanicus archive has no place in Fjærkroa's café persona.
- **D-017** — All human-behavior knobs default to off/v3.0.0
semantics; behavior changes are config rollouts per deployment, not
code flips. The classifier's `factual` flag is the only coupling
+21 -8
View File
@@ -20,13 +20,6 @@ The bot now supports real-time video game information through IGDB (Internet Gam
- **Category**: Select appropriate category
3. Note down your **Client ID**
4. Generate a **Client Secret**
5. Get an access token using this curl command:
```bash
curl -X POST 'https://id.twitch.tv/oauth2/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials'
```
6. Save the `access_token` from the response
### 2. Configure the Bot
@@ -35,6 +28,25 @@ Update your `config.toml` file:
```toml
# IGDB Configuration for game information
igdb-client-id = "your_actual_client_id_here"
igdb-client-secret = "your_actual_client_secret_here"
enable-game-info = true
```
With the client secret configured, the bot fetches an app access token from
Twitch itself and refreshes it automatically before it expires (Twitch app
tokens live ~60 days) — no manual token handling needed.
Alternatively, a static token still works (legacy setup — it expires after
~60 days and then game lookups fail with 401 until you replace it):
```bash
curl -X POST 'https://id.twitch.tv/oauth2/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials'
```
```toml
igdb-client-id = "your_actual_client_id_here"
igdb-access-token = "your_actual_access_token_here"
enable-game-info = true
```
@@ -99,7 +111,8 @@ The integration provides two OpenAI functions:
- Verify client ID and access token are set
2. **Authentication errors**
- Regenerate access token (they expire)
- Prefer `igdb-client-secret` — the bot then refreshes tokens itself
- With a static `igdb-access-token`: regenerate it (they expire)
- Verify client ID matches your Twitch app
3. **No game results**
+3
View File
@@ -83,3 +83,6 @@ ci: install-dev all-checks ## Full CI pipeline (install deps and run all checks)
# Deploy targets (SPEC-007)
deploy: ## Deploy a tag to a host: make deploy HOST=ggg TAG=v3.0.0
bash deploy/deploy.sh $(HOST) $(TAG)
backup: ## Back up a local bot.db: make backup DB=history/bot.db DIR=backups
uv run python deploy/backup_db.py $(DB) $(DIR) $(or $(KEEP),14)
+34 -1
View File
@@ -14,7 +14,11 @@ system = "You are a smart AI assistant with access to real-time video game infor
# IGDB Configuration for game information
igdb-client-id = "YOUR_IGDB_CLIENT_ID"
igdb-access-token = "YOUR_IGDB_ACCESS_TOKEN"
# With the Twitch app client secret set, the bot fetches and refreshes the
# access token itself (recommended). A static igdb-access-token still works
# but expires after ~60 days.
igdb-client-secret = "YOUR_IGDB_CLIENT_SECRET"
# igdb-access-token = "YOUR_IGDB_ACCESS_TOKEN"
enable-game-info = true
# --- operator / safety (SPEC-003, SPEC-006) ---
@@ -59,3 +63,32 @@ enable-game-info = true
# image-cache-mb = 500 # LRU cap (ggg: consider 2000 — screenshots)
# image-cache-ttl-days = 90
# image-max-bytes = 8388608 # 8 MB upload cap
# Self-tasking (SPEC-005) — experimental, DEFAULT OFF:
# tasks-enabled = true
# tasks-generators = ["idle-impulse", "follow-up"]
# tasks-max-per-channel-per-day = 2
# tasks-approval = false # true: neue Tasks brauchen !bot task-approve
# idle-impulse-hours = 12
# taskgen-interval-hours = 6
# Staff: !bot tasks | task-approve <id> | task-cancel <id>
# URL reading (SPEC-011, FDB-018) — DEFAULT OFF; web pages are hostile input:
# enable-url-reading = true
# url-max-bytes = 2097152 # 2 MB fetch cap
# url-max-chars = 6000 # text handed to the model
# url-max-images = 2 # page images into the vision cache
# url-daily-per-user = 20
# Ops (SPEC-012): consecutive OpenAI failures before a staff alert
# api-error-alert-threshold = 5
# Backups: cron runs deploy/backup_db.py daily -> ~/backups/<bot>/ (keep 14)
# News digest (SPEC-013) — `python -m fjerkroa_bot.news --config X.toml` via cron;
# writes the {news} file. Feeds are [url, label] pairs (RSS or Atom):
# news = "news_feed.txt"
# news-per-feed = 3
# news-max-items = 15
# news-feeds = [
# ["https://blog.playstation.com/feed/", "PS"],
# ["https://kotaku.com/rss", "Kotaku"],
# ["https://www.pushsquare.com/feeds/latest", "Push"],
# ["https://mein-mmo.de/feed/", "MeinMMO"],
# ]
+80
View File
@@ -0,0 +1,80 @@
#!/usr/bin/env python3
"""Consistent, rotated bot.db backups (SPEC-012 OPS-13).
Run from cron on each host. Uses the sqlite3 online-backup API so the
snapshot is consistent even while the bot writes (WAL-safe), gzips it,
and keeps the newest N. Stdlib only.
Usage: python3 backup_db.py <bot.db> <backup-dir> [keep]
"""
import gzip
import os
import shutil
import sqlite3
import sys
import tempfile
import time
from pathlib import Path
DEFAULT_KEEP = 14
BACKUP_GLOB = "bot-*.db.gz"
def snapshot(src: Path, dest_gz: Path) -> None:
"""Write a consistent gzipped snapshot of src to dest_gz (OPS-13)."""
fd, tmp_path = tempfile.mkstemp(suffix=".db", dir=str(dest_gz.parent))
os.close(fd)
tmp = Path(tmp_path)
try:
source = sqlite3.connect(str(src))
try:
target = sqlite3.connect(str(tmp))
try:
source.backup(target) # atomic, WAL-safe online backup
finally:
target.close()
finally:
source.close()
with open(tmp, "rb") as raw, gzip.open(str(dest_gz), "wb") as gz:
shutil.copyfileobj(raw, gz)
os.chmod(dest_gz, 0o600) # conversation data
finally:
tmp.unlink(missing_ok=True)
def victims(existing: list, keep: int) -> list:
"""Given backup paths (any order), return the ones to delete, oldest first (OPS-14)."""
ordered = sorted(existing) # timestamped names sort chronologically
return ordered[: max(0, len(ordered) - keep)]
def rotate(backup_dir: Path, keep: int) -> int:
removed = 0
for path in victims(list(backup_dir.glob(BACKUP_GLOB)), keep):
Path(path).unlink(missing_ok=True)
removed += 1
return removed
def main() -> int:
if len(sys.argv) < 3:
print("usage: backup_db.py <bot.db> <backup-dir> [keep]", file=sys.stderr)
return 2
src = Path(sys.argv[1]).expanduser()
backup_dir = Path(sys.argv[2]).expanduser()
keep = int(sys.argv[3]) if len(sys.argv) > 3 else DEFAULT_KEEP
if not src.exists():
print(f"backup: source {src} missing", file=sys.stderr)
return 1
backup_dir.mkdir(parents=True, exist_ok=True)
stamp = time.strftime("%Y%m%d-%H%M%S", time.gmtime())
dest = backup_dir / f"bot-{stamp}.db.gz"
snapshot(src, dest)
removed = rotate(backup_dir, keep)
print(f"backup: wrote {dest.name} ({dest.stat().st_size} bytes), rotated {removed} old")
return 0
if __name__ == "__main__":
sys.exit(main())
+130
View File
@@ -0,0 +1,130 @@
# Operator runbook — Fjærkroa / Luma bot
One page for "something is wrong, what do I do". Two deployments of one
codebase, both on **uberspace** (push-based deploy from the dev machine —
there is no git checkout on the hosts).
| | Fjærkroa (café) | Luma (GGG clan) |
| --- | --- | --- |
| SSH host | `ssh fjerkroa` (pictor.uberspace.de) | `ssh ggg` |
| Service | `kroa` | `luma` |
| Config | `~/fjerkroa_bot/kroa.toml` | `~/fjerkroa_bot/ggg.toml` |
| Staff channel | `#kassa` | `#mods` |
| Language / persona | Norwegian, café host | German, "Luma" |
Common paths on each host: bot code `~/fjerkroa_bot`, venv `~/venv-bot`,
database `~/fjerkroa_bot/history/bot.db` (SQLite, WAL), our snapshots
`~/backups/<kroa|luma>/`, logs under `~/logs` and `~/tmp`.
## From Discord (staff channel only, prefix `!bot`)
No SSH needed for day-to-day control. Type `!bot help` in the staff
channel for the full, grouped list. The essentials:
- `!bot pause` / `!bot resume` — stop / start all replies.
- `!bot quiet <minutes>` — go silent for a while, then auto-resume.
- `!bot status` — replies/images/tasks flags + quiet time left.
- `!bot spend` — today's estimated USD spend, tokens, images, budget.
- `!bot images on|off`, `!bot tasks on|off` — kill-switches.
`!help` works in **any** channel (for everyone) and lists only what is
usable there. `!forgetme` and `!privacy` also work everywhere, even
while the bot is paused.
## Restart / check health (SSH)
```sh
ssh <host>
supervisorctl status <kroa|luma> # RUNNING + uptime
supervisorctl restart <kroa|luma>
tail -n 40 ~/tmp/<kroa|luma>-stderr*.log # discord login / errors
tail -n 40 ~/logs/supervisord.log # "We have logged in as ..."
```
A healthy start shows a fresh `connected to Gateway` + `We have logged
in as ...` line within ~15 s.
## Deploy a release / roll back
From the **dev machine** (`~/Repos/FjerkroaBot`), tags only:
```sh
git tag -m "<msg>" vX.Y.Z && git push --tags # cut the release first
bash deploy/deploy.sh ggg vX.Y.Z # luma
DEPLOY_FORCE=1 bash deploy/deploy.sh fjerkroa vX.Y.Z # kroa (see window)
```
- kroa refuses to deploy **11:0022:00 Europe/Oslo** (restaurant hours);
`DEPLOY_FORCE=1` overrides. Café is closed Mondays.
- The script backs up `bot.db``bot.db.pre-<tag>` before restart, then
smoke-tests (RUNNING + fresh login) and fails loudly if either misses.
- **Rollback** = deploy the previous tag. If the schema version moved
between the two tags, restore the matching `bot.db.pre-<newtag>` first
(see below) so the older code meets a schema it understands.
## Restore the database
Three independent daily backup layers exist — pick the freshest good one.
```sh
ssh <host>
supervisorctl stop <kroa|luma>
DB=~/fjerkroa_bot/history/bot.db
# 1) uberspace nightly backup of the whole home (read-only):
# /backup = current + daily.0..7 + weekly.1..7 (15 restore points)
cp /backup/daily.1/home/<user>/fjerkroa_bot/history/bot.db "$DB"
# 2) our own rotated gzip snapshot (03:17 UTC cron, keep 14):
gunzip -c ~/backups/<kroa|luma>/bot-YYYYMMDD-HHMMSS.db.gz > "$DB"
# 3) the pre-deploy snapshot for a given release:
cp "$DB".pre-vX.Y.Z "$DB"
rm -f "$DB"-wal "$DB"-shm # drop stale WAL sidecars after a restore
supervisorctl start <kroa|luma>
```
`<user>` is `fjerkroa` or `ggg`. The DB holds conversation history,
structured memory, usage ledger, image cache index, tasks, and the news
store — all regenerable, none critical. That is why there is no off-host
backup: uberspace `/backup` + the on-host snapshots are enough.
## Rotate a secret
Secrets live only in the host `*.toml` (never in the repo). Edit in
place and restart:
```sh
ssh <host>
# OpenAI: edit openai-token = "sk-..." in kroa.toml / ggg.toml
# Discord: edit discord-token = "..." (get a new token from the
# Discord developer portal → Bot → Reset Token first)
supervisorctl restart <kroa|luma>
```
After rotating an OpenAI key, revoke the old one in the OpenAI dashboard.
Keep a `*.toml` backup before editing; a broken TOML crash-loops the
service (validate: `~/venv-bot/bin/python -c 'import tomlkit; tomlkit.load(open("kroa.toml"))'`).
## Scheduled jobs (crontab -l)
| Host | When (server time) | Job |
| --- | --- | --- |
| both | `17 3 * * *` | `backup_db.py``~/backups/<bot>/` (keep 14) |
| kroa | `5 * * * *` | news digest → `{news}` file + news store |
| ggg | `*/15 * * * *` | news poster → #news/#newsjp webhooks + store |
Logs: `~/backups/<bot>/backup.log`, `~/backups/<bot>/news*.log`.
## Quick triage
- **Bot silent everywhere** → `!bot status` (paused/quiet?), else
`supervisorctl status`; if not RUNNING, `restart` and read stderr.
- **Bot silent in one channel** → check the host config `ignore-channels`
/ `short-path` rules for that channel (a stray `short-path` rule can
archive messages without replying).
- **Repeated API errors** → the bot posts a rate-limited alert to the
staff channel after 5 consecutive OpenAI failures (OPS-16); check
`!bot spend` (budget hit?) and the OpenAI status/key.
- **Bad deploy** → roll back to the previous tag (above).
+5 -1
View File
@@ -177,7 +177,11 @@ class AIResponder(AIResponderBase):
recent_images = self.image_cache.recent(message.channel, 4)
if recent_images:
# the model cannot use picture_edit unless told images exist (IMG-16)
context.append(f"recent images in this channel: {len(recent_images)} (set picture_edit=true to edit/remix the newest)")
context.append(
f"recent images in this channel: {len(recent_images)}. When the user asks to modify, reuse, combine or"
" include a previously shared image, you MUST set picture_edit=true — text-to-image cannot see earlier"
" images; only picture_edit passes them to the image model."
)
return context
def message(self, message: AIMessage, limit: Optional[int] = None) -> List[Dict[str, Any]]:
+147
View File
@@ -0,0 +1,147 @@
"""Codex Mechanicus search tool (SPEC-014, FDB-019).
Luma's own sacred archive — the Codex Mechanicus at binaric.tech — as a
function tool. He searches the codex index and answers Cult Mechanicus
lore from real, sourced inscriptions instead of inventing it. The index
is fetched over HTTPS (SSRF-guarded, size-bounded, cached in memory) and
every field returned to the model is sanitized (SAF-03), because even
one's own web content is still untrusted input by the time it reaches a
prompt.
The model calls `codex_search`; production wires the live index URL.
"""
import json
import logging
import time
from typing import Any, Callable, Dict, List, Optional
from urllib.parse import urljoin
import aiohttp
from .ai_responder import sanitize_external_text
from .httpread import read_capped
from .url_reader import guard_url
DEFAULT_INDEX_URL = "https://binaric.tech/search-index.json"
DEFAULT_MAX_BYTES = 4 * 1024 * 1024
DEFAULT_LIMIT = 5
DEFAULT_TTL_S = 3600
DEFAULT_SUMMARY_CHARS = 500
FETCH_TIMEOUT_S = 15
_VALID_LANGS = ("en", "de", "eo", "no", "uk")
CODEX_SEARCH_TOOL = {
"name": "codex_search",
"description": "Search Luma's own Codex Mechanicus (the sacred archive at binaric.tech) for Adeptus "
"Mechanicus lore: doctrines, forges, orders, rites, relics, weapons, entities, the lexicon, and the "
"priest's own adoptus. Returns matching inscriptions with a short summary and the URL to read the full "
"text. Use for any Cult Mechanicus / Warhammer 40k Mechanicus question so the answer is grounded in the "
"codex, not invented.",
"parameters": {
"type": "object",
"properties": {
"query": {"type": "string", "description": "What to look for: a name, concept, rite, or phrase."},
"lang": {"type": "string", "description": "Language of the inscriptions to prefer: en, de, eo, no, uk. Default en."},
},
"required": ["query"],
},
}
_STOP = {"the", "a", "an", "of", "and", "or", "to", "in", "is", "der", "die", "das", "und", "von", "en", "et"}
def _tokenize(text: str) -> List[str]:
cleaned = "".join(c.lower() if c.isalnum() else " " for c in text)
return [t for t in cleaned.split() if len(t) > 1 and t not in _STOP]
def _score(item: Dict[str, Any], terms: List[str]) -> int:
"""Weight a hit by field: title beats summary beats body (CDX-03)."""
title = str(item.get("title") or "").lower()
summary = str(item.get("summary") or "").lower()
body = str(item.get("body") or "").lower()
score = 0
for term in terms:
score += 8 if term in title else 0
score += 3 if term in summary else 0
score += 1 if term in body else 0
return score
def _rank(items: List[Dict[str, Any]], terms: List[str], lang: str) -> List[Dict[str, Any]]:
"""Score items in the given language; fall back to all languages if empty (CDX-04)."""
def scored(only_lang: Optional[str]) -> List[Any]:
out = []
for item in items:
if only_lang and f"/{only_lang}/" not in str(item.get("url") or ""):
continue
hit = _score(item, terms)
if hit > 0:
out.append((hit, item))
out.sort(key=lambda pair: pair[0], reverse=True)
return out
ranked = scored(lang) or scored(None)
return [item for _, item in ranked]
class CodexSearch:
def __init__(self, config_getter: Callable[[], Dict[str, Any]]) -> None:
self._config = config_getter
self._cache: Optional[List[Dict[str, Any]]] = None
self._fetched_at = 0.0
def enabled(self) -> bool:
return bool(self._config().get("enable-codex", False))
def _index_url(self) -> str:
return str(self._config().get("codex-index-url", DEFAULT_INDEX_URL))
async def _load_index(self) -> List[Dict[str, Any]]:
"""Fetch + cache the codex index, SSRF-guarded and size-bounded (CDX-02)."""
ttl = float(self._config().get("codex-cache-ttl", DEFAULT_TTL_S))
if self._cache is not None and (time.monotonic() - self._fetched_at) < ttl:
return self._cache
url = self._index_url()
reason = guard_url(url)
if reason:
raise ValueError(reason)
max_bytes = int(self._config().get("codex-max-bytes", DEFAULT_MAX_BYTES))
timeout = aiohttp.ClientTimeout(total=FETCH_TIMEOUT_S)
async with aiohttp.ClientSession(timeout=timeout, headers={"User-Agent": "FjerkroaBot-codex/1.0"}) as session:
async with session.get(url) as response:
response.raise_for_status()
raw = await read_capped(response, max_bytes)
data = json.loads(raw.decode("utf-8", "ignore"))
items = data.get("items", []) if isinstance(data, dict) else []
self._cache = [i for i in items if isinstance(i, dict)]
self._fetched_at = time.monotonic()
return self._cache
async def search(self, query: str, lang: str = "en", limit: int = DEFAULT_LIMIT) -> Dict[str, Any]:
"""Return sanitized top matches, or an error dict — never raise (CDX-05)."""
try:
items = await self._load_index()
except Exception as err:
logging.warning(f"codex: index load failed: {err!r}")
return {"error": f"codex unavailable: {err}"}
terms = _tokenize(query)
if not terms:
return {"query": query, "results": []}
pick = (lang or "en").lower()
if pick not in _VALID_LANGS:
pick = "en"
summary_chars = int(self._config().get("codex-summary-chars", DEFAULT_SUMMARY_CHARS))
results = []
for item in _rank(items, terms, pick)[: max(1, limit)]:
results.append(
{
"title": sanitize_external_text(str(item.get("title") or ""), 200),
"summary": sanitize_external_text(str(item.get("summary") or ""), summary_chars),
"collection": str(item.get("collection") or ""),
"url": urljoin(self._index_url(), str(item.get("url") or "")),
}
)
return {"query": query, "lang": pick, "results": results}
+148 -52
View File
@@ -1,12 +1,13 @@
import argparse
import asyncio
import logging
import math
import random
import re
import shutil
import sys
import time
from collections import deque
from pathlib import Path
from typing import Optional, Union
import discord
@@ -17,7 +18,9 @@ from watchdog.events import FileSystemEventHandler
from watchdog.observers import Observer
from .ai_responder import AIMessage
from .monitor import HealthMonitor
from .openai_responder import OpenAIResponder
from .tasks import TaskEngine
DEFAULT_PRIVACY_NOTICE = (
"I keep recent channel messages and a short conversation summary to answer better. "
@@ -89,6 +92,7 @@ class FjerkroaBot(commands.Bot):
self.tasks_enabled = True
self.quiet_until = 0.0
self._staff_alert_times: deque = deque()
self._consecutive_api_errors = 0 # OPS-16
self.init_observer()
self.init_aichannels()
@@ -114,38 +118,65 @@ class FjerkroaBot(commands.Bot):
self.staff_channel = self.channel_by_name(self.config["staff-channel"], no_ignore=True)
self.welcome_channel = self.channel_by_name(self.config["welcome-channel"], no_ignore=True)
def init_boreness(self):
if "chat-channel" not in self.config:
return
def init_tasks(self):
"""Task engine replaces the sigmoid boreness loop (TSK-07)."""
self.last_activity_time = time.monotonic()
self.loop.create_task(self.on_boreness())
logging.info("Boreness initialised.")
self.task_engine = TaskEngine(
store=self.airesponder.store,
ledger=self.airesponder.ledger,
config_getter=lambda: self.config,
execute=self._execute_task,
propose=self.airesponder.propose_task,
staff_alert=self.send_staff_alert,
allowed=self.bot_initiated_allowed,
idle_seconds=lambda: time.monotonic() - self.last_activity_time,
observe=self.airesponder.observe_event,
)
self.loop.create_task(self.task_loop())
# Proactive health monitoring -> staff alerts (OPS-18/19)
self.health_monitor = HealthMonitor(
config_getter=lambda: self.config,
ledger=self.airesponder.ledger,
store=self.airesponder.store,
disk_free_mb=self._disk_free_mb,
alert=self.send_staff_alert,
)
self.loop.create_task(self.monitor_loop())
logging.info("Task engine initialised.")
async def on_boreness(self):
logging.info(f"Boreness started on channel: {repr(self.chat_channel)}")
async def task_loop(self):
while True:
if self.chat_channel is None or not self.bot_initiated_allowed():
await asyncio.sleep(7)
continue
boreness_interval = float(self.config.get("boreness-interval", 12.0))
elapsed_time = (time.monotonic() - self.last_activity_time) / 3600.0
probability = 1 / (1 + math.exp(-1 * (elapsed_time - (boreness_interval / 2.0)) + math.log(1 / 0.2 - 1)))
if random.random() < probability:
prev_messages = [msg async for msg in self.chat_channel.history(limit=2)]
last_author = prev_messages[1].author.id if len(prev_messages) > 1 else None
if last_author and last_author != self.user.id:
logging.info(f"Borred with {probability} probability after {elapsed_time}")
boreness_prompt = self.config.get("boreness-prompt", "Pretend that you just now thought of something, be creative.")
message = AIMessage("system", boreness_prompt, self.config.get("chat-channel", "chat"), True, False)
try:
await self.respond(message, self.chat_channel)
except Exception as err:
logging.warning(f"Failed to activate borringness: {repr(err)}")
await asyncio.sleep(7)
await asyncio.sleep(60)
try:
await self.task_engine.tick()
except Exception as err:
logging.warning(f"task tick failed: {repr(err)}")
def _disk_free_mb(self) -> float:
directory = Path(self.config.get("history-directory", ".")).expanduser()
target = directory if directory.exists() else Path.home()
return shutil.disk_usage(target).free / (1024 * 1024)
async def monitor_loop(self):
while True:
await asyncio.sleep(int(self.config.get("monitor-interval", 300)))
if self.health_monitor.enabled():
try:
await self.health_monitor.tick()
except Exception as err:
logging.warning(f"monitor tick failed: {repr(err)}")
async def _execute_task(self, channel_name: str, prompt: str) -> None:
"""Run a due task through the normal responder path (TSK-02)."""
channel = self.channel_by_name(channel_name, getattr(self, "chat_channel", None), no_ignore=True)
if channel is None:
raise RuntimeError(f"task channel {channel_name!r} not resolvable")
message = AIMessage("system", prompt, channel_name, True, False)
await self.respond(message, channel)
async def on_ready(self):
self.init_channels()
self.init_boreness()
self.init_tasks()
logging.info(
f"We have logged in as {self.user}" f" ({repr(self.staff_channel)}, {repr(self.welcome_channel)}, {repr(self.chat_channel)})"
)
@@ -177,6 +208,9 @@ class FjerkroaBot(commands.Bot):
if content.startswith("!privacy"):
await message.channel.send(self.config.get("privacy-notice", DEFAULT_PRIVACY_NOTICE), suppress_embeds=True)
return
if content.startswith("!help"): # OPS-17: context-aware, works even while paused
await message.channel.send(self._help_text(staff=self.is_staff_channel(message.channel)), suppress_embeds=True)
return
if not self.replies_allowed():
return
if str(message.content).startswith("!wichtel"):
@@ -241,14 +275,52 @@ class FjerkroaBot(commands.Bot):
return "\n".join(f"{pin['id']} [{pin['channel'] or 'global'}]: {pin['fact']}" for pin in pins) or "No pins."
return None
def _task_command(self, args) -> Optional[str]:
"""Task queue surface (OPS-12, TSK-05)."""
is_list = args[:1] == ["tasks"] and len(args) == 1
if args[:1] not in (["task-approve"], ["task-cancel"]) and not is_list:
return None
store = self.airesponder.store
if store is None:
return "No store configured - task commands unavailable."
if is_list:
tasks = store.tasks_open()
return "\n".join(f"{t['id']} [{t['state']}] {t['kind']} #{t['channel']} due {t['due_at']}" for t in tasks) or "No open tasks."
if args[1:2] and args[1].isdigit():
if args[0] == "task-approve":
return f"Approved {store.task_set_state(int(args[1]), 'queued')} task(s)."
return f"Cancelled {store.task_set_state(int(args[1]), 'cancelled')} task(s)."
return None
def _help_text(self, staff: bool) -> str:
"""Context-aware command help (OPS-17): every channel lists the user commands; the staff channel also lists operator commands."""
everywhere = (
"Available to everyone, in any channel:\n"
"• `!help` — this help\n"
"• `!forgetme` — delete your messages and memory traces (works even while I'm paused)\n"
"• `!privacy` — how your data is handled (works even while I'm paused)\n"
"• `!wichtel @a @b @c …` — draw Secret Santa pairings (needs ≥2 mentions; only while I'm active)"
)
if not staff:
return everywhere
operator = (
"Staff commands — this channel only, prefixed `!bot`:\n"
"• Control: `pause`, `resume`, `quiet <minutes>`, `status`\n"
"• Cost: `spend`, `images on|off`\n"
"• Memory: `memory <user>`, `forget-fact <id>`, `pin <channel|global> <text>`, `unpin <id>`, `pins`\n"
"• Tasks: `tasks` (list), `tasks on|off`, `task-approve <id>`, `task-cancel <id>`"
)
return operator + "\n\n" + everywhere
async def handle_staff_command(self, message: Message) -> None:
"""Operator kill-switches, staff channel only (OPS-01..05, OPS-09, MEM-07)."""
"""Operator kill-switches, staff channel only (OPS-01..05, OPS-09, OPS-17, MEM-07)."""
args = str(message.content).split()[1:]
memory_reply = self._memory_command(args)
if memory_reply is not None:
await message.channel.send(memory_reply, suppress_embeds=True)
return
reply = "Commands: pause, resume, images on|off, tasks on|off, quiet <minutes>, status, spend, memory <user>, forget-fact <id>, pin <channel|global> <fact>, unpin <id>"
for handler in (self._memory_command, self._task_command):
reply = handler(args)
if reply is not None:
await message.channel.send(reply, suppress_embeds=True)
return
reply = self._help_text(staff=True) # OPS-17: unknown/`help` -> full grouped help
if args[:1] == ["pause"]:
self.replies_enabled = False
reply = "Replies paused."
@@ -401,35 +473,44 @@ class FjerkroaBot(commands.Bot):
def get_ai_responder(self, channel_name):
return self.aichannels[channel_name] if channel_name in self.aichannels else self.airesponder
async def _ingest_attachments(self, message, channel_name: str, airesponder) -> list:
"""Cache-first attachment handling; CDN URLs never travel further (IMG-10/11)."""
urls = []
for attachment in message.attachments:
if airesponder.image_cache is None:
urls.append(attachment.url)
continue
sha = await airesponder.image_cache.ingest_url(attachment.url, channel_name, message.author.name, str(message.id))
if sha is not None:
recent = airesponder.image_cache.recent(channel_name, 8)
ext = next((row["ext"] for row in recent if row["sha256"] == sha), "png")
data_url = airesponder.image_cache.data_url(sha, ext)
if data_url:
urls.append(data_url)
return urls
async def handle_message_through_responder(self, message):
"""Handle a message through the AI responder"""
message_content = str(message.content).strip()
if message.reference and message.reference.resolved and isinstance(message.reference.resolved.content, str):
reference_content = str(message.reference.resolved.content).replace("\n", "> \n")
message_content = f"> {reference_content}\n\n{message_content}"
channel_name = self.get_channel_name(message.channel)
airesponder = self.get_ai_responder(channel_name)
attachment_urls = []
if message.attachments:
attachment_urls = await self._ingest_attachments(message, channel_name, airesponder)
if len(message_content) < 1:
# image-only posts: cached + observed, no reply (IMG-17)
if attachment_urls:
await airesponder.observe_event(message.author.name, "image", f"posted {len(attachment_urls)} image(s)")
return
message_content = self._resolve_mentions(message_content)
channel_name = self.get_channel_name(message.channel)
msg = AIMessage(
message.author.name, message_content, channel_name, self.user in message.mentions or isinstance(message.channel, DMChannel)
)
airesponder = self.get_ai_responder(channel_name)
if message.attachments:
for attachment in message.attachments:
if not msg.urls:
msg.urls = []
if airesponder.image_cache is not None:
# cache-first: CDN URLs never travel further (IMG-10/11)
sha = await airesponder.image_cache.ingest_url(attachment.url, channel_name, message.author.name, str(message.id))
if sha is not None:
recent = airesponder.image_cache.recent(channel_name, 8)
ext = next((row["ext"] for row in recent if row["sha256"] == sha), "png")
data_url = airesponder.image_cache.data_url(sha, ext)
if data_url:
msg.urls.append(data_url)
else:
msg.urls.append(attachment.url)
if attachment_urls:
msg.urls = attachment_urls
# Reply/ignore classifier gate — direct messages bypass (BEH-01/02/03/07)
handled, factual = await self._classifier_gate(message, msg, airesponder, channel_name)
@@ -467,6 +548,14 @@ class FjerkroaBot(commands.Bot):
return True, False
return False, bool(verdict.get("factual", False))
async def _note_api_error(self, err: Exception) -> None:
"""Count consecutive failures; alert staff once at threshold (OPS-16)."""
self._consecutive_api_errors += 1
logging.warning(f"responder call failed ({self._consecutive_api_errors} in a row): {repr(err)}")
threshold = int(self.config.get("api-error-alert-threshold", 5))
if self._consecutive_api_errors == threshold:
await self.send_staff_alert(f"⚠️ {threshold} consecutive API errors — the bot may be down. Last: {str(err)[:200]}")
async def send_message_with_typing(self, airesponder, channel, message):
"""Send the user message to the AI responder with typing animation in discord"""
async with channel.typing():
@@ -572,8 +661,15 @@ class FjerkroaBot(commands.Bot):
# Get the AI responder based on the channel name
airesponder = self.get_ai_responder(channel_name)
# Send the user message to the AI responder, with typing indicators
response = await self.send_message_with_typing(airesponder, channel, message)
# Send the user message to the AI responder, with typing indicators.
# A raised call = a broken API path (cf. the gpt-5.6 tools incident):
# count it, alert staff at threshold, never crash the handler (OPS-16).
try:
response = await self.send_message_with_typing(airesponder, channel, message)
except Exception as err:
await self._note_api_error(err)
return
self._consecutive_api_errors = 0
# SAF/OPS gates between model proposal and delivery
await self._apply_response_gates(message, response)
+18
View File
@@ -0,0 +1,18 @@
"""Bounded HTTP body read (leaf module, no intra-package imports).
`response.content.read(n)` returns whatever is buffered, not n bytes,
so it silently truncates large or chunked bodies (and web feeds/pages
parse to garbage). This accumulates decompressed chunks up to a hard
cap instead.
"""
CHUNK = 65536
async def read_capped(response, max_bytes: int) -> bytes:
buf = bytearray()
async for chunk in response.content.iter_chunked(CHUNK):
buf.extend(chunk)
if len(buf) > max_bytes:
break
return bytes(buf[:max_bytes])
+50 -11
View File
@@ -1,30 +1,67 @@
import logging
import time
from functools import cache
from typing import Any, Dict, List, Optional
import requests
TWITCH_OAUTH_URL = "https://id.twitch.tv/oauth2/token"
# Refresh this long before Twitch expires the token (app tokens live ~60 days)
TOKEN_REFRESH_MARGIN = 86400
class IGDBQuery(object):
def __init__(self, client_id, igdb_api_key):
def __init__(self, client_id, igdb_api_key=None, client_secret=None):
self.client_id = client_id
self.igdb_api_key = igdb_api_key
self.client_secret = client_secret
# Unknown for statically configured tokens; set after each refresh
self._token_expires_at = None
def _refresh_token(self):
response = requests.post(
TWITCH_OAUTH_URL,
params={"client_id": self.client_id, "client_secret": self.client_secret, "grant_type": "client_credentials"},
)
response.raise_for_status()
data = response.json()
self.igdb_api_key = data["access_token"]
self._token_expires_at = time.time() + data.get("expires_in", 0) - TOKEN_REFRESH_MARGIN
logging.info("IGDB: refreshed Twitch app access token")
def _ensure_token(self):
if not self.client_secret:
return
if not self.igdb_api_key or (self._token_expires_at is not None and time.time() >= self._token_expires_at):
self._refresh_token()
def send_igdb_request(self, endpoint, query_body):
igdb_url = f"https://api.igdb.com/v4/{endpoint}"
headers = {"Client-ID": self.client_id, "Authorization": f"Bearer {self.igdb_api_key}"}
try:
response = requests.post(igdb_url, headers=headers, data=query_body)
self._ensure_token()
response = self._post_igdb(igdb_url, query_body)
if self.client_secret and response.status_code == 401:
# Token expired server-side (e.g. statically configured) — refresh and retry once
self._refresh_token()
response = self._post_igdb(igdb_url, query_body)
response.raise_for_status()
return response.json()
except requests.RequestException as e:
print(f"Error during IGDB API request: {e}")
return None
def _post_igdb(self, igdb_url, query_body):
headers = {"Client-ID": self.client_id, "Authorization": f"Bearer {self.igdb_api_key}"}
return requests.post(igdb_url, headers=headers, data=query_body)
@staticmethod
def build_query(fields, filters=None, limit=10, offset=None):
query = f"fields {','.join(fields) if fields is not None and len(fields) > 0 else '*'}; limit {limit};"
def build_query(fields, filters=None, limit=10, offset=None, search_term=None):
query = ""
if search_term:
escaped = search_term.replace("\\", "\\\\").replace('"', '\\"')
query += f'search "{escaped}"; '
query += f"fields {','.join(fields) if fields is not None and len(fields) > 0 else '*'}; limit {limit};"
if offset is not None:
query += f" offset {offset};"
if filters:
@@ -32,12 +69,12 @@ class IGDBQuery(object):
query += " where " + " & ".join(filter_statements) + ";"
return query
def generalized_igdb_query(self, params, endpoint, fields, additional_filters=None, limit=10, offset=None):
def generalized_igdb_query(self, params, endpoint, fields, additional_filters=None, limit=10, offset=None, search_term=None):
all_filters = {key: f'~ "{value}"*' for key, value in params.items() if value}
if additional_filters:
all_filters.update(additional_filters)
query = self.build_query(fields, all_filters, limit, offset)
query = self.build_query(fields, all_filters, limit, offset, search_term)
data = self.send_igdb_request(endpoint, query)
print(f"{endpoint}: {query} -> {data}")
return data
@@ -79,7 +116,7 @@ class IGDBQuery(object):
"id",
"name",
"alternative_names",
"category",
"game_type",
"release_dates",
"franchise",
"language_supports",
@@ -101,9 +138,10 @@ class IGDBQuery(object):
return None
try:
# Search for games with fuzzy matching
# IGDB native full-text search: diacritic- and word-order-insensitive,
# unlike a `name ~ "..."*` prefix filter
games = self.generalized_igdb_query(
{"name": query.strip()},
{},
"games",
[
"id",
@@ -120,8 +158,9 @@ class IGDBQuery(object):
"themes.name",
"cover.url",
],
additional_filters={"category": "= 0"}, # Main games only
additional_filters={"game_type": "= 0"}, # Main games only (IGDB renamed category -> game_type)
limit=limit,
search_term=query.strip(),
)
if not games:
+4 -1
View File
@@ -14,6 +14,7 @@ from typing import Any, Callable, Dict, List, Optional
import aiohttp
from .httpread import read_capped
from .persistence import PersistentStore
DEFAULT_CACHE_MB = 500
@@ -79,7 +80,9 @@ class ImageCache:
async with aiohttp.ClientSession(timeout=timeout) as session:
async with session.get(url) as response:
response.raise_for_status()
return await response.content.read(limit + 1)
# limit + 1: an over-limit body must stay over-limit so
# ingest_bytes rejects it instead of caching it truncated
return await read_capped(response, limit + 1)
def data_url(self, sha256: str, ext: str) -> Optional[str]:
path = self._path(sha256, ext)
+82
View File
@@ -0,0 +1,82 @@
"""Proactive health monitoring -> staff alerts (SPEC-012, FDB-012).
A periodic check that watches daily spend against the budget, free disk,
and task-queue depth, and posts a staff alert when a threshold is crossed
once per crossing, re-arming when the metric recovers, so a persistent
condition never spams. Opt-in per deployment (`enable-monitoring`); it
reuses the rate-limited staff-alert channel (OPS-07).
"""
import logging
from typing import Any, Callable, Dict, Optional, Tuple
# A check returns (metric-name, is-over-threshold, alert-message) or None when not applicable.
Check = Optional[Tuple[str, bool, str]]
class HealthMonitor:
def __init__(
self,
config_getter: Callable[[], Dict[str, Any]],
ledger: Any,
store: Any,
disk_free_mb: Callable[[], float],
alert: Callable[[str], Any],
) -> None:
self._config = config_getter
self._ledger = ledger
self._store = store
self._disk_free_mb = disk_free_mb
self._alert = alert
self._armed: Dict[str, bool] = {}
def enabled(self) -> bool:
return bool(self._config().get("enable-monitoring", False))
def _check_spend(self) -> Check:
config = self._config()
if "daily-budget-usd" not in config:
return None
budget = float(config["daily-budget-usd"])
if budget <= 0:
return None
spent = float(self._ledger.spent_usd())
frac = spent / budget
threshold = float(config.get("monitor-spend-alert-frac", 0.8))
return ("spend", frac >= threshold, f"💸 Spend at ${spent:.2f} of ${budget:.2f} today ({frac:.0%}, alert ≥ {threshold:.0%}).")
def _check_disk(self) -> Check:
try:
free = float(self._disk_free_mb())
except Exception as err:
logging.debug(f"monitor: disk check failed: {err!r}")
return None
min_mb = float(self._config().get("monitor-disk-min-mb", 500))
return ("disk", free < min_mb, f"💾 Low disk: {free:.0f} MB free (alert < {min_mb:.0f} MB).")
def _check_queue(self) -> Check:
if self._store is None:
return None
try:
depth = len(self._store.tasks_open())
except Exception as err:
logging.debug(f"monitor: queue check failed: {err!r}")
return None
limit = int(self._config().get("monitor-taskqueue-max", 20))
return ("task-queue", depth >= limit, f"🗒️ Task queue deep: {depth} open (alert ≥ {limit}).")
async def tick(self) -> None:
"""Evaluate every check; alert on a rising edge only (OPS-18/19)."""
for check in (self._check_spend(), self._check_disk(), self._check_queue()):
if check is None:
continue
metric, over, message = check
await self._fire(metric, over, message)
async def _fire(self, metric: str, over: bool, message: str) -> None:
was_over = self._armed.get(metric, False)
if over and not was_over:
self._armed[metric] = True
await self._alert(message)
elif not over and was_over:
self._armed[metric] = False # recovered — re-arm silently for the next crossing
+399
View File
@@ -0,0 +1,399 @@
"""News digest fetcher (SPEC-013, FDB-012 news rewrite).
Replaces the broken pre-1.0-openai `news_feed.py`. Fetches configured
RSS/Atom feeds (stdlib, no feedparser dep), builds a compact sanitized
headline digest, and writes it to the `{news}` file the responder
injects (AIResponder.message). Feeds are external input: titles are
sanitized (SAF-03) and each feed URL is SSRF-guarded before fetching.
CLI: python -m fjerkroa_bot.news --config kroa.toml
"""
import argparse
import logging
import re
import sys
import time
from html import unescape
from typing import Any, Dict, List, Optional, Tuple
import defusedxml.ElementTree as ElementTree # hardened XML: feeds are untrusted (XXE/billion-laughs)
from .ai_responder import sanitize_external_text
DEFAULT_PER_FEED = 3
DEFAULT_MAX_ITEMS = 15
DEFAULT_SUMMARY_CHARS = 200
DEFAULT_NEWS_KEEP = 400
FETCH_TIMEOUT_S = 15
_ATOM = "{http://www.w3.org/2005/Atom}"
_RSS1 = "{http://purl.org/rss/1.0/}" # RSS 1.0 / RDF (e.g. 4gamer.net) namespaces <item>/<title>/<link>
_TAG_RE = re.compile(r"<[^>]+>")
def _clean_summary(raw: str, max_len: int = 300) -> str:
"""Strip HTML, unescape entities, collapse whitespace (feed descriptions are often HTML)."""
text = unescape(_TAG_RE.sub(" ", raw or ""))
return re.sub(r"\s+", " ", text).strip()[:max_len]
def _rss_items(root: Any, ns: str, source: str) -> List[Dict[str, str]]:
"""RSS 2.0 (ns='') and RSS 1.0/RDF (ns=_RSS1) both use <item><title><link><description>."""
out: List[Dict[str, str]] = []
for item in root.iter(f"{ns}item"):
title = (item.findtext(f"{ns}title") or "").strip()
link = (item.findtext(f"{ns}link") or "").strip()
summary = _clean_summary(item.findtext(f"{ns}description") or "")
if title:
out.append({"title": title, "link": link, "source": source, "summary": summary})
return out
def parse_feed(data: bytes, source: str = "") -> List[Dict[str, str]]:
"""Parse RSS 2.0, RSS 1.0/RDF, or Atom bytes into [{title, link, source, summary}] (tolerant)."""
try:
root = ElementTree.fromstring(data)
except Exception as err:
# malformed XML or a blocked entity/DTD attack — tolerate, never raise (NEWS-01)
logging.warning(f"news: unparseable/unsafe feed {source!r}: {err!r}")
return []
# RSS 2.0 (unqualified) + RSS 1.0/RDF (namespaced, e.g. 4gamer) share <item><title><link><description>
items: List[Dict[str, str]] = _rss_items(root, "", source) + _rss_items(root, _RSS1, source)
# Atom: <feed><entry><title/><link href=/><summary|content/>
for entry in root.iter(f"{_ATOM}entry"):
title = (entry.findtext(f"{_ATOM}title") or "").strip()
link_el = entry.find(f"{_ATOM}link")
link = link_el.get("href", "") if link_el is not None else ""
summary = _clean_summary(entry.findtext(f"{_ATOM}summary") or entry.findtext(f"{_ATOM}content") or "")
if title:
items.append({"title": title, "link": link, "source": source, "summary": summary})
return items
def render_digest(items: List[Dict[str, str]], max_items: int = DEFAULT_MAX_ITEMS, summary_chars: int = DEFAULT_SUMMARY_CHARS) -> str:
"""Compact sanitized digest for the {news} prompt slot (title + short summary + link)."""
lines = []
for item in items[:max_items]:
title = sanitize_external_text(item["title"], 200)
source = item.get("source", "")
link = item.get("link", "")
summary = sanitize_external_text(item.get("summary", ""), summary_chars) if summary_chars else ""
prefix = f"[{source}] " if source else ""
line = f"- {prefix}{title}"
if summary:
line += f"{summary}"
if link:
line += f" ({link})"
lines.append(line)
return "\n".join(lines)
class NewsFetcher:
def __init__(self, guard, fetch_bytes) -> None:
# injected so tests need no network; production wires aiohttp + guard_url
self._guard = guard
self._fetch_bytes = fetch_bytes
async def collect(self, feeds: List[Tuple[str, str]], per_feed: int) -> List[Dict[str, str]]:
"""feeds = [(url, label)]; returns deduped items, order preserved."""
seen = set()
out: List[Dict[str, str]] = []
for url, label in feeds:
reason = self._guard(url)
if reason:
logging.warning(f"news: skipping feed {label}{reason}")
continue
try:
data = await self._fetch_bytes(url)
except Exception as err:
logging.warning(f"news: fetch failed for {label}: {repr(err)}")
continue
for item in parse_feed(data, label)[:per_feed]:
key = item["title"]
if key not in seen:
seen.add(key)
out.append(item)
return out
DEFAULT_SEEN_CAP = 5000
DEFAULT_POST_PER_FEED = 5
DEFAULT_POST_MAX_PER_RUN = 8
def item_key(item: Dict[str, str]) -> str:
return item.get("link") or item.get("title") or ""
class NewsPoster:
"""Post NEW feed items to Discord channel webhooks (ggg model, SPEC-013 NEWS-04..06)."""
def __init__(self, guard, fetch_bytes, post_webhook, store: Any = None) -> None:
self._guard = guard
self._fetch_bytes = fetch_bytes
self._post_webhook = post_webhook
self._store = store
async def run_post(
self,
feeds: List[Tuple[str, str, str]],
webhooks: Dict[str, str],
seen: set,
per_feed: int,
max_per_run: int,
seed_only: bool,
keep: int = DEFAULT_NEWS_KEEP,
) -> Tuple[int, set]:
"""Returns (posted_count, updated_seen). seed_only marks new items seen without posting."""
posted = 0
harvested: List[Dict[str, str]] = []
for url, label, channel in feeds:
reason = self._guard(url)
if reason:
logging.warning(f"news-post: skipping feed {label}{reason}")
continue
try:
data = await self._fetch_bytes(url)
except Exception as err:
logging.warning(f"news-post: fetch failed for {label}: {repr(err)}")
continue
for item in parse_feed(data, label)[:per_feed]:
harvested.append(item) # NEWS-09: everything parsed feeds the searchable store
key = item_key(item)
if not key or key in seen:
continue
seen.add(key)
may_post = not seed_only and posted < max_per_run
if may_post and await self._deliver(item, label, channel, webhooks):
posted += 1
if self._store is not None and harvested:
self._store.add_news_items(harvested)
self._store.prune_news(keep)
return posted, seen
async def _deliver(self, item: Dict[str, str], label: str, channel: str, webhooks: Dict[str, str]) -> bool:
hook = webhooks.get(channel)
if not hook:
logging.warning(f"news-post: no webhook for channel {channel!r} ({label})")
return False
title = sanitize_external_text(item["title"], 300)
link = item.get("link", "")
content = f"**[{label}]** {title}" + (f"\n{link}" if link else "")
try:
await self._post_webhook(hook, content)
return True
except Exception as err:
logging.warning(f"news-post: webhook post failed ({label}): {repr(err)}")
return False
# --- news memory + on-demand retrieval tool (SPEC-013 NEWS-09..12) ---
GET_NEWS_TOOL = {
"name": "get_news",
"description": "Fetch news the bot has collected from its RSS feeds — this is the SAME news that gets posted in the "
"server's news channels (e.g. #news, #newsjp / ニュース). Use this FIRST, before web_search, for anything about "
"current news or about something someone saw in a news channel; filter by topic (a keyword, also matches the source "
"label) or by source. Returns headlines with a short summary and a link; follow up with fetch_url for the full text.",
"parameters": {
"type": "object",
"properties": {
"topic": {"type": "string", "description": "Optional keywords to filter by, e.g. 'Nordland', 'football', 'weather'."},
"source": {"type": "string", "description": "Optional source label, e.g. 'NRK', 'Aftenposten', 'Verden', 'Sport'."},
"limit": {"type": "integer", "description": "How many items to return (default 10, max 30)."},
},
"required": [],
},
}
def _news_terms(topic: Optional[str]) -> List[str]:
return [t for t in re.split(r"\W+", (topic or "").lower()) if len(t) > 1][:5]
def query_news(
store: Any, topic: Optional[str] = None, source: Optional[str] = None, limit: int = 10, summary_chars: int = DEFAULT_SUMMARY_CHARS
) -> Dict[str, Any]:
"""Retrieve stored news for the get_news tool: term/source-filtered, sanitized (NEWS-11)."""
if store is None:
return {"error": "news store unavailable"}
limit = max(1, min(int(limit or 10), 30))
src = (str(source).strip() or None) if source else None
terms = _news_terms(topic)
try:
rows = store.search_news(terms, limit, src) if terms else store.recent_news(limit, src)
except Exception as err:
logging.warning(f"news: query failed: {err!r}")
return {"error": "news lookup failed"}
results = [
{
"source": row.get("source", ""),
"title": sanitize_external_text(row.get("title", ""), 200),
"summary": sanitize_external_text(row.get("summary", ""), summary_chars),
"link": row.get("link", ""),
}
for row in rows
]
return {"topic": topic or "", "source": src or "", "results": results}
def _open_store(config: Dict[str, Any]) -> Any:
directory = config.get("history-directory")
if not directory:
return None
from pathlib import Path
from .persistence import PersistentStore
return PersistentStore(Path(str(directory)).expanduser() / "bot.db")
def persist_news(config: Dict[str, Any], items: List[Dict[str, str]]) -> int:
"""Upsert fetched items into the news store, prune to the rolling window (NEWS-09)."""
store = _open_store(config)
if store is None or not items:
return 0
added = store.add_news_items(items)
store.prune_news(int(config.get("news-keep", DEFAULT_NEWS_KEEP)))
return added
def load_seen(path: str) -> Tuple[set, bool]:
"""(seen-set, existed). Missing/broken state -> empty set, existed=False (seed run)."""
import json
import os
if not os.path.exists(path):
return set(), False
try:
with open(path, encoding="utf-8") as fd:
return set(json.load(fd)), True
except Exception as err:
logging.warning(f"news-post: unreadable state {path}: {err!r} — reseeding")
return set(), False
def save_seen(path: str, seen: set, cap: int = DEFAULT_SEEN_CAP) -> None:
import json
# keep the newest `cap` keys (insertion order preserved by Python sets? no — use a bounded slice)
keys = list(seen)[-cap:]
with open(path, "w", encoding="utf-8") as fd:
json.dump(keys, fd)
def _post_feeds_from_config(config: Dict[str, Any]) -> List[Tuple[str, str, str]]:
feeds = []
for entry in config.get("news-post-feeds", []):
if isinstance(entry, (list, tuple)) and len(entry) >= 3:
feeds.append((str(entry[0]), str(entry[1]), str(entry[2])))
return feeds
def _feeds_from_config(config: Dict[str, Any]) -> List[Tuple[str, str]]:
"""news-feeds = [["url", "label"], ...] or ["url", ...]."""
feeds = []
for entry in config.get("news-feeds", []):
if isinstance(entry, (list, tuple)):
feeds.append((str(entry[0]), str(entry[1]) if len(entry) > 1 else ""))
else:
feeds.append((str(entry), ""))
return feeds
async def _aiohttp_fetch(url: str) -> bytes:
import aiohttp
from .httpread import read_capped
timeout = aiohttp.ClientTimeout(total=FETCH_TIMEOUT_S)
async with aiohttp.ClientSession(timeout=timeout, headers={"User-Agent": "Mozilla/5.0 (compatible; FjerkroaBot-news/1.0)"}) as session:
async with session.get(url) as response:
response.raise_for_status()
return await read_capped(response, 4 * 1024 * 1024)
async def _aiohttp_post(hook: str, content: str) -> None:
import aiohttp
timeout = aiohttp.ClientTimeout(total=FETCH_TIMEOUT_S)
async with aiohttp.ClientSession(timeout=timeout) as session:
# allowed_mentions none: a headline can never ping the channel (SAF-02 spirit)
payload = {"content": content[:2000], "allowed_mentions": {"parse": []}}
async with session.post(hook, json=payload) as response:
response.raise_for_status()
async def run_post(config: Dict[str, Any]) -> int:
"""Webhook-posting mode (ggg): post new items to channels. Returns posted count."""
from .url_reader import guard_url
webhooks = dict(config.get("news-post-webhooks", {}))
feeds = _post_feeds_from_config(config)
state_path = config.get("news-post-state", "news_state.json")
if not webhooks or not feeds:
logging.error("news-post: need news-post-webhooks and news-post-feeds")
return 0
seen, existed = load_seen(state_path)
poster = NewsPoster(guard_url, _aiohttp_fetch, _aiohttp_post, store=_open_store(config))
posted, seen = await poster.run_post(
feeds,
webhooks,
seen,
int(config.get("news-post-per-feed", DEFAULT_POST_PER_FEED)),
int(config.get("news-post-max-per-run", DEFAULT_POST_MAX_PER_RUN)),
seed_only=not existed, # first run seeds without flooding the channels
keep=int(config.get("news-keep", DEFAULT_NEWS_KEEP)),
)
save_seen(state_path, seen, int(config.get("news-post-seen-cap", DEFAULT_SEEN_CAP)))
logging.info(f"news-post: posted {posted} item(s)" + (" (seed run — nothing posted)" if not existed else ""))
return posted
async def run(config: Dict[str, Any]) -> Optional[str]:
from .url_reader import guard_url
out_path = config.get("news")
if not out_path:
logging.error("news: no `news` output path in config")
return None
feeds = _feeds_from_config(config)
if not feeds:
logging.error("news: no `news-feeds` configured")
return None
fetcher = NewsFetcher(guard_url, _aiohttp_fetch)
items = await fetcher.collect(feeds, int(config.get("news-per-feed", DEFAULT_PER_FEED)))
persist_news(config, items) # NEWS-09: feed the searchable rolling store for get_news
digest = render_digest(
items, int(config.get("news-max-items", DEFAULT_MAX_ITEMS)), int(config.get("news-summary-chars", DEFAULT_SUMMARY_CHARS))
)
header = f"News as of {time.strftime('%Y-%m-%d %H:%M UTC', time.gmtime())}:\n"
with open(out_path, "w", encoding="utf-8") as fd:
fd.write(header + digest + "\n")
logging.info(f"news: wrote {len(items)} items to {out_path}")
return out_path
def main() -> int:
import asyncio
import tomlkit
logging.basicConfig(level=logging.INFO, format="%(asctime)s [%(levelname)s] %(message)s")
parser = argparse.ArgumentParser(
description="Fetch RSS/Atom feeds: --post to channel webhooks (ggg) or default {news} digest file (kroa)"
)
parser.add_argument("--config", required=True)
parser.add_argument("--post", action="store_true", help="webhook-posting mode (post new items to Discord channels)")
args = parser.parse_args()
with open(args.config, encoding="utf-8") as fd:
config = tomlkit.load(fd)
if args.post:
asyncio.run(run_post(config))
return 0
result = asyncio.run(run(config))
return 0 if result else 1
if __name__ == "__main__":
sys.exit(main())
+134 -31
View File
@@ -9,9 +9,16 @@ from typing import Any, Dict, List, Optional, Tuple
import openai
from .ai_responder import AIResponder, exponential_backoff, sanitize_external_text
from .codex import CODEX_SEARCH_TOOL
from .codex import DEFAULT_LIMIT as CODEX_DEFAULT_LIMIT
from .codex import CodexSearch
from .igdblib import IGDBQuery
from .leonardo_draw import LeonardoAIDrawMixIn
from .news import GET_NEWS_TOOL, query_news
from .quota import QuotaLedger
from .url_reader import FETCH_URL_TOOL, URLReader
from .websearch import DEFAULT_RESULTS as WEB_DEFAULT_RESULTS
from .websearch import WEB_SEARCH_TOOL, WebSearch
# The response envelope, enforced server-side via structured outputs
# (ENV-19). All fields required, closed object, nullable where the
@@ -58,6 +65,31 @@ CONSOLIDATION_RESPONSE_FORMAT = {
"type": "json_schema",
"json_schema": {"name": "consolidation", "strict": True, "schema": CONSOLIDATION_SCHEMA},
}
# Follow-up task proposal (SPEC-005 TSK-08): one task or null
TASKGEN_SCHEMA = {
"type": "object",
"properties": {
"task": {
"type": ["object", "null"],
"properties": {
"channel": {"type": ["string", "null"], "description": "Target channel, or null for the main chat channel."},
"prompt": {"type": "string", "description": "Instruction the assistant will act on when the task runs."},
"due_hours": {"type": "number", "description": "Hours from now until the task should run (0 = now)."},
},
"required": ["channel", "prompt", "due_hours"],
"additionalProperties": False,
}
},
"required": ["task"],
"additionalProperties": False,
}
TASKGEN_RESPONSE_FORMAT = {"type": "json_schema", "json_schema": {"name": "task_proposal", "strict": True, "schema": TASKGEN_SCHEMA}}
TASKGEN_SYSTEM = (
"You plan the self-initiated actions of a Discord assistant. Given recent conversation summaries, propose AT MOST ONE follow-up"
" worth doing on the assistant's own initiative (ask how something announced went, revisit an open question, congratulate on an"
" event). Only propose something genuinely worthwhile — when in doubt, return a null task."
)
# Reply/ignore + factual pre-pass (SPEC-010 BEH-01): one cheap call
CLASSIFIER_SCHEMA = {
"type": "object",
@@ -111,16 +143,20 @@ class OpenAIResponder(AIResponder, LeonardoAIDrawMixIn):
# Initialize IGDB if enabled
self.igdb = None
igdb_client_id = self.config.get("igdb-client-id")
igdb_client_secret = self.config.get("igdb-client-secret")
igdb_access_token = self.config.get("igdb-access-token")
logging.info("IGDB Configuration Check:")
logging.info(f" enable-game-info: {self.config.get('enable-game-info', 'NOT SET')}")
logging.info(f" igdb-client-id: {'SET' if self.config.get('igdb-client-id') else 'NOT SET'}")
logging.info(f" igdb-access-token: {'SET' if self.config.get('igdb-access-token') else 'NOT SET'}")
logging.info(f" igdb-client-id: {'SET' if igdb_client_id else 'NOT SET'}")
logging.info(f" igdb-client-secret: {'SET' if igdb_client_secret else 'NOT SET'}")
logging.info(f" igdb-access-token: {'SET' if igdb_access_token else 'NOT SET'}")
if self.config.get("enable-game-info", False) and self.config.get("igdb-client-id") and self.config.get("igdb-access-token"):
if self.config.get("enable-game-info", False) and igdb_client_id and (igdb_client_secret or igdb_access_token):
try:
self.igdb = IGDBQuery(self.config["igdb-client-id"], self.config["igdb-access-token"])
self.igdb = IGDBQuery(igdb_client_id, igdb_access_token, client_secret=igdb_client_secret)
logging.info("✅ IGDB integration SUCCESSFULLY enabled for game information")
logging.info(f" Client ID: {self.config['igdb-client-id'][:8]}...")
logging.info(f" Client ID: {igdb_client_id[:8]}...")
logging.info(f" Available functions: {len(self.igdb.get_openai_functions())}")
except Exception as e:
logging.error(f"❌ Failed to initialize IGDB: {e}")
@@ -128,6 +164,63 @@ class OpenAIResponder(AIResponder, LeonardoAIDrawMixIn):
else:
logging.warning("❌ IGDB integration DISABLED - missing configuration or disabled in config")
# URL reading tool (SPEC-011); shares the image cache for page images
self.url_reader = URLReader(lambda: self.config, self.image_cache)
# Codex Mechanicus search (SPEC-014); Luma's own archive at binaric.tech
self.codex = CodexSearch(lambda: self.config)
# Web search (SPEC-015) via Exa; general "look it up" beyond fetch_url/news/codex
self.web_search = WebSearch(lambda: self.config)
def _available_tools(self) -> List[Dict[str, Any]]:
"""Assemble the function-tool list from every enabled provider (URL-01)."""
functions: List[Dict[str, Any]] = []
if self.igdb and self.config.get("enable-game-info", False):
try:
igdb_functions = self.igdb.get_openai_functions()
if isinstance(igdb_functions, list):
functions.extend(igdb_functions)
except (TypeError, AttributeError) as err:
logging.warning(f"Error setting up IGDB functions: {err}")
if self.url_reader.enabled():
functions.append(FETCH_URL_TOOL)
if self.codex.enabled(): # CDX-01
functions.append(CODEX_SEARCH_TOOL)
if self.config.get("enable-news-tool", False) and self.store is not None: # NEWS-10
functions.append(GET_NEWS_TOOL)
if self.web_search.enabled(): # WEB-01
functions.append(WEB_SEARCH_TOOL)
return functions
async def _dispatch_tool(self, name: str, args: Dict[str, Any], author: str) -> Any:
"""Route a tool call to its provider (IGDB, URL reader, or codex)."""
if name == "fetch_url":
per_user_cap = int(self.config.get("url-daily-per-user", 20))
if self.ledger._get(f"url-fetch:{author}") >= per_user_cap: # URL-07
return {"error": "daily URL fetch limit reached"}
self.ledger._add(f"url-fetch:{author}", 1)
return await self.url_reader.fetch(str(args.get("url", "")), self.channel, author or "user")
if name == "codex_search":
per_user_cap = int(self.config.get("codex-daily-per-user", 50))
if self.ledger._get(f"codex:{author}") >= per_user_cap: # CDX-06
return {"error": "daily codex search limit reached"}
self.ledger._add(f"codex:{author}", 1)
limit = int(self.config.get("codex-limit", CODEX_DEFAULT_LIMIT))
return await self.codex.search(str(args.get("query", "")), str(args.get("lang", "en")), limit)
if name == "get_news":
per_user_cap = int(self.config.get("news-daily-per-user", 30))
if self.ledger._get(f"news:{author}") >= per_user_cap: # NEWS-12
return {"error": "daily news lookup limit reached"}
self.ledger._add(f"news:{author}", 1)
summary_chars = int(self.config.get("news-summary-chars", 200))
return query_news(self.store, args.get("topic"), args.get("source"), args.get("limit", 10), summary_chars)
if name == "web_search":
per_user_cap = int(self.config.get("web-daily-per-user", 30))
if self.ledger._get(f"web:{author}") >= per_user_cap: # WEB-05
return {"error": "daily web search limit reached"}
self.ledger._add(f"web:{author}", 1)
return await self.web_search.search(str(args.get("query", "")), int(args.get("num_results", WEB_DEFAULT_RESULTS)))
return await self._execute_igdb_function(name, args)
async def draw_openai(self, description: str, count: int = 1) -> List[BytesIO]:
if not self.ledger.budget_ok():
raise RuntimeError("daily budget exhausted - refusing image call")
@@ -216,24 +309,13 @@ class OpenAIResponder(AIResponder, LeonardoAIDrawMixIn):
# hashed, never the raw Discord name (SAF-10)
chat_kwargs["safety_identifier"] = "discord-" + hashlib.sha256(author.encode()).hexdigest()[:16]
if self.igdb and self.config.get("enable-game-info", False):
try:
igdb_functions = self.igdb.get_openai_functions()
if igdb_functions and isinstance(igdb_functions, list):
chat_kwargs["tools"] = [{"type": "function", "function": func} for func in igdb_functions]
chat_kwargs["tool_choice"] = "auto"
# gpt-5.6 rejects tools + reasoning on chat/completions (ENV-21)
chat_kwargs["reasoning_effort"] = self.config.get("reasoning-effort", "none")
logging.info(f"🎮 IGDB functions available to AI: {[f['name'] for f in igdb_functions]}")
logging.debug(f" Full chat_kwargs with tools: {list(chat_kwargs.keys())}")
except (TypeError, AttributeError) as e:
logging.warning(f"Error setting up IGDB functions: {e}")
else:
logging.debug(
"🎮 IGDB not available for this request (igdb={}, enabled={})".format(
self.igdb is not None, self.config.get("enable-game-info", False)
)
)
available_tools = self._available_tools()
if available_tools:
chat_kwargs["tools"] = [{"type": "function", "function": func} for func in available_tools]
chat_kwargs["tool_choice"] = "auto"
# gpt-5.6 rejects tools + reasoning on chat/completions (ENV-21)
chat_kwargs["reasoning_effort"] = self.config.get("reasoning-effort", "none")
logging.info(f"🔧 Tools available to AI: {[func['name'] for func in available_tools]}")
result = await openai_chat(self.client, **chat_kwargs)
self._record_usage(result)
@@ -253,10 +335,8 @@ class OpenAIResponder(AIResponder, LeonardoAIDrawMixIn):
tool_names = [tc.function.name for tc in message.tool_calls]
logging.info(f"🔧 OpenAI requested function calls: {tool_names}")
# Check if we have function/tool calls and IGDB is enabled
has_tool_calls = (
hasattr(message, "tool_calls") and message.tool_calls and self.igdb and self.config.get("enable-game-info", False)
)
# Any offered tool may have been called (IGDB or fetch_url)
has_tool_calls = bool(hasattr(message, "tool_calls") and message.tool_calls and available_tools)
# Clean up any existing tool messages in the history to avoid conflicts
if has_tool_calls:
@@ -279,12 +359,12 @@ class OpenAIResponder(AIResponder, LeonardoAIDrawMixIn):
function_name = tool_call.function.name
function_args = json.loads(tool_call.function.arguments)
logging.info(f"🎮 Executing IGDB function: {function_name} with args: {function_args}")
logging.info(f"🔧 Executing tool: {function_name} with args: {function_args}")
# Execute IGDB function
function_result = await self._execute_igdb_function(function_name, function_args)
# Route to the right provider (IGDB or URL reader)
function_result = await self._dispatch_tool(function_name, function_args, self._last_author(messages) or "")
logging.info(f"🎮 IGDB function result: {type(function_result)} - {str(function_result)[:200]}...")
logging.info(f"🔧 Tool result: {type(function_result)} - {str(function_result)[:200]}...")
messages.append(
{
@@ -381,6 +461,29 @@ class OpenAIResponder(AIResponder, LeonardoAIDrawMixIn):
logging.info(f"edited {len(buffers)} image(s) on {model} from {len(handles)} input(s)")
return buffers
async def propose_task(self) -> Optional[Dict[str, Any]]:
"""One follow-up proposal from recent episodes on memory-model (TSK-08)."""
if "memory-model" not in self.config or self.store is None or not self.ledger.budget_ok():
return None
channel = self.config.get("chat-channel", "chat")
episodes = await asyncio.to_thread(self.store.recent_episodes, channel, 5)
if not episodes:
return None
episode_lines = "\n".join(f"- {episode}" for episode in episodes)
messages = [
{"role": "system", "content": TASKGEN_SYSTEM},
{"role": "user", "content": f"Recent conversation summaries in #{channel}:\n{episode_lines}"},
]
try:
result = await openai_chat(
self.client, model=self.config["memory-model"], messages=messages, response_format=TASKGEN_RESPONSE_FORMAT
)
self._record_usage(result)
return json.loads(result.choices[0].message.content)
except Exception as err:
logging.warning(f"task proposal failed: {repr(err)}")
return None
async def classify(self, message: Any, history_tail: List[Dict[str, Any]]) -> Optional[Dict[str, Any]]:
"""~100-token reply/factual/emoji verdict on classifier-model (BEH-01/03)."""
if "classifier-model" not in self.config or not self.ledger.budget_ok():
+105 -1
View File
@@ -13,7 +13,7 @@ from contextlib import closing
from pathlib import Path
from typing import Any, Dict, List, Optional
SCHEMA_VERSION = 4
SCHEMA_VERSION = 6
class PersistentStore:
@@ -66,6 +66,19 @@ class PersistentStore:
" user TEXT NOT NULL, message_id TEXT, ext TEXT NOT NULL, bytes INTEGER NOT NULL,"
" created_at TEXT NOT NULL DEFAULT (datetime('now')))"
)
if version < 5:
conn.execute(
"CREATE TABLE IF NOT EXISTS tasks (id INTEGER PRIMARY KEY, kind TEXT NOT NULL, channel TEXT NOT NULL,"
" due_at TEXT NOT NULL, payload TEXT NOT NULL, state TEXT NOT NULL DEFAULT 'queued',"
" created_at TEXT NOT NULL DEFAULT (datetime('now')), executed_at TEXT)"
)
if version < 6:
# News memory (SPEC-013 NEWS-09): deduped rolling store of fetched items
conn.execute(
"CREATE TABLE IF NOT EXISTS news (id INTEGER PRIMARY KEY, dedup_key TEXT UNIQUE NOT NULL,"
" source TEXT NOT NULL DEFAULT '', title TEXT NOT NULL, link TEXT NOT NULL DEFAULT '',"
" summary TEXT NOT NULL DEFAULT '', first_seen TEXT NOT NULL DEFAULT (datetime('now')))"
)
if version < SCHEMA_VERSION:
conn.execute(f"PRAGMA user_version = {SCHEMA_VERSION}")
os.chmod(self.db_path, 0o600) # conversation data (PER-04)
@@ -109,6 +122,64 @@ class PersistentStore:
row = conn.execute("SELECT value FROM usage WHERE day = ? AND key = ?", (day, key)).fetchone()
return float(row[0]) if row else 0.0
# --- news memory (SPEC-013 NEWS-09..12) ---
def add_news_items(self, items: List[Dict[str, Any]]) -> int:
"""Insert deduped news rows (by link or title); returns how many were new (NEWS-09)."""
added = 0
with closing(self._connect()) as conn, conn:
for item in items:
title = str(item.get("title") or "").strip()
key = (str(item.get("link") or "").strip()) or title
if not title or not key:
continue
cursor = conn.execute(
"INSERT OR IGNORE INTO news (dedup_key, source, title, link, summary) VALUES (?, ?, ?, ?, ?)",
(key, str(item.get("source") or ""), title, str(item.get("link") or ""), str(item.get("summary") or "")),
)
added += cursor.rowcount
return added
def recent_news(self, limit: int = 20, source: Optional[str] = None) -> List[Dict[str, Any]]:
sql = "SELECT source, title, link, summary FROM news"
params: List[Any] = []
if source:
sql += " WHERE source = ?"
params.append(source)
sql += " ORDER BY id DESC LIMIT ?"
params.append(int(limit))
with closing(self._connect()) as conn:
rows = conn.execute(sql, params).fetchall()
return [{"source": r[0], "title": r[1], "link": r[2], "summary": r[3]} for r in rows]
def search_news(self, terms: List[str], limit: int = 20, source: Optional[str] = None) -> List[Dict[str, Any]]:
"""Rows where every term appears in title or summary; optional source filter (NEWS-11)."""
params: List[Any] = []
clauses = []
for term in terms:
clauses.append("(title LIKE ? OR summary LIKE ? OR source LIKE ?)")
like = f"%{term}%"
params += [like, like, like]
where = " AND ".join(clauses) if clauses else "1=1"
if source:
where = f"({where}) AND source = ?"
params.append(source)
params.append(int(limit))
sql = f"SELECT source, title, link, summary FROM news WHERE {where} ORDER BY id DESC LIMIT ?" # nosec B608 - fixed templates; values parameterised
with closing(self._connect()) as conn:
rows = conn.execute(sql, params).fetchall()
return [{"source": r[0], "title": r[1], "link": r[2], "summary": r[3]} for r in rows]
def prune_news(self, keep: int) -> int:
"""Keep the newest `keep` rows, delete the rest (rolling window, NEWS-09)."""
with closing(self._connect()) as conn, conn:
cursor = conn.execute("DELETE FROM news WHERE id NOT IN (SELECT id FROM news ORDER BY id DESC LIMIT ?)", (int(keep),))
return cursor.rowcount
def news_count(self) -> int:
with closing(self._connect()) as conn:
return int(conn.execute("SELECT COUNT(*) FROM news").fetchone()[0])
def delete_history_of_user(self, user: str) -> int:
"""Remove persisted rows carrying this user's messages (SAF-08)."""
with closing(self._connect()) as conn, conn:
@@ -195,6 +266,39 @@ class PersistentStore:
)
return cursor.rowcount
# --- task queue (SPEC-005, FDB-011) ---
def task_add(self, kind: str, channel: str, due_at: str, payload: str, state: str = "queued") -> int:
with closing(self._connect()) as conn, conn:
cursor = conn.execute(
"INSERT INTO tasks (kind, channel, due_at, payload, state) VALUES (?, ?, ?, ?, ?)",
(kind, channel, due_at, payload, state),
)
return int(cursor.lastrowid or 0)
def tasks_due(self) -> List[Dict[str, Any]]:
with closing(self._connect()) as conn:
rows = conn.execute(
"SELECT id, kind, channel, payload FROM tasks WHERE state = 'queued' AND due_at <= datetime('now') ORDER BY due_at"
).fetchall()
return [{"id": row[0], "kind": row[1], "channel": row[2], "payload": row[3]} for row in rows]
def tasks_open(self) -> List[Dict[str, Any]]:
with closing(self._connect()) as conn:
rows = conn.execute(
"SELECT id, kind, channel, due_at, state FROM tasks WHERE state IN ('queued', 'approval') ORDER BY id"
).fetchall()
return [{"id": row[0], "kind": row[1], "channel": row[2], "due_at": row[3], "state": row[4]} for row in rows]
def task_set_state(self, task_id: int, state: str) -> int:
with closing(self._connect()) as conn, conn:
return conn.execute("UPDATE tasks SET state = ?, executed_at = datetime('now') WHERE id = ?", (state, task_id)).rowcount
def tasks_pending_of_kind(self, kind: str) -> int:
with closing(self._connect()) as conn:
row = conn.execute("SELECT COUNT(*) FROM tasks WHERE kind = ? AND state IN ('queued', 'approval')", (kind,)).fetchone()
return int(row[0])
# --- image cache index (SPEC-004, FDB-010) ---
def image_add(self, sha256: str, channel: str, user: str, message_id: Optional[str], ext: str, nbytes: int) -> None:
+139
View File
@@ -0,0 +1,139 @@
"""Self-tasking engine (SPEC-005, FDB-011).
Generators propose, the scheduler executes through the injected
execute callback (= the normal responder path), so budget, gates and
kill-switches all apply. Everything is off unless `tasks-enabled` is
true (TSK-03).
"""
import asyncio
import logging
import time
from typing import Any, Awaitable, Callable, Dict, List, Optional
from .persistence import PersistentStore
from .quota import QuotaLedger
DEFAULT_MAX_PER_CHANNEL_PER_DAY = 2
DEFAULT_IDLE_IMPULSE_HOURS = 12.0
DEFAULT_TASKGEN_INTERVAL_HOURS = 6.0
DEFAULT_BORENESS_PROMPT = (
"A thought just occurred to you. Anchor it to something real you know — recent news (use get_news), a game "
"releasing soon, the weather, or a regular you remember — not a generic musing. Share it briefly, in your own "
"voice, as an observation, a gentle question, or a joke; never an advertisement. Read the room and stay in character."
)
ExecuteCallback = Callable[[str, str], Awaitable[None]]
ProposeCallback = Callable[[], Awaitable[Optional[Dict[str, Any]]]]
AlertCallback = Callable[[str], Awaitable[None]]
class TaskEngine:
def __init__(
self,
store: Optional[PersistentStore],
ledger: QuotaLedger,
config_getter: Callable[[], Dict[str, Any]],
execute: ExecuteCallback,
propose: ProposeCallback,
staff_alert: AlertCallback,
allowed: Callable[[], bool],
idle_seconds: Callable[[], float],
observe: Callable[[str, str, str], Awaitable[None]],
) -> None:
self.store = store
self.ledger = ledger
self._config = config_getter
self._execute = execute
self._propose = propose
self._staff_alert = staff_alert
self._allowed = allowed
self._idle_seconds = idle_seconds
self._observe = observe
self._last_generation = 0.0
self._lock = asyncio.Lock()
def active(self) -> bool:
return self.store is not None and bool(self._config().get("tasks-enabled", False)) # TSK-03
def generators(self) -> List[str]:
return list(self._config().get("tasks-generators", ["idle-impulse", "follow-up"]))
async def enqueue(self, kind: str, channel: str, payload: str, due_hours: float = 0.0) -> int:
assert self.store is not None
state = "approval" if self._config().get("tasks-approval", False) else "queued" # TSK-05
due_at = time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime(time.time() + due_hours * 3600.0))
task_id = int(await asyncio.to_thread(self.store.task_add, kind, channel, due_at, payload, state) or 0)
if state == "approval":
await self._staff_alert(f"Task #{task_id} proposed ({kind}, #{channel}): {payload[:180]} — !bot task-approve {task_id}")
return task_id
def _channel_cap_ok(self, channel: str) -> bool:
cap = int(self._config().get("tasks-max-per-channel-per-day", DEFAULT_MAX_PER_CHANNEL_PER_DAY))
return self.ledger._get(f"task-runs:{channel}") < cap # TSK-04
async def tick(self) -> None:
"""One scheduler pass: execute due tasks, then maybe generate (TSK-02/06)."""
if not self.active() or not self._allowed() or self._lock.locked():
return
assert self.store is not None
async with self._lock:
await self._maybe_generate()
for task in await asyncio.to_thread(self.store.tasks_due):
if not self._channel_cap_ok(task["channel"]):
continue # stays queued for tomorrow (TSK-04)
try:
await self._execute(task["channel"], task["payload"])
await asyncio.to_thread(self.store.task_set_state, task["id"], "done")
self.ledger._add(f"task-runs:{task['channel']}", 1)
await self._observe("system", "task", f"executed {task['kind']}: {task['payload'][:200]}")
except Exception as err:
logging.warning(f"task {task['id']} failed: {repr(err)}")
await asyncio.to_thread(self.store.task_set_state, task["id"], "failed")
async def _maybe_generate(self) -> None:
config = self._config()
interval = float(config.get("taskgen-interval-hours", DEFAULT_TASKGEN_INTERVAL_HOURS)) * 3600.0
now = time.monotonic()
if self._last_generation and now - self._last_generation < interval:
return
self._last_generation = now
generators = self.generators()
if "idle-impulse" in generators:
await self._generate_idle_impulse()
if "follow-up" in generators:
await self._generate_follow_up()
async def _generate_idle_impulse(self) -> None:
"""Boreness, demoted to a deterministic generator (TSK-07)."""
assert self.store is not None
config = self._config()
channel = config.get("chat-channel")
if not channel:
return
idle_threshold = float(config.get("idle-impulse-hours", DEFAULT_IDLE_IMPULSE_HOURS)) * 3600.0
if self._idle_seconds() < idle_threshold:
return
if await asyncio.to_thread(self.store.tasks_pending_of_kind, "idle-impulse"):
return # one pending impulse is enough
prompt = config.get("boreness-prompt", DEFAULT_BORENESS_PROMPT)
await self.enqueue("idle-impulse", channel, prompt)
async def _generate_follow_up(self) -> None:
"""Ask the model for one follow-up worth doing (TSK-08)."""
assert self.store is not None
if await asyncio.to_thread(self.store.tasks_pending_of_kind, "follow-up"):
return
proposal = await self._propose()
if not proposal or not isinstance(proposal.get("task"), dict):
return
task = proposal["task"]
channel = str(task.get("channel") or self._config().get("chat-channel") or "")
prompt = str(task.get("prompt") or "").strip()
if not channel or not prompt:
return
try:
due_hours = max(0.0, float(task.get("due_hours") or 0.0))
except (TypeError, ValueError):
due_hours = 0.0
await self.enqueue("follow-up", channel, prompt, due_hours)
+183
View File
@@ -0,0 +1,183 @@
"""URL reading tool (SPEC-011, FDB-018).
The model calls `fetch_url`; this module fetches safely and returns
readable text plus prominent image URLs. Web pages are hostile input:
every fetch is SSRF-guarded (no private/loopback/link-local targets,
http/https only, redirects re-validated) and every byte of text is
sanitized before it can reach the prompt.
"""
import ipaddress
import logging
import re
import socket
from html.parser import HTMLParser
from typing import Any, Callable, Dict, List, Optional, Tuple
from urllib.parse import urljoin, urlparse
import aiohttp
from .ai_responder import sanitize_external_text
from .httpread import read_capped
DEFAULT_MAX_BYTES = 2 * 1024 * 1024
DEFAULT_MAX_CHARS = 6000
DEFAULT_MAX_IMAGES = 2
FETCH_TIMEOUT_S = 15
MAX_REDIRECTS = 5
FETCH_URL_TOOL = {
"name": "fetch_url",
"description": "Fetch a public web page and return its readable text plus prominent image links. "
"Use when the user shares a URL and asks about it, or to get details behind a news link.",
"parameters": {
"type": "object",
"properties": {"url": {"type": "string", "description": "The http/https URL to read."}},
"required": ["url"],
},
}
_META_REFRESH_URL = re.compile(r"url\s*=\s*['\"]?([^'\";\s]+)", re.I)
class _Extractor(HTMLParser):
def __init__(self) -> None:
super().__init__()
self._skip = 0
self.parts: List[str] = []
self.images: List[str] = []
self.og_image: Optional[str] = None
self.refresh_url: Optional[str] = None
def handle_starttag(self, tag: str, attrs) -> None:
if tag in ("script", "style", "noscript", "svg"):
self._skip += 1
attr = dict(attrs)
src = attr.get("src")
if tag == "img" and src:
self.images.append(src)
if tag == "meta" and attr.get("property") == "og:image" and attr.get("content"):
self.og_image = attr["content"]
# meta-refresh redirect (link shorteners, getnews stubs) — URL-04
content = attr.get("content")
if tag == "meta" and (attr.get("http-equiv") or "").lower() == "refresh" and content:
match = _META_REFRESH_URL.search(content)
if match and self.refresh_url is None:
self.refresh_url = match.group(1)
def handle_endtag(self, tag: str) -> None:
if tag in ("script", "style", "noscript", "svg") and self._skip > 0:
self._skip -= 1
def handle_data(self, data: str) -> None:
if self._skip == 0 and data.strip():
self.parts.append(data.strip())
def _ip_is_public(ip_str: str) -> bool:
try:
ip = ipaddress.ip_address(ip_str)
except ValueError:
return False
return not (ip.is_private or ip.is_loopback or ip.is_link_local or ip.is_multicast or ip.is_reserved or ip.is_unspecified)
def guard_url(url: str) -> Optional[str]:
"""Return None if safe to fetch, else a human-readable refusal reason (URL-02/03)."""
parsed = urlparse(url)
if parsed.scheme not in ("http", "https"):
return f"refused scheme {parsed.scheme!r} (only http/https)"
host = parsed.hostname
if not host:
return "refused: no host"
try:
literal = ipaddress.ip_address(host)
return None if _ip_is_public(str(literal)) else f"refused non-public address {host}"
except ValueError:
pass
try:
infos = socket.getaddrinfo(host, None)
except socket.gaierror:
return f"refused: cannot resolve {host}"
for info in infos:
if not _ip_is_public(str(info[4][0])):
return f"refused: {host} resolves to non-public address"
return None
class URLReader:
def __init__(self, config_getter: Callable[[], Dict[str, Any]], image_cache) -> None:
self._config = config_getter
self.image_cache = image_cache
def enabled(self) -> bool:
return bool(self._config().get("enable-url-reading", False))
async def _get(self, session, url: str, max_bytes: int) -> Tuple[str, bytes]:
"""Manual redirect handling so every hop is re-guarded (URL-04)."""
current = url
for _ in range(MAX_REDIRECTS):
reason = guard_url(current)
if reason:
raise ValueError(reason)
async with session.get(current, allow_redirects=False) as response:
if response.status in (301, 302, 303, 307, 308) and response.headers.get("Location"):
current = urljoin(current, response.headers["Location"])
continue
response.raise_for_status()
return str(response.url), await read_capped(response, max_bytes)
raise ValueError("too many redirects")
async def fetch(self, url: str, channel: str, user: str) -> Dict[str, Any]:
config = self._config()
max_bytes = int(config.get("url-max-bytes", DEFAULT_MAX_BYTES))
timeout = aiohttp.ClientTimeout(total=FETCH_TIMEOUT_S)
try:
async with aiohttp.ClientSession(timeout=timeout, headers={"User-Agent": "FjerkroaBot/1.0"}) as session:
final_url, body = await self._get(session, url, max_bytes)
# follow a meta-refresh redirect (link shorteners / getnews stubs), re-guarded — URL-04
for _ in range(2):
extractor = self._extract(body.decode("utf-8", "ignore"))
if not extractor.refresh_url:
break
target = urljoin(final_url, extractor.refresh_url)
if guard_url(target) is not None or target == final_url:
break
logging.info(f"url reader: following meta-refresh -> {target}")
final_url, body = await self._get(session, target, max_bytes)
except Exception as err:
return {"error": str(err)}
html = body.decode("utf-8", "ignore")
clean = sanitize_external_text(self._to_text(html), int(config.get("url-max-chars", DEFAULT_MAX_CHARS)))
images = await self._ingest_images(html, final_url, channel, user)
return {"url": final_url, "text": clean, "images_cached": images}
def _extract(self, html: str) -> "_Extractor":
extractor = _Extractor()
try:
extractor.feed(html)
except Exception as err:
logging.debug(f"html parse failed: {err!r}")
return extractor
def _to_text(self, html: str) -> str:
return re.sub(r"\s+\n", "\n", " ".join(self._extract(html).parts))
async def _ingest_images(self, html: str, base_url: str, channel: str, user: str) -> int:
if self.image_cache is None:
return 0
extractor = self._extract(html)
candidates = ([extractor.og_image] if extractor.og_image else []) + extractor.images
limit = int(self._config().get("url-max-images", DEFAULT_MAX_IMAGES))
cached = 0
for src in candidates:
if cached >= limit:
break
absolute = urljoin(base_url, src)
if guard_url(absolute) is not None:
continue
sha = await self.image_cache.ingest_url(absolute, channel, user, None)
if sha is not None:
cached += 1
return cached
+94
View File
@@ -0,0 +1,94 @@
"""Web search tool via Exa (SPEC-015, FDB-022).
A `web_search` function tool: the model looks things up on the open web
when a general "look it up" question is not covered by IGDB, the codex,
the news store, or a URL the user pasted. Results are external text, so
titles and snippets are sanitized (SAF-03) before they reach the prompt.
The Exa API key lives in host config (or the `EXA_API_KEY` env), never in
the repo.
"""
import logging
import os
from typing import Any, Callable, Dict, List
import aiohttp
from .ai_responder import sanitize_external_text
EXA_SEARCH_URL = "https://api.exa.ai/search"
DEFAULT_RESULTS = 5
MAX_RESULTS = 10
DEFAULT_SNIPPET_CHARS = 400
FETCH_TIMEOUT_S = 15
WEB_SEARCH_TOOL = {
"name": "web_search",
"description": "Search the open web for general information. Use ONLY when the answer is not in your own sources: for "
"the server's news use get_news, for Adeptus Mechanicus / Warhammer 40k lore use codex_search, for video-game facts use "
"the game tools, for a specific URL someone pasted use fetch_url. Returns result titles, URLs, and a short snippet; "
"follow up with fetch_url on a result link for the full article.",
"parameters": {
"type": "object",
"properties": {
"query": {"type": "string", "description": "What to search the web for."},
"num_results": {"type": "integer", "description": "How many results to return (default 5, max 10)."},
},
"required": ["query"],
},
}
def _format_results(data: Any, snippet_chars: int) -> List[Dict[str, str]]:
"""Reduce an Exa response to sanitized {title, url, snippet, published} rows (WEB-02)."""
results = data.get("results", []) if isinstance(data, dict) else []
out: List[Dict[str, str]] = []
for item in results:
if not isinstance(item, dict):
continue
out.append(
{
"title": sanitize_external_text(str(item.get("title") or ""), 200),
"url": str(item.get("url") or ""),
"snippet": sanitize_external_text(str(item.get("text") or item.get("snippet") or ""), snippet_chars),
"published": str(item.get("publishedDate") or ""),
}
)
return out
class WebSearch:
def __init__(self, config_getter: Callable[[], Dict[str, Any]]) -> None:
self._config = config_getter
def _api_key(self) -> str:
return str(self._config().get("exa-api-key") or os.environ.get("EXA_API_KEY", ""))
def enabled(self) -> bool:
return bool(self._config().get("enable-web-search", False)) and bool(self._api_key())
async def _post(self, payload: Dict[str, Any], headers: Dict[str, str]) -> Any:
timeout = aiohttp.ClientTimeout(total=FETCH_TIMEOUT_S)
async with aiohttp.ClientSession(timeout=timeout) as session:
async with session.post(EXA_SEARCH_URL, json=payload, headers=headers) as response:
response.raise_for_status()
return await response.json()
async def search(self, query: str, num_results: int = DEFAULT_RESULTS) -> Dict[str, Any]:
"""Return sanitized web results, or an error dict — never raise (WEB-04)."""
key = self._api_key()
if not key:
return {"error": "web search unavailable: no api key"}
query = (query or "").strip()
if not query:
return {"query": "", "results": []}
num = max(1, min(int(num_results or DEFAULT_RESULTS), MAX_RESULTS)) # WEB-03
snippet_chars = int(self._config().get("web-snippet-chars", DEFAULT_SNIPPET_CHARS))
payload = {"query": query, "numResults": num, "type": "auto", "contents": {"text": {"maxCharacters": max(snippet_chars, 200)}}}
headers = {"x-api-key": key, "Content-Type": "application/json"}
try:
data = await self._post(payload, headers)
except Exception as err:
logging.warning(f"web search failed: {err!r}")
return {"error": "web search failed"}
return {"query": query, "results": _format_results(data, snippet_chars)}
+4 -2
View File
@@ -6,9 +6,11 @@ with date + result.
| ID | Date | Result |
| --- | --- | --- |
| DEP-01 | 2026-07-13 | Verified with the v3.0.0 ggg deploy: tag-only refusal + untracked config/state survived. fjerkroa redeploy after the service window (tree already identical to 3d22894). |
| DEP-02 | 2026-07-13 | Service map exercised: luma restart via script (v3.0.0); kroa mapping code-reviewed, exercised on its next deploy. |
| DEP-01 | 2026-07-13 | Verified on both hosts (ggg v3.0.0..v3.3.2, fjerkroa v3.3.2): tag-only refusal + untracked config/state survived every deploy. |
| DEP-02 | 2026-07-13 | Service map exercised on both hosts: luma (v3.0.0..v3.3.2) and kroa (v3.3.2, DEPLOY_FORCE per operator order). |
| DEP-03 | 2026-07-13 | Exercised with the v3.1.0 ggg deploy: bot.db.pre-v3.1.0 confirmed on the host. (v3.0.0 note: no pre-existing db in the pickle era.) |
| DEP-04 | 2026-07-13 | Smoke gate exercised on ggg: RUNNING + fresh login line. |
| DEP-05 | 2026-07-13 | Live-verified: kroa deploy attempt ~15h Oslo refused without DEPLOY_FORCE=1. |
| DEP-06 | 2026-07-13 | Rollback documented (older tag + db backup restore); live drill pending — next release. |
| OPS-15 | 2026-07-13 | Backup cron installed on both hosts (daily 03:17 UTC → ~/backups/<bot>/, keep 14); first snapshots written + verified 0600 (kroa 10965 B, luma 25871 B). |
| CDX-07 | 2026-07-13 | Pending live verify on ggg after v3.8.0 deploy: persona grounding + codex_search returns binaric.tech inscriptions with links. |
+1
View File
@@ -15,6 +15,7 @@ dependencies = [
"tomlkit>=0.13",
"watchdog>=6",
"requests>=2.32",
"defusedxml>=0.7",
]
[project.scripts]
+8
View File
@@ -82,6 +82,14 @@ SAF-08/MEM-09).
Bot-generated images are ingested like uploads (user `assistant`), so
"make a variant of that" remix chains work on the bot's own output.
### IMG-17 — Image-only messages are cached (coverage: test)
A message consisting only of attachments (no text) is ingested into
the cache and recorded as an observation, even though no reply is
produced — the image must be available for later `picture_edit` and
vision follow-ups. (Previously the empty-text early-return dropped
such posts entirely.)
### IMG-16 — The prompt announces editable images (coverage: test)
When the answer channel has cached images, the context suffix states
+59
View File
@@ -0,0 +1,59 @@
# SPEC-005 — Self-tasking
The sigmoid "boreness" loop becomes a persistent task queue (schema
v5): generators propose, a scheduler executes — through the normal
responder path, so every SAF gate, quota and kill-switch applies.
**Default off** (`tasks-enabled`, kitchen stays quiet unless opted
in); generators are individually selectable per persona
(`tasks-generators`). Marked experimental per plan v4.
### TSK-01 — Tasks are persistent queue rows (coverage: test)
A task is a store row: kind, channel, due-at, payload (the prompt the
responder will run), state (`queued`/`approval`/`done`/`cancelled`/
`failed`). Enqueued tasks survive restarts.
### TSK-02 — Due tasks run through the responder path (coverage: test)
The scheduler executes due queued tasks as system messages via the
normal respond flow (inheriting budget, gates, envelope), marks them
`done`/`failed`, and records the outcome as an observation so memory
learns what the bot did on its own.
### TSK-03 — Off by default (coverage: test)
Without `tasks-enabled = true` nothing is generated and nothing is
executed. A restaurant server does not improvise unless asked to.
### TSK-04 — Per-channel daily cap (coverage: test)
At most `tasks-max-per-channel-per-day` (default 2) task executions
per channel per day, counted in the ledger; further due tasks stay
queued for the next day.
### TSK-05 — Approval mode (coverage: test)
With `tasks-approval = true`, generated tasks enter state `approval`
and a staff alert announces them; `!bot task-approve <id>` moves them
to the queue, `!bot task-cancel <id>` kills them (works for queued
tasks too). Staged-rollout path from the review.
### TSK-06 — Kill-switches govern execution (coverage: test)
Task execution respects `bot_initiated_allowed()``!bot tasks off`,
pause, quiet mode and quiet hours all stop the scheduler tick.
### TSK-07 — Idle-impulse generator (boreness, demoted) (coverage: test)
When the chat channel has been idle longer than
`idle-impulse-hours` (default 12), the generator enqueues one
impulse task with the configured boreness prompt — deterministic
threshold instead of the old 7-second sigmoid dice loop, bounded by
TSK-04. The `on_boreness` loop is gone.
### TSK-08 — Follow-up generator proposes from memory (coverage: test)
Periodically (`taskgen-interval-hours`, default 6) the follow-up
generator asks `memory-model` (strict structured outputs) whether the
recent episodes/facts warrant one follow-up task (channel, prompt,
due-in-hours). A null/failed proposal enqueues nothing.
+18
View File
@@ -62,8 +62,26 @@ Bot-initiated posts also respect pause/quiet.
`!bot pins` answers with all pinned facts and their ids (global +
per-channel) — without it, `!bot unpin <id>` required guessing ids.
### OPS-12 — Task queue surface (coverage: test)
`!bot tasks` lists open tasks (queued + awaiting approval) with ids;
`!bot task-approve <id>` and `!bot task-cancel <id>` manage them
(TSK-05). `!bot tasks on|off` stays the kill-switch (OPS-09).
### OPS-10 — Spend report (coverage: test)
`!bot spend` answers in the staff channel with today's estimated
spend in USD, token and image counts, and the configured budget.
Management sees the cost, not just the cap.
### OPS-17 — Help is complete and context-aware (coverage: test)
Help reflects where each command actually works, because not every
command is allowed everywhere. `!help` answers in any channel and
lists only the commands usable there: in a normal channel the
everyone-commands (`!help`, `!forgetme`, `!privacy`, `!wichtel`); in
the staff channel it additionally lists the operator commands grouped
by purpose (control, cost, memory, tasks). `!bot help` — and any
unrecognised `!bot` command — answers with that same full staff help,
so the listing is exhaustive rather than the old hand-maintained
partial line. Help works even while the bot is paused.
+60
View File
@@ -0,0 +1,60 @@
# SPEC-011 — URL reading
A `fetch_url` tool alongside IGDB: the model decides when to read a
link (user pastes a URL + question; a news item links an article
Luma wants details on). Web pages are the number-one injection
vector, so everything fetched is sanitized (SAF-03) and the fetch
itself is SSRF-guarded — the bot runs on shared hosting. Active only
when `enable-url-reading = true`.
### URL-01 — fetch_url is offered as a tool (coverage: test)
When `enable-url-reading` is true, the chat call's `tools` list
includes a `fetch_url` function (url string param) next to any IGDB
tools. When false, it is absent.
### URL-02 — Only http/https are fetched (coverage: test)
`file:`, `ftp:`, `data:`, `gopher:` and schemeless inputs are
refused before any network call, with an error result the model can
relay.
### URL-03 — SSRF guard blocks non-public addresses (coverage: test)
Before fetching, the host is resolved and every resulting IP is
checked; the fetch is refused when any is private, loopback,
link-local, or otherwise non-global (RFC1918, 127/8, 169.254/16,
::1, fc00::/7, etc.). A URL literal that is already such an IP is
refused without DNS.
### URL-04 — Redirects are re-validated (coverage: test)
Redirects are followed manually; each hop's target passes URL-02 and
URL-03 again. A public URL that 302-redirects to `localhost` or an
internal IP is refused at the redirect, not fetched. **HTML
meta-refresh** redirects (link shorteners, the old getnews stubs) are
also followed — the target is SSRF-re-guarded and fetched, so the
reader returns the real article, not the "Redirecting…" stub.
### URL-05 — Fetched text is bounded and sanitized (coverage: test)
Responses are capped at `url-max-bytes` (default 2 MB) with a
download timeout; HTML is reduced to readable text (script/style
dropped, tags stripped, whitespace collapsed) and passed through
`sanitize_external_text` before it reaches the model, truncated to
`url-max-chars` (default 6000).
### URL-06 — Page images feed the cache (coverage: test)
Up to `url-max-images` (default 2) prominent images (og:image, then
large `<img>`) are ingested into the ImageCache for the requesting
channel (SSRF-guarded like the page), so the model can see them and
`picture_edit` can remix them. Ingestion failures are skipped, never
fatal to the text result.
### URL-07 — Fetches are metered and capped (coverage: test)
Each fetch increments a per-user daily counter; over
`url-daily-per-user` (default 20) `fetch_url` refuses with an error
result. The budget gate (SAF-04) still applies to the surrounding
model calls.
+52
View File
@@ -0,0 +1,52 @@
# SPEC-012 — Operations hardening
Runtime + host operability (FDB-012). Backups and host wiring are
`manual` coverage; the in-process alerting is `test`.
### OPS-13 — Consistent DB backups (coverage: test)
`deploy/backup_db.py` writes a gzipped snapshot of `bot.db` using the
sqlite3 online-backup API — consistent even while the bot writes
(WAL-safe) — with 0600 permissions. Restoring a snapshot yields a
readable database with the same rows.
### OPS-14 — Backups are rotated (coverage: test)
The newest `backup-keep` (default 14) snapshots are kept; older ones
are deleted. Timestamped names sort chronologically so rotation is a
pure list operation.
### OPS-15 — Backup cron on each host (coverage: manual)
Each host runs `backup_db.py` daily via cron, writing to
`~/backups/<bot>/` (outside `~/fjerkroa_bot`, so deploys and service
restarts never touch it). Verified by presence of the cron line and a
fresh snapshot.
### OPS-16 — Repeated API errors alert staff (coverage: test)
The responder counts consecutive OpenAI request failures; at
`api-error-alert-threshold` (default 5) in a row it fires one staff
alert (rate-limited like all staff alerts) so a silently-broken bot
(cf. the gpt-5.6 tools/reasoning incident) surfaces within minutes
instead of hours. A success resets the counter.
### OPS-18 — Health monitor watches spend, disk, task-queue (coverage: test)
When `enable-monitoring` is true, a loop wakes every `monitor-interval`
(default 300 s) and checks three thresholds, alerting the staff channel
when one is crossed: daily spend at or above `monitor-spend-alert-frac`
(default 0.8) of `daily-budget-usd`; free disk below `monitor-disk-min-mb`
(default 500 MB); open task-queue depth at or above `monitor-taskqueue-max`
(default 20). A check with no data to evaluate (no budget set, no store,
a failed disk read) is skipped, never fatal. With the flag off the loop
does nothing.
### OPS-19 — Alerts fire once per crossing and re-arm on recovery (coverage: test)
Each metric alerts only on the rising edge — the first tick that finds
it over its threshold — and stays silent while it remains over, so a
persistent condition does not repeat every interval. When the metric
falls back below the threshold the alert re-arms silently, ready to fire
again on the next crossing. All alerts still pass through the
rate-limited staff-alert path (OPS-07).
+100
View File
@@ -0,0 +1,100 @@
# SPEC-013 — News digest
Replaces the broken pre-1.0-openai `news_feed.py`. A CLI
(`python -m fjerkroa_bot.news --config <cfg>`) fetches the
`news-feeds` and writes a compact digest to the `news` file that
`AIResponder.message` injects into the `{news}` slot. Feeds are
external input and operator-configured.
### NEWS-01 — RSS (2.0 and 1.0/RDF) and Atom parse to items (coverage: test)
`parse_feed(bytes, label)` extracts `{title, link, source}` from both
RSS (`<item>`) and Atom (`<entry>`) documents, tolerates malformed
XML (returns an empty list, logs), and never raises.
### NEWS-02 — Digest is sanitized and bounded (coverage: test)
`render_digest` caps at `news-max-items`, and every headline passes
`sanitize_external_text` (SAF-03) — a feed cannot inject `@everyone`
or control characters into the prompt via a headline.
### NEWS-03 — Feeds are SSRF-guarded and deduped (coverage: test)
`NewsFetcher.collect` skips any feed URL the SSRF guard rejects,
skips feeds that fail to fetch (one bad feed never sinks the run),
and drops duplicate headlines across feeds.
## Webhook posting (ggg model)
`--post` mode fetches feeds mapped to channels and posts NEW items to
the channel's Discord webhook — replacing the py3.8 `getnews.py`
(dead play3 feed, 35 MB substring-scan state file, HTML-redirect
cruft). Config: `news-post-feeds = [[url, label, channel], …]`,
`news-post-webhooks = {channel = url}`, `news-post-state`.
### NEWS-04 — Only unseen items post, then are marked seen (coverage: test)
`NewsPoster.run_post` posts each item whose key (link, else title) is
not in the seen-set, adds it to the set, and posts to the mapped
channel's webhook. Re-runs over the same feed post nothing new.
### NEWS-05 — First run seeds without flooding (coverage: test)
With no prior state file (`seed_only`), every current item is marked
seen but nothing is posted — migrating off getnews.py never dumps a
backlog into the channels. `news-post-max-per-run` caps steady-state
posts per run.
### NEWS-06 — Post failures and bad channels are survived (coverage: test)
A feed the SSRF guard rejects, a feed that fails to fetch, an item
whose channel has no configured webhook, and a webhook POST that
raises are each logged and skipped — one failure never sinks the
run, and the seen-set still advances for successfully-processed
items.
### NEWS-07 — Item summaries are extracted (coverage: test)
`parse_feed` also captures each item's short description — RSS
`<description>`, Atom `<summary>` or `<content>` — with HTML stripped,
entities unescaped, and whitespace collapsed, so an item carries what
it is about, not only a headline. Missing descriptions yield an empty
summary, never an error.
### NEWS-08 — The digest carries summaries (coverage: test)
`render_digest` appends the sanitized, length-capped
(`news-summary-chars`, default 200) summary after each headline, so
the bot's ambient `{news}` context knows the gist of each story, not
just its title. A zero cap restores the title-only digest.
### NEWS-09 — Fetched news is stored, deduped, and rolled over (coverage: test)
Both the digest run (kroa) and the posting run (ggg) upsert every
fetched item into a `news` table keyed by link (or title), so the same
story is stored once. After each run the store is pruned to the newest
`news-keep` rows (default 400), a rolling window that bounds growth
while keeping recent history searchable.
### NEWS-10 — get_news is offered as a tool (coverage: test)
When `enable-news-tool` is true and a store is configured, the chat
call's `tools` list includes a `get_news` function (optional `topic`,
`source`, `limit`) next to the other tools. Without a store or the
flag it is absent.
### NEWS-11 — get_news retrieves filtered, sanitized items (coverage: test)
`get_news` returns recent stored items, newest first, optionally
narrowed by `topic` (every keyword must appear in the title, summary,
or source label — so `topic: "Nordland"` finds items from that source)
and/or an exact `source`; `limit` is clamped to 1..30. Each result's title and
summary are passed through `sanitize_external_text`. The bot can then
`fetch_url` a returned link for the full article.
### NEWS-12 — get_news is metered per user (coverage: test)
Each `get_news` call increments a per-user daily counter; over
`news-daily-per-user` (default 30) the tool refuses with an error
result without touching the store. The budget gate (SAF-04) still
applies to the surrounding model calls.
+59
View File
@@ -0,0 +1,59 @@
# SPEC-014 — Codex Mechanicus search
Luma is an Adeptus Mechanicus tech-priest; his lore has a real home —
the priest's own Codex Mechanicus at `binaric.tech` (an Astro/MDX
archive, five tongues). A `codex_search` function tool lets him consult
that archive and answer from sourced inscriptions instead of inventing
lore. The index is public but still untrusted by the time it reaches a
prompt: the fetch is SSRF-guarded (SPEC-011 shares `guard_url`),
size-bounded, and every returned field is sanitized (SAF-03). Luma-only;
active only when `enable-codex = true`.
### CDX-01 — codex_search is offered as a tool (coverage: test)
When `enable-codex` is true, the chat call's `tools` list includes a
`codex_search` function (`query` string, optional `lang`) next to any
IGDB / fetch_url tools. When false, it is absent.
### CDX-02 — The index is fetched safely and cached (coverage: test)
The index URL (`codex-index-url`, default
`https://binaric.tech/search-index.json`) passes the SSRF guard before
any network call, is read under a byte cap (`codex-max-bytes`, default
4 MB) with a download timeout, and is cached in memory for
`codex-cache-ttl` (default 3600 s) so repeated searches do not re-fetch.
### CDX-03 — Ranking weights title over summary over body (coverage: test)
The query is tokenized (stopwords dropped); each inscription is scored
by term hits weighted title (8) > summary (3) > body (1). Results are
returned highest-score first, each as `{title, summary, collection,
url}`, with `url` absolute against the site origin.
### CDX-04 — Language is preferred, with fallback (coverage: test)
Results are filtered to the requested `lang` (en, de, eo, no, uk;
default en; unknown codes fall back to en) by the language segment in
each inscription URL. If no inscription in that tongue matches, the
search falls back to all tongues rather than returning nothing.
### CDX-05 — Results are sanitized and failure is reported (coverage: test)
Each `title` and `summary` is passed through `sanitize_external_text`
and length-capped (`codex-summary-chars`, default 500). An index that
cannot be fetched or parsed returns an `{error: ...}` dict the model can
relay — `search` never raises.
### CDX-06 — Searches are metered per user (coverage: test)
Each `codex_search` increments a per-user daily counter; over
`codex-daily-per-user` (default 50) the tool refuses with an error
result without touching the index. The budget gate (SAF-04) still
applies to the surrounding model calls.
### CDX-07 — Luma cites the codex, not invention (coverage: manual)
With the persona grounding line, when a pilgrim asks Cult Mechanicus
lore Luma consults `codex_search` and answers from it, offering the
`binaric.tech` link to read the full inscription rather than
hallucinating. Verified live on ggg.
+42
View File
@@ -0,0 +1,42 @@
# SPEC-015 — Web search (Exa)
A `web_search` function tool for general "look it up on the internet"
questions the other tools do not cover: IGDB is games, the Codex is
Adeptus Mechanicus lore, the news store is the configured feeds, and
`fetch_url` needs a URL the user already has. Web search fills the gap
and pairs with `fetch_url` (search → pick a link → read it). Results are
external text and are sanitized (SAF-03); the Exa key is a host secret,
never in the repo. Active only when `enable-web-search = true` and a key
is present.
### WEB-01 — web_search is offered as a tool (coverage: test)
When `enable-web-search` is true **and** an Exa key is available
(`exa-api-key` in config, else `EXA_API_KEY` env), the chat call's
`tools` list includes a `web_search` function (`query` string, optional
`num_results`). With the flag off or no key it is absent.
### WEB-02 — Results are reduced and sanitized (coverage: test)
Each Exa result becomes `{title, url, snippet, published}`; `title` and
`snippet` pass through `sanitize_external_text` (snippet capped at
`web-snippet-chars`, default 400) so a web page can neither inject an
`@everyone` nor smuggle control characters into the prompt.
### WEB-03 — Result count is bounded (coverage: test)
`num_results` is clamped to 1..`MAX_RESULTS` (10) before the request, so
neither a huge fan-out nor a zero/negative count reaches the API.
### WEB-04 — Missing key and API failure are reported, not raised (coverage: test)
With no key the tool returns an `{error: ...}` result without a network
call. A request that raises (network, non-2xx, bad JSON) is logged and
returns an `{error: ...}` dict — `search` never raises into the loop.
### WEB-05 — Searches are metered per user (coverage: test)
Each `web_search` increments a per-user daily counter; over
`web-daily-per-user` (default 30) the tool refuses with an error result
without calling the API. The budget gate (SAF-04) still applies to the
surrounding model calls.
+1 -1
View File
@@ -28,7 +28,7 @@ class TestIGDBIntegration(unittest.IsolatedAsyncioTestCase):
responder = OpenAIResponder(self.config_with_igdb)
mock_igdb.assert_called_once_with("test_client", "test_token")
mock_igdb.assert_called_once_with("test_client", "test_token", client_secret=None)
self.assertEqual(responder.igdb, mock_igdb_instance)
def test_igdb_initialization_disabled(self):
+100 -1
View File
@@ -160,7 +160,7 @@ class TestIGDBQuery(unittest.TestCase):
"id",
"name",
"alternative_names",
"category",
"game_type",
"release_dates",
"franchise",
"language_supports",
@@ -174,5 +174,104 @@ class TestIGDBQuery(unittest.TestCase):
self.assertEqual(result, [{"id": 1, "name": "Super Mario Bros"}])
class TestIGDBNativeSearch(unittest.TestCase):
def test_build_query_with_search_term(self):
"""search_games uses IGDB full-text search, not a name prefix filter."""
query = IGDBQuery.build_query(["name"], {"game_type": "= 0"}, limit=5, search_term="Marvel Tōkon")
self.assertEqual(query, 'search "Marvel Tōkon"; fields name; limit 5; where game_type = 0;')
def test_search_term_escapes_quotes_and_backslashes(self):
query = IGDBQuery.build_query(["name"], search_term='say "hi" \\ bye')
self.assertIn('search "say \\"hi\\" \\\\ bye";', query)
@patch.object(IGDBQuery, "generalized_igdb_query")
def test_search_games_passes_search_term(self, mock_query):
mock_query.return_value = []
IGDBQuery("cid", "token").search_games("Elden Ring", limit=3)
_, kwargs = mock_query.call_args
self.assertEqual(kwargs["search_term"], "Elden Ring")
self.assertEqual(mock_query.call_args.args[0], {})
class TestIGDBTokenRefresh(unittest.TestCase):
@staticmethod
def _oauth_response(token="fresh_token", expires_in=5_000_000):
response = Mock()
response.json.return_value = {"access_token": token, "expires_in": expires_in}
response.raise_for_status.return_value = None
return response
@staticmethod
def _api_response(payload, status_code=200):
response = Mock()
response.status_code = status_code
response.json.return_value = payload
response.raise_for_status.return_value = None
return response
@patch("fjerkroa_bot.igdblib.requests.post")
def test_fetches_token_when_only_secret_configured(self, mock_post):
"""Without a static token, the first request fetches one via Twitch OAuth."""
mock_post.side_effect = [self._oauth_response(), self._api_response([{"id": 1}])]
igdb = IGDBQuery("cid", client_secret="secret")
result = igdb.send_igdb_request("games", "fields name; limit 1;")
self.assertEqual(result, [{"id": 1}])
oauth_call, api_call = mock_post.call_args_list
self.assertEqual(oauth_call.args[0], "https://id.twitch.tv/oauth2/token")
self.assertEqual(
oauth_call.kwargs["params"],
{"client_id": "cid", "client_secret": "secret", "grant_type": "client_credentials"},
)
self.assertEqual(api_call.kwargs["headers"]["Authorization"], "Bearer fresh_token")
@patch("fjerkroa_bot.igdblib.requests.post")
def test_refreshes_and_retries_on_401(self, mock_post):
"""A 401 with a configured secret triggers one refresh and retry."""
mock_post.side_effect = [
self._api_response(None, status_code=401),
self._oauth_response(),
self._api_response([{"id": 2}]),
]
igdb = IGDBQuery("cid", "expired_token", client_secret="secret")
result = igdb.send_igdb_request("games", "fields name; limit 1;")
self.assertEqual(result, [{"id": 2}])
self.assertEqual(igdb.igdb_api_key, "fresh_token")
self.assertEqual(mock_post.call_args_list[2].kwargs["headers"]["Authorization"], "Bearer fresh_token")
@patch("fjerkroa_bot.igdblib.time.time")
@patch("fjerkroa_bot.igdblib.requests.post")
def test_proactive_refresh_before_expiry(self, mock_post, mock_time):
"""An expired self-fetched token is refreshed before the request."""
mock_time.return_value = 1_000_000.0
mock_post.side_effect = [self._oauth_response("token_a", expires_in=5_000_000), self._api_response([])]
igdb = IGDBQuery("cid", client_secret="secret")
igdb.send_igdb_request("games", "fields name;")
# jump past the token expiry -> next request refreshes first
mock_time.return_value = 1_000_000.0 + 5_000_000
mock_post.side_effect = [self._oauth_response("token_b"), self._api_response([])]
igdb.send_igdb_request("games", "fields name;")
self.assertEqual(igdb.igdb_api_key, "token_b")
@patch("fjerkroa_bot.igdblib.requests.post")
def test_no_refresh_without_secret(self, mock_post):
"""Static-token setups keep the old behavior: no OAuth calls, error -> None."""
response = Mock()
response.status_code = 401
response.raise_for_status.side_effect = requests.RequestException("401 Client Error")
mock_post.return_value = response
igdb = IGDBQuery("cid", "expired_token")
result = igdb.send_igdb_request("games", "fields name; limit 1;")
self.assertIsNone(result)
mock_post.assert_called_once()
if __name__ == "__main__":
unittest.main()
+159
View File
@@ -0,0 +1,159 @@
"""Unit coverage for SPEC-014 Codex Mechanicus search (CDX-01..06)."""
import json
import unittest
from unittest.mock import AsyncMock, patch
from fjerkroa_bot.codex import CODEX_SEARCH_TOOL, CodexSearch
from fjerkroa_bot.openai_responder import OpenAIResponder
CONFIG = {"openai-token": "t", "model": "m", "system": "s", "history-limit": 5}
INDEX = {
"items": [
{
"id": "doctrine-heretek",
"collection": "doctrines",
"url": "/en/codex/doctrines/doctrine-heretek/",
"title": "Heretek — Doctrine of the Tech-Heretic",
"summary": "The label the Cult Mechanicus stamps on Tech-Priests who pursue forbidden sciences.",
"body": "xenotech, sentient machines, Warp-touched archeotech",
},
{
"id": "doctrine-heretek",
"collection": "doctrines",
"url": "/de/codex/doctrines/doctrine-heretek/",
"title": "Heretek — Doktrin des Techketzers",
"summary": "Das Etikett des Kultes Mechanicus fuer Techpriester verbotener Wissenschaften.",
"body": "Xenotech, empfindungsfaehige Maschinen",
},
{
"id": "forge-stygies",
"collection": "forges",
"url": "/en/codex/forges/forge-stygies/",
"title": "Stygies VIII",
"summary": "A forge world of shrouded reputation.",
"body": "The forge fields many Skitarii legions.",
},
]
}
def _reader(cfg):
reader = CodexSearch(lambda: cfg)
return reader
class TestToolOffered(unittest.TestCase):
def test_tool_present_only_when_enabled(self):
"""CDX-01: codex_search appears only with enable-codex."""
off = OpenAIResponder(CONFIG, "chat")
self.assertNotIn("codex_search", [f["name"] for f in off._available_tools()])
on = OpenAIResponder(dict(CONFIG, **{"enable-codex": True}), "chat")
self.assertIn("codex_search", [f["name"] for f in on._available_tools()])
self.assertEqual(CODEX_SEARCH_TOOL["name"], "codex_search")
class TestIndexGuardAndCache(unittest.IsolatedAsyncioTestCase):
async def test_internal_index_url_refused(self):
"""CDX-02: an index URL on a private address is refused before any fetch."""
reader = _reader({"enable-codex": True, "codex-index-url": "http://127.0.0.1/search-index.json"})
result = await reader.search("heretek")
self.assertIn("error", result)
async def test_index_cached_within_ttl(self):
"""CDX-02: a second search inside the TTL does not re-fetch the index."""
reader = _reader({"enable-codex": True, "codex-cache-ttl": 9999})
raw = json.dumps(INDEX).encode()
calls = [0]
class FakeResp:
status = 200
async def __aenter__(self):
return self
async def __aexit__(self, *a):
return False
def raise_for_status(self):
pass
class FakeSession:
def get(self, url):
calls[0] += 1
return FakeResp()
async def __aenter__(self):
return self
async def __aexit__(self, *a):
return False
with patch("fjerkroa_bot.codex.read_capped", new=AsyncMock(return_value=raw)):
with patch("fjerkroa_bot.codex.guard_url", return_value=None):
with patch("fjerkroa_bot.codex.aiohttp.ClientSession", return_value=FakeSession()):
first = await reader.search("heretek")
second = await reader.search("stygies")
self.assertEqual(calls[0], 1) # fetched once, served from cache the second time
self.assertTrue(first["results"] and second["results"])
class TestRankingAndLang(unittest.IsolatedAsyncioTestCase):
async def _search(self, cfg, query, lang="en"):
reader = _reader(dict({"enable-codex": True}, **cfg))
reader._cache = INDEX["items"]
reader._fetched_at = 1e18 # far future: never expires in test
with patch("fjerkroa_bot.codex.time.monotonic", return_value=1e18):
return await reader.search(query, lang)
async def test_title_hit_outranks_body_hit(self):
"""CDX-03: a title match ranks above a body-only match."""
result = await self._search({}, "heretek")
self.assertEqual(result["results"][0]["title"].split(" ")[0], "Heretek")
self.assertTrue(result["results"][0]["url"].startswith("https://binaric.tech/en/"))
async def test_lang_filter_selects_language(self):
"""CDX-04: lang=de returns the German inscription."""
result = await self._search({}, "heretek", lang="de")
self.assertTrue(all("/de/" in r["url"] for r in result["results"]))
self.assertIn("Techketzer", result["results"][0]["title"])
async def test_lang_fallback_when_absent(self):
"""CDX-04: a tongue with no match falls back to all tongues, not empty."""
result = await self._search({}, "stygies", lang="uk") # only en/de exist
self.assertTrue(result["results"])
self.assertEqual(result["results"][0]["title"], "Stygies VIII")
class TestSanitizeAndFailure(unittest.IsolatedAsyncioTestCase):
async def test_result_sanitized_and_capped(self):
"""CDX-05: title/summary are @-neutralized and length-capped."""
reader = _reader({"enable-codex": True, "codex-summary-chars": 40})
reader._cache = [{"collection": "x", "url": "/en/x/", "title": "@everyone hi", "summary": "@here " + "y" * 500, "body": "hit"}]
reader._fetched_at = 1e18
with patch("fjerkroa_bot.codex.time.monotonic", return_value=1e18):
result = await reader.search("hit")
top = result["results"][0]
self.assertNotIn("@everyone", top["title"])
self.assertNotIn("@here", top["summary"])
self.assertLessEqual(len(top["summary"]), 40)
async def test_index_failure_returns_error(self):
"""CDX-05: a broken index returns an error dict, never raises."""
reader = _reader({"enable-codex": True})
with patch.object(reader, "_load_index", new=AsyncMock(side_effect=ValueError("boom"))):
result = await reader.search("heretek")
self.assertIn("error", result)
class TestPerUserCap(unittest.IsolatedAsyncioTestCase):
async def test_dispatch_caps_searches(self):
"""CDX-06: over codex-daily-per-user, codex_search refuses without searching."""
responder = OpenAIResponder(dict(CONFIG, **{"enable-codex": True, "codex-daily-per-user": 2}), "chat")
responder.codex.search = AsyncMock(return_value={"query": "x", "results": []})
for _ in range(2):
await responder._dispatch_tool("codex_search", {"query": "heretek"}, "magos")
blocked = await responder._dispatch_tool("codex_search", {"query": "heretek"}, "magos")
self.assertIn("error", blocked)
self.assertEqual(responder.codex.search.await_count, 2)
+61
View File
@@ -45,6 +45,45 @@ class TestIngest(unittest.TestCase):
self.assertIsNone(cache.ingest_bytes(PNG, "chat", "alice", "1"))
class TestOversizedDownloadRejected(unittest.IsolatedAsyncioTestCase):
async def test_download_stays_over_limit_and_is_rejected(self):
"""IMG-10: an over-limit download must be rejected, not cached truncated."""
with tempfile.TemporaryDirectory() as tmp:
_, cache = make_cache(tmp, {"image-max-bytes": 32})
class FakeContent:
@staticmethod
async def iter_chunked(size):
yield PNG # 72 bytes > 32
class FakeResp:
content = FakeContent()
async def __aenter__(self):
return self
async def __aexit__(self, *a):
return False
def raise_for_status(self):
pass
class FakeSession:
def get(self, url):
return FakeResp()
async def __aenter__(self):
return self
async def __aexit__(self, *a):
return False
with patch("fjerkroa_bot.images.aiohttp.ClientSession", return_value=FakeSession()):
data = await cache._download("http://x.com/big.png")
self.assertEqual(len(data), 33) # limit + 1, not silently capped to limit
self.assertIsNone(await cache.ingest_url("http://x.com/big.png", "chat", "alice", "1"))
class TestVisionDataUrls(OpsBase):
async def test_attachment_becomes_data_url(self):
"""IMG-11: the model sees a data: URL, never the CDN link."""
@@ -158,6 +197,28 @@ class TestGeneratedImagesCached(OpsBase):
self.assertEqual(rows[0]["user"], "assistant")
class TestImageOnlyMessages(OpsBase):
async def test_image_only_post_cached_no_reply(self):
"""IMG-17: attachment without text -> cached + observed, no reply."""
with tempfile.TemporaryDirectory() as tmp:
store, cache = make_cache(tmp)
self.bot.airesponder.image_cache = cache
self.bot.airesponder.observe_event = AsyncMock()
self.bot.respond = AsyncMock()
message = self.public_msg("")
message.content = ""
message.channel.name = "chat"
attachment = Mock()
attachment.url = "https://cdn.discordapp.com/attachments/1/2/silent.png"
message.attachments = [attachment]
message.id = 77
with patch.object(ImageCache, "_download", new_callable=AsyncMock, return_value=PNG):
await self.bot.on_message(message)
self.assertEqual(len(store.images_recent("chat", 5)), 1)
self.bot.airesponder.observe_event.assert_awaited_once()
self.bot.respond.assert_not_awaited()
class TestContextAnnouncesImages(unittest.IsolatedAsyncioTestCase):
def test_suffix_mentions_picture_edit(self):
"""IMG-16: cached channel images are announced in the context suffix."""
+106
View File
@@ -0,0 +1,106 @@
"""Unit coverage for SPEC-012 health monitoring (OPS-18/19)."""
import unittest
from unittest.mock import AsyncMock
from fjerkroa_bot.monitor import HealthMonitor
class FakeLedger:
def __init__(self, spent=0.0):
self._spent = spent
def spent_usd(self):
return self._spent
class FakeStore:
def __init__(self, open_tasks=0):
self._n = open_tasks
def tasks_open(self):
return list(range(self._n))
def _monitor(cfg, ledger=None, store=None, disk=1000.0):
alert = AsyncMock()
monitor = HealthMonitor(lambda: cfg, ledger or FakeLedger(), store, lambda: disk, alert)
return monitor, alert
class TestEnabled(unittest.TestCase):
def test_opt_in(self):
"""OPS-18: monitoring is opt-in via enable-monitoring."""
self.assertFalse(_monitor({})[0].enabled())
self.assertTrue(_monitor({"enable-monitoring": True})[0].enabled())
class TestChecks(unittest.IsolatedAsyncioTestCase):
async def test_spend_over_threshold_alerts(self):
"""OPS-18: spend at/above frac*budget alerts."""
monitor, alert = _monitor({"daily-budget-usd": 2.0, "monitor-spend-alert-frac": 0.8}, ledger=FakeLedger(1.8))
await monitor.tick()
alert.assert_awaited_once()
self.assertIn("Spend", alert.await_args.args[0])
async def test_spend_under_threshold_silent(self):
"""OPS-18: spend below threshold stays silent."""
monitor, alert = _monitor({"daily-budget-usd": 2.0}, ledger=FakeLedger(0.5))
await monitor.tick()
alert.assert_not_awaited()
async def test_no_budget_skips_spend(self):
"""OPS-18: no budget configured -> spend check skipped, never fatal."""
monitor, alert = _monitor({"enable-monitoring": True}, ledger=FakeLedger(99))
await monitor.tick()
alert.assert_not_awaited()
async def test_low_disk_alerts(self):
"""OPS-18: free disk below the floor alerts."""
monitor, alert = _monitor({"monitor-disk-min-mb": 500}, disk=100.0)
await monitor.tick()
self.assertTrue(any("Low disk" in call.args[0] for call in alert.await_args_list))
async def test_disk_read_failure_skipped(self):
"""OPS-18: a failing disk read is skipped, not fatal."""
def boom():
raise OSError("nope")
alert = AsyncMock()
monitor = HealthMonitor(lambda: {}, FakeLedger(), None, boom, alert)
await monitor.tick()
alert.assert_not_awaited()
async def test_deep_queue_alerts(self):
"""OPS-18: task-queue depth at/above max alerts."""
monitor, alert = _monitor({"monitor-taskqueue-max": 3}, store=FakeStore(5), disk=9999.0)
await monitor.tick()
self.assertTrue(any("Task queue" in call.args[0] for call in alert.await_args_list))
async def test_no_store_skips_queue(self):
"""OPS-18: no store -> queue check skipped."""
monitor, alert = _monitor({"monitor-taskqueue-max": 1}, store=None, disk=9999.0)
await monitor.tick()
alert.assert_not_awaited()
class TestEdgeArming(unittest.IsolatedAsyncioTestCase):
async def test_fires_once_per_crossing(self):
"""OPS-19: a persistent over-threshold condition alerts once, not every tick."""
monitor, alert = _monitor({"daily-budget-usd": 2.0}, ledger=FakeLedger(1.9))
await monitor.tick()
await monitor.tick()
await monitor.tick()
self.assertEqual(alert.await_count, 1)
async def test_rearms_on_recovery(self):
"""OPS-19: recovery re-arms silently; the next crossing alerts again."""
ledger = FakeLedger(1.9)
monitor, alert = _monitor({"daily-budget-usd": 2.0}, ledger=ledger, disk=9999.0)
await monitor.tick() # over -> alert (1)
ledger._spent = 0.5
await monitor.tick() # recovered -> silent, re-arm
ledger._spent = 1.95
await monitor.tick() # over again -> alert (2)
self.assertEqual(alert.await_count, 2)
+334
View File
@@ -0,0 +1,334 @@
"""Unit coverage for SPEC-013 news digest + memory + tool (NEWS-01..12)."""
import tempfile
import unittest
from pathlib import Path
from unittest.mock import AsyncMock
from fjerkroa_bot.news import (
GET_NEWS_TOOL,
NewsFetcher,
NewsPoster,
load_seen,
parse_feed,
query_news,
render_digest,
save_seen,
)
from fjerkroa_bot.openai_responder import OpenAIResponder
from fjerkroa_bot.persistence import PersistentStore
CONFIG = {"openai-token": "t", "model": "m", "system": "s", "history-limit": 5}
RSS = b"""<?xml version="1.0"?><rss><channel>
<item><title>Game X released</title><link>https://ex.com/x</link></item>
<item><title>Patch Y notes</title><link>https://ex.com/y</link></item>
</channel></rss>"""
ATOM = b"""<?xml version="1.0"?><feed xmlns="http://www.w3.org/2005/Atom">
<entry><title>Atom headline</title><link href="https://ex.com/a"/></entry>
</feed>"""
RSS1 = (
'<?xml version="1.0" encoding="UTF-8"?>'
'<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns="http://purl.org/rss/1.0/">'
'<channel rdf:about="https://ex.jp"><title>Feed</title></channel>'
'<item rdf:about="https://ex.jp/1"><title>ゲームニュース</title><link>https://ex.jp/1</link>'
"<description>本文ここ</description></item>"
'<item rdf:about="https://ex.jp/2"><title>Second</title><link>https://ex.jp/2</link></item>'
"</rdf:RDF>"
).encode("utf-8")
class TestParse(unittest.TestCase):
def test_rss(self):
"""NEWS-01: RSS items parsed with title + link."""
items = parse_feed(RSS, "Src")
self.assertEqual([i["title"] for i in items], ["Game X released", "Patch Y notes"])
self.assertEqual(items[0]["link"], "https://ex.com/x")
self.assertEqual(items[0]["source"], "Src")
def test_atom(self):
"""NEWS-01: Atom entries parsed with href link."""
items = parse_feed(ATOM, "A")
self.assertEqual(items[0]["title"], "Atom headline")
self.assertEqual(items[0]["link"], "https://ex.com/a")
def test_rss1_rdf(self):
"""NEWS-01: RSS 1.0/RDF (namespaced <item>, e.g. 4gamer.net) parses like RSS 2.0."""
items = parse_feed(RSS1, "JP")
self.assertEqual([i["title"] for i in items], ["ゲームニュース", "Second"])
self.assertEqual(items[0]["link"], "https://ex.jp/1")
self.assertEqual(items[0]["summary"], "本文ここ")
def test_malformed_never_raises(self):
"""NEWS-01: garbage XML returns [] without raising."""
self.assertEqual(parse_feed(b"<not xml", "bad"), [])
self.assertEqual(parse_feed(b"", "empty"), [])
class TestDigest(unittest.TestCase):
def test_sanitized_and_capped(self):
"""NEWS-02: headlines sanitized, item count capped."""
items = [{"title": "@everyone big news \x00", "link": "", "source": "S"} for _ in range(20)]
digest = render_digest(items, max_items=5)
self.assertEqual(digest.count("\n"), 4) # 5 lines
self.assertNotIn("@everyone", digest)
self.assertNotIn("\x00", digest)
class TestCollect(unittest.IsolatedAsyncioTestCase):
async def test_ssrf_skip_and_dedup(self):
"""NEWS-03: guarded feed skipped, dup titles dropped, bad fetch survived."""
def guard(url):
return "refused" if "internal" in url else None
async def fetch(url):
if "boom" in url:
raise ValueError("boom")
return RSS # same content from two feeds -> dedup
fetcher = NewsFetcher(guard, fetch)
feeds = [
("https://a.com/feed", "A"),
("https://internal/feed", "Internal"), # SSRF-skipped
("https://boom.com/feed", "Boom"), # fetch fails
("https://b.com/feed", "B"), # same RSS -> dup titles dropped
]
items = await fetcher.collect(feeds, per_feed=5)
titles = [i["title"] for i in items]
self.assertEqual(titles, ["Game X released", "Patch Y notes"]) # deduped, internal+boom skipped
async def test_per_feed_limit(self):
"""NEWS-03: per-feed cap honored."""
fetcher = NewsFetcher(lambda u: None, AsyncMock(return_value=RSS))
items = await fetcher.collect([("https://a.com", "A")], per_feed=1)
self.assertEqual(len(items), 1)
class TestPoster(unittest.IsolatedAsyncioTestCase):
def poster(self, posts):
async def fetch(url):
return RSS
async def post(hook, content):
posts.append((hook, content))
return NewsPoster(lambda u: None, fetch, post)
async def test_posts_unseen_then_dedups(self):
"""NEWS-04: unseen items post to the mapped webhook; re-run posts nothing."""
posts = []
poster = self.poster(posts)
feeds = [("https://a.com/feed", "PS", "news")]
hooks = {"news": "https://discord.com/api/webhooks/x"}
posted, seen = await poster.run_post(feeds, hooks, set(), per_feed=5, max_per_run=8, seed_only=False)
self.assertEqual(posted, 2)
self.assertIn("PS", posts[0][1])
self.assertIn("https://discord.com/api/webhooks/x", posts[0][0])
# re-run with the accumulated seen -> nothing new
posts.clear()
posted2, _ = await poster.run_post(feeds, hooks, seen, per_feed=5, max_per_run=8, seed_only=False)
self.assertEqual(posted2, 0)
self.assertEqual(posts, [])
async def test_seed_run_posts_nothing(self):
"""NEWS-05: seed_only marks items seen without posting."""
posts = []
poster = self.poster(posts)
feeds = [("https://a.com/feed", "PS", "news")]
posted, seen = await poster.run_post(feeds, {"news": "h"}, set(), 5, 8, seed_only=True)
self.assertEqual(posted, 0)
self.assertEqual(posts, [])
self.assertEqual(len(seen), 2) # both marked seen
async def test_max_per_run_caps(self):
"""NEWS-05: max-per-run caps posts; extras stay seen (not re-posted next run)."""
posts = []
poster = self.poster(posts)
feeds = [("https://a.com/feed", "PS", "news")]
posted, seen = await poster.run_post(feeds, {"news": "h"}, set(), per_feed=5, max_per_run=1, seed_only=False)
self.assertEqual(posted, 1)
self.assertEqual(len(seen), 2) # both seen, only one posted
async def test_failures_survived(self):
"""NEWS-06: SSRF-skip, fetch fail, missing webhook, post error each survive."""
posts = []
async def fetch(url):
if "boom" in url:
raise ValueError("boom")
return RSS
async def post(hook, content):
if hook == "bad":
raise RuntimeError("post failed")
posts.append((hook, content))
def guard(url):
return "refused" if "internal" in url else None
poster = NewsPoster(guard, fetch, post)
feeds = [
("https://internal/feed", "I", "news"), # SSRF-skipped
("https://boom.com/feed", "B", "news"), # fetch fails
("https://ok.com/feed", "OK", "nowhere"), # no webhook for channel
("https://ok2.com/feed", "OK2", "news"), # webhook raises
]
posted, seen = await poster.run_post(feeds, {"news": "bad"}, set(), 5, 8, seed_only=False)
self.assertEqual(posted, 0) # everything failed/skipped, no crash
class TestSeenState(unittest.TestCase):
def test_roundtrip_and_seed_detection(self):
"""NEWS-05: missing state -> (empty, existed=False); saved state reloads."""
import tempfile
from pathlib import Path
with tempfile.TemporaryDirectory() as tmp:
path = str(Path(tmp) / "state.json")
seen, existed = load_seen(path)
self.assertEqual((seen, existed), (set(), False))
save_seen(path, {"a", "b", "c"}, cap=5000)
reloaded, existed2 = load_seen(path)
self.assertEqual(reloaded, {"a", "b", "c"})
self.assertTrue(existed2)
def test_cap_bounds_state(self):
"""NEWS-05: save keeps at most `cap` keys."""
import json
with tempfile.TemporaryDirectory() as tmp:
path = str(Path(tmp) / "state.json")
save_seen(path, {f"k{i}" for i in range(100)}, cap=10)
self.assertEqual(len(json.load(open(path))), 10)
RSS_DESC = b"""<?xml version="1.0"?><rss><channel>
<item><title>Storm hits coast</title><link>https://ex.com/s</link>
<description>&lt;p&gt;Heavy &lt;b&gt;wind&lt;/b&gt; expected&lt;/p&gt;</description></item>
</channel></rss>"""
ATOM_SUM = b"""<?xml version="1.0"?><feed xmlns="http://www.w3.org/2005/Atom">
<entry><title>Atom T</title><link href="https://ex.com/a"/><summary>Short gist here</summary></entry>
</feed>"""
class TestSummaries(unittest.TestCase):
def test_rss_description_stripped(self):
"""NEWS-07: RSS description parsed, HTML stripped, entities unescaped, whitespace collapsed."""
items = parse_feed(RSS_DESC, "S")
self.assertEqual(items[0]["summary"], "Heavy wind expected")
def test_atom_summary(self):
"""NEWS-07: Atom summary collapsed to clean text."""
items = parse_feed(ATOM_SUM, "A")
self.assertEqual(items[0]["summary"], "Short gist here")
def test_missing_description_is_empty(self):
"""NEWS-07: no description -> empty summary, never an error."""
self.assertEqual(parse_feed(RSS, "S")[0]["summary"], "")
def test_digest_carries_summary(self):
"""NEWS-08: digest appends the sanitized capped summary; zero cap = title only."""
items = [{"title": "T", "link": "https://ex.com/x", "source": "NRK", "summary": "the gist of it"}]
digest = render_digest(items, 10, 100)
self.assertIn("[NRK]", digest)
self.assertIn("the gist of it", digest)
self.assertNotIn("the gist", render_digest(items, 10, 0)) # zero cap -> title only
class NewsStoreBase(unittest.TestCase):
def setUp(self):
self.tmp = tempfile.TemporaryDirectory()
self.addCleanup(self.tmp.cleanup)
self.store = PersistentStore(Path(self.tmp.name) / "bot.db")
class TestNewsStore(NewsStoreBase):
def test_dedup_and_rolling_window(self):
"""NEWS-09: items deduped by link; prune keeps the newest N."""
first = [
{"title": "A", "link": "L1", "source": "S", "summary": "sa"},
{"title": "B", "link": "L2", "source": "S", "summary": "sb"},
]
self.assertEqual(self.store.add_news_items(first), 2)
self.assertEqual(self.store.add_news_items([dict(first[0])]), 0) # dup link ignored
self.assertEqual(self.store.news_count(), 2)
self.store.prune_news(1)
self.assertEqual(self.store.news_count(), 1)
self.assertEqual(self.store.recent_news(5)[0]["title"], "B") # newest survives
def test_dedup_by_title_when_no_link(self):
"""NEWS-09: linkless items dedup on title."""
self.store.add_news_items([{"title": "Same", "link": "", "source": "S", "summary": ""}])
self.store.add_news_items([{"title": "Same", "link": "", "source": "S", "summary": ""}])
self.assertEqual(self.store.news_count(), 1)
class TestQueryNews(NewsStoreBase):
def seed(self):
self.store.add_news_items(
[
{"title": "Nordland storm", "link": "L1", "source": "Nordland", "summary": "strong wind on the coast"},
{"title": "Oslo budget", "link": "L2", "source": "NRK", "summary": "@everyone spending plan"},
{"title": "Sport result", "link": "L3", "source": "Sport", "summary": "the match ended"},
]
)
def test_topic_filter(self):
"""NEWS-11: topic keywords must appear in title or summary."""
self.seed()
res = query_news(self.store, topic="storm")
self.assertEqual([r["title"] for r in res["results"]], ["Nordland storm"])
def test_topic_matches_source_label(self):
"""NEWS-11: topic also matches the source label, so 'Nordland' finds regional items."""
self.store.add_news_items([{"title": "Ferry delayed", "link": "LX", "source": "Nordland", "summary": "boat late"}])
res = query_news(self.store, topic="Nordland")
self.assertTrue(any(r["link"] == "LX" for r in res["results"])) # matched via source, not title/summary
def test_source_filter_and_sanitize(self):
"""NEWS-11: source narrows results; title/summary are sanitized."""
self.seed()
res = query_news(self.store, source="NRK")
self.assertTrue(res["results"] and all(r["source"] == "NRK" for r in res["results"]))
self.assertNotIn("@everyone", res["results"][0]["summary"])
def test_limit_clamped_and_no_store(self):
"""NEWS-11: limit clamps to 1..30; a missing store returns an error."""
self.seed()
self.assertLessEqual(len(query_news(self.store, limit=999)["results"]), 30)
self.assertGreaterEqual(len(query_news(self.store, limit=0)["results"]), 1)
self.assertIn("error", query_news(None))
class TestNewsTool(unittest.IsolatedAsyncioTestCase):
def setUp(self):
self.tmp = tempfile.TemporaryDirectory()
self.addCleanup(self.tmp.cleanup)
def _responder(self, **extra):
cfg = dict(CONFIG, **{"history-directory": self.tmp.name}, **extra)
return OpenAIResponder(cfg, "chat")
def test_tool_offered_needs_flag_and_store(self):
"""NEWS-10: get_news offered only with enable-news-tool AND a store."""
no_store = OpenAIResponder(dict(CONFIG, **{"enable-news-tool": True}), "chat")
self.assertIsNone(no_store.store)
self.assertNotIn("get_news", [f["name"] for f in no_store._available_tools()])
flag_off = self._responder()
self.assertNotIn("get_news", [f["name"] for f in flag_off._available_tools()])
on = self._responder(**{"enable-news-tool": True})
self.assertIn("get_news", [f["name"] for f in on._available_tools()])
self.assertEqual(GET_NEWS_TOOL["name"], "get_news")
async def test_dispatch_caps_news(self):
"""NEWS-12: over news-daily-per-user, get_news refuses without querying."""
responder = self._responder(**{"enable-news-tool": True, "news-daily-per-user": 2})
responder.store.add_news_items([{"title": "x", "link": "l", "source": "s", "summary": "y"}])
for _ in range(2):
self.assertIn("results", await responder._dispatch_tool("get_news", {}, "alice"))
blocked = await responder._dispatch_tool("get_news", {}, "alice")
self.assertIn("error", blocked)
+66
View File
@@ -133,3 +133,69 @@ class TestTasksKillSwitch(OpsBase):
"""OPS-09: bot-initiated posts respect pause/quiet."""
await self.bot.on_message(self.staff_msg("!bot pause"))
self.assertFalse(self.bot.bot_initiated_allowed())
class TestHelp(OpsBase):
STAFF_CMDS = (
"pause",
"resume",
"quiet <minutes>",
"status",
"spend",
"images on|off",
"memory <user>",
"forget-fact <id>",
"pin <channel|global>",
"unpin <id>",
"pins",
"task-approve <id>",
"task-cancel <id>",
"(list)",
)
def test_staff_help_is_complete_and_grouped(self):
"""OPS-17: staff help lists every operator command, grouped by purpose."""
text = self.bot._help_text(staff=True)
for cmd in self.STAFF_CMDS:
self.assertIn(cmd, text, f"missing {cmd!r} in staff help")
for group in ("Control:", "Cost:", "Memory:", "Tasks:"):
self.assertIn(group, text)
for cmd in ("!help", "!forgetme", "!privacy", "!wichtel"):
self.assertIn(cmd, text) # everywhere-commands shown too
def test_user_help_hides_operator_commands(self):
"""OPS-17: non-staff help shows only the everyone-commands."""
text = self.bot._help_text(staff=False)
for cmd in ("!help", "!forgetme", "!privacy", "!wichtel"):
self.assertIn(cmd, text)
for op in ("task-approve", "images on|off", "spend", "Staff commands", "Control:"):
self.assertNotIn(op, text)
async def test_bot_help_in_staff_channel_returns_full_help(self):
"""OPS-17: `!bot help` answers with the complete staff help."""
await self.bot.on_message(self.staff_msg("!bot help"))
text = self.bot.staff_channel.send.await_args.args[0]
self.assertIn("Staff commands", text)
self.assertIn("task-cancel <id>", text)
async def test_unknown_bot_command_falls_back_to_help(self):
"""OPS-17: an unrecognised `!bot` command shows the full help, not a partial line."""
await self.bot.on_message(self.staff_msg("!bot wat"))
text = self.bot.staff_channel.send.await_args.args[0]
self.assertIn("Control:", text)
async def test_help_in_public_channel_is_user_scoped(self):
"""OPS-17: `!help` in a normal channel lists only everyone-commands."""
msg = self.public_msg("!help")
await self.bot.on_message(msg)
text = msg.channel.send.await_args.args[0]
self.assertIn("!forgetme", text)
self.assertNotIn("Staff commands", text)
self.assertNotIn("task-approve", text)
async def test_help_works_while_paused(self):
"""OPS-17: help answers even when replies are paused."""
await self.bot.on_message(self.staff_msg("!bot pause"))
msg = self.public_msg("!help")
await self.bot.on_message(msg)
msg.channel.send.assert_awaited()
+100
View File
@@ -0,0 +1,100 @@
"""Unit coverage for SPEC-012 ops hardening (OPS-13/14/16)."""
import gzip
import sqlite3
import stat
import sys
import tempfile
import unittest
from pathlib import Path
from unittest.mock import AsyncMock, MagicMock
from fjerkroa_bot.persistence import PersistentStore
from .test_spec_ops import OpsBase
sys.path.insert(0, str(Path(__file__).resolve().parent.parent / "deploy"))
import backup_db # noqa: E402
class TestSnapshotConsistency(unittest.TestCase):
def test_snapshot_roundtrips(self):
"""OPS-13: a gzipped snapshot restores to a readable DB with the same rows, 0600."""
with tempfile.TemporaryDirectory() as tmp:
db = Path(tmp) / "bot.db"
store = PersistentStore(db)
store.save_history("chat", [{"role": "user", "content": "hei"}])
store.add_user_fact("alice", "likes espresso", "self")
dest = Path(tmp) / "snap.db.gz"
backup_db.snapshot(db, dest)
self.assertEqual(stat.S_IMODE(dest.stat().st_mode), 0o600)
restored = Path(tmp) / "restored.db"
with gzip.open(dest, "rb") as gz, open(restored, "wb") as out:
out.write(gz.read())
conn = sqlite3.connect(restored)
try:
rows = conn.execute("SELECT content FROM history WHERE channel='chat'").fetchall()
facts = conn.execute("SELECT fact FROM user_facts").fetchall()
finally:
conn.close()
self.assertEqual(rows, [("hei",)])
self.assertEqual(facts, [("likes espresso",)])
def test_snapshot_during_writes(self):
"""OPS-13: snapshot succeeds while another connection holds the DB open (WAL)."""
with tempfile.TemporaryDirectory() as tmp:
db = Path(tmp) / "bot.db"
store = PersistentStore(db)
store.save_history("chat", [{"role": "user", "content": "x"}])
live = sqlite3.connect(db) # simulate the running bot's open handle
live.execute("PRAGMA journal_mode=WAL")
try:
dest = Path(tmp) / "snap.db.gz"
backup_db.snapshot(db, dest) # must not raise
self.assertTrue(dest.exists())
finally:
live.close()
class TestRotation(unittest.TestCase):
def test_victims_keeps_newest(self):
"""OPS-14: only the oldest beyond `keep` are selected for deletion."""
names = [f"bot-2026070{d}-000000.db.gz" for d in range(1, 8)] # 7 chronological
victims = backup_db.victims(list(reversed(names)), keep=3)
self.assertEqual(victims, names[:4]) # oldest 4 removed, newest 3 kept
def test_victims_under_keep_deletes_nothing(self):
"""OPS-14: fewer than `keep` backups -> nothing deleted."""
self.assertEqual(backup_db.victims(["bot-20260701-000000.db.gz"], keep=14), [])
def test_rotate_on_disk(self):
"""OPS-14: rotate removes the right files from a real dir."""
with tempfile.TemporaryDirectory() as tmp:
for d in range(1, 6):
(Path(tmp) / f"bot-2026070{d}-000000.db.gz").write_bytes(b"x")
removed = backup_db.rotate(Path(tmp), keep=2)
self.assertEqual(removed, 3)
self.assertEqual(len(list(Path(tmp).glob("bot-*.db.gz"))), 2)
class TestApiErrorAlert(OpsBase):
async def test_threshold_alert_and_reset(self):
"""OPS-16: N consecutive failures fire one staff alert; success resets."""
self.bot.config["api-error-alert-threshold"] = 3
self.bot.send_message_with_typing = AsyncMock(side_effect=RuntimeError("boom"))
origin = MagicMock()
from fjerkroa_bot.ai_responder import AIMessage
for _ in range(3):
await self.bot.respond(AIMessage("alice", "hei", "chat"), origin)
self.assertEqual(self.bot.staff_channel.send.await_count, 1) # exactly one alert at threshold
self.assertEqual(self.bot._consecutive_api_errors, 3)
# a success resets the counter
from fjerkroa_bot.ai_responder import AIResponse
self.bot.send_message_with_typing = AsyncMock(return_value=AIResponse(None, False, "chat", None, None, False, False))
await self.bot.respond(AIMessage("alice", "hei", "chat"), origin)
self.assertEqual(self.bot._consecutive_api_errors, 0)
+165
View File
@@ -0,0 +1,165 @@
"""Unit coverage for SPEC-005 self-tasking (TSK-01..08) + OPS-12."""
import tempfile
import unittest
from pathlib import Path
from unittest.mock import AsyncMock
from fjerkroa_bot.persistence import PersistentStore
from fjerkroa_bot.quota import QuotaLedger
from fjerkroa_bot.tasks import TaskEngine
from .test_spec_ops import OpsBase
class EngineBase(unittest.IsolatedAsyncioTestCase):
def setUp(self):
self.tmp = tempfile.TemporaryDirectory()
self.addCleanup(self.tmp.cleanup)
self.store = PersistentStore(Path(self.tmp.name) / "bot.db")
self.config = {"tasks-enabled": True, "chat-channel": "chat", "taskgen-interval-hours": 0}
self.ledger = QuotaLedger(self.store, lambda: self.config)
self.execute = AsyncMock()
self.propose = AsyncMock(return_value={"task": None})
self.alert = AsyncMock()
self.observe = AsyncMock()
self.idle = lambda: 0.0
self.engine = TaskEngine(
self.store,
self.ledger,
lambda: self.config,
self.execute,
self.propose,
self.alert,
lambda: True,
lambda: self.idle(),
self.observe,
)
class TestQueuePersistence(EngineBase):
async def test_tasks_survive_restart(self):
"""TSK-01: enqueued tasks are store rows and reload in a fresh store."""
await self.engine.enqueue("follow-up", "chat", "frag bob nach der pruefung", due_hours=1)
reborn = PersistentStore(Path(self.tmp.name) / "bot.db")
tasks = reborn.tasks_open()
self.assertEqual(len(tasks), 1)
self.assertEqual((tasks[0]["kind"], tasks[0]["channel"], tasks[0]["state"]), ("follow-up", "chat", "queued"))
class TestExecution(EngineBase):
async def test_due_task_executes_and_completes(self):
"""TSK-02: due task runs via execute callback, marked done, observed."""
await self.engine.enqueue("idle-impulse", "chat", "sag was nettes")
await self.engine.tick()
self.execute.assert_awaited_once_with("chat", "sag was nettes")
self.assertEqual(self.store.tasks_open(), [])
self.observe.assert_awaited()
async def test_failed_execution_marked_failed(self):
"""TSK-02: execute raising marks the task failed, not done."""
self.execute.side_effect = RuntimeError("channel gone")
await self.engine.enqueue("idle-impulse", "chat", "x")
await self.engine.tick()
self.assertEqual(self.store.tasks_open(), []) # not queued anymore
rows = [t for t in self.store.tasks_due()]
self.assertEqual(rows, [])
class TestDefaultOff(EngineBase):
async def test_disabled_engine_is_dormant(self):
"""TSK-03: without tasks-enabled nothing executes or generates."""
self.store.task_add("idle-impulse", "chat", "2020-01-01 00:00:00", "x")
self.config.pop("tasks-enabled")
await self.engine.tick()
self.execute.assert_not_awaited()
self.propose.assert_not_awaited()
class TestDailyCap(EngineBase):
async def test_cap_defers_excess_tasks(self):
"""TSK-04: over the per-channel cap tasks stay queued."""
self.config["tasks-max-per-channel-per-day"] = 1
self.store.task_add("a", "chat", "2020-01-01 00:00:00", "one")
self.store.task_add("b", "chat", "2020-01-01 00:00:00", "two")
await self.engine.tick()
self.assertEqual(self.execute.await_count, 1)
self.assertEqual(len(self.store.tasks_open()), 1)
class TestApproval(EngineBase):
async def test_approval_flow(self):
"""TSK-05: approval mode holds tasks until approved; cancel kills them."""
self.config["tasks-approval"] = True
task_id = await self.engine.enqueue("follow-up", "chat", "frag nach")
self.alert.assert_awaited_once()
await self.engine.tick()
self.execute.assert_not_awaited() # approval != due
self.store.task_set_state(task_id, "queued")
await self.engine.tick()
self.execute.assert_awaited_once()
class TestKillSwitch(EngineBase):
async def test_not_allowed_blocks_tick(self):
"""TSK-06: bot_initiated_allowed()=False stops execution."""
self.store.task_add("a", "chat", "2020-01-01 00:00:00", "x")
engine = TaskEngine(
self.store, self.ledger, lambda: self.config, self.execute, self.propose, self.alert, lambda: False, lambda: 0.0, self.observe
)
await engine.tick()
self.execute.assert_not_awaited()
class TestIdleImpulse(EngineBase):
async def test_idle_enqueues_once(self):
"""TSK-07: long idle enqueues one impulse; pending impulse dedupes."""
self.config["idle-impulse-hours"] = 1
self.config["boreness-prompt"] = "denk dir was aus"
self.idle = lambda: 2 * 3600.0
await self.engine.tick()
open_tasks = self.store.tasks_open()
impulse = [t for t in open_tasks if t["kind"] == "idle-impulse"]
self.assertEqual(len(impulse), 0) # executed immediately (due now)
self.execute.assert_awaited_once_with("chat", "denk dir was aus")
async def test_short_idle_no_impulse(self):
"""TSK-07: below the idle threshold nothing is generated."""
self.config["idle-impulse-hours"] = 12
self.idle = lambda: 60.0
await self.engine.tick()
self.execute.assert_not_awaited()
class TestFollowUpGenerator(EngineBase):
async def test_proposal_becomes_task(self):
"""TSK-08: a proposed task is enqueued with its due offset."""
self.config.pop("chat-channel")
self.propose.return_value = {"task": {"channel": "chat", "prompt": "frag bob", "due_hours": 24}}
await self.engine.tick()
tasks = self.store.tasks_open()
self.assertEqual(len(tasks), 1)
self.assertEqual(tasks[0]["kind"], "follow-up")
async def test_null_proposal_no_task(self):
"""TSK-08: null proposal enqueues nothing."""
self.propose.return_value = {"task": None}
await self.engine.tick()
self.assertEqual(self.store.tasks_open(), [])
class TestTaskCommands(OpsBase):
async def test_list_approve_cancel(self):
"""OPS-12: !bot tasks lists; task-approve/task-cancel manage states."""
with tempfile.TemporaryDirectory() as tmp:
store = PersistentStore(Path(tmp) / "bot.db")
self.bot.airesponder.store = store
task_id = store.task_add("follow-up", "chat", "2099-01-01 00:00:00", "frag bob", "approval")
await self.bot.on_message(self.staff_msg("!bot tasks"))
listing = self.bot.staff_channel.send.await_args.args[0]
self.assertIn("follow-up", listing)
self.assertIn("approval", listing)
await self.bot.on_message(self.staff_msg(f"!bot task-approve {task_id}"))
self.assertEqual(store.tasks_open()[0]["state"], "queued")
await self.bot.on_message(self.staff_msg(f"!bot task-cancel {task_id}"))
self.assertEqual(store.tasks_open(), [])
+242
View File
@@ -0,0 +1,242 @@
"""Unit coverage for SPEC-011 URL reading (URL-01..07)."""
import unittest
from unittest.mock import AsyncMock, patch
from fjerkroa_bot.openai_responder import OpenAIResponder
from fjerkroa_bot.url_reader import FETCH_URL_TOOL, URLReader, guard_url
CONFIG = {"openai-token": "t", "model": "m", "system": "s", "history-limit": 5}
class TestToolOffered(unittest.TestCase):
def test_tool_present_only_when_enabled(self):
"""URL-01: fetch_url appears in the tool list only with enable-url-reading."""
off = OpenAIResponder(CONFIG, "chat")
self.assertNotIn("fetch_url", [f["name"] for f in off._available_tools()])
on = OpenAIResponder(dict(CONFIG, **{"enable-url-reading": True}), "chat")
self.assertIn("fetch_url", [f["name"] for f in on._available_tools()])
self.assertEqual(FETCH_URL_TOOL["name"], "fetch_url")
class TestSchemeGuard(unittest.TestCase):
def test_non_http_schemes_refused(self):
"""URL-02: only http/https pass the guard."""
self.assertIsNone(guard_url("https://example.com/article"))
for bad in ("file:///etc/passwd", "ftp://host/x", "data:text/html,x", "gopher://h", "no-scheme.com/x"):
self.assertIsNotNone(guard_url(bad))
class TestSSRFGuard(unittest.TestCase):
def test_private_and_loopback_refused(self):
"""URL-03: private/loopback/link-local literals are refused without DNS."""
for bad in (
"http://127.0.0.1/admin",
"http://localhost/x", # resolves to loopback
"http://10.0.0.5/x",
"http://192.168.1.1/x",
"http://169.254.169.254/latest/meta-data", # cloud metadata
"http://[::1]/x",
):
self.assertIsNotNone(guard_url(bad), f"{bad} should be refused")
def test_public_ip_allowed(self):
"""URL-03: a public IP literal passes."""
self.assertIsNone(guard_url("http://93.184.216.34/"))
@patch("fjerkroa_bot.url_reader.socket.getaddrinfo")
def test_dns_to_private_refused(self, getaddrinfo):
"""URL-03: a hostname resolving to a private IP is refused."""
getaddrinfo.return_value = [(2, 1, 6, "", ("10.1.2.3", 0))]
self.assertIsNotNone(guard_url("http://evil.example.com/x"))
class TestRedirectRevalidation(unittest.IsolatedAsyncioTestCase):
async def test_redirect_to_internal_refused(self):
"""URL-04: a public URL redirecting to localhost is refused at the hop."""
reader = URLReader(lambda: {}, None)
class FakeResp:
status = 302
headers = {"Location": "http://127.0.0.1/secret"}
url = "http://safe.example.com"
async def __aenter__(self):
return self
async def __aexit__(self, *a):
return False
def raise_for_status(self):
pass
class FakeSession:
def get(self, url, allow_redirects=False):
return FakeResp()
with patch("fjerkroa_bot.url_reader.guard_url", side_effect=[None, "refused internal"]):
with self.assertRaises(ValueError):
await reader._get(FakeSession(), "http://safe.example.com", 1000)
class TestMetaRefresh(unittest.IsolatedAsyncioTestCase):
async def test_follows_meta_refresh_to_real_article(self):
"""URL-04: a getnews-style meta-refresh stub is followed to the real article."""
reader = URLReader(lambda: {}, None)
stub = (
b'<html><head><meta http-equiv="refresh" content="0;url=https://pushsquare.com/real"></head><body>Redirecting...</body></html>'
)
article = b"<html><body><h1>MARVEL Tokon</h1><p>Full article text here</p></body></html>"
calls = []
async def fake_get(session, url, max_bytes):
calls.append(url)
return (url, stub if "stub" in url else article)
reader._get = fake_get # type: ignore
with patch("fjerkroa_bot.url_reader.guard_url", return_value=None):
import fjerkroa_bot.url_reader as ur
# patch the session context so fetch() runs against fake_get
class FakeCM:
async def __aenter__(self):
return object()
async def __aexit__(self, *a):
return False
with patch.object(ur.aiohttp, "ClientSession", return_value=FakeCM()):
result = await reader.fetch("https://gggemein.de/url/stub.html", "chat", "alice")
self.assertIn("Full article text", result["text"])
self.assertEqual(result["url"], "https://pushsquare.com/real")
self.assertIn("https://pushsquare.com/real", calls)
async def test_meta_refresh_to_internal_is_not_followed(self):
"""URL-04: a meta-refresh pointing at an internal IP is refused (SSRF)."""
reader = URLReader(lambda: {}, None)
stub = b'<meta http-equiv="refresh" content="0; url=http://127.0.0.1/secret">Redirecting'
async def fake_get(session, url, max_bytes):
return (url, stub)
reader._get = fake_get # type: ignore
import fjerkroa_bot.url_reader as ur
class FakeCM:
async def __aenter__(self):
return object()
async def __aexit__(self, *a):
return False
def guard(u):
return "refused" if "127.0.0.1" in u else None
with patch("fjerkroa_bot.url_reader.guard_url", side_effect=guard):
with patch.object(ur.aiohttp, "ClientSession", return_value=FakeCM()):
result = await reader.fetch("https://safe.com/x", "chat", "alice")
self.assertEqual(result["url"], "https://safe.com/x") # did not follow to 127.0.0.1
class TestTextExtraction(unittest.TestCase):
def test_html_reduced_to_text(self):
"""URL-05: scripts/styles dropped, tags stripped."""
reader = URLReader(lambda: {}, None)
html = "<html><head><style>x{}</style></head><body><h1>Titel</h1><script>evil()</script><p>Inhalt hier</p></body></html>"
text = reader._to_text(html)
self.assertIn("Titel", text)
self.assertIn("Inhalt hier", text)
self.assertNotIn("evil", text)
self.assertNotIn("x{}", text)
class TestBodyReadCollectsAllChunks(unittest.IsolatedAsyncioTestCase):
async def test_get_reads_past_first_chunk(self):
"""URL-05 regression: body arrives in many chunks; all are collected up to the cap."""
reader = URLReader(lambda: {}, None)
chunks = [b"<title>t</title>", b"<p>middle</p>", b"<p>end</p>"]
class FakeContent:
@staticmethod
async def iter_chunked(size):
for chunk in chunks:
yield chunk
class FakeResp:
status = 200
headers = {}
url = "http://safe.example.com"
content = FakeContent()
async def __aenter__(self):
return self
async def __aexit__(self, *a):
return False
def raise_for_status(self):
pass
class FakeSession:
def get(self, url, allow_redirects=False):
return FakeResp()
with patch("fjerkroa_bot.url_reader.guard_url", return_value=None):
_, body = await reader._get(FakeSession(), "http://safe.example.com", 1000)
self.assertEqual(body, b"".join(chunks))
with patch("fjerkroa_bot.url_reader.guard_url", return_value=None):
_, body = await reader._get(FakeSession(), "http://safe.example.com", 20)
self.assertEqual(body, b"".join(chunks)[:20])
class TestFetchSanitizes(unittest.IsolatedAsyncioTestCase):
async def test_fetch_result_is_sanitized_and_capped(self):
"""URL-05: fetch output is length-capped and @everyone-neutralized."""
reader = URLReader(lambda: {"url-max-chars": 50}, None)
payload = ("<p>@everyone " + "x" * 5000 + "</p>").encode()
with patch.object(reader, "_get", new=AsyncMock(return_value=("http://x.com", payload))):
result = await reader.fetch("http://x.com", "chat", "alice")
self.assertLessEqual(len(result["text"]), 50)
self.assertNotIn("@everyone", result["text"])
async def test_fetch_error_is_reported_not_raised(self):
"""URL-05: a fetch failure returns an error dict the model can relay."""
reader = URLReader(lambda: {}, None)
with patch.object(reader, "_get", new=AsyncMock(side_effect=ValueError("refused non-public address"))):
result = await reader.fetch("http://10.0.0.1", "chat", "alice")
self.assertIn("error", result)
class TestImageIngest(unittest.IsolatedAsyncioTestCase):
async def test_page_images_go_to_cache_ssrf_guarded(self):
"""URL-06: og:image + <img> ingested (cap honored), internal srcs skipped."""
cache = type("C", (), {})()
cache.ingest_url = AsyncMock(side_effect=["sha1", "sha2", "sha3"])
reader = URLReader(lambda: {"url-max-images": 2}, cache)
html = (
'<meta property="og:image" content="https://cdn.example.com/hero.jpg">'
'<img src="https://cdn.example.com/a.png"><img src="http://127.0.0.1/internal.png">'
)
# guard by scheme/loopback only, no real DNS in the test
def fake_guard(url):
return "refused" if "127.0.0.1" in url else None
with patch("fjerkroa_bot.url_reader.guard_url", side_effect=fake_guard):
count = await reader._ingest_images(html, "https://example.com", "chat", "alice")
self.assertEqual(count, 2) # og:image + first public img, cap 2
ingested = [call.args[0] for call in cache.ingest_url.await_args_list]
self.assertNotIn("http://127.0.0.1/internal.png", ingested)
class TestPerUserCap(unittest.IsolatedAsyncioTestCase):
async def test_dispatch_caps_fetches(self):
"""URL-07: over url-daily-per-user, fetch_url returns an error without fetching."""
responder = OpenAIResponder(dict(CONFIG, **{"enable-url-reading": True, "url-daily-per-user": 2}), "chat")
responder.url_reader.fetch = AsyncMock(return_value={"url": "x", "text": "ok"})
for _ in range(2):
await responder._dispatch_tool("fetch_url", {"url": "http://x.com"}, "alice")
blocked = await responder._dispatch_tool("fetch_url", {"url": "http://x.com"}, "alice")
self.assertIn("error", blocked)
self.assertEqual(responder.url_reader.fetch.await_count, 2)
+102
View File
@@ -0,0 +1,102 @@
"""Unit coverage for SPEC-015 web search via Exa (WEB-01..05)."""
import os
import unittest
from unittest.mock import AsyncMock, patch
from fjerkroa_bot.openai_responder import OpenAIResponder
from fjerkroa_bot.websearch import WEB_SEARCH_TOOL, WebSearch, _format_results
CONFIG = {"openai-token": "t", "model": "m", "system": "s", "history-limit": 5}
def _tool_names(responder):
return [f["name"] for f in responder._available_tools()]
class TestToolOffered(unittest.TestCase):
def test_gate_needs_flag_and_key(self):
"""WEB-01: web_search offered only with enable-web-search AND a key."""
off = OpenAIResponder(CONFIG, "chat") # flag off -> absent even if env key exists
self.assertNotIn("web_search", _tool_names(off))
on = OpenAIResponder(dict(CONFIG, **{"enable-web-search": True, "exa-api-key": "k"}), "chat")
self.assertIn("web_search", _tool_names(on))
self.assertEqual(WEB_SEARCH_TOOL["name"], "web_search")
with patch.dict(os.environ, {"EXA_API_KEY": ""}):
nokey = OpenAIResponder(dict(CONFIG, **{"enable-web-search": True}), "chat")
self.assertNotIn("web_search", _tool_names(nokey))
class TestFormat(unittest.TestCase):
def test_results_sanitized_and_capped(self):
"""WEB-02: title/snippet sanitized + capped; non-dict rows skipped."""
data = {
"results": [
{"title": "@everyone Hi", "url": "https://x.com/a", "text": "@here " + "y" * 1000, "publishedDate": "2026-01-01"},
{"title": "T2", "url": "https://x.com/b", "text": "short"},
"not a dict",
]
}
rows = _format_results(data, 50)
self.assertEqual(len(rows), 2)
self.assertNotIn("@everyone", rows[0]["title"])
self.assertNotIn("@here", rows[0]["snippet"])
self.assertLessEqual(len(rows[0]["snippet"]), 50)
self.assertEqual(rows[0]["url"], "https://x.com/a")
self.assertEqual(rows[0]["published"], "2026-01-01")
class TestSearch(unittest.IsolatedAsyncioTestCase):
async def test_num_results_clamped(self):
"""WEB-03: numResults clamped to 1..10; 0 falls back to default."""
ws = WebSearch(lambda: {"exa-api-key": "k"})
with patch.object(ws, "_post", new=AsyncMock(return_value={"results": []})) as post:
await ws.search("hi", num_results=999)
self.assertEqual(post.await_args.args[0]["numResults"], 10)
await ws.search("hi", num_results=0)
self.assertEqual(post.await_args.args[0]["numResults"], 5)
async def test_no_key_returns_error(self):
"""WEB-04: no key -> error dict, no network call."""
with patch.dict(os.environ, {"EXA_API_KEY": ""}):
ws = WebSearch(lambda: {})
with patch.object(ws, "_post", new=AsyncMock()) as post:
result = await ws.search("hi")
post.assert_not_awaited()
self.assertIn("error", result)
async def test_api_failure_returns_error(self):
"""WEB-04: a raising request is caught, returns an error dict."""
ws = WebSearch(lambda: {"exa-api-key": "k"})
with patch.object(ws, "_post", new=AsyncMock(side_effect=RuntimeError("boom"))):
result = await ws.search("hi")
self.assertIn("error", result)
async def test_empty_query_no_call(self):
"""WEB-04: blank query returns empty results without a call."""
ws = WebSearch(lambda: {"exa-api-key": "k"})
with patch.object(ws, "_post", new=AsyncMock()) as post:
result = await ws.search(" ")
post.assert_not_awaited()
self.assertEqual(result["results"], [])
async def test_search_returns_formatted(self):
"""WEB-02: a successful search returns sanitized rows."""
ws = WebSearch(lambda: {"exa-api-key": "k"})
payload = {"results": [{"title": "Norge", "url": "https://ex.com/n", "text": "fakta"}]}
with patch.object(ws, "_post", new=AsyncMock(return_value=payload)):
result = await ws.search("norge")
self.assertEqual(result["results"][0]["title"], "Norge")
self.assertEqual(result["results"][0]["url"], "https://ex.com/n")
class TestPerUserCap(unittest.IsolatedAsyncioTestCase):
async def test_dispatch_caps_searches(self):
"""WEB-05: over web-daily-per-user, web_search refuses without calling the API."""
responder = OpenAIResponder(dict(CONFIG, **{"enable-web-search": True, "exa-api-key": "k", "web-daily-per-user": 2}), "chat")
responder.web_search.search = AsyncMock(return_value={"query": "x", "results": []})
for _ in range(2):
self.assertIn("results", await responder._dispatch_tool("web_search", {"query": "hi"}, "bob"))
blocked = await responder._dispatch_tool("web_search", {"query": "hi"}, "bob")
self.assertIn("error", blocked)
self.assertEqual(responder.web_search.search.await_count, 2)
Generated
+2
View File
@@ -627,6 +627,7 @@ version = "3.0.0"
source = { editable = "." }
dependencies = [
{ name = "aiohttp" },
{ name = "defusedxml" },
{ name = "discord-py" },
{ name = "openai" },
{ name = "requests" },
@@ -656,6 +657,7 @@ dev = [
[package.metadata]
requires-dist = [
{ name = "aiohttp", specifier = ">=3.12" },
{ name = "defusedxml", specifier = ">=0.7" },
{ name = "discord-py", specifier = ">=2.5,<3" },
{ name = "openai", specifier = ">=2.45" },
{ name = "requests", specifier = ">=2.32" },