Adding support for async script operation. (#2534)

* Adding support for async script operation.

* Fixed flag name

* fixed flows and more comments

---------

Co-authored-by: Aasim Khan <[email protected]>

Author: aasimkhan30

src/Microsoft.SqlTools.ServiceLayer/Scripting/ScriptingService.cs

@@ -137,9 +137,16 @@ public Task HandleScriptExecuteRequest(ScriptingParams parameters, RequestContex
 
             operation.PlanNotification += (sender, e) => requestContext.SendEvent(ScriptingPlanNotificationEvent.Type, e).Wait();
             operation.ProgressNotification += (sender, e) => requestContext.SendEvent(ScriptingProgressNotificationEvent.Type, e).Wait();
-            operation.CompleteNotification += (sender, e) => this.SendScriptingCompleteEvent(requestContext, ScriptingCompleteEvent.Type, e, operation, parameters.ScriptDestination);
+            operation.CompleteNotification += (sender, e) => this.SendScriptingCompleteEvent(requestContext, ScriptingCompleteEvent.Type, e, operation, parameters);
 
             RunTask(requestContext, operation);
+
+            // If ReturnScriptAsynchronously is enabled, return operation ID immediately
+            if (parameters.ReturnScriptAsynchronously)
+            {
+                return requestContext.SendResult(new ScriptingResult { OperationId = operation.OperationId });
+            }
+
             return Task.CompletedTask;
         }
 
@@ -180,10 +187,19 @@ public async Task HandleScriptCancelRequest(ScriptingCancelParams parameters, Re
         }
 
         private async void SendScriptingCompleteEvent<TParams>(RequestContext<ScriptingResult> requestContext, EventType<TParams> eventType, TParams parameters,
-                                                               SmoScriptingOperation operation, string scriptDestination)
+                                                               SmoScriptingOperation operation, ScriptingParams scriptingParams)
         {
+            // If ReturnScriptAsynchronously is enabled, include script in the complete event
+            if (scriptingParams.ReturnScriptAsynchronously && parameters is ScriptingCompleteParams completeParams)
+            {
+                completeParams.Script = operation.ScriptText;
+                await requestContext.SendEvent(eventType, parameters);
+                return;
+            }
+
             await requestContext.SendEvent(eventType, parameters);
-            switch (scriptDestination)
+
+            switch (scriptingParams.ScriptDestination)
             {
                 case "ToEditor":
                     await requestContext.SendResult(new ScriptingResult { OperationId = operation.OperationId, Script = operation.ScriptText });

src/Microsoft.SqlTools.SqlCore/Scripting/Contracts/ScriptingCompleteParams.cs

@@ -34,5 +34,10 @@ public class ScriptingCompleteParams : ScriptingEventParams
         /// Get or sets a value to indicate the scripting operation successfully completed.
         /// </summary>
         public bool Success { get; set; }
+
+        /// <summary>
+        /// Gets or sets the script text when ReturnScriptAsEvent is enabled.
+        /// </summary>
+        public string Script { get; set; }
     }
 }

src/Microsoft.SqlTools.SqlCore/Scripting/Contracts/ScriptingParams.cs

@@ -77,5 +77,13 @@ public class ScriptingParams
         /// </summary>
         public ScriptingOperationType Operation { get; set; } = ScriptingOperationType.Create;
 
+        /// <summary>
+        /// Gets or sets whether to return the operation ID immediately and deliver the script via the complete event.
+        /// When true, the script request returns immediately with an operation ID,
+        /// and the script content is delivered later via the scriptComplete event.
+        /// When false (default), the request waits for completion and returns both operation ID and script together.
+        /// </summary>
+        public bool ReturnScriptAsynchronously { get; set; }
+
     }
 }