Merge branch 'dev' into dev-pkgdeprecation

Author: xavierdecoster

src/NuGetGallery.Core/Auditing/AuditedEntities/AuditedFeatureFlagFeature.cs

@@ -0,0 +1,30 @@
+// 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.Linq;
+using NuGet.Services.FeatureFlags;
+
+namespace NuGetGallery.Auditing.AuditedEntities
+{
+    public class AuditedFeatureFlagFeature
+    {
+        public string Name { get; private set; }
+        public FeatureStatus Status { get; private set; }
+
+        public static AuditedFeatureFlagFeature[] CreateFrom(FeatureFlags flags)
+        {
+            return flags.Features?
+                .Select(f => CreateFrom(f.Key, f.Value))
+                .ToArray() ?? new AuditedFeatureFlagFeature[0];
+        }
+
+        public static AuditedFeatureFlagFeature CreateFrom(string name, FeatureStatus status)
+        {
+            return new AuditedFeatureFlagFeature
+            {
+                Name = name,
+                Status = status
+            };
+        }
+    }
+}

src/NuGetGallery.Core/Auditing/AuditedEntities/AuditedFeatureFlagFlight.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.Linq;
+using NuGet.Services.FeatureFlags;
+
+namespace NuGetGallery.Auditing.AuditedEntities
+{
+    public class AuditedFeatureFlagFlight
+    {
+        public string Name { get; private set; }
+        public bool All { get; private set; }
+        public bool SiteAdmins { get; private set; }
+        public string[] Accounts { get; private set; }
+        public string[] Domains { get; private set; }
+
+        public static AuditedFeatureFlagFlight[] CreateFrom(FeatureFlags flags)
+        {
+            return flags.Flights?
+                .Select(f => CreateFrom(f.Key, f.Value))
+                .ToArray() ?? new AuditedFeatureFlagFlight[0];
+        }
+
+        public static AuditedFeatureFlagFlight CreateFrom(string name, Flight flight)
+        {
+            return new AuditedFeatureFlagFlight
+            {
+                Name = name,
+                All = flight.All,
+                SiteAdmins = flight.SiteAdmins,
+                Accounts = flight.Accounts?.ToArray() ?? new string[0],
+                Domains = flight.Domains?.ToArray() ?? new string[0]
+            };
+        }
+    }
+}

src/NuGetGallery.Core/Auditing/AuditedFeatureFlagsAction.cs

@@ -0,0 +1,10 @@
+// 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.
+
+namespace NuGetGallery.Auditing
+{
+    public enum AuditedFeatureFlagsAction
+    {
+        Update
+    }
+}

src/NuGetGallery.Core/Auditing/FeatureFlagsAuditRecord.cs

@@ -0,0 +1,48 @@
+// 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 NuGet.Services.FeatureFlags;
+using NuGetGallery.Auditing.AuditedEntities;
+using NuGetGallery.Features;
+
+namespace NuGetGallery.Auditing
+{
+    public sealed class FeatureFlagsAuditRecord : AuditRecord<AuditedFeatureFlagsAction>
+    {
+        public AuditedFeatureFlagFeature[] Features { get; }
+        public AuditedFeatureFlagFlight[] Flights { get; }
+        public string ContentId { get; }
+        public FeatureFlagSaveResult Result { get; }
+
+        public FeatureFlagsAuditRecord(
+            AuditedFeatureFlagsAction action, 
+            FeatureFlags flags,
+            string contentId, 
+            FeatureFlagSaveResult result)
+            : base(action)
+        {
+            if (flags == null)
+            {
+                throw new ArgumentNullException(nameof(flags));
+            }
+
+            ContentId = contentId ?? throw new ArgumentNullException(nameof(contentId));
+
+            Features = AuditedFeatureFlagFeature.CreateFrom(flags);
+            Flights = AuditedFeatureFlagFlight.CreateFrom(flags);
+            
+            Result = result;
+
+            // Group feature flags changes by the month they occurred in.
+            var currentTime = DateTime.UtcNow;
+            _path = $"{currentTime.Year}-{currentTime.Month}";
+        }
+
+        private readonly string _path;
+        public override string GetPath()
+        {
+            return _path;
+        }
+    }
+}

