문의하기 구글 스프레드시트 API 요청 책임을 클라이언트에서 서버로 변경

backend/src/main/java/codezap/voc/config/VocClientHttpRequestInterceptor.java

@@ -0,0 +1,28 @@
+package codezap.voc.config;
+
+import java.io.IOException;
+import java.net.SocketTimeoutException;
+
+import org.springframework.http.HttpRequest;
+import org.springframework.http.client.ClientHttpRequestExecution;
+import org.springframework.http.client.ClientHttpRequestInterceptor;
+import org.springframework.http.client.ClientHttpResponse;
+
+import codezap.global.exception.CodeZapException;
+import codezap.global.exception.ErrorCode;
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+public class VocClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {
+
+    @Override
+    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) {
+        try {
+            return execution.execute(request, body);
+        } catch (SocketTimeoutException e) {
+            throw new CodeZapException(ErrorCode.INTERNAL_SERVER_ERROR, "스프레드시트 API 요청 시간이 초과되었습니다: " + e.getMessage());
+        } catch (IOException e) {
+            throw new CodeZapException(ErrorCode.INTERNAL_SERVER_ERROR, "스프레드시트 API 요청에 실패했습니다: " + e.getMessage());
+        }
+    }
+}

backend/src/main/java/codezap/voc/config/VocConfiguration.java

@@ -0,0 +1,39 @@
+package codezap.voc.config;
+
+import static org.springframework.http.HttpHeaders.CONTENT_TYPE;
+import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
+
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.client.BufferingClientHttpRequestFactory;
+import org.springframework.http.client.ClientHttpRequestFactory;
+import org.springframework.http.client.SimpleClientHttpRequestFactory;
+import org.springframework.web.client.RestClient;
+
+import lombok.RequiredArgsConstructor;
+
+@Configuration
+@EnableConfigurationProperties(VocProperties.class)
+@RequiredArgsConstructor
+public class VocConfiguration {
+
+    private final VocProperties properties;
+
+    @Bean
+    public RestClient.Builder vocRestClientBuilder() {
+        return RestClient.builder()
+                .baseUrl(properties.getBaseUrl())
+                .defaultHeader(CONTENT_TYPE, APPLICATION_JSON_VALUE)
+                .defaultStatusHandler(new VocResponseErrorHandler())
+                .requestInterceptor(new VocClientHttpRequestInterceptor())
+                .requestFactory(requestFactory());
+    }
+
+    private ClientHttpRequestFactory requestFactory() {
+        var httpRequestFactory = new SimpleClientHttpRequestFactory();
+        httpRequestFactory.setConnectTimeout(properties.getConnectTimeout());
+        httpRequestFactory.setReadTimeout(properties.getReadTimeout());
+        return new BufferingClientHttpRequestFactory(httpRequestFactory);
+    }
+}

backend/src/main/java/codezap/voc/config/VocProperties.java

@@ -0,0 +1,17 @@
+package codezap.voc.config;
+
+import java.time.Duration;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@ConfigurationProperties("voc.http.client")
+@RequiredArgsConstructor
+@Getter
+public class VocProperties {
+    private final String baseUrl;
+    private final Duration connectTimeout;
+    private final Duration readTimeout;
+}

backend/src/main/java/codezap/voc/config/VocResponseErrorHandler.java

@@ -0,0 +1,37 @@
+package codezap.voc.config;
+
+import java.io.IOException;
+
+import org.springframework.http.HttpStatusCode;
+import org.springframework.http.client.ClientHttpResponse;
+import org.springframework.web.client.ResponseErrorHandler;
+
+import codezap.global.exception.CodeZapException;
+import codezap.global.exception.ErrorCode;
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+public class VocResponseErrorHandler implements ResponseErrorHandler {
+
+    @Override
+    public boolean hasError(ClientHttpResponse response) {
+        try {
+            HttpStatusCode statusCode = response.getStatusCode();
+            return statusCode.isError();
+        } catch (IOException e) {
+            log.error(e.getMessage(), e);
+            throw new CodeZapException(ErrorCode.INTERNAL_SERVER_ERROR, "스프레드시트 API 요청에 실패했습니다.");
+        }
+    }
+
+    @Override
+    public void handleError(ClientHttpResponse response) {
+        try {
+            HttpStatusCode statusCode = response.getStatusCode();
+            log.error("{}", statusCode);
+        } catch (IOException e) {
+            log.error(e.getMessage(), e);
+        }
+        throw new CodeZapException(ErrorCode.INTERNAL_SERVER_ERROR, "스프레드시트 API 요청에 실패했습니다.");
+    }
+}

