GitLabgitlab-org
cli
main
1package expand
3import (
4 "errors"
5 "fmt"
6 "os"
7 "os/exec"
8 "path/filepath"
9 "regexp"
10 "runtime"
11 "slices"
12 "strconv"
13 "strings"
15 "github.com/google/shlex"
17 "gitlab.com/gitlab-org/cli/internal/config"
18)
20// ExpandAlias processes argv to see if it should be rewritten according to a user's aliases. The
21// second return value indicates whether the alias should be executed in a new shell process instead
22// of running gh itself.
23func ExpandAlias(cfg config.Config, args []string, findShFunc func() (string, error)) ([]string, bool, error) {
24 if len(args) < 2 {
25 // the command is lacking a subcommand
26 return nil, false, nil
27 }
28 expanded := args[1:]
30 aliases, err := cfg.Aliases()
31 if err != nil {
32 return expanded, false, err
33 }
35 expansion, ok := aliases.Get(args[1])
36 if !ok {
37 return expanded, false, nil
38 }
40 if strings.HasPrefix(expansion, "!") {
41 isShell := true
42 if findShFunc == nil {
43 findShFunc = findSh
44 }
45 shPath, shErr := findShFunc()
46 if shErr != nil {
47 return nil, false, shErr
48 }
50 expanded = []string{shPath, "-c", expansion[1:]}
52 if len(args[2:]) > 0 {
53 expanded = append(expanded, "--")
54 expanded = append(expanded, args[2:]...)
55 }
57 return expanded, isShell, nil
58 }
60 // Split before filling the placeholders, so that an argument is never
61 // parsed again: its quotes, spaces and "$N" text reach the command as is.
62 newArgs, err := shlex.Split(expansion)
63 if err != nil {
64 return nil, false, err
65 }
67 aliasArgs := args[2:]
68 fill := func(s string) string {
69 return placeholderRE.ReplaceAllStringFunc(s, func(p string) string {
70 n, _ := strconv.Atoi(p[1:])
71 if n > len(aliasArgs) {
72 return p
73 }
74 return aliasArgs[n-1]
75 })
76 }
78 highest := 0
79 for _, word := range newArgs {
80 for _, m := range placeholderRE.FindAllStringSubmatch(word, -1) {
81 n, _ := strconv.Atoi(m[1])
82 highest = max(highest, n)
83 }
84 }
85 if highest > len(aliasArgs) {
86 return nil, false, fmt.Errorf("not enough arguments for alias: %s", fill(expansion))
87 }
89 for i, word := range newArgs {
90 newArgs[i] = fill(word)
91 }
93 expanded = slices.Concat(newArgs, aliasArgs[highest:])
94 return expanded, false, nil
95}
97var placeholderRE = regexp.MustCompile(`\$([1-9]\d*)`)
99func findSh() (string, error) {
100 shPath, err := exec.LookPath("sh")
101 if err == nil {
102 return shPath, nil
103 }
105 if runtime.GOOS == "windows" {
106 winNotFoundErr := errors.New("unable to locate sh to execute the shell alias with. The sh.exe interpreter is typically distributed with Git for Windows")
107 // We can try and find a sh executable in a Git for Windows install
108 gitPath, err := exec.LookPath("git")
109 if err != nil {
110 return "", winNotFoundErr
111 }
113 shPath = filepath.Join(filepath.Dir(gitPath), "..", "bin", "sh.exe")
114 _, err = os.Stat(shPath)
115 if err != nil {
116 return "", winNotFoundErr
117 }
119 return shPath, nil
120 }
122 return "", errors.New("unable to locate sh to execute shell alias with")
123}
Diagnostics8 git calls · 365 ms
CallStatusSizeTime0365 ms
discover200185 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs 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 KiB · hit3 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=HIT 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 · 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:02001.8 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=1857 git.response.cache=HIT git.response.duration_ms=4 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:0200256 B · 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=256 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=9b63d874f7ad9ca8ff5a684fa9f649afab76eddc 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=256 git.pkt.payload.max=229 git.sideband.band1.bytes=229 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=229 git.pack.trailer=21020800d0a123456c692912cb576372452d51baOpen pack map
fetchtree:0200144 B · 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=144 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=53a7f35a9eb83c12a89d7c45b3e70a8b0196e587 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=144 git.pkt.payload.max=117 git.sideband.band1.bytes=117 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=117 git.pack.trailer=677c523b92315f5070acf708f5e16db1df8368f8Open pack map
fetch2001.3 KiB350 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=350 git.response.bytes=1304 git.response.cache=MISS git.response.duration_ms=350 git.fetch.wants=6a2353f349f17d05e86fdd918cada4c649b4caba 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=1304 git.pkt.payload.max=1277 git.sideband.band1.bytes=1277 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
- a5e2df3c2a9b2308
- Request
- 682a2eb1…
- 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