Feature/distribute lock

.dockerignore

@@ -4,7 +4,7 @@
 .env.local
 .gitignore
 README.md
-.gitmessage
+.gitmessage.txt
 LICENSE
 SunStyle_edited.xml
 codecov.yml

README.md

@@ -6,6 +6,95 @@
 ![Codecov](https://img.shields.io/badge/Codecov-F01F7A?logo=codecov&logoColor=white)
 ![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF?logo=githubactions&logoColor=white)
 
-# 관심사
+# 주문 서버 관심사
+### 주문 및 결제 과정
 
-# 정보
+1. 클라이언트는 주문 서버에 주문 요청
+2. 주문 서버는 클라이언트 요청의 유효성을 검사
+   1. `PENDING_ORDER` 상태의 유형제품을 선택
+   2. 유형제품의 상태를 `PROCESSING`로 변경
+   3. 주문에 유형 제품을 추가
+   4. 만약 주문 요청한 수량만큼 `PENDING_ORDER` 상태의 유형제품이 없다면, `재고가 부족합니다. ` 문구를 클라이언트에게 응답
+3. 주문 서버가 결제 서버에 결제 요청
+4. 결제 서버가 결제 요청 받았다고 응답
+5. 주문 서버는 결제 요청이 들어간 것을 클라이언트에게 전달
+6. 결제 서버가 결제 결과를 주문 서버에 전달
+    1. 결제가 정상적으로 완료되면,
+       1. 유형제품의 상태를 `SHIPPING`으로 변경
+       2. 핵심제품의 재고를 차감
+    2. 결제가 실패되면, 
+       1. 재고 유지
+       2. 주문의 유형제품 상태를 `PENDING_ORDER`로 변경
+7. 주문 서버는 받는 결과를 클라이언트에게 전달
+
+### 클라이언트 주문 요청 형태
+
+```json
+{
+    "core_products" : {
+        "1" : "30",
+        "2" : "10"
+    },
+    "client_type" : "InexperiencedCustomer",
+    "payment_method" : "CREDIT_CARD"
+}
+```
+
+### 결제 요청 형태
+```json
+{
+    "buyer": {
+        "name": "John Doe",
+        "email": "[email protected]"
+    },
+    "seller": {
+        "name": "Jane Doe",
+        "email": "[email protected]"
+    },
+    "payment": "CREDIT_CARD",
+    "price": 100,
+    "redirect": "http://localhost:8080/payment/confirm"
+}
+```
+
+### 상품의 상태에 대한 설명
+
+`PENDING_ORDER` : 유형제품이 주문에 포함되지 않는 기본적인 상태를 의미. 여러 주문에서 동시에 접근하면 한 주문에만 들어간다.
+
+`PROCESSING` : 유형제품이 주문에 포함되며, 결제 결과를 기다리는 상태를 의미.
+
+`SHIPPING` : 결제가 정상적으로 종료되고, 해당 유형제품이 온전히 고객의 소유가 되는 상태.  
+
+`DELIVERED` : 상품이 고객에게 배송 완료된 상태. 현재 프로젝트에서는 배송까지는 관심사가 아니기 때문에 사용하지 않는다.
+
+### 클라이언트 요청 유효성 검사 리스트
+
+- [ ] 핵심제품 id가 존재하는가?
+- [ ] 핵심제품의 재고가 충분한가?
+- [ ] `PENDING_ORDER` 상태의 유형제품이 충분한가? 
+- [ ] 클라이언트가 상품 구매 권한이 있는가?
+- [ ] 결제 방식이 유효한 방식인가?
+
+## 시퀀스 다이어그램
+
+![count-sequence.png](./count-sequence.png)
+
+**Transaction 1**
+
+- 사용자 권한 확인
+- 재고 확인
+- 주문 생성
+- 상품을 결제 중으로 상태 변환
+
+**Transaction 2**
+
+- 결제 결과가 성공일 때,
+    -  상품 상태를 SHIPMENT 로 변경
+    - 주문의 상태를 FINISH 로 변경
+- 에러가 발생하거나, 결제가 실패했을 때,
+  - 상품의 상태를 PENDING_ORDER 으로 변경
+  - 상품 재고를 원복
+  - 주문의 상태를 FAIL 로 변경
+
+**Transaction 3**
+- 리디렉션 정보에 따라 주문을 읽기

build.gradle.kts

@@ -23,6 +23,16 @@ repositories {
 }
 
 @Suppress("SpellCheckingInspection") dependencies {
+    // spring-distribute-lock
+    implementation("org.springframework.integration:spring-integration-jdbc")
+    implementation("org.springframework.boot:spring-boot-starter-jdbc")
+    implementation("org.springframework.boot:spring-boot-starter-integration")
+
+    // spring-web-payment
+    implementation("org.springframework.boot:spring-boot-starter-webflux")
+    implementation("org.springdoc:springdoc-openapi-starter-webflux-ui:2.5.0")
+    runtimeOnly("io.netty:netty-resolver-dns-native-macos:4.1.94.Final:osx-aarch_64")
+
     // spring-web-jpa-concurrency
     implementation("org.springframework.boot:spring-boot-starter-data-jpa")
     implementation("org.springframework.boot:spring-boot-starter-web")

docker-compose.yaml

@@ -21,22 +21,22 @@ services:
     depends_on:
       mysql:
         condition: service_healthy
-    networks:
-      - private-subnet
+#    networks:
+#      - private-subnet
 
   mysql:
     <<: *mysql-template
     hostname: dev
     container_name: mysql-dev
     ports:
       - "3306:3306"
-    networks:
-      - private-subnet
-
-networks:
-  private-subnet: # private: 172.19.0.x
-    driver: bridge
-    ipam:
-      driver: default
-      config:
-        - subnet: 172.19.0.0/24
+#    networks:
+#      - private-subnet
+#
+#networks:
+#  private-subnet: # private: 172.19.0.x
+#    driver: bridge
+#    ipam:
+#      driver: default
+#      config:
+#        - subnet: 172.19.0.0/24

src/main/java/com/concurrency/config/EnumMappingConfig.java

@@ -0,0 +1,14 @@
+package com.concurrency.config;
+
+import org.springframework.boot.convert.ApplicationConversionService;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.format.FormatterRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+@Configuration
+public class EnumMappingConfig implements WebMvcConfigurer {
+    @Override
+    public void addFormatters(FormatterRegistry registry) {
+        ApplicationConversionService.configure(registry);
+    }
+}

src/main/java/com/concurrency/config/JDBCConfig.java

@@ -0,0 +1,21 @@
+package com.concurrency.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.integration.jdbc.lock.DefaultLockRepository;
+import org.springframework.integration.jdbc.lock.JdbcLockRegistry;
+import org.springframework.integration.jdbc.lock.LockRepository;
+
+import javax.sql.DataSource;
+
+@Configuration
+public class JDBCConfig {
+    @Bean
+    public DefaultLockRepository DefaultLockRepository(DataSource dataSource){
+        return new DefaultLockRepository(dataSource);
+    }
+    @Bean
+    public JdbcLockRegistry jdbcLockRegistry(LockRepository lockRepository){
+        return new JdbcLockRegistry(lockRepository);
+    }
+}

src/main/java/com/concurrency/jpa/customer/Product/ActualProductRepository.java

@@ -1,8 +1,29 @@
 package com.concurrency.jpa.customer.Product;
 
+import com.concurrency.jpa.customer.Product.entity.ActualProduct;
+import com.concurrency.jpa.customer.Product.enums.ActualStatus;
+import jakarta.persistence.LockModeType;
+import org.springframework.data.domain.Pageable;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Lock;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
+import java.util.List;
 
 @Repository
 public interface ActualProductRepository extends JpaRepository<ActualProduct, Long>{
+    @Query(value = "SELECT count(a.id) FROM ActualProduct a " +
+            "WHERE a.coreProduct.id = :coreId AND a.actualStatus = :actualStatus")
+    Long countByCoreProductIdANDActualStatus(@Param("coreId") Long k, @Param("actualStatus") ActualStatus actualStatus);
+
+    @Lock(LockModeType.PESSIMISTIC_READ)
+    @Query(value = "SELECT a FROM ActualProduct a " +
+            "WHERE a.coreProduct.id = :coreProductId AND a.actualStatus = :reqStatus")
+    List<ActualProduct> findByCoreProduct_IdAndActualStatus(@Param("coreProductId") Long coreProductId, @Param("reqStatus")ActualStatus reqStatus, Pageable pageable);
+    List<ActualProduct> findByOrder_Id(Long orderId);
+
+    @Lock(LockModeType.PESSIMISTIC_WRITE)
+    @Query("SELECT a FROM ActualProduct a join fetch a.coreProduct c WHERE a.order.id = :orderId")
+    List<ActualProduct> findByOrder_IdPessimistic(@Param("orderId") Long orderId);
 }

src/main/java/com/concurrency/jpa/customer/Product/CoreProductRepository.java

@@ -1,8 +1,20 @@
 package com.concurrency.jpa.customer.Product;
 
+import com.concurrency.jpa.customer.Product.entity.CoreProduct;
+import jakarta.persistence.LockModeType;
+import jakarta.persistence.QueryHint;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Lock;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.jpa.repository.QueryHints;
+import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
 
+import java.util.Optional;
+
 @Repository
 public interface CoreProductRepository extends JpaRepository<CoreProduct, Long> {
+    @Lock(LockModeType.PESSIMISTIC_WRITE)
+    @Query("select c from CoreProduct c where c.id = :id" )
+    Optional<CoreProduct> findByIdPessimistic(@Param("id") Long id);
 }

src/main/java/com/concurrency/jpa/customer/Product/ProductService.java

@@ -0,0 +1,18 @@
+package com.concurrency.jpa.customer.Product;
+
+import com.concurrency.jpa.customer.Product.entity.ActualProduct;
+import com.concurrency.jpa.customer.Product.enums.ActualStatus;
+
+import java.util.List;
+import java.util.Map;
+
+public interface ProductService {
+    List<ActualProduct> findActualProductsByOrder(Long orderId);
+    List<ActualProduct> findActualProducts(Long coreProductId, ActualStatus actualStatus, Long stock);
+
+    List<ActualProduct> concatActualProductList(Map<Long, Long> coreProducts);
+    void updateCoreProductsStock(Map<Long, Long> requireProducts);
+    long subtractCoreProductStock(Long coreProductId, Long reqStock);
+    long subtractCoreProductStockPessimistic(Long coreProductId, Long reqStock);
+    long subtractCoreProductStockOptimistic(Long coreProductId, Long reqStock);
+}