Use checkout location during content init

Author: Furisto

components/content-service/pkg/initializer/initializer.go

@@ -516,3 +516,22 @@ func PlaceWorkspaceReadyFile(ctx context.Context, wspath string, initsrc csapi.W
 
 	return nil
 }
+
+func GetCheckoutLocationFromInitializer(init *csapi.WorkspaceInitializer) string {
+	switch {
+	case init.GetGit() != nil:
+		return init.GetGit().CheckoutLocation
+	case init.GetPrebuild() != nil && len(init.GetPrebuild().Git) > 0:
+		return init.GetPrebuild().Git[0].CheckoutLocation
+	case init.GetBackup() != nil:
+		return init.GetBackup().CheckoutLocation
+	case init.GetComposite() != nil:
+		for _, c := range init.GetComposite().Initializer {
+			loc := GetCheckoutLocationFromInitializer(c)
+			if loc != "" {
+				return loc
+			}
+		}
+	}
+	return ""
+}

components/ws-daemon/pkg/content/service.go

@@ -253,7 +253,7 @@ func (s *WorkspaceService) creator(req *api.InitWorkspaceRequest) session.Worksp
 	return func(ctx context.Context, location string) (res *session.Workspace, err error) {
 		return &session.Workspace{
 			Location:              location,
-			CheckoutLocation:      getCheckoutLocation(req),
+			CheckoutLocation:      wsinit.GetCheckoutLocationFromInitializer(req.Initializer),
 			CreatedAt:             time.Now(),
 			Owner:                 req.Metadata.Owner,
 			WorkspaceID:           req.Metadata.MetaId,
@@ -273,24 +273,6 @@ func ServiceDirName(instanceID string) string {
 	return instanceID + "-daemon"
 }
 
-// getCheckoutLocation returns the first checkout location found of any Git initializer configured by this request
-func getCheckoutLocation(req *api.InitWorkspaceRequest) string {
-	spec := req.Initializer.Spec
-	if ir, ok := spec.(*csapi.WorkspaceInitializer_Git); ok {
-		if ir.Git != nil {
-			return ir.Git.CheckoutLocation
-		}
-	}
-	if ir, ok := spec.(*csapi.WorkspaceInitializer_Prebuild); ok {
-		if ir.Prebuild != nil {
-			if len(ir.Prebuild.Git) > 0 {
-				return ir.Prebuild.Git[0].CheckoutLocation
-			}
-		}
-	}
-	return ""
-}
-
 // DisposeWorkspace cleans up a workspace, possibly after taking a final backup
 func (s *WorkspaceService) DisposeWorkspace(ctx context.Context, req *api.DisposeWorkspaceRequest) (resp *api.DisposeWorkspaceResponse, err error) {
 	//nolint:ineffassign

components/ws-daemon/pkg/internal/session/workspace.go

@@ -268,7 +268,7 @@ func (s *Workspace) UpdateGitStatus(ctx context.Context) (res *csapi.GitStatus,
 
 	loc = filepath.Join(loc, s.CheckoutLocation)
 	if !git.IsWorkingCopy(loc) {
-		log.WithField("loc", loc).WithFields(s.OWI()).Debug("did not find a Git working copy - not updating Git status")
+		log.WithField("loc", loc).WithField("checkout location", s.CheckoutLocation).WithFields(s.OWI()).Debug("did not find a Git working copy - not updating Git status")
 		return nil, nil
 	}
 

components/ws-manager/pkg/manager/create.go

@@ -27,7 +27,7 @@ import (
 	"github.com/gitpod-io/gitpod/common-go/kubernetes"
 	wsk8s "github.com/gitpod-io/gitpod/common-go/kubernetes"
 	"github.com/gitpod-io/gitpod/common-go/tracing"
-	csapi "github.com/gitpod-io/gitpod/content-service/api"
+	content "github.com/gitpod-io/gitpod/content-service/pkg/initializer"
 	regapi "github.com/gitpod-io/gitpod/registry-facade/api"
 	"github.com/gitpod-io/gitpod/ws-manager/api"
 	config "github.com/gitpod-io/gitpod/ws-manager/api/config"
@@ -608,9 +608,11 @@ func (m *Manager) createWorkspaceEnvironment(startContext *startWorkspaceContext
 		return filepath.Join("/workspace", strings.TrimPrefix(segment, "/workspace"))
 	}
 
+	repoRoot := content.GetCheckoutLocationFromInitializer(spec.Initializer)
+
 	// Envs that start with GITPOD_ are appended to the Terminal environments
 	result := []corev1.EnvVar{}
-	result = append(result, corev1.EnvVar{Name: "GITPOD_REPO_ROOT", Value: getWorkspaceRelativePath(startContext.CheckoutLocation)})
+	result = append(result, corev1.EnvVar{Name: "GITPOD_REPO_ROOT", Value: getWorkspaceRelativePath(repoRoot)})
 	result = append(result, corev1.EnvVar{Name: "GITPOD_CLI_APITOKEN", Value: startContext.CLIAPIKey})
 	result = append(result, corev1.EnvVar{Name: "GITPOD_WORKSPACE_ID", Value: startContext.Request.Metadata.MetaId})
 	result = append(result, corev1.EnvVar{Name: "GITPOD_INSTANCE_ID", Value: startContext.Request.Id})
@@ -743,25 +745,6 @@ func (m *Manager) createDefaultSecurityContext() (*corev1.SecurityContext, error
 	return res, nil
 }
 
-func getCheckoutLocationFromInitializer(init *csapi.WorkspaceInitializer) string {
-	switch {
-	case init.GetGit() != nil:
-		return init.GetGit().CheckoutLocation
-	case init.GetPrebuild() != nil && len(init.GetPrebuild().Git) > 0:
-		return init.GetPrebuild().Git[0].CheckoutLocation
-	case init.GetBackup() != nil:
-		return init.GetBackup().CheckoutLocation
-	case init.GetComposite() != nil:
-		for _, c := range init.GetComposite().Initializer {
-			loc := getCheckoutLocationFromInitializer(c)
-			if loc != "" {
-				return loc
-			}
-		}
-	}
-	return ""
-}
-
 func (m *Manager) newStartWorkspaceContext(ctx context.Context, req *api.StartWorkspaceRequest) (res *startWorkspaceContext, err error) {
 	// we deliberately do not shadow ctx here as we need the original context later to extract the TraceID
 	span, ctx := tracing.FromContext(ctx, "newStartWorkspaceContext")
@@ -802,15 +785,14 @@ func (m *Manager) newStartWorkspaceContext(ctx context.Context, req *api.StartWo
 			headlessLabel:          fmt.Sprintf("%v", headless),
 			markerLabel:            "true",
 		},
-		CLIAPIKey:        cliAPIKey,
-		OwnerToken:       ownerToken,
-		Request:          req,
-		IDEPort:          23000,
-		SupervisorPort:   22999,
-		WorkspaceURL:     workspaceURL,
-		TraceID:          traceID,
-		Headless:         headless,
-		CheckoutLocation: getCheckoutLocationFromInitializer(req.Spec.Initializer),
+		CLIAPIKey:      cliAPIKey,
+		OwnerToken:     ownerToken,
+		Request:        req,
+		IDEPort:        23000,
+		SupervisorPort: 22999,
+		WorkspaceURL:   workspaceURL,
+		TraceID:        traceID,
+		Headless:       headless,
 	}, nil
 }
 

components/ws-manager/pkg/manager/manager.go

@@ -68,16 +68,15 @@ type Manager struct {
 }
 
 type startWorkspaceContext struct {
-	Request          *api.StartWorkspaceRequest `json:"request"`
-	Labels           map[string]string          `json:"labels"`
-	CLIAPIKey        string                     `json:"cliApiKey"`
-	OwnerToken       string                     `json:"ownerToken"`
-	IDEPort          int32                      `json:"idePort"`
-	SupervisorPort   int32                      `json:"supervisorPort"`
-	WorkspaceURL     string                     `json:"workspaceURL"`
-	TraceID          string                     `json:"traceID"`
-	Headless         bool                       `json:"headless"`
-	CheckoutLocation string                     `json:"checkoutLocation"`
+	Request        *api.StartWorkspaceRequest `json:"request"`
+	Labels         map[string]string          `json:"labels"`
+	CLIAPIKey      string                     `json:"cliApiKey"`
+	OwnerToken     string                     `json:"ownerToken"`
+	IDEPort        int32                      `json:"idePort"`
+	SupervisorPort int32                      `json:"supervisorPort"`
+	WorkspaceURL   string                     `json:"workspaceURL"`
+	TraceID        string                     `json:"traceID"`
+	Headless       bool                       `json:"headless"`
 }
 
 const (