Create proxy update

* Refactor and add job log upload support

* Rename method to be consistent

.github/workflows/codeql.yml

@@ -27,7 +27,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       # Override language selection by uncommenting this and choosing your languages
       # with:
       #   languages: go, javascript, csharp, python, cpp, java
@@ -38,4 +38,4 @@ jobs:
       working-directory: src
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/lint.yml

@@ -18,7 +18,6 @@ jobs:
         uses: github/super-linter@v4
         env:
           DEFAULT_BRANCH: ${{ github.base_ref }}
-          DISABLE_ERRORS: true
           EDITORCONFIG_FILE_NAME: .editorconfig
           LINTER_RULES_PATH: /src/
           VALIDATE_ALL_CODEBASE: false

docs/adrs/0000-proxy-update.md

@@ -0,0 +1,38 @@
+# ADR 000: Update Proxy Behavior of Self-Hosted Runners
+
+**Date**: 2023-02-21
+
+**Status**: Pending
+
+## Context
+
+Today, the different user-accessible building blocks of GitHub Actions implement proxy behaviour with significant functional differences.
+Users could realistically run all of the below examples and they would reasonably expect that their proxy settings will have the same networking effects across all of them.
+
+A user running `actions/actions-runner-controller`, which starts instances of `actions/runner`, that the runs node.js actions made with `actions/toolkit`
+- ARC and its controller and listener pods in k8s will follow `golang` defaults for proxy behaviour
+- The `runner` overrides the default proxy behaviour of C# and implements it [explicitly](https://github.com/actions/runner/blob/main/src/Runner.Sdk/RunnerWebProxy.cs), however currently differently from `toolkit`
+- `toolkit` overrides the default proxy behaviour of node.js and implements it [explicitly](https://github.com/actions/toolkit/blob/main/packages/http-client/src/proxy.ts), however currently differently from `runner`
+
+
+## Example 1 - ARC
+
+A user wants to create a scaleset in ARC. They give following settings when creating an ARC Scale Set:
+- `https_proxy=https://someproxy.company.com`
+- `no_proxy=8.8.8.8,192.168.1.1/32`
+The ENV variables are propagated through all actors, but:
+
+- *ARC operators and listener pods* will: follow the proxy but bypass it for `8.8.8.8` and the CIDR block `192.168.1.1/32`
+- *The runner* will: use a proxy and ignore these `no_proxy` settings (no IP support in `runner` for `no_proxy`)
+- *A node.js GitHub Action in a job executed by the runner* will: bypass `8.8.8.8` but use proxy for the CIDR block `192.168.1.1/32`
+
+## Example 2 - Self-Hosted runner
+
+Given the following settings when creating an ARC Scale Set:
+- `https_proxy=someproxy.company.com`
+
+- *The runner* will: silently ignore `https_proxy` value because it doesn't have a protocol (missing `https://`)
+- *A node.js GitHub Action in a job executed by the runner* will: throw an exception because proxy could not be parsed (missing `https://`)
+
+## Decisions
+## Consequences

docs/contribute.md

@@ -158,3 +158,11 @@ cat (Runner/Worker)_TIMESTAMP.log # view your log file
 
 We use the .NET Foundation and CoreCLR style guidelines [located here](
 https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md)
+
+### Format C# Code
+
+To format both staged and unstaged .cs files
+```
+cd ./src
+./dev.(cmd|sh) format
+```

releaseVersion

@@ -1 +1 @@
-2.302.1
+<Update to ./src/runnerversion when creating release>

src/Runner.Common/JobServer.cs

@@ -30,7 +30,9 @@ namespace GitHub.Runner.Common
         Task<TaskLog> AppendLogContentAsync(Guid scopeIdentifier, string hubName, Guid planId, int logId, Stream uploadStream, CancellationToken cancellationToken);
         Task AppendTimelineRecordFeedAsync(Guid scopeIdentifier, string hubName, Guid planId, Guid timelineId, Guid timelineRecordId, Guid stepId, IList<string> lines, long? startLine, CancellationToken cancellationToken);
         Task<TaskAttachment> CreateAttachmentAsync(Guid scopeIdentifier, string hubName, Guid planId, Guid timelineId, Guid timelineRecordId, String type, String name, Stream uploadStream, CancellationToken cancellationToken);
-        Task CreateStepSymmaryAsync(string planId, string jobId, string stepId, string file, CancellationToken cancellationToken);
+        Task CreateStepSummaryAsync(string planId, string jobId, Guid stepId, string file, CancellationToken cancellationToken);
+        Task CreateResultsStepLogAsync(string planId, string jobId, Guid stepId, string file, bool finalize, bool firstBlock, long lineCount, CancellationToken cancellationToken);
+        Task CreateResultsJobLogAsync(string planId, string jobId, string file, bool finalize, bool firstBlock, long lineCount, CancellationToken cancellationToken);
         Task<TaskLog> CreateLogAsync(Guid scopeIdentifier, string hubName, Guid planId, TaskLog log, CancellationToken cancellationToken);
         Task<Timeline> CreateTimelineAsync(Guid scopeIdentifier, string hubName, Guid planId, Guid timelineId, CancellationToken cancellationToken);
         Task<List<TimelineRecord>> UpdateTimelineRecordsAsync(Guid scopeIdentifier, string hubName, Guid planId, Guid timelineId, IEnumerable<TimelineRecord> records, CancellationToken cancellationToken);
@@ -316,7 +318,7 @@ namespace GitHub.Runner.Common
             return _taskClient.CreateAttachmentAsync(scopeIdentifier, hubName, planId, timelineId, timelineRecordId, type, name, uploadStream, cancellationToken: cancellationToken);
         }
 
