chore(fork): 上游血缘重建 - 以 upstream/main@e70fe1b9 为基线重放本仓库定制(端口 7380/7381、AGENTS 约定、移除 backend/server)
Publish container images / Quality checks (push) Has been cancelled
Publish container images / Resolve build version (push) Has been cancelled
Publish container images / Build open-ai-canvas-backend (amd64) (push) Has been cancelled
Publish container images / Build open-ai-canvas-backend (arm64) (push) Has been cancelled
Publish container images / Build open-ai-canvas-web (multi) (push) Has been cancelled
Publish container images / Build open-ai-canvas-yingce-agent (multi) (push) Has been cancelled
Publish container images / Publish open-ai-canvas-backend manifest (push) Has been cancelled
Publish container images / Publish open-ai-canvas-web manifest (push) Has been cancelled
Publish container images / Publish open-ai-canvas-yingce-agent manifest (push) Has been cancelled
Publish container images / Publish release assets (push) Has been cancelled

This commit is contained in:
tongtong committed 2026-10-13 10:58:42 +08:00
1 parent e70fe1b9c9
commit d6d6eab512
24 files changed
+348 -24

No files matched your search

+99
View File
@@ -164,3 +164,102 @@ cd web && bun run dev
- Git 提交说明使用 `<type>(<scope>): <业务模块> - <变更摘要>`,`type` 为 `feat|fix|refactor|perf|docs|test|build|ci|chore|revert`。
交付前至少检查:改动是否聚焦、调用方和类型是否同步、错误/权限/数据归属是否完整、必要文档是否同步、验证是否如实说明、是否留下密钥或本地数据。
---
# 本项目附加约定
以上第 1–9 章继承自上游 `ddcat-ai/open-ai-canvas`。以下为本仓库(`ttstd-infinite-canvas`)在底座之上叠加的约定;**与上游冲突时以本章为准**。
## A. 底座与上游同步
本仓库以 `ddcat-ai/open-ai-canvas` 为底座,通过 Git remote 保持可追溯的上游关系:
- `upstream` → `https://github.com/ddcat-ai/open-ai-canvas.git`(开发机上另存有一份克隆,可作离线 fetch 源)。
- 同步新功能:`git fetch upstream && git merge upstream/main`。冲突优先保留上游实现,本仓库的差异应集中在 B~D 三项。
- **功能一律优先使用上游源码实现**,不要在本仓库另起一套。确需偏离上游时,先在本章登记原因再改代码。
- `libtv.html` 与 `libtv-前端技术分析.md` 是竞品运行时快照与分析资料,属于本地参考,不要当作上游代码改动。
- 分支:本仓库工作分支为 `master`,上游为 `main`;`git pull upstream` 后按需合并。
## B. 端口约定
**不要改回上游默认的 3000 / 8080**——同机上 `infinite-canvas`、`open-ai-canvas`、`open-canvas` 都占用 3000,会互相抢占。
| 场景 | 前端 | 后端 |
| --- | --- | --- |
| 本地开发(宿主机) | **7380** | **7381** |
| Docker(宿主机映射) | **7380** → 容器 3000 | 不暴露(容器内仍 8080) |
容器内部端口保持上游原样(nginx `listen 3000`、后端 `:8080`),以减小与上游的差异面。改端口时必须同步:
- `web/package.json` — `dev` / `start` 的 `--port`
- `web/vite.config.ts` — `apiProxyTarget` 默认值
- `backend/cmd/server/main.go` — `CANVAS_BACKEND_ADDR` 默认值
- `scripts/start-local.ps1` — 后端地址、代理目标、提示文案
- `docker-compose.yml`、`docker-compose.local.yml` — 宿主机端口映射与 `CANVAS_CORS_ORIGINS`
- `.env.example` — `CANVAS_CORS_ORIGINS`、`CANVAS_HTTP_PORT`
- `README.md` 快速开始
`docker-compose.deploy.yml` / `docker-compose.server.yml` 与 `scripts/install-server*.sh` 面向独立服务器部署,保留上游的 3000 默认值,不做本地化改动。
`scripts/launch-canvas.ps1` 是上游维护者的个人脚本(硬编码 `D:\yingce\...`、`Administrator`、cloudflared 隧道),在本机不可用,**保持原样不要改**。
## C. 许可与商标红线
- 本仓库与上游均为 **MIT**。复制上游代码必须保留其版权声明与 `NOTICE`(声明 fork 自 `basketikun/infinite-canvas`,上游作者权利保留)。
- **`tldraw` 许可非 MIT**:生产环境商用需购买 license key,否则必须保留 "Made with tldraw" 水印。上游已预留 `VITE_TLDRAW_LICENSE_KEY`(构建期)与 `tldraw_license_key`(运行时设置),对外商用前必须就此明确决策。
- **不得新增他人 logo / 商标**:`web/public/icons/` 下的模型厂商图标、根 README 的赞助商与社群素材仅在上游语境下存在,对外分发前必须清理或替换为纯文字。
- **禁止把带 GPL 组件的 ffmpeg 打进分发镜像**:服务端 ffmpeg 使用 LGPL 构建或由用户挂载(`CANVAS_FFMPEG_PATH`)。
- 面向国内公众提供服务时,需处理 AI 生成内容标识、生成式 AI 服务备案与深度合成管理要求。
## D. 进程清理(强制)
验收或调试结束后清理进程时,**只允许按精确 PID 操作**,严禁用命令名、路径片段或宽正则批量匹配后终止。
正确做法:
1. `netstat -ano | Select-String 'LISTENING' | Select-String ':<端口>'` 拿到占用端口的 PID;
2. `Get-Process -Id <pid>` 确认进程名与可执行文件路径确属本项目;
3. `Stop-Process -Id <pid> -Force`;需要连带子进程时用 `taskkill /PID <pid> /T /F`。
禁止的做法(已有实际事故):
- ❌ `Get-CimInstance Win32_Process | Where-Object { $_.CommandLine -match 'server\.exe' } | Stop-Process`
曾匹配到 IDE 的 `embeddings-server.exe`,导致误杀开发环境进程。
- ❌ `-match 'vite'` / `-match 'node'` / `-match 'concurrently'` / `-match 'go'`
这些字符串同样会命中编辑器本体、语言服务器,以及同机上其它工程。
补充要求:
- 需要批量清理时,**先只打印**匹配结果(PID、进程名、完整命令行)供人工确认,确认后另起一步执行终止;不要在同一条命令里「查完即杀」。
- 无法确认归属的进程一律不动,交回用户处理。同机存在多个同类工程时尤其要区分(例如 `infinite-canvas/web/.../vite.js` 与本项目的 `vite.js`)。
- 误杀非本项目进程时,必须立即如实告知用户,说明进程名、可能影响与恢复方式,不要轻描淡写。
## E. 上游大文件与同步方式(backend/server)
上游在 `9727656b`(2026-09-14)提交了 `backend/server` —— 一个 62.7 MB 的构建产物(blob `cfba15a0`),且一直保留在 `upstream/main` 中;本仓库已在 `8cbc11e2` 之后用 `git filter-repo --path backend/server --invert-paths` 把它从自己的全部历史里移除,`git filter-repo` 单文件脚本与重写前的完整 bundle 备份放在本机 `.local/backup/`。由此有一条硬约束:
- **不要把上游提交并入 `main`**。`git merge upstream/main`、`git rebase upstream/main`、以及 `git pull origin main`(把重写前的旧远端历史拉回来)都会让该 blob 重新进入可达集合(`git rev-list --objects main` 会再次列出 `backend/server`),克隆体积复原。三种情况都已实测复现。
- 需要跟进上游内容时用「指定基线 + 快照提交」,不建立上游父提交:
```powershell
# 1. 记下上一次同步对应的上游 tip(作为本次三方合并的基线)
git rev-parse --short upstream/main # 例如 37b44444
git fetch upstream
# 2. 指定基线做三方合并。不要直接用 git merge:重写后与上游的共同祖先太远
# (准确说是文件引入前的老提交),git 会误报上百个冲突。
git merge-recursive 37b44444 -- main upstream/main
# 3. 解冲突(通常 0~2 个,只落在本仓库改过的文件上)
# 4. 确认大文件没有被加回:git ls-files backend/server 应为空
# 5. 提交:merge-recursive 不写 MERGE_HEAD,因此是单父提交,历史不接上游血缘
git add -A
git commit -m "chore(sync): 上游同步 - 快照导入 upstream/main@<新 tip> 并重放本项目差异"
```
- 首次实操记录(2026-10-12,同步 `37b44444` → `e70fe1b9`,15 个上游提交):指定基线后仅 1 个冲突(`canvas-project-top-bar.tsx` 的图标 import,取上游清单并保留本仓库仍在用的 `Settings`),167 个文件变更;用默认 `git merge` 则误报约 140 个冲突。
- 不要用 `git diff --binary` 生成差异补丁:本仓库相对上游包含 `backend/server` 的删除,二进制补丁会把 62.7 MB 内容整段写进补丁文件(实测 43.8 MB)。
- 与远端 `origin/main` 的对齐只能用强推(`git push --force-with-lease=main:<旧值> origin main`),不要 `git pull`:Gitea 上仍是重写前的历史,pull 必然冲突且把 blob 带回来。
- `git fetch upstream` 会把该 blob 拉进本地对象库(只在对象库,不进历史与工作区)。要回收本地空间:`git update-ref -d refs/remotes/upstream/main` 后再 `git gc --prune=now`。
- 若将来决定改回常规 `merge` 同步(换取上游血缘的合并体验),则必须在**每次合并提交里**执行 `git rm --cached backend/server`,并接受该 blob 常驻历史与克隆体积。`.gitignore` 已加 `/backend/server`,防止它被再次 `git add`。
- 根本解法是上游清理该文件。上游清理后,`git reset --hard upstream/main` 再重放本项目差异即可两全。