GitLabgitlab-org

cli

main
ply6 git calls201 ms97 KiB3 cachedprotocol v2
81 lines2.5 KiBRaw
1package cmdutils
3import (
4 "errors"
5 "fmt"
6 "io"
7 "os"
9 "github.com/spf13/cobra"
11 "gitlab.com/gitlab-org/cli/internal/iostreams"
14const (
15 descriptionFlag = "description"
16 descriptionFileFlag = "description-file"
19// AddDescriptionFileFlag registers --description-file on cmd and marks it mutually
20// exclusive with --description. The --description flag must already be registered.
21//
22// resource names the thing being described, for example "issue" or "merge request".
23func AddDescriptionFileFlag(cmd *cobra.Command, resource string) {
24 cmd.Flags().String(descriptionFileFlag, "",
25 fmt.Sprintf("Read the %s description from a file. Use \"-\" to read from standard input.", resource))
26 cmd.MarkFlagsMutuallyExclusive(descriptionFlag, descriptionFileFlag)
29// ResolveDescriptionFile reads the file named by --description-file into the
30// --description flag, so commands can keep reading the description from
31// --description alone. It is a no-op when --description-file was not passed.
32//
33// A path of "-" reads from standard input. Because the two flags are mutually
34// exclusive, this never overwrites a description the user passed directly.
35func ResolveDescriptionFile(ios *iostreams.IOStreams, cmd *cobra.Command) error {
36 if !cmd.Flags().Changed(descriptionFileFlag) {
37 return nil
38 }
40 path, err := cmd.Flags().GetString(descriptionFileFlag)
41 if err != nil {
42 return err
43 }
45 if err := checkAttachmentStdin(cmd, path); err != nil {
46 return err
47 }
49 content, err := readDescriptionFile(ios, path)
50 if err != nil {
51 return err
52 }
54 // --description uses "-" to open an editor, so a file holding exactly that
55 // cannot be passed through without silently changing meaning.
56 if content == "-" {
57 return &FlagError{Err: fmt.Errorf("--%s content is only %q, which --%s uses to open an editor", descriptionFileFlag, "-", descriptionFlag)}
58 }
60 // Set marks --description as changed, so the callers' Changed("description")
61 // checks treat a description read from a file the same as one passed inline.
62 return cmd.Flags().Set(descriptionFlag, content)
65func readDescriptionFile(ios *iostreams.IOStreams, path string) (_ string, err error) {
66 if path == "-" {
67 defer func() { err = errors.Join(err, ios.In.Close()) }()
69 b, readErr := io.ReadAll(ios.In)
70 if readErr != nil {
71 return "", fmt.Errorf("failed to read description from standard input: %w", readErr)
72 }
73 return string(b), nil
74 }
76 b, err := os.ReadFile(path)
77 if err != nil {
78 return "", fmt.Errorf("failed to read description file: %w", err)
79 }
80 return string(b), nil
Diagnostics6 git calls · 201 ms
CallStatusSizeTime0201 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
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=3
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
fetchcombine:blob:none+tree:2 · deepen 12004.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=4273
git.response.cache=HIT
git.response.duration_ms=2
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 · 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=32926
git.response.cache=HIT
git.response.duration_ms=3
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=44
Open pack map
fetchtree:02001.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=193
git.response.bytes=1238
git.response.cache=HIT
git.response.duration_ms=3
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=7373aa350f2a611db7d4116eb1450c92f18a27ca
Open pack map
fetch2001.1 KiB193 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1098
git.response.cache=MISS
git.response.duration_ms=193
git.fetch.wants=e45156441dba7634617ce0b594f8536083bf5092
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=1098
git.pkt.payload.max=1071
git.sideband.band1.bytes=1071
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
a5e188022e365e37
Request
a87cef60…
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