[Bug fix] Ensure bin-wrappers use latest devbox binary to prevent false update notifications #1324
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
|
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
savil
force-pushed
the
savil/fix-bin-wrappers-accuracy
branch
from
a4dff66 to
c4433d6
Compare
savil
force-pushed
the
savil/fix-bin-wrappers-accuracy
branch
from
c4433d6 to
ff6e1ed
Compare
…se update notifications
savil
force-pushed
the
savil/fix-bin-wrappers-accuracy
branch
from
ff6e1ed to
2d3db2e
Compare
mikeland73
approved these changes
Jul 27, 2023
internal/wrapnix/wrapper.go
Outdated
| // So, the bin-wrappers need to use a symlink to the latest devbox binary. This | ||
| // symlink is updated when devbox is updated. | ||
| func CreateDevboxSymlink() (string, error) { | ||
| curDir := xdg.CacheSubpath(filepath.Join("devbox", "current")) |
There was a problem hiding this comment.
thoughts on making this devbox/bin/current instead? that way we keep it with all the other bins.
There was a problem hiding this comment.
yeah, I like that. Will update.
internal/wrapnix/wrapper.go
Outdated
| return "", errors.WithStack(err) | ||
| } | ||
|
|
||
| if err := os.Symlink(devboxBinaryPath, currentDevboxSymlinkPath); err != nil { |
There was a problem hiding this comment.
Don't return error if error is os.ErrExist (to protect against race conditions)
|
I have a small commit locally to fix the code review feedback, but its not showing up on Github due to their incident: |
savil
added a commit
that referenced
this pull request
Jul 28, 2023
…binary (#1330) ## Summary This PR tries to address some concerns with #1324. 1. We drop `export` from `PATH` in the bin-wrappers. This would have modified PATH for all child programs, which we need not do. 2. When creating the symlink, we ensure the target value is passed through `EvalSymlink`. Previously, it was set as the result of `os.Executable`, which may still have been a symlink. ## How was it tested? did a basic sanity test of opening a devbox shell in a golang project
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
Motivation
In #1260, the bin-wrappers were changed to invoke the devbox-binary, instead of the devbox-launcher. However, when devbox has been updated, these bin-wrappers have the older devbox-binary's path hardcoded. So, they call the older devbox-binary leading to two issues:
Implementation
devbox shellenv.devboxvia the launcher. This is problematic for users who have installedcoreutilsvia devbox, but for most users this fallback would work.ensurePackagesAreInstalledthat runs indevbox.PrintEnvduringdevbox shellenv.devbox global shellenvwould run, refreshing these bin-wrappers.devbox version update, so that it points to the new Devbox binary.Drawbacks
Switching between devbox versions (for testing and development) may lead to subtle unexpected behavior: The devbox-symlink will point to the version that created the bin-wrappers, rather than respecting the devbox of the PATH. We need to ensure we run
devbox installor similar to re-create the bin-wrappers.How was it tested?
devbox shellinexamples/development/go/hello-world.devbox run buildusing the devbox binary from this PR.devbox version -vto ensure that it was re-created.