Add more context to errors in remotebazel.go (#11414)

A customer reported a NotFound error and it's hard to tell where it's
coming from - the console just shows "rpc error code = NotFound desc =
missing digest" with no additional context.

Ensure all errors are wrapped so that we can diagnose errors more
easily.

Author: bduffany

cli/remotebazel/remotebazel.go

@@ -216,7 +216,7 @@ func determineRemote() (*gitRemote, error) {
 		Options: remoteNames,
 	}
 	if err := survey.AskOne(prompt, &selectedRemoteAndURL); err != nil {
-		return nil, err
+		return nil, fmt.Errorf("select git remote: %w", err)
 	}
 
 	selectedRemote := strings.Split(selectedRemoteAndURL, " (")[0]
@@ -295,7 +295,7 @@ func runCommand(name string, args ...string) (string, error) {
 func isBinaryFile(path string) (bool, error) {
 	fileDetails, err := runCommand("file", "--mime", path)
 	if err != nil {
-		return false, err
+		return false, fmt.Errorf("inspect file mime: %w", err)
 	}
 	isBinary := strings.Contains(fileDetails, "charset=binary")
 	return isBinary, nil
@@ -304,7 +304,7 @@ func isBinaryFile(path string) (bool, error) {
 func diffUntrackedFile(path string) (string, error) {
 	isBinary, err := isBinaryFile(path)
 	if err != nil {
-		return "", err
+		return "", fmt.Errorf("check whether %q is binary: %w", path, err)
 	}
 
 	args := []string{"diff", "--no-index", "/dev/null", path}
@@ -316,7 +316,7 @@ func diffUntrackedFile(path string) (string, error) {
 		// `git diff` returns exit code 1 if there is (valid) diff. Explicitly
 		// check for this case.
 		if !strings.Contains(patch, "diff --git") {
-			return "", err
+			return "", fmt.Errorf("diff untracked file %q: %w", path, err)
 		}
 	}
 
@@ -385,7 +385,7 @@ func getBaseBranchAndCommit(remoteData string) (branch string, commit string, er
 
 	currentBranch, err := getCurrentRef()
 	if err != nil {
-		return "", "", err
+		return "", "", fmt.Errorf("get current ref: %w", err)
 	}
 
 	currentBranchExistsRemotely := branchExistsRemotely(remoteData, currentBranch)
@@ -419,7 +419,7 @@ func getBaseBranchAndCommit(remoteData string) (branch string, commit string, er
 
 		defaultBranchCommitHash, err := getHeadCommitForLocalBranch(defaultBranch)
 		if err != nil {
-			return "", "", err
+			return "", "", fmt.Errorf("get head commit for local branch %q: %w", defaultBranch, err)
 		}
 		commit = defaultBranchCommitHash
 	}
@@ -644,7 +644,7 @@ func streamLogs(ctx context.Context, bbClient bbspb.BuildBuddyServiceClient, inv
 			MinLines:     100,
 		})
 		if err != nil {
-			return err
+			return status.WrapError(err, "get event log chunk")
 		}
 
 		chunks = append(chunks, l)
@@ -687,7 +687,7 @@ func printLogs(ctx context.Context, bbClient bbspb.BuildBuddyServiceClient, invo
 			MinLines:     100,
 		})
 		if err != nil {
-			return err
+			return status.WrapError(err, "get event log chunk")
 		}
 
 		if l.GetLive() {
@@ -706,23 +706,23 @@ func printLogs(ctx context.Context, bbClient bbspb.BuildBuddyServiceClient, invo
 
 func downloadFile(ctx context.Context, bsClient bspb.ByteStreamClient, resourceName *digest.CASResourceName, outFile string) error {
 	if err := os.MkdirAll(filepath.Dir(outFile), 0755); err != nil {
-		return err
+		return fmt.Errorf("create output dir for %q: %w", outFile, err)
 	}
 	out, err := os.Create(outFile)
 	if err != nil {
-		return err
+		return fmt.Errorf("create output file %q: %w", outFile, err)
 	}
 	defer out.Close()
 	if err := cachetools.GetBlob(ctx, bsClient, resourceName, out); err != nil {
-		return err
+		return status.WrapError(err, "download blob")
 	}
 	return nil
 }
 
 func lookupBazelInvocationOutputs(ctx context.Context, bbClient bbspb.BuildBuddyServiceClient, invocationID string) ([]*bespb.File, error) {
 	childInRsp, err := bbClient.GetInvocation(ctx, &inpb.GetInvocationRequest{Lookup: &inpb.InvocationLookup{InvocationId: invocationID}})
 	if err != nil {
-		return nil, fmt.Errorf("could not retrieve invocation %q: %s", invocationID, err)
+		return nil, status.WrapErrorf(err, "get invocation %q", invocationID)
 	}
 
 	if len(childInRsp.GetInvocation()) < 1 {
@@ -748,12 +748,12 @@ func lookupBazelInvocationOutputs(ctx context.Context, bbClient bbspb.BuildBuddy
 func bytestreamURIToResourceName(uri string) (*digest.CASResourceName, error) {
 	u, err := url.Parse(uri)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("parse bytestream uri %q: %w", uri, err)
 	}
 	r := strings.TrimPrefix(u.RequestURI(), "/")
 	rn, err := digest.ParseDownloadResourceName(r)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("parse bytestream resource name %q: %w", r, err)
 	}
 	return rn, nil
 }
@@ -767,46 +767,46 @@ func downloadOutputs(ctx context.Context, env environment.Env, mainOutputs []*be
 	download := func(f *bespb.File) (string, error) {
 		r, err := bytestreamURIToResourceName(f.GetUri())
 		if err != nil {
-			return "", nil
+			return "", fmt.Errorf("resolve output uri for %q: %w", f.GetName(), err)
 		}
 		outFile := filepath.Join(outputBaseDir, BuildBuddyArtifactDir)
 		for _, p := range f.GetPathPrefix() {
 			outFile = filepath.Join(outFile, p)
 		}
 		outFile = filepath.Join(outFile, f.GetName())
 		if err := downloadFile(ctx, bsClient, r, outFile); err != nil {
-			return "", err
+			return "", fmt.Errorf("download output %q: %w", f.GetName(), err)
 		}
 		return outFile, nil
 	}
 	for _, f := range mainOutputs {
 		outFile, err := download(f)
 		if err != nil {
-			return nil, err
+			return nil, fmt.Errorf("download main output %q: %w", f.GetName(), err)
 		}
 		mainLocalArtifacts = append(mainLocalArtifacts, outFile)
 	}
 	// Supporting outputs (i.e. runtime files) are downloaded but not displayed to the user.
 	for _, f := range supportingOutputs {
 		if _, err := download(f); err != nil {
-			return nil, err
+			return nil, fmt.Errorf("download supporting output %q: %w", f.GetName(), err)
 		}
 	}
 	for _, d := range supportingDirs {
 		rn, err := bytestreamURIToResourceName(d.GetUri())
 		if err != nil {
-			return nil, err
+			return nil, fmt.Errorf("resolve supporting output dir uri %q: %w", d.GetName(), err)
 		}
 		tree := &repb.Tree{}
 		if err := cachetools.GetBlobAsProto(ctx, bsClient, rn, tree); err != nil {
-			return nil, err
+			return nil, fmt.Errorf("download supporting output dir metadata %q: %w", d.GetName(), err)
 		}
 		outDir := filepath.Join(outputBaseDir, BuildBuddyArtifactDir, d.GetName())
 		if err := os.MkdirAll(outDir, 0755); err != nil {
-			return nil, err
+			return nil, fmt.Errorf("create supporting output dir %q: %w", outDir, err)
 		}
 		if _, err := dirtools.DownloadTree(ctx, env, rn.GetInstanceName(), rn.GetDigestFunction(), tree, &dirtools.DownloadTreeOpts{RootDir: outDir}); err != nil {
-			return nil, err
+			return nil, fmt.Errorf("download supporting output dir %q: %w", d.GetName(), err)
 		}
 	}
 
@@ -815,7 +815,7 @@ func downloadOutputs(ctx context.Context, env environment.Env, mainOutputs []*be
 	for _, a := range mainLocalArtifacts {
 		rp, err := filepath.Rel(outputBaseDir, a)
 		if err != nil {
-			return nil, err
+			return nil, fmt.Errorf("compute relative artifact path for %q: %w", a, err)
 		}
 		relArtifacts = append(relArtifacts, "  "+rp)
 	}
@@ -1019,27 +1019,27 @@ func Run(ctx context.Context, opts RunOpts, repoConfig *RepoConfig) (int, error)
 		if childIID != "" {
 			conn, err := grpc_client.DialSimple(opts.Server)
 			if err != nil {
-				return 1, fmt.Errorf("could not communicate with sidecar: %s", err)
+				return 1, fmt.Errorf("dial sidecar: %w", err)
 			}
 			env.SetByteStreamClient(bspb.NewByteStreamClient(conn))
 			env.SetContentAddressableStorageClient(repb.NewContentAddressableStorageClient(conn))
 
 			mainOutputs, err := lookupBazelInvocationOutputs(ctx, bbClient, childIID)
 			if err != nil {
-				return 1, err
+				return 1, fmt.Errorf("lookup invocation outputs for %q: %w", childIID, err)
 			}
 			outputsBaseDir := filepath.Dir(opts.WorkspaceFilePath)
 			outputs, err := downloadOutputs(ctx, env, mainOutputs, runfiles, runfileDirectories, outputsBaseDir)
 			if err != nil {
-				return 1, err
+				return 1, fmt.Errorf("download invocation outputs for %q: %w", childIID, err)
 			}
 			if opts.RunOutputLocally {
 				if len(outputs) > 1 {
 					return 1, fmt.Errorf("run requested but target produced more than one artifact")
 				}
 				binPath := outputs[0]
 				if err := os.Chmod(binPath, 0755); err != nil {
-					return 1, fmt.Errorf("could not prepare binary %q for execution: %s", binPath, err)
+					return 1, fmt.Errorf("prepare binary %q for execution: %w", binPath, err)
 				}
 				execArgs := defaultRunArgs
 				// Pass through extra arguments (-- --foo=bar) from the command line.
@@ -1053,7 +1053,7 @@ func Run(ctx context.Context, opts RunOpts, repoConfig *RepoConfig) (int, error)
 				if e, ok := err.(*exec.ExitError); ok {
 					return e.ExitCode(), nil
 				} else if err != nil {
-					return 1, err
+					return 1, fmt.Errorf("run local output %q: %w", binPath, err)
 				}
 				return 0, nil
 			}
@@ -1071,7 +1071,7 @@ func attemptRun(ctx context.Context, bbClient bbspb.BuildBuddyServiceClient, exe
 
 	rsp, err := bbClient.Run(ctx, req)
 	if err != nil {
-		return nil, nil, err
+		return nil, nil, status.WrapError(err, "start remote run")
 	}
 	iid := rsp.GetInvocationId()
 
@@ -1109,7 +1109,7 @@ func attemptRun(ctx context.Context, bbClient bbspb.BuildBuddyServiceClient, exe
 		var err error
 		inRsp, err = bbClient.GetInvocation(ctx, &inpb.GetInvocationRequest{Lookup: &inpb.InvocationLookup{InvocationId: iid}})
 		if err != nil {
-			return fmt.Errorf("could not retrieve invocation: %w", err)
+			return status.WrapErrorf(err, "get invocation %q", iid)
 		}
 		if len(inRsp.GetInvocation()) == 0 {
 			return fmt.Errorf("invocation not found")
@@ -1147,7 +1147,7 @@ func attemptRun(ctx context.Context, bbClient bbspb.BuildBuddyServiceClient, exe
 
 	err = eg.Wait()
 	if err != nil {
-		return nil, nil, err
+		return nil, nil, fmt.Errorf("wait for run result: %w", err)
 	}
 
 	return inRsp, execRsp, nil
@@ -1161,7 +1161,7 @@ func HandleRemoteBazel(commandLineArgs []string) (int, error) {
 
 	tempDir, err := os.MkdirTemp("", "buildbuddy-cli-*")
 	if err != nil {
-		return 1, err
+		return 1, fmt.Errorf("create temp dir: %w", err)
 	}
 	defer func() {
 		os.RemoveAll(tempDir)
@@ -1241,7 +1241,7 @@ func HandleRemoteBazel(commandLineArgs []string) (int, error) {
 		apiKey, err = login.GetAPIKey()
 		if err != nil {
 			log.Warnf("Failed to enter login flow. Manually trigger with `bb login` or add an API key to your remote bazel run with `--remote_header=x-buildbuddy-api-key=XXX`.")
-			return 1, err
+			return 1, fmt.Errorf("get api key: %w", err)
 		}
 	}
 	ctx = metadata.AppendToOutgoingContext(ctx, "x-buildbuddy-api-key", apiKey)
@@ -1266,11 +1266,11 @@ func parseArgs(commandLineArgs []string) (bazelArgs []string, execArgs []string,
 
 	bazelArgs, err = login.ConfigureAPIKey(bazelArgs)
 	if err != nil {
-		return nil, nil, err
+		return nil, nil, fmt.Errorf("configure api key: %w", err)
 	}
 	bazelArgs, err = parser.CanonicalizeArgs(bazelArgs)
 	if err != nil {
-		return nil, nil, err
+		return nil, nil, fmt.Errorf("canonicalize bazel args: %w", err)
 	}
 
 	// Ensure all bazel remote runs use the remote cache.
@@ -1349,7 +1349,7 @@ func parseRemoteCliFlags(args []string) ([]string, error) {
 					unparsedArgs = unparsedArgs[1:]
 				}
 			} else {
-				return nil, err
+				return nil, fmt.Errorf("parse remote flags: %w", err)
 			}
 		}
 	}