Moved process-compose into a generic utilities Devbox project (#2122)

## Summary
Moved process-compose into a generic utilities Devbox project.

This PR deletes `addDevboxUtilityPackage` and
`removeDevboxUtilityPackage`, since they're no longer used.

## Motivation
#2106

## How was it tested?
1. Manually deleted `~/.local/share/devbox/util` directory and verified
that it is re-created when starting a service, and that process-compose
is correctly added as a dependency with the binary present at the
expected path.
2. Ensured that `devbox services up nginx` starts the service and that
the process-compose UI is displayed correctly.

Author: josh-d2

internal/devbox/devbox.go

@@ -13,7 +13,6 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
-	"regexp"
 	"runtime/trace"
 	"slices"
 	"strconv"
@@ -24,29 +23,27 @@ import (
 	"github.com/briandowns/spinner"
 	"github.com/pkg/errors"
 	"github.com/samber/lo"
-	"go.jetpack.io/devbox/internal/cachehash"
-	"go.jetpack.io/devbox/internal/devbox/envpath"
-	"go.jetpack.io/devbox/internal/devbox/generate"
-	"go.jetpack.io/devbox/internal/devpkg"
-	"go.jetpack.io/devbox/internal/devpkg/pkgtype"
-	"go.jetpack.io/devbox/internal/searcher"
-	"go.jetpack.io/devbox/internal/shellgen"
-	"go.jetpack.io/devbox/internal/telemetry"
-	"go.jetpack.io/devbox/internal/vercheck"
-
 	"go.jetpack.io/devbox/internal/boxcli/usererr"
+	"go.jetpack.io/devbox/internal/cachehash"
 	"go.jetpack.io/devbox/internal/cmdutil"
 	"go.jetpack.io/devbox/internal/conf"
 	"go.jetpack.io/devbox/internal/debug"
 	"go.jetpack.io/devbox/internal/devbox/devopt"
+	"go.jetpack.io/devbox/internal/devbox/envpath"
+	"go.jetpack.io/devbox/internal/devbox/generate"
 	"go.jetpack.io/devbox/internal/devconfig"
+	"go.jetpack.io/devbox/internal/devpkg"
+	"go.jetpack.io/devbox/internal/devpkg/pkgtype"
 	"go.jetpack.io/devbox/internal/envir"
 	"go.jetpack.io/devbox/internal/fileutil"
 	"go.jetpack.io/devbox/internal/lock"
 	"go.jetpack.io/devbox/internal/nix"
 	"go.jetpack.io/devbox/internal/plugin"
 	"go.jetpack.io/devbox/internal/redact"
+	"go.jetpack.io/devbox/internal/searcher"
 	"go.jetpack.io/devbox/internal/services"
+	"go.jetpack.io/devbox/internal/shellgen"
+	"go.jetpack.io/devbox/internal/telemetry"
 	"go.jetpack.io/devbox/internal/ux"
 )
 
@@ -768,7 +765,12 @@ func (d *Devbox) StartProcessManager(
 		}
 	}
 
-	servicesProcessComposeOpts, err := d.configureProcessCompose(ctx, processComposeOpts)
+	err = initDevboxUtilityProject(ctx, d.stderr)
+	if err != nil {
+		return err
+	}
+
+	processComposeBinPath, err := utilityLookPath("process-compose")
 	if err != nil {
 		return err
 	}
@@ -780,55 +782,14 @@ func (d *Devbox) StartProcessManager(
 		requestedServices,
 		svcs,
 		d.projectDir,
-		*servicesProcessComposeOpts,
+		services.ProcessComposeOpts{
+			BinPath:    processComposeBinPath,
+			Background: processComposeOpts.Background,
+			ExtraFlags: processComposeOpts.ExtraFlags,
+		},
 	)
 }
 
-func (d *Devbox) configureProcessCompose(ctx context.Context, processComposeOpts devopt.ProcessComposeOpts) (*services.ProcessComposeOpts, error) {
-	processComposePath, err := utilityLookPath("process-compose")
-	if err != nil {
-		fmt.Fprintln(d.stderr, "Installing process-compose. This may take a minute but will only happen once.")
-		if err = d.addDevboxUtilityPackage(ctx, "github:F1bonacc1/process-compose/"+processComposeTargetVersion); err != nil {
-			return nil, err
-		}
-
-		// re-lookup the path to process-compose
-		processComposePath, err = utilityLookPath("process-compose")
-		if err != nil {
-			fmt.Fprintln(d.stderr, "failed to find process-compose after installing it.")
-			return nil, err
-		}
-	}
-	re := regexp.MustCompile(`(?m)Version:\s*(v\d*\.\d*\.\d*)`)
-	pcVersionString, err := exec.Command(processComposePath, "version").Output()
-	if err != nil {
-		fmt.Fprintln(d.stderr, "failed to get process-compose version")
-		return nil, err
-	}
-
-	pcVersion := re.FindStringSubmatch(strings.TrimSpace(string(pcVersionString)))[1]
-
-	if vercheck.SemverCompare(pcVersion, processComposeTargetVersion) < 0 {
-		fmt.Fprintln(d.stderr, "Upgrading process-compose to "+processComposeTargetVersion+"...")
-		oldProcessComposePkg := "github:F1bonacc1/process-compose/" + pcVersion + "#defaultPackage." + nix.System()
-		newProcessComposePkg := "github:F1bonacc1/process-compose/" + processComposeTargetVersion
-		// Find the old process Compose package
-		if err := d.removeDevboxUtilityPackage(ctx, oldProcessComposePkg); err != nil {
-			return nil, err
-		}
-
-		if err = d.addDevboxUtilityPackage(ctx, newProcessComposePkg); err != nil {
-			return nil, err
-		}
-	}
-
-	return &services.ProcessComposeOpts{
-		BinPath:    processComposePath,
-		Background: processComposeOpts.Background,
-		ExtraFlags: processComposeOpts.ExtraFlags,
-	}, nil
-}
-
 // computeEnv computes the set of environment variables that define a Devbox
 // environment. The "devbox run" and "devbox shell" commands source these
 // variables into a shell before executing a command or showing an interactive

