Composite Actions UI

src/Runner.Worker/ActionManager.cs

@@ -400,6 +400,8 @@ public Definition LoadAction(IExecutionContext executionContext, Pipelines.Actio
                         var compositeAction = definition.Data.Execution as CompositeActionExecutionData;
                         Trace.Info($"Load {compositeAction.Steps.Count} action steps.");
                         Trace.Verbose($"Details: {StringUtil.ConvertToJson(compositeAction.Steps)}");
+                        Trace.Info($"Load: {compositeAction.Outputs} outputs");
+                        Trace.Info($"Details: {StringUtil.ConvertToJson(compositeAction.Outputs)}");
                     }
                     else
                     {
@@ -1222,6 +1224,7 @@ public sealed class CompositeActionExecutionData : ActionExecutionData
         public override bool HasPre => false;
         public override bool HasPost => false;
         public List<Pipelines.ActionStep> Steps { get; set; }
+        public MappingToken Outputs { get; set; }
     }
 
     public abstract class ActionExecutionData

src/Runner.Worker/ActionManifestManager.cs

@@ -89,6 +89,8 @@ public ActionDefinitionData Load(IExecutionContext executionContext, string mani
                 }
 
                 var actionMapping = token.AssertMapping("action manifest root");
+                var actionOutputs = default(MappingToken);
+
                 foreach (var actionPair in actionMapping)
                 {
                     var propertyName = actionPair.Key.AssertString($"action.yml property key");
@@ -99,6 +101,15 @@ public ActionDefinitionData Load(IExecutionContext executionContext, string mani
                             actionDefinition.Name = actionPair.Value.AssertString("name").Value;
                             break;
 
+                        case "outputs":
+                            if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("TESTING_COMPOSITE_ACTIONS_ALPHA")))
+                            {
+                                actionOutputs = actionPair.Value.AssertMapping("outputs");
+                                break;
+                            }
+                            Trace.Info($"Ignore action property outputs. Outputs for a whole action is not supported yet.");
+                            break;
+
                         case "description":
                             actionDefinition.Description = actionPair.Value.AssertString("description").Value;
                             break;
@@ -108,8 +119,9 @@ public ActionDefinitionData Load(IExecutionContext executionContext, string mani
                             break;
 
                         case "runs":
-                            actionDefinition.Execution = ConvertRuns(executionContext, templateContext, actionPair.Value);
+                            actionDefinition.Execution = ConvertRuns(executionContext, templateContext, actionPair.Value, actionOutputs);
                             break;
+
                         default:
                             Trace.Info($"Ignore action property {propertyName}.");
                             break;
@@ -309,7 +321,8 @@ private TemplateContext CreateContext(
         private ActionExecutionData ConvertRuns(
             IExecutionContext executionContext,
             TemplateContext context,
-            TemplateToken inputsToken)
+            TemplateToken inputsToken,
+            MappingToken outputs = null)
         {
             var runsMapping = inputsToken.AssertMapping("runs");
             var usingToken = default(StringToken);
@@ -439,6 +452,7 @@ private ActionExecutionData ConvertRuns(
                         return new CompositeActionExecutionData()
                         {
                             Steps = stepsLoaded,
+                            Outputs = outputs
                         };
                     }
                 }

src/Runner.Worker/ExecutionContext.cs

@@ -52,7 +52,6 @@ public interface IExecutionContext : IRunnerService
         IDictionary<String, IDictionary<String, String>> JobDefaults { get; }
         Dictionary<string, VariableValue> JobOutputs { get; }
         IDictionary<String, String> EnvironmentVariables { get; }
-        IDictionary<String, ContextScope> Scopes { get; }
         IList<String> FileTable { get; }
         StepsContext StepsContext { get; }
         DictionaryContextData ExpressionValues { get; }
@@ -70,10 +69,12 @@ public interface IExecutionContext : IRunnerService
 
         bool EchoOnActionCommand { get; set; }
 
+        IExecutionContext FinalizeContext { get; set; }
+
         // Initialize
         void InitializeJob(Pipelines.AgentJobRequestMessage message, CancellationToken token);
         void CancelToken();
-        IExecutionContext CreateChild(Guid recordId, string displayName, string refName, string scopeName, string contextName, Dictionary<string, string> intraActionState = null, int? recordOrder = null);
+        IExecutionContext CreateChild(Guid recordId, string displayName, string refName, string scopeName, string contextName, Dictionary<string, string> intraActionState = null, int? recordOrder = null, IPagingLogger logger = null);
 
         // logging
         bool WriteDebug { get; }
@@ -105,7 +106,7 @@ public interface IExecutionContext : IRunnerService
         // others
         void ForceTaskComplete();
         void RegisterPostJobStep(IStep step);
-        void RegisterNestedStep(IStep step, DictionaryContextData inputsData, int location, Dictionary<string, string> envData);
+        IStep RegisterNestedStep(IActionRunner step, DictionaryContextData inputsData, int location, Dictionary<string, string> envData, Boolean cleanUp = false);
     }
 
     public sealed class ExecutionContext : RunnerService, IExecutionContext
