refactor: improve dev pod context handling

Author: FabianKramm

cmd/run_pipeline.go

@@ -374,8 +374,12 @@ func runPipeline(ctx *devspacecontext.Context, f factory.Factory, forceLeader bo
 		ctx.Log.Debugf("Run pipeline:\n%s\n", string(configPipelineBytes))
 	}
 
+	// create dev context
+	devCtxCancel, cancelDevCtx := context.WithCancel(ctx.Context)
+	ctx = ctx.WithContext(values.WithDevContext(ctx.Context, devCtxCancel))
+
 	// create a new base dev pod manager
-	devPodManager := devpod.NewManager(ctx.Context)
+	devPodManager := devpod.NewManager(cancelDevCtx)
 	defer devPodManager.Close()
 
 	// create dependency registry

pkg/devspace/context/values/values.go

@@ -12,8 +12,20 @@ const (
 	commandKey
 	dependencyKey
 	rootNameKey
+	devContextKey
 )
 
+// WithDevContext creates a new context with the dev context
+func WithDevContext(parent context.Context, devCtx context.Context) context.Context {
+	return WithValue(parent, devContextKey, devCtx)
+}
+
+// DevContextFrom returns a context used to start and stop dev configurations
+func DevContextFrom(ctx context.Context) (context.Context, bool) {
+	devCtx, ok := ctx.Value(devContextKey).(context.Context)
+	return devCtx, ok
+}
+
 // RootNameFrom returns the root name of the devspace config
 func RootNameFrom(ctx context.Context) (string, bool) {
 	user, ok := ctx.Value(rootNameKey).(string)

pkg/devspace/devpod/manager.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"github.com/loft-sh/devspace/pkg/devspace/config/versions/latest"
 	devspacecontext "github.com/loft-sh/devspace/pkg/devspace/context"
+	"github.com/loft-sh/devspace/pkg/devspace/context/values"
 	"github.com/loft-sh/devspace/pkg/devspace/deploy"
 	"github.com/loft-sh/devspace/pkg/devspace/services/podreplace"
 	"github.com/loft-sh/devspace/pkg/util/lockfactory"
@@ -41,9 +42,6 @@ type Manager interface {
 	// Close will close the manager and wait for all dev pods to stop
 	Close()
 
-	// Context returns the context of the DevManager
-	Context() context.Context
-
 	// Wait will wait until all DevPods are stopped
 	Wait() error
 }
@@ -52,15 +50,12 @@ type devPodManager struct {
 	lockFactory lockfactory.LockFactory
 
 	m       sync.Mutex
-	ctx     context.Context
 	cancels []context.CancelFunc
 	devPods map[string]*devPod
 }
 
-func NewManager(ctx context.Context) Manager {
-	ctx, cancel := context.WithCancel(ctx)
+func NewManager(cancel context.CancelFunc) Manager {
 	return &devPodManager{
-		ctx:         ctx,
 		cancels:     []context.CancelFunc{cancel},
 		lockFactory: lockfactory.NewDefaultLockFactory(),
 		devPods:     map[string]*devPod{},
@@ -86,21 +81,18 @@ func (d *devPodManager) Close() {
 	}
 	d.cancels = []context.CancelFunc{}
 	d.m.Unlock()
-	d.Wait()
-}
-
-func (d *devPodManager) Context() context.Context {
-	return d.ctx
+	_ = d.Wait()
 }
 
 func (d *devPodManager) StartMultiple(ctx *devspacecontext.Context, devPods []string, options Options) error {
+	devCtx, _ := values.DevContextFrom(ctx.Context)
 	select {
-	case <-d.ctx.Done():
-		return d.ctx.Err()
+	case <-devCtx.Done():
+		return devCtx.Err()
 	default:
 	}
 
-	cancelCtx, cancel := context.WithCancel(d.ctx)
+	cancelCtx, cancel := context.WithCancel(devCtx)
 	d.m.Lock()
 	d.cancels = append(d.cancels, cancel)
 	d.m.Unlock()
@@ -174,16 +166,17 @@ func (d *devPodManager) Start(originalContext *devspacecontext.Context, devPodCo
 	var dp *devPod
 	d.m.Lock()
 	dp = d.devPods[devPodConfig.Name]
-	d.m.Unlock()
-
-	// check if already running
 	if dp != nil {
-		return nil, DevPodAlreadyExists{}
+		select {
+		case <-dp.Done():
+		default:
+			d.m.Unlock()
+			return nil, DevPodAlreadyExists{}
+		}
 	}
 
 	// create a new dev pod
 	dp = newDevPod()
-	d.m.Lock()
 	d.devPods[devPodConfig.Name] = dp
 	d.m.Unlock()
 

pkg/devspace/pipeline/pipeline.go

@@ -1,6 +1,7 @@
 package pipeline
 
 import (
+	"context"
 	"fmt"
 	"github.com/loft-sh/devspace/pkg/devspace/context/values"
 	utilerrors "k8s.io/apimachinery/pkg/util/errors"
@@ -205,7 +206,10 @@ func (p *pipeline) startNewDependency(ctx *devspacecontext.Context, dependency t
 		pipelineConfig = dependency.Config().Config().Pipelines[executePipeline]
 	}
 
-	dependencyDevPodManager := devpod.NewManager(p.devPodManager.Context())
+	devCtx, _ := values.DevContextFrom(ctx.Context)
+	devCtxCancel, cancelDevCtx := context.WithCancel(devCtx)
+	ctx = ctx.WithContext(values.WithDevContext(ctx.Context, devCtxCancel))
+	dependencyDevPodManager := devpod.NewManager(cancelDevCtx)
 	pip := NewPipeline(dependency.Name(), dependencyDevPodManager, p.dependencyRegistry, pipelineConfig, p.options)
 	pip.(*pipeline).parent = p
 

pkg/devspace/services/sync/sync.go

@@ -81,19 +81,19 @@ func StartSync(ctx *devspacecontext.Context, devPod *latest.DevPod, selector tar
 		for _, syncConfig := range devContainer.Sync {
 			// start a new go routine in the tomb
 			s := syncConfig
+			syncCtx := ctx
 			var cancel context.CancelFunc
 			if s.NoWatch {
 				var cancelCtx context.Context
-				cancelCtx, cancel = context.WithCancel(ctx.Context)
-				defer cancel()
-				ctx = ctx.WithContext(cancelCtx)
+				cancelCtx, cancel = context.WithCancel(syncCtx.Context)
+				syncCtx = syncCtx.WithContext(cancelCtx)
 			}
 			initDone := parent.NotifyGo(func() error {
 				if cancel != nil {
 					defer cancel()
 				}
 
-				return startSync(ctx, devPod.Name, string(devContainer.Arch), s, selector.WithContainer(devContainer.Container), starter, parent)
+				return startSync(syncCtx, devPod.Name, string(devContainer.Arch), s, selector.WithContainer(devContainer.Container), starter, parent)
 			})
 			initDoneArray = append(initDoneArray, initDone)
 

pkg/util/yamlutil/yaml.go

@@ -38,6 +38,7 @@ func prettifyError(data []byte, err error) error {
 	if typeError, ok := err.(*yaml.TypeError); ok {
 		for i, message := range typeError.Errors {
 			typeError.Errors[i] = strings.Replace(message, "!!seq", "an array", -1)
+			typeError.Errors[i] = strings.Replace(message, "!!str", "string", -1)
 
 			// add line to error
 			match := lineRegEx.FindSubmatch([]byte(message))