StorageStatusService (#7165)

Gallery status service will verify the storage primary or secondary for status depending on the read only mode. The readOnly will verify the secondary storage and the readWrite will verify the primary storage.

Author: cristinamanum

src/NuGetGallery.Core/Auditing/CloudAuditingService.cs

@@ -2,20 +2,14 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
-using System.Collections.Generic;
 using System.Globalization;
 using System.IO;
-using System.Linq;
-using System.Reflection;
 using System.Threading.Tasks;
 using Microsoft.WindowsAzure.Storage;
 using Microsoft.WindowsAzure.Storage.Blob;
 using Microsoft.WindowsAzure.Storage.Blob.Protocol;
 using Microsoft.WindowsAzure.Storage.RetryPolicies;
 using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
-using Newtonsoft.Json.Linq;
-using Newtonsoft.Json.Serialization;
 using NuGetGallery.Auditing.Obfuscation;
 
 namespace NuGetGallery.Auditing
@@ -133,9 +127,9 @@ private static async Task WriteBlob(string auditData, string fullPath, CloudBloc
             }
         }
 
-        public Task<bool> IsAvailableAsync()
+        public Task<bool> IsAvailableAsync(BlobRequestOptions options, OperationContext operationContext)
         {
-            return _auditContainer.ExistsAsync();
+            return _auditContainer.ExistsAsync(options, operationContext);
         }
 
         public override string RenderAuditEntry(AuditEntry entry)

src/NuGetGallery.Core/ICloudStorageStatusDependency.cs

@@ -2,6 +2,8 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System.Threading.Tasks;
+using Microsoft.WindowsAzure.Storage;
+using Microsoft.WindowsAzure.Storage.Blob;
 
 namespace NuGetGallery
 {
@@ -11,6 +13,6 @@ namespace NuGetGallery
     /// </summary>
     public interface ICloudStorageStatusDependency
     {
-        Task<bool> IsAvailableAsync();
+        Task<bool> IsAvailableAsync(BlobRequestOptions options, OperationContext operationContext);
     }
 }

src/NuGetGallery.Core/Services/CloudBlobContainerWrapper.cs

@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System.Threading.Tasks;
+using Microsoft.WindowsAzure.Storage;
 using Microsoft.WindowsAzure.Storage.Blob;
 
 namespace NuGetGallery
@@ -34,9 +35,9 @@ public ISimpleCloudBlob GetBlobReference(string blobAddressUri)
             return new CloudBlobWrapper(_blobContainer.GetBlockBlobReference(blobAddressUri));
         }
 
-        public Task<bool> ExistsAsync()
+        public Task<bool> ExistsAsync(BlobRequestOptions blobRequestOptions, OperationContext context)
         {
-            return _blobContainer.ExistsAsync();
+            return _blobContainer.ExistsAsync(blobRequestOptions, context);
         }
 
         public async Task<bool> DeleteIfExistsAsync()

src/NuGetGallery.Core/Services/ICloudBlobContainer.cs

@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System.Threading.Tasks;
+using Microsoft.WindowsAzure.Storage;
 using Microsoft.WindowsAzure.Storage.Blob;
 
 namespace NuGetGallery
@@ -11,7 +12,7 @@ public interface ICloudBlobContainer
         Task CreateIfNotExistAsync();
         Task SetPermissionsAsync(BlobContainerPermissions permissions);
         ISimpleCloudBlob GetBlobReference(string blobAddressUri);
-        Task<bool> ExistsAsync();
+        Task<bool> ExistsAsync(BlobRequestOptions options, OperationContext operationContext);
         Task<bool> DeleteIfExistsAsync();
         Task CreateAsync();
     }

src/NuGetGallery/App_Start/DefaultDependenciesModule.cs

@@ -863,14 +863,15 @@ private static void ConfigureForAzureStorage(ContainerBuilder builder, IGalleryC
                        .SingleInstance()
                        .Keyed<ICloudBlobClient>(dependent.BindingKey);
 
+                    // Do not register the service as ICloudStorageStatusDependency because
+                    // the CloudAuditingService registers it and the gallery uses the same storage account for all the containers.
                     builder.RegisterType<CloudBlobFileStorageService>()
                         .WithParameter(new ResolvedParameter(
                            (pi, ctx) => pi.ParameterType == typeof(ICloudBlobClient),
                            (pi, ctx) => ctx.ResolveKeyed<ICloudBlobClient>(dependent.BindingKey)))
                         .AsSelf()
                         .As<IFileStorageService>()
                         .As<ICoreFileStorageService>()
-                        .As<ICloudStorageStatusDependency>()
                         .SingleInstance()
                         .Keyed<IFileStorageService>(dependent.BindingKey);
                 }
