Rename vulnerability service (#8356)

drewgillies · web-flow · commit 9ddf91f97c79 · 2020-12-18T06:37:23.000+10:00
diff --git a/src/GitHubVulnerabilities2Db/Ingest/AdvisoryIngestor.cs b/src/GitHubVulnerabilities2Db/Ingest/AdvisoryIngestor.cs
@@ -13,11 +13,11 @@ namespace GitHubVulnerabilities2Db.Ingest
 {
     public class AdvisoryIngestor : IAdvisoryIngestor
     {
-        private readonly IPackageVulnerabilityService _packageVulnerabilityService;
+        private readonly IPackageVulnerabilitiesManagementService _packageVulnerabilityService;
         private readonly IGitHubVersionRangeParser _gitHubVersionRangeParser;
 
         public AdvisoryIngestor(
-            IPackageVulnerabilityService packageVulnerabilityService,
+            IPackageVulnerabilitiesManagementService packageVulnerabilityService,
             IGitHubVersionRangeParser gitHubVersionRangeParser)
         {
             _packageVulnerabilityService = packageVulnerabilityService ?? throw new ArgumentNullException(nameof(packageVulnerabilityService));
diff --git a/src/GitHubVulnerabilities2Db/Job.cs b/src/GitHubVulnerabilities2Db/Job.cs
@@ -64,8 +64,8 @@ protected void ConfigureIngestionServices(ContainerBuilder containerBuilder)
             ConfigureGalleryServices(containerBuilder);
 
             containerBuilder
-                .RegisterType<PackageVulnerabilityService>()
-                .As<IPackageVulnerabilityService>();
+                .RegisterType<PackageVulnerabilitiesManagementService>()
+                .As<IPackageVulnerabilitiesManagementService>();
 
             containerBuilder
                 .RegisterType<GitHubVersionRangeParser>()
diff --git a/src/NuGetGallery.Services/Configuration/FeatureFlagService.cs b/src/NuGetGallery.Services/Configuration/FeatureFlagService.cs
@@ -25,6 +25,7 @@ public class FeatureFlagService : IFeatureFlagService
         private const string ManageDeprecationFeatureName = GalleryPrefix + "ManageDeprecation";
         private const string ManageDeprecationForManyVersionsFeatureName = GalleryPrefix + "ManageDeprecationMany";
         private const string ManageDeprecationApiFeatureName = GalleryPrefix + "ManageDeprecationApi";
+        private const string DisplayVulnerabilitiesFeatureName = GalleryPrefix + "DisplayVulnerabilities";
         private const string ODataReadOnlyDatabaseFeatureName = GalleryPrefix + "ODataReadOnlyDatabase";
         private const string PackagesAtomFeedFeatureName = GalleryPrefix + "PackagesAtomFeed";
         private const string SearchSideBySideFlightName = GalleryPrefix + "SearchSideBySide";
@@ -127,6 +128,11 @@ public bool IsManageDeprecationApiEnabled(User user)
             return _client.IsEnabled(ManageDeprecationApiFeatureName, user, defaultValue: false);
         }
 
+        public bool IsDisplayVulnerabilitiesEnabled()
+        {
+            return _client.IsEnabled(DisplayVulnerabilitiesFeatureName, defaultValue: false);
+        }
+
         public bool AreEmbeddedIconsEnabled(User user)
         {
             return _client.IsEnabled(EmbeddedIconFlightName, user, defaultValue: false);
diff --git a/src/NuGetGallery.Services/Configuration/IFeatureFlagService.cs b/src/NuGetGallery.Services/Configuration/IFeatureFlagService.cs
@@ -56,6 +56,11 @@ public interface IFeatureFlagService
         /// </summary>
         bool IsManageDeprecationApiEnabled(User user);
 
+        /// <summary>
+        /// Whether or not a package owner can view vulnerability advisory information on their package.
+        /// </summary>
+        bool IsDisplayVulnerabilitiesEnabled();
+
         /// <summary>
         /// Whether the user is allowed to publish packages with an embedded icon.
         /// </summary>
diff --git a/src/NuGetGallery.Services/NuGetGallery.Services.csproj b/src/NuGetGallery.Services/NuGetGallery.Services.csproj
@@ -161,7 +161,7 @@
     <Compile Include="PackageManagement\IPackageOwnershipManagementService.cs" />
     <Compile Include="PackageManagement\IPackageService.cs" />
     <Compile Include="PackageManagement\IPackageUpdateService.cs" />
-    <Compile Include="PackageManagement\IPackageVulnerabilityService.cs" />
+    <Compile Include="PackageManagement\IPackageVulnerabilitiesManagementService.cs" />
     <Compile Include="PackageManagement\IReservedNamespaceService.cs" />
     <Compile Include="PackageManagement\PackageDeleteDecision.cs" />
     <Compile Include="PackageManagement\PackageFilter.cs" />
@@ -170,7 +170,7 @@
     <Compile Include="PackageManagement\PackageOwnerRequestService.cs" />
     <Compile Include="PackageManagement\PackageOwnershipManagementService.cs" />
     <Compile Include="PackageManagement\PackageService.cs" />
-    <Compile Include="PackageManagement\PackageVulnerabilityService.cs" />
+    <Compile Include="PackageManagement\PackageVulnerabilitiesManagementService.cs" />
     <Compile Include="PackageManagement\ReservedNamespaceService.cs" />
     <Compile Include="Permissions\ActionRequiringAccountPermissions.cs" />
     <Compile Include="Permissions\ActionRequiringEntityPermissions.cs" />
diff --git a/src/NuGetGallery.Services/PackageManagement/IPackageVulnerabilitiesManagementService.cs b/src/NuGetGallery.Services/PackageManagement/IPackageVulnerabilitiesManagementService.cs
@@ -6,10 +6,10 @@
 
 namespace NuGetGallery
 {
-    public interface IPackageVulnerabilityService
+    public interface IPackageVulnerabilitiesManagementService
     {
         /// <summary>
-        /// Adds any <see cref="VulnerablePackageVersionRange"/>s to <see cref="Package.Vulnerabilities"/> that it is a part of.
+        /// Adds any <see cref="VulnerablePackageVersionRange"/>s to <see cref="Package.VulnerableVersionRanges"/> that it is a part of.
         /// </summary>
         /// <remarks>
         /// Does not commit changes. The caller is expected to commit any changes separately.
diff --git a/src/NuGetGallery.Services/PackageManagement/PackageVulnerabilitiesManagementService.cs b/src/NuGetGallery.Services/PackageManagement/PackageVulnerabilitiesManagementService.cs
@@ -12,16 +12,16 @@
 
 namespace NuGetGallery
 {
-    public class PackageVulnerabilityService : IPackageVulnerabilityService
+    public class PackageVulnerabilitiesManagementService : IPackageVulnerabilitiesManagementService
     {
         private readonly IEntitiesContext _entitiesContext;
         private readonly IPackageUpdateService _packageUpdateService;
-        private readonly ILogger<PackageVulnerabilityService> _logger;
+        private readonly ILogger<PackageVulnerabilitiesManagementService> _logger;
 
-        public PackageVulnerabilityService(
+        public PackageVulnerabilitiesManagementService(
             IEntitiesContext entitiesContext,
             IPackageUpdateService packageUpdateService,
-            ILogger<PackageVulnerabilityService> logger)
+            ILogger<PackageVulnerabilitiesManagementService> logger)
         {
             _entitiesContext = entitiesContext ?? throw new ArgumentNullException(nameof(entitiesContext));
             _packageUpdateService = packageUpdateService ?? throw new ArgumentNullException(nameof(packageUpdateService));
diff --git a/src/NuGetGallery/App_Data/Files/Content/flags.json b/src/NuGetGallery/App_Data/Files/Content/flags.json
@@ -22,7 +22,8 @@
     "NuGetGallery.ODataV2FindPackagesByIdNonHijacked": "Enabled",
     "NuGetGallery.ODataV2FindPackagesByIdCountNonHijacked": "Enabled",
     "NuGetGallery.ODataV2SearchNonHijacked": "Enabled",
-    "NuGetGallery.ODataV2SearchCountNonHijacked": "Enabled"
+    "NuGetGallery.ODataV2SearchCountNonHijacked": "Enabled",
+    "NuGetGallery.DisplayVulnerabilities": "Enabled"
   },
   "Flights": {
     "NuGetGallery.TyposquattingFlight": {
diff --git a/src/NuGetGallery/App_Start/DefaultDependenciesModule.cs b/src/NuGetGallery/App_Start/DefaultDependenciesModule.cs
@@ -442,8 +442,8 @@ protected override void Load(ContainerBuilder builder)
                 .As<IIconUrlTemplateProcessor>()
                 .InstancePerLifetimeScope();
 
-            builder.RegisterType<PackageVulnerabilityService>()
-                .As<IPackageVulnerabilityService>()
+            builder.RegisterType<PackageVulnerabilitiesManagementService>()
+                .As<IPackageVulnerabilitiesManagementService>()
                 .InstancePerLifetimeScope();
 
             services.AddHttpClient();
diff --git a/src/NuGetGallery/Services/PackageUploadService.cs b/src/NuGetGallery/Services/PackageUploadService.cs
@@ -22,7 +22,7 @@ public class PackageUploadService : IPackageUploadService
         private readonly IReservedNamespaceService _reservedNamespaceService;
         private readonly IValidationService _validationService;
         private readonly ICoreLicenseFileService _coreLicenseFileService;
-        private readonly IPackageVulnerabilityService _vulnerabilityService;
+        private readonly IPackageVulnerabilitiesManagementService _vulnerabilityService;
         private readonly IPackageMetadataValidationService _metadataValidationService;
 
         public PackageUploadService(
@@ -33,7 +33,7 @@ public PackageUploadService(
             IValidationService validationService,
             ICoreLicenseFileService coreLicenseFileService,
             IDiagnosticsService diagnosticsService,
-            IPackageVulnerabilityService vulnerabilityService,
+            IPackageVulnerabilitiesManagementService vulnerabilityService,
             IPackageMetadataValidationService metadataValidationService)
         {
             _packageService = packageService ?? throw new ArgumentNullException(nameof(packageService));
diff --git a/src/VerifyGitHubVulnerabilities/Job.cs b/src/VerifyGitHubVulnerabilities/Job.cs
@@ -34,7 +34,7 @@ public override async Task Run()
             Console.WriteLine($" FOUND {advisories.Count} advisories.");
 
             Console.WriteLine("Fetching vulnerabilities from DB...");
-            var verifier = new PackageVulnerabilityServiceVerifier(_serviceProvider.GetRequiredService<IEntitiesContext>());
+            var verifier = new PackageVulnerabilitiesVerifier(_serviceProvider.GetRequiredService<IEntitiesContext>());
             var ingestor = new AdvisoryIngestor(verifier, new GitHubVersionRangeParser());
             await ingestor.IngestAsync(advisories);
 
diff --git a/src/VerifyGitHubVulnerabilities/Verify/PackageVulnerabilitiesVerifier.cs b/src/VerifyGitHubVulnerabilities/Verify/PackageVulnerabilitiesVerifier.cs
@@ -11,11 +11,11 @@
 
 namespace VerifyGitHubVulnerabilities.Verify
 {
-    public class PackageVulnerabilityServiceVerifier : IPackageVulnerabilityService
+    public class PackageVulnerabilitiesVerifier : IPackageVulnerabilitiesManagementService
     {
         private readonly IEntitiesContext _entitiesContext;
 
-        public PackageVulnerabilityServiceVerifier(
+        public PackageVulnerabilitiesVerifier(
             IEntitiesContext entitiesContext)
         {
             _entitiesContext = entitiesContext ?? throw new ArgumentNullException(nameof(entitiesContext));
diff --git a/src/VerifyGitHubVulnerabilities/VerifyGitHubVulnerabilities.csproj b/src/VerifyGitHubVulnerabilities/VerifyGitHubVulnerabilities.csproj
@@ -49,7 +49,7 @@
     <Compile Include="Job.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
-    <Compile Include="Verify\PackageVulnerabilityServiceVerifier.cs" />
+    <Compile Include="Verify\PackageVulnerabilitiesVerifier.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="App.config" />
diff --git a/tests/GitHubVulnerabilities2Db.Facts/AdvisoryIngestorFacts.cs b/tests/GitHubVulnerabilities2Db.Facts/AdvisoryIngestorFacts.cs
@@ -132,14 +132,14 @@ public class MethodFacts
         {
             public MethodFacts()
             {
-                PackageVulnerabilityServiceMock = new Mock<IPackageVulnerabilityService>();
+                PackageVulnerabilityServiceMock = new Mock<IPackageVulnerabilitiesManagementService>();
                 GitHubVersionRangeParserMock = new Mock<IGitHubVersionRangeParser>();
                 Ingestor = new AdvisoryIngestor(
                     PackageVulnerabilityServiceMock.Object,
                     GitHubVersionRangeParserMock.Object);
             }
 
-            public Mock<IPackageVulnerabilityService> PackageVulnerabilityServiceMock { get; }
+            public Mock<IPackageVulnerabilitiesManagementService> PackageVulnerabilityServiceMock { get; }
             public Mock<IGitHubVersionRangeParser> GitHubVersionRangeParserMock { get; }
             public AdvisoryIngestor Ingestor { get; }
         }
diff --git a/tests/NuGetGallery.Facts/NuGetGallery.Facts.csproj b/tests/NuGetGallery.Facts/NuGetGallery.Facts.csproj
@@ -110,7 +110,7 @@
     <Compile Include="Services\PackageDeprecationManagementServiceFacts.cs" />
     <Compile Include="Services\PackageDeprecationServiceFacts.cs" />
     <Compile Include="Services\PackageRenameServiceFacts.cs" />
-    <Compile Include="Services\PackageVulnerabilityServiceFacts.cs" />
+    <Compile Include="Services\PackageVulnerabilitiesManagementServiceFacts.cs" />
     <Compile Include="Services\SearchSideBySideServiceFacts.cs" />
     <Compile Include="Services\PackageUpdateServiceFacts.cs" />
     <Compile Include="Services\StatusServiceFacts.cs" />
diff --git a/tests/NuGetGallery.Facts/Services/PackageUploadServiceFacts.cs b/tests/NuGetGallery.Facts/Services/PackageUploadServiceFacts.cs
@@ -32,7 +32,7 @@ private static PackageUploadService CreateService(
             Mock<IPackageService> packageService = null,
             Mock<IReservedNamespaceService> reservedNamespaceService = null,
             Mock<IValidationService> validationService = null,
-            Mock<IPackageVulnerabilityService> vulnerabilityService = null)
+            Mock<IPackageVulnerabilitiesManagementService> vulnerabilityService = null)
         {
             packageService = packageService ?? new Mock<IPackageService>();
 
@@ -64,7 +64,7 @@ private static PackageUploadService CreateService(
 
             if (vulnerabilityService == null)
             {
-                vulnerabilityService = new Mock<IPackageVulnerabilityService>();
+                vulnerabilityService = new Mock<IPackageVulnerabilitiesManagementService>();
             }
 
             validationService = validationService ?? new Mock<IValidationService>();
@@ -96,7 +96,7 @@ public async Task WillCallCreatePackageAsyncCorrectly()
                 var key = 0;
                 var packageService = new Mock<IPackageService>();
                 packageService.Setup(x => x.FindPackageRegistrationById(It.IsAny<string>())).Returns((PackageRegistration)null);
-                var vulnerabilityService = new Mock<IPackageVulnerabilityService>();
+                var vulnerabilityService = new Mock<IPackageVulnerabilitiesManagementService>();
 
                 var id = "Microsoft.Aspnet.Mvc";
                 var packageUploadService = CreateService(packageService, vulnerabilityService: vulnerabilityService);
@@ -151,7 +151,7 @@ public async Task WillMarkPackageRegistrationVerifiedFlagCorrectly(bool shouldMa
                     .Setup(r => r.GetReservedNamespacesForId(It.IsAny<string>()))
                     .Returns(testNamespaces.ToList().AsReadOnly());
 
-                var vulnerabilityService = new Mock<IPackageVulnerabilityService>();
+                var vulnerabilityService = new Mock<IPackageVulnerabilitiesManagementService>();
 
                 var packageUploadService = CreateService(
                     reservedNamespaceService: reservedNamespaceService, 
@@ -193,7 +193,7 @@ public async Task WillMarkPackageRegistrationNotVerifiedIfIdMatchesNonOwnedShare
                     .Setup(r => r.GetReservedNamespacesForId(It.IsAny<string>()))
                     .Returns(testNamespaces.ToList().AsReadOnly());
 
-                var vulnerabilityService = new Mock<IPackageVulnerabilityService>();
+                var vulnerabilityService = new Mock<IPackageVulnerabilitiesManagementService>();
 
                 var packageUploadService = CreateService(
                     reservedNamespaceService: reservedNamespaceService,
@@ -741,7 +741,7 @@ public abstract class FactsBase
             protected readonly Mock<ITelemetryService> _telemetryService;
             protected readonly Mock<ICoreLicenseFileService> _licenseFileService;
             protected readonly Mock<IDiagnosticsService> _diagnosticsService;
-            protected readonly Mock<IPackageVulnerabilityService> _vulnerabilityService;
+            protected readonly Mock<IPackageVulnerabilitiesManagementService> _vulnerabilityService;
             protected readonly Mock<IPackageMetadataValidationService> _metadataValidationService;
             protected Package _package;
             protected Stream _packageFile;
@@ -784,7 +784,7 @@ public FactsBase()
                     .Setup(ds => ds.GetSource(It.IsAny<string>()))
                     .Returns(Mock.Of<IDiagnosticsSource>());
 
-                _vulnerabilityService = new Mock<IPackageVulnerabilityService>();
+                _vulnerabilityService = new Mock<IPackageVulnerabilitiesManagementService>();
 
                 _metadataValidationService = new Mock<IPackageMetadataValidationService>();
 
diff --git a/tests/NuGetGallery.Facts/Services/PackageVulnerabilitiesManagementServiceFacts.cs b/tests/NuGetGallery.Facts/Services/PackageVulnerabilitiesManagementServiceFacts.cs
@@ -13,7 +13,7 @@
 
 namespace NuGetGallery.Services
 {
-    public class PackageVulnerabilityServiceFacts
+    public class PackageVulnerabilitiesManagementServiceFacts
     {
         public class TheApplyExistingVulnerabilitiesToPackageMethod : MethodFacts
         {
@@ -211,7 +211,7 @@ public async Task WithExistingVulnerability_Withdrawn_RemovesAndUnmarks(bool has
                         .Verifiable();
                 }
 
-                var service = GetService<PackageVulnerabilityService>();
+                var service = GetService<PackageVulnerabilitiesManagementService>();
 
                 // Act
                 await service.UpdateVulnerabilityAsync(vulnerability, true);
@@ -258,7 +258,7 @@ public async Task WithExistingVulnerability_NotWithdrawn_NoRanges_RemovesAndUnma
                         .Verifiable();
                 }
 
-                var service = GetService<PackageVulnerabilityService>();
+                var service = GetService<PackageVulnerabilitiesManagementService>();
 
                 // Act
                 await service.UpdateVulnerabilityAsync(vulnerability, false);
@@ -440,7 +440,7 @@ public async Task WithExistingVulnerability_NotWithdrawn_UpdatesPackages(
                         .Verifiable();
                 }
 
-                var service = GetService<PackageVulnerabilityService>();
+                var service = GetService<PackageVulnerabilitiesManagementService>();
 
                 // Act
                 await service.UpdateVulnerabilityAsync(vulnerability, false);
@@ -469,7 +469,7 @@ public MethodFacts()
                 _databaseMock = new Mock<IDatabase>();
                 Context = GetFakeContext();
                 UpdateServiceMock = GetMock<IPackageUpdateService>();
-                Service = GetService<PackageVulnerabilityService>();
+                Service = GetService<PackageVulnerabilitiesManagementService>();
 
                 _transactionMock
                     .Setup(x => x.Commit())
@@ -487,7 +487,7 @@ public MethodFacts()
             private Mock<IDatabase> _databaseMock { get; }
             protected FakeEntitiesContext Context { get; }
             protected Mock<IPackageUpdateService> UpdateServiceMock { get; }
-            protected PackageVulnerabilityService Service { get; }
+            protected PackageVulnerabilitiesManagementService Service { get; }
 
             protected void VerifyTransaction()
             {

Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,11 @@ namespace GitHubVulnerabilities2Db.Ingest`
`13`	`13`	`{`
`14`	`14`	`public class AdvisoryIngestor : IAdvisoryIngestor`
`15`	`15`	`{`
`16`		`- private readonly IPackageVulnerabilityService _packageVulnerabilityService;`
	`16`	`+ private readonly IPackageVulnerabilitiesManagementService _packageVulnerabilityService;`
`17`	`17`	`private readonly IGitHubVersionRangeParser _gitHubVersionRangeParser;`
`18`	`18`
`19`	`19`	`public AdvisoryIngestor(`
`20`		`- IPackageVulnerabilityService packageVulnerabilityService,`
	`20`	`+ IPackageVulnerabilitiesManagementService packageVulnerabilityService,`
`21`	`21`	`IGitHubVersionRangeParser gitHubVersionRangeParser)`
`22`	`22`	`{`
`23`	`23`	`_packageVulnerabilityService = packageVulnerabilityService ?? throw new ArgumentNullException(nameof(packageVulnerabilityService));`
Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,10 @@`
`6`	`6`
`7`	`7`	`namespace NuGetGallery`
`8`	`8`	`{`
`9`		`- public interface IPackageVulnerabilityService`
	`9`	`+ public interface IPackageVulnerabilitiesManagementService`
`10`	`10`	`{`
`11`	`11`	`/// <summary>`
`12`		`- /// Adds any <see cref="VulnerablePackageVersionRange"/>s to <see cref="Package.Vulnerabilities"/> that it is a part of.`
	`12`	`+ /// Adds any <see cref="VulnerablePackageVersionRange"/>s to <see cref="Package.VulnerableVersionRanges"/> that it is a part of.`
`13`	`13`	`/// </summary>`
`14`	`14`	`/// <remarks>`
`15`	`15`	`/// Does not commit changes. The caller is expected to commit any changes separately.`
Original file line number	Diff line number	Diff line change
`@@ -12,16 +12,16 @@`
`12`	`12`
`13`	`13`	`namespace NuGetGallery`
`14`	`14`	`{`
`15`		`- public class PackageVulnerabilityService : IPackageVulnerabilityService`
	`15`	`+ public class PackageVulnerabilitiesManagementService : IPackageVulnerabilitiesManagementService`
`16`	`16`	`{`
`17`	`17`	`private readonly IEntitiesContext _entitiesContext;`
`18`	`18`	`private readonly IPackageUpdateService _packageUpdateService;`
`19`		`- private readonly ILogger<PackageVulnerabilityService> _logger;`
	`19`	`+ private readonly ILogger<PackageVulnerabilitiesManagementService> _logger;`
`20`	`20`
`21`		`- public PackageVulnerabilityService(`
	`21`	`+ public PackageVulnerabilitiesManagementService(`
`22`	`22`	`IEntitiesContext entitiesContext,`
`23`	`23`	`IPackageUpdateService packageUpdateService,`
`24`		`- ILogger<PackageVulnerabilityService> logger)`
	`24`	`+ ILogger<PackageVulnerabilitiesManagementService> logger)`
`25`	`25`	`{`
`26`	`26`	`_entitiesContext = entitiesContext ?? throw new ArgumentNullException(nameof(entitiesContext));`
`27`	`27`	`_packageUpdateService = packageUpdateService ?? throw new ArgumentNullException(nameof(packageUpdateService));`