[context parser] Check current ref for Docker image existence (#20345)

* [context parser] Check current ref for Docker image existence

* Better builder bob errors from supervisor

* Gently soft-fail when the Dockerfile isn't found

* Add warning to ws metadata when starting workspace

* Introduce a magic constant instead of empty strings

* Improve supervisor failed reading bob log error

* Fixup cloning our special SHA

* idk what happened

* let workspaces start even on invalid docker refs

Author: filiptronicek

components/dashboard/src/workspaces/CreateWorkspacePage.tsx

@@ -552,6 +552,11 @@ export function CreateWorkspacePage() {
                                 <span className="text-sm">{warningIde}</span>
                             </Alert>
                         )}
+                        {workspaceContext.data?.data.metadata?.warnings.map((warning) => (
+                            <Alert type="warning" key={warning}>
+                                <span className="text-sm">{warning}</span>
+                            </Alert>
+                        )) ?? []}
 
                         <InputField>
                             <RepositoryFinder

components/gitpod-protocol/src/protocol.ts

@@ -1018,6 +1018,8 @@ export interface WorkspaceContext {
     normalizedContextURL?: string;
     forceCreateNewWorkspace?: boolean;
     forceImageBuild?: boolean;
+    // The context can have non-blocking warnings that should be displayed to the user.
+    warnings?: string[];
 }
 
 export namespace WorkspaceContext {

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/public-api/gitpod/v1/workspace.proto

@@ -316,6 +316,9 @@ message WorkspaceMetadata {
   // original_context_url is the normalized URL from which the workspace was
   // created
   string original_context_url = 7;
+
+  // warnings are user-facing warnings that should be displayed to the user when trying to start the workspace
+  repeated string warnings = 8;
 }
 
 // WorkspaceSpec specifies the configuration of a workspace for a workspace