@gadmin2n/schematics 0.0.92 → 0.0.94

package/dist/lib/application/files/gadmin2-game-angle-demo/readme.md

@@ -13,31 +13,6 @@ Check CLI version
 $ gadmin2 -v
 ```
 
-## Template Sync
-
-本项目是 gadmin2 的实例项目。日常在本项目迭代新功能，完成后需要同步回模板。
-
-### 查看与模板的差异
-```bash
-# 完整 diff（含文件内容差异）
-$ gadmin2 template diff
-
-# 只看文件列表
-$ gadmin2 template diff --no-content
-```
-
-### 从模板拉取更新
-```bash
-# 预览变更（不执行）
-$ gadmin2 template update --dry-run
-
-# 执行更新（冲突文件会生成 conflict markers）
-$ gadmin2 template update
-
-# 跳过确认
-$ gadmin2 template update -y
-```
-
 ## Usage
 
 ### Define data model
@@ -70,6 +45,174 @@ $ yarn start:dev
 ```
 About nestjs server [read more](https://ptc.coding.intlgame.com/p/gadmin2/d/schematics/git/tree/master/src/lib/application/files/server/nest/README.md)
 
+## 构建与部署
+
+### 模块划分
+
+monorepo 包含 3 个独立部署的模块：
+
+| 模块 | 路径 | 镜像 |
+|------|------|------|
+| Web | `web/` | `gadmin2-web` |
+| Server | `server/` | `gadmin2-server` |
+| Temporal Worker | `temporal/worker/` | `gadmin2-worker` |
+
+### Dockerfile 布局
+
+所有 Dockerfile 都放在项目根（`-f Dockerfile.*`），构建上下文也是项目根。
+
+| 文件 | 作用 |
+|------|------|
+| `Dockerfile.codegen` | 装 gadmin2 CLI + server devDeps，跑 `gadmin2 g prisma`，产出**带生成代码的中间镜像** |
+| `Dockerfile.web` | `FROM ${CODEGEN_IMAGE}` 取 web 源码 → vite build → nginx |
+| `Dockerfile.server` | `FROM ${CODEGEN_IMAGE}` 取 server 源码 → gadmin2 build → NestJS runner |
+| `temporal/worker/Dockerfile` | 独立 worker，不依赖 codegen |
+
+**为什么独立 codegen 镜像（方案 C）：**
+- `gadmin2 g prisma` 物理上依赖 server 的 devDeps（`@gadmin2n/prisma-react-generator` / `prisma-nest-generator`）
+- 抽出单独镜像后，web/server 各自的镜像不再需要重装 server devDeps，构建更轻
+- 同一 docker daemon 内 `FROM ${CODEGEN_IMAGE}` 直接命中本地缓存，**不需要 push/pull registry**
+
+### 本地构建（docker-compose 集成验证）
+
+```bash
+# 首次 / config/ 有变更后：先 rebuild codegen 中间镜像
+docker compose --profile codegen build codegen
+
+# 起全套服务（PG + Temporal + Server + Worker + Web）
+docker compose up -d --build
+```
+
+详细使用与端口分配见 `docker-compose.md`。
+
+> 注：开发态 web/server 推荐直接 `yarn dev` / `yarn start:dev`（见 Usage 章节），`docker compose` 是用于完整集成验证。
+
+### CI/CD 流水线
+
+由 Coding CI（Jenkins）驱动，分支 `test` / `master` 自动触发。流水线定义在项目根 `Jenkinsfile`。
+
+**路径触发规则（变更哪些目录构建哪些镜像）：**
+
+| 变更路径 | web | server | worker |
+|------|:---:|:---:|:---:|
+| `web/**` | ✅ | | |
+| `config/ui/**` | ✅ | | |
+| `config/prisma/**` | ✅ | ✅ | |
+| `server/**` | | ✅ | |
+| `temporal/worker/**` | | | ✅ |
+
+纯文档变更（`docs/`、`*.md`、`.gitignore`、`Jenkinsfile` 自身、`.claude/`、`sync-to-template.*`）跳过所有构建。
+
+**流水线阶段：**
+
+```
+检出 Git
+   ↓
+检测变更模块（计算 BUILD_WEB / BUILD_SERVER / BUILD_WORKER）
+   ↓
+代码生成（仅当 BUILD_WEB || BUILD_SERVER）
+   docker build -f Dockerfile.codegen -t gadmin2-codegen:build-${N} .
+   产出本地中间镜像，不 push
+   ↓
+并行构建推送镜像
+   ├─ web    docker build --build-arg CODEGEN_IMAGE=... -f Dockerfile.web .  → push
+   ├─ server docker build --build-arg CODEGEN_IMAGE=... -f Dockerfile.server . → push
+   └─ worker docker build -f temporal/worker/Dockerfile temporal/worker        → push
+   ↓
+触发 Spinnaker 部署 webhook（每个模块独立的 application）
+   ↓
+post.always: 清理本地 codegen 中间镜像
+```
+
+### 部署
+
+镜像推送到 Coding 制品库后，Jenkins 通过 webhook 触发 [Spinnaker](https://api-spinnaker.devops.intlgame.com)，由 Spinnaker 完成 K8s 滚动更新。Spinnaker application 命名约定：`oit-gadmin2-{web|server|worker}-{test|prod}`。
+
+### 数据库初始化全链路
+
+数据库的「库 → schema → 表 → 基础数据」分布在多个环节自动完成。本地 compose 与生产/临时环境走的是不同路径，以下是从容器启动到接入流量的完整时序。
+
+#### 1. 本地 compose（`./compose-ctl.sh up`）
+
+```
+./compose-ctl.sh up
+   └── docker compose up
+        ├── postgres 服务首次启动（pgdata 卷为空时）
+        │    └── 自动执行 /docker-entrypoint-initdb.d/init.sql   ← 数据库在这里创建
+        │          • CREATE DATABASE gadmin_demo
+        │          • CREATE DATABASE temporal
+        │          • CREATE DATABASE temporal_visibility
+        │
+        ├── server-init（一次性容器，depends_on postgres healthy）
+        │    • yarn push:db    （prisma 把 schema 推到 gadmin_demo）
+        │    • yarn seed       （播种 RBAC 等基础数据，跑完即退出 Exited 0）
+        │
+        └── server / web / temporal-* （正常服务）
+```
+
+要点：
+- `init.sql` 只在 **pgdata 卷为空** 时执行一次。`./compose-ctl.sh --reset` 会清卷重新触发；卷还在但库被手动 drop 不会重跑。
+- `server-init` 显示 `Exited 0` 是正常状态，不是失败。
+- 业务 server 镜像走 `--production` 安装，**不带** ts-node / prisma CLI / `seed/` 源码，因此 seed 不能在 server 容器里跑，必须独立 server-init。
+
+#### 2. 生产 / 临时环境（K8s + `server/start-prod.sh`）
+
+server 镜像的入口是 `start-prod.sh`，比本地 compose 多了「按需 push:db」「per-branch schema 隔离」逻辑：
+
+```
+container start
+   └── start-prod.sh
+        ├── 加载 .env（不覆盖已有 env 变量）
+        ├── 校验 DATABASE_URL 非空
+        │
+        ├── node ensure-database.js                  ← 兜底建库（IF NOT EXISTS 风格，幂等）
+        │   ※ 本地 compose 此步是 no-op（init.sql 已建好）；
+        │     主战场：托管 PG / 库被误删 / 无 docker-entrypoint-initdb.d 的环境
+        │
+        ├── 根据 DEPLOY_NAME 分支：
+        │   │
+        │   ├─ A. 临时环境（feature*/bugfix*/hotfix*）：每次启动都重建分支 schema
+        │   │    • 改写 DATABASE_URL：schema=<DEPLOY_NAME>（- 与 / 替换为 _）
+        │   │    • yarn push:db
+        │   │    • node migrate-between-pg-schemas.js   （从 public schema 拷数据到分支 schema）
+        │   │    • yarn seed                            （幂等，每次启动都跑）
+        │   │
+        │   └─ B. 非临时环境（默认 / production）：按需初始化
+        │        • DATABASE_URL 兜底 schema=public
+        │        • 探测 t_role：不存在或 count=0 → yarn push:db + yarn seed；否则跳过
+        │        • 连接失败等异常 → 保守走初始化路径
+        │
+        └── exec node dist/src/main                  ← 启动 NestJS
+```
+
+要点：
+- `ensure-database.js` 与本地 compose 的 `init.sql` 是**互补关系**：compose 路径走 init.sql，K8s / 外部托管 PG 走 ensure-database.js。重复执行无副作用。
+- 临时环境「每次启动都 seed」依赖所有 seed 实现都是 upsert / skipDuplicates 风格，重复跑不插重。
+- 非临时环境用 `t_role` 行数判断是否需要初始化（首次部署或被清库），避免每次重启都跑 push:db + seed。
+- 如果部署环境已通过 DBA / 运维流程保证库存在，可设 `SKIP_ENSURE_DATABASE=1` 跳过 ensure-database.js（预留开关，当前实现未消费该变量，按需扩展）。
+
+#### 3. 谁在何时建什么 — 总览
+
+| 对象 | 本地 compose | 生产 / 临时环境 |
+|---|---|---|
+| 数据库（`gadmin_demo`） | `dev/postgres/init.sql`（pgdata 卷为空时） | `ensure-database.js`（每次启动幂等） |
+| Schema + 表结构 | `server-init` 里 `yarn push:db` | `start-prod.sh` 按分支策略 `yarn push:db` |
+| 基础数据（seed） | `server-init` 里 `yarn seed` | `start-prod.sh` 按分支策略 `yarn seed` |
+| 临时环境 schema 隔离 | — | `start-prod.sh` 改写 DATABASE_URL + `migrate-between-pg-schemas.js` |
+
+## Template Sync
+
+本项目是 gadmin2 的实例项目。日常在本项目迭代新功能，完成后需要同步回模板。
+
+### 将本项目变更推送回模板
+```bash
+# 预览
+$ ./sync-to-template.sh --dry-run
+
+# 执行同步
+$ ./sync-to-template.sh
+```
+
 ## 登录流程
 
 ```

package/dist/lib/application/files/gadmin2-game-angle-demo/server/.env

@@ -18,10 +18,10 @@ TAIHU_BASE=https://tai.it.tencent.com/api/auth-center/oauth2
 
 #https://tai.it.woa.com/odc/app/list?currentPage=0&pageSize=10
 TAIHU_ODC_CLIENT_ID=oit-erp-app
-TAIHU_ODC_APP_TOKEN=token
+#TAIHU_ODC_APP_TOKEN=token
 
 #https://tai.it.woa.com/apps?currentPage=0&pageSize=10
-TAIHU_APP_TOKEN=token
+#TAIHU_APP_TOKEN=token
 
 EXTERNAL_PAGE_SECRET=secret
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gadmin2n/schematics",
-  "version": "0.0.92",
+  "version": "0.0.94",
   "description": "Gadmin - modern, fast, powerful node.js web framework (@schematics)",
   "main": "dist/index.js",
   "files": [