Merge pull request #121 from leanix/feature/CID-3913/ignore-webhook-events-if-a-scan-is-running

CID-3913: Ignore webhook events if a scan is running

Author: mohamedlajmileanix

src/main/kotlin/net/leanix/githubagent/services/GitHubWebhookService.kt

@@ -13,13 +13,19 @@ import org.springframework.stereotype.Service
 @Service
 class GitHubWebhookService(
     private val webhookEventService: WebhookEventService,
-    private val gitHubEnterpriseProperties: GitHubEnterpriseProperties
+    private val gitHubEnterpriseProperties: GitHubEnterpriseProperties,
+    private val cachingService: CachingService,
 ) {
 
     private val logger = LoggerFactory.getLogger(GitHubWebhookService::class.java)
 
     @Async
     fun handleWebhookEvent(eventType: String, host: String, signature256: String?, payload: String) {
+        val runId = cachingService.get("runId")
+        if (runId != null && eventType.uppercase() != "INSTALLATION") {
+            logger.info("Received a webhook event while a full sync is in progress, ignoring the event.")
+            return
+        }
         if (SUPPORTED_EVENT_TYPES.contains(eventType.uppercase())) {
             if (!gitHubEnterpriseProperties.baseUrl.contains(host)) {
                 logger.error("Received a webhook event from an unknown host: $host")

src/test/kotlin/net/leanix/githubagent/services/GitHubWebhookServiceTest.kt

@@ -14,10 +14,16 @@ class GitHubWebhookServiceTest {
 
     private val webhookEventService = mockk<WebhookEventService>()
     private val gitHubEnterpriseProperties = mockk<GitHubEnterpriseProperties>()
-    private val gitHubWebhookService = GitHubWebhookService(webhookEventService, gitHubEnterpriseProperties)
+    private val cachingService = mockk<CachingService>()
+    private val gitHubWebhookService = GitHubWebhookService(
+        webhookEventService,
+        gitHubEnterpriseProperties,
+        cachingService,
+    )
 
     @BeforeEach
     fun setUp() {
+        every { cachingService.get("runId") } returns null
     }
 
     @Test
@@ -69,4 +75,16 @@ class GitHubWebhookServiceTest {
 
         verify { webhookEventService.consumeWebhookEvent("PUSH", "{}") }
     }
+
+    @Test
+    fun `should ignore event when runId is present and event type is not INSTALLATION`() {
+        every { gitHubEnterpriseProperties.baseUrl } returns "host"
+        every { gitHubEnterpriseProperties.webhookSecret } returns ""
+        every { webhookEventService.consumeWebhookEvent(any(), any()) } returns Unit
+        every { cachingService.get("runId") } returns "someRunId"
+
+        gitHubWebhookService.handleWebhookEvent("PUSH", "host", null, "{}")
+
+        verify(exactly = 0) { webhookEventService.consumeWebhookEvent(any(), any()) }
+    }
 }