Fix GitHub only release condition (#4002)

* BUG 1972388: vsbuild task in YAML build pipeline hangs forever in ADO even though the task has already logged completion (#3979) * moved logic to drain queue in separate method "DrainQueues" * Implemented a call of method "DrainQueues" once step is completed * Simplified syntax of property 'JobServerQueue' * Fix condition for onlyGitHubRelease Co-authored-by: Sergey Koryshev <sergey.koryshev@akvelon.com>
microsoft · Oct 24, 2022 · 24dffd6 · 24dffd6
1 parent c27b8de
commit 24dffd6
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 20 deletions.
diff --git a/.vsts.release.yml b/.vsts.release.yml
@@ -124,7 +124,7 @@ extends:
               Write-Host "Force Refresh Azure CDN Cache"
               Publish-AzureRmCdnEndpointContent -EndpointName vstsagentpackage -ProfileName vstsagentpackage -ResourceGroupName vstsagentpackage -LoadContent $uploadFiles
             displayName: Upload to Azure Blob
-            condition: not(parameters.onlyGitHubRelease)
+            condition: eq('${{ parameters.onlyGitHubRelease }}', 'false')
 
           # Download all agent hashes created in previous phases
           - task: DownloadBuildArtifacts@0
@@ -178,7 +178,7 @@ extends:
             displayName: Create agent release on Github
 
       - stage: CreatePRs
-        condition: not(parameters.onlyGitHubRelease)
+        condition: eq('${{ parameters.onlyGitHubRelease }}', 'false')
         jobs:
         ################################################################################
         - job: create_ado_prs

diff --git a/src/Agent.Worker/StepsRunner.cs b/src/Agent.Worker/StepsRunner.cs
@@ -10,6 +10,7 @@
 using System.Threading.Tasks;
 using Microsoft.TeamFoundation.DistributedTask.Expressions;
 using Pipelines = Microsoft.TeamFoundation.DistributedTask.Pipelines;
+using Microsoft.VisualStudio.Services.CircuitBreaker;
 
 namespace Microsoft.VisualStudio.Services.Agent.Worker
 {
@@ -33,6 +34,10 @@ public interface IStepsRunner : IAgentService
 
     public sealed class StepsRunner : AgentService, IStepsRunner
     {
+        private IJobServerQueue _jobServerQueue;
+
+        private IJobServerQueue JobServerQueue => _jobServerQueue ??= HostContext.GetService<IJobServerQueue>();
+
         // StepsRunner should never throw exception to caller
         public async Task RunAsync(IExecutionContext jobContext, IList<IStep> steps)
         {
@@ -303,6 +308,17 @@ private async Task RunStepAsync(IStep step, CancellationToken jobCancellationTok
             // Complete the step context.
             step.ExecutionContext.Section(StringUtil.Loc("StepFinishing", step.DisplayName));
             step.ExecutionContext.Complete();
+
+            try
+            {
+                // We need to drain the queues after a task just in case if
+                // there are a lot of items since it can cause some UI hangs.
+                await JobServerQueue.DrainQueues();
+            } catch (Exception ex)
+            {
+                Trace.Error($"Error has occurred while draining queues, it can cause some UI glitches but it doesn't affect a pipeline execution itself: {ex}");
+                step.ExecutionContext.Error(ex);
+            }
         }
 
         private async Task SwitchToUtf8Codepage(IStep step)

diff --git a/src/Microsoft.VisualStudio.Services.Agent/JobServerQueue.cs b/src/Microsoft.VisualStudio.Services.Agent/JobServerQueue.cs
@@ -20,6 +20,7 @@ public interface IJobServerQueue : IAgentService, IThrottlingReporter
     {
         event EventHandler<ThrottlingEventArgs> JobServerQueueThrottling;
         Task ShutdownAsync();
+        Task DrainQueues();
         void Start(Pipelines.AgentJobRequestMessage jobRequest);
         void QueueWebConsoleLine(Guid stepRecordId, string line, long lineNumber);
         void QueueFileUpload(Guid timelineId, Guid timelineRecordId, string type, string name, string path, bool deleteSource);
@@ -91,6 +92,28 @@ public override void Initialize(IHostContext hostContext)
             _jobServer = hostContext.GetService<IJobServer>();
         }
 
+        public async Task DrainQueues()
+        {
+            // Drain the queue
+            // ProcessWebConsoleLinesQueueAsync() will never throw exception, live console update is always best effort.
+            Trace.Verbose("Draining web console line queue.");
+            await ProcessWebConsoleLinesQueueAsync(runOnce: true);
+            Trace.Info("Web console line queue drained.");
+
+            // ProcessFilesUploadQueueAsync() will never throw exception, log file upload is always best effort.
+            Trace.Verbose("Draining file upload queue.");
+            await ProcessFilesUploadQueueAsync(runOnce: true);
+            Trace.Info("File upload queue drained.");
+
+            // ProcessTimelinesUpdateQueueAsync() will throw exception during shutdown
+            // if there is any timeline records that failed to update contains output variabls.
+            Trace.Verbose("Draining timeline update queue.");
+            await ProcessTimelinesUpdateQueueAsync(runOnce: true);
+            Trace.Info("Timeline update queue drained.");
+
+            Trace.Info("All queues are drained.");
+        }
+
         public void Start(Pipelines.AgentJobRequestMessage jobRequest)
         {
             Trace.Entering();
@@ -169,24 +192,7 @@ public async Task ShutdownAsync()
             _queueInProcess = false;
             Trace.Info("All queue process task stopped.");
 
-            // Drain the queue
-            // ProcessWebConsoleLinesQueueAsync() will never throw exception, live console update is always best effort.
-            Trace.Verbose("Draining web console line queue.");
-            await ProcessWebConsoleLinesQueueAsync(runOnce: true);
-            Trace.Info("Web console line queue drained.");
-
-            // ProcessFilesUploadQueueAsync() will never throw exception, log file upload is always best effort.
-            Trace.Verbose("Draining file upload queue.");
-            await ProcessFilesUploadQueueAsync(runOnce: true);
-            Trace.Info("File upload queue drained.");
-
-            // ProcessTimelinesUpdateQueueAsync() will throw exception during shutdown
-            // if there is any timeline records that failed to update contains output variabls.
-            Trace.Verbose("Draining timeline update queue.");
-            await ProcessTimelinesUpdateQueueAsync(runOnce: true);
-            Trace.Info("Timeline update queue drained.");
-
-            Trace.Info("All queue process tasks have been stopped, and all queues are drained.");
+            await DrainQueues();
         }
 
         public void QueueWebConsoleLine(Guid stepRecordId, string line, long lineNumber)