-        public Task CreateStepSymmaryAsync(string planId, string jobId, string stepId, string file, CancellationToken cancellationToken)
+        public Task CreateStepSummaryAsync(string planId, string jobId, Guid stepId, string file, CancellationToken cancellationToken)
         {
             if (_resultsClient != null)
             {
@@ -325,6 +327,23 @@ namespace GitHub.Runner.Common
             throw new InvalidOperationException("Results client is not initialized.");
         }
 
+        public Task CreateResultsStepLogAsync(string planId, string jobId, Guid stepId, string file, bool finalize, bool firstBlock, long lineCount, CancellationToken cancellationToken)
+        {
+            if (_resultsClient != null)
+            {
+                return _resultsClient.UploadResultsStepLogAsync(planId, jobId, stepId, file, finalize, firstBlock, lineCount, cancellationToken: cancellationToken);
+            }
+            throw new InvalidOperationException("Results client is not initialized.");
+        }
+
+        public Task CreateResultsJobLogAsync(string planId, string jobId, string file, bool finalize, bool firstBlock, long lineCount, CancellationToken cancellationToken)
+        {
+            if (_resultsClient != null)
+            {
+                return _resultsClient.UploadResultsJobLogAsync(planId, jobId, file, finalize, firstBlock, lineCount, cancellationToken: cancellationToken);
+            }
+            throw new InvalidOperationException("Results client is not initialized.");
+        }
 
         public Task<TaskLog> CreateLogAsync(Guid scopeIdentifier, string hubName, Guid planId, TaskLog log, CancellationToken cancellationToken)
         {

src/Runner.Common/JobServerQueue.cs

@@ -20,7 +20,7 @@ namespace GitHub.Runner.Common
         void Start(Pipelines.AgentJobRequestMessage jobRequest);
         void QueueWebConsoleLine(Guid stepRecordId, string line, long? lineNumber = null);
         void QueueFileUpload(Guid timelineId, Guid timelineRecordId, string type, string name, string path, bool deleteSource);
-        void QueueSummaryUpload(Guid stepRecordId, string name, string path, bool deleteSource);
+        void QueueResultsUpload(Guid timelineRecordId, string name, string path, string type, bool deleteSource, bool finalize, bool firstBlock, long totalLines);
         void QueueTimelineRecordUpdate(Guid timelineId, TimelineRecord timelineRecord);
     }
 
@@ -31,7 +31,7 @@ namespace GitHub.Runner.Common
         private static readonly TimeSpan _delayForWebConsoleLineDequeue = TimeSpan.FromMilliseconds(500);
         private static readonly TimeSpan _delayForTimelineUpdateDequeue = TimeSpan.FromMilliseconds(500);
         private static readonly TimeSpan _delayForFileUploadDequeue = TimeSpan.FromMilliseconds(1000);
-        private static readonly TimeSpan _delayForSummaryUploadDequeue = TimeSpan.FromMilliseconds(1000);
+        private static readonly TimeSpan _delayForResultsUploadDequeue = TimeSpan.FromMilliseconds(1000);
 
         // Job message information
         private Guid _scopeIdentifier;
@@ -46,7 +46,7 @@ namespace GitHub.Runner.Common
         // queue for file upload (log file or attachment)
         private readonly ConcurrentQueue<UploadFileInfo> _fileUploadQueue = new();
 
-        private readonly ConcurrentQueue<SummaryUploadFileInfo> _summaryFileUploadQueue = new();
+        private readonly ConcurrentQueue<ResultsUploadFileInfo> _resultsFileUploadQueue = new();
 
         // queue for timeline or timeline record update (one queue per timeline)
         private readonly ConcurrentDictionary<Guid, ConcurrentQueue<TimelineRecord>> _timelineUpdateQueue = new();
@@ -60,7 +60,7 @@ namespace GitHub.Runner.Common
         // Task for each queue's dequeue process
         private Task _webConsoleLineDequeueTask;
         private Task _fileUploadDequeueTask;
-        private Task _summaryUploadDequeueTask;
+        private Task _resultsUploadDequeueTask;
         private Task _timelineUpdateDequeueTask;
 
         // common
@@ -84,6 +84,9 @@ namespace GitHub.Runner.Common
         private bool _webConsoleLineAggressiveDequeue = true;
         private bool _firstConsoleOutputs = true;
 
+        private bool _resultsClientInitiated = false;
+        private delegate Task ResultsFileUploadHandler(ResultsUploadFileInfo file);
+
         public override void Initialize(IHostContext hostContext)
         {
             base.Initialize(hostContext);
@@ -109,9 +112,9 @@ namespace GitHub.Runner.Common
             {
                 Trace.Info("Initializing results client");
                 _jobServer.InitializeResultsClient(new Uri(resultsReceiverEndpoint), accessToken);
+                _resultsClientInitiated = true;
             }
 
-
             if (_queueInProcess)
             {
                 Trace.Info("No-opt, all queue process tasks are running.");
@@ -140,12 +143,12 @@ namespace GitHub.Runner.Common
             _fileUploadDequeueTask = ProcessFilesUploadQueueAsync();
 
             Trace.Info("Start results file upload queue.");
-            _summaryUploadDequeueTask = ProcessSummaryUploadQueueAsync();
+            _resultsUploadDequeueTask = ProcessResultsUploadQueueAsync();
 
             Trace.Info("Start process timeline update queue.");
             _timelineUpdateDequeueTask = ProcessTimelinesUpdateQueueAsync();
 
-            _allDequeueTasks = new Task[] { _webConsoleLineDequeueTask, _fileUploadDequeueTask, _timelineUpdateDequeueTask, _summaryUploadDequeueTask };
+            _allDequeueTasks = new Task[] { _webConsoleLineDequeueTask, _fileUploadDequeueTask, _timelineUpdateDequeueTask, _resultsUploadDequeueTask };
             _queueInProcess = true;
         }
 
@@ -176,9 +179,9 @@ namespace GitHub.Runner.Common
             await ProcessFilesUploadQueueAsync(runOnce: true);
             Trace.Info("File upload queue drained.");
 
-            Trace.Verbose("Draining results summary upload queue.");
-            await ProcessSummaryUploadQueueAsync(runOnce: true);
-            Trace.Info("Results summary upload queue drained.");
+            Trace.Verbose("Draining results upload queue.");
+            await ProcessResultsUploadQueueAsync(runOnce: true);
+            Trace.Info("Results upload queue drained.");
 
             // ProcessTimelinesUpdateQueueAsync() will throw exception during shutdown
             // if there is any timeline records that failed to update contains output variabls.
@@ -230,21 +233,43 @@ namespace GitHub.Runner.Common
             _fileUploadQueue.Enqueue(newFile);
         }
 
-        public void QueueSummaryUpload(Guid stepRecordId, string name, string path, bool deleteSource)
+        public void QueueResultsUpload(Guid timelineRecordId, string name, string path, string type, bool deleteSource, bool finalize, bool firstBlock, long totalLines)
         {
+            if (!_resultsClientInitiated)
+            {
+                Trace.Verbose("Skipping results upload");
+                try
+                {
+                    if (deleteSource)
+                    {
+                        File.Delete(path);
+                    }
+                }
+                catch (Exception ex)
+                {
+                    Trace.Info("Catch exception during delete skipped results upload file.");
+                    Trace.Error(ex);
+                }
+                return;
+            }
+
             // all parameter not null, file path exist.
-            var newFile = new SummaryUploadFileInfo()
+            var newFile = new ResultsUploadFileInfo()
             {
                 Name = name,
                 Path = path,
+                Type = type,
                 PlanId = _planId.ToString(),
                 JobId = _jobTimelineRecordId.ToString(),
-                StepId = stepRecordId.ToString(),
-                DeleteSource = deleteSource
+                RecordId = timelineRecordId,
+                DeleteSource = deleteSource,
+                Finalize = finalize,
+                FirstBlock = firstBlock,
+                TotalLines = totalLines,
             };
 
-            Trace.Verbose("Enqueue results file upload queue: file '{0}' attach to job {1} step {2}", newFile.Path, _jobTimelineRecordId, stepRecordId);
-            _summaryFileUploadQueue.Enqueue(newFile);
+            Trace.Verbose("Enqueue results file upload queue: file '{0}' attach to job {1} step {2}", newFile.Path, _jobTimelineRecordId, timelineRecordId);
+            _resultsFileUploadQueue.Enqueue(newFile);
         }
 
         public void QueueTimelineRecordUpdate(Guid timelineId, TimelineRecord timelineRecord)
@@ -437,18 +462,18 @@ namespace GitHub.Runner.Common
             }
         }
 
