GitLabgitlab-org
cli
main
1package iostreams
3import (
4 "encoding/json"
5 "reflect"
6)
8// PrintJSON marshals v to JSON and writes it to stdout. If v is a nil slice,
9// it converts it to an empty slice so that JSON marshaling produces [] instead
10// of null. This addresses the issue where gitlab.ScanAndCollect returns nil for
11// empty results, which would otherwise marshal as null instead of [].
12//
13// Nested slices within the data structure are left as-is to preserve the
14// semantic difference between absent fields (null) and empty arrays ([]) in
15// the original API response.
16//
17// When IOStreams.JQ is active (a --jq expression was supplied), the value is
18// passed through the filter before being written.
19func (s *IOStreams) PrintJSON(v any) error {
20 rv := reflect.ValueOf(v)
21 if rv.Kind() == reflect.Slice && rv.IsNil() {
22 v = reflect.MakeSlice(rv.Type(), 0, 0).Interface()
23 }
25 if s.JQ != nil && s.JQ.IsActive() {
26 return s.JQ.Apply(s.StdOut, v)
27 }
29 encoder := json.NewEncoder(s.StdOut) //nolint:forbidigo // this is the PrintJSON helper itself
30 return encoder.Encode(v)
31}
33// The message is nested under "error" so it cannot be mistaken for the
34// command's success payload, which shares the stream, and so fields can be
35// added later without changing the type of an existing one.
36type jsonErrorEnvelope struct {
37 Error jsonErrorBody `json:"error"`
38}
40type jsonErrorBody struct {
41 Message string `json:"message"`
42}
44// PrintJSONError writes a machine-readable description of err to stdout for a
45// command asked for JSON output that failed before printing anything.
46//
47// Unlike PrintJSON it does not apply --jq: that filter targets the command's
48// success output, so running it here would report a filter failure instead of
49// the failure the user needs to see.
50func (s *IOStreams) PrintJSONError(err error) error {
51 encoder := json.NewEncoder(s.StdOut) //nolint:forbidigo // this is the PrintJSON helper for errors
52 return encoder.Encode(jsonErrorEnvelope{Error: jsonErrorBody{Message: err.Error()}})
53}
Diagnostics6 git calls · 31 ms
CallStatusSizeTime031 ms
discover200185 B4 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=9 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 · hit9 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=9 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:0200432 B · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=18 git.response.bytes=432 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=a79e8e89fbedf0d57724da455f6326f6e79de3b5 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=432 git.pkt.payload.max=405 git.sideband.band1.bytes=405 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=405 git.pack.trailer=6b5f558fa7a37603ce66aafb676f53aedcb02370Open pack map
fetch2001.0 KiB · hit18 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1042 git.response.cache=HIT git.response.duration_ms=18 git.fetch.wants=a615121151e234de5d8e0fe1d3492de0c803911f 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=1042 git.pkt.payload.max=1015 git.sideband.band1.bytes=1015 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
- a5e2980a4d452407
- Request
- 53f25422…
- 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