Files
archie/internal/webui/api_setup.go
T

68 lines
2.0 KiB
Go

package webui
import (
"net/http"
"strings"
)
// SetupStep is one item in the dashboard's getting-started checklist.
type SetupStep struct {
Title string `json:"title"`
Detail string `json:"detail,omitempty"`
Done bool `json:"done"`
}
// handleSetup reports which setup steps are still missing, from live state.
func (s *Server) handleSetup(w http.ResponseWriter, r *http.Request) {
steps := []SetupStep{}
// Every step is read from the configuration projection this process
// renders, so the checklist works the same whether configuration is
// held here or published by its owner.
view, found, err := s.configSource()(r.Context())
if err != nil || !found {
// No configuration available: report nothing rather than
// guessing, so the dashboard simply omits the panel.
writeJSON(w, map[string]any{"steps": steps})
return
}
// The operator's name is deployment data, configured once in [chat]. The
// dashboard greets with it rather than hardcoding a name, which would be
// wrong on every deployment but one.
operator := view.Chat.Operator
steps = append(steps, SetupStep{
Title: "Give Archie an identity",
Detail: "The account it commits and comments as.",
Done: strings.TrimSpace(view.Identity.BotUser) != "",
})
steps = append(steps, SetupStep{
Title: "Connect a repository",
Detail: "Archie polls these for issues assigned to it.",
Done: len(view.Repositories) > 0,
})
steps = append(steps, SetupStep{
Title: "Connect a chat channel",
Detail: "Chat and approvals.",
Done: view.Chat.ChannelConfigured,
})
// Only meaningful once there is somewhere to run work.
if count, err := s.Store.StatusCounts(r.Context()); err == nil {
total := 0
for _, n := range count {
total += n
}
steps = append(steps, SetupStep{
Title: "Run your first task",
Detail: "Assign Archie an issue, or ask it for something in chat.",
Done: total > 0,
})
}
writeJSON(w, map[string]any{"steps": steps, "operator": operator})
}