Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#270 [fix] /authorize 명세 수정 #271

Merged
merged 5 commits into from
Jun 26, 2024
Merged

#270 [fix] /authorize 명세 수정 #271

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e6685d4
#270 [fix] response dto 수정
KWY0218 Jun 25, 2024
4295dae
#270 [fix] response 메시지 수정
KWY0218 Jun 25, 2024
24e49b3
#270 [feat] response data 수정
KWY0218 Jun 25, 2024
fa92952
#270 [test] /authorize 테스트 코드 수정
KWY0218 Jun 25, 2024
0859f5d
#270 [chore] template에서 format으로 상수명 수정
KWY0218 Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions operation-api/src/main/java/org/sopt/makers/operation/auth/api/AuthApiController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,24 @@
package org.sopt.makers.operation.auth.api;

import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.EXPIRED_PLATFORM_CODE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.EXPIRED_REFRESH_TOKEN;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.INVALID_GRANT_TYPE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.INVALID_SOCIAL_TYPE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.NOT_FOUNT_REGISTERED_TEAM;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.NOT_NULL_CODE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.NOT_NULL_GRANT_TYPE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.NOT_NULL_REFRESH_TOKEN;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.USED_PLATFORM_CODE;
import static org.sopt.makers.operation.code.success.auth.AuthSuccessCode.SUCCESS_GENERATE_TOKEN;
import static org.sopt.makers.operation.code.success.auth.AuthSuccessCode.SUCCESS_RETURN_REDIRECT_URL_WITH_PLATFORM_CODE;
import static org.sopt.makers.operation.jwt.JwtTokenType.PLATFORM_CODE;
import static org.sopt.makers.operation.jwt.JwtTokenType.REFRESH_TOKEN;
Comment on lines +3 to +15
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P4

static import 문을 import 선언 섹션의 최하단이 아닌 최상단으로 옮기신 이유가 따로 있나요?!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

자동 정렬이 시켰습니다..!
다시 변경할까 싶었는데, 변수를 선언할 때도 항상 상수를 위에 다 정의한 것이 떠올라 커밋했습니다..!


import java.util.concurrent.ConcurrentHashMap;
import lombok.RequiredArgsConstructor;
import lombok.val;
import org.sopt.makers.operation.auth.dto.request.AccessTokenRequest;
import org.sopt.makers.operation.auth.dto.response.AuthorizationCodeResponse;
import org.sopt.makers.operation.auth.dto.response.RedirectUrlResponse;
import org.sopt.makers.operation.auth.dto.response.TokenResponse;
import org.sopt.makers.operation.auth.service.AuthService;
import org.sopt.makers.operation.dto.BaseResponse;
Expand All @@ -20,29 +35,14 @@
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.concurrent.ConcurrentHashMap;

