Update Orchestrator APIs to include ValidatingType in queries that could return packages and symbols if they have the same key. (#551)

Author: cristinamanum

src/NuGet.Services.Validation.Orchestrator/PackageSigning/ValidateCertificate/PackageCertificatesValidator.cs

@@ -186,7 +186,7 @@ private async Task<ValidatorStatus> StartInternalAsync(IValidationRequest reques
 
             // If any of the author signature's certificates are known to be revoked, invalidate any the signatures.
             // A revoked certificate is assumed to remain revoked forever.
-            var isRevalidationRequest = await _validatorStateService.IsRevalidationRequestAsync(request);
+            var isRevalidationRequest = await _validatorStateService.IsRevalidationRequestAsync(request, ValidatingType.Package);
 
             if (ShouldInvalidateSignature(signature, isRevalidationRequest))
             {

src/NuGet.Services.Validation.Orchestrator/ValidatingEntitites/IValidatingEntity.cs

@@ -28,5 +28,10 @@ public interface IValidatingEntity<T> where T : class, IEntity
         /// The time when the entity was created in Gallery.
         /// </summary>
         DateTime Created { get; }
+
+        /// <summary>
+        /// The ValidatingType.
+        /// </summary>
+        ValidatingType ValidatingType { get; }
     }
 }

src/NuGet.Services.Validation.Orchestrator/ValidatingEntitites/PackageValidatingEntity.cs

@@ -20,5 +20,7 @@ public PackageValidatingEntity(Package entity)
         public PackageStatus Status => EntityRecord.PackageStatusKey;
 
         public DateTime Created => EntityRecord.Created;
+
+        public ValidatingType ValidatingType => ValidatingType.Package;
     }
 }

src/NuGet.Services.Validation.Orchestrator/ValidatingEntitites/SymbolPackageValidatingEntity.cs

@@ -20,5 +20,7 @@ public SymbolPackageValidatingEntity(SymbolPackage entity)
         public PackageStatus Status => EntityRecord.StatusKey;
 
         public DateTime Created => EntityRecord.Created;
+
+        public ValidatingType ValidatingType => ValidatingType.SymbolPackage;
     }
 }

src/NuGet.Services.Validation.Orchestrator/ValidationStorageService.cs

@@ -211,14 +211,15 @@ public async Task<bool> OtherRecentValidationSetForPackageExists<T>(
                 .PackageValidationSets
                 .AnyAsync(pvs => pvs.PackageKey == validatingEntity.Key
                     && pvs.Created > cutoffTimestamp
-                    && pvs.ValidationTrackingId != currentValidationSetTrackingId);
+                    && pvs.ValidationTrackingId != currentValidationSetTrackingId
+                    && pvs.ValidatingType == validatingEntity.ValidatingType);
         }
 
         public async Task<int> GetValidationSetCountAsync<T>(IValidatingEntity<T> validatingEntity) where T : class, IEntity
         {
             return await _validationContext
                 .PackageValidationSets
-                .CountAsync(x => x.PackageKey == validatingEntity.Key);
+                .CountAsync(x => x.PackageKey == validatingEntity.Key && x.ValidatingType == validatingEntity.ValidatingType);
         }
 
         private void AddValidationIssues(PackageValidation packageValidation, IReadOnlyList<IValidationIssue> validationIssues)

src/Validation.Common.Job/Storage/IValidatorStateService.cs

@@ -31,17 +31,9 @@ public interface IValidatorStateService
         /// a different validation request.
         /// </summary>
         /// <param name="request">The package validation request.</param>
+        /// <param name="validatingType">The <see cref="ValidatingType"/>.</param>
         /// <returns>Whether the <see cref="TValidator"/> has already validated this request's package in a different validation request.</returns>
-        Task<bool> IsRevalidationRequestAsync(IValidationRequest request);
-
-        /// <summary>
-        /// Check if the request intends to revalidate a package that has already been validated by <see cref="TValidator"/> by
-        /// a different validation request.
-        /// </summary>
-        /// <param name="packageKey">The package key for the validation request.</param>
-        /// <param name="validationId">The validation id for the validation request.</param>
-        /// <returns>Whether the <see cref="TValidator"/> has already validated this request's package in a different validation request.</returns>
-        Task<bool> IsRevalidationRequestAsync(int packageKey, Guid validationId);
+        Task<bool> IsRevalidationRequestAsync(IValidationRequest request, ValidatingType validatingType);
 
         /// <summary>
         /// Persist the status of a new validation request.

