From 51cf9f5264b84715211239c187b701f01ec8406c Mon Sep 17 00:00:00 2001
From: Lewis Sanchez <lewissanchez@microsoft.com>
Date: Tue, 20 Aug 2024 17:28:31 -0700
Subject: [PATCH 1/8] Copy query results to the clipboard

---
 .../Contracts/CopyResultsRequest.cs           |  6 ++++
 .../QueryExecution/QueryExecutionService.cs   | 30 +++++++++++++++----
 2 files changed, 31 insertions(+), 5 deletions(-)

diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
index 41d018bdae..75ccd4919e 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
@@ -49,4 +49,10 @@ public class CopyResultsRequest
         public static readonly RequestType<CopyResultsRequestParams, CopyResultsRequestResult> Type =
             RequestType<CopyResultsRequestParams, CopyResultsRequestResult>.Create("query/copy");
     }
+
+    public class CopyResultsToClipboardEvent
+    {
+        public static readonly EventType<CopyResultsRequestParams> Type =
+            EventType<CopyResultsRequestParams>.Create("query/copyToClipboard");
+    }
 }
\ No newline at end of file
diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
index c49a90375c..621cbb10ae 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
@@ -29,6 +29,7 @@
 using Microsoft.SqlTools.ServiceLayer.Workspace.Contracts;
 using Microsoft.SqlTools.ServiceLayer.Workspace;
 using Microsoft.SqlTools.Utility;
+using TextCopy;
 
 namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
 {
@@ -206,6 +207,7 @@ public void InitializeService(ServiceHost serviceHost)
             serviceHost.SetRequestHandler(SimpleExecuteRequest.Type, HandleSimpleExecuteRequest, true);
             serviceHost.SetRequestHandler(QueryExecutionOptionsRequest.Type, HandleQueryExecutionOptionsRequest, true);
             serviceHost.SetRequestHandler(CopyResultsRequest.Type, HandleCopyResultsRequest, true);
+            serviceHost.SetEventHandler(CopyResultsToClipboardEvent.Type, HandleCopyResultsToClipboardNotification, true);
 
             // Register the file open update handler
             WorkspaceService<SqlToolsSettings>.Instance.RegisterTextDocCloseCallback(HandleDidCloseTextDocumentNotification);
@@ -777,6 +779,27 @@ private Task OnNewConnection(ConnectionInfo info)
         /// Handles the copy results.
         /// </summary>
         internal async Task HandleCopyResultsRequest(CopyResultsRequestParams requestParams, RequestContext<CopyResultsRequestResult> requestContext)
+        {
+            StringBuilder builder = await GetStringBuilderToCopyQueryResults(requestParams);
+
+            CopyResultsRequestResult result = new CopyResultsRequestResult
+            {
+                Results = builder.ToString()
+            };
+            await requestContext.SendResult(result);
+        }
+
+        /// <summary>
+        /// Handles copying results to the clipboard.
+        /// </summary>
+        internal async Task HandleCopyResultsToClipboardNotification(CopyResultsRequestParams requestParams, EventContext eventContext)
+        {
+            StringBuilder builder = await GetStringBuilderToCopyQueryResults(requestParams);
+
+            await ClipboardService.SetTextAsync(builder.ToString());
+        }
+
+        private async Task<StringBuilder> GetStringBuilderToCopyQueryResults(CopyResultsRequestParams requestParams)
         {
             var valueSeparator = "\t";
             var columnRanges = this.MergeRanges(requestParams.Selections.Select(selection => new Range() { Start = selection.FromColumn, End = selection.ToColumn }).ToList());
@@ -871,11 +894,8 @@ internal async Task HandleCopyResultsRequest(CopyResultsRequestParams requestPar
                     pageStartRowIndex += rowsToFetch;
                 } while (pageStartRowIndex < rowRange.End);
             }
-            CopyResultsRequestResult result = new CopyResultsRequestResult
-            {
-                Results = builder.ToString()
-            };
-            await requestContext.SendResult(result);
+
+            return builder;
         }
 
         #endregion

From 2ada50cf0a7eea2c00cc62eb255661954b5d198a Mon Sep 17 00:00:00 2001
From: Lewis Sanchez <lewissanchez@microsoft.com>
Date: Tue, 20 Aug 2024 18:31:56 -0700
Subject: [PATCH 2/8] Add TextCopy NuGet package.

---
 Packages.props                                                   | 1 +
 .../Microsoft.SqlTools.ServiceLayer.csproj                       | 1 +
 2 files changed, 2 insertions(+)

