Merge pull request #24 from boostcampwm-2022/10-be-oauth-구현체-구현

BE - oauth 구현체 구현 (kakao, naver)

Author: punkryn

backend/package.json

@@ -7,7 +7,7 @@
   "license": "UNLICENSED",
   "scripts": {
     "prebuild": "rimraf dist",
-    "build": "nest build",
+    "build": "nest build && tsc-alias",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "start": "nest start",
     "start:dev": "nest start --watch",
@@ -31,6 +31,7 @@
     "@nestjs/typeorm": "^9.0.1",
     "@types/cookie-parser": "^1.4.3",
     "@types/helmet": "^4.0.0",
+    "axios": "^1.1.3",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.13.2",
     "cookie-parser": "^1.4.6",
@@ -68,6 +69,7 @@
     "ts-jest": "28.0.8",
     "ts-loader": "^9.2.3",
     "ts-node": "^10.0.0",
+    "tsc-alias": "^1.7.1",
     "tsconfig-paths": "4.1.0",
     "typescript": "^4.7.4"
   },
@@ -86,6 +88,12 @@
       "**/*.(t|j)s"
     ],
     "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
+    "testEnvironment": "node",
+    "moduleNameMapper": {
+      "@config": "<rootDir>/config/index",
+      "@constant": "<rootDir>/constant/index",
+      "@types": "<rootDir>/types/index",
+      "^src/(.*)$": "<rootDir>/$1"
+    }
   }
 }

backend/src/auth/auth.module.ts

@@ -4,21 +4,23 @@ import { AuthController } from './controller/auth.controller';
 import { TypeormUserRepository } from 'src/user/repository/typeorm-user.repository';
 import { USER_REPOSITORY_INTERFACE } from '@constant';
 import { UserModule } from 'src/user/user.module';
-import { OauthGoogleService } from './service/oauth/google-oauth.service';
 import { OauthNaverService } from './service/oauth/naver-oauth.service';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { OauthKakaoService } from './service/oauth/kakao-oauth.service';
 import { JwtService } from '@nestjs/jwt';
 import { ConfigService } from '@nestjs/config';
 import { JwtAccessStrategy } from './jwt/access-jwt.strategy';
 import { JwtRefreshStrategy } from './jwt/refresh-jwt.strategy';
 
