max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2025-02-16 23:27:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

nix profile: Make profile element names stable

Browse source 
The profile manifest is now an object keyed on the name returned by
getNameFromURL() at installation time, instead of an array. This
ensures that the names of profile elements don't change when other
elements are added/removed.
This commit is contained in:
Eelco Dolstra 2023-12-22 16:11:25 +01:00
parent 3187bc9ac3
commit 6268a45b65
2 changed files with 80 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

140
src/nix/profile.cc
View file

@ -45,7 +45,6 @@ const int defaultPriority = 5;
struct ProfileElement struct ProfileElement
{ {
StorePathSet storePaths; StorePathSet storePaths;
std::string name;
std::optional<ProfileElementSource> source; std::optional<ProfileElementSource> source;
bool active = true; bool active = true;
int priority = defaultPriority; int priority = defaultPriority;
@ -82,11 +81,6 @@ struct ProfileElement
return showVersions(versions); return showVersions(versions);
} }
bool operator < (const ProfileElement & other) const
{
return std::tuple(identifier(), storePaths) < std::tuple(other.identifier(), other.storePaths);
}
void updateStorePaths( void updateStorePaths(
ref<Store> evalStore, ref<Store> evalStore,
ref<Store> store, ref<Store> store,
@ -109,7 +103,9 @@ struct ProfileElement
struct ProfileManifest struct ProfileManifest
{ {
std::vector<ProfileElement> elements; using ProfileElementName = std::string;
std::map<ProfileElementName, ProfileElement> elements;
ProfileManifest() { } ProfileManifest() { }
@ -119,8 +115,6 @@ struct ProfileManifest
if (pathExists(manifestPath)) { if (pathExists(manifestPath)) {
auto json = nlohmann::json::parse(readFile(manifestPath)); auto json = nlohmann::json::parse(readFile(manifestPath));
/* Keep track of already found names to allow preventing duplicates. */
std::set<std::string> foundNames;
auto version = json.value("version", 0); auto version = json.value("version", 0);
std::string sUrl; std::string sUrl;
@ -131,6 +125,7 @@ struct ProfileManifest
sOriginalUrl = "originalUri"; sOriginalUrl = "originalUri";
break; break;
case 2: case 2:
case 3:
sUrl = "url"; sUrl = "url";
sOriginalUrl = "originalUrl"; sOriginalUrl = "originalUrl";
break; break;
@ -138,7 +133,9 @@ struct ProfileManifest
throw Error("profile manifest '%s' has unsupported version %d", manifestPath, version); throw Error("profile manifest '%s' has unsupported version %d", manifestPath, version);
} }
for (auto & e : json["elements"]) { auto elems = json["elements"];
for (auto & elem : elems.items()) {
auto & e = elem.value();
ProfileElement element; ProfileElement element;
for (auto & p : e["storePaths"]) for (auto & p : e["storePaths"])
element.storePaths.insert(state.store->parseStorePath((std::string) p)); element.storePaths.insert(state.store->parseStorePath((std::string) p));
@ -155,25 +152,16 @@ struct ProfileManifest
}; };
} }
std::string nameCandidate = element.identifier(); std::string name =
if (e.contains("name")) { elems.is_object()
nameCandidate = e["name"]; ? elem.key()
} : e.contains("name")
else if (element.source) { ? (std::string) e["name"]
auto url = parseURL(element.source->to_string()); : element.source
auto name = getNameFromURL(url); ? getNameFromURL(parseURL(element.source->to_string())).value_or(element.identifier())
if (name) : element.identifier();
nameCandidate = *name;
}
auto finalName = nameCandidate; addElement(name, std::move(element));
for (int i = 1; foundNames.contains(finalName); ++i) {
finalName = nameCandidate + std::to_string(i);
}
element.name = finalName;
foundNames.insert(element.name);
elements.emplace_back(std::move(element));
} }
} }
@ -187,16 +175,34 @@ struct ProfileManifest
for (auto & drvInfo : drvInfos) { for (auto & drvInfo : drvInfos) {
ProfileElement element; ProfileElement element;
element.storePaths = {drvInfo.queryOutPath()}; element.storePaths = {drvInfo.queryOutPath()};
element.name = element.identifier(); addElement(std::move(element));
elements.emplace_back(std::move(element));
} }
} }
} }
void addElement(std::string_view nameCandidate, ProfileElement element)
{
std::string finalName(nameCandidate);
for (int i = 1; elements.contains(finalName); ++i)
finalName = nameCandidate + "-" + std::to_string(i);
elements.insert_or_assign(finalName, std::move(element));
}
void addElement(ProfileElement element)
{
auto name =
element.source
? getNameFromURL(parseURL(element.source->to_string()))
: std::nullopt;
auto name2 = name ? *name : element.identifier();
addElement(name2, std::move(element));
}
nlohmann::json toJSON(Store & store) const nlohmann::json toJSON(Store & store) const
{ {
auto array = nlohmann::json::array(); auto es = nlohmann::json::object();
for (auto & element : elements) { for (auto & [name, element] : elements) {
auto paths = nlohmann::json::array(); auto paths = nlohmann::json::array();
for (auto & path : element.storePaths) for (auto & path : element.storePaths)
paths.push_back(store.printStorePath(path)); paths.push_back(store.printStorePath(path));
@ -210,11 +216,11 @@ struct ProfileManifest
obj["attrPath"] = element.source->attrPath; obj["attrPath"] = element.source->attrPath;
obj["outputs"] = element.source->outputs; obj["outputs"] = element.source->outputs;
} }
array.push_back(obj); es[name] = obj;
} }
nlohmann::json json; nlohmann::json json;
json["version"] = 2; json["version"] = 3;
json["elements"] = array; json["elements"] = es;
return json; return json;
} }
@ -225,7 +231,7 @@ struct ProfileManifest
StorePathSet references; StorePathSet references;
Packages pkgs; Packages pkgs;
for (auto & element : elements) { for (auto & [name, element] : elements) {
for (auto & path : element.storePaths) { for (auto & path : element.storePaths) {
if (element.active) if (element.active)
pkgs.emplace_back(store->printStorePath(path), true, element.priority); pkgs.emplace_back(store->printStorePath(path), true, element.priority);
@ -267,33 +273,27 @@ struct ProfileManifest
static void printDiff(const ProfileManifest & prev, const ProfileManifest & cur, std::string_view indent) static void printDiff(const ProfileManifest & prev, const ProfileManifest & cur, std::string_view indent)
{ {
auto prevElems = prev.elements; auto i = prev.elements.begin();
std::sort(prevElems.begin(), prevElems.end()); auto j = cur.elements.begin();
auto curElems = cur.elements;
std::sort(curElems.begin(), curElems.end());
auto i = prevElems.begin();
auto j = curElems.begin();
bool changes = false; bool changes = false;
while (i != prevElems.end() || j != curElems.end()) { while (i != prev.elements.end() || j != cur.elements.end()) {
if (j != curElems.end() && (i == prevElems.end() || i->identifier() > j->identifier())) { if (j != cur.elements.end() && (i == prev.elements.end() || i->first > j->first)) {
logger->cout("%s%s: ∅ -> %s", indent, j->identifier(), j->versions()); logger->cout("%s%s: ∅ -> %s", indent, j->second.identifier(), j->second.versions());
changes = true; changes = true;
++j; ++j;
} }
else if (i != prevElems.end() && (j == curElems.end() || i->identifier() < j->identifier())) { else if (i != prev.elements.end() && (j == cur.elements.end() || i->first < j->first)) {
logger->cout("%s%s: %s -> ∅", indent, i->identifier(), i->versions()); logger->cout("%s%s: %s -> ∅", indent, i->second.identifier(), i->second.versions());
changes = true; changes = true;
++i; ++i;
} }
else { else {
auto v1 = i->versions(); auto v1 = i->second.versions();
auto v2 = j->versions(); auto v2 = j->second.versions();
if (v1 != v2) { if (v1 != v2) {
logger->cout("%s%s: %s -> %s", indent, i->identifier(), v1, v2); logger->cout("%s%s: %s -> %s", indent, i->second.identifier(), v1, v2);
changes = true; changes = true;
} }
++i; ++i;
@ -392,7 +392,7 @@ struct CmdProfileInstall : InstallablesCommand, MixDefaultProfile
element.updateStorePaths(getEvalStore(), store, res); element.updateStorePaths(getEvalStore(), store, res);
manifest.elements.push_back(std::move(element)); manifest.addElement(std::move(element));
} }
try { try {
@ -402,7 +402,7 @@ struct CmdProfileInstall : InstallablesCommand, MixDefaultProfile
// See https://github.com/NixOS/nix/compare/3efa476c5439f8f6c1968a6ba20a31d1239c2f04..1fe5d172ece51a619e879c4b86f603d9495cc102 // See https://github.com/NixOS/nix/compare/3efa476c5439f8f6c1968a6ba20a31d1239c2f04..1fe5d172ece51a619e879c4b86f603d9495cc102
auto findRefByFilePath = [&]<typename Iterator>(Iterator begin, Iterator end) { auto findRefByFilePath = [&]<typename Iterator>(Iterator begin, Iterator end) {
for (auto it = begin; it != end; it++) { for (auto it = begin; it != end; it++) {
auto profileElement = *it; auto & profileElement = it->second;
for (auto & storePath : profileElement.storePaths) { for (auto & storePath : profileElement.storePaths) {
if (conflictError.fileA.starts_with(store->printStorePath(storePath))) { if (conflictError.fileA.starts_with(store->printStorePath(storePath))) {
return std::pair(conflictError.fileA, profileElement.toInstallables(*store)); return std::pair(conflictError.fileA, profileElement.toInstallables(*store));
@ -488,13 +488,17 @@ public:
return res; return res;
} }
bool matches(const Store & store, const ProfileElement & element, const std::vector<Matcher> & matchers) bool matches(
const Store & store,
const std::string & name,
const ProfileElement & element,
const std::vector<Matcher> & matchers)
{ {
for (auto & matcher : matchers) { for (auto & matcher : matchers) {
if (auto path = std::get_if<Path>(&matcher)) { if (auto path = std::get_if<Path>(&matcher)) {
if (element.storePaths.count(store.parseStorePath(*path))) return true; if (element.storePaths.count(store.parseStorePath(*path))) return true;
} else if (auto regex = std::get_if<RegexPattern>(&matcher)) { } else if (auto regex = std::get_if<RegexPattern>(&matcher)) {
if (std::regex_match(element.name, regex->reg)) if (std::regex_match(name, regex->reg))
return true; return true;
} }
} }
@ -525,10 +529,9 @@ struct CmdProfileRemove : virtual EvalCommand, MixDefaultProfile, MixProfileElem
ProfileManifest newManifest; ProfileManifest newManifest;
for (size_t i = 0; i < oldManifest.elements.size(); ++i) { for (auto & [name, element] : oldManifest.elements) {
auto & element(oldManifest.elements[i]); if (!matches(*store, name, element, matchers)) {
if (!matches(*store, element, matchers)) { newManifest.elements.insert_or_assign(name, std::move(element));
newManifest.elements.push_back(std::move(element));
} else { } else {
notice("removing '%s'", element.identifier()); notice("removing '%s'", element.identifier());
} }
@ -574,14 +577,13 @@ struct CmdProfileUpgrade : virtual SourceExprCommand, MixDefaultProfile, MixProf
auto matchers = getMatchers(store); auto matchers = getMatchers(store);
Installables installables; Installables installables;
std::vector<size_t> indices; std::vector<ProfileElement *> elems;
auto matchedCount = 0; auto matchedCount = 0;
auto upgradedCount = 0; auto upgradedCount = 0;
for (size_t i = 0; i < manifest.elements.size(); ++i) { for (auto & [name, element] : manifest.elements) {
auto & element(manifest.elements[i]); if (!matches(*store, name, element, matchers)) {
if (!matches(*store, element, matchers)) {
continue; continue;
} }
@ -637,7 +639,7 @@ struct CmdProfileUpgrade : virtual SourceExprCommand, MixDefaultProfile, MixProf
}; };
installables.push_back(installable); installables.push_back(installable);
indices.push_back(i); elems.push_back(&element);
} }
if (upgradedCount == 0) { if (upgradedCount == 0) {
@ -661,7 +663,7 @@ struct CmdProfileUpgrade : virtual SourceExprCommand, MixDefaultProfile, MixProf
for (size_t i = 0; i < installables.size(); ++i) { for (size_t i = 0; i < installables.size(); ++i) {
auto & installable = installables.at(i); auto & installable = installables.at(i);
auto & element = manifest.elements[indices.at(i)]; auto & element = *elems.at(i);
element.updateStorePaths( element.updateStorePaths(
getEvalStore(), getEvalStore(),
store, store,
@ -693,11 +695,11 @@ struct CmdProfileList : virtual EvalCommand, virtual StoreCommand, MixDefaultPro
if (json) { if (json) {
std::cout << manifest.toJSON(*store).dump() << "\n"; std::cout << manifest.toJSON(*store).dump() << "\n";
} else { } else {
for (size_t i = 0; i < manifest.elements.size(); ++i) { for (const auto & [i, e] : enumerate(manifest.elements)) {
auto & element(manifest.elements[i]); auto & [name, element] = e;
if (i) logger->cout(""); if (i) logger->cout("");
logger->cout("Name: " ANSI_BOLD "%s" ANSI_NORMAL "%s", logger->cout("Name: " ANSI_BOLD "%s" ANSI_NORMAL "%s",
element.name, name,
element.active ? "" : " " ANSI_RED "(inactive)" ANSI_NORMAL); element.active ? "" : " " ANSI_RED "(inactive)" ANSI_NORMAL);
if (element.source) { if (element.source) {
logger->cout("Flake attribute: %s%s", element.source->attrPath, element.source->outputs.to_string()); logger->cout("Flake attribute: %s%s", element.source->attrPath, element.source->outputs.to_string());

17
tests/functional/nix-profile.sh
View file

@ -59,7 +59,7 @@ nix profile diff-closures | grep 'env-manifest.nix: ε → ∅'
# Test XDG Base Directories support # Test XDG Base Directories support
export NIX_CONFIG="use-xdg-base-directories = true" export NIX_CONFIG="use-xdg-base-directories = true"
nix profile remove flake1 nix profile remove flake1 2>&1 | grep 'removed 1 packages'
nix profile install $flake1Dir nix profile install $flake1Dir
[[ $($TEST_HOME/.local/state/nix/profile/bin/hello) = "Hello World" ]] [[ $($TEST_HOME/.local/state/nix/profile/bin/hello) = "Hello World" ]]
unset NIX_CONFIG unset NIX_CONFIG
@ -80,7 +80,7 @@ nix profile rollback
# Test uninstall. # Test uninstall.
[ -e $TEST_HOME/.nix-profile/bin/foo ] [ -e $TEST_HOME/.nix-profile/bin/foo ]
nix profile remove foo nix profile remove foo 2>&1 | grep 'removed 1 packages'
(! [ -e $TEST_HOME/.nix-profile/bin/foo ]) (! [ -e $TEST_HOME/.nix-profile/bin/foo ])
nix profile history | grep 'foo: 1.0 -> ∅' nix profile history | grep 'foo: 1.0 -> ∅'
nix profile diff-closures | grep 'Version 3 -> 4' nix profile diff-closures | grep 'Version 3 -> 4'
@ -88,7 +88,7 @@ nix profile diff-closures | grep 'Version 3 -> 4'
# Test installing a non-flake package. # Test installing a non-flake package.
nix profile install --file ./simple.nix '' nix profile install --file ./simple.nix ''
[[ $(cat $TEST_HOME/.nix-profile/hello) = "Hello World!" ]] [[ $(cat $TEST_HOME/.nix-profile/hello) = "Hello World!" ]]
nix profile remove simple nix profile remove simple 2>&1 | grep 'removed 1 packages'
nix profile install $(nix-build --no-out-link ./simple.nix) nix profile install $(nix-build --no-out-link ./simple.nix)
[[ $(cat $TEST_HOME/.nix-profile/hello) = "Hello World!" ]] [[ $(cat $TEST_HOME/.nix-profile/hello) = "Hello World!" ]]
@ -96,8 +96,9 @@ nix profile install $(nix-build --no-out-link ./simple.nix)
mkdir $TEST_ROOT/simple-too mkdir $TEST_ROOT/simple-too
cp ./simple.nix ./config.nix simple.builder.sh $TEST_ROOT/simple-too cp ./simple.nix ./config.nix simple.builder.sh $TEST_ROOT/simple-too
nix profile install --file $TEST_ROOT/simple-too/simple.nix '' nix profile install --file $TEST_ROOT/simple-too/simple.nix ''
nix profile list | grep -A4 'Name:.*simple' | grep 'Name:.*simple1' nix profile list | grep -A4 'Name:.*simple' | grep 'Name:.*simple-1'
nix profile remove simple1 nix profile remove simple 2>&1 | grep 'removed 1 packages'
nix profile remove simple-1 2>&1 | grep 'removed 1 packages'
# Test wipe-history. # Test wipe-history.
nix profile wipe-history nix profile wipe-history
@ -110,7 +111,7 @@ nix profile upgrade flake1
nix profile history | grep "packages.$system.default: 1.0, 1.0-man -> 3.0, 3.0-man" nix profile history | grep "packages.$system.default: 1.0, 1.0-man -> 3.0, 3.0-man"
# Test new install of CA package. # Test new install of CA package.
nix profile remove flake1 nix profile remove flake1 2>&1 | grep 'removed 1 packages'
printf 4.0 > $flake1Dir/version printf 4.0 > $flake1Dir/version
printf Utrecht > $flake1Dir/who printf Utrecht > $flake1Dir/who
nix profile install $flake1Dir nix profile install $flake1Dir
@ -131,14 +132,14 @@ nix profile upgrade flake1
[ -e $TEST_HOME/.nix-profile/share/man ] [ -e $TEST_HOME/.nix-profile/share/man ]
[ -e $TEST_HOME/.nix-profile/include ] [ -e $TEST_HOME/.nix-profile/include ]
nix profile remove flake1 nix profile remove flake1 2>&1 | grep 'removed 1 packages'
nix profile install "$flake1Dir^man" nix profile install "$flake1Dir^man"
(! [ -e $TEST_HOME/.nix-profile/bin/hello ]) (! [ -e $TEST_HOME/.nix-profile/bin/hello ])
[ -e $TEST_HOME/.nix-profile/share/man ] [ -e $TEST_HOME/.nix-profile/share/man ]
(! [ -e $TEST_HOME/.nix-profile/include ]) (! [ -e $TEST_HOME/.nix-profile/include ])
# test priority # test priority
nix profile remove flake1 nix profile remove flake1 2>&1 | grep 'removed 1 packages'
# Make another flake. # Make another flake.
flake2Dir=$TEST_ROOT/flake2 flake2Dir=$TEST_ROOT/flake2