[Devbox] introduce devopt.EnvOptions #2159
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
savil force-pushed the savil/global-min-env branch from 8b2b47b to 5b66556 Compare 5 tasks
savil force-pushed the savil/global-min-env branch from 5b66556 to 0be27b4 Compare 
mikeland73 approved these changes Jun 19, 2024
| // 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 { |
Collaborator
There was a problem hiding this comment.
RunScriptWithDefaultOptions ?
Collaborator Author
There was a problem hiding this comment.
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.
savil added a commit that referenced this pull request Jun 19, 2024
…ands (#2150) …vars ## Summary In this PR, we change `devbox global` shell environment to omit the env-vars from `nix print-dev-env`. Instead, we rely on the `nix profile` that Devbox manages to introduce the global packages into `PATH`. As before, `nix profile` continues to be generated from the `buildInputs` from `nix print-dev-env <devbox-generated-flake>`. The motivation is: 1. `devbox global` adds a bunch of nix stdenv packages to the top of your `$PATH` variable, which can cause conflicts when trying to compile or build projects on your machine. 2. `devbox global` also sets a global `PYTHONPATH` variable that interferes with other packages, as well as python scripts that are installed/running on the host. This global `PYTHONPATH` is unnecessary because any python binaries installed by the user are already wrapped with the `PYTHONPATH` Implementation notes: - Sets `Devbox.envForPackageBins` boolean setting that controls whether the Devbox Environment is optimized for executing package binaries, or for developing software using the packages. - [x] see if this can be passed down as a function parameter (see #2159) - Adds `flagDefaultOptions` to `shellEnvCmd`. This is a nicer way of overriding the defaults in global, even for the `--recompute` flag that we had done before. - Refactors code into a `devbox.execPrintDevEnv` function to remove some of the complexity from the `devbox.computeEnv` function (thanks to finger-wagging by our linter tool ;) ). TODO: - [x] Verify `omitNixEnv` is still properly handling the useNixPrintDevEnvCache call paths ## How was it tested? CICD tests should pass TODO: - [x] Ensure the python global scenario works - [x] Ensure we can use common packages (fzf, ripgrep, etc.) in `devbox global` - [x] Thanks to @gcurtis vetted this PR helps resolve issues with a couple of repos: (rust: https://github.com/zed-industries/zed.git) and (golang with cgo: [github.com/Code-Hex/vz/example/macOS](http://github.com/Code-Hex/vz/example/macOS))
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Summary
From the EnvOptions docblock:
This gets rid of the pseudo-global state in the
Devboxstruct where we were settingpure,preservePathStackandomitNixEnvvalues.How was it tested?
TODO:
devbox globalanddevboxomitNixEnv works as expectedpureworks as expected fordevbox shell --pure.