[Rename] DB schema change (#7923)

* DB schema for package rename.

* nit

* Handle feedback

* Nit

Author: zhhyu

src/NuGet.Services.Entities/NuGet.Services.Entities.csproj

@@ -77,6 +77,7 @@
     <Compile Include="PackageLicenseReport.cs" />
     <Compile Include="PackageOwnerRequest.cs" />
     <Compile Include="PackageRegistration.cs" />
+    <Compile Include="PackageRename.cs" />
     <Compile Include="PackageStatus.cs" />
     <Compile Include="PackageType.cs" />
     <Compile Include="PackageVulnerability.cs" />

src/NuGet.Services.Entities/PackageRegistration.cs

@@ -16,6 +16,7 @@ public PackageRegistration()
             ReservedNamespaces = new HashSet<ReservedNamespace>();
             RequiredSigners = new HashSet<User>();
             AlternativeOf = new HashSet<PackageDeprecation>();
+            PackageRenames = new HashSet<PackageRename>();
         }
 
         [StringLength(Constants.MaxPackageIdLength)]
@@ -44,5 +45,15 @@ public PackageRegistration()
         /// See <see cref="PackageDeprecation.AlternatePackageRegistration"/>.
         /// </summary>
         public virtual ICollection<PackageDeprecation> AlternativeOf { get; set; }
+
+        /// <summary>
+        /// Gets or sets the list of replacement package registrations.
+        /// </summary>
+        public ICollection<PackageRename> PackageRenames { get; set; }
+
+        /// <summary>
+        /// Gets or sets the user-provided custom message for this renamed package registration.
+        /// </summary>
+        public string RenamedMessage { get; set; }
     }
 }

src/NuGet.Services.Entities/PackageRename.cs

@@ -0,0 +1,44 @@
+// 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 System.ComponentModel.DataAnnotations.Schema;
+
+namespace NuGet.Services.Entities
+{
+    public class PackageRename : IEntity
+    {
+        /// <summary>
+        /// Gets or sets the primary key for the entity.
+        /// </summary>
+        public int Key { get; set; }
+
+        /// <summary>
+        /// Gets or sets the renamed package registration entity key.
+        /// </summary>
+        public int FromPackageRegistrationKey { get; set; }
+
+        /// <summary>
+        /// Gets or sets the renamed package registration entity.
+        /// </summary>
+        public virtual PackageRegistration FromPackageRegistration { get; set; }
+
+        /// <summary>
+        /// Gets or sets the replacement package registration entity key.
+        /// </summary>
+        public int ToPackageRegistrationKey { get; set; }
+
+        /// <summary>
+        /// Gets or sets the replacement package registration entity.
+        /// </summary>
+        public virtual PackageRegistration ToPackageRegistration { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether the renamed package's popularity should be transferred to the replacement packages.
+        /// </summary>
+        public bool TransferPopularity { get; set; }
+
+        [DatabaseGenerated(DatabaseGeneratedOption.Computed)]
+        public DateTime UpdatedOn { get; set; }
+    }
+}

src/NuGetGallery.Core/Entities/EntitiesContext.cs

@@ -69,6 +69,7 @@ public EntitiesContext(DbConnection connection, bool readOnly)
         public DbSet<SymbolPackage> SymbolPackages { get; set; }
         public DbSet<PackageVulnerability> Vulnerabilities { get; set; }
         public DbSet<VulnerablePackageVersionRange> VulnerableRanges { get; set; }
+        public DbSet<PackageRename> PackageRenames { get; set; }
 
         /// <summary>
         /// User or organization accounts.
@@ -477,6 +478,28 @@ protected override void OnModelCreating(DbModelBuilder modelBuilder)
             modelBuilder.Entity<VulnerablePackageVersionRange>()
                 .HasIndex(pv => new { pv.VulnerabilityKey, pv.PackageId, pv.PackageVersionRange })
                 .IsUnique();
+
+            modelBuilder.Entity<PackageRename>()
+                .HasKey(r => r.Key)
+                .HasIndex(r => r.TransferPopularity);
+
+            modelBuilder.Entity<PackageRename>()
+                .HasIndex(r => new { r.FromPackageRegistrationKey, r.ToPackageRegistrationKey})
+                .IsUnique();
+
+            modelBuilder.Entity<PackageRename>()
+                .HasRequired(r => r.FromPackageRegistration)
+                .WithMany(rg => rg.PackageRenames)
+                .HasForeignKey(r => r.FromPackageRegistrationKey)
+                .WillCascadeOnDelete(true);
+
+            // Cascade deletion on the reference key "ToPackageRegistrationKey" will cause the multiple cascade path issue.
+            // Package registration deletion will delete the related "PackageRename" entities whose "ToPackageRegistrationKey" refers it.
+            modelBuilder.Entity<PackageRename>()
+                .HasRequired(r => r.ToPackageRegistration)
+                .WithMany()
+                .HasForeignKey(r => r.ToPackageRegistrationKey)
+                .WillCascadeOnDelete(false);
         }
 #pragma warning restore 618
     }

