Merge pull request #13 from meokullu/new_version_0001

meokullu · web-flow · commit 421c0e0531bb · 2025-11-24T16:20:36.000+03:00
New version 0001
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,16 @@
 #### Security
 -->
 
+### [1.3.0] (2025-11-24)
+#### Added
+* Null check for return package data in `CheckVersionAsync(string path, bool includePrerelease)` method. If it is null, return empty list of Packages.
+* Null check for return package data in `CheckVersionAsync(List<string> pathList, bool includePrerelease)` method. If it is null, return empty list of Packages.
+* Network availability check before making NuGet API calls in `GetPackageFromNuGetAsync(string packageName, bool includePrerelease)` method. If network is unavailable, it return empty Package.
+* Network availability check before making NuGet API calls in `GetPackagesFromNuGetAsync(List<string> packageNameList, bool includePrerelease)` method. If network is unavailable, it return empty list of Packages.
+
+#### Changed
+* Updated NuGet.Protocol package to the 6.14.0 version.
+
 ### [1.2.0] (2024-07-07)
 #### Added
 * `PackageEqualityComparer` class is added into `Package`. It has `Equal(Package x, Package y)` and `GetHashCode(Package obj)` interface methods of `IEqualityComparer<Package>`.
diff --git a/NuGetVersionChecker/NuGetVersionChecker.csproj b/NuGetVersionChecker/NuGetVersionChecker.csproj
@@ -11,22 +11,25 @@
     <RepositoryType>git</RepositoryType>
     <PackageTags>version; version-checker; version-compare; NuGet; Nuget-Package; version-check; Dependency</PackageTags>
     <PackageReleaseNotes>
