From 2eeed98a63e28f85826afe249e81b03b79281fe7 Mon Sep 17 00:00:00 2001
From: Benjamin Russell <benrr101@outlook.com>
Date: Thu, 13 Oct 2016 12:14:22 -0700
Subject: [PATCH] Returning start/end and elapsed time with batch summaries
 (#92)

Returning start/end and elapsed timestamps for batches with the batch summary.
---
 .../QueryExecution/Batch.cs                   | 36 +++++++++++++++++++
 .../QueryExecution/Contracts/BatchSummary.cs  | 15 ++++++++
 .../QueryExecution/Query.cs                   |  3 ++
 3 files changed, 54 insertions(+)

diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs
index 10b2d9b1..14a5e2c7 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs
@@ -30,6 +30,16 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
         /// </summary>
         private bool disposed;
 
+        /// <summary>
+        /// Local time when the execution and retrieval of files is finished
+        /// </summary>
+        private DateTime executionEndTime;
+
+        /// <summary>
+        /// Local time when the execution starts, specifically when the object is created
+        /// </summary>
+        private readonly DateTime executionStartTime;
+
         /// <summary>
         /// Factory for creating readers/writers for the output of the batch
         /// </summary>
@@ -55,6 +65,7 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
 
             // Initialize the internal state
             BatchText = batchText;
+            executionStartTime = DateTime.Now;
             Selection = new SelectionData(startLine, startColumn, endLine, endColumn);
             HasExecuted = false;
             resultSets = new List<ResultSet>();
@@ -69,6 +80,30 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
         /// </summary>
         public string BatchText { get; set; }
 
+        /// <summary>
+        /// Localized timestamp for when the execution completed.
+        /// Stored in UTC ISO 8601 format; should be localized before displaying to any user
+        /// </summary>
+        public string ExecutionEndTimeStamp { get { return executionEndTime.ToString("o"); } }
+
+        /// <summary>
+        /// Localized timestamp for how long it took for the execution to complete
+        /// </summary>
+        public string ExecutionElapsedTime
+        {
+            get
+            {
+                TimeSpan elapsedTime = executionEndTime - executionStartTime;
+                return elapsedTime.ToString();
+            }
+        }
+
+        /// <summary>
+        /// Localized timestamp for when the execution began.
+        /// Stored in UTC ISO 8601 format; should be localized before displaying to any user
+        /// </summary>
+        public string ExecutionStartTimeStamp { get { return executionStartTime.ToString("o"); } }
+
         /// <summary>
         /// Whether or not this batch has an error
         /// </summary>
@@ -218,6 +253,7 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
 
                 // Mark that we have executed
                 HasExecuted = true;
+                executionEndTime = DateTime.Now;
             }
         }
 
diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/BatchSummary.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/BatchSummary.cs
index 7e1b2837..884d76f6 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/BatchSummary.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/BatchSummary.cs
@@ -10,6 +10,21 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
     /// </summary>
     public class BatchSummary
     {
+        /// <summary>
+        /// Localized timestamp for how long it took for the execution to complete
+        /// </summary>
+        public string ExecutionElapsed { get; set; }
+
+        /// <summary>
+        /// Localized timestamp for when the execution completed.
+        /// </summary>
+        public string ExecutionEnd { get; set; }
+
+        /// <summary>
+        /// Localized timestamp for when the execution started.
+        /// </summary>
+        public string ExecutionStart { get; set; }
+
         /// <summary>
         /// Whether or not the batch was successful. True indicates errors, false indicates success
         /// </summary>
diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Query.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Query.cs
index 1c48d516..61b17543 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Query.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Query.cs
@@ -132,6 +132,9 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
                 return Batches.Select((batch, index) => new BatchSummary
                 {
                     Id = index,
+                    ExecutionStart = batch.ExecutionStartTimeStamp,
+                    ExecutionEnd = batch.ExecutionEndTimeStamp,
+                    ExecutionElapsed = batch.ExecutionElapsedTime,
                     HasError = batch.HasError,
                     Messages = batch.ResultMessages.ToArray(),
                     ResultSetSummaries = batch.ResultSummaries,