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

Jump to bottom

Show Vulnerable label in versions combobox #5185

Merged
merged 2 commits into from
May 30, 2023
Merged

Show Vulnerable label in versions combobox #5185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44a65b5
add vulnerable info in versions combobox
martinrrm Apr 21, 2023
869673a
removed constructor
martinrrm May 23, 2023
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
26 changes: 23 additions & 3 deletions src/NuGet.Clients/NuGet.PackageManagement.UI/DisplayVersion.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public DisplayVersion(
bool autoReferenced = false,
bool isDeprecated = false,
string versionFormat = "N")
: this(range, version: null, additionalInfo, isValidVersion, isCurrentInstalled, autoReferenced, isDeprecated, versionFormat)
: this(range, version: null, additionalInfo, isValidVersion, isCurrentInstalled, autoReferenced, isDeprecated, isVulnerable: false, versionFormat)
{
}

Expand All @@ -48,6 +48,7 @@ public DisplayVersion(
bool isCurrentInstalled = false,
bool autoReferenced = false,
bool isDeprecated = false,
bool isVulnerable = false,
string versionFormat = "N")
{
if (versionFormat == null)
Expand All @@ -65,6 +66,7 @@ public DisplayVersion(
IsCurrentInstalled = isCurrentInstalled;
AutoReferenced = autoReferenced;
IsDeprecated = isDeprecated;
IsVulnerable = isVulnerable;

// Display a single version if the range is locked
if (range.OriginalString == null && range.HasLowerAndUpperBounds && range.MinVersion == range.MaxVersion)
Expand All @@ -83,13 +85,28 @@ public DisplayVersion(
AdditionalInfo + " " + Range.OriginalString;
}

if (IsDeprecated)
if (IsDeprecated && IsVulnerable)
{
_toString += string.Format(
CultureInfo.CurrentCulture,
" ({0}, {1})",
Resources.Label_Vulnerable,
Resources.Label_Deprecated);
}
else if (IsDeprecated)
{
_toString += string.Format(
CultureInfo.CurrentCulture,
" ({0})",
Resources.Label_Deprecated);
}
else if (IsVulnerable)
{
_toString += string.Format(
CultureInfo.CurrentCulture,
" ({0})",
Resources.Label_Vulnerable);
}
}

public bool IsCurrentInstalled { get; set; }
Expand All @@ -104,6 +121,8 @@ public DisplayVersion(

public bool IsDeprecated { get; set; }

public bool IsVulnerable { get; set; }

public override string ToString()
{
return _toString;
Expand All @@ -115,7 +134,8 @@ public override bool Equals(object obj)
return other != null
&& other.Version == Version
&& string.Equals(other.AdditionalInfo, AdditionalInfo, StringComparison.Ordinal)
&& IsDeprecated == other.IsDeprecated;
&& IsDeprecated == other.IsDeprecated
&& IsVulnerable == other.IsVulnerable;
}

public override int GetHashCode()
Expand Down
12 changes: 7 additions & 5 deletions src/NuGet.Clients/NuGet.PackageManagement.UI/Models/DetailControlModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public abstract class DetailControlModel : INotifyPropertyChanged, IDisposable

// all versions of the _searchResultPackage
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1051:DoNotDeclareVisibleInstanceFields")]
protected List<(NuGetVersion version, bool isDeprecated)> _allPackageVersions;
protected List<(NuGetVersion version, bool isDeprecated, bool isVulnerable)> _allPackageVersions;

[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1051:DoNotDeclareVisibleInstanceFields")]
protected PackageItemViewModel _searchResultPackage;
Expand Down Expand Up @@ -219,9 +219,9 @@ public async virtual Task SetCurrentPackageAsync(
}

// Show the current package version as the only package in the list at first just in case fetching the versions takes a while.
_allPackageVersions = new List<(NuGetVersion version, bool isDeprecated)>()
_allPackageVersions = new List<(NuGetVersion version, bool isDeprecated, bool isVulnerable)>()
{
(searchResultPackage.Version, false)
(searchResultPackage.Version, false, false)
};

await CreateVersionsAsync(CancellationToken.None);
Expand Down Expand Up @@ -269,15 +269,17 @@ public async virtual Task SetCurrentPackageAsync(
}
}

private (NuGetVersion version, bool isDeprecated) GetVersion(VersionInfoContextInfo versionInfo)
private (NuGetVersion version, bool isDeprecated, bool isVulnerable) GetVersion(VersionInfoContextInfo versionInfo)
{
var isDeprecated = false;
var isVulnerable = false;
if (versionInfo.PackageSearchMetadata != null)
{
isDeprecated = versionInfo.PackageDeprecationMetadata != null;
isVulnerable = versionInfo.PackageSearchMetadata.Vulnerabilities != null;
}

return (versionInfo.Version, isDeprecated);
return (versionInfo.Version, isDeprecated, isVulnerable);
}

protected virtual void DependencyBehavior_SelectedChanged(object sender, EventArgs e)
Expand Down
15 changes: 8 additions & 7 deletions src/NuGet.Clients/NuGet.PackageManagement.UI/Models/PackageDetailControlModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,14 +141,14 @@ protected override Task CreateVersionsAsync(CancellationToken cancellationToken)
// installVersion is null if the package is not installed
var installedVersion = installedDependency?.VersionRange;

List<(NuGetVersion version, bool isDeprecated)> allVersions = _allPackageVersions?.OrderByDescending(v => v.version).ToList();
List<(NuGetVersion version, bool isDeprecated, bool isVulnerable)> allVersions = _allPackageVersions?.OrderByDescending(v => v.version).ToList();

// null, if no version constraint defined in package.config
VersionRange allowedVersions = _projectVersionConstraints.Select(e => e.VersionRange).FirstOrDefault();
// null, if all versions are allowed to be install or update
var blockedVersions = new List<NuGetVersion>(allVersions.Count);

List<(NuGetVersion version, bool isDeprecated)> allVersionsAllowed;
List<(NuGetVersion version, bool isDeprecated, bool isVulnerable)> allVersionsAllowed;
if (allowedVersions == null)
{
allowedVersions = VersionRange.All;
Expand All @@ -157,7 +157,7 @@ protected override Task CreateVersionsAsync(CancellationToken cancellationToken)
else
{
allVersionsAllowed = allVersions.Where(v => allowedVersions.Satisfies(v.version)).ToList();
foreach ((NuGetVersion version, bool isDeprecated) in allVersions)
foreach ((NuGetVersion version, bool isDeprecated, bool isVulnerable) in allVersions)
{
if (!allVersionsAllowed.Any(a => a.version.Version.Equals(version.Version)))
{
Expand All @@ -175,7 +175,8 @@ protected override Task CreateVersionsAsync(CancellationToken cancellationToken)
VersionRange installedVersionRange = VersionRange.Parse(installedDependency.VersionRange.OriginalString, true);
NuGetVersion bestVersion = installedVersionRange.FindBestMatch(allVersionsAllowed.Select(v => v.version));
var deprecationInfo = allVersionsAllowed.FirstOrDefault(v => v.version == bestVersion).isDeprecated;
DisplayVersion displayVersion = new DisplayVersion(installedVersionRange, bestVersion, additionalInfo: string.Empty, isDeprecated: deprecationInfo);
var vulnerableInfo = allVersionsAllowed.FirstOrDefault(v => v.version == bestVersion).isVulnerable;
DisplayVersion displayVersion = new DisplayVersion(installedVersionRange, bestVersion, additionalInfo: string.Empty, isDeprecated: deprecationInfo, isVulnerable: vulnerableInfo);

_versions.Add(displayVersion);
}
Expand All @@ -188,15 +189,15 @@ protected override Task CreateVersionsAsync(CancellationToken cancellationToken)
(isInstalledFloatingOrRange || !latestPrerelease.version.Equals(installedVersion?.MinVersion)))
{
VersionRange latestPrereleaseVersionRange = VersionRange.Parse(latestPrerelease.version.ToString(), allowFloating: false);
_versions.Add(new DisplayVersion(latestPrereleaseVersionRange, latestPrerelease.version, Resources.Version_LatestPrerelease, isDeprecated: latestPrerelease.isDeprecated));
_versions.Add(new DisplayVersion(latestPrereleaseVersionRange, latestPrerelease.version, Resources.Version_LatestPrerelease, isDeprecated: latestPrerelease.isDeprecated, isVulnerable: latestPrerelease.isVulnerable));
}

// Add latest stable if needed
if (latestStableVersion.version != null &&
(isInstalledFloatingOrRange || !latestStableVersion.version.Equals(InstalledVersion)))
{
VersionRange latestStableVersionRange = VersionRange.Parse(latestStableVersion.version.ToString(), allowFloating: false);
_versions.Add(new DisplayVersion(latestStableVersionRange, latestStableVersion.version, Resources.Version_LatestStable, isDeprecated: latestStableVersion.isDeprecated));
_versions.Add(new DisplayVersion(latestStableVersionRange, latestStableVersion.version, Resources.Version_LatestStable, isDeprecated: latestStableVersion.isDeprecated, isVulnerable: latestStableVersion.isVulnerable));
}

// add a separator
Expand All @@ -218,7 +219,7 @@ protected override Task CreateVersionsAsync(CancellationToken cancellationToken)
}

VersionRange versionRange = VersionRange.Parse(version.version.ToString(), allowFloating: false);
_versions.Add(new DisplayVersion(versionRange, version.version, additionalInfo: null, isCurrentInstalled: installed, autoReferenced: autoReferenced, isDeprecated: version.isDeprecated));
_versions.Add(new DisplayVersion(versionRange, version.version, additionalInfo: null, isCurrentInstalled: installed, autoReferenced: autoReferenced, isDeprecated: version.isDeprecated, isVulnerable: version.isVulnerable));
}

// Disable controls if this is an auto referenced package.
Expand Down
4 changes: 2 additions & 2 deletions src/NuGet.Clients/NuGet.PackageManagement.UI/Models/PackageSolutionDetailControlModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +205,14 @@ protected override async Task CreateVersionsAsync(CancellationToken cancellation
}

_versions.Clear();
List<(NuGetVersion version, bool isDeprecated)> allVersions = _allPackageVersions?.Where(v => v.version != null).OrderByDescending(v => v.version).ToList();
List<(NuGetVersion version, bool isDeprecated, bool isVulnerable)> allVersions = _allPackageVersions?.Where(v => v.version != null).OrderByDescending(v => v.version).ToList();

// null, if no version constraint defined in package.config
VersionRange allowedVersions = await GetAllowedVersionsAsync(cancellationToken);
var allVersionsAllowed = allVersions.Where(v => allowedVersions.Satisfies(v.version)).ToArray();

var blockedVersions = new List<NuGetVersion>(allVersions.Count);
foreach ((NuGetVersion version, bool isDeprecated) in allVersions)
foreach ((NuGetVersion version, bool isDeprecated, bool isVulnerable) in allVersions)
{
if (!allVersionsAllowed.Any(a => a.version.Version.Equals(version.Version)))
{
Expand Down
9 changes: 9 additions & 0 deletions src/NuGet.Clients/NuGet.PackageManagement.UI/Resources.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions src/NuGet.Clients/NuGet.PackageManagement.UI/Resources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -990,4 +990,7 @@ Please see https://aka.ms/troubleshoot_nuget_cache for more help.</value>
<data name="Text_PackageMappingsDisabled" xml:space="preserve">
<value>Package source mapping is off.</value>
</data>
<data name="Label_Vulnerable" xml:space="preserve">
<value>Vulnerable</value>
</data>
</root>
6 changes: 2 additions & 4 deletions src/NuGet.Clients/NuGet.PackageManagement.UI/Xamls/ProjectView.xaml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Input;
using Microsoft.TeamFoundation.Common;
using NuGet.Versioning;

namespace NuGet.PackageManagement.UI
Expand Down Expand Up @@ -170,7 +168,7 @@ protected override void OnKeyUp(KeyEventArgs e)
bool isBestOption = rangeBestVersion.ToString() == _versions.Items[_versions.SelectedIndex].ToString();
if (isBestOption)
{
PackageDetailControlModel.SelectedVersion = new DisplayVersion(userRequestedVersionRange, rangeBestVersion, additionalInfo: null);
PackageDetailControlModel.SelectedVersion = new DisplayVersion(userRequestedVersionRange, rangeBestVersion, additionalInfo: null, isVulnerable: false);
_versions.Text = comboboxText;
}
else
Expand Down Expand Up @@ -253,7 +251,7 @@ private void SetComboboxCurrentVersion(string comboboxText, IEnumerable<NuGetVer
if (currentItem != null && (comboboxText == _versions.Items[i].ToString() || _versions.Items[i].ToString() == matchVersion?.ToString()))
{
_versions.SelectedIndex = i; // This is the "select" effect in the dropdown
PackageDetailControlModel.SelectedVersion = new DisplayVersion(userRange, matchVersion, additionalInfo: null);
PackageDetailControlModel.SelectedVersion = new DisplayVersion(userRange, matchVersion, additionalInfo: null, isVulnerable: currentItem.IsVulnerable);
}
}
}
Expand Down