Protocol loads Owners from package sources as an enumerable type (#5751)

Author: donnie-msft

src/NuGet.Clients/NuGet.VisualStudio.Internal.Contracts/TransitivePackageSearchMetadata.cs

@@ -39,6 +39,8 @@ public class TransitivePackageSearchMetadata : IPackageSearchMetadata
 
         public DateTimeOffset? Published => _packageSearchMetadata.Published;
 
+        public IReadOnlyList<string> OwnersList => _packageSearchMetadata.OwnersList;
+
         public string Owners => _packageSearchMetadata.Owners;
 
         public bool RequireLicenseAcceptance => _packageSearchMetadata.RequireLicenseAcceptance;

src/NuGet.Core/NuGet.Protocol/Converters/MetadataStringOrArrayConverter.cs

@@ -0,0 +1,36 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using Newtonsoft.Json;
+
+namespace NuGet.Protocol
+{
+    internal class MetadataStringOrArrayConverter : JsonConverter
+    {
+        public override bool CanConvert(Type objectType) => (objectType == typeof(string) || objectType == typeof(string[]));
+
+        public override bool CanWrite => false;
+
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            if (reader.TokenType == JsonToken.Null || reader.TokenType == JsonToken.None)
+            {
+                return string.Empty;
+            }
+
+            if (reader.TokenType == JsonToken.String)
+            {
+                var str = serializer.Deserialize<string>(reader);
+                return string.IsNullOrWhiteSpace(str) ? null : new string[] { str };
+            }
+
+            return serializer.Deserialize<string[]>(reader);
+        }
+
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/NuGet.Core/NuGet.Protocol/GlobalSuppressions.cs

@@ -230,3 +230,4 @@
 [assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "We convert packageId to lower case for api call.", Scope = "member", Target = "~M:NuGet.Protocol.PackageMetadataResourceV3.GetRegistratioIndexPageAsync(NuGet.Protocol.HttpSource,System.String,System.String,NuGet.Versioning.NuGetVersion,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.HttpSourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)~System.Threading.Tasks.Task{NuGet.Protocol.Model.RegistrationPage}")]
 [assembly: SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "We convert packageId to lower case for api call.", Scope = "member", Target = "~M:NuGet.Protocol.PackageMetadataResourceV3.LoadRegistrationIndexAsync(NuGet.Protocol.HttpSource,System.Uri,System.String,NuGet.Protocol.Core.Types.SourceCacheContext,System.Func{NuGet.Protocol.HttpSourceResult,System.Threading.Tasks.Task{NuGet.Protocol.Model.RegistrationIndex}},NuGet.Common.ILogger,System.Threading.CancellationToken)~System.Threading.Tasks.Task{System.ValueTuple{NuGet.Protocol.Model.RegistrationIndex,NuGet.Protocol.Core.Types.HttpSourceCacheContext}}")]
 [assembly: SuppressMessage("Usage", "CA2237:Mark ISerializable types with serializable", Justification = "<Pending>", Scope = "type", Target = "~T:NuGet.Protocol.PackageNotFoundProtocolException")]
+[assembly: SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "The `Build` method in `src/NuGet.Core/NuGet.Protocol/Model/PackageSearchMetadataBuilder.cs` sets this reference when creating a `ClonedPackageSearchMetadata`.", Scope = "member", Target = "~P:NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.OwnersList")]

src/NuGet.Core/NuGet.Protocol/Model/IPackageSearchMetadata.cs

@@ -27,6 +27,7 @@ public interface IPackageSearchMetadata
         Uri ReportAbuseUrl { get; }
         Uri PackageDetailsUrl { get; }
         DateTimeOffset? Published { get; }
+        IReadOnlyList<string> OwnersList { get; }
         string Owners { get; }
         bool RequireLicenseAcceptance { get; }
         string Summary { get; }

src/NuGet.Core/NuGet.Protocol/Model/LocalPackageSearchMetadata.cs

@@ -42,6 +42,21 @@ public LocalPackageSearchMetadata(LocalPackageInfo package)
 
         public Uri LicenseUrl => Convert(_nuspec.GetLicenseUrl());
 
+        private IReadOnlyList<string> _ownersList;
+
+        public IReadOnlyList<string> OwnersList
+        {
+            get
+            {
+                if (_ownersList is null)
+                {
+                    _ownersList = Owners != null ? Owners.Split(',').Where(s => !string.IsNullOrWhiteSpace(s)).Select(s => s.Trim()).ToList() : null;
+                }
+
+                return _ownersList;
+            }
+        }
+
         public string Owners => _nuspec.GetOwners();
 
         public Uri ProjectUrl => Convert(_nuspec.GetProjectUrl());

