From 13f823e5e3c12689599da692e989e4c126dec791 Mon Sep 17 00:00:00 2001 From: ryan Date: Thu, 18 Jun 2026 10:50:45 +0800 Subject: [PATCH] test(bootstrap): fix review findings and sync architecture docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Register tasks in admin/task test setup after init() removal - Strengthen bootstrap test: RegisterPushDomainEvents before Init - Add admin_login auth→push listener integration test - Update AGENTS.md and push/new-async-task/new-api skills for bootstrap composition root, listener domain events, and explicit test wiring conventions introduced since 50c45db5 --- .agent/skills/new-api/SKILL.md | 3 +- .agent/skills/new-async-task/SKILL.md | 23 ++- .agent/skills/push-notification/SKILL.md | 88 +++++---- AGENTS.md | 17 +- .../push/custom_events/admin_login_test.go | 175 ++++++++++++++++++ internal/apps/admin/task/routers_test.go | 2 + internal/bootstrap/bootstrap_test.go | 21 ++- 7 files changed, 281 insertions(+), 48 deletions(-) create mode 100644 internal/apps/admin/push/custom_events/admin_login_test.go diff --git a/.agent/skills/new-api/SKILL.md b/.agent/skills/new-api/SKILL.md index 9752dec3..6d829fba 100644 --- a/.agent/skills/new-api/SKILL.md +++ b/.agent/skills/new-api/SKILL.md @@ -119,8 +119,9 @@ internal/ ### 步骤 2：在模块内实现业务逻辑 (`logics.go` / `service.go`) 业务逻辑逻辑应当实现于 `internal/apps/custom/` 目录下： -- **优先使用纯函数（`logics.go`）**：定义接收 `context.Context` 且不依赖 `*gin.Context` 的函数，易于单元测试。 +- **优先使用纯函数（`logics.go`）**：定义接收 `context.Context` 且不依赖 `*gin.Context` 的函数，易于单元测试与 Worker 复用。参考 `internal/apps/user/logics.go`。 - **有状态服务（`service.go`）**：若需注入依赖（如 DB 连接、外部客户端等），可定义 Service 结构体和构造函数。 +- **跨模块副作用（推送、任务监听等）**：核心业务代码通过 `internal/listener` 发射域事件，禁止直接 `import` push 模块；装配在 `internal/bootstrap` 完成（参见 `push-notification` skill）。 ### 步骤 3：编写 HTTP Handler (`routers.go`) 在 `internal/apps/custom/routers.go` 中编写 Handler： diff --git a/.agent/skills/new-async-task/SKILL.md b/.agent/skills/new-async-task/SKILL.md index 92774fe4..5305e14d 100644 --- a/.agent/skills/new-async-task/SKILL.md +++ b/.agent/skills/new-async-task/SKILL.md @@ -13,8 +13,9 @@ description: "Wavelet 项目专用：新增或修改 Asynq 异步任务、后台 - `internal/task/handler.go`：`TaskHandler`、`TaskResult`、`PayloadValidator` - `internal/task/meta.go`：`TaskMeta`、`TaskParam` -- `internal/task/executor.go`：下发、执行、日志、重试 -- `internal/task/handlers/register.go`：Handler 和元数据注册 +- `internal/task/executor.go`：下发、执行、日志、重试、`OnTaskCompleted` 订阅 +- `internal/task/handlers/register.go`：Handler 和元数据注册（由 bootstrap 调用） +- `internal/bootstrap/bootstrap.go`：任务注册与进程级装配入口 - `internal/task/worker/worker.go`：Worker 路由和队列 - `internal/task/scheduler/scheduler.go`：定时调度 - `internal/apps/admin/task/routers.go`：Admin 任务 API @@ -48,6 +49,24 @@ description: "Wavelet 项目专用：新增或修改 Asynq 异步任务、后台 - 在 `internal/task/handlers/register.go` 同时注册 Handler 和 `TaskMeta`。 - 不要在其他位置单独注册任务。 +- **禁止**在业务包 `routers.go` 或 `init()` 中调用 `task.RegisterHandler`；统一由 `bootstrap.RegisterTasks()` → `taskhandlers.Register()` 在进程启动时装配。 +- 任务完成钩子（如 push 通知）通过 `task.OnTaskCompleted` 注册，在 `bootstrap.RegisterTaskListeners()` 中装配（Worker/`all` 进程）。 + +### 进程装配分工 + +| 进程 | 注册入口 | +| :--- | :--- | +| `api` | `cmd/api.go` → `bootstrap.RegisterAPI()`（含 `RegisterTasks`） | +| `worker` | `worker.StartWorker()` → `bootstrap.RegisterWorker()`（含 `RegisterTasks` + `RegisterTaskListeners`） | +| `scheduler` | `scheduler.StartScheduler()` → `bootstrap.RegisterScheduler()` | +| `all` | `cmd/all.go` → `bootstrap.RegisterAll()` | + +所有 `Register*` 使用 `sync.Once`，重复调用安全。 + +### 测试 + +- 依赖已注册任务类型或 Handler 的测试（如 `internal/apps/admin/task/routers_test.go`），必须在 setup 中显式调用 `bootstrap.RegisterTasks()`。 +- 不得依赖 `init()` 副作用或 import 链触发注册。 ## 日志要求 diff --git a/.agent/skills/push-notification/SKILL.md b/.agent/skills/push-notification/SKILL.md index 4e4f5e52..4e4e0f12 100644 --- a/.agent/skills/push-notification/SKILL.md +++ b/.agent/skills/push-notification/SKILL.md @@ -17,7 +17,9 @@ Wavelet 的消息推送机制采用了**元数据驱动 + 统一触发器 + 异 | :--- | :--- | :--- | | **`pkg/push/`** | 推送基础设施层 | 静态定义、不依赖系统数据库和任何框架。定义了统一接口 `Pusher`、单例 `PusherPool` 和多实现（Lark, Webhook, Email 等），提供配置验证及发送功能。 | | **`internal/apps/admin/push/`** | 通知服务与后台任务层 | 包含以下核心文件：
1. [events.go](file:///Users/ryan/DEV/Go/Wavelet/internal/apps/admin/push/events.go)：定义通知事件的结构模型（`NotificationMessage`, `EventMetadata`）、内置事件的动态注册中心（`BuiltInEvents` 及 `RegisterBuiltInEvent` 函数）以及统一触发器类 `EventTrigger`（包括其底层的派发引擎逻辑）。
2. [tasks.go](file:///Users/ryan/DEV/Go/Wavelet/internal/apps/admin/push/tasks.go)：定义 Asynq 后台异步发送任务、处理器 `PushHandler` 及其校验逻辑，并记录推送历史审计。
3. [routers.go](file:///Users/ryan/DEV/Go/Wavelet/internal/apps/admin/push/routers.go)：管理端接口，负责获取事件配置列表和更新配置。 | -| **`internal/apps/admin/push/custom_events/`** | 自定义通知事件包 | 自定义的事件定义和触发函数单独放到此包下，**一个 Go 文件代表一个事件**。例如：
[admin_login.go](file:///Users/ryan/DEV/Go/Wavelet/internal/apps/admin/push/custom_events/admin_login.go) 代表管理员登录事件。 | +| **`internal/apps/admin/push/custom_events/`** | 自定义通知事件包 | 事件元数据定义与 push 侧处理逻辑；**一个 Go 文件代表一个事件**。在 [register.go](file:///Users/ryan/DEV/Go/Wavelet/internal/apps/admin/push/custom_events/register.go) 统一装配，禁止 `init()` 副作用。 | +| **`internal/listener/`** | 域事件分发层 | 核心域发射事件（如 `EmitAdminLoggedIn`），push 在 bootstrap 阶段通过 `OnAdminLoggedIn` 订阅，避免 auth/user 直接依赖 push。 | +| **`internal/bootstrap/`** | 应用装配根 | `RegisterPushDomainEvents()` 调用 `custom_events.Register()`；`Init` 中执行 `SyncEvents` 将内置事件元数据同步到数据库。 | | **数据库审计表** | 状态与历史审计 | `w_push_events` 存放每个通知事件的启用状态、启用渠道、发送目标和自定义渲染模板。
`w_push_histories` 存放消息发送记录用于审计。 | --- @@ -26,8 +28,8 @@ Wavelet 的消息推送机制采用了**元数据驱动 + 统一触发器 + 异 如果某个新业务（如“新用户注册”或“订单创建”）需要带有消息推送功能，请严格按照以下步骤开发： -### 步骤 1：在 `custom_events/` 中以一个文件声明事件元数据 -在 `internal/apps/admin/push/custom_events/` 下新建一个 Go 文件（如 `user_registered.go`），声明其事件元数据并利用 `init()` 动态注册。 +### 步骤 1：在 `custom_events/` 中声明事件元数据与处理函数 +在 `internal/apps/admin/push/custom_events/` 下新建一个 Go 文件（如 `user_registered.go`），声明 `EventMetadata` 和 push 侧处理函数（组装 body 并调用 `DefaultTrigger.Trigger`）。 ```go package custom_events @@ -37,10 +39,9 @@ import ( "time" "github.com/Rain-kl/Wavelet/internal/apps/admin/push" - "github.com/Rain-kl/Wavelet/internal/model" + "github.com/Rain-kl/Wavelet/internal/listener" ) -// NewUserRegistered is the metadata definition for the user registered event. var NewUserRegistered = push.EventMetadata{ Key: "user_registered", Name: "新用户注册提醒", @@ -52,58 +53,58 @@ var NewUserRegistered = push.EventMetadata{ Description: "当系统有新用户注册成功时，向管理员或指定目标发送通知", } -func init() { - push.RegisterBuiltInEvent(NewUserRegistered) -} -``` - -### 步骤 2：在该事件文件中编写触发封装函数 (Wrapper) -为了使业务层调用方便且类型安全，在同一个事件 Go 文件中为该事件定义一个封装函数。 - -> [!NOTE] -> - 底层框架 `EventTrigger.Trigger` 本身已经内置了**异步 Goroutine 执行**以及 **`context.WithoutCancel(ctx)` 衍生上下文转换**逻辑。 -> - 开发者只需在封装函数中组装数据，并直接调用 `DefaultTrigger.Trigger` 即可，无需在外部手动写 `go func()` 也不需要处理上下文防取消问题，从而通过框架底层强制约束了异步投递行为。 - -```go -// TriggerNewUserRegisteredEvent triggers the user registration notification event. -func TriggerNewUserRegisteredEvent(ctx context.Context, user *model.User) { - if user == nil { +func handleUserRegistered(ctx context.Context, event listener.UserRegistered) { + if event.User == nil { return } body := map[string]any{ - "user": user, + "user": event.User, "time": time.Now().Format("2006-01-02 15:04:05"), } push.DefaultTrigger.Trigger(ctx, NewUserRegistered, body) } ``` -### 步骤 3：在业务代码中调用触发函数 -在业务逻辑完成处（例如 `internal/apps/user/routers.go` 的注册 Handler 中）导入 `custom_events` 并调用该函数。 +> `EventTrigger.Trigger` 已内置异步 Goroutine 与 `context.WithoutCancel`；处理函数内直接调用即可，无需外层 `go func()`。 + +### 步骤 2：在 `listener/` 定义域事件并在 `register.go` 装配 +1. 在 `internal/listener/` 新增域事件类型、`Emit*` 与 `On*` 注册函数（参考 [admin_login.go](file:///Users/ryan/DEV/Go/Wavelet/internal/listener/admin_login.go)）。 +2. 在 [register.go](file:///Users/ryan/DEV/Go/Wavelet/internal/apps/admin/push/custom_events/register.go) 中注册元数据并订阅域事件： ```go -import ( - "github.com/Rain-kl/Wavelet/internal/apps/admin/push/custom_events" -) - -func Register(c *gin.Context) { - // ... 注册成功逻辑 ... - - // 异步触发通知推送事件 - custom_events.TriggerNewUserRegisteredEvent(ctx, user) +func Register() { + push.RegisterBuiltInEvent(NewUserRegistered) + listener.OnUserRegistered(handleUserRegistered) } ``` -### 步骤 4：在主路由器或初始化模块进行匿名导入以确保注册 -由于事件是在 `custom_events` 的 `init()` 中注册到 `push` 包的，所以应用程序的执行路径（例如 [router.go](file:///Users/ryan/DEV/Go/Wavelet/internal/router/router.go)）必须匿名导入 `custom_events` 包，以确保其在程序启动时被加载和初始化。 +**禁止**在 `custom_events` 或 `router` 中使用 `init()` 注册；**禁止**在 `router.go` 空白导入 `custom_events`。 + +### 步骤 3：在业务代码中发射域事件（不 import push） +在业务逻辑完成处（如 `internal/apps/user/routers.go`）仅 import `internal/listener` 并发射事件： ```go -import ( - _ "github.com/Rain-kl/Wavelet/internal/apps/admin/push/custom_events" -) +import "github.com/Rain-kl/Wavelet/internal/listener" + +func Register(c *gin.Context) { + // ... 注册成功逻辑 ... + listener.EmitUserRegistered(ctx, user) +} ``` -当程序启动后，系统在初始化阶段的 `SyncEvents` 流程中会自动将新声明的 `user_registered` 事件元数据插入数据库表 `w_push_events` 中。此后，管理员即可直接在管理端前端界面上为该事件配置推送渠道。 +### 步骤 4：在 bootstrap / cmd 入口显式装配 +新增事件后，确保 `custom_events.Register()` 已被 `bootstrap.RegisterPushDomainEvents()` 调用，且 API/`all` 进程在 `bootstrap.Init` 之前完成注册： + +| 进程 | cmd 入口调用 | +| :--- | :--- | +| `api` | `bootstrap.RegisterAPI()` → `bootstrap.Init(ctx, Options{API: true})` | +| `all` | `bootstrap.RegisterAll()` → `bootstrap.Init(ctx, Options{API: true})` | +| `worker` / `scheduler` | 不注册 push 域事件；仅 `bootstrap.Init` + 各自 `RegisterWorker`/`RegisterScheduler` | + +`Init` 中的 `SyncEvents` 会将 `user_registered` 元数据同步到 `w_push_events`，管理员即可在前端配置推送渠道。 + +### 步骤 5：编写集成测试 +在 `custom_events/` 或 `listener/` 包内添加测试，验证 `Emit*` → handler → `DefaultTrigger.Trigger` 全链路。测试 setup 须显式调用 `custom_events.Register()`（或 `bootstrap.RegisterPushDomainEvents()`）和 `push.SyncEvents`，参考 [admin_login_test.go](file:///Users/ryan/DEV/Go/Wavelet/internal/apps/admin/push/custom_events/admin_login_test.go)。 --- @@ -159,3 +160,12 @@ import ( ### 1. 禁止绕过统一触发器 (Always Use EventTrigger) - 所有推送请求必须经过 `EventTrigger.Trigger`，以确保进行“事件是否启用”、“目标渠道过滤”、“全局推送配置读取”及“发送日志审计”等流程。 + +### 2. 禁止业务模块直接依赖 push (Decouple via listener) +- `oauth`、`user` 等核心域 **不得** `import` `internal/apps/admin/push` 或 `custom_events`。 +- 跨模块通知必须通过 `internal/listener` 发射域事件；push 在 `custom_events.Register()` 中订阅。 + +### 3. 禁止 init() 与 router 副作用注册 (Explicit Bootstrap) +- 不得在 `init()` 中调用 `RegisterBuiltInEvent` 或订阅 listener。 +- 不得在 `router.go` 空白导入 `custom_events` 触发注册。 +- 统一在 `internal/bootstrap` + `internal/cmd` 入口显式装配。 diff --git a/AGENTS.md b/AGENTS.md index 9cd3053b..ce55e5b2 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -39,6 +39,10 @@ - 当 API Handler 发生变化时，更新 Swagger 文档（运行 `make swagger`）。 - 在完成代码开发后必须运行 `make code-check`, 并修复报错。 - 需要缓存或文件管理能力时，必须复用现有平台实现，禁止在业务包中自行创建缓存目录、直接管理缓存文件或重复封装存储后端。 +- 禁止在 `init()` 中注册跨模块集成（任务 Handler、推送内置事件、域事件监听器、任务完成钩子）。统一通过 `internal/bootstrap` 在 `internal/cmd` 入口显式装配。 +- `internal/router/router.go` 的 `Serve()` 仅负责 HTTP 路由与中间件，禁止在其中执行 `SyncEvents`、`InitLogWriter` 等进程级运行时初始化。 +- 核心业务模块（如 `oauth`、`user`）禁止直接 `import` `internal/apps/admin/push` 或 `custom_events` 触发通知；应通过 `internal/listener` 发射域事件，由 push 模块在 bootstrap 阶段订阅。 +- 编写依赖任务注册或推送事件同步的测试时，必须在测试 setup 中显式调用 `bootstrap.RegisterTasks()`、`bootstrap.RegisterPushDomainEvents()` 等，不得依赖 `init()` 副作用。 ## 项目介绍 @@ -67,7 +71,8 @@ 后端目录： -- `internal/cmd/`：用于 API、worker、scheduler、root init 的 Cobra 命令。 +- `internal/cmd/`：用于 API、worker、scheduler、root init 的 Cobra 命令。进程启动时在此调用 `bootstrap.Register*` 与 `bootstrap.Init`，再启动 router / worker / scheduler。 +- `internal/bootstrap/`：应用装配根（composition root）。集中注册任务 Handler、推送域事件订阅、任务完成监听器，并执行 `SyncEvents`、ClickHouse 访问日志写入等进程级初始化；所有注册函数使用 `sync.Once` 保证幂等。 - `internal/config/`：Viper 加载和配置结构体。运行时代码应使用 `config.Config.
.`。 - `internal/router/`：唯一的 HTTP 路由注册点。 - `internal/apps/`：按功能（Feature-based）组织的 HTTP Handler、中间件、内部服务与模块逻辑。移除全局 service 层，模块内部业务逻辑（如验证码业务逻辑管理器 `internal/apps/cap/manager.go`）均收敛于各自模块中；管理端模块位于 `internal/apps/admin/`。 @@ -79,7 +84,7 @@ - `internal/task/`：Asynq 任务框架；参见 `new-async-task` 了解变更。 - `internal/common/`：共享的通用模型及响应（如 `internal/common/response`）、绑定（bind）、常量以及通用错误。 - `internal/util/`：纯底层工具包，无任何 HTTP/数据库框架依赖。 -- `internal/listener/`：事件监听器和消息/Webhook 消费者。 +- `internal/listener/`：域事件分发层。核心域（auth、user 等）在此定义并发射事件（如 `EmitAdminLoggedIn`）；运维模块（push、webhook 等）在 bootstrap 阶段订阅，实现跨模块解耦。 - `internal/otel_trace/`：链路追踪（tracing）助手。 - `internal/testhelper/`：后端测试共享辅助能力。 - `internal/buildinfo/`：暴露在发布/构建工作流中注入的元数据（如版本号、编译时间等）。 @@ -139,7 +144,13 @@ Handler 规范： 路由与模块： - 仅在 `internal/router/router.go` 中作为统一高层入口进行路由分发委派，不允许在 `router.go` 中直接挂载业务 Handler。 -- 关于所有的路由归属划分、接口开发隔离防线以及详细的注册和开发步骤，请直接阅读并严格遵循 [new-api](file:///Users/ryan/DEV/Go/Wavelet/.agent/skills/new-api/SKILL.md) 技能。 +- 关于所有的路由归属划分、接口开发隔离防线以及详细的注册和开发步骤，请直接阅读并严格遵循 [new-api](file:///Users/ryan/DEV/Go/Wavelet/.claude/skills/new-api/SKILL.md) 技能。 + +应用装配与跨模块集成： + +- 新增跨模块副作用（任务注册、推送订阅、后台监听器）时，在 `internal/bootstrap/bootstrap.go` 增加 `Register*` 函数，并在对应 `internal/cmd/*.go` 入口调用；参考现有 `RegisterAPI` / `RegisterWorker` / `RegisterAll` 分工。 +- `bootstrap.Init` 必须在 `RegisterPushDomainEvents()` 之后调用（API/`all` 模式），以确保 `SyncEvents` 能同步内置推送事件元数据。 +- Handler 与业务逻辑分离：HTTP Handler 负责绑定与响应；可复用逻辑放入 `logics.go`（接受 `context.Context`，不依赖 `*gin.Context`），便于 Worker 与单元测试复用。参考 `internal/apps/user/logics.go`。 中间件： diff --git a/internal/apps/admin/push/custom_events/admin_login_test.go b/internal/apps/admin/push/custom_events/admin_login_test.go new file mode 100644 index 00000000..b9c54f81 --- /dev/null +++ b/internal/apps/admin/push/custom_events/admin_login_test.go @@ -0,0 +1,175 @@ +// Copyright 2026 Arctel.net +// SPDX-License-Identifier: Apache-2.0 + +package custom_events + +import ( + "context" + "encoding/json" + "sync" + "testing" + "time" + + "github.com/Rain-kl/Wavelet/internal/apps/admin/push" + "github.com/Rain-kl/Wavelet/internal/listener" + "github.com/Rain-kl/Wavelet/internal/model" + "github.com/Rain-kl/Wavelet/internal/task" + "github.com/Rain-kl/Wavelet/internal/testhelper" + "github.com/hibiken/asynq" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "gorm.io/gorm" +) + +var registerOnce sync.Once + +func ensureRegistered() { + registerOnce.Do(Register) +} + +func setupAdminLoginIntegrationTest(t *testing.T) (*gorm.DB, func()) { + t.Helper() + + dbConn, mr, cleanup := testhelper.SetupTestEnvironment(t) + + err := dbConn.AutoMigrate( + &model.PushEvent{}, + &model.PushHistory{}, + &model.PushChannel{}, + ) + require.NoError(t, err) + + sysUser := &model.User{ + ID: 999, + Username: "system", + Nickname: "系统", + Password: "*", + IsActive: true, + } + require.NoError(t, dbConn.Create(sysUser).Error) + + task.AsynqClient = asynq.NewClient(asynq.RedisClientOpt{Addr: mr.Addr()}) + task.RegisterHandler(push.SendNotificationTask, &push.PushHandler{}) + task.RegisterTaskMeta(push.SendNotificationMeta) + + ensureRegistered() + + require.NoError(t, push.SyncEvents(context.Background())) + + return dbConn, func() { + cleanup() + if task.AsynqClient != nil { + task.AsynqClient.Close() + task.AsynqClient = nil + } + } +} + +func seedMockPushChannel(t *testing.T, dbConn *gorm.DB) *model.PushChannel { + t.Helper() + + channel := &model.PushChannel{ + Name: "mock_channel", + Type: "custom", + URL: "https://webhook.site/admin-login", + Other: `{"text": "$content"}`, + Enabled: true, + } + require.NoError(t, dbConn.Create(channel).Error) + return channel +} + +func enableAdminLoginEvent(t *testing.T, dbConn *gorm.DB, channelName string, targets []string) { + t.Helper() + + var event model.PushEvent + require.NoError(t, dbConn.Where("event_key = ?", AdminLogin.Key).First(&event).Error) + + event.Enabled = true + event.Channels = []string{channelName} + event.Targets = targets + require.NoError(t, dbConn.Save(&event).Error) +} + +func waitForAsyncTrigger(t *testing.T) { + t.Helper() + time.Sleep(100 * time.Millisecond) +} + +func countPushTasks(t *testing.T, dbConn *gorm.DB) int64 { + t.Helper() + + var count int64 + require.NoError(t, dbConn.Model(&model.TaskExecution{}). + Where("task_type = ?", push.SendNotificationTask). + Count(&count).Error) + return count +} + +func TestAdminLoginPushIntegration(t *testing.T) { + dbConn, cleanup := setupAdminLoginIntegrationTest(t) + defer cleanup() + + channel := seedMockPushChannel(t, dbConn) + defer dbConn.Delete(channel) + + enableAdminLoginEvent(t, dbConn, channel.Name, []string{"ops_team"}) + + adminUser := &model.User{ + ID: 1001, + Username: "super_admin", + IsAdmin: true, + IsActive: true, + } + require.NoError(t, dbConn.Create(adminUser).Error) + + t.Run("admin login emits push task with user and ip", func(t *testing.T) { + dbConn.Where("task_type = ?", push.SendNotificationTask).Delete(&model.TaskExecution{}) + + listener.EmitAdminLoggedIn(context.Background(), adminUser, "203.0.113.42") + waitForAsyncTrigger(t) + + var execution model.TaskExecution + require.NoError(t, dbConn.Where("task_type = ?", push.SendNotificationTask).First(&execution).Error) + + var payload push.SendPayload + require.NoError(t, json.Unmarshal([]byte(execution.Payload), &payload)) + + assert.Equal(t, AdminLogin.Key, payload.EventKey) + assert.Equal(t, "ops_team", payload.Target) + assert.Equal(t, "管理员登录提醒", payload.Body.Title) + assert.Contains(t, payload.Body.Content, "super_admin") + assert.Contains(t, payload.Body.Content, "203.0.113.42") + }) + + t.Run("non-admin login does not trigger push", func(t *testing.T) { + dbConn.Where("task_type = ?", push.SendNotificationTask).Delete(&model.TaskExecution{}) + + nonAdmin := &model.User{ + ID: 2002, + Username: "regular_user", + IsAdmin: false, + IsActive: true, + } + require.NoError(t, dbConn.Create(nonAdmin).Error) + + listener.EmitAdminLoggedIn(context.Background(), nonAdmin, "198.51.100.1") + waitForAsyncTrigger(t) + + assert.Equal(t, int64(0), countPushTasks(t, dbConn)) + }) + + t.Run("disabled admin login event does not enqueue push", func(t *testing.T) { + dbConn.Where("task_type = ?", push.SendNotificationTask).Delete(&model.TaskExecution{}) + + var event model.PushEvent + require.NoError(t, dbConn.Where("event_key = ?", AdminLogin.Key).First(&event).Error) + event.Enabled = false + require.NoError(t, dbConn.Save(&event).Error) + + listener.EmitAdminLoggedIn(context.Background(), adminUser, "10.0.0.1") + waitForAsyncTrigger(t) + + assert.Equal(t, int64(0), countPushTasks(t, dbConn)) + }) +} \ No newline at end of file diff --git a/internal/apps/admin/task/routers_test.go b/internal/apps/admin/task/routers_test.go index 2102c022..5c118ff4 100644 --- a/internal/apps/admin/task/routers_test.go +++ b/internal/apps/admin/task/routers_test.go @@ -16,6 +16,7 @@ import ("bytes" "github.com/Rain-kl/Wavelet/internal/apps/oauth" "github.com/Rain-kl/Wavelet/internal/apps/upload" "github.com/Rain-kl/Wavelet/internal/apps/user" + "github.com/Rain-kl/Wavelet/internal/bootstrap" "github.com/Rain-kl/Wavelet/internal/model" "github.com/Rain-kl/Wavelet/internal/task" "github.com/Rain-kl/Wavelet/internal/testhelper" @@ -29,6 +30,7 @@ import ("bytes" func setupTaskTestEnvironment(t *testing.T) func() { _, mr, cleanup := testhelper.SetupTestEnvironment(t) + bootstrap.RegisterTasks() task.AsynqClient = asynq.NewClient(asynq.RedisClientOpt{ Addr: mr.Addr(), }) diff --git a/internal/bootstrap/bootstrap_test.go b/internal/bootstrap/bootstrap_test.go index ef678c03..7823d14b 100644 --- a/internal/bootstrap/bootstrap_test.go +++ b/internal/bootstrap/bootstrap_test.go @@ -20,15 +20,30 @@ func TestInitSyncsPushEventsOnce(t *testing.T) { t.Fatalf("auto migrate push events failed: %v", err) } + RegisterPushDomainEvents() + + wantCount := len(admin_push.BuiltInEvents) + if wantCount < 1 { + t.Fatalf("built-in push events = %d, want at least 1", wantCount) + } + ctx := context.Background() Init(ctx, Options{}) - Init(ctx, Options{API: true}) + Init(ctx, Options{API: true}) // second Init must not duplicate events (initRuntimeOnce) var count int64 if err := dbConn.Model(&model.PushEvent{}).Count(&count).Error; err != nil { t.Fatalf("count push events failed: %v", err) } - if count != int64(len(admin_push.BuiltInEvents)) { - t.Fatalf("push event count = %d, want %d", count, len(admin_push.BuiltInEvents)) + if count != int64(wantCount) { + t.Fatalf("push event count = %d, want %d", count, wantCount) + } + + var adminLogin model.PushEvent + if err := dbConn.Where("event_key = ?", "admin_login").First(&adminLogin).Error; err != nil { + t.Fatalf("admin_login event not found after Init: %v", err) + } + if adminLogin.Name != "管理员登录" { + t.Fatalf("admin_login name = %q, want %q", adminLogin.Name, "管理员登录") } } \ No newline at end of file