Better builder bob errors from supervisor

Author: filiptronicek

components/image-builder-bob/cmd/build.go

@@ -5,7 +5,9 @@
 package cmd
 
 import (
+	"errors"
 	"os"
+	"strings"
 	"time"
 
 	"github.com/spf13/cobra"
@@ -32,6 +34,14 @@ var buildCmd = &cobra.Command{
 
 		cfg, err := builder.GetConfigFromEnv()
 		if err != nil {
+			if errors.Is(err, builder.DockerfilePathNotExists) {
+				dockerfilePath := strings.TrimPrefix(os.Getenv("BOB_DOCKERFILE_PATH"), "/workspace/")
+				err = os.WriteFile("/workspace/.gitpod/bob.log", []byte("could not find Dockerfile at \""+dockerfilePath+"\". Please double-check the value specified in image.file in .gitpod.yml"), 0644)
+				if err != nil {
+					log.WithError(err).Error("cannot write init message to /workspace/.gitpod/bob.log")
+				}
+			}
+
 			log.WithError(err).Fatal("cannot get config")
 			return
 		}
@@ -43,6 +53,11 @@ var buildCmd = &cobra.Command{
 		if err != nil {
 			log.WithError(err).Error("build failed")
 
+			err := os.WriteFile("/workspace/.gitpod/bob.log", []byte(err.Error()), 0644)
+			if err != nil {
+				log.WithError(err).Error("cannot write error to /workspace/.gitpod/bob.log")
+			}
+
 			// make sure we're running long enough to have our logs read
 			if dt := time.Since(t0); dt < 5*time.Second {
 				time.Sleep(10 * time.Second)

components/image-builder-bob/pkg/builder/config.go

@@ -29,6 +29,8 @@ type Config struct {
 	localCacheImport   string
 }
 
+var DockerfilePathNotExists = xerrors.Errorf("BOB_DOCKERFILE_PATH does not exist or isn't a file")
+
 // GetConfigFromEnv extracts configuration from environment variables
 func GetConfigFromEnv() (*Config, error) {
 	cfg := &Config{
@@ -63,7 +65,7 @@ func GetConfigFromEnv() (*Config, error) {
 			return nil, xerrors.Errorf("BOB_DOCKERFILE_PATH must begin with /workspace")
 		}
 		if stat, err := os.Stat(cfg.Dockerfile); err != nil || stat.IsDir() {
-			return nil, xerrors.Errorf("BOB_DOCKERFILE_PATH does not exist or isn't a file")
+			return nil, DockerfilePathNotExists
 		}
 	}
 

components/server/src/github/file-provider.ts

@@ -32,11 +32,11 @@ export class GithubFileProvider implements FileProvider {
         const notFoundError = new Error(
             `File ${path} does not exist in repository ${repository.owner}/${repository.name}`,
         );
-        const fileExists =
-            (await this.getFileContent({ repository, revision: revisionOrBranch }, user, path)) !== undefined;
-        if (!fileExists) {
-            throw notFoundError;
-        }
+        // const fileExists =
+        //     (await this.getFileContent({ repository, revision: revisionOrBranch }, user, path)) !== undefined;
+        // if (!fileExists) {
+        //     throw notFoundError;
+        // }
 
         const commits = (
             await this.githubApi.run(user, (gh) =>

components/supervisor/pkg/supervisor/supervisor.go

@@ -1601,7 +1601,12 @@ func stopWhenTasksAreDone(wg *sync.WaitGroup, cfg *Config, shutdown chan Shutdow
 	if success.Failed() {
 		var msg []byte
 		if cfg.isImageBuild() {
-			msg = []byte("image build failed (" + string(success) + "). This is likely due to a misconfiguration in your Dockerfile. Debug this using `gp validate` (visit https://www.gitpod.io/docs/configure/workspaces#validate-your-gitpod-configuration) to learn more")
+			logFromFile, err := os.ReadFile("/workspace/.gitpod/bob.log")
+			if err != nil {
+				msg = []byte("err while reading bob.log" + err.Error())
+			} else {
+				msg = []byte("image build failed: " + string(logFromFile) + ". Debug this using `gp validate` (visit https://www.gitpod.io/docs/configure/workspaces#validate-your-gitpod-configuration) to learn more")
+			}
 		} else {
 			msg = []byte("headless task failed: " + string(success))
 		}