internal/control/milestone.go
331 lines · 10526 bytes
1package control
2
3import (
4 "errors"
5 "fmt"
6 "io"
7 "path"
8 "regexp"
9 "strings"
10
11 "gitbay.org/gitbay/internal/gitutil"
12 "gitbay.org/gitbay/internal/policy"
13 "gitbay.org/gitbay/internal/protocol"
14 "gitbay.org/gitbay/internal/store"
15)
16
17func init() {
18 register(Command{Path: []string{"milestone", "create"},
19 Summary: "create a milestone",
20 Usage: "milestone create <owner/name> <title> [--description <d>] [--due YYYY-MM-DD]",
21 Flags: []Flag{
22 {"--description", "<d>", "what the milestone covers", ""},
23 {"--due", "YYYY-MM-DD", "target date", ""},
24 },
25 Examples: []string{`milestone create krz/gitbay v1.31.0 --due 2026-10-01`},
26 Run: runMilestoneCreate})
27 register(Command{Path: []string{"milestone", "list"},
28 Summary: "list milestones with progress",
29 Usage: "milestone list <owner/name> [--state open|closed|all]",
30 Flags: []Flag{
31 {"--state", "open|closed|all", "which milestones", "open"},
32 },
33 Examples: []string{"milestone list krz/gitbay --state all"},
34 ReadOnly: true, Run: runMilestoneList})
35 register(Command{Path: []string{"milestone", "close"},
36 Summary: "close a milestone",
37 Usage: "milestone close <owner/name> <title>",
38 Examples: []string{"milestone close krz/gitbay v1.30.0"},
39 Run: runMilestoneClose})
40 register(Command{Path: []string{"milestone", "reopen"},
41 Summary: "reopen a milestone",
42 Usage: "milestone reopen <owner/name> <title>",
43 Examples: []string{"milestone reopen krz/gitbay v1.30.0"},
44 Run: runMilestoneReopen})
45 register(Command{Path: []string{"issue", "milestone"},
46 Summary: "set or clear an issue's milestone",
47 Usage: "issue milestone <owner/name> <n> <title|none>",
48 Examples: []string{"issue milestone krz/gitbay 42 v1.31.0"},
49 Run: runIssueMilestone})
50 register(Command{Path: []string{"mr", "milestone"},
51 Summary: "set or clear an MR's milestone",
52 Usage: "mr milestone <owner/name> <n> <title|none>",
53 Examples: []string{"mr milestone krz/gitbay 431 v1.31.0"},
54 Run: runMRMilestone})
55 register(Command{Path: []string{"issue", "templates"},
56 Summary: "list issue templates (.gitbay/issue-template*.md)",
57 Usage: "issue templates <owner/name>",
58 Examples: []string{"issue templates krz/gitbay"},
59 ReadOnly: true, Run: runIssueTemplates})
60}
61
62var duePat = regexp.MustCompile(`^\d{4}-\d{2}-\d{2}$`)
63
64func runMilestoneCreate(c *Ctx, args []string) int {
65 f, err := c.parseArgs(args, flagSpec{Values: []string{"--description", "--due"}, MaxPos: 2,
66 Usage: "milestone create <owner/name> <title> [--description <d>] [--due YYYY-MM-DD]"})
67 if err != nil {
68 return c.fail(protocol.ExitUsage, "%v", err)
69 }
70 path, title, description, due := f.pos(0), f.pos(1), f.Value("--description"), f.Value("--due")
71 if path == "" || title == "" {
72 return c.usage()
73 }
74 if due != "" && !duePat.MatchString(due) {
75 return c.fail(protocol.ExitUsage, "--due must be YYYY-MM-DD")
76 }
77 repo, code := resolveRepo(c, path, policy.CanWrite)
78 if code >= 0 {
79 return code
80 }
81 if code := refuseArchived(c, repo); code >= 0 {
82 return code
83 }
84 if _, err := c.Store.CreateMilestone(repo, title, description, due); err != nil {
85 if errors.Is(err, store.ErrOrgScoped) {
86 return c.fail(protocol.ExitFailure, "%s", orgScopedMsg(repo, "milestone", title, "create"))
87 }
88 return c.failErr(err)
89 }
90 return c.emit(map[string]string{"milestone": title}, func(w io.Writer) {
91 fmt.Fprintf(w, "created milestone %q on %s\n", title, repo.Path())
92 })
93}
94
95func runMilestoneList(c *Ctx, args []string) int {
96 f, err := c.parseArgs(args, flagSpec{Values: []string{"--state"}, MaxPos: 1, Usage: "milestone list <owner/name> [--state open|closed|all]"})
97 if err != nil {
98 return c.fail(protocol.ExitUsage, "%v", err)
99 }
100 state, path := "open", f.pos(0)
101 if f.Has("--state") {
102 state = f.Value("--state")
103 }
104 if path == "" || (state != "open" && state != "closed" && state != "all") {
105 return c.usage()
106 }
107 repo, code := resolveRepo(c, path, policy.CanRead)
108 if code >= 0 {
109 return code
110 }
111 readable, err := ReadableScope(c.Store, c.User, repo)
112 if err != nil {
113 return c.fail(protocol.ExitFailure, "%v", err)
114 }
115 ms, err := c.Store.ListMilestones(repo, state, readable)
116 if err != nil {
117 return c.fail(protocol.ExitFailure, "%v", err)
118 }
119 return emitMilestones(c, ms)
120}
121
122// emitMilestones renders a milestone list for the caller, JSON or plain.
123func emitMilestones(c *Ctx, ms []store.Milestone) int {
124 type out struct {
125 Title string `json:"title"`
126 Description string `json:"description,omitempty"`
127 Due string `json:"due,omitempty"`
128 State string `json:"state"`
129 Org bool `json:"org,omitempty"`
130 Open int `json:"open"`
131 Closed int `json:"closed"`
132 }
133 var ds []out
134 for _, m := range ms {
135 ds = append(ds, out{m.Title, m.Description, m.DueDate, m.State, m.OrgID != 0, m.OpenItems, m.ClosedItems})
136 }
137 return c.emit(ds, func(w io.Writer) {
138 if c.Term.Cols > 0 {
139 tb := c.table(w, "TITLE", "STATE", "DUE", "PROGRESS", "SCOPE")
140 for _, d := range ds {
141 due := cText("")
142 if t, ok := parseStamp(d.Due + " 00:00:00"); ok {
143 due = cText(relAge(d.Due+" 00:00:00", termNow()))
144 if d.State == "open" && t.Before(termNow()) {
145 due = cMark("overdue "+d.Due, sgrRed)
146 }
147 }
148 progress := ""
149 if total := d.Open + d.Closed; total > 0 {
150 progress = fmt.Sprintf("%d/%d closed (%d%%)", d.Closed, total, d.Closed*100/total)
151 }
152 scope := ""
153 if d.Org {
154 scope = "org"
155 }
156 tb.row(cRef(d.Title), cState(d.State), due, cText(progress), cText(scope))
157 }
158 tb.flush()
159 return
160 }
161 tb := c.table(w, "TITLE", "STATE", "DUE", "PROGRESS")
162 for _, d := range ds {
163 due := d.Due
164 if due == "" {
165 due = "-"
166 }
167 cells := []cell{cRef(d.Title), cState(d.State), cText("due " + due), cText(fmt.Sprintf("%d open, %d closed", d.Open, d.Closed))}
168 if d.Org {
169 cells = append(cells, cText("org"))
170 }
171 tb.row(cells...)
172 }
173 tb.flush()
174 })
175}
176
177func runMilestoneClose(c *Ctx, args []string) int { return setMilestoneState(c, args, "closed") }
178func runMilestoneReopen(c *Ctx, args []string) int { return setMilestoneState(c, args, "open") }
179
180func setMilestoneState(c *Ctx, args []string, state string) int {
181 verb := "close"
182 if state == "open" {
183 verb = "reopen"
184 }
185 if len(args) != 2 {
186 return c.usage()
187 }
188 repo, code := resolveRepo(c, args[0], policy.CanWrite)
189 if code >= 0 {
190 return code
191 }
192 if code := refuseArchived(c, repo); code >= 0 {
193 return code
194 }
195 m, err := c.Store.MilestoneByTitle(repo, args[1])
196 if err != nil {
197 return milestoneErr(c, repo, args[1], err)
198 }
199 if m.OrgID != 0 {
200 return c.fail(protocol.ExitFailure, "%s", orgScopedMsg(repo, "milestone", m.Title, verb))
201 }
202 if err := c.Store.SetMilestoneState(m.ID, state); err != nil {
203 return c.fail(protocol.ExitFailure, "%v", err)
204 }
205 return c.emit(map[string]string{"milestone": m.Title, "state": state}, func(w io.Writer) {
206 fmt.Fprintf(w, "%sd milestone %q on %s\n", verb, m.Title, repo.Path())
207 })
208}
209
210func milestoneErr(c *Ctx, repo store.Repo, title string, err error) int {
211 if errors.Is(err, store.ErrNotFound) {
212 return c.fail(protocol.ExitNotFound, "no milestone %q in %s", title, repo.Path())
213 }
214 return c.fail(protocol.ExitFailure, "%v", err)
215}
216
217func runIssueMilestone(c *Ctx, args []string) int {
218 repo, issue, code := issueRef(c, args, policy.CanWrite)
219 if code >= 0 {
220 return code
221 }
222 if code := refuseArchived(c, repo); code >= 0 {
223 return code
224 }
225 if len(args) != 3 {
226 return c.usage()
227 }
228 return setItemMilestone(c, repo, "issue", issue.Number, args[2], func(id int64) error {
229 return c.Store.SetIssueMilestone(issue.ID, id)
230 })
231}
232
233func runMRMilestone(c *Ctx, args []string) int {
234 repo, mr, code := mrRef(c, args, policy.CanWrite)
235 if code >= 0 {
236 return code
237 }
238 if code := refuseArchived(c, repo); code >= 0 {
239 return code
240 }
241 if len(args) != 3 {
242 return c.usage()
243 }
244 return setItemMilestone(c, repo, "mr", mr.Number, args[2], func(id int64) error {
245 return c.Store.SetMRMilestone(mr.ID, id)
246 })
247}
248
249// recordItemMilestone sets milestone id (0 clears it) through set and
250// records the milestoned event naming title ("" when cleared).
251func recordItemMilestone(c *Ctx, repo store.Repo, noun string, number, id int64, title string, set func(int64) error) error {
252 if err := set(id); err != nil {
253 return err
254 }
255 c.Store.RecordEvent(repo.ID, c.User.ID, noun+".milestoned",
256 fmt.Sprintf(`{"number":%d,"milestone":%q}`, number, title))
257 return nil
258}
259
260// noun and number name what the milestone was set on, for the event.
261func setItemMilestone(c *Ctx, repo store.Repo, noun string, number int64, title string, set func(int64) error) int {
262 var id int64
263 if title != "none" {
264 m, err := c.Store.MilestoneByTitle(repo, title)
265 if err != nil {
266 return milestoneErr(c, repo, title, err)
267 }
268 id = m.ID
269 }
270 cleared := title
271 if cleared == "none" {
272 cleared = ""
273 }
274 if err := recordItemMilestone(c, repo, noun, number, id, cleared, set); err != nil {
275 return c.fail(protocol.ExitFailure, "%v", err)
276 }
277 if title == "none" {
278 return c.emit(map[string]string{"milestone": ""}, func(w io.Writer) {
279 fmt.Fprintln(w, "milestone cleared")
280 })
281 }
282 return c.emit(map[string]string{"milestone": title}, func(w io.Writer) {
283 fmt.Fprintf(w, "milestone set to %q\n", title)
284 })
285}
286
287// runIssueTemplates lists .gitbay/issue-template*.md at the default branch.
288func runIssueTemplates(c *Ctx, args []string) int {
289 if len(args) != 1 {
290 return c.usage()
291 }
292 repo, code := resolveRepo(c, args[0], policy.CanRead)
293 if code >= 0 {
294 return code
295 }
296 dir := RepoDir(c.Cfg.Server.Root, repo.OwnerName, repo.Name)
297 ts := IssueTemplates(dir, repo.DefaultBranch)
298 return c.emit(ts, func(w io.Writer) {
299 tb := c.table(w, "NAME")
300 for _, t := range ts {
301 tb.row(cRef(t.Name))
302 }
303 tb.flush()
304 })
305}
306
307type IssueTemplate struct {
308 Name string `json:"name"`
309 Body string `json:"body"`
310}
311
312// IssueTemplates reads .gitbay/issue-template*.md from ref. Missing
313// directory or unreadable files yield an empty list, never an error.
314func IssueTemplates(dir, ref string) []IssueTemplate {
315 entries, err := gitutil.ListTree(dir, ref, ".gitbay")
316 if err != nil {
317 return nil
318 }
319 var out []IssueTemplate
320 for _, e := range entries {
321 if e.Type != "blob" || !strings.HasPrefix(e.Name, "issue-template") || !strings.HasSuffix(e.Name, ".md") {
322 continue
323 }
324 raw, err := gitutil.ReadBlob(dir, ref, path.Join(".gitbay", e.Name), maxBodyBytes)
325 if err != nil {
326 continue
327 }
328 out = append(out, IssueTemplate{Name: e.Name, Body: string(raw)})
329 }
330 return out
331}