src/NuGetGallery.Core/Entities/IEntitiesContext.cs

@@ -21,6 +21,7 @@ public interface IEntitiesContext : IReadOnlyEntitiesContext
         DbSet<SymbolPackage> SymbolPackages { get; set; }
         DbSet<PackageVulnerability> Vulnerabilities { get; set; }
         DbSet<VulnerablePackageVersionRange> VulnerableRanges { get; set; }
+        DbSet<PackageRename> PackageRenames { get; set; }
 
         Task<int> SaveChangesAsync();
         void DeleteOnCommit<T>(T entity) where T : class;

src/NuGetGallery/Migrations/202004030548285_AddPackageRename.Designer.cs

@@ -0,0 +1,39 @@
+namespace NuGetGallery.Migrations
+{
+    using System;
+    using System.Data.Entity.Migrations;
+    
+    public partial class AddPackageRename : DbMigration
+    {
+        public override void Up()
+        {
+            CreateTable(
+                "dbo.PackageRenames",
+                c => new
+                    {
+                        Key = c.Int(nullable: false, identity: true),
+                        FromPackageRegistrationKey = c.Int(nullable: false),
+                        ToPackageRegistrationKey = c.Int(nullable: false),
+                        TransferPopularity = c.Boolean(nullable: false),
+                        UpdatedOn = c.DateTime(nullable: false, defaultValueSql: "GETUTCDATE()"),
+                    })
+                .PrimaryKey(t => t.Key)
+                .ForeignKey("dbo.PackageRegistrations", t => t.FromPackageRegistrationKey, cascadeDelete: true)
+                .ForeignKey("dbo.PackageRegistrations", t => t.ToPackageRegistrationKey)
+                .Index(t => new { t.FromPackageRegistrationKey, t.ToPackageRegistrationKey }, unique: true)
+                .Index(t => t.TransferPopularity);
+            
+            AddColumn("dbo.PackageRegistrations", "RenamedMessage", c => c.String());
+        }
+        
+        public override void Down()
+        {
+            DropForeignKey("dbo.PackageRenames", "ToPackageRegistrationKey", "dbo.PackageRegistrations");
+            DropForeignKey("dbo.PackageRenames", "FromPackageRegistrationKey", "dbo.PackageRegistrations");
+            DropIndex("dbo.PackageRenames", new[] { "TransferPopularity" });
+            DropIndex("dbo.PackageRenames", new[] { "FromPackageRegistrationKey", "ToPackageRegistrationKey" });
+            DropColumn("dbo.PackageRegistrations", "RenamedMessage");
+            DropTable("dbo.PackageRenames");
+        }
+    }
+}

src/NuGetGallery/Migrations/202004030548285_AddPackageRename.cs

@@ -286,6 +286,10 @@
     <Compile Include="Migrations\201912051135094_PackageVulnerabilityAdvisoryUrlRenameAndRequired.designer.cs">
       <DependentUpon>201912051135094_PackageVulnerabilityAdvisoryUrlRenameAndRequired.cs</DependentUpon>
     </Compile>
+    <Compile Include="Migrations\202004030548285_AddPackageRename.cs" />
+    <Compile Include="Migrations\202004030548285_AddPackageRename.designer.cs">
+      <DependentUpon>202004030548285_AddPackageRename.cs</DependentUpon>
+    </Compile>
     <Compile Include="Services\ConfigurationIconFileProvider.cs" />
     <Compile Include="Services\IconUrlDeprecationValidationMessage.cs" />
     <Compile Include="Services\GravatarProxyResult.cs" />
@@ -1661,6 +1665,9 @@
     <EmbeddedResource Include="Migrations\201912051135094_PackageVulnerabilityAdvisoryUrlRenameAndRequired.resx">
       <DependentUpon>201912051135094_PackageVulnerabilityAdvisoryUrlRenameAndRequired.cs</DependentUpon>
     </EmbeddedResource>
+    <EmbeddedResource Include="Migrations\202004030548285_AddPackageRename.resx">
+      <DependentUpon>202004030548285_AddPackageRename.cs</DependentUpon>
+    </EmbeddedResource>
     <EmbeddedResource Include="OData\QueryAllowed\Data\apiv1packages.json" />
     <EmbeddedResource Include="OData\QueryAllowed\Data\apiv1search.json" />
     <EmbeddedResource Include="OData\QueryAllowed\Data\apiv2getupdates.json" />

src/NuGetGallery/Migrations/202004030548285_AddPackageRename.resx

@@ -33,6 +33,9 @@ UPDATE PackageDeprecations
                 SET AlternatePackageRegistrationKey = NULL
                 WHERE AlternatePackageRegistrationKey = @key
 
+                DELETE r FROM PackageRenames AS r
+                WHERE r.[ToPackageRegistrationKey] = @key
+
                 DELETE pr FROM PackageRegistrations AS pr
                 WHERE pr.[Key] = @key
             END";