diff --git a/Packages.props b/Packages.props
index 5bbce37539..d4f78e844e 100644
--- a/Packages.props
+++ b/Packages.props
@@ -54,6 +54,7 @@
     <PackageReference Update="Microsoft.SqlServer.XEvent.XELite" Version="2023.1.30.3" />
     <PackageReference Update="SkiaSharp" Version="2.88.6" />
     <PackageReference Update="SkiaSharp.NativeAssets.Linux.NoDependencies" Version="2.88.6" Condition="$([MSBuild]::IsOsPlatform('Linux'))" />
+    <PackageReference Update="TextCopy" Version="6.2.1" />
   </ItemGroup>
 
   <!-- When updating version of Dependencies in the below section, please also update the version in the following files:
diff --git a/src/Microsoft.SqlTools.ServiceLayer/Microsoft.SqlTools.ServiceLayer.csproj b/src/Microsoft.SqlTools.ServiceLayer/Microsoft.SqlTools.ServiceLayer.csproj
index 5c57bcf0d5..b18fe11e40 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/Microsoft.SqlTools.ServiceLayer.csproj
+++ b/src/Microsoft.SqlTools.ServiceLayer/Microsoft.SqlTools.ServiceLayer.csproj
@@ -60,6 +60,7 @@
     <PackageReference Include="Microsoft.SqlServer.TransactSql.ScriptDom.NRT">
       <Aliases>ASAScriptDom</Aliases>
     </PackageReference>
+    <PackageReference Include="TextCopy" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="../Microsoft.SqlTools.Hosting/Microsoft.SqlTools.Hosting.csproj" />

From d45dbe1f3bbf4c7a7128f08778d49f5e8ac9088a Mon Sep 17 00:00:00 2001
From: Lewis Sanchez <lewissanchez@microsoft.com>
Date: Wed, 21 Aug 2024 10:54:36 -0700
Subject: [PATCH 3/8] Conditionally copies directly to clipboard

---
 .../Contracts/CopyResultsRequest.cs           | 11 ++++---
 .../QueryExecution/QueryExecutionService.cs   | 29 ++++++++++---------
 2 files changed, 21 insertions(+), 19 deletions(-)

diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
index 75ccd4919e..6e39a44128 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
@@ -31,6 +31,11 @@ public class CopyResultsRequestParams : SubsetParams
         /// The selections.
         /// </summary>
         public TableSelectionRange[] Selections { get; set; }
+
+        /// <summary>
+        /// Whether to copy the results directly to the clipboard from STS.
+        /// </summary>
+        public bool CopyDirectlyToClipboard { get; set; }
     }
 
     /// <summary>
@@ -49,10 +54,4 @@ public class CopyResultsRequest
         public static readonly RequestType<CopyResultsRequestParams, CopyResultsRequestResult> Type =
             RequestType<CopyResultsRequestParams, CopyResultsRequestResult>.Create("query/copy");
     }
-
-    public class CopyResultsToClipboardEvent
-    {
-        public static readonly EventType<CopyResultsRequestParams> Type =
-            EventType<CopyResultsRequestParams>.Create("query/copyToClipboard");
-    }
 }
\ No newline at end of file
diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
index 621cbb10ae..1ba9b73e95 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
@@ -207,7 +207,6 @@ public void InitializeService(ServiceHost serviceHost)
             serviceHost.SetRequestHandler(SimpleExecuteRequest.Type, HandleSimpleExecuteRequest, true);
             serviceHost.SetRequestHandler(QueryExecutionOptionsRequest.Type, HandleQueryExecutionOptionsRequest, true);
             serviceHost.SetRequestHandler(CopyResultsRequest.Type, HandleCopyResultsRequest, true);
-            serviceHost.SetEventHandler(CopyResultsToClipboardEvent.Type, HandleCopyResultsToClipboardNotification, true);
 
             // Register the file open update handler
             WorkspaceService<SqlToolsSettings>.Instance.RegisterTextDocCloseCallback(HandleDidCloseTextDocumentNotification);
@@ -782,21 +781,25 @@ internal async Task HandleCopyResultsRequest(CopyResultsRequestParams requestPar
         {
             StringBuilder builder = await GetStringBuilderToCopyQueryResults(requestParams);
 
-            CopyResultsRequestResult result = new CopyResultsRequestResult
+            CopyResultsRequestResult result;
+            if (requestParams.CopyDirectlyToClipboard)
             {
-                Results = builder.ToString()
-            };
-            await requestContext.SendResult(result);
-        }
+                await ClipboardService.SetTextAsync(builder.ToString());
 
-        /// <summary>
-        /// Handles copying results to the clipboard.
-        /// </summary>
-        internal async Task HandleCopyResultsToClipboardNotification(CopyResultsRequestParams requestParams, EventContext eventContext)
-        {
-            StringBuilder builder = await GetStringBuilderToCopyQueryResults(requestParams);
+                result = new CopyResultsRequestResult
+                {
+                    Results = string.Empty
+                };   
+            }
+            else
+            {
+                result = new CopyResultsRequestResult
+                {
+                    Results = builder.ToString()
+                };
+            }
 
-            await ClipboardService.SetTextAsync(builder.ToString());
+            await requestContext.SendResult(result);
         }
 
         private async Task<StringBuilder> GetStringBuilderToCopyQueryResults(CopyResultsRequestParams requestParams)