-const userRepository: ClassProvider = {
+export const UserRepository: ClassProvider = {
 	provide: USER_REPOSITORY_INTERFACE,
 	useClass: TypeormUserRepository,
 };
 
 @Module({
-	imports: [UserModule],
+	imports: [UserModule, TypeOrmModule.forFeature([TypeormUserRepository])],
 	controllers: [AuthController],
+	providers: [AuthService, UserRepository, OauthKakaoService, OauthNaverService],
 	providers: [
 		AuthService,
 		userRepository,

backend/src/auth/controller/auth.controller.spec.ts

@@ -1,3 +1,4 @@
+import { Response } from 'express';
 import {
 	Controller,
 	Get,
@@ -28,18 +29,19 @@ export class AuthController {
 	constructor(private readonly authService: AuthService) {}
 
 	@Get('oauth/redirect/:type')
-	@Redirect('/', 301)
-	redirectOauthPage(@Param('type') type: string) {
-		return this.authService.getSocialUrl(type);
+	@HttpCode(301)
+	redirectOauthPage(@Param('type') type: string, @Res() res: Response) {
+		const pageUrl = this.authService.getSocialUrl(type);
+		res.redirect(pageUrl);
 	}
 
 	@Get('oauth/callback/:type')
 	async socialStart(
-		@Query('authorization_code') authorizationCode: string,
+		@Query('code') authorizationCode: string,
 		@Param('type') type: string,
 		@Res({ passthrough: true }) res: Response
 	) {
-		// const user = await this.authService.socialStart({ type, authorizationCode });
+		const user = await this.authService.socialStart({ type, authorizationCode });
 		const accessToken = this.authService.createJwt({
 			payload: { nickname: 'user.nickname', email: 'user.email' },
 			secret: JWT_ACCESS_TOKEN_SECRET,

backend/src/auth/controller/auth.controller.ts

@@ -1,18 +1,100 @@
+import { USER_REPOSITORY_INTERFACE } from '@constant';
 import { Test, TestingModule } from '@nestjs/testing';
+import { UserInfo } from 'src/types/auth.type';
+import { MockRepository } from 'src/types/mock.type';
+import { JoinUserBuilder, UserEntity } from 'src/user/entities/typeorm-user.entity';
+import { UserRepository } from 'src/user/repository/interface-user.repository';
 import { AuthService } from './auth.service';
+import { OauthKakaoService } from './oauth/kakao-oauth.service';
+import { OauthNaverService } from './oauth/naver-oauth.service';
+
+const mockUserRepository = () => ({
+	saveUser: jest.fn(),
+	findUserById: jest.fn(),
+	findAllUser: jest.fn(),
+});
 
 describe('AuthService', () => {
-	let service: AuthService;
+	let authService: AuthService;
+	let userRepository: MockRepository<UserRepository<UserEntity>>;
+	let oauthGoogleService: OauthKakaoService;
+	let oauthNaverService: OauthNaverService;
 
 	beforeEach(async () => {
 		const module: TestingModule = await Test.createTestingModule({
-			providers: [AuthService],
+			providers: [
+				AuthService,
+				{
+					provide: USER_REPOSITORY_INTERFACE,
+					useValue: mockUserRepository(),
+				},
+				OauthKakaoService,
+				OauthNaverService,
+			],
 		}).compile();
 
-		service = module.get<AuthService>(AuthService);
+		authService = module.get(AuthService);
+		userRepository = module.get(USER_REPOSITORY_INTERFACE);
+		oauthNaverService = module.get(OauthNaverService);
+		oauthGoogleService = module.get(OauthKakaoService);
+	});
+
+	describe('valid case', () => {
+		it('의존성 주입 테스트', () => {
+			expect(authService).toBeDefined();
+			expect(userRepository).toBeDefined();
+			expect(oauthNaverService).toBeDefined();
+			expect(oauthGoogleService).toBeDefined();
+		});
+
+		it('유저의 OAuth로 시작 테스트', async () => {
+			const user = makeMockUser({ id: 'testId', oauthType: 'naver' } as UserInfo);
+
+			jest.spyOn(oauthNaverService, 'getAccessTokenByAuthorizationCode').mockResolvedValue(
+				'success'
+			);
+			jest.spyOn(oauthNaverService, 'getSocialInfoByAccessToken').mockResolvedValue(user);
+			jest.spyOn(userRepository, 'saveUser').mockResolvedValue(user);
+
+			const joinedUser = await authService.socialStart({
+				type: 'naver',
+				authorizationCode: 'test',
+			});
+
+			expect(user).toEqual(joinedUser);
+		});
 	});
 
-	it('should be defined', () => {
-		expect(service).toBeDefined();
+	describe('error case', () => {
+		it('유저의 OAuth 승인 취소 테스트', async () => {
+			try {
+				await authService.socialStart({ type: 'naver', authorizationCode: undefined });
+			} catch (err) {
+				expect(err).toBeInstanceOf(Error);
+				expect(err.message).toBe('social 인증이 되지 않았습니다.');
+			}
+		});
+
+		it('옳바른 OAuth타입이 아닐 때의 오류 테스트', async () => {
+			try {
+				await authService.socialStart({ type: 'invalid', authorizationCode: 'authCode' });
+			} catch (err) {
+				expect(err).toBeInstanceOf(Error);
+				expect(err.message).toBe('');
+			}
+		});
 	});
+
+	const makeMockUser = (userInfo: UserInfo): UserEntity => {
+		const { id, email, password, nickname, oauthType } = userInfo;
+		const userEntity = new JoinUserBuilder()
+			.setId(id)
+			.setEmail(email)
+			.setPassword(password)
+			.setNickname(nickname)
+			.setOauthType(oauthType)
+			.setDefaultValue()
+			.build();
+		return userEntity;
+	};
 });

backend/src/auth/service/auth.service.spec.ts

@@ -3,9 +3,9 @@ import { Inject, Injectable } from '@nestjs/common';
 import { UserInfo } from 'src/types/auth.type';
 import { UserEntity } from 'src/user/entities/typeorm-user.entity';
 import { UserRepository } from 'src/user/repository/interface-user.repository';
-import { OauthGoogleService } from './oauth/google-oauth.service';
 import { OauthNaverService } from './oauth/naver-oauth.service';
 import { OauthService } from './oauth/interface-oauth.service';
+import { OauthKakaoService } from './oauth/kakao-oauth.service';
 import { JwtService } from '@nestjs/jwt';
 import { ConfigService } from '@nestjs/config';
 import { CreateJwtDto } from '../dto/create-jwt.dto';
@@ -18,8 +18,8 @@ export class AuthService {
 		@Inject(USER_REPOSITORY_INTERFACE)
 		private readonly userRepository: UserRepository<UserEntity>,
 
-		private readonly oauthGoogleService: OauthGoogleService,
-		private readonly oauthNaverService: OauthNaverService,
+		private readonly oauthKakaoService: OauthKakaoService,
+		private readonly oauthNaverService: OauthNaverService
 
 		private jwtService: JwtService,
 		private configService: ConfigService
@@ -46,6 +46,8 @@ export class AuthService {
 	async socialStart({ type, authorizationCode }: { type: string; authorizationCode: string }) {
 		this.setOauthInstanceByType(type);
 
+		if (!authorizationCode) throw new Error('social 인증이 되지 않았습니다.');
+
 		const accessToken = await this.oauthInstance.getAccessTokenByAuthorizationCode(
 			authorizationCode
 		);
@@ -88,8 +90,8 @@ export class AuthService {
 			case OAUTH_TYPE.NAVER:
 				this.oauthInstance = this.oauthNaverService;
 				break;
-			case OAUTH_TYPE.GOOGLE:
-				this.oauthInstance = this.oauthGoogleService;
+			case OAUTH_TYPE.KAKAO:
+				this.oauthInstance = this.oauthKakaoService;
 				break;
 			default:
 				throw new Error();

backend/src/auth/service/auth.service.ts

@@ -1,7 +1,22 @@
 import { UserSocialInfo } from 'src/types/auth.type';
 
 export interface OauthService {
+	/**
+	 * 해당하는 oauth type에 따른 authorization page url을 반환합니다.
+	 */
 	getSocialUrl(): string;
+
+	/**
+	 * social login을 승인 시 반환되는 authorization code를 전달하여 access token을 받아서 반환합니다.
+	 * @param authorizationCode social login으로 얻은 authorization code
+	 * @return accessToken - social 인증으로 얻은 accessToken
+	 */
 	getAccessTokenByAuthorizationCode(authorizationCode: string): Promise<string>;
+
+	/**
+	 * accessToken으로 해당 social에 profile 조회 api를 통해 user 정보를 얻어 반환합니다.
+	 * @param accessToken
+	 * @return userInfo
+	 */
 	getSocialInfoByAccessToken(accessToken: string): Promise<UserSocialInfo>;
 }

backend/src/auth/service/oauth/google-oauth.service.ts

@@ -0,0 +1,56 @@
+import {
+	AUTHORIZATION_TOKEN_TYPE,
+	KAKAO_ACCESS_TOKEN_URL,
+	KAKAO_AUTHORIZE_PAGE_URL,
+	KAKAO_PROFILE_API_URL,
+	OAUTH_CALLBACK_URL,
+	OAUTH_TYPE,
+} from '@constant';
+import { Injectable } from '@nestjs/common';
+import axios from 'axios';
+import { UserSocialInfo } from 'src/types/auth.type';
+import { OauthService } from './interface-oauth.service';
+
+@Injectable()
+export class OauthKakaoService implements OauthService {
+	private clientId = process.env.KAKAO_CLIENT_ID;
+	private clientSecret = process.env.KAKAO_CLIENT_SECRET;
+	private callbackUrl = [
+		process.env.SERVER_ORIGIN_URL,
+		OAUTH_CALLBACK_URL,
+		OAUTH_TYPE.KAKAO,
+	].join('/');
+
+	getSocialUrl(): string {
+		const queryString = `?response_type=code&client_id=${this.clientId}&redirect_uri=${this.callbackUrl}`;
+		return KAKAO_AUTHORIZE_PAGE_URL + queryString;
+	}
+
+	async getAccessTokenByAuthorizationCode(authorizationCode: string): Promise<string> {
+		const queryString =
+			`?grant_type=authorization_code` +
+			`&client_id=${this.clientId}&client_secret=${this.clientSecret}` +
+			`&redirect_uri=${this.callbackUrl}&code=${authorizationCode}`;
+
+		const { access_token } = await axios
+			.get(KAKAO_ACCESS_TOKEN_URL + queryString)
+			.then((res) => res.data);
+		console.log(access_token);
+		return access_token;
+	}
+
+	/**
+	 * @link https://developers.kakao.com/docs/latest/ko/kakaologin/rest-api#req-user-info
+	 * @param accessToken
+	 * @returns userInfo
+	 */
+	async getSocialInfoByAccessToken(accessToken: string): Promise<UserSocialInfo> {
+		const headers = { Authorization: `${AUTHORIZATION_TOKEN_TYPE} ${accessToken}` };
+		const res = await axios.get(KAKAO_PROFILE_API_URL, { headers }).then((res) => res.data);
+
+		const user = res['kakao_account'] as UserSocialInfo;
+		user.id = res.id;
+		user.oauthType = OAUTH_TYPE.KAKAO;
+		return user;
+	}
+}