import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.EXPIRED_PLATFORM_CODE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.EXPIRED_REFRESH_TOKEN;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.INVALID_GRANT_TYPE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.INVALID_SOCIAL_TYPE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.NOT_FOUNT_REGISTERED_TEAM;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.NOT_NULL_CODE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.NOT_NULL_GRANT_TYPE;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.NOT_NULL_REFRESH_TOKEN;
import static org.sopt.makers.operation.code.failure.auth.AuthFailureCode.USED_PLATFORM_CODE;
import static org.sopt.makers.operation.code.success.auth.AuthSuccessCode.SUCCESS_GENERATE_TOKEN;
import static org.sopt.makers.operation.code.success.auth.AuthSuccessCode.SUCCESS_GET_AUTHORIZATION_CODE;
import static org.sopt.makers.operation.jwt.JwtTokenType.PLATFORM_CODE;
import static org.sopt.makers.operation.jwt.JwtTokenType.REFRESH_TOKEN;

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/auth")
public class AuthApiController implements AuthApi {

private static final String AUTHORIZATION_CODE_GRANT_TYPE = "authorizationCode";
private static final String REFRESH_TOKEN_GRANT_TYPE = "refreshToken";
private static final String REDIRECT_URL_WITH_CODE_TEMPLATE = "%s?code=%s";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P4

네이밍을 Template으로 가져가신 이유가 무엇인가요?!
통상적으로 %s, %d와 같이 정규식 문법을 사용할 땐 format이라는 표현을 많이 쓴다고 생각하여 다른 이유가 있었는지 궁금합니다!!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

저 때 template이란 단어가 생각나서 사용했습니다.
혹시 어색할까요??

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KWY0218 아무래도 정규식을 사용하고 실제 String.format() 함수에서 사용하는 상수값이다 보니 의미 전달력이 조금 떨어지지 않을까 생각했어요!!

급한 부분은 아니니 만약 동의하신다면 추후 커밋에 슬-쩍 포함해서 변경해주셔도 무관할 것 같습니다!! 👍


private final ConcurrentHashMap<String, String> tempPlatformCode;
private final AuthService authService;
Expand All @@ -65,7 +65,8 @@ public ResponseEntity<BaseResponse<?>> authorize(

val userId = findUserIdBySocialTypeAndCode(type, code);
val platformCode = generatePlatformCode(clientId, redirectUri, userId);
return ApiResponseUtil.success(SUCCESS_GET_AUTHORIZATION_CODE, new AuthorizationCodeResponse(platformCode));
val redirectUrl = String.format(REDIRECT_URL_WITH_CODE_TEMPLATE, redirectUri, platformCode);
return ApiResponseUtil.success(SUCCESS_RETURN_REDIRECT_URL_WITH_PLATFORM_CODE, new RedirectUrlResponse(redirectUrl));
}

@Override
Expand Down
4 changes: 0 additions & 4 deletions .../src/main/java/org/sopt/makers/operation/auth/dto/response/AuthorizationCodeResponse.java
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions ...on-api/src/main/java/org/sopt/makers/operation/auth/dto/response/RedirectUrlResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
package org.sopt.makers.operation.auth.dto.response;

public record RedirectUrlResponse(String redirectUrl) {
}
5 changes: 3 additions & 2 deletions operation-api/src/test/java/org/sopt/makers/operation/auth/api/AuthApiControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ class SuccessTest {
@DisplayName("유효한 type, code, clientId, redirectUri 값이 들어왔을 때, 플랫폼 인가코드를 반환한다.")
@ParameterizedTest
@CsvSource({
"APPLE,code,clientId,redirectUri"
"APPLE,code,clientId,https://localhost:8080/auth/redirectUri"
})
void successTest(String type, String code, String clientId, String redirectUri) throws Exception {
// given
Expand All @@ -71,7 +71,8 @@ void successTest(String type, String code, String clientId, String redirectUri)
.param("clientId", clientId)
.param("redirectUri", redirectUri))
.andExpect(status().isOk())
.andExpect(jsonPath("$.message").value("플랫폼 인가코드 발급 성공"));
.andExpect(jsonPath("$.message").value("플랫폼 인가코드를 포함한 redirect url 반환 성공"))
.andExpect(jsonPath("$.data.redirectUrl").value("https://localhost:8080/auth/redirectUri?code=Platform Code"));
}

@DisplayName("grantType 이 authorizationCode 이고, 유효한 clientId, redirectUri, code 값이 들어왔을 때, 액세스 토큰과 리프레시 토큰을 발급한다.")
Expand Down
2 changes: 1 addition & 1 deletion ...ion-common/src/main/java/org/sopt/makers/operation/code/success/auth/AuthSuccessCode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
@Getter
@RequiredArgsConstructor
public enum AuthSuccessCode implements SuccessCode {
SUCCESS_GET_AUTHORIZATION_CODE(OK, "플랫폼 인가코드 발급 성공"),
SUCCESS_RETURN_REDIRECT_URL_WITH_PLATFORM_CODE(OK, "플랫폼 인가코드를 포함한 redirect url 반환 성공"),
SUCCESS_GENERATE_TOKEN(OK, "토큰 발급 성공");
private final HttpStatus status;
private final String message;
Expand Down
Loading