internal/devbox/util.go

@@ -5,73 +5,65 @@ package devbox
 
 import (
 	"context"
+	"io"
 	"io/fs"
 	"os"
 	"path/filepath"
 
 	"github.com/pkg/errors"
-	"go.jetpack.io/devbox/internal/devpkg"
-	"go.jetpack.io/devbox/internal/nix"
 
+	"go.jetpack.io/devbox/internal/devbox/devopt"
 	"go.jetpack.io/devbox/internal/xdg"
 )
 
-// addDevboxUtilityPackage adds a package to the devbox utility profile.
-// It's used to install applications devbox might need, like process-compose
-// This is an alternative to a global install which would modify a user's
-// environment.
-func (d *Devbox) addDevboxUtilityPackage(ctx context.Context, pkgName string) error {
-	pkg := devpkg.PackageFromStringWithDefaults(pkgName, d.lockfile)
-	installables, err := pkg.Installables()
+const processComposeVersion = "1.5.0"
+
+var utilProjectConfigPath string
+
+func initDevboxUtilityProject(ctx context.Context, stderr io.Writer) error {
+	devboxUtilityProjectPath, err := ensureDevboxUtilityConfig()
 	if err != nil {
 		return err
 	}
-	profilePath, err := utilityNixProfilePath()
+
+	box, err := Open(&devopt.Opts{
+		Dir:    devboxUtilityProjectPath,
+		Stderr: stderr,
+	})
 	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	// Add all utilities here.
+	utilities := []string{
+		"process-compose@" + processComposeVersion,
+	}
+	if err = box.Add(ctx, utilities, devopt.AddOpts{}); err != nil {
 		return err
 	}
 
-	for _, installable := range installables {
+	return box.Install(ctx)
+}
 
-		err = nix.ProfileInstall(ctx, &nix.ProfileInstallArgs{
-			Installable: installable,
-			ProfilePath: profilePath,
-			Writer:      d.stderr,
-		})
-		if err != nil {
-			return err
-		}
+func ensureDevboxUtilityConfig() (string, error) {
+	if utilProjectConfigPath != "" {
+		return utilProjectConfigPath, nil
 	}
-	return nil
-}
 
-func (d *Devbox) removeDevboxUtilityPackage(
-	ctx context.Context, pkgName string,
-) error {
-	pkg := devpkg.PackageFromStringWithDefaults(pkgName, d.lockfile)
-	installables, err := pkg.Installables()
+	path, err := utilityDataPath()
 	if err != nil {
-		return err
+		return "", err
 	}
 
-	utilityProfilePath, err := utilityNixProfilePath()
+	_, err = InitConfig(path)
 	if err != nil {
-		return err
+		return "", err
 	}
 
-	for _, installable := range installables {
-		storePaths, err := nix.StorePathsFromInstallable(ctx, installable, false)
-		if err != nil {
-			return err
-		}
-
-		for _, storePath := range storePaths {
-			if err = nix.ProfileRemove(utilityProfilePath, storePath); err != nil {
-				return err
-			}
-		}
-	}
-	return nil
+	// Avoids unnecessarily initializing the config again by caching the path
+	utilProjectConfigPath = path
+
+	return path, nil
 }
 
 func utilityLookPath(binName string) (string, error) {
@@ -97,13 +89,14 @@ func utilityNixProfilePath() (string, error) {
 	if err != nil {
 		return "", err
 	}
-	return filepath.Join(path, "profile"), nil
+	return filepath.Join(path, ".devbox/nix/profile"), nil
 }
 
 func utilityBinPath() (string, error) {
 	nixProfilePath, err := utilityNixProfilePath()
 	if err != nil {
 		return "", err
 	}
-	return filepath.Join(nixProfilePath, "bin"), nil
+
+	return filepath.Join(nixProfilePath, "default/bin"), nil
 }