69a1e22cf5
* feat(initial-workspace): per-instance agnes init override Adds Initial Workspace Template — an admin-configurable per-instance override for the agnes init analyst workspace. When configured, agnes init downloads a server-rendered zip from a Git repo the admin registered and extracts it into the analyst's workspace, fully bypassing Agnes-default CLAUDE.md / settings.json / hooks / slash commands / AGNES_WORKSPACE.md. Repo layout convention: only the contents of a top-level `workspace/` subdirectory ship to analysts; admin docs (README, CI configs) at the repo root stay in the repo and never reach an analyst. Sync rejects repos without `workspace/` at root. Server side: - src/initial_workspace.py — clone (or fetch+reset), validate, build zip with strict path checks and reserved-path rejection (workspace/.claude/init-complete reserved by Agnes) - app/api/initial_workspace.py — admin CRUD + sync endpoint + analyst- facing status/zip/applied endpoints; config persists to instance.yaml overlay, PAT to .env_overlay - app/secrets.py — refactor: persist_overlay_token shared helper with threading.Lock for .env_overlay writes (closes pre-existing race between concurrent marketplaces saves) - app/web/templates/admin_server_config.html — new "Initial Workspace Template" section + modal + Sync/Edit/Delete/Download buttons (matches existing cfg-section visual language) CLI side: - cli/lib/override.py — single source of truth for is_override_workspace sentinel detection - cli/lib/initial_workspace.py — probe status, safe zip extraction with ../absolute/symlink rejection, typed-YES force confirmation - cli/commands/init.py — override branch (skips Agnes-default workspace writes); extended sentinel with override:true, template_source, template_sha so future agnes self-upgrade does not auto-refresh hooks - cli/lib/hooks.py + cli/lib/commands.py — short-circuit on override workspaces (install_claude_hooks, install_claude_commands, maybe_refresh_claude_hooks) Audit-event strategy: server writes initial_workspace.fetch_started inside GET /api/initial-workspace.zip (cannot be spoofed by PAT-holder); CLI POST /applied writes initial_workspace.applied as best-effort confirmation. Admin mutations log via the existing _audit pattern. Tests: 27 server (clone/validate/zip + workspace-subdir convention + concurrent persist_overlay_token + endpoint shapes + audit rows) + 29 CLI (override sentinel parse + probe fall-through + safe extraction + YES strictness + hook guards + e2e mocked init). Risk acceptance — documented in docs/initial-workspace-override.md + CHANGELOG Internal section so AI reviewers understand the deviations from defaults are intentional: - maybe_refresh_claude_hooks deliberately no-ops on override workspaces - --force on override does NOT back up CLAUDE.md (admin's repo is the source of truth) - .claude/CLAUDE.local.md IS overwritten by override extraction when admin's repo ships one * test+vendor-agnostic: drop Groupon tokens from #292 fixtures + extend admin-gate coverage Two fixes from the takeover review on #292: 1. **Vendor-agnostic OSS rule**: Replace `Groupon` / `groupon/template` tokens in test fixtures with `Acme` / `acme/template` (8 sites in test_cli_init_override.py + 1 in test_initial_workspace_api.py). Per CLAUDE.md "Vendor-agnostic OSS — no customer-specific content" rule: customer-specific tokens don't belong in shipped artifacts, even in test fixtures. The pre-existing FoundryAI mentions in test_instance_config.py + test_setup_instructions.py are out of scope for this PR (didn't introduce them). 2. **Admin-gate coverage gap**: `test_admin_endpoints_require_admin` only covered GET /api/admin/initial-workspace + POST .../sync. The register-write (POST .../initial-workspace) and delete (DELETE .../initial-workspace) endpoints used the same `Depends(require_admin)` wiring but had no regression test. Loop now covers all 4 verbs so a future refactor that drops the dependency from one endpoint fails here instead of silently exposing the write/delete paths to any analyst with a PAT. * release: 0.54.9 — Initial Workspace Template (per-instance agnes init override) Last commit on the PR per CLAUDE.md hard rule. Patch bump (0.54.8 → 0.54.9) for Mina's Initial Workspace Template feature. No DB migration (config lives in instance.yaml overlay). No mandatory operator action — empty default keeps OSS-default agnes init behavior. Operators wanting full template control link a Git repo on /admin/server-config → "Initial Workspace Template". See docs/initial-workspace-override.md for the full responsibility-transfer contract. --------- Co-authored-by: Minas Arustamyan <arustamyan.minas@gmail.com> Co-authored-by: ZdenekSrotyr <zdenek.srotyr@keboola.com>
51 lines
1.8 KiB
Python
51 lines
1.8 KiB
Python
"""Shared utilities for the FastAPI application."""
|
|
import os
|
|
from pathlib import Path
|
|
|
|
|
|
def get_data_dir() -> Path:
|
|
"""Return the configured data directory path."""
|
|
return Path(os.environ.get("DATA_DIR", "./data"))
|
|
|
|
|
|
def get_marketplaces_dir() -> Path:
|
|
"""Path where marketplace git repos are cloned by the nightly sync."""
|
|
return get_data_dir() / "marketplaces"
|
|
|
|
|
|
def get_marketplace_cache_dir() -> Path:
|
|
"""Root for the curated-marketplace external-asset mirror.
|
|
|
|
Each registered marketplace gets a sub-directory keyed by slug holding a
|
|
``manifest.json`` and one file per mirrored URL. Lives outside the cloned
|
|
git working tree so its contents don't interfere with ``git status`` /
|
|
``git fetch --depth 1 ; git reset --hard`` semantics. Cleaned up
|
|
alongside the working tree on marketplace unregister
|
|
(``src.marketplace.delete_marketplace_dir``).
|
|
"""
|
|
return get_data_dir() / "marketplace-cache"
|
|
|
|
|
|
def get_initial_workspace_dir() -> Path:
|
|
"""Path where the admin-configured Initial Workspace Template is cloned.
|
|
|
|
Singleton (one per instance) — admin registers the repo via
|
|
/admin/server-config → "Initial Workspace Template" section. Used by
|
|
``src.initial_workspace`` to clone/fetch and to serve via
|
|
``/api/initial-workspace.zip``. Layout:
|
|
|
|
${DATA_DIR}/initial-workspace/ ← git working copy
|
|
.git/ ← present on disk, excluded from zip
|
|
CLAUDE.md, .claude/, ... ← analyst workspace content
|
|
"""
|
|
return get_data_dir() / "initial-workspace"
|
|
|
|
|
|
def get_store_dir() -> Path:
|
|
"""Root for community-uploaded Store entities.
|
|
|
|
Layout:
|
|
${DATA_DIR}/store/<entity_id>/plugin/ ← canonical Claude Code plugin tree
|
|
${DATA_DIR}/store/<entity_id>/assets/ ← photo + docs
|
|
"""
|
|
return get_data_dir() / "store"
|