-        private async Task ProcessSummaryUploadQueueAsync(bool runOnce = false)
+        private async Task ProcessResultsUploadQueueAsync(bool runOnce = false)
         {
             Trace.Info("Starting results-based upload queue...");
 
             while (!_jobCompletionSource.Task.IsCompleted || runOnce)
             {
-                List<SummaryUploadFileInfo> filesToUpload = new();
-                SummaryUploadFileInfo dequeueFile;
-                while (_summaryFileUploadQueue.TryDequeue(out dequeueFile))
+                List<ResultsUploadFileInfo> filesToUpload = new();
+                ResultsUploadFileInfo dequeueFile;
+                while (_resultsFileUploadQueue.TryDequeue(out dequeueFile))
                 {
                     filesToUpload.Add(dequeueFile);
-                    // process at most 10 file upload.
+                    // process at most 10 file uploads.
                     if (!runOnce && filesToUpload.Count > 10)
                     {
                         break;
@@ -459,7 +484,7 @@ namespace GitHub.Runner.Common
                 {
                     if (runOnce)
                     {
-                        Trace.Info($"Uploading {filesToUpload.Count} summary files in one shot through results service.");
+                        Trace.Info($"Uploading {filesToUpload.Count} file(s) in one shot through results service.");
                     }
 
                     int errorCount = 0;
@@ -467,11 +492,27 @@ namespace GitHub.Runner.Common
                     {
                         try
                         {
-                            await UploadSummaryFile(file);
+                            if (String.Equals(file.Type, ChecksAttachmentType.StepSummary, StringComparison.OrdinalIgnoreCase))
+                            {
+                                await UploadSummaryFile(file);
+                            }
+                            else if (String.Equals(file.Type, CoreAttachmentType.ResultsLog, StringComparison.OrdinalIgnoreCase))
+                            {
+                                if (file.RecordId != _jobTimelineRecordId)
+                                {
+                                    Trace.Info($"Got a step log file to send to results service.");
+                                    await UploadResultsStepLogFile(file);
+                                }
+                                else if (file.RecordId == _jobTimelineRecordId)
+                                {
+                                    Trace.Info($"Got a job log file to send to results service.");
+                                    await UploadResultsJobLogFile(file);
+                                }
+                            }
                         }
                         catch (Exception ex)
                         {
-                            var issue = new Issue() { Type = IssueType.Warning, Message = $"Caught exception during summary file upload to results. {ex.Message}" };
+                            var issue = new Issue() { Type = IssueType.Warning, Message = $"Caught exception during file upload to results. {ex.Message}" };
                             issue.Data[Constants.Runner.InternalTelemetryIssueDataKey] = Constants.Runner.ResultsUploadFailure;
 
                             var telemetryRecord = new TimelineRecord()
@@ -481,16 +522,13 @@ namespace GitHub.Runner.Common
                             telemetryRecord.Issues.Add(issue);
                             QueueTimelineRecordUpdate(_jobTimelineId, telemetryRecord);
 
-                            Trace.Info("Catch exception during summary file upload to results, keep going since the process is best effort.");
+                            Trace.Info("Catch exception during file upload to results, keep going since the process is best effort.");
                             Trace.Error(ex);
-                        }
-                        finally
-                        {
                             errorCount++;
                         }
                     }
 
-                    Trace.Info("Tried to upload {0} summary files to results, success rate: {1}/{0}.", filesToUpload.Count, filesToUpload.Count - errorCount);
+                    Trace.Info("Tried to upload {0} file(s) to results, success rate: {1}/{0}.", filesToUpload.Count, filesToUpload.Count - errorCount);
                 }
 
                 if (runOnce)
@@ -499,7 +537,7 @@ namespace GitHub.Runner.Common
                 }
                 else
                 {
-                    await Task.Delay(_delayForSummaryUploadDequeue);
+                    await Task.Delay(_delayForResultsUploadDequeue);
                 }
             }
         }
@@ -776,16 +814,45 @@ namespace GitHub.Runner.Common
             }
         }
 