-      v1.2.0
-      PackageEqualityComparer added which is derived from IEqualityComparer.
-      CheckVersionAsync() method is added to compare versions as a list of Package.
-      GetPackageFromNuGetAsync() and GetPackagesFromNuGetAsync() method have now includePrerelease option parameter which is set false default to determine if prerelease packages are included during search from NuGet API.      
+		v1.3.0
+		* Null check for return package data in `CheckVersionAsync(string path, bool includePrerelease)` method. If it is null, return empty list of Packages.
+		* Null check for return package data in `CheckVersionAsync(List&lt;string&gt;
+			pathList, bool includePrerelease)` method. If it is null, return empty list of Packages.
+		* Network availability check before making NuGet API calls in `GetPackageFromNuGetAsync(string packageName, bool includePrerelease)` method. If network is unavailable, it return empty Package.
+		* Network availability check before making NuGet API calls in `GetPackagesFromNuGetAsync(List&lt;string&gt; packageNameList, bool includePrerelease)` method. If network is unavailable, it return empty list of Packages.	  
+	  
       See changelog (https://github.com/meokullu/NuGetVersionChecker/blob/master/CHANGELOG.md)
     </PackageReleaseNotes>
-    <AssemblyVersion>1.2.0</AssemblyVersion>
-    <FileVersion>1.2.0</FileVersion>
+    <AssemblyVersion>1.3.0</AssemblyVersion>
+    <FileVersion>1.3.0</FileVersion>
     <Title>Nuget Version Checker</Title>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageProjectUrl>https://meokullu.github.io/NuGetVersionChecker/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/meokullu/NuGetVersionChecker</RepositoryUrl>
     <ApplicationIcon>Resources\icon256.ico</ApplicationIcon>
     <Copyright>Enes Okullu</Copyright>
     <PackageIcon>icon128.png</PackageIcon>
-    <Version>1.2.0</Version>
+    <Version>1.3.0</Version>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
   </PropertyGroup>
 
@@ -63,7 +66,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="NuGet.Protocol" Version="6.10.0">
+    <PackageReference Include="NuGet.Protocol" Version="6.14.0">
     </PackageReference>
   </ItemGroup>
 
diff --git a/NuGetVersionChecker/src/GetPackageFromNuGet.cs b/NuGetVersionChecker/src/GetPackageFromNuGet.cs
@@ -1,11 +1,11 @@
 ﻿using NuGet.Common;
 using NuGet.Protocol;
 using NuGet.Protocol.Core.Types;
-using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
+using System.Net.NetworkInformation;
 
 namespace NuGetVersionChecker
 {
@@ -30,61 +30,18 @@ public partial class NuGetVersionChecker
         /// <returns>Returns a package.</returns>
         public static async Task<Package> GetPackageFromNuGetAsync(string packageName, bool includePrerelease = true)
         {
-            PackageSearchResource resource = await s_repository.GetResourceAsync<PackageSearchResource>();
-            SearchFilter searchFilter = new SearchFilter(includePrerelease: includePrerelease);
-
-            // Making a search with taking one package.
-            IEnumerable<IPackageSearchMetadata> searchResults = await resource.SearchAsync(
-            packageName,
-            searchFilter,
-            skip: 0,
-            take: 1,
-            s_logger,
-            s_cancellationToken);
-
-            // Getting only one value from the list. Since it takes only 1, it is "Single" instead of "First".
-            IPackageSearchMetadata package = searchResults.SingleOrDefault();
-
-            // Checking if package is null.
-            if (package == null)
+            // Quick check for network availability to avoid unnecessary network calls when offline.
+            if (NetworkInterface.GetIsNetworkAvailable() == false)
             {
                 return new Package();
             }
 
-            // Get version info of list of the package.
-            IEnumerable<VersionInfo> versionInfoList = await package.GetVersionsAsync();
-
-            // Checking if versionInfoList is null or empty.
-            if (versionInfoList == null || versionInfoList.Any() == false)
+            try
             {
-                return new Package();
-            }
-
-            // Get latets version of the list of versions.
-            VersionInfo versionInfo = versionInfoList.OrderByDescending(p => p.Version).First();
-
-            // Returning a Package via creating with its constructor.
-            return new Package(name: package.Identity.Id, version: versionInfo.Version);
-        }
+                PackageSearchResource resource = await s_repository.GetResourceAsync<PackageSearchResource>();
+                SearchFilter searchFilter = new SearchFilter(includePrerelease: includePrerelease);
 
-        /// <summary>
-        /// Returns list of packages by making search on NuGet.
-        /// </summary>
-        /// <param name="packageNameList">List of package names.</param>
-        /// <param name="includePrerelease">Include Prerelease version to compare versions.</param>
-        /// <returns>List of packages.</returns>
-        public static async Task<List<Package>> GetPackagesFromNuGetAsync(List<string> packageNameList, bool includePrerelease = true)
-        {
-            PackageSearchResource resource = await s_repository.GetResourceAsync<PackageSearchResource>();
-            SearchFilter searchFilter = new SearchFilter(includePrerelease: includePrerelease);
-
-            // Return value.
-            List<Package> packageList = new List<Package>();
-
-            // Loop for given list of package name.
-            foreach (string packageName in packageNameList)
-            {
-                //
+                // Making a search with taking one package.
                 IEnumerable<IPackageSearchMetadata> searchResults = await resource.SearchAsync(
                 packageName,
                 searchFilter,
@@ -99,33 +56,105 @@ public static async Task<List<Package>> GetPackagesFromNuGetAsync(List<string> p
                 // Checking if package is null.
                 if (package == null)
                 {
-                    continue;
+                return new Package();
                 }
 
-                // Get latest version info of newest version of the package.
+                // Get version info of list of the package.
                 IEnumerable<VersionInfo> versionInfoList = await package.GetVersionsAsync();
 
                 // Checking if versionInfoList is null or empty.
                 if (versionInfoList == null || versionInfoList.Any() == false)
                 {
-                    continue;
+                return new Package();
                 }
 
-                // Get latest version of the list of versions.
+                // Get latets version of the list of versions.
                 VersionInfo versionInfo = versionInfoList.OrderByDescending(p => p.Version).First();
 
-                // Checking if versionInfo is null.
-                if (versionInfo == null)
+                // Returning a Package via creating with its constructor.
+                return new Package(name: package.Identity.Id, version: versionInfo.Version);
+            }
+            catch
+            {
+                // If any network or runtime error occurs, return empty package.
+                return new Package();
+            }
+        }
+
+        /// <summary>
+        /// Returns list of packages by making search on NuGet.
+        /// </summary>
+        /// <param name="packageNameList">List of package names.</param>
+        /// <param name="includePrerelease">Include Prerelease version to compare versions.</param>
+        /// <returns>List of packages.</returns>
+        public static async Task<List<Package>> GetPackagesFromNuGetAsync(List<string> packageNameList, bool includePrerelease = true)
+        {
+            // Return value.
+            List<Package> packageList = new List<Package>();
+
+            // Quick check for network availability to avoid unnecessary network calls when offline.
+            if (NetworkInterface.GetIsNetworkAvailable() == false)
+            {
+                return packageList;
+            }
+
+            try
+            {
+                PackageSearchResource resource = await s_repository.GetResourceAsync<PackageSearchResource>();
+                SearchFilter searchFilter = new SearchFilter(includePrerelease: includePrerelease);
+
+                
+                // Loop for given list of package name.
+                foreach (string packageName in packageNameList)
                 {
-                    continue;
+                    //
+                    IEnumerable<IPackageSearchMetadata> searchResults = await resource.SearchAsync(
+                    packageName,
+                    searchFilter,
+                    skip: 0,
+                    take: 1,
+                    s_logger,
+                    s_cancellationToken);
+
+                    // Getting only one value from the list. Since it takes only 1, it is "Single" instead of "First".
+                    IPackageSearchMetadata package = searchResults.SingleOrDefault();
+
+                    // Checking if package is null.
+                    if (package == null)
+                    {
+                        continue;
+                    }
+
+                    // Get latest version info of newest version of the package.
+                    IEnumerable<VersionInfo> versionInfoList = await package.GetVersionsAsync();
+
+                    // Checking if versionInfoList is null or empty.
+                    if (versionInfoList == null || versionInfoList.Any() == false)
+                    {
+                        continue;
+                    }
+
+                    // Get latest version of the list of versions.
+                    VersionInfo versionInfo = versionInfoList.OrderByDescending(p => p.Version).First();
+
+                    // Checking if versionInfo is null.
+                    if (versionInfo == null)
+                    {
+                        continue;
+                    }
+
+                    // Adding the Package via creating with its constructor.
+                    packageList.Add(new Package(name: package.Identity.Id, version: versionInfo.Version));
                 }
 
-                // Adding the Package via creating with its constructor.
-                packageList.Add(new Package(name: package.Identity.Id, version: versionInfo.Version));
+                // Retuning list of packages as return data.
+                return packageList;
+            }
+            catch
+            {
+                // If any network or runtime error occurs, return list of empty packages.
+                return packageList;
             }
-
-            // Retuning list of packages as return data.
-            return packageList;
         }
     }
 }
diff --git a/NuGetVersionChecker/src/Package.cs b/NuGetVersionChecker/src/Package.cs
@@ -87,7 +87,7 @@ public bool Equals(Package x, Package y)
                     if (x == null || y == null)
                     {
                         // Returning false to indicate at least one of packages is null.
-                        return false; 
+                        return false;
                     }
                     // Checking if two given package's property values are same.
                     else if (x.Name == y.Name && x.Version == y.Version)
@@ -113,5 +113,5 @@ public int GetHashCode(Package obj)
                 }
             }
         }
