Expose eventType as event variable to rules (#136)

* New feature to avoid revision check

Use new directive
.check revision false
this should help in scenario like #128 and #125

* Documentation migrated to aggregator-docs repo

* Expose eventType as event variable to rules

Author: giuliov

src/aggregator-cli/Rules/AggregatorRules.cs

@@ -431,7 +431,7 @@ internal async Task<bool> InvokeLocalAsync(string projectName, string @event, in
                     var engine = new Engine.RuleEngine(engineLogger, saveMode, dryRun: dryRun);
 
                     var workItem = await clientsContext.WitClient.GetWorkItemAsync(projectName, workItemId, expand: WorkItemExpand.All, cancellationToken: cancellationToken);
-                    string result = await engine.RunAsync(rule, teamProjectId, workItem, clientsContext, cancellationToken);
+                    string result = await engine.RunAsync(rule, teamProjectId, workItem, @event, clientsContext, cancellationToken);
                     _logger.WriteInfo($"Rule returned '{result}'");
 
                     return true;

src/aggregator-function/AzureFunctionHandler.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.IO;
 using System.Linq;
 using System.Threading;
@@ -132,13 +132,13 @@ protected WorkItemEventContext CreateContextFromEvent(WebHookEvent eventData)
                 var workItem = resourceObject.GetValue("revision").ToObject<WorkItem>();
                 MigrateIdentityInformation(eventData.ResourceVersion, workItem);
                 var workItemUpdate = resourceObject.ToObject<WorkItemUpdate>();
-                return new WorkItemEventContext(teamProjectId, new Uri(collectionUrl), workItem, workItemUpdate);
+                return new WorkItemEventContext(teamProjectId, new Uri(collectionUrl), workItem, eventData.EventType, workItemUpdate);
             }
             else
             {
                 var workItem = resourceObject.ToObject<WorkItem>();
                 MigrateIdentityInformation(eventData.ResourceVersion, workItem);
-                return new WorkItemEventContext(teamProjectId, new Uri(collectionUrl), workItem);
+                return new WorkItemEventContext(teamProjectId, new Uri(collectionUrl), workItem, eventData.EventType);
             }
         }
 

src/aggregator-ruleng/RuleEngine.cs

@@ -15,7 +15,7 @@ namespace aggregator.Engine
 {
     internal interface IRuleEngine
     {
-        Task<string> RunAsync(IRule rule, Guid projectId, WorkItemData workItemPayload, IClientsContext clients, CancellationToken cancellationToken = default);
+        Task<string> RunAsync(IRule rule, Guid projectId, WorkItemData workItemPayload, string eventType, IClientsContext clients, CancellationToken cancellationToken = default);
     }
 
     public abstract class RuleEngineBase : IRuleEngine
@@ -34,9 +34,9 @@ protected RuleEngineBase(IAggregatorLogger logger, SaveMode saveMode, bool dryRu
             this.dryRun = dryRun;
         }
 
-        public async Task<string> RunAsync(IRule rule, Guid projectId, WorkItemData workItemPayload, IClientsContext clients, CancellationToken cancellationToken = default)
+        public async Task<string> RunAsync(IRule rule, Guid projectId, WorkItemData workItemPayload, string eventType, IClientsContext clients, CancellationToken cancellationToken = default)
         {
-            var executionContext = CreateRuleExecutionContext(projectId, workItemPayload, clients, rule.Settings);
+            var executionContext = CreateRuleExecutionContext(projectId, workItemPayload, eventType, clients, rule.Settings);
 
             var result = await ExecuteRuleAsync(rule, executionContext, cancellationToken);
 
@@ -45,7 +45,7 @@ public async Task<string> RunAsync(IRule rule, Guid projectId, WorkItemData work
 
         protected abstract Task<string> ExecuteRuleAsync(IRule rule, RuleExecutionContext executionContext, CancellationToken cancellationToken = default);
 
-        protected RuleExecutionContext CreateRuleExecutionContext(Guid projectId, WorkItemData workItemPayload, IClientsContext clients, IRuleSettings ruleSettings)
+        protected RuleExecutionContext CreateRuleExecutionContext(Guid projectId, WorkItemData workItemPayload, string eventType, IClientsContext clients, IRuleSettings ruleSettings)
         {
             var workItem = workItemPayload.WorkItem;
             var context = new EngineContext(clients, projectId, workItem.GetTeamProject(), logger, ruleSettings);
@@ -59,7 +59,8 @@ protected RuleExecutionContext CreateRuleExecutionContext(Guid projectId, WorkIt
                 self = self,
                 selfChanges = selfChanges,
                 store = store,
-                logger = logger
+                logger = logger,
+                eventType = eventType
             };
             return globals;
         }

src/aggregator-ruleng/RuleExecutionContext.cs

@@ -13,5 +13,6 @@ public class RuleExecutionContext
         public WorkItemUpdateWrapper selfChanges;
         public WorkItemStore store;
         public IAggregatorLogger logger;
+        public string eventType;
     }
 }

src/aggregator-ruleng/RuleExecutor.cs

@@ -43,11 +43,11 @@ public async Task<string> ExecuteAsync(IRule rule, WorkItemEventContext eventCon
                 {
                     var engine = new RuleEngine(logger, configuration.SaveMode, configuration.DryRun);
 
-                    var ruleResult = await engine.RunAsync(rule, eventContext.ProjectId, eventContext.WorkItemPayload, clientsContext, cancellationToken);
+                    var ruleResult = await engine.RunAsync(rule, eventContext.ProjectId, eventContext.WorkItemPayload, eventContext.EventType, clientsContext, cancellationToken);
                     logger.WriteInfo(ruleResult);
                     return ruleResult;
                 }
             }
         }
     }
-}
+}

src/aggregator-ruleng/WorkItemEventContext.cs

@@ -6,16 +6,18 @@ namespace aggregator.Engine
 
     public class WorkItemEventContext
     {
-        public WorkItemEventContext(Guid projectId, Uri collectionUri, WorkItem workItem, WorkItemUpdate workItemUpdate = null)
+        public WorkItemEventContext(Guid projectId, Uri collectionUri, WorkItem workItem, string eventType, WorkItemUpdate workItemUpdate = null)
         {
             ProjectId = projectId;
             CollectionUri = collectionUri;
             WorkItemPayload = new WorkItemData(workItem, workItemUpdate);
+            EventType = eventType;
         }
 
         public WorkItemData WorkItemPayload { get; }
         public Guid ProjectId { get; }
         public Uri CollectionUri { get; }
+        public string EventType { get; }
     }
 
     public static class WorkItemEventContextExtension