(#59) Add property to IChocolateyPackageSearchMetadata

gep13 · gep13 · commit 693ea0f63855 · 2026-02-24T16:29:14.000Z
This commit adds a new property to the IChocolateyPackageSearchMetadata
interface, and implements this property on all instances of this
interface.

This is required, since we need a mechanism to store the information
about _where_ a package was located.  When running the FindPackage
method in Chocolatey.CLI, the retured metadata class doesn't have this
information, however, at the time of calling this method, we do know
what source is being used, so we can record this information, we just
need a property to store it.  Once stored, it can then be retrieved
furhter upstream as/when required.

Typically, properties on the IChocolateyPackageSearchMetadata interface
don't have a public set, since they are typically initialised when being
created, however, since we are only setting this property once the meta
data is returned, we need there to be a public set method for this
property.
diff --git a/src/NuGet.Clients/NuGet.VisualStudio.Internal.Contracts/PublicAPI.Unshipped.txt b/src/NuGet.Clients/NuGet.VisualStudio.Internal.Contracts/PublicAPI.Unshipped.txt
@@ -1 +1,2 @@
 #nullable enable
+NuGet.VisualStudio.Internal.Contracts.TransitivePackageSearchMetadata.AvailableVersionSource.get -> string!
diff --git a/src/NuGet.Clients/NuGet.VisualStudio.Internal.Contracts/TransitivePackageSearchMetadata.cs b/src/NuGet.Clients/NuGet.VisualStudio.Internal.Contracts/TransitivePackageSearchMetadata.cs
@@ -63,6 +63,7 @@ public partial class TransitivePackageSearchMetadata : IPackageSearchMetadata
 
         public bool PrefixReserved => _packageSearchMetadata.PrefixReserved;
 
+        public string AvailableVersionSource => _packageSearchMetadata.AvailableVersionSource;
         public LicenseMetadata LicenseMetadata => _packageSearchMetadata.LicenseMetadata;
 
         public IEnumerable<PackageVulnerabilityMetadata> Vulnerabilities => _packageSearchMetadata.Vulnerabilities;
diff --git a/src/NuGet.Core/NuGet.Protocol/Model/ChocolateyLocalPackageSearchMetadata.cs b/src/NuGet.Core/NuGet.Protocol/Model/ChocolateyLocalPackageSearchMetadata.cs
@@ -15,6 +15,8 @@ namespace NuGet.Protocol
 {
     public partial class LocalPackageSearchMetadata : IPackageSearchMetadata
     {
+        private string _availableVersionSource;
+
         /// <remarks>
         /// Not applicable to local packages
         /// </remarks>
@@ -187,5 +189,10 @@ public Uri BugTrackerUrl
         /// Not applicable to local packages
         /// </remarks>
         public string PackageScanFlagResult => null;
+
+        /// <remarks>
+        /// Not applicable to local packages
+        /// </remarks>
+        public string AvailableVersionSource { get { return _availableVersionSource; } set { _availableVersionSource = value; } }
     }
 }
diff --git a/src/NuGet.Core/NuGet.Protocol/Model/ChocolateyPackageSearchMetadata.cs b/src/NuGet.Core/NuGet.Protocol/Model/ChocolateyPackageSearchMetadata.cs
@@ -76,5 +76,7 @@ public partial class PackageSearchMetadata : IPackageSearchMetadata
         public DateTime? PackageScanResultDate { get; set; }
         [JsonIgnore]
         public string PackageScanFlagResult { get; set; }
+        [JsonIgnore]
+        public string AvailableVersionSource { get; set; }
     }
 }
diff --git a/src/NuGet.Core/NuGet.Protocol/Model/ChocolateyPackageSearchMetadataV2Feed.cs b/src/NuGet.Core/NuGet.Protocol/Model/ChocolateyPackageSearchMetadataV2Feed.cs
@@ -85,6 +85,7 @@ public IEnumerable<DownloadCache> DownloadCache
         public string PackageScanStatus { get; private set; }
         public DateTime? PackageScanResultDate { get; private set; }
         public string PackageScanFlagResult { get; private set; }
+        public string AvailableVersionSource { get; set; }
 
         private void FinishInitialization(V2FeedPackageInfo package)
         {
diff --git a/src/NuGet.Core/NuGet.Protocol/Model/IChocolateyPackageSearchMetadata.cs b/src/NuGet.Core/NuGet.Protocol/Model/IChocolateyPackageSearchMetadata.cs
@@ -44,5 +44,7 @@ public partial interface IPackageSearchMetadata
         string PackageScanStatus { get; }
         DateTime? PackageScanResultDate { get; }
         string PackageScanFlagResult { get; }
+
+        string AvailableVersionSource { get; set; }
     }
 }
diff --git a/src/NuGet.Core/NuGet.Protocol/Model/PackageSearchMetadataBuilder.cs b/src/NuGet.Core/NuGet.Protocol/Model/PackageSearchMetadataBuilder.cs
@@ -77,6 +77,7 @@ public partial class ClonedPackageSearchMetadata : IPackageSearchMetadata
             [Obsolete("PackagePath is recommended in place of PackageReader")]
             public Func<PackageReaderBase> PackageReader { get; set; }
             public string PackagePath { get; set; }
+            public string AvailableVersionSource { get; set; }
         }
 
         private PackageSearchMetadataBuilder(IPackageSearchMetadata metadata)