-    }    
+    }
 }
diff --git a/NuGetVersionChecker/src/ParseFile.cs b/NuGetVersionChecker/src/ParseFile.cs
@@ -50,7 +50,7 @@ public static List<Package> GetPackages(string path)
                 {
                     // Checking if node is null.
                     if (xmlNode == null)
-                    {   
+                    {
                         continue;
                     }
 
diff --git a/NuGetVersionChecker/src/VersionChecker.cs b/NuGetVersionChecker/src/VersionChecker.cs
@@ -1,5 +1,4 @@
 ﻿using System.Collections.Generic;
-using System.Diagnostics;
 using System.Linq;
 using System.Threading.Tasks;
 using static NuGetVersionChecker.NuGetVersionChecker.Package;
@@ -33,6 +32,12 @@ public static async Task<List<Package>> CheckVersionAsync(string path, bool incl
                 packageNameList: usedPackages.Select(p => p.Name).ToList(),
                 includePrerelease: includePrerelease);
 
+            // Check if nuget packages is null or empty.
+            if (nugetPackages == null || nugetPackages.Count == 0)
+            {
+                return packages;
+            }
+
             // Loop for packages
             foreach (Package package in usedPackages)
             {
@@ -89,6 +94,12 @@ public static async Task<List<Package>> CheckVersionAsync(List<string> pathList,
                 packageNameList: disctinctUsedPackage.Select(p => p.Name).ToList(),
                 includePrerelease: includePrerelease);
 
+            // Check if nuget packages is null or empty.
+            if (nugetPackages == null || nugetPackages.Count == 0)
+            {
+                return packages;
+            }
+
             // Loop for packages
             foreach (Package package in usedPackages)
             {

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ public bool Equals(Package x, Package y)`
`87`	`87`	`if (x == null \|\| y == null)`
`88`	`88`	`{`
`89`	`89`	`// Returning false to indicate at least one of packages is null.`
`90`		`- return false;`
	`90`	`+ return false;`
`91`	`91`	`}`
`92`	`92`	`// Checking if two given package's property values are same.`
`93`	`93`	`else if (x.Name == y.Name && x.Version == y.Version)`
`@@ -113,5 +113,5 @@ public int GetHashCode(Package obj)`
`113`	`113`	`}`
`114`	`114`	`}`
`115`	`115`	`}`
`116`		`- }`
	`116`	`+ }`
`117`	`117`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public static List<Package> GetPackages(string path)`
`50`	`50`	`{`
`51`	`51`	`// Checking if node is null.`
`52`	`52`	`if (xmlNode == null)`
`53`		`- {`
	`53`	`+ {`
`54`	`54`	`continue;`
`55`	`55`	`}`
`56`	`56`