@@ -149,7 +150,6 @@ public sealed class ExecutionContext : RunnerService, IExecutionContext
         public IDictionary<String, IDictionary<String, String>> JobDefaults { get; private set; }
         public Dictionary<string, VariableValue> JobOutputs { get; private set; }
         public IDictionary<String, String> EnvironmentVariables { get; private set; }
-        public IDictionary<String, ContextScope> Scopes { get; private set; }
         public IList<String> FileTable { get; private set; }
         public StepsContext StepsContext { get; private set; }
         public DictionaryContextData ExpressionValues { get; } = new DictionaryContextData();
@@ -170,6 +170,8 @@ public sealed class ExecutionContext : RunnerService, IExecutionContext
 
         public bool EchoOnActionCommand { get; set; }
 
+        public IExecutionContext FinalizeContext { get; set; }
+
         public TaskResult? Result
         {
             get
@@ -270,17 +272,40 @@ public void RegisterPostJobStep(IStep step)
         /// Helper function used in CompositeActionHandler::RunAsync to
         /// add a child node, aka a step, to the current job to the Root.JobSteps based on the location. 
         /// </summary>
-        public void RegisterNestedStep(IStep step, DictionaryContextData inputsData, int location, Dictionary<string, string> envData)
+        public IStep RegisterNestedStep(
+            IActionRunner step, DictionaryContextData inputsData, int location,
+            Dictionary<string, string> envData,
+            Boolean cleanUp = false)
         {
             // TODO: For UI purposes, look at figuring out how to condense steps in one node => maybe use the same previous GUID
-            var newGuid = Guid.NewGuid();
-            step.ExecutionContext = Root.CreateChild(newGuid, step.DisplayName, newGuid.ToString("N"), null, null);
+            // You don't want to create the NewGuid at all. We want to inherit the current node.
+            // We want to get the ID
+            // var newGuid = Guid.NewGuid();
+
+            // Set Scope Name. Note, for our design, we consider each step in a composite action to have the same scope
+            // This makes it much simpler to handle their outputs at the end of the Composite Action
+            var childScopeName = !string.IsNullOrEmpty(this.ScopeName) ? $"{this.ScopeName}.{this.ContextName}" : this.ContextName;
+
+            // If the context name is empty and the scope name is empty, we would generate a unique scope name for this child in the following format:
+            // "__<GUID>"
+            if (String.IsNullOrEmpty(childScopeName))
+            {
+                var newGuid = Guid.NewGuid();
+                childScopeName = $"__{newGuid}";
+            }
+
+            var childContextName = step.Action.ContextName;
+
+            step.ExecutionContext = Root.CreateChild(_record.Id, step.DisplayName, _record.Id.ToString("N"), childScopeName, childContextName, logger: _logger);
             step.ExecutionContext.ExpressionValues["inputs"] = inputsData;
 
+            // Set Parent Attribute for Clean Up Step
+            if (cleanUp)
+            {
+                step.ExecutionContext.FinalizeContext = this;
+            }
+
             // Add the composite action environment variables to each step.
-            // If the key already exists, we override it since the composite action env variables will have higher precedence
-            // Note that for each composite action step, it's environment variables will be set in the StepRunner automatically
-            // step.ExecutionContext.SetEnvironmentVariables(envData);
 #if OS_WINDOWS
             var envContext = new DictionaryContextData();
 #else
@@ -293,9 +318,11 @@ public void RegisterNestedStep(IStep step, DictionaryContextData inputsData, int
             step.ExecutionContext.ExpressionValues["env"] = envContext;
 
             Root.JobSteps.Insert(location, step);
+
+            return step;
         }
 
-        public IExecutionContext CreateChild(Guid recordId, string displayName, string refName, string scopeName, string contextName, Dictionary<string, string> intraActionState = null, int? recordOrder = null)
+        public IExecutionContext CreateChild(Guid recordId, string displayName, string refName, string scopeName, string contextName, Dictionary<string, string> intraActionState = null, int? recordOrder = null, IPagingLogger logger = null)
         {
             Trace.Entering();
 
@@ -317,7 +344,6 @@ public IExecutionContext CreateChild(Guid recordId, string displayName, string r
             }
             child.EnvironmentVariables = EnvironmentVariables;
             child.JobDefaults = JobDefaults;
-            child.Scopes = Scopes;
             child.FileTable = FileTable;
             child.StepsContext = StepsContext;
             foreach (var pair in ExpressionValues)
@@ -344,9 +370,15 @@ public IExecutionContext CreateChild(Guid recordId, string displayName, string r
             {
                 child.InitializeTimelineRecord(_mainTimelineId, recordId, _record.Id, ExecutionContextType.Task, displayName, refName, ++_childTimelineRecordOrder);
             }
-
-            child._logger = HostContext.CreateService<IPagingLogger>();
-            child._logger.Setup(_mainTimelineId, recordId);
+            if (logger != null)
+            {
+                child._logger = logger;
+            }
+            else
+            {
+                child._logger = HostContext.CreateService<IPagingLogger>();
+                child._logger.Setup(_mainTimelineId, recordId);
+            }
 
             return child;
         }
@@ -466,7 +498,10 @@ public void SetOutput(string name, string value, out string reference)
         {
             ArgUtil.NotNullOrEmpty(name, nameof(name));
 
-            if (String.IsNullOrEmpty(ContextName))
+            // Checks if scope name is null or 
+            // if the ScopeName follows the __GUID format which is set as the default value for ScopeNames if null for Composite Actions. 
+            bool scopeNameCondition = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("TESTING_COMPOSITE_ACTIONS_ALPHA")) && !String.IsNullOrEmpty(ScopeName) && ScopeName.Length >= 36 && String.Equals(ScopeName.Substring(0, 2), "__") && Guid.TryParse(ScopeName.Substring(2, 36), out Guid test);
+            if (String.IsNullOrEmpty(ContextName) || scopeNameCondition)
             {
                 reference = null;
                 return;
@@ -633,16 +668,6 @@ public void InitializeJob(Pipelines.AgentJobRequestMessage message, Cancellation
             // Steps context (StepsRunner manages adding the scoped steps context)
             StepsContext = new StepsContext();
 
-            // Scopes
-            Scopes = new Dictionary<String, ContextScope>(StringComparer.OrdinalIgnoreCase);
-            if (message.Scopes?.Count > 0)
-            {
-                foreach (var scope in message.Scopes)
-                {
-                    Scopes[scope.Name] = scope;
-                }
-            }
-
             // File table
             FileTable = new List<String>(message.FileTable ?? new string[0]);
 

src/Runner.Worker/Handlers/CompositeActionHandler.cs

@@ -23,6 +23,13 @@ public sealed class CompositeActionHandler : Handler, ICompositeActionHandler
     {
         public CompositeActionExecutionData Data { get; set; }
 
+        private void InitializeScope(IStep step)
+        {
+            var stepsContext = step.ExecutionContext.StepsContext;
+            var scopeName = step.ExecutionContext.ScopeName;
+            step.ExecutionContext.ExpressionValues["steps"] = stepsContext.GetScope(scopeName);
+        }
+
         public Task RunAsync(ActionRunStage stage)
         {
             // Validate args.
@@ -47,6 +54,12 @@ public Task RunAsync(ActionRunStage stage)
 
             // Add each composite action step to the front of the queue
             int location = 0;
+
+            Dictionary<string, string> scopesAndContexts = new Dictionary<string, string>();
+
+            var parentScopeName = !String.IsNullOrEmpty(ExecutionContext.ScopeName) ? ExecutionContext.ScopeName : ExecutionContext.ContextName;
+            Trace.Info($"Parent Scope Name {parentScopeName}");
+
             foreach (Pipelines.ActionStep aStep in actionSteps)
             {
                 // Ex: 
@@ -83,12 +96,26 @@ public Task RunAsync(ActionRunStage stage)
                 actionRunner.Action = aStep;
                 actionRunner.Stage = stage;
                 actionRunner.Condition = aStep.Condition;
-                actionRunner.DisplayName = aStep.DisplayName;
 
-                ExecutionContext.RegisterNestedStep(actionRunner, inputsData, location, Environment);
+                var step = ExecutionContext.RegisterNestedStep(actionRunner, inputsData, location, Environment);
+
+                InitializeScope(step);
+
                 location++;
             }
 
+            // Create a step that handles all the composite action steps' outputs
+            Pipelines.ActionStep cleanOutputsStep = new Pipelines.ActionStep();
+            cleanOutputsStep.ContextName = ExecutionContext.ContextName;
+            // Use the same reference type as our composite steps.
+            cleanOutputsStep.Reference = Action;
+
+            var actionRunner2 = HostContext.CreateService<IActionRunner>();
+            actionRunner2.Action = cleanOutputsStep;
+            actionRunner2.Stage = ActionRunStage.Main;
+            actionRunner2.Condition = "always()";
+            ExecutionContext.RegisterNestedStep(actionRunner2, inputsData, location, Environment, true);
+
             return Task.CompletedTask;
         }
 

src/Runner.Worker/Handlers/CompositeActionOutputHandler.cs

@@ -0,0 +1,70 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using GitHub.DistributedTask.ObjectTemplating.Tokens;
+using GitHub.DistributedTask.Pipelines.ContextData;
+using GitHub.DistributedTask.WebApi;
+using GitHub.Runner.Common;
+using GitHub.Runner.Sdk;
+using Pipelines = GitHub.DistributedTask.Pipelines;
+
+namespace GitHub.Runner.Worker.Handlers
+{
+    [ServiceLocator(Default = typeof(CompositeActionOutputHandler))]
+    public interface ICompositeActionOutputHandler : IHandler
+    {
+        CompositeActionExecutionData Data { get; set; }
+    }
+
+    public sealed class CompositeActionOutputHandler : Handler, ICompositeActionOutputHandler
+    {
+        public CompositeActionExecutionData Data { get; set; }
+        public Task RunAsync(ActionRunStage stage)
+        {
+            // Evaluate the mapped outputs value
+            if (Data.Outputs != null)
+            {
+                // Evaluate the outputs in the steps context to easily retrieve the values
+                var evaluator = ExecutionContext.ToPipelineTemplateEvaluator();
+                DictionaryContextData actionOutputs = evaluator.EvaluateCompositeOutputs(Data.Outputs, ExecutionContext.ExpressionValues, ExecutionContext.ExpressionFunctions);
+
+                // Each pair is structured like this
+                // We ignore "description" for now
+                // "key": "output_id",
+                // {
+                //     "value": {
+                //         "t": 2,
+                //         "d": [
+                //         {
+                //             "k": "description",
+                //             "v": "string (can be null)"
+                //         },
+                //         {
+                //             "k": "value",
+                //             "v": "string/expression"
+                //         }
+                //         ]
+                //     }
+                // }
+                foreach (var pair in actionOutputs)
+                {
+                    var outputsName = pair.Key;
+                    var outputsAttributes = pair.Value as DictionaryContextData;
+                    outputsAttributes.TryGetValue("value", out var val);
+                    var outputsValue = val as StringContextData;
+
+                    // Set output in the whole composite scope. 
+                    if (!String.IsNullOrEmpty(outputsName) && !String.IsNullOrEmpty(outputsValue))
+                    {
+                        ExecutionContext.FinalizeContext.SetOutput(outputsName, outputsValue, out string test);
+                    }
+                }
+            }
+
+            return Task.CompletedTask;
+        }
+    }
+}

src/Runner.Worker/Handlers/HandlerFactory.cs

@@ -68,8 +68,16 @@ public IHandler Create(
             }
             else if (data.ExecutionType == ActionExecutionType.Composite)
             {
-                handler = HostContext.CreateService<ICompositeActionHandler>();
-                (handler as ICompositeActionHandler).Data = data as CompositeActionExecutionData;
+                if (executionContext.FinalizeContext == null)
+                {
+                    handler = HostContext.CreateService<ICompositeActionHandler>();
+                    (handler as ICompositeActionHandler).Data = data as CompositeActionExecutionData;
+                }
+                else
+                {
+                    handler = HostContext.CreateService<ICompositeActionOutputHandler>();
+                    (handler as ICompositeActionOutputHandler).Data = data as CompositeActionExecutionData;
+                }
             }
             else
             {