Suggest extra packages that the users may need

jetify-com · LucilleH · Oct 17, 2022 · Oct 7, 2022 · Oct 10, 2022 · Oct 13, 2022
commit ba4a3b7561ea901529c9084b89d7bd491dc105ab
diff --git a/devbox.go b/devbox.go
@@ -153,8 +153,9 @@ func (d *Devbox) Build(flags *docker.BuildFlags) error {
 // Plan creates a plan of the actions that devbox will take to generate its
 // shell environment.
 func (d *Devbox) ShellPlan() *plansdk.ShellPlan {
-	shellPlan := planner.GetShellPlan(d.srcDir, d.cfg.Packages)
-	shellPlan.DevPackages = d.cfg.Packages
+	userDefinedPkgs := d.cfg.Packages
+	shellPlan := planner.GetShellPlan(d.srcDir, userDefinedPkgs)
+	shellPlan.DevPackages = userDefinedPkgs
 
 	return shellPlan
 }
@@ -195,17 +196,29 @@ func (d *Devbox) Shell() error {
 	}
 
 	nixShellFilePath := filepath.Join(d.srcDir, ".devbox/gen/shell.nix")
-	sh, err := nix.DetectShell(
+	shell, err := nix.DetectShell(
 		nix.WithPlanInitHook(strings.Join(plan.ShellInitHook, "\n")),
 		nix.WithProfile(profileDir),
 		nix.WithHistoryFile(filepath.Join(d.srcDir, shellHistoryFile)),
 	)
 	if err != nil {
 		// Fall back to using a plain Nix shell.
-		sh = &nix.Shell{}
+		shell = &nix.Shell{}
 	}
-	sh.UserInitHook = d.cfg.Shell.InitHook.String()
-	return sh.Run(nixShellFilePath)
+
+	allPkgs := planner.GetShellPackageSuggestion(d.srcDir, d.cfg.Packages)
+	pkgsToSuggest, _ := lo.Difference(allPkgs, d.cfg.Packages)
+	if len(pkgsToSuggest) > 0 {
+		s := fmt.Sprintf("devbox add %s", strings.Join(pkgsToSuggest, " "))
+		fmt.Fprintf(
+			d.writer,
+			"We detected extra packages you may need. To install them, run `%s`\n",
+			color.HiYellowString(s),
+		)
+	}
+
+	shell.UserInitHook = d.cfg.Shell.InitHook.String()
+	return shell.Run(nixShellFilePath)
 }
 
 func (d *Devbox) Exec(cmds ...string) error {

diff --git a/pkgslice/slice.go b/pkgslice/slice.go
@@ -30,17 +30,3 @@ func Exclude(s []string, elems []string) []string {
 	}
 	return filtered
 }
-
-// returns true when superset includes all elements from subset.
-func Contains(superset []string, subset []string) bool {
-	sMap := make(map[string]bool, len(superset))
-	for _, str := range superset {
-		sMap[str] = true
-	}
-	for _, e := range subset {
-		if _, ok := sMap[e]; !ok {
-			return false
-		}
-	}
-	return true
-}
diff --git a/planner/languages/dotnet/dotnet_planner.go b/planner/languages/dotnet/dotnet_planner.go
@@ -45,7 +45,17 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 }
 
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
-	return &plansdk.ShellPlan{}
+	proj, err := project(srcDir)
+	if err != nil {
+		return &plansdk.ShellPlan{}
+	}
+	dotNetPkg, err := dotNetNixPackage(proj)
+	if err != nil {
+		return &plansdk.ShellPlan{}
+	}
+	return &plansdk.ShellPlan{
+		DevPackages: []string{dotNetPkg},
+	}
 }
 
 func (p *Planner) GetBuildPlan(srcDir string) *plansdk.BuildPlan {

diff --git a/planner/languages/golang/golang_planner.go b/planner/languages/golang/golang_planner.go
@@ -37,7 +37,11 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 }
 
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
-	return &plansdk.ShellPlan{}
+	goPkg := getGoPackage(srcDir)
+
+	return &plansdk.ShellPlan{
+		DevPackages: []string{goPkg},
+	}
 }
 
 func (p *Planner) GetBuildPlan(srcDir string) *plansdk.BuildPlan {

diff --git a/planner/languages/haskell/haskell_planner.go b/planner/languages/haskell/haskell_planner.go
@@ -49,7 +49,9 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 }
 
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
-	return &plansdk.ShellPlan{}
+	return &plansdk.ShellPlan{
+		DevPackages: []string{"stack", "libiconv", "libffi", "binutils", "ghc"},
+	}
 }
 
 func (p *Planner) GetBuildPlan(srcDir string) *plansdk.BuildPlan {

diff --git a/planner/languages/java/java_planner.go b/planner/languages/java/java_planner.go
@@ -57,7 +57,18 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 }
 
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
-	return &plansdk.ShellPlan{}
+	builderTool, err := p.packageManager(srcDir)
+	if err != nil {
+		return &plansdk.ShellPlan{}
+	}
+	devPackages, err := p.devPackages(srcDir, builderTool)
+	if err != nil {
+		return &plansdk.ShellPlan{}
+	}
+
+	return &plansdk.ShellPlan{
+		DevPackages: devPackages,
+	}
 }
 
 func (p *Planner) GetBuildPlan(srcDir string) *plansdk.BuildPlan {

diff --git a/planner/languages/javascript/nodejs_planner.go b/planner/languages/javascript/nodejs_planner.go
@@ -26,7 +26,13 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 }
 
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
-	return &plansdk.ShellPlan{}
+	pkgManager := p.packageManager(srcDir)
+	project := p.nodeProject(srcDir)
+	packages := p.packages(pkgManager, project)
+
+	return &plansdk.ShellPlan{
+		DevPackages: packages,
+	}
 }
 
 func (p *Planner) GetBuildPlan(srcDir string) *plansdk.BuildPlan {

diff --git a/planner/languages/nginx/nginx_planner.go b/planner/languages/nginx/nginx_planner.go
@@ -29,6 +29,10 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
 	return &plansdk.ShellPlan{
+		DevPackages: []string{
+			"nginx",
+			"shell-nginx",
+		},
 		Definitions: []string{
 			fmt.Sprintf(nginxShellStartScript, srcDir, p.shellConfig(srcDir)),
 		},

diff --git a/planner/languages/php/php_planner.go b/planner/languages/php/php_planner.go
@@ -44,6 +44,10 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
 	v := p.version(srcDir)
 	return &plansdk.ShellPlan{
+		DevPackages: []string{
+			fmt.Sprintf("php%s", v.MajorMinorConcatenated()),
+			fmt.Sprintf("php%sPackages.composer", v.MajorMinorConcatenated()),
+		},
 		Definitions: p.definitions(srcDir, v),
 	}
 }

diff --git a/planner/languages/python/python_pip_planner.go b/planner/languages/python/python_pip_planner.go
@@ -32,6 +32,9 @@ func (p *PIPPlanner) IsRelevant(srcDir string) bool {
 
 func (p *PIPPlanner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
 	return &plansdk.ShellPlan{
+		DevPackages: []string{
+			"python3",
+		},
 		ShellInitHook: []string{p.shellInitHook(srcDir)},
 	}
 }

diff --git a/planner/languages/python/python_poetry_planner.go b/planner/languages/python/python_poetry_planner.go
@@ -31,7 +31,15 @@ func (p *PoetryPlanner) IsRelevant(srcDir string) bool {
 }
 
 func (p *PoetryPlanner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
-	return &plansdk.ShellPlan{}
+	version := p.PythonVersion(srcDir)
+	pythonPkg := fmt.Sprintf("python%s", version.MajorMinorConcatenated())
+
+	return &plansdk.ShellPlan{
+		DevPackages: []string{
+			pythonPkg,
+			"poetry",
+		},
+	}
 }
 
 func (p *PoetryPlanner) GetBuildPlan(srcDir string) *plansdk.BuildPlan {

diff --git a/planner/languages/ruby/ruby_planner.go b/planner/languages/ruby/ruby_planner.go
@@ -36,7 +36,19 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 }
 
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
+	gemfile := filepath.Join(srcDir, "Gemfile")
+	v := parseRubyVersion(gemfile)
+	pkg, ok := nixPackages[semver.MajorMinor(v)]
+	if !ok {
+		pkg = defaultPkg
+	}
+
 	return &plansdk.ShellPlan{
+		DevPackages: []string{
+			pkg,
+			"gcc",     // for rails
+			"gnumake", // for rails
+		},
 		ShellInitHook: []string{plansdk.WelcomeMessage(
 			"It looks like you are developing a Ruby project.\n" +
 				"To keep dependencies isolated, it is recommended that you install them in deployment mode, by running:\n" +

diff --git a/planner/languages/rust/rust_planner.go b/planner/languages/rust/rust_planner.go
@@ -33,9 +33,22 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 }
 
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
-	return &plansdk.ShellPlan{
+	plan := &plansdk.ShellPlan{
 		NixOverlays: []string{RustOxalicaOverlay},
 	}
+	manifest, err := p.cargoManifest(srcDir)
+	if err != nil {
+		return plan
+	}
+	rustVersion, err := p.rustOxalicaVersion(manifest)
+	if err != nil {
+		return plan
+	}
+
+	rustPkgDev := fmt.Sprintf("rust-bin.stable.%s.default", rustVersion)
+	plan.DevPackages = []string{rustPkgDev, "gcc"}
+
+	return plan
 }
 
 func (p *Planner) GetBuildPlan(srcDir string) *plansdk.BuildPlan {

diff --git a/planner/languages/zig/zig_planner.go b/planner/languages/zig/zig_planner.go
@@ -31,7 +31,9 @@ func (p *Planner) IsRelevant(srcDir string) bool {
 }
 
 func (p *Planner) GetShellPlan(srcDir string) *plansdk.ShellPlan {
-	return &plansdk.ShellPlan{}
+	return &plansdk.ShellPlan{
+		DevPackages: []string{"zig"},
+	}
 }
 
 func (p *Planner) GetBuildPlan(srcDir string) *plansdk.BuildPlan {

diff --git a/planner/planner.go b/planner/planner.go
@@ -4,8 +4,8 @@
 package planner
 
 import (
+	"github.com/samber/lo"
 	"go.jetpack.io/devbox/boxcli/usererr"
-	"go.jetpack.io/devbox/pkgslice"
 	"go.jetpack.io/devbox/planner/languages/c"
 	"go.jetpack.io/devbox/planner/languages/clojure"
 	"go.jetpack.io/devbox/planner/languages/cplusplus"
@@ -69,27 +69,43 @@ var PLANNERS = []plansdk.Planner{
 	&zig.Planner{},
 }
 
-// Return a merged shell plan from all planners.
+// Return a merged shell plan from shell planners if user defined packages
+// contain one or more dev packages from a shell planner.
 func GetShellPlan(srcDir string, userPkgs []string) *plansdk.ShellPlan {
 	result := &plansdk.ShellPlan{}
 	planners := getRelevantPlanners(srcDir)
 	for _, p := range planners {
-		if pkgslice.Contains(userPkgs, p.GetShellPlan(srcDir).DevPackages) {
+		pkgs := p.GetShellPlan(srcDir).DevPackages
+		mutualPkgs := lo.Intersect(userPkgs, pkgs)
+		// Only apply shell plan if user packages list all the packages from shell plan.
+		if len(mutualPkgs) == len(pkgs) {
 			// if merge fails, we return no errors for now.
 			result, _ = plansdk.MergeShellPlans(result, p.GetShellPlan(srcDir))
 		}
 	}
 	return result
 }
 
+// Return a merged shell plan from all planners.
+func GetShellPackageSuggestion(srcDir string, userPkgs []string) []string {
+	result := &plansdk.ShellPlan{}
+	planners := getRelevantPlanners(srcDir)
+	for _, p := range planners {
+		result, _ = plansdk.MergeShellPlans(result, p.GetShellPlan(srcDir))
+	}
+
+	return result.DevPackages
+}
+
 // Return one buildable plan from all planners.
 // If no buildable plan is found, return errors from the first unbuildable plan.
 func GetBuildPlan(srcDir string, userPkgs []string) (*plansdk.BuildPlan, error) {
 	buildables := []*plansdk.BuildPlan{}
 	unbuildables := []*plansdk.BuildPlan{}
 	for _, p := range getRelevantPlanners(srcDir) {
 		plan := p.GetBuildPlan(srcDir)
-		if pkgslice.Contains(userPkgs, plan.DevPackages) {
+		mutualPkgs := lo.Intersect(userPkgs, plan.DevPackages)
+		if len(mutualPkgs) > 0 {
 			if !plan.Invalid() {
 				buildables = append(buildables, plan)
 			} else {

diff --git a/planner/plansdk/plansdk.go b/planner/plansdk/plansdk.go
@@ -78,10 +78,9 @@ type Planner interface {
 	GetShellPlan(srcDir string) *ShellPlan
 }
 
-// MergePlans merges multiple Plans into one. The merged plan's packages, definitions,
+// MergeShellPlans merges multiple Plans into one. The merged plan's packages, definitions,
 // and overlays is the union of the packages, definitions, and overlays of the input plans,
-// respectively. The install/build/start stages of the merged plans are taken from the _first_
-// buildable plan (order matters!). If no plan is buildable, returns a non-buildable plan.
+// respectively.
 func MergeShellPlans(plans ...*ShellPlan) (*ShellPlan, error) {
 	shellPlan := &ShellPlan{}
 	for _, p := range plans {
@@ -91,6 +90,7 @@ func MergeShellPlans(plans ...*ShellPlan) (*ShellPlan, error) {
 		}
 	}
 
+	shellPlan.DevPackages = pkgslice.Unique(shellPlan.DevPackages)
 	shellPlan.Definitions = pkgslice.Unique(shellPlan.Definitions)
 	shellPlan.NixOverlays = pkgslice.Unique(shellPlan.NixOverlays)
 	shellPlan.ShellInitHook = pkgslice.Unique(shellPlan.ShellInitHook)
@@ -159,8 +159,7 @@ func MergeUserBuildPlan(userPlan *BuildPlan, automatedPlan *BuildPlan) (*BuildPl
 	}
 	// Merging devPackages and runtimePackages fields.
 	packagesPlan := &BuildPlan{
-		DevPackages:     append([]string{}, userPlan.DevPackages...),
-		RuntimePackages: []string{},
+		DevPackages: append([]string{}, userPlan.DevPackages...),
 	}
 	err := mergo.Merge(packagesPlan, automatedPlan, mergo.WithAppendSlice)
 	if err != nil {

diff --git a/planner/plansdk/plansdk_test.go b/planner/plansdk/plansdk_test.go
@@ -12,6 +12,7 @@ import (
 func TestMergeShellPlans(t *testing.T) {
 	plan1 := &ShellPlan{}
 	plan2 := &ShellPlan{
+		DevPackages:   []string{},
 		Definitions:   []string{"a"},
 		NixOverlays:   []string{"b"},
 		ShellInitHook: []string{"a", "b"},
@@ -36,6 +37,7 @@ func TestMergeShellPlans(t *testing.T) {
 		ShellInitHook: []string{"a", "b"},
 	}
 	expected = &ShellPlan{
+		DevPackages:   []string{},
 		Definitions:   []string{"a"},
 		NixOverlays:   []string{"b", "a"},
 		ShellInitHook: []string{"c", "a", "b"},
@@ -59,6 +61,7 @@ func TestMergeShellPlans(t *testing.T) {
 		},
 	}
 	expected = &ShellPlan{
+		DevPackages:   []string{},
 		Definitions:   []string{},
 		NixOverlays:   []string{},
 		ShellInitHook: []string{},