feat: refactor activation package #1460
Merged
Conversation
This file contains 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
14 tasks
limeytexan
force-pushed
the
activate-package
branch
5 times, most recently
from
1f67413
to
dd2c3c8
Compare
limeytexan
force-pushed
the
activate-package
branch
from
dd2c3c8
to
f7c0aaf
Compare
This patch refactors all files associated with flox environment activation into a single `flox-activate` package, and accordingly updates all internal references between these files to refer exclusively to the installed package path within the Nix store. This package is then installed into the environment to provide that top-level `activate` script, after which all further logic is specific to that one package. This opens the possibility of invoking newer versions of the flox-activate package with previously-rendered environments, allowing for improvements in the flox activation experience without forcing users to re-render their environments. Note that this PR moves the scripts previously defined as constants in `realise.cc` to separate scripts that are now checked by `shellcheck` as part of the build. That said, I have disabled all shellcheck auditing in the process so that this patch can represent a faithful *move* of the scripts from one location to the other, and incorporates no other modifications. A followup PR will enable shellcheck auditing for all scripts and introduce the associated fixes to silence the various warnings and errors.
limeytexan
force-pushed
the
activate-package
branch
from
f7c0aaf
to
88287f3
Compare
zmitchell
reviewed
May 21, 2024
| @@ -169,60 +168,6 @@ test_scriptsAreAddedToScriptsDir( nix::ref<nix::EvalState> & state, | |||
| } | |||
|
|
|||
|
|
|||
| /* -------------------------------------------------------------------------- */ | |||
|
|
|||
| bool | |||
There was a problem hiding this comment.
Why was this test removed?
There was a problem hiding this comment.
That was testing functionality that was removed from the C++ code, so I similarly removed that test. Specifically, we previously constructed the bashScript and zshScript files as bespoke to each environment, embedding lines to source each of the various hook files as rendered from the manifest. In the new version these scripts are now static and part of the activate package, and they instead first look for the existence of the various hook files in the environment before sourcing them. Basically the conditional logic for sourcing the hook scripts has moved from build time to run time, make sense?
zmitchell
approved these changes
May 21, 2024
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.
Proposed Changes
This patch refactors all files associated with flox environment activation into a single
flox-activatepackage, and accordingly updates all internal references between these files to refer exclusively to the installed package path within the Nix store. This package is then installed into the environment to provide that top-levelactivatescript, after which all further logic is specific to that one package. This opens the possibility of invoking newer versions of the flox-activate package with previously-rendered environments, allowing for improvements in the flox activation experience without requiring users to re-render their environments.Note that this PR moves the scripts previously defined as constants in
realise.ccto separate scripts that are now checked byshellcheckas part of the build. That said, I have disabled all shellcheck auditing in the process so that this patch can represent a faithful move of the scripts from one location to the other, and incorporates no other modifications.A followup PR will enable shellcheck auditing for all scripts and introduce the associated fixes to silence the various warnings and errors.
Release Notes
N/A