fix: passing context into packager (#3303)

Signed-off-by: Austin Abro <[email protected]>
zarf-dev · Dec 9, 2024 · 8ae4946 · 8ae4946
1 parent 610013d
commit 8ae4946
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 12 deletions.
diff --git a/src/cmd/dev.go b/src/cmd/dev.go
@@ -57,7 +57,7 @@ var devDeployCmd = &cobra.Command{
 		pkgConfig.PkgOpts.SetVariables = helpers.TransformAndMergeMap(
 			v.GetStringMapString(common.VPkgDeploySet), pkgConfig.PkgOpts.SetVariables, strings.ToUpper)
 
-		pkgClient, err := packager.New(&pkgConfig)
+		pkgClient, err := packager.New(&pkgConfig, packager.WithContext(ctx))
 		if err != nil {
 			return err
 		}
@@ -87,7 +87,7 @@ var devGenerateCmd = &cobra.Command{
 		pkgConfig.CreateOpts.BaseDir = "."
 		pkgConfig.FindImagesOpts.RepoHelmChartPath = pkgConfig.GenerateOpts.GitPath
 
-		pkgClient, err := packager.New(&pkgConfig)
+		pkgClient, err := packager.New(&pkgConfig, packager.WithContext(cmd.Context()))
 		if err != nil {
 			return err
 		}
@@ -252,7 +252,7 @@ var devFindImagesCmd = &cobra.Command{
 			v.GetStringMapString(common.VPkgCreateSet), pkgConfig.CreateOpts.SetVariables, strings.ToUpper)
 		pkgConfig.PkgOpts.SetVariables = helpers.TransformAndMergeMap(
 			v.GetStringMapString(common.VPkgDeploySet), pkgConfig.PkgOpts.SetVariables, strings.ToUpper)
-		pkgClient, err := packager.New(&pkgConfig)
+		pkgClient, err := packager.New(&pkgConfig, packager.WithContext(cmd.Context()))
 		if err != nil {
 			return err
 		}

diff --git a/src/cmd/initialize.go b/src/cmd/initialize.go
@@ -61,7 +61,7 @@ var initCmd = &cobra.Command{
 		pkgConfig.PkgOpts.SetVariables = helpers.TransformAndMergeMap(
 			v.GetStringMapString(common.VPkgDeploySet), pkgConfig.PkgOpts.SetVariables, strings.ToUpper)
 
-		pkgClient, err := packager.New(&pkgConfig, packager.WithSource(src))
+		pkgClient, err := packager.New(&pkgConfig, packager.WithSource(src), packager.WithContext(ctx))
 		if err != nil {
 			return err
 		}

diff --git a/src/cmd/package.go b/src/cmd/package.go
@@ -110,7 +110,7 @@ var packageDeployCmd = &cobra.Command{
 		pkgConfig.PkgOpts.SetVariables = helpers.TransformAndMergeMap(
 			v.GetStringMapString(common.VPkgDeploySet), pkgConfig.PkgOpts.SetVariables, strings.ToUpper)
 
-		pkgClient, err := packager.New(&pkgConfig)
+		pkgClient, err := packager.New(&pkgConfig, packager.WithContext(cmd.Context()))
 		if err != nil {
 			return err
 		}
@@ -360,7 +360,7 @@ var packagePublishCmd = &cobra.Command{
 
 		pkgConfig.PublishOpts.PackageDestination = ref.String()
 
-		pkgClient, err := packager.New(&pkgConfig)
+		pkgClient, err := packager.New(&pkgConfig, packager.WithContext(cmd.Context()))
 		if err != nil {
 			return err
 		}

diff --git a/src/pkg/packager/common.go b/src/pkg/packager/common.go
@@ -32,6 +32,7 @@ import (
 
 // Packager is the main struct for managing packages.
 type Packager struct {
+	// NOTE(mkcp): Storing ctx on structs is not recommended, but this is intended as a temporary workaround.
 	ctx            context.Context
 	cfg            *types.PackagerConfig
 	variableConfig *variables.VariableConfig

diff --git a/src/types/packager.go b/src/types/packager.go
@@ -5,17 +5,11 @@
 package types
 
 import (
-	"context"
-
 	"github.com/zarf-dev/zarf/src/api/v1alpha1"
 )
 
 // PackagerConfig is the main struct that the packager uses to hold high-level options.
 type PackagerConfig struct {
-	// Context provides deadlines, cancellations, and values throughout the API.
-	// NOTE(mkcp): Storing ctx on structs is not recommended, but this is intended as a temporary workaround.
-	Context context.Context
-
 	// CreateOpts tracks the user-defined options used to create the package
 	CreateOpts ZarfCreateOptions