Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better handling of min version merging in DependencyList #4987

Merged
merged 1 commit into from
Nov 19, 2024
+73 −21
Merged

Better handling of min version merging in DependencyList #4987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions src/AppInstallerCLITests/Dependencies.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,3 +209,66 @@ TEST_CASE("DependencyNodeProcessor_NoMatches", "[dependencies]")
REQUIRE(installOutput.str().find(Resource::LocString(Resource::String::DependenciesFlowNoMatches)) != std::string::npos);
REQUIRE(result == DependencyNodeProcessorResult::Error);
}

TEST_CASE("DependencyList_Add_MinVersion", "[dependencies]")
{
DependencyType type = DependencyType::Package;
std::string identifier = "Identifier";

DependencyList list;
Dependency dependencyWithoutMinVersion{ type, identifier };
Dependency dependencyWithLowerMinVersion{ type, identifier, "1.0" };
Dependency dependencyWithHigherMinVersion{ type, identifier, "3.0" };

Dependency dependencyToAdd{ type, identifier, "2.0" };

SECTION("Existing dependency has no min version, added does")
{
list.Add(dependencyWithoutMinVersion);
list.Add(dependencyToAdd);

const Dependency* dependency = list.HasDependency(dependencyToAdd);
REQUIRE(dependency != nullptr);
REQUIRE(dependency->MinVersion.has_value());
REQUIRE(dependency->MinVersion == dependencyToAdd.MinVersion);
}
SECTION("Existing dependency has lower min version")
{
list.Add(dependencyWithLowerMinVersion);
list.Add(dependencyToAdd);

const Dependency* dependency = list.HasDependency(dependencyToAdd);
REQUIRE(dependency != nullptr);
REQUIRE(dependency->MinVersion.has_value());
REQUIRE(dependency->MinVersion == dependencyToAdd.MinVersion);
}
SECTION("Existing dependency has higher min version")
{
list.Add(dependencyWithHigherMinVersion);
list.Add(dependencyToAdd);

const Dependency* dependency = list.HasDependency(dependencyToAdd);
REQUIRE(dependency != nullptr);
REQUIRE(dependency->MinVersion.has_value());
REQUIRE(dependency->MinVersion == dependencyWithHigherMinVersion.MinVersion);
}
SECTION("Existing dependency has no min version, neither does added")
{
list.Add(dependencyWithoutMinVersion);
list.Add(dependencyWithoutMinVersion);

const Dependency* dependency = list.HasDependency(dependencyToAdd);
REQUIRE(dependency != nullptr);
REQUIRE(!dependency->MinVersion.has_value());
}
SECTION("Existing dependency has min version, added does not")
{
list.Add(dependencyWithHigherMinVersion);
list.Add(dependencyWithoutMinVersion);

const Dependency* dependency = list.HasDependency(dependencyToAdd);
REQUIRE(dependency != nullptr);
REQUIRE(dependency->MinVersion.has_value());
REQUIRE(dependency->MinVersion == dependencyWithHigherMinVersion.MinVersion);
}
}
23 changes: 6 additions & 17 deletions src/AppInstallerCommonCore/Manifest/ManifestCommon.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1113,22 +1113,11 @@ namespace AppInstaller::Manifest
{
Dependency* existingDependency = this->HasDependency(newDependency);

if (existingDependency != NULL) {
if (newDependency.MinVersion)
if (existingDependency != NULL)
{
if (newDependency.MinVersion > existingDependency->MinVersion)
{
if (existingDependency->MinVersion)
{
const auto& newDependencyVersion = Utility::Version(newDependency.MinVersion.value());
const auto& existingDependencyVersion = Utility::Version(existingDependency->MinVersion.value());
if (newDependencyVersion > existingDependencyVersion)
{
existingDependency->MinVersion.value() = newDependencyVersion.ToString();
}
}
else
{
existingDependency->MinVersion.value() = newDependency.MinVersion.value();
}
existingDependency->MinVersion = newDependency.MinVersion;
}
}
else
Expand Down Expand Up @@ -1168,15 +1157,15 @@ namespace AppInstaller::Manifest
}

// for testing purposes
bool DependencyList::HasExactDependency(DependencyType type, string_t id, string_t minVersion)
bool DependencyList::HasExactDependency(DependencyType type, const string_t& id, const string_t& minVersion)
{
for (const auto& dependency : m_dependencies)
{
if (dependency.Type == type && Utility::ICUCaseInsensitiveEquals(dependency.Id(), id))
{
if (!minVersion.empty())
{
return dependency.MinVersion.has_value() && dependency.MinVersion.value() == Utility::Version{ minVersion };
return dependency.MinVersion == Utility::Version{ minVersion };
}
else
{
Expand Down
8 changes: 4 additions & 4 deletions src/AppInstallerCommonCore/Public/winget/ManifestCommon.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ namespace AppInstaller::Manifest
const string_t& Id() const { return m_id; };
std::optional<Utility::Version> MinVersion;

Dependency(DependencyType type, string_t id, string_t minVersion) : Type(type), m_id(std::move(id)), MinVersion(Utility::Version(minVersion)), m_foldedId(FoldCase(m_id)) {}
Dependency(DependencyType type, string_t id, string_t minVersion) : Type(type), m_id(std::move(id)), MinVersion(Utility::Version(std::move(minVersion))), m_foldedId(FoldCase(m_id)) {}
Dependency(DependencyType type, string_t id) : Type(type), m_id(std::move(id)), m_foldedId(FoldCase(m_id)){}
Dependency(DependencyType type) : Type(type) {}

Expand All @@ -285,9 +285,9 @@ namespace AppInstaller::Manifest
return m_foldedId < rhs.m_foldedId;
}

bool IsVersionOk(Utility::Version version)
bool IsVersionOk(const Utility::Version& version)
{
return MinVersion <= Utility::Version(version);
return MinVersion <= version;
}

// m_foldedId should be set whenever Id is set
Expand All @@ -313,7 +313,7 @@ namespace AppInstaller::Manifest
void ApplyToAll(std::function<void(const Dependency&)> func) const;
bool Empty() const;
void Clear();
bool HasExactDependency(DependencyType type, string_t id, string_t minVersion = "");
bool HasExactDependency(DependencyType type, const string_t& id, const string_t& minVersion = "");
size_t Size();

private:
Expand Down
Loading