src/NuGetGallery.Core/Features/FeatureFlagFileStorageService.cs

@@ -10,9 +10,9 @@
 using Microsoft.WindowsAzure.Storage;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
-using Newtonsoft.Json.Linq;
 using NuGet.Services.Entities;
 using NuGet.Services.FeatureFlags;
+using NuGetGallery.Auditing;
 
 namespace NuGetGallery.Features
 {
@@ -23,6 +23,7 @@ public class FeatureFlagFileStorageService : IEditableFeatureFlagStorageService
         private static readonly JsonSerializer Serializer;
 
         private readonly ICoreFileStorageService _storage;
+        private readonly IAuditingService _auditing;
         private readonly ILogger<FeatureFlagFileStorageService> _logger;
 
         static FeatureFlagFileStorageService()
@@ -40,9 +41,11 @@ static FeatureFlagFileStorageService()
 
         public FeatureFlagFileStorageService(
             ICoreFileStorageService storage,
+            IAuditingService auditing,
             ILogger<FeatureFlagFileStorageService> logger)
         {
             _storage = storage ?? throw new ArgumentNullException(nameof(storage));
+            _auditing = auditing ?? throw new ArgumentNullException(nameof(auditing));
             _logger = logger ?? throw new ArgumentNullException(nameof(logger));
         }
 
@@ -118,6 +121,19 @@ public async Task RemoveUserAsync(User user)
         }
 
         public async Task<FeatureFlagSaveResult> TrySaveAsync(FeatureFlags flags, string contentId)
+        {
+            var result = await TrySaveInternalAsync(flags, contentId);
+            await _auditing.SaveAuditRecordAsync(
+                new FeatureFlagsAuditRecord(
+                    AuditedFeatureFlagsAction.Update, 
+                    flags, 
+                    contentId, 
+                    result));
+
+            return result;
+        }
+
+        private async Task<FeatureFlagSaveResult> TrySaveInternalAsync(FeatureFlags flags, string contentId)
         {
             var accessCondition = AccessConditionWrapper.GenerateIfMatchCondition(contentId);
 

src/NuGetGallery.Core/NuGetGallery.Core.csproj

@@ -62,9 +62,13 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Auditing\AggregateAuditingService.cs" />
+    <Compile Include="Auditing\AuditedEntities\AuditedFeatureFlagFlight.cs" />
+    <Compile Include="Auditing\AuditedEntities\AuditedFeatureFlagFeature.cs" />
+    <Compile Include="Auditing\AuditedFeatureFlagsAction.cs" />
     <Compile Include="Auditing\AuditedCertificateAction.cs" />
     <Compile Include="Auditing\AuditedDeleteAccountAction.cs" />
     <Compile Include="Auditing\AuditedEntities\AuditedPackageDeprecation.cs" />
+    <Compile Include="Auditing\FeatureFlagsAuditRecord.cs" />
     <Compile Include="Auditing\CertificateAuditRecord.cs" />
     <Compile Include="Auditing\Obfuscation\ObfuscateAttribute.cs" />
     <Compile Include="Auditing\Obfuscation\ObfuscationType.cs" />

tests/NuGetGallery.Core.Facts/Auditing/AuditRecordTests.cs

@@ -18,6 +18,7 @@ public void SubclassingTypeSet_HasNotChanged()
                 "NuGetGallery.Auditing.CertificateAuditRecord",
                 "NuGetGallery.Auditing.DeleteAccountAuditRecord",
                 "NuGetGallery.Auditing.FailedAuthenticatedOperationAuditRecord",
+                "NuGetGallery.Auditing.FeatureFlagsAuditRecord",
                 "NuGetGallery.Auditing.PackageAuditRecord",
                 "NuGetGallery.Auditing.PackageRegistrationAuditRecord",
                 "NuGetGallery.Auditing.ReservedNamespaceAuditRecord",