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