nicopico-dev · nicopico-dev · Oct 20, 2024 · Oct 20, 2024
diff --git a/src/main/kotlin/fr/nicopico/n2rss/controller/home/HomeController.kt b/src/main/kotlin/fr/nicopico/n2rss/controller/home/HomeController.kt
@@ -18,6 +18,7 @@
 package fr.nicopico.n2rss.controller.home
 
 import fr.nicopico.n2rss.config.N2RssProperties
+import fr.nicopico.n2rss.monitoring.MonitoringService
 import fr.nicopico.n2rss.newsletter.models.GroupedNewsletterInfo
 import fr.nicopico.n2rss.newsletter.models.toGroupedNewsletterInfo
 import fr.nicopico.n2rss.newsletter.service.NewsletterService
@@ -44,6 +45,7 @@ import java.net.URL
 class HomeController(
     private val newsletterService: NewsletterService,
     private val reCaptchaService: ReCaptchaService,
+    private val monitoringService: MonitoringService,
     private val feedProperties: N2RssProperties.FeedsProperties,
     private val recaptchaProperties: N2RssProperties.ReCaptchaProperties,
 ) {
@@ -100,7 +102,7 @@ class HomeController(
             val url = with(newsletterUrl) {
                 if (contains("://")) newsletterUrl else "https://$newsletterUrl"
             }.let { URL(it) }
-            newsletterService.saveNewsletterRequest(url)
+            monitoringService.notifyNewsletterRequest(url)
             ResponseEntity.ok().build()
         } else {
             ResponseEntity

diff --git a/src/main/kotlin/fr/nicopico/n2rss/monitoring/GithubMonitoringService.kt b/src/main/kotlin/fr/nicopico/n2rss/monitoring/GithubMonitoringService.kt
@@ -31,6 +31,7 @@ import kotlinx.datetime.format.char
 import org.slf4j.LoggerFactory
 import org.springframework.scheduling.annotation.Async
 import org.springframework.stereotype.Service
+import org.springframework.transaction.annotation.Transactional
 import java.net.URL
 
 @Service
@@ -103,7 +104,15 @@ class GithubMonitoringService(
     }
 
     @Async
-    override fun notifyRequest(uniqueUrl: URL) {
+    @Transactional
+    override fun notifyNewsletterRequest(newsletterUrl: URL) {
+        // Sanitize URL
+        val uniqueUrl = URL(
+            /* protocol = */ "https",
+            /* host = */ newsletterUrl.host,
+            /* port = */ newsletterUrl.port,
+            /* file = */ "",
+        )
         try {
             val today = clock.now().format(DateTimeComponents.Format {
                 year(Padding.ZERO)

diff --git a/src/main/kotlin/fr/nicopico/n2rss/monitoring/MonitoringService.kt b/src/main/kotlin/fr/nicopico/n2rss/monitoring/MonitoringService.kt
@@ -26,6 +26,12 @@ interface MonitoringService {
     fun notifyEmailClientError(error: Exception)
     @Async
     fun notifyEmailProcessingError(email: Email, error: Exception)
+
+    /**
+     * Saves a given newsletter request by sanitizing the provided URL and notifying the monitoring service.
+     *
+     * @param newsletterUrl The URL of the newsletter request to be saved.
+     */
     @Async
-    fun notifyRequest(uniqueUrl: URL)
+    fun notifyNewsletterRequest(newsletterUrl: URL)
 }
diff --git a/src/main/kotlin/fr/nicopico/n2rss/monitoring/NoOpMonitoringService.kt b/src/main/kotlin/fr/nicopico/n2rss/monitoring/NoOpMonitoringService.kt
@@ -31,7 +31,7 @@ class NoOpMonitoringService : MonitoringService {
         // No-op
     }
 
-    override fun notifyRequest(uniqueUrl: URL) {
+    override fun notifyNewsletterRequest(newsletterUrl: URL) {
         // No-op
     }
 }
diff --git a/src/main/kotlin/fr/nicopico/n2rss/newsletter/service/NewsletterService.kt b/src/main/kotlin/fr/nicopico/n2rss/newsletter/service/NewsletterService.kt
@@ -18,21 +18,17 @@
 package fr.nicopico.n2rss.newsletter.service
 
 import fr.nicopico.n2rss.mail.models.Email
-import fr.nicopico.n2rss.monitoring.MonitoringService
 import fr.nicopico.n2rss.newsletter.data.NewsletterRepository
 import fr.nicopico.n2rss.newsletter.handlers.NewsletterHandler
 import fr.nicopico.n2rss.newsletter.models.Newsletter
 import fr.nicopico.n2rss.newsletter.models.NewsletterInfo
 import org.slf4j.LoggerFactory
 import org.springframework.stereotype.Service
-import org.springframework.transaction.annotation.Transactional
-import java.net.URL
 
 @Service
 class NewsletterService(
     private val newsletterRepository: NewsletterRepository,
     private val publicationService: PublicationService,
-    private val monitoringService: MonitoringService,
 ) {
     /**
      * Retrieves information on all enabled newsletters.
@@ -85,23 +81,6 @@ class NewsletterService(
         }
     }
 
-    /**
-     * Saves a given newsletter request by sanitizing the provided URL and notifying the monitoring service.
-     *
-     * @param newsletterUrl The URL of the newsletter request to be saved.
-     */
-    @Transactional
-    fun saveNewsletterRequest(newsletterUrl: URL) {
-        // Sanitize URL
-        val uniqueUrl = URL(
-            /* protocol = */ "https",
-            /* host = */ newsletterUrl.host,
-            /* port = */ newsletterUrl.port,
-            /* file = */ "",
-        )
-        monitoringService.notifyRequest(uniqueUrl)
-    }
-
     companion object {
         private val LOG = LoggerFactory.getLogger(NewsletterService::class.java)
     }

diff --git a/src/test/kotlin/fr/nicopico/n2rss/controller/home/HomeControllerTest.kt b/src/test/kotlin/fr/nicopico/n2rss/controller/home/HomeControllerTest.kt
@@ -18,6 +18,7 @@
 package fr.nicopico.n2rss.controller.home
 
 import fr.nicopico.n2rss.config.N2RssProperties
+import fr.nicopico.n2rss.monitoring.MonitoringService
 import fr.nicopico.n2rss.newsletter.models.GroupedNewsletterInfo
 import fr.nicopico.n2rss.newsletter.models.NewsletterInfo
 import fr.nicopico.n2rss.newsletter.service.NewsletterService
@@ -47,6 +48,8 @@ class HomeControllerTest {
     @MockK
     private lateinit var reCaptchaService: ReCaptchaService
     @MockK
+    private lateinit var monitoringService: MonitoringService
+    @MockK
     private lateinit var feedsProperties: N2RssProperties.FeedsProperties
     @MockK(relaxed = true)
     private lateinit var reCaptchaProperties: N2RssProperties.ReCaptchaProperties
@@ -62,6 +65,7 @@ class HomeControllerTest {
         homeController = HomeController(
             newsletterService = newsletterService,
             reCaptchaService = reCaptchaService,
+            monitoringService = monitoringService,
             feedProperties = feedsProperties,
             recaptchaProperties = reCaptchaProperties
         )
@@ -246,14 +250,14 @@ class HomeControllerTest {
             // SETUP
             every { reCaptchaProperties.enabled } returns true
             every { reCaptchaProperties.secretKey } returns captchaSecretKey
-            every { newsletterService.saveNewsletterRequest(any()) } just Runs
+            every { monitoringService.notifyNewsletterRequest(any()) } just Runs
             every { reCaptchaService.isCaptchaValid(any(), any()) } returns true
 
             // WHEN
             val response = homeController.requestNewsletter(newsletterUrl, captchaResponse, userAgent)
 
             // THEN
-            verify { newsletterService.saveNewsletterRequest(URL(newsletterUrl)) }
+            verify { monitoringService.notifyNewsletterRequest(URL(newsletterUrl)) }
             verify { reCaptchaService.isCaptchaValid(captchaSecretKey, captchaResponse) }
             response.statusCode shouldBe HttpStatus.OK
         }
@@ -274,7 +278,7 @@ class HomeControllerTest {
             val response = homeController.requestNewsletter(newsletterUrl, captchaResponse, userAgent)
 
             // THEN
-            verify(exactly = 0) { newsletterService.saveNewsletterRequest(any()) }
+            verify(exactly = 0) { monitoringService.notifyNewsletterRequest(any()) }
             response.statusCode shouldBe HttpStatus.BAD_REQUEST
         }
 
@@ -285,13 +289,13 @@ class HomeControllerTest {
 
             // SETUP
             every { reCaptchaProperties.enabled } returns false
-            every { newsletterService.saveNewsletterRequest(any()) } just Runs
+            every { monitoringService.notifyNewsletterRequest(any()) } just Runs
 
             // WHEN
             val response = homeController.requestNewsletter(newsletterUrl, userAgent = userAgent)
 
             // THEN
-            verify(exactly = 1) { newsletterService.saveNewsletterRequest(any()) }
+            verify(exactly = 1) { monitoringService.notifyNewsletterRequest(any()) }
             verify(exactly = 0) { reCaptchaService.isCaptchaValid(any(), any()) }
             response.statusCode shouldBe HttpStatus.OK
         }
@@ -304,14 +308,14 @@ class HomeControllerTest {
 
             // SETUP
             every { reCaptchaProperties.enabled } returns false
-            every { newsletterService.saveNewsletterRequest(any()) } just Runs
+            every { monitoringService.notifyNewsletterRequest(any()) } just Runs
 
             // WHEN
             homeController.requestNewsletter(newsletterUrl, captchaResponse, userAgent)
 
             // THEN
             val slotUrl = slot<URL>()
-            verify { newsletterService.saveNewsletterRequest(capture(slotUrl)) }
+            verify { monitoringService.notifyNewsletterRequest(capture(slotUrl)) }
             slotUrl.captured.toString() shouldBe "https://www.google.com"
         }
 

diff --git a/src/test/kotlin/fr/nicopico/n2rss/monitoring/GithubMonitoringServiceTest.kt b/src/test/kotlin/fr/nicopico/n2rss/monitoring/GithubMonitoringServiceTest.kt
@@ -270,9 +270,9 @@ class GithubMonitoringServiceTest {
     }
     //endregion
 
-    //region notifyRequest
+    //region notifyNewsletterRequest
     @Test
-    fun `notifyRequest should create a new GitHub issue and save it to the repository`() {
+    fun `notifyNewsletterRequest should create a new GitHub issue and save it to the repository`() {
         // GIVEN
         val newsletterUrl = URL("https://www.androidweekly.net")
         val issueId = IssueId(Random.nextInt())
@@ -285,7 +285,7 @@ class GithubMonitoringServiceTest {
         }
 
         // WHEN
-        monitoringService.notifyRequest(newsletterUrl)
+        monitoringService.notifyNewsletterRequest(newsletterUrl)
 
         // THEN
         val bodySlot = slot<String>()
@@ -313,7 +313,7 @@ class GithubMonitoringServiceTest {
     }
 
     @Test
-    fun `notifyRequest should add a comment to an existing GitHub issue`() {
+    fun `notifyNewsletterRequest should add a comment to an existing GitHub issue`() {
         // GIVEN
         val newsletterUrl = URL("https://www.androidweekly.net")
         val issueId = IssueId(Random.nextInt())
@@ -327,7 +327,7 @@ class GithubMonitoringServiceTest {
         every { client.addCommentToIssue(any(), any()) } just Runs
 
         // WHEN
-        monitoringService.notifyRequest(newsletterUrl)
+        monitoringService.notifyNewsletterRequest(newsletterUrl)
 
         // THEN
         verifySequence {
@@ -338,18 +338,47 @@ class GithubMonitoringServiceTest {
     }
 
     @Test
-    fun `notifyRequest should not throw if a GithubException occurs`() {
+    fun `notifyNewsletterRequest should not throw if a GithubException occurs`() {
         // SETUP
         every { repository.findNewsletterRequest(any()) } returns null
         every { client.createIssue(any(), any(), any()) } throws GithubException("Some GitHub error !")
 
         // WHEN
         shouldNotThrowAny {
-            monitoringService.notifyRequest(URL("https://github.com/test"))
+            monitoringService.notifyNewsletterRequest(URL("https://github.com/test"))
         }
 
         // THEN
         verify(exactly = 0) { repository.save(any<GithubIssueData.NewsletterRequest>()) }
     }
+
+    @Test
+    fun `notifyNewsletterRequest should unify the newsletter url`() {
+        // GIVEN
+        @Suppress("HttpUrlsUsage")
+        val newsletterUrl = URL("http://www.nicopico.com/test/")
+        val uniqueUrl = URL("https://www.nicopico.com")
+        val issueId = IssueId(Random.nextInt())
+
+        // SETUP
+        every { repository.findNewsletterRequest(any()) } returns null
+        every { client.createIssue(any(), any(), any()) } returns issueId
+        every { repository.save(any<GithubIssueData.NewsletterRequest>()) } answers {
+            firstArg<GithubIssueData.NewsletterRequest>()
+        }
+
+        // WHEN
+        monitoringService.notifyNewsletterRequest(newsletterUrl)
+
+        // THEN
+        verify {
+            repository.save(
+                match<GithubIssueData.NewsletterRequest> {
+                    it.issueId == issueId
+                        && it.newsletterUrl.toURI() == uniqueUrl.toURI()
+                }
+            )
+        }
+    }
     //endregion
 }