483 lines
20 KiB
Go
483 lines
20 KiB
Go
package handler
|
||
|
||
import (
|
||
stderrors "errors"
|
||
"net/http"
|
||
"strconv"
|
||
"time"
|
||
|
||
"github.com/gin-gonic/gin"
|
||
|
||
"github.com/Tencent/WeKnora/internal/application/service"
|
||
"github.com/Tencent/WeKnora/internal/errors"
|
||
"github.com/Tencent/WeKnora/internal/logger"
|
||
"github.com/Tencent/WeKnora/internal/types"
|
||
)
|
||
|
||
// AutomationHandler serves the caller's automations and notifications.
|
||
type AutomationHandler struct {
|
||
automations *service.AutomationService
|
||
notifications *service.NotificationService
|
||
}
|
||
|
||
// NewAutomationHandler builds the handler.
|
||
func NewAutomationHandler(
|
||
automations *service.AutomationService, notifications *service.NotificationService,
|
||
) *AutomationHandler {
|
||
return &AutomationHandler{automations: automations, notifications: notifications}
|
||
}
|
||
|
||
func (h *AutomationHandler) fail(c *gin.Context, err error) {
|
||
var appErr *errors.AppError
|
||
if stderrors.As(err, &appErr) {
|
||
_ = c.Error(appErr)
|
||
return
|
||
}
|
||
logger.ErrorWithFields(c.Request.Context(), err, nil)
|
||
_ = c.Error(errors.NewInternalServerError("automation request failed"))
|
||
}
|
||
|
||
// CreateAutomationRequest is the body of POST /automations; see
|
||
// types.AutomationPatch for the fields.
|
||
type CreateAutomationRequest struct {
|
||
// What the automation is called
|
||
Name string `json:"name" binding:"required" extensions:"x-agent"`
|
||
// What it is for
|
||
Description string `json:"description" extensions:"x-agent"`
|
||
// Agent that runs it, from agent.list; empty runs the WeKnora assistant
|
||
AgentID string `json:"agent_id" extensions:"x-agent"`
|
||
// The task, sent as the user message of each run. May name now,
|
||
// last_run_at, last_success_at, run_id or automation_name inside double
|
||
// curly braces to have it filled in
|
||
Instruction string `json:"instruction" binding:"required" extensions:"x-agent,x-agent-max-bytes=32000"`
|
||
// When it runs
|
||
Trigger types.AutomationTrigger `json:"trigger" binding:"required" extensions:"x-agent"`
|
||
// per_run (default) starts a new conversation each run; persistent keeps one
|
||
SessionMode string `json:"session_mode" enums:"per_run,persistent" extensions:"x-agent"`
|
||
// Whether each per_run conversation gets the last successful answer
|
||
CarryLastResult bool `json:"carry_last_result" extensions:"x-agent"`
|
||
// What happens to runs missed while the service was down; default skip
|
||
MisfirePolicy string `json:"misfire_policy" enums:"skip,run_once" extensions:"x-agent"`
|
||
// What happens when a run is due while the previous one is still going; default skip
|
||
OverlapPolicy string `json:"overlap_policy" enums:"skip,queue" extensions:"x-agent"`
|
||
// How far runs may change data without asking; default confirm
|
||
AccessLevel types.AssistantAccessLevel `json:"access_level" enums:"read_only,confirm,auto_write" extensions:"x-agent"`
|
||
// How long a run waits for an approval before it fails, in minutes; default 1440
|
||
ApprovalTimeoutMinutes int `json:"approval_timeout_minutes" extensions:"x-agent"`
|
||
Limits types.AutomationLimits `json:"limits"`
|
||
// Whether a successful run notifies the owner; failures always do
|
||
NotifyOnSuccess bool `json:"notify_on_success" extensions:"x-agent"`
|
||
}
|
||
|
||
func (r CreateAutomationRequest) patch() *types.AutomationPatch {
|
||
return &types.AutomationPatch{
|
||
Name: &r.Name, Description: &r.Description, AgentID: &r.AgentID, Instruction: &r.Instruction,
|
||
Trigger: &r.Trigger, SessionMode: &r.SessionMode, CarryLastResult: &r.CarryLastResult,
|
||
MisfirePolicy: &r.MisfirePolicy, OverlapPolicy: &r.OverlapPolicy, AccessLevel: &r.AccessLevel,
|
||
ApprovalTimeoutMinutes: &r.ApprovalTimeoutMinutes, Limits: &r.Limits, NotifyOnSuccess: &r.NotifyOnSuccess,
|
||
}
|
||
}
|
||
|
||
// ListAutomations godoc
|
||
// @Summary 列出我的自动化
|
||
// @Description 列出当前用户在本空间创建的自动化(定时任务),最新的在前
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Success 200 {object} handler.DataResponse{data=[]types.Automation} "自动化列表"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.list","risk":"read","max_items":100}
|
||
// @x-agent-hint "Lists the user's automations: scheduled tasks an agent runs on their behalf, with next and last run."
|
||
// @Router /automations [get]
|
||
func (h *AutomationHandler) ListAutomations(c *gin.Context) {
|
||
list, err := h.automations.List(c.Request.Context())
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": list})
|
||
}
|
||
|
||
// CreateAutomation godoc
|
||
// @Summary 创建自动化
|
||
// @Description 创建一个按计划由 Agent 以当前用户身份运行的任务
|
||
// @Tags 自动化
|
||
// @Accept json
|
||
// @Produce json
|
||
// @Param request body CreateAutomationRequest true "自动化"
|
||
// @Success 201 {object} handler.DataResponse{data=types.Automation} "创建的自动化"
|
||
// @Failure 400 {object} errors.AppError "参数不合法"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.create","role":"viewer","risk":"write","label_param":"name","always_confirm":true}
|
||
// @x-agent-hint "Creates an automation the user runs as. Turn the user's wording into a cron expression (five fields, minute first) and an IANA timezone, and check it with automation.validate_trigger first, telling the user the next run times it returns. Runs are unattended: write the instruction as a complete task, since nobody can answer questions during a run. access_level defaults to confirm, where each change waits for the user's approval; only set auto_write when the user asks for it."
|
||
// @Router /automations [post]
|
||
func (h *AutomationHandler) CreateAutomation(c *gin.Context) {
|
||
var req CreateAutomationRequest
|
||
if err := c.ShouldBindJSON(&req); err != nil {
|
||
_ = c.Error(errors.NewBadRequestError("invalid automation").WithDetails(err.Error()))
|
||
return
|
||
}
|
||
a, err := h.automations.Create(c.Request.Context(), req.patch())
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusCreated, gin.H{"success": true, "data": a})
|
||
}
|
||
|
||
// ValidateTriggerRequest is the body of POST /automations/validate-trigger.
|
||
type ValidateTriggerRequest struct {
|
||
// The trigger to check
|
||
Trigger types.AutomationTrigger `json:"trigger" binding:"required" extensions:"x-agent"`
|
||
}
|
||
|
||
// ValidateTriggerResult is the data of POST /automations/validate-trigger.
|
||
type ValidateTriggerResult struct {
|
||
// The next times the trigger fires, in UTC
|
||
NextRuns []time.Time `json:"next_runs" extensions:"x-agent"`
|
||
}
|
||
|
||
// ValidateTrigger godoc
|
||
// @Summary 校验触发器
|
||
// @Description 校验 cron 或一次性触发器,返回未来 3 次触发时间
|
||
// @Tags 自动化
|
||
// @Accept json
|
||
// @Produce json
|
||
// @Param request body ValidateTriggerRequest true "触发器"
|
||
// @Success 200 {object} handler.DataResponse{data=ValidateTriggerResult} "未来触发时间"
|
||
// @Failure 400 {object} errors.AppError "触发器不合法"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.validate_trigger","risk":"probe"}
|
||
// @x-agent-hint "Checks a trigger and returns its next three run times in UTC; convert them to the trigger's timezone for the user."
|
||
// @Router /automations/validate-trigger [post]
|
||
func (h *AutomationHandler) ValidateTrigger(c *gin.Context) {
|
||
var req ValidateTriggerRequest
|
||
if err := c.ShouldBindJSON(&req); err != nil {
|
||
_ = c.Error(errors.NewBadRequestError("invalid trigger").WithDetails(err.Error()))
|
||
return
|
||
}
|
||
times, err := h.automations.ValidateTrigger(req.Trigger, 3)
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": ValidateTriggerResult{NextRuns: times}})
|
||
}
|
||
|
||
// GetAutomationBySession godoc
|
||
// @Summary 按会话查找自动化
|
||
// @Description 返回这次会话所属的自动化,供会话页跳回
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param session_id path string true "会话 ID"
|
||
// @Success 200 {object} handler.DataResponse{data=types.Automation} "自动化"
|
||
// @Failure 404 {object} errors.AppError "不存在"
|
||
// @Security Bearer
|
||
// @Router /automations/by-session/{session_id} [get]
|
||
func (h *AutomationHandler) GetAutomationBySession(c *gin.Context) {
|
||
a, err := h.automations.FindBySession(c.Request.Context(), c.Param("session_id"))
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": a})
|
||
}
|
||
|
||
// GetAutomation godoc
|
||
// @Summary 获取自动化
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID" extensions(x-agent=automation_id)
|
||
// @Success 200 {object} handler.DataResponse{data=types.Automation} "自动化"
|
||
// @Failure 404 {object} errors.AppError "不存在"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.get","risk":"read"}
|
||
// @x-agent-hint "Returns one automation, including its instruction."
|
||
// @Router /automations/{id} [get]
|
||
func (h *AutomationHandler) GetAutomation(c *gin.Context) {
|
||
a, err := h.automations.Get(c.Request.Context(), c.Param("id"))
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": a})
|
||
}
|
||
|
||
// UpdateAutomation godoc
|
||
// @Summary 修改自动化
|
||
// @Description 只修改请求中出现的字段,其余保持不变
|
||
// @Tags 自动化
|
||
// @Accept json
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID" extensions(x-agent=automation_id)
|
||
// @Param request body types.AutomationPatch true "要修改的字段"
|
||
// @Success 200 {object} handler.DataResponse{data=types.Automation} "修改后的自动化"
|
||
// @Failure 400 {object} errors.AppError "参数不合法"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.update","role":"viewer","risk":"write","target":"automation.get","label":"name","always_confirm":true}
|
||
// @x-agent-hint "Changes the listed fields of an automation; a field left out is kept. Check a new trigger with automation.validate_trigger first. Use automation.pause and automation.resume to switch it off and on."
|
||
// @Router /automations/{id} [put]
|
||
func (h *AutomationHandler) UpdateAutomation(c *gin.Context) {
|
||
var req types.AutomationPatch
|
||
if err := c.ShouldBindJSON(&req); err != nil {
|
||
_ = c.Error(errors.NewBadRequestError("invalid automation").WithDetails(err.Error()))
|
||
return
|
||
}
|
||
a, err := h.automations.Update(c.Request.Context(), c.Param("id"), &req)
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": a})
|
||
}
|
||
|
||
// DeleteAutomation godoc
|
||
// @Summary 删除自动化
|
||
// @Description 停止进行中的运行,删除自动化及其运行记录、会话和长期授权
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID" extensions(x-agent=automation_id)
|
||
// @Success 200 {object} handler.SuccessResponse "删除成功"
|
||
// @Failure 404 {object} errors.AppError "不存在"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.delete","role":"viewer","risk":"destructive","target":"automation.get","label":"name"}
|
||
// @x-agent-hint "Deletes an automation with its run history and conversations. Cannot be undone; automation.pause keeps it."
|
||
// @Router /automations/{id} [delete]
|
||
func (h *AutomationHandler) DeleteAutomation(c *gin.Context) {
|
||
if err := h.automations.Delete(c.Request.Context(), c.Param("id")); err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true})
|
||
}
|
||
|
||
// PauseAutomation godoc
|
||
// @Summary 暂停自动化
|
||
// @Description 停止按计划触发;进行中的运行不受影响
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID" extensions(x-agent=automation_id)
|
||
// @Success 200 {object} handler.DataResponse{data=types.Automation} "暂停后的自动化"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.pause","role":"viewer","risk":"write","target":"automation.get","label":"name"}
|
||
// @x-agent-hint "Stops an automation from running on schedule until automation.resume."
|
||
// @Router /automations/{id}/pause [post]
|
||
func (h *AutomationHandler) PauseAutomation(c *gin.Context) {
|
||
a, err := h.automations.Pause(c.Request.Context(), c.Param("id"))
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": a})
|
||
}
|
||
|
||
// ResumeAutomation godoc
|
||
// @Summary 恢复自动化
|
||
// @Description 从现在起重新按计划触发,并清零连续失败计数
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID" extensions(x-agent=automation_id)
|
||
// @Success 200 {object} handler.DataResponse{data=types.Automation} "恢复后的自动化"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.resume","role":"viewer","risk":"write","target":"automation.get","label":"name","always_confirm":true}
|
||
// @x-agent-hint "Schedules a paused automation again from now; missed runs are not caught up."
|
||
// @Router /automations/{id}/resume [post]
|
||
func (h *AutomationHandler) ResumeAutomation(c *gin.Context) {
|
||
a, err := h.automations.Resume(c.Request.Context(), c.Param("id"))
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": a})
|
||
}
|
||
|
||
// RunAutomation godoc
|
||
// @Summary 立即运行自动化
|
||
// @Description 排队一次手动运行;已有运行在排队或进行中时拒绝
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID" extensions(x-agent=automation_id)
|
||
// @Success 202 {object} handler.DataResponse{data=types.AutomationRun} "排队的运行"
|
||
// @Failure 409 {object} errors.AppError "已有运行"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.run_now","role":"viewer","risk":"write","target":"automation.get","label":"name","always_confirm":true}
|
||
// @x-agent-hint "Queues a run now, in the background; follow it with automation.list_runs."
|
||
// @Router /automations/{id}/run [post]
|
||
func (h *AutomationHandler) RunAutomation(c *gin.Context) {
|
||
run, err := h.automations.RunNow(c.Request.Context(), c.Param("id"))
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusAccepted, gin.H{"success": true, "data": run})
|
||
}
|
||
|
||
// ListAutomationRuns godoc
|
||
// @Summary 列出运行记录
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID" extensions(x-agent=automation_id)
|
||
// @Param page query int false "页码,从 1 开始" extensions(x-agent)
|
||
// @Param page_size query int false "每页条数,最多 100" extensions(x-agent,x-agent-maximum=20)
|
||
// @Success 200 {object} handler.PageResponse{data=[]types.AutomationRun} "运行记录"
|
||
// @Security Bearer
|
||
// @x-agent {"id":"automation.list_runs","risk":"read"}
|
||
// @x-agent-hint "Lists an automation's runs, newest first, with status, error and the start of the answer."
|
||
// @Router /automations/{id}/runs [get]
|
||
func (h *AutomationHandler) ListAutomationRuns(c *gin.Context) {
|
||
page, _ := strconv.Atoi(c.DefaultQuery("page", "1"))
|
||
size, _ := strconv.Atoi(c.DefaultQuery("page_size", "20"))
|
||
page = max(page, 1)
|
||
if size <= 0 || size > 100 {
|
||
size = 20
|
||
}
|
||
runs, total, err := h.automations.ListRuns(c.Request.Context(), c.Param("id"), size, (page-1)*size)
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": runs, "total": total, "page": page, "page_size": size})
|
||
}
|
||
|
||
// GetAutomationRun godoc
|
||
// @Summary 获取运行记录
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "运行 ID"
|
||
// @Success 200 {object} handler.DataResponse{data=types.AutomationRun} "运行记录"
|
||
// @Security Bearer
|
||
// @Router /automation-runs/{id} [get]
|
||
func (h *AutomationHandler) GetAutomationRun(c *gin.Context) {
|
||
run, err := h.automations.GetRun(c.Request.Context(), c.Param("id"))
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": run})
|
||
}
|
||
|
||
// CancelAutomationRun godoc
|
||
// @Summary 停止运行
|
||
// @Description 排队或等待审批的运行立即结束;执行中的运行在下一次检查时停止
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "运行 ID"
|
||
// @Success 200 {object} handler.DataResponse{data=types.AutomationRun} "运行记录"
|
||
// @Security Bearer
|
||
// @Router /automation-runs/{id}/cancel [post]
|
||
func (h *AutomationHandler) CancelAutomationRun(c *gin.Context) {
|
||
run, err := h.automations.CancelRun(c.Request.Context(), c.Param("id"))
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": run})
|
||
}
|
||
|
||
// ListAutomationGrants godoc
|
||
// @Summary 列出自动化的长期授权
|
||
// @Description 列出以后的运行无需确认即可执行的调用,以及失效原因
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID"
|
||
// @Success 200 {object} map[string]interface{} "长期授权"
|
||
// @Security Bearer
|
||
// @Router /automations/{id}/grants [get]
|
||
func (h *AutomationHandler) ListAutomationGrants(c *gin.Context) {
|
||
grants, err := h.automations.Grants(c.Request.Context(), c.Param("id"))
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": grants})
|
||
}
|
||
|
||
// ListAutomationGrantCandidates godoc
|
||
// @Summary 列出可设为长期授权的调用
|
||
// @Description 列出本自动化的运行请求过审批、尚未长期授权的调用;需每次审批的调用不在其中
|
||
// @Tags 自动化
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID"
|
||
// @Success 200 {object} map[string]interface{} "候选调用"
|
||
// @Security Bearer
|
||
// @Router /automations/{id}/grant-candidates [get]
|
||
func (h *AutomationHandler) ListAutomationGrantCandidates(c *gin.Context) {
|
||
candidates, err := h.automations.GrantCandidates(c.Request.Context(), c.Param("id"))
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": candidates})
|
||
}
|
||
|
||
type addAutomationGrantRequest struct {
|
||
PromptID string `json:"prompt_id" binding:"required"`
|
||
}
|
||
|
||
// AddAutomationGrant godoc
|
||
// @Summary 添加长期授权
|
||
// @Description 让以后的运行无需确认即可执行某次运行请求过审批的调用;Agent 配置或所有者角色变化后失效
|
||
// @Tags 自动化
|
||
// @Accept json
|
||
// @Produce json
|
||
// @Param id path string true "自动化 ID"
|
||
// @Param request body object true "{prompt_id}"
|
||
// @Success 200 {object} map[string]interface{} "授权"
|
||
// @Security Bearer
|
||
// @Router /automations/{id}/grants [post]
|
||
func (h *AutomationHandler) AddAutomationGrant(c *gin.Context) {
|
||
var req addAutomationGrantRequest
|
||
if err := c.ShouldBindJSON(&req); err != nil {
|
||
_ = c.Error(errors.NewBadRequestError("prompt_id is required"))
|
||
return
|
||
}
|
||
grant, err := h.automations.AddGrant(c.Request.Context(), c.Param("id"), req.PromptID)
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": grant})
|
||
}
|
||
|
||
// ListNotifications godoc
|
||
// @Summary 列出我的通知
|
||
// @Tags 通知
|
||
// @Produce json
|
||
// @Param limit query int false "条数,最多 100"
|
||
// @Param unread query bool false "只看未读"
|
||
// @Success 200 {object} map[string]interface{} "{items, unread}"
|
||
// @Security Bearer
|
||
// @Router /notifications [get]
|
||
func (h *AutomationHandler) ListNotifications(c *gin.Context) {
|
||
limit, _ := strconv.Atoi(c.DefaultQuery("limit", "20"))
|
||
page, err := h.notifications.List(c.Request.Context(), limit, c.Query("unread") == "true")
|
||
if err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true, "data": page})
|
||
}
|
||
|
||
type markNotificationsReadRequest struct {
|
||
IDs []string `json:"ids"`
|
||
}
|
||
|
||
// MarkNotificationsRead godoc
|
||
// @Summary 标记通知已读
|
||
// @Description ids 为空时全部标记已读
|
||
// @Tags 通知
|
||
// @Accept json
|
||
// @Produce json
|
||
// @Param request body object false "{ids}"
|
||
// @Success 200 {object} map[string]interface{} "结果"
|
||
// @Security Bearer
|
||
// @Router /notifications/read [post]
|
||
func (h *AutomationHandler) MarkNotificationsRead(c *gin.Context) {
|
||
var req markNotificationsReadRequest
|
||
_ = c.ShouldBindJSON(&req)
|
||
if err := h.notifications.MarkRead(c.Request.Context(), req.IDs); err != nil {
|
||
h.fail(c, err)
|
||
return
|
||
}
|
||
c.JSON(http.StatusOK, gin.H{"success": true})
|
||
}
|