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