rename back to ensurePackagesAreInstalled

Author: savil

internal/impl/devbox.go

@@ -257,7 +257,7 @@ func (d *Devbox) Install(ctx context.Context) error {
 	ctx, task := trace.NewTask(ctx, "devboxInstall")
 	defer task.End()
 
-	return d.ensureDevboxEnvIsUpToDate(ctx, ensure)
+	return d.ensurePackagesAreInstalled(ctx, ensure)
 }
 
 func (d *Devbox) ListScripts() []string {
@@ -475,7 +475,7 @@ func (d *Devbox) GenerateEnvrcFile(ctx context.Context, force bool, envFlags dev
 	}
 
 	// generate all shell files to ensure we can refer to them in the .envrc script
-	if err := d.ensureDevboxEnvIsUpToDate(ctx, ensure); err != nil {
+	if err := d.ensurePackagesAreInstalled(ctx, ensure); err != nil {
 		return err
 	}
 
@@ -918,9 +918,9 @@ func (d *Devbox) ensurePackagesAreInstalledAndComputeEnv(
 ) (map[string]string, error) {
 	defer debug.FunctionTimer().End()
 
-	// When ensureDevboxEnvIsUpToDate is called with ensure=true, it always
+	// When ensurePackagesAreInstalled is called with ensure=true, it always
 	// returns early if the lockfile is up to date. So we don't need to check here
-	if err := d.ensureDevboxEnvIsUpToDate(ctx, ensure); err != nil {
+	if err := d.ensurePackagesAreInstalled(ctx, ensure); err != nil {
 		return nil, err
 	}
 

internal/impl/packages.go

@@ -108,7 +108,7 @@ func (d *Devbox) Add(ctx context.Context, platforms, excludePlatforms []string,
 		}
 	}
 
-	// Resolving here ensures we allow insecure before running ensureDevboxEnvIsUpToDate
+	// Resolving here ensures we allow insecure before running ensurePackagesAreInstalled
 	// which will call print-dev-env. Resolving does not save the lockfile, we
 	// save at the end when everything has succeeded.
 	if d.allowInsecureAdds {
@@ -126,7 +126,7 @@ func (d *Devbox) Add(ctx context.Context, platforms, excludePlatforms []string,
 		}
 	}
 
-	if err := d.ensureDevboxEnvIsUpToDate(ctx, install); err != nil {
+	if err := d.ensurePackagesAreInstalled(ctx, install); err != nil {
 		return usererr.WithUserMessage(err, "There was an error installing nix packages")
 	}
 
@@ -190,14 +190,14 @@ func (d *Devbox) Remove(ctx context.Context, pkgs ...string) error {
 	}
 
 	// this will clean up the now-extra package from nix profile and the lockfile
-	if err := d.ensureDevboxEnvIsUpToDate(ctx, uninstall); err != nil {
+	if err := d.ensurePackagesAreInstalled(ctx, uninstall); err != nil {
 		return err
 	}
 
 	return d.saveCfg()
 }
 
-// installMode is an enum for helping with ensureDevboxEnvIsUpToDate implementation
+// installMode is an enum for helping with ensurePackagesAreInstalled implementation
 type installMode string
 
 const (
@@ -208,7 +208,7 @@ const (
 	ensure installMode = "ensure"
 )
 
-// ensureDevboxEnvIsUpToDate ensures:
+// ensurePackagesAreInstalled ensures:
 //  1. Packages are installed, in nix-profile or runx.
 //     Extraneous packages are removed (references purged, not uninstalled).
 //  2. Files for devbox shellenv are generated
@@ -218,7 +218,8 @@ const (
 // The `mode` is used for:
 // 1. Skipping certain operations that may not apply.
 // 2. User messaging to explain what operations are happening, because this function may take time to execute.
-func (d *Devbox) ensureDevboxEnvIsUpToDate(ctx context.Context, mode installMode) error {
+// TODO: Rename method since it does more than just ensure packages are installed.
+func (d *Devbox) ensurePackagesAreInstalled(ctx context.Context, mode installMode) error {
 	defer trace.StartRegion(ctx, "ensurePackages").End()
 	defer debug.FunctionTimer().End()
 

internal/impl/update.go

@@ -62,7 +62,7 @@ func (d *Devbox) Update(ctx context.Context, opts devopt.UpdateOpts) error {
 		}
 	}
 
-	if err := d.ensureDevboxEnvIsUpToDate(ctx, update); err != nil {
+	if err := d.ensurePackagesAreInstalled(ctx, update); err != nil {
 		return err
 	}