[#35] restdocs도입

build.gradle

@@ -3,6 +3,11 @@ plugins {
     id 'groovy'
     id 'org.springframework.boot' version '3.2.1'
     id 'io.spring.dependency-management' version '1.1.4'
+    id "org.asciidoctor.jvm.convert" version "3.3.2"
+}
+
+configurations {
+    asciidoctorExt
 }
 
 group = 'com'
@@ -38,6 +43,8 @@ dependencies {
     testImplementation 'org.springframework.security:spring-security-test'
     implementation 'org.springframework.session:spring-session-data-redis'
     testImplementation 'org.springframework.batch:spring-batch-test'
+    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
+    asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor'
 
     // 구글 지오코딩 api
     implementation 'com.google.maps:google-maps-services:2.2.0'
@@ -52,6 +59,43 @@ dependencies {
     testAnnotationProcessor 'org.projectlombok:lombok'
 }
 
+ext {
+    snippetsDir = file('build/generated-snippets')
+}
+
+test {
+    outputs.dir snippetsDir
+}
+
+bootJar {
+    dependsOn asciidoctor
+    from ("${asciidoctor.outputDir}/html5") {
+        into 'static/docs'
+    }
+}
+
 tasks.named('test') {
     useJUnitPlatform()
 }
+
+
+asciidoctor {
+    inputs.dir snippetsDir
+    configurations 'asciidoctorExt'
+    dependsOn test
+    baseDirFollowsSourceFile()
+}
+
+asciidoctor.doFirst {
+    delete file('src/main/resources/static/docs')
+}
+
+task copyDocument(type: Copy) {
+    dependsOn asciidoctor
+    from file("build/docs/asciidoc")
+    into file("src/main/resources/static/docs")
+}
+
+build {
+    dependsOn copyDocument
+}

src/docs/asciidoc/CancelLike.adoc

@@ -0,0 +1,2 @@
+== Like a feed
+operation::like-controller-test/Cancel like[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/CreateADiary.adoc

@@ -0,0 +1,2 @@
+== Create a diary
+operation::diary-controller-test/Create a diary[snippets="http-request,http-response"]

src/docs/asciidoc/CreateChildComment.adoc

@@ -0,0 +1,2 @@
+== Create a nested comment
+operation::comment-controller-test/Create child comment[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/CreateComment.adoc

@@ -0,0 +1,2 @@
+== Create a comment
+operation::comment-controller-test/Create comment[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/CreateFeed.adoc

@@ -0,0 +1,2 @@
+== Create a feed
+operation::feed-controller-test/Create Feed[snippets="http-request,http-response"]

src/docs/asciidoc/DeleteADiary.adoc

@@ -0,0 +1,2 @@
+== Delete a diary
+operation::diary-controller-test/Delete a diary[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/DeleteAFeed.adoc

@@ -0,0 +1,2 @@
+== Get a feed
+operation::feed-controller-test/Delete a feed[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/DeleteComments.adoc

@@ -0,0 +1,2 @@
+== Delete a comment
+operation::comment-controller-test/Delete a comment[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/GetAFeed.adoc

@@ -0,0 +1,2 @@
+== Get a feed
+operation::feed-controller-test/Get a feed[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/GetChildComments.adoc

@@ -0,0 +1,2 @@
+== Get child comments
+operation::comment-controller-test/Get child comments[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/GetComments.adoc

@@ -0,0 +1,2 @@
+== Get comments
+operation::comment-controller-test/Get comments[snippets="http-request,http-response,path-parameters,query-parameters"]

src/docs/asciidoc/GetDailyHotFeeds.adoc

@@ -0,0 +1,2 @@
+== Get daily hot feeds
+operation::ranking-controller-test/get daily-hot-feeds[snippets="http-request,http-response"]

src/docs/asciidoc/GetDiariesOfAMember.adoc

@@ -0,0 +1,2 @@
+== Get diaries of a member
+operation::diary-controller-test/Get diaries of a member[snippets="http-request,http-response,path-parameters,query-parameters"]

src/docs/asciidoc/GetFeedsByTag.adoc

@@ -0,0 +1,2 @@
+== Get feeds by tag
+operation::feed-controller-test/Get feeds by tag[snippets="http-request,http-response,path-parameters,query-parameters"]

src/docs/asciidoc/GetFeedsOfMember.adoc

@@ -0,0 +1,2 @@
+== Get feeds of member
+operation::feed-controller-test/Get feeds of member[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/GetMonthlyHotFeeds.adoc

@@ -0,0 +1,2 @@
+== Get monthly hot feeds
+operation::ranking-controller-test/get monthly-hot-feeds[snippets="http-request,http-response"]

src/docs/asciidoc/GetPopularAbroadSpots.adoc

@@ -0,0 +1,2 @@
+== Get popular abroad spots
+operation::ranking-controller-test/Get popular abroad spots[snippets="http-request,http-response"]

src/docs/asciidoc/GetPopularDomesticSpots.adoc

@@ -0,0 +1,2 @@
+== Get popular domestic spots
+operation::ranking-controller-test/Get popular domestic spots[snippets="http-request,http-response"]

src/docs/asciidoc/GetWeeklyHotFeeds.adoc

@@ -0,0 +1,2 @@
+== Get weekly hot feeds
+operation::ranking-controller-test/get weekly-hot-feeds[snippets="http-request,http-response"]

src/docs/asciidoc/JoinMember.adoc

@@ -0,0 +1,2 @@
+== JoinMember
+operation::member-controller-test/JoinMember[snippets="http-request,http-response"]

src/docs/asciidoc/LikeAFeed.adoc

@@ -0,0 +1,2 @@
+== Like a feed
+operation::like-controller-test/Like a feed[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/UpdateAFeed.adoc

@@ -0,0 +1,2 @@
+== Get a feed
+operation::feed-controller-test/Update a feed[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/index.adoc

@@ -0,0 +1,30 @@
+= Stoury API docs
+:doctype: book
+:source-highlighter: highlightjs
+:toc: left
+:toclevels: 2
+:seclinks:
+
+include::JoinMember.adoc[]
+include::CreateFeed.adoc[]
+include::GetAFeed.adoc[]
+include::GetFeedsByTag.adoc[]
+include::GetFeedsOfMember.adoc[]
+include::UpdateAFeed.adoc[]
+include::DeleteAFeed.adoc[]
+include::LikeAFeed.adoc[]
+include::CancelLike.adoc[]
+include::CreateComment.adoc[]
+include::CreateChildComment.adoc[]
+include::GetComments.adoc[]
+include::GetChildComments.adoc[]
+include::DeleteComments.adoc[]
+include::CreateADiary.adoc[]
+include::GetDiariesOfAMember.adoc[]
+include::DeleteADiary.adoc[]
+include::GetPopularDomesticSpots.adoc[]
+include::GetPopularAbroadSpots.adoc[]
+include::GetDailyHotFeeds.adoc[]
+include::GetWeeklyHotFeeds.adoc[]
+include::GetMonthlyHotFeeds.adoc[]
+

src/main/java/com/stoury/batch/BatchHotFeedsConfig.java

@@ -0,0 +1,133 @@
+package com.stoury.batch;
+
+import com.stoury.domain.Feed;
+import com.stoury.dto.feed.SimpleFeedResponse;
+import com.stoury.repository.LikeRepository;
+import com.stoury.repository.RankingRepository;
+import jakarta.persistence.EntityManagerFactory;
+import lombok.RequiredArgsConstructor;
+import org.springframework.batch.core.Job;
+import org.springframework.batch.core.Step;
+import org.springframework.batch.core.job.builder.JobBuilder;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.core.step.builder.StepBuilder;
+import org.springframework.batch.item.ItemProcessor;
+import org.springframework.batch.item.ItemWriter;
+import org.springframework.batch.item.database.JpaPagingItemReader;
+import org.springframework.batch.item.database.builder.JpaPagingItemReaderBuilder;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.util.Pair;
+import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
+import org.springframework.transaction.PlatformTransactionManager;
+
+import java.time.temporal.ChronoUnit;
+
+@Configuration
+@RequiredArgsConstructor
+@ConditionalOnExpression("'${spring.batch.job.names}'.contains('jobHotFeeds')")
+public class BatchHotFeedsConfig {
+    private final EntityManagerFactory entityManagerFactory;
+
+    private final RankingRepository rankingRepository;
+
+    @Bean
+    public Job jobDailyFeed(JobRepository jobRepository, PlatformTransactionManager tm,
+                            ThreadPoolTaskExecutor taskExecutor, LikeRepository likeRepository) {
+        return new JobBuilder("jobDailyFeed", jobRepository)
+                .start(stepDailyFeed(jobRepository, tm, taskExecutor, likeRepository))
+                .build();
+    }
+
+    @Bean
+    public Job jobWeeklyFeed(JobRepository jobRepository, PlatformTransactionManager tm,
+                             ThreadPoolTaskExecutor taskExecutor, LikeRepository likeRepository) {
+        return new JobBuilder("jobWeeklyFeed", jobRepository)
+                .start(stepWeeklyFeed(jobRepository, tm, taskExecutor, likeRepository))
+                .build();
+    }
+
+    @Bean
+    public Job jobMonthlyFeed(JobRepository jobRepository, PlatformTransactionManager tm,
+                              ThreadPoolTaskExecutor taskExecutor, LikeRepository likeRepository) {
+        return new JobBuilder("jobMonthlyFeed", jobRepository)
+                .start(stepMonthlyFeed(jobRepository, tm, taskExecutor, likeRepository))
+                .build();
+    }
+
+    @Bean
+    public Step stepDailyFeed(JobRepository jobRepository, PlatformTransactionManager tm,
+                              ThreadPoolTaskExecutor taskExecutor, LikeRepository likeRepository) {
+        return new StepBuilder("stepDailyFeed", jobRepository)
+                .<Feed, Pair<SimpleFeedResponse, Long>>chunk(100, tm)
+                .reader(feedReader())
+                .processor(feedProcessor(likeRepository, ChronoUnit.DAYS))
+                .writer(feedWriter(ChronoUnit.DAYS))
+                .taskExecutor(taskExecutor)
+                .build();
+    }
+
+    @Bean
+    public Step stepWeeklyFeed(JobRepository jobRepository, PlatformTransactionManager tm,
+                               ThreadPoolTaskExecutor taskExecutor, LikeRepository likeRepository) {
+        return new StepBuilder("stepWeeklyFeed", jobRepository)
+                .<Feed, Pair<SimpleFeedResponse, Long>>chunk(100, tm)
+                .reader(feedReader())
+                .processor(feedProcessor(likeRepository, ChronoUnit.WEEKS))
+                .writer(feedWriter(ChronoUnit.WEEKS))
+                .taskExecutor(taskExecutor)
+                .build();
+    }
+
+    @Bean
+    public Step stepMonthlyFeed(JobRepository jobRepository, PlatformTransactionManager tm,
+                                ThreadPoolTaskExecutor taskExecutor, LikeRepository likeRepository) {
+        return new StepBuilder("stepMonthlyFeed", jobRepository)
+                .<Feed, Pair<SimpleFeedResponse, Long>>chunk(100, tm)
+                .reader(feedReader())
+                .processor(feedProcessor(likeRepository, ChronoUnit.MONTHS))
+                .writer(feedWriter(ChronoUnit.MONTHS))
+                .taskExecutor(taskExecutor)
+                .build();
+    }
+
+
+    public JpaPagingItemReader<Feed> feedReader() {
+        return new JpaPagingItemReaderBuilder<Feed>()
+                .name("feedReader")
+                .pageSize(100)
+                .entityManagerFactory(entityManagerFactory)
+                .queryString("select f from Feed f")
+                .build();
+    }
+
+    public ItemProcessor<Feed, Pair<SimpleFeedResponse, Long>> feedProcessor(LikeRepository likeRepository, ChronoUnit chronoUnit) {
+        return feed -> {
+            Long feedId = feed.getId();
+
+            if (!likeRepository.existsByFeedId(feedId.toString())) {
+                return null;
+            }
+            long currentLikes = likeRepository.getCountByFeedId(feedId.toString());
+            long prevLikes = likeRepository.getCountSnapshotByFeed(feedId.toString(), chronoUnit);
+
+            SimpleFeedResponse simpleFeed = SimpleFeedResponse.from(feed);
+
+            return Pair.of(simpleFeed, currentLikes - prevLikes);
+        };
+    }
+
+    public ItemWriter<Pair<SimpleFeedResponse, Long>> feedWriter(ChronoUnit chronoUnit) {
+        return list -> {
+            for (Pair<SimpleFeedResponse, Long> pair : list) {
+                SimpleFeedResponse rawSimpleFeed = pair.getFirst();
+                Long likeIncrease = pair.getSecond();
+
+                if (likeIncrease > 0) {
+                    rankingRepository.saveHotFeed(rawSimpleFeed, likeIncrease, chronoUnit);
+                }
+            }
+        };
+    }
+}

src/main/java/com/stoury/config/batch/BatchConfig.java → src/main/java/com/stoury/batch/BatchPopularSpotsConfig.java

@@ -1,8 +1,8 @@
-package com.stoury.config.batch;
+package com.stoury.batch;
 
 import com.stoury.repository.FeedRepository;
 import com.stoury.repository.RankingRepository;
-import com.stoury.utils.CacheKeys;
+import com.stoury.utils.cachekeys.PopularSpotsKey;
 import lombok.RequiredArgsConstructor;
 import org.springframework.batch.core.Job;
 import org.springframework.batch.core.Step;
@@ -12,30 +12,31 @@
 import org.springframework.batch.core.repository.JobRepository;
 import org.springframework.batch.core.step.builder.StepBuilder;
 import org.springframework.batch.repeat.RepeatStatus;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Pageable;
-import org.springframework.scheduling.annotation.EnableScheduling;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
 import org.springframework.transaction.PlatformTransactionManager;
 
 import java.util.List;
 
 @Configuration
-@EnableScheduling
 @RequiredArgsConstructor
-public class BatchConfig {
+@ConditionalOnExpression("'${spring.batch.job.names}'.contains('jobPopularSpots')")
+public class BatchPopularSpotsConfig {
     Pageable pageable = PageRequest.of(0, 10);
     private final FeedRepository feedRepository;
     private final RankingRepository rankingRepository;
 
+
     @Bean
     public Step stepUpdatePopularDomesticCities(JobRepository jobRepository, PlatformTransactionManager tm) {
         return new StepBuilder("stepUpdatePopularDomesticCities", jobRepository)
                 .tasklet((contribution, chunkContext) -> {
                     List<String> rankedDomesticCities = feedRepository.findTop10CitiesInKorea(pageable);
-                    rankingRepository.update(CacheKeys.POPULAR_DOMESTIC_SPOTS, rankedDomesticCities);
+                    rankingRepository.update(PopularSpotsKey.POPULAR_DOMESTIC_SPOTS, rankedDomesticCities);
                     return RepeatStatus.FINISHED;
                 }, tm)
                 .build();
@@ -46,7 +47,7 @@ public Step stepUpdatePopularAbroadCities(JobRepository jobRepository, PlatformT
         return new StepBuilder("stepUpdatePopularAbroadCities", jobRepository)
                 .tasklet((contribution, chunkContext) -> {
                     List<String> rankedCountries = feedRepository.findTop10CountriesNotKorea(pageable);
-                    rankingRepository.update(CacheKeys.POPULAR_ABROAD_SPOTS, rankedCountries);
+                    rankingRepository.update(PopularSpotsKey.POPULAR_ABROAD_SPOTS, rankedCountries);
                     return RepeatStatus.FINISHED;
                 }, tm)
                 .build();

src/main/java/com/stoury/config/ContextConfiguration.java

@@ -23,11 +23,9 @@ public PasswordEncoder passwordEncoder() {
     public GeoApiContext geoApiContext() {
         return new GeoApiContext.Builder()
                 .apiKey(apiKey)
-                .connectTimeout(5, TimeUnit.SECONDS)
+                .connectTimeout(2, TimeUnit.SECONDS)
                 .readTimeout(3, TimeUnit.SECONDS)
-                .retryTimeout(2, TimeUnit.SECONDS)
-                .writeTimeout(5, TimeUnit.SECONDS)
-                .maxRetries(5)
+                .maxRetries(3)
                 .build();
     }
 }