mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-09-29 14:06:36 +08:00
dbaa3bf140
docs(changelog): 修正表述笔误
refactor(cordis): 磁盘缓存改用上上游能力并清理本地副本
按上游/下游归属规约:类型断言守卫已回流 Wavelet(f3d85d5,附回归用例),
本仓库删除 OpenFlare/plugins/server/pkg/cache 整包并改 import 到
Wavelet/pkg/cache/disk,同步后与上游零漂移。
验证:go build 通过;go test ./... exit 0(137 包 ok);256 条路由对拍与
232 条 swagger 操作均零差异;make build-all 四进制;前端零改动。
docs(cordis): 记录 T1 清理结果与五个复用阻塞点
refactor(cordis): server 复用上游 pkg 能力并删除等价本地副本
按上游/下游归属规约清理重复实现,删除 7 个与上游等价的本地包并改 import:
shared/response→pkg/response、pkg/{logger,mail,trace,httppool,cache/ram}→
上游同名包、infra/persistence/batchwriter→pkg/batchwriter。逐项核过差异:
httppool 逐字节相同;logger 的 Config 字段完全一致;response 的 7 个 Abort*
一致;cache/ram 换过去顺带把裸 go 变回带 panic 恢复的 util.Go。
两处非等价差异按语义处理:
- batchwriter.Stats 与 status DTO 原为类型别名,改为消费侧逐字段转换,
避免 model 反向依赖基础设施类型;
- 上游 pkg/idgen 要求显式 Init(本地副本为懒加载自动初始化),本次保留本地
副本,待与 infra 初始化一并迁移(已登记在清理计划)。
验证:go build 通过;go test ./... exit 0(138 包 ok);256 条路由对拍零差异;
make swagger 232 条操作零增减,且归一化后与旧文档深度相等——差异仅为
response.Any / logger.LogEntry 两个定义名随包路径改名,接口形状未变。
chore(cordis): 回流内核与 pkg/util 通用能力并清理 vendoring 污染
按新增的上游/下游归属规约:HandleRaw/BasePath 与版本比较、网络、格式化助手
属通用能力,已提交到 Wavelet 分支 feat/cordis-router-raw-routes,本仓库改为
纯同步获取(pkg/util 已零漂移),补丁登记保留至上游合并。
同时修掉我此前 git add -A 造成的污染:首次 vendoring 把上游工作区里被
gitignore 的运行期产物一起提交进来(upload 的 diskcache 缓存块 650 个与
driver_http/dist 前端构建物 380 个,共 12872 行/1030 文件)。sync-upstream.sh
现显式排除 uploads/dist/data/*.db,.gitignore 补上对应兜底规则。
AGENTS.md 增加上游/下游改动归属规约,并把仍指向前 Cordis 布局的硬性约束
(internal/router + Serve、internal/repository/logstore、internal/platform/bootstrap、
internal/cmd)改到当前插件路径。
验证:go build 通过;go test ./... exit 0(144 包 ok);make swagger 232 条
操作与基线逐条一致;make build-all 四进制;gofmt 干净。
feat(cordis): server 插件化并改由内核挂载控制面路由
新增 plugins/server/plugin.go:Apply 以 ctx.Router().Group(app.api_prefix)
声明根级与 /v1 全部路由;33 个注册函数由 *gin.RouterGroup 改为
core.RouterExtension,RegisterCollection 改用内核新增的 HandleRaw 保留
尾部斜杠变体,AdminMiddlewares 返回 []any(Go 不允许把 []T 展开为 ...any)。
删除 router.Serve 与 registerRoutes,装配根改为 core.App +
driver_http.New(WithEngine(router.BuildEngine())),监听、信号与优雅退出归内核;
前端 SPA 的 NoRoute 兜底因内核暂无贡献点而保留在引擎层。
路由保真证据:plugin_parity_test 对拍 baseline/routes-engine.txt 的 256 条
(方法 路径) 零差异;go test ./... exit 0(144 包 ok,含真实 handler 的
openflare/integration 用例走同一条挂载路径);make swagger 232 条操作与基线
逐条一致;golangci-lint 0 issues;make build-all 四进制;embed_frontend
标签编译通过;前端零改动。
已知待补:带 Redis 的实机 HTTP 冒烟(本机 6379 未启动,session store 与
改造前一样在建店阶段即 fatal),以及 bootstrap 的任务/设置/迁移注册迁入 Apply。
feat(core): RouterExtension 增加 HandleRaw 与 BasePath 以保真尾部斜杠路由
server 插件化的前置:Handle 经 cleanPath 会剥掉尾部斜杠,无法表达
/resource 与 /resource/ 两条不同路由,而 OpenFlare 有 20 个历史 list
端点两者都注册且部署关闭了 RedirectTrailingSlash,缺失即 404。新增
HandleRaw 与 BasePath(作用域包装器同样登记反注册),补 extpoints 用例;
并把 router.Serve 拆出 BuildEngine 以便交给 driver_http.WithEngine 复用,
新增路由表导出 harness,固化 256 条 (方法 路径) 基线供插件化对拍。
上游补丁登记于 backend/OpenFlare/upstream-patches.md,同步脚本改为按目录
前缀输出差异并在同步后提醒确认补丁是否仍在。
验证:go build 通过;go test ./... exit 0(143 包 ok);gofmt 干净。
docs(cordis): 记录 server 插件接入内核的可行路径与内核能力缺口
feat(cordis): agent/relay/flared 落地为内核驱动插件
三个边缘守护进程各新增 plugin.go,实现 core.Plugin + core.Driver
(自定义 DriverType 与同名 profile),装配与生命周期从 main 迁入
Apply/Start/Stop:Apply 负责 JSON 配置加载、运行环境与用户确保、
openresty/frps/frpc 管理器与各服务装配;Start 以 util.Go 拉起阻塞式
runner 与 GeoIP 周期更新;Stop 收敛主循环结果并在超时时报错而非静默。
入口改为 core.NewApp(core.WithProfile(...)) + Prepare/Run,保持
-config 旗标、默认路径、退出码与启动/停止日志不变。
验证:go build 通过;go test ./... exit 0(143 包 ok,含 3 个插件身份
与配置失败路径测试);make build-all 四进制产出;三进制实跑缺失配置
均 exit 1 且错误链保留 load {agent,relay,flared} config 原因;gofmt 干净。
refactor(cordis): 按功能职责拆分为 4 个插件与 share 共享层
backend/OpenFlare 不再平铺遗留分层,改为 plugins/{server,agent,relay,flared}
加 share/:控制面业务(openflare/admin/oauth/user/upload/cap/config/health 与
repository/model/infra/router 等支撑层)归 server;三个边缘守护进程各自成插件;
被两个以上插件消费的 protocol/geoip/wsclient/render/pagesarchive/edge 归 share。
同时把 pkg/util 与 buildinfo 合并回上游 pkg(上游已覆盖全部符号,仅 8 个函数与
2 个类型为 OpenFlare 独有,已一并迁入),装配根统一到 backend/cmd(含三个 daemon
入口),Dockerfile 与 release 工作流的构建路径和 -X 注入路径同步更新。
验证:go build 通过;go test ./... exit 0(141 包 ok);make swagger exit 0 且
232 条 API 操作与基线逐条一致;make build-all 产出 4 进制;-X 注入经二进制
strings 实测生效;日志后端直连门禁改写为按 server 插件业务域扫描并在扫描数为 0
时报错(防门禁静默失效);前端零改动。
feat(cordis): 落地 backend/share 共享层与上游同步脚本
跨插件共享资源(控制消息协议、GeoIP+iputil、边缘守护进程日志)从下游包
移入 backend/share,并声明其只能依赖 core/pkg 与标准/第三方库,禁止反向
引用下游业务与具体插件实现;新增 scripts/sync-upstream.sh 只覆盖
backend/{core,pkg,plugins},同步后 --check 报告零差异,证明与上游逐字一致。
go build 通过,go test ./... exit 0(142 包 ok),前端零改动。
refactor(cordis): 采用与 Wavelet 同构的单模块布局并引入上游内核
按上游结构落位:backend/{core,pkg,plugins} 为 Wavelet 上游拷贝,OpenFlare
全部业务收拢到上游 downstream 所对应的位置 backend/OpenFlare/,模块名保持
Wavelet 以保证上游 import 路径逐字一致、同步零改写;三个 daemon 入口移至
backend/OpenFlare/cmd,backend/cmd 与 main.go 作为控制面装配根。
行为不变:go build 通过,142 个测试包全绿(含上游插件测试),232 条 API
操作与改造前逐条一致,四进制产物正常,前端零改动。swagger 暂只扫描下游代码,
待 P4 挂载上游路由后再纳入 plugins/。
style: 修正模块路径改写导致的 import 分组排序漂移
refactor(layout): Go 代码迁入 backend/ 并将模块名简化为 OpenFlare
对齐上游 Wavelet 的仓库布局,为以第二 module 形态 vendoring Cordis 内核与
平台插件做准备:模块路径整体改写为 OpenFlare,Go 目标加 cd backend,
swaggo 产物移至 backend/docs 并把 json/yaml 复制回 docs/ 供站点消费,
Dockerfile 与 release 工作流的构建目录、ldflags 模块路径同步更新。
行为保持不变:232 条路由与改造前逐条一致,95 个测试包全绿,
四进制产物正常,前端零改动。
chore(cordis): 落地改造计划与 schema/路由基线
新增 legacy_dump_test 迁移快照 harness:在临时 sqlite 库上按生产顺序
(goose.UpTo → zone 导入 → goose.Up)跑完 76 个历史迁移并导出 schema 与
版本序列,作为改造前后一致性门禁的唯一事实来源。同时记录 232 条路由清单
与 foundation 实施计划。
docs(cordis): add OpenFlare Cordis 架构改造设计
明确上游以第二 module 形态 vendoring 进 backend/Wavelet、4 个插件
(server/agent/relay/flared) 全部装载内核,并规定保留 76 个历史 goose
迁移 + 一次性版本 stamp 桥接的迁移方案,配套三方 schema 一致性门禁,
确保已部署库不重跑历史、不丢数据。
286 lines
6.6 KiB
Go
286 lines
6.6 KiB
Go
// Copyright 2026 Arctel.net
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package extpoints
|
|
|
|
import (
|
|
"Wavelet/core/contracts"
|
|
"sync"
|
|
"time"
|
|
)
|
|
|
|
// TaskDefinition holds the definition and runtime options for an asynchronous background task.
|
|
type TaskDefinition struct {
|
|
Pattern string
|
|
Type string
|
|
Name string
|
|
DisplayName string
|
|
Description string
|
|
Category string
|
|
SupportsTime bool
|
|
Retryable bool
|
|
Queue string
|
|
Params []contracts.TaskParamDTO
|
|
Handler any
|
|
Concurrency int
|
|
Retry int
|
|
Timeout time.Duration
|
|
Metadata map[string]any
|
|
}
|
|
|
|
// TaskOption configures a TaskDefinition.
|
|
type TaskOption func(*TaskDefinition)
|
|
|
|
// WithTaskType sets the admin task type identifier.
|
|
func WithTaskType(taskType string) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Type = taskType
|
|
}
|
|
}
|
|
|
|
// WithTaskName sets the task human-readable display name.
|
|
func WithTaskName(name string) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Name = name
|
|
if td.DisplayName == "" {
|
|
td.DisplayName = name
|
|
}
|
|
}
|
|
}
|
|
|
|
// WithTaskDisplayName sets the task display name.
|
|
func WithTaskDisplayName(displayName string) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.DisplayName = displayName
|
|
if td.Name == "" {
|
|
td.Name = displayName
|
|
}
|
|
}
|
|
}
|
|
|
|
// WithTaskDescription sets the task description.
|
|
func WithTaskDescription(desc string) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Description = desc
|
|
}
|
|
}
|
|
|
|
// WithTaskCategory sets the task category grouping.
|
|
func WithTaskCategory(category string) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Category = category
|
|
}
|
|
}
|
|
|
|
// WithTaskSupportsTime sets whether the task supports time range filtering.
|
|
func WithTaskSupportsTime(supports bool) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.SupportsTime = supports
|
|
}
|
|
}
|
|
|
|
// WithTaskQueue sets the task queue.
|
|
func WithTaskQueue(queue string) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Queue = queue
|
|
}
|
|
}
|
|
|
|
// WithTaskRetryable sets whether the task is retryable.
|
|
func WithTaskRetryable(retryable bool) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Retryable = retryable
|
|
}
|
|
}
|
|
|
|
// WithTaskParams sets the task parameter definitions.
|
|
func WithTaskParams(params ...contracts.TaskParamDTO) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Params = append(td.Params, params...)
|
|
}
|
|
}
|
|
|
|
// WithTaskMeta sets all task metadata from a TaskMetaDTO.
|
|
func WithTaskMeta(meta contracts.TaskMetaDTO) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
if meta.Type != "" {
|
|
td.Type = meta.Type
|
|
}
|
|
if meta.Name != "" {
|
|
td.Name = meta.Name
|
|
}
|
|
if meta.DisplayName != "" {
|
|
td.DisplayName = meta.DisplayName
|
|
}
|
|
if meta.Description != "" {
|
|
td.Description = meta.Description
|
|
}
|
|
if meta.Category != "" {
|
|
td.Category = meta.Category
|
|
}
|
|
td.SupportsTime = meta.SupportsTime
|
|
if meta.Queue != "" {
|
|
td.Queue = meta.Queue
|
|
}
|
|
td.Retryable = meta.Retryable
|
|
if meta.MaxRetry > 0 {
|
|
td.Retry = meta.MaxRetry
|
|
}
|
|
if meta.Timeout > 0 {
|
|
td.Timeout = meta.Timeout
|
|
}
|
|
if len(meta.Params) > 0 {
|
|
td.Params = append([]contracts.TaskParamDTO(nil), meta.Params...)
|
|
}
|
|
}
|
|
}
|
|
|
|
// WithTaskConcurrency sets the concurrency limit for the task.
|
|
func WithTaskConcurrency(concurrency int) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Concurrency = concurrency
|
|
}
|
|
}
|
|
|
|
// WithTaskRetry sets the maximum retry count for the task.
|
|
func WithTaskRetry(retry int) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Retry = retry
|
|
}
|
|
}
|
|
|
|
// WithTaskTimeout sets the execution timeout for the task.
|
|
func WithTaskTimeout(timeout time.Duration) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
td.Timeout = timeout
|
|
}
|
|
}
|
|
|
|
// WithTaskMetadata adds a key-value pair to the task metadata.
|
|
func WithTaskMetadata(key string, val any) TaskOption {
|
|
return func(td *TaskDefinition) {
|
|
if td.Metadata == nil {
|
|
td.Metadata = make(map[string]any)
|
|
}
|
|
td.Metadata[key] = val
|
|
}
|
|
}
|
|
|
|
// ToDTO converts TaskDefinition to contracts.TaskMetaDTO.
|
|
func (td TaskDefinition) ToDTO() contracts.TaskMetaDTO {
|
|
taskType := td.Type
|
|
if taskType == "" {
|
|
taskType = td.Pattern
|
|
}
|
|
name := td.Name
|
|
if name == "" {
|
|
name = td.DisplayName
|
|
}
|
|
if name == "" {
|
|
name = td.Pattern
|
|
}
|
|
displayName := td.DisplayName
|
|
if displayName == "" {
|
|
displayName = name
|
|
}
|
|
queue := td.Queue
|
|
if queue == "" {
|
|
queue = "default"
|
|
}
|
|
retryable := td.Retryable
|
|
if !retryable && td.Retry > 0 {
|
|
retryable = true
|
|
}
|
|
return contracts.TaskMetaDTO{
|
|
Type: taskType,
|
|
AsynqTask: td.Pattern,
|
|
Name: name,
|
|
DisplayName: displayName,
|
|
Description: td.Description,
|
|
Category: td.Category,
|
|
SupportsTime: td.SupportsTime,
|
|
Params: td.Params,
|
|
MaxRetry: td.Retry,
|
|
Timeout: td.Timeout,
|
|
Queue: queue,
|
|
Retryable: retryable,
|
|
}
|
|
}
|
|
|
|
// TaskExtension defines the interface for registering and querying background task handlers.
|
|
type TaskExtension interface {
|
|
Register(pattern string, handler any, opts ...TaskOption)
|
|
Tasks() []TaskDefinition
|
|
Get(pattern string) (TaskDefinition, bool)
|
|
Unregister(pattern string) bool
|
|
}
|
|
|
|
// TaskRegistry collects and manages task registrations.
|
|
type TaskRegistry struct {
|
|
mu sync.RWMutex
|
|
tasks []TaskDefinition
|
|
lookup map[string]TaskDefinition
|
|
}
|
|
|
|
// NewTaskRegistry creates a new task registry.
|
|
func NewTaskRegistry() *TaskRegistry {
|
|
return &TaskRegistry{
|
|
lookup: make(map[string]TaskDefinition),
|
|
}
|
|
}
|
|
|
|
// Register registers a task pattern and its handler with optional configuration.
|
|
func (t *TaskRegistry) Register(pattern string, handler any, opts ...TaskOption) {
|
|
t.mu.Lock()
|
|
defer t.mu.Unlock()
|
|
|
|
td := TaskDefinition{
|
|
Pattern: pattern,
|
|
Handler: handler,
|
|
Metadata: make(map[string]any),
|
|
}
|
|
|
|
for _, opt := range opts {
|
|
if opt != nil {
|
|
opt(&td)
|
|
}
|
|
}
|
|
|
|
if _, exists := t.lookup[pattern]; exists {
|
|
for i, item := range t.tasks {
|
|
if item.Pattern == pattern {
|
|
t.tasks[i] = td
|
|
break
|
|
}
|
|
}
|
|
} else {
|
|
t.tasks = append(t.tasks, td)
|
|
}
|
|
|
|
t.lookup[pattern] = td
|
|
}
|
|
|
|
// Unregister removes a registered task definition by its pattern.
|
|
func (t *TaskRegistry) Unregister(pattern string) bool {
|
|
return unregisterEntry(&t.mu, t.lookup, &t.tasks, pattern, func(item TaskDefinition) bool {
|
|
return item.Pattern == pattern
|
|
})
|
|
}
|
|
|
|
// Tasks returns a copy of all registered TaskDefinitions.
|
|
func (t *TaskRegistry) Tasks() []TaskDefinition {
|
|
t.mu.RLock()
|
|
defer t.mu.RUnlock()
|
|
res := make([]TaskDefinition, len(t.tasks))
|
|
copy(res, t.tasks)
|
|
return res
|
|
}
|
|
|
|
// Get retrieves a task definition by its pattern.
|
|
func (t *TaskRegistry) Get(pattern string) (TaskDefinition, bool) {
|
|
t.mu.RLock()
|
|
defer t.mu.RUnlock()
|
|
td, ok := t.lookup[pattern]
|
|
return td, ok
|
|
}
|