GitLabgitlab-org
cli
main
1package config
3import (
4 "errors"
5 "fmt"
6 "os"
7 "os/exec"
8 "path/filepath"
9 "strings"
11 "go.yaml.in/yaml/v3"
12)
14type LocalConfig struct {
15 ConfigMap
16 Parent Config
17 dir string
18}
20// for later use we might prefer relative paths
21// GitDir will find a directory or just return ".git"
22func GitDir(preferRelative bool) []string {
23 // `git rev-parse --git-dir` since git v1.2.2
24 return revParseDir("--git-dir", preferRelative)
25}
27// GitCommonDir will find the directory every linked worktree of a repository has
28// in common, or just return ".git". In a normal checkout it is the same directory
29// GitDir returns; in a linked worktree GitDir is .git/worktrees/<name> while this
30// is the main repository's .git. A submodule keeps its own, .git/modules/<name>.
31func GitCommonDir(preferRelative bool) []string {
32 // `git rev-parse --git-common-dir` since git v2.5, which introduced worktrees
33 return revParseDir("--git-common-dir", preferRelative)
34}
36// revParseDir resolves one `git rev-parse` directory flag to the caller's
37// preferred path form, falling back to ".git" when git cannot answer.
38func revParseDir(revParseFlag string, preferRelative bool) []string {
39 var err error
40 var out strings.Builder
42 cmd := exec.Command("git", "rev-parse", revParseFlag)
44 cmd.Stdout = &out
45 err = cmd.Run()
46 if err != nil {
47 // should fail
48 return []string{".git"}
49 }
51 gitDir := strings.TrimSpace(out.String())
53 if !filepath.IsAbs(gitDir) {
54 // gitDir is relative
55 if !preferRelative {
56 // but we prefer absolute
57 workDir, err := os.Getwd()
58 if err == nil {
59 return []string{workDir, gitDir}
60 }
61 }
62 // relative should work, cleaned because git answers with forward slashes
63 return []string{filepath.Clean(gitDir)}
64 } else {
65 // gitDir is absolute
66 if preferRelative {
67 // but we prefer relative
68 var relativeDir string
69 workDir, err := os.Getwd()
70 if err == nil {
71 relativeDir, err = filepath.Rel(workDir, gitDir)
72 }
73 if err == nil {
74 return []string{relativeDir}
75 }
76 }
77 // absolute should work
78 return []string{gitDir}
79 }
80}
82// LocalConfigDir returns the local config path in map
83// which must be joined for complete path.
84//
85// The shared git directory is used, so one repository has one local config that
86// every linked worktree reads and writes. Git itself shares .git/config the same
87// way and makes per-worktree config opt-in, and these keys describe the
88// repository rather than the checkout.
89//
90// A worktree that already has its own file keeps using it, so a config written
91// before this change is still found. In a normal checkout the two directories are
92// the same and nothing changes.
93func LocalConfigDir() []string {
94 perWorktree := append(GitDir(true), "glab-cli")
95 if CheckFileExists(filepath.Join(append(perWorktree, "config.yml")...)) {
96 return perWorktree
97 }
99 return append(GitCommonDir(true), "glab-cli")
100}
102// LocalConfigFile returns the config file name with full path
103func LocalConfigFile() string {
104 configFile := append(LocalConfigDir(), "config.yml")
105 return filepath.Join(configFile...)
106}
108func (a *LocalConfig) Get(key string) (string, bool) {
109 key = ConfigKeyEquivalence(key)
110 if a.Empty() {
111 return "", false
112 }
113 value, _ := a.GetStringValue(key)
115 return value, value != ""
116}
118func (a *LocalConfig) Set(key, value string) error {
119 key = ConfigKeyEquivalence(key)
120 err := a.SetStringValue(key, value)
121 if err != nil {
122 return fmt.Errorf("failed to update config: %w", err)
123 }
125 err = a.Write()
126 if err != nil {
127 return fmt.Errorf("failed to write config: %w", err)
128 }
130 return nil
131}
133func (a *LocalConfig) Delete(key string) error {
134 a.RemoveEntry(key)
136 return a.Write()
137}
139func (a *LocalConfig) Write() error {
140 // An empty dir means the config is in-memory only; nothing to persist.
141 if a.dir == "" {
142 return nil
143 }
145 // Check if it's a Git repository
146 if !CheckPathExists(filepath.Join(GitDir(true)...)) {
147 return errors.New("not a Git repository")
148 }
150 localConfigBytes, err := yaml.Marshal(a.ConfigMap.Root)
151 if err != nil {
152 return err
153 }
154 err = writeConfigFile(LocalConfigFile(), yamlNormalize(localConfigBytes))
155 if err != nil {
156 return fmt.Errorf("failed to write config: %w", err)
157 }
159 return nil
160}
162func (a *LocalConfig) All() map[string]string {
163 out := map[string]string{}
165 if a.Empty() {
166 return out
167 }
169 for i := 0; i < len(a.Root.Content)-1; i += 2 {
170 key := a.Root.Content[i].Value
171 value := a.Root.Content[i+1].Value
172 out[key] = value
173 }
175 return out
176}
Diagnostics6 git calls · 310 ms
CallStatusSizeTime0310 ms
discover200185 B2 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 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 · 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=2 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=44Open pack map
fetchtree:02001.4 KiB · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=304 git.response.bytes=1391 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=e9da9edfdcf44933ee5fa121d411de326220161c 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=1391 git.pkt.payload.max=1364 git.sideband.band1.bytes=1364 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1364 git.pack.trailer=bf750bd385ed98d15e1fea1289d3b00caa61d64cOpen pack map
fetch2001.7 KiB304 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1731 git.response.cache=MISS git.response.duration_ms=304 git.fetch.wants=52e721a496ee675ccb79966af7442754daae8c75 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=1731 git.pkt.payload.max=1704 git.sideband.band1.bytes=1704 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
- a5e2a79e1d471293
- Request
- 8c5753fa…
- 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