GitLabgitlab-org
cli
main
1package subscribe
3import (
4 "errors"
5 "fmt"
6 "net/http"
8 "github.com/MakeNowJust/heredoc/v2"
9 "github.com/spf13/cobra"
11 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
13 "gitlab.com/gitlab-org/cli/internal/cmdutils"
14 "gitlab.com/gitlab-org/cli/internal/commands/issuable"
15 "gitlab.com/gitlab-org/cli/internal/commands/issue/issueutils"
16 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
17)
19// errIssuableUserAlreadySubscribed received when trying to subscribe to an issue the user is already subscribed to
20var errIssuableUserAlreadySubscribed = errors.New("you are already subscribed to this issue")
22var subscribingMessage = map[issuable.IssueType]string{
23 issuable.TypeIssue: "Subscribing to issue",
24 issuable.TypeIncident: "Subscribing to incident",
25}
27func NewCmdSubscribe(f cmdutils.Factory, issueType issuable.IssueType) *cobra.Command {
28 examplePath := "issues/123"
30 if issueType == issuable.TypeIncident {
31 examplePath = "issues/incident/123"
32 }
34 issueSubscribeCmd := &cobra.Command{
35 Use: "subscribe <id>",
36 Short: fmt.Sprintf(`Subscribe to an %s.`, issueType),
37 Long: heredoc.Docf(`
38 You receive notifications when the %s is updated, commented on,
39 or has its state changed.
40 `, issueType),
41 Aliases: []string{"sub"},
42 Example: heredoc.Doc(fmt.Sprintf(`
43 glab %[1]s subscribe 123
44 glab %[1]s sub 123
45 glab %[1]s subscribe https://gitlab.com/OWNER/REPO/-/%[2]s`, issueType, examplePath)),
46 Args: cobra.ExactArgs(1),
47 Annotations: map[string]string{
48 mcpannotations.Destructive: "true",
49 },
50 RunE: func(cmd *cobra.Command, args []string) error {
51 c := f.IO().Color()
52 client, err := f.GitLabClient()
53 if err != nil {
54 return err
55 }
57 issues, repo, err := issueutils.IssuesFromArgs(cmd.Context(), f.ApiClient, client, f.BaseRepo, f.DefaultHostname(), f.Config(), args)
58 if err != nil {
59 return err
60 }
62 for _, issue := range issues {
63 valid, msg := issuable.ValidateIncidentCmd(issueType, "subscribe", issue)
64 if !valid {
65 f.IO().LogInfo(msg)
66 continue
67 }
69 if f.IO().IsaTTY && f.IO().IsErrTTY {
70 f.IO().LogInfof(
71 "- %s #%d in %s\n",
72 subscribingMessage[issueType],
73 issue.IID,
74 c.Cyan(repo.FullName()),
75 )
76 }
78 issue, err := subscribe(client, repo.FullName(), int(issue.IID))
79 if err != nil {
80 if errors.Is(err, errIssuableUserAlreadySubscribed) {
81 f.IO().LogInfof(
82 "%s You are already subscribed to this %s.\n\n",
83 c.FailedIcon(),
84 issueType,
85 )
86 return nil // the error already handled
87 }
88 return err
89 }
91 f.IO().LogInfo(c.GreenCheck(), "Subscribed")
92 f.IO().LogInfo(issueutils.DisplayIssue(c, issue, f.IO().IsaTTY))
93 }
94 return nil
95 },
96 }
98 return issueSubscribeCmd
99}
101func subscribe(client *gitlab.Client, projectID any, issueID int) (*gitlab.Issue, error) {
102 issue, resp, err := client.Issues.SubscribeToIssue(projectID, int64(issueID))
103 if err != nil {
104 if resp != nil {
105 // If the user is already subscribed to the issue, the status code 304 is returned.
106 if resp.StatusCode == http.StatusNotModified {
107 return nil, errIssuableUserAlreadySubscribed
108 }
109 }
110 return issue, err
111 }
113 return issue, nil
114}
Diagnostics8 git calls · 207 ms
CallStatusSizeTime0207 ms
discover200185 B4 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=4 git.response.bytes=185 git.server.agent=git/2.56.g1891de4-Linux git.server.object_format=sha1 git.server.caps=agent ls-refs fetch server-option object-format git.server.fetch=shallow wait-for-done filter git.protocol.version=2 git.pkt.frames=9 git.pkt.data=7 git.pkt.flush=2 git.pkt.delim=0 git.pkt.bytes=185 git.pkt.payload.max=35
ls-refs20058 KiB5 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=3 git.response.bytes=59849 git.response.cache=UPDATING git.response.duration_ms=5 git.protocol.version=2 git.pkt.frames=731 git.pkt.data=730 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=59849 git.pkt.payload.max=143 git.ls_refs.count=730 git.ls_refs.head=refs/heads/main
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=4273 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=combine:blob:none+tree:2 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=1 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=7 git.pkt.data=5 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=4273 git.pkt.payload.max=4173 git.sideband.band1.bytes=4173 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=11 git.pack.bytes=4173 git.fetch.wide.objects=11 git.fetch.wide.extra_bytes=3930 git.fetch.wide.blobs=0
fetchtree:0 · deepen 1020032 KiB · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=32926 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=10 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=22 git.pkt.data=20 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=32926 git.pkt.payload.max=32046 git.sideband.band1.bytes=32046 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=80 git.pack.bytes=32046 git.pack.ofs_delta=36 git.pack.ref_delta=0 git.pack.chain.max=2 git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91 git.pack.full=44Open pack map
fetchtree:02001.8 KiB · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 git.response.bytes=1857 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1857 git.pkt.payload.max=1830 git.sideband.band1.bytes=1830 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1830 git.pack.trailer=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200347 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=347 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=73f6a798386c4a4df64da0b5349881ded38885ca git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=347 git.pkt.payload.max=320 git.sideband.band1.bytes=320 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=320 git.pack.trailer=93ed36ed1884d41429801c50b3bb5d32ef1307a5Open pack map
fetchtree:0200150 B · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=150 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=0d8a4853f153ab6bf1270fa17e8387fd27d9b064 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=150 git.pkt.payload.max=123 git.sideband.band1.bytes=123 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=123 git.pack.trailer=7b43b83d975888b44b41535afcdc630b1fa37956Open pack map
fetch2001.3 KiB190 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=190 git.response.bytes=1338 git.response.cache=MISS git.response.duration_ms=190 git.fetch.wants=0fe88c4e37c4a8ba5bc2b5ddaac9d02f3779f57f git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1338 git.pkt.payload.max=1311 git.sideband.band1.bytes=1311 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0
Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.
- Remote
- https://gitlab.com/gitlab-org/cli
- Ref
- refs/heads/main
- Commit
- 0dd7574dce9e385c5c30540e6c15657adc6bdce9
- cf-ray
- a5e2f32279587089
- Request
- 1bf16edc…
- Protocol
- v2 · sha1
- Agent
- git/2.56.g1891de4-Linux
- Filter
- advertised
- Fetch
- shallow wait-for-done filter
- Capabilities
- agent ls-refs fetch server-option object-format