-        private async Task UploadSummaryFile(SummaryUploadFileInfo file)
+        private async Task UploadSummaryFile(ResultsUploadFileInfo file)
+        {
+            Trace.Info($"Starting to upload summary file to results service {file.Name}, {file.Path}");
+            ResultsFileUploadHandler summaryHandler = async (file) =>
+            {
+                await _jobServer.CreateStepSummaryAsync(file.PlanId, file.JobId, file.RecordId, file.Path, CancellationToken.None);
+            };
+
+            await UploadResultsFile(file, summaryHandler);
+        }
+
+        private async Task UploadResultsStepLogFile(ResultsUploadFileInfo file)
+        {
+            Trace.Info($"Starting upload of step log file to results service {file.Name}, {file.Path}");
+            ResultsFileUploadHandler stepLogHandler = async (file) =>
+            {
+                await _jobServer.CreateResultsStepLogAsync(file.PlanId, file.JobId, file.RecordId, file.Path, file.Finalize, file.FirstBlock, file.TotalLines, CancellationToken.None);
+            };
+
+            await UploadResultsFile(file, stepLogHandler);
+        }
+
+        private async Task UploadResultsJobLogFile(ResultsUploadFileInfo file)
+        {
+            Trace.Info($"Starting upload of job log file to results service {file.Name}, {file.Path}");
+            ResultsFileUploadHandler jobLogHandler = async (file) =>
+            {
+                await _jobServer.CreateResultsJobLogAsync(file.PlanId, file.JobId, file.Path, file.Finalize, file.FirstBlock, file.TotalLines, CancellationToken.None);
+            };
+
+            await UploadResultsFile(file, jobLogHandler);
+        }
+
+        private async Task UploadResultsFile(ResultsUploadFileInfo file, ResultsFileUploadHandler uploadHandler)
         {
             bool uploadSucceed = false;
             try
             {
-                // Upload the step summary
-                Trace.Info($"Starting to upload summary file to results service {file.Name}, {file.Path}");
-                var cancellationTokenSource = new CancellationTokenSource();
-                await _jobServer.CreateStepSymmaryAsync(file.PlanId, file.JobId, file.StepId, file.Path, cancellationTokenSource.Token);
-
+                await uploadHandler(file);
                 uploadSucceed = true;
             }
             finally
@@ -798,7 +865,7 @@ namespace GitHub.Runner.Common
                     }
                     catch (Exception ex)
                     {
-                        Trace.Info("Catch exception during delete success results uploaded summary file.");
+                        Trace.Info("Exception encountered during deletion of a temporary file that was already successfully uploaded to results.");
                         Trace.Error(ex);
                     }
                 }
@@ -822,14 +889,18 @@ namespace GitHub.Runner.Common
         public bool DeleteSource { get; set; }
     }
 
-    internal class SummaryUploadFileInfo
+    internal class ResultsUploadFileInfo
     {
         public string Name { get; set; }
+        public string Type { get; set; }
         public string Path { get; set; }
         public string PlanId { get; set; }
         public string JobId { get; set; }
-        public string StepId { get; set; }
+        public Guid RecordId { get; set; }
         public bool DeleteSource { get; set; }
+        public bool Finalize { get; set; }
+        public bool FirstBlock { get; set; }
+        public long TotalLines { get; set; }
     }
 
 

src/Runner.Common/Logging.cs

@@ -21,6 +21,12 @@ namespace GitHub.Runner.Common
         // 8 MB
         public const int PageSize = 8 * 1024 * 1024;
 
+        // For Results
+        public static string BlocksFolder = "blocks";
+
+        // 2 MB
+        public const int BlockSize = 2 * 1024 * 1024;
+
         private Guid _timelineId;
         private Guid _timelineRecordId;
         private FileStream _pageData;
@@ -32,6 +38,13 @@ namespace GitHub.Runner.Common
         private string _pagesFolder;
         private IJobServerQueue _jobServerQueue;
 
+        private string _resultsDataFileName;
+        private FileStream _resultsBlockData;
+        private StreamWriter _resultsBlockWriter;
+        private string _resultsBlockFolder;
+        private int _blockByteCount;
+        private int _blockCount;
+
         public long TotalLines => _totalLines;
 
         public override void Initialize(IHostContext hostContext)
@@ -39,8 +52,10 @@ namespace GitHub.Runner.Common
             base.Initialize(hostContext);
             _totalLines = 0;
             _pagesFolder = Path.Combine(hostContext.GetDirectory(WellKnownDirectory.Diag), PagingFolder);
-            _jobServerQueue = HostContext.GetService<IJobServerQueue>();
             Directory.CreateDirectory(_pagesFolder);
+            _resultsBlockFolder = Path.Combine(hostContext.GetDirectory(WellKnownDirectory.Diag), BlocksFolder);
+            Directory.CreateDirectory(_resultsBlockFolder);
+            _jobServerQueue = HostContext.GetService<IJobServerQueue>();
         }
 
         public void Setup(Guid timelineId, Guid timelineRecordId)
@@ -60,11 +75,17 @@ namespace GitHub.Runner.Common
             // lazy creation on write
             if (_pageWriter == null)
             {
-                Create();
+                NewPage();
+            }
+
+            if (_resultsBlockWriter == null)
+            {
+                NewBlock();
             }
 
             string line = $"{DateTime.UtcNow.ToString("O")} {message}";
             _pageWriter.WriteLine(line);
+            _resultsBlockWriter.WriteLine(line);
 
             _totalLines++;
             if (line.IndexOf('\n') != -1)
@@ -78,21 +99,25 @@ namespace GitHub.Runner.Common
                 }
             }
 
-            _byteCount += System.Text.Encoding.UTF8.GetByteCount(line);
+            var bytes = System.Text.Encoding.UTF8.GetByteCount(line);
+            _byteCount += bytes;
+            _blockByteCount += bytes;
             if (_byteCount >= PageSize)
             {
                 NewPage();
             }
+
+            if (_blockByteCount >= BlockSize)
+            {
+                NewBlock();
+            }
+
         }
 
         public void End()
         {
             EndPage();
-        }
-
-        private void Create()
-        {
-            NewPage();
+            EndBlock(true);
         }
 
         private void NewPage()
