#19 - CodexiaModule: transforming sendReview to saveReview && ext…

…racting SendReviews cron (#38)
iakunin · Apr 17, 2020 · c743679 · c743679 · 0pdd · Apr 17, 2020
1 parent 95ad97f
commit c743679
Show file tree

Hide file tree

Showing 28 changed files with 497 additions and 101 deletions.
diff --git a/src/main/java/dev/iakunin/codexiabot/bot/FoundOnHackernews.java b/src/main/java/dev/iakunin/codexiabot/bot/FoundOnHackernews.java
@@ -93,7 +93,7 @@ public void run() {
             )
             .forEach(
                 review -> {
-                    this.codexiaModule.sendReview(review);
+                    this.codexiaModule.saveReview(review);
                     this.codexiaModule.sendMeta(
                         review.getCodexiaProject(),
                         "hacker-news-id",

diff --git a/src/main/java/dev/iakunin/codexiabot/bot/FoundOnReddit.java b/src/main/java/dev/iakunin/codexiabot/bot/FoundOnReddit.java
@@ -77,7 +77,7 @@ public void run() {
             )
             .forEach(
                 review -> {
-                    this.codexiaModule.sendReview(review);
+                    this.codexiaModule.saveReview(review);
                     this.codexiaModule.sendMeta(
                         review.getCodexiaProject(),
                         "reddit-id",

diff --git a/src/main/java/dev/iakunin/codexiabot/bot/StarsUp.java b/src/main/java/dev/iakunin/codexiabot/bot/StarsUp.java
@@ -81,7 +81,7 @@ protected void processStatList(Deque<GithubRepoStat> deque) {
                 .setGithubRepo(deque.getLast().getGithubRepo())
                 .setGithubRepoStat(deque.getLast())
         );
-        this.codexiaModule.sendReview(review);
+        this.codexiaModule.saveReview(review);
         this.codexiaModule.sendMeta(
             review.getCodexiaProject(),
             "stars-count",

diff --git a/src/main/java/dev/iakunin/codexiabot/codexia/CodexiaModule.java b/src/main/java/dev/iakunin/codexiabot/codexia/CodexiaModule.java
@@ -8,14 +8,11 @@
 
 public interface CodexiaModule {
 
-    // @todo #6 split codexiaModule.sendReview() to codexiaModule.createReview() and codexiaModule.sendReview()
-    //  - codexiaModule.createReview() - just a saving to DB.
-    //  - codexiaModule.sendReview() - real sending review to Codexia api.
-    //  - codexiaModule.sendReview() must be used ONLY inside a cron-job.
-    //  - In other code there should be only a codexiaModule.createReview() calls.
-    //  - All the codexiaModule.createReview() calls MUST be inside a transaction/
-    void sendReview(CodexiaReview review);
+    // @todo #19 All the codexiaModule.createReview() calls MUST be inside a transaction
+    void saveReview(CodexiaReview review);
 
+    // @todo #19 sending meta should also be asynchronous (via cron)
+    //  here should be only a saving Meta (as saving Review)
     void sendMeta(CodexiaProject codexiaProject, String metaKey, String metaValue);
 
     Optional<CodexiaProject> findCodexiaProject(GithubRepo repo);

diff --git a/src/main/java/dev/iakunin/codexiabot/codexia/CodexiaModuleImpl.java b/src/main/java/dev/iakunin/codexiabot/codexia/CodexiaModuleImpl.java
@@ -2,83 +2,35 @@
 
 import dev.iakunin.codexiabot.codexia.entity.CodexiaProject;
 import dev.iakunin.codexiabot.codexia.entity.CodexiaReview;
-import dev.iakunin.codexiabot.codexia.entity.CodexiaReviewNotification;
 import dev.iakunin.codexiabot.codexia.repository.CodexiaProjectRepository;
-import dev.iakunin.codexiabot.codexia.repository.CodexiaReviewNotificationRepository;
 import dev.iakunin.codexiabot.codexia.repository.CodexiaReviewRepository;
 import dev.iakunin.codexiabot.codexia.sdk.CodexiaClient;
 import dev.iakunin.codexiabot.github.GithubModule;
 import dev.iakunin.codexiabot.github.entity.GithubRepo;
-import feign.FeignException;
 import java.util.List;
 import java.util.Optional;
 import lombok.AllArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Service;
 
 @Service
 @Slf4j
 @AllArgsConstructor(onConstructor_={@Autowired})
 public final class CodexiaModuleImpl implements CodexiaModule {
 
-    private static final int REVIEW_ALREADY_EXISTS_STATUS = 404;
-
     private final CodexiaProjectRepository codexiaProjectRepository;
 
     private final CodexiaReviewRepository codexiaReviewRepository;
 
-    private final CodexiaReviewNotificationRepository codexiaReviewNotificationRepository;
-
     private final CodexiaClient codexiaClient;
 
     private final GithubModule githubModule;
 
     @Override
-    public void sendReview(CodexiaReview review) {
-        log.info("Got a review: {}", review);
-
-        final CodexiaReview savedReview = this.codexiaReviewRepository.save(review);
-
-        final CodexiaReviewNotification savedNotification = this.codexiaReviewNotificationRepository.save(
-            new CodexiaReviewNotification()
-                .setCodexiaReview(savedReview)
-                .setStatus(CodexiaReviewNotification.Status.NEW)
-        );
-
-        final ResponseEntity<String> response;
-        try {
-            response = this.codexiaClient.createReview(
-                savedReview.getCodexiaProject().getExternalId(),
-                savedReview.getText(),
-                savedReview.getUuid().toString()
-            );
-        } catch (FeignException e) {
-            log.warn(
-                "Exception occurred during review creation in Codexia; externalId='{}'",
-                review.getCodexiaProject().getExternalId(),
-                e
-            );
-            this.codexiaReviewNotificationRepository.save(
-                savedNotification
-                    .setStatus(
-                        e.status() == REVIEW_ALREADY_EXISTS_STATUS
-                            ? CodexiaReviewNotification.Status.SUCCESS
-                            : CodexiaReviewNotification.Status.ERROR
-                    )
-                    .setResponseCode(e.status())
-                    .setResponse(e.content() != null ? e.contentUTF8() : "")
-            );
-            return;
-        }
-
-        this.codexiaReviewNotificationRepository.save(
-            savedNotification
-                .setStatus(CodexiaReviewNotification.Status.SUCCESS)
-                .setResponseCode(response.getStatusCodeValue())
-                .setResponse(response.toString())
-        );
+    public void saveReview(CodexiaReview review) {
+        log.info("Saving a review: {}", review);
+        this.codexiaReviewRepository.save(review);
     }
 
     @Override

diff --git a/src/main/java/dev/iakunin/codexiabot/codexia/cron/ResendErroneousReviews.java b/src/main/java/dev/iakunin/codexiabot/codexia/cron/ResendErroneousReviews.java
@@ -24,7 +24,7 @@ public void run() {
 
         this.codexiaReviewNotificationRepository.findAllByLastStatus(CodexiaReviewNotification.Status.ERROR)
             .forEach(
-                reviewNotification -> this.codexiaModule.sendReview(reviewNotification.getCodexiaReview())
+                reviewNotification -> this.codexiaModule.saveReview(reviewNotification.getCodexiaReview())
             );
 
         log.info("Exiting from {}", this.getClass().getName());

diff --git a/src/main/java/dev/iakunin/codexiabot/codexia/cron/SendReviews.java b/src/main/java/dev/iakunin/codexiabot/codexia/cron/SendReviews.java
@@ -0,0 +1,97 @@
+package dev.iakunin.codexiabot.codexia.cron;
+
+import dev.iakunin.codexiabot.codexia.entity.CodexiaReview;
+import dev.iakunin.codexiabot.codexia.entity.CodexiaReviewNotification;
+import dev.iakunin.codexiabot.codexia.repository.CodexiaReviewNotificationRepository;
+import dev.iakunin.codexiabot.codexia.repository.CodexiaReviewRepository;
+import dev.iakunin.codexiabot.codexia.sdk.CodexiaClient;
+import feign.FeignException;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.ResponseEntity;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+@Slf4j
+@Component
+@AllArgsConstructor(onConstructor_={@Autowired})
+public final class SendReviews {
+
+    private static final int REVIEW_ALREADY_EXISTS_STATUS = 404;
+
+    private final CodexiaReviewRepository codexiaReviewRepository;
+
+    private final CodexiaReviewNotificationRepository codexiaReviewNotificationRepository;
+
+    private final CodexiaClient codexiaClient;
+
+    @Scheduled(cron="${app.cron.codexia.send-reviews:-}")
+    public void run() {
+        log.info("Running {}", this.getClass().getName());
+
+        this.codexiaReviewRepository
+            .findAllWithoutNotifications()
+            .forEach(this::process);
+
+        log.info("Exiting from {}", this.getClass().getName());
+    }
+
+    private void process(CodexiaReview review) {
+        final CodexiaReviewNotification savedNotification = this.saveNewNotification(review);
+        final ResponseEntity<String> response;
+        try {
+            response = this.codexiaClient.createReview(
+                review.getCodexiaProject().getExternalId(),
+                review.getText(),
+                review.getUuid().toString()
+            );
+        } catch (FeignException e) {
+            log.warn(
+                "Exception occurred during review creation in Codexia; externalId='{}'",
+                review.getCodexiaProject().getExternalId(),
+                e
+            );
+            this.saveExceptionalNotification(savedNotification, e);
+            return;
+        }
+        this.saveSuccessfulNotification(savedNotification, response);
+    }
+
+    private CodexiaReviewNotification saveNewNotification(CodexiaReview review) {
+        return this.codexiaReviewNotificationRepository.save(
+            new CodexiaReviewNotification()
+                .setCodexiaReview(review)
+                .setStatus(CodexiaReviewNotification.Status.NEW)
+        );
+    }
+
+    private void saveSuccessfulNotification(
+        CodexiaReviewNotification notification,
+        ResponseEntity<String> response
+    ) {
+        this.codexiaReviewNotificationRepository.save(
+            notification
+                .setStatus(CodexiaReviewNotification.Status.SUCCESS)
+                .setResponseCode(response.getStatusCodeValue())
+                .setResponse(response.toString())
+        );
+    }
+
+    private void saveExceptionalNotification(
+        CodexiaReviewNotification notification,
+        FeignException e
+    ) {
+        this.codexiaReviewNotificationRepository.save(
+            notification
+                .setStatus(
+                    // @todo #19 rewrite via custom Feign exceptions
+                    e.status() == REVIEW_ALREADY_EXISTS_STATUS
+                        ? CodexiaReviewNotification.Status.SUCCESS
+                        : CodexiaReviewNotification.Status.ERROR
+                )
+                .setResponseCode(e.status())
+                .setResponse(e.content() != null ? e.contentUTF8() : "")
+        );
+    }
+}
diff --git a/src/main/java/dev/iakunin/codexiabot/codexia/repository/CodexiaReviewRepository.java b/src/main/java/dev/iakunin/codexiabot/codexia/repository/CodexiaReviewRepository.java
@@ -4,10 +4,21 @@
 import dev.iakunin.codexiabot.codexia.entity.CodexiaReview;
 import java.util.List;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
 
 public interface CodexiaReviewRepository extends JpaRepository<CodexiaReview, Long> {
 
     boolean existsByCodexiaProjectAndAuthorAndReason(CodexiaProject codexiaProject, String author, String reason);
 
     List<CodexiaReview> findAllByCodexiaProjectAndAuthorOrderByIdAsc(CodexiaProject codexiaProject, String author);
+
+    @Query(
+        "select cr " +
+        "from CodexiaReview cr " +
+        "left join CodexiaReviewNotification crn " +
+        "   on (cr = crn.codexiaReview) " +
+        "where crn.id is null " +
+        "order by cr.id asc"
+    )
+    List<CodexiaReview> findAllWithoutNotifications();
 }
diff --git a/src/main/java/dev/iakunin/codexiabot/github/cron/stat/Github.java b/src/main/java/dev/iakunin/codexiabot/github/cron/stat/Github.java
@@ -22,8 +22,7 @@ public void run() {
 
         this.githubModule
             .findAllInCodexia()
-            .forEach(this::updateStat)
-        ;
+            .forEach(this::updateStat);
 
         log.info("Exiting from {}", this.getClass().getName());
     }

diff --git a/src/main/resources/META-INF/spring-configuration-metadata.json b/src/main/resources/META-INF/spring-configuration-metadata.json
@@ -55,6 +55,11 @@
       "type": "java.lang.String",
       "description": "Cron expression for codexia.missing-filler."
     },
+    {
+      "name": "app.cron.codexia.send-reviews",
+      "type": "java.lang.String",
+      "description": "Cron expression for codexia.send-reviews."
+    },
     {
       "name": "app.cron.codexia.resend-erroneous-reviews",
       "type": "java.lang.String",

diff --git a/src/main/resources/application-prod.properties b/src/main/resources/application-prod.properties
@@ -4,6 +4,7 @@ app.cron.bot.stars-up=0 30 * * * *
 
 app.cron.codexia.codexia-parser=45 * * * * *
 app.cron.codexia.missing-filler=0 0 0 * * *
+app.cron.codexia.send-reviews=55 * * * * *
 app.cron.codexia.resend-erroneous-reviews=25 * * * * *
 app.cron.codexia.projects-health-check=35 * * * * *