From a7f10ac847e59dd03c8b63fac406bc3930018e6c Mon Sep 17 00:00:00 2001
From: Lewis Sanchez <lewissanchez@microsoft.com>
Date: Wed, 21 Aug 2024 11:14:38 -0700
Subject: [PATCH 4/8] Rename copy in backend request property

---
 .../QueryExecution/Contracts/CopyResultsRequest.cs            | 4 ++--
 .../QueryExecution/QueryExecutionService.cs                   | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
index 6e39a44128..d763abee0f 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
@@ -33,9 +33,9 @@ public class CopyResultsRequestParams : SubsetParams
         public TableSelectionRange[] Selections { get; set; }
 
         /// <summary>
-        /// Whether to copy the results directly to the clipboard from STS.
+        /// Whether to copy the results in the backend.
         /// </summary>
-        public bool CopyDirectlyToClipboard { get; set; }
+        public bool CopyInBackend { get; set; }
     }
 
     /// <summary>
diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
index 1ba9b73e95..b296d44af3 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
@@ -782,7 +782,7 @@ internal async Task HandleCopyResultsRequest(CopyResultsRequestParams requestPar
             StringBuilder builder = await GetStringBuilderToCopyQueryResults(requestParams);
 
             CopyResultsRequestResult result;
-            if (requestParams.CopyDirectlyToClipboard)
+            if (requestParams.CopyInBackend)
             {
                 await ClipboardService.SetTextAsync(builder.ToString());
 

From f0dd6fd5c27cd9793c3fd82f0f9dd48f6173e6ab Mon Sep 17 00:00:00 2001
From: Lewis Sanchez <lewissanchez@microsoft.com>
Date: Mon, 26 Aug 2024 17:48:19 -0700
Subject: [PATCH 5/8] Rename property for copying results request.

---
 .../QueryExecution/Contracts/CopyResultsRequest.cs            | 4 ++--
 .../QueryExecution/QueryExecutionService.cs                   | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
index d763abee0f..0b79976d01 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
@@ -33,9 +33,9 @@ public class CopyResultsRequestParams : SubsetParams
         public TableSelectionRange[] Selections { get; set; }
 
         /// <summary>
-        /// Whether to copy the results in the backend.
+        /// Whether to copy results from the UI process.
         /// </summary>
-        public bool CopyInBackend { get; set; }
+        public bool CopyFromUIProcess { get; set; }
     }
 
     /// <summary>
diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
index b296d44af3..a5c60e9b35 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
@@ -782,14 +782,14 @@ internal async Task HandleCopyResultsRequest(CopyResultsRequestParams requestPar
             StringBuilder builder = await GetStringBuilderToCopyQueryResults(requestParams);
 
             CopyResultsRequestResult result;
-            if (requestParams.CopyInBackend)
+            if (!requestParams.CopyFromUIProcess)
             {
                 await ClipboardService.SetTextAsync(builder.ToString());
 
                 result = new CopyResultsRequestResult
                 {
                     Results = string.Empty
-                };   
+                };
             }
             else
             {

From 606e10f5c5b2a58e752343aa946896cd18a94e77 Mon Sep 17 00:00:00 2001
From: Lewis Sanchez <lewissanchez@microsoft.com>
Date: Tue, 27 Aug 2024 18:04:10 -0700
Subject: [PATCH 6/8] Stop sending result string for copying

---
 .../Contracts/CopyResultsRequest.cs           |  6 ----
 .../QueryExecution/QueryExecutionService.cs   | 29 ++-----------------
 2 files changed, 2 insertions(+), 33 deletions(-)

diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
index 0b79976d01..33c55e067a 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Contracts/CopyResultsRequest.cs
@@ -31,11 +31,6 @@ public class CopyResultsRequestParams : SubsetParams
         /// The selections.
         /// </summary>
         public TableSelectionRange[] Selections { get; set; }
-
-        /// <summary>
-        /// Whether to copy results from the UI process.
-        /// </summary>
-        public bool CopyFromUIProcess { get; set; }
     }
 
     /// <summary>
@@ -43,7 +38,6 @@ public class CopyResultsRequestParams : SubsetParams
     /// </summary>
     public class CopyResultsRequestResult
     {
-        public string Results { get; set; }
     }
 
     /// <summary>
diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
index a5c60e9b35..37b830123c 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
@@ -778,31 +778,6 @@ private Task OnNewConnection(ConnectionInfo info)
         /// Handles the copy results.
         /// </summary>
         internal async Task HandleCopyResultsRequest(CopyResultsRequestParams requestParams, RequestContext<CopyResultsRequestResult> requestContext)
-        {
-            StringBuilder builder = await GetStringBuilderToCopyQueryResults(requestParams);
-
-            CopyResultsRequestResult result;
-            if (!requestParams.CopyFromUIProcess)
-            {
-                await ClipboardService.SetTextAsync(builder.ToString());
-
-                result = new CopyResultsRequestResult
-                {
-                    Results = string.Empty
-                };
-            }
-            else
-            {
-                result = new CopyResultsRequestResult
-                {
-                    Results = builder.ToString()
-                };
-            }
-
-            await requestContext.SendResult(result);
-        }
-
-        private async Task<StringBuilder> GetStringBuilderToCopyQueryResults(CopyResultsRequestParams requestParams)
         {
             var valueSeparator = "\t";
             var columnRanges = this.MergeRanges(requestParams.Selections.Select(selection => new Range() { Start = selection.FromColumn, End = selection.ToColumn }).ToList());
@@ -897,8 +872,8 @@ private async Task<StringBuilder> GetStringBuilderToCopyQueryResults(CopyResults
                     pageStartRowIndex += rowsToFetch;
                 } while (pageStartRowIndex < rowRange.End);
             }
-
-            return builder;
+            await ClipboardService.SetTextAsync(builder.ToString());
+            await requestContext.SendResult(new CopyResultsRequestResult());
         }
 
         #endregion

