Merge pull request #130 from leanix/feature/CID-3864/Make-the-full-scan-only-run-once

CID-3864: Make full scan run only once

Author: mohamedlajmileanix

src/main/kotlin/net/leanix/githubagent/dto/FullScanStatus.kt

@@ -0,0 +1,6 @@
+package net.leanix.githubagent.dto
+
+enum class FullScanStatus {
+    IN_PROGRESS,
+    FINISHED,
+}

src/main/kotlin/net/leanix/githubagent/handler/FullScanHandler.kt

@@ -1,7 +1,7 @@
 package net.leanix.githubagent.handler
 
 import net.leanix.githubagent.services.CachingService
-import net.leanix.githubagent.services.GitHubStartService
+import net.leanix.githubagent.services.FullScanService
 import org.slf4j.LoggerFactory
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Value
@@ -16,7 +16,7 @@ class FullScanHandler(
     @Lazy @Autowired
     private val cachingService: CachingService,
     @Lazy @Autowired
-    private val gitHubStartService: GitHubStartService,
+    private val fullScanService: FullScanService,
     @Value("\${webhookEventService.waitingTime}") private val waitingTime: Long,
 ) : StompFrameHandler {
 
@@ -33,8 +33,8 @@ class FullScanHandler(
                 logger.info("A full scan is already in progress, waiting for it to finish.")
                 Thread.sleep(waitingTime)
             }
-            GitHubStartService.requireScan = true
-            gitHubStartService.verifyAndStartScan()
+            FullScanService.requireScan = true
+            fullScanService.verifyAndStartScan()
         }
     }
 }

src/main/kotlin/net/leanix/githubagent/scheduler/FullScanStatusScheduler.kt

@@ -0,0 +1,21 @@
+package net.leanix.githubagent.scheduler
+
+import net.leanix.githubagent.dto.FullScanStatus
+import net.leanix.githubagent.services.CachingService
+import net.leanix.githubagent.services.WebSocketService
+import org.springframework.scheduling.annotation.Scheduled
+import org.springframework.stereotype.Component
+
+@Component
+class FullScanStatusScheduler(
+    private val webSocketService: WebSocketService,
+    private val cachingService: CachingService,
+) {
+
+    @Scheduled(fixedDelay = 30000, initialDelay = 30000)
+    fun sendFullScanStatus() {
+        val runId = cachingService.get("runId")
+        val status = if (runId != null) FullScanStatus.IN_PROGRESS else FullScanStatus.FINISHED
+        webSocketService.sendMessage("/fullScanStatus", status.name)
+    }
+}

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

@@ -0,0 +1,30 @@
+package net.leanix.githubagent.services
+
+import net.leanix.githubagent.exceptions.UnableToSendMessageException
+import org.springframework.stereotype.Service
+
+@Service
+class FullScanService(
+    private val gitHubScanningService: GitHubScanningService,
+    private val syncLogService: SyncLogService
+) {
+
+    companion object {
+        var requireScan: Boolean = false
+    }
+
+    fun verifyAndStartScan() {
+        if (requireScan) {
+            runCatching {
+                requireScan = false
+                syncLogService.sendFullScanStart(null)
+                gitHubScanningService.scanGitHubResources()
+            }.onSuccess {
+                syncLogService.sendFullScanSuccess()
+            }.onFailure {
+                if (it is UnableToSendMessageException) requireScan = true
+                syncLogService.sendFullScanFailure(it.message)
+            }
+        }
+    }
+}

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

@@ -1,7 +1,6 @@
 package net.leanix.githubagent.services
 
 import net.leanix.githubagent.dto.ConnectionEstablishedEvent
-import net.leanix.githubagent.exceptions.UnableToSendMessageException
 import net.leanix.githubagent.shared.APP_NAME_TOPIC
 import org.springframework.context.event.EventListener
 import org.springframework.scheduling.annotation.Async
@@ -11,44 +10,23 @@ import org.springframework.stereotype.Service
 class GitHubStartService(
     private val githubAuthenticationService: GitHubAuthenticationService,
     private val webSocketService: WebSocketService,
-    private val gitHubScanningService: GitHubScanningService,
     private val gitHubEnterpriseService: GitHubEnterpriseService,
     private val cachingService: CachingService,
-    private val syncLogService: SyncLogService
 ) {
-    companion object {
-        var requireScan: Boolean = true
-    }
 
     @SuppressWarnings("UnusedParameter")
     @Async
     @EventListener
     fun startAgent(connectionEstablishedEvent: ConnectionEstablishedEvent) {
-        verifyAndStartScan()
-    }
-
-    fun verifyAndStartScan() {
-        if (requireScan) {
-            runCatching {
-                requireScan = false
-                syncLogService.sendFullScanStart(null)
-                scanResources()
-            }.onSuccess {
-                syncLogService.sendFullScanSuccess()
-            }.onFailure {
-                if (it is UnableToSendMessageException) requireScan = true
-                syncLogService.sendFullScanFailure(it.message)
-            }
-        }
+        githubAuthenticationService.generateAndCacheJwtToken()
+        sendAppName()
     }
 
-    private fun scanResources() {
-        githubAuthenticationService.generateAndCacheJwtToken()
+    private fun sendAppName() {
         val jwt = cachingService.get("jwtToken") as String
         webSocketService.sendMessage(
             APP_NAME_TOPIC,
             gitHubEnterpriseService.getGitHubApp(jwt).slug
         )
-        gitHubScanningService.scanGitHubResources()
     }
 }

src/test/kotlin/net/leanix/githubagent/scheduler/FullScanStatusSchedulerTest.kt

@@ -0,0 +1,34 @@
+package net.leanix.githubagent.scheduler
+
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.verify
+import net.leanix.githubagent.dto.FullScanStatus
+import net.leanix.githubagent.services.CachingService
+import net.leanix.githubagent.services.WebSocketService
+import org.junit.jupiter.api.Test
+
+class FullScanStatusSchedulerTest {
+
+    private val webSocketService: WebSocketService = mockk(relaxed = true)
+    private val cachingService: CachingService = mockk()
+    private val scheduler = FullScanStatusScheduler(webSocketService, cachingService)
+
+    @Test
+    fun `should send IN_PROGRESS status when runId is present`() {
+        every { cachingService.get("runId") } returns "someRunId"
+
+        scheduler.sendFullScanStatus()
+
+        verify { webSocketService.sendMessage("/fullScanStatus", FullScanStatus.IN_PROGRESS.name) }
+    }
+
+    @Test
+    fun `should send FINISHED status when runId is null`() {
+        every { cachingService.get("runId") } returns null
+
+        scheduler.sendFullScanStatus()
+
+        verify { webSocketService.sendMessage("/fullScanStatus", FullScanStatus.FINISHED.name) }
+    }
+}

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

@@ -34,10 +34,8 @@ class GitHubStartServiceTest {
         gitHubStartService = GitHubStartService(
             githubAuthenticationService,
             webSocketService,
-            gitHubScanningService,
             gitHubEnterpriseService,
             cachingService,
-            syncLogService
         )
 
         every { webSocketService.initSession() } returns Unit
@@ -64,6 +62,5 @@ class GitHubStartServiceTest {
         gitHubStartService.startAgent(ConnectionEstablishedEvent())
 
         verify { webSocketService.sendMessage(APP_NAME_TOPIC, gitHubAppName) }
-        verify { syncLogService.sendFullScanStart(any()) }
     }
 }