Merge remote-tracking branch 'origin/product_review_fix_328' into product_review_fix_328

Author: Prankurtiwari

.github/workflows/dev-branch-pr-build-and-test-pipeline.yaml

@@ -37,7 +37,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout the source code from the Github repository
+        uses: actions/checkout@v4
 
       - name: Set up JDK 21
         uses: actions/setup-java@v3
@@ -56,3 +57,12 @@ jobs:
 
       - name: Run unit tests
         run: mvn test -Pdev --file pom.xml
+
+      - name: Generate test coverage report
+        run: mvn jacoco:report --file pom.xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./target/site/jacoco/jacoco.xml

.github/workflows/dev-branch-pr-deployment-pipeline.yml

@@ -45,7 +45,7 @@ jobs:
             docker stop ${{ vars.DOCKER_CONTAINER_NAME }} || true
             docker rm ${{ vars.DOCKER_CONTAINER_NAME }} || true
             docker rmi ${{ vars.DOCKER_HUB_ACCOUNT_NAME }}/${{ vars.DOCKER_IMAGE_NAME }}:latest-version || true
-            docker pull ${{ vars.DOCKER_HUB_ACCOUNT_NAME }}/${{ vars.DOCKER_IMAGE_NAME }}:latest-version 
+            docker pull ${{ vars.DOCKER_HUB_ACCOUNT_NAME }}/${{ vars.DOCKER_IMAGE_NAME }}:latest-version
             docker run -d \
               --name ${{ vars.DOCKER_CONTAINER_NAME }} \
               --network=${{ vars.DOCKER_NETWORK }} \
@@ -69,7 +69,7 @@ jobs:
               -e REDIS_PORT=${{ vars.REDIS_PORT }} \
               -e SPRING_AI_OPENAI_API_KEY=${{ secrets.SPRING_AI_OPENAI_API_KEY }} \
               -e STRIPE_SECRET_KEY=${{ secrets.STRIPE_SECRET_KEY }} \
+              -e STRIPE_WEBHOOK_SECRET=${{ secrets.STRIPE_WEBHOOK_SECRET }} \
               -v ${{ vars.APP_DATA_PATH_ON_THE_REMOTE_SERVER }}:/usr/app/logs \
               -v ${{ vars.APP_DATA_PATH_ON_THE_REMOTE_SERVER }}/products:/usr/app/products \
               zufarexplainedit/iced-latte-backend:latest-version
-            

README.md

@@ -7,10 +7,12 @@
 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/danilqa/node-file-router/blob/main/LICENSE)
 [![GitHub issues](https://img.shields.io/github/issues/Sunagatov/Iced-Latte)](https://github.com/Sunagatov/Iced-Latte/issues)
 [![Total Lines of Code](https://tokei.rs/b1/github/Sunagatov/Iced-Latte?category=lines)](https://github.com/Sunagatov/Iced-Latte)
+[![codecov](https://codecov.io/github/Sunagatov/Iced-Latte/branch/development/graph/badge.svg?token=515f0ca9-2c4d-4458-ba0b-baf1de67635e)](https://app.codecov.io/github/Sunagatov/Iced-Latte)
 
 [![Docker Pulls](https://img.shields.io/docker/pulls/zufarexplainedit/iced-latte-backend.svg)](https://hub.docker.com/r/zufarexplainedit/iced-latte-backend/)
 [![GitHub contributors](https://img.shields.io/github/contributors/Sunagatov/Iced-Latte)](https://github.com/Sunagatov/Iced-Latte/graphs/contributors)
 [![GitHub stars](https://img.shields.io/github/stars/Sunagatov/Iced-Latte)](https://github.com/Sunagatov/Iced-Latte/stargazers)
+[![Fork on GitHub](https://img.shields.io/github/forks/Sunagatov/Iced-Latte.svg?style=social)](https://github.com/Sunagatov/Iced-Latte/network/members)
 </div>
 
 ## Table of Contents
@@ -101,10 +103,12 @@ Contributions are welcome.
 
 The main point of interaction is the [Issues page](https://github.com/Sunagatov/Iced-Latte/issues).
 
-Here's our contribution guidelines — [CONTRIBUTING.md](CONTRIBUTING.md).
-
 > The official development language at the moment is English, because 100% of our users speak it. We don't want to introduce unnecessary barriers for them. But we are used to writing commits and comments in Russian and we won't mind communicating with you in it.
 
+The bussiness docs are here [Docs](https://drive.google.com/drive/folders/1vvfXy6n4cz01JjNyTgoYG0g6EIRvyHDw?usp=share_link).
+
+Swagger REST APIs contracts described [here](https://iced-latte.uk/backend/api/docs/swagger-ui/index.html).
+
 ### 😎 I want to write some code
 
 - Open our [Issues page](https://github.com/Sunagatov/Iced-Latte/issues) to see the most important tickets at top.

START.md

@@ -26,7 +26,8 @@ Key variables which are used in the startup of the app. They are pre-configured
 - `AWS_PRODUCT_BUCKET` AWS product's bucket name
 - `AWS_USER_BUCKET`  AWS product's bucket name
 - `AWS_DEFAULT_PRODUCT_IMAGES_PATH` Package with product's files 
-- `STRIPE_SECRET_KEY` Stripe secret key for payment integration
+- `STRIPE_SECRET_KEY` Stripe secret key for payment session creation
+- `STRIPE_WEBHOOK_SECRET` Stripe secret key for webhook
 
 Refer to [docker-compose.local.yml](./docker-compose.local.yml)
 
@@ -114,6 +115,15 @@ docker compose -f docker-compose.local.yml up -d --build
 
 AWS is available only in production, therefore there are no real pictures of products, only stubs.
 
+#### Stripe Integration Testing (local)
+
+1. Install [Stripe CLI](https://docs.stripe.com/stripe-cli)
+2. Redirect webhook events
+   ```bash
+   stripe listen --forward-to localhost:80/backend/api/v1/payment/stripe/webhook
+   ```
+3. Use [test cards](https://docs.stripe.com/testing): `4242424242424242`
+
 ## Database Navigator
 
 > For Ultimate Edition consider using [Database Tools and SQL plugin](https://www.jetbrains.com/help/idea/relational-databases.html)

docker-compose.local.yml

@@ -48,6 +48,7 @@ services:
       GOOGLE_AUTH_CLIENT_SECRET: vbfgngfdndgndgndgndgndgndgndg
       GOOGLE_AUTH_REDIRECT_URI: vbfgngfdndgndgndgndgndgndgndg
       STRIPE_SECRET_KEY: sk_test_51PJxciHA4AopuQMMeXaJNETc7RUAITeMTKJei07L8iEHrRiWLQalKsr756dnOzmKPUXufkUVNUSaiPyktJG9dGY500x0cM817f
+      STRIPE_WEBHOOK_SECRET: whsec_81c734081f94172b76e5dede103b67b3fcfc69220fa0747a12d67244c9ddb57d
     build:
       context: .
       dockerfile: Dockerfile.local

docs/ERD.png

@@ -113,22 +113,6 @@ entity "shopping_cart_item" {
  version : INT
 }
 
-enum "RESERVATION_STATUS" {
-  CREATED
-  CONFIRMED
-  CANCELLED
-}
-
-entity "reservation" {
- *id : SERIAL PK
- --
- *reservation_id : UUID
- *product_id : UUID
- *reserved_quantity : INT
- *created_at : TIMESTAMP
- *status : RESERVATION_STATUS
-}
-
 entity "favorite_list" {
  *id : UUID PK
  --
@@ -186,8 +170,6 @@ entity "user_details" {
 "product" ||..o{ "product_reviews_likes" : product_id->id
 "user_details" ||..o{ "product_reviews_likes" : user_id->id
 
-RESERVATION_STATUS ||..o{ "reservation"
-
 "user_details" ||..o{ "favorite_list" : user_id->id
 
 "favorite_list" ||..o{ "favorite_item" : favorite_id->id

docs/ERD.puml

@@ -0,0 +1,34 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+autonumber
+
+title Checkout Sequence, Logged-In User
+
+actor "User" as user
+participant "Frontend" as fe
+participant "Backend" as be
+participant "Stripe" as stripe
+database "PostgreSQL" as db
+
+user -> fe: Clicks "Go to checkout"
+fe -> be: GET /api/v1/payment
+be -> stripe: Create session and POST /v1/checkout/sessions
+be <-- stripe: Return client_secret
+be --> fe: Return client_secret
+fe -> stripe: Embed Stripe's payment page using client_secret
+fe <-- stripe: Redirect /orders?sessionId={CHECKOUT_SESSION_ID}
+fe -> be: GET /stripe/status?sessionId={CHECKOUT_SESSION_ID}
+be -> stripe: GET /v1/checkout/sessions/CHECKOUT_SESSION_ID
+be <-- stripe: Session status (OPEN / COMPLETE)
+fe <-- be: Response with session status and email
+
+be <-- stripe: POST /v1/stripe/webhook
+alt <font color=green>"checkout.session.completed"</font>
+    be -> db: Create Order
+    be -> db: Delete Cart
+    user <-- be: Send email (successful order)
+else <font color=red>"checkout.session.expired"</font>
+    be -> db: Update status and description in Payment
+end
+@enduml

docs/plantuml/payment/checkout-sequence.png

@@ -0,0 +1,9 @@
+@startuml
+
+title Order States
+
+[*] --> CREATED : BE receives Stripe Webhook\n"checkout.session.completed"
+
+CREATED: New Order
+
+@enduml

docs/plantuml/payment/checkout-sequence.puml

@@ -1,14 +1,11 @@
 package com.zufar.icedlatte;
 
-import com.zufar.icedlatte.payment.config.StripeConfiguration;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.cache.annotation.EnableCaching;
 import org.springframework.scheduling.annotation.EnableScheduling;
 
 @SpringBootApplication
-@EnableConfigurationProperties(StripeConfiguration.class)
 @EnableScheduling
 @EnableCaching
 public class IcedLatteApplication {

docs/plantuml/payment/checkout-sequence.txt

@@ -58,13 +58,13 @@ private List<ShoppingCartItem> createItems(Set<NewShoppingCartItemDto> itemsToAd
         Map<UUID, Integer> productsWithQuantity = itemsToAdd.stream()
                 .collect(Collectors.toMap(NewShoppingCartItemDto::getProductId, NewShoppingCartItemDto::getProductQuantity));
 
-        Set<UUID> existedProductIds = shoppingCart.getItems().stream()
+        Set<UUID> existingProductIds = shoppingCart.getItems().stream()
                 .map(ShoppingCartItem::getProductInfo)
                 .map(ProductInfo::getProductId)
                 .collect(Collectors.toSet());
 
         Set<UUID> newProductIds = productsWithQuantity.keySet().stream()
-                .filter(productId -> !existedProductIds.contains(productId))
+                .filter(productId -> !existingProductIds.contains(productId))
                 .collect(Collectors.toSet());
 
         return productInfoRepository.findAllById(newProductIds).stream()