From a4725dafe3e892b96f164a073b4029657eee3f1e Mon Sep 17 00:00:00 2001
From: Lewis Sanchez <lewissanchez@microsoft.com>
Date: Thu, 29 Aug 2024 16:47:12 -0700
Subject: [PATCH 7/8] Improve check for new line at builder end

---
 .../QueryExecution/QueryExecutionService.cs                  | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
index 37b830123c..a156499bee 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
@@ -1,4 +1,4 @@
-//
+//
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
@@ -864,7 +864,8 @@ internal async Task HandleCopyResultsRequest(CopyResultsRequestParams requestPar
                             }
                         }
                         // Add line break if this is not the last row in all selections.
-                        if (rowIndex + pageStartRowIndex != lastRowIndex && (!builder.ToString().EndsWith(Environment.NewLine) || (!Settings?.QueryEditorSettings?.Results?.SkipNewLineAfterTrailingLineBreak ?? true)))
+                        var lastChar = builder[builder.Length - 1];
+                        if (rowIndex + pageStartRowIndex != lastRowIndex && (!Environment.NewLine.EndsWith(lastChar) || (!Settings?.QueryEditorSettings?.Results?.SkipNewLineAfterTrailingLineBreak ?? true)))
                         {
                             builder.Append(Environment.NewLine);
                         }

From 72758ce87693d52a47912bc1b962ae1232439627 Mon Sep 17 00:00:00 2001
From: Lewis Sanchez <lewissanchez@microsoft.com>
Date: Wed, 11 Sep 2024 18:00:59 -0700
Subject: [PATCH 8/8] Correctly checks if row end needs line break

---
 .../QueryExecution/QueryExecutionService.cs        | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
index a156499bee..3fe847100e 100644
--- a/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs
@@ -864,8 +864,7 @@ internal async Task HandleCopyResultsRequest(CopyResultsRequestParams requestPar
                             }
                         }
                         // Add line break if this is not the last row in all selections.
-                        var lastChar = builder[builder.Length - 1];
-                        if (rowIndex + pageStartRowIndex != lastRowIndex && (!Environment.NewLine.EndsWith(lastChar) || (!Settings?.QueryEditorSettings?.Results?.SkipNewLineAfterTrailingLineBreak ?? true)))
+                        if (rowIndex + pageStartRowIndex != lastRowIndex && (!StringBuilderEndsWith(builder, Environment.NewLine) || (!Settings?.QueryEditorSettings?.Results?.SkipNewLineAfterTrailingLineBreak ?? true)))
                         {
                             builder.Append(Environment.NewLine);
                         }
@@ -881,6 +880,17 @@ internal async Task HandleCopyResultsRequest(CopyResultsRequestParams requestPar
 
         #region Private Helpers
 
+        private bool StringBuilderEndsWith(StringBuilder sb, string target)
+        {
+            if (sb.Length < target.Length)
+            {
+                return false;
+            }
+
+            // Calling ToString like this only converts the last few characters of the StringBuilder to a string
+            return sb.ToString(sb.Length - target.Length, target.Length).EndsWith(target);
+        }
+
         private Query CreateQuery(
             ExecuteRequestParamsBase executeParams,
             ConnectionInfo connInfo,