fix(cli): PRD-814 surface version check errors when verbose

Store GitHub release lookup failures, send a User-Agent on the request,
and print the error with escape-cli version -v when the check fails.

Co-authored-by: maxence <maxence@escape.tech>

Author: 2 people

pkg/cli/cmd/version.go

@@ -20,7 +20,11 @@ and build date. Use this to verify your installation and check for updates.`,
   escape-cli version -o json`,
 	Run: func(c *cobra.Command, _ []string) {
 		v := version.GetDetailedVersion(c.Context())
-		out.Print(v, v.String())
+		text := v.String()
+		if rootCmdVerbose > 0 && v.UpdateCheckError != "" {
+			text += "\n  Check error:  " + v.UpdateCheckError
+		}
+		out.Print(v, text)
 	},
 }
 

pkg/version/update_check.go

@@ -21,9 +21,10 @@ type githubRelease struct {
 
 // UpdateInfo stores the cached result of the latest release lookup.
 type UpdateInfo struct {
-	Current   string `json:"current,omitempty"`
-	Latest    string `json:"latest,omitempty"`
-	Available bool   `json:"available,omitempty"`
+	Current    string `json:"current,omitempty"`
+	Latest     string `json:"latest,omitempty"`
+	Available  bool   `json:"available,omitempty"`
+	CheckError string `json:"checkError,omitempty"`
 }
 
 var (
@@ -66,6 +67,8 @@ func getLatestReleaseTag(ctx context.Context) (string, error) {
 	if err != nil {
 		return "", fmt.Errorf("create request: %w", err)
 	}
+	req.Header.Set("Accept", "application/vnd.github+json")
+	req.Header.Set("User-Agent", "escape-cli/"+normalizeVersion(GetVersion().Version))
 
 	resp, err := client.Do(req)
 	if err != nil {
@@ -101,7 +104,13 @@ func CheckForUpdate(parentCtx context.Context) *UpdateInfo {
 		defer cancel()
 
 		latest, err := getLatestReleaseTag(ctx)
-		if err != nil || latest == "" {
+		if err != nil {
+			info.CheckError = err.Error()
+			updateInfo = info
+			return
+		}
+		if latest == "" {
+			info.CheckError = "empty latest release tag"
 			updateInfo = info
 			return
 		}

pkg/version/version.go

@@ -22,8 +22,9 @@ type V struct {
 	Commit         string `json:"commit"`
 	BuildDate      string `json:"buildDate"`
 	InstallMethod  string `json:"installMethod,omitempty"`
-	LatestVersion  string `json:"latestVersion,omitempty"`
-	UpgradeCommand string `json:"upgradeCommand,omitempty"`
+	LatestVersion     string `json:"latestVersion,omitempty"`
+	UpgradeCommand    string `json:"upgradeCommand,omitempty"`
+	UpdateCheckError  string `json:"updateCheckError,omitempty"`
 }
 
 // GetVersion returns the version information
@@ -43,6 +44,7 @@ func GetDetailedVersion(ctx context.Context) V {
 
 	v.InstallMethod = string(installInfo.Method)
 	v.LatestVersion = updateInfo.Latest
+	v.UpdateCheckError = updateInfo.CheckError
 	if updateInfo.Available {
 		v.UpgradeCommand = UpgradeCommand(installInfo.Method, updateInfo.Latest)
 	}