backend/src/main/java/codezap/voc/controller/SpringDocVocController.java

@@ -0,0 +1,28 @@
+package codezap.voc.controller;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+import codezap.global.swagger.error.ApiErrorResponse;
+import codezap.global.swagger.error.ErrorCase;
+import codezap.voc.dto.VocRequest;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+@Tag(name = "문의하기")
+public interface SpringDocVocController {
+
+    @Operation(summary = "문의하기")
+    @ApiResponse(responseCode = "201", description = "VOC 스프레드시트 데이터 추가 성공")
+    @ApiErrorResponse(
+            status = HttpStatus.BAD_REQUEST,
+            instance = "/contact",
+            errorCases = {
+                    @ErrorCase(description = "문의 내용을 입력하지 않은 경우.", exampleMessage = "문의 내용을 입력해주세요."),
+                    @ErrorCase(description = "문의 내용이 20자 미만인 경우.", exampleMessage = "문의 내용을 20자 이상 입력해주세요."),
+                    @ErrorCase(description = "문의 내용이 10,000 글자를 초과한 경우.", exampleMessage = "문의 내용은 최대 10,000 글자까지 입력할 수 있습니다.")
+            }
+    )
+    ResponseEntity<Void> create(VocRequest request);
+}

backend/src/main/java/codezap/voc/controller/VocController.java

@@ -0,0 +1,25 @@
+package codezap.voc.controller;
+
+import jakarta.validation.Valid;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+
+import codezap.voc.dto.VocRequest;
+import codezap.voc.service.VocService;
+import lombok.RequiredArgsConstructor;
+
+@RestController
+@RequiredArgsConstructor
+public class VocController implements SpringDocVocController {
+
+    private final VocService vocService;
+
+    @PostMapping("/contact")
+    public ResponseEntity<Void> create(@Valid @RequestBody VocRequest request) {
+        vocService.create(request);
+        return ResponseEntity.ok().build();
+    }
+}

backend/src/main/java/codezap/voc/dto/VocRequest.java

@@ -0,0 +1,40 @@
+package codezap.voc.dto;
+
+import jakarta.annotation.Nullable;
+import jakarta.validation.constraints.Email;
+import jakarta.validation.constraints.Min;
+import jakarta.validation.constraints.NotEmpty;
+import jakarta.validation.constraints.Size;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+public record VocRequest(
+
+        @Schema(description = "문의 내용", example = "코드잽 정말 잘 사용하고 있어요. 우테코 6기 코드잽 화이팅!")
+        @NotEmpty(message = "문의 내용은 비어있을 수 없습니다.")
+        @Size(min = 20, max = 10_000, message = "문의 내용은 최소 20자, 최대 10,000 자 입력할 수 있습니다.")
+        String message,
+
+        @Nullable
+        @Schema(description = "이메일(선택)", example = "[email protected]")
+        @Email(regexp = "[a-zA-Z0-9_!#$%&’*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+$", message = "올바른 형식의 이메일 주소여야 합니다.") // Regex from RFC 5322
+        String email,
+
+        @Nullable
+        @Schema(description = "사용자 db id(선택)", example = "1")
+        @Min(value = 1, message = "1 이상이어야 합니다.")
+        Long memberId,
+
+        @Nullable
+        @Schema(description = "사용자 아이디(선택)", example = "만두")
+        @Size(max = 255, message = "아이디는 255자 이하로 입력해주세요.")
+        String name
+) {
+    public VocRequest(String message) {
+        this(message, null);
+    }
+
+    public VocRequest(String message, String email) {
+        this(message, email, null, null);
+    }
+}

