Files
ragflow/internal/dao/canvas_template.go

41 lines
1.3 KiB
Go
Raw Normal View History

feat[Go]: implement GET /agents/templates (issue #15240) (#15573) ## Summary Port the canvas-template catalogue endpoint to the Go API server. Listed in the Go-API port checklist of #15240. Mirrors `list_agent_template` in `api/apps/restful_apis/agent_api.py`: returns every row from the `canvas_template` table so that the UI can render the template gallery on the New-Agent screen. ## What - `internal/dao/canvas_template.go` — new `CanvasTemplateDAO.GetAll()` ordered by `create_time desc` (newest templates first). - `internal/service/agent.go` — wire the new DAO into `AgentService` and expose `ListTemplates() ([]*entity.CanvasTemplate, error)`. - `internal/handler/agent.go` — new `AgentHandler.ListTemplates` HTTP handler (auth-gated, mirrors Python `@login_required`). - `internal/router/router.go` — `agents.GET("/templates", r.agentHandler.ListTemplates)` registered alongside the existing `GET /agents`. - `internal/handler/agent_test.go` — three new tests covering: success path, empty-list → JSON array (not `null`), and the auth gate. ## Notes - `CanvasTemplate` entity, GORM tags, and DB migration already exist in `internal/entity/canvas.go` and `internal/dao/database.go` — no schema change required. - The handler coerces a `nil` slice to `[]*entity.CanvasTemplate{}` so the JSON payload is always an array (the frontend does `data.map(...)` on it). ## Test plan - [x] `go vet ./internal/handler ./internal/service ./internal/dao ./internal/router` clean - [x] Three unit tests added; existing `TestListAgents_Success` untouched - [ ] CI runs `go test ./internal/handler` with cgo binding linked ## Related - Tracker: #15240
2026-06-04 19:13:30 -07:00
//
// Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package dao
import (
"ragflow/internal/entity"
)
// CanvasTemplateDAO data-access object for the canvas_template table.
type CanvasTemplateDAO struct{}
// NewCanvasTemplateDAO creates a CanvasTemplate DAO.
func NewCanvasTemplateDAO() *CanvasTemplateDAO {
return &CanvasTemplateDAO{}
}
// GetAll returns every row in canvas_template ordered by create_time desc, so
// templates appear newest first in the UI. Mirrors the Python
// CanvasTemplateService.get_all() behaviour.
func (dao *CanvasTemplateDAO) GetAll() ([]*entity.CanvasTemplate, error) {
var templates []*entity.CanvasTemplate
if err := DB.Order("create_time desc").Find(&templates).Error; err != nil {
return nil, err
}
return templates, nil
}