GitLabgitlab-org
cli
main
1package autoflowutils
3import (
4 "context"
5 "fmt"
6 "strings"
7 "time"
9 "github.com/spf13/cobra"
10 autoflowrpcv1 "gitlab.com/gitlab-org/protos/gen/go/gitlab/autoflow/rpc/v1"
11 "google.golang.org/grpc/codes"
12 "google.golang.org/grpc/status"
14 "gitlab.com/gitlab-org/cli/internal/cmdutils"
15)
17// State returns the name of s without its enum prefix, as the commands print
18// it.
19func State(s autoflowrpcv1.WorkflowState) string {
20 return strings.TrimPrefix(s.String(), "WORKFLOW_STATE_")
21}
23// isTerminal reports whether a workflow in state s can no longer change.
24func isTerminal(s autoflowrpcv1.WorkflowState) bool {
25 switch s {
26 case autoflowrpcv1.WorkflowState_WORKFLOW_STATE_UNSPECIFIED,
27 autoflowrpcv1.WorkflowState_WORKFLOW_STATE_RUNNING:
28 return false
29 default:
30 // A state this version does not know yet ends the wait rather than
31 // polling forever.
32 return true
33 }
34}
36const maxTransientFailures = 5
38func isTransient(err error) bool {
39 switch status.Code(err) {
40 case codes.Unavailable, codes.DeadlineExceeded:
41 return true
42 default:
43 return false
44 }
45}
47// GetWorkflow reads the workflow req addresses.
48func GetWorkflow(ctx context.Context, client autoflowrpcv1.AutoFlowServiceClient, req *autoflowrpcv1.GetWorkflowRequest) (*autoflowrpcv1.GetWorkflowResponse, error) {
49 ctx, cancel := context.WithTimeout(ctx, CallTimeout)
50 defer cancel()
51 resp, err := client.GetWorkflow(ctx, req)
52 if err != nil {
53 return nil, fmt.Errorf("failed to get workflow: %w", err)
54 }
55 return resp, nil
56}
58// Wait is the set of flags that makes a command poll a workflow until it has
59// finished.
60type Wait struct {
61 Enabled bool
62 interval time.Duration
63}
65// AddFlags registers --wait and --poll-interval on cmd.
66func (w *Wait) AddFlags(cmd *cobra.Command) {
67 fl := cmd.Flags()
68 fl.BoolVar(&w.Enabled, "wait", false, "Poll until the workflow has finished.")
69 fl.DurationVar(&w.interval, "poll-interval", 2*time.Second, "How often to poll the workflow with --wait.")
70}
72// Validate checks the poll interval.
73func (w *Wait) Validate() error {
74 if w.interval <= 0 {
75 return &cmdutils.FlagError{Err: fmt.Errorf("--poll-interval must be positive, got %s", w.interval)}
76 }
77 return nil
78}
80// Until reads the workflow req addresses every poll interval until it has
81// finished. It keeps polling through up to maxTransientFailures consecutive
82// failures that a retry can fix, such as a restarting Relay.
83func (w *Wait) Until(ctx context.Context, client autoflowrpcv1.AutoFlowServiceClient, req *autoflowrpcv1.GetWorkflowRequest) (*autoflowrpcv1.GetWorkflowResponse, error) {
84 failures := 0
85 for {
86 resp, err := GetWorkflow(ctx, client, req)
87 switch {
88 case err == nil && isTerminal(resp.GetState()):
89 return resp, nil
90 case err == nil:
91 failures = 0
92 case ctx.Err() == nil && isTransient(err) && failures < maxTransientFailures:
93 failures++
94 default:
95 return nil, err
96 }
97 select {
98 case <-ctx.Done():
99 return nil, ctx.Err()
100 case <-time.After(w.interval):
101 }
102 }
103}
Diagnostics8 git calls · 270 ms
CallStatusSizeTime0270 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 KiB · hit2 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=HIT 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 · 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 · hit2 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=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
fetchtree:02001.8 KiB · hit1 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=1 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: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=257bc2fe070f60e712099d7a0548db758c6c9692Open 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=259 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=af37f0f3464e64b4cacdcc0b52d6281fadf15460Open pack map
fetch2001.3 KiB259 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1292 git.response.cache=MISS git.response.duration_ms=259 git.fetch.wants=4b7e1a14829261124a795c1e468f9f6d8e543258 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=1292 git.pkt.payload.max=1265 git.sideband.band1.bytes=1265 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
- a5e2d2495e9dcf3a
- Request
- 24a43c6b…
- 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