src/NuGet.Core/NuGet.Protocol/Model/PackageSearchMetadata.cs

@@ -62,9 +62,35 @@ public PackageIdentity Identity
         [JsonConverter(typeof(SafeUriConverter))]
         public Uri LicenseUrl { get; private set; }
 
+        private IReadOnlyList<string> _ownersList;
+
         [JsonProperty(PropertyName = JsonProperties.Owners)]
-        [JsonConverter(typeof(MetadataFieldConverter))]
-        public string Owners { get; private set; }
+        [JsonConverter(typeof(MetadataStringOrArrayConverter))]
+        public IReadOnlyList<string> OwnersList
+        {
+            get { return _ownersList; }
+            private set
+            {
+                if (_ownersList != value)
+                {
+                    _ownersList = value;
+                    _owners = null;
+                }
+            }
+        }
+
+        private string _owners;
+        public string Owners
+        {
+            get
+            {
+                if (_owners == null)
+                {
+                    _owners = OwnersList != null ? string.Join(", ", OwnersList.Where(s => !string.IsNullOrWhiteSpace(s))) : null;
+                }
+                return _owners;
+            }
+        }
 
         [JsonProperty(PropertyName = JsonProperties.PackageId)]
         public string PackageId { get; private set; }

src/NuGet.Core/NuGet.Protocol/Model/PackageSearchMetadataBuilder.cs

@@ -35,6 +35,7 @@ public class ClonedPackageSearchMetadata : IPackageSearchMetadata
             public Uri IconUrl { get; set; }
             public PackageIdentity Identity { get; set; }
             public Uri LicenseUrl { get; set; }
+            public IReadOnlyList<string> OwnersList { get; set; }
             public string Owners { get; set; }
             public Uri ProjectUrl { get; set; }
             public DateTimeOffset? Published { get; set; }
@@ -92,6 +93,7 @@ public IPackageSearchMetadata Build()
                 IconUrl = _metadata.IconUrl,
                 Identity = _metadata.Identity,
                 LicenseUrl = _metadata.LicenseUrl,
+                OwnersList = _metadata.OwnersList,
                 Owners = _metadata.Owners,
                 ProjectUrl = _metadata.ProjectUrl,
                 Published = _metadata.Published,

src/NuGet.Core/NuGet.Protocol/Model/PackageSearchMetadataV2Feed.cs

@@ -3,7 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading.Tasks;
 using NuGet.Packaging;
 using NuGet.Packaging.Core;
@@ -49,6 +48,7 @@ public PackageSearchMetadataV2Feed(V2FeedPackageInfo package, MetadataReferenceC
             Description = package.Description;
             IconUrl = GetUriSafe(package.IconUrl);
             LicenseUrl = GetUriSafe(package.LicenseUrl);
+            _ownersList = (IReadOnlyList<string>)package.Owners;
             Owners = metadataCache.GetString(string.Join(", ", package.Owners));
             PackageId = package.Id;
             ProjectUrl = GetUriSafe(package.ProjectUrl);
@@ -85,6 +85,9 @@ public PackageSearchMetadataV2Feed(V2FeedPackageInfo package, MetadataReferenceC
 
         public Uri LicenseUrl { get; private set; }
 
+        private IReadOnlyList<string> _ownersList;
+        public IReadOnlyList<string> OwnersList => _ownersList;
+
         public string Owners { get; private set; }
 
         public string PackageId { get; private set; }

src/NuGet.Core/NuGet.Protocol/PublicAPI/net472/PublicAPI.Unshipped.txt

@@ -1 +1,7 @@
 #nullable enable
+~NuGet.Protocol.Core.Types.IPackageSearchMetadata.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>
+~NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>
+~NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.OwnersList.set -> void
+~NuGet.Protocol.LocalPackageSearchMetadata.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>
+~NuGet.Protocol.PackageSearchMetadata.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>
+~NuGet.Protocol.PackageSearchMetadataV2Feed.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>

src/NuGet.Core/NuGet.Protocol/PublicAPI/netcoreapp5.0/PublicAPI.Unshipped.txt

@@ -1 +1,7 @@
 #nullable enable
+~NuGet.Protocol.Core.Types.IPackageSearchMetadata.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>
+~NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>
+~NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder.ClonedPackageSearchMetadata.OwnersList.set -> void
+~NuGet.Protocol.LocalPackageSearchMetadata.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>
+~NuGet.Protocol.PackageSearchMetadata.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>
+~NuGet.Protocol.PackageSearchMetadataV2Feed.OwnersList.get -> System.Collections.Generic.IReadOnlyList<string>