GitLabgitlab-org

cli

main
ply8 git calls234 ms99 KiB5 cachedprotocol v2
128 lines4.2 KiBRaw
1// Package autoflowutils holds what the `glab autoflow workflow` commands
2// share.
3package autoflowutils
5import (
6 "context"
7 "crypto/tls"
8 "crypto/x509"
9 "errors"
10 "fmt"
11 "io"
12 "os"
13 "time"
15 "github.com/google/uuid"
16 "github.com/spf13/cobra"
17 autoflowrpcv1 "gitlab.com/gitlab-org/protos/gen/go/gitlab/autoflow/rpc/v1"
19 "gitlab.com/gitlab-org/cli/internal/api"
20 "gitlab.com/gitlab-org/cli/internal/api/autoflow"
21 "gitlab.com/gitlab-org/cli/internal/cmdutils"
22 "gitlab.com/gitlab-org/cli/internal/glinstance"
23 "gitlab.com/gitlab-org/cli/internal/iostreams"
26// CallTimeout bounds a single RPC to the AutoFlow service.
27const CallTimeout = 30 * time.Second
29// Connection is the set of flags that addresses the AutoFlow service and a
30// namespace in it.
31type Connection struct {
32 hostname string
33 address string
34 caCertFile string
35 insecure bool
36 namespaceID string
38 // NamespaceID is the parsed --namespace-id, set by Complete, or the
39 // organization of the AutoFlow token, set by Dial.
40 NamespaceID uuid.UUID
43// AddFlags registers the connection flags on cmd.
44func (c *Connection) AddFlags(cmd *cobra.Command) {
45 fl := cmd.Flags()
46 fl.StringVar(&c.hostname, "hostname", "", "GitLab hostname to exchange the token with. Defaults to the configured GitLab instance.")
47 fl.StringVar(&c.address, "address", "", "Address of the AutoFlow service, as <host>:<port>.")
48 fl.StringVar(&c.caCertFile, "ca-cert", "", "Path to a PEM-encoded CA certificate to trust for the AutoFlow service, in addition to the system roots.")
49 fl.BoolVar(&c.insecure, "insecure", false, "Connect to the AutoFlow service without TLS, for a local service only. The AutoFlow token and the workflow's credentials travel in cleartext.")
50 fl.StringVar(&c.namespaceID, "namespace-id", "", "UUID of the AutoFlow namespace. Defaults to the organization of your token.")
52 cobra.CheckErr(cmd.MarkFlagRequired("address"))
53 cobra.CheckErr(cmd.MarkFlagFilename("ca-cert", "pem", "crt"))
54 cmd.MarkFlagsMutuallyExclusive("insecure", "ca-cert")
57// Complete parses and validates the connection flags.
58func (c *Connection) Complete() error {
59 if c.hostname != "" {
60 if err := glinstance.HostnameValidator(c.hostname); err != nil {
61 return &cmdutils.FlagError{Err: fmt.Errorf("error parsing --hostname: %w", err)}
62 }
63 }
64 if c.namespaceID == "" {
65 return nil
66 }
67 id, err := uuid.Parse(c.namespaceID)
68 if err != nil {
69 return &cmdutils.FlagError{Err: fmt.Errorf("error parsing --namespace-id: %w", err)}
70 }
71 if id == uuid.Nil {
72 return &cmdutils.FlagError{Err: errors.New("error parsing --namespace-id: must not be the nil UUID")}
73 }
74 c.NamespaceID = id
75 return nil
78// Dial connects to the AutoFlow service with a token exchanged on the GitLab
79// instance and sets NamespaceID to the token's organization unless
80// --namespace-id is set. The caller must close the returned connection.
81func (c *Connection) Dial(ctx context.Context, ios *iostreams.IOStreams, apiClient func(repoHost string) (*api.Client, error)) (autoflowrpcv1.AutoFlowServiceClient, io.Closer, error) {
82 var tlsConfig *tls.Config
83 if c.insecure {
84 ios.LogErrorf("warning: --insecure sends the AutoFlow token and the workflow's credentials to %s in cleartext\n", c.address)
85 } else {
86 var err error
87 tlsConfig, err = c.tlsConfig()
88 if err != nil {
89 return nil, nil, err
90 }
91 }
92 client, err := apiClient(c.hostname)
93 if err != nil {
94 return nil, nil, err
95 }
96 conn, err := autoflow.Dial(ctx, client.Lab(), c.address, tlsConfig)
97 if err != nil {
98 return nil, nil, err
99 }
100 if c.NamespaceID == uuid.Nil {
101 c.NamespaceID, err = conn.Organization()
102 if err != nil {
103 _ = conn.Close()
104 return nil, nil, err
105 }
106 }
107 return conn, conn, nil
110func (c *Connection) tlsConfig() (*tls.Config, error) {
111 cfg := &tls.Config{MinVersion: tls.VersionTLS12}
112 if c.caCertFile == "" {
113 return cfg, nil
114 }
115 pem, err := os.ReadFile(c.caCertFile)
116 if err != nil {
117 return nil, fmt.Errorf("failed to read --ca-cert: %w", err)
118 }
119 pool, err := x509.SystemCertPool()
120 if err != nil {
121 return nil, fmt.Errorf("failed to load the system certificate pool: %w", err)
122 }
123 if !pool.AppendCertsFromPEM(pem) {
124 return nil, fmt.Errorf("--ca-cert %s contains no PEM-encoded certificate", c.caCertFile)
125 }
126 cfg.RootCAs = pool
127 return cfg, nil
Diagnostics8 git calls · 234 ms
CallStatusSizeTime0234 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=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 KiB2 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=2
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 · hit1 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=1
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=1
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 · 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=44
Open 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=fb03183b7909876778f740d196d7516811003517
Open pack map
fetchtree:0200173 B · hit2 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=173
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=9842465ba0bef0fe35148002069a98d0492349fa
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=173
git.pkt.payload.max=146
git.sideband.band1.bytes=146
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=146
git.pack.trailer=257bc2fe070f60e712099d7a0548db758c6c9692
Open pack map
fetchtree:0200176 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=223
git.response.bytes=176
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=67d60b9731d73bfe7a89cc47b7ab1b8a1e32c79c
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=176
git.pkt.payload.max=149
git.sideband.band1.bytes=149
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=149
git.pack.trailer=af37f0f3464e64b4cacdcc0b52d6281fadf15460
Open pack map
fetch2001.6 KiB223 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1646
git.response.cache=MISS
git.response.duration_ms=223
git.fetch.wants=09f57e4511b4b433d20b50d8ae5824bfeee8f5bb
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=1646
git.pkt.payload.max=1619
git.sideband.band1.bytes=1619
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
a5e2e6ef987fecfa
Request
543c0144…
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