Introduce a version-specific ID column for display purposes (#8504)

* Add new ID column to packages table
* Add field length

Progress on #3349

Author: joelverhagen

src/NuGet.Services.Entities/Package.cs

@@ -12,6 +12,7 @@ namespace NuGet.Services.Entities
     public class Package
         : IPackageEntity
     {
+        private string _id;
 
 #pragma warning disable 618 // TODO: remove Package.Authors completely once production services definitely no longer need it
         public Package()
@@ -264,7 +265,17 @@ public bool HasEmbeddedReadme
 
         public virtual ICollection<SymbolPackage> SymbolPackages { get; set; }
 
-        public string Id => PackageRegistration.Id;
+        /// <summary>
+        /// The package ID with casing specific to this version if available, otherwise it will fallback to the ID on
+        /// the package registration. WARNING: this property should not be used for comparisons in LINQ to SQL because
+        /// it may be null sometimes. Use <see cref="PackageRegistration.Id"/> instead.
+        /// </summary>
+        [StringLength(Constants.MaxPackageIdLength)]
+        public string Id
+        {
+            get => _id ?? PackageRegistration?.Id;
+            set => _id = value;
+        }
 
         public EmbeddedLicenseFileType EmbeddedLicenseType { get; set; }
 

src/NuGetGallery.Core/Services/CorePackageService.cs

@@ -202,6 +202,17 @@ public virtual async Task UpdateIsLatestAsync(PackageRegistration packageRegistr
                 }
             }
 
+            // Update the ID on the PackageRegistration if the value differs only by case from the absolute latest
+            // (stable or prerelease) SemVer 2.0.0 package. This is a best effort flow because in general package IDs
+            // are compared in a case-insensitive manner and therefore the PackageRegistration ID casing should not
+            // have any functional impact. The specific casing is only a display concern.
+            if (latestSemVer2Package != null
+                && string.Equals(latestSemVer2Package.Id, packageRegistration.Id, StringComparison.OrdinalIgnoreCase)
+                && !string.Equals(latestSemVer2Package.Id, packageRegistration.Id, StringComparison.Ordinal))
+            {
+                packageRegistration.Id = latestSemVer2Package.Id;
+            }
+
             if (commitChanges)
             {
                 await _packageRepository.CommitChangesAsync();

src/NuGetGallery.Services/PackageManagement/PackageService.cs

@@ -636,6 +636,8 @@ public virtual Package EnrichPackageFromNuGetPackage(
             PackageStreamMetadata packageStreamMetadata,
             User user)
         {
+            package.Id = packageMetadata.Id;
+
             // Version must always be the exact string from the nuspec, which OriginalVersion will return to us.
             // However, we do also store a normalized copy for looking up later.
             package.Version = packageMetadata.Version.OriginalVersion;

src/NuGetGallery/Areas/Admin/Controllers/DeleteController.cs

@@ -109,7 +109,7 @@ private DeleteSearchResult CreateDeleteSearchResult(Package package)
         {
             return new DeleteSearchResult
             {
-                PackageId = package.PackageRegistration.Id,
+                PackageId = package.Id,
                 PackageVersionNormalized = !string.IsNullOrEmpty(package.NormalizedVersion)
                     ? package.NormalizedVersion 
                     : NuGetVersion.Parse(package.Version).ToNormalizedString(),

src/NuGetGallery/Helpers/ViewModelExtensions/PackageViewModelFactory.cs

@@ -35,7 +35,7 @@ public PackageViewModel Setup(PackageViewModel viewModel, Package package)
 
             viewModel.FullVersion = NuGetVersionFormatter.ToFullString(package.Version);
 
-            viewModel.Id = package.PackageRegistration.Id;
+            viewModel.Id = package.Id;
             viewModel.Version = String.IsNullOrEmpty(package.NormalizedVersion) ?
                 NuGetVersionFormatter.Normalize(package.Version) :
                 package.NormalizedVersion;

src/NuGetGallery/Infrastructure/LuceneDocumentFactory.cs

@@ -49,23 +49,23 @@ public Document Create(Package package)
 
             // Style 1: As-Is Id, no tokenizing (so you can search using dot or dash-joined terms)
             // Boost this one
-            field = new Field("Id", package.PackageRegistration.Id, Field.Store.NO, Field.Index.ANALYZED);
+            field = new Field("Id", package.Id, Field.Store.NO, Field.Index.ANALYZED);
             document.Add(field);
 
             // Style 2: dot+dash tokenized (so you can search using undotted terms)
-            field = new Field("Id", SplitId(package.PackageRegistration.Id), Field.Store.NO, Field.Index.ANALYZED);
+            field = new Field("Id", SplitId(package.Id), Field.Store.NO, Field.Index.ANALYZED);
             field.Boost = 0.8f;
             document.Add(field);
 
             // Style 3: camel-case tokenized (so you can search using parts of the camelCasedWord). 
             // De-boosted since matches are less likely to be meaningful
-            field = new Field("Id", CamelSplitId(package.PackageRegistration.Id), Field.Store.NO, Field.Index.ANALYZED);
+            field = new Field("Id", CamelSplitId(package.Id), Field.Store.NO, Field.Index.ANALYZED);
             field.Boost = 0.25f;
             document.Add(field);
 
             // If an element does not have a Title, fall back to Id, same as the website.
             var workingTitle = String.IsNullOrEmpty(package.Title)
-                                   ? package.PackageRegistration.Id
+                                   ? package.Id
                                    : package.Title;
 
             // As-Is (stored for search results)
@@ -113,7 +113,7 @@ public Document Create(Package package)
             document.Add(new Field("FlattenedPackageTypes", package.FlattenedPackageTypes.ToStringSafe(), Field.Store.YES, Field.Index.NO));
             document.Add(new Field("Hash", package.Hash.ToStringSafe(), Field.Store.YES, Field.Index.NO));
             document.Add(new Field("HashAlgorithm", package.HashAlgorithm.ToStringSafe(), Field.Store.YES, Field.Index.NO));
-            document.Add(new Field("Id-Original", package.PackageRegistration.Id, Field.Store.YES, Field.Index.NO));
+            document.Add(new Field("Id-Original", package.Id, Field.Store.YES, Field.Index.NO));
             document.Add(new Field("IsVerified-Original", package.PackageRegistration.IsVerified.ToString(), Field.Store.YES, Field.Index.NO));
             document.Add(new Field("LastUpdated", package.LastUpdated.ToString(CultureInfo.InvariantCulture), Field.Store.YES, Field.Index.NO));
             if (package.LastEdited != null)

src/NuGetGallery/Migrations/202104062157118_AddVersionSpecificId.Designer.cs

@@ -0,0 +1,18 @@
+namespace NuGetGallery.Migrations
+{
+    using System;
+    using System.Data.Entity.Migrations;
+    
+    public partial class AddVersionSpecificId : DbMigration
+    {
+        public override void Up()
+        {
+            AddColumn("dbo.Packages", "Id", c => c.String(maxLength: 128));
+        }
+        
+        public override void Down()
+        {
+            DropColumn("dbo.Packages", "Id");
+        }
+    }
+}

src/NuGetGallery/Migrations/202104062157118_AddVersionSpecificId.cs

@@ -303,6 +303,10 @@
     <Compile Include="Migrations\202007220027197_AddEmbeddedReadmeTypeColumn.designer.cs">
       <DependentUpon>202007220027197_AddEmbeddedReadmeTypeColumn.cs</DependentUpon>
     </Compile>
+    <Compile Include="Migrations\202104062157118_AddVersionSpecificId.cs" />
+    <Compile Include="Migrations\202104062157118_AddVersionSpecificId.designer.cs">
+      <DependentUpon>202104062157118_AddVersionSpecificId.cs</DependentUpon>
+    </Compile>
     <Compile Include="Modules\CookieComplianceHttpModule.cs" />
     <Compile Include="RequestModels\DeletePackagesApiRequest.cs" />
     <Compile Include="Services\ImageDomainValidator.cs" />
@@ -1640,6 +1644,9 @@
     <EmbeddedResource Include="Migrations\202007220027197_AddEmbeddedReadmeTypeColumn.resx">
       <DependentUpon>202007220027197_AddEmbeddedReadmeTypeColumn.cs</DependentUpon>
     </EmbeddedResource>
+    <EmbeddedResource Include="Migrations\202104062157118_AddVersionSpecificId.resx">
+      <DependentUpon>202104062157118_AddVersionSpecificId.cs</DependentUpon>
+    </EmbeddedResource>
     <EmbeddedResource Include="OData\QueryAllowed\Data\apiv1packages.json" />
     <EmbeddedResource Include="OData\QueryAllowed\Data\apiv1search.json" />
     <EmbeddedResource Include="OData\QueryAllowed\Data\apiv2getupdates.json" />