@@ -902,7 +903,6 @@ private static void ConfigureForAzureStorage(ContainerBuilder builder, IGalleryC
             builder.RegisterInstance(new CloudReportService(configuration.Current.AzureStorage_Statistics_ConnectionString, configuration.Current.AzureStorageReadAccessGeoRedundant))
                 .AsSelf()
                 .As<IReportService>()
-                .As<ICloudStorageStatusDependency>()
                 .SingleInstance();
 
             // when running on Windows Azure, download counts come from the downloads.v1.json blob

src/NuGetGallery/Services/CloudBlobFileStorageService.cs

@@ -11,7 +11,7 @@
 
 namespace NuGetGallery
 {
-    public class CloudBlobFileStorageService : CloudBlobCoreFileStorageService, IFileStorageService, ICloudStorageStatusDependency
+    public class CloudBlobFileStorageService : CloudBlobCoreFileStorageService, IFileStorageService
     {
         private readonly IAppConfiguration _configuration;
         private readonly ISourceDestinationRedirectPolicy _redirectPolicy;
@@ -98,7 +98,7 @@ internal Uri GetRedirectUri(Uri requestUrl, Uri blobUri)
         public async Task<bool> IsAvailableAsync()
         {
             var container = await GetContainerAsync(CoreConstants.Folders.PackagesFolderName);
-            return await container.ExistsAsync();
+            return await container.ExistsAsync(options: null, operationContext: null);
         }
     }
 }

src/NuGetGallery/Services/CloudReportService.cs

@@ -8,7 +8,7 @@
 
 namespace NuGetGallery
 {
-    public class CloudReportService : IReportService, ICloudStorageStatusDependency
+    public class CloudReportService : IReportService
     {
         private const string _statsContainerName = "nuget-cdnstats";
         private readonly string _connectionString;
@@ -20,12 +20,6 @@ public CloudReportService(string connectionString, bool readAccessGeoRedundant)
             _readAccessGeoRedundant = readAccessGeoRedundant;
         }
 
-        public Task<bool> IsAvailableAsync()
-        {
-            var container = GetCloudBlobContainer();
-            return container.ExistsAsync();
-        }
-
         public async Task<StatisticsReport> Load(string reportName)
         {
             // In NuGet we always use lowercase names for all blobs in Azure Storage

src/NuGetGallery/Services/StatusService.cs

@@ -10,6 +10,8 @@
 using System.Net.Http;
 using System.Threading.Tasks;
 using System.Web.Mvc;
+using Microsoft.WindowsAzure.Storage.Blob;
+using Microsoft.WindowsAzure.Storage.RetryPolicies;
 using NuGetGallery.Configuration;
 using NuGetGallery.Helpers;
 
@@ -80,7 +82,7 @@ private bool IsSqlAzureAvailable()
             return sqlAzureAvailable;
         }
 
-        private async Task<bool?> IsAzureStorageAvailable()
+        internal async Task<bool?> IsAzureStorageAvailable()
         {
             if (_config == null || _config.StorageType != StorageType.AzureStorage)
             {
@@ -91,7 +93,12 @@ private bool IsSqlAzureAvailable()
             try
             {
                 // Check Storage Availability
-                var tasks = _cloudStorageAvailabilityChecks.Select(s => s.IsAvailableAsync());
+                BlobRequestOptions options = new BlobRequestOptions();
+                // Used the LocationMode.SecondaryOnly and not PrimaryThenSecondary for two reasons:
+                // 1. When the primary is down and secondary is up if PrimaryThenSecondary is used there will be an extra and not needed call to the primary.
+                // 2. When the primary is up the secondary status check will return the primary status instead of secondary.
+                options.LocationMode = _config.ReadOnlyMode ? LocationMode.SecondaryOnly : LocationMode.PrimaryOnly;
+                var tasks = _cloudStorageAvailabilityChecks.Select(s => s.IsAvailableAsync(options, operationContext : null));
                 var eachAvailable = await Task.WhenAll(tasks);
                 storageAvailable = eachAvailable.All(a => a);
             }

tests/NuGetGallery.Facts/NuGetGallery.Facts.csproj

@@ -89,6 +89,7 @@
     <Compile Include="Infrastructure\Lucene\GallerySearchServiceFacts.cs" />
     <Compile Include="Helpers\StreamHelperFacts.cs" />
     <Compile Include="Services\PackageDeprecationServiceFacts.cs" />
+    <Compile Include="Services\StatusServiceFacts.cs" />
     <Compile Include="TestData\TestDataResourceUtility.cs" />
     <Compile Include="UsernameValidationRegex.cs" />
     <Compile Include="Extensions\NumberExtensionsFacts.cs" />