[Devbox] introduce devopt.EnvOptions

Author: savil

internal/boxcli/run.go

@@ -73,7 +73,6 @@ func listScripts(cmd *cobra.Command, flags runCmdFlags) []string {
 Dir: flags.config.path,
 Environment: flags.config.environment,
 Stderr: cmd.ErrOrStderr(),
-Pure: flags.pure,
 IgnoreWarnings: true,
 })
 if err != nil {
@@ -114,15 +113,17 @@ func runScriptCmd(cmd *cobra.Command, args []string, flags runCmdFlags) error {
 Dir: path,
 Environment: flags.config.environment,
 Stderr: cmd.ErrOrStderr(),
-OmitNixEnv: flags.omitNixEnv,
-Pure: flags.pure,
 Env: env,
 })
 if err != nil {
 return redact.Errorf("error reading devbox.json: %w", err)
 }
 
-if err := box.RunScript(cmd.Context(), script, scriptArgs); err != nil {
+envOpts := devopt.EnvOptions{
+OmitNixEnv: flags.omitNixEnv,
+Pure: flags.pure,
+}
+if err := box.RunScript(cmd.Context(), envOpts, script, scriptArgs); err != nil {
 return redact.Errorf("error running script %q in Devbox: %w", script, err)
 }
 return nil

internal/boxcli/shell.go

@@ -69,8 +69,6 @@ func runShellCmd(cmd *cobra.Command, flags shellCmdFlags) error {
 Dir: flags.config.path,
 Env: env,
 Environment: flags.config.environment,
-OmitNixEnv: flags.omitNixEnv,
-Pure: flags.pure,
 Stderr: cmd.ErrOrStderr(),
 })
 if err != nil {
@@ -93,7 +91,10 @@ func runShellCmd(cmd *cobra.Command, flags shellCmdFlags) error {
 return shellInceptionErrorMsg("devbox shell")
 }
 
-return box.Shell(cmd.Context())
+return box.Shell(cmd.Context(), devopt.EnvOptions{
+OmitNixEnv: flags.omitNixEnv,
+Pure: flags.pure,
+})
 }
 
 func shellInceptionErrorMsg(cmdPath string) error {

internal/boxcli/shellenv.go

@@ -33,7 +33,6 @@ type shellenvFlagDefaults struct {
 }
 
 func shellEnvCmd(defaults shellenvFlagDefaults) *cobra.Command {
-
 flags := shellEnvCmdFlags{}
 command := &cobra.Command{
 Use: "shellenv",
@@ -96,13 +95,10 @@ func shellEnvFunc(
 return "", err
 }
 box, err := devbox.Open(&devopt.Opts{
-Dir: flags.config.path,
-Environment: flags.config.environment,
-OmitNixEnv: flags.omitNixEnv,
-Stderr: cmd.ErrOrStderr(),
-PreservePathStack: flags.preservePathStack,
-Pure: flags.pure,
-Env: env,
+Dir: flags.config.path,
+Environment: flags.config.environment,
+Stderr: cmd.ErrOrStderr(),
+Env: env,
 })
 if err != nil {
 return "", err
@@ -116,8 +112,13 @@ func shellEnvFunc(
 
 envStr, err := box.EnvExports(cmd.Context(), devopt.EnvExportsOpts{
 DontRecomputeEnvironment: !flags.recomputeEnv,
-NoRefreshAlias: flags.noRefreshAlias,
-RunHooks: flags.runInitHook,
+EnvOptions: devopt.EnvOptions{
+OmitNixEnv: flags.omitNixEnv,
+PreservePathStack: flags.preservePathStack,
+Pure: flags.pure,
+},
+NoRefreshAlias: flags.noRefreshAlias,
+RunHooks: flags.runInitHook,
 })
 if err != nil {
 return "", err

internal/devbox/devbox.go

@@ -59,14 +59,11 @@ const (
 type Devbox struct {
 cfg *devconfig.Config
 env map[string]string
-envForPackageBins bool
 environment string
 lockfile *lock.File
 nix nix.Nixer
 projectDir string
 pluginManager *plugin.Manager
-preservePathStack bool
-pure bool
 customProcessComposeFile string
 
 // This is needed because of the --quiet flag.
@@ -98,14 +95,11 @@ func Open(opts *devopt.Opts) (*Devbox, error) {
 box := &Devbox{
 cfg: cfg,
 env: opts.Env,
-envForPackageBins: opts.OmitNixEnv,
 environment: environment,
 nix: &nix.Nix{},
 projectDir: projectDir,
 pluginManager: plugin.NewManager(),
 stderr: opts.Stderr,
-preservePathStack: opts.PreservePathStack,
-pure: opts.Pure,
 customProcessComposeFile: opts.CustomProcessComposeFile,
 }
 
@@ -200,11 +194,11 @@ func (d *Devbox) Generate(ctx context.Context) error {
 return errors.WithStack(shellgen.GenerateForPrintEnv(ctx, d))
 }
 
-func (d *Devbox) Shell(ctx context.Context) error {
+func (d *Devbox) Shell(ctx context.Context, envOpts devopt.EnvOptions) error {
 ctx, task := trace.NewTask(ctx, "devboxShell")
 defer task.End()
 
-envs, err := d.ensureStateIsUpToDateAndComputeEnv(ctx)
+envs, err := d.ensureStateIsUpToDateAndComputeEnv(ctx, envOpts)
 if err != nil {
 return err
 }
@@ -228,15 +222,22 @@ func (d *Devbox) Shell(ctx context.Context) error {
 WithShellStartTime(telemetry.ShellStart()),
 }
 
-shell, err := NewDevboxShell(d, opts...)
+shell, err := NewDevboxShell(d, envOpts, opts...)
 if err != nil {
 return err
 }
 
 return shell.Run()
 }
 
-func (d *Devbox) RunScript(ctx context.Context, cmdName string, cmdArgs []string) error {
+// runDevboxServicesScript invokes RunScript with the envOptions set to the appropriate
+// defaults for the `devbox services` scenario.
+// TODO: move to services.go
+func (d *Devbox) runDevboxServicesScript(ctx context.Context, cmdArgs []string) error {
+return d.RunScript(ctx, devopt.EnvOptions{}, "devbox", cmdArgs)
+}
+
+func (d *Devbox) RunScript(ctx context.Context, envOpts devopt.EnvOptions, cmdName string, cmdArgs []string) error {
 ctx, task := trace.NewTask(ctx, "devboxRun")
 defer task.End()
 
@@ -245,7 +246,7 @@ func (d *Devbox) RunScript(ctx context.Context, cmdName string, cmdArgs []string
 }
 
 lock.SetIgnoreShellMismatch(true)
-env, err := d.ensureStateIsUpToDateAndComputeEnv(ctx)
+env, err := d.ensureStateIsUpToDateAndComputeEnv(ctx, envOpts)
 if err != nil {
 return err
 }
@@ -329,9 +330,9 @@ func (d *Devbox) EnvExports(ctx context.Context, opts devopt.EnvExportsOpts) (st
 )
 }
 
-envs, err = d.computeEnv(ctx, true /*usePrintDevEnvCache*/)
+envs, err = d.computeEnv(ctx, true /*usePrintDevEnvCache*/, opts.EnvOptions)
 } else {
-envs, err = d.ensureStateIsUpToDateAndComputeEnv(ctx)
+envs, err = d.ensureStateIsUpToDateAndComputeEnv(ctx, opts.EnvOptions)
 }
 
 if err != nil {
@@ -356,7 +357,7 @@ func (d *Devbox) EnvVars(ctx context.Context) ([]string, error) {
 ctx, task := trace.NewTask(ctx, "devboxEnvVars")
 defer task.End()
 // this only returns env variables for the shell environment excluding hooks
-envs, err := d.ensureStateIsUpToDateAndComputeEnv(ctx)
+envs, err := d.ensureStateIsUpToDateAndComputeEnv(ctx, devopt.EnvOptions{})
 if err != nil {
 return nil, err
 }
@@ -566,11 +567,12 @@ func (d *Devbox) Services() (services.Services, error) {
 return result, nil
 }
 
+// TODO: move to services.go
 func (d *Devbox) StartServices(
 ctx context.Context, runInCurrentShell bool, serviceNames ...string,
 ) error {
 if !runInCurrentShell {
-return d.RunScript(ctx, "devbox",
+return d.runDevboxServicesScript(ctx,
 append(
 []string{"services", "start", "--run-in-current-shell"},
 serviceNames...,
@@ -610,14 +612,15 @@ func (d *Devbox) StartServices(
 return nil
 }
 
+// TODO: move to services.go
 func (d *Devbox) StopServices(ctx context.Context, runInCurrentShell, allProjects bool, serviceNames ...string) error {
 if !runInCurrentShell {
 args := []string{"services", "stop", "--run-in-current-shell"}
 args = append(args, serviceNames...)
 if allProjects {
 args = append(args, "--all-projects")
 }
-return d.RunScript(ctx, "devbox", args)
+return d.runDevboxServicesScript(ctx, args)
 }
 
 if allProjects {
@@ -649,10 +652,10 @@ func (d *Devbox) StopServices(ctx context.Context, runInCurrentShell, allProject
 return nil
 }
 
+// TODO: move to services.go
 func (d *Devbox) ListServices(ctx context.Context, runInCurrentShell bool) error {
 if !runInCurrentShell {
-return d.RunScript(ctx,
-"devbox", []string{"services", "ls", "--run-in-current-shell"})
+return d.runDevboxServicesScript(ctx, []string{"services", "ls", "--run-in-current-shell"})
 }
 
 svcSet, err := d.Services()
@@ -688,11 +691,12 @@ func (d *Devbox) ListServices(ctx context.Context, runInCurrentShell bool) error
 return nil
 }
 
+// TODO: move to services.go
 func (d *Devbox) RestartServices(
 ctx context.Context, runInCurrentShell bool, serviceNames ...string,
 ) error {
 if !runInCurrentShell {
-return d.RunScript(ctx, "devbox",
+return d.runDevboxServicesScript(ctx,
 append(
 []string{"services", "restart", "--run-in-current-shell"},
 serviceNames...,
@@ -727,6 +731,7 @@ func (d *Devbox) RestartServices(
 return nil
 }
 
+// TODO: move to services.go
 func (d *Devbox) StartProcessManager(
 ctx context.Context,
 runInCurrentShell bool,
@@ -750,7 +755,7 @@ func (d *Devbox) StartProcessManager(
 args = append(args, "--pcflags", flag)
 }
 
-return d.RunScript(ctx, "devbox", args)
+return d.runDevboxServicesScript(ctx, args)
 }
 
 svcs, err := d.Services()
@@ -874,13 +879,17 @@ func (d *Devbox) execPrintDevEnv(ctx context.Context, usePrintDevEnvCache bool)
 // Note that the shellrc.tmpl template (which sources this environment) does
 // some additional processing. The computeEnv environment won't necessarily
 // represent the final "devbox run" or "devbox shell" environments.
-func (d *Devbox) computeEnv(ctx context.Context, usePrintDevEnvCache bool) (map[string]string, error) {
+func (d *Devbox) computeEnv(
+ctx context.Context,
+usePrintDevEnvCache bool,
+envOpts devopt.EnvOptions,
+) (map[string]string, error) {
 defer debug.FunctionTimer().End()
 defer trace.StartRegion(ctx, "devboxComputeEnv").End()
 
 // Append variables from current env if --pure is not passed
 currentEnv := os.Environ()
-env, err := d.parseEnvAndExcludeSpecialCases(currentEnv)
+env, err := d.parseEnvAndExcludeSpecialCases(currentEnv, envOpts.Pure)
 if err != nil {
 return nil, err
 }
@@ -900,7 +909,7 @@ func (d *Devbox) computeEnv(ctx context.Context, usePrintDevEnvCache bool) (map[
 
 // TODO: look up callers of computeEnv to ensure we properly cache print-dev-env
 // when needed in the product flows
-if !d.envForPackageBins {
+if !envOpts.OmitNixEnv {
 nixEnv, err := d.execPrintDevEnv(ctx, usePrintDevEnvCache)
 if err != nil {
 return nil, err
@@ -979,13 +988,13 @@ func (d *Devbox) computeEnv(ctx context.Context, usePrintDevEnvCache bool) (map[
 devboxEnvPath = envpath.JoinPathLists(devboxEnvPath, runXPaths)
 
 pathStack := envpath.Stack(env, originalEnv)
-pathStack.Push(env, d.ProjectDirHash(), devboxEnvPath, d.preservePathStack)
+pathStack.Push(env, d.ProjectDirHash(), devboxEnvPath, envOpts.PreservePathStack)
 env["PATH"] = pathStack.Path(env)
 slog.Debug("new path stack is", "path_stack", pathStack)
 
 slog.Debug("computed environment PATH", "path", env["PATH"])
 
-if !d.pure {
+if !envOpts.Pure {
 // preserve the original XDG_DATA_DIRS by prepending to it
 env["XDG_DATA_DIRS"] = envpath.JoinPathLists(env["XDG_DATA_DIRS"], os.Getenv("XDG_DATA_DIRS"))
 }
@@ -1001,6 +1010,7 @@ func (d *Devbox) computeEnv(ctx context.Context, usePrintDevEnvCache bool) (map[
 // while ensuring these reflect the current (up to date) state of the project.
 func (d *Devbox) ensureStateIsUpToDateAndComputeEnv(
 ctx context.Context,
+envOpts devopt.EnvOptions,
 ) (map[string]string, error) {
 defer debug.FunctionTimer().End()
 
@@ -1027,7 +1037,7 @@ func (d *Devbox) ensureStateIsUpToDateAndComputeEnv(
 // it's ok to use usePrintDevEnvCache=true here always. This does end up
 // doing some non-nix work twice if lockfile is not up to date.
 // TODO: Improve this to avoid extra work.
-return d.computeEnv(ctx, true /*usePrintDevEnvCache*/)
+return d.computeEnv(ctx, true /*usePrintDevEnvCache*/, envOpts)
 }
 
 func (d *Devbox) nixPrintDevEnvCachePath() string {
@@ -1246,7 +1256,7 @@ func (d *Devbox) addHashToEnv(env map[string]string) error {
 
 // parseEnvAndExcludeSpecialCases converts env as []string to map[string]string
 // In case of pure shell, it leaks HOME and it leaks PATH with some modifications
-func (d *Devbox) parseEnvAndExcludeSpecialCases(currentEnv []string) (map[string]string, error) {
+func (d *Devbox) parseEnvAndExcludeSpecialCases(currentEnv []string, pure bool) (map[string]string, error) {
 env := make(map[string]string, len(currentEnv))
 for _, kv := range currentEnv {
 key, val, found := strings.Cut(kv, "=")
@@ -1260,13 +1270,13 @@ func (d *Devbox) parseEnvAndExcludeSpecialCases(currentEnv []string) (map[string
 // - HOME required for devbox binary to work
 // - PATH to find the nix installation. It is cleaned for pure mode below.
 // - TERM to enable colored text in the pure shell
-if !d.pure || key == "HOME" || key == "PATH" || key == "TERM" {
+if !pure || key == "HOME" || key == "PATH" || key == "TERM" {
 env[key] = val
 }
 }
 
 // handling special case for PATH
-if d.pure {
+if pure {
 // Setting a custom env variable to differentiate pure and regular shell
 env["DEVBOX_PURE_SHELL"] = "1"
 // Finding nix executables in path and passing it through