Skip to content

[Devbox] introduce devopt.EnvOptions #2159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 19, 2024
Merged

[Devbox] introduce devopt.EnvOptions #2159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions internal/boxcli/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions internal/boxcli/shell.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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 {
Expand Down
20 changes: 11 additions & 9 deletions internal/boxcli/shellenv.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,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
Expand All @@ -115,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
Expand Down
68 changes: 39 additions & 29 deletions internal/devbox/devbox.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,11 @@ const (
type Devbox struct {
cfg *devconfig.Config
env map[string]string
omitNixEnv 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.
Expand Down Expand Up @@ -98,14 +95,11 @@ func Open(opts *devopt.Opts) (*Devbox, error) {
box := &Devbox{
cfg: cfg,
env: opts.Env,
omitNixEnv: opts.OmitNixEnv,
environment: environment,
nix: &nix.Nix{},
projectDir: projectDir,
pluginManager: plugin.NewManager(),
stderr: opts.Stderr,
preservePathStack: opts.PreservePathStack,
pure: opts.Pure,
customProcessComposeFile: opts.CustomProcessComposeFile,
}

Expand Down Expand Up @@ -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
}
Expand All @@ -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 {
Copy link
Collaborator

@mikeland73 mikeland73 Jun 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RunScriptWithDefaultOptions ?
Copy link
Collaborator Author

@savil savil Jun 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I'm going to leave this as is, because "default options" may not be correct or obvious-in-meaning in all scenarios. I'll modify this in a follow up to be even more Services-specific.
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()

Expand All @@ -256,7 +257,7 @@ func (d *Devbox) RunScript(ctx context.Context, cmdName string, cmdArgs []string
env[d.SkipInitHookEnvName()] = "true"
} else {
var err error
env, err = d.ensureStateIsUpToDateAndComputeEnv(ctx)
env, err = d.ensureStateIsUpToDateAndComputeEnv(ctx, envOpts)
if err != nil {
return err
}
Expand Down Expand Up @@ -341,9 +342,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 {
Expand All @@ -368,7 +369,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
}
Expand Down Expand Up @@ -578,11 +579,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...,
Expand Down Expand Up @@ -622,14 +624,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 {
Expand Down Expand Up @@ -661,10 +664,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()
Expand Down Expand Up @@ -700,11 +703,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...,
Expand Down Expand Up @@ -739,6 +743,7 @@ func (d *Devbox) RestartServices(
return nil
}

// TODO: move to services.go
func (d *Devbox) StartProcessManager(
ctx context.Context,
runInCurrentShell bool,
Expand All @@ -762,7 +767,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()
Expand Down Expand Up @@ -886,13 +891,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
}
Expand All @@ -910,7 +919,7 @@ func (d *Devbox) computeEnv(ctx context.Context, usePrintDevEnvCache bool) (map[
originalEnv := make(map[string]string, len(env))
maps.Copy(originalEnv, env)

if !d.omitNixEnv {
if !envOpts.OmitNixEnv {
nixEnv, err := d.execPrintDevEnv(ctx, usePrintDevEnvCache)
if err != nil {
return nil, err
Expand Down Expand Up @@ -989,13 +998,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"))
}
Expand All @@ -1011,6 +1020,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()

Expand All @@ -1037,7 +1047,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 {
Expand Down Expand Up @@ -1256,7 +1266,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, "=")
Expand All @@ -1270,13 +1280,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
Expand Down
Loading