GitLabgitlab-org
cli
main
1// Package binarymgr provides a reusable lifecycle for managed CLI binaries
2// distributed through a GitLab project's Generic Package Registry. Each
3// consumer describes its binary with a Spec and gets download, checksum
4// verification, atomic install, scheduled update checks, and run-time
5// pass-through orchestration in return.
6package binarymgr
8// Spec describes a single managed binary. Everything that varies between
9// consumers (project, naming, supported platforms, optional tarball
10// extraction) lives here; the Manager and Runner contain no consumer-specific
11// strings.
12type Spec struct {
13 // DisplayName appears in user-facing prompts and log lines
14 // (e.g. "GitLab Duo CLI", "Orbit local CLI").
15 DisplayName string
17 // ProjectID is the GitLab project ID that hosts the generic package.
18 ProjectID string
20 // PackageName is the generic-package name (e.g. "duo-cli", "orbit-cli").
21 PackageName string
23 // Command is the glab subcommand chain that runs the binary
24 // (e.g. "duo cli", "orbit"), used in update hints.
25 Command string
27 // ConfigPrefix is the config-key namespace. Keys are derived as
28 // <prefix>_binary_path, _binary_version, _binary_checksum,
29 // _last_update_check, _auto_run, _auto_download.
30 ConfigPrefix string
32 // EnvVarPrefix is the env-var namespace. Variables are derived as
33 // <prefix>_BINARY_PATH, _CHECK_UPDATE.
34 EnvVarPrefix string
36 // MaxCompatibleMajor caps automatic updates to this major version.
37 // 0 disables the cap (every newer version is considered compatible).
38 MaxCompatibleMajor int
40 // MinVersion forces a re-download when the installed version is below it; empty disables the floor.
41 MinVersion string
43 // RequireChecksum makes a missing registry checksum fatal instead of a
44 // skipped-with-warning verification. Set it for binaries whose integrity is
45 // load-bearing (e.g. one that can block tool calls), so an unverified
46 // artifact is never executed.
47 RequireChecksum bool
49 // SupportedOS lists the GOOS values the binary is published for.
50 SupportedOS []string
52 // NormalizeArch converts (GOOS, GOARCH) into the upstream arch name
53 // used in asset filenames (e.g. amd64 -> "x64" for duo, "x86_64"
54 // for orbit). Should return ErrUnsupportedPlatform-wrapped errors
55 // for unsupported combinations.
56 NormalizeArch func(goos, goarch string) (string, error)
58 // AssetName returns the upstream asset filename for a (os, arch) pair
59 // (e.g. "duo-darwin-arm64", "orbit-cli-darwin-aarch64.tar.gz").
60 AssetName func(os, arch string) string
62 // InstalledName returns the local filename of the installed binary
63 // (e.g. "duo", "duo.exe", "orbit"). The install directory is shared
64 // across managed binaries (<config-dir>/bin).
65 InstalledName func(os string) string
67 // Extract optionally transforms the downloaded asset into a binary on
68 // disk. nil means the downloaded file IS the binary. TarGzExtractor is
69 // the typical choice for tarball-distributed binaries.
70 Extract Extractor
71}
73// Extractor pulls the executable out of a downloaded asset and writes it to
74// destDir. It returns the path to the resulting binary file.
75type Extractor func(srcPath, destDir string) (binaryPath string, err error)
77// configKey returns the fully qualified config key for a suffix.
78func (s Spec) configKey(suffix string) string {
79 return s.ConfigPrefix + "_" + suffix
80}
82// envVar returns the fully qualified env var for a suffix.
83func (s Spec) envVar(suffix string) string {
84 return s.EnvVarPrefix + "_" + suffix
85}
Diagnostics6 git calls · 39 ms
CallStatusSizeTime039 ms
discover200185 B2 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs 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
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=3 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
fetchcombine:blob:none+tree:2 · deepen 12004.2 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=4273 git.response.cache=HIT git.response.duration_ms=4 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:0200528 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=528 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=6f25b436c20690dd9e61e310cecb2c93d3671017 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=528 git.pkt.payload.max=501 git.sideband.band1.bytes=501 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=501 git.pack.trailer=3f78362ab585c40c9cff18b66b4df6f87bfba2d8Open pack map
fetch2001.6 KiB · hit30 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=30 git.response.bytes=1595 git.response.cache=HIT git.response.duration_ms=30 git.fetch.wants=32b269990200910ac63246e865059f0146d1dac4 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=1595 git.pkt.payload.max=1568 git.sideband.band1.bytes=1568 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
- a5e132b7ea6ba9fe
- Request
- 0e3261d4…
- 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