Allow the SQL command timeout to be configured in Search.GenerateAuxi…

…liaryData (#736) Progress on NuGet/Engineering#2327
NuGet · Mar 28, 2019 · ff58142 · ff58142
1 parent 028dfef
commit ff58142
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 16 deletions.
diff --git a/src/Search.GenerateAuxiliaryData/Configuration/InitializationConfiguration.cs b/src/Search.GenerateAuxiliaryData/Configuration/InitializationConfiguration.cs
@@ -1,6 +1,8 @@
 // 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;
+
 namespace Search.GenerateAuxiliaryData
 {
     public class InitializationConfiguration
@@ -12,5 +14,7 @@ public class InitializationConfiguration
         public string PrimaryDestination { get; set; }
 
         public string DestinationContainerName { get; set; }
+
+        public TimeSpan SqlCommandTimeout { get; set; } = TimeSpan.FromMinutes(1);
     }
 }
diff --git a/src/Search.GenerateAuxiliaryData/Job.cs b/src/Search.GenerateAuxiliaryData/Job.cs
@@ -58,7 +58,8 @@ public override void Init(IServiceContainer serviceContainer, IDictionary<string
                     OpenSqlConnectionAsync<GalleryDbConfiguration>,
                     destinationContainer,
                     ScriptVerifiedPackages,
-                    OutputNameVerifiedPackages),
+                    OutputNameVerifiedPackages,
+                    Configuration.SqlCommandTimeout),
 
                 new NestedJArrayExporter(
                     LoggerFactory.CreateLogger<NestedJArrayExporter>(),
@@ -67,14 +68,16 @@ public override void Init(IServiceContainer serviceContainer, IDictionary<string
                     ScriptOwners,
                     OutputNameOwners,
                     Col0Owners,
-                    Col1Owners),
+                    Col1Owners,
+                    Configuration.SqlCommandTimeout),
 
                 new RankingsExporter(
                     LoggerFactory.CreateLogger<RankingsExporter>(),
                     OpenSqlConnectionAsync<StatisticsDbConfiguration>,
                     destinationContainer,
                     ScriptRankingsTotal,
-                    OutputNameRankings),
+                    OutputNameRankings,
+                    Configuration.SqlCommandTimeout),
 
                 new BlobStorageExporter(
                     LoggerFactory.CreateLogger<BlobStorageExporter>(),

diff --git a/src/Search.GenerateAuxiliaryData/NestedJArrayExporter.cs b/src/Search.GenerateAuxiliaryData/NestedJArrayExporter.cs
@@ -23,8 +23,12 @@ public NestedJArrayExporter(
             ILogger<NestedJArrayExporter> logger,
             Func<Task<SqlConnection>> openSqlConnectionAsync,
             CloudBlobContainer defaultDestinationContainer,
-            string defaultSqlScript, string defaultName, string defaultCol0, string defaultCol1)
-            : base(logger, openSqlConnectionAsync, defaultDestinationContainer, defaultName)
+            string defaultSqlScript,
+            string defaultName,
+            string defaultCol0,
+            string defaultCol1,
+            TimeSpan commandTimeout)
+            : base(logger, openSqlConnectionAsync, defaultDestinationContainer, defaultName, commandTimeout)
         {
             Col0 = defaultCol0;
             Col1 = defaultCol1;

diff --git a/src/Search.GenerateAuxiliaryData/RankingsExporter.cs b/src/Search.GenerateAuxiliaryData/RankingsExporter.cs
@@ -24,8 +24,9 @@ public RankingsExporter(
             Func<Task<SqlConnection>> openSqlConnectionAsync,
             CloudBlobContainer defaultDestinationContainer,
             string defaultRankingsScript,
-            string defaultName)
-            : base(logger, openSqlConnectionAsync, defaultDestinationContainer, defaultName)
+            string defaultName,
+            TimeSpan commandTimeout)
+            : base(logger, openSqlConnectionAsync, defaultDestinationContainer, defaultName, commandTimeout)
         {
             _rankingsTotalScript = defaultRankingsScript;
         }
@@ -34,7 +35,6 @@ protected override JContainer GetResultOfQuery(SqlConnection connection)
         {
             var rankingsTotalCommand = GetEmbeddedSqlCommand(connection, _rankingsTotalScript);
             rankingsTotalCommand.Parameters.AddWithValue(_rankingCountParameterName, _rankingCount);
-            rankingsTotalCommand.CommandTimeout = 60;
 
             return GetRankings(rankingsTotalCommand.ExecuteReader());
         }

