rename PackagePackages to InstallablePackages

Author: savil

internal/devconfig/packages.go

@@ -45,9 +45,9 @@ func (pkgs *Packages) VersionedNames() []string {
 	return result
 }
 
-func (pkgs *Packages) VersionedNamesForPlatform() []string {
+func (pkgs *Packages) VersionedNamesForPlatform() ([]string, error) {
 	// TODO savil. Next PR will update this implementation
-	return pkgs.VersionedNames()
+	return pkgs.VersionedNames(), nil
 }
 
 // Add adds a package to the list of packages

internal/impl/devbox.go

@@ -483,10 +483,12 @@ func (d *Devbox) saveCfg() error {
 }
 
 func (d *Devbox) Services() (services.Services, error) {
-	pluginSvcs, err := d.pluginManager.GetServices(
-		d.PlatformPackages(),
-		d.cfg.Include,
-	)
+	packages, err := d.InstallablePackages()
+	if err != nil {
+		return nil, err
+	}
+
+	pluginSvcs, err := d.pluginManager.GetServices(packages, d.cfg.Include)
 	if err != nil {
 		return nil, err
 	}
@@ -824,7 +826,11 @@ func (d *Devbox) computeNixEnv(ctx context.Context, usePrintDevEnvCache bool) (m
 	// We still need to be able to add env variables to non-service binaries
 	// (e.g. ruby). This would involve understanding what binaries are associated
 	// to a given plugin.
-	pluginEnv, err := d.pluginManager.Env(d.PlatformPackages(), d.cfg.Include, env)
+	installablePackages, err := d.InstallablePackages()
+	if err != nil {
+		return nil, err
+	}
+	pluginEnv, err := d.pluginManager.Env(installablePackages, d.cfg.Include, env)
 	if err != nil {
 		return nil, err
 	}
@@ -926,20 +932,13 @@ func (d *Devbox) nixFlakesFilePath() string {
 	return filepath.Join(d.projectDir, ".devbox/gen/flake/flake.nix")
 }
 
-// Refactoring steps:
-// 1. Change all users of Packages() to ConfigPackageNames() or PlatformPackageNames()
-// 2. ConfigPackages() consumes d.cfg.Packages
-// 3. Change d.cfg.Packages.VersionedNames() callers to Packages() variants
-// 3. Change ConfigPackages() consumers to ConfigPackages() or PlatformPackages()
-
 // ConfigPackageNames returns the package names as defined in devbox.json
 func (d *Devbox) ConfigPackageNames() []string {
 	return d.cfg.Packages.VersionedNames()
 }
 
-// PlatformPackageNames returns the names of packages that are to be installed
-// on the user's current platform.
-func (d *Devbox) PlatformPackageNames() []string {
+// InstallablePackageNames returns the names of packages that are to be installed
+func (d *Devbox) InstallablePackageNames() ([]string, error) {
 	// TODO: next PR replaces this implementation
 	return d.cfg.Packages.VersionedNamesForPlatform()
 }
@@ -950,9 +949,13 @@ func (d *Devbox) ConfigPackages() []*devpkg.Package {
 	return devpkg.PackageFromStrings(d.ConfigPackageNames(), d.lockfile)
 }
 
-// PlatformPackages returns the packages that are to be installed
-func (d *Devbox) PlatformPackages() []*devpkg.Package {
-	return devpkg.PackageFromStrings(d.PlatformPackageNames(), d.lockfile)
+// InstallablePackages returns the packages that are to be installed
+func (d *Devbox) InstallablePackages() ([]*devpkg.Package, error) {
+	names, err := d.InstallablePackageNames()
+	if err != nil {
+		return nil, err
+	}
+	return devpkg.PackageFromStrings(names, d.lockfile), nil
 }
 
 func (d *Devbox) Includes() []plugin.Includable {

internal/impl/packages.go

@@ -258,7 +258,11 @@ func (d *Devbox) addPackagesToProfile(ctx context.Context, mode installMode) err
 	// If packages are in profile but nixpkgs has been purged, the experience
 	// will be poor when we try to run print-dev-env. So we ensure nixpkgs is
 	// prefetched for all relevant packages (those not in binary cache).
-	for _, input := range d.PlatformPackages() {
+	installablePkgs, err := d.InstallablePackages()
+	if err != nil {
+		return err
+	}
+	for _, input := range installablePkgs {
 		if err := input.EnsureNixpkgsPrefetched(d.writer); err != nil {
 			return err
 		}
@@ -381,7 +385,11 @@ func (d *Devbox) pendingPackagesForInstallation(ctx context.Context) ([]string,
 	if err != nil {
 		return nil, err
 	}
-	for _, input := range d.PlatformPackages() {
+	installablePkgs, err := d.InstallablePackages()
+	if err != nil {
+		return nil, err
+	}
+	for _, input := range installablePkgs {
 		_, err := nixprofile.ProfileListIndex(&nixprofile.ProfileListIndexArgs{
 			List:       list,
 			Lockfile:   d.lockfile,
@@ -416,7 +424,10 @@ func (d *Devbox) extraPackagesInProfile(ctx context.Context) ([]*nixprofile.NixP
 	if err != nil {
 		return nil, err
 	}
-	devboxInputs := d.PlatformPackages()
+	devboxInputs, err := d.InstallablePackages()
+	if err != nil {
+		return nil, err
+	}
 
 	if len(devboxInputs) == len(profileItems) {
 		// Optimization: skip comparison if number of packages are the same. This only works

internal/plugin/manager.go

@@ -15,7 +15,7 @@ type Manager struct {
 }
 
 type devboxProject interface {
-	PlatformPackageNames() []string
+	InstallablePackageNames() ([]string, error)
 	ProjectDir() string
 }
 

internal/plugin/plugin.go

@@ -157,17 +157,21 @@ func (m *Manager) createFile(
 		urlForInput = pkg.URLForFlakeInput()
 	}
 
+	packages, err := m.InstallablePackageNames()
+	if err != nil {
+		return err
+	}
+
 	var buf bytes.Buffer
 	if err = tmpl.Execute(&buf, map[string]any{
 		"DevboxDir":            filepath.Join(m.ProjectDir(), devboxDirName, name),
 		"DevboxDirRoot":        filepath.Join(m.ProjectDir(), devboxDirName),
 		"DevboxProfileDefault": filepath.Join(m.ProjectDir(), nix.ProfilePath),
 		"PackageAttributePath": attributePath,
-		// TODO savil: not sure about this one.
-		"Packages":    m.PlatformPackageNames(),
-		"System":      system,
-		"URLForInput": urlForInput,
-		"Virtenv":     filepath.Join(virtenvPath, name),
+		"Packages":             packages,
+		"System":               system,
+		"URLForInput":          urlForInput,
+		"Virtenv":              filepath.Join(virtenvPath, name),
 	}); err != nil {
 		return errors.WithStack(err)
 	}

internal/shellgen/flake_plan.go

@@ -22,8 +22,13 @@ func newFlakePlan(ctx context.Context, devbox devboxer) (*flakePlan, error) {
 	ctx, task := trace.NewTask(ctx, "devboxFlakePlan")
 	defer task.End()
 
+	userPackages, err := devbox.InstallablePackages()
+	if err != nil {
+		return nil, err
+	}
+
 	// Create plugin directories first because inputs might depend on them
-	for _, pkg := range devbox.PlatformPackages() {
+	for _, pkg := range userPackages {
 		if err := devbox.PluginManager().Create(pkg); err != nil {
 			return nil, err
 		}
@@ -41,7 +46,6 @@ func newFlakePlan(ctx context.Context, devbox devboxer) (*flakePlan, error) {
 		}
 	}
 
-	userPackages := devbox.PlatformPackages()
 	pluginPackages, err := devbox.PluginManager().PluginInputs(userPackages)
 	if err != nil {
 		return nil, err

internal/shellgen/scripts.go

@@ -23,7 +23,7 @@ const HooksFilename = ".hooks"
 type devboxer interface {
 	Config() *devconfig.Config
 	Lockfile() *lock.File
-	PlatformPackages() []*devpkg.Package
+	InstallablePackages() ([]*devpkg.Package, error)
 	PluginManager() *plugin.Manager
 	ProjectDir() string
 }
@@ -42,9 +42,14 @@ func WriteScriptsToFiles(devbox devboxer) error {
 		return errors.WithStack(err)
 	}
 
+	packages, err := devbox.InstallablePackages()
+	if err != nil {
+		return err
+	}
+
 	// Write all hooks to a file.
 	written := map[string]struct{}{} // set semantics; value is irrelevant
-	pluginHooks, err := plugin.InitHooks(devbox.PlatformPackages(), devbox.ProjectDir())
+	pluginHooks, err := plugin.InitHooks(packages, devbox.ProjectDir())
 	if err != nil {
 		return errors.WithStack(err)
 	}