diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bb0092b..4a5fcf7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,9 +17,10 @@ jobs: with: python-version: "3.12" cache: pip - - run: pip install -e ./backend + # pytest and ruff come from the dev extra, so CI matches a fresh clone. + - run: pip install -e "./backend[dev]" - run: python -m pytest -q - - run: pip install ruff==0.16.10 && ruff check backend/src bench + - run: ruff check backend/src bench mcp: runs-on: ubuntu-latest diff --git a/CHECKLIST.md b/CHECKLIST.md index ac4ac78..a014ca2 100644 --- a/CHECKLIST.md +++ b/CHECKLIST.md @@ -246,15 +246,41 @@ - 第四轮 **PASS**（同一个 reviewer，39 条命令、15分44秒，不读我的话只跑东西）：它自己写探针复现了三个场景（挂 X 后写更新的 Y → 行说 adapter-x；两个 runtime 一个 unload → 仍 loaded/adapter-y 且不说 gone；两个都 unload → available + gone），自己跑变异测试（行身份改回解析结果 → 3 个测试 FAILED；`live_attachments()` 忽略存活 → 2 个 FAILED；去掉复数主语 → 2 个 FAILED），并逐项核了仓库规则（无文件 >500 行、新增 `#` 注释 0 行、4 个单行 docstring、无新造 scenario 字段、无新依赖、无 v1/v2、无死代码）。它另记一条有界陈旧：`live_attachments()` 只在下次 `record_load` 时清理，所以刚被回收的模型在下一次加载前仍可能显示 loaded（docstring 写了）。它还提了一条「挂载是按连接的」——**这条我实测推翻**：`mounts` 是表，同一个 home 上换一个 `Database` 对象读 `mounted_ids` 仍返回 `['cart-a']`；那个测试断言 `mounted == []` 只是因为那个测试本身没挂任何东西。 - CLI 面：`ely-eye adapters` 打印同一份报告。 - [ ] **p1-4** 工程地基 - - [ ] p1-4.1 pytest 从零到有（后端） - - [ ] p1-4.2 go test 从零到有（MCP） + - [x] p1-4.1 pytest 从零到有（后端） + - 验收写的路径是 `tests/`，实际在 `backend/tests/`（24 个文件）；`pytest -q` 全仓 **252 passed** + - [x] p1-4.2 go test 从零到有（MCP） + - 5 个 `*_test.go`（`internal/apiclient/client_test.go` 4 个、`internal/mcpserver/write_tools_test.go` 6 个等），`go build ./... && go vet ./... && go test ./... && gofmt -l .` 全干净 - [ ] p1-4.3 CI 在 Linux runner 上跑真测试 - - [ ] p1-4.4 `Dockerfile` 不再 COPY 缺失的 `PRD.md` - - [ ] p1-4.5 去掉 `RTX 4090` / `Ubuntu` 硬编码，改可配置 - - [ ] p1-4.6 补 `.sh` 脚本，与 `.ps1` 对等 - - [ ] p1-4.7 `LICENSE` - - [ ] p1-4.8 `backup` / `restore` / `doctor` - - 验收：CI 绿；干净 clone 上 `docker build` 成功；桩 `nvidia-smi` 证明设备名不再致命 + - `.github/workflows/ci.yml` 四个 job：backend（python 3.12 = `requires-python` 的下限，`pip install -e "./backend[dev]"` → `python -m pytest -q` → `ruff check backend/src bench`）、mcp（go 1.25 build/vet/test + gofmt）、interface（node 22 `npm ci && npm run build`）、image（`docker build` + 起容器 curl `/api/status` 与 `/`） + - 首跑 run **37736363930**：image / interface / mcp 绿，backend 红在 `No module named pytest` —— **pytest 不是任何地方的依赖，所以「跑测试」这件事在一个新克隆上根本不可执行**。修法是把测试工具写进依赖声明：`backend/pyproject.toml` 新增 `[project.optional-dependencies] dev = ["pytest>=9.1.0", "ruff==0.16.10"]`，CI 与新人装的是同一套，ruff 也不再靠 CI 里一个裸版本号漂移 + - 为了让 CI 真能当门禁，先清了仓库既有的 lint 债：`ruff check backend/src bench` 在 HEAD 上是 **17 errors**，现在 All checks passed（14 条机械 `--fix`，加 `profiles.py` 三个探针把 `except Exception` 收窄成 `(OSError, subprocess.SubprocessError, ValueError)`，并显式挡住 `json.loads` 返回 dict 的假设） + - [x] p1-4.4 `Dockerfile` 不再 COPY 缺失的 `PRD.md` + - 干净克隆实测：`git clone` 之后 `ls PRD.md` → `No such file or directory`（PRD 一直没进 git），旧镜像在 `COPY README.md PRD.md ./` 那一步就建不出来 + - 改两阶段：`node:22-bookworm-slim AS ui` 跑 `npm ci && npm run build`（Ubuntu 24.04 自带的 node 18 建不了 Vite 8，`frontend/package.json` 是 `vite ^8.0.0`），运行阶段 `pip install ./backend`（不再 `-e`）+ `COPY --from=ui /ui/dist /srv/ely-eye/ui`，node/npm 从运行阶段去掉 + - 建了却没人服务也是假的：`config.py` 加 `ui_dir`（env `ELY_EYE_UI_DIR`），`api.py` 用 `StaticFiles(html=True)` 同源挂 `/`；目录被设了但不存在 → `SystemExit` 点名 `npm run build`，不静默降级。前端本来就打相对 `/api/...`，所以同源不需要改客户端 + - 实测：干净克隆 `docker build -t ely-eye:ci .` → `Successfully built 09803cd49add`（22.4GB，torch CUDA wheel）；`docker run -p 18765:8765` → `GET /api/status` 200（`available:false` + `SGLang endpoint is not reachable`，无模型服务器时应有）、`GET /` 200 text/html 带 `/assets/index-C4NuxpJV.js`（200，208733 字节）与 css 200 + - 另加 `.dockerignore`：没有它从开发机建镜像要送 19GB 构建上下文（`.venv`、`bench/corpus` 19GB、`bench/runs`、`node_modules`），Dockerfile 一个字都不读 + - [x] p1-4.5 去掉 `RTX 4090` / `Ubuntu` 硬编码，改可配置 + - 根因是量出来的：这台机器 `printenv` 里 `WSL_DISTRO_NAME=Ubuntu` 已设，也就是在 WSL 内部地 shell 本来就是 Linux，`wsl.exe` 那一跳只有从 Windows 宿主才需要。旧代码无条件 `wsl.exe -d Ubuntu`，于是原生 Linux 上六个 profile 全被报成 missing，哪怕卡就在机器上 + - `profiles.py` 重写宿主判定：`uses_wsl()`（`WSL_DISTRO_NAME` 有值即假）、`host_shell()`、`host_path()`、`gpu_available()`（替掉 `wsl_gpu_available()`）、`host_python_command()`、`launch_script()`（按宿主选 `.ps1` / `.sh`）；`Settings.wsl_distro` 可配；`schemas.py:442` 字段名 `wsl_gpu` → `gpu_available`（Linux 上叫 wsl 是撒谎） + - 设备名致命这条也拆了：`proofs/training_trace.py` 新增 `cuda_bf16_training(environment)`，判据是 `cuda_available and bf16_supported`（`training.training_environment()` 本来就记了这两个事实），不再 `"RTX 4090" in device_name`；`training.py:1272` 报错里那句 PRD 卡名删掉 + - 验收就是桩：PATH 上放一个打印 `NVIDIA GeForce RTX 5090` 的假 `nvidia-smi` → `gpu_available` 为真（顺带证明 `bash -lc` 会带 PATH）；exit 127 的桩 → 假；`cuda_bf16_training` 对 5090、4080 都为真，对不支持 bf16 的 4090 为假；`require_cuda_bf16` 的报错里不含 4090。`backend/tests/test_host_profiles.py` 8 个测试，含「每个 profile 在本机都有对应脚本」 + - [x] p1-4.6 补 `.sh` 脚本，与 `.ps1` 对等 + - 14 个 `.sh`：六个 launch（sglang live/extreme、vllm live/extreme、ktransformers、llamacpp，flag 与 `.ps1` 逐条对齐）+ install / install-cuda-torch / setup-linux-runtimes / serve-backend / serve-frontend / verify / download-models / run-prd-finetune；全部 `chmod +x` 且 `bash -n` 干净 + - 六个跨 WSL 的 `.ps1` 改成 `$distro = if ($env:ELY_EYE_WSL_DISTRO) { $env:ELY_EYE_WSL_DISTRO } else { "Ubuntu" }` 再 `wsl.exe -d $distro` + - 诚实记录两处没证到的：这台机器没有 PowerShell 解析器，那六个 `.ps1` 的改动是机械替换、未经语法校验；`scripts/run-all-prd-finetunes.ps1`（100 行）还没有 `.sh` 对应 + - [x] p1-4.7 `LICENSE` + - 选 **AGPL-3.0-only**，依据是查来的不是猜的：`pymupdf` 安装元数据写 `Dual Licensed - GNU AFFERO GPL 3.0 or Artifex Commercial License`，而 `gh repo view --json visibility` → **PUBLIC**，分发真的发生，所以 AGPL 的 network 条款真的会咬人。PyMuPDF 是 PDF 页/区块 atom 的承重墙，只要它还在，写 MIT 就是不诚实 + - `LICENSE` 与 gnu.org 原文逐字节相同（sha256 `0d96a4ff68ad6d4b6f1f30f713b18d5184912ba8dd389f86aa7710db079abcb0`）；`backend/pyproject.toml` 加 `license = "AGPL-3.0-only"`，`pip wheel` 实测元数据出 `License-Expression: AGPL-3.0-only`；`frontend/package.json` 同值；README 新增 License 段写明版权人与「买 Artifex 商业授权才谈得上宽松许可」 + - 这是业务决定不是工程决定：owner 若要 MIT，得先处置 PyMuPDF（买授权或换 reader），我在 README 与这里都标出来 + - [x] p1-4.8 `backup` / `restore` / `doctor` + - `backend/src/ely_eye/maintenance.py` + `cli_maintenance.py`（走仓库已有的 `register(app, settings)` 模式，因为 `cli.py` 已 488 行，再塞三个命令就破 500 规则）。backup 用 SQLite 自己的在线备份 API（服务在跑也能备，不是 `shutil.copy` 拷一个正在写的 WAL 库），清单记 schema 版本 / 行数 / sha256 / 体积 / 版本，行数是从**副本**读回来的 + - restore 的顺序是校验在先：sha256 对不上清单 → 拒绝；`PRAGMA integrity_check` 不是 ok → 拒绝；缺必需表 → 拒绝；schema 比本构建新 → 拒绝；被替换的库连同 `-wal`/`-shm` 留成 `.before-restore`；然后 `Database(settings).init()`，所以旧备份是「进来时被迁移」而不是要求人再跑一次 + - doctor 分两级：problems 让库停摆（integrity、打不开、挂载的卡带文件没了、ui_dir 设了但没建），warnings 只说明降级（快照缺失、视觉索引落后、dense 索引落后）。真数据实测（`bench/runs/baseline`，906MB / 165,973 atoms / 50,278 sources）：`backup` 4.0 秒，清单里的 sha256 `c815c6049c5bb562…` 用 `sha256sum` 独立核对一致；`restore` 到新 home 2.8 秒，读回 165,973 atoms / 50,278 sources / schema 7 全等；`doctor` ok=true、0 problems，并给出真降级警告：**「the store holds 21362 picture atoms but no CLIP snapshot is set (ELY_EYE_CLIP_MODEL_DIR), so they are findable only by the text already on them」** + - doctor 第一版是假健康：它只对「路径设了但目录不在」报警，对「库里有 21,362 个图片 atom 却压根没配 CLIP」报 ok=true。现在按库里的 modality 计数判，`test_doctor_names_the_senses_a_store_holds_but_cannot_use` 钉住这条 + - 测试写出来才发现的两条：`Database.__init__` 每次构造都跑迁移，所以 doctor 永远看不到旧 schema，我原先那句 remediation「run `ely-eye status` to migrate」是编的 → 改成 catch `SystemExit` 报「the store cannot be opened by this build: …」；另一条是 fixture 假设错（`_store()` 往已有库里加，被替换的库确实有 3 个 atom），改测试不改产品 + - 验收：CI 绿；干净 clone 上 `docker build` 成功（已实测 `09803cd49add` + 容器 curl 通）；桩 `nvidia-smi` 打印 RTX 5090 证明设备名不再致命（已实测） + - 门禁：`pytest -q` **252 passed**；`ruff check backend/src bench` All checks passed（HEAD 是 17 errors）；mypy 冷缓存查改动文件与 HEAD 同错、净新增 0；`pyright` 查 maintenance 三个文件 → **0 errors, 0 warnings**；go build/vet/test + gofmt 干净；`bash -n` 15 个 `.sh` 干净；`pip wheel ./backend` 能建且元数据带 license 表达式 - [ ] **p1-5** 产品面 - [ ] p1-5.1 `GET /api/search` - [ ] p1-5.2 前端：搜索、浏览、forget、挂载卡带、时间显示、图像渲染 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index f38c917..0a2cf35 100644 --- a/README.md +++ b/README.md @@ -148,6 +148,14 @@ capsule, any attached adapters, and the eval proofs. ```text backend/ Python: ingestion, retrieval, runtime, training, proof suite, FastAPI frontend/ the local dashboard (Vite + React) -scripts/ PowerShell: install, model download, serving, runtimes, fine-tuning +scripts/ install, model download, serving, runtimes, fine-tuning (.ps1 on Windows, .sh on Linux) ely-eye-mcp/ Go: local MCP server exposing the memory store to coding agents ``` + +## License + +AGPL-3.0-only. Copyright © 2026 雷电芽衣 . + +The PDF reader (PyMuPDF) is dual-licensed under AGPL-3.0 or an Artifex +Commercial license, so this project ships under AGPL while that dependency is +in use. Buying the Artifex license is what would allow a permissive one. diff --git a/backend/pyproject.toml b/backend/pyproject.toml index 6036e2d..1dded57 100644 --- a/backend/pyproject.toml +++ b/backend/pyproject.toml @@ -7,6 +7,7 @@ name = "ely-eye" version = "0.1.0" description = "Local multimodal context operating system for Qwen3.5-9B." readme = "README.md" +license = "AGPL-3.0-only" requires-python = ">=3.12" dependencies = [ "accelerate>=1.12.0", @@ -41,6 +42,12 @@ dependencies = [ "zstandard>=0.25.0" ] +[project.optional-dependencies] +dev = [ + "pytest>=9.1.0", + "ruff==0.16.10" +] + [project.scripts] ely-eye = "ely_eye.cli:app" diff --git a/backend/src/ely_eye/cli.py b/backend/src/ely_eye/cli.py index 4d3787b..ac1c3d7 100644 --- a/backend/src/ely_eye/cli.py +++ b/backend/src/ely_eye/cli.py @@ -18,6 +18,7 @@ from .benchmarks import ( from .cartridge import CartridgeService from .cartridge_assets import CartridgeAssetService from .cli_common import json_dump +from .cli_maintenance import register as register_maintenance_commands from .cli_senses import register as register_sense_commands from .cli_senses import senses_report from .cli_transactive import register as register_transactive_commands @@ -40,6 +41,7 @@ app = typer.Typer(no_args_is_help=True) register_transactive_commands(app, lambda: get_settings()) register_sense_commands(app, lambda: get_settings()) +register_maintenance_commands(app, lambda: get_settings()) @app.command() diff --git a/backend/src/ely_eye/cli_maintenance.py b/backend/src/ely_eye/cli_maintenance.py new file mode 100644 index 0000000..2bfe6da --- /dev/null +++ b/backend/src/ely_eye/cli_maintenance.py @@ -0,0 +1,33 @@ +"""The commands that keep a local store keepable: backup, restore, doctor.""" + +from __future__ import annotations + +from collections.abc import Callable +from pathlib import Path + +import typer + +from .config import Settings +from .maintenance import backup, doctor, restore + + +def register(app: typer.Typer, settings: Callable[[], Settings]) -> None: + """Add the maintenance commands; the settings thunk lets one patch in a test redirect every path.""" + + @app.command("backup") + def backup_command(destination: Path, force: bool = False) -> None: + """Copy the whole store into a folder while a running server keeps answering.""" + typer.echo(backup(settings(), destination, force).model_dump_json(indent=2)) + + @app.command("restore") + def restore_command(source: Path, force: bool = False) -> None: + """Put a backed-up folder back; the store it replaces is kept beside the new one.""" + typer.echo(restore(settings(), source, force).model_dump_json(indent=2)) + + @app.command("doctor") + def doctor_command() -> None: + """Report what is broken and what is only degraded; a broken store exits non-zero.""" + report = doctor(settings()) + typer.echo(report.model_dump_json(indent=2)) + if not report.ok: + raise typer.Exit(code=1) diff --git a/backend/src/ely_eye/maintenance.py b/backend/src/ely_eye/maintenance.py new file mode 100644 index 0000000..b2d9467 --- /dev/null +++ b/backend/src/ely_eye/maintenance.py @@ -0,0 +1,259 @@ +"""Move the store and ask whether it is well: backup, restore, doctor.""" + +from __future__ import annotations + +import hashlib +import shutil +import sqlite3 +from datetime import datetime +from pathlib import Path + +from pydantic import BaseModel + +from . import __version__ +from .cartridge_store import mounted_ids +from .config import Settings +from .db import Database +from .embeddings import EmbeddingService +from .migrations import SCHEMA_VERSION +from .schemas import utc_now +from .visual_index import VisualIndex + +BACKUP_FILE = "ely_eye.sqlite" +MANIFEST_FILE = "backup_manifest.json" +_REQUIRED_TABLES = ("atoms", "sources", "cartridges") +PICTURE_MODALITIES = ("image", "ui_screenshot") + + +class BackupManifest(BaseModel): + """What a backup holds, so a folder of files can be checked before it is trusted.""" + + created_at: datetime + ely_eye_version: str + schema_version: int + atoms: int + sources: int + cartridges: int + sha256: str + size_bytes: int + path: str + + +class DoctorReport(BaseModel): + """Broken versus degraded: problems stop the store, warnings only shrink what it can do.""" + + ok: bool + store: str + schema_version: int | None = None + atoms: int = 0 + sources: int = 0 + cartridges: int = 0 + mounted: list[str] = [] + problems: list[str] = [] + warnings: list[str] = [] + + +def _atoms_word(count: int) -> str: + return "atom" if count == 1 else "atoms" + + +def _modality_counts(database: Database) -> dict[str, int]: + with database.connect() as connection: + rows = connection.execute("SELECT modality, COUNT(*) AS total FROM atoms GROUP BY modality").fetchall() + return {str(row["modality"]): int(row["total"]) for row in rows} + + +def _counts(connection: sqlite3.Connection) -> dict[str, int]: + return { + "atoms": int(connection.execute("SELECT COUNT(*) FROM atoms").fetchone()[0]), + "sources": int(connection.execute("SELECT COUNT(*) FROM sources").fetchone()[0]), + "cartridges": int(connection.execute("SELECT COUNT(*) FROM cartridges").fetchone()[0]), + } + + +def _schema_version(connection: sqlite3.Connection) -> int: + return int(connection.execute("PRAGMA user_version").fetchone()[0]) + + +def _sha256(path: Path) -> str: + digest = hashlib.sha256() + with path.open("rb") as handle: + for block in iter(lambda: handle.read(1024 * 1024), b""): + digest.update(block) + return digest.hexdigest() + + +def backup(settings: Settings, destination: Path, force: bool = False) -> BackupManifest: + """Copy the live store with SQLite's own backup API, so a running server still yields a whole file.""" + origin = settings.db_path + if not origin.exists(): + raise ValueError(f"no memory store at {origin}; nothing to back up") + destination.mkdir(parents=True, exist_ok=True) + target = destination / BACKUP_FILE + if target.exists() and not force: + raise ValueError(f"{target} already holds a backup; pass --force to replace it") + with sqlite3.connect(origin) as source, sqlite3.connect(target) as copy: + source.backup(copy) + counted = _counts(copy) + version = _schema_version(copy) + manifest = BackupManifest( + created_at=utc_now(), + ely_eye_version=__version__, + schema_version=version, + atoms=counted["atoms"], + sources=counted["sources"], + cartridges=counted["cartridges"], + sha256=_sha256(target), + size_bytes=target.stat().st_size, + path=str(target), + ) + (destination / MANIFEST_FILE).write_text(manifest.model_dump_json(indent=2), encoding="utf-8") + return manifest + + +def _read_sidecar(source: Path) -> tuple[BackupManifest, int]: + manifest_path = source / MANIFEST_FILE + backup_file = source / BACKUP_FILE + if not manifest_path.is_file() or not backup_file.is_file(): + raise ValueError(f"{source} is not a backup: it needs {BACKUP_FILE} and {MANIFEST_FILE} inside it") + manifest = BackupManifest.model_validate_json(manifest_path.read_text(encoding="utf-8")) + digest = _sha256(backup_file) + if digest != manifest.sha256: + raise ValueError( + f"{backup_file} does not match its manifest: the file hashes {digest[:12]}, the manifest says {manifest.sha256[:12]}" + ) + with sqlite3.connect(backup_file) as connection: + if str(connection.execute("PRAGMA integrity_check").fetchone()[0]) != "ok": + raise ValueError(f"{backup_file} fails integrity_check; do not restore it") + tables = { + str(row[0]) + for row in connection.execute("SELECT name FROM sqlite_master WHERE type = 'table'").fetchall() + } + missing = [table for table in _REQUIRED_TABLES if table not in tables] + if missing: + raise ValueError(f"{backup_file} is missing the tables this store needs: {', '.join(missing)}") + version = _schema_version(connection) + return manifest, version + + +def restore(settings: Settings, source: Path, force: bool = False) -> BackupManifest: + """Put a backup back, and keep the store it replaces out of reach instead of under it.""" + manifest, version = _read_sidecar(source) + if version > SCHEMA_VERSION: + raise ValueError( + f"{source / BACKUP_FILE} was written by a newer build: schema {version}, this build understands {SCHEMA_VERSION}" + ) + live = settings.db_path + if live.exists(): + if not force: + raise ValueError(f"{live} already holds a store; pass --force to replace it") + kept = live.with_suffix(".before-restore") + try: + shutil.move(str(live), kept) + for suffix in ("-wal", "-shm"): + sibling = Path(f"{live}{suffix}") + if sibling.exists(): + shutil.move(str(sibling), Path(f"{kept}{suffix}")) + except OSError as error: + raise ValueError(f"cannot move {live} aside to {kept}: {error}") from error + live.parent.mkdir(parents=True, exist_ok=True) + try: + shutil.copyfile(source / BACKUP_FILE, live) + except OSError as error: + raise ValueError(f"cannot write the store to {live}: {error}") from error + Database(settings).init() + return manifest.model_copy(update={"path": str(live)}) + + +def _check_cartridges(database: Database, mounted: list[str], problems: list[str]) -> None: + roots = {str(row["cartridge_id"]): str(row["root_path"]) for row in database.list_cartridges()} + for cartridge_id in mounted: + root = roots.get(cartridge_id) + if root is None: + problems.append(f"{cartridge_id} is mounted but no cartridge row names it") + elif not Path(root).exists(): + problems.append(f"{cartridge_id} is mounted but its files at {root} are gone") + + +def _check_senses(settings: Settings, database: Database, visual: VisualIndex, warnings: list[str]) -> None: + counts = _modality_counts(database) + pictures = sum(counts.get(name, 0) for name in PICTURE_MODALITIES) + if settings.clip_model_dir is not None and visual.model_dir() is None: + warnings.append(f"the CLIP snapshot at {settings.clip_model_dir} is missing, so wordless pictures cannot be found") + elif pictures and not visual.available(): + warnings.append( + f"the store holds {pictures} picture {_atoms_word(pictures)} but no CLIP snapshot is set " + "(ELY_EYE_CLIP_MODEL_DIR), so they are findable only by the text already on them" + ) + elif visual.visual_atoms() and not visual.is_current(): + warnings.append("the visual index is behind the store; run `ely-eye index-visual`") + audio = counts.get("audio", 0) + if settings.asr_model_dir is None: + if audio: + warnings.append( + f"the store holds {audio} audio {_atoms_word(audio)} but no speech snapshot is set " + "(ELY_EYE_ASR_MODEL_DIR), so new audio will not be transcribed" + ) + elif not settings.asr_model_dir.exists(): + warnings.append(f"the speech snapshot at {settings.asr_model_dir} is missing, so audio cannot be transcribed") + if settings.vlm_model_dir is not None and not settings.vlm_model_dir.exists(): + warnings.append(f"the captioning model at {settings.vlm_model_dir} is missing, so images stay uncaptioned") + + +def _check_indexes(settings: Settings, database: Database, warnings: list[str]) -> None: + if not settings.dense_embeddings_enabled: + return + index = EmbeddingService(settings, database).load_index() + stored = database.atom_count() + if index is None: + warnings.append("dense embeddings are on but no index exists; run `ely-eye build-dense-index`") + elif len(index.atom_ids) != stored: + warnings.append( + f"the dense index covers {len(index.atom_ids)} atoms while the store holds {stored}; run `ely-eye build-dense-index`" + ) + + +def doctor(settings: Settings) -> DoctorReport: + """Say what is broken and what is only degraded, and name the command that fixes each.""" + problems: list[str] = [] + warnings: list[str] = [] + live = settings.db_path + if not live.exists(): + return DoctorReport( + ok=False, + store=str(live), + schema_version=None, + problems=[f"no memory store at {live}; run `ely-eye ingest` or `ely-eye remember` first"], + ) + database: Database + try: + database = Database(settings) + except SystemExit as error: + return DoctorReport( + ok=False, + store=str(live), + problems=[f"the store cannot be opened by this build: {error}"], + ) + with database.connect() as connection: + if str(connection.execute("PRAGMA integrity_check").fetchone()[0]) != "ok": + problems.append(f"{live} fails integrity_check; restore a backup before writing to it") + version = _schema_version(connection) + if version != SCHEMA_VERSION: + problems.append(f"the schema settled at version {version} while this build writes {SCHEMA_VERSION}") + mounted = mounted_ids(database) + _check_cartridges(database, mounted, problems) + _check_senses(settings, database, VisualIndex(settings, database), warnings) + _check_indexes(settings, database, warnings) + if settings.ui_dir is not None and not settings.ui_dir.exists(): + problems.append(f"ui_dir {settings.ui_dir} is set but holds no built interface, so the API refuses to start") + return DoctorReport( + ok=not problems, + store=str(live), + schema_version=version, + atoms=database.atom_count(), + sources=database.source_count(), + cartridges=database.cartridge_count(), + mounted=mounted, + problems=problems, + warnings=warnings, + ) diff --git a/backend/tests/test_maintenance.py b/backend/tests/test_maintenance.py new file mode 100644 index 0000000..89be85d --- /dev/null +++ b/backend/tests/test_maintenance.py @@ -0,0 +1,225 @@ +"""Backup, restore and doctor: a store nobody can move is a store nobody trusts.""" + +from __future__ import annotations + +import hashlib +import json +import sqlite3 +from pathlib import Path + +import pytest +from typer.testing import CliRunner + +from ely_eye import cli as cli_module +from ely_eye import maintenance +from ely_eye.cartridge_store import set_mounts +from ely_eye.cli import app +from ely_eye.config import Settings +from ely_eye.db import Database +from ely_eye.memory import MemoryService +from ely_eye.migrations import SCHEMA_VERSION +from ely_eye.schemas import EvidenceAtom, MemoryOrigin, Modality, SourceRecord, TrustScores, utc_now + +KEYS = "the keys are on the shelf by the door" +PASSPORT = "the passport is in the blue box" + + +def _settings(tmp_path: Path) -> Settings: + return Settings(home=tmp_path / "home", default_holder="wife") + + +def _store(settings: Settings, statements: tuple[str, ...] = (KEYS, PASSPORT)) -> Database: + database = Database(settings) + database.init() + service = MemoryService(settings, database) + for statement in statements: + service.remember(statement, holder_id="wife", origin=MemoryOrigin.self_) + return database + + +def _digest(path: Path) -> str: + return hashlib.sha256(path.read_bytes()).hexdigest() + + +def test_a_backup_carries_the_store_and_says_what_it_holds(tmp_path: Path) -> None: + settings = _settings(tmp_path) + _store(settings) + manifest = maintenance.backup(settings, tmp_path / "backup") + assert (tmp_path / "backup" / maintenance.BACKUP_FILE).is_file() + assert (tmp_path / "backup" / maintenance.MANIFEST_FILE).is_file() + assert manifest.atoms == 2 + assert manifest.sources == 2 + assert manifest.cartridges == 0 + assert manifest.schema_version == SCHEMA_VERSION + written = tmp_path / "backup" / maintenance.BACKUP_FILE + assert manifest.sha256 == _digest(written) + assert manifest.size_bytes == written.stat().st_size + + +def test_a_backup_refuses_to_overwrite_itself_without_permission(tmp_path: Path) -> None: + settings = _settings(tmp_path) + _store(settings) + maintenance.backup(settings, tmp_path / "backup") + with pytest.raises(ValueError, match="already holds a backup"): + maintenance.backup(settings, tmp_path / "backup") + assert maintenance.backup(settings, tmp_path / "backup", force=True).atoms == 2 + + +def test_backup_names_the_store_it_cannot_find(tmp_path: Path) -> None: + settings = _settings(tmp_path) + with pytest.raises(ValueError, match="nothing to back up"): + maintenance.backup(settings, tmp_path / "backup") + + +def test_a_restore_brings_the_memories_back(tmp_path: Path) -> None: + source = _settings(tmp_path) + _store(source) + manifest = maintenance.backup(source, tmp_path / "backup") + destination = Settings(home=tmp_path / "elsewhere", default_holder="wife") + restored = maintenance.restore(destination, tmp_path / "backup") + assert restored.path == str(destination.db_path) + assert manifest.atoms == 2 + database = Database(destination) + assert database.atom_count() == 2 + assert {atom.text for atom in database.list_atoms()} == {KEYS, PASSPORT} + + +def test_a_restore_keeps_the_store_it_replaces(tmp_path: Path) -> None: + settings = _settings(tmp_path) + _store(settings) + maintenance.backup(settings, tmp_path / "backup") + _store(settings, statements=("only one memory here",)) + with pytest.raises(ValueError, match="pass --force"): + maintenance.restore(settings, tmp_path / "backup") + maintenance.restore(settings, tmp_path / "backup", force=True) + kept = settings.db_path.with_suffix(".before-restore") + assert kept.is_file() + with sqlite3.connect(kept) as connection: + kept_atoms = int(connection.execute("SELECT COUNT(*) FROM atoms").fetchone()[0]) + assert kept_atoms == 3 + assert Database(settings).atom_count() == 2 + + +def test_a_tampered_backup_is_refused(tmp_path: Path) -> None: + settings = _settings(tmp_path) + _store(settings) + maintenance.backup(settings, tmp_path / "backup") + database_file = tmp_path / "backup" / maintenance.BACKUP_FILE + database_file.write_bytes(database_file.read_bytes() + b"\x00") + with pytest.raises(ValueError, match="does not match its manifest"): + maintenance.restore(Settings(home=tmp_path / "elsewhere"), tmp_path / "backup") + + +def test_a_backup_from_a_newer_build_is_refused(tmp_path: Path) -> None: + settings = _settings(tmp_path) + _store(settings) + maintenance.backup(settings, tmp_path / "backup") + database_file = tmp_path / "backup" / maintenance.BACKUP_FILE + with sqlite3.connect(database_file) as connection: + connection.execute(f"PRAGMA user_version = {SCHEMA_VERSION + 7}") + manifest_path = tmp_path / "backup" / maintenance.MANIFEST_FILE + manifest = json.loads(manifest_path.read_text(encoding="utf-8")) + manifest["schema_version"] = SCHEMA_VERSION + 7 + manifest["sha256"] = _digest(database_file) + manifest_path.write_text(json.dumps(manifest), encoding="utf-8") + with pytest.raises(ValueError, match="newer build"): + maintenance.restore(Settings(home=tmp_path / "elsewhere"), tmp_path / "backup") + + +def test_a_folder_without_the_backup_pair_is_refused(tmp_path: Path) -> None: + (tmp_path / "backup").mkdir() + with pytest.raises(ValueError, match="is not a backup"): + maintenance.restore(_settings(tmp_path), tmp_path / "backup") + + +def test_doctor_reports_a_store_that_does_not_exist_yet(tmp_path: Path) -> None: + report = maintenance.doctor(_settings(tmp_path)) + assert report.ok is False + assert len(report.problems) == 1 + assert "no memory store" in report.problems[0] + assert report.atoms == 0 + + +def test_doctor_passes_a_healthy_store(tmp_path: Path) -> None: + settings = _settings(tmp_path) + _store(settings) + report = maintenance.doctor(settings) + assert report.ok is True + assert report.problems == [] + assert report.atoms == 2 + assert report.sources == 2 + assert report.schema_version == SCHEMA_VERSION + + +def test_doctor_names_the_senses_a_store_holds_but_cannot_use(tmp_path: Path) -> None: + settings = _settings(tmp_path) + database = Database(settings) + database.init() + trust = TrustScores(parser=0.0, ocr=0.0, model=0.0) + database.upsert_sources( + [ + SourceRecord(source_id="img", path="file:///img.png", kind="image", mime="image/png", sha256="a", size_bytes=1), + SourceRecord(source_id="aud", path="file:///a.mp3", kind="audio", mime="audio/mpeg", sha256="b", size_bytes=1), + ] + ) + database.upsert_atoms( + [ + EvidenceAtom(atom_id="img:1", modality=Modality.image, source_id="img", source="file:///img.png", trust=trust), + EvidenceAtom(atom_id="aud:1", modality=Modality.audio, source_id="aud", source="file:///a.mp3", trust=trust), + ] + ) + report = maintenance.doctor(settings) + assert report.ok is True + assert len(report.warnings) == 2 + assert "1 picture atom but no CLIP snapshot" in report.warnings[0] + assert "1 audio atom but no speech snapshot" in report.warnings[1] + + +def test_doctor_names_a_mount_whose_files_are_gone(tmp_path: Path) -> None: + settings = _settings(tmp_path) + database = _store(settings) + database.write_cartridge( + "cart-a", "Cart A", tmp_path / "gone", "{}", "dna", 10, utc_now() + ) + set_mounts(database, ["cart-a"], utc_now()) + report = maintenance.doctor(settings) + assert report.ok is False + assert report.mounted == ["cart-a"] + assert len(report.problems) == 1 + assert "is mounted but its files at" in report.problems[0] + + +def test_doctor_refuses_a_store_written_by_a_newer_build(tmp_path: Path) -> None: + settings = _settings(tmp_path) + _store(settings) + with sqlite3.connect(settings.db_path) as connection: + connection.execute(f"PRAGMA user_version = {SCHEMA_VERSION + 7}") + report = maintenance.doctor(settings) + assert report.ok is False + assert len(report.problems) == 1 + assert "this build understands" in report.problems[0] + + +def test_the_cli_backs_up_and_a_restore_bring_the_store_home(tmp_path: Path, monkeypatch) -> None: + runner = CliRunner() + settings = _settings(tmp_path) + monkeypatch.setattr(cli_module, "get_settings", lambda: settings) + + empty = runner.invoke(app, ["doctor"]) + assert empty.exit_code == 1 + assert "no memory store" in empty.output + + _store(settings) + healthy = runner.invoke(app, ["doctor"]) + assert healthy.exit_code == 0 + assert json.loads(healthy.output)["atoms"] == 2 + + backed_up = runner.invoke(app, ["backup", str(tmp_path / "backup")]) + assert backed_up.exit_code == 0 + assert json.loads(backed_up.output)["sha256"] + + elsewhere = Settings(home=tmp_path / "elsewhere", default_holder="wife") + monkeypatch.setattr(cli_module, "get_settings", lambda: elsewhere) + moved = runner.invoke(app, ["restore", str(tmp_path / "backup")]) + assert moved.exit_code == 0 + assert Database(elsewhere).atom_count() == 2 diff --git a/frontend/package.json b/frontend/package.json index 85ca7f2..250ddb8 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -2,6 +2,7 @@ "name": "ely-eye-frontend", "version": "0.1.0", "private": true, + "license": "AGPL-3.0-only", "type": "module", "scripts": { "dev": "vite --host 127.0.0.1 --port 5173",