[bin-wrappers] Don't use wrappers on run #1361
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
mohsenari
reviewed
Aug 10, 2023
Comment on lines
-835
to
-858
| // Prepend the bin-wrappers directory to the PATH. This ensures that | ||
| // bin-wrappers execute before the unwrapped binaries. | ||
| filepath.Join(d.projectDir, plugin.WrapperBinPath), | ||
| // Adding profile bin path is a temporary hack. Some packages .e.g. curl | ||
| // don't export the correct bin in the package, instead they export | ||
| // as a propagated build input. This can be fixed in 2 ways: | ||
| // * have NixBins() recursively look for bins in propagated build inputs | ||
| // * Turn existing planners into flakes (i.e. php, haskell) and use the bins | ||
| // in the profile. | ||
| // Landau: I prefer option 2 because it doesn't require us to re-implement | ||
| // nix recursive bin lookup. |
There was a problem hiding this comment.
this is in computeNixEnv which is called in both devbox run and devbox shell.
Is this change not going to affect devbox shell?
There was a problem hiding this comment.
for callers other than devbox run, the d.OmitBinWrappersFromPath defaults to false, so this change is a no-op and hence safe for them
savil
approved these changes
Aug 10, 2023
Comment on lines
-835
to
-858
| // Prepend the bin-wrappers directory to the PATH. This ensures that | ||
| // bin-wrappers execute before the unwrapped binaries. | ||
| filepath.Join(d.projectDir, plugin.WrapperBinPath), | ||
| // Adding profile bin path is a temporary hack. Some packages .e.g. curl | ||
| // don't export the correct bin in the package, instead they export | ||
| // as a propagated build input. This can be fixed in 2 ways: | ||
| // * have NixBins() recursively look for bins in propagated build inputs | ||
| // * Turn existing planners into flakes (i.e. php, haskell) and use the bins | ||
| // in the profile. | ||
| // Landau: I prefer option 2 because it doesn't require us to re-implement | ||
| // nix recursive bin lookup. |
There was a problem hiding this comment.
for callers other than devbox run, the d.OmitBinWrappersFromPath defaults to false, so this change is a no-op and hence safe for them
mikeland73
added a commit
that referenced
this pull request
Aug 11, 2023
## Summary While working on #1361 I noticed that we were not installing plugin packages (usually just custom flakes) to profile. This means in cases like the PHP plugin, the binary int he profile was wrong because it did not include extensions. Everything was still working as expected because bin wrappers would point to the correct binary but this is bad for 2 reasons: * We want to get rid of bin wrappers * It is quite fragile for binaries in profile to be wrong binaries This PR fixes it by ensuring plugin packages are installed. I also refactored some function names that were out of date. TODO: We currently output text when installing plugin packages that is not very user friendly. We could improve it. ## How was it tested? ```bash ➜ devbox git:(landau/install-plugin-packages-to-profile) devbox run -c examples/development/php/php8.1 php -m | grep imagick Installing dependencies from lock file (including require-dev) Verifying lock file contents can be installed on current platform. Nothing to install, update or remove Generating autoload files imagick ```
Suspect IssuesThis pull request has been 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
When doing
devbox runthe environment is always correct because commands are run in a new sub-process with correct computed environment therefore wrappers are not needed. This is a low handing fruit that should improve performance when doingdevbox runHow was it tested?