[volume-9] Product Ranking with Redis

.github/workflows/main.yml

@@ -0,0 +1,13 @@
+name: PR Agent
+on:
+  pull_request:
+    types: [opened, synchronize]
+jobs:
+  pr_agent_job:
+    runs-on: ubuntu-latest
+    steps:
+      - name: PR Agent action step
+        uses: Codium-ai/pr-agent@main
+        env:
+          OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
+          GITHUB_TOKEN: ${{ secrets.G_TOKEN }}

README.md

@@ -27,6 +27,7 @@ docker-compose -f ./docker/monitoring-compose.yml up
 Root
 ├── apps ( spring-applications )
 │   ├── 📦 commerce-api
+│   ├── 📦 commerce-batch
 │   └── 📦 commerce-streamer
 ├── modules ( reusable-configurations )
 │   ├── 📦 jpa

apps/commerce-api/src/main/java/com/loopers/application/product/ProductFacade.java

@@ -17,6 +17,8 @@
 import org.springframework.transaction.annotation.Transactional;
 
 import java.math.BigDecimal;
+import java.time.LocalDate;
+import java.time.format.DateTimeFormatter;
 import java.util.List;
 
 @Component
@@ -25,6 +27,7 @@ public class ProductFacade {
     private final ProductRepository productRepository;
     private final BrandRepository brandRepository;
     private final OutboxRepository outBoxRepository;
+    private final RankingRedisReader rankingRedisReader;
 
     @Transactional
     public ProductInfo registerProduct(ProductV1Dto.ProductRequest request) {
@@ -52,7 +55,7 @@ public List<ProductInfo> findAllProducts() {
 
     @Transactional
     @Cacheable(value = "product", key = "#id")
-    public ProductInfo findProductById(Long id) {
+    public ProductRankingInfo findProductById(Long id) {
         Product product = productRepository.findById(id).orElseThrow(
                 () -> new CoreException(ErrorType.NOT_FOUND, "찾고자 하는 상품이 존재하지 않습니다.")
         );
@@ -65,7 +68,14 @@ public ProductInfo findProductById(Long id) {
 
         outBoxRepository.save(outBoxEvent);
 
-        return ProductInfo.from(product);
+        RankingInfo ranking = null;
+
+        try {
+            String date = LocalDate.now().format(DateTimeFormatter.BASIC_ISO_DATE);
+            ranking = rankingRedisReader.getDailyRanking(date, product.getId());
+        } catch (Exception ignored) {}
+
+        return ProductRankingInfo.from(product, ranking);
     }
 
     @Transactional(readOnly = true)

apps/commerce-api/src/main/java/com/loopers/application/product/ProductRankingInfo.java

@@ -0,0 +1,20 @@
+package com.loopers.application.product;
+
+import com.loopers.domain.product.Product;
+
+import java.math.BigDecimal;
+
+public record ProductRankingInfo(Long id, Long brandId, String name, BigDecimal price, int stock, int likeCount, int rank, double score) {
+    public static ProductRankingInfo from(Product product, RankingInfo ranking) {
+        return new ProductRankingInfo(
+                product.getId(),
+                product.getBrandId(),
+                product.getName(),
+                product.getPrice(),
+                product.getStock(),
+                product.getLikeCount(),
+                ranking.rank(),
+                ranking.score()
+        );
+    }
+}

apps/commerce-api/src/main/java/com/loopers/application/product/RankingInfo.java

@@ -0,0 +1,9 @@
+package com.loopers.application.product;
+
+public record RankingInfo(
+        String date,
+        double score,
+        int rank,
+        Long total
+) {
+}

apps/commerce-api/src/main/java/com/loopers/application/product/RankingRedisReader.java

@@ -0,0 +1,40 @@
+package com.loopers.application.product;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.redis.core.RedisCallback;
+import org.springframework.data.redis.core.StringRedisTemplate;
+import org.springframework.data.redis.serializer.RedisSerializer;
+import org.springframework.stereotype.Component;
+
+import java.util.List;
+
+@Component
+@RequiredArgsConstructor
+public class RankingRedisReader {
+    private final StringRedisTemplate redisTemplate;
+
+    public RankingInfo getDailyRanking(String date, Long productId) {
+        String key = "ranking:all:" + date;
+        String member = String.valueOf(productId);
+
+        RedisSerializer<String> serializer = redisTemplate.getStringSerializer();
+        byte[] keyBytes = serializer.serialize(key);
+        byte[] memberBytes = serializer.serialize(member);
+
+        @SuppressWarnings("unchecked")
+        List<Object> results = (List<Object>) redisTemplate.executePipelined((RedisCallback<Object>) connection -> {
+            connection.zScore(keyBytes, memberBytes);   // -> Double (or null)
+            connection.zRevRank(keyBytes, memberBytes); // -> Long   (or null) 0-base
+            connection.zCard(keyBytes);                 // -> Long
+            return null;
+        });
+
+        Double score = (Double) results.get(0);
+        Long revRank0 = (Long) results.get(1);
+        Long total = (Long) results.get(2);
+
+        Integer rank = (revRank0 == null) ? null : Math.toIntExact(revRank0 + 1);
+
+        return new RankingInfo(date, score, rank, total);
+    }
+}

apps/commerce-api/src/main/java/com/loopers/application/ranking/RankingFacade.java

@@ -0,0 +1,70 @@
+package com.loopers.application.ranking;
+
+import com.loopers.interfaces.api.ranking.RankingV1Dto;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.redis.core.StringRedisTemplate;
+import org.springframework.data.redis.core.ZSetOperations;
+import org.springframework.stereotype.Component;
+
+import java.time.LocalDate;
+import java.time.ZoneId;
+import java.time.format.DateTimeFormatter;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+
+@Component
+@RequiredArgsConstructor
+public class RankingFacade {
+    private final StringRedisTemplate redisTemplate;
+    private static final ZoneId KST = ZoneId.of("Asia/Seoul");
+    private static final DateTimeFormatter YYYYMMDD = DateTimeFormatter.BASIC_ISO_DATE;
+
+    public RankingV1Dto.ProductRankingPageResponse getDailyProductRanking(int page, int size) {
+        if (page < 1) page = 1;
+        if (size < 1) size = 20;
+
+        String date = LocalDate.now(KST).format(YYYYMMDD);
+
+        String key = "ranking:all:" + date;
+        ZSetOperations<String, String> zset = redisTemplate.opsForZSet();
+
+        Long total = zset.size(key);
+        long totalElements = (total == null) ? 0 : total;
+
+        if (totalElements == 0) {
+            return new RankingV1Dto.ProductRankingPageResponse(date, page, size, 0, 0, List.of());
+        }
+
+        long start = (long) (page - 1) * size;
+        long end = start + size - 1;
+
+        if (start >= totalElements) {
+            int totalPages = (int) Math.ceil((double) totalElements / size);
+            return new RankingV1Dto.ProductRankingPageResponse(date, page, size, totalElements, totalPages, List.of());
+        }
+
+        Set<ZSetOperations.TypedTuple<String>> tuples =
+                zset.reverseRangeWithScores(key, start, end);
+
+        List<RankingV1Dto.ProductRankingResponse> items = new ArrayList<>();
+        if (tuples != null) {
+            long rank = start + 1;
+            for (var t : tuples) {
+                String member = t.getValue();
+                Double score = t.getScore();
+                if (member == null || score == null) continue;
+
+                items.add(new RankingV1Dto.ProductRankingResponse(
+                        rank++,
+                        Long.parseLong(member),
+                        score
+                ));
+            }
+        }
+
+        int totalPages = (int) Math.ceil((double) totalElements / size);
+        return new RankingV1Dto.ProductRankingPageResponse(date, page, size, totalElements, totalPages, items);
+    }
+
+}

apps/commerce-api/src/main/java/com/loopers/interfaces/api/product/ProductV1ApiSpec.java

@@ -15,7 +15,7 @@ public interface ProductV1ApiSpec {
     ApiResponse<List<ProductV1Dto.ProductResponse>> findAllProducts();
 
     @Operation(summary = "상품 상세 조회")
-    ApiResponse<ProductV1Dto.ProductResponse> findProductById(Long id);
+    ApiResponse<ProductV1Dto.ProductRankingResponse> findProductById(Long id);
 
     @Operation(summary = "상품 정렬 조회")
     ApiResponse<List<ProductV1Dto.ProductResponse>> findProductsBySortCondition(ProductV1Dto.SearchProductRequest request);

apps/commerce-api/src/main/java/com/loopers/interfaces/api/product/ProductV1Controller.java

@@ -2,6 +2,7 @@
 
 import com.loopers.application.product.ProductFacade;
 import com.loopers.application.product.ProductInfo;
+import com.loopers.application.product.ProductRankingInfo;
 import com.loopers.interfaces.api.ApiResponse;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -42,9 +43,9 @@ public ApiResponse<List<ProductV1Dto.ProductResponse>> findAllProducts() {
 
     @GetMapping("/{id}")
     @Override
-    public ApiResponse<ProductV1Dto.ProductResponse> findProductById(@PathVariable Long id) {
-        ProductInfo info = productFacade.findProductById(id);
-        ProductV1Dto.ProductResponse response = ProductV1Dto.ProductResponse.from(info);
+    public ApiResponse<ProductV1Dto.ProductRankingResponse> findProductById(@PathVariable Long id) {
+        ProductRankingInfo info = productFacade.findProductById(id);
+        ProductV1Dto.ProductRankingResponse response = ProductV1Dto.ProductRankingResponse.from(info);
 
         return ApiResponse.success(response);
     }

apps/commerce-api/src/main/java/com/loopers/interfaces/api/product/ProductV1Dto.java

@@ -1,13 +1,27 @@
 package com.loopers.interfaces.api.product;
 
 import com.loopers.application.product.ProductInfo;
+import com.loopers.application.product.ProductRankingInfo;
 import com.loopers.domain.product.Product;
 import com.loopers.support.error.CoreException;
 import com.loopers.support.error.ErrorType;
 
 import java.math.BigDecimal;
 
 public class ProductV1Dto {
+    public record ProductRankingResponse(Long id, Long brandId, String name, BigDecimal price, int stock, int rank, double score) {
+        public static ProductRankingResponse from(ProductRankingInfo info) {
+            return new ProductRankingResponse(
+                    info.id(),
+                    info.brandId(),
+                    info.name(),
+                    info.price(),
+                    info.stock(),
+                    info.rank(),
+                    info.score()
+            );
+        }
+    }
     public record ProductResponse(Long id, Long brandId, String name, BigDecimal price, int stock, int likeCount) {
         public static ProductResponse from(ProductInfo info) {
             return new ProductResponse(

apps/commerce-api/src/main/java/com/loopers/interfaces/api/ranking/RankingV1ApiSpec.java

@@ -0,0 +1,9 @@
+package com.loopers.interfaces.api.ranking;
+
+import com.loopers.interfaces.api.ApiResponse;
+
+public interface RankingV1ApiSpec {
+
+    ApiResponse<RankingV1Dto.ProductRankingPageResponse> getDailyProductRanking(int size, int page);
+
+}

apps/commerce-api/src/main/java/com/loopers/interfaces/api/ranking/RankingV1Controller.java

@@ -0,0 +1,27 @@
+package com.loopers.interfaces.api.ranking;
+
+import com.loopers.application.ranking.RankingFacade;
+import com.loopers.interfaces.api.ApiResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/v1/rankings")
+@RequiredArgsConstructor
+public class RankingV1Controller implements RankingV1ApiSpec {
+    private final RankingFacade rankingFacade;
+
+    @GetMapping
+    @Override
+    public ApiResponse<RankingV1Dto.ProductRankingPageResponse> getDailyProductRanking(
+            @RequestParam int size,
+            @RequestParam int page
+    ) {
+        RankingV1Dto.ProductRankingPageResponse response = rankingFacade.getDailyProductRanking(page, size);
+
+        return ApiResponse.success(response);
+    }
+}

apps/commerce-api/src/main/java/com/loopers/interfaces/api/ranking/RankingV1Dto.java

@@ -0,0 +1,20 @@
+package com.loopers.interfaces.api.ranking;
+
+import java.util.List;
+
+public class RankingV1Dto {
+    public record ProductRankingResponse(
+            Long rank,
+            Long productId,
+            double score
+    ) {}
+
+    public record ProductRankingPageResponse(
+            String date,
+            int page,
+            int size,
+            long totalElements,
+            int totalPages,
+            List<ProductRankingResponse> items
+    ) {}
+}

apps/commerce-batch/build.gradle.kts

@@ -0,0 +1,21 @@
+dependencies {
+    // add-ons
+    implementation(project(":modules:jpa"))
+    implementation(project(":modules:redis"))
+    implementation(project(":supports:jackson"))
+    implementation(project(":supports:logging"))
+    implementation(project(":supports:monitoring"))
+
+    // batch
+    implementation("org.springframework.boot:spring-boot-starter-batch")
+    testImplementation("org.springframework.batch:spring-batch-test")
+
+    // querydsl
+    annotationProcessor("com.querydsl:querydsl-apt::jakarta")
+    annotationProcessor("jakarta.persistence:jakarta.persistence-api")
+    annotationProcessor("jakarta.annotation:jakarta.annotation-api")
+
+    // test-fixtures
+    testImplementation(testFixtures(project(":modules:jpa")))
+    testImplementation(testFixtures(project(":modules:redis")))
+}

apps/commerce-batch/src/main/java/com/loopers/CommerceBatchApplication.java

@@ -0,0 +1,24 @@
+package com.loopers;
+
+import jakarta.annotation.PostConstruct;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
+
+import java.util.TimeZone;
+
+@ConfigurationPropertiesScan
+@SpringBootApplication
+public class CommerceBatchApplication {
+
+    @PostConstruct
+    public void started() {
+        // set timezone
+        TimeZone.setDefault(TimeZone.getTimeZone("Asia/Seoul"));
+    }
+
+    public static void main(String[] args) {
+        int exitCode = SpringApplication.exit(SpringApplication.run(CommerceBatchApplication.class, args));
+        System.exit(exitCode);
+    }
+}