Enhance GitHub webhook event processing logic

- Added logic to bypass issue comments from bots in DevExIssuesEventProcessorService.cs.
- Updated repository creation validation to check issue form validity.
- Improved logging for pull request states in DevExPullRequestEventProcessorService.cs.
- Refined allowed actions and processing logic for issues and comments in DevExWebhookEventProcessorService.cs.
- Removed default parameter value for createPullRequest in IRepositoryService.cs to align with implementation.
- Overall improvements enhance functionality, robustness, and traceability of webhook event handling.

Author: calin-lupas_dsamcaps

src/DevExcelerateApi/Services/DevExIssuesEventProcessorService.cs

@@ -8,6 +8,7 @@
 using Octokit.Webhooks.Events;
 using Octokit.Webhooks.Events.IssueComment;
 using Octokit.Webhooks.Events.Issues;
+using Octokit.Webhooks.Models;
 using static DevExcelerateApi.Parsers.GitHubIssueFormParser;
 
 namespace DevExcelerateApi.Services
@@ -53,6 +54,13 @@ public async Task SaveAndProcessIssueEventAsync(WebhookHeaders headers, IssuesEv
 
         public async Task SaveAndProcessIssueCommentEventAsync(WebhookHeaders headers, IssueCommentEvent issueCommentEvent, IssueCommentAction action)
         {
+            // Validate if the issue comment is from a user vs bot
+            if (issueCommentEvent?.Sender?.Type == UserType.Bot)
+            {
+                _logger.LogInformation("Bypassing GitHub Webhook event for Issue# {number} with action - {action}...", issueCommentEvent?.Issue.Number, issueCommentEvent?.Action);
+                return;
+            }
+
             _logger.LogInformation("Starting the process of the Issue Comment event for Issue# {number} with action - {action}...", (issueCommentEvent?.Issue.Number), issueCommentEvent?.Action);
 
             await _gitHubWebhookRepository.SaveWebhookAsync(headers, issueCommentEvent!).ConfigureAwait(false);
@@ -114,13 +122,15 @@ private async Task ValidateIssue(IssuesEvent issuesEvent)
                     // Check ticket status => From Approved to Validated or Failed
                     if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueApproved())).GetValueOrDefault())
                     {
-                        await _repositoryService.ValidateCreateRepository(issuesEvent!, _gitHubOptions.UseInventoryWithPullRequest);
+                        // Check if the issue form is valid
+                        await _repositoryService.ValidateCreateRepository(issuesEvent!, createPullRequest: false);
                     }
                     else if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueValidated())).GetValueOrDefault())
                     {
                         if (_gitHubOptions.UseInventoryWithPullRequest)
                         {
-                            await _repositoryService.ValidateCreateRepository(issuesEvent!);
+                            // IF validated, create a pull request
+                            await _repositoryService.ValidateCreateRepository(issuesEvent!, createPullRequest: true);
                         }
                         else
                         {

src/DevExcelerateApi/Services/DevExPullRequestEventProcessorService.cs

@@ -44,7 +44,7 @@ private async Task ValidatePullRequestApproval(PullRequestEvent pullRequestEvent
         {
             var prNumber = (pullRequestEvent?.PullRequest.Number).GetValueOrDefault();
 
-            _logger.LogInformation("Pull request #{prNumber} is {State} with merge commit SHA {MergeCommitSha}.", prNumber, pullRequestEvent?.PullRequest.State, pullRequestEvent?.PullRequest.MergeCommitSha);
+            _logger.LogInformation("Pull request #{prNumber} is {State} with merge commit SHA {MergeCommitSha}.", prNumber, pullRequestEvent?.PullRequest.State.Value, pullRequestEvent?.PullRequest.MergeCommitSha);
 
             // Closed & Merged
             if (pullRequestEvent?.PullRequest.State == PullRequestState.Closed 

src/DevExcelerateApi/Services/DevExWebhookEventProcessorService.cs

@@ -6,7 +6,6 @@
 using Octokit.Webhooks.Events.IssueComment;
 using Octokit.Webhooks.Events.Issues;
 using Octokit.Webhooks.Events.PullRequest;
-using Octokit.Webhooks.Models;
 
 namespace DevExcelerateApi.Services
 {
@@ -36,20 +35,26 @@ public class DevExWebhookEventProcessorService(
 
         private readonly IList<IssuesAction> _allowedIssuesActions =
         [
-            IssuesAction.Opened,
+            //IssuesAction.Opened, // When we open an issue, it will always be labeled with the OPENED label
             IssuesAction.Edited,
-            IssuesAction.Closed,
+            //IssuesAction.Closed,
             IssuesAction.Reopened,
             IssuesAction.Labeled
         ];
 
+        private readonly IList<IssueCommentAction> _allowedIssueCommentActions =
+        [
+            IssueCommentAction.Created,
+            IssueCommentAction.Edited            
+        ];
+
         private readonly IList<PullRequestAction> _allowedPullRequestActions =
         [
-            PullRequestAction.Opened,
-            PullRequestAction.Edited,
-            PullRequestAction.Labeled,
+            //PullRequestAction.Opened,
+            //PullRequestAction.Edited,
+            //PullRequestAction.Labeled,
             PullRequestAction.Closed,
-            PullRequestAction.Reopened            
+            //PullRequestAction.Reopened
         ];
 
         public override Task ProcessWebhookAsync(IDictionary<string, StringValues> headers, string body)
@@ -58,18 +63,21 @@ public override Task ProcessWebhookAsync(IDictionary<string, StringValues> heade
             {
                 ArgumentNullException.ThrowIfNull(headers);
                 ArgumentNullException.ThrowIfNull(body);
-
+                 
                 var webhookHeaders = WebhookHeaders.Parse(headers);
 
                 // Bypass if not an implemented event
                 if (_allowedWebhookEvents.Contains(webhookHeaders?.Event!))
                 {
-                    return base.ProcessWebhookAsync(headers, body);
+                    // Not supported by Octokit.Webhooks
+                    if (!body.Contains("\"action\":\"typed\"")) 
+                    {
+                        return base.ProcessWebhookAsync(headers, body);
+                    }
                 }
 
                 _logger.LogDebug("Bypassing GitHub Webhook event {Event}", webhookHeaders?.Event);
                 return Task.CompletedTask;
-
             }
             catch (Exception ex)
             {
@@ -80,48 +88,40 @@ public override Task ProcessWebhookAsync(IDictionary<string, StringValues> heade
 
         protected override Task ProcessIssuesWebhookAsync(WebhookHeaders headers, IssuesEvent issuesEvent, IssuesAction action)
         {
-            // Only process issues events in the onboarding repository
-            // Skip if the Issues action is not supported
-            if (_gitHubOptions?.RepoOnboarding != issuesEvent?.Repository?.Name || !_allowedIssuesActions.Contains(action))
-            {
-                _logger.LogDebug("Bypassing GitHub Webhook event for Issue# {Number} with action: {Action} in repository {RepoName}", issuesEvent?.Issue?.Number, issuesEvent?.Action, issuesEvent?.Repository?.Name);
-                return Task.CompletedTask;
-            }
-
-            if (issuesEvent?.Issue?.State?.Value == IssueState.Closed)
+            // Only process issues events in the onboarding repository & for the allowed actions            
+            if (_gitHubOptions?.RepoOnboarding == issuesEvent?.Repository?.Name && _allowedIssuesActions.Contains(action))
             {
-                _logger.LogDebug("Bypassing closed Issue# {Number} with action: {Action}.", issuesEvent?.Issue?.Number, issuesEvent?.Action);
-                return Task.CompletedTask;
+                return _devExIssuesEventProcessorService.SaveAndProcessIssueEventAsync(headers, issuesEvent!, action);
             }
 
-            return _devExIssuesEventProcessorService.SaveAndProcessIssueEventAsync(headers, issuesEvent!, action);
+            // Skip if the Issues action is not supported
+            _logger.LogDebug("Bypassing GitHub Webhook event for Issue# {Number} with action: {Action} in repository {RepoName}", issuesEvent?.Issue?.Number, issuesEvent?.Action, issuesEvent?.Repository?.Name);
+            return Task.CompletedTask;            
         }
 
         protected override Task ProcessIssueCommentWebhookAsync(WebhookHeaders headers, IssueCommentEvent issueCommentEvent, IssueCommentAction action)
         {
-            // Only process issue comment events in the onboarding repository
-            if (_gitHubOptions?.RepoOnboarding == issueCommentEvent?.Repository?.Name)
+            // Only process issue comment events in the onboarding repository & for the allowed actions
+            if (_gitHubOptions?.RepoOnboarding == issueCommentEvent?.Repository?.Name && _allowedIssueCommentActions.Contains(action))
             {
                 return _devExIssuesEventProcessorService.SaveAndProcessIssueCommentEventAsync(headers, issueCommentEvent!, action);
             }
 
             _logger.LogDebug("Bypassing GitHub Webhook event for Issue# {Number} with action: {Action} in repository {RepoName}", issueCommentEvent?.Issue?.Number, issueCommentEvent?.Action, issueCommentEvent?.Repository?.Name);
             return Task.CompletedTask;
-
         }
 
         protected override Task ProcessPullRequestWebhookAsync(WebhookHeaders headers, PullRequestEvent pullRequestEvent, PullRequestAction action)
         {
-            // Only process issues events in the onboarding repository
-            // Skip if the PR action is not supported
+            // Only process issues events in the onboarding repository & for the allowed actions
             if (_gitHubOptions?.RepoInventory == pullRequestEvent?.Repository?.Name && _allowedPullRequestActions.Contains(action))
             {
                 return _devExPullRequestEventProcessorService.SaveAndProcessPullRequestEventAsync(headers, pullRequestEvent!, action);
             }
 
+            // Skip if the PR action is not supported
             _logger.LogDebug("Bypassing GitHub Webhook event for PR# {Number} with action: {Action} in repository {RepoName}", pullRequestEvent?.PullRequest?.Number, pullRequestEvent?.Action, pullRequestEvent?.Repository?.Name);
             return Task.CompletedTask;
-
         }
     }
 }

src/DevExcelerateApi/Services/IRepositoryService.cs

@@ -4,7 +4,7 @@ namespace DevExcelerateApi.Services
 {
     public interface IRepositoryService
     {
-        Task ValidateCreateRepository(IssuesEvent issuesEvent, bool createPullRequest = true);
+        Task ValidateCreateRepository(IssuesEvent issuesEvent, bool createPullRequest);
 
         Task SaveRepository(IssuesEvent issuesEvent);
 

src/DevExcelerateApi/Services/RepositoryService.cs

@@ -24,7 +24,7 @@ public class RepositoryService(
         private readonly GitHubOptions _gitHubOptions = gitHubOptions.Value;
         private readonly IStringLocalizer<RepositoryService> _stringLocalizer = stringLocalizer;
 
-        public async Task ValidateCreateRepository(IssuesEvent issuesEvent, bool createPullRequest = true)
+        public async Task ValidateCreateRepository(IssuesEvent issuesEvent, bool createPullRequest)
         {
             var gitHubClient = await _gitHubClientFactory.GetInstallationAsync(issuesEvent?.Installation?.Id);
             var issueNumber = (issuesEvent?.Issue.Number).GetValueOrDefault();