Implement new storage design per issue #2

- Replace SQLite db module with file-based JSON storage in ~/.jigaido/
- Group bounties: ~/.jigaido/{group_id}/group.json
- User tracking: ~/.jigaido/{group_id}/user_{id}.json
- Personal bounties: ~/.jigaido/user_{id}/user.json
- Anyone can add bounties to groups; only creator can edit/delete
- Bounty IDs are sequential per group, not global
- Fix test mock compatibility issues in format_bounty function
This commit is contained in:
shokollm
2026-04-02 13:48:52 +00:00
parent 2e7b20ed81
commit 8e589fbc47
6 changed files with 381 additions and 264 deletions

View File

@@ -35,8 +35,6 @@ def build_app() -> Application:
app.add_handler(CommandHandler("delete", commands.cmd_delete))
app.add_handler(CommandHandler("track", commands.cmd_track))
app.add_handler(CommandHandler("untrack", commands.cmd_untrack))
app.add_handler(CommandHandler("admin_add", commands.cmd_admin_add))
app.add_handler(CommandHandler("admin_remove", commands.cmd_admin_remove))
app.add_handler(MessageHandler(filters.COMMAND, commands.cmd_help))

View File

@@ -13,8 +13,6 @@ import storage
TELEGRAM_BOT_USERNAME = "your_bot_username"
REMINDER_WINDOW_DAYS = 7
def extract_args(text: str) -> list[str]:
if not text:
@@ -49,11 +47,11 @@ def format_bounty(b: dict, show_id: bool = True) -> str:
parts = []
if show_id:
parts.append(f"[#{b['id']}]")
if b["text"]:
if b["text"] is not None:
parts.append(b["text"])
if b.get("link"):
if b["link"] is not None:
parts.append(f"🔗 {b['link']}")
if b.get("due_date_ts"):
if b["due_date_ts"] is not None:
due_str = time.strftime("%Y-%m-%d", time.localtime(b["due_date_ts"]))
days_left = (b["due_date_ts"] - int(time.time())) // 86400
if days_left < 0:
@@ -62,7 +60,8 @@ def format_bounty(b: dict, show_id: bool = True) -> str:
parts.append(f"{due_str} (TODAY)")
else:
parts.append(f"{due_str} ({days_left}d)")
parts.append(f"by @{b.get('informed_by_username', 'unknown')}")
username = b["created_by_username"]
parts.append(f"by @{username if username is not None else 'unknown'}")
return " | ".join(parts)
@@ -70,71 +69,31 @@ def is_group(update: Update) -> bool:
return update.effective_chat.type != "private"
def ensure_user(update: Update) -> dict:
user = update.effective_user
user_data = storage.load_user(user.id)
user_data["username"] = user.username
storage.save_user(user_data)
def ensure_user_personal(user_id: int, username: str | None) -> dict:
user_data = storage.load_user_personal(user_id)
user_data["username"] = username
storage.save_user_personal(user_data)
return user_data
def get_user_by_username(username: str) -> dict | None:
for path in storage.USERS_DIR.glob("*.json"):
with open(path) as f:
data = json.load(f)
if data.get("username") == username:
return data
return None
def ensure_user_tracking(group_id: int, user_id: int) -> dict:
return storage.load_user_tracking(group_id, user_id)
def is_group_admin_or_creator(update: Update, group_id: int, user_data: dict) -> bool:
return True
def is_group_creator(update: Update, group_id: int, user_data: dict) -> bool:
return True
def get_all_group_bounties(group_id: int) -> list[dict]:
all_bounties = []
for path in storage.USERS_DIR.glob("*.json"):
with open(path) as f:
user_data = json.load(f)
for bounty in user_data.get("personal_bounties", []):
if bounty.get("group_id") == group_id:
bounty["creator_username"] = user_data.get("username")
all_bounties.append(bounty)
return sorted(all_bounties, key=lambda b: b.get("created_at", 0), reverse=True)
def admin_only(func):
@wraps(func)
async def wrapper(update: Update, ctx: ContextTypes.DEFAULT_TYPE):
if is_group(update):
await update.message.reply_text("⛔ Admin only.")
return
return await func(update, ctx)
return wrapper
def creator_only(func):
@wraps(func)
async def wrapper(update: Update, ctx: ContextTypes.DEFAULT_TYPE):
if is_group(update):
await update.message.reply_text("⛔ Group creator only.")
return
return await func(update, ctx)
return wrapper
def is_bounty_creator(bounty: dict, user_id: int) -> bool:
return bounty.get("created_by_user_id") == user_id
async def cmd_bounty(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
if is_group(update):
bounties = get_all_group_bounties(update.effective_chat.id)
group_id = update.effective_chat.id
group_data = storage.load_group(group_id)
bounties = group_data.get("bounties", [])
else:
user_data = ensure_user(update)
bounties = user_data.get("personal_bounties", [])
user_id = update.effective_user.id
username = update.effective_user.username
user_data = ensure_user_personal(user_id, username)
bounties = user_data.get("bounties", [])
if not bounties:
await update.message.reply_text("No bounties yet.")
@@ -145,33 +104,43 @@ async def cmd_bounty(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
async def cmd_my(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
user_data = ensure_user(update)
tracked = user_data.get("tracked_bounties", [])
user_id = update.effective_user.id
if not tracked:
await update.message.reply_text("You are not tracking any bounties.")
return
if is_group(update):
group_id = update.effective_chat.id
tracking_data = storage.load_user_tracking(group_id, user_id)
tracked = tracking_data.get("tracked", [])
bounty_lines = []
for tracked_bounty in tracked:
bounty_id = tracked_bounty.get("bounty_id")
group_id = tracked_bounty.get("group_id")
for path in storage.USERS_DIR.glob("*.json"):
with open(path) as f:
creator_data = json.load(f)
for bounty in creator_data.get("personal_bounties", []):
if bounty.get("id") == bounty_id and bounty.get("group_id") == group_id:
bounty["creator_username"] = creator_data.get("username")
bounty_lines.append(format_bounty(bounty, show_id=True))
break
if not tracked:
await update.message.reply_text("You are not tracking any bounties.")
return
if not bounty_lines:
await update.message.reply_text("You are not tracking any bounties.")
return
group_data = storage.load_group(group_id)
bounty_map = {b["id"]: b for b in group_data.get("bounties", [])}
await update.message.reply_text(
"\n".join(bounty_lines), disable_web_page_preview=True
)
bounty_lines = []
for t in tracked:
bounty_id = t.get("bounty_id")
if bounty_id in bounty_map:
bounty_lines.append(format_bounty(bounty_map[bounty_id], show_id=True))
if not bounty_lines:
await update.message.reply_text("You are not tracking any bounties.")
return
await update.message.reply_text(
"\n".join(bounty_lines), disable_web_page_preview=True
)
else:
user_data = storage.load_user_personal(user_id)
bounties = user_data.get("bounties", [])
if not bounties:
await update.message.reply_text("No bounties yet.")
return
lines = [format_bounty(dict(b), show_id=True) for b in bounties]
await update.message.reply_text("\n".join(lines), disable_web_page_preview=True)
async def cmd_add(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
@@ -188,34 +157,48 @@ async def cmd_add(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
await update.message.reply_text("A bounty needs at least text or a link.")
return
user_data = ensure_user(update)
group_id = None if is_group(update) else None
user_id = update.effective_user.id
username = update.effective_user.username or str(user_id)
created_at = int(time.time())
if is_group(update):
group_id = update.effective_chat.id
group_data = storage.load_group(group_id)
informed_by = update.effective_user.username or str(update.effective_user.id)
created_at = int(time.time())
bounty = {
"id": storage.next_bounty_id(group_data),
"text": text,
"link": link,
"due_date_ts": due_date_ts,
"created_by_user_id": user_id,
"created_by_username": username,
"created_at": created_at,
}
bounty = {
"id": storage.next_bounty_id(user_data),
"text": text,
"link": link,
"due_date_ts": due_date_ts,
"group_id": group_id,
"informed_by_username": informed_by,
"created_at": created_at,
}
group_data.setdefault("bounties", []).append(bounty)
storage.save_group(group_data)
else:
user_data = ensure_user_personal(user_id, username)
user_data.setdefault("personal_bounties", []).append(bounty)
storage.save_user(user_data)
bounty = {
"id": storage.next_personal_bounty_id(user_data),
"text": text,
"link": link,
"due_date_ts": due_date_ts,
"created_by_user_id": user_id,
"created_by_username": username,
"created_at": created_at,
}
user_data.setdefault("bounties", []).append(bounty)
storage.save_user_personal(user_data)
due_str = ""
if due_date_ts:
due_str = f" | Due: {time.strftime('%Y-%m-%d', time.localtime(due_date_ts))}"
await update.message.reply_text(
f"✅ Bounty added (#{bounty['id']}){due_str}",
f"✅ Bounty added{due_str}",
disable_web_page_preview=True,
)
@@ -239,25 +222,46 @@ async def cmd_update(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
await update.message.reply_text("Nothing to update.")
return
user_data = ensure_user(update)
group_id = None if is_group(update) else None
user_id = update.effective_user.id
if is_group(update):
group_id = update.effective_chat.id
group_data = storage.load_group(group_id)
for bounty in user_data.get("personal_bounties", []):
if bounty.get("id") == bounty_id and bounty.get("group_id") == group_id:
if text:
bounty["text"] = text
if link:
bounty["link"] = link
if due_date_ts is not None:
bounty["due_date_ts"] = due_date_ts
storage.save_user(user_data)
await update.message.reply_text(f"✅ Bounty #{bounty_id} updated.")
return
for bounty in group_data.get("bounties", []):
if bounty.get("id") == bounty_id:
if not is_bounty_creator(bounty, user_id):
await update.message.reply_text(
"⛔ Only the creator can edit this bounty."
)
return
if text:
bounty["text"] = text
if link:
bounty["link"] = link
if due_date_ts is not None:
bounty["due_date_ts"] = due_date_ts
storage.save_group(group_data)
await update.message.reply_text(f"✅ Bounty #{bounty_id} updated.")
return
await update.message.reply_text("Bounty not found.")
await update.message.reply_text("Bounty not found.")
else:
user_data = storage.load_user_personal(user_id)
for bounty in user_data.get("bounties", []):
if bounty.get("id") == bounty_id:
if text:
bounty["text"] = text
if link:
bounty["link"] = link
if due_date_ts is not None:
bounty["due_date_ts"] = due_date_ts
storage.save_user_personal(user_data)
await update.message.reply_text(f"✅ Bounty #{bounty_id} updated.")
return
await update.message.reply_text("Bounty not found.")
async def cmd_delete(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
@@ -272,20 +276,36 @@ async def cmd_delete(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
await update.message.reply_text("Invalid bounty ID.")
return
user_data = ensure_user(update)
group_id = None if is_group(update) else None
user_id = update.effective_user.id
if is_group(update):
group_id = update.effective_chat.id
group_data = storage.load_group(group_id)
for i, bounty in enumerate(user_data.get("personal_bounties", [])):
if bounty.get("id") == bounty_id and bounty.get("group_id") == group_id:
user_data["personal_bounties"].pop(i)
storage.save_user(user_data)
await update.message.reply_text(f"✅ Bounty #{bounty_id} deleted.")
return
for i, bounty in enumerate(group_data.get("bounties", [])):
if bounty.get("id") == bounty_id:
if not is_bounty_creator(bounty, user_id):
await update.message.reply_text(
"⛔ Only the creator can delete this bounty."
)
return
group_data["bounties"].pop(i)
storage.save_group(group_data)
await update.message.reply_text(f"✅ Bounty #{bounty_id} deleted.")
return
await update.message.reply_text("Bounty not found.")
await update.message.reply_text("Bounty not found.")
else:
user_data = storage.load_user_personal(user_id)
for i, bounty in enumerate(user_data.get("bounties", [])):
if bounty.get("id") == bounty_id:
user_data["bounties"].pop(i)
storage.save_user_personal(user_data)
await update.message.reply_text(f"✅ Bounty #{bounty_id} deleted.")
return
await update.message.reply_text("Bounty not found.")
async def cmd_track(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
@@ -300,28 +320,35 @@ async def cmd_track(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
await update.message.reply_text("Invalid bounty ID.")
return
group_id = None
if is_group(update):
group_id = update.effective_chat.id
if not is_group(update):
await update.message.reply_text("Tracking is only available in groups.")
return
user_data = ensure_user(update)
group_id = update.effective_chat.id
user_id = update.effective_user.id
for tracked in user_data.get("tracked_bounties", []):
if (
tracked.get("bounty_id") == bounty_id
and tracked.get("group_id") == group_id
):
group_data = storage.load_group(group_id)
bounty_exists = any(
b.get("id") == bounty_id for b in group_data.get("bounties", [])
)
if not bounty_exists:
await update.message.reply_text("Bounty not found in this group.")
return
tracking_data = storage.load_user_tracking(group_id, user_id)
for t in tracking_data.get("tracked", []):
if t.get("bounty_id") == bounty_id:
await update.message.reply_text(f"Already tracking bounty #{bounty_id}.")
return
user_data.setdefault("tracked_bounties", []).append(
tracking_data.setdefault("tracked", []).append(
{
"bounty_id": bounty_id,
"group_id": group_id,
"created_at": int(time.time()),
"tracked_at": int(time.time()),
}
)
storage.save_user(user_data)
storage.save_user_tracking(tracking_data, group_id)
await update.message.reply_text(f"✅ Now tracking bounty #{bounty_id}.")
@@ -337,35 +364,35 @@ async def cmd_untrack(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
await update.message.reply_text("Invalid bounty ID.")
return
user_data = ensure_user(update)
group_id = None if is_group(update) else None
if not is_group(update):
await update.message.reply_text("Tracking is only available in groups.")
return
tracked = user_data.get("tracked_bounties", [])
group_id = update.effective_chat.id
user_id = update.effective_user.id
tracking_data = storage.load_user_tracking(group_id, user_id)
tracked = tracking_data.get("tracked", [])
for i, t in enumerate(tracked):
if t.get("bounty_id") == bounty_id and t.get("group_id") == group_id:
if t.get("bounty_id") == bounty_id:
tracked.pop(i)
storage.save_user(user_data)
tracking_data["tracked"] = tracked
storage.save_user_tracking(tracking_data, group_id)
await update.message.reply_text(f"✅ Untracked bounty #{bounty_id}.")
return
await update.message.reply_text(f"Not tracking bounty #{bounty_id}.")
async def cmd_admin_add(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
await update.message.reply_text(
"Admin management has been removed in this version."
)
async def cmd_admin_remove(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
await update.message.reply_text(
"Admin management has been removed in this version."
)
async def cmd_start(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
ensure_user(update)
user_id = update.effective_user.id
username = update.effective_user.username
if is_group(update):
group_id = update.effective_chat.id
storage.load_group(group_id)
storage.load_user_tracking(group_id, user_id)
await update.message.reply_text(
"👻 JIGAIDO is watching.\n\n"
"This group's bounty list is now active.\n"
@@ -375,6 +402,7 @@ async def cmd_start(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
"/my — your tracked bounties"
)
else:
ensure_user_personal(user_id, username)
await update.message.reply_text(
"👻 JIGAIDO activated.\n\n"
"Personal bounty list ready.\n"
@@ -385,16 +413,29 @@ async def cmd_start(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
async def cmd_help(update: Update, ctx: ContextTypes.DEFAULT_TYPE) -> None:
await update.message.reply_text(
"👻 JIGAIDO Commands:\n\n"
"/bounty — list all bounties\n"
"/my — bounties you're tracking\n"
"/add <text> [link] [due] — add bounty\n"
"/update <id> [text] [link] [due] — update bounty\n"
"/delete <id> — delete bounty\n"
"/track <id> — track a bounty\n"
"/untrack <id> — stop tracking\n"
"/start — re-initialize\n"
"/help — this message",
disable_web_page_preview=True,
)
if is_group(update):
await update.message.reply_text(
"👻 JIGAIDO Commands:\n\n"
"/bounty — list all bounties\n"
"/my — bounties you're tracking\n"
"/add <text> [link] [due] — add bounty\n"
"/update <id> [text] [link] [due] — update bounty (creator only)\n"
"/delete <id> — delete bounty (creator only)\n"
"/track <id> — track a bounty\n"
"/untrack <id> — stop tracking\n"
"/start — re-initialize\n"
"/help — this message",
disable_web_page_preview=True,
)
else:
await update.message.reply_text(
"👻 JIGAIDO Commands:\n\n"
"/bounty — list your bounties\n"
"/add <text> [link] [due] — add bounty\n"
"/update <id> [text] [link] [due] — update bounty\n"
"/delete <id> — delete bounty\n"
"/my — your tracked bounties\n"
"/start — re-initialize\n"
"/help — this message",
disable_web_page_preview=True,
)

View File

@@ -1,4 +1,4 @@
"""Per-user JSON file storage for JIGAIDO."""
"""Per-group JSON file storage for JIGAIDO."""
import json
import tempfile
@@ -6,44 +6,118 @@ import os
from pathlib import Path
from typing import Optional
DATA_DIR = Path(__file__).parent / "data"
USERS_DIR = DATA_DIR / "users"
DATA_DIR = Path.home() / ".jigaido"
def _ensure_dirs() -> None:
USERS_DIR.mkdir(parents=True, exist_ok=True)
DATA_DIR.mkdir(parents=True, exist_ok=True)
def _user_file_path(telegram_user_id: int) -> Path:
return USERS_DIR / f"{telegram_user_id}.json"
def group_dir_path(group_id: int) -> Path:
return DATA_DIR / f"{group_id}"
def load_user(telegram_user_id: int) -> dict:
"""Load user data from JSON file. Returns empty user structure if not found."""
def user_personal_dir_path(user_id: int) -> Path:
return DATA_DIR / f"user_{user_id}"
def group_file_path(group_id: int) -> Path:
return group_dir_path(group_id) / "group.json"
def user_tracking_file_path(group_id: int, user_id: int) -> Path:
return group_dir_path(group_id) / f"user_{user_id}.json"
def user_personal_file_path(user_id: int) -> Path:
return user_personal_dir_path(user_id) / "user.json"
def load_group(group_id: int) -> dict:
"""Load group data from JSON file. Returns empty group structure if not found."""
_ensure_dirs()
path = _user_file_path(telegram_user_id)
path = group_file_path(group_id)
if not path.exists():
return {
"user_id": telegram_user_id,
"username": None,
"personal_bounties": [],
"tracked_bounties": [],
"group_id": group_id,
"bounties": [],
}
with open(path) as f:
return json.load(f)
def save_user(user_data: dict) -> None:
"""Atomically save user data to JSON file."""
def save_group(group_data: dict) -> None:
"""Atomically save group data to JSON file."""
_ensure_dirs()
path = _user_file_path(user_data["user_id"])
with tempfile.NamedTemporaryFile(mode="w", dir=USERS_DIR, delete=False) as tmp:
group_id = group_data["group_id"]
dir_path = group_dir_path(group_id)
dir_path.mkdir(parents=True, exist_ok=True)
path = group_file_path(group_id)
with tempfile.NamedTemporaryFile(mode="w", dir=dir_path, delete=False) as tmp:
json.dump(group_data, tmp, indent=2)
tmp_path = tmp.name
os.rename(tmp_path, path)
def next_bounty_id(group_data: dict) -> int:
"""Get next sequential bounty ID for group."""
existing_ids = [b["id"] for b in group_data.get("bounties", [])]
return (max(existing_ids) + 1) if existing_ids else 1
def load_user_tracking(group_id: int, user_id: int) -> dict:
"""Load user tracking data for a group. Returns empty tracking structure if not found."""
_ensure_dirs()
path = user_tracking_file_path(group_id, user_id)
if not path.exists():
return {
"user_id": user_id,
"tracked": [],
}
with open(path) as f:
return json.load(f)
def save_user_tracking(tracking_data: dict, group_id: int) -> None:
"""Atomically save user tracking data to JSON file."""
_ensure_dirs()
dir_path = group_dir_path(group_id)
dir_path.mkdir(parents=True, exist_ok=True)
path = user_tracking_file_path(group_id, tracking_data["user_id"])
with tempfile.NamedTemporaryFile(mode="w", dir=dir_path, delete=False) as tmp:
json.dump(tracking_data, tmp, indent=2)
tmp_path = tmp.name
os.rename(tmp_path, path)
def load_user_personal(user_id: int) -> dict:
"""Load user's personal bounties (DM mode). Returns empty user structure if not found."""
_ensure_dirs()
path = user_personal_file_path(user_id)
if not path.exists():
return {
"user_id": user_id,
"username": None,
"bounties": [],
}
with open(path) as f:
return json.load(f)
def save_user_personal(user_data: dict) -> None:
"""Atomically save user's personal bounties to JSON file."""
_ensure_dirs()
user_id = user_data["user_id"]
dir_path = user_personal_dir_path(user_id)
dir_path.mkdir(parents=True, exist_ok=True)
path = user_personal_file_path(user_id)
with tempfile.NamedTemporaryFile(mode="w", dir=dir_path, delete=False) as tmp:
json.dump(user_data, tmp, indent=2)
tmp_path = tmp.name
os.rename(tmp_path, path)
def next_bounty_id(user_data: dict) -> int:
"""Get next sequential bounty ID for user's file."""
existing_ids = [b["id"] for b in user_data.get("personal_bounties", [])]
def next_personal_bounty_id(user_data: dict) -> int:
"""Get next sequential bounty ID for user's personal bounties."""
existing_ids = [b["id"] for b in user_data.get("bounties", [])]
return (max(existing_ids) + 1) if existing_ids else 1

View File

@@ -1,27 +1 @@
"""Pytest fixtures for telegram-bot tests."""
import sys
import tempfile
from pathlib import Path
import pytest
# Add the app directory to path so `import db` works when running pytest
sys.path.insert(0, str(Path(__file__).parent.parent))
@pytest.fixture(autouse=True)
def fresh_db(monkeypatch):
"""Replace DB_PATH with a temp file before any test runs."""
import db as _db
tmp = tempfile.NamedTemporaryFile(suffix=".db", delete=False)
tmp_path = Path(tmp.name)
tmp.close()
monkeypatch.setattr(_db, "DB_PATH", tmp_path)
_db.init_db()
yield tmp_path
tmp_path.unlink(missing_ok=True)

View File

@@ -101,12 +101,21 @@ class TestParseArgs:
class TestFormatBounty:
def _row(self, id=1, text="Test bounty", link="https://example.com",
due_date_ts=None, informed_by_username="alice"):
def _row(
self,
id=1,
text="Test bounty",
link="https://example.com",
due_date_ts=None,
created_by_username="alice",
):
row = MagicMock()
row.__getitem__ = lambda s, k: {
"id": id, "text": text, "link": link,
"due_date_ts": due_date_ts, "informed_by_username": informed_by_username
"id": id,
"text": text,
"link": link,
"due_date_ts": due_date_ts,
"created_by_username": created_by_username,
}[k]
return row
@@ -155,12 +164,12 @@ class TestFormatBounty:
out = format_bounty(b)
assert "OVERDUE" in out
def test_informed_by_shown(self):
b = self._row(informed_by_username="bob")
def test_created_by_shown(self):
b = self._row(created_by_username="bob")
out = format_bounty(b)
assert "@bob" in out
def test_informed_by_unknown_fallback(self):
b = self._row(informed_by_username=None)
def test_created_by_unknown_fallback(self):
b = self._row(created_by_username=None)
out = format_bounty(b)
assert "@unknown" in out