@@ -167,7 +168,7 @@ public IPackageSearchMetadata Build()
                 DownloadCacheStatus = _metadata.DownloadCacheStatus,
                 PackageScanStatus = _metadata.PackageScanStatus,
                 PackageScanResultDate = _metadata.PackageScanResultDate,
-                PackageScanFlagResult = _metadata.PackageScanFlagResult,
+                PackageScanFlagResult = _metadata.PackageScanFlagResult
 
                 //////////////////////////////////////////////////////////
                 // End - Chocolatey Specific Modification
diff --git a/src/NuGet.Core/NuGet.Protocol/PublicAPI/net472/PublicAPI.Unshipped.txt b/src/NuGet.Core/NuGet.Protocol/PublicAPI/net472/PublicAPI.Unshipped.txt
@@ -0,0 +1,10 @@
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.set -> void
diff --git a/src/NuGet.Core/NuGet.Protocol/PublicAPI/netcoreapp5.0/PublicAPI.Unshipped.txt b/src/NuGet.Core/NuGet.Protocol/PublicAPI/netcoreapp5.0/PublicAPI.Unshipped.txt
@@ -0,0 +1,10 @@
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.set -> void
diff --git a/src/NuGet.Core/NuGet.Protocol/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt b/src/NuGet.Core/NuGet.Protocol/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt
@@ -0,0 +1,10 @@
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.IPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.LocalPackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadata.AvailableVersionSource.set -> void
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.get -> string
+NuGet.Protocol.PackageSearchMetadataV2Feed.AvailableVersionSource.set -> void
diff --git a/test/NuGet.Clients.Tests/NuGet.PackageManagement.UI.Test/ChocolateyTestPackageSearchMetadata.cs b/test/NuGet.Clients.Tests/NuGet.PackageManagement.UI.Test/ChocolateyTestPackageSearchMetadata.cs
@@ -43,5 +43,6 @@ partial class TestPackageSearchMetadata : IPackageSearchMetadata
         public string PackageScanStatus { get; set; }
         public DateTime? PackageScanResultDate { get; set; }
         public string PackageScanFlagResult { get; set; }
+        public string AvailableVersionSource { get; set; }
     }
 }
diff --git a/test/TestUtilities/Test.Utility/Protocol/ChocolateyV3PackageSearchMetadataFixture.cs b/test/TestUtilities/Test.Utility/Protocol/ChocolateyV3PackageSearchMetadataFixture.cs
@@ -45,6 +45,7 @@ public partial class MockPackageSearchMetadata : IPackageSearchMetadata
             public string PackageScanStatus => null;
             public DateTime? PackageScanResultDate => null;
             public string PackageScanFlagResult => null;
+            public string AvailableVersionSource => null;
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`#nullable enable`
	`2`	`+NuGet.VisualStudio.Internal.Contracts.TransitivePackageSearchMetadata.AvailableVersionSource.get -> string!`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ namespace NuGet.Protocol`
`15`	`15`	`{`
`16`	`16`	`public partial class LocalPackageSearchMetadata : IPackageSearchMetadata`
`17`	`17`	`{`
	`18`	`+ private string _availableVersionSource;`
	`19`	`+`
`18`	`20`	`/// <remarks>`
`19`	`21`	`/// Not applicable to local packages`
`20`	`22`	`/// </remarks>`
`@@ -187,5 +189,10 @@ public Uri BugTrackerUrl`
`187`	`189`	`/// Not applicable to local packages`
`188`	`190`	`/// </remarks>`
`189`	`191`	`public string PackageScanFlagResult => null;`
	`192`	`+`
	`193`	`+ /// <remarks>`
	`194`	`+ /// Not applicable to local packages`
	`195`	`+ /// </remarks>`
	`196`	`+ public string AvailableVersionSource { get { return _availableVersionSource; } set { _availableVersionSource = value; } }`
`190`	`197`	`}`
`191`	`198`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,5 +76,7 @@ public partial class PackageSearchMetadata : IPackageSearchMetadata`
`76`	`76`	`public DateTime? PackageScanResultDate { get; set; }`
`77`	`77`	`[JsonIgnore]`
`78`	`78`	`public string PackageScanFlagResult { get; set; }`
	`79`	`+ [JsonIgnore]`
	`80`	`+ public string AvailableVersionSource { get; set; }`
`79`	`81`	`}`
`80`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,7 @@ public IEnumerable<DownloadCache> DownloadCache`
`85`	`85`	`public string PackageScanStatus { get; private set; }`
`86`	`86`	`public DateTime? PackageScanResultDate { get; private set; }`
`87`	`87`	`public string PackageScanFlagResult { get; private set; }`
	`88`	`+ public string AvailableVersionSource { get; set; }`
`88`	`89`
`89`	`90`	`private void FinishInitialization(V2FeedPackageInfo package)`
`90`	`91`	`{`
Original file line number	Diff line number	Diff line change
`@@ -44,5 +44,7 @@ public partial interface IPackageSearchMetadata`
`44`	`44`	`string PackageScanStatus { get; }`
`45`	`45`	`DateTime? PackageScanResultDate { get; }`
`46`	`46`	`string PackageScanFlagResult { get; }`
	`47`	`+`
	`48`	`+ string AvailableVersionSource { get; set; }`
`47`	`49`	`}`
`48`	`50`	`}`