diff --git a/src/Search.GenerateAuxiliaryData/SqlExporter.cs b/src/Search.GenerateAuxiliaryData/SqlExporter.cs
@@ -24,27 +24,32 @@ public abstract class SqlExporter : Exporter
 
         private Func<Task<SqlConnection>> OpenSqlConnectionAsync { get; }
 
+        private readonly TimeSpan _commandTimeout;
+
         public SqlExporter(
             ILogger<SqlExporter> logger,
             Func<Task<SqlConnection>> openSqlConnectionAsync,
             CloudBlobContainer defaultDestinationContainer,
-            string defaultName)
+            string defaultName,
+            TimeSpan commandTimeout)
             : base(logger, defaultDestinationContainer, defaultName)
         {
             _logger = logger;
             OpenSqlConnectionAsync = openSqlConnectionAsync;
+            _commandTimeout = commandTimeout;
         }
 
         [SuppressMessage("Microsoft.Security", "CA2100", Justification = "Query string comes from embedded resource, not user input.")]
-        protected static SqlCommand GetEmbeddedSqlCommand(SqlConnection connection, string resourceName)
+        protected SqlCommand GetEmbeddedSqlCommand(SqlConnection connection, string resourceName)
         {
             using (var reader = new StreamReader(_executingAssembly.GetManifestResourceStream(_assemblyName + "." + resourceName)))
             {
                 var commandText = reader.ReadToEnd();
 
                 return new SqlCommand(commandText, connection)
                 {
-                    CommandType = CommandType.Text
+                    CommandType = CommandType.Text,
+                    CommandTimeout = (int)_commandTimeout.TotalSeconds,
                 };
             }
         }

diff --git a/src/Search.GenerateAuxiliaryData/VerifiedPackagesExporter.cs b/src/Search.GenerateAuxiliaryData/VerifiedPackagesExporter.cs
@@ -21,16 +21,16 @@ public VerifiedPackagesExporter(
             Func<Task<SqlConnection>> openSqlConnectionAsync,
             CloudBlobContainer defaultDestinationContainer,
             string defaultVerifiedPackagesScript,
-            string defaultName)
-            : base(logger, openSqlConnectionAsync, defaultDestinationContainer, defaultName)
+            string defaultName,
+            TimeSpan commandTimeout)
+            : base(logger, openSqlConnectionAsync, defaultDestinationContainer, defaultName, commandTimeout)
         {
             _verifiedPackagesScript = defaultVerifiedPackagesScript;
         }
 
         protected override JContainer GetResultOfQuery(SqlConnection connection)
         {
             var verifiedPackagesCommand = GetEmbeddedSqlCommand(connection, _verifiedPackagesScript);
-            verifiedPackagesCommand.CommandTimeout = 60;
 
             SqlDataReader reader = null;
 

diff --git a/tests/Tests.Search.GenerateAuxiliaryData/RankingsExporterTests.cs b/tests/Tests.Search.GenerateAuxiliaryData/RankingsExporterTests.cs
@@ -47,7 +47,8 @@ private static RankingsExporter CreateExporter()
                 openSqlConnectionAsync: () => null,
                 defaultDestinationContainer: new CloudBlobContainer(new Uri("https://nuget.org")),
                 defaultRankingsScript: "b",
-                defaultName: "c");
+                defaultName: "c",
+                commandTimeout: TimeSpan.FromSeconds(10));
         }
     }
 }
diff --git a/tests/Tests.Search.GenerateAuxiliaryData/VerifiedPackagesExporterTests.cs b/tests/Tests.Search.GenerateAuxiliaryData/VerifiedPackagesExporterTests.cs
@@ -46,7 +46,8 @@ private static VerifiedPackagesExporter CreateExporter()
                 openSqlConnectionAsync: () => null,
                 defaultDestinationContainer: new CloudBlobContainer(new Uri("https://nuget.org")),
                 defaultVerifiedPackagesScript: "b",
-                defaultName: "c");
+                defaultName: "c",
+                commandTimeout: TimeSpan.FromSeconds(10));
         }
     }
 }