Initial commit: Plane 自部署与 gptproto AI 集成
包含本地/远程部署脚本、AI Agent 服务、Dashboard 与 QA 验证。 Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
+11
@@ -0,0 +1,11 @@
|
|||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
*.key
|
||||||
|
*.pem
|
||||||
|
__pycache__/
|
||||||
|
*.pyc
|
||||||
|
.pytest_cache/
|
||||||
|
.venv/
|
||||||
|
venv/
|
||||||
|
deploy/local/data/
|
||||||
|
.DS_Store
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
# AGENTS.md — Worker 共享上下文
|
||||||
|
|
||||||
|
> 你是 omc team 中的一员。**先读这份文档**再动手。
|
||||||
|
|
||||||
|
## 项目概要
|
||||||
|
本项目落地"Plane(开源项目管理)从 GitHub 自部署 + gptproto AI 集成"方案。
|
||||||
|
- 完整设计见 `docs/PLAN.md` — 必读
|
||||||
|
- 当前阶段:**Stage A(本地 mac docker 验证)**
|
||||||
|
- 部署目标:本地 `localhost:8080`(Plane Web)+ `localhost:8100`(AI Agent)
|
||||||
|
|
||||||
|
## 工作目录
|
||||||
|
固定为 `<PROJECT_ROOT>/`。**不要修改这个目录之外的任何文件**。
|
||||||
|
|
||||||
|
## 红线
|
||||||
|
1. **不要**直接 ssh 任何远程服务器(Stage B 由用户人工执行)
|
||||||
|
2. **不要**改 `docs/PLAN.md`(设计文档已冻结)
|
||||||
|
3. **不要**写 `OPENAI_API_KEY` / `GPTPROTO_API_KEY` 实值进任何文件,全用 `.env` 占位
|
||||||
|
4. **不要**删除其它 worker 的文件
|
||||||
|
5. **TDD 强制**:写功能必须先写 pytest 让其 RED,再实现让其 GREEN
|
||||||
|
|
||||||
|
## 任务边界(避免冲突)
|
||||||
|
- **Worker A** 只动:`deploy/local/`、`deploy/remote/`、`qa/`
|
||||||
|
- **Worker B** 只动:`ai-agent/`(含 `ai_agent/`、`tests/`、`requirements.txt`、`Dockerfile`)
|
||||||
|
- 谁都不动 `docs/`、`AGENTS.md`、`README.md`
|
||||||
|
|
||||||
|
## 必读约束
|
||||||
|
### Plane 部署来源
|
||||||
|
- 必须 `git clone --branch v1.3.0 --depth 1 https://github.com/makeplane/plane.git`
|
||||||
|
- 不允许 `curl ... | bash`
|
||||||
|
- docker-compose 镜像必须锁 tag(`makeplane/plane-frontend:v1.3.0`),禁用 `:latest`
|
||||||
|
|
||||||
|
### 本地端口
|
||||||
|
- Plane Web → `localhost:8080`
|
||||||
|
- Plane API → 仅 docker 网络内 `api:8000`
|
||||||
|
- AI Agent → `localhost:8100`
|
||||||
|
- Postgres/Redis/MinIO **不**暴露到 host
|
||||||
|
|
||||||
|
### gptproto 配置
|
||||||
|
- Base URL: `https://gptproto.com/v1`(OpenAI SDK 兼容)
|
||||||
|
- Model 默认: `claude-sonnet-4-6`
|
||||||
|
- Key 通过 `GPTPROTO_API_KEY` 环境变量注入,**绝对不写明文**
|
||||||
|
|
||||||
|
### TDD 流程(Worker B 必读)
|
||||||
|
```
|
||||||
|
1. 写 tests/test_<feature>.py
|
||||||
|
2. pytest -v # 必须 RED,且失败原因合理(不是 import error)
|
||||||
|
3. 写 ai_agent/main.py 中的实现
|
||||||
|
4. pytest -v # GREEN
|
||||||
|
5. 提交一个端点再做下一个
|
||||||
|
```
|
||||||
|
要求:用 `pytest` + `httpx.AsyncClient` 测 FastAPI;用 `pytest-mock` 或 `respx` mock gptproto 和 Plane API(不要真发外网请求)。
|
||||||
|
|
||||||
|
### Mock 策略
|
||||||
|
- `gptproto` 调用 → respx 拦截 `https://gptproto.com/v1/chat/completions`
|
||||||
|
- `Plane API` 调用 → respx 拦截 `http://api:8000/api/v1/...`
|
||||||
|
- 单测**禁止**真实联网
|
||||||
|
|
||||||
|
## 完成定义
|
||||||
|
- **Worker A**:`deploy/local/` 下脚本可一键 `bash pull-plane.sh && docker compose up -d`,QA 脚本能验证健康;`deploy/remote/` 给出可读 README + install.sh(不实际执行远程)
|
||||||
|
- **Worker B**:`pytest ai-agent/tests/ -v` 全绿;4 个端点(healthz / create-issue / summarize / search)全实现;`ai-agent/Dockerfile` 可 `docker build` 成功
|
||||||
|
|
||||||
|
## 完成后
|
||||||
|
在 `qa/checklist.md` 末尾追加自己的"WORKER A 完成"或"WORKER B 完成"+ 时间戳,结束 worker。
|
||||||
@@ -0,0 +1,143 @@
|
|||||||
|
# plane-gptproto-integration
|
||||||
|
|
||||||
|
Plane v1.3.0(AGPL-3.0 开源项目管理)自部署 + gptproto.com(OpenAI 兼容聚合 API)AI Agent 集成。本地 mac docker 验证后再上 YOUR_SERVER_IP 生产。
|
||||||
|
|
||||||
|
## 双环境部署架构
|
||||||
|
|
||||||
|
| 环境 | Web 入口 | AI 端点 | compose 路径 | 端口绑定 |
|
||||||
|
|---|---|---|---|---|
|
||||||
|
| 本地 mac | http://localhost:8090 | http://localhost:8100 | `deploy/local/` + `src/` git clone | `0.0.0.0:8090/8100` |
|
||||||
|
| 生产 YOUR_SERVER_IP | https://YOUR_SERVER_IP:8445 | https://YOUR_SERVER_IP:8446 | `/opt/plane/` (1Panel + OpenResty) | `127.0.0.1:8092/8101` |
|
||||||
|
|
||||||
|
生产走 1Panel + OpenResty 反代 + ufw + 自签 SSL(`/opt/1panel/www/ssl/luma/luma.{crt,key}`,已存在)。**容器只绑 127.0.0.1**,公网入口由 OpenResty `/opt/1panel/www/conf.d/plane.conf` 反代。生产端口规划遵循 `~/dev/PRODUCTION_DEPLOY_TEMPLATE.md`:公网用 8445/8446/8447 段,内部用 8090+。**8090 已被 1Panel openresty 占用**,本地 mac 用 8090 OK,生产改 8092。
|
||||||
|
|
||||||
|
## 常用命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 本地启停
|
||||||
|
cd deploy/local
|
||||||
|
docker compose -f src/deployments/cli/community/docker-compose.yml -f docker-compose.override.yml --env-file .env up -d --pull never
|
||||||
|
bash ../../qa/verify-local.sh # 6 项健康检查,exit=0 全过
|
||||||
|
|
||||||
|
# 生产 (ssh + docker compose)
|
||||||
|
ssh root@YOUR_SERVER_IP 'cd /opt/plane && docker compose -f src/deployments/cli/community/docker-compose.yml -f docker-compose.override.yml --env-file .env restart'
|
||||||
|
|
||||||
|
# AI Agent 改 main.py 后同步生产 + rebuild
|
||||||
|
rsync -az --exclude=.venv --exclude=__pycache__ ai-agent/ root@YOUR_SERVER_IP:/opt/plane/ai-agent/
|
||||||
|
ssh root@YOUR_SERVER_IP 'cd /opt/plane && docker compose -f src/deployments/cli/community/docker-compose.yml -f docker-compose.override.yml --env-file .env up -d --build --force-recreate plane-ai'
|
||||||
|
|
||||||
|
# pytest 本地 TDD
|
||||||
|
cd ai-agent && source .venv/bin/activate && pytest -v
|
||||||
|
```
|
||||||
|
|
||||||
|
## 非显然坑点(必读,本次会话血泪验证)
|
||||||
|
|
||||||
|
### 1. Plane v1.3.0 compose 路径变了
|
||||||
|
官方 selfhost 入口从旧版 `src/deploy/selfhost/docker-compose.yml` 搬到 `src/deployments/cli/community/docker-compose.yml`。Worker 用旧路径会 `no such file or directory`。
|
||||||
|
|
||||||
|
### 2. Docker Desktop 自动捕获 macOS 系统代理 → TLS bug
|
||||||
|
mac 上 `docker pull` 报 `tls: bad record MAC` / `version 300 vs 303` 几乎一定是你 Clash/V2Ray 占着 `127.0.0.1:1082`,Docker Desktop 自动用了它,本地代理拆 TLS 失败。修法:Docker Desktop → Settings → Resources → Proxies → **打开 Manual** 但三栏全留空 → **Quit Docker Desktop**(完整退出,Restart 不够,要 Quit)→ 重开。`http.docker.internal:3128` 在 `docker info` 里永远显示,是 Docker 内置 forwarder,跟你的代理设置无关。
|
||||||
|
|
||||||
|
### 3. OpenResty 反代 FastAPI uvicorn 必须显式 HTTP/1.1
|
||||||
|
```nginx
|
||||||
|
proxy_pass http://127.0.0.1:8101;
|
||||||
|
proxy_http_version 1.1;
|
||||||
|
proxy_set_header Connection "";
|
||||||
|
```
|
||||||
|
缺这两行 → uvicorn 等 keepalive 不释放 → 30s 必 ReadTimeout。已修进 `deploy/remote/plane.conf` 8446 server block。
|
||||||
|
|
||||||
|
### 4. gptproto 部分 model 当前不可用
|
||||||
|
`claude-sonnet-4-6` 60s timeout(gptproto 端挂),改用 `claude-sonnet-4-5-20250929` 或 `claude-haiku-4-5-20251001`。`chatgpt-4o-latest` 可能 503 overloaded。`.env` 里 `GPTPROTO_MODEL` 决定。
|
||||||
|
|
||||||
|
### 5. Anthropic 不支持 OpenAI 的 `response_format: json_object`
|
||||||
|
gptproto 转发给 Anthropic 时该参数被忽略,模型可能返回 ```` ```json ... ``` ```` 围栏或纯文本。`ai_agent/main.py::_extract_json` 已用 regex 兜底(先抓围栏再抓 `{...}`)。
|
||||||
|
|
||||||
|
### 6. plane-ai 进程残留死连接
|
||||||
|
切 model 或修 .env 后 ReadTimeout 不消失,必须 `docker compose up -d --force-recreate plane-ai`。普通 `restart` 或 `up -d` 不彻底。
|
||||||
|
|
||||||
|
### 7. `rsync --delete` 会清生产 src/
|
||||||
|
本地 staging 目录没 src/ 时,`rsync -az --delete /tmp/staging/ /opt/plane/` 会删服务器 git clone 的 src/。**绝不在生产路径用 --delete**,或显式 `--exclude=src/`。
|
||||||
|
|
||||||
|
### 8. 非标端口部署:OpenResty 必须用 `$http_host` 不是 `$host`
|
||||||
|
Plane backend `storage.py` 用 `request.get_host()` 构造 MinIO presigned upload URL。两层反代(OpenResty → Caddy → Django)必须把**带端口**的 Host 头透传到底:
|
||||||
|
- nginx `$host` 不带端口(`YOUR_SERVER_IP`)
|
||||||
|
- nginx `$http_host` 带端口(`YOUR_SERVER_IP:8445`)
|
||||||
|
|
||||||
|
错误用 `$host` → Django 得到 host 没端口 → presigned URL `https://YOUR_SERVER_IP/uploads`(走 443 撞别的服务) → CORS blocked。
|
||||||
|
|
||||||
|
正确:
|
||||||
|
```nginx
|
||||||
|
location / {
|
||||||
|
proxy_pass http://127.0.0.1:8092;
|
||||||
|
proxy_set_header Host $http_host; # ← 必须 $http_host 不是 $host
|
||||||
|
...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`APP_DOMAIN=YOUR_SERVER_IP:8445` 也要(影响 Plane CORS allow-origin 等),但单独改它不够,必须配合 OpenResty 修。
|
||||||
|
|
||||||
|
## Plane v1.3.0 数据库/安全实测
|
||||||
|
|
||||||
|
- `users.password` PBKDF2 哈希 ✅ 标准
|
||||||
|
- `api_tokens.token` **明文**存储 ⚠️ 任何 PG 读权限可枚举所有 token
|
||||||
|
- `instance_configurations` 加密字段(如 LLM_API_KEY)通过 GET `/api/instances/configurations/` 时被 `InstanceConfigurationSerializer.to_representation` **decrypt 后明文回吐**给前端 → F12 Network 可见
|
||||||
|
- 真 `GPTPROTO_API_KEY` 仅放 `.env`(chmod 600)+ 容器 env,**不入 Plane DB**
|
||||||
|
- god-mode AI Settings 永远留空(我们走独立 plane-ai 服务,Plane backend 用不到这个 key)
|
||||||
|
|
||||||
|
## API 端点 (FastAPI plane-ai)
|
||||||
|
|
||||||
|
| 端点 | 输入 | 行为 |
|
||||||
|
|---|---|---|
|
||||||
|
| `GET /healthz` | — | `{"status":"ok"}`,Dockerfile healthcheck 用 |
|
||||||
|
| `POST /ai/create-issue` | `{prompt, project_id, workspace_slug}` | gptproto 解析 → POST Plane `/api/v1/.../issues/` |
|
||||||
|
| `POST /ai/summarize` | `{issues:[...]}` | gptproto 中文摘要 |
|
||||||
|
| `POST /ai/search` | `{query, workspace_slug}` | Plane `/issues/search/?search=` + gptproto 排序 |
|
||||||
|
|
||||||
|
注意 search 用 `/issues/search/`(v1 public 端点)不是 `/search/`(internal app 端点要 session auth)。
|
||||||
|
|
||||||
|
## 文件清单
|
||||||
|
|
||||||
|
```
|
||||||
|
CLAUDE.md 本文件
|
||||||
|
AGENTS.md worker 共享上下文(开发期产物)
|
||||||
|
README.md 对外简介
|
||||||
|
docs/PLAN.md 完整设计 + 后门/隐私评估
|
||||||
|
docs/USER_GUIDE.md 给领导/团队的使用说明
|
||||||
|
deploy/local/.env 本地密钥(600, .gitignore)
|
||||||
|
deploy/local/docker-compose.override.yml 本地端口 0.0.0.0:8090/8100
|
||||||
|
deploy/local/pull-plane.sh git clone v1.3.0(idempotent)
|
||||||
|
deploy/local/src/ Plane 源码(git, .gitignore)
|
||||||
|
deploy/remote/docker-compose.override.yml 生产端口 127.0.0.1:8092/8101
|
||||||
|
deploy/remote/plane.conf OpenResty 反代(8445/8446 → 8092/8101,含 HTTP/1.1 修复)
|
||||||
|
ai-agent/ai_agent/main.py 4 端点 + _extract_json + httpx async
|
||||||
|
ai-agent/tests/ pytest TDD,respx mock 不真联网
|
||||||
|
qa/verify-local.sh 6 项健康检查
|
||||||
|
qa/checklist.md worker 签名 + 人工验收项
|
||||||
|
```
|
||||||
|
|
||||||
|
## 红线
|
||||||
|
|
||||||
|
- 不在 god-mode → AI Settings 填真 GPTPROTO_API_KEY(Plane backend 用不到 + 解密回显有 leak 风险)
|
||||||
|
- 不直接绑容器到 0.0.0.0:80(违反 `~/dev/PRODUCTION_DEPLOY_TEMPLATE.md`)
|
||||||
|
- 不 ssh 手动改生产 .env 不同步本地(本地 `deploy/remote/` 是 source of truth)
|
||||||
|
- 不拉 Plane master/latest,锁 `v1.3.0` + GitHub Release tag
|
||||||
|
- 不在生产路径用 `rsync --delete`
|
||||||
|
|
||||||
|
## 升级流程(Plane 出新版后)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ssh root@YOUR_SERVER_IP
|
||||||
|
cd /opt/plane/src
|
||||||
|
git fetch --depth 1 origin refs/tags/vX.Y.Z:refs/tags/vX.Y.Z
|
||||||
|
git checkout vX.Y.Z
|
||||||
|
cd ..
|
||||||
|
sed -i 's/^APP_RELEASE=.*/APP_RELEASE=vX.Y.Z/' .env
|
||||||
|
docker compose -f src/deployments/cli/community/docker-compose.yml -f docker-compose.override.yml --env-file .env pull
|
||||||
|
docker compose -f src/deployments/cli/community/docker-compose.yml -f docker-compose.override.yml --env-file .env up -d
|
||||||
|
# 本地同步: 改 deploy/remote/.env.template 的 APP_RELEASE
|
||||||
|
# 验证: 镜像无 :latest, ufw 无变, openresty conf 无需改
|
||||||
|
```
|
||||||
|
|
||||||
|
## 服务器现状 (YOUR_SERVER_IP, 1Panel v2.1.10)
|
||||||
|
|
||||||
|
8 核 / 31GB / 387GB(余 360GB+),Hostinger VPS。已部署兄弟项目:Luma 主站(443/8088)、harvester(8443/8089)、领航 BI(8444)、VideoFlow(9080-9443)。新增 Plane 占 8445(web)/8446(ai),内部 8092/8101。
|
||||||
+165
@@ -0,0 +1,165 @@
|
|||||||
|
# 交付说明 — plane-gptproto-integration
|
||||||
|
|
||||||
|
本压缩包包含 Plane v1.3.0 (AGPL-3.0 开源项目管理工具) 自部署 + gptproto.com AI 聚合 API 集成的完整代码。已脱敏,可直接交付外部团队部署。
|
||||||
|
|
||||||
|
## 包内容速览
|
||||||
|
|
||||||
|
```
|
||||||
|
plane-gptproto-integration/
|
||||||
|
├── HANDOFF.md ← 你正在看的这份
|
||||||
|
├── README.md 项目简介
|
||||||
|
├── CLAUDE.md / AGENTS.md 开发期 AI 协作上下文 (可保留作技术参考)
|
||||||
|
├── docs/
|
||||||
|
│ ├── PLAN.md 完整方案 + 后门/隐私评估
|
||||||
|
│ └── USER_GUIDE.md 给最终用户的使用说明
|
||||||
|
├── deploy/
|
||||||
|
│ ├── local/ 本地 Docker 部署 (推荐先在这跑通)
|
||||||
|
│ │ ├── .env.template 所有密钥占位符,部署前需填
|
||||||
|
│ │ ├── docker-compose.override.yml
|
||||||
|
│ │ ├── pull-plane.sh 从 GitHub 拉 Plane v1.3.0 源码 (源码已附带,通常无需运行)
|
||||||
|
│ │ ├── README.md 本地部署详细步骤
|
||||||
|
│ │ └── src/ Plane v1.3.0 上游源码 (已随包附带,离线可部署)
|
||||||
|
│ └── remote/ 生产部署 (1Panel + OpenResty 反代 + 自签 SSL)
|
||||||
|
│ ├── .env.template
|
||||||
|
│ ├── docker-compose.override.yml
|
||||||
|
│ ├── install.sh 生产一键安装脚本
|
||||||
|
│ ├── plane.conf OpenResty 反代配置
|
||||||
|
│ ├── tdb.js 前端注入脚本
|
||||||
|
│ └── README.md
|
||||||
|
├── ai-agent/ FastAPI AI 聚合服务源码
|
||||||
|
│ ├── ai_agent/main.py 4 个端点: /healthz /ai/create-issue /ai/summarize /ai/search
|
||||||
|
│ ├── Dockerfile
|
||||||
|
│ ├── requirements.txt
|
||||||
|
│ └── tests/ pytest TDD 用例
|
||||||
|
├── plane-dashboard/ 自定义前端 (React + Vite + Semi UI)
|
||||||
|
│ ├── src/ 源码
|
||||||
|
│ ├── dist/ 预编译产物 (可直接 docker build 不必本机 npm install)
|
||||||
|
│ ├── Dockerfile
|
||||||
|
│ ├── nginx.conf
|
||||||
|
│ └── package.json
|
||||||
|
└── qa/
|
||||||
|
├── verify-local.sh 6 项健康检查
|
||||||
|
└── checklist.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## 已脱敏
|
||||||
|
|
||||||
|
- ✅ 所有真实密钥/Token 已剔除,`deploy/*/.env.template` 全部为 `CHANGEME_*` 占位符
|
||||||
|
- ✅ 生产服务器 IP 已替换为占位符 `YOUR_SERVER_IP`
|
||||||
|
- ✅ docker-compose 中的本机绝对路径已改为相对路径 (`../../ai-agent`、`../../plane-dashboard`)
|
||||||
|
- ✅ `__pycache__` / `.venv` / `node_modules` / `.DS_Store` / `.omc` 已剔除
|
||||||
|
|
||||||
|
## 反遥测 / 反回拨锁定 (LOCKDOWN) ★ 必读
|
||||||
|
|
||||||
|
Plane v1.3.0 默认有几个"回拨家里"通道,**本包已用 env-gated 开关全部封堵**。
|
||||||
|
设计原则: 不动上游业务代码逻辑,只在 1 个文件加 2 处 if 守卫,通过 .env 里的开关控制开关。
|
||||||
|
升级 Plane 时几乎不会和上游冲突,改动可审计、可一键还原。
|
||||||
|
|
||||||
|
| 通道 | 默认状态 | 已采取的措施 |
|
||||||
|
|---|---|---|
|
||||||
|
| OpenTelemetry → `telemetry.plane.so` (每 6 小时 + 启动各一次,发送 instance_id / 用户数 / issue 数等) | 上游默认 **开** | (1) `register_instance.py` 新建 Instance 时根据 env `DISABLE_TELEMETRY=1` 把 `is_telemetry_enabled` 置 False (2) tracer.py 上游本身的 `if instance.is_telemetry_enabled:` 守卫会直接跳过上报逻辑 (3) 防御纵深: `OTLP_ENDPOINT=http://127.0.0.1:1` 让 exporter 连黑洞 |
|
||||||
|
| GitHub release 检查 → `api.github.com/repos/makeplane/.../releases/latest` (启动一次) | 上游默认 **开,无 env 关** | `register_instance.py` 的 `check_for_latest_version()` 加 env 守卫: `DISABLE_GITHUB_VERSION_CHECK=1` 时直接返回 fallback,后面 try/requests.get 流程保留(便于将来想恢复) |
|
||||||
|
| PostHog 事件追踪 → 用户邀请/工作区删除等 | 关 (需 env 配置才会发) | `.env.template` 显式空 `POSTHOG_API_KEY` / `POSTHOG_HOST` |
|
||||||
|
| Microsoft Clarity 前端会话录制 → `clarity.ms` | 关 (需 env 配置才会发) | `.env.template` 显式空 `VITE_SESSION_RECORDER_KEY` |
|
||||||
|
| Intercom 客服 widget → `widget.intercom.io` | 上游默认 **开** | `IS_INTERCOM_ENABLED=0` |
|
||||||
|
|
||||||
|
代码改动只有 1 个文件,2 处新增 if 守卫(共 6 行),其他逻辑 100% 原样:
|
||||||
|
- `apps/api/plane/license/management/commands/register_instance.py`
|
||||||
|
- diff 在 `deploy/local/patches/01-env-gated-register-instance.patch`
|
||||||
|
- override.yml 通过 `volumes:` bind-mount 把这个 patched 文件覆盖到上游容器内的 `/code/plane/...` (绕过预构建镜像不能改源码的限制)
|
||||||
|
|
||||||
|
### 部署后如何验证 LOCKDOWN 生效
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. DB 里 telemetry 标志位
|
||||||
|
docker compose exec plane-db psql -U plane -d plane -c \
|
||||||
|
"SELECT instance_id, is_telemetry_enabled FROM instances;"
|
||||||
|
# 期望: is_telemetry_enabled = f (false)
|
||||||
|
|
||||||
|
# 2. 容器内确认 env-gated 补丁已挂载
|
||||||
|
docker compose exec api grep -n "LOCKDOWN" \
|
||||||
|
/code/plane/license/management/commands/register_instance.py
|
||||||
|
# 期望: 2 行 (check_for_latest_version 守卫 + create 默认值)
|
||||||
|
|
||||||
|
# 3. 容器里看 env 开关已注入
|
||||||
|
docker compose exec api sh -c 'env | grep -E "DISABLE_TELEMETRY|DISABLE_GITHUB"'
|
||||||
|
# 期望: DISABLE_TELEMETRY=1 DISABLE_GITHUB_VERSION_CHECK=1
|
||||||
|
```
|
||||||
|
|
||||||
|
### 想恢复上游原版行为(关闭 LOCKDOWN)?
|
||||||
|
|
||||||
|
只需在 .env 里把 `DISABLE_TELEMETRY=0` 和 `DISABLE_GITHUB_VERSION_CHECK=0`,然后 `docker compose up -d --force-recreate api`。 代码逻辑完整无缺,不需要改源码。
|
||||||
|
|
||||||
|
## 快速部署 (本地 Docker)
|
||||||
|
|
||||||
|
前置: Docker Desktop ≥ 4.30,8090 / 8100 端口空闲。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. 解压
|
||||||
|
unzip plane-gptproto-integration.zip
|
||||||
|
cd plane-gptproto-integration
|
||||||
|
|
||||||
|
# 2. 准备环境变量 (复制模板 → 替换所有 CHANGEME_*)
|
||||||
|
cp deploy/local/.env.template deploy/local/.env
|
||||||
|
chmod 600 deploy/local/.env
|
||||||
|
# 用你喜欢的编辑器把所有 CHANGEME_xxx 改成强随机值
|
||||||
|
# 必填项:
|
||||||
|
# POSTGRES_PASSWORD 强密码 (随机 32 字符)
|
||||||
|
# RABBITMQ_PASSWORD 强密码 (随机 32 字符)
|
||||||
|
# SECRET_KEY Django 密钥 (≥ 50 字符)
|
||||||
|
# AWS_ACCESS_KEY_ID MinIO 用,任意字符串
|
||||||
|
# AWS_SECRET_ACCESS_KEY MinIO 用,任意字符串
|
||||||
|
# LIVE_SERVER_SECRET_KEY ≥ 32 字符
|
||||||
|
# GPTPROTO_API_KEY gptproto.com 控制台申请
|
||||||
|
# PLANE_API_TOKEN 留空,Plane 首次登录后在 god-mode 生成再回填
|
||||||
|
${EDITOR:-vim} deploy/local/.env
|
||||||
|
|
||||||
|
# 3. 启动
|
||||||
|
cd deploy/local
|
||||||
|
docker compose \
|
||||||
|
-f src/deployments/cli/community/docker-compose.yml \
|
||||||
|
-f docker-compose.override.yml \
|
||||||
|
--env-file .env \
|
||||||
|
up -d
|
||||||
|
|
||||||
|
# 4. 等约 30s 让 migrator 跑完,然后健康检查
|
||||||
|
bash ../../qa/verify-local.sh
|
||||||
|
|
||||||
|
# 5. 浏览器访问
|
||||||
|
# http://localhost:8090 Plane Web
|
||||||
|
# http://localhost:8100/healthz AI Agent
|
||||||
|
# http://localhost:8103 自定义 dashboard
|
||||||
|
```
|
||||||
|
|
||||||
|
## 生产部署 (Linux + 1Panel + OpenResty)
|
||||||
|
|
||||||
|
参见 `deploy/remote/README.md` 和 `docs/PLAN.md`。要点:
|
||||||
|
- 容器只绑 `127.0.0.1:<port>`,公网入口由 OpenResty 反代到 HTTPS
|
||||||
|
- `plane.conf` 反代配置已包含 HTTP/1.1 修复 (避免 uvicorn keepalive 超时)
|
||||||
|
- `$http_host` 必须透传 (非 `$host`),否则 MinIO presigned URL 会丢端口导致 CORS 失败
|
||||||
|
|
||||||
|
## 已知坑点 (来自原作者实战,务必读 `CLAUDE.md` 完整版)
|
||||||
|
|
||||||
|
1. **Plane v1.3.0 compose 路径** = `src/deployments/cli/community/docker-compose.yml` (旧版的 `src/deploy/selfhost/docker-compose.yml` 已废弃)
|
||||||
|
2. **macOS Docker Desktop 走系统代理会导致 TLS 失败**: Settings → Resources → Proxies → Manual 但全留空 → Quit (非 Restart) → 重开
|
||||||
|
3. **gptproto 的 `claude-sonnet-4-6` 当前 60s timeout 不可用**,改用 `claude-sonnet-4-5-20250929` 或 `claude-haiku-4-5-20251001`
|
||||||
|
4. **改 .env 后 plane-ai 容器要 `up -d --force-recreate plane-ai`**,普通 restart 不彻底
|
||||||
|
5. **生产路径上禁用 `rsync --delete`** (会清掉服务器上的 git clone 的 src/)
|
||||||
|
|
||||||
|
## 端口规划速查
|
||||||
|
|
||||||
|
| 服务 | 本地端口 | 生产容器内 | 生产对外 (经 OpenResty) |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Plane Web (proxy) | 8090 | 127.0.0.1:8092 | YOUR_SERVER_IP:8445 (HTTPS) |
|
||||||
|
| AI Agent (FastAPI) | 8100 | 127.0.0.1:8101 | YOUR_SERVER_IP:8446 (HTTPS) |
|
||||||
|
| 自定义 dashboard | 8103 | 127.0.0.1:8103 | YOUR_SERVER_IP:8445/dashboard/ |
|
||||||
|
| Postgres / Redis / MinIO / RabbitMQ | 仅 docker 网络 | 仅 docker 网络 | - |
|
||||||
|
|
||||||
|
## 许可证
|
||||||
|
|
||||||
|
- Plane 上游源码: AGPL-3.0 (见 `deploy/local/src/LICENSE.txt`)
|
||||||
|
- 本集成代码: 内部使用,请按贵团队规定处理
|
||||||
|
|
||||||
|
## 联系/反馈
|
||||||
|
|
||||||
|
部署遇到问题,优先看 `CLAUDE.md` 的"非显然坑点"一节——基本覆盖了实战中遇到的所有陷阱。
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# plane-gptproto-integration
|
||||||
|
|
||||||
|
Plane(github.com/makeplane/plane,AGPL-3.0)自部署 + gptproto.com AI 聚合 API 集成。
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- `docs/PLAN.md` — 完整方案,含**后门/隐私评估**
|
||||||
|
- `deploy/local/` — 本地 mac docker 验证脚本(Stage A)
|
||||||
|
- `deploy/remote/` — 上 YOUR_SERVER_IP 的部署脚本(Stage B)
|
||||||
|
- `ai-agent/` — FastAPI AI Agent(TDD + pytest)
|
||||||
|
- `qa/` — 验证脚本与清单
|
||||||
|
|
||||||
|
## 当前阶段
|
||||||
|
**Stage A**:本地 mac docker 跑通 → 通过 QA 后再上远程。
|
||||||
|
|
||||||
|
## 快速开始(Stage A 完成后)
|
||||||
|
```bash
|
||||||
|
cd deploy/local
|
||||||
|
cp .env.template .env && vim .env # 填 GPTPROTO_API_KEY
|
||||||
|
bash pull-plane.sh # git clone v1.3.0
|
||||||
|
docker compose up -d
|
||||||
|
bash ../../qa/verify-local.sh # 验证全绿
|
||||||
|
open http://localhost:8090
|
||||||
|
```
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
FROM python:3.11-slim
|
||||||
|
|
||||||
|
ENV PYTHONDONTWRITEBYTECODE=1 \
|
||||||
|
PYTHONUNBUFFERED=1 \
|
||||||
|
PIP_NO_CACHE_DIR=1
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY requirements.txt /app/requirements.txt
|
||||||
|
RUN pip install --no-cache-dir -r /app/requirements.txt
|
||||||
|
|
||||||
|
COPY ai_agent /app/ai_agent
|
||||||
|
|
||||||
|
EXPOSE 8100
|
||||||
|
|
||||||
|
HEALTHCHECK --interval=30s --timeout=5s --retries=3 \
|
||||||
|
CMD python -c "import urllib.request,sys; sys.exit(0 if urllib.request.urlopen('http://127.0.0.1:8100/healthz').status==200 else 1)"
|
||||||
|
|
||||||
|
CMD ["uvicorn", "ai_agent.main:app", "--host", "0.0.0.0", "--port", "8100"]
|
||||||
@@ -0,0 +1,296 @@
|
|||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
from contextlib import asynccontextmanager
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import asyncpg
|
||||||
|
import httpx
|
||||||
|
from fastapi import FastAPI, HTTPException, Query, Request
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
_db_pool: asyncpg.Pool | None = None
|
||||||
|
|
||||||
|
|
||||||
|
@asynccontextmanager
|
||||||
|
async def lifespan(app: FastAPI):
|
||||||
|
global _db_pool
|
||||||
|
db_url = os.environ.get("DATABASE_URL")
|
||||||
|
if db_url:
|
||||||
|
try:
|
||||||
|
_db_pool = await asyncpg.create_pool(
|
||||||
|
db_url, min_size=1, max_size=3, command_timeout=5
|
||||||
|
)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("plane-ai DB pool init failed — /data/role will return is_admin=false")
|
||||||
|
yield
|
||||||
|
if _db_pool:
|
||||||
|
await _db_pool.close()
|
||||||
|
_db_pool = None
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_json(text: str) -> dict:
|
||||||
|
s = text.strip()
|
||||||
|
fence = re.search(r"```(?:json)?\s*(\{.*?\})\s*```", s, re.DOTALL)
|
||||||
|
if fence:
|
||||||
|
s = fence.group(1)
|
||||||
|
else:
|
||||||
|
m = re.search(r"\{.*\}", s, re.DOTALL)
|
||||||
|
if m:
|
||||||
|
s = m.group(0)
|
||||||
|
return json.loads(s)
|
||||||
|
|
||||||
|
|
||||||
|
app = FastAPI(title="plane-gptproto ai-agent", lifespan=lifespan)
|
||||||
|
|
||||||
|
|
||||||
|
def get_settings() -> dict:
|
||||||
|
return {
|
||||||
|
"gptproto_base_url": os.environ.get("GPTPROTO_BASE_URL", "https://gptproto.com/v1"),
|
||||||
|
"gptproto_api_key": os.environ.get("GPTPROTO_API_KEY", ""),
|
||||||
|
"gptproto_model": os.environ.get("GPTPROTO_MODEL", "claude-sonnet-4-6"),
|
||||||
|
"plane_api_base": os.environ.get("PLANE_API_BASE", "http://api:8000"),
|
||||||
|
"plane_api_token": os.environ.get("PLANE_API_TOKEN", ""),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
async def gptproto_chat(messages: list[dict], response_json: bool = False) -> str:
|
||||||
|
cfg = get_settings()
|
||||||
|
payload: dict[str, Any] = {"model": cfg["gptproto_model"], "messages": messages}
|
||||||
|
if response_json:
|
||||||
|
payload["response_format"] = {"type": "json_object"}
|
||||||
|
headers = {
|
||||||
|
"Authorization": f"Bearer {cfg['gptproto_api_key']}",
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
async with httpx.AsyncClient(timeout=30) as hc:
|
||||||
|
r = await hc.post(
|
||||||
|
f"{cfg['gptproto_base_url']}/chat/completions", json=payload, headers=headers
|
||||||
|
)
|
||||||
|
if r.status_code >= 400:
|
||||||
|
raise HTTPException(status_code=502, detail=f"gptproto error: {r.text}")
|
||||||
|
data = r.json()
|
||||||
|
return data["choices"][0]["message"]["content"]
|
||||||
|
|
||||||
|
|
||||||
|
async def plane_request(
|
||||||
|
method: str, path: str, json_body: dict | None = None, params: dict | None = None
|
||||||
|
) -> httpx.Response:
|
||||||
|
cfg = get_settings()
|
||||||
|
headers = {"X-Api-Key": cfg["plane_api_token"], "Content-Type": "application/json"}
|
||||||
|
url = f"{cfg['plane_api_base']}{path}"
|
||||||
|
async with httpx.AsyncClient(timeout=30) as hc:
|
||||||
|
return await hc.request(method, url, json=json_body, params=params, headers=headers)
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/healthz")
|
||||||
|
async def healthz():
|
||||||
|
return {"status": "ok"}
|
||||||
|
|
||||||
|
|
||||||
|
class CreateIssueIn(BaseModel):
|
||||||
|
prompt: str = Field(min_length=1)
|
||||||
|
project_id: str
|
||||||
|
workspace_slug: str
|
||||||
|
|
||||||
|
|
||||||
|
@app.post("/ai/create-issue")
|
||||||
|
async def ai_create_issue(body: CreateIssueIn):
|
||||||
|
system = (
|
||||||
|
"Convert the user prompt into a Plane issue. "
|
||||||
|
"Output MUST be a single JSON object with exactly these keys: "
|
||||||
|
'"name" (short title string), "description_html" (HTML body string). '
|
||||||
|
"Do NOT wrap in markdown. Do NOT add prose. Output the JSON object only."
|
||||||
|
)
|
||||||
|
raw = await gptproto_chat(
|
||||||
|
[
|
||||||
|
{"role": "system", "content": system},
|
||||||
|
{"role": "user", "content": body.prompt},
|
||||||
|
],
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
issue = _extract_json(raw)
|
||||||
|
except json.JSONDecodeError as e:
|
||||||
|
raise HTTPException(status_code=502, detail=f"gptproto bad json: {e}; raw={raw[:200]}")
|
||||||
|
if "name" not in issue:
|
||||||
|
raise HTTPException(status_code=502, detail="gptproto missing name")
|
||||||
|
|
||||||
|
path = f"/api/v1/workspaces/{body.workspace_slug}/projects/{body.project_id}/issues/"
|
||||||
|
plane_resp = await plane_request(
|
||||||
|
"POST",
|
||||||
|
path,
|
||||||
|
json_body={
|
||||||
|
"name": issue["name"],
|
||||||
|
"description_html": issue.get("description_html", ""),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
if plane_resp.status_code >= 400:
|
||||||
|
raise HTTPException(status_code=502, detail=f"plane error: {plane_resp.text}")
|
||||||
|
return plane_resp.json()
|
||||||
|
|
||||||
|
|
||||||
|
class SummarizeIn(BaseModel):
|
||||||
|
issues: list[dict] = Field(min_length=1)
|
||||||
|
|
||||||
|
|
||||||
|
@app.post("/ai/summarize")
|
||||||
|
async def ai_summarize(body: SummarizeIn):
|
||||||
|
system = "You summarize a list of Plane issues into a concise paragraph."
|
||||||
|
user = json.dumps({"issues": body.issues}, ensure_ascii=False)
|
||||||
|
summary = await gptproto_chat(
|
||||||
|
[
|
||||||
|
{"role": "system", "content": system},
|
||||||
|
{"role": "user", "content": user},
|
||||||
|
]
|
||||||
|
)
|
||||||
|
return {"summary": summary}
|
||||||
|
|
||||||
|
|
||||||
|
class SearchIn(BaseModel):
|
||||||
|
query: str = Field(min_length=1)
|
||||||
|
workspace_slug: str
|
||||||
|
|
||||||
|
|
||||||
|
@app.post("/ai/search")
|
||||||
|
async def ai_search(body: SearchIn):
|
||||||
|
plane_resp = await plane_request(
|
||||||
|
"GET",
|
||||||
|
f"/api/v1/workspaces/{body.workspace_slug}/issues/search/",
|
||||||
|
params={"search": body.query},
|
||||||
|
)
|
||||||
|
if plane_resp.status_code >= 400:
|
||||||
|
raise HTTPException(status_code=502, detail=f"plane error: {plane_resp.text}")
|
||||||
|
results = plane_resp.json()
|
||||||
|
|
||||||
|
system = "You write a one-sentence summary of these Plane search results."
|
||||||
|
ai_summary = await gptproto_chat(
|
||||||
|
[
|
||||||
|
{"role": "system", "content": system},
|
||||||
|
{
|
||||||
|
"role": "user",
|
||||||
|
"content": json.dumps(
|
||||||
|
{"query": body.query, "results": results}, ensure_ascii=False
|
||||||
|
),
|
||||||
|
},
|
||||||
|
]
|
||||||
|
)
|
||||||
|
return {"results": results, "ai_summary": ai_summary}
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Dashboard data proxy endpoints — forward to Plane API with server-side token
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
async def _plane_get_list(path: str, params: dict | None = None) -> list:
|
||||||
|
resp = await plane_request("GET", path, params=params)
|
||||||
|
if resp.status_code >= 400:
|
||||||
|
raise HTTPException(status_code=502, detail=f"plane error: {resp.text}")
|
||||||
|
data = resp.json()
|
||||||
|
return data.get("results", data) if isinstance(data, dict) else data
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/data/members")
|
||||||
|
async def data_members(workspace_slug: str = Query(...)):
|
||||||
|
return await _plane_get_list(f"/api/v1/workspaces/{workspace_slug}/members/")
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/data/projects")
|
||||||
|
async def data_projects(workspace_slug: str = Query(...)):
|
||||||
|
return await _plane_get_list(f"/api/v1/workspaces/{workspace_slug}/projects/")
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/data/issues")
|
||||||
|
async def data_issues(
|
||||||
|
workspace_slug: str = Query(...),
|
||||||
|
project_id: str = Query(...),
|
||||||
|
assignee_id: str | None = Query(default=None),
|
||||||
|
):
|
||||||
|
params: dict = {"expand": "state_detail", "per_page": "250"}
|
||||||
|
if assignee_id:
|
||||||
|
params["assignees"] = assignee_id
|
||||||
|
return await _plane_get_list(
|
||||||
|
f"/api/v1/workspaces/{workspace_slug}/projects/{project_id}/issues/",
|
||||||
|
params=params,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/data/states")
|
||||||
|
async def data_states(workspace_slug: str = Query(...), project_id: str = Query(...)):
|
||||||
|
return await _plane_get_list(
|
||||||
|
f"/api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/data/cycles")
|
||||||
|
async def data_cycles(workspace_slug: str = Query(...), project_id: str = Query(...)):
|
||||||
|
return await _plane_get_list(
|
||||||
|
f"/api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/data/cycle-issues")
|
||||||
|
async def data_cycle_issues(
|
||||||
|
workspace_slug: str = Query(...),
|
||||||
|
project_id: str = Query(...),
|
||||||
|
cycle_id: str = Query(...),
|
||||||
|
):
|
||||||
|
return await _plane_get_list(
|
||||||
|
f"/api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/issues/",
|
||||||
|
params={"expand": "state_detail", "per_page": "250"},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# Plane v1.3.0 workspace role enum: Admin=20, Member=15, Guest=5
|
||||||
|
_ADMIN_ROLE_MIN = 20
|
||||||
|
|
||||||
|
_SESSION_COOKIE_NAME = os.environ.get("SESSION_COOKIE_NAME", "session-id")
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/data/role")
|
||||||
|
async def data_role(request: Request, workspace_slug: str = Query(...)):
|
||||||
|
"""Return is_admin for the current session by querying PostgreSQL directly.
|
||||||
|
|
||||||
|
Flow: session-id cookie → sessions table (user_id) → workspace_members table (role).
|
||||||
|
Uses direct SQL to avoid dependency on the workspace-admin-gated Plane API endpoint.
|
||||||
|
"""
|
||||||
|
session_key = request.cookies.get(_SESSION_COOKIE_NAME)
|
||||||
|
if not session_key or not _db_pool:
|
||||||
|
return {"is_admin": False, "role": 0}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Look up user_id from active (non-expired) session
|
||||||
|
session_row = await _db_pool.fetchrow(
|
||||||
|
"SELECT user_id::text FROM sessions WHERE session_key = $1 AND expire_date > NOW()",
|
||||||
|
session_key,
|
||||||
|
)
|
||||||
|
if not session_row:
|
||||||
|
return {"is_admin": False, "role": 0}
|
||||||
|
|
||||||
|
user_id = session_row["user_id"]
|
||||||
|
|
||||||
|
# Look up workspace member role directly in the DB (avoids admin-gated Plane API)
|
||||||
|
member_row = await _db_pool.fetchrow(
|
||||||
|
"""
|
||||||
|
SELECT wm.role FROM workspace_members wm
|
||||||
|
JOIN workspaces w ON wm.workspace_id = w.id
|
||||||
|
WHERE w.slug = $1
|
||||||
|
AND wm.member_id = $2::uuid
|
||||||
|
AND wm.is_active = TRUE
|
||||||
|
AND wm.deleted_at IS NULL
|
||||||
|
""",
|
||||||
|
workspace_slug,
|
||||||
|
user_id,
|
||||||
|
)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("data_role DB query failed")
|
||||||
|
return {"is_admin": False, "role": 0}
|
||||||
|
|
||||||
|
if not member_row:
|
||||||
|
return {"is_admin": False, "role": 0}
|
||||||
|
|
||||||
|
role = member_row["role"]
|
||||||
|
return {"is_admin": role >= _ADMIN_ROLE_MIN, "role": role}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
[pytest]
|
||||||
|
asyncio_mode = auto
|
||||||
|
testpaths = tests
|
||||||
|
filterwarnings =
|
||||||
|
ignore::DeprecationWarning
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
asyncpg>=0.29,<1.0
|
||||||
|
fastapi>=0.110,<1.0
|
||||||
|
httpx>=0.27,<1.0
|
||||||
|
pytest>=8.0,<9.0
|
||||||
|
pytest-asyncio>=0.23,<1.0
|
||||||
|
respx>=0.21,<1.0
|
||||||
|
uvicorn[standard]>=0.27,<1.0
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
import os
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
import pytest_asyncio
|
||||||
|
from httpx import ASGITransport, AsyncClient
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def _env(monkeypatch):
|
||||||
|
monkeypatch.setenv("GPTPROTO_BASE_URL", "https://gptproto.com/v1")
|
||||||
|
monkeypatch.setenv("GPTPROTO_API_KEY", "test-key")
|
||||||
|
monkeypatch.setenv("GPTPROTO_MODEL", "claude-sonnet-4-6")
|
||||||
|
monkeypatch.setenv("PLANE_API_BASE", "http://api:8000")
|
||||||
|
monkeypatch.setenv("PLANE_API_TOKEN", "test-plane-token")
|
||||||
|
yield
|
||||||
|
|
||||||
|
|
||||||
|
@pytest_asyncio.fixture
|
||||||
|
async def client():
|
||||||
|
from ai_agent.main import app
|
||||||
|
|
||||||
|
transport = ASGITransport(app=app)
|
||||||
|
async with AsyncClient(transport=transport, base_url="http://testserver") as ac:
|
||||||
|
yield ac
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
import json
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
import respx
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_create_issue_calls_gptproto_then_plane(client):
|
||||||
|
gpt_route = respx.post("https://gptproto.com/v1/chat/completions").mock(
|
||||||
|
return_value=httpx.Response(
|
||||||
|
200,
|
||||||
|
json={
|
||||||
|
"id": "chatcmpl-1",
|
||||||
|
"object": "chat.completion",
|
||||||
|
"created": 0,
|
||||||
|
"model": "claude-sonnet-4-6",
|
||||||
|
"choices": [
|
||||||
|
{
|
||||||
|
"index": 0,
|
||||||
|
"message": {
|
||||||
|
"role": "assistant",
|
||||||
|
"content": json.dumps(
|
||||||
|
{
|
||||||
|
"name": "Fix login bug",
|
||||||
|
"description_html": "<p>Login fails on Safari</p>",
|
||||||
|
}
|
||||||
|
),
|
||||||
|
},
|
||||||
|
"finish_reason": "stop",
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"usage": {"prompt_tokens": 10, "completion_tokens": 20, "total_tokens": 30},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
plane_route = respx.post(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/issues/"
|
||||||
|
).mock(
|
||||||
|
return_value=httpx.Response(
|
||||||
|
201,
|
||||||
|
json={
|
||||||
|
"id": "issue-uuid-1",
|
||||||
|
"name": "Fix login bug",
|
||||||
|
"description_html": "<p>Login fails on Safari</p>",
|
||||||
|
"project": "proj-123",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
payload = {
|
||||||
|
"prompt": "users report login broken on safari",
|
||||||
|
"project_id": "proj-123",
|
||||||
|
"workspace_slug": "ws-demo",
|
||||||
|
}
|
||||||
|
resp = await client.post("/ai/create-issue", json=payload)
|
||||||
|
|
||||||
|
assert resp.status_code == 200, resp.text
|
||||||
|
body = resp.json()
|
||||||
|
assert body["id"] == "issue-uuid-1"
|
||||||
|
assert body["name"] == "Fix login bug"
|
||||||
|
|
||||||
|
assert gpt_route.called
|
||||||
|
assert plane_route.called
|
||||||
|
|
||||||
|
plane_request_body = json.loads(plane_route.calls[0].request.content.decode())
|
||||||
|
assert plane_request_body["name"] == "Fix login bug"
|
||||||
|
assert "Safari" in plane_request_body["description_html"]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_create_issue_validates_input(client):
|
||||||
|
resp = await client.post("/ai/create-issue", json={"prompt": "x"})
|
||||||
|
assert resp.status_code == 422
|
||||||
@@ -0,0 +1,108 @@
|
|||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
import respx
|
||||||
|
|
||||||
|
|
||||||
|
CYCLES_RESPONSE = [
|
||||||
|
{
|
||||||
|
"id": "cycle-1",
|
||||||
|
"name": "Sprint 1",
|
||||||
|
"start_date": "2026-04-01",
|
||||||
|
"end_date": "2026-04-14",
|
||||||
|
"progress_snapshot": {
|
||||||
|
"2026-04-01": {"total_issues": 10, "completed_issues": 0},
|
||||||
|
"2026-04-07": {"total_issues": 10, "completed_issues": 4},
|
||||||
|
"2026-04-14": {"total_issues": 10, "completed_issues": 9},
|
||||||
|
},
|
||||||
|
"status": "current",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "cycle-2",
|
||||||
|
"name": "Sprint 2",
|
||||||
|
"start_date": "2026-04-15",
|
||||||
|
"end_date": "2026-04-28",
|
||||||
|
"progress_snapshot": {},
|
||||||
|
"status": "upcoming",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_cycles_returns_list(client):
|
||||||
|
respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/cycles/"
|
||||||
|
).mock(return_value=httpx.Response(200, json={"results": CYCLES_RESPONSE}))
|
||||||
|
resp = await client.get(
|
||||||
|
"/data/cycles",
|
||||||
|
params={"workspace_slug": "ws-demo", "project_id": "proj-123"},
|
||||||
|
)
|
||||||
|
assert resp.status_code == 200
|
||||||
|
body = resp.json()
|
||||||
|
assert isinstance(body, list)
|
||||||
|
assert len(body) == 2
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_cycles_fields(client):
|
||||||
|
respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/cycles/"
|
||||||
|
).mock(return_value=httpx.Response(200, json={"results": CYCLES_RESPONSE}))
|
||||||
|
resp = await client.get(
|
||||||
|
"/data/cycles",
|
||||||
|
params={"workspace_slug": "ws-demo", "project_id": "proj-123"},
|
||||||
|
)
|
||||||
|
cycle = resp.json()[0]
|
||||||
|
for field in ("id", "name", "start_date", "end_date", "progress_snapshot"):
|
||||||
|
assert field in cycle
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_cycles_progress_snapshot_preserved(client):
|
||||||
|
respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/cycles/"
|
||||||
|
).mock(return_value=httpx.Response(200, json={"results": CYCLES_RESPONSE}))
|
||||||
|
resp = await client.get(
|
||||||
|
"/data/cycles",
|
||||||
|
params={"workspace_slug": "ws-demo", "project_id": "proj-123"},
|
||||||
|
)
|
||||||
|
cycle = resp.json()[0]
|
||||||
|
assert isinstance(cycle["progress_snapshot"], dict)
|
||||||
|
assert "2026-04-07" in cycle["progress_snapshot"]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_cycles_sends_api_key(client):
|
||||||
|
route = respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/cycles/"
|
||||||
|
).mock(return_value=httpx.Response(200, json={"results": CYCLES_RESPONSE}))
|
||||||
|
await client.get(
|
||||||
|
"/data/cycles",
|
||||||
|
params={"workspace_slug": "ws-demo", "project_id": "proj-123"},
|
||||||
|
)
|
||||||
|
assert route.calls[0].request.headers.get("x-api-key") == "test-plane-token"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_cycles_plane_error_returns_502(client):
|
||||||
|
respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/cycles/"
|
||||||
|
).mock(return_value=httpx.Response(500, json={"detail": "server error"}))
|
||||||
|
resp = await client.get(
|
||||||
|
"/data/cycles",
|
||||||
|
params={"workspace_slug": "ws-demo", "project_id": "proj-123"},
|
||||||
|
)
|
||||||
|
assert resp.status_code == 502
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_cycles_missing_params_returns_422(client):
|
||||||
|
resp = await client.get("/data/cycles", params={"workspace_slug": "ws-demo"})
|
||||||
|
assert resp.status_code == 422
|
||||||
|
|
||||||
|
resp2 = await client.get("/data/cycles", params={"project_id": "proj-123"})
|
||||||
|
assert resp2.status_code == 422
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
import respx
|
||||||
|
|
||||||
|
|
||||||
|
ISSUES_RESPONSE = [
|
||||||
|
{
|
||||||
|
"id": "issue-1",
|
||||||
|
"name": "修复登录 Bug",
|
||||||
|
"state": "state-uuid-1",
|
||||||
|
"priority": "urgent",
|
||||||
|
"assignees": ["mem-1"],
|
||||||
|
"start_date": "2026-04-01",
|
||||||
|
"due_date": "2026-04-10",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "issue-2",
|
||||||
|
"name": "优化首页性能",
|
||||||
|
"state": "state-uuid-2",
|
||||||
|
"priority": "medium",
|
||||||
|
"assignees": ["mem-2"],
|
||||||
|
"start_date": None,
|
||||||
|
"due_date": None,
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_issues_returns_list(client):
|
||||||
|
respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/issues/"
|
||||||
|
).mock(return_value=httpx.Response(200, json={"results": ISSUES_RESPONSE}))
|
||||||
|
resp = await client.get(
|
||||||
|
"/data/issues",
|
||||||
|
params={"workspace_slug": "ws-demo", "project_id": "proj-123"},
|
||||||
|
)
|
||||||
|
assert resp.status_code == 200
|
||||||
|
body = resp.json()
|
||||||
|
assert isinstance(body, list)
|
||||||
|
assert len(body) == 2
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_issues_fields(client):
|
||||||
|
respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/issues/"
|
||||||
|
).mock(return_value=httpx.Response(200, json={"results": ISSUES_RESPONSE}))
|
||||||
|
resp = await client.get(
|
||||||
|
"/data/issues",
|
||||||
|
params={"workspace_slug": "ws-demo", "project_id": "proj-123"},
|
||||||
|
)
|
||||||
|
issue = resp.json()[0]
|
||||||
|
for field in ("id", "name", "state", "priority", "assignees"):
|
||||||
|
assert field in issue
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_issues_forwards_assignee_filter(client):
|
||||||
|
route = respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/issues/"
|
||||||
|
).mock(return_value=httpx.Response(200, json={"results": [ISSUES_RESPONSE[0]]}))
|
||||||
|
resp = await client.get(
|
||||||
|
"/data/issues",
|
||||||
|
params={
|
||||||
|
"workspace_slug": "ws-demo",
|
||||||
|
"project_id": "proj-123",
|
||||||
|
"assignee_id": "mem-1",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
assert resp.status_code == 200
|
||||||
|
assert route.called
|
||||||
|
qs = str(route.calls[0].request.url)
|
||||||
|
assert "assignee" in qs or "mem-1" in qs
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_issues_sends_api_key(client):
|
||||||
|
route = respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/issues/"
|
||||||
|
).mock(return_value=httpx.Response(200, json={"results": ISSUES_RESPONSE}))
|
||||||
|
await client.get(
|
||||||
|
"/data/issues",
|
||||||
|
params={"workspace_slug": "ws-demo", "project_id": "proj-123"},
|
||||||
|
)
|
||||||
|
assert route.calls[0].request.headers.get("x-api-key") == "test-plane-token"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_issues_plane_error_returns_502(client):
|
||||||
|
respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/projects/proj-123/issues/"
|
||||||
|
).mock(return_value=httpx.Response(404, json={"detail": "not found"}))
|
||||||
|
resp = await client.get(
|
||||||
|
"/data/issues",
|
||||||
|
params={"workspace_slug": "ws-demo", "project_id": "proj-123"},
|
||||||
|
)
|
||||||
|
assert resp.status_code == 502
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_issues_missing_params_returns_422(client):
|
||||||
|
resp = await client.get("/data/issues", params={"workspace_slug": "ws-demo"})
|
||||||
|
assert resp.status_code == 422
|
||||||
|
|
||||||
|
resp2 = await client.get("/data/issues", params={"project_id": "proj-123"})
|
||||||
|
assert resp2.status_code == 422
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
import respx
|
||||||
|
|
||||||
|
|
||||||
|
MEMBERS_RESPONSE = [
|
||||||
|
{"id": "mem-1", "display_name": "张三", "avatar_url": "https://example.com/a.png", "role": 15},
|
||||||
|
{"id": "mem-2", "display_name": "李四", "avatar_url": "", "role": 10},
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_members_returns_list(client):
|
||||||
|
respx.get("http://api:8000/api/v1/workspaces/ws-demo/members/").mock(
|
||||||
|
return_value=httpx.Response(200, json={"results": MEMBERS_RESPONSE})
|
||||||
|
)
|
||||||
|
resp = await client.get("/data/members", params={"workspace_slug": "ws-demo"})
|
||||||
|
assert resp.status_code == 200
|
||||||
|
body = resp.json()
|
||||||
|
assert isinstance(body, list)
|
||||||
|
assert len(body) == 2
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_members_fields(client):
|
||||||
|
respx.get("http://api:8000/api/v1/workspaces/ws-demo/members/").mock(
|
||||||
|
return_value=httpx.Response(200, json={"results": MEMBERS_RESPONSE})
|
||||||
|
)
|
||||||
|
resp = await client.get("/data/members", params={"workspace_slug": "ws-demo"})
|
||||||
|
member = resp.json()[0]
|
||||||
|
assert "id" in member
|
||||||
|
assert "display_name" in member
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_members_sends_api_key(client):
|
||||||
|
route = respx.get("http://api:8000/api/v1/workspaces/ws-demo/members/").mock(
|
||||||
|
return_value=httpx.Response(200, json={"results": MEMBERS_RESPONSE})
|
||||||
|
)
|
||||||
|
await client.get("/data/members", params={"workspace_slug": "ws-demo"})
|
||||||
|
assert route.called
|
||||||
|
assert route.calls[0].request.headers.get("x-api-key") == "test-plane-token"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_members_plane_error_returns_502(client):
|
||||||
|
respx.get("http://api:8000/api/v1/workspaces/ws-demo/members/").mock(
|
||||||
|
return_value=httpx.Response(401, json={"detail": "unauthorized"})
|
||||||
|
)
|
||||||
|
resp = await client.get("/data/members", params={"workspace_slug": "ws-demo"})
|
||||||
|
assert resp.status_code == 502
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_members_missing_slug_returns_422(client):
|
||||||
|
resp = await client.get("/data/members")
|
||||||
|
assert resp.status_code == 422
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
import respx
|
||||||
|
|
||||||
|
|
||||||
|
PROJECTS_RESPONSE = [
|
||||||
|
{"id": "proj-1", "name": "后端服务", "identifier": "BE", "description": ""},
|
||||||
|
{"id": "proj-2", "name": "前端应用", "identifier": "FE", "description": ""},
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_projects_returns_list(client):
|
||||||
|
respx.get("http://api:8000/api/v1/workspaces/ws-demo/projects/").mock(
|
||||||
|
return_value=httpx.Response(200, json={"results": PROJECTS_RESPONSE})
|
||||||
|
)
|
||||||
|
resp = await client.get("/data/projects", params={"workspace_slug": "ws-demo"})
|
||||||
|
assert resp.status_code == 200
|
||||||
|
body = resp.json()
|
||||||
|
assert isinstance(body, list)
|
||||||
|
assert len(body) == 2
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_projects_fields(client):
|
||||||
|
respx.get("http://api:8000/api/v1/workspaces/ws-demo/projects/").mock(
|
||||||
|
return_value=httpx.Response(200, json={"results": PROJECTS_RESPONSE})
|
||||||
|
)
|
||||||
|
resp = await client.get("/data/projects", params={"workspace_slug": "ws-demo"})
|
||||||
|
proj = resp.json()[0]
|
||||||
|
assert "id" in proj
|
||||||
|
assert "name" in proj
|
||||||
|
assert "identifier" in proj
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_projects_sends_api_key(client):
|
||||||
|
route = respx.get("http://api:8000/api/v1/workspaces/ws-demo/projects/").mock(
|
||||||
|
return_value=httpx.Response(200, json={"results": PROJECTS_RESPONSE})
|
||||||
|
)
|
||||||
|
await client.get("/data/projects", params={"workspace_slug": "ws-demo"})
|
||||||
|
assert route.called
|
||||||
|
assert route.calls[0].request.headers.get("x-api-key") == "test-plane-token"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_projects_plane_error_returns_502(client):
|
||||||
|
respx.get("http://api:8000/api/v1/workspaces/ws-demo/projects/").mock(
|
||||||
|
return_value=httpx.Response(403, json={"detail": "forbidden"})
|
||||||
|
)
|
||||||
|
resp = await client.get("/data/projects", params={"workspace_slug": "ws-demo"})
|
||||||
|
assert resp.status_code == 502
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_projects_missing_slug_returns_422(client):
|
||||||
|
resp = await client.get("/data/projects")
|
||||||
|
assert resp.status_code == 422
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_healthz_returns_ok(client):
|
||||||
|
resp = await client.get("/healthz")
|
||||||
|
assert resp.status_code == 200
|
||||||
|
assert resp.json() == {"status": "ok"}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
import json
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
import respx
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_search_calls_plane_then_gptproto(client):
|
||||||
|
plane_route = respx.get(
|
||||||
|
"http://api:8000/api/v1/workspaces/ws-demo/issues/search/"
|
||||||
|
).mock(
|
||||||
|
return_value=httpx.Response(
|
||||||
|
200,
|
||||||
|
json={
|
||||||
|
"results": {
|
||||||
|
"issue": [
|
||||||
|
{"id": "i1", "name": "Login bug Safari"},
|
||||||
|
{"id": "i2", "name": "Login bug iOS"},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
gpt_route = respx.post("https://gptproto.com/v1/chat/completions").mock(
|
||||||
|
return_value=httpx.Response(
|
||||||
|
200,
|
||||||
|
json={
|
||||||
|
"id": "chatcmpl-3",
|
||||||
|
"object": "chat.completion",
|
||||||
|
"created": 0,
|
||||||
|
"model": "claude-sonnet-4-6",
|
||||||
|
"choices": [
|
||||||
|
{
|
||||||
|
"index": 0,
|
||||||
|
"message": {
|
||||||
|
"role": "assistant",
|
||||||
|
"content": "Two open Safari login issues match the query.",
|
||||||
|
},
|
||||||
|
"finish_reason": "stop",
|
||||||
|
}
|
||||||
|
],
|
||||||
|
},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
resp = await client.post(
|
||||||
|
"/ai/search", json={"query": "safari login", "workspace_slug": "ws-demo"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert resp.status_code == 200, resp.text
|
||||||
|
body = resp.json()
|
||||||
|
assert "results" in body
|
||||||
|
assert "ai_summary" in body
|
||||||
|
assert "Safari" in body["ai_summary"]
|
||||||
|
|
||||||
|
assert plane_route.called
|
||||||
|
assert gpt_route.called
|
||||||
|
|
||||||
|
plane_url = str(plane_route.calls[0].request.url)
|
||||||
|
assert "search=safari+login" in plane_url or "search=safari%20login" in plane_url
|
||||||
|
|
||||||
|
gpt_body = json.loads(gpt_route.calls[0].request.content.decode())
|
||||||
|
assert any("safari login" in m["content"].lower() for m in gpt_body["messages"])
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_search_validates_input(client):
|
||||||
|
resp = await client.post("/ai/search", json={"workspace_slug": "ws-demo"})
|
||||||
|
assert resp.status_code == 422
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
import respx
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_summarize_calls_gptproto_only(client):
|
||||||
|
gpt_route = respx.post("https://gptproto.com/v1/chat/completions").mock(
|
||||||
|
return_value=httpx.Response(
|
||||||
|
200,
|
||||||
|
json={
|
||||||
|
"id": "chatcmpl-2",
|
||||||
|
"object": "chat.completion",
|
||||||
|
"created": 0,
|
||||||
|
"model": "claude-sonnet-4-6",
|
||||||
|
"choices": [
|
||||||
|
{
|
||||||
|
"index": 0,
|
||||||
|
"message": {
|
||||||
|
"role": "assistant",
|
||||||
|
"content": "Three login bugs reported on Safari this week.",
|
||||||
|
},
|
||||||
|
"finish_reason": "stop",
|
||||||
|
}
|
||||||
|
],
|
||||||
|
},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
plane_guard = respx.route(host="api").mock(return_value=httpx.Response(500))
|
||||||
|
|
||||||
|
payload = {
|
||||||
|
"issues": [
|
||||||
|
{"id": "i1", "name": "Login broken on Safari"},
|
||||||
|
{"id": "i2", "name": "Login broken on iPhone Safari"},
|
||||||
|
{"id": "i3", "name": "Safari 18 blank login page"},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
resp = await client.post("/ai/summarize", json=payload)
|
||||||
|
|
||||||
|
assert resp.status_code == 200, resp.text
|
||||||
|
body = resp.json()
|
||||||
|
assert "summary" in body
|
||||||
|
assert "Safari" in body["summary"]
|
||||||
|
|
||||||
|
assert gpt_route.called
|
||||||
|
assert not plane_guard.called, "summarize must not hit Plane API"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@respx.mock
|
||||||
|
async def test_summarize_rejects_empty_issues(client):
|
||||||
|
resp = await client.post("/ai/summarize", json={"issues": []})
|
||||||
|
assert resp.status_code == 422
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
# deploy/local/.env.template — Plane v1.3.0 (community self-host) + AI Agent
|
||||||
|
# Copy to .env, replace every CHANGEME_* with a real value, then chmod 600 .env.
|
||||||
|
# Do NOT commit .env to git.
|
||||||
|
|
||||||
|
# ---- Release pin (DO NOT change without rerunning pull-plane.sh) ----
|
||||||
|
APP_RELEASE=v1.3.0
|
||||||
|
APP_DOMAIN=localhost
|
||||||
|
|
||||||
|
# ---- Listening ports (host-side; we expose ONLY proxy via override) ----
|
||||||
|
LISTEN_HTTP_PORT=80
|
||||||
|
LISTEN_HTTPS_PORT=443
|
||||||
|
|
||||||
|
# ---- Plane URLs (must match host-mapped port from override.yml) ----
|
||||||
|
WEB_URL=http://localhost:8090
|
||||||
|
CORS_ALLOWED_ORIGINS=http://localhost:8090
|
||||||
|
API_BASE_URL=http://api:8000
|
||||||
|
SITE_ADDRESS=:80
|
||||||
|
TRUSTED_PROXIES=0.0.0.0/0
|
||||||
|
|
||||||
|
# ---- Postgres ----
|
||||||
|
PGHOST=plane-db
|
||||||
|
PGDATABASE=plane
|
||||||
|
POSTGRES_USER=plane
|
||||||
|
POSTGRES_PASSWORD=CHANGEME_POSTGRES_STRONG_PASSWORD
|
||||||
|
POSTGRES_DB=plane
|
||||||
|
POSTGRES_PORT=5432
|
||||||
|
PGDATA=/var/lib/postgresql/data
|
||||||
|
DATABASE_URL=postgresql://plane:CHANGEME_POSTGRES_STRONG_PASSWORD@plane-db/plane
|
||||||
|
|
||||||
|
# ---- Redis ----
|
||||||
|
REDIS_HOST=plane-redis
|
||||||
|
REDIS_PORT=6379
|
||||||
|
REDIS_URL=redis://plane-redis:6379/
|
||||||
|
|
||||||
|
# ---- RabbitMQ ----
|
||||||
|
RABBITMQ_HOST=plane-mq
|
||||||
|
RABBITMQ_PORT=5672
|
||||||
|
RABBITMQ_USER=plane
|
||||||
|
RABBITMQ_PASSWORD=CHANGEME_RABBITMQ_STRONG_PASSWORD
|
||||||
|
RABBITMQ_VHOST=plane
|
||||||
|
AMQP_URL=amqp://plane:CHANGEME_RABBITMQ_STRONG_PASSWORD@plane-mq:5672/plane
|
||||||
|
|
||||||
|
# ---- Django ----
|
||||||
|
SECRET_KEY=CHANGEME_DJANGO_SECRET_KEY_AT_LEAST_50_CHARS
|
||||||
|
DEBUG=0
|
||||||
|
GUNICORN_WORKERS=1
|
||||||
|
|
||||||
|
# ---- MinIO / S3 ----
|
||||||
|
USE_MINIO=1
|
||||||
|
AWS_REGION=
|
||||||
|
AWS_ACCESS_KEY_ID=CHANGEME_MINIO_ACCESS_KEY
|
||||||
|
AWS_SECRET_ACCESS_KEY=CHANGEME_MINIO_SECRET_KEY
|
||||||
|
AWS_S3_ENDPOINT_URL=http://plane-minio:9000
|
||||||
|
AWS_S3_BUCKET_NAME=uploads
|
||||||
|
FILE_SIZE_LIMIT=5242880
|
||||||
|
MINIO_ENDPOINT_SSL=0
|
||||||
|
|
||||||
|
# ---- Live collab server ----
|
||||||
|
LIVE_SERVER_SECRET_KEY=CHANGEME_LIVE_SECRET_KEY_AT_LEAST_32_CHARS
|
||||||
|
|
||||||
|
# ---- Replicas (single-host local) ----
|
||||||
|
WEB_REPLICAS=1
|
||||||
|
SPACE_REPLICAS=1
|
||||||
|
ADMIN_REPLICAS=1
|
||||||
|
API_REPLICAS=1
|
||||||
|
WORKER_REPLICAS=1
|
||||||
|
BEAT_WORKER_REPLICAS=1
|
||||||
|
LIVE_REPLICAS=1
|
||||||
|
|
||||||
|
# ---- Cert (unused locally, leave blank) ----
|
||||||
|
CERT_EMAIL=
|
||||||
|
CERT_ACME_CA=https://acme-v02.api.letsencrypt.org/directory
|
||||||
|
CERT_ACME_DNS=
|
||||||
|
|
||||||
|
# ---- API rate ----
|
||||||
|
API_KEY_RATE_LIMIT=60/minute
|
||||||
|
|
||||||
|
# ---- AI Agent (FastAPI; gptproto OpenAI-compatible aggregator) ----
|
||||||
|
GPTPROTO_API_KEY=CHANGEME_GPTPROTO_API_KEY
|
||||||
|
GPTPROTO_BASE_URL=https://gptproto.com/v1
|
||||||
|
GPTPROTO_MODEL=claude-sonnet-4-6
|
||||||
|
PLANE_API_BASE=http://api:8000
|
||||||
|
PLANE_API_TOKEN=CHANGEME_PLANE_API_TOKEN
|
||||||
|
|
||||||
|
# ============================================================
|
||||||
|
# 反遥测 / 反回拨锁定 (LOCKDOWN) — 不要清空这些开关!
|
||||||
|
# 设计原则:env-gated 开关,上游源码完整保留,不残废任何逻辑
|
||||||
|
# 详见 deploy/local/patches/README.md
|
||||||
|
# ============================================================
|
||||||
|
# [核心开关] 阻止 OpenTelemetry 把 instance trace (用户数 / issue 数等)
|
||||||
|
# 发到 https://telemetry.plane.so —— 新建 Instance 时 is_telemetry_enabled 默认置 False,
|
||||||
|
# 上游的 if instance.is_telemetry_enabled: 守卫会直接跳过整个 trace 上报逻辑
|
||||||
|
DISABLE_TELEMETRY=1
|
||||||
|
# [核心开关] 阻止 register_instance 每次启动 GET api.github.com/.../releases/latest
|
||||||
|
DISABLE_GITHUB_VERSION_CHECK=1
|
||||||
|
# 防御纵深:把 OTLP exporter endpoint 指向本机不存在端口
|
||||||
|
# 即使将来上游改了 telemetry 流程,数据也只能发去黑洞
|
||||||
|
OTLP_ENDPOINT=http://127.0.0.1:1
|
||||||
|
# PostHog 事件追踪 (USER_INVITED / WORKSPACE_DELETED) —— 留空即禁用 (上游默认就是空)
|
||||||
|
POSTHOG_API_KEY=
|
||||||
|
POSTHOG_HOST=
|
||||||
|
# Microsoft Clarity 前端会话录制 —— 留空即禁用 (上游默认就是空)
|
||||||
|
VITE_SESSION_RECORDER_KEY=
|
||||||
|
# Intercom 客服 widget (会加载 widget.intercom.io) —— 0 即禁用
|
||||||
|
IS_INTERCOM_ENABLED=0
|
||||||
|
# Unsplash 图片搜索 (按需调 api.unsplash.com,不主动外发数据) —— 留空即关
|
||||||
|
UNSPLASH_ACCESS_KEY=
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
# Stage A — 本地 mac docker 部署
|
||||||
|
|
||||||
|
> 跑通后再上 YOUR_SERVER_IP,详见 `docs/PLAN.md`。
|
||||||
|
|
||||||
|
## 前置
|
||||||
|
- Docker Desktop ≥ 4.30(含 docker compose v2)
|
||||||
|
- 本机 8090 / 8100 端口未被占用:`lsof -nP -iTCP:8090 -sTCP:LISTEN`
|
||||||
|
- git ≥ 2.30
|
||||||
|
|
||||||
|
## 一键启动
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1) Plane v1.3.0 源码已随包附带于 deploy/local/src/
|
||||||
|
# (如缺失,可运行 bash deploy/local/pull-plane.sh 从 GitHub 拉取)
|
||||||
|
|
||||||
|
# 2) cp .env.template .env first ← 必做,否则 docker 起不来
|
||||||
|
cp deploy/local/.env.template deploy/local/.env
|
||||||
|
chmod 600 deploy/local/.env
|
||||||
|
# 用编辑器把所有 CHANGEME_* 替换成强密码 / 真实 API key
|
||||||
|
$EDITOR deploy/local/.env
|
||||||
|
|
||||||
|
# 3) 启动 (使用 Plane v1.3.0 community self-host compose)
|
||||||
|
cd deploy/local
|
||||||
|
docker compose \
|
||||||
|
-f src/deployments/cli/community/docker-compose.yml \
|
||||||
|
-f docker-compose.override.yml \
|
||||||
|
--env-file .env \
|
||||||
|
up -d
|
||||||
|
|
||||||
|
# 4) 健康检查
|
||||||
|
bash ../../qa/verify-local.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
完成后访问:
|
||||||
|
- Plane Web → http://localhost:8090
|
||||||
|
- AI Agent → http://localhost:8100/healthz
|
||||||
|
|
||||||
|
## 首次登录后必做
|
||||||
|
|
||||||
|
1. 打开 `http://localhost:8090/god-mode`
|
||||||
|
2. General → **Telemetry → off**(关 Plausible 默认上报)
|
||||||
|
3. 设置 admin 邮箱/密码
|
||||||
|
|
||||||
|
## 停止 / 重启 / 清理
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd deploy/local
|
||||||
|
# 停止(保留数据卷)
|
||||||
|
docker compose -f src/deployments/cli/community/docker-compose.yml -f docker-compose.override.yml down
|
||||||
|
# 重启
|
||||||
|
docker compose -f src/deployments/cli/community/docker-compose.yml -f docker-compose.override.yml up -d
|
||||||
|
# 完全清理(含数据卷,不可逆)
|
||||||
|
docker compose -f src/deployments/cli/community/docker-compose.yml -f docker-compose.override.yml down -v
|
||||||
|
```
|
||||||
|
|
||||||
|
## Troubleshoot
|
||||||
|
|
||||||
|
| 症状 | 检查 |
|
||||||
|
|---|---|
|
||||||
|
| `cp .env.template .env first`:未 cp 就启动会报变量未定义 | 确认 `deploy/local/.env` 存在且权限 600 |
|
||||||
|
| 8090 端口被占 | `lsof -nP -iTCP:8090 -sTCP:LISTEN` 改 override.yml 里的 `8090:80` |
|
||||||
|
| `:latest` 镜像告警 | `docker compose images` 应全是 `v1.3.0`(除 db/redis/minio) |
|
||||||
|
| AI healthz 失败 | `docker compose logs plane-ai` 检查 GPTPROTO_API_KEY 是否注入 |
|
||||||
|
| 启动后页面 502 | 等 30s — migrator 容器需先跑完数据库迁移 |
|
||||||
|
| 数据卷迁移 | `docker compose ps` 看到 `plane-db` 后 `docker volume ls \| grep plane` |
|
||||||
|
|
||||||
|
## 红线
|
||||||
|
|
||||||
|
- `.env` **永不**入 git(`.gitignore` 已忽略)
|
||||||
|
- 镜像 tag 锁死 `v1.3.0`,**禁用 `:latest`**
|
||||||
|
- Postgres / Redis / MinIO **不**暴露 host 端口
|
||||||
|
- 真实 `GPTPROTO_API_KEY` 只在本地 `.env`,不写明文进任何提交
|
||||||
@@ -0,0 +1,126 @@
|
|||||||
|
# deploy/local/docker-compose.override.yml — Plane v1.3.0 community self-host
|
||||||
|
# Run with:
|
||||||
|
# cd deploy/local && \
|
||||||
|
# docker compose \
|
||||||
|
# -f src/deployments/cli/community/docker-compose.yml \
|
||||||
|
# -f docker-compose.override.yml \
|
||||||
|
# --env-file .env up -d
|
||||||
|
#
|
||||||
|
# Goals:
|
||||||
|
# - Pin Plane release via APP_RELEASE=v1.3.0 in .env (no :latest in any service).
|
||||||
|
# - Expose ONLY the proxy on host port 8090 (8080 occupied by local dart server).
|
||||||
|
# - Postgres / Redis / RabbitMQ / MinIO have no host port mapping.
|
||||||
|
# - Add plane-ai (FastAPI on host port 8100) joined to Plane's default network.
|
||||||
|
# - LOCKDOWN: 注入反遥测 env 到 api/worker/beat-worker/web,详见 patches/README.md
|
||||||
|
|
||||||
|
# 反遥测 env anchor — env-gated 开关,注入到 plane-backend / 前端容器
|
||||||
|
x-lockdown-env: &lockdown-env
|
||||||
|
# [核心] 让 register_instance.py 新建 Instance 时 is_telemetry_enabled=False
|
||||||
|
# 进而让 instance_traces 任务的 if 守卫直接跳过整个 OpenTelemetry 上报
|
||||||
|
DISABLE_TELEMETRY: ${DISABLE_TELEMETRY:-1}
|
||||||
|
# [核心] 让 register_instance.py 跳过 GET api.github.com/.../releases/latest
|
||||||
|
DISABLE_GITHUB_VERSION_CHECK: ${DISABLE_GITHUB_VERSION_CHECK:-1}
|
||||||
|
# 防御纵深: OpenTelemetry exporter 指向本机不存在端口
|
||||||
|
OTLP_ENDPOINT: ${OTLP_ENDPOINT:-http://127.0.0.1:1}
|
||||||
|
# PostHog 事件追踪: 留空即禁用 (上游默认即空)
|
||||||
|
POSTHOG_API_KEY: ${POSTHOG_API_KEY:-}
|
||||||
|
POSTHOG_HOST: ${POSTHOG_HOST:-}
|
||||||
|
# Microsoft Clarity 前端会话录制: 留空即禁用
|
||||||
|
VITE_SESSION_RECORDER_KEY: ${VITE_SESSION_RECORDER_KEY:-}
|
||||||
|
# Intercom 客服 widget: 0 即禁用
|
||||||
|
IS_INTERCOM_ENABLED: ${IS_INTERCOM_ENABLED:-0}
|
||||||
|
# Unsplash 图搜索: 留空即禁用
|
||||||
|
UNSPLASH_ACCESS_KEY: ${UNSPLASH_ACCESS_KEY:-}
|
||||||
|
|
||||||
|
# 把已打补丁的 Python 文件覆盖挂载到上游 makeplane/plane-backend:v1.3.0 容器内
|
||||||
|
# 的 /code/plane/... 路径上,绕过"用预构建镜像"的限制。
|
||||||
|
# 详见 patches/README.md
|
||||||
|
x-lockdown-volumes: &lockdown-volumes
|
||||||
|
# 保留上游 logs_api named volume
|
||||||
|
- logs_api:/code/plane/logs
|
||||||
|
# 唯一补丁:把 env-gated 版 register_instance.py 覆盖到容器内
|
||||||
|
# tracer.py 不打补丁 —— 它已经有 if instance.is_telemetry_enabled: 守卫,DB flag 关掉就够
|
||||||
|
- ${PWD}/src/apps/api/plane/license/management/commands/register_instance.py:/code/plane/license/management/commands/register_instance.py:ro
|
||||||
|
|
||||||
|
services:
|
||||||
|
api:
|
||||||
|
environment:
|
||||||
|
<<: *lockdown-env
|
||||||
|
volumes: *lockdown-volumes
|
||||||
|
|
||||||
|
worker:
|
||||||
|
environment:
|
||||||
|
<<: *lockdown-env
|
||||||
|
volumes: *lockdown-volumes
|
||||||
|
|
||||||
|
beat-worker:
|
||||||
|
environment:
|
||||||
|
<<: *lockdown-env
|
||||||
|
volumes: *lockdown-volumes
|
||||||
|
|
||||||
|
migrator:
|
||||||
|
environment:
|
||||||
|
<<: *lockdown-env
|
||||||
|
volumes: *lockdown-volumes
|
||||||
|
|
||||||
|
web:
|
||||||
|
environment:
|
||||||
|
<<: *lockdown-env
|
||||||
|
|
||||||
|
space:
|
||||||
|
environment:
|
||||||
|
<<: *lockdown-env
|
||||||
|
|
||||||
|
admin:
|
||||||
|
environment:
|
||||||
|
<<: *lockdown-env
|
||||||
|
|
||||||
|
proxy:
|
||||||
|
ports: !override
|
||||||
|
- "8090:80"
|
||||||
|
|
||||||
|
plane-db:
|
||||||
|
ports: !override []
|
||||||
|
|
||||||
|
plane-redis:
|
||||||
|
ports: !override []
|
||||||
|
|
||||||
|
plane-mq:
|
||||||
|
ports: !override []
|
||||||
|
|
||||||
|
plane-minio:
|
||||||
|
# Pin minio (upstream community compose uses :latest)
|
||||||
|
image: minio/minio:RELEASE.2024-12-18T13-15-44Z
|
||||||
|
ports: !override []
|
||||||
|
|
||||||
|
plane-ai:
|
||||||
|
build:
|
||||||
|
# ${PWD} = deploy/local/ (when running compose from this dir);
|
||||||
|
# 用 ${PWD} 让 build context 不受 -f 顺序影响——纯相对路径会从第一个 -f 文件所在目录解析
|
||||||
|
context: ${PWD}/../../ai-agent
|
||||||
|
dockerfile: Dockerfile
|
||||||
|
image: plane-ai:v1.3.0
|
||||||
|
container_name: plane-ai
|
||||||
|
restart: unless-stopped
|
||||||
|
environment:
|
||||||
|
GPTPROTO_API_KEY: ${GPTPROTO_API_KEY}
|
||||||
|
GPTPROTO_BASE_URL: ${GPTPROTO_BASE_URL:-https://gptproto.com/v1}
|
||||||
|
GPTPROTO_MODEL: ${GPTPROTO_MODEL:-claude-sonnet-4-6}
|
||||||
|
PLANE_API_BASE: ${PLANE_API_BASE:-http://api:8000}
|
||||||
|
PLANE_API_TOKEN: ${PLANE_API_TOKEN}
|
||||||
|
DATABASE_URL: postgresql://${POSTGRES_USER:-plane}:${POSTGRES_PASSWORD:-plane}@plane-db:5432/${POSTGRES_DB:-plane}
|
||||||
|
ports:
|
||||||
|
- "8100:8100"
|
||||||
|
depends_on:
|
||||||
|
- api
|
||||||
|
- plane-db
|
||||||
|
|
||||||
|
plane-dashboard:
|
||||||
|
build:
|
||||||
|
context: ${PWD}/../../plane-dashboard
|
||||||
|
dockerfile: Dockerfile
|
||||||
|
image: plane-dashboard:v1.0.0
|
||||||
|
container_name: plane-dashboard
|
||||||
|
restart: unless-stopped
|
||||||
|
ports:
|
||||||
|
- "0.0.0.0:8103:80"
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
--- /tmp/orig_register.py 2026-05-13 15:49:57
|
||||||
|
+++ /tmp/current_register.py 2026-05-13 15:49:57
|
||||||
|
@@ -38,6 +38,9 @@
|
||||||
|
return "v0.1.0"
|
||||||
|
|
||||||
|
def check_for_latest_version(self, fallback_version):
|
||||||
|
+ # LOCKDOWN: env-gated GitHub fetch — set DISABLE_GITHUB_VERSION_CHECK=1 to skip
|
||||||
|
+ if os.environ.get("DISABLE_GITHUB_VERSION_CHECK") == "1":
|
||||||
|
+ return fallback_version
|
||||||
|
try:
|
||||||
|
response = requests.get(
|
||||||
|
"https://api.github.com/repos/makeplane/plane/releases/latest",
|
||||||
|
@@ -65,6 +68,8 @@
|
||||||
|
raise CommandError("Machine signature is required")
|
||||||
|
|
||||||
|
instance = Instance.objects.create(
|
||||||
|
+ # LOCKDOWN: env-gated default — set DISABLE_TELEMETRY=1 to start with telemetry off
|
||||||
|
+ is_telemetry_enabled=(os.environ.get("DISABLE_TELEMETRY") != "1"),
|
||||||
|
instance_name="Plane Community Edition",
|
||||||
|
instance_id=secrets.token_hex(12),
|
||||||
|
current_version=current_version,
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
# Plane v1.3.0 反遥测 / 反回拨补丁
|
||||||
|
|
||||||
|
**设计原则**: env-gated 开关,上游源码逻辑完整保留,不删任何代码,只新增 2 个 if 守卫。
|
||||||
|
升级 Plane 版本时,这种最小入侵的改动几乎不会冲突。
|
||||||
|
|
||||||
|
## 改了什么
|
||||||
|
|
||||||
|
只动一个文件:`apps/api/plane/license/management/commands/register_instance.py`,加 2 处守卫:
|
||||||
|
|
||||||
|
| 位置 | 改动 | 触发条件 |
|
||||||
|
|---|---|---|
|
||||||
|
| `check_for_latest_version()` 函数首行 | 多了一个 `if os.environ.get("DISABLE_GITHUB_VERSION_CHECK") == "1": return fallback_version` | 启动时阻止 GET `api.github.com/repos/makeplane/plane/releases/latest` |
|
||||||
|
| `Instance.objects.create(...)` 调用 | `is_telemetry_enabled` 字段从硬编码 `True` 改为 `is_telemetry_enabled=(os.environ.get("DISABLE_TELEMETRY") != "1")` | 新建 Instance 时,根据 env 决定 telemetry 默认开关 |
|
||||||
|
|
||||||
|
**上游所有其他代码 100% 原样保留**。包括:
|
||||||
|
- `tracer.py` 整个文件不动 —— 它本身有 `if instance.is_telemetry_enabled:` 守卫,只要 DB flag 是 False,整个 OpenTelemetry 上报流程就不会执行
|
||||||
|
- `register_instance.py` 的 try/except 流程、try/except 块、`Instance.update()` 分支等全都保留
|
||||||
|
|
||||||
|
## env 开关速查 (.env / .env.template 已设)
|
||||||
|
|
||||||
|
| 开关 | 默认值 | 作用 |
|
||||||
|
|---|---|---|
|
||||||
|
| `DISABLE_TELEMETRY` | `1` | 新建 Instance 时 `is_telemetry_enabled` 置 False,`tracer.instance_traces` 内部的 if 守卫会跳过整个上报逻辑 |
|
||||||
|
| `DISABLE_GITHUB_VERSION_CHECK` | `1` | 启动时跳过 GitHub release 查询 |
|
||||||
|
| `OTLP_ENDPOINT` | `http://127.0.0.1:1` | 防御纵深: 即使 telemetry 误开,exporter 也连不存在的本地端口 |
|
||||||
|
| `POSTHOG_API_KEY` / `POSTHOG_HOST` | (空) | PostHog 事件追踪禁用 (上游默认就是空) |
|
||||||
|
| `VITE_SESSION_RECORDER_KEY` | (空) | Microsoft Clarity 前端会话录制禁用 (上游默认就是空) |
|
||||||
|
| `IS_INTERCOM_ENABLED` | `0` | Intercom 客服 widget 禁用 |
|
||||||
|
| `UNSPLASH_ACCESS_KEY` | (空) | Unsplash 图搜索关闭 |
|
||||||
|
|
||||||
|
## 升级 Plane 时如何重新应用
|
||||||
|
|
||||||
|
补丁过的 `register_instance.py` 已经替换在 `deploy/local/src/apps/api/plane/license/management/commands/register_instance.py`。如果你跑了 `pull-plane.sh` 拉新版本,补丁会被覆盖。重新应用:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd deploy/local/src
|
||||||
|
patch -p1 < ../patches/01-env-gated-register-instance.patch
|
||||||
|
```
|
||||||
|
|
||||||
|
只动 1 个文件 2 处,几乎不会冲突。若失败手动加这 2 个 if 守卫即可,锚点很好认。
|
||||||
|
|
||||||
|
## 同时 — docker-compose.override.yml 还做了一层"覆盖挂载"
|
||||||
|
|
||||||
|
`override.yml` 把上面这个 patched 文件**通过 `volumes:` bind-mount** 覆盖到上游预构建镜像 `makeplane/plane-backend:v1.3.0` 容器内的 `/code/plane/license/management/commands/register_instance.py`。
|
||||||
|
|
||||||
|
这是必须的:上游镜像是预编译的,host 上改了 src/ 文件不会自动进容器。bind-mount 是绕过这点的最轻量做法 —— 比 rebuild 整个 backend 镜像快 100 倍。
|
||||||
|
|
||||||
|
## 验证
|
||||||
|
|
||||||
|
部署后:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# (1) DB flag 应为 false
|
||||||
|
docker compose exec plane-db psql -U plane -d plane -c \
|
||||||
|
"SELECT instance_id, is_telemetry_enabled FROM instances;"
|
||||||
|
|
||||||
|
# (2) 容器内补丁可见
|
||||||
|
docker compose exec api grep -n "LOCKDOWN" \
|
||||||
|
/code/plane/license/management/commands/register_instance.py
|
||||||
|
|
||||||
|
# (3) 模拟跑函数,确认 env-gated 起效
|
||||||
|
docker compose exec api python manage.py shell -c "
|
||||||
|
from plane.license.management.commands.register_instance import Command
|
||||||
|
import os
|
||||||
|
c = Command()
|
||||||
|
# 当前 env DISABLE_GITHUB_VERSION_CHECK=1,应直接返回 fallback
|
||||||
|
print(c.check_for_latest_version('v1.3.0')) # 期望: v1.3.0
|
||||||
|
"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 没动什么
|
||||||
|
|
||||||
|
为避免影响上游构建/逻辑:
|
||||||
|
- **没改** `tracer.py`、Plane model 定义、Django 数据迁移、celery 任务注册、UI 组件
|
||||||
|
- **没移除** god-mode 里的 telemetry toggle (UI 还在,但即便管理员手贱开了它,因为 env 仍是 DISABLE_TELEMETRY=1,下次重启 register_instance 又把 DB flag 改回 False —— 重启即恢复 lockdown)
|
||||||
|
- **没破坏** 任何 import / 函数签名 / 类定义,可以正常 git diff、code review、覆盖测试
|
||||||
Executable
+35
@@ -0,0 +1,35 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# pull-plane.sh — fetch official Plane v1.3.0 from GitHub (idempotent).
|
||||||
|
# Reads from GitHub only; never piped install scripts.
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
RELEASE="${PLANE_RELEASE:-v1.3.0}"
|
||||||
|
REPO_URL="https://github.com/makeplane/plane.git"
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||||
|
SRC_DIR="${SCRIPT_DIR}/src"
|
||||||
|
|
||||||
|
log() { printf '[pull-plane] %s\n' "$*"; }
|
||||||
|
|
||||||
|
if [[ -d "${SRC_DIR}/.git" ]]; then
|
||||||
|
CURRENT_TAG="$(git -C "${SRC_DIR}" describe --tags --exact-match 2>/dev/null || echo "")"
|
||||||
|
if [[ "${CURRENT_TAG}" == "${RELEASE}" ]]; then
|
||||||
|
log "src already at ${RELEASE}; nothing to do."
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
log "src exists but tag is '${CURRENT_TAG:-unknown}'; updating to ${RELEASE}."
|
||||||
|
git -C "${SRC_DIR}" fetch --depth 1 origin "refs/tags/${RELEASE}:refs/tags/${RELEASE}"
|
||||||
|
git -C "${SRC_DIR}" checkout "tags/${RELEASE}"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -e "${SRC_DIR}" ]]; then
|
||||||
|
log "ERROR: ${SRC_DIR} exists but is not a git repo. Refusing to overwrite." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
log "cloning ${REPO_URL} @ ${RELEASE} into ${SRC_DIR}"
|
||||||
|
git clone --branch "${RELEASE}" --depth 1 "${REPO_URL}" "${SRC_DIR}"
|
||||||
|
|
||||||
|
log "cloned. Verifying tag…"
|
||||||
|
git -C "${SRC_DIR}" describe --tags --exact-match
|
||||||
|
log "done."
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
.git
|
||||||
|
*.pyc
|
||||||
|
.env
|
||||||
|
venv
|
||||||
|
.venv
|
||||||
|
node_modules/
|
||||||
|
**/node_modules/
|
||||||
|
npm-debug.log
|
||||||
|
.next/
|
||||||
|
**/.next/
|
||||||
|
.turbo/
|
||||||
|
**/.turbo/
|
||||||
|
build/
|
||||||
|
**/build/
|
||||||
|
out/
|
||||||
|
**/out/
|
||||||
|
dist/
|
||||||
|
**/dist/
|
||||||
|
# Logs
|
||||||
|
npm-debug.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
.pnpm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
|
||||||
|
# OS junk
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
|
|
||||||
|
# Editor settings
|
||||||
|
.vscode
|
||||||
|
.idea
|
||||||
|
|
||||||
|
# Coverage and test output
|
||||||
|
coverage/
|
||||||
|
**/coverage/
|
||||||
|
*.lcov
|
||||||
|
.junit/
|
||||||
|
test-results/
|
||||||
|
|
||||||
|
# Caches and build artifacts
|
||||||
|
.cache/
|
||||||
|
**/.cache/
|
||||||
|
storybook-static/
|
||||||
|
*storybook.log
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# Local env and secrets
|
||||||
|
.env.local
|
||||||
|
.env.development.local
|
||||||
|
.env.test.local
|
||||||
|
.env.production.local
|
||||||
|
.secrets
|
||||||
|
tmp/
|
||||||
|
temp/
|
||||||
|
|
||||||
|
# Database/cache dumps
|
||||||
|
*.rdb
|
||||||
|
*.rdb.gz
|
||||||
|
|
||||||
|
# Misc
|
||||||
|
*.pem
|
||||||
|
*.key
|
||||||
|
|
||||||
|
# React Router - https://github.com/remix-run/react-router-templates/blob/dc79b1a065f59f3bfd840d4ef75cc27689b611e6/default/.dockerignore
|
||||||
|
.react-router/
|
||||||
|
build/
|
||||||
|
node_modules/
|
||||||
|
README.md
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
# Database Settings
|
||||||
|
POSTGRES_USER="plane"
|
||||||
|
POSTGRES_PASSWORD="plane"
|
||||||
|
POSTGRES_DB="plane"
|
||||||
|
PGDATA="/var/lib/postgresql/data"
|
||||||
|
|
||||||
|
# Redis Settings
|
||||||
|
REDIS_HOST="plane-redis"
|
||||||
|
REDIS_PORT="6379"
|
||||||
|
|
||||||
|
# RabbitMQ Settings
|
||||||
|
RABBITMQ_HOST="plane-mq"
|
||||||
|
RABBITMQ_PORT="5672"
|
||||||
|
RABBITMQ_USER="plane"
|
||||||
|
RABBITMQ_PASSWORD="plane"
|
||||||
|
RABBITMQ_VHOST="plane"
|
||||||
|
|
||||||
|
LISTEN_HTTP_PORT=80
|
||||||
|
LISTEN_HTTPS_PORT=443
|
||||||
|
|
||||||
|
# AWS Settings
|
||||||
|
AWS_REGION=""
|
||||||
|
AWS_ACCESS_KEY_ID="access-key"
|
||||||
|
AWS_SECRET_ACCESS_KEY="secret-key"
|
||||||
|
AWS_S3_ENDPOINT_URL="http://plane-minio:9000"
|
||||||
|
# Changing this requires change in the proxy config for uploads if using minio setup
|
||||||
|
AWS_S3_BUCKET_NAME="uploads"
|
||||||
|
# Maximum file upload limit
|
||||||
|
FILE_SIZE_LIMIT=5242880
|
||||||
|
|
||||||
|
# GPT settings
|
||||||
|
OPENAI_API_BASE="https://api.openai.com/v1" # deprecated
|
||||||
|
OPENAI_API_KEY="sk-" # deprecated
|
||||||
|
GPT_ENGINE="gpt-3.5-turbo" # deprecated
|
||||||
|
|
||||||
|
# Settings related to Docker
|
||||||
|
DOCKERIZED=1 # deprecated
|
||||||
|
|
||||||
|
# set to 1 If using the pre-configured minio setup
|
||||||
|
USE_MINIO=1
|
||||||
|
|
||||||
|
# If SSL Cert to be generated, set CERT_EMAIl="email <EMAIL_ADDRESS>"
|
||||||
|
CERT_ACME_CA=https://acme-v02.api.letsencrypt.org/directory
|
||||||
|
TRUSTED_PROXIES=0.0.0.0/0
|
||||||
|
SITE_ADDRESS=:80
|
||||||
|
CERT_EMAIL=
|
||||||
|
|
||||||
|
# For DNS Challenge based certificate generation, set the CERT_ACME_DNS, CERT_EMAIL
|
||||||
|
# CERT_ACME_DNS="acme_dns <CERT_DNS_PROVIDER> <CERT_DNS_PROVIDER_API_KEY>"
|
||||||
|
CERT_ACME_DNS=
|
||||||
|
|
||||||
|
# Force HTTPS for handling SSL Termination
|
||||||
|
MINIO_ENDPOINT_SSL=0
|
||||||
|
|
||||||
|
# API key rate limit
|
||||||
|
API_KEY_RATE_LIMIT="60/minute"
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
*.sh text eol=lf
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
name: Bug report
|
||||||
|
description: Create a bug report to help us improve Plane
|
||||||
|
title: "[bug]: "
|
||||||
|
labels: [🐛bug, plane]
|
||||||
|
assignees: [vihar, pushya22]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for taking the time to fill out this bug report.
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: Please search to see if an issue already exists for the bug you encountered
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Current behavior
|
||||||
|
description: A concise description of what you're experiencing and what you expect
|
||||||
|
placeholder: |
|
||||||
|
When I do <X>, <Y> happens and I see the error message attached below:
|
||||||
|
```...```
|
||||||
|
What I expect is <Z>
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Add steps to reproduce this behaviour, include console or network logs and screenshots
|
||||||
|
placeholder: |
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: env
|
||||||
|
attributes:
|
||||||
|
label: Environment
|
||||||
|
options:
|
||||||
|
- Production
|
||||||
|
- Deploy preview
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: browser
|
||||||
|
attributes:
|
||||||
|
label: Browser
|
||||||
|
options:
|
||||||
|
- Google Chrome
|
||||||
|
- Mozilla Firefox
|
||||||
|
- Safari
|
||||||
|
- Other
|
||||||
|
- type: dropdown
|
||||||
|
id: variant
|
||||||
|
attributes:
|
||||||
|
label: Variant
|
||||||
|
options:
|
||||||
|
- Cloud
|
||||||
|
- Self-hosted
|
||||||
|
- Local
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
attributes:
|
||||||
|
label: Version
|
||||||
|
placeholder: v0.17.0-dev
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
name: Feature request
|
||||||
|
description: Suggest a feature to improve Plane
|
||||||
|
title: "[feature]: "
|
||||||
|
labels: [✨feature, plane]
|
||||||
|
assignees: [vihar, pushya22]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for taking the time to request a feature for Plane
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: Please search to see if an issue related to this feature request already exists
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Summary
|
||||||
|
description: One paragraph description of the feature
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Why should this be worked on?
|
||||||
|
description: A concise description of the problems or use cases for this feature request
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
contact_links:
|
||||||
|
- name: Help and support
|
||||||
|
about: Reach out to us on our Forum or GitHub discussions.
|
||||||
|
- name: Dedicated support
|
||||||
|
url: mailto:support@plane.so
|
||||||
|
about: Write to us if you'd like dedicated support using Plane
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
---
|
||||||
|
description: Guidelines for bash commands and tooling in the monorepo
|
||||||
|
applyTo: "**/*.sh"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Bash & Tooling Instructions
|
||||||
|
|
||||||
|
This document outlines the standard tools and commands used in this monorepo.
|
||||||
|
|
||||||
|
## Package Manager
|
||||||
|
|
||||||
|
We use **pnpm** for package management.
|
||||||
|
- **Do not use `npm` or `yarn`.**
|
||||||
|
- Lockfile: `pnpm-lock.yaml`
|
||||||
|
- Workspace configuration: `pnpm-workspace.yaml`
|
||||||
|
|
||||||
|
### Common Commands
|
||||||
|
- Install dependencies: `pnpm install`
|
||||||
|
- Run a script in a specific package: `pnpm --filter <package_name> run <script>`
|
||||||
|
- Run a script in all packages: `pnpm -r run <script>`
|
||||||
|
|
||||||
|
## Monorepo Tooling
|
||||||
|
|
||||||
|
We use **Turbo** for build system orchestration.
|
||||||
|
- Configuration: `turbo.json`
|
||||||
|
|
||||||
|
## Project Structure
|
||||||
|
|
||||||
|
- `apps/`: Contains application services (admin, api, live, proxy, space, web).
|
||||||
|
- `packages/`: Contains shared packages and libraries.
|
||||||
|
- `deployments/`: Deployment configurations.
|
||||||
|
|
||||||
|
## Running Tests
|
||||||
|
|
||||||
|
- To run tests in a specific package (e.g., codemods):
|
||||||
|
```bash
|
||||||
|
cd packages/codemods
|
||||||
|
pnpm run test
|
||||||
|
```
|
||||||
|
- Or from root:
|
||||||
|
```bash
|
||||||
|
pnpm --filter @plane/codemods run test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Docker
|
||||||
|
|
||||||
|
- Local development uses `docker-compose-local.yml`.
|
||||||
|
- Production/Staging uses `docker-compose.yml`.
|
||||||
@@ -0,0 +1,129 @@
|
|||||||
|
---
|
||||||
|
description: Guidelines for using modern TypeScript features (v5.0-v5.8)
|
||||||
|
applyTo: "**/*.{ts,tsx,mts,cts}"
|
||||||
|
---
|
||||||
|
|
||||||
|
# TypeScript Coding Guidelines & Modern Features (v5.0 - v5.8)
|
||||||
|
|
||||||
|
When writing TypeScript code, prioritize using modern features and best practices introduced in recent versions (up to 5.8).
|
||||||
|
|
||||||
|
## Global Themes Across 5.x
|
||||||
|
|
||||||
|
1. **Standard decorators are here; legacy decorators are legacy.**
|
||||||
|
New TC39-compliant decorators landed in 5.0 and were extended in 5.2 (metadata). Old `experimentalDecorators`-style behavior is still supported but should be treated as legacy.
|
||||||
|
|
||||||
|
2. **Type system is more precise and less noisy.**
|
||||||
|
Major work went into narrowing, control flow analysis, error messages, and new helpers like `NoInfer`, inferred predicates, and better `undefined`/`never`/uninitialized checks.
|
||||||
|
|
||||||
|
3. **Module / runtime interop has been modernized.**
|
||||||
|
Options like `--moduleResolution bundler`, `--module nodenext`/`node18`, `--rewriteRelativeImportExtensions`, `--erasableSyntaxOnly`, and `--verbatimModuleSyntax` are about playing nicely with ESM, Node 18+/22+, direct TypeScript execution, and bundlers.
|
||||||
|
|
||||||
|
4. **The standard library keeps tracking modern JS.**
|
||||||
|
Support for new ES features (iterator helpers, `Object.groupBy`/`Map.groupBy`, new Set/ES2024 APIs) shows up as type declarations and sometimes extra checks (regex syntax checking, etc.).
|
||||||
|
|
||||||
|
When generating or refactoring code, prefer these newer idioms, and avoid patterns that conflict with updated checks.
|
||||||
|
|
||||||
|
## Modern Features to Utilize
|
||||||
|
|
||||||
|
### Type System & Inference
|
||||||
|
- **`const` Type Parameters (5.0)**: Use `const` type parameters for more precise literal inference.
|
||||||
|
```typescript
|
||||||
|
declare function names<const T extends string[]>(...names: T): void;
|
||||||
|
```
|
||||||
|
- **`@satisfies` Operator (5.0)**: Use `satisfies` to validate types without widening them.
|
||||||
|
- **Inferred Type Predicates (5.5)**: Allow TypeScript to infer type predicates for functions that filter arrays or check types, reducing the need for explicit `is` return types.
|
||||||
|
- **`NoInfer` Utility (5.4)**: Use `NoInfer<T>` to block inference for specific type arguments when you want them to be determined by other arguments.
|
||||||
|
- **Narrowing**:
|
||||||
|
- **Switch(true) (5.3)**: Utilize narrowing in `switch(true)` blocks.
|
||||||
|
- **Boolean Comparisons (5.3)**: Rely on narrowing from direct boolean comparisons.
|
||||||
|
- **Closures (5.4)**: Trust preserved narrowing in closures when variables aren't modified after the check.
|
||||||
|
- **Constant Indexed Access (5.5)**: Use constant indices to narrow object/array properties.
|
||||||
|
|
||||||
|
### Syntax & Control Flow
|
||||||
|
- **Decorators (5.0)**: Use standard ECMAScript decorators (Stage 3).
|
||||||
|
- **`using` Declarations (5.2)**: Use `using` for explicit resource management (Disposable pattern) instead of manual cleanup.
|
||||||
|
```typescript
|
||||||
|
using resource = new Resource();
|
||||||
|
```
|
||||||
|
- **Import Attributes (5.3/5.8)**: Use `with { type: "json" }` for import attributes. Avoid the deprecated `assert` syntax.
|
||||||
|
- **`switch` Exhaustiveness**: Rely on TypeScript's exhaustiveness checking in switch statements.
|
||||||
|
|
||||||
|
### Modules & Imports
|
||||||
|
- **`verbatimModuleSyntax` (5.0)**: Respect this flag by using `import type` explicitly when importing types to ensure they are erased during compilation.
|
||||||
|
- **Type-Only Imports with Extensions (5.2)**: You can use `.ts`, `.mts`, `.cts` extensions in `import type` statements.
|
||||||
|
- **`resolution-mode` (5.3)**: Use `import type { Type } from "mod" with { "resolution-mode": "import" }` if needed for specific module resolution contexts.
|
||||||
|
- **JSDoc `@import` (5.5)**: Use `@import` tags in JSDoc for cleaner type imports in JS files if working in a mixed codebase.
|
||||||
|
|
||||||
|
### Standard Library & Built-ins
|
||||||
|
- **Iterator Helpers (5.6)**: Use new iterator methods (map, filter, etc.) if targeting modern environments.
|
||||||
|
- **Set Methods (5.5)**: Utilize new `Set` methods like `union`, `intersection`, etc., when available.
|
||||||
|
- **`Object.groupBy` / `Map.groupBy` (5.4)**: Use these standard methods for grouping instead of external libraries like Lodash when appropriate.
|
||||||
|
- **`Promise.withResolvers` (5.7)**: Use `Promise.withResolvers()` for creating promises with exposed resolve/reject functions.
|
||||||
|
|
||||||
|
### Configuration & Tooling
|
||||||
|
- **`--moduleResolution bundler` (5.0)**: Assume this resolution strategy for modern web projects (Vite, Next.js, etc.).
|
||||||
|
- **`--erasableSyntaxOnly` (5.8)**: Be aware of this flag; avoid TypeScript-specific syntax that cannot be simply erased (like `enum`s or `namespaces`) if the project aims for maximum compatibility with tools like Node.js's `--strip-types`. Prefer `const` objects or unions over `enum`s if requested.
|
||||||
|
|
||||||
|
## Specific Coding Patterns
|
||||||
|
|
||||||
|
### Arrays & Collections
|
||||||
|
- Use **Copying Array Methods (5.2)** (`toSorted`, `toSpliced`, `with`) for immutable array operations.
|
||||||
|
- **TypedArrays (5.7)**: Be aware that TypedArrays are now generic over `ArrayBufferLike`.
|
||||||
|
|
||||||
|
### Classes
|
||||||
|
- **Parameter Decorators (5.0/5.2)**: Use modern standard decorators.
|
||||||
|
- **`super` Property Access (5.3)**: Avoid accessing instance fields via `super`.
|
||||||
|
|
||||||
|
### Error Handling
|
||||||
|
- **Checks for Never-Initialized Variables (5.7)**: Ensure variables are initialized before use to avoid new errors.
|
||||||
|
|
||||||
|
## Deprecations to Avoid
|
||||||
|
- Avoid `import ... assert` (use `with`).
|
||||||
|
- Avoid implicit `any` returns in `undefined`-returning functions (though 5.1 makes this easier, explicit is better).
|
||||||
|
- Avoid `enum`s if the project prefers erasable syntax (5.8).
|
||||||
|
|
||||||
|
## Version-Specific Highlights
|
||||||
|
|
||||||
|
### TypeScript 5.0
|
||||||
|
- **Decorators**: Use standard decorators unless `experimentalDecorators` is explicitly enabled.
|
||||||
|
- **`const` Type Parameters**: Use for literal inference.
|
||||||
|
- **Enums**: All enums are union enums.
|
||||||
|
- **Modules**: `--moduleResolution bundler` and `--verbatimModuleSyntax` are key for modern bundlers.
|
||||||
|
|
||||||
|
### TypeScript 5.1
|
||||||
|
- **Returns**: `undefined`-returning functions don't need explicit returns.
|
||||||
|
- **Getters/Setters**: Can have unrelated types with explicit annotations.
|
||||||
|
|
||||||
|
### TypeScript 5.2
|
||||||
|
- **Resource Management**: `using` declarations for `Symbol.dispose`.
|
||||||
|
- **Decorator Metadata**: Use `context.metadata` for design-time metadata.
|
||||||
|
|
||||||
|
### TypeScript 5.3
|
||||||
|
- **Import Attributes**: Use `with { type: "json" }`.
|
||||||
|
- **Switch(true)**: Narrowing works in `switch(true)`.
|
||||||
|
|
||||||
|
### TypeScript 5.4
|
||||||
|
- **Closures**: Narrowing preserved in closures if last assignment is before creation.
|
||||||
|
- **`NoInfer`**: Block inference for specific arguments.
|
||||||
|
- **Grouping**: `Object.groupBy` / `Map.groupBy`.
|
||||||
|
|
||||||
|
### TypeScript 5.5
|
||||||
|
- **Inferred Predicates**: Functions checking types often don't need explicit `is` return types.
|
||||||
|
- **Constant Index Access**: Better narrowing for constant keys.
|
||||||
|
- **Regex**: Syntax checking for regex literals.
|
||||||
|
|
||||||
|
### TypeScript 5.6
|
||||||
|
- **Truthiness Checks**: Errors on always-truthy/falsy conditions (e.g., `if (/regex/)`).
|
||||||
|
- **Iterator Helpers**: `.map`, `.filter` on iterators.
|
||||||
|
|
||||||
|
### TypeScript 5.7
|
||||||
|
- **Uninitialized Variables**: Stricter checks for never-initialized variables.
|
||||||
|
- **Relative Imports**: `--rewriteRelativeImportExtensions` for `.ts` imports in output.
|
||||||
|
- **ES2024**: Support for `Promise.withResolvers`, `Atomics.waitAsync`.
|
||||||
|
|
||||||
|
### TypeScript 5.8
|
||||||
|
- **Return Checks**: Granular checks for conditional returns.
|
||||||
|
- **Node Modules**: `--module node18` stable; `require()` of ESM allowed in `nodenext`.
|
||||||
|
- **Erasable Syntax**: `--erasableSyntaxOnly` forbids enums, namespaces, etc.
|
||||||
|
|
||||||
|
When generating code, always prefer the most modern, standard, and type-safe approach available in TypeScript 5.8.
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
### Description
|
||||||
|
<!-- Provide a detailed description of the changes in this PR -->
|
||||||
|
|
||||||
|
### Type of Change
|
||||||
|
<!-- Put an 'x' in the boxes that apply -->
|
||||||
|
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||||
|
- [ ] Feature (non-breaking change which adds functionality)
|
||||||
|
- [ ] Improvement (change that would cause existing functionality to not work as expected)
|
||||||
|
- [ ] Code refactoring
|
||||||
|
- [ ] Performance improvements
|
||||||
|
- [ ] Documentation update
|
||||||
|
|
||||||
|
### Screenshots and Media (if applicable)
|
||||||
|
<!-- Add screenshots to help explain your changes, ideally showcasing before and after -->
|
||||||
|
|
||||||
|
### Test Scenarios
|
||||||
|
<!-- Please describe the tests that you ran to verify your changes -->
|
||||||
|
|
||||||
|
### References
|
||||||
|
<!-- Link related issues if there are any -->
|
||||||
+410
@@ -0,0 +1,410 @@
|
|||||||
|
name: Branch Build CE
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
build_type:
|
||||||
|
description: "Type of build to run"
|
||||||
|
required: true
|
||||||
|
type: choice
|
||||||
|
default: "Build"
|
||||||
|
options:
|
||||||
|
- "Build"
|
||||||
|
- "Release"
|
||||||
|
releaseVersion:
|
||||||
|
description: "Release Version"
|
||||||
|
type: string
|
||||||
|
default: v0.0.0
|
||||||
|
isPrerelease:
|
||||||
|
description: "Is Pre-release"
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
required: true
|
||||||
|
arm64:
|
||||||
|
description: "Build for ARM64 architecture"
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
aio_build:
|
||||||
|
description: "Build for AIO docker image"
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- preview
|
||||||
|
- canary
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
env:
|
||||||
|
TARGET_BRANCH: ${{ github.ref_name }}
|
||||||
|
ARM64_BUILD: ${{ github.event.inputs.arm64 }}
|
||||||
|
BUILD_TYPE: ${{ github.event.inputs.build_type }}
|
||||||
|
RELEASE_VERSION: ${{ github.event.inputs.releaseVersion }}
|
||||||
|
IS_PRERELEASE: ${{ github.event.inputs.isPrerelease }}
|
||||||
|
AIO_BUILD: ${{ github.event.inputs.aio_build }}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
branch_build_setup:
|
||||||
|
name: Build Setup
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
outputs:
|
||||||
|
gh_branch_name: ${{ steps.set_env_variables.outputs.TARGET_BRANCH }}
|
||||||
|
gh_buildx_driver: ${{ steps.set_env_variables.outputs.BUILDX_DRIVER }}
|
||||||
|
gh_buildx_version: ${{ steps.set_env_variables.outputs.BUILDX_VERSION }}
|
||||||
|
gh_buildx_platforms: ${{ steps.set_env_variables.outputs.BUILDX_PLATFORMS }}
|
||||||
|
gh_buildx_endpoint: ${{ steps.set_env_variables.outputs.BUILDX_ENDPOINT }}
|
||||||
|
|
||||||
|
dh_img_web: ${{ steps.set_env_variables.outputs.DH_IMG_WEB }}
|
||||||
|
dh_img_space: ${{ steps.set_env_variables.outputs.DH_IMG_SPACE }}
|
||||||
|
dh_img_admin: ${{ steps.set_env_variables.outputs.DH_IMG_ADMIN }}
|
||||||
|
dh_img_live: ${{ steps.set_env_variables.outputs.DH_IMG_LIVE }}
|
||||||
|
dh_img_backend: ${{ steps.set_env_variables.outputs.DH_IMG_BACKEND }}
|
||||||
|
dh_img_proxy: ${{ steps.set_env_variables.outputs.DH_IMG_PROXY }}
|
||||||
|
dh_img_aio: ${{ steps.set_env_variables.outputs.DH_IMG_AIO }}
|
||||||
|
|
||||||
|
build_type: ${{steps.set_env_variables.outputs.BUILD_TYPE}}
|
||||||
|
build_release: ${{ steps.set_env_variables.outputs.BUILD_RELEASE }}
|
||||||
|
build_prerelease: ${{ steps.set_env_variables.outputs.BUILD_PRERELEASE }}
|
||||||
|
release_version: ${{ steps.set_env_variables.outputs.RELEASE_VERSION }}
|
||||||
|
aio_build: ${{ steps.set_env_variables.outputs.AIO_BUILD }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- id: set_env_variables
|
||||||
|
name: Set Environment Variables
|
||||||
|
run: |
|
||||||
|
if [ "${{ env.ARM64_BUILD }}" == "true" ] || ([ "${{ env.BUILD_TYPE }}" == "Release" ] && [ "${{ env.IS_PRERELEASE }}" != "true" ]); then
|
||||||
|
echo "BUILDX_DRIVER=cloud" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILDX_VERSION=lab:latest" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILDX_PLATFORMS=linux/amd64,linux/arm64" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILDX_ENDPOINT=makeplane/plane-dev" >> $GITHUB_OUTPUT
|
||||||
|
else
|
||||||
|
echo "BUILDX_DRIVER=docker-container" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILDX_VERSION=latest" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILDX_PLATFORMS=linux/amd64" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILDX_ENDPOINT=" >> $GITHUB_OUTPUT
|
||||||
|
fi
|
||||||
|
BR_NAME=$( echo "${{ env.TARGET_BRANCH }}" |sed 's/[^a-zA-Z0-9.-]//g')
|
||||||
|
echo "TARGET_BRANCH=$BR_NAME" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
echo "DH_IMG_WEB=plane-frontend" >> $GITHUB_OUTPUT
|
||||||
|
echo "DH_IMG_SPACE=plane-space" >> $GITHUB_OUTPUT
|
||||||
|
echo "DH_IMG_ADMIN=plane-admin" >> $GITHUB_OUTPUT
|
||||||
|
echo "DH_IMG_LIVE=plane-live" >> $GITHUB_OUTPUT
|
||||||
|
echo "DH_IMG_BACKEND=plane-backend" >> $GITHUB_OUTPUT
|
||||||
|
echo "DH_IMG_PROXY=plane-proxy" >> $GITHUB_OUTPUT
|
||||||
|
echo "DH_IMG_AIO=plane-aio-community" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
echo "BUILD_TYPE=${{env.BUILD_TYPE}}" >> $GITHUB_OUTPUT
|
||||||
|
BUILD_RELEASE=false
|
||||||
|
BUILD_PRERELEASE=false
|
||||||
|
RELVERSION="latest"
|
||||||
|
|
||||||
|
BUILD_AIO=${{ env.AIO_BUILD }}
|
||||||
|
|
||||||
|
if [ "${{ env.BUILD_TYPE }}" == "Release" ]; then
|
||||||
|
FLAT_RELEASE_VERSION=$(echo "${{ env.RELEASE_VERSION }}" | sed 's/[^a-zA-Z0-9.-]//g')
|
||||||
|
echo "FLAT_RELEASE_VERSION=${FLAT_RELEASE_VERSION}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
semver_regex="^v([0-9]+)\.([0-9]+)\.([0-9]+)(-[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$"
|
||||||
|
if [[ ! $FLAT_RELEASE_VERSION =~ $semver_regex ]]; then
|
||||||
|
echo "Invalid Release Version Format : $FLAT_RELEASE_VERSION"
|
||||||
|
echo "Please provide a valid SemVer version"
|
||||||
|
echo "e.g. v1.2.3 or v1.2.3-alpha-1"
|
||||||
|
echo "Exiting the build process"
|
||||||
|
exit 1 # Exit with status 1 to fail the step
|
||||||
|
fi
|
||||||
|
BUILD_RELEASE=true
|
||||||
|
RELVERSION=$FLAT_RELEASE_VERSION
|
||||||
|
|
||||||
|
if [ "${{ env.IS_PRERELEASE }}" == "true" ]; then
|
||||||
|
BUILD_PRERELEASE=true
|
||||||
|
fi
|
||||||
|
|
||||||
|
BUILD_AIO=true
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "BUILD_RELEASE=${BUILD_RELEASE}" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILD_PRERELEASE=${BUILD_PRERELEASE}" >> $GITHUB_OUTPUT
|
||||||
|
echo "RELEASE_VERSION=${RELVERSION}" >> $GITHUB_OUTPUT
|
||||||
|
echo "AIO_BUILD=${BUILD_AIO}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- id: checkout_files
|
||||||
|
name: Checkout Files
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
branch_build_push_admin:
|
||||||
|
name: Build-Push Admin Docker Image
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs: [branch_build_setup]
|
||||||
|
steps:
|
||||||
|
- name: Admin Build and Push
|
||||||
|
uses: makeplane/actions/build-push@v1.4.0
|
||||||
|
with:
|
||||||
|
build-release: ${{ needs.branch_build_setup.outputs.build_release }}
|
||||||
|
build-prerelease: ${{ needs.branch_build_setup.outputs.build_prerelease }}
|
||||||
|
release-version: ${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
docker-image-owner: makeplane
|
||||||
|
docker-image-name: ${{ needs.branch_build_setup.outputs.dh_img_admin }}
|
||||||
|
build-context: .
|
||||||
|
dockerfile-path: ./apps/admin/Dockerfile.admin
|
||||||
|
buildx-driver: ${{ needs.branch_build_setup.outputs.gh_buildx_driver }}
|
||||||
|
buildx-version: ${{ needs.branch_build_setup.outputs.gh_buildx_version }}
|
||||||
|
buildx-platforms: ${{ needs.branch_build_setup.outputs.gh_buildx_platforms }}
|
||||||
|
buildx-endpoint: ${{ needs.branch_build_setup.outputs.gh_buildx_endpoint }}
|
||||||
|
|
||||||
|
branch_build_push_web:
|
||||||
|
name: Build-Push Web Docker Image
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs: [branch_build_setup]
|
||||||
|
steps:
|
||||||
|
- name: Web Build and Push
|
||||||
|
uses: makeplane/actions/build-push@v1.4.0
|
||||||
|
with:
|
||||||
|
build-release: ${{ needs.branch_build_setup.outputs.build_release }}
|
||||||
|
build-prerelease: ${{ needs.branch_build_setup.outputs.build_prerelease }}
|
||||||
|
release-version: ${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
docker-image-owner: makeplane
|
||||||
|
docker-image-name: ${{ needs.branch_build_setup.outputs.dh_img_web }}
|
||||||
|
build-context: .
|
||||||
|
dockerfile-path: ./apps/web/Dockerfile.web
|
||||||
|
buildx-driver: ${{ needs.branch_build_setup.outputs.gh_buildx_driver }}
|
||||||
|
buildx-version: ${{ needs.branch_build_setup.outputs.gh_buildx_version }}
|
||||||
|
buildx-platforms: ${{ needs.branch_build_setup.outputs.gh_buildx_platforms }}
|
||||||
|
buildx-endpoint: ${{ needs.branch_build_setup.outputs.gh_buildx_endpoint }}
|
||||||
|
|
||||||
|
branch_build_push_space:
|
||||||
|
name: Build-Push Space Docker Image
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs: [branch_build_setup]
|
||||||
|
steps:
|
||||||
|
- name: Space Build and Push
|
||||||
|
uses: makeplane/actions/build-push@v1.4.0
|
||||||
|
with:
|
||||||
|
build-release: ${{ needs.branch_build_setup.outputs.build_release }}
|
||||||
|
build-prerelease: ${{ needs.branch_build_setup.outputs.build_prerelease }}
|
||||||
|
release-version: ${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
docker-image-owner: makeplane
|
||||||
|
docker-image-name: ${{ needs.branch_build_setup.outputs.dh_img_space }}
|
||||||
|
build-context: .
|
||||||
|
dockerfile-path: ./apps/space/Dockerfile.space
|
||||||
|
buildx-driver: ${{ needs.branch_build_setup.outputs.gh_buildx_driver }}
|
||||||
|
buildx-version: ${{ needs.branch_build_setup.outputs.gh_buildx_version }}
|
||||||
|
buildx-platforms: ${{ needs.branch_build_setup.outputs.gh_buildx_platforms }}
|
||||||
|
buildx-endpoint: ${{ needs.branch_build_setup.outputs.gh_buildx_endpoint }}
|
||||||
|
|
||||||
|
branch_build_push_live:
|
||||||
|
name: Build-Push Live Collaboration Docker Image
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs: [branch_build_setup]
|
||||||
|
steps:
|
||||||
|
- name: Live Build and Push
|
||||||
|
uses: makeplane/actions/build-push@v1.4.0
|
||||||
|
with:
|
||||||
|
build-release: ${{ needs.branch_build_setup.outputs.build_release }}
|
||||||
|
build-prerelease: ${{ needs.branch_build_setup.outputs.build_prerelease }}
|
||||||
|
release-version: ${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
docker-image-owner: makeplane
|
||||||
|
docker-image-name: ${{ needs.branch_build_setup.outputs.dh_img_live }}
|
||||||
|
build-context: .
|
||||||
|
dockerfile-path: ./apps/live/Dockerfile.live
|
||||||
|
buildx-driver: ${{ needs.branch_build_setup.outputs.gh_buildx_driver }}
|
||||||
|
buildx-version: ${{ needs.branch_build_setup.outputs.gh_buildx_version }}
|
||||||
|
buildx-platforms: ${{ needs.branch_build_setup.outputs.gh_buildx_platforms }}
|
||||||
|
buildx-endpoint: ${{ needs.branch_build_setup.outputs.gh_buildx_endpoint }}
|
||||||
|
|
||||||
|
branch_build_push_api:
|
||||||
|
name: Build-Push API Server Docker Image
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs: [branch_build_setup]
|
||||||
|
steps:
|
||||||
|
- name: Backend Build and Push
|
||||||
|
uses: makeplane/actions/build-push@v1.4.0
|
||||||
|
with:
|
||||||
|
build-release: ${{ needs.branch_build_setup.outputs.build_release }}
|
||||||
|
build-prerelease: ${{ needs.branch_build_setup.outputs.build_prerelease }}
|
||||||
|
release-version: ${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
docker-image-owner: makeplane
|
||||||
|
docker-image-name: ${{ needs.branch_build_setup.outputs.dh_img_backend }}
|
||||||
|
build-context: ./apps/api
|
||||||
|
dockerfile-path: ./apps/api/Dockerfile.api
|
||||||
|
buildx-driver: ${{ needs.branch_build_setup.outputs.gh_buildx_driver }}
|
||||||
|
buildx-version: ${{ needs.branch_build_setup.outputs.gh_buildx_version }}
|
||||||
|
buildx-platforms: ${{ needs.branch_build_setup.outputs.gh_buildx_platforms }}
|
||||||
|
buildx-endpoint: ${{ needs.branch_build_setup.outputs.gh_buildx_endpoint }}
|
||||||
|
|
||||||
|
branch_build_push_proxy:
|
||||||
|
name: Build-Push Proxy Docker Image
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs: [branch_build_setup]
|
||||||
|
steps:
|
||||||
|
- name: Proxy Build and Push
|
||||||
|
uses: makeplane/actions/build-push@v1.4.0
|
||||||
|
with:
|
||||||
|
build-release: ${{ needs.branch_build_setup.outputs.build_release }}
|
||||||
|
build-prerelease: ${{ needs.branch_build_setup.outputs.build_prerelease }}
|
||||||
|
release-version: ${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
docker-image-owner: makeplane
|
||||||
|
docker-image-name: ${{ needs.branch_build_setup.outputs.dh_img_proxy }}
|
||||||
|
build-context: ./apps/proxy
|
||||||
|
dockerfile-path: ./apps/proxy/Dockerfile.ce
|
||||||
|
buildx-driver: ${{ needs.branch_build_setup.outputs.gh_buildx_driver }}
|
||||||
|
buildx-version: ${{ needs.branch_build_setup.outputs.gh_buildx_version }}
|
||||||
|
buildx-platforms: ${{ needs.branch_build_setup.outputs.gh_buildx_platforms }}
|
||||||
|
buildx-endpoint: ${{ needs.branch_build_setup.outputs.gh_buildx_endpoint }}
|
||||||
|
|
||||||
|
branch_build_push_aio:
|
||||||
|
if: ${{ needs.branch_build_setup.outputs.aio_build == 'true' }}
|
||||||
|
name: Build-Push AIO Docker Image
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs:
|
||||||
|
- branch_build_setup
|
||||||
|
- branch_build_push_admin
|
||||||
|
- branch_build_push_web
|
||||||
|
- branch_build_push_space
|
||||||
|
- branch_build_push_live
|
||||||
|
- branch_build_push_api
|
||||||
|
- branch_build_push_proxy
|
||||||
|
steps:
|
||||||
|
- name: Checkout Files
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Prepare AIO Assets
|
||||||
|
id: prepare_aio_assets
|
||||||
|
run: |
|
||||||
|
cd deployments/aio/community
|
||||||
|
|
||||||
|
if [ "${{ needs.branch_build_setup.outputs.build_type }}" == "Release" ]; then
|
||||||
|
aio_version=${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
else
|
||||||
|
aio_version=${{ needs.branch_build_setup.outputs.gh_branch_name }}
|
||||||
|
fi
|
||||||
|
bash ./build.sh --release $aio_version
|
||||||
|
echo "AIO_BUILD_VERSION=${aio_version}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Upload AIO Assets
|
||||||
|
uses: actions/upload-artifact@v7
|
||||||
|
with:
|
||||||
|
path: ./deployments/aio/community/dist
|
||||||
|
name: aio-assets-dist
|
||||||
|
|
||||||
|
- name: AIO Build and Push
|
||||||
|
uses: makeplane/actions/build-push@v1.4.0
|
||||||
|
with:
|
||||||
|
build-release: ${{ needs.branch_build_setup.outputs.build_release }}
|
||||||
|
build-prerelease: ${{ needs.branch_build_setup.outputs.build_prerelease }}
|
||||||
|
release-version: ${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
docker-image-owner: makeplane
|
||||||
|
docker-image-name: ${{ needs.branch_build_setup.outputs.dh_img_aio }}
|
||||||
|
build-context: ./deployments/aio/community
|
||||||
|
dockerfile-path: ./deployments/aio/community/Dockerfile
|
||||||
|
buildx-driver: ${{ needs.branch_build_setup.outputs.gh_buildx_driver }}
|
||||||
|
buildx-version: ${{ needs.branch_build_setup.outputs.gh_buildx_version }}
|
||||||
|
buildx-platforms: ${{ needs.branch_build_setup.outputs.gh_buildx_platforms }}
|
||||||
|
buildx-endpoint: ${{ needs.branch_build_setup.outputs.gh_buildx_endpoint }}
|
||||||
|
additional-assets: aio-assets-dist
|
||||||
|
additional-assets-dir: ./deployments/aio/community/dist
|
||||||
|
build-args: |
|
||||||
|
PLANE_VERSION=${{ steps.prepare_aio_assets.outputs.AIO_BUILD_VERSION }}
|
||||||
|
|
||||||
|
upload_build_assets:
|
||||||
|
name: Upload Build Assets
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs:
|
||||||
|
- branch_build_setup
|
||||||
|
- branch_build_push_admin
|
||||||
|
- branch_build_push_web
|
||||||
|
- branch_build_push_space
|
||||||
|
- branch_build_push_live
|
||||||
|
- branch_build_push_api
|
||||||
|
- branch_build_push_proxy
|
||||||
|
steps:
|
||||||
|
- name: Checkout Files
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Update Assets
|
||||||
|
run: |
|
||||||
|
if [ "${{ needs.branch_build_setup.outputs.build_type }}" == "Release" ]; then
|
||||||
|
REL_VERSION=${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
else
|
||||||
|
REL_VERSION=${{ needs.branch_build_setup.outputs.gh_branch_name }}
|
||||||
|
fi
|
||||||
|
|
||||||
|
cp ./deployments/cli/community/install.sh deployments/cli/community/setup.sh
|
||||||
|
sed -i 's/${APP_RELEASE:-stable}/${APP_RELEASE:-'${REL_VERSION}'}/g' deployments/cli/community/docker-compose.yml
|
||||||
|
# sed -i 's/APP_RELEASE=stable/APP_RELEASE='${REL_VERSION}'/g' deployments/cli/community/variables.env
|
||||||
|
|
||||||
|
- name: Upload Assets
|
||||||
|
uses: actions/upload-artifact@v7
|
||||||
|
with:
|
||||||
|
name: community-assets
|
||||||
|
path: |
|
||||||
|
./deployments/cli/community/setup.sh
|
||||||
|
./deployments/cli/community/restore.sh
|
||||||
|
./deployments/cli/community/restore-airgapped.sh
|
||||||
|
./deployments/cli/community/docker-compose.yml
|
||||||
|
./deployments/cli/community/variables.env
|
||||||
|
./deployments/swarm/community/swarm.sh
|
||||||
|
|
||||||
|
publish_release:
|
||||||
|
if: ${{ needs.branch_build_setup.outputs.build_type == 'Release' }}
|
||||||
|
name: Build Release
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs:
|
||||||
|
[
|
||||||
|
branch_build_setup,
|
||||||
|
branch_build_push_admin,
|
||||||
|
branch_build_push_web,
|
||||||
|
branch_build_push_space,
|
||||||
|
branch_build_push_live,
|
||||||
|
branch_build_push_api,
|
||||||
|
branch_build_push_proxy,
|
||||||
|
]
|
||||||
|
env:
|
||||||
|
REL_VERSION: ${{ needs.branch_build_setup.outputs.release_version }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Update Assets
|
||||||
|
run: |
|
||||||
|
cp ./deployments/cli/community/install.sh deployments/cli/community/setup.sh
|
||||||
|
sed -i 's/${APP_RELEASE:-stable}/${APP_RELEASE:-'${REL_VERSION}'}/g' deployments/cli/community/docker-compose.yml
|
||||||
|
# sed -i 's/APP_RELEASE=stable/APP_RELEASE='${REL_VERSION}'/g' deployments/cli/community/variables.env
|
||||||
|
|
||||||
|
- name: Create Release
|
||||||
|
id: create_release
|
||||||
|
uses: softprops/action-gh-release@v2.6.1
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
|
||||||
|
with:
|
||||||
|
tag_name: ${{ env.REL_VERSION }}
|
||||||
|
name: ${{ env.REL_VERSION }}
|
||||||
|
target_commitish: ${{ github.sha }}
|
||||||
|
draft: false
|
||||||
|
prerelease: ${{ env.IS_PRERELEASE }}
|
||||||
|
generate_release_notes: true
|
||||||
|
files: |
|
||||||
|
${{ github.workspace }}/deployments/cli/community/setup.sh
|
||||||
|
${{ github.workspace }}/deployments/cli/community/restore.sh
|
||||||
|
${{ github.workspace }}/deployments/cli/community/restore-airgapped.sh
|
||||||
|
${{ github.workspace }}/deployments/cli/community/docker-compose.yml
|
||||||
|
${{ github.workspace }}/deployments/cli/community/variables.env
|
||||||
|
${{ github.workspace }}/deployments/swarm/community/swarm.sh
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
name: Version Change Before Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check-version:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
ref: ${{ github.head_ref }}
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
|
||||||
|
- name: Get PR Branch version
|
||||||
|
run: echo "PR_VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
- name: Fetch base branch
|
||||||
|
run: git fetch origin master:master
|
||||||
|
|
||||||
|
- name: Get Master Branch version
|
||||||
|
run: |
|
||||||
|
git checkout master
|
||||||
|
echo "MASTER_VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
- name: Get master branch version and compare
|
||||||
|
run: |
|
||||||
|
echo "Comparing versions: PR version is $PR_VERSION, Master version is $MASTER_VERSION"
|
||||||
|
if [ "$PR_VERSION" == "$MASTER_VERSION" ]; then
|
||||||
|
echo "Version in PR branch is the same as in master. Failing the CI."
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "Version check passed. Versions are different."
|
||||||
|
fi
|
||||||
|
env:
|
||||||
|
PR_VERSION: ${{ env.PR_VERSION }}
|
||||||
|
MASTER_VERSION: ${{ env.MASTER_VERSION }}
|
||||||
+39
@@ -0,0 +1,39 @@
|
|||||||
|
name: "CodeQL"
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
push:
|
||||||
|
branches: ["preview", "canary", "master"]
|
||||||
|
pull_request:
|
||||||
|
branches: ["preview", "canary", "master"]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
analyze:
|
||||||
|
name: Analyze
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
actions: read
|
||||||
|
contents: read
|
||||||
|
security-events: write
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
language: ["python", "javascript"]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Initialize CodeQL
|
||||||
|
uses: github/codeql-action/init@v4
|
||||||
|
with:
|
||||||
|
languages: ${{ matrix.language }}
|
||||||
|
|
||||||
|
- name: Autobuild
|
||||||
|
uses: github/codeql-action/autobuild@v4
|
||||||
|
|
||||||
|
- name: Perform CodeQL Analysis
|
||||||
|
uses: github/codeql-action/analyze@v4
|
||||||
|
with:
|
||||||
|
category: "/language:${{matrix.language}}"
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
name: Copy Right Check
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- "preview"
|
||||||
|
types:
|
||||||
|
- "opened"
|
||||||
|
- "synchronize"
|
||||||
|
- "ready_for_review"
|
||||||
|
- "review_requested"
|
||||||
|
- "reopened"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
license-check:
|
||||||
|
name: Copy Right Check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Set up Go
|
||||||
|
uses: actions/setup-go@v6
|
||||||
|
with:
|
||||||
|
go-version: "1.22"
|
||||||
|
|
||||||
|
- name: Install addlicense
|
||||||
|
run: |
|
||||||
|
go install github.com/google/addlicense@latest
|
||||||
|
echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
|
||||||
|
|
||||||
|
- name: Check Copyright For Python Files
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
echo "Running copyright check..."
|
||||||
|
addlicense -check -f COPYRIGHT.txt -ignore "**/migrations/**" $(git ls-files '*.py')
|
||||||
|
echo "Copyright check passed."
|
||||||
|
|
||||||
|
- name: Check Copyright For TypeScript Files
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
echo "Running copyright check..."
|
||||||
|
addlicense -check -f COPYRIGHT.txt -ignore "**/*.config.ts" -ignore "**/*.d.ts" $(git ls-files '*.ts' '*.tsx')
|
||||||
|
echo "Copyright check passed."
|
||||||
@@ -0,0 +1,168 @@
|
|||||||
|
name: Feature Preview
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
base_tag_name:
|
||||||
|
description: 'Base Tag Name'
|
||||||
|
required: false
|
||||||
|
default: 'preview'
|
||||||
|
|
||||||
|
env:
|
||||||
|
TARGET_BRANCH: ${{ github.ref_name }}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
branch_build_setup:
|
||||||
|
name: Build Setup
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
gh_branch_name: ${{ steps.set_env_variables.outputs.TARGET_BRANCH }}
|
||||||
|
flat_branch_name: ${{ steps.set_env_variables.outputs.FLAT_BRANCH_NAME }}
|
||||||
|
gh_buildx_driver: ${{ steps.set_env_variables.outputs.BUILDX_DRIVER }}
|
||||||
|
gh_buildx_version: ${{ steps.set_env_variables.outputs.BUILDX_VERSION }}
|
||||||
|
gh_buildx_platforms: ${{ steps.set_env_variables.outputs.BUILDX_PLATFORMS }}
|
||||||
|
gh_buildx_endpoint: ${{ steps.set_env_variables.outputs.BUILDX_ENDPOINT }}
|
||||||
|
aio_base_tag: ${{ steps.set_env_variables.outputs.AIO_BASE_TAG }}
|
||||||
|
do_full_build: ${{ steps.set_env_variables.outputs.DO_FULL_BUILD }}
|
||||||
|
do_slim_build: ${{ steps.set_env_variables.outputs.DO_SLIM_BUILD }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- id: set_env_variables
|
||||||
|
name: Set Environment Variables
|
||||||
|
run: |
|
||||||
|
echo "BUILDX_DRIVER=docker-container" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILDX_VERSION=latest" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILDX_PLATFORMS=linux/amd64" >> $GITHUB_OUTPUT
|
||||||
|
echo "BUILDX_ENDPOINT=" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
if [ "${{ github.event.inputs.base_tag_name }}" != "" ]; then
|
||||||
|
echo "AIO_BASE_TAG=${{ github.event.inputs.base_tag_name }}" >> $GITHUB_OUTPUT
|
||||||
|
else
|
||||||
|
echo "AIO_BASE_TAG=develop" >> $GITHUB_OUTPUT
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "TARGET_BRANCH=${{ env.TARGET_BRANCH }}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
FLAT_BRANCH_NAME=$(echo "${{ env.TARGET_BRANCH }}" | sed 's/[^a-zA-Z0-9]/-/g')
|
||||||
|
echo "FLAT_BRANCH_NAME=$FLAT_BRANCH_NAME" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- id: checkout_files
|
||||||
|
name: Checkout Files
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
full_build_push:
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
needs: [branch_build_setup]
|
||||||
|
env:
|
||||||
|
BUILD_TYPE: full
|
||||||
|
AIO_BASE_TAG: ${{ needs.branch_build_setup.outputs.aio_base_tag }}
|
||||||
|
AIO_IMAGE_TAGS: makeplane/plane-aio-feature:${{ needs.branch_build_setup.outputs.flat_branch_name }}
|
||||||
|
BUILDX_DRIVER: ${{ needs.branch_build_setup.outputs.gh_buildx_driver }}
|
||||||
|
BUILDX_VERSION: ${{ needs.branch_build_setup.outputs.gh_buildx_version }}
|
||||||
|
BUILDX_PLATFORMS: ${{ needs.branch_build_setup.outputs.gh_buildx_platforms }}
|
||||||
|
BUILDX_ENDPOINT: ${{ needs.branch_build_setup.outputs.gh_buildx_endpoint }}
|
||||||
|
steps:
|
||||||
|
- name: Login to Docker Hub
|
||||||
|
uses: docker/login-action@v4
|
||||||
|
with:
|
||||||
|
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v4
|
||||||
|
with:
|
||||||
|
driver: ${{ env.BUILDX_DRIVER }}
|
||||||
|
version: ${{ env.BUILDX_VERSION }}
|
||||||
|
endpoint: ${{ env.BUILDX_ENDPOINT }}
|
||||||
|
|
||||||
|
- name: Check out the repo
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Build and Push to Docker Hub
|
||||||
|
uses: docker/build-push-action@v7.0.0
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
file: ./aio/Dockerfile-app
|
||||||
|
platforms: ${{ env.BUILDX_PLATFORMS }}
|
||||||
|
tags: ${{ env.AIO_IMAGE_TAGS }}
|
||||||
|
push: true
|
||||||
|
build-args:
|
||||||
|
BUILD_TAG=${{ env.AIO_BASE_TAG }}
|
||||||
|
BUILD_TYPE=${{env.BUILD_TYPE}}
|
||||||
|
# cache-from: type=gha
|
||||||
|
# cache-to: type=gha,mode=max
|
||||||
|
env:
|
||||||
|
DOCKER_BUILDKIT: 1
|
||||||
|
DOCKER_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
outputs:
|
||||||
|
AIO_IMAGE_TAGS: ${{ env.AIO_IMAGE_TAGS }}
|
||||||
|
|
||||||
|
feature-deploy:
|
||||||
|
needs: [branch_build_setup, full_build_push]
|
||||||
|
name: Feature Deploy
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
KUBE_CONFIG_FILE: ${{ secrets.FEATURE_PREVIEW_KUBE_CONFIG }}
|
||||||
|
DEPLOYMENT_NAME: ${{ needs.branch_build_setup.outputs.flat_branch_name }}
|
||||||
|
steps:
|
||||||
|
- name: Install AWS cli
|
||||||
|
run: |
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y python3-pip
|
||||||
|
pip3 install awscli
|
||||||
|
- name: Tailscale
|
||||||
|
uses: tailscale/github-action@v4
|
||||||
|
with:
|
||||||
|
oauth-client-id: ${{ secrets.TAILSCALE_OAUTH_CLIENT_ID }}
|
||||||
|
oauth-secret: ${{ secrets.TAILSCALE_OAUTH_SECRET }}
|
||||||
|
tags: tag:ci
|
||||||
|
- name: Kubectl Setup
|
||||||
|
run: |
|
||||||
|
curl -LO "https://dl.k8s.io/release/${{ vars.FEATURE_PREVIEW_KUBE_VERSION }}/bin/linux/amd64/kubectl"
|
||||||
|
chmod +x kubectl
|
||||||
|
|
||||||
|
mkdir -p ~/.kube
|
||||||
|
echo "$KUBE_CONFIG_FILE" > ~/.kube/config
|
||||||
|
chmod 600 ~/.kube/config
|
||||||
|
- name: HELM Setup
|
||||||
|
run: |
|
||||||
|
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
|
||||||
|
chmod 700 get_helm.sh
|
||||||
|
./get_helm.sh
|
||||||
|
- name: App Deploy
|
||||||
|
run: |
|
||||||
|
helm --kube-insecure-skip-tls-verify repo add feature-preview ${{ vars.FEATURE_PREVIEW_HELM_CHART_URL }}
|
||||||
|
|
||||||
|
APP_NAMESPACE="${{ vars.FEATURE_PREVIEW_NAMESPACE }}"
|
||||||
|
|
||||||
|
helm --kube-insecure-skip-tls-verify uninstall \
|
||||||
|
${{ env.DEPLOYMENT_NAME }} \
|
||||||
|
--namespace $APP_NAMESPACE \
|
||||||
|
--timeout 10m0s \
|
||||||
|
--wait \
|
||||||
|
--ignore-not-found
|
||||||
|
|
||||||
|
METADATA=$(helm --kube-insecure-skip-tls-verify upgrade \
|
||||||
|
--install=true \
|
||||||
|
--namespace $APP_NAMESPACE \
|
||||||
|
--set dockerhub.loginid=${{ secrets.DOCKERHUB_USERNAME }} \
|
||||||
|
--set dockerhub.password=${{ secrets.DOCKERHUB_TOKEN_RO}} \
|
||||||
|
--set config.feature_branch=${{ env.DEPLOYMENT_NAME }} \
|
||||||
|
--set ingress.primaryDomain=${{vars.FEATURE_PREVIEW_PRIMARY_DOMAIN || 'feature.plane.tools' }} \
|
||||||
|
--set ingress.tls_secret=${{vars.FEATURE_PREVIEW_INGRESS_TLS_SECRET || '' }} \
|
||||||
|
--output json \
|
||||||
|
--timeout 10m0s \
|
||||||
|
--wait \
|
||||||
|
${{ env.DEPLOYMENT_NAME }} feature-preview/${{ vars.FEATURE_PREVIEW_HELM_CHART_NAME }} )
|
||||||
|
|
||||||
|
APP_NAME=$(echo $METADATA | jq -r '.name')
|
||||||
|
|
||||||
|
INGRESS_HOSTNAME=$(kubectl get ingress -n $APP_NAMESPACE --insecure-skip-tls-verify \
|
||||||
|
-o jsonpath='{.items[?(@.metadata.annotations.meta\.helm\.sh\/release-name=="'$APP_NAME'")]}' | \
|
||||||
|
jq -r '.spec.rules[0].host')
|
||||||
|
|
||||||
|
echo "****************************************"
|
||||||
|
echo "APP NAME ::: $APP_NAME"
|
||||||
|
echo "INGRESS HOSTNAME ::: $INGRESS_HOSTNAME"
|
||||||
|
echo "****************************************"
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
name: Build and lint API
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- "preview"
|
||||||
|
types:
|
||||||
|
- "opened"
|
||||||
|
- "synchronize"
|
||||||
|
- "ready_for_review"
|
||||||
|
- "review_requested"
|
||||||
|
- "reopened"
|
||||||
|
paths:
|
||||||
|
- "apps/api/**"
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint-api:
|
||||||
|
name: Lint API
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 25
|
||||||
|
if: |
|
||||||
|
github.event.pull_request.draft == false &&
|
||||||
|
github.event.pull_request.requested_reviewers != null
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v6
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v6
|
||||||
|
with:
|
||||||
|
python-version: "3.12.x"
|
||||||
|
cache: 'pip'
|
||||||
|
cache-dependency-path: 'apps/api/requirements.txt'
|
||||||
|
- name: Install Pylint
|
||||||
|
run: python -m pip install ruff
|
||||||
|
- name: Install API Dependencies
|
||||||
|
run: cd apps/api && pip install -r requirements.txt
|
||||||
|
- name: Lint apps/api
|
||||||
|
run: ruff check --fix apps/api
|
||||||
@@ -0,0 +1,205 @@
|
|||||||
|
name: Build and lint web apps
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- "preview"
|
||||||
|
types:
|
||||||
|
- "opened"
|
||||||
|
- "synchronize"
|
||||||
|
- "reopened"
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
# Format check has no build dependencies - run immediately in parallel
|
||||||
|
check-format:
|
||||||
|
name: check:format
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 10
|
||||||
|
if: |
|
||||||
|
github.event.pull_request.draft == false &&
|
||||||
|
github.event.pull_request.requested_reviewers != null
|
||||||
|
env:
|
||||||
|
TURBO_SCM_BASE: ${{ github.event.pull_request.base.sha }}
|
||||||
|
TURBO_SCM_HEAD: ${{ github.sha }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 50
|
||||||
|
filter: blob:none
|
||||||
|
|
||||||
|
- name: Set up Node.js
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
|
||||||
|
- name: Enable Corepack and pnpm
|
||||||
|
run: corepack enable pnpm
|
||||||
|
|
||||||
|
- name: Get pnpm store directory
|
||||||
|
shell: bash
|
||||||
|
run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
- name: Cache pnpm store
|
||||||
|
uses: actions/cache@v5
|
||||||
|
with:
|
||||||
|
path: ${{ env.STORE_PATH }}
|
||||||
|
key: pnpm-store-${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||||
|
restore-keys: |
|
||||||
|
pnpm-store-${{ runner.os }}-
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Check formatting
|
||||||
|
run: pnpm turbo run check:format --affected
|
||||||
|
|
||||||
|
# Build packages - required for lint and type checks
|
||||||
|
build:
|
||||||
|
name: Build packages
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 15
|
||||||
|
if: |
|
||||||
|
github.event.pull_request.draft == false &&
|
||||||
|
github.event.pull_request.requested_reviewers != null
|
||||||
|
env:
|
||||||
|
TURBO_SCM_BASE: ${{ github.event.pull_request.base.sha }}
|
||||||
|
TURBO_SCM_HEAD: ${{ github.sha }}
|
||||||
|
NODE_OPTIONS: "--max-old-space-size=4096"
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 50
|
||||||
|
filter: blob:none
|
||||||
|
|
||||||
|
- name: Set up Node.js
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
|
||||||
|
- name: Enable Corepack and pnpm
|
||||||
|
run: corepack enable pnpm
|
||||||
|
|
||||||
|
- name: Get pnpm store directory
|
||||||
|
shell: bash
|
||||||
|
run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
- name: Cache pnpm store
|
||||||
|
uses: actions/cache@v5
|
||||||
|
with:
|
||||||
|
path: ${{ env.STORE_PATH }}
|
||||||
|
key: pnpm-store-${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||||
|
restore-keys: |
|
||||||
|
pnpm-store-${{ runner.os }}-
|
||||||
|
|
||||||
|
- name: Restore Turbo cache
|
||||||
|
uses: actions/cache/restore@v5
|
||||||
|
with:
|
||||||
|
path: .turbo
|
||||||
|
key: turbo-${{ runner.os }}-${{ github.event.pull_request.base.sha }}-${{ github.sha }}
|
||||||
|
restore-keys: |
|
||||||
|
turbo-${{ runner.os }}-${{ github.event.pull_request.base.sha }}-
|
||||||
|
turbo-${{ runner.os }}-
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Build packages
|
||||||
|
run: pnpm turbo run build --affected
|
||||||
|
|
||||||
|
- name: Save Turbo cache
|
||||||
|
uses: actions/cache/save@v5
|
||||||
|
with:
|
||||||
|
path: .turbo
|
||||||
|
key: turbo-${{ runner.os }}-${{ github.event.pull_request.base.sha }}-${{ github.sha }}
|
||||||
|
|
||||||
|
# Lint check - no build dependency, OxLint is a standalone Rust binary
|
||||||
|
check-lint:
|
||||||
|
name: check:lint
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 10
|
||||||
|
if: |
|
||||||
|
github.event.pull_request.draft == false &&
|
||||||
|
github.event.pull_request.requested_reviewers != null
|
||||||
|
env:
|
||||||
|
TURBO_SCM_BASE: ${{ github.event.pull_request.base.sha }}
|
||||||
|
TURBO_SCM_HEAD: ${{ github.sha }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 50
|
||||||
|
filter: blob:none
|
||||||
|
|
||||||
|
- name: Set up Node.js
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
|
||||||
|
- name: Enable Corepack and pnpm
|
||||||
|
run: corepack enable pnpm
|
||||||
|
|
||||||
|
- name: Get pnpm store directory
|
||||||
|
shell: bash
|
||||||
|
run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
- name: Cache pnpm store
|
||||||
|
uses: actions/cache@v5
|
||||||
|
with:
|
||||||
|
path: ${{ env.STORE_PATH }}
|
||||||
|
key: pnpm-store-${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||||
|
restore-keys: |
|
||||||
|
pnpm-store-${{ runner.os }}-
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Run check:lint
|
||||||
|
run: pnpm turbo run check:lint --affected
|
||||||
|
|
||||||
|
# Type check depends on build artifacts
|
||||||
|
check-types:
|
||||||
|
name: check:types
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: build
|
||||||
|
timeout-minutes: 15
|
||||||
|
env:
|
||||||
|
TURBO_SCM_BASE: ${{ github.event.pull_request.base.sha }}
|
||||||
|
TURBO_SCM_HEAD: ${{ github.sha }}
|
||||||
|
NODE_OPTIONS: "--max-old-space-size=4096"
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 50
|
||||||
|
filter: blob:none
|
||||||
|
|
||||||
|
- name: Set up Node.js
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
|
||||||
|
- name: Enable Corepack and pnpm
|
||||||
|
run: corepack enable pnpm
|
||||||
|
|
||||||
|
- name: Get pnpm store directory
|
||||||
|
shell: bash
|
||||||
|
run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
- name: Cache pnpm store
|
||||||
|
uses: actions/cache@v5
|
||||||
|
with:
|
||||||
|
path: ${{ env.STORE_PATH }}
|
||||||
|
key: pnpm-store-${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||||
|
restore-keys: |
|
||||||
|
pnpm-store-${{ runner.os }}-
|
||||||
|
|
||||||
|
- name: Restore Turbo cache
|
||||||
|
uses: actions/cache/restore@v5
|
||||||
|
with:
|
||||||
|
path: .turbo
|
||||||
|
key: turbo-${{ runner.os }}-${{ github.event.pull_request.base.sha }}-${{ github.sha }}
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Run check:types
|
||||||
|
run: pnpm turbo run check:types --affected
|
||||||
@@ -0,0 +1,112 @@
|
|||||||
|
node_modules
|
||||||
|
.next
|
||||||
|
.yarn
|
||||||
|
|
||||||
|
### NextJS ###
|
||||||
|
# Dependencies
|
||||||
|
/node_modules
|
||||||
|
/.pnp
|
||||||
|
.pnp.js
|
||||||
|
|
||||||
|
# Testing
|
||||||
|
/coverage
|
||||||
|
|
||||||
|
# Next.js
|
||||||
|
/.next/
|
||||||
|
/out/
|
||||||
|
|
||||||
|
# Production
|
||||||
|
dist/
|
||||||
|
out/
|
||||||
|
build/
|
||||||
|
.react-router/
|
||||||
|
|
||||||
|
# Misc
|
||||||
|
.DS_Store
|
||||||
|
*.pem
|
||||||
|
.history
|
||||||
|
tsconfig.tsbuildinfo
|
||||||
|
|
||||||
|
# Debug
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
.pnpm-debug.log*
|
||||||
|
|
||||||
|
# Local env files
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.development.local
|
||||||
|
.env.test.local
|
||||||
|
.env.production.local
|
||||||
|
|
||||||
|
# Vercel
|
||||||
|
.vercel
|
||||||
|
|
||||||
|
# Turborepo
|
||||||
|
.turbo
|
||||||
|
|
||||||
|
## Django ##
|
||||||
|
venv
|
||||||
|
.venv
|
||||||
|
*.pyc
|
||||||
|
staticfiles
|
||||||
|
mediafiles
|
||||||
|
.env
|
||||||
|
.DS_Store
|
||||||
|
logs/
|
||||||
|
htmlcov/
|
||||||
|
.coverage
|
||||||
|
|
||||||
|
node_modules/
|
||||||
|
assets/dist/
|
||||||
|
npm-debug.log
|
||||||
|
yarn-error.log
|
||||||
|
pnpm-debug.log
|
||||||
|
|
||||||
|
# Editor directories and files
|
||||||
|
.idea
|
||||||
|
*.suo
|
||||||
|
*.ntvs*
|
||||||
|
*.njsproj
|
||||||
|
*.sln
|
||||||
|
package-lock.json
|
||||||
|
.vscode
|
||||||
|
|
||||||
|
# Sentry
|
||||||
|
.sentryclirc
|
||||||
|
|
||||||
|
# lock files
|
||||||
|
package-lock.json
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
.secrets
|
||||||
|
tmp/
|
||||||
|
|
||||||
|
## packages
|
||||||
|
dist
|
||||||
|
.temp/
|
||||||
|
deploy/selfhost/plane-app/
|
||||||
|
|
||||||
|
## Storybook
|
||||||
|
*storybook.log
|
||||||
|
output.css
|
||||||
|
|
||||||
|
dev-editor
|
||||||
|
# Redis
|
||||||
|
*.rdb
|
||||||
|
*.rdb.gz
|
||||||
|
|
||||||
|
storybook-static
|
||||||
|
|
||||||
|
CLAUDE.md
|
||||||
|
|
||||||
|
build/
|
||||||
|
.react-router/
|
||||||
|
|
||||||
|
build/
|
||||||
|
.react-router/
|
||||||
|
temp/
|
||||||
|
scripts/
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
pnpm lint-staged
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
{ pkgs, ... }: {
|
||||||
|
|
||||||
|
# Which nixpkgs channel to use.
|
||||||
|
channel = "stable-23.11"; # or "unstable"
|
||||||
|
|
||||||
|
# Use https://search.nixos.org/packages to find packages
|
||||||
|
packages = [
|
||||||
|
pkgs.nodejs_20
|
||||||
|
pkgs.python3
|
||||||
|
];
|
||||||
|
|
||||||
|
services.docker.enable = true;
|
||||||
|
services.postgres.enable = true;
|
||||||
|
services.redis.enable = true;
|
||||||
|
|
||||||
|
}
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
[tools]
|
||||||
|
node = "22.18.0"
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
# ------------------------------
|
||||||
|
# Core Workspace Behavior
|
||||||
|
# ------------------------------
|
||||||
|
|
||||||
|
# Always prefer using local workspace packages when available
|
||||||
|
prefer-workspace-packages = true
|
||||||
|
|
||||||
|
# Symlink workspace packages instead of duplicating them
|
||||||
|
link-workspace-packages = true
|
||||||
|
|
||||||
|
# Use a single lockfile across the whole monorepo
|
||||||
|
shared-workspace-lockfile = true
|
||||||
|
|
||||||
|
# Ensure packages added from workspace save using workspace: protocol
|
||||||
|
save-workspace-protocol = true
|
||||||
|
|
||||||
|
|
||||||
|
# ------------------------------
|
||||||
|
# Dependency Resolution
|
||||||
|
# ------------------------------
|
||||||
|
|
||||||
|
# Choose the highest compatible version across the workspace
|
||||||
|
# → reduces fragmentation & node_modules bloat
|
||||||
|
resolution-mode = highest
|
||||||
|
|
||||||
|
# Automatically install peer dependencies instead of forcing every package to declare them
|
||||||
|
auto-install-peers = true
|
||||||
|
|
||||||
|
# Don't break the install if peers are missing
|
||||||
|
strict-peer-dependencies = false
|
||||||
|
|
||||||
|
|
||||||
|
# ------------------------------
|
||||||
|
# Performance Optimizations
|
||||||
|
# ------------------------------
|
||||||
|
|
||||||
|
# Use cached artifacts for native modules (sharp, esbuild, etc.)
|
||||||
|
side-effects-cache = true
|
||||||
|
|
||||||
|
# Prefer local cached packages rather than hitting network
|
||||||
|
prefer-offline = true
|
||||||
|
|
||||||
|
# In CI, refuse to modify lockfile (prevents drift)
|
||||||
|
prefer-frozen-lockfile = true
|
||||||
|
|
||||||
|
# Use isolated linker (best compatibility with Node ecosystem tools)
|
||||||
|
node-linker = isolated
|
||||||
|
|
||||||
|
# Hoist commonly used tools to the root to prevent duplicates and speed up resolution
|
||||||
|
public-hoist-pattern[] = typescript
|
||||||
|
public-hoist-pattern[] = eslint
|
||||||
|
public-hoist-pattern[] = *@plane/*
|
||||||
|
public-hoist-pattern[] = vite
|
||||||
|
public-hoist-pattern[] = turbo
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"printWidth": 120,
|
||||||
|
"tabWidth": 2,
|
||||||
|
"trailingComma": "es5",
|
||||||
|
"sortTailwindcss": {
|
||||||
|
"stylesheet": "packages/tailwind-config/index.css",
|
||||||
|
"functions": ["cn", "clsx", "cva"]
|
||||||
|
},
|
||||||
|
"overrides": [
|
||||||
|
{
|
||||||
|
"files": ["packages/codemods/**/*"],
|
||||||
|
"options": {
|
||||||
|
"printWidth": 80
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
{
|
||||||
|
"$schema": "./node_modules/oxlint/configuration_schema.json",
|
||||||
|
"plugins": ["react", "typescript", "jsx-a11y", "import", "promise", "unicorn", "oxc"],
|
||||||
|
"categories": {
|
||||||
|
"correctness": "warn",
|
||||||
|
"suspicious": "warn",
|
||||||
|
"perf": "warn"
|
||||||
|
},
|
||||||
|
"env": {
|
||||||
|
"browser": true,
|
||||||
|
"node": true,
|
||||||
|
"es2024": true
|
||||||
|
},
|
||||||
|
"settings": {
|
||||||
|
"react": {
|
||||||
|
"version": "18.3"
|
||||||
|
},
|
||||||
|
"jsx-a11y": {
|
||||||
|
"polymorphicPropName": "as"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"ignorePatterns": [
|
||||||
|
".cache/**",
|
||||||
|
".next/**",
|
||||||
|
".react-router/**",
|
||||||
|
".storybook/**",
|
||||||
|
".turbo/**",
|
||||||
|
".vite/**",
|
||||||
|
"*.config.{js,mjs,cjs,ts}",
|
||||||
|
"build/**",
|
||||||
|
"coverage/**",
|
||||||
|
"dist/**",
|
||||||
|
"**/public/**",
|
||||||
|
"storybook-static/**"
|
||||||
|
],
|
||||||
|
"rules": {
|
||||||
|
"react/react-in-jsx-scope": "off",
|
||||||
|
"react/prop-types": "off",
|
||||||
|
"unicorn/filename-case": "off",
|
||||||
|
"unicorn/no-null": "off",
|
||||||
|
"unicorn/prevent-abbreviations": "off",
|
||||||
|
"no-unused-vars": [
|
||||||
|
"warn",
|
||||||
|
{
|
||||||
|
"argsIgnorePattern": "^_",
|
||||||
|
"varsIgnorePattern": "^_",
|
||||||
|
"caughtErrorsIgnorePattern": "^_",
|
||||||
|
"destructuredArrayIgnorePattern": "^_",
|
||||||
|
"ignoreRestSiblings": true
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
.next/
|
||||||
|
.react-router/
|
||||||
|
.turbo/
|
||||||
|
.vite/
|
||||||
|
build/
|
||||||
|
dist/
|
||||||
|
node_modules/
|
||||||
|
out/
|
||||||
|
pnpm-lock.yaml
|
||||||
|
storybook-static/
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# Agent Development Guide
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
- `pnpm dev` - Start all dev servers (web:3000, admin:3001)
|
||||||
|
- `pnpm build` - Build all packages and apps
|
||||||
|
- `pnpm check` - Run all checks (format, lint, types)
|
||||||
|
- `pnpm check:lint` - OxLint across all packages
|
||||||
|
- `pnpm check:types` - TypeScript type checking
|
||||||
|
- `pnpm fix` - Auto-fix format and lint issues
|
||||||
|
- `pnpm turbo run <command> --filter=<package>` - Target specific package/app
|
||||||
|
- `pnpm --filter=@plane/ui storybook` - Start Storybook on port 6006
|
||||||
|
|
||||||
|
## Code Style
|
||||||
|
|
||||||
|
- **Imports**: Use `workspace:*` for internal packages, `catalog:` for external deps
|
||||||
|
- **TypeScript**: Strict mode enabled, all files must be typed
|
||||||
|
- **Formatting**: oxfmt, run `pnpm fix:format`
|
||||||
|
- **Linting**: OxLint with shared `.oxlintrc.json` config
|
||||||
|
- **Naming**: camelCase for variables/functions, PascalCase for components/types
|
||||||
|
- **Error Handling**: Use try-catch with proper error types, log errors appropriately
|
||||||
|
- **State Management**: MobX stores in `packages/shared-state`, reactive patterns
|
||||||
|
- **Testing**: All features require unit tests, use existing test framework per package
|
||||||
|
- **Components**: Build in `@plane/ui` with Storybook for isolated development
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
eslint.config.mjs @lifeiscontent
|
||||||
@@ -0,0 +1,128 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity
|
||||||
|
and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
- Demonstrating empathy and kindness toward other people
|
||||||
|
- Being respectful of differing opinions, viewpoints, and experiences
|
||||||
|
- Giving and gracefully accepting constructive feedback
|
||||||
|
- Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
|
and learning from the experience
|
||||||
|
- Focusing on what is best not just for us as individuals, but for the
|
||||||
|
overall community
|
||||||
|
|
||||||
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
|
- The use of sexualized language or imagery, and sexual attention or
|
||||||
|
advances of any kind
|
||||||
|
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
|
- Public or private harassment
|
||||||
|
- Publishing others' private information, such as a physical or email
|
||||||
|
address, without their explicit permission
|
||||||
|
- Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official e-mail address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement at
|
||||||
|
squawk@plane.so.
|
||||||
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series
|
||||||
|
of actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or
|
||||||
|
permanent ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.0, available at
|
||||||
|
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||||
|
enforcement ladder](https://github.com/mozilla/diversity).
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
https://www.contributor-covenant.org/faq. Translations are available at
|
||||||
|
https://www.contributor-covenant.org/translations.
|
||||||
@@ -0,0 +1,247 @@
|
|||||||
|
# Contributing to Plane
|
||||||
|
|
||||||
|
Thank you for showing an interest in contributing to Plane! All kinds of contributions are valuable to us. In this guide, we will cover how you can quickly onboard and make your first contribution.
|
||||||
|
|
||||||
|
## Submitting an issue
|
||||||
|
|
||||||
|
Before submitting a new issue, please search the [issues](https://github.com/makeplane/plane/issues) tab. Maybe an issue or discussion already exists and might inform you of workarounds. Otherwise, you can give new information.
|
||||||
|
|
||||||
|
While we want to fix all the [issues](https://github.com/makeplane/plane/issues), before fixing a bug we need to be able to reproduce and confirm it. Please provide us with a minimal reproduction scenario using a repository or [Gist](https://gist.github.com/). Having a live, reproducible scenario gives us the information without asking questions back & forth with additional questions like:
|
||||||
|
|
||||||
|
- 3rd-party libraries being used and their versions
|
||||||
|
- a use-case that fails
|
||||||
|
|
||||||
|
Without said minimal reproduction, we won't be able to investigate all [issues](https://github.com/makeplane/plane/issues), and the issue might not be resolved.
|
||||||
|
|
||||||
|
You can open a new issue with this [issue form](https://github.com/makeplane/plane/issues/new).
|
||||||
|
|
||||||
|
### Naming conventions for issues
|
||||||
|
|
||||||
|
When opening a new issue, please use a clear and concise title that follows this format:
|
||||||
|
|
||||||
|
- For bugs: `🐛 Bug: [short description]`
|
||||||
|
- For features: `🚀 Feature: [short description]`
|
||||||
|
- For improvements: `🛠️ Improvement: [short description]`
|
||||||
|
- For documentation: `📘 Docs: [short description]`
|
||||||
|
|
||||||
|
**Examples:**
|
||||||
|
|
||||||
|
- `🐛 Bug: API token expiry time not saving correctly`
|
||||||
|
- `📘 Docs: Clarify RAM requirement for local setup`
|
||||||
|
- `🚀 Feature: Allow custom time selection for token expiration`
|
||||||
|
|
||||||
|
This helps us triage and manage issues more efficiently.
|
||||||
|
|
||||||
|
## Projects setup and Architecture
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
- Docker Engine installed and running
|
||||||
|
- Node.js version 20+ [LTS version](https://nodejs.org/en/about/previous-releases)
|
||||||
|
- Python version 3.8+
|
||||||
|
- Postgres version v14
|
||||||
|
- Redis version v6.2.7
|
||||||
|
- **Memory**: Minimum **12 GB RAM** recommended
|
||||||
|
> ⚠️ Running the project on a system with only 8 GB RAM may lead to setup failures or memory crashes (especially during Docker container build/start or dependency install). Use cloud environments like GitHub Codespaces or upgrade local RAM if possible.
|
||||||
|
|
||||||
|
### Setup the project
|
||||||
|
|
||||||
|
The project is a monorepo, with backend api and frontend in a single repo.
|
||||||
|
|
||||||
|
The backend is a django project which is kept inside apps/api
|
||||||
|
|
||||||
|
1. Clone the repo
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/makeplane/plane.git [folder-name]
|
||||||
|
cd [folder-name]
|
||||||
|
chmod +x setup.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Run setup.sh
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./setup.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Start the containers
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose -f docker-compose-local.yml up
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Start web apps:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm dev
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Open your browser to http://localhost:3001/god-mode/ and register yourself as instance admin
|
||||||
|
6. Open up your browser to http://localhost:3000 then log in using the same credentials from the previous step
|
||||||
|
|
||||||
|
That’s it! You’re all set to begin coding. Remember to refresh your browser if changes don’t auto-reload. Happy contributing! 🎉
|
||||||
|
|
||||||
|
## Missing a Feature?
|
||||||
|
|
||||||
|
If a feature is missing, you can directly _request_ a new one [here](https://github.com/makeplane/plane/issues/new?assignees=&labels=feature&template=feature_request.yml&title=%F0%9F%9A%80+Feature%3A+). You also can do the same by choosing "🚀 Feature" when raising a [New Issue](https://github.com/makeplane/plane/issues/new/choose) on our GitHub Repository.
|
||||||
|
If you would like to _implement_ it, an issue with your proposal must be submitted first, to be sure that we can use it. Please consider the guidelines given below.
|
||||||
|
|
||||||
|
## Coding guidelines
|
||||||
|
|
||||||
|
To ensure consistency throughout the source code, please keep these rules in mind as you are working:
|
||||||
|
|
||||||
|
- All features or bug fixes must be tested by one or more specs (unit-tests).
|
||||||
|
- We lint with [OxLint](https://oxc.rs/docs/guide/usage/linter) using the shared `.oxlintrc.json` and format with [oxfmt](https://oxc.rs/docs/guide/usage/formatter) using `.oxfmtrc.json`.
|
||||||
|
|
||||||
|
## Ways to contribute
|
||||||
|
|
||||||
|
- Try Plane Cloud and the self hosting platform and give feedback
|
||||||
|
- Add new integrations
|
||||||
|
- Add or update translations
|
||||||
|
- Help with open [issues](https://github.com/makeplane/plane/issues) or [create your own](https://github.com/makeplane/plane/issues/new/choose)
|
||||||
|
- Share your thoughts and suggestions with us
|
||||||
|
- Help create tutorials and blog posts
|
||||||
|
- Request a feature by submitting a proposal
|
||||||
|
- Report a bug
|
||||||
|
- **Improve documentation** - fix incomplete or missing [docs](https://docs.plane.so/), bad wording, examples or explanations.
|
||||||
|
|
||||||
|
## Contributing to language support
|
||||||
|
|
||||||
|
This guide is designed to help contributors understand how to add or update translations in the application.
|
||||||
|
|
||||||
|
### Understanding translation structure
|
||||||
|
|
||||||
|
#### File organization
|
||||||
|
|
||||||
|
Translations are organized by language in the locales directory. Each language has its own folder containing JSON files for translations. Here's how it looks:
|
||||||
|
|
||||||
|
```
|
||||||
|
packages/i18n/src/locales/
|
||||||
|
├── en/
|
||||||
|
│ ├── core.json # Critical translations
|
||||||
|
│ └── translations.json
|
||||||
|
├── fr/
|
||||||
|
│ └── translations.json
|
||||||
|
└── [language]/
|
||||||
|
└── translations.json
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Nested structure
|
||||||
|
|
||||||
|
To keep translations organized, we use a nested structure for keys. This makes it easier to manage and locate specific translations. For example:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"issue": {
|
||||||
|
"label": "Work item",
|
||||||
|
"title": {
|
||||||
|
"label": "Work item title"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Translation formatting guide
|
||||||
|
|
||||||
|
We use [IntlMessageFormat](https://formatjs.github.io/docs/intl-messageformat/) to handle dynamic content, such as variables and pluralization. Here's how to format your translations:
|
||||||
|
|
||||||
|
#### Examples
|
||||||
|
|
||||||
|
- **Simple variables**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"greeting": "Hello, {name}!"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Pluralization**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"items": "{count, plural, one {Work item} other {Work items}}"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Contributing guidelines
|
||||||
|
|
||||||
|
#### Updating existing translations
|
||||||
|
|
||||||
|
1. Locate the key in `locales/<language>/translations.json`.
|
||||||
|
|
||||||
|
2. Update the value while ensuring the key structure remains intact.
|
||||||
|
3. Preserve any existing ICU formats (e.g., variables, pluralization).
|
||||||
|
|
||||||
|
#### Adding new translation keys
|
||||||
|
|
||||||
|
1. When introducing a new key, ensure it is added to **all** language files, even if translations are not immediately available. Use English as a placeholder if needed.
|
||||||
|
|
||||||
|
2. Keep the nesting structure consistent across all languages.
|
||||||
|
|
||||||
|
3. If the new key requires dynamic content (e.g., variables or pluralization), ensure the ICU format is applied uniformly across all languages.
|
||||||
|
|
||||||
|
### Adding new languages
|
||||||
|
|
||||||
|
Adding a new language involves several steps to ensure it integrates seamlessly with the project. Follow these instructions carefully:
|
||||||
|
|
||||||
|
1. **Update type definitions**
|
||||||
|
Add the new language to the TLanguage type in the language definitions file:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// packages/i18n/src/types/language.ts
|
||||||
|
export type TLanguage = "en" | "fr" | "your-lang";
|
||||||
|
```
|
||||||
|
|
||||||
|
1. **Add language configuration**
|
||||||
|
Include the new language in the list of supported languages:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// packages/i18n/src/constants/language.ts
|
||||||
|
export const SUPPORTED_LANGUAGES: ILanguageOption[] = [
|
||||||
|
{ label: "English", value: "en" },
|
||||||
|
{ label: "Your Language", value: "your-lang" },
|
||||||
|
];
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Create translation files**
|
||||||
|
1. Create a new folder for your language under locales (e.g., `locales/your-lang/`).
|
||||||
|
|
||||||
|
2. Add a `translations.json` file inside the folder.
|
||||||
|
|
||||||
|
3. Copy the structure from an existing translation file and translate all keys.
|
||||||
|
|
||||||
|
3. **Update import logic**
|
||||||
|
Modify the language import logic to include your new language:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
private importLanguageFile(language: TLanguage): Promise<any> {
|
||||||
|
switch (language) {
|
||||||
|
case "your-lang":
|
||||||
|
return import("../locales/your-lang/translations.json");
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Quality checklist
|
||||||
|
|
||||||
|
Before submitting your contribution, please ensure the following:
|
||||||
|
|
||||||
|
- All translation keys exist in every language file.
|
||||||
|
- Nested structures match across all language files.
|
||||||
|
- ICU message formats are correctly implemented.
|
||||||
|
- All languages load without errors in the application.
|
||||||
|
- Dynamic values and pluralization work as expected.
|
||||||
|
- There are no missing or untranslated keys.
|
||||||
|
|
||||||
|
#### Pro tips
|
||||||
|
|
||||||
|
- When in doubt, refer to the English translations for context.
|
||||||
|
- Verify pluralization works with different numbers.
|
||||||
|
- Ensure dynamic values (e.g., `{name}`) are correctly interpolated.
|
||||||
|
- Double-check that nested key access paths are accurate.
|
||||||
|
|
||||||
|
Happy translating! 🌍✨
|
||||||
|
|
||||||
|
## Need help? Questions and suggestions
|
||||||
|
|
||||||
|
Questions, suggestions, and thoughts are most welcome. We can also be reached in our [Forum](https://forum.plane.so).
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
See the LICENSE file for details.
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
## Copyright check
|
||||||
|
|
||||||
|
To verify that all tracked Python files contain the correct copyright header for **Plane Software Inc.** for the year **2023**, run this command from the repository root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
addlicense --check -f COPYRIGHT.txt -ignore "**/migrations/**" $(git ls-files '*.py')
|
||||||
|
```
|
||||||
|
|
||||||
|
#### To Apply Changes
|
||||||
|
|
||||||
|
python files
|
||||||
|
|
||||||
|
```bash
|
||||||
|
addlicense -v -f COPYRIGHT.txt -ignore "**/migrations/**" $(git ls-files '*.py')
|
||||||
|
```
|
||||||
|
|
||||||
|
ts and tsx files in a specific app
|
||||||
|
|
||||||
|
```bash
|
||||||
|
addlicense -v -f COPYRIGHT.txt \
|
||||||
|
-ignore "**/*.config.ts" \
|
||||||
|
-ignore "**/*.d.ts" \
|
||||||
|
$(git ls-files 'packages/*.ts')
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: Please make sure ts command is running on specific folder, running it for the whole mono repo is crashing os processes.
|
||||||
|
|
||||||
|
#### Other Options
|
||||||
|
|
||||||
|
- **`addlicense -check`**: runs in check-only mode and fails if any file is missing or has an incorrect header.
|
||||||
|
- **`-c "Plane Software Inc."`**: sets the copyright holder.
|
||||||
|
- **`-f LICENSE.txt`**: uses the contents and format defined in `LICENSE.txt` as the header template.
|
||||||
|
- **`-y 2023`**: sets the year in the header.
|
||||||
|
- **`$(git ls-files '*.py')`**: restricts the check to Python files tracked in git.
|
||||||
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
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.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <name of author>
|
||||||
|
|
||||||
|
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 <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
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
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
@@ -0,0 +1,165 @@
|
|||||||
|
<br /><br />
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://plane.so">
|
||||||
|
<img src="https://media.docs.plane.so/logo/plane_github_readme.png" alt="Plane Logo" width="400">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
<p align="center"><b>Modern project management for all teams</b></p>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://plane.so/"><b>Website</b></a> •
|
||||||
|
<a href="https://forum.plane.so"><b>Forum</b></a> •
|
||||||
|
<a href="https://twitter.com/planepowers"><b>Twitter</b></a> •
|
||||||
|
<a href="https://docs.plane.so/"><b>Documentation</b></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a href="https://app.plane.so/#gh-light-mode-only" target="_blank">
|
||||||
|
<img
|
||||||
|
src="https://media.docs.plane.so/GitHub-readme/github-top.webp"
|
||||||
|
alt="Plane Screens"
|
||||||
|
width="100%"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
Meet [Plane](https://plane.so/), an open-source project management tool to track issues, run ~sprints~ cycles, and manage product roadmaps without the chaos of managing the tool itself. 🧘♀️
|
||||||
|
|
||||||
|
> Plane is evolving every day. Your suggestions, ideas, and reported bugs help us immensely. Do not hesitate to join in the conversation on [Forum](https://forum.plane.so) or raise a GitHub issue. We read everything and respond to most.
|
||||||
|
|
||||||
|
## 🚀 Installation
|
||||||
|
|
||||||
|
Getting started with Plane is simple. Choose the setup that works best for you:
|
||||||
|
|
||||||
|
- **Plane Cloud**
|
||||||
|
Sign up for a free account on [Plane Cloud](https://app.plane.so)—it's the fastest way to get up and running without worrying about infrastructure.
|
||||||
|
|
||||||
|
- **Self-host Plane**
|
||||||
|
Prefer full control over your data and infrastructure? Install and run Plane on your own servers. Follow our detailed [deployment guides](https://developers.plane.so/self-hosting/overview) to get started.
|
||||||
|
|
||||||
|
| Installation methods | Docs link |
|
||||||
|
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Docker | [](https://developers.plane.so/self-hosting/methods/docker-compose) |
|
||||||
|
| Kubernetes | [](https://developers.plane.so/self-hosting/methods/kubernetes) |
|
||||||
|
|
||||||
|
`Instance admins` can configure instance settings with [God mode](https://developers.plane.so/self-hosting/govern/instance-admin).
|
||||||
|
|
||||||
|
## 🌟 Features
|
||||||
|
|
||||||
|
- **Work Items**
|
||||||
|
Efficiently create and manage tasks with a robust rich text editor that supports file uploads. Enhance organization and tracking by adding sub-properties and referencing related issues.
|
||||||
|
|
||||||
|
- **Cycles**
|
||||||
|
Maintain your team’s momentum with Cycles. Track progress effortlessly using burn-down charts and other insightful tools.
|
||||||
|
|
||||||
|
- **Modules**
|
||||||
|
Simplify complex projects by dividing them into smaller, manageable modules.
|
||||||
|
|
||||||
|
- **Views**
|
||||||
|
Customize your workflow by creating filters to display only the most relevant issues. Save and share these views with ease.
|
||||||
|
|
||||||
|
- **Pages**
|
||||||
|
Capture and organize ideas using Plane Pages, complete with AI capabilities and a rich text editor. Format text, insert images, add hyperlinks, or convert your notes into actionable items.
|
||||||
|
|
||||||
|
- **Analytics**
|
||||||
|
Access real-time insights across all your Plane data. Visualize trends, remove blockers, and keep your projects moving forward.
|
||||||
|
|
||||||
|
## 🛠️ Local development
|
||||||
|
|
||||||
|
See [CONTRIBUTING](./CONTRIBUTING.md)
|
||||||
|
|
||||||
|
## ⚙️ Built with
|
||||||
|
|
||||||
|
[](https://reactrouter.com/)
|
||||||
|
[](https://www.djangoproject.com/)
|
||||||
|
[](https://nodejs.org/en)
|
||||||
|
|
||||||
|
## 📸 Screenshots
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a href="https://plane.so" target="_blank">
|
||||||
|
<img
|
||||||
|
src="https://media.docs.plane.so/GitHub-readme/github-work-items.webp"
|
||||||
|
alt="Plane Views"
|
||||||
|
width="100%"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<a href="https://plane.so" target="_blank">
|
||||||
|
<img
|
||||||
|
src="https://media.docs.plane.so/GitHub-readme/github-cycles.webp"
|
||||||
|
width="100%"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<a href="https://plane.so" target="_blank">
|
||||||
|
<img
|
||||||
|
src="https://media.docs.plane.so/GitHub-readme/github-modules.webp"
|
||||||
|
alt="Plane Cycles and Modules"
|
||||||
|
width="100%"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<a href="https://plane.so" target="_blank">
|
||||||
|
<img
|
||||||
|
src="https://media.docs.plane.so/GitHub-readme/github-views.webp"
|
||||||
|
alt="Plane Analytics"
|
||||||
|
width="100%"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<a href="https://plane.so" target="_blank">
|
||||||
|
<img
|
||||||
|
src="https://media.docs.plane.so/GitHub-readme/github-analytics.webp"
|
||||||
|
alt="Plane Pages"
|
||||||
|
width="100%"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## 📝 Documentation
|
||||||
|
|
||||||
|
Explore Plane's [product documentation](https://docs.plane.so/) and [developer documentation](https://developers.plane.so/) to learn about features, setup, and usage.
|
||||||
|
|
||||||
|
## ❤️ Community
|
||||||
|
|
||||||
|
Join the Plane community on [GitHub Discussions](https://github.com/orgs/makeplane/discussions) and our [Forum](https://forum.plane.so). We follow a [Code of conduct](https://github.com/makeplane/plane/blob/master/CODE_OF_CONDUCT.md) in all our community channels.
|
||||||
|
|
||||||
|
Feel free to ask questions, report bugs, participate in discussions, share ideas, request features, or showcase your projects. We’d love to hear from you!
|
||||||
|
|
||||||
|
## 🛡️ Security
|
||||||
|
|
||||||
|
If you discover a security vulnerability in Plane, please report it responsibly instead of opening a public issue. We take all legitimate reports seriously and will investigate them promptly. See [Security policy](https://github.com/makeplane/plane/blob/master/SECURITY.md) for more info.
|
||||||
|
|
||||||
|
To disclose any security issues, please email us at security@plane.so.
|
||||||
|
|
||||||
|
## 🤝 Contributing
|
||||||
|
|
||||||
|
There are many ways you can contribute to Plane:
|
||||||
|
|
||||||
|
- Report [bugs](https://github.com/makeplane/plane/issues/new?assignees=srinivaspendem%2Cpushya22&labels=%F0%9F%90%9Bbug&projects=&template=--bug-report.yaml&title=%5Bbug%5D%3A+) or submit [feature requests](https://github.com/makeplane/plane/issues/new?assignees=srinivaspendem%2Cpushya22&labels=%E2%9C%A8feature&projects=&template=--feature-request.yaml&title=%5Bfeature%5D%3A+).
|
||||||
|
- Review the [documentation](https://docs.plane.so/) and submit [pull requests](https://github.com/makeplane/docs) to improve it—whether it's fixing typos or adding new content.
|
||||||
|
- Talk or write about Plane or any other ecosystem integration and [let us know](https://forum.plane.so)!
|
||||||
|
- Show your support by upvoting [popular feature requests](https://github.com/makeplane/plane/issues).
|
||||||
|
|
||||||
|
Please read [CONTRIBUTING.md](https://github.com/makeplane/plane/blob/master/CONTRIBUTING.md) for details on the process for submitting pull requests to us.
|
||||||
|
|
||||||
|
### Repo activity
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### We couldn't have done this without you.
|
||||||
|
|
||||||
|
<a href="https://github.com/makeplane/plane/graphs/contributors">
|
||||||
|
<img src="https://contrib.rocks/image?repo=makeplane/plane" />
|
||||||
|
</a>
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the [GNU Affero General Public License v3.0](https://github.com/makeplane/plane/blob/master/LICENSE.txt).
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
# Security policy
|
||||||
|
This document outlines the security protocols and vulnerability reporting guidelines for the Plane project. Ensuring the security of our systems is a top priority, and while we work diligently to maintain robust protection, vulnerabilities may still occur. We highly value the community’s role in identifying and reporting security concerns to uphold the integrity of our systems and safeguard our users.
|
||||||
|
|
||||||
|
## Reporting a vulnerability
|
||||||
|
If you have identified a security vulnerability, submit your findings to [security@plane.so](mailto:security@plane.so).
|
||||||
|
Ensure your report includes all relevant information needed for us to reproduce and assess the issue. Include the IP address or URL of the affected system.
|
||||||
|
|
||||||
|
To ensure a responsible and effective disclosure process, please adhere to the following:
|
||||||
|
|
||||||
|
- Maintain confidentiality and refrain from publicly disclosing the vulnerability until we have had the opportunity to investigate and address the issue.
|
||||||
|
- Refrain from running automated vulnerability scans on our infrastructure or dashboard without prior consent. Contact us to set up a sandbox environment if necessary.
|
||||||
|
- Do not exploit any discovered vulnerabilities for malicious purposes, such as accessing or altering user data.
|
||||||
|
- Do not engage in physical security attacks, social engineering, distributed denial of service (DDoS) attacks, spam campaigns, or attacks on third-party applications as part of your vulnerability testing.
|
||||||
|
|
||||||
|
## Out of scope
|
||||||
|
While we appreciate all efforts to assist in improving our security, please note that the following types of vulnerabilities are considered out of scope:
|
||||||
|
|
||||||
|
- Vulnerabilities requiring man-in-the-middle (MITM) attacks or physical access to a user’s device.
|
||||||
|
- Content spoofing or text injection issues without a clear attack vector or the ability to modify HTML/CSS.
|
||||||
|
- Issues related to email spoofing.
|
||||||
|
- Missing DNSSEC, CAA, or CSP headers.
|
||||||
|
- Absence of secure or HTTP-only flags on non-sensitive cookies.
|
||||||
|
|
||||||
|
## Our commitment
|
||||||
|
|
||||||
|
At Plane, we are committed to maintaining transparent and collaborative communication throughout the vulnerability resolution process. Here's what you can expect from us:
|
||||||
|
|
||||||
|
- **Response Time** <br/>
|
||||||
|
We will acknowledge receipt of your vulnerability report within three business days and provide an estimated timeline for resolution.
|
||||||
|
- **Legal Protection** <br/>
|
||||||
|
We will not initiate legal action against you for reporting vulnerabilities, provided you adhere to the reporting guidelines.
|
||||||
|
- **Confidentiality** <br/>
|
||||||
|
Your report will be treated with confidentiality. We will not disclose your personal information to third parties without your consent.
|
||||||
|
- **Recognition** <br/>
|
||||||
|
With your permission, we are happy to publicly acknowledge your contribution to improving our security once the issue is resolved.
|
||||||
|
- **Timely Resolution** <br/>
|
||||||
|
We are committed to working closely with you throughout the resolution process, providing timely updates as necessary. Our goal is to address all reported vulnerabilities swiftly, and we will actively engage with you to coordinate a responsible disclosure once the issue is fully resolved.
|
||||||
|
|
||||||
|
We appreciate your help in ensuring the security of our platform. Your contributions are crucial to protecting our users and maintaining a secure environment. Thank you for working with us to keep Plane safe.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# React Router - https://github.com/remix-run/react-router-templates/blob/dc79b1a065f59f3bfd840d4ef75cc27689b611e6/default/.dockerignore
|
||||||
|
.react-router/
|
||||||
|
build/
|
||||||
|
node_modules/
|
||||||
|
README.md
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
VITE_API_BASE_URL="http://localhost:8000"
|
||||||
|
|
||||||
|
VITE_WEB_BASE_URL="http://localhost:3000"
|
||||||
|
|
||||||
|
VITE_ADMIN_BASE_URL="http://localhost:3001"
|
||||||
|
VITE_ADMIN_BASE_PATH="/god-mode"
|
||||||
|
|
||||||
|
VITE_SPACE_BASE_URL="http://localhost:3002"
|
||||||
|
VITE_SPACE_BASE_PATH="/spaces"
|
||||||
|
|
||||||
|
VITE_LIVE_BASE_URL="http://localhost:3100"
|
||||||
|
VITE_LIVE_BASE_PATH="/live"
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
.next/
|
||||||
|
.react-router/
|
||||||
|
.turbo/
|
||||||
|
.vite/
|
||||||
|
build/
|
||||||
|
dist/
|
||||||
|
node_modules/
|
||||||
|
out/
|
||||||
|
pnpm-lock.yaml
|
||||||
|
storybook-static/
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
FROM node:22-alpine AS base
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
ENV TURBO_TELEMETRY_DISABLED=1
|
||||||
|
ENV PNPM_HOME="/pnpm"
|
||||||
|
ENV PATH="$PNPM_HOME:$PATH"
|
||||||
|
ENV CI=1
|
||||||
|
|
||||||
|
RUN corepack enable pnpm
|
||||||
|
|
||||||
|
# =========================================================================== #
|
||||||
|
|
||||||
|
FROM base AS builder
|
||||||
|
|
||||||
|
RUN pnpm add -g turbo@2.9.4
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# Create a pruned workspace for just the admin app
|
||||||
|
RUN turbo prune --scope=admin --docker
|
||||||
|
|
||||||
|
# =========================================================================== #
|
||||||
|
|
||||||
|
FROM base AS installer
|
||||||
|
|
||||||
|
# Build in production mode; we still install dev deps explicitly below
|
||||||
|
ENV NODE_ENV=production
|
||||||
|
|
||||||
|
# Public envs required at build time (pick up via process.env)
|
||||||
|
ARG VITE_API_BASE_URL=""
|
||||||
|
ENV VITE_API_BASE_URL=$VITE_API_BASE_URL
|
||||||
|
ARG VITE_API_BASE_PATH="/api"
|
||||||
|
ENV VITE_API_BASE_PATH=$VITE_API_BASE_PATH
|
||||||
|
|
||||||
|
ARG VITE_ADMIN_BASE_URL=""
|
||||||
|
ENV VITE_ADMIN_BASE_URL=$VITE_ADMIN_BASE_URL
|
||||||
|
ARG VITE_ADMIN_BASE_PATH="/god-mode"
|
||||||
|
ENV VITE_ADMIN_BASE_PATH=$VITE_ADMIN_BASE_PATH
|
||||||
|
|
||||||
|
ARG VITE_SPACE_BASE_URL=""
|
||||||
|
ENV VITE_SPACE_BASE_URL=$VITE_SPACE_BASE_URL
|
||||||
|
ARG VITE_SPACE_BASE_PATH="/spaces"
|
||||||
|
ENV VITE_SPACE_BASE_PATH=$VITE_SPACE_BASE_PATH
|
||||||
|
|
||||||
|
ARG VITE_LIVE_BASE_URL=""
|
||||||
|
ENV VITE_LIVE_BASE_URL=$VITE_LIVE_BASE_URL
|
||||||
|
ARG VITE_LIVE_BASE_PATH="/live"
|
||||||
|
ENV VITE_LIVE_BASE_PATH=$VITE_LIVE_BASE_PATH
|
||||||
|
|
||||||
|
ARG VITE_WEB_BASE_URL=""
|
||||||
|
ENV VITE_WEB_BASE_URL=$VITE_WEB_BASE_URL
|
||||||
|
ARG VITE_WEB_BASE_PATH=""
|
||||||
|
ENV VITE_WEB_BASE_PATH=$VITE_WEB_BASE_PATH
|
||||||
|
|
||||||
|
ARG VITE_WEBSITE_URL="https://plane.so"
|
||||||
|
ENV VITE_WEBSITE_URL=$VITE_WEBSITE_URL
|
||||||
|
ARG VITE_SUPPORT_EMAIL="support@plane.so"
|
||||||
|
ENV VITE_SUPPORT_EMAIL=$VITE_SUPPORT_EMAIL
|
||||||
|
|
||||||
|
COPY .gitignore .gitignore
|
||||||
|
COPY --from=builder /app/out/json/ .
|
||||||
|
COPY --from=builder /app/out/pnpm-lock.yaml ./pnpm-lock.yaml
|
||||||
|
|
||||||
|
# Copy full directory structure before fetch to ensure all package.json files are available
|
||||||
|
COPY --from=builder /app/out/full/ .
|
||||||
|
COPY turbo.json turbo.json
|
||||||
|
|
||||||
|
# Fetch dependencies to cache store, then install offline with dev deps
|
||||||
|
RUN --mount=type=cache,id=pnpm-store,target=/pnpm/store pnpm fetch --store-dir=/pnpm/store
|
||||||
|
RUN --mount=type=cache,id=pnpm-store,target=/pnpm/store CI=true pnpm install --offline --frozen-lockfile --store-dir=/pnpm/store --prod=false
|
||||||
|
|
||||||
|
# Build only the admin package
|
||||||
|
RUN pnpm turbo run build --filter=admin
|
||||||
|
|
||||||
|
# =========================================================================== #
|
||||||
|
|
||||||
|
FROM nginx:1.29-alpine AS production
|
||||||
|
|
||||||
|
COPY apps/admin/nginx/nginx.conf /etc/nginx/nginx.conf
|
||||||
|
COPY --from=installer /app/apps/admin/build/client /usr/share/nginx/html/god-mode
|
||||||
|
|
||||||
|
EXPOSE 3000
|
||||||
|
|
||||||
|
HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \
|
||||||
|
CMD curl -fsS http://127.0.0.1:3000/ >/dev/null || exit 1
|
||||||
|
|
||||||
|
CMD ["nginx", "-g", "daemon off;"]
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
FROM node:22-alpine
|
||||||
|
RUN apk add --no-cache libc6-compat
|
||||||
|
# Set working directory
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
RUN corepack enable pnpm && pnpm add -g turbo
|
||||||
|
RUN pnpm install
|
||||||
|
|
||||||
|
ENV VITE_ADMIN_BASE_PATH="/god-mode"
|
||||||
|
|
||||||
|
EXPOSE 3000
|
||||||
|
|
||||||
|
VOLUME [ "/app/node_modules", "/app/admin/node_modules" ]
|
||||||
|
|
||||||
|
CMD ["pnpm", "dev", "--filter=admin"]
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useForm } from "react-hook-form";
|
||||||
|
import { Lightbulb } from "lucide-react";
|
||||||
|
import { Button } from "@plane/propel/button";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import type { IFormattedInstanceConfiguration, TInstanceAIConfigurationKeys } from "@plane/types";
|
||||||
|
// components
|
||||||
|
import type { TControllerInputFormField } from "@/components/common/controller-input";
|
||||||
|
import { ControllerInput } from "@/components/common/controller-input";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
|
||||||
|
type IInstanceAIForm = {
|
||||||
|
config: IFormattedInstanceConfiguration;
|
||||||
|
};
|
||||||
|
|
||||||
|
type AIFormValues = Record<TInstanceAIConfigurationKeys, string>;
|
||||||
|
|
||||||
|
export function InstanceAIForm(props: IInstanceAIForm) {
|
||||||
|
const { config } = props;
|
||||||
|
// store
|
||||||
|
const { updateInstanceConfigurations } = useInstance();
|
||||||
|
// form data
|
||||||
|
const {
|
||||||
|
handleSubmit,
|
||||||
|
control,
|
||||||
|
formState: { errors, isSubmitting },
|
||||||
|
} = useForm<AIFormValues>({
|
||||||
|
defaultValues: {
|
||||||
|
LLM_API_KEY: config["LLM_API_KEY"],
|
||||||
|
LLM_MODEL: config["LLM_MODEL"],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const aiFormFields: TControllerInputFormField[] = [
|
||||||
|
{
|
||||||
|
key: "LLM_MODEL",
|
||||||
|
type: "text",
|
||||||
|
label: "LLM Model",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Choose an OpenAI engine.{" "}
|
||||||
|
<a
|
||||||
|
href="https://platform.openai.com/docs/models/overview"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
Learn more
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "gpt-4o-mini",
|
||||||
|
error: Boolean(errors.LLM_MODEL),
|
||||||
|
required: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "LLM_API_KEY",
|
||||||
|
type: "password",
|
||||||
|
label: "API key",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
You will find your API key{" "}
|
||||||
|
<a
|
||||||
|
href="https://platform.openai.com/api-keys"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
here.
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "sk-asddassdfasdefqsdfasd23das3dasdcasd",
|
||||||
|
error: Boolean(errors.LLM_API_KEY),
|
||||||
|
required: false,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const onSubmit = async (formData: AIFormValues) => {
|
||||||
|
const payload: Partial<AIFormValues> = { ...formData };
|
||||||
|
|
||||||
|
await updateInstanceConfigurations(payload)
|
||||||
|
.then(() =>
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
title: "Success",
|
||||||
|
message: "AI Settings updated successfully",
|
||||||
|
})
|
||||||
|
)
|
||||||
|
.catch((err) => console.error(err));
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="space-y-8">
|
||||||
|
<div className="space-y-3">
|
||||||
|
<div>
|
||||||
|
<div className="pb-1 text-18 font-medium text-primary">OpenAI</div>
|
||||||
|
<div className="text-13 font-regular text-tertiary">If you use ChatGPT, this is for you.</div>
|
||||||
|
</div>
|
||||||
|
<div className="grid-col grid w-full grid-cols-1 items-center justify-between gap-x-12 gap-y-8 lg:grid-cols-3">
|
||||||
|
{aiFormFields.map((field) => (
|
||||||
|
<ControllerInput
|
||||||
|
key={field.key}
|
||||||
|
control={control}
|
||||||
|
type={field.type}
|
||||||
|
name={field.key}
|
||||||
|
label={field.label}
|
||||||
|
description={field.description}
|
||||||
|
placeholder={field.placeholder}
|
||||||
|
error={field.error}
|
||||||
|
required={field.required}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="flex flex-col items-start gap-4">
|
||||||
|
<Button variant="primary" size="lg" onClick={handleSubmit(onSubmit)} loading={isSubmitting}>
|
||||||
|
{isSubmitting ? "Saving" : "Save changes"}
|
||||||
|
</Button>
|
||||||
|
|
||||||
|
<div className="relative inline-flex items-center gap-1.5 rounded-sm border border-accent-subtle bg-accent-subtle px-4 py-2 text-caption-sm-regular text-accent-secondary">
|
||||||
|
<Lightbulb className="size-4" />
|
||||||
|
<div>
|
||||||
|
If you have a preferred AI models vendor, please get in{" "}
|
||||||
|
<a className="font-medium underline" href="https://plane.so/contact">
|
||||||
|
touch with us.
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import useSWR from "swr";
|
||||||
|
import { Loader } from "@plane/ui";
|
||||||
|
// components
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
// local
|
||||||
|
import { InstanceAIForm } from "./form";
|
||||||
|
|
||||||
|
const InstanceAIPage = observer(function InstanceAIPage(_props: Route.ComponentProps) {
|
||||||
|
// store
|
||||||
|
const { fetchInstanceConfigurations, formattedConfig } = useInstance();
|
||||||
|
|
||||||
|
useSWR("INSTANCE_CONFIGURATIONS", () => fetchInstanceConfigurations());
|
||||||
|
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
header={{
|
||||||
|
title: "AI features for all your workspaces",
|
||||||
|
description: "Configure your AI API credentials so Plane AI features are turned on for all your workspaces.",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{formattedConfig ? (
|
||||||
|
<InstanceAIForm config={formattedConfig} />
|
||||||
|
) : (
|
||||||
|
<Loader className="space-y-8">
|
||||||
|
<Loader.Item height="50px" width="40%" />
|
||||||
|
<div className="grid w-2/3 grid-cols-2 gap-x-8 gap-y-4">
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
</div>
|
||||||
|
<Loader.Item height="50px" width="20%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "Artificial Intelligence Settings - God Mode" }];
|
||||||
|
|
||||||
|
export default InstanceAIPage;
|
||||||
@@ -0,0 +1,225 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { isEmpty } from "lodash-es";
|
||||||
|
import Link from "next/link";
|
||||||
|
import { useForm } from "react-hook-form";
|
||||||
|
// plane internal packages
|
||||||
|
import { API_BASE_URL } from "@plane/constants";
|
||||||
|
import { Button, getButtonStyling } from "@plane/propel/button";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import type { IFormattedInstanceConfiguration, TInstanceGiteaAuthenticationConfigurationKeys } from "@plane/types";
|
||||||
|
// components
|
||||||
|
import { CodeBlock } from "@/components/common/code-block";
|
||||||
|
import { ConfirmDiscardModal } from "@/components/common/confirm-discard-modal";
|
||||||
|
import type { TControllerInputFormField } from "@/components/common/controller-input";
|
||||||
|
import { ControllerInput } from "@/components/common/controller-input";
|
||||||
|
import type { TControllerSwitchFormField } from "@/components/common/controller-switch";
|
||||||
|
import { ControllerSwitch } from "@/components/common/controller-switch";
|
||||||
|
import type { TCopyField } from "@/components/common/copy-field";
|
||||||
|
import { CopyField } from "@/components/common/copy-field";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
|
||||||
|
type Props = {
|
||||||
|
config: IFormattedInstanceConfiguration;
|
||||||
|
};
|
||||||
|
|
||||||
|
type GiteaConfigFormValues = Record<TInstanceGiteaAuthenticationConfigurationKeys, string>;
|
||||||
|
|
||||||
|
export function InstanceGiteaConfigForm(props: Props) {
|
||||||
|
const { config } = props;
|
||||||
|
// states
|
||||||
|
const [isDiscardChangesModalOpen, setIsDiscardChangesModalOpen] = useState(false);
|
||||||
|
// store hooks
|
||||||
|
const { updateInstanceConfigurations } = useInstance();
|
||||||
|
// form data
|
||||||
|
const {
|
||||||
|
handleSubmit,
|
||||||
|
control,
|
||||||
|
reset,
|
||||||
|
formState: { errors, isDirty, isSubmitting },
|
||||||
|
} = useForm<GiteaConfigFormValues>({
|
||||||
|
defaultValues: {
|
||||||
|
GITEA_HOST: config["GITEA_HOST"] || "https://gitea.com",
|
||||||
|
GITEA_CLIENT_ID: config["GITEA_CLIENT_ID"],
|
||||||
|
GITEA_CLIENT_SECRET: config["GITEA_CLIENT_SECRET"],
|
||||||
|
ENABLE_GITEA_SYNC: config["ENABLE_GITEA_SYNC"] || "0",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const originURL = !isEmpty(API_BASE_URL) ? API_BASE_URL : typeof window !== "undefined" ? window.location.origin : "";
|
||||||
|
|
||||||
|
const GITEA_FORM_FIELDS: TControllerInputFormField[] = [
|
||||||
|
{
|
||||||
|
key: "GITEA_HOST",
|
||||||
|
type: "text",
|
||||||
|
label: "Gitea Host",
|
||||||
|
description: (
|
||||||
|
<>Use the URL of your Gitea instance. For the official Gitea instance, use "https://gitea.com".</>
|
||||||
|
),
|
||||||
|
placeholder: "https://gitea.com",
|
||||||
|
error: Boolean(errors.GITEA_HOST),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "GITEA_CLIENT_ID",
|
||||||
|
type: "text",
|
||||||
|
label: "Client ID",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
You will get this from your{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://gitea.com/user/settings/applications"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
Gitea OAuth application settings.
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "70a44354520df8bd9bcd",
|
||||||
|
error: Boolean(errors.GITEA_CLIENT_ID),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "GITEA_CLIENT_SECRET",
|
||||||
|
type: "password",
|
||||||
|
label: "Client secret",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Your client secret is also found in your{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://gitea.com/user/settings/applications"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
Gitea OAuth application settings.
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "9b0050f94ec1b744e32ce79ea4ffacd40d4119cb",
|
||||||
|
error: Boolean(errors.GITEA_CLIENT_SECRET),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const GITEA_FORM_SWITCH_FIELD: TControllerSwitchFormField<GiteaConfigFormValues> = {
|
||||||
|
name: "ENABLE_GITEA_SYNC",
|
||||||
|
label: "Gitea",
|
||||||
|
};
|
||||||
|
|
||||||
|
const GITEA_SERVICE_FIELD: TCopyField[] = [
|
||||||
|
{
|
||||||
|
key: "Callback_URI",
|
||||||
|
label: "Callback URI",
|
||||||
|
url: `${originURL}/auth/gitea/callback/`,
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
We will auto-generate this. Paste this into your <CodeBlock darkerShade>Authorized Callback URI</CodeBlock>{" "}
|
||||||
|
field{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href={`${control._formValues.GITEA_HOST || "https://gitea.com"}/user/settings/applications`}
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
here.
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const onSubmit = async (formData: GiteaConfigFormValues) => {
|
||||||
|
const payload: Partial<GiteaConfigFormValues> = { ...formData };
|
||||||
|
|
||||||
|
try {
|
||||||
|
const response = await updateInstanceConfigurations(payload);
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
title: "Done!",
|
||||||
|
message: "Your Gitea authentication is configured. You should test it now.",
|
||||||
|
});
|
||||||
|
reset({
|
||||||
|
GITEA_HOST: response.find((item) => item.key === "GITEA_HOST")?.value,
|
||||||
|
GITEA_CLIENT_ID: response.find((item) => item.key === "GITEA_CLIENT_ID")?.value,
|
||||||
|
GITEA_CLIENT_SECRET: response.find((item) => item.key === "GITEA_CLIENT_SECRET")?.value,
|
||||||
|
ENABLE_GITEA_SYNC: response.find((item) => item.key === "ENABLE_GITEA_SYNC")?.value,
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleGoBack = (e: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => {
|
||||||
|
if (isDirty) {
|
||||||
|
e.preventDefault();
|
||||||
|
setIsDiscardChangesModalOpen(true);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<ConfirmDiscardModal
|
||||||
|
isOpen={isDiscardChangesModalOpen}
|
||||||
|
onDiscardHref="/authentication"
|
||||||
|
handleClose={() => setIsDiscardChangesModalOpen(false)}
|
||||||
|
/>
|
||||||
|
<div className="flex flex-col gap-8">
|
||||||
|
<div className="grid w-full grid-cols-2 gap-x-12 gap-y-8">
|
||||||
|
<div className="col-span-2 flex flex-col gap-y-4 pt-1 md:col-span-1">
|
||||||
|
<div className="pt-2.5 text-18 font-medium">Gitea-provided details for Plane</div>
|
||||||
|
{GITEA_FORM_FIELDS.map((field) => (
|
||||||
|
<ControllerInput
|
||||||
|
key={field.key}
|
||||||
|
control={control}
|
||||||
|
type={field.type}
|
||||||
|
name={field.key}
|
||||||
|
label={field.label}
|
||||||
|
description={field.description}
|
||||||
|
placeholder={field.placeholder}
|
||||||
|
error={field.error}
|
||||||
|
required={field.required}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
<ControllerSwitch control={control} field={GITEA_FORM_SWITCH_FIELD} />
|
||||||
|
<div className="flex flex-col gap-1 pt-4">
|
||||||
|
<div className="flex items-center gap-4">
|
||||||
|
<Button
|
||||||
|
variant="primary"
|
||||||
|
size="lg"
|
||||||
|
onClick={(e) => void handleSubmit(onSubmit)(e)}
|
||||||
|
loading={isSubmitting}
|
||||||
|
disabled={!isDirty}
|
||||||
|
>
|
||||||
|
{isSubmitting ? "Saving" : "Save changes"}
|
||||||
|
</Button>
|
||||||
|
<Link href="/authentication" className={getButtonStyling("secondary", "lg")} onClick={handleGoBack}>
|
||||||
|
Go back
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="col-span-2 md:col-span-1">
|
||||||
|
<div className="flex flex-col gap-y-4 rounded-lg bg-layer-1 px-6 pt-1.5 pb-4">
|
||||||
|
<div className="pt-2 text-18 font-medium">Plane-provided details for Gitea</div>
|
||||||
|
{GITEA_SERVICE_FIELD.map((field) => (
|
||||||
|
<CopyField key={field.key} label={field.label} url={field.url} description={field.description} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import useSWR from "swr";
|
||||||
|
// plane internal packages
|
||||||
|
import { setPromiseToast } from "@plane/propel/toast";
|
||||||
|
import { Loader, ToggleSwitch } from "@plane/ui";
|
||||||
|
// assets
|
||||||
|
import giteaLogo from "@/app/assets/logos/gitea-logo.svg?url";
|
||||||
|
// components
|
||||||
|
import { AuthenticationMethodCard } from "@/components/authentication/authentication-method-card";
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
// local
|
||||||
|
import { InstanceGiteaConfigForm } from "./form";
|
||||||
|
|
||||||
|
const InstanceGiteaAuthenticationPage = observer(function InstanceGiteaAuthenticationPage() {
|
||||||
|
// store
|
||||||
|
const { fetchInstanceConfigurations, formattedConfig, updateInstanceConfigurations } = useInstance();
|
||||||
|
// state
|
||||||
|
const [isSubmitting, setIsSubmitting] = useState<boolean>(false);
|
||||||
|
// config
|
||||||
|
const enableGiteaConfig = formattedConfig?.IS_GITEA_ENABLED ?? "";
|
||||||
|
useSWR("INSTANCE_CONFIGURATIONS", () => fetchInstanceConfigurations());
|
||||||
|
|
||||||
|
const updateConfig = async (key: "IS_GITEA_ENABLED", value: string) => {
|
||||||
|
setIsSubmitting(true);
|
||||||
|
|
||||||
|
const payload = {
|
||||||
|
[key]: value,
|
||||||
|
};
|
||||||
|
|
||||||
|
const updateConfigPromise = updateInstanceConfigurations(payload);
|
||||||
|
|
||||||
|
setPromiseToast(updateConfigPromise, {
|
||||||
|
loading: "Saving Configuration",
|
||||||
|
success: {
|
||||||
|
title: "Configuration saved",
|
||||||
|
message: () => `Gitea authentication is now ${value === "1" ? "active" : "disabled"}.`,
|
||||||
|
},
|
||||||
|
error: {
|
||||||
|
title: "Error",
|
||||||
|
message: () => "Failed to save configuration",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await updateConfigPromise
|
||||||
|
.then(() => {
|
||||||
|
setIsSubmitting(false);
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
console.error(err);
|
||||||
|
setIsSubmitting(false);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
const isGiteaEnabled = enableGiteaConfig === "1";
|
||||||
|
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
customHeader={
|
||||||
|
<AuthenticationMethodCard
|
||||||
|
name="Gitea"
|
||||||
|
description="Allow members to login or sign up to plane with their Gitea accounts."
|
||||||
|
icon={<img src={giteaLogo} height={24} width={24} alt="Gitea Logo" />}
|
||||||
|
config={
|
||||||
|
<ToggleSwitch
|
||||||
|
value={isGiteaEnabled}
|
||||||
|
onChange={() => {
|
||||||
|
updateConfig("IS_GITEA_ENABLED", isGiteaEnabled ? "0" : "1");
|
||||||
|
}}
|
||||||
|
size="sm"
|
||||||
|
disabled={isSubmitting || !formattedConfig}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
disabled={isSubmitting || !formattedConfig}
|
||||||
|
withBorder={false}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{formattedConfig ? (
|
||||||
|
<InstanceGiteaConfigForm config={formattedConfig} />
|
||||||
|
) : (
|
||||||
|
<Loader className="space-y-8">
|
||||||
|
<Loader.Item height="50px" width="25%" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" width="50%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "Gitea Authentication - God Mode" }];
|
||||||
|
|
||||||
|
export default InstanceGiteaAuthenticationPage;
|
||||||
@@ -0,0 +1,263 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { isEmpty } from "lodash-es";
|
||||||
|
import Link from "next/link";
|
||||||
|
import { useForm } from "react-hook-form";
|
||||||
|
import { Monitor } from "lucide-react";
|
||||||
|
// plane internal packages
|
||||||
|
import { API_BASE_URL } from "@plane/constants";
|
||||||
|
import { Button, getButtonStyling } from "@plane/propel/button";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import type { IFormattedInstanceConfiguration, TInstanceGithubAuthenticationConfigurationKeys } from "@plane/types";
|
||||||
|
// components
|
||||||
|
import { CodeBlock } from "@/components/common/code-block";
|
||||||
|
import { ConfirmDiscardModal } from "@/components/common/confirm-discard-modal";
|
||||||
|
import type { TControllerInputFormField } from "@/components/common/controller-input";
|
||||||
|
import type { TControllerSwitchFormField } from "@/components/common/controller-switch";
|
||||||
|
import { ControllerSwitch } from "@/components/common/controller-switch";
|
||||||
|
import { ControllerInput } from "@/components/common/controller-input";
|
||||||
|
import type { TCopyField } from "@/components/common/copy-field";
|
||||||
|
import { CopyField } from "@/components/common/copy-field";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
|
||||||
|
type Props = {
|
||||||
|
config: IFormattedInstanceConfiguration;
|
||||||
|
};
|
||||||
|
|
||||||
|
type GithubConfigFormValues = Record<TInstanceGithubAuthenticationConfigurationKeys, string>;
|
||||||
|
|
||||||
|
export function InstanceGithubConfigForm(props: Props) {
|
||||||
|
const { config } = props;
|
||||||
|
// states
|
||||||
|
const [isDiscardChangesModalOpen, setIsDiscardChangesModalOpen] = useState(false);
|
||||||
|
// store hooks
|
||||||
|
const { updateInstanceConfigurations } = useInstance();
|
||||||
|
// form data
|
||||||
|
const {
|
||||||
|
handleSubmit,
|
||||||
|
control,
|
||||||
|
reset,
|
||||||
|
formState: { errors, isDirty, isSubmitting },
|
||||||
|
} = useForm<GithubConfigFormValues>({
|
||||||
|
defaultValues: {
|
||||||
|
GITHUB_CLIENT_ID: config["GITHUB_CLIENT_ID"],
|
||||||
|
GITHUB_CLIENT_SECRET: config["GITHUB_CLIENT_SECRET"],
|
||||||
|
GITHUB_ORGANIZATION_ID: config["GITHUB_ORGANIZATION_ID"],
|
||||||
|
ENABLE_GITHUB_SYNC: config["ENABLE_GITHUB_SYNC"] || "0",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const originURL = !isEmpty(API_BASE_URL) ? API_BASE_URL : typeof window !== "undefined" ? window.location.origin : "";
|
||||||
|
|
||||||
|
const GITHUB_FORM_FIELDS: TControllerInputFormField[] = [
|
||||||
|
{
|
||||||
|
key: "GITHUB_CLIENT_ID",
|
||||||
|
type: "text",
|
||||||
|
label: "Client ID",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
You will get this from your{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://github.com/settings/applications/new"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
GitHub OAuth application settings.
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "70a44354520df8bd9bcd",
|
||||||
|
error: Boolean(errors.GITHUB_CLIENT_ID),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "GITHUB_CLIENT_SECRET",
|
||||||
|
type: "password",
|
||||||
|
label: "Client secret",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Your client secret is also found in your{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://github.com/settings/applications/new"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
GitHub OAuth application settings.
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "9b0050f94ec1b744e32ce79ea4ffacd40d4119cb",
|
||||||
|
error: Boolean(errors.GITHUB_CLIENT_SECRET),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "GITHUB_ORGANIZATION_ID",
|
||||||
|
type: "text",
|
||||||
|
label: "Organization ID",
|
||||||
|
description: <>The organization github ID.</>,
|
||||||
|
placeholder: "123456789",
|
||||||
|
error: Boolean(errors.GITHUB_ORGANIZATION_ID),
|
||||||
|
required: false,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const GITHUB_FORM_SWITCH_FIELD: TControllerSwitchFormField<GithubConfigFormValues> = {
|
||||||
|
name: "ENABLE_GITHUB_SYNC",
|
||||||
|
label: "GitHub",
|
||||||
|
};
|
||||||
|
|
||||||
|
const GITHUB_COMMON_SERVICE_DETAILS: TCopyField[] = [
|
||||||
|
{
|
||||||
|
key: "Origin_URL",
|
||||||
|
label: "Origin URL",
|
||||||
|
url: originURL,
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
We will auto-generate this. Paste this into the <CodeBlock darkerShade>Authorized origin URL</CodeBlock> field{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://github.com/settings/applications/new"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
here.
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const GITHUB_SERVICE_DETAILS: TCopyField[] = [
|
||||||
|
{
|
||||||
|
key: "Callback_URI",
|
||||||
|
label: "Callback URI",
|
||||||
|
url: `${originURL}/auth/github/callback/`,
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
We will auto-generate this. Paste this into your <CodeBlock darkerShade>Authorized Callback URI</CodeBlock>{" "}
|
||||||
|
field{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://github.com/settings/applications/new"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
here.
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const onSubmit = async (formData: GithubConfigFormValues) => {
|
||||||
|
const payload: Partial<GithubConfigFormValues> = { ...formData };
|
||||||
|
|
||||||
|
try {
|
||||||
|
const response = await updateInstanceConfigurations(payload);
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
title: "Done!",
|
||||||
|
message: "Your GitHub authentication is configured. You should test it now.",
|
||||||
|
});
|
||||||
|
reset({
|
||||||
|
GITHUB_CLIENT_ID: response.find((item) => item.key === "GITHUB_CLIENT_ID")?.value,
|
||||||
|
GITHUB_CLIENT_SECRET: response.find((item) => item.key === "GITHUB_CLIENT_SECRET")?.value,
|
||||||
|
GITHUB_ORGANIZATION_ID: response.find((item) => item.key === "GITHUB_ORGANIZATION_ID")?.value,
|
||||||
|
ENABLE_GITHUB_SYNC: response.find((item) => item.key === "ENABLE_GITHUB_SYNC")?.value,
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleGoBack = (e: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => {
|
||||||
|
if (isDirty) {
|
||||||
|
e.preventDefault();
|
||||||
|
setIsDiscardChangesModalOpen(true);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<ConfirmDiscardModal
|
||||||
|
isOpen={isDiscardChangesModalOpen}
|
||||||
|
onDiscardHref="/authentication"
|
||||||
|
handleClose={() => setIsDiscardChangesModalOpen(false)}
|
||||||
|
/>
|
||||||
|
<div className="flex flex-col gap-8">
|
||||||
|
<div className="grid w-full grid-cols-2 gap-x-12 gap-y-8">
|
||||||
|
<div className="col-span-2 flex flex-col gap-y-4 pt-1 md:col-span-1">
|
||||||
|
<div className="pt-2.5 text-18 font-medium">GitHub-provided details for Plane</div>
|
||||||
|
{GITHUB_FORM_FIELDS.map((field) => (
|
||||||
|
<ControllerInput
|
||||||
|
key={field.key}
|
||||||
|
control={control}
|
||||||
|
type={field.type}
|
||||||
|
name={field.key}
|
||||||
|
label={field.label}
|
||||||
|
description={field.description}
|
||||||
|
placeholder={field.placeholder}
|
||||||
|
error={field.error}
|
||||||
|
required={field.required}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
<ControllerSwitch control={control} field={GITHUB_FORM_SWITCH_FIELD} />
|
||||||
|
<div className="flex flex-col gap-1 pt-4">
|
||||||
|
<div className="flex items-center gap-4">
|
||||||
|
<Button
|
||||||
|
variant="primary"
|
||||||
|
size="lg"
|
||||||
|
onClick={(e) => void handleSubmit(onSubmit)(e)}
|
||||||
|
loading={isSubmitting}
|
||||||
|
disabled={!isDirty}
|
||||||
|
>
|
||||||
|
{isSubmitting ? "Saving" : "Save changes"}
|
||||||
|
</Button>
|
||||||
|
<Link href="/authentication" className={getButtonStyling("secondary", "lg")} onClick={handleGoBack}>
|
||||||
|
Go back
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="col-span-2 flex flex-col gap-y-6 md:col-span-1">
|
||||||
|
<div className="pt-2 text-18 font-medium">Plane-provided details for GitHub</div>
|
||||||
|
|
||||||
|
<div className="flex flex-col gap-y-4">
|
||||||
|
{/* common service details */}
|
||||||
|
<div className="flex flex-col gap-y-4 rounded-lg bg-layer-1 px-6 py-4">
|
||||||
|
{GITHUB_COMMON_SERVICE_DETAILS.map((field) => (
|
||||||
|
<CopyField key={field.key} label={field.label} url={field.url} description={field.description} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* web service details */}
|
||||||
|
<div className="flex flex-col overflow-hidden rounded-lg">
|
||||||
|
<div className="flex items-center gap-x-3 bg-layer-3 px-6 py-3 text-11 font-medium text-secondary uppercase">
|
||||||
|
<Monitor className="h-3 w-3" />
|
||||||
|
Web
|
||||||
|
</div>
|
||||||
|
<div className="flex flex-col gap-y-4 bg-layer-1 px-6 py-4">
|
||||||
|
{GITHUB_SERVICE_DETAILS.map((field) => (
|
||||||
|
<CopyField key={field.key} label={field.label} url={field.url} description={field.description} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,121 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import { useTheme } from "next-themes";
|
||||||
|
import useSWR from "swr";
|
||||||
|
// plane internal packages
|
||||||
|
import { setPromiseToast } from "@plane/propel/toast";
|
||||||
|
import { Loader, ToggleSwitch } from "@plane/ui";
|
||||||
|
import { resolveGeneralTheme } from "@plane/utils";
|
||||||
|
// assets
|
||||||
|
import githubLightModeImage from "@/app/assets/logos/github-black.png?url";
|
||||||
|
import githubDarkModeImage from "@/app/assets/logos/github-white.png?url";
|
||||||
|
// components
|
||||||
|
import { AuthenticationMethodCard } from "@/components/authentication/authentication-method-card";
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
// local
|
||||||
|
import { InstanceGithubConfigForm } from "./form";
|
||||||
|
|
||||||
|
const InstanceGithubAuthenticationPage = observer(function InstanceGithubAuthenticationPage(
|
||||||
|
_props: Route.ComponentProps
|
||||||
|
) {
|
||||||
|
// store
|
||||||
|
const { fetchInstanceConfigurations, formattedConfig, updateInstanceConfigurations } = useInstance();
|
||||||
|
// state
|
||||||
|
const [isSubmitting, setIsSubmitting] = useState<boolean>(false);
|
||||||
|
// theme
|
||||||
|
const { resolvedTheme } = useTheme();
|
||||||
|
// config
|
||||||
|
const enableGithubConfig = formattedConfig?.IS_GITHUB_ENABLED ?? "";
|
||||||
|
|
||||||
|
useSWR("INSTANCE_CONFIGURATIONS", () => fetchInstanceConfigurations());
|
||||||
|
|
||||||
|
const updateConfig = async (key: "IS_GITHUB_ENABLED", value: string) => {
|
||||||
|
setIsSubmitting(true);
|
||||||
|
|
||||||
|
const payload = {
|
||||||
|
[key]: value,
|
||||||
|
};
|
||||||
|
|
||||||
|
const updateConfigPromise = updateInstanceConfigurations(payload);
|
||||||
|
|
||||||
|
setPromiseToast(updateConfigPromise, {
|
||||||
|
loading: "Saving Configuration",
|
||||||
|
success: {
|
||||||
|
title: "Configuration saved",
|
||||||
|
message: () => `GitHub authentication is now ${value === "1" ? "active" : "disabled"}.`,
|
||||||
|
},
|
||||||
|
error: {
|
||||||
|
title: "Error",
|
||||||
|
message: () => "Failed to save configuration",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await updateConfigPromise
|
||||||
|
.then(() => {
|
||||||
|
setIsSubmitting(false);
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
console.error(err);
|
||||||
|
setIsSubmitting(false);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
const isGithubEnabled = enableGithubConfig === "1";
|
||||||
|
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
customHeader={
|
||||||
|
<AuthenticationMethodCard
|
||||||
|
name="GitHub"
|
||||||
|
description="Allow members to login or sign up to plane with their GitHub accounts."
|
||||||
|
icon={
|
||||||
|
<img
|
||||||
|
src={resolveGeneralTheme(resolvedTheme) === "dark" ? githubDarkModeImage : githubLightModeImage}
|
||||||
|
height={24}
|
||||||
|
width={24}
|
||||||
|
alt="GitHub Logo"
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
config={
|
||||||
|
<ToggleSwitch
|
||||||
|
value={isGithubEnabled}
|
||||||
|
onChange={() => {
|
||||||
|
updateConfig("IS_GITHUB_ENABLED", isGithubEnabled ? "0" : "1");
|
||||||
|
}}
|
||||||
|
size="sm"
|
||||||
|
disabled={isSubmitting || !formattedConfig}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
disabled={isSubmitting || !formattedConfig}
|
||||||
|
withBorder={false}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{formattedConfig ? (
|
||||||
|
<InstanceGithubConfigForm config={formattedConfig} />
|
||||||
|
) : (
|
||||||
|
<Loader className="space-y-8">
|
||||||
|
<Loader.Item height="50px" width="25%" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" width="50%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "GitHub Authentication - God Mode" }];
|
||||||
|
|
||||||
|
export default InstanceGithubAuthenticationPage;
|
||||||
@@ -0,0 +1,229 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { isEmpty } from "lodash-es";
|
||||||
|
import Link from "next/link";
|
||||||
|
import { useForm } from "react-hook-form";
|
||||||
|
// plane internal packages
|
||||||
|
import { API_BASE_URL } from "@plane/constants";
|
||||||
|
import { Button, getButtonStyling } from "@plane/propel/button";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import type { IFormattedInstanceConfiguration, TInstanceGitlabAuthenticationConfigurationKeys } from "@plane/types";
|
||||||
|
// components
|
||||||
|
import { CodeBlock } from "@/components/common/code-block";
|
||||||
|
import { ConfirmDiscardModal } from "@/components/common/confirm-discard-modal";
|
||||||
|
import type { TControllerInputFormField } from "@/components/common/controller-input";
|
||||||
|
import type { TControllerSwitchFormField } from "@/components/common/controller-switch";
|
||||||
|
import { ControllerSwitch } from "@/components/common/controller-switch";
|
||||||
|
import { ControllerInput } from "@/components/common/controller-input";
|
||||||
|
import type { TCopyField } from "@/components/common/copy-field";
|
||||||
|
import { CopyField } from "@/components/common/copy-field";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
|
||||||
|
type Props = {
|
||||||
|
config: IFormattedInstanceConfiguration;
|
||||||
|
};
|
||||||
|
|
||||||
|
type GitlabConfigFormValues = Record<TInstanceGitlabAuthenticationConfigurationKeys, string>;
|
||||||
|
|
||||||
|
export function InstanceGitlabConfigForm(props: Props) {
|
||||||
|
const { config } = props;
|
||||||
|
// states
|
||||||
|
const [isDiscardChangesModalOpen, setIsDiscardChangesModalOpen] = useState(false);
|
||||||
|
// store hooks
|
||||||
|
const { updateInstanceConfigurations } = useInstance();
|
||||||
|
// form data
|
||||||
|
const {
|
||||||
|
handleSubmit,
|
||||||
|
control,
|
||||||
|
reset,
|
||||||
|
formState: { errors, isDirty, isSubmitting },
|
||||||
|
} = useForm<GitlabConfigFormValues>({
|
||||||
|
defaultValues: {
|
||||||
|
GITLAB_HOST: config["GITLAB_HOST"],
|
||||||
|
GITLAB_CLIENT_ID: config["GITLAB_CLIENT_ID"],
|
||||||
|
GITLAB_CLIENT_SECRET: config["GITLAB_CLIENT_SECRET"],
|
||||||
|
ENABLE_GITLAB_SYNC: config["ENABLE_GITLAB_SYNC"] || "0",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const originURL = !isEmpty(API_BASE_URL) ? API_BASE_URL : typeof window !== "undefined" ? window.location.origin : "";
|
||||||
|
|
||||||
|
const GITLAB_FORM_FIELDS: TControllerInputFormField[] = [
|
||||||
|
{
|
||||||
|
key: "GITLAB_HOST",
|
||||||
|
type: "text",
|
||||||
|
label: "Host",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
This is either https://gitlab.com or the <CodeBlock>domain.tld</CodeBlock> where you host GitLab.
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "https://gitlab.com",
|
||||||
|
error: Boolean(errors.GITLAB_HOST),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "GITLAB_CLIENT_ID",
|
||||||
|
type: "text",
|
||||||
|
label: "Application ID",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Get this from your{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://docs.gitlab.com/ee/integration/oauth_provider.html"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
GitLab OAuth application settings
|
||||||
|
</a>
|
||||||
|
.
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "c2ef2e7fc4e9d15aa7630f5637d59e8e4a27ff01dceebdb26b0d267b9adcf3c3",
|
||||||
|
error: Boolean(errors.GITLAB_CLIENT_ID),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "GITLAB_CLIENT_SECRET",
|
||||||
|
type: "password",
|
||||||
|
label: "Secret",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
The client secret is also found in your{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://docs.gitlab.com/ee/integration/oauth_provider.html"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
GitLab OAuth application settings
|
||||||
|
</a>
|
||||||
|
.
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "gloas-f79cfa9a03c97f6ffab303177a5a6778a53c61e3914ba093412f68a9298a1b28",
|
||||||
|
error: Boolean(errors.GITLAB_CLIENT_SECRET),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const GITLAB_FORM_SWITCH_FIELD: TControllerSwitchFormField<GitlabConfigFormValues> = {
|
||||||
|
name: "ENABLE_GITLAB_SYNC",
|
||||||
|
label: "GitLab",
|
||||||
|
};
|
||||||
|
|
||||||
|
const GITLAB_SERVICE_FIELD: TCopyField[] = [
|
||||||
|
{
|
||||||
|
key: "Callback_URL",
|
||||||
|
label: "Callback URL",
|
||||||
|
url: `${originURL}/auth/gitlab/callback/`,
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
We will auto-generate this. Paste this into the <CodeBlock darkerShade>Redirect URI</CodeBlock> field of your{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://docs.gitlab.com/ee/integration/oauth_provider.html"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
GitLab OAuth application
|
||||||
|
</a>
|
||||||
|
.
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const onSubmit = async (formData: GitlabConfigFormValues) => {
|
||||||
|
const payload: Partial<GitlabConfigFormValues> = { ...formData };
|
||||||
|
|
||||||
|
try {
|
||||||
|
const response = await updateInstanceConfigurations(payload);
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
title: "Done!",
|
||||||
|
message: "Your GitLab authentication is configured. You should test it now.",
|
||||||
|
});
|
||||||
|
reset({
|
||||||
|
GITLAB_HOST: response.find((item) => item.key === "GITLAB_HOST")?.value,
|
||||||
|
GITLAB_CLIENT_ID: response.find((item) => item.key === "GITLAB_CLIENT_ID")?.value,
|
||||||
|
GITLAB_CLIENT_SECRET: response.find((item) => item.key === "GITLAB_CLIENT_SECRET")?.value,
|
||||||
|
ENABLE_GITLAB_SYNC: response.find((item) => item.key === "ENABLE_GITLAB_SYNC")?.value,
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleGoBack = (e: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => {
|
||||||
|
if (isDirty) {
|
||||||
|
e.preventDefault();
|
||||||
|
setIsDiscardChangesModalOpen(true);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<ConfirmDiscardModal
|
||||||
|
isOpen={isDiscardChangesModalOpen}
|
||||||
|
onDiscardHref="/authentication"
|
||||||
|
handleClose={() => setIsDiscardChangesModalOpen(false)}
|
||||||
|
/>
|
||||||
|
<div className="flex flex-col gap-8">
|
||||||
|
<div className="grid w-full grid-cols-2 gap-x-12 gap-y-8">
|
||||||
|
<div className="col-span-2 flex flex-col gap-y-4 pt-1 md:col-span-1">
|
||||||
|
<div className="pt-2.5 text-18 font-medium">GitLab-provided details for Plane</div>
|
||||||
|
{GITLAB_FORM_FIELDS.map((field) => (
|
||||||
|
<ControllerInput
|
||||||
|
key={field.key}
|
||||||
|
control={control}
|
||||||
|
type={field.type}
|
||||||
|
name={field.key}
|
||||||
|
label={field.label}
|
||||||
|
description={field.description}
|
||||||
|
placeholder={field.placeholder}
|
||||||
|
error={field.error}
|
||||||
|
required={field.required}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
<ControllerSwitch control={control} field={GITLAB_FORM_SWITCH_FIELD} />
|
||||||
|
<div className="flex flex-col gap-1 pt-4">
|
||||||
|
<div className="flex items-center gap-4">
|
||||||
|
<Button
|
||||||
|
variant="primary"
|
||||||
|
size="lg"
|
||||||
|
onClick={(e) => void handleSubmit(onSubmit)(e)}
|
||||||
|
loading={isSubmitting}
|
||||||
|
disabled={!isDirty}
|
||||||
|
>
|
||||||
|
{isSubmitting ? "Saving" : "Save changes"}
|
||||||
|
</Button>
|
||||||
|
<Link href="/authentication" className={getButtonStyling("secondary", "lg")} onClick={handleGoBack}>
|
||||||
|
Go back
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="col-span-2 md:col-span-1">
|
||||||
|
<div className="flex flex-col gap-y-4 rounded-lg bg-layer-3 px-6 pt-1.5 pb-4">
|
||||||
|
<div className="pt-2 text-18 font-medium">Plane-provided details for GitLab</div>
|
||||||
|
{GITLAB_SERVICE_FIELD.map((field) => (
|
||||||
|
<CopyField key={field.key} label={field.label} url={field.url} description={field.description} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import useSWR from "swr";
|
||||||
|
import { setPromiseToast } from "@plane/propel/toast";
|
||||||
|
import { Loader, ToggleSwitch } from "@plane/ui";
|
||||||
|
// assets
|
||||||
|
import GitlabLogo from "@/app/assets/logos/gitlab-logo.svg?url";
|
||||||
|
// components
|
||||||
|
import { AuthenticationMethodCard } from "@/components/authentication/authentication-method-card";
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
// local
|
||||||
|
import { InstanceGitlabConfigForm } from "./form";
|
||||||
|
|
||||||
|
const InstanceGitlabAuthenticationPage = observer(function InstanceGitlabAuthenticationPage(
|
||||||
|
_props: Route.ComponentProps
|
||||||
|
) {
|
||||||
|
// store
|
||||||
|
const { fetchInstanceConfigurations, formattedConfig, updateInstanceConfigurations } = useInstance();
|
||||||
|
// state
|
||||||
|
const [isSubmitting, setIsSubmitting] = useState<boolean>(false);
|
||||||
|
// config
|
||||||
|
const enableGitlabConfig = formattedConfig?.IS_GITLAB_ENABLED ?? "";
|
||||||
|
|
||||||
|
useSWR("INSTANCE_CONFIGURATIONS", () => fetchInstanceConfigurations());
|
||||||
|
|
||||||
|
const updateConfig = async (key: "IS_GITLAB_ENABLED", value: string) => {
|
||||||
|
setIsSubmitting(true);
|
||||||
|
|
||||||
|
const payload = {
|
||||||
|
[key]: value,
|
||||||
|
};
|
||||||
|
|
||||||
|
const updateConfigPromise = updateInstanceConfigurations(payload);
|
||||||
|
|
||||||
|
setPromiseToast(updateConfigPromise, {
|
||||||
|
loading: "Saving Configuration",
|
||||||
|
success: {
|
||||||
|
title: "Configuration saved",
|
||||||
|
message: () => `GitLab authentication is now ${value === "1" ? "active" : "disabled"}.`,
|
||||||
|
},
|
||||||
|
error: {
|
||||||
|
title: "Error",
|
||||||
|
message: () => "Failed to save configuration",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await updateConfigPromise
|
||||||
|
.then(() => {
|
||||||
|
setIsSubmitting(false);
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
console.error(err);
|
||||||
|
setIsSubmitting(false);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
customHeader={
|
||||||
|
<AuthenticationMethodCard
|
||||||
|
name="GitLab"
|
||||||
|
description="Allow members to login or sign up to plane with their GitLab accounts."
|
||||||
|
icon={<img src={GitlabLogo} height={24} width={24} alt="GitLab Logo" />}
|
||||||
|
config={
|
||||||
|
<ToggleSwitch
|
||||||
|
value={Boolean(parseInt(enableGitlabConfig))}
|
||||||
|
onChange={() => {
|
||||||
|
if (Boolean(parseInt(enableGitlabConfig)) === true) {
|
||||||
|
updateConfig("IS_GITLAB_ENABLED", "0");
|
||||||
|
} else {
|
||||||
|
updateConfig("IS_GITLAB_ENABLED", "1");
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
size="sm"
|
||||||
|
disabled={isSubmitting || !formattedConfig}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
disabled={isSubmitting || !formattedConfig}
|
||||||
|
withBorder={false}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{formattedConfig ? (
|
||||||
|
<InstanceGitlabConfigForm config={formattedConfig} />
|
||||||
|
) : (
|
||||||
|
<Loader className="space-y-8">
|
||||||
|
<Loader.Item height="50px" width="25%" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" width="50%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "GitLab Authentication - God Mode" }];
|
||||||
|
|
||||||
|
export default InstanceGitlabAuthenticationPage;
|
||||||
@@ -0,0 +1,251 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { isEmpty } from "lodash-es";
|
||||||
|
import Link from "next/link";
|
||||||
|
import { useForm } from "react-hook-form";
|
||||||
|
import { Monitor } from "lucide-react";
|
||||||
|
// plane internal packages
|
||||||
|
import { API_BASE_URL } from "@plane/constants";
|
||||||
|
import { Button, getButtonStyling } from "@plane/propel/button";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import type { IFormattedInstanceConfiguration, TInstanceGoogleAuthenticationConfigurationKeys } from "@plane/types";
|
||||||
|
// components
|
||||||
|
import { CodeBlock } from "@/components/common/code-block";
|
||||||
|
import { ConfirmDiscardModal } from "@/components/common/confirm-discard-modal";
|
||||||
|
import type { TControllerInputFormField } from "@/components/common/controller-input";
|
||||||
|
import type { TControllerSwitchFormField } from "@/components/common/controller-switch";
|
||||||
|
import { ControllerSwitch } from "@/components/common/controller-switch";
|
||||||
|
import { ControllerInput } from "@/components/common/controller-input";
|
||||||
|
import type { TCopyField } from "@/components/common/copy-field";
|
||||||
|
import { CopyField } from "@/components/common/copy-field";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
|
||||||
|
type Props = {
|
||||||
|
config: IFormattedInstanceConfiguration;
|
||||||
|
};
|
||||||
|
|
||||||
|
type GoogleConfigFormValues = Record<TInstanceGoogleAuthenticationConfigurationKeys, string>;
|
||||||
|
|
||||||
|
export function InstanceGoogleConfigForm(props: Props) {
|
||||||
|
const { config } = props;
|
||||||
|
// states
|
||||||
|
const [isDiscardChangesModalOpen, setIsDiscardChangesModalOpen] = useState(false);
|
||||||
|
// store hooks
|
||||||
|
const { updateInstanceConfigurations } = useInstance();
|
||||||
|
// form data
|
||||||
|
const {
|
||||||
|
handleSubmit,
|
||||||
|
control,
|
||||||
|
reset,
|
||||||
|
formState: { errors, isDirty, isSubmitting },
|
||||||
|
} = useForm<GoogleConfigFormValues>({
|
||||||
|
defaultValues: {
|
||||||
|
GOOGLE_CLIENT_ID: config["GOOGLE_CLIENT_ID"],
|
||||||
|
GOOGLE_CLIENT_SECRET: config["GOOGLE_CLIENT_SECRET"],
|
||||||
|
ENABLE_GOOGLE_SYNC: config["ENABLE_GOOGLE_SYNC"] || "0",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const originURL = !isEmpty(API_BASE_URL) ? API_BASE_URL : typeof window !== "undefined" ? window.location.origin : "";
|
||||||
|
|
||||||
|
const GOOGLE_FORM_FIELDS: TControllerInputFormField[] = [
|
||||||
|
{
|
||||||
|
key: "GOOGLE_CLIENT_ID",
|
||||||
|
type: "text",
|
||||||
|
label: "Client ID",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Your client ID lives in your Google API Console.{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://developers.google.com/identity/protocols/oauth2/javascript-implicit-flow#creatingcred"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
Learn more
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "840195096245-0p2tstej9j5nc4l8o1ah2dqondscqc1g.apps.googleusercontent.com",
|
||||||
|
error: Boolean(errors.GOOGLE_CLIENT_ID),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "GOOGLE_CLIENT_SECRET",
|
||||||
|
type: "password",
|
||||||
|
label: "Client secret",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Your client secret should also be in your Google API Console.{" "}
|
||||||
|
<a
|
||||||
|
tabIndex={-1}
|
||||||
|
href="https://developers.google.com/identity/oauth2/web/guides/get-google-api-clientid"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
Learn more
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
placeholder: "GOCShX-ADp4cI0kPqav1gGCBg5bE02E",
|
||||||
|
error: Boolean(errors.GOOGLE_CLIENT_SECRET),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const GOOGLE_FORM_SWITCH_FIELD: TControllerSwitchFormField<GoogleConfigFormValues> = {
|
||||||
|
name: "ENABLE_GOOGLE_SYNC",
|
||||||
|
label: "Google",
|
||||||
|
};
|
||||||
|
|
||||||
|
const GOOGLE_COMMON_SERVICE_DETAILS: TCopyField[] = [
|
||||||
|
{
|
||||||
|
key: "Origin_URL",
|
||||||
|
label: "Origin URL",
|
||||||
|
url: originURL,
|
||||||
|
description: (
|
||||||
|
<p>
|
||||||
|
We will auto-generate this. Paste this into your{" "}
|
||||||
|
<CodeBlock darkerShade>Authorized JavaScript origins</CodeBlock> field. For this OAuth client{" "}
|
||||||
|
<a
|
||||||
|
href="https://console.cloud.google.com/apis/credentials/oauthclient"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
here.
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const GOOGLE_SERVICE_DETAILS: TCopyField[] = [
|
||||||
|
{
|
||||||
|
key: "Callback_URI",
|
||||||
|
label: "Callback URI",
|
||||||
|
url: `${originURL}/auth/google/callback/`,
|
||||||
|
description: (
|
||||||
|
<p>
|
||||||
|
We will auto-generate this. Paste this into your <CodeBlock darkerShade>Authorized Redirect URI</CodeBlock>{" "}
|
||||||
|
field. For this OAuth client{" "}
|
||||||
|
<a
|
||||||
|
href="https://console.cloud.google.com/apis/credentials/oauthclient"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
here.
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const onSubmit = async (formData: GoogleConfigFormValues) => {
|
||||||
|
const payload: Partial<GoogleConfigFormValues> = { ...formData };
|
||||||
|
|
||||||
|
try {
|
||||||
|
const response = await updateInstanceConfigurations(payload);
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
title: "Done!",
|
||||||
|
message: "Your Google authentication is configured. You should test it now.",
|
||||||
|
});
|
||||||
|
reset({
|
||||||
|
GOOGLE_CLIENT_ID: response.find((item) => item.key === "GOOGLE_CLIENT_ID")?.value,
|
||||||
|
GOOGLE_CLIENT_SECRET: response.find((item) => item.key === "GOOGLE_CLIENT_SECRET")?.value,
|
||||||
|
ENABLE_GOOGLE_SYNC: response.find((item) => item.key === "ENABLE_GOOGLE_SYNC")?.value,
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleGoBack = (e: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => {
|
||||||
|
if (isDirty) {
|
||||||
|
e.preventDefault();
|
||||||
|
setIsDiscardChangesModalOpen(true);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<ConfirmDiscardModal
|
||||||
|
isOpen={isDiscardChangesModalOpen}
|
||||||
|
onDiscardHref="/authentication"
|
||||||
|
handleClose={() => setIsDiscardChangesModalOpen(false)}
|
||||||
|
/>
|
||||||
|
<div className="flex flex-col gap-8">
|
||||||
|
<div className="grid w-full grid-cols-2 gap-x-12 gap-y-8">
|
||||||
|
<div className="col-span-2 flex flex-col gap-y-4 pt-1 md:col-span-1">
|
||||||
|
<div className="pt-2.5 text-18 font-medium">Google-provided details for Plane</div>
|
||||||
|
{GOOGLE_FORM_FIELDS.map((field) => (
|
||||||
|
<ControllerInput
|
||||||
|
key={field.key}
|
||||||
|
control={control}
|
||||||
|
type={field.type}
|
||||||
|
name={field.key}
|
||||||
|
label={field.label}
|
||||||
|
description={field.description}
|
||||||
|
placeholder={field.placeholder}
|
||||||
|
error={field.error}
|
||||||
|
required={field.required}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
<ControllerSwitch control={control} field={GOOGLE_FORM_SWITCH_FIELD} />
|
||||||
|
<div className="flex flex-col gap-1 pt-4">
|
||||||
|
<div className="flex items-center gap-4">
|
||||||
|
<Button
|
||||||
|
variant="primary"
|
||||||
|
size="lg"
|
||||||
|
onClick={(e) => void handleSubmit(onSubmit)(e)}
|
||||||
|
loading={isSubmitting}
|
||||||
|
disabled={!isDirty}
|
||||||
|
>
|
||||||
|
{isSubmitting ? "Saving" : "Save changes"}
|
||||||
|
</Button>
|
||||||
|
<Link href="/authentication" className={getButtonStyling("secondary", "lg")} onClick={handleGoBack}>
|
||||||
|
Go back
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="col-span-2 flex flex-col gap-y-6 md:col-span-1">
|
||||||
|
<div className="pt-2 text-18 font-medium">Plane-provided details for Google</div>
|
||||||
|
|
||||||
|
<div className="flex flex-col gap-y-4">
|
||||||
|
{/* common service details */}
|
||||||
|
<div className="flex flex-col gap-y-4 rounded-lg bg-layer-1 px-6 py-4">
|
||||||
|
{GOOGLE_COMMON_SERVICE_DETAILS.map((field) => (
|
||||||
|
<CopyField key={field.key} label={field.label} url={field.url} description={field.description} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* web service details */}
|
||||||
|
<div className="flex flex-col overflow-hidden rounded-lg">
|
||||||
|
<div className="flex items-center gap-x-3 bg-layer-3 px-6 py-3 text-11 font-medium text-secondary uppercase">
|
||||||
|
<Monitor className="h-3 w-3" />
|
||||||
|
Web
|
||||||
|
</div>
|
||||||
|
<div className="flex flex-col gap-y-4 bg-layer-1 px-6 py-4">
|
||||||
|
{GOOGLE_SERVICE_DETAILS.map((field) => (
|
||||||
|
<CopyField key={field.key} label={field.label} url={field.url} description={field.description} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,110 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import useSWR from "swr";
|
||||||
|
import { setPromiseToast } from "@plane/propel/toast";
|
||||||
|
import { Loader, ToggleSwitch } from "@plane/ui";
|
||||||
|
// assets
|
||||||
|
import GoogleLogo from "@/app/assets/logos/google-logo.svg?url";
|
||||||
|
// components
|
||||||
|
import { AuthenticationMethodCard } from "@/components/authentication/authentication-method-card";
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
// local
|
||||||
|
import { InstanceGoogleConfigForm } from "./form";
|
||||||
|
|
||||||
|
const InstanceGoogleAuthenticationPage = observer(function InstanceGoogleAuthenticationPage(
|
||||||
|
_props: Route.ComponentProps
|
||||||
|
) {
|
||||||
|
// store
|
||||||
|
const { fetchInstanceConfigurations, formattedConfig, updateInstanceConfigurations } = useInstance();
|
||||||
|
// state
|
||||||
|
const [isSubmitting, setIsSubmitting] = useState<boolean>(false);
|
||||||
|
// config
|
||||||
|
const enableGoogleConfig = formattedConfig?.IS_GOOGLE_ENABLED ?? "";
|
||||||
|
|
||||||
|
useSWR("INSTANCE_CONFIGURATIONS", () => fetchInstanceConfigurations());
|
||||||
|
|
||||||
|
const updateConfig = async (key: "IS_GOOGLE_ENABLED", value: string) => {
|
||||||
|
setIsSubmitting(true);
|
||||||
|
|
||||||
|
const payload = {
|
||||||
|
[key]: value,
|
||||||
|
};
|
||||||
|
|
||||||
|
const updateConfigPromise = updateInstanceConfigurations(payload);
|
||||||
|
|
||||||
|
setPromiseToast(updateConfigPromise, {
|
||||||
|
loading: "Saving Configuration",
|
||||||
|
success: {
|
||||||
|
title: "Configuration saved",
|
||||||
|
message: () => `Google authentication is now ${value === "1" ? "active" : "disabled"}.`,
|
||||||
|
},
|
||||||
|
error: {
|
||||||
|
title: "Error",
|
||||||
|
message: () => "Failed to save configuration",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await updateConfigPromise
|
||||||
|
.then(() => {
|
||||||
|
setIsSubmitting(false);
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
console.error(err);
|
||||||
|
setIsSubmitting(false);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
customHeader={
|
||||||
|
<AuthenticationMethodCard
|
||||||
|
name="Google"
|
||||||
|
description="Allow members to login or sign up to plane with their Google
|
||||||
|
accounts."
|
||||||
|
icon={<img src={GoogleLogo} height={24} width={24} alt="Google Logo" />}
|
||||||
|
config={
|
||||||
|
<ToggleSwitch
|
||||||
|
value={Boolean(parseInt(enableGoogleConfig))}
|
||||||
|
onChange={() => {
|
||||||
|
if (Boolean(parseInt(enableGoogleConfig)) === true) {
|
||||||
|
updateConfig("IS_GOOGLE_ENABLED", "0");
|
||||||
|
} else {
|
||||||
|
updateConfig("IS_GOOGLE_ENABLED", "1");
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
size="sm"
|
||||||
|
disabled={isSubmitting || !formattedConfig}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
disabled={isSubmitting || !formattedConfig}
|
||||||
|
withBorder={false}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{formattedConfig ? (
|
||||||
|
<InstanceGoogleConfigForm config={formattedConfig} />
|
||||||
|
) : (
|
||||||
|
<Loader className="space-y-8">
|
||||||
|
<Loader.Item height="50px" width="25%" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" />
|
||||||
|
<Loader.Item height="50px" width="50%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "Google Authentication - God Mode" }];
|
||||||
|
|
||||||
|
export default InstanceGoogleAuthenticationPage;
|
||||||
@@ -0,0 +1,174 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useCallback, useRef, useState } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import { useTheme } from "next-themes";
|
||||||
|
import useSWR from "swr";
|
||||||
|
// plane internal packages
|
||||||
|
import { setPromiseToast, setToast, TOAST_TYPE } from "@plane/propel/toast";
|
||||||
|
import type { TInstanceConfigurationKeys, TInstanceAuthenticationModes } from "@plane/types";
|
||||||
|
import { Loader, ToggleSwitch } from "@plane/ui";
|
||||||
|
import { cn, resolveGeneralTheme } from "@plane/utils";
|
||||||
|
// components
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
import { AuthenticationMethodCard } from "@/components/authentication/authentication-method-card";
|
||||||
|
// helpers
|
||||||
|
import { canDisableAuthMethod } from "@/helpers/authentication";
|
||||||
|
// hooks
|
||||||
|
import { useAuthenticationModes } from "@/hooks/oauth";
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
|
||||||
|
const InstanceAuthenticationPage = observer(function InstanceAuthenticationPage(_props: Route.ComponentProps) {
|
||||||
|
// theme
|
||||||
|
const { resolvedTheme: resolvedThemeAdmin } = useTheme();
|
||||||
|
const resolvedTheme = resolveGeneralTheme(resolvedThemeAdmin);
|
||||||
|
// Ref to store authentication modes for validation (avoids circular dependency)
|
||||||
|
const authenticationModesRef = useRef<TInstanceAuthenticationModes[]>([]);
|
||||||
|
// state
|
||||||
|
const [isSubmitting, setIsSubmitting] = useState<boolean>(false);
|
||||||
|
// store hooks
|
||||||
|
const { fetchInstanceConfigurations, formattedConfig, updateInstanceConfigurations } = useInstance();
|
||||||
|
// derived values
|
||||||
|
const enableSignUpConfig = formattedConfig?.ENABLE_SIGNUP ?? "";
|
||||||
|
|
||||||
|
useSWR("INSTANCE_CONFIGURATIONS", () => fetchInstanceConfigurations());
|
||||||
|
|
||||||
|
// Create updateConfig with validation - uses authenticationModesRef for current modes
|
||||||
|
const updateConfig = useCallback(
|
||||||
|
(key: TInstanceConfigurationKeys, value: string): void => {
|
||||||
|
// Check if trying to disable (value === "0")
|
||||||
|
if (value === "0") {
|
||||||
|
// Check if this key is an authentication method key
|
||||||
|
const currentAuthModes = authenticationModesRef.current;
|
||||||
|
const isAuthMethodKey = currentAuthModes.some((method) => method.enabledConfigKey === key);
|
||||||
|
|
||||||
|
// Only validate if this is an authentication method key
|
||||||
|
if (isAuthMethodKey) {
|
||||||
|
const canDisable = canDisableAuthMethod(key, currentAuthModes, formattedConfig);
|
||||||
|
|
||||||
|
if (!canDisable) {
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.ERROR,
|
||||||
|
title: "Cannot disable authentication",
|
||||||
|
message:
|
||||||
|
"At least one authentication method must remain enabled. Please enable another method before disabling this one.",
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Proceed with the update
|
||||||
|
setIsSubmitting(true);
|
||||||
|
|
||||||
|
const payload = {
|
||||||
|
[key]: value,
|
||||||
|
};
|
||||||
|
|
||||||
|
const updateConfigPromise = updateInstanceConfigurations(payload);
|
||||||
|
|
||||||
|
setPromiseToast(updateConfigPromise, {
|
||||||
|
loading: "Saving configuration",
|
||||||
|
success: {
|
||||||
|
title: "Success",
|
||||||
|
message: () => "Configuration saved successfully",
|
||||||
|
},
|
||||||
|
error: {
|
||||||
|
title: "Error",
|
||||||
|
message: () => "Failed to save configuration",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
void updateConfigPromise
|
||||||
|
.then(() => {
|
||||||
|
setIsSubmitting(false);
|
||||||
|
return undefined;
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
console.error(err);
|
||||||
|
setIsSubmitting(false);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
[formattedConfig, updateInstanceConfigurations]
|
||||||
|
);
|
||||||
|
|
||||||
|
// Get authentication modes - this will use updateConfig which includes validation
|
||||||
|
const authenticationModes = useAuthenticationModes({
|
||||||
|
disabled: isSubmitting,
|
||||||
|
updateConfig,
|
||||||
|
resolvedTheme,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Update ref with latest authentication modes
|
||||||
|
authenticationModesRef.current = authenticationModes;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
header={{
|
||||||
|
title: "Manage authentication modes for your instance",
|
||||||
|
description: "Configure authentication modes for your team and restrict sign-ups to be invite only.",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{formattedConfig ? (
|
||||||
|
<div className="space-y-3">
|
||||||
|
<div className={cn("flex w-full items-center gap-14 rounded-sm")}>
|
||||||
|
<div className="flex grow items-center gap-4">
|
||||||
|
<div className="grow">
|
||||||
|
<div className="pb-1 text-16 font-medium">Allow anyone to sign up even without an invite</div>
|
||||||
|
<div className={cn("text-11 leading-5 font-regular text-tertiary")}>
|
||||||
|
Toggling this off will only let users sign up when they are invited.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className={`shrink-0 pr-4 ${isSubmitting && "opacity-70"}`}>
|
||||||
|
<div className="flex items-center gap-4">
|
||||||
|
<ToggleSwitch
|
||||||
|
value={Boolean(parseInt(enableSignUpConfig))}
|
||||||
|
onChange={() => {
|
||||||
|
if (Boolean(parseInt(enableSignUpConfig)) === true) {
|
||||||
|
updateConfig("ENABLE_SIGNUP", "0");
|
||||||
|
} else {
|
||||||
|
updateConfig("ENABLE_SIGNUP", "1");
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
size="sm"
|
||||||
|
disabled={isSubmitting}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="text-lg pt-6 font-medium">Available authentication modes</div>
|
||||||
|
{authenticationModes.map((method) => (
|
||||||
|
<AuthenticationMethodCard
|
||||||
|
key={method.key}
|
||||||
|
name={method.name}
|
||||||
|
description={method.description}
|
||||||
|
icon={method.icon}
|
||||||
|
config={method.config}
|
||||||
|
disabled={isSubmitting}
|
||||||
|
unavailable={method.unavailable}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
) : (
|
||||||
|
<Loader className="space-y-10">
|
||||||
|
<Loader.Item height="50px" width="75%" />
|
||||||
|
<Loader.Item height="50px" width="75%" />
|
||||||
|
<Loader.Item height="50px" width="40%" />
|
||||||
|
<Loader.Item height="50px" width="40%" />
|
||||||
|
<Loader.Item height="50px" width="20%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "Authentication Settings - Plane Web" }];
|
||||||
|
|
||||||
|
export default InstanceAuthenticationPage;
|
||||||
@@ -0,0 +1,232 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useMemo, useState } from "react";
|
||||||
|
import { useForm } from "react-hook-form";
|
||||||
|
// types
|
||||||
|
import { Button } from "@plane/propel/button";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import type { IFormattedInstanceConfiguration, TInstanceEmailConfigurationKeys } from "@plane/types";
|
||||||
|
// ui
|
||||||
|
import { CustomSelect } from "@plane/ui";
|
||||||
|
// components
|
||||||
|
import type { TControllerInputFormField } from "@/components/common/controller-input";
|
||||||
|
import { ControllerInput } from "@/components/common/controller-input";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// local components
|
||||||
|
import { SendTestEmailModal } from "./test-email-modal";
|
||||||
|
|
||||||
|
type IInstanceEmailForm = {
|
||||||
|
config: IFormattedInstanceConfiguration;
|
||||||
|
};
|
||||||
|
|
||||||
|
type EmailFormValues = Record<TInstanceEmailConfigurationKeys, string>;
|
||||||
|
|
||||||
|
type TEmailSecurityKeys = "EMAIL_USE_TLS" | "EMAIL_USE_SSL" | "NONE";
|
||||||
|
|
||||||
|
const EMAIL_SECURITY_OPTIONS: { [key in TEmailSecurityKeys]: string } = {
|
||||||
|
EMAIL_USE_TLS: "TLS",
|
||||||
|
EMAIL_USE_SSL: "SSL",
|
||||||
|
NONE: "No email security",
|
||||||
|
};
|
||||||
|
|
||||||
|
export function InstanceEmailForm(props: IInstanceEmailForm) {
|
||||||
|
const { config } = props;
|
||||||
|
// states
|
||||||
|
const [isSendTestEmailModalOpen, setIsSendTestEmailModalOpen] = useState(false);
|
||||||
|
// store hooks
|
||||||
|
const { updateInstanceConfigurations } = useInstance();
|
||||||
|
// form data
|
||||||
|
const {
|
||||||
|
handleSubmit,
|
||||||
|
watch,
|
||||||
|
setValue,
|
||||||
|
control,
|
||||||
|
formState: { errors, isValid, isDirty, isSubmitting },
|
||||||
|
} = useForm<EmailFormValues>({
|
||||||
|
defaultValues: {
|
||||||
|
EMAIL_HOST: config["EMAIL_HOST"],
|
||||||
|
EMAIL_PORT: config["EMAIL_PORT"],
|
||||||
|
EMAIL_HOST_USER: config["EMAIL_HOST_USER"],
|
||||||
|
EMAIL_HOST_PASSWORD: config["EMAIL_HOST_PASSWORD"],
|
||||||
|
EMAIL_USE_TLS: config["EMAIL_USE_TLS"],
|
||||||
|
EMAIL_USE_SSL: config["EMAIL_USE_SSL"],
|
||||||
|
EMAIL_FROM: config["EMAIL_FROM"],
|
||||||
|
ENABLE_SMTP: config["ENABLE_SMTP"],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const emailFormFields: TControllerInputFormField[] = [
|
||||||
|
{
|
||||||
|
key: "EMAIL_HOST",
|
||||||
|
type: "text",
|
||||||
|
label: "Host",
|
||||||
|
placeholder: "email.google.com",
|
||||||
|
error: Boolean(errors.EMAIL_HOST),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "EMAIL_PORT",
|
||||||
|
type: "text",
|
||||||
|
label: "Port",
|
||||||
|
placeholder: "8080",
|
||||||
|
error: Boolean(errors.EMAIL_PORT),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "EMAIL_FROM",
|
||||||
|
type: "text",
|
||||||
|
label: "Sender's email address",
|
||||||
|
description:
|
||||||
|
"This is the email address your users will see when getting emails from this instance. You will need to verify this address.",
|
||||||
|
placeholder: "no-reply@projectplane.so",
|
||||||
|
error: Boolean(errors.EMAIL_FROM),
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const OptionalEmailFormFields: TControllerInputFormField[] = [
|
||||||
|
{
|
||||||
|
key: "EMAIL_HOST_USER",
|
||||||
|
type: "text",
|
||||||
|
label: "Username",
|
||||||
|
placeholder: "getitdone@projectplane.so",
|
||||||
|
error: Boolean(errors.EMAIL_HOST_USER),
|
||||||
|
required: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "EMAIL_HOST_PASSWORD",
|
||||||
|
type: "password",
|
||||||
|
label: "Password",
|
||||||
|
placeholder: "Password",
|
||||||
|
error: Boolean(errors.EMAIL_HOST_PASSWORD),
|
||||||
|
required: false,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const onSubmit = async (formData: EmailFormValues) => {
|
||||||
|
const payload: Partial<EmailFormValues> = { ...formData, ENABLE_SMTP: "1" };
|
||||||
|
|
||||||
|
await updateInstanceConfigurations(payload)
|
||||||
|
.then(() =>
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
title: "Success",
|
||||||
|
message: "Email Settings updated successfully",
|
||||||
|
})
|
||||||
|
)
|
||||||
|
.catch((err) => console.error(err));
|
||||||
|
};
|
||||||
|
|
||||||
|
const useTLSValue = watch("EMAIL_USE_TLS");
|
||||||
|
const useSSLValue = watch("EMAIL_USE_SSL");
|
||||||
|
const emailSecurityKey: TEmailSecurityKeys = useMemo(() => {
|
||||||
|
if (useTLSValue === "1") return "EMAIL_USE_TLS";
|
||||||
|
if (useSSLValue === "1") return "EMAIL_USE_SSL";
|
||||||
|
return "NONE";
|
||||||
|
}, [useTLSValue, useSSLValue]);
|
||||||
|
|
||||||
|
const handleEmailSecurityChange = (key: TEmailSecurityKeys) => {
|
||||||
|
if (key === "EMAIL_USE_SSL") {
|
||||||
|
setValue("EMAIL_USE_TLS", "0");
|
||||||
|
setValue("EMAIL_USE_SSL", "1");
|
||||||
|
}
|
||||||
|
if (key === "EMAIL_USE_TLS") {
|
||||||
|
setValue("EMAIL_USE_TLS", "1");
|
||||||
|
setValue("EMAIL_USE_SSL", "0");
|
||||||
|
}
|
||||||
|
if (key === "NONE") {
|
||||||
|
setValue("EMAIL_USE_TLS", "0");
|
||||||
|
setValue("EMAIL_USE_SSL", "0");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="space-y-8">
|
||||||
|
<div>
|
||||||
|
<SendTestEmailModal isOpen={isSendTestEmailModalOpen} handleClose={() => setIsSendTestEmailModalOpen(false)} />
|
||||||
|
<div className="grid-col grid w-full max-w-4xl grid-cols-1 items-start justify-between gap-10 lg:grid-cols-2">
|
||||||
|
{emailFormFields.map((field) => (
|
||||||
|
<ControllerInput
|
||||||
|
key={field.key}
|
||||||
|
control={control}
|
||||||
|
type={field.type}
|
||||||
|
name={field.key}
|
||||||
|
label={field.label}
|
||||||
|
description={field.description}
|
||||||
|
placeholder={field.placeholder}
|
||||||
|
error={field.error}
|
||||||
|
required={field.required}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
<div className="flex flex-col gap-1">
|
||||||
|
<h4 className="text-13 text-tertiary">Email security</h4>
|
||||||
|
<CustomSelect
|
||||||
|
value={emailSecurityKey}
|
||||||
|
label={EMAIL_SECURITY_OPTIONS[emailSecurityKey]}
|
||||||
|
onChange={handleEmailSecurityChange}
|
||||||
|
buttonClassName="rounded-md border-subtle"
|
||||||
|
input
|
||||||
|
>
|
||||||
|
{Object.entries(EMAIL_SECURITY_OPTIONS).map(([key, value]) => (
|
||||||
|
<CustomSelect.Option key={key} value={key} className="w-full">
|
||||||
|
{value}
|
||||||
|
</CustomSelect.Option>
|
||||||
|
))}
|
||||||
|
</CustomSelect>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="my-6 flex flex-col gap-6 border-t border-subtle pt-4">
|
||||||
|
<div className="flex w-full max-w-xl flex-col gap-y-10 px-1">
|
||||||
|
<div className="mr-8 flex items-center gap-10 pt-4">
|
||||||
|
<div className="grow">
|
||||||
|
<div className="text-13 font-medium text-primary">Authentication</div>
|
||||||
|
<div className="text-11 font-regular text-tertiary">
|
||||||
|
This is optional, but we recommend setting up a username and a password for your SMTP server.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="grid-col grid w-full max-w-4xl grid-cols-1 items-center justify-between gap-10 lg:grid-cols-2">
|
||||||
|
{OptionalEmailFormFields.map((field) => (
|
||||||
|
<ControllerInput
|
||||||
|
key={field.key}
|
||||||
|
control={control}
|
||||||
|
type={field.type}
|
||||||
|
name={field.key}
|
||||||
|
label={field.label}
|
||||||
|
description={field.description}
|
||||||
|
placeholder={field.placeholder}
|
||||||
|
error={field.error}
|
||||||
|
required={field.required}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="flex max-w-4xl items-center gap-4 py-1">
|
||||||
|
<Button
|
||||||
|
variant="primary"
|
||||||
|
size="lg"
|
||||||
|
onClick={handleSubmit(onSubmit)}
|
||||||
|
loading={isSubmitting}
|
||||||
|
disabled={!isValid || !isDirty}
|
||||||
|
>
|
||||||
|
{isSubmitting ? "Saving" : "Save changes"}
|
||||||
|
</Button>
|
||||||
|
<Button
|
||||||
|
variant="secondary"
|
||||||
|
size="lg"
|
||||||
|
onClick={() => setIsSendTestEmailModalOpen(true)}
|
||||||
|
loading={isSubmitting}
|
||||||
|
disabled={!isValid}
|
||||||
|
>
|
||||||
|
Send test email
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useEffect, useState } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import useSWR from "swr";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import { Loader, ToggleSwitch } from "@plane/ui";
|
||||||
|
// components
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
// local
|
||||||
|
import { InstanceEmailForm } from "./email-config-form";
|
||||||
|
|
||||||
|
const InstanceEmailPage = observer(function InstanceEmailPage(_props: Route.ComponentProps) {
|
||||||
|
// store
|
||||||
|
const { fetchInstanceConfigurations, formattedConfig, disableEmail } = useInstance();
|
||||||
|
|
||||||
|
const { isLoading } = useSWR("INSTANCE_CONFIGURATIONS", () => fetchInstanceConfigurations());
|
||||||
|
|
||||||
|
const [isSubmitting, setIsSubmitting] = useState(false);
|
||||||
|
const [isSMTPEnabled, setIsSMTPEnabled] = useState(false);
|
||||||
|
|
||||||
|
const handleToggle = async () => {
|
||||||
|
if (isSMTPEnabled) {
|
||||||
|
setIsSubmitting(true);
|
||||||
|
try {
|
||||||
|
await disableEmail();
|
||||||
|
setIsSMTPEnabled(false);
|
||||||
|
setToast({
|
||||||
|
title: "Email feature disabled",
|
||||||
|
message: "Email feature has been disabled",
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
});
|
||||||
|
} catch (_error) {
|
||||||
|
setToast({
|
||||||
|
title: "Error disabling email",
|
||||||
|
message: "Failed to disable email feature. Please try again.",
|
||||||
|
type: TOAST_TYPE.ERROR,
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
setIsSubmitting(false);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
setIsSMTPEnabled(true);
|
||||||
|
};
|
||||||
|
useEffect(() => {
|
||||||
|
if (formattedConfig) {
|
||||||
|
setIsSMTPEnabled(formattedConfig.ENABLE_SMTP === "1");
|
||||||
|
}
|
||||||
|
}, [formattedConfig]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
header={{
|
||||||
|
title: "Secure emails from your own instance",
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Plane can send useful emails to you and your users from your own instance without talking to the Internet.
|
||||||
|
<div className="text-13 font-regular text-tertiary">
|
||||||
|
Set it up below and please test your settings before you save them.
|
||||||
|
<span className="text-danger-primary">Misconfigs can lead to email bounces and errors.</span>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
actions: isLoading ? (
|
||||||
|
<Loader>
|
||||||
|
<Loader.Item width="24px" height="16px" className="rounded-full" />
|
||||||
|
</Loader>
|
||||||
|
) : (
|
||||||
|
<ToggleSwitch value={isSMTPEnabled} onChange={handleToggle} size="sm" disabled={isSubmitting} />
|
||||||
|
),
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{isSMTPEnabled && !isLoading && (
|
||||||
|
<>
|
||||||
|
{formattedConfig ? (
|
||||||
|
<InstanceEmailForm config={formattedConfig} />
|
||||||
|
) : (
|
||||||
|
<Loader className="space-y-10">
|
||||||
|
<Loader.Item height="50px" width="75%" />
|
||||||
|
<Loader.Item height="50px" width="75%" />
|
||||||
|
<Loader.Item height="50px" width="40%" />
|
||||||
|
<Loader.Item height="50px" width="40%" />
|
||||||
|
<Loader.Item height="50px" width="20%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "Email Settings - God Mode" }];
|
||||||
|
|
||||||
|
export default InstanceEmailPage;
|
||||||
@@ -0,0 +1,142 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useEffect, useState, Fragment } from "react";
|
||||||
|
import { Dialog, Transition } from "@headlessui/react";
|
||||||
|
// plane imports
|
||||||
|
import { Button } from "@plane/propel/button";
|
||||||
|
import { InstanceService } from "@plane/services";
|
||||||
|
// ui
|
||||||
|
import { Input } from "@plane/ui";
|
||||||
|
|
||||||
|
type Props = {
|
||||||
|
isOpen: boolean;
|
||||||
|
handleClose: () => void;
|
||||||
|
};
|
||||||
|
|
||||||
|
enum ESendEmailSteps {
|
||||||
|
SEND_EMAIL = "SEND_EMAIL",
|
||||||
|
SUCCESS = "SUCCESS",
|
||||||
|
FAILED = "FAILED",
|
||||||
|
}
|
||||||
|
|
||||||
|
const instanceService = new InstanceService();
|
||||||
|
|
||||||
|
export function SendTestEmailModal(props: Props) {
|
||||||
|
const { isOpen, handleClose } = props;
|
||||||
|
|
||||||
|
// state
|
||||||
|
const [receiverEmail, setReceiverEmail] = useState("");
|
||||||
|
const [sendEmailStep, setSendEmailStep] = useState<ESendEmailSteps>(ESendEmailSteps.SEND_EMAIL);
|
||||||
|
const [isLoading, setIsLoading] = useState(false);
|
||||||
|
const [error, setError] = useState("");
|
||||||
|
|
||||||
|
// reset state
|
||||||
|
const resetState = () => {
|
||||||
|
setReceiverEmail("");
|
||||||
|
setSendEmailStep(ESendEmailSteps.SEND_EMAIL);
|
||||||
|
setIsLoading(false);
|
||||||
|
setError("");
|
||||||
|
};
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (!isOpen) {
|
||||||
|
resetState();
|
||||||
|
}
|
||||||
|
}, [isOpen]);
|
||||||
|
|
||||||
|
const handleSubmit = async (e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => {
|
||||||
|
e.preventDefault();
|
||||||
|
|
||||||
|
setIsLoading(true);
|
||||||
|
await instanceService
|
||||||
|
.sendTestEmail(receiverEmail)
|
||||||
|
.then(() => {
|
||||||
|
setSendEmailStep(ESendEmailSteps.SUCCESS);
|
||||||
|
})
|
||||||
|
.catch((error) => {
|
||||||
|
setError(error?.error || "Failed to send email");
|
||||||
|
setSendEmailStep(ESendEmailSteps.FAILED);
|
||||||
|
})
|
||||||
|
.finally(() => {
|
||||||
|
setIsLoading(false);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Transition.Root show={isOpen} as={Fragment}>
|
||||||
|
<Dialog as="div" className="relative z-20" onClose={handleClose}>
|
||||||
|
<Transition.Child
|
||||||
|
as={Fragment}
|
||||||
|
enter="ease-out duration-300"
|
||||||
|
enterFrom="opacity-0"
|
||||||
|
enterTo="opacity-100"
|
||||||
|
leave="ease-in duration-200"
|
||||||
|
leaveFrom="opacity-100"
|
||||||
|
leaveTo="opacity-0"
|
||||||
|
>
|
||||||
|
<div className="fixed inset-0 bg-backdrop transition-opacity" />
|
||||||
|
</Transition.Child>
|
||||||
|
<div className="fixed inset-0 z-20 overflow-y-auto">
|
||||||
|
<div className="my-10 flex justify-center p-4 text-center sm:p-0 md:my-20">
|
||||||
|
<Transition.Child
|
||||||
|
as={Fragment}
|
||||||
|
enter="ease-out duration-300"
|
||||||
|
enterFrom="opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95"
|
||||||
|
enterTo="opacity-100 translate-y-0 sm:scale-100"
|
||||||
|
leave="ease-in duration-200"
|
||||||
|
leaveFrom="opacity-100 translate-y-0 sm:scale-100"
|
||||||
|
leaveTo="opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95"
|
||||||
|
>
|
||||||
|
<Dialog.Panel className="relative w-full transform rounded-lg bg-surface-1 p-5 px-4 text-left shadow-raised-200 transition-all sm:max-w-xl">
|
||||||
|
<h3 className="text-16 leading-6 font-medium text-primary">
|
||||||
|
{sendEmailStep === ESendEmailSteps.SEND_EMAIL
|
||||||
|
? "Send test email"
|
||||||
|
: sendEmailStep === ESendEmailSteps.SUCCESS
|
||||||
|
? "Email send"
|
||||||
|
: "Failed"}{" "}
|
||||||
|
</h3>
|
||||||
|
<div className="pt-6 pb-2">
|
||||||
|
{sendEmailStep === ESendEmailSteps.SEND_EMAIL && (
|
||||||
|
<Input
|
||||||
|
id="receiver_email"
|
||||||
|
type="email"
|
||||||
|
value={receiverEmail}
|
||||||
|
onChange={(e) => setReceiverEmail(e.target.value)}
|
||||||
|
placeholder="Receiver email"
|
||||||
|
className="w-full resize-none text-16"
|
||||||
|
tabIndex={1}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
{sendEmailStep === ESendEmailSteps.SUCCESS && (
|
||||||
|
<div className="flex flex-col gap-y-4 text-13">
|
||||||
|
<p>
|
||||||
|
We have sent the test email to {receiverEmail}. Please check your spam folder if you cannot find
|
||||||
|
it.
|
||||||
|
</p>
|
||||||
|
<p>If you still cannot find it, recheck your SMTP configuration and trigger a new test email.</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{sendEmailStep === ESendEmailSteps.FAILED && <div className="text-13">{error}</div>}
|
||||||
|
<div className="mt-5 flex items-center justify-end gap-2">
|
||||||
|
<Button variant="secondary" size="lg" onClick={handleClose} tabIndex={2}>
|
||||||
|
{sendEmailStep === ESendEmailSteps.SEND_EMAIL ? "Cancel" : "Close"}
|
||||||
|
</Button>
|
||||||
|
{sendEmailStep === ESendEmailSteps.SEND_EMAIL && (
|
||||||
|
<Button variant="primary" size="lg" loading={isLoading} onClick={handleSubmit} tabIndex={3}>
|
||||||
|
{isLoading ? "Sending email" : "Send email"}
|
||||||
|
</Button>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</Dialog.Panel>
|
||||||
|
</Transition.Child>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</Dialog>
|
||||||
|
</Transition.Root>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import { Controller, useForm } from "react-hook-form";
|
||||||
|
import { Telescope } from "lucide-react";
|
||||||
|
// plane imports
|
||||||
|
import { Button } from "@plane/propel/button";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import type { IInstance, IInstanceAdmin } from "@plane/types";
|
||||||
|
import { Input, ToggleSwitch } from "@plane/ui";
|
||||||
|
// components
|
||||||
|
import { ControllerInput } from "@/components/common/controller-input";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// components
|
||||||
|
import { IntercomConfig } from "./intercom";
|
||||||
|
|
||||||
|
export interface IGeneralConfigurationForm {
|
||||||
|
instance: IInstance;
|
||||||
|
instanceAdmins: IInstanceAdmin[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export const GeneralConfigurationForm = observer(function GeneralConfigurationForm(props: IGeneralConfigurationForm) {
|
||||||
|
const { instance, instanceAdmins } = props;
|
||||||
|
// hooks
|
||||||
|
const { instanceConfigurations, updateInstanceInfo, updateInstanceConfigurations } = useInstance();
|
||||||
|
|
||||||
|
// form data
|
||||||
|
const {
|
||||||
|
handleSubmit,
|
||||||
|
control,
|
||||||
|
formState: { errors, isSubmitting },
|
||||||
|
watch,
|
||||||
|
} = useForm<Partial<IInstance>>({
|
||||||
|
defaultValues: {
|
||||||
|
instance_name: instance?.instance_name,
|
||||||
|
is_telemetry_enabled: instance?.is_telemetry_enabled,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const onSubmit = async (formData: Partial<IInstance>) => {
|
||||||
|
const payload: Partial<IInstance> = { ...formData };
|
||||||
|
|
||||||
|
// update the intercom configuration
|
||||||
|
const isIntercomEnabled =
|
||||||
|
instanceConfigurations?.find((config) => config.key === "IS_INTERCOM_ENABLED")?.value === "1";
|
||||||
|
if (!payload.is_telemetry_enabled && isIntercomEnabled) {
|
||||||
|
try {
|
||||||
|
await updateInstanceConfigurations({ IS_INTERCOM_ENABLED: "0" });
|
||||||
|
} catch (error) {
|
||||||
|
console.error(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
await updateInstanceInfo(payload)
|
||||||
|
.then(() =>
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
title: "Success",
|
||||||
|
message: "Settings updated successfully",
|
||||||
|
})
|
||||||
|
)
|
||||||
|
.catch((err) => console.error(err));
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="space-y-8">
|
||||||
|
<div className="space-y-4">
|
||||||
|
<div className="text-16 font-medium text-primary">Instance details</div>
|
||||||
|
<div className="grid-col grid w-full grid-cols-1 items-center justify-between gap-8 md:grid-cols-2 lg:grid-cols-3">
|
||||||
|
<ControllerInput
|
||||||
|
key="instance_name"
|
||||||
|
name="instance_name"
|
||||||
|
control={control}
|
||||||
|
type="text"
|
||||||
|
label="Name of instance"
|
||||||
|
placeholder="Instance name"
|
||||||
|
error={Boolean(errors.instance_name)}
|
||||||
|
required
|
||||||
|
/>
|
||||||
|
|
||||||
|
<div className="flex flex-col gap-1">
|
||||||
|
<h4 className="text-13 text-tertiary">Email</h4>
|
||||||
|
<Input
|
||||||
|
id="email"
|
||||||
|
name="email"
|
||||||
|
type="email"
|
||||||
|
value={instanceAdmins[0]?.user_detail?.email ?? ""}
|
||||||
|
placeholder="Admin email"
|
||||||
|
className="w-full cursor-not-allowed !text-placeholder"
|
||||||
|
autoComplete="on"
|
||||||
|
disabled
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="flex flex-col gap-1">
|
||||||
|
<h4 className="text-13 text-tertiary">Instance ID</h4>
|
||||||
|
<Input
|
||||||
|
id="instance_id"
|
||||||
|
name="instance_id"
|
||||||
|
type="text"
|
||||||
|
value={instance.instance_id}
|
||||||
|
className="w-full cursor-not-allowed rounded-md font-medium !text-placeholder"
|
||||||
|
disabled
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="space-y-6">
|
||||||
|
<div className="border-b border-subtle pb-1.5 text-16 font-medium text-primary">Chat + telemetry</div>
|
||||||
|
<IntercomConfig isTelemetryEnabled={watch("is_telemetry_enabled") ?? false} />
|
||||||
|
<div className="flex items-center gap-14">
|
||||||
|
<div className="flex grow items-center gap-4">
|
||||||
|
<div className="shrink-0">
|
||||||
|
<div className="flex size-11 items-center justify-center rounded-lg bg-layer-1">
|
||||||
|
<Telescope className="size-5 text-tertiary" />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="grow">
|
||||||
|
<div className="text-13 leading-5 font-medium text-primary">Let Plane collect anonymous usage data</div>
|
||||||
|
<div className="text-11 leading-5 font-regular text-tertiary">
|
||||||
|
No PII is collected.This anonymized data is used to understand how you use Plane and build new features
|
||||||
|
in line with{" "}
|
||||||
|
<a
|
||||||
|
href="https://developers.plane.so/self-hosting/telemetry"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
our Telemetry Policy.
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className={`shrink-0 ${isSubmitting && "opacity-70"}`}>
|
||||||
|
<Controller
|
||||||
|
control={control}
|
||||||
|
name="is_telemetry_enabled"
|
||||||
|
render={({ field: { value, onChange } }) => (
|
||||||
|
<ToggleSwitch value={value ?? false} onChange={onChange} size="sm" disabled={isSubmitting} />
|
||||||
|
)}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div>
|
||||||
|
<Button
|
||||||
|
variant="primary"
|
||||||
|
size="lg"
|
||||||
|
onClick={() => {
|
||||||
|
void handleSubmit(onSubmit)();
|
||||||
|
}}
|
||||||
|
loading={isSubmitting}
|
||||||
|
>
|
||||||
|
{isSubmitting ? "Saving" : "Save changes"}
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import useSWR from "swr";
|
||||||
|
import { MessageSquare } from "lucide-react";
|
||||||
|
import type { IFormattedInstanceConfiguration } from "@plane/types";
|
||||||
|
import { ToggleSwitch } from "@plane/ui";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
|
||||||
|
type TIntercomConfig = {
|
||||||
|
isTelemetryEnabled: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const IntercomConfig = observer(function IntercomConfig(props: TIntercomConfig) {
|
||||||
|
const { isTelemetryEnabled } = props;
|
||||||
|
// hooks
|
||||||
|
const { instanceConfigurations, updateInstanceConfigurations, fetchInstanceConfigurations } = useInstance();
|
||||||
|
// states
|
||||||
|
const [isSubmitting, setIsSubmitting] = useState<boolean>(false);
|
||||||
|
|
||||||
|
// derived values
|
||||||
|
const isIntercomEnabled = isTelemetryEnabled
|
||||||
|
? instanceConfigurations
|
||||||
|
? instanceConfigurations?.find((config) => config.key === "IS_INTERCOM_ENABLED")?.value === "1"
|
||||||
|
? true
|
||||||
|
: false
|
||||||
|
: undefined
|
||||||
|
: false;
|
||||||
|
|
||||||
|
const { isLoading } = useSWR(isTelemetryEnabled ? "INSTANCE_CONFIGURATIONS" : null, () =>
|
||||||
|
isTelemetryEnabled ? fetchInstanceConfigurations() : null
|
||||||
|
);
|
||||||
|
|
||||||
|
const initialLoader = isLoading && isIntercomEnabled === undefined;
|
||||||
|
|
||||||
|
const submitInstanceConfigurations = async (payload: Partial<IFormattedInstanceConfiguration>) => {
|
||||||
|
try {
|
||||||
|
await updateInstanceConfigurations(payload);
|
||||||
|
} catch (error) {
|
||||||
|
console.error(error);
|
||||||
|
} finally {
|
||||||
|
setIsSubmitting(false);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const enableIntercomConfig = () => {
|
||||||
|
void submitInstanceConfigurations({ IS_INTERCOM_ENABLED: isIntercomEnabled ? "0" : "1" });
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<div className="flex items-center gap-14">
|
||||||
|
<div className="flex grow items-center gap-4">
|
||||||
|
<div className="shrink-0">
|
||||||
|
<div className="flex size-11 items-center justify-center rounded-lg bg-layer-1">
|
||||||
|
<MessageSquare className="size-5 p-0.5 text-tertiary" />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="grow">
|
||||||
|
<div className="text-13 leading-5 font-medium text-primary">Chat with us</div>
|
||||||
|
<div className="text-11 leading-5 font-regular text-tertiary">
|
||||||
|
Let your users chat with us via Intercom or another service. Toggling Telemetry off turns this off
|
||||||
|
automatically.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="ml-auto">
|
||||||
|
<ToggleSwitch
|
||||||
|
value={isIntercomEnabled ? true : false}
|
||||||
|
onChange={enableIntercomConfig}
|
||||||
|
size="sm"
|
||||||
|
disabled={!isTelemetryEnabled || isSubmitting || initialLoader}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
// components
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// local imports
|
||||||
|
import { GeneralConfigurationForm } from "./form";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
|
||||||
|
function GeneralPage() {
|
||||||
|
const { instance, instanceAdmins } = useInstance();
|
||||||
|
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
header={{
|
||||||
|
title: "General settings",
|
||||||
|
description:
|
||||||
|
"Change the name of your instance and instance admin e-mail addresses. Enable or disable telemetry in your instance.",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{instance && instanceAdmins && <GeneralConfigurationForm instance={instance} instanceAdmins={instanceAdmins} />}
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "General Settings - God Mode" }];
|
||||||
|
|
||||||
|
export default observer(GeneralPage);
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useForm } from "react-hook-form";
|
||||||
|
import { Button } from "@plane/propel/button";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import type { IFormattedInstanceConfiguration, TInstanceImageConfigurationKeys } from "@plane/types";
|
||||||
|
// components
|
||||||
|
import { ControllerInput } from "@/components/common/controller-input";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
|
||||||
|
type IInstanceImageConfigForm = {
|
||||||
|
config: IFormattedInstanceConfiguration;
|
||||||
|
};
|
||||||
|
|
||||||
|
type ImageConfigFormValues = Record<TInstanceImageConfigurationKeys, string>;
|
||||||
|
|
||||||
|
export function InstanceImageConfigForm(props: IInstanceImageConfigForm) {
|
||||||
|
const { config } = props;
|
||||||
|
// store hooks
|
||||||
|
const { updateInstanceConfigurations } = useInstance();
|
||||||
|
// form data
|
||||||
|
const {
|
||||||
|
handleSubmit,
|
||||||
|
control,
|
||||||
|
formState: { errors, isSubmitting },
|
||||||
|
} = useForm<ImageConfigFormValues>({
|
||||||
|
defaultValues: {
|
||||||
|
UNSPLASH_ACCESS_KEY: config["UNSPLASH_ACCESS_KEY"],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const onSubmit = async (formData: ImageConfigFormValues) => {
|
||||||
|
const payload: Partial<ImageConfigFormValues> = { ...formData };
|
||||||
|
|
||||||
|
await updateInstanceConfigurations(payload)
|
||||||
|
.then(() =>
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
title: "Success",
|
||||||
|
message: "Image Configuration Settings updated successfully",
|
||||||
|
})
|
||||||
|
)
|
||||||
|
.catch((err) => console.error(err));
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="space-y-8">
|
||||||
|
<div className="grid-col grid w-full grid-cols-1 items-center justify-between gap-x-16 gap-y-8 lg:grid-cols-2">
|
||||||
|
<ControllerInput
|
||||||
|
control={control}
|
||||||
|
type="password"
|
||||||
|
name="UNSPLASH_ACCESS_KEY"
|
||||||
|
label="Access key from your Unsplash account"
|
||||||
|
description={
|
||||||
|
<>
|
||||||
|
You will find your access key in your Unsplash developer console.
|
||||||
|
<a
|
||||||
|
href="https://unsplash.com/documentation#creating-a-developer-account"
|
||||||
|
target="_blank"
|
||||||
|
className="text-accent-primary hover:underline"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
Learn more.
|
||||||
|
</a>
|
||||||
|
</>
|
||||||
|
}
|
||||||
|
placeholder="oXgq-sdfadsaeweqasdfasdf3234234rassd"
|
||||||
|
error={Boolean(errors.UNSPLASH_ACCESS_KEY)}
|
||||||
|
required
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div>
|
||||||
|
<Button variant="primary" size="lg" onClick={handleSubmit(onSubmit)} loading={isSubmitting}>
|
||||||
|
{isSubmitting ? "Saving" : "Save changes"}
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import useSWR from "swr";
|
||||||
|
import { Loader } from "@plane/ui";
|
||||||
|
// components
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
// local
|
||||||
|
import { InstanceImageConfigForm } from "./form";
|
||||||
|
|
||||||
|
const InstanceImagePage = observer(function InstanceImagePage(_props: Route.ComponentProps) {
|
||||||
|
// store
|
||||||
|
const { formattedConfig, fetchInstanceConfigurations } = useInstance();
|
||||||
|
|
||||||
|
useSWR("INSTANCE_CONFIGURATIONS", () => fetchInstanceConfigurations());
|
||||||
|
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
header={{
|
||||||
|
title: "Third-party image libraries",
|
||||||
|
description: "Let your users search and choose images from third-party libraries",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{formattedConfig ? (
|
||||||
|
<InstanceImageConfigForm config={formattedConfig} />
|
||||||
|
) : (
|
||||||
|
<Loader className="space-y-8">
|
||||||
|
<Loader.Item height="50px" width="50%" />
|
||||||
|
<Loader.Item height="50px" width="20%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "Images Settings - God Mode" }];
|
||||||
|
|
||||||
|
export default InstanceImagePage;
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useEffect } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import { useRouter } from "next/navigation";
|
||||||
|
import { Outlet } from "react-router";
|
||||||
|
// components
|
||||||
|
import { AdminHeader } from "@/components/common/header";
|
||||||
|
import { LogoSpinner } from "@/components/common/logo-spinner";
|
||||||
|
import { NewUserPopup } from "@/components/common/new-user-popup";
|
||||||
|
// hooks
|
||||||
|
import { useUser } from "@/hooks/store";
|
||||||
|
// local components
|
||||||
|
import type { Route } from "./+types/layout";
|
||||||
|
import { AdminSidebar } from "./sidebar";
|
||||||
|
|
||||||
|
function AdminLayout(_props: Route.ComponentProps) {
|
||||||
|
// router
|
||||||
|
const { replace } = useRouter();
|
||||||
|
// store hooks
|
||||||
|
const { isUserLoggedIn } = useUser();
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (isUserLoggedIn === false) replace("/");
|
||||||
|
}, [replace, isUserLoggedIn]);
|
||||||
|
|
||||||
|
if (isUserLoggedIn === undefined) {
|
||||||
|
return (
|
||||||
|
<div className="relative flex h-screen w-full items-center justify-center">
|
||||||
|
<LogoSpinner />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isUserLoggedIn) {
|
||||||
|
return (
|
||||||
|
<div className="relative flex h-screen w-screen overflow-hidden">
|
||||||
|
<AdminSidebar />
|
||||||
|
<main className="relative flex h-full w-full flex-col overflow-hidden bg-surface-1">
|
||||||
|
<AdminHeader />
|
||||||
|
<div className="vertical-scrollbar scrollbar-md h-full w-full overflow-hidden overflow-y-scroll">
|
||||||
|
<Outlet />
|
||||||
|
</div>
|
||||||
|
</main>
|
||||||
|
<NewUserPopup />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return <></>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export default observer(AdminLayout);
|
||||||
@@ -0,0 +1,151 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { Fragment, useEffect, useState } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import { useTheme as useNextTheme } from "next-themes";
|
||||||
|
import { LogOut, UserCog2, Palette } from "lucide-react";
|
||||||
|
import { Menu, Transition } from "@headlessui/react";
|
||||||
|
// plane internal packages
|
||||||
|
import { API_BASE_URL } from "@plane/constants";
|
||||||
|
import { AuthService } from "@plane/services";
|
||||||
|
import { Avatar } from "@plane/ui";
|
||||||
|
import { getFileURL, cn } from "@plane/utils";
|
||||||
|
// hooks
|
||||||
|
import { useTheme, useUser } from "@/hooks/store";
|
||||||
|
|
||||||
|
// service initialization
|
||||||
|
const authService = new AuthService();
|
||||||
|
|
||||||
|
export const AdminSidebarDropdown = observer(function AdminSidebarDropdown() {
|
||||||
|
// store hooks
|
||||||
|
const { isSidebarCollapsed } = useTheme();
|
||||||
|
const { currentUser, signOut } = useUser();
|
||||||
|
// hooks
|
||||||
|
const { resolvedTheme, setTheme } = useNextTheme();
|
||||||
|
// state
|
||||||
|
const [csrfToken, setCsrfToken] = useState<string | undefined>(undefined);
|
||||||
|
|
||||||
|
const handleThemeSwitch = () => {
|
||||||
|
const newTheme = resolvedTheme === "dark" ? "light" : "dark";
|
||||||
|
setTheme(newTheme);
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleSignOut = () => signOut();
|
||||||
|
|
||||||
|
const getSidebarMenuItems = () => (
|
||||||
|
<Menu.Items
|
||||||
|
className={cn(
|
||||||
|
"shadow-lg absolute left-0 z-20 mt-1.5 flex w-52 flex-col divide-y divide-subtle rounded-md border border-subtle bg-surface-1 px-1 py-2 text-11 outline-none",
|
||||||
|
{
|
||||||
|
"left-4": isSidebarCollapsed,
|
||||||
|
}
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
<div className="flex flex-col gap-2.5 pb-2">
|
||||||
|
<span className="truncate px-2 text-secondary">{currentUser?.email}</span>
|
||||||
|
</div>
|
||||||
|
<div className="py-2">
|
||||||
|
<Menu.Item
|
||||||
|
as="button"
|
||||||
|
type="button"
|
||||||
|
className="flex w-full items-center gap-2 rounded-sm px-2 py-1 hover:bg-layer-1-hover"
|
||||||
|
onClick={handleThemeSwitch}
|
||||||
|
>
|
||||||
|
<Palette className="h-4 w-4 stroke-[1.5]" />
|
||||||
|
Switch to {resolvedTheme === "dark" ? "light" : "dark"} mode
|
||||||
|
</Menu.Item>
|
||||||
|
</div>
|
||||||
|
<div className="py-2">
|
||||||
|
<form method="POST" action={`${API_BASE_URL}/api/instances/admins/sign-out/`} onSubmit={handleSignOut}>
|
||||||
|
<input type="hidden" name="csrfmiddlewaretoken" value={csrfToken} />
|
||||||
|
<Menu.Item
|
||||||
|
as="button"
|
||||||
|
type="submit"
|
||||||
|
className="flex w-full items-center gap-2 rounded-sm px-2 py-1 hover:bg-layer-1-hover"
|
||||||
|
>
|
||||||
|
<LogOut className="h-4 w-4 stroke-[1.5]" />
|
||||||
|
Sign out
|
||||||
|
</Menu.Item>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</Menu.Items>
|
||||||
|
);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (csrfToken === undefined)
|
||||||
|
void authService.requestCSRFToken().then((data) => data?.csrf_token && setCsrfToken(data.csrf_token));
|
||||||
|
}, [csrfToken]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="flex max-h-header items-center gap-x-5 gap-y-2 border-b border-subtle px-4 py-2.5">
|
||||||
|
<div className="h-full w-full truncate">
|
||||||
|
<div
|
||||||
|
className={`flex flex-grow items-center gap-x-2 truncate rounded-sm ${
|
||||||
|
isSidebarCollapsed ? "justify-center" : ""
|
||||||
|
}`}
|
||||||
|
>
|
||||||
|
<Menu as="div" className="flex-shrink-0">
|
||||||
|
<Menu.Button
|
||||||
|
className={cn("grid place-items-center outline-none", {
|
||||||
|
"cursor-default": !isSidebarCollapsed,
|
||||||
|
})}
|
||||||
|
>
|
||||||
|
<div className="flex size-8 flex-shrink-0 items-center justify-center rounded-sm bg-layer-1">
|
||||||
|
<UserCog2 className="size-5 text-primary" />
|
||||||
|
</div>
|
||||||
|
</Menu.Button>
|
||||||
|
{isSidebarCollapsed && (
|
||||||
|
<Transition
|
||||||
|
as={Fragment}
|
||||||
|
enter="transition ease-out duration-100"
|
||||||
|
enterFrom="transform opacity-0 scale-95"
|
||||||
|
enterTo="transform opacity-100 scale-100"
|
||||||
|
leave="transition ease-in duration-75"
|
||||||
|
leaveFrom="transform opacity-100 scale-100"
|
||||||
|
leaveTo="transform opacity-0 scale-95"
|
||||||
|
>
|
||||||
|
{getSidebarMenuItems()}
|
||||||
|
</Transition>
|
||||||
|
)}
|
||||||
|
</Menu>
|
||||||
|
|
||||||
|
{!isSidebarCollapsed && (
|
||||||
|
<div className="flex w-full gap-2">
|
||||||
|
<h4 className="grow truncate text-body-md-medium text-primary">Instance admin</h4>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{!isSidebarCollapsed && currentUser && (
|
||||||
|
<Menu as="div" className="relative flex-shrink-0">
|
||||||
|
<Menu.Button className="grid place-items-center outline-none">
|
||||||
|
<Avatar
|
||||||
|
name={currentUser.display_name}
|
||||||
|
src={getFileURL(currentUser.avatar_url)}
|
||||||
|
size={24}
|
||||||
|
shape="square"
|
||||||
|
className="!text-body-sm-medium"
|
||||||
|
/>
|
||||||
|
</Menu.Button>
|
||||||
|
|
||||||
|
<Transition
|
||||||
|
as={Fragment}
|
||||||
|
enter="transition ease-out duration-100"
|
||||||
|
enterFrom="transform opacity-0 scale-95"
|
||||||
|
enterTo="transform opacity-100 scale-100"
|
||||||
|
leave="transition ease-in duration-75"
|
||||||
|
leaveFrom="transform opacity-100 scale-100"
|
||||||
|
leaveTo="transform opacity-0 scale-95"
|
||||||
|
>
|
||||||
|
{getSidebarMenuItems()}
|
||||||
|
</Transition>
|
||||||
|
</Menu>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,143 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState, useRef } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import Link from "next/link";
|
||||||
|
import { HelpCircle, MessageSquare, MoveLeft } from "lucide-react";
|
||||||
|
import { Transition } from "@headlessui/react";
|
||||||
|
import { WEB_BASE_URL } from "@plane/constants";
|
||||||
|
// plane internal packages
|
||||||
|
import { GithubIcon, NewTabIcon, PageIcon } from "@plane/propel/icons";
|
||||||
|
import { Tooltip } from "@plane/propel/tooltip";
|
||||||
|
import { cn } from "@plane/utils";
|
||||||
|
// hooks
|
||||||
|
import { useInstance, useTheme } from "@/hooks/store";
|
||||||
|
// assets
|
||||||
|
|
||||||
|
const helpOptions = [
|
||||||
|
{
|
||||||
|
name: "Documentation",
|
||||||
|
href: "https://docs.plane.so/",
|
||||||
|
Icon: PageIcon,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Join our Forum",
|
||||||
|
href: "https://forum.plane.so",
|
||||||
|
Icon: MessageSquare,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Report a bug",
|
||||||
|
href: "https://github.com/makeplane/plane/issues/new/choose",
|
||||||
|
Icon: GithubIcon,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
export const AdminSidebarHelpSection = observer(function AdminSidebarHelpSection() {
|
||||||
|
// states
|
||||||
|
const [isNeedHelpOpen, setIsNeedHelpOpen] = useState(false);
|
||||||
|
// store
|
||||||
|
const { instance } = useInstance();
|
||||||
|
const { isSidebarCollapsed, toggleSidebar } = useTheme();
|
||||||
|
// refs
|
||||||
|
const helpOptionsRef = useRef<HTMLDivElement | null>(null);
|
||||||
|
|
||||||
|
const redirectionLink = encodeURI(WEB_BASE_URL + "/");
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
className={cn(
|
||||||
|
"flex h-14 w-full flex-shrink-0 items-center justify-between gap-1 self-baseline border-t border-subtle bg-surface-1 px-4",
|
||||||
|
{
|
||||||
|
"h-auto flex-col py-1.5": isSidebarCollapsed,
|
||||||
|
}
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
<div className={`flex items-center gap-1 ${isSidebarCollapsed ? "flex-col justify-center" : "w-full"}`}>
|
||||||
|
<Tooltip tooltipContent="Redirect to Plane" position="right" className="ml-4" disabled={!isSidebarCollapsed}>
|
||||||
|
<a
|
||||||
|
href={redirectionLink}
|
||||||
|
className={`relative flex items-center gap-1 rounded-sm bg-layer-1 px-2 py-1 text-body-xs-medium whitespace-nowrap text-secondary`}
|
||||||
|
>
|
||||||
|
<NewTabIcon width={14} height={14} />
|
||||||
|
{!isSidebarCollapsed && "Redirect to Plane"}
|
||||||
|
</a>
|
||||||
|
</Tooltip>
|
||||||
|
<Tooltip tooltipContent="Help" position={isSidebarCollapsed ? "right" : "top"} className="ml-4">
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className={`ml-auto grid place-items-center rounded-md p-1.5 text-secondary outline-none hover:bg-layer-1-hover hover:text-primary ${
|
||||||
|
isSidebarCollapsed ? "w-full" : ""
|
||||||
|
}`}
|
||||||
|
onClick={() => setIsNeedHelpOpen((prev) => !prev)}
|
||||||
|
>
|
||||||
|
<HelpCircle className="size-4" />
|
||||||
|
</button>
|
||||||
|
</Tooltip>
|
||||||
|
<Tooltip tooltipContent="Toggle sidebar" position={isSidebarCollapsed ? "right" : "top"} className="ml-4">
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className={`grid place-items-center rounded-md p-1.5 text-secondary outline-none hover:bg-layer-1-hover hover:text-primary ${
|
||||||
|
isSidebarCollapsed ? "w-full" : ""
|
||||||
|
}`}
|
||||||
|
onClick={() => toggleSidebar(!isSidebarCollapsed)}
|
||||||
|
>
|
||||||
|
<MoveLeft className={`size-4 duration-300 ${isSidebarCollapsed ? "rotate-180" : ""}`} />
|
||||||
|
</button>
|
||||||
|
</Tooltip>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="relative">
|
||||||
|
<Transition
|
||||||
|
show={isNeedHelpOpen}
|
||||||
|
enter="transition ease-out duration-100"
|
||||||
|
enterFrom="transform opacity-0 scale-95"
|
||||||
|
enterTo="transform opacity-100 scale-100"
|
||||||
|
leave="transition ease-in duration-75"
|
||||||
|
leaveFrom="transform opacity-100 scale-100"
|
||||||
|
leaveTo="transform opacity-0 scale-95"
|
||||||
|
>
|
||||||
|
<div
|
||||||
|
className={`absolute bottom-2 z-[15] min-w-[10rem] ${
|
||||||
|
isSidebarCollapsed ? "left-full" : "-left-[75px]"
|
||||||
|
} divide-y divide-subtle-1 rounded-sm bg-surface-1 p-1 whitespace-nowrap shadow-raised-100`}
|
||||||
|
ref={helpOptionsRef}
|
||||||
|
>
|
||||||
|
<div className="space-y-1 pb-2">
|
||||||
|
{helpOptions.map(({ name, Icon, href }) => {
|
||||||
|
if (href)
|
||||||
|
return (
|
||||||
|
<Link href={href} key={name} target="_blank">
|
||||||
|
<div className="flex items-center gap-x-2 rounded-sm px-2 py-1 text-11 hover:bg-layer-1-hover">
|
||||||
|
<div className="grid flex-shrink-0 place-items-center">
|
||||||
|
<Icon className="h-3.5 w-3.5 text-secondary" />
|
||||||
|
</div>
|
||||||
|
<span className="text-11">{name}</span>
|
||||||
|
</div>
|
||||||
|
</Link>
|
||||||
|
);
|
||||||
|
else
|
||||||
|
return (
|
||||||
|
<button
|
||||||
|
key={name}
|
||||||
|
type="button"
|
||||||
|
className="flex w-full items-center gap-x-2 rounded-sm px-2 py-1 text-11 hover:bg-layer-1"
|
||||||
|
>
|
||||||
|
<div className="grid flex-shrink-0 place-items-center">
|
||||||
|
<Icon className="h-3.5 w-3.5 text-secondary" />
|
||||||
|
</div>
|
||||||
|
<span className="text-11">{name}</span>
|
||||||
|
</button>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</div>
|
||||||
|
<div className="px-2 pt-2 pb-1 text-10">Version: v{instance?.current_version}</div>
|
||||||
|
</div>
|
||||||
|
</Transition>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import Link from "next/link";
|
||||||
|
import { usePathname } from "next/navigation";
|
||||||
|
// plane internal packages
|
||||||
|
import { Tooltip } from "@plane/propel/tooltip";
|
||||||
|
import { cn } from "@plane/utils";
|
||||||
|
// hooks
|
||||||
|
import { useTheme } from "@/hooks/store";
|
||||||
|
import { useSidebarMenu } from "@/hooks/use-sidebar-menu";
|
||||||
|
|
||||||
|
export const AdminSidebarMenu = observer(function AdminSidebarMenu() {
|
||||||
|
// router
|
||||||
|
const pathName = usePathname();
|
||||||
|
// store hooks
|
||||||
|
const { isSidebarCollapsed, toggleSidebar } = useTheme();
|
||||||
|
// derived values
|
||||||
|
const sidebarMenu = useSidebarMenu();
|
||||||
|
|
||||||
|
const handleItemClick = () => {
|
||||||
|
if (window.innerWidth < 768) {
|
||||||
|
toggleSidebar(!isSidebarCollapsed);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="vertical-scrollbar flex scrollbar-sm h-full w-full flex-col gap-2.5 overflow-y-scroll px-4 py-4">
|
||||||
|
{sidebarMenu.map((item, index) => {
|
||||||
|
const isActive = item.href === pathName || pathName?.includes(item.href);
|
||||||
|
return (
|
||||||
|
<Link key={index} href={item.href} onClick={handleItemClick}>
|
||||||
|
<div>
|
||||||
|
<Tooltip tooltipContent={item.name} position="right" className="ml-2" disabled={!isSidebarCollapsed}>
|
||||||
|
<div
|
||||||
|
className={cn(
|
||||||
|
"group flex w-full items-center gap-3 rounded-md px-3 py-2 transition-colors outline-none",
|
||||||
|
{
|
||||||
|
"!bg-layer-transparent-active text-primary": isActive,
|
||||||
|
"text-secondary hover:bg-layer-transparent-hover active:bg-layer-transparent-active": !isActive,
|
||||||
|
},
|
||||||
|
isSidebarCollapsed ? "justify-center" : "w-[260px]"
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
{<item.Icon className="h-4 w-4 flex-shrink-0" />}
|
||||||
|
{!isSidebarCollapsed && (
|
||||||
|
<div className="w-full">
|
||||||
|
<div className={cn(`text-body-xs-medium transition-colors`)}>{item.name}</div>
|
||||||
|
<div className={cn(`text-caption-sm-regular transition-colors`)}>{item.description}</div>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</Tooltip>
|
||||||
|
</div>
|
||||||
|
</Link>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useEffect, useRef } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
// plane helpers
|
||||||
|
import { useOutsideClickDetector } from "@plane/hooks";
|
||||||
|
// hooks
|
||||||
|
import { useTheme } from "@/hooks/store";
|
||||||
|
// components
|
||||||
|
import { AdminSidebarDropdown } from "./sidebar-dropdown";
|
||||||
|
import { AdminSidebarHelpSection } from "./sidebar-help-section";
|
||||||
|
import { AdminSidebarMenu } from "./sidebar-menu";
|
||||||
|
|
||||||
|
export const AdminSidebar = observer(function AdminSidebar() {
|
||||||
|
// store
|
||||||
|
const { isSidebarCollapsed, toggleSidebar } = useTheme();
|
||||||
|
|
||||||
|
const ref = useRef<HTMLDivElement>(null);
|
||||||
|
|
||||||
|
useOutsideClickDetector(ref, () => {
|
||||||
|
if (isSidebarCollapsed === false) {
|
||||||
|
if (window.innerWidth < 768) {
|
||||||
|
toggleSidebar(!isSidebarCollapsed);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const handleResize = () => {
|
||||||
|
if (window.innerWidth <= 768) {
|
||||||
|
toggleSidebar(true);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
handleResize();
|
||||||
|
window.addEventListener("resize", handleResize);
|
||||||
|
return () => {
|
||||||
|
window.removeEventListener("resize", handleResize);
|
||||||
|
};
|
||||||
|
}, [toggleSidebar]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
className={`fixed inset-y-0 z-20 flex h-full flex-shrink-0 flex-grow-0 flex-col border-r border-subtle bg-surface-1 duration-300 md:relative ${isSidebarCollapsed ? "-ml-[290px]" : ""} sm:${isSidebarCollapsed ? "-ml-[290px]" : ""} md:ml-0 ${isSidebarCollapsed ? "w-[70px]" : "w-[290px]"} lg:ml-0 ${isSidebarCollapsed ? "w-[70px]" : "w-[290px]"} `}
|
||||||
|
>
|
||||||
|
<div ref={ref} className="flex h-full w-full flex-1 flex-col">
|
||||||
|
<AdminSidebarDropdown />
|
||||||
|
<AdminSidebarMenu />
|
||||||
|
<AdminSidebarHelpSection />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,207 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState, useEffect } from "react";
|
||||||
|
import Link from "next/link";
|
||||||
|
import { useRouter } from "next/navigation";
|
||||||
|
import { Controller, useForm } from "react-hook-form";
|
||||||
|
// plane imports
|
||||||
|
import { WEB_BASE_URL, ORGANIZATION_SIZE, RESTRICTED_URLS } from "@plane/constants";
|
||||||
|
import { Button, getButtonStyling } from "@plane/propel/button";
|
||||||
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
||||||
|
import { InstanceWorkspaceService } from "@plane/services";
|
||||||
|
import type { IWorkspace } from "@plane/types";
|
||||||
|
import { validateSlug, validateWorkspaceName } from "@plane/utils";
|
||||||
|
// components
|
||||||
|
import { CustomSelect, Input } from "@plane/ui";
|
||||||
|
// hooks
|
||||||
|
import { useWorkspace } from "@/hooks/store";
|
||||||
|
|
||||||
|
const instanceWorkspaceService = new InstanceWorkspaceService();
|
||||||
|
|
||||||
|
export function WorkspaceCreateForm() {
|
||||||
|
// router
|
||||||
|
const router = useRouter();
|
||||||
|
// states
|
||||||
|
const [slugError, setSlugError] = useState(false);
|
||||||
|
const [invalidSlug, setInvalidSlug] = useState(false);
|
||||||
|
const [defaultValues, setDefaultValues] = useState<Partial<IWorkspace>>({
|
||||||
|
name: "",
|
||||||
|
slug: "",
|
||||||
|
organization_size: "",
|
||||||
|
});
|
||||||
|
// store hooks
|
||||||
|
const { createWorkspace } = useWorkspace();
|
||||||
|
// form info
|
||||||
|
const {
|
||||||
|
handleSubmit,
|
||||||
|
control,
|
||||||
|
setValue,
|
||||||
|
getValues,
|
||||||
|
formState: { errors, isSubmitting, isValid },
|
||||||
|
} = useForm<IWorkspace>({ defaultValues, mode: "onChange" });
|
||||||
|
// derived values
|
||||||
|
const workspaceBaseURL = encodeURI(WEB_BASE_URL || window.location.origin + "/");
|
||||||
|
|
||||||
|
const handleCreateWorkspace = async (formData: IWorkspace) => {
|
||||||
|
await instanceWorkspaceService
|
||||||
|
.slugCheck(formData.slug)
|
||||||
|
.then(async (res) => {
|
||||||
|
if (res.status === true && !RESTRICTED_URLS.includes(formData.slug)) {
|
||||||
|
setSlugError(false);
|
||||||
|
await createWorkspace(formData)
|
||||||
|
.then(async () => {
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.SUCCESS,
|
||||||
|
title: "Success!",
|
||||||
|
message: "Workspace created successfully.",
|
||||||
|
});
|
||||||
|
router.push(`/workspace`);
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.ERROR,
|
||||||
|
title: "Error!",
|
||||||
|
message: "Workspace could not be created. Please try again.",
|
||||||
|
});
|
||||||
|
});
|
||||||
|
} else setSlugError(true);
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
setToast({
|
||||||
|
type: TOAST_TYPE.ERROR,
|
||||||
|
title: "Error!",
|
||||||
|
message: "Some error occurred while creating workspace. Please try again.",
|
||||||
|
});
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
useEffect(
|
||||||
|
() => () => {
|
||||||
|
// when the component unmounts set the default values to whatever user typed in
|
||||||
|
setDefaultValues(getValues());
|
||||||
|
},
|
||||||
|
[getValues, setDefaultValues]
|
||||||
|
);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="space-y-8">
|
||||||
|
<div className="grid-col grid w-full max-w-4xl grid-cols-1 items-start justify-between gap-x-10 gap-y-6 lg:grid-cols-2">
|
||||||
|
<div className="flex flex-col gap-1">
|
||||||
|
<h4 className="text-13 text-tertiary">Name your workspace</h4>
|
||||||
|
<div className="flex flex-col gap-1">
|
||||||
|
<Controller
|
||||||
|
control={control}
|
||||||
|
name="name"
|
||||||
|
rules={{
|
||||||
|
validate: (value) => validateWorkspaceName(value, true),
|
||||||
|
}}
|
||||||
|
render={({ field: { value, ref, onChange } }) => (
|
||||||
|
<Input
|
||||||
|
id="workspaceName"
|
||||||
|
type="text"
|
||||||
|
value={value}
|
||||||
|
onChange={(e) => {
|
||||||
|
onChange(e.target.value);
|
||||||
|
setValue("name", e.target.value);
|
||||||
|
setValue("slug", e.target.value.toLocaleLowerCase().trim().replace(/ /g, "-"), {
|
||||||
|
shouldValidate: true,
|
||||||
|
});
|
||||||
|
}}
|
||||||
|
ref={ref}
|
||||||
|
hasError={Boolean(errors.name)}
|
||||||
|
placeholder="Something familiar and recognizable is always best."
|
||||||
|
className="w-full"
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
/>
|
||||||
|
<span className="text-11 text-danger-primary">{errors?.name?.message}</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="flex flex-col gap-1">
|
||||||
|
<h4 className="text-13 text-tertiary">Set your workspace's URL</h4>
|
||||||
|
<div className="flex w-full items-center gap-0.5 rounded-md border-[0.5px] border-subtle px-3">
|
||||||
|
<span className="text-13 whitespace-nowrap text-secondary">{workspaceBaseURL}</span>
|
||||||
|
<Controller
|
||||||
|
control={control}
|
||||||
|
name="slug"
|
||||||
|
rules={{
|
||||||
|
validate: (value) => validateSlug(value),
|
||||||
|
}}
|
||||||
|
render={({ field: { onChange, value, ref } }) => (
|
||||||
|
<Input
|
||||||
|
id="workspaceUrl"
|
||||||
|
type="text"
|
||||||
|
value={value.toLocaleLowerCase().trim().replace(/ /g, "-")}
|
||||||
|
onChange={(e) => {
|
||||||
|
if (/^[a-zA-Z0-9_-]+$/.test(e.target.value)) setInvalidSlug(false);
|
||||||
|
else setInvalidSlug(true);
|
||||||
|
onChange(e.target.value.toLowerCase());
|
||||||
|
}}
|
||||||
|
ref={ref}
|
||||||
|
hasError={Boolean(errors.slug)}
|
||||||
|
placeholder="workspace-name"
|
||||||
|
className="block w-full rounded-md border-none bg-transparent !px-0 py-2 text-13"
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
{slugError && <p className="text-13 text-danger-primary">This URL is taken. Try something else.</p>}
|
||||||
|
{invalidSlug && (
|
||||||
|
<p className="text-13 text-danger-primary">{`URLs can contain only ( - ), ( _ ) and alphanumeric characters.`}</p>
|
||||||
|
)}
|
||||||
|
{errors.slug && <span className="text-11 text-danger-primary">{errors.slug.message}</span>}
|
||||||
|
</div>
|
||||||
|
<div className="flex flex-col gap-1">
|
||||||
|
<h4 className="text-13 text-tertiary">How many people will use this workspace?</h4>
|
||||||
|
<div className="w-full">
|
||||||
|
<Controller
|
||||||
|
name="organization_size"
|
||||||
|
control={control}
|
||||||
|
rules={{ required: "This is a required field." }}
|
||||||
|
render={({ field: { value, onChange } }) => (
|
||||||
|
<CustomSelect
|
||||||
|
value={value}
|
||||||
|
onChange={onChange}
|
||||||
|
label={
|
||||||
|
ORGANIZATION_SIZE.find((c) => c === value) ?? (
|
||||||
|
<span className="text-placeholder">Select a range</span>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
buttonClassName="!border-[0.5px] !border-subtle !shadow-none"
|
||||||
|
input
|
||||||
|
>
|
||||||
|
{ORGANIZATION_SIZE.map((item) => (
|
||||||
|
<CustomSelect.Option key={item} value={item}>
|
||||||
|
{item}
|
||||||
|
</CustomSelect.Option>
|
||||||
|
))}
|
||||||
|
</CustomSelect>
|
||||||
|
)}
|
||||||
|
/>
|
||||||
|
{errors.organization_size && (
|
||||||
|
<span className="text-13 text-danger-primary">{errors.organization_size.message}</span>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="flex max-w-4xl items-center gap-4 py-1">
|
||||||
|
<Button
|
||||||
|
variant="primary"
|
||||||
|
size="lg"
|
||||||
|
onClick={handleSubmit(handleCreateWorkspace)}
|
||||||
|
disabled={!isValid}
|
||||||
|
loading={isSubmitting}
|
||||||
|
>
|
||||||
|
{isSubmitting ? "Creating workspace" : "Create workspace"}
|
||||||
|
</Button>
|
||||||
|
<Link className={getButtonStyling("secondary", "lg")} href="/workspace">
|
||||||
|
Go back
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
// components
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
// local
|
||||||
|
import { WorkspaceCreateForm } from "./form";
|
||||||
|
|
||||||
|
const WorkspaceCreatePage = observer(function WorkspaceCreatePage(_props: Route.ComponentProps) {
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
header={{
|
||||||
|
title: "Create a new workspace on this instance.",
|
||||||
|
description: "You will need to invite users from Workspace Settings after you create this workspace.",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<WorkspaceCreateForm />
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "Create Workspace - God Mode" }];
|
||||||
|
|
||||||
|
export default WorkspaceCreatePage;
|
||||||
@@ -0,0 +1,172 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import Link from "next/link";
|
||||||
|
import useSWR from "swr";
|
||||||
|
import { Loader as LoaderIcon } from "lucide-react";
|
||||||
|
// types
|
||||||
|
import { Button, getButtonStyling } from "@plane/propel/button";
|
||||||
|
import { setPromiseToast } from "@plane/propel/toast";
|
||||||
|
import type { TInstanceConfigurationKeys } from "@plane/types";
|
||||||
|
import { Loader, ToggleSwitch } from "@plane/ui";
|
||||||
|
import { cn } from "@plane/utils";
|
||||||
|
// components
|
||||||
|
import { PageWrapper } from "@/components/common/page-wrapper";
|
||||||
|
import { WorkspaceListItem } from "@/components/workspace/list-item";
|
||||||
|
// hooks
|
||||||
|
import { useInstance, useWorkspace } from "@/hooks/store";
|
||||||
|
// types
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
|
||||||
|
const WorkspaceManagementPage = observer(function WorkspaceManagementPage(_props: Route.ComponentProps) {
|
||||||
|
// states
|
||||||
|
const [isSubmitting, setIsSubmitting] = useState<boolean>(false);
|
||||||
|
// store
|
||||||
|
const { formattedConfig, fetchInstanceConfigurations, updateInstanceConfigurations } = useInstance();
|
||||||
|
const {
|
||||||
|
workspaceIds,
|
||||||
|
loader: workspaceLoader,
|
||||||
|
paginationInfo,
|
||||||
|
fetchWorkspaces,
|
||||||
|
fetchNextWorkspaces,
|
||||||
|
} = useWorkspace();
|
||||||
|
// derived values
|
||||||
|
const disableWorkspaceCreation = formattedConfig?.DISABLE_WORKSPACE_CREATION ?? "";
|
||||||
|
const hasNextPage = paginationInfo?.next_page_results && paginationInfo?.next_cursor !== undefined;
|
||||||
|
|
||||||
|
// fetch data
|
||||||
|
useSWR("INSTANCE_CONFIGURATIONS", () => fetchInstanceConfigurations());
|
||||||
|
useSWR("INSTANCE_WORKSPACES", () => fetchWorkspaces());
|
||||||
|
|
||||||
|
const updateConfig = async (key: TInstanceConfigurationKeys, value: string) => {
|
||||||
|
setIsSubmitting(true);
|
||||||
|
|
||||||
|
const payload = {
|
||||||
|
[key]: value,
|
||||||
|
};
|
||||||
|
|
||||||
|
const updateConfigPromise = updateInstanceConfigurations(payload);
|
||||||
|
|
||||||
|
setPromiseToast(updateConfigPromise, {
|
||||||
|
loading: "Saving configuration",
|
||||||
|
success: {
|
||||||
|
title: "Success",
|
||||||
|
message: () => "Configuration saved successfully",
|
||||||
|
},
|
||||||
|
error: {
|
||||||
|
title: "Error",
|
||||||
|
message: () => "Failed to save configuration",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await updateConfigPromise
|
||||||
|
.then(() => {
|
||||||
|
setIsSubmitting(false);
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
console.error(err);
|
||||||
|
setIsSubmitting(false);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<PageWrapper
|
||||||
|
header={{
|
||||||
|
title: "Workspaces on this instance",
|
||||||
|
description: "See all workspaces and control who can create them.",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<div className="space-y-3">
|
||||||
|
{formattedConfig ? (
|
||||||
|
<div className={cn("flex w-full items-center gap-14 rounded-sm")}>
|
||||||
|
<div className="flex grow items-center gap-4">
|
||||||
|
<div className="grow">
|
||||||
|
<div className="pb-1 text-16 font-medium">Prevent anyone else from creating a workspace.</div>
|
||||||
|
<div className={cn("text-11 leading-5 font-regular text-tertiary")}>
|
||||||
|
Toggling this on will let only you create workspaces. You will have to invite users to new workspaces.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className={`shrink-0 pr-4 ${isSubmitting && "opacity-70"}`}>
|
||||||
|
<div className="flex items-center gap-4">
|
||||||
|
<ToggleSwitch
|
||||||
|
value={Boolean(parseInt(disableWorkspaceCreation))}
|
||||||
|
onChange={() => {
|
||||||
|
if (Boolean(parseInt(disableWorkspaceCreation)) === true) {
|
||||||
|
updateConfig("DISABLE_WORKSPACE_CREATION", "0");
|
||||||
|
} else {
|
||||||
|
updateConfig("DISABLE_WORKSPACE_CREATION", "1");
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
size="sm"
|
||||||
|
disabled={isSubmitting}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
) : (
|
||||||
|
<Loader>
|
||||||
|
<Loader.Item height="50px" width="100%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
{workspaceLoader !== "init-loader" ? (
|
||||||
|
<>
|
||||||
|
<div className="flex items-center justify-between gap-2 pt-6">
|
||||||
|
<div className="flex flex-col items-start gap-x-2">
|
||||||
|
<div className="flex items-center gap-2 text-16 font-medium">
|
||||||
|
All workspaces on this instance <span className="text-tertiary">• {workspaceIds.length}</span>
|
||||||
|
{workspaceLoader && ["mutation", "pagination"].includes(workspaceLoader) && (
|
||||||
|
<LoaderIcon className="h-4 w-4 animate-spin" />
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
<div className={cn("text-11 leading-5 font-regular text-tertiary")}>
|
||||||
|
You can't yet delete workspaces and you can only go to the workspace if you are an Admin or a
|
||||||
|
Member.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="flex items-center gap-2">
|
||||||
|
<Link href="/workspace/create" className={getButtonStyling("primary", "base")}>
|
||||||
|
Create workspace
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="flex flex-col gap-4 py-2">
|
||||||
|
{workspaceIds.map((workspaceId) => (
|
||||||
|
<WorkspaceListItem key={workspaceId} workspaceId={workspaceId} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
{hasNextPage && (
|
||||||
|
<div className="flex justify-center">
|
||||||
|
<Button
|
||||||
|
variant="link"
|
||||||
|
size="lg"
|
||||||
|
onClick={() => fetchNextWorkspaces()}
|
||||||
|
disabled={workspaceLoader === "pagination"}
|
||||||
|
>
|
||||||
|
Load more
|
||||||
|
{workspaceLoader === "pagination" && <LoaderIcon className="h-3 w-3 animate-spin" />}
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</>
|
||||||
|
) : (
|
||||||
|
<Loader className="space-y-10 py-8">
|
||||||
|
<Loader.Item height="24px" width="20%" />
|
||||||
|
<Loader.Item height="92px" width="100%" />
|
||||||
|
<Loader.Item height="92px" width="100%" />
|
||||||
|
<Loader.Item height="92px" width="100%" />
|
||||||
|
</Loader>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</PageWrapper>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [{ title: "Workspace Management - God Mode" }];
|
||||||
|
|
||||||
|
export default WorkspaceManagementPage;
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { Info } from "lucide-react";
|
||||||
|
// plane constants
|
||||||
|
import type { TAdminAuthErrorInfo } from "@plane/constants";
|
||||||
|
// icons
|
||||||
|
import { CloseIcon } from "@plane/propel/icons";
|
||||||
|
|
||||||
|
type TAuthBanner = {
|
||||||
|
bannerData: TAdminAuthErrorInfo | undefined;
|
||||||
|
handleBannerData?: (bannerData: TAdminAuthErrorInfo | undefined) => void;
|
||||||
|
};
|
||||||
|
|
||||||
|
export function AuthBanner(props: TAuthBanner) {
|
||||||
|
const { bannerData, handleBannerData } = props;
|
||||||
|
|
||||||
|
if (!bannerData) return <></>;
|
||||||
|
return (
|
||||||
|
<div className="relative flex items-center gap-2 rounded-md border border-accent-strong/50 bg-accent-primary/10 p-2">
|
||||||
|
<div className="relative flex h-4 w-4 flex-shrink-0 items-center justify-center">
|
||||||
|
<Info size={16} className="text-accent-primary" />
|
||||||
|
</div>
|
||||||
|
<div className="w-full text-13 font-medium text-accent-primary">{bannerData?.message}</div>
|
||||||
|
<div
|
||||||
|
className="relative ml-auto flex h-6 w-6 cursor-pointer items-center justify-center rounded-xs text-accent-primary transition-all hover:bg-accent-primary/20"
|
||||||
|
onClick={() => handleBannerData && handleBannerData(undefined)}
|
||||||
|
>
|
||||||
|
<CloseIcon className="h-4 w-4 flex-shrink-0" />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import Link from "next/link";
|
||||||
|
import { PlaneLockup } from "@plane/propel/icons";
|
||||||
|
|
||||||
|
export function AuthHeader() {
|
||||||
|
return (
|
||||||
|
<div className="sticky top-0 flex w-full flex-shrink-0 items-center justify-between gap-6">
|
||||||
|
<Link href="/">
|
||||||
|
<PlaneLockup height={20} width={95} className="text-primary" />
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,100 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import Link from "next/link";
|
||||||
|
// plane packages
|
||||||
|
import type { TAdminAuthErrorInfo } from "@plane/constants";
|
||||||
|
import { SUPPORT_EMAIL, EAdminAuthErrorCodes } from "@plane/constants";
|
||||||
|
|
||||||
|
export enum EErrorAlertType {
|
||||||
|
BANNER_ALERT = "BANNER_ALERT",
|
||||||
|
INLINE_FIRST_NAME = "INLINE_FIRST_NAME",
|
||||||
|
INLINE_EMAIL = "INLINE_EMAIL",
|
||||||
|
INLINE_PASSWORD = "INLINE_PASSWORD",
|
||||||
|
INLINE_EMAIL_CODE = "INLINE_EMAIL_CODE",
|
||||||
|
}
|
||||||
|
|
||||||
|
const errorCodeMessages: {
|
||||||
|
[key in EAdminAuthErrorCodes]: { title: string; message: (email?: string) => React.ReactNode };
|
||||||
|
} = {
|
||||||
|
// admin
|
||||||
|
[EAdminAuthErrorCodes.ADMIN_ALREADY_EXIST]: {
|
||||||
|
title: `Admin already exists`,
|
||||||
|
message: () => `Admin already exists. Please try again.`,
|
||||||
|
},
|
||||||
|
[EAdminAuthErrorCodes.REQUIRED_ADMIN_EMAIL_PASSWORD_FIRST_NAME]: {
|
||||||
|
title: `Email, password and first name required`,
|
||||||
|
message: () => `Email, password and first name required. Please try again.`,
|
||||||
|
},
|
||||||
|
[EAdminAuthErrorCodes.INVALID_ADMIN_EMAIL]: {
|
||||||
|
title: `Invalid admin email`,
|
||||||
|
message: () => `Invalid admin email. Please try again.`,
|
||||||
|
},
|
||||||
|
[EAdminAuthErrorCodes.INVALID_ADMIN_PASSWORD]: {
|
||||||
|
title: `Invalid admin password`,
|
||||||
|
message: () => `Invalid admin password. Please try again.`,
|
||||||
|
},
|
||||||
|
[EAdminAuthErrorCodes.REQUIRED_ADMIN_EMAIL_PASSWORD]: {
|
||||||
|
title: `Email and password required`,
|
||||||
|
message: () => `Email and password required. Please try again.`,
|
||||||
|
},
|
||||||
|
[EAdminAuthErrorCodes.ADMIN_AUTHENTICATION_FAILED]: {
|
||||||
|
title: `Authentication failed`,
|
||||||
|
message: () => `Authentication failed. Please try again.`,
|
||||||
|
},
|
||||||
|
[EAdminAuthErrorCodes.ADMIN_USER_ALREADY_EXIST]: {
|
||||||
|
title: `Admin user already exists`,
|
||||||
|
message: () => (
|
||||||
|
<div>
|
||||||
|
Admin user already exists.
|
||||||
|
<Link className="font-medium underline underline-offset-4 transition-all hover:font-bold" href={`/admin`}>
|
||||||
|
Sign In
|
||||||
|
</Link>
|
||||||
|
now.
|
||||||
|
</div>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
[EAdminAuthErrorCodes.ADMIN_USER_DOES_NOT_EXIST]: {
|
||||||
|
title: `Admin user does not exist`,
|
||||||
|
message: () => (
|
||||||
|
<div>
|
||||||
|
Admin user does not exist.
|
||||||
|
<Link className="font-medium underline underline-offset-4 transition-all hover:font-bold" href={`/admin`}>
|
||||||
|
Sign In
|
||||||
|
</Link>
|
||||||
|
now.
|
||||||
|
</div>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
[EAdminAuthErrorCodes.ADMIN_USER_DEACTIVATED]: {
|
||||||
|
title: `User account deactivated`,
|
||||||
|
message: () => `User account deactivated. Please contact ${SUPPORT_EMAIL ? SUPPORT_EMAIL : "administrator"}.`,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const authErrorHandler = (errorCode: EAdminAuthErrorCodes, email?: string): TAdminAuthErrorInfo | undefined => {
|
||||||
|
const bannerAlertErrorCodes = [
|
||||||
|
EAdminAuthErrorCodes.ADMIN_ALREADY_EXIST,
|
||||||
|
EAdminAuthErrorCodes.REQUIRED_ADMIN_EMAIL_PASSWORD_FIRST_NAME,
|
||||||
|
EAdminAuthErrorCodes.INVALID_ADMIN_EMAIL,
|
||||||
|
EAdminAuthErrorCodes.INVALID_ADMIN_PASSWORD,
|
||||||
|
EAdminAuthErrorCodes.REQUIRED_ADMIN_EMAIL_PASSWORD,
|
||||||
|
EAdminAuthErrorCodes.ADMIN_AUTHENTICATION_FAILED,
|
||||||
|
EAdminAuthErrorCodes.ADMIN_USER_ALREADY_EXIST,
|
||||||
|
EAdminAuthErrorCodes.ADMIN_USER_DOES_NOT_EXIST,
|
||||||
|
EAdminAuthErrorCodes.ADMIN_USER_DEACTIVATED,
|
||||||
|
];
|
||||||
|
|
||||||
|
if (bannerAlertErrorCodes.includes(errorCode))
|
||||||
|
return {
|
||||||
|
type: EErrorAlertType.BANNER_ALERT,
|
||||||
|
code: errorCode,
|
||||||
|
title: errorCodeMessages[errorCode]?.title || "Error",
|
||||||
|
message: errorCodeMessages[errorCode]?.message(email) || "Something went wrong. Please try again.",
|
||||||
|
};
|
||||||
|
|
||||||
|
return undefined;
|
||||||
|
};
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useEffect } from "react";
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
import { useRouter } from "next/navigation";
|
||||||
|
import { Outlet } from "react-router";
|
||||||
|
// hooks
|
||||||
|
import { useUser } from "@/hooks/store/use-user";
|
||||||
|
|
||||||
|
function RootLayout() {
|
||||||
|
// router
|
||||||
|
const { replace } = useRouter();
|
||||||
|
// store hooks
|
||||||
|
const { isUserLoggedIn } = useUser();
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (isUserLoggedIn === true) replace("/general");
|
||||||
|
}, [replace, isUserLoggedIn]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="relative z-10 flex h-screen w-screen flex-col items-center overflow-hidden overflow-y-auto bg-surface-1 px-8 pt-6 pb-10">
|
||||||
|
<Outlet />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export default observer(RootLayout);
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { observer } from "mobx-react";
|
||||||
|
// components
|
||||||
|
import { LogoSpinner } from "@/components/common/logo-spinner";
|
||||||
|
import { InstanceFailureView } from "@/components/instance/failure";
|
||||||
|
import { InstanceSetupForm } from "@/components/instance/setup-form";
|
||||||
|
// hooks
|
||||||
|
import { useInstance } from "@/hooks/store";
|
||||||
|
// components
|
||||||
|
import type { Route } from "./+types/page";
|
||||||
|
import { InstanceSignInForm } from "./sign-in-form";
|
||||||
|
|
||||||
|
function HomePage() {
|
||||||
|
// store hooks
|
||||||
|
const { instance, error } = useInstance();
|
||||||
|
|
||||||
|
// if instance is not fetched, show loading
|
||||||
|
if (!instance && !error) {
|
||||||
|
return (
|
||||||
|
<div className="flex h-screen w-full items-center justify-center">
|
||||||
|
<LogoSpinner />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// if instance fetch fails, show failure view
|
||||||
|
if (error) {
|
||||||
|
return <InstanceFailureView />;
|
||||||
|
}
|
||||||
|
|
||||||
|
// if instance is fetched and setup is not done, show setup form
|
||||||
|
if (instance && !instance?.is_setup_done) {
|
||||||
|
return <InstanceSetupForm />;
|
||||||
|
}
|
||||||
|
|
||||||
|
// if instance is fetched and setup is done, show sign in form
|
||||||
|
return <InstanceSignInForm />;
|
||||||
|
}
|
||||||
|
|
||||||
|
export default observer(HomePage);
|
||||||
|
|
||||||
|
export const meta: Route.MetaFunction = () => [
|
||||||
|
{ title: "Admin – Instance Setup & Sign-In" },
|
||||||
|
{ name: "description", content: "Configure your Plane instance or sign in to the admin portal." },
|
||||||
|
];
|
||||||
@@ -0,0 +1,199 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2023-present Plane Software, Inc. and contributors
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
* See the LICENSE file for details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { useEffect, useMemo, useState } from "react";
|
||||||
|
import { useSearchParams } from "next/navigation";
|
||||||
|
import { Eye, EyeOff } from "lucide-react";
|
||||||
|
// plane internal packages
|
||||||
|
import type { EAdminAuthErrorCodes, TAdminAuthErrorInfo } from "@plane/constants";
|
||||||
|
import { API_BASE_URL } from "@plane/constants";
|
||||||
|
import { Button } from "@plane/propel/button";
|
||||||
|
import { AuthService } from "@plane/services";
|
||||||
|
import { Input, Spinner } from "@plane/ui";
|
||||||
|
// components
|
||||||
|
import { Banner } from "@/components/common/banner";
|
||||||
|
// local components
|
||||||
|
import { FormHeader } from "@/components/instance/form-header";
|
||||||
|
import { AuthBanner } from "./auth-banner";
|
||||||
|
import { AuthHeader } from "./auth-header";
|
||||||
|
import { authErrorHandler } from "./auth-helpers";
|
||||||
|
|
||||||
|
// service initialization
|
||||||
|
const authService = new AuthService();
|
||||||
|
|
||||||
|
// error codes
|
||||||
|
enum EErrorCodes {
|
||||||
|
INSTANCE_NOT_CONFIGURED = "INSTANCE_NOT_CONFIGURED",
|
||||||
|
REQUIRED_EMAIL_PASSWORD = "REQUIRED_EMAIL_PASSWORD",
|
||||||
|
INVALID_EMAIL = "INVALID_EMAIL",
|
||||||
|
USER_DOES_NOT_EXIST = "USER_DOES_NOT_EXIST",
|
||||||
|
AUTHENTICATION_FAILED = "AUTHENTICATION_FAILED",
|
||||||
|
}
|
||||||
|
|
||||||
|
type TError = {
|
||||||
|
type: EErrorCodes | undefined;
|
||||||
|
message: string | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
// form data
|
||||||
|
type TFormData = {
|
||||||
|
email: string;
|
||||||
|
password: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
const defaultFromData: TFormData = {
|
||||||
|
email: "",
|
||||||
|
password: "",
|
||||||
|
};
|
||||||
|
|
||||||
|
export function InstanceSignInForm() {
|
||||||
|
// search params
|
||||||
|
const searchParams = useSearchParams();
|
||||||
|
const emailParam = searchParams.get("email") || undefined;
|
||||||
|
const errorCode = searchParams.get("error_code") || undefined;
|
||||||
|
const errorMessage = searchParams.get("error_message") || undefined;
|
||||||
|
// state
|
||||||
|
const [showPassword, setShowPassword] = useState(false);
|
||||||
|
const [csrfToken, setCsrfToken] = useState<string | undefined>(undefined);
|
||||||
|
const [formData, setFormData] = useState<TFormData>(defaultFromData);
|
||||||
|
const [isSubmitting, setIsSubmitting] = useState(false);
|
||||||
|
const [errorInfo, setErrorInfo] = useState<TAdminAuthErrorInfo | undefined>(undefined);
|
||||||
|
|
||||||
|
const handleFormChange = (key: keyof TFormData, value: string | boolean) =>
|
||||||
|
setFormData((prev) => ({ ...prev, [key]: value }));
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (csrfToken === undefined)
|
||||||
|
authService.requestCSRFToken().then((data) => data?.csrf_token && setCsrfToken(data.csrf_token));
|
||||||
|
}, [csrfToken]);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (emailParam) setFormData((prev) => ({ ...prev, email: emailParam }));
|
||||||
|
}, [emailParam]);
|
||||||
|
|
||||||
|
// derived values
|
||||||
|
const errorData: TError = useMemo(() => {
|
||||||
|
if (errorCode && errorMessage) {
|
||||||
|
switch (errorCode) {
|
||||||
|
case EErrorCodes.INSTANCE_NOT_CONFIGURED:
|
||||||
|
return { type: EErrorCodes.INSTANCE_NOT_CONFIGURED, message: errorMessage };
|
||||||
|
case EErrorCodes.REQUIRED_EMAIL_PASSWORD:
|
||||||
|
return { type: EErrorCodes.REQUIRED_EMAIL_PASSWORD, message: errorMessage };
|
||||||
|
case EErrorCodes.INVALID_EMAIL:
|
||||||
|
return { type: EErrorCodes.INVALID_EMAIL, message: errorMessage };
|
||||||
|
case EErrorCodes.USER_DOES_NOT_EXIST:
|
||||||
|
return { type: EErrorCodes.USER_DOES_NOT_EXIST, message: errorMessage };
|
||||||
|
case EErrorCodes.AUTHENTICATION_FAILED:
|
||||||
|
return { type: EErrorCodes.AUTHENTICATION_FAILED, message: errorMessage };
|
||||||
|
default:
|
||||||
|
return { type: undefined, message: undefined };
|
||||||
|
}
|
||||||
|
} else return { type: undefined, message: undefined };
|
||||||
|
}, [errorCode, errorMessage]);
|
||||||
|
|
||||||
|
const isButtonDisabled = useMemo(
|
||||||
|
() => (!isSubmitting && formData.email && formData.password ? false : true),
|
||||||
|
[formData.email, formData.password, isSubmitting]
|
||||||
|
);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (errorCode) {
|
||||||
|
const errorDetail = authErrorHandler(errorCode?.toString() as EAdminAuthErrorCodes);
|
||||||
|
if (errorDetail) {
|
||||||
|
setErrorInfo(errorDetail);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}, [errorCode]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<AuthHeader />
|
||||||
|
<div className="mt-10 flex w-full flex-grow flex-col items-center justify-center py-6">
|
||||||
|
<div className="relative flex w-full max-w-[22.5rem] flex-col gap-6">
|
||||||
|
<FormHeader
|
||||||
|
heading="Manage your Plane instance"
|
||||||
|
subHeading="Configure instance-wide settings to secure your instance"
|
||||||
|
/>
|
||||||
|
<form
|
||||||
|
className="space-y-4"
|
||||||
|
method="POST"
|
||||||
|
action={`${API_BASE_URL}/api/instances/admins/sign-in/`}
|
||||||
|
onSubmit={() => setIsSubmitting(true)}
|
||||||
|
onError={() => setIsSubmitting(false)}
|
||||||
|
>
|
||||||
|
{errorData.type && errorData?.message ? (
|
||||||
|
<Banner type="error" message={errorData?.message} />
|
||||||
|
) : (
|
||||||
|
<>
|
||||||
|
{errorInfo && <AuthBanner bannerData={errorInfo} handleBannerData={(value) => setErrorInfo(value)} />}
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
<input type="hidden" name="csrfmiddlewaretoken" value={csrfToken} />
|
||||||
|
|
||||||
|
<div className="w-full space-y-1">
|
||||||
|
<label className="text-13 font-medium text-tertiary" htmlFor="email">
|
||||||
|
Email <span className="text-danger-primary">*</span>
|
||||||
|
</label>
|
||||||
|
<Input
|
||||||
|
className="w-full border border-subtle !bg-surface-1 placeholder:text-placeholder"
|
||||||
|
id="email"
|
||||||
|
name="email"
|
||||||
|
type="email"
|
||||||
|
inputSize="md"
|
||||||
|
placeholder="name@company.com"
|
||||||
|
value={formData.email}
|
||||||
|
onChange={(e) => handleFormChange("email", e.target.value)}
|
||||||
|
autoComplete="off"
|
||||||
|
autoFocus
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="w-full space-y-1">
|
||||||
|
<label className="text-13 font-medium text-tertiary" htmlFor="password">
|
||||||
|
Password <span className="text-danger-primary">*</span>
|
||||||
|
</label>
|
||||||
|
<div className="relative">
|
||||||
|
<Input
|
||||||
|
className="w-full border border-subtle !bg-surface-1 placeholder:text-placeholder"
|
||||||
|
id="password"
|
||||||
|
name="password"
|
||||||
|
type={showPassword ? "text" : "password"}
|
||||||
|
inputSize="md"
|
||||||
|
placeholder="Enter your password"
|
||||||
|
value={formData.password}
|
||||||
|
onChange={(e) => handleFormChange("password", e.target.value)}
|
||||||
|
autoComplete="off"
|
||||||
|
/>
|
||||||
|
{showPassword ? (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className="absolute top-3.5 right-3 flex items-center justify-center text-placeholder"
|
||||||
|
onClick={() => setShowPassword(false)}
|
||||||
|
>
|
||||||
|
<EyeOff className="h-4 w-4" />
|
||||||
|
</button>
|
||||||
|
) : (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className="absolute top-3.5 right-3 flex items-center justify-center text-placeholder"
|
||||||
|
onClick={() => setShowPassword(true)}
|
||||||
|
>
|
||||||
|
<Eye className="h-4 w-4" />
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="py-2">
|
||||||
|
<Button type="submit" size="xl" className="w-full" disabled={isButtonDisabled}>
|
||||||
|
{isSubmitting ? <Spinner height="20px" width="20px" /> : "Sign in"}
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 6.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 466 B |
Binary file not shown.
|
After Width: | Height: | Size: 761 B |
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user