src/Validation.Common.Job/Storage/ValidatorStateService.cs

@@ -68,17 +68,18 @@ public Task<ValidatorStatus> GetStatusAsync(Guid validationId)
                 .FirstOrDefaultAsync();
         }
 
-        public Task<bool> IsRevalidationRequestAsync(IValidationRequest request)
+        public Task<bool> IsRevalidationRequestAsync(IValidationRequest request, ValidatingType validatingType)
         {
-            return IsRevalidationRequestAsync(request.PackageKey, request.ValidationId);
+            return IsRevalidationRequestAsync(request.PackageKey, request.ValidationId, validatingType);
         }
 
-        public Task<bool> IsRevalidationRequestAsync(int packageKey, Guid validationId)
+        private Task<bool> IsRevalidationRequestAsync(int packageKey, Guid validationId, ValidatingType validatingType)
         {
             return _validationContext
                 .ValidatorStatuses
                 .Where(s => s.PackageKey == packageKey)
                 .Where(s => s.ValidatorName == _validatorName)
+                .Where(s => s.ValidatingType == validatingType)
                 .Where(s => s.ValidationId != validationId)
                 .AnyAsync();
         }

tests/NuGet.Services.Validation.Orchestrator.Tests/NuGet.Services.Validation.Orchestrator.Tests.csproj

@@ -55,6 +55,7 @@
     <Compile Include="PackageSigning\ProcessSignature\PackageSignatureProcessorFacts.cs" />
     <Compile Include="PackageStatusProcessorFacts.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="Symbol\SymbolPackageValidatingEntityFacts.cs" />
     <Compile Include="Symbol\SymbolMessageEnqueuerFacts.cs" />
     <Compile Include="Symbol\SymbolEntityServiceFacts.cs" />
     <Compile Include="Symbol\SymbolScanValidatorFacts.cs" />

tests/NuGet.Services.Validation.Orchestrator.Tests/PackageValidatingEntityFacts.cs

@@ -28,6 +28,7 @@ public void PropertiesValidation()
             Assert.Equal(PackageKey, validatingEntity.Key);
             Assert.Equal(PackageId, validatingEntity.EntityRecord.PackageRegistration.Id);
             Assert.Equal(PackageNormalizedVersion, validatingEntity.EntityRecord.NormalizedVersion);
+            Assert.Equal(ValidatingType.Package, validatingEntity.ValidatingType);
         }
 
         private static Package CreatePackage()

tests/NuGet.Services.Validation.Orchestrator.Tests/Symbol/SymbolPackageValidatingEntityFacts.cs

@@ -0,0 +1,57 @@
+// 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 NuGetGallery;
+using NuGet.Services.Validation.Orchestrator;
+using Xunit;
+
+namespace NuGet.Services.Validation
+{
+    public class SymbolPackageValidatingEntityFacts
+    {
+        private const int PackageKey = 1001;
+        private const int SymbolPackageKey = 1002;
+        private const string PackageId = "NuGet.Versioning";
+        private const string PackageNormalizedVersion = "1.0.0";
+        private static DateTime PackageCreated = new DateTime(2018, 4, 4, 4, 4, 4);
+        private static DateTime SymbolPackageCreated = new DateTime(2018, 5, 4, 4, 4, 4);
+
+        [Fact]
+        public void PropertiesValidation()
+        {
+            // Arrange
+            var symbolPackage = CreateSymbolPackage();
+
+            // Act & Assert
+            var validatingEntity = new SymbolPackageValidatingEntity(symbolPackage);
+
+            Assert.Equal(SymbolPackageCreated, validatingEntity.Created);
+            Assert.Equal(SymbolPackageKey, validatingEntity.Key);
+            Assert.Equal(ValidatingType.SymbolPackage, validatingEntity.ValidatingType);
+            Assert.Equal(PackageStatus.Available, validatingEntity.Status);
+        }
+
+        private static SymbolPackage CreateSymbolPackage()
+        {
+            var package =  new Package()
+            {
+                NormalizedVersion = PackageNormalizedVersion,
+                PackageRegistration = new PackageRegistration()
+                {
+                    Id = PackageId
+                },
+                Key = PackageKey,
+                Created = PackageCreated
+            };
+
+            return new SymbolPackage()
+            {
+                Created = SymbolPackageCreated,
+                Key = SymbolPackageKey,
+                StatusKey = PackageStatus.Available
+            };
+
+        }
+    }
+}