GitLabgitlab-org
cli
main
1package cmdutils
3import (
4 "context"
5 "fmt"
6 "slices"
8 "github.com/spf13/cobra"
10 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
12 "gitlab.com/gitlab-org/cli/internal/iostreams"
13 "gitlab.com/gitlab-org/cli/internal/upload"
14)
16const attachFlag = "attach"
18// AddAttachFlag registers --attach on cmd, bound to paths.
19func AddAttachFlag(cmd *cobra.Command, paths *[]string, resource string) {
20 cmd.Flags().StringArrayVar(paths, attachFlag, nil, fmt.Sprintf(
21 "(EXPERIMENTAL) Upload a file and reference it at the end of the %s. Use \"-\" to read the file from standard input. Repeat the flag to attach multiple files.",
22 resource,
23 ))
24}
26// SkipNoteBody reports whether --attach prevents reading a note body: an
27// attachment claims stdin for itself, or stdin is a terminal, where an
28// attachment-only note must not open the editor.
29func SkipNoteBody(ios *iostreams.IOStreams, attach []string) bool {
30 return slices.Contains(attach, upload.StdinPath) || (len(attach) > 0 && ios.IsInTTY)
31}
33// checkAttachmentStdin rejects sharing stdin: reading the description closes
34// the stream, leaving the attachment an exhausted reader.
35func checkAttachmentStdin(cmd *cobra.Command, descriptionFile string) error {
36 if descriptionFile != upload.StdinPath || cmd.Flags().Lookup(attachFlag) == nil {
37 return nil
38 }
40 paths, err := cmd.Flags().GetStringArray(attachFlag)
41 if err != nil {
42 return err
43 }
44 if !slices.Contains(paths, upload.StdinPath) {
45 return nil
46 }
48 return &FlagError{Err: fmt.Errorf("--%s and --%s cannot both read from %q", descriptionFileFlag, attachFlag, upload.StdinPath)}
49}
51// AppendAttachments uploads paths and appends a markdown reference to each.
52//
53// projectPath must be the project that renders the body, since that is the only
54// one an upload reference resolves against. For a merge request from a fork
55// that is the target project, not the head repo.
56func AppendAttachments(ctx context.Context, ios *iostreams.IOStreams, client *gitlab.Client, projectPath, body string, paths []string) (string, error) {
57 if len(paths) == 0 {
58 return body, nil
59 }
61 attachments, err := upload.Attachments(ios.In, paths)
62 if err != nil {
63 return "", err
64 }
66 references, err := upload.Upload(ctx, ios, client, projectPath, attachments)
67 if err != nil {
68 return "", err
69 }
71 return upload.Append(body, references), nil
72}
74// AppendAttachmentsToUpdate appends to newBody, or to current when the user
75// supplied no new body. current is called only when needed, so a caller that
76// fetches the existing body spends no request when newBody made it redundant.
77func AppendAttachmentsToUpdate(ctx context.Context, ios *iostreams.IOStreams, client *gitlab.Client, projectPath string, newBody *string, current func() (string, error), paths []string) (string, error) {
78 if newBody != nil {
79 return AppendAttachments(ctx, ios, client, projectPath, *newBody, paths)
80 }
82 body, err := current()
83 if err != nil {
84 return "", err
85 }
87 return AppendAttachments(ctx, ios, client, projectPath, body, paths)
88}
Diagnostics6 git calls · 36 ms
CallStatusSizeTime036 ms
discover200185 B2 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 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 KiB3 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 git.response.bytes=59849 git.response.cache=UPDATING git.response.duration_ms=3 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
fetchtree:0 · deepen 1020032 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=32926 git.response.cache=HIT git.response.duration_ms=2 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
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · 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=4273 git.response.cache=HIT git.response.duration_ms=4 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:02001.2 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=1238 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=c10f4b8b760c3fec7ed8ca85e428d5bc523f8e17 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=1238 git.pkt.payload.max=1211 git.sideband.band1.bytes=1211 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1211 git.pack.trailer=7373aa350f2a611db7d4116eb1450c92f18a27caOpen pack map
fetch2001.2 KiB · hit27 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=27 git.response.bytes=1252 git.response.cache=HIT git.response.duration_ms=27 git.fetch.wants=b81626e06a837993527f1bd04c43a2f93d61c5be 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=1252 git.pkt.payload.max=1225 git.sideband.band1.bytes=1225 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
- a5e126957f587fd8
- Request
- 19532484…
- 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