1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package app
4
5import (
6 "fmt"
7 "os"
8 "os/signal"
9 "strings"
10 "syscall"
11
12 "github.com/spf13/cobra"
13
14 "bnema.dev/ermite-api/gen/ermite"
15 "bnema.dev/ermite/internal/adapters/client"
16)
17
18// jsonEvent is the stable JSON shape of one event: one object per line with
19// `ermite watch --json`. Fields not meaningful for a type are omitted.
20type jsonEvent struct {
21 ID string `json:"id"`
22 Time *string `json:"time"`
23 Type string `json:"type"`
24 Repo string `json:"repo,omitempty"`
25 Repository *jsonRepo `json:"repository,omitempty"`
26 RefUpdates []jsonRefUpdate `json:"ref_updates,omitempty"`
27 // MergeRequest is set for the merge_request_* events, Number and Comment
28 // for comment_added.
29 MergeRequest *jsonMergeRequest `json:"merge_request,omitempty"`
30 Number int64 `json:"number,omitempty"`
31 Comment *jsonComment `json:"comment,omitempty"`
32 // Mergeability is set for a merge_request_mergeability event.
33 Mergeability *jsonMergeability `json:"mergeability,omitempty"`
34}
35
36type jsonRefUpdate struct {
37 Ref string `json:"ref"`
38 OldID string `json:"old_id"`
39 NewID string `json:"new_id"`
40}
41
42// Event types in the output.
43const (
44 eventRepoCreated = "repo_created"
45 eventRepoUpdated = "repo_updated"
46 eventRepoDeleted = "repo_deleted"
47 eventPushed = "pushed"
48 eventGap = "gap"
49
50 eventMROpened = "merge_request_opened"
51 eventMRMerged = "merge_request_merged"
52 eventMRClosed = "merge_request_closed"
53 eventCommentAdded = "comment_added"
54 eventCommentEdited = "comment_edited"
55 eventCommentDeleted = "comment_deleted"
56 eventCommentResolved = "comment_resolved"
57 eventMRMergeability = "merge_request_mergeability"
58)
59
60// toJSONEvent maps an event; ok is false for kinds this client does not know,
61// which the contract says to ignore.
62func toJSONEvent(ev *ermite.Event, baseURL string) (jsonEvent, bool) {
63 out := jsonEvent{ID: ev.GetId(), Time: jsonTime(ev.GetTime())}
64 switch k := ev.GetKind().(type) {
65 case *ermite.Event_RepoCreated:
66 r := toJSONRepo(k.RepoCreated.GetRepo())
67 out.Type, out.Repo, out.Repository = eventRepoCreated, r.Name, &r
68 case *ermite.Event_RepoUpdated:
69 r := toJSONRepo(k.RepoUpdated.GetRepo())
70 out.Type, out.Repo, out.Repository = eventRepoUpdated, r.Name, &r
71 case *ermite.Event_RepoDeleted:
72 out.Type, out.Repo = eventRepoDeleted, k.RepoDeleted.GetRepo()
73 case *ermite.Event_Pushed:
74 out.Type, out.Repo = eventPushed, k.Pushed.GetRepo()
75 out.RefUpdates = []jsonRefUpdate{}
76 for _, u := range k.Pushed.GetRefUpdates() {
77 out.RefUpdates = append(out.RefUpdates, jsonRefUpdate{Ref: u.GetRef(), OldID: u.GetOldId(), NewID: u.GetNewId()})
78 }
79 case *ermite.Event_MergeRequestOpened:
80 m := toJSONMergeRequest(k.MergeRequestOpened.GetMergeRequest(), baseURL)
81 out.Type, out.Repo, out.MergeRequest = eventMROpened, m.Repo, &m
82 case *ermite.Event_MergeRequestMerged:
83 m := toJSONMergeRequest(k.MergeRequestMerged.GetMergeRequest(), baseURL)
84 out.Type, out.Repo, out.MergeRequest = eventMRMerged, m.Repo, &m
85 case *ermite.Event_MergeRequestClosed:
86 m := toJSONMergeRequest(k.MergeRequestClosed.GetMergeRequest(), baseURL)
87 out.Type, out.Repo, out.MergeRequest = eventMRClosed, m.Repo, &m
88 case *ermite.Event_CommentAdded:
89 c := toJSONComment(k.CommentAdded.GetComment())
90 out.Type, out.Repo, out.Number, out.Comment = eventCommentAdded, k.CommentAdded.GetRepo(), k.CommentAdded.GetNumber(), &c
91 case *ermite.Event_CommentEdited:
92 c := toJSONComment(k.CommentEdited.GetComment())
93 out.Type, out.Repo, out.Number, out.Comment = eventCommentEdited, k.CommentEdited.GetRepo(), k.CommentEdited.GetNumber(), &c
94 case *ermite.Event_CommentDeleted:
95 c := toJSONComment(k.CommentDeleted.GetComment())
96 out.Type, out.Repo, out.Number, out.Comment = eventCommentDeleted, k.CommentDeleted.GetRepo(), k.CommentDeleted.GetNumber(), &c
97 case *ermite.Event_CommentResolved:
98 c := toJSONComment(k.CommentResolved.GetComment())
99 out.Type, out.Repo, out.Number, out.Comment = eventCommentResolved, k.CommentResolved.GetRepo(), k.CommentResolved.GetNumber(), &c
100 case *ermite.Event_MergeRequestMergeability:
101 out.Type, out.Repo, out.Number = eventMRMergeability, k.MergeRequestMergeability.GetRepo(), k.MergeRequestMergeability.GetNumber()
102 out.Mergeability = toJSONMergeability(k.MergeRequestMergeability.GetMergeability())
103 case *ermite.Event_Gap:
104 out.Type = eventGap
105 default:
106 return jsonEvent{}, false
107 }
108 return out, true
109}
110
111// eventLine is the human line of an event: "<time> <type> <details>".
112func eventLine(e jsonEvent) string {
113 ts := "-"
114 if e.Time != nil {
115 ts = *e.Time
116 }
117 var detail string
118 switch e.Type {
119 case eventRepoCreated:
120 detail = e.Repo + " (" + e.Repository.Visibility + ")"
121 case eventRepoUpdated:
122 detail = e.Repo + " (" + e.Repository.Visibility + ", default branch " + e.Repository.DefaultBranch + ")"
123 case eventRepoDeleted:
124 detail = e.Repo
125 case eventPushed:
126 parts := make([]string, 0, len(e.RefUpdates))
127 for _, u := range e.RefUpdates {
128 parts = append(parts, refUpdateText(u))
129 }
130 detail = e.Repo + " " + strings.Join(parts, ", ")
131 case eventMROpened, eventMRMerged, eventMRClosed:
132 detail = fmt.Sprintf("%s!%d %s -> %s", e.Repo, e.MergeRequest.Number, e.MergeRequest.SourceBranch, e.MergeRequest.TargetBranch)
133 case eventCommentAdded, eventCommentEdited, eventCommentDeleted, eventCommentResolved:
134 detail = fmt.Sprintf("%s!%d by %s", e.Repo, e.Number, e.Comment.Author)
135 case eventMRMergeability:
136 detail = fmt.Sprintf("%s!%d mergeability: %s", e.Repo, e.Number, mergeabilityEventText(e.Mergeability))
137 case eventGap:
138 detail = "events were lost, reload what you display"
139 }
140 return clean(ts + " " + e.Type + " " + detail)
141}
142
143// mergeabilityEventText is the short form of a mergeability for a watch line:
144// "up_to_date", "behind by 2", "conflict (a, b)", "checking".
145func mergeabilityEventText(m *jsonMergeability) string {
146 if m == nil {
147 return "unknown"
148 }
149 switch m.State {
150 case "behind":
151 return fmt.Sprintf("behind by %d%s", m.Behind, plus(m.BehindCapped))
152 case "conflict":
153 if len(m.ConflictPaths) == 0 {
154 return "conflict (no common history)"
155 }
156 more := ""
157 if m.ConflictPathsTruncated {
158 more = ", ..."
159 }
160 return "conflict (" + strings.Join(m.ConflictPaths, ", ") + more + ")"
161 }
162 return m.State
163}
164
165func refUpdateText(u jsonRefUpdate) string {
166 short := func(id string) string {
167 if len(id) > 8 {
168 return id[:8]
169 }
170 return id
171 }
172 switch {
173 case u.OldID == "":
174 return u.Ref + " created at " + short(u.NewID)
175 case u.NewID == "":
176 return u.Ref + " deleted (was " + short(u.OldID) + ")"
177 default:
178 return u.Ref + " " + short(u.OldID) + ".." + short(u.NewID)
179 }
180}
181
182func newWatchCmd(env *cliEnv) *cobra.Command {
183 cmd := &cobra.Command{
184 Use: "watch [repo]",
185 Short: "Print repository events as they happen",
186 Long: "Print one line per event (repository created, updated or deleted, refs pushed, merge requests\n" +
187 "opened, merged or closed, notes added, edited, deleted or resolved) for every\n" +
188 "repository you can see, or only for [repo]. It runs until interrupted. When the connection drops it\n" +
189 "reconnects with a growing delay and resumes after the last event it printed; if the server no longer\n" +
190 "has that event it prints a gap event: reload what you display. Connection notices go to standard\n" +
191 "error.\n\n" +
192 "--json prints one JSON object per line (NDJSON). Fields: id, time (RFC 3339 UTC), type\n" +
193 "(repo_created, repo_updated, repo_deleted, pushed, merge_request_opened, merge_request_merged,\n" +
194 "merge_request_closed, comment_added, comment_edited, comment_deleted, comment_resolved or gap)\n" +
195 "and, depending on the type, repo (name),\n" +
196 "repository (the repository fields of `repo show --json`), ref_updates (array of ref, old_id,\n" +
197 "new_id; an empty id means the ref was created or deleted), merge_request (the fields of\n" +
198 "`mr show --json`) and, for comment events, number (of the merge request) and comment. Unknown\n" +
199 "event types are skipped.",
200 Args: cobra.MaximumNArgs(1),
201 ValidArgsFunction: completeRepoNames(env),
202 }
203 asJSON := addJSONFlag(cmd)
204 cmd.RunE = func(cmd *cobra.Command, args []string) error {
205 topics := []string{"home"}
206 if len(args) == 1 {
207 topics = []string{"repo:" + args[0]}
208 }
209 c, err := env.client(cmd)
210 if err != nil {
211 return err
212 }
213 ctx, stop := signal.NotifyContext(env.ctx(cmd), os.Interrupt, syscall.SIGTERM)
214 defer stop()
215 out := cmd.OutOrStdout()
216 opts := client.WatchOptions{
217 Topics: topics,
218 Backoff: env.backoff,
219 Sleep: env.sleep,
220 OnNotice: func(msg string) { noticef(cmd, "%s", clean(msg)) },
221 }
222 return c.Watch(ctx, opts, func(ev *ermite.Event) error {
223 e, ok := toJSONEvent(ev, c.URL())
224 if !ok {
225 return nil
226 }
227 if *asJSON {
228 return writeNDJSON(out, e)
229 }
230 _, err := fmt.Fprintln(out, eventLine(e))
231 return err
232 })
233 }
234 return cmd
235}