feature: 배너 이미지 조회 #18

TaeyeonRoyce · 2024-01-24T08:43:32Z

📌 관련 이슈

closed feature: 배너 이미지 조회 #16

📁 작업 설명

홈 화면에서 사용 배너 정보를 제공하는 API 개발
Spring Cache를 통해 배너 정보 caching
워크플로우 수정
- CI의 경우 push하는 경우에만 수행되도록 변경하였습니다. 보통 push -> PR을 생성하니깐 동일한 작업이 2번 돌더라고요.
- CD의 경우 docker image가 삭제 되지 않는 현상이 발견되어서 image를 지우는 option을 추가하였습니다.
- 배포시 table이 생성되어 있지 않아 임시로 ddl-auto: create를 추가하였습니다.

💻 미완료 태스크

BaseEntity 적용
API Test

기타

ApiTestConfig를 추가했습니다! 7c74c6b

공통으로 설정되는 부분들 (`@SpringBootTest(web ..), dataCleaner, afterContainer)을 공통화 해보았습니다.
BehaviorSpec을 상속하는 구조이다 보니, 추가하기 어려웠는데요. 달라진 점은 아래와 같습니다!

AS-IS

@SpringBootTest(webEnvironment = RANDOM_PORT)
class BannerControllerTest(
    @LocalServerPort private val port: Int,
    private val bannerRepository: BannerRepository,
    private val dataCleaner: DataCleaner,
) : BehaviorSpec({

    RestAssured.port = port

    Given() {
//  ....
    }

    afterContainer {
        dataCleaner.clean()
    }
)}

TO-BE

class BannerControllerTest(
    private val bannerRepository: BannerRepository
) : ApiTestConfig() {

    init {
        Given() {
        // ....
       }
   }
}

ApiTestConfig에서 BehaviorSpec을 상속해서 init{} depth가 생겼는데요.
다들 어떠신가요? 의견에 따라 반영해보겠습니다.
쉽게 롤백하기 위해 커밋을 분리해두었어요!

github-actions · 2024-01-24T08:45:02Z

Test Results

7 files +2 7 suites +2 2s ⏱️ ±0s
21 tests +3 21 ✅ +3 0 💤 ±0 0 ❌ ±0
23 runs +3 23 ✅ +3 0 💤 ±0 0 ❌ ±0

Results for commit 18ffcc5. ± Comparison against base commit c98a990.

♻️ This comment has been updated with latest results.

- ddl-auto option으로 table 생성 - docker compose시 이전 Image 삭제 옵션 추가

- only push

hgo641

어쁘루브합니다 ApiTestConfig 넘 좋네요 고생하셨습니닷

hgo641 · 2024-01-26T05:50:44Z

src/main/kotlin/com/petqua/presentation/banner/BannerController.kt

+
+    @GetMapping
+    fun readAll(): ResponseEntity<List<BannerResponse>> {
+        val bannerList = bannerService.readAll()


오 변수명에 자료형 이름 쓰는 거 허용하시나요
전 좋긴함.

안쓰는게 좋을 것 같아요!
수정하겠습니다~

hgo641 · 2024-01-26T05:54:54Z

src/test/kotlin/com/petqua/test/ApiTestConfig.kt

+import org.springframework.boot.test.web.server.LocalServerPort
+
+@SpringBootTest(webEnvironment = RANDOM_PORT)
+abstract class ApiTestConfig : BehaviorSpec() {


조아요~~

Combi153

고생하셨습니다!
최고예요~~

Combi153 · 2024-01-26T05:36:09Z

.github/workflows/deploy-prod.yml

+    needs: [ build-docker-image-and-push ]
+    steps:


도커 공부 해야하는데 언제하죠ㅋㅋㅋㅎ

Combi153 · 2024-01-26T05:38:21Z

src/main/kotlin/com/petqua/application/banner/BannerDtos.kt

+    val createAt: LocalDateTime,
+    val updateAt: LocalDateTime,


createAt, updateAt 도 응답하네요! 클라이언트에게 아마도 필요하지 않을 정보를 응답하는 이유가 궁금합니다

문제없는 범위 내에서 createdAt을 자주 응답하긴 했었습니다.. 추후에 추가되는 경우가 종종 있었거든요!
굳이 응답할 필요 없는 것 같은데 제거해두겠습니다~!

Combi153 · 2024-01-26T05:38:50Z

src/main/kotlin/com/petqua/application/banner/BannerService.kt

+
+    @Cacheable("banners")


캐시 좋네요! 이거 나중에 레디스로 이사하나요?

나중에 cacheConfig에서 구현체만 수정하면 될 것 같군요!
레디스를 생각하진 않았는데, 레디스가 도입되면 얘도 거기서 처리하면 되겠네요

Combi153 · 2024-01-26T05:39:48Z

src/main/kotlin/com/petqua/domain/banner/Banner.kt

+package com.petqua.domain.banner
+
+import com.petqua.common.domain.BaseEntity
+import jakarta.persistence.*


* 👻 귀신이다아아

Combi153 · 2024-01-26T05:41:15Z

src/test/kotlin/com/petqua/application/banner/BannerServiceTest.kt

+        When("Banner가 캐싱 되어 있으면") {
+            repeat(5) { bannerService.getBannerList() }
+
+            Then("퀴리가 발생 하지 않는다") {
+                verify(bannerRepository, atMost(1)).findAll()


꼼꼼 테스트 좋아요 👍

Combi153 · 2024-01-26T05:42:40Z

src/test/kotlin/com/petqua/test/ApiTestConfig.kt

+@SpringBootTest(webEnvironment = RANDOM_PORT)
+abstract class ApiTestConfig : BehaviorSpec() {
+
+    @LocalServerPort
+    protected val port: Int = RestAssured.port
+
+    @Autowired
+    private lateinit var dataCleaner: DataCleaner
+
+    init {
+        afterContainer {
+            dataCleaner.clean()
+        }
+    }
+}


저는 너무 좋은데요! 한결 편해질 것 같아요!!!

Combi153 · 2024-01-26T05:44:09Z

src/test/kotlin/com/petqua/presentation/banner/BannerControllerTest.kt

+                    assertThat(response.statusCode).isEqualTo(HttpStatus.OK.value())
+                    assertThat(findBannerResponse.size).isEqualTo(2)


SoftAssertions 안 쓰면 홍고가 화내요ㅠ

아 이걸 놓쳤네;;;;;;;;;;;

* feat: Banner 도메인 추가 * chore: Spring Cache 설정 추가 * feat: Banner 조회 로직 추가 * feat: Banner 조회 API 추가 * test: Banner Api test 추가 * test: Api test 공통화 * chore: 배포 오류 수정 - ddl-auto option으로 table 생성 - docker compose시 이전 Image 삭제 옵션 추가 * chore: CI scope 수정 - only push * refactor: Api resource url 수정 * style: method, dto naming 수정 * style: 변수명에 자료형 제거 * refactor: 불필요한 응답 필드 제거 * style: static import 제거 * test: SoftAssertions 적용

TaeyeonRoyce added the feature label Jan 24, 2024

TaeyeonRoyce added this to the 홈 화면에서 공지, 배너, 카테고리를 확인할 수 있다 milestone Jan 24, 2024

TaeyeonRoyce self-assigned this Jan 24, 2024

TaeyeonRoyce mentioned this pull request Jan 25, 2024

feature: 공지사항 조회 #20

Merged

TaeyeonRoyce added 8 commits January 26, 2024 13:25

feat: Banner 도메인 추가

a4e94bb

chore: Spring Cache 설정 추가

d9997e4

feat: Banner 조회 로직 추가

78df0f3

feat: Banner 조회 API 추가

e4116e0

test: Banner Api test 추가

417bf03

test: Api test 공통화

7c74c6b

chore: 배포 오류 수정

0b66947

- ddl-auto option으로 table 생성 - docker compose시 이전 Image 삭제 옵션 추가

chore: CI scope 수정

bec1f0b

- only push

TaeyeonRoyce force-pushed the 16-feature-배너-이미지-조회 branch from 8567d37 to bec1f0b Compare January 26, 2024 05:19

TaeyeonRoyce marked this pull request as ready for review January 26, 2024 05:22

TaeyeonRoyce requested review from Combi153 and hgo641 as code owners January 26, 2024 05:22

TaeyeonRoyce added 2 commits January 26, 2024 14:44

refactor: Api resource url 수정

28769f2

style: method, dto naming 수정

b938c23

hgo641 approved these changes Jan 26, 2024

View reviewed changes

Combi153 approved these changes Jan 26, 2024

View reviewed changes

TaeyeonRoyce added 4 commits January 26, 2024 15:04

style: 변수명에 자료형 제거

3160c34

refactor: 불필요한 응답 필드 제거

c3422fc

style: static import 제거

9db6793

test: SoftAssertions 적용

18ffcc5

TaeyeonRoyce merged commit 69cd895 into develop Jan 26, 2024
2 checks passed

TaeyeonRoyce deleted the 16-feature-배너-이미지-조회 branch January 26, 2024 07:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: 배너 이미지 조회 #18

feature: 배너 이미지 조회 #18

TaeyeonRoyce commented Jan 24, 2024 •

edited

Loading

github-actions bot commented Jan 24, 2024 •

edited

Loading

hgo641 left a comment •

edited

Loading

hgo641 Jan 26, 2024

TaeyeonRoyce Jan 26, 2024

hgo641 Jan 26, 2024

Combi153 left a comment

Combi153 Jan 26, 2024

Combi153 Jan 26, 2024

TaeyeonRoyce Jan 26, 2024

Combi153 Jan 26, 2024

TaeyeonRoyce Jan 26, 2024

Combi153 Jan 26, 2024

Combi153 Jan 26, 2024

Combi153 Jan 26, 2024

Combi153 Jan 26, 2024

hgo641 Jan 26, 2024

		assertThat(response.statusCode).isEqualTo(HttpStatus.OK.value())
		assertThat(findBannerResponse.size).isEqualTo(2)

feature: 배너 이미지 조회 #18

feature: 배너 이미지 조회 #18

Conversation

TaeyeonRoyce commented Jan 24, 2024 • edited Loading

📌 관련 이슈

📁 작업 설명

💻 미완료 태스크

기타

github-actions bot commented Jan 24, 2024 • edited Loading

Test Results

hgo641 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Combi153 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TaeyeonRoyce commented Jan 24, 2024 •

edited

Loading

github-actions bot commented Jan 24, 2024 •

edited

Loading

hgo641 left a comment •

edited

Loading