@@ -117,5 +142,27 @@ namespace GitHub.Runner.Common
                 _jobServerQueue.QueueFileUpload(_timelineId, _timelineRecordId, "DistributedTask.Core.Log", "CustomToolLog", _dataFileName, true);
             }
         }
+
+        private void NewBlock()
+        {
+            EndBlock(false);
+            _blockByteCount = 0;
+            _resultsDataFileName = Path.Combine(_resultsBlockFolder, $"{_timelineId}_{_timelineRecordId}.{++_blockCount}");
+            _resultsBlockData = new FileStream(_resultsDataFileName, FileMode.CreateNew, FileAccess.ReadWrite, FileShare.ReadWrite);
+            _resultsBlockWriter = new StreamWriter(_resultsBlockData, System.Text.Encoding.UTF8);
+        }
+
+        private void EndBlock(bool finalize)
+        {
+            if (_resultsBlockWriter != null)
+            {
+                _resultsBlockWriter.Flush();
+                _resultsBlockData.Flush();
+                _resultsBlockWriter.Dispose();
+                _resultsBlockWriter = null;
+                _resultsBlockData = null;
+                _jobServerQueue.QueueResultsUpload(_timelineRecordId, "ResultsLog", _resultsDataFileName, "Results.Core.Log", deleteSource: true, finalize, firstBlock: _resultsDataFileName.EndsWith(".1"), totalLines: _totalLines);
+            }
+        }
     }
 }

src/Runner.Worker/ExecutionContext.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Globalization;
 using System.IO;
@@ -81,7 +81,7 @@ namespace GitHub.Runner.Worker
         // logging
         long Write(string tag, string message);
         void QueueAttachFile(string type, string name, string filePath);
-        void QueueSummaryFile(string name, string filePath,  Guid stepRecordId);
+        void QueueSummaryFile(string name, string filePath, Guid stepRecordId);
 
         // timeline record update methods
         void Start(string currentOperation = null);
@@ -871,8 +871,7 @@ namespace GitHub.Runner.Worker
             {
                 throw new FileNotFoundException($"Can't upload (name:{name}) file: {filePath}. File does not exist.");
             }
-
-            _jobServerQueue.QueueSummaryUpload(stepRecordId, name, filePath, deleteSource: false);
+            _jobServerQueue.QueueResultsUpload(stepRecordId, name, filePath, ChecksAttachmentType.StepSummary, deleteSource: false, finalize: true, firstBlock: true, totalLines: 0);
         }
 
         // Add OnMatcherChanged

src/Sdk/DTPipelines/Pipelines/ObjectTemplating/PipelineTemplateEvaluator.cs

@@ -455,7 +455,6 @@ namespace GitHub.DistributedTask.Pipelines.ObjectTemplating
         private readonly String[] s_expressionValueNames = new[]
         {
             PipelineTemplateConstants.GitHub,
-            PipelineTemplateConstants.Needs,
             PipelineTemplateConstants.Strategy,
             PipelineTemplateConstants.Matrix,
             PipelineTemplateConstants.Needs,

src/Sdk/DTWebApi/WebApi/TaskAttachment.cs

@@ -1,4 +1,4 @@
-using GitHub.Services.Common;
+using GitHub.Services.Common;
 using GitHub.Services.WebApi;
 using System;
 using System.Runtime.Serialization;
@@ -100,6 +100,7 @@ namespace GitHub.DistributedTask.WebApi
         public static readonly String Summary = "DistributedTask.Core.Summary";
         public static readonly String FileAttachment = "DistributedTask.Core.FileAttachment";
         public static readonly String DiagnosticLog = "DistributedTask.Core.DiagnosticLog";
+        public static readonly String ResultsLog = "Results.Core.Log";
     }
 
     [GenerateAllConstants]

src/Sdk/WebApi/WebApi/Contracts.cs

@@ -46,7 +46,81 @@ namespace GitHub.Services.Results.Contracts
 
     [DataContract]
     [JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
-    public class CreateStepSummaryMetadataResponse
+    public class GetSignedJobLogsURLRequest
+    {
+        [DataMember]
+        public string WorkflowJobRunBackendId;
+        [DataMember]
+        public string WorkflowRunBackendId;
+    }
+
+    [DataContract]
+    [JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
+    public class GetSignedJobLogsURLResponse
+    {
+        [DataMember]
+        public string LogsUrl;
+        [DataMember]
+        public string BlobStorageType;
+    }
+
+    [DataContract]
+    [JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
+    public class GetSignedStepLogsURLRequest
+    {
+        [DataMember]
+        public string WorkflowJobRunBackendId;
+        [DataMember]
+        public string WorkflowRunBackendId;
+        [DataMember]
+        public string StepBackendId;
+    }
+
+    [DataContract]
+    [JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
+    public class GetSignedStepLogsURLResponse
+    {
+        [DataMember]
+        public string LogsUrl;
+        [DataMember]
+        public string BlobStorageType;
+        [DataMember]
+        public long SoftSizeLimit;
+    }
+
+    [DataContract]
+    [JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
+    public class JobLogsMetadataCreate
+    {
+        [DataMember]
+        public string WorkflowRunBackendId;
+        [DataMember]
+        public string WorkflowJobRunBackendId;
+        [DataMember]
+        public string UploadedAt;
+        [DataMember]
+        public long LineCount;
+    }
+
+    [DataContract]
+    [JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
+    public class StepLogsMetadataCreate
+    {
+        [DataMember]
+        public string WorkflowRunBackendId;
+        [DataMember]
+        public string WorkflowJobRunBackendId;
+        [DataMember]
+        public string StepBackendId;
+        [DataMember]
+        public string UploadedAt;
+        [DataMember]
+        public long LineCount;
+    }
+
+    [DataContract]
+    [JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
+    public class CreateMetadataResponse
     {
         [DataMember]
         public bool Ok;

src/Sdk/WebApi/WebApi/ResultsHttpClient.cs

@@ -24,68 +24,138 @@ namespace GitHub.Services.Results.Client
             m_formatter = new JsonMediaTypeFormatter();
         }
 
-        public async Task<GetSignedStepSummaryURLResponse> GetStepSummaryUploadUrlAsync(string planId, string jobId, string stepId, CancellationToken cancellationToken)
+        // Get Sas URL calls
+        private async Task<T> GetResultsSignedURLResponse<R, T>(Uri uri, CancellationToken cancellationToken, R request)
         {
-            var request = new GetSignedStepSummaryURLRequest()
-            {
-                WorkflowJobRunBackendId= jobId,
-                WorkflowRunBackendId= planId,
-                StepBackendId= stepId
-            };
-
-            var stepSummaryUploadRequest = new Uri(m_resultsServiceUrl, "twirp/results.services.receiver.Receiver/GetStepSummarySignedBlobURL");
-
-            using (HttpRequestMessage requestMessage = new HttpRequestMessage(HttpMethod.Post, stepSummaryUploadRequest))
+            using (HttpRequestMessage requestMessage = new HttpRequestMessage(HttpMethod.Post, uri))
             {
                 requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", m_token);
                 requestMessage.Headers.Accept.Add(MediaTypeWithQualityHeaderValue.Parse("application/json"));
 
-                using (HttpContent content = new ObjectContent<GetSignedStepSummaryURLRequest>(request, m_formatter))
+                using (HttpContent content = new ObjectContent<R>(request, m_formatter))
                 {
                     requestMessage.Content = content;
                     using (var response = await SendAsync(requestMessage, HttpCompletionOption.ResponseContentRead, cancellationToken: cancellationToken))
                     {
-                        return await ReadJsonContentAsync<GetSignedStepSummaryURLResponse>(response, cancellationToken);
+                        return await ReadJsonContentAsync<T>(response, cancellationToken);
                     }
                 }
             }
         }
 
-        private async Task StepSummaryUploadCompleteAsync(string planId, string jobId, string stepId, long size, CancellationToken cancellationToken)
+        private async Task<GetSignedStepSummaryURLResponse> GetStepSummaryUploadUrlAsync(string planId, string jobId, Guid stepId, CancellationToken cancellationToken)
         {
-            var timestamp = DateTime.UtcNow.ToString("yyyy-MM-dd'T'HH:mm:ss.fffK");
-            var request = new StepSummaryMetadataCreate()
+            var request = new GetSignedStepSummaryURLRequest()
             {
-                WorkflowJobRunBackendId= jobId,
-                WorkflowRunBackendId= planId,
-                StepBackendId = stepId,
-                Size = size,
-                UploadedAt = timestamp
+                WorkflowJobRunBackendId = jobId,
+                WorkflowRunBackendId = planId,
+                StepBackendId = stepId.ToString()
             };
 
-            var stepSummaryUploadCompleteRequest = new Uri(m_resultsServiceUrl, "twirp/results.services.receiver.Receiver/CreateStepSummaryMetadata");
+            var getStepSummarySignedBlobURLEndpoint = new Uri(m_resultsServiceUrl, Constants.GetStepSummarySignedBlobURL);
 
-            using (HttpRequestMessage requestMessage = new HttpRequestMessage(HttpMethod.Post, stepSummaryUploadCompleteRequest))
+            return await GetResultsSignedURLResponse<GetSignedStepSummaryURLRequest, GetSignedStepSummaryURLResponse>(getStepSummarySignedBlobURLEndpoint, cancellationToken, request);
+        }
+
+        private async Task<GetSignedStepLogsURLResponse> GetStepLogUploadUrlAsync(string planId, string jobId, Guid stepId, CancellationToken cancellationToken)
+        {
+            var request = new GetSignedStepLogsURLRequest()
+            {
+                WorkflowJobRunBackendId = jobId,
+                WorkflowRunBackendId = planId,
+                StepBackendId = stepId.ToString(),
+            };
+
+            var getStepLogsSignedBlobURLEndpoint = new Uri(m_resultsServiceUrl, Constants.GetStepLogsSignedBlobURL);
+
+            return await GetResultsSignedURLResponse<GetSignedStepLogsURLRequest, GetSignedStepLogsURLResponse>(getStepLogsSignedBlobURLEndpoint, cancellationToken, request);
+        }
+
+        private async Task<GetSignedJobLogsURLResponse> GetJobLogUploadUrlAsync(string planId, string jobId, CancellationToken cancellationToken)
+        {
+            var request = new GetSignedJobLogsURLRequest()
+            {
+                WorkflowJobRunBackendId = jobId,
+                WorkflowRunBackendId = planId,
+            };
+
+            var getJobLogsSignedBlobURLEndpoint = new Uri(m_resultsServiceUrl, Constants.GetJobLogsSignedBlobURL);
+
+            return await GetResultsSignedURLResponse<GetSignedJobLogsURLRequest, GetSignedJobLogsURLResponse>(getJobLogsSignedBlobURLEndpoint, cancellationToken, request);
+        }
+
+        // Create metadata calls
+
+        private async Task CreateMetadata<R>(Uri uri, CancellationToken cancellationToken, R request, string timestamp)
+        {
+            using (HttpRequestMessage requestMessage = new HttpRequestMessage(HttpMethod.Post, uri))
             {
                 requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", m_token);
                 requestMessage.Headers.Accept.Add(MediaTypeWithQualityHeaderValue.Parse("application/json"));
 
-                using (HttpContent content = new ObjectContent<StepSummaryMetadataCreate>(request, m_formatter))
+                using (HttpContent content = new ObjectContent<R>(request, m_formatter))
                 {
                     requestMessage.Content = content;
                     using (var response = await SendAsync(requestMessage, HttpCompletionOption.ResponseContentRead, cancellationToken: cancellationToken))
                     {
-                        var jsonResponse = await ReadJsonContentAsync<CreateStepSummaryMetadataResponse>(response, cancellationToken);
+                        var jsonResponse = await ReadJsonContentAsync<CreateMetadataResponse>(response, cancellationToken);
                         if (!jsonResponse.Ok)
                         {
-                            throw new Exception($"Failed to mark step summary upload as complete, status code: {response.StatusCode}, ok: {jsonResponse.Ok}, size: {size}, timestamp: {timestamp}");
+                            throw new Exception($"Failed to mark {typeof(R).Name} upload as complete, status code: {response.StatusCode}, ok: {jsonResponse.Ok}, timestamp: {timestamp}");
                         }
                     }
                 }
             }
         }
 
-        private async Task<HttpResponseMessage> UploadFileAsync(string url, string blobStorageType, FileStream file, CancellationToken cancellationToken)
+        private async Task StepSummaryUploadCompleteAsync(string planId, string jobId, Guid stepId, long size, CancellationToken cancellationToken)
+        {
+            var timestamp = DateTime.UtcNow.ToString(Constants.TimestampFormat);
+            var request = new StepSummaryMetadataCreate()
+            {
+                WorkflowJobRunBackendId = jobId,
+                WorkflowRunBackendId = planId,
+                StepBackendId = stepId.ToString(),
+                Size = size,
+                UploadedAt = timestamp
+            };
+
+            var createStepSummaryMetadataEndpoint = new Uri(m_resultsServiceUrl, Constants.CreateStepSummaryMetadata);
+            await CreateMetadata<StepSummaryMetadataCreate>(createStepSummaryMetadataEndpoint, cancellationToken, request, timestamp);
+        }
+
+        private async Task StepLogUploadCompleteAsync(string planId, string jobId, Guid stepId, long lineCount, CancellationToken cancellationToken)
+        {
+            var timestamp = DateTime.UtcNow.ToString(Constants.TimestampFormat);
+            var request = new StepLogsMetadataCreate()
+            {
+                WorkflowJobRunBackendId = jobId,
+                WorkflowRunBackendId = planId,
+                StepBackendId = stepId.ToString(),
+                UploadedAt = timestamp,
+                LineCount = lineCount,
+            };
+
+            var createStepLogsMetadataEndpoint = new Uri(m_resultsServiceUrl, Constants.CreateStepLogsMetadata);
+            await CreateMetadata<StepLogsMetadataCreate>(createStepLogsMetadataEndpoint, cancellationToken, request, timestamp);
+        }
+
+        private async Task JobLogUploadCompleteAsync(string planId, string jobId, long lineCount, CancellationToken cancellationToken)
+        {
+            var timestamp = DateTime.UtcNow.ToString(Constants.TimestampFormat);
+            var request = new JobLogsMetadataCreate()
+            {
+                WorkflowJobRunBackendId = jobId,
+                WorkflowRunBackendId = planId,
+                UploadedAt = timestamp,
+                LineCount = lineCount,
+            };
+
+            var createJobLogsMetadataEndpoint = new Uri(m_resultsServiceUrl, Constants.CreateJobLogsMetadata);
+            await CreateMetadata<JobLogsMetadataCreate>(createJobLogsMetadataEndpoint, cancellationToken, request, timestamp);
+        }
+
+        private async Task<HttpResponseMessage> UploadBlockFileAsync(string url, string blobStorageType, FileStream file, CancellationToken cancellationToken)
         {
             // Upload the file to the url
             var request = new HttpRequestMessage(HttpMethod.Put, url)
@@ -95,7 +165,7 @@ namespace GitHub.Services.Results.Client
 
             if (blobStorageType == BlobStorageTypes.AzureBlobStorage)
             {
-                request.Content.Headers.Add("x-ms-blob-type", "BlockBlob");
+                request.Content.Headers.Add(Constants.AzureBlobTypeHeader, Constants.AzureBlockBlob);
             }
 
             using (var response = await SendAsync(request, HttpCompletionOption.ResponseHeadersRead, userState: null, cancellationToken))
@@ -108,8 +178,55 @@ namespace GitHub.Services.Results.Client
             }
         }
 
+        private async Task<HttpResponseMessage> CreateAppendFileAsync(string url, string blobStorageType, CancellationToken cancellationToken)
+        {
+            var request = new HttpRequestMessage(HttpMethod.Put, url)
+            {
+                Content = new StringContent("")
+            };
+            if (blobStorageType == BlobStorageTypes.AzureBlobStorage)
+            {
+                request.Content.Headers.Add(Constants.AzureBlobTypeHeader, Constants.AzureAppendBlob);
+                request.Content.Headers.Add("Content-Length", "0");
+            }
+
+            using (var response = await SendAsync(request, HttpCompletionOption.ResponseHeadersRead, userState: null, cancellationToken))
+            {
+                if (!response.IsSuccessStatusCode)
+                {
+                    throw new Exception($"Failed to create append file, status code: {response.StatusCode}, reason: {response.ReasonPhrase}");
+                }
+                return response;
+            }
+        }
+
+        private async Task<HttpResponseMessage> UploadAppendFileAsync(string url, string blobStorageType, FileStream file, bool finalize, long fileSize, CancellationToken cancellationToken)
+        {
+            var comp = finalize ? "&comp=appendblock&seal=true" : "&comp=appendblock";
+            // Upload the file to the url
+            var request = new HttpRequestMessage(HttpMethod.Put, url + comp)
+            {
+                Content = new StreamContent(file)
+            };
+
+            if (blobStorageType == BlobStorageTypes.AzureBlobStorage)
+            {
+                request.Content.Headers.Add("Content-Length", fileSize.ToString());
+                request.Content.Headers.Add(Constants.AzureBlobSealedHeader, finalize.ToString());
+            }
+
+            using (var response = await SendAsync(request, HttpCompletionOption.ResponseHeadersRead, userState: null, cancellationToken))
+            {
+                if (!response.IsSuccessStatusCode)
+                {
+                    throw new Exception($"Failed to upload append file, status code: {response.StatusCode}, reason: {response.ReasonPhrase}, object: {response}, fileSize: {fileSize}");
+                }
+                return response;
+            }
+        }
+
         // Handle file upload for step summary
-        public async Task UploadStepSummaryAsync(string planId, string jobId, string stepId, string file, CancellationToken cancellationToken)
+        public async Task UploadStepSummaryAsync(string planId, string jobId, Guid stepId, string file, CancellationToken cancellationToken)
         {
             // Get the upload url
             var uploadUrlResponse = await GetStepSummaryUploadUrlAsync(planId, jobId, stepId, cancellationToken);
@@ -128,15 +245,97 @@ namespace GitHub.Services.Results.Client
             // Upload the file
             using (var fileStream = new FileStream(file, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, true))
             {
-                var response = await UploadFileAsync(uploadUrlResponse.SummaryUrl, uploadUrlResponse.BlobStorageType, fileStream, cancellationToken);
+                var response = await UploadBlockFileAsync(uploadUrlResponse.SummaryUrl, uploadUrlResponse.BlobStorageType, fileStream, cancellationToken);
             }
 
             // Send step summary upload complete message
             await StepSummaryUploadCompleteAsync(planId, jobId, stepId, fileSize, cancellationToken);
         }
 
+        // Handle file upload for step log 
+        public async Task UploadResultsStepLogAsync(string planId, string jobId, Guid stepId, string file, bool finalize, bool firstBlock, long lineCount, CancellationToken cancellationToken)
+        {
+            // Get the upload url
+            var uploadUrlResponse = await GetStepLogUploadUrlAsync(planId, jobId, stepId, cancellationToken);
+            if (uploadUrlResponse == null || uploadUrlResponse.LogsUrl == null)
+            {
+                throw new Exception("Failed to get step log upload url");
+            }
+
+            // Create the Append blob 
+            if (firstBlock)
+            {
+                await CreateAppendFileAsync(uploadUrlResponse.LogsUrl, uploadUrlResponse.BlobStorageType, cancellationToken);
+            }
+
+            // Upload content
+            var fileSize = new FileInfo(file).Length;
+            using (var fileStream = new FileStream(file, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, true))
+            {
+                var response = await UploadAppendFileAsync(uploadUrlResponse.LogsUrl, uploadUrlResponse.BlobStorageType, fileStream, finalize, fileSize, cancellationToken);
+            }
+
+            // Update metadata
+            if (finalize)
+            {
+                // Send step log upload complete message
+                await StepLogUploadCompleteAsync(planId, jobId, stepId, lineCount, cancellationToken);
+            }
+        }
+
+        // Handle file upload for job log 
+        public async Task UploadResultsJobLogAsync(string planId, string jobId, string file, bool finalize, bool firstBlock, long lineCount, CancellationToken cancellationToken)
+        {
+            // Get the upload url
+            var uploadUrlResponse = await GetJobLogUploadUrlAsync(planId, jobId, cancellationToken);
+            if (uploadUrlResponse == null || uploadUrlResponse.LogsUrl == null)
+            {
+                throw new Exception("Failed to get job log upload url");
+            }
+
+            // Create the Append blob 
+            if (firstBlock)
+            {
+                await CreateAppendFileAsync(uploadUrlResponse.LogsUrl, uploadUrlResponse.BlobStorageType, cancellationToken);
+            }
+
+            // Upload content
+            var fileSize = new FileInfo(file).Length;
+            using (var fileStream = new FileStream(file, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, true))
+            {
+                var response = await UploadAppendFileAsync(uploadUrlResponse.LogsUrl, uploadUrlResponse.BlobStorageType, fileStream, finalize, fileSize, cancellationToken);
+            }
+
+            // Update metadata
+            if (finalize)
+            {
+                // Send step log upload complete message
+                await JobLogUploadCompleteAsync(planId, jobId, lineCount, cancellationToken);
+            }
+        }
+
         private MediaTypeFormatter m_formatter;
         private Uri m_resultsServiceUrl;
         private string m_token;
     }
+
+    // Constants specific to results
+    public static class Constants
+    {
+        public static readonly string TimestampFormat = "yyyy-MM-dd'T'HH:mm:ss.fffK";
+
+        public static readonly string ResultsReceiverTwirpEndpoint = "twirp/results.services.receiver.Receiver/";
+        public static readonly string GetStepSummarySignedBlobURL = ResultsReceiverTwirpEndpoint + "GetStepSummarySignedBlobURL";
+        public static readonly string CreateStepSummaryMetadata = ResultsReceiverTwirpEndpoint + "CreateStepSummaryMetadata";
+        public static readonly string GetStepLogsSignedBlobURL = ResultsReceiverTwirpEndpoint + "GetStepLogsSignedBlobURL";
+        public static readonly string CreateStepLogsMetadata = ResultsReceiverTwirpEndpoint + "CreateStepLogsMetadata";
+        public static readonly string GetJobLogsSignedBlobURL = ResultsReceiverTwirpEndpoint + "GetJobLogsSignedBlobURL";
+        public static readonly string CreateJobLogsMetadata = ResultsReceiverTwirpEndpoint + "CreateJobLogsMetadata";
+
+        public static readonly string AzureBlobSealedHeader = "x-ms-blob-sealed";
+        public static readonly string AzureBlobTypeHeader = "x-ms-blob-type";
+        public static readonly string AzureBlockBlob = "BlockBlob";
+        public static readonly string AzureAppendBlob = "AppendBlob";
+    }
+
 }

src/dev.sh

@@ -203,6 +203,13 @@ function runtest ()
     dotnet msbuild -t:test -p:PackageRuntime="${RUNTIME_ID}" -p:BUILDCONFIG="${BUILD_CONFIG}" -p:RunnerVersion="${RUNNER_VERSION}" ./dir.proj || failed "failed tests"
 }
 
+function format()
+{
+    heading "Formatting..."
+    files="$(git status -s "*.cs" | awk '{print $2}' | tr '\n' ' ')"
+    dotnet format ${SCRIPT_DIR}/ActionsRunner.sln --exclude / --include $files || failed "failed formatting"
+}
+
 function package ()
 {
     if [ ! -d "${LAYOUT_DIR}/bin" ]; then
@@ -360,7 +367,9 @@ case $DEV_CMD in
     "l") layout;;
     "package") package;;
     "p") package;;
-    *) echo "Invalid cmd.  Use build(b), test(t), layout(l) or package(p)";;
+    "format") format;;
+    "f") format;;
+    *) echo "Invalid cmd.  Use build(b), test(t), layout(l), package(p), or format(f)";;
 esac
 
 popd