backend/src/main/java/codezap/voc/service/VocService.java

@@ -0,0 +1,23 @@
+package codezap.voc.service;
+
+import org.springframework.stereotype.Service;
+import org.springframework.web.client.RestClient;
+
+import codezap.voc.dto.VocRequest;
+
+@Service
+public class VocService {
+
+    private final RestClient restClient;
+
+    public VocService(RestClient.Builder builder) {
+        restClient = builder.build();
+    }
+
+    public void create(VocRequest request) {
+        restClient.post()
+                .body(request)
+                .retrieve()
+                .toBodilessEntity();
+    }
+}

backend/src/main/resources/application-voc.yml

@@ -0,0 +1,6 @@
+voc:
+  http:
+    client:
+      base-url: ${VOC_SPREADSHEET_API_BASE_URL}
+      connect-timeout: 5s
+      read-timeout: 5s

backend/src/main/resources/application.yml

@@ -1,6 +1,6 @@
 spring:
   profiles:
     group:
-      default: local
-      dev: db, actuator, swagger, cors
-      prod: db, actuator, swagger, cors
+      default: local, voc
+      dev: db, actuator, swagger, cors, voc
+      prod: db, actuator, swagger, cors, voc

backend/src/test/java/codezap/global/MockMvcTest.java

@@ -24,6 +24,7 @@
 import codezap.member.service.MemberService;
 import codezap.template.service.facade.TemplateApplicationService;
 import codezap.tag.service.TagService;
+import codezap.voc.service.VocService;
 
 @WebMvcTest(SpringExtension.class)
 @EnableConfigurationProperties(CorsProperties.class)
@@ -51,6 +52,9 @@ public abstract class MockMvcTest {
     @MockBean
     protected LikesService likesService;
 
+    @MockBean
+    private VocService vocService;
+
     @MockBean
     protected TemplateApplicationService templateApplicationService;
 

backend/src/test/java/codezap/voc/config/VocPropertiesTest.java

@@ -0,0 +1,28 @@
+package codezap.voc.config;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertAll;
+
+import java.time.Duration;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest(classes = VocConfiguration.class)
+class VocPropertiesTest {
+
+    @Autowired
+    private VocProperties sut;
+
+    @Test
+    @DisplayName("yml 파일로부터 http client 관련 설정 값을 가져오는지 확인")
+    void getAllowedOrigins() {
+        assertAll(
+                () -> assertThat(sut.getBaseUrl()).isEqualTo("http://localhost:8080"),
+                () -> assertThat(sut.getConnectTimeout()).isEqualTo(Duration.ofSeconds(5L)),
+                () -> assertThat(sut.getReadTimeout()).isEqualTo(Duration.ofSeconds(5L))
+        );
+    }
+}

backend/src/test/java/codezap/voc/controller/VocControllerTest.java

@@ -0,0 +1,34 @@
+package codezap.voc.controller;
+
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.context.annotation.Import;
+import org.springframework.http.MediaType;
+
+import codezap.global.MockMvcTest;
+import codezap.voc.dto.VocRequest;
+
+@Import(VocController.class)
+class VocControllerTest extends MockMvcTest {
+
+    @Test
+    @DisplayName("문의하기 요청 성공")
+    void create() throws Exception {
+        var request = new VocRequest("lorem ipsum dolor sit amet consectetur adipiscing elit", null);
+
+        mvc.perform(post("/contact")
+                        .content(objectMapper.writeValueAsString(request))
+                        .contentType(MediaType.APPLICATION_JSON))
+                .andExpect(status().isOk());
+    }
+
+    @Test
+    @DisplayName("문의하기 요청 실패 : 요청 본문 없음")
+    void create_error() throws Exception {
+        mvc.perform(post("/contact"))
+                .andExpect(status().isBadRequest());
+    }
+}