diff --git a/README.md b/README.md index b4de073..90cfbc4 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ ## Quick Start README에 아래 코드를 추가하고 `사용자명`을 본인의 Dreamhack 닉네임으로 변경하세요. +닉네임에 `&`, `#`, `+`, 공백 같은 특수문자가 있다면 [메인 페이지](https://dreamhack-readme-stats.vercel.app)에서 코드를 생성하세요. URL에 맞게 자동으로 인코딩됩니다. ### Wargame Stats @@ -34,9 +35,9 @@ README에 아래 코드를 추가하고 `사용자명`을 본인의 Dreamhack ![Dreamhack Categories](https://dreamhack-readme-stats.vercel.app/api/most-solved?username=사용자명) ``` -> 💡 클릭 시 Dreamhack 프로필로 이동하게 하려면 HTML 사용: +> 💡 클릭 시 Dreamhack 프로필로 이동하게 하려면 HTML 사용 (`사용자ID`는 프로필 주소 `https://dreamhack.io/users/12345`의 숫자이며, 메인 페이지에서 미리보기하면 자동으로 채워집니다): > ```html -> +> > > > ``` diff --git a/src/__tests__/pages/api/most-solved.test.ts b/src/__tests__/pages/api/most-solved.test.ts index 08e87b1..fa3f0a5 100644 --- a/src/__tests__/pages/api/most-solved.test.ts +++ b/src/__tests__/pages/api/most-solved.test.ts @@ -133,48 +133,48 @@ describe('most-solved API 엔드포인트 테스트', () => { expect(generateSvgArg.categories).toHaveLength(0); }); - it('사용자 이름이 없을 때 400 에러를 반환해야 함', async () => { - // HTTP 요청 모킹 (사용자 이름 없음) + it('사용자 이름이 없을 때 안내 카드를 반환해야 함', async () => { const { req, res } = createMocks({ method: 'GET', query: {}, }); - // API 핸들러 호출 await handler(req, res); - // 응답 검증 - expect(res._getStatusCode()).toBe(400); - expect(JSON.parse(res._getData())).toEqual({ error: 'Username is required' }); + expect(res._getStatusCode()).toBe(200); + expect(res._getHeaders()).toHaveProperty('content-type', 'image/svg+xml'); + expect(res._getHeaders()).toHaveProperty('cache-control', 'no-cache, no-store, must-revalidate'); + expect(res._getData()).toContain('Most Solved Categories'); + expect(res._getData()).toContain('Missing username'); }); - it('사용자를 찾을 수 없을 때 400 에러를 반환해야 함', async () => { - // 모킹된 함수 구현 (사용자 ID가 null) + it('사용자를 찾을 수 없을 때 안내 카드를 반환해야 함', async () => { (dreamhackUtils.getUserId as jest.Mock).mockResolvedValueOnce(null); - // HTTP 요청 모킹 const { req, res } = createMocks({ method: 'GET', query: { username: 'nonexistentuser', + theme: 'dark', }, }); - // API 핸들러 호출 await handler(req, res); - // 응답 검증 - expect(res._getStatusCode()).toBe(400); - expect(JSON.parse(res._getData())).toEqual({ error: 'User not found' }); + expect(res._getStatusCode()).toBe(200); + expect(res._getHeaders()).toHaveProperty('content-type', 'image/svg+xml'); + expect(res._getHeaders()).toHaveProperty('cache-control', 'no-cache, no-store, must-revalidate'); + expect(res._getData()).toContain('User not found'); + expect(res._getData()).toContain('nonexistentuser'); + // 다크 테마 배경색 적용 + expect(res._getData()).toContain('#0d1117'); }); - it('사용자 데이터를 가져올 수 없을 때 400 에러를 반환해야 함', async () => { - // 모킹된 함수 구현 + it('사용자 데이터를 가져올 수 없을 때 오류 카드를 반환해야 함', async () => { const username = 'weakness'; (dreamhackUtils.getUserId as jest.Mock).mockResolvedValueOnce(123); (dreamhackUtils.getUserData as jest.Mock).mockResolvedValueOnce(null); - // HTTP 요청 모킹 const { req, res } = createMocks({ method: 'GET', query: { @@ -182,20 +182,18 @@ describe('most-solved API 엔드포인트 테스트', () => { }, }); - // API 핸들러 호출 await handler(req, res); - // 응답 검증 - expect(res._getStatusCode()).toBe(400); - expect(JSON.parse(res._getData())).toEqual({ error: 'User information cannot be read.' }); + expect(res._getStatusCode()).toBe(200); + expect(res._getHeaders()).toHaveProperty('content-type', 'image/svg+xml'); + expect(res._getHeaders()).toHaveProperty('cache-control', 'no-cache, no-store, must-revalidate'); + expect(res._getData()).toContain('Failed to load stats'); expect(dreamhackUtils.getUserData).toHaveBeenCalledWith(123, username); }); - it('예외 발생 시 500 에러를 반환해야 함', async () => { - // 모킹된 함수 구현 (예외 발생) + it('예외 발생 시 오류 카드를 반환해야 함', async () => { (dreamhackUtils.getUserId as jest.Mock).mockRejectedValueOnce(new Error('테스트 에러')); - // HTTP 요청 모킹 const { req, res } = createMocks({ method: 'GET', query: { @@ -203,11 +201,11 @@ describe('most-solved API 엔드포인트 테스트', () => { }, }); - // API 핸들러 호출 await handler(req, res); - // 응답 검증 - expect(res._getStatusCode()).toBe(500); - expect(JSON.parse(res._getData())).toEqual({ error: 'Internal Server Error' }); + expect(res._getStatusCode()).toBe(200); + expect(res._getHeaders()).toHaveProperty('content-type', 'image/svg+xml'); + expect(res._getHeaders()).toHaveProperty('cache-control', 'no-cache, no-store, must-revalidate'); + expect(res._getData()).toContain('Failed to load stats'); }); }); \ No newline at end of file diff --git a/src/__tests__/pages/api/stats.test.ts b/src/__tests__/pages/api/stats.test.ts index 1e28941..84911a5 100644 --- a/src/__tests__/pages/api/stats.test.ts +++ b/src/__tests__/pages/api/stats.test.ts @@ -123,26 +123,23 @@ describe('stats API 엔드포인트 테스트', () => { ); }); - it('사용자 이름이 없을 때 400 에러를 반환해야 함', async () => { - // HTTP 요청 모킹 (사용자 이름 없음) + it('사용자 이름이 없을 때 안내 카드를 반환해야 함', async () => { const { req, res } = createMocks({ method: 'GET', query: {}, }); - // API 핸들러 호출 await handler(req, res); - // 응답 검증 - expect(res._getStatusCode()).toBe(400); - expect(JSON.parse(res._getData())).toEqual({ error: 'Username is required' }); + expect(res._getStatusCode()).toBe(200); + expect(res._getHeaders()).toHaveProperty('content-type', 'image/svg+xml'); + expect(res._getHeaders()).toHaveProperty('cache-control', 'no-cache, no-store, must-revalidate'); + expect(res._getData()).toContain('Missing username'); }); - it('사용자를 찾을 수 없을 때 400 에러를 반환해야 함', async () => { - // 모킹된 함수 구현 (사용자 ID가 null) + it('사용자를 찾을 수 없을 때 안내 카드를 반환해야 함', async () => { (dreamhackUtils.getUserId as jest.Mock).mockResolvedValueOnce(null); - // HTTP 요청 모킹 const { req, res } = createMocks({ method: 'GET', query: { @@ -150,20 +147,37 @@ describe('stats API 엔드포인트 테스트', () => { }, }); - // API 핸들러 호출 await handler(req, res); - // 응답 검증 - expect(res._getStatusCode()).toBe(400); - expect(JSON.parse(res._getData())).toEqual({ error: 'User not found' }); + expect(res._getStatusCode()).toBe(200); + expect(res._getHeaders()).toHaveProperty('content-type', 'image/svg+xml'); + expect(res._getHeaders()).toHaveProperty('cache-control', 'no-cache, no-store, must-revalidate'); + expect(res._getData()).toContain('User not found'); + expect(res._getData()).toContain('nonexistentuser'); + // 사용자가 없으면 마지막 랭크는 조회하지 않음 + expect(dreamhackUtils.getLastRank).not.toHaveBeenCalled(); }); - it('마지막 랭크를 가져올 수 없을 때 500 에러를 반환해야 함', async () => { - // 모킹된 함수 구현 + it('안내 카드에 표시하는 닉네임을 이스케이프해야 함', async () => { + (dreamhackUtils.getUserId as jest.Mock).mockResolvedValueOnce(null); + + const { req, res } = createMocks({ + method: 'GET', + query: { + username: '', + }, + }); + + await handler(req, res); + + expect(res._getData()).not.toContain('', 'system("/bin/sh")']) { + const result = generateStatsSvg({ ...mockStats, nickname }); - const result = generateStatsSvg(specialStats); - - // 특수 문자가 포함된 사용자 이름이 SVG에 포함되어 있는지 확인 - expect(result).toContain('test'); + // XML로 파싱되고, 닉네임이 태그가 아닌 텍스트로 들어가야 함 + const doc = new DOMParser().parseFromString(result.trim(), 'image/svg+xml'); + expect(doc.getElementsByTagName('parsererror')).toHaveLength(0); + expect(doc.getElementsByTagName('script')).toHaveLength(0); + expect(doc.querySelector('.user-name')?.textContent).toBe(nickname); + } }); it('긴 사용자 이름을 처리할 수 있어야 함', () => { diff --git a/src/__tests__/utils/redis.test.ts b/src/__tests__/utils/redis.test.ts index 9be7f72..ce50f2b 100644 --- a/src/__tests__/utils/redis.test.ts +++ b/src/__tests__/utils/redis.test.ts @@ -1,4 +1,11 @@ -import { saveUserIdToCache, getUserIdFromCache, __setRedisClientForTesting } from '../../utils/redis'; +import { + saveUserIdToCache, + getUserIdFromCache, + deleteUserIdFromCache, + saveUserNotFoundToCache, + isUserNotFoundCached, + __setRedisClientForTesting, +} from '../../utils/redis'; import Redis from 'ioredis'; // 테스트 환경 설정 (process.env.NODE_ENV는 jest에 의해 'test'로 설정됨) @@ -11,6 +18,7 @@ jest.mock('ioredis'); const mockRedis = new Redis() as jest.Mocked; mockRedis.get = jest.fn(); mockRedis.set = jest.fn(); +mockRedis.del = jest.fn(); // 테스트용 Redis 클라이언트 설정 beforeAll(() => { @@ -31,6 +39,7 @@ describe('Redis 유틸리티 함수 테스트', () => { await saveUserIdToCache('testuser', 12345); expect(mockRedis.set).toHaveBeenCalledWith('userId:testuser', 12345); + expect(mockRedis.del).toHaveBeenCalledWith('userNotFound:testuser'); expect(console.log).toHaveBeenCalledWith(expect.stringContaining('Redis에 사용자 ID 저장 완료')); }); @@ -75,4 +84,52 @@ describe('Redis 유틸리티 함수 테스트', () => { expect(console.error).toHaveBeenCalledWith('Redis에서 사용자 ID 조회 실패:', mockError); }); }); -}); \ No newline at end of file + + describe('deleteUserIdFromCache 함수', () => { + it('Redis에서 사용자 ID를 삭제해야 함', async () => { + mockRedis.del.mockResolvedValueOnce(1); + + await deleteUserIdFromCache('testuser'); + + expect(mockRedis.del).toHaveBeenCalledWith('userId:testuser'); + }); + + it('예외 발생 시 오류를 기록해야 함', async () => { + const mockError = new Error('Redis 연결 오류'); + mockRedis.del.mockRejectedValueOnce(mockError); + + await deleteUserIdFromCache('testuser'); + + expect(console.error).toHaveBeenCalledWith('Redis에서 사용자 ID 삭제 실패:', mockError); + }); + }); + + describe('미존재 사용자 캐시 함수', () => { + it('찾지 못한 닉네임을 10분 동안 저장해야 함', async () => { + mockRedis.set.mockResolvedValueOnce('OK'); + + await saveUserNotFoundToCache('nonexistentuser'); + + expect(mockRedis.set).toHaveBeenCalledWith('userNotFound:nonexistentuser', '1', 'EX', 600); + }); + + it('저장된 닉네임이면 true를 반환해야 함', async () => { + mockRedis.get.mockResolvedValueOnce('1'); + + expect(await isUserNotFoundCached('nonexistentuser')).toBe(true); + expect(mockRedis.get).toHaveBeenCalledWith('userNotFound:nonexistentuser'); + }); + + it('저장되지 않은 닉네임이면 false를 반환해야 함', async () => { + mockRedis.get.mockResolvedValueOnce(null); + + expect(await isUserNotFoundCached('weakness')).toBe(false); + }); + + it('조회 중 예외가 나면 false를 반환해야 함', async () => { + mockRedis.get.mockRejectedValueOnce(new Error('Redis 연결 오류')); + + expect(await isUserNotFoundCached('weakness')).toBe(false); + }); + }); +}); diff --git a/src/__tests__/utils/svg.test.ts b/src/__tests__/utils/svg.test.ts new file mode 100644 index 0000000..c6908a7 --- /dev/null +++ b/src/__tests__/utils/svg.test.ts @@ -0,0 +1,23 @@ +import { escapeXml } from '../../utils/svg'; + +describe('escapeXml 함수 테스트', () => { + it('XML 특수 문자를 이스케이프해야 함', () => { + expect(escapeXml(`a&bd"e'f`)).toBe('a&b<c>d"e'f'); + }); + + it('이미 이스케이프된 문자열의 &도 다시 이스케이프해야 함', () => { + expect(escapeXml('&')).toBe('&amp;'); + }); + + it('XML에서 허용되지 않는 제어 문자를 제거해야 함', () => { + expect(escapeXml('a\u0000b\u0008c\u001Fd')).toBe('abcd'); + }); + + it('탭, 줄바꿈, 한글, 이모지는 그대로 두어야 함', () => { + expect(escapeXml('꿈나라역1번출구\t🐿\n')).toBe('꿈나라역1번출구\t🐿\n'); + }); + + it('숫자도 문자열로 변환해야 함', () => { + expect(escapeXml(5000)).toBe('5000'); + }); +}); diff --git a/src/pages/api/most-solved.ts b/src/pages/api/most-solved.ts index 77b4f17..b9753b8 100644 --- a/src/pages/api/most-solved.ts +++ b/src/pages/api/most-solved.ts @@ -1,8 +1,16 @@ import { NextApiRequest, NextApiResponse } from 'next'; import { TCategoryData, TCategoryStats, Theme } from '../../types'; import { generateCategorySvg } from '../../utils/generateCategorySvg'; +import { generateErrorSvg, errorCards } from '../../utils/generateErrorSvg'; +import { sendSvg } from '../../utils/svg'; import { getUserId, getUserData } from '../../utils/dreamhack'; +// 처음 조회하는 닉네임은 Dreamhack 검색이 여러 번 필요해 기본 10초를 넘을 수 있음 +// (요청당 타임아웃 10초 × 최대 5단계 + 여유, Hobby 플랜 최대값) +export const config = { maxDuration: 60 }; + +const CARD_TITLE = 'Most Solved Categories'; + // 성능 측정을 위한 유틸리티 함수 const measureTime = async (name: string, fn: () => Promise): Promise => { console.time(`⏱️ ${name}`); @@ -30,30 +38,30 @@ const defaultColors = [ ]; export default async function handler(req: NextApiRequest, res: NextApiResponse) { - console.time('⏱️ 전체 API 실행 시간'); const { username, theme: themeParam } = req.query; - if (!username || typeof username !== 'string') { - return res.status(400).json({ error: 'Username is required' }); - } - // 테마 파라미터 검증 const theme: Theme = themeParam === 'dark' ? 'dark' : 'light'; + if (!username || typeof username !== 'string') { + return sendSvg(res, generateErrorSvg(errorCards.missingUsername(CARD_TITLE), theme)); + } + + console.time('⏱️ 전체 API 실행 시간'); try { // 개별 API 호출 시간 측정 - const userId = await measureTime('getUserId', () => getUserId(username as string)); + const userId = await measureTime('getUserId', () => getUserId(username)); if (!userId) { console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.status(400).json({ error: 'User not found' }); + return sendSvg(res, generateErrorSvg(errorCards.userNotFound(CARD_TITLE, username), theme)); } // username을 함께 전달하여 캐시된 ID가 유효하지 않을 경우 재시도할 수 있도록 함 - const userData = await measureTime('getUserData', () => getUserData(userId, username as string)); + const userData = await measureTime('getUserData', () => getUserData(userId, username)); if (!userData) { console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.status(400).json({ error: 'User information cannot be read.' }); + return sendSvg(res, generateErrorSvg(errorCards.fetchFailed(CARD_TITLE), theme)); } console.time('⏱️ 데이터 가공 및 SVG 생성'); @@ -74,10 +82,9 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse) }; const svg = generateCategorySvg(emptyStats, theme); - res.setHeader('Content-Type', 'image/svg+xml'); - res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate'); + console.timeEnd('⏱️ 데이터 가공 및 SVG 생성'); console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.send(svg); + return sendSvg(res, svg); } // 카테고리 데이터가 있는 경우 가공 @@ -105,13 +112,11 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse) const svg = generateCategorySvg(categoryStats, theme); console.timeEnd('⏱️ 데이터 가공 및 SVG 생성'); - res.setHeader('Content-Type', 'image/svg+xml'); - res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate'); console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.send(svg); + return sendSvg(res, svg); } catch (error) { console.error(error); console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.status(500).json({ error: 'Internal Server Error' }); + return sendSvg(res, generateErrorSvg(errorCards.fetchFailed(CARD_TITLE), theme)); } } \ No newline at end of file diff --git a/src/pages/api/stats.ts b/src/pages/api/stats.ts index fe81df1..4039b56 100644 --- a/src/pages/api/stats.ts +++ b/src/pages/api/stats.ts @@ -1,6 +1,8 @@ import { NextApiRequest, NextApiResponse } from 'next'; import { Tstats, Theme } from '../../types'; import { generateStatsSvg } from '../../utils/generateStatsSvg'; +import { generateErrorSvg, errorCards } from '../../utils/generateErrorSvg'; +import { sendSvg } from '../../utils/svg'; import { getLastRank, calculateTopPercentage, @@ -8,6 +10,12 @@ import { getUserData } from '../../utils/dreamhack'; +// 처음 조회하는 닉네임은 Dreamhack 검색이 여러 번 필요해 기본 10초를 넘을 수 있음 +// (요청당 타임아웃 10초 × 최대 5단계 + 여유, Hobby 플랜 최대값) +export const config = { maxDuration: 60 }; + +const CARD_TITLE = 'Dreamhack Wargame Stats'; + // 성능 측정을 위한 유틸리티 함수 const measureTime = async (name: string, fn: () => Promise): Promise => { console.time(`⏱️ ${name}`); @@ -19,35 +27,35 @@ const measureTime = async (name: string, fn: () => Promise): Promise => }; export default async function handler(req: NextApiRequest, res: NextApiResponse) { - console.time('⏱️ 전체 API 실행 시간'); const { username, theme: themeParam } = req.query; - if (!username || typeof username !== 'string') { - return res.status(400).json({ error: 'Username is required' }); - } - // 테마 파라미터 검증 const theme: Theme = themeParam === 'dark' ? 'dark' : 'light'; + if (!username || typeof username !== 'string') { + return sendSvg(res, generateErrorSvg(errorCards.missingUsername(CARD_TITLE), theme)); + } + + console.time('⏱️ 전체 API 실행 시간'); try { // 개별 API 호출 시간 측정 - const userId = await measureTime('getUserId', () => getUserId(username as string)); - const lastRank = await measureTime('getLastRank', () => getLastRank()); - + const userId = await measureTime('getUserId', () => getUserId(username)); if (!userId) { console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.status(400).json({ error: 'User not found' }); + return sendSvg(res, generateErrorSvg(errorCards.userNotFound(CARD_TITLE, username), theme)); } + + const lastRank = await measureTime('getLastRank', () => getLastRank()); if (!lastRank) { console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.status(500).json({ error: 'Failed to fetch last rank' }); + return sendSvg(res, generateErrorSvg(errorCards.fetchFailed(CARD_TITLE), theme)); } // username을 함께 전달하여 캐시된 ID가 유효하지 않을 경우 재시도할 수 있도록 함 - const userData = await measureTime('getUserData', () => getUserData(userId, username as string)); + const userData = await measureTime('getUserData', () => getUserData(userId, username)); if (!userData) { console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.status(400).json({ error: 'User information cannot be read.' }); + return sendSvg(res, generateErrorSvg(errorCards.fetchFailed(CARD_TITLE), theme)); } console.time('⏱️ 데이터 가공 및 SVG 생성'); @@ -70,13 +78,11 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse) const svg = generateStatsSvg(stats, theme); console.timeEnd('⏱️ 데이터 가공 및 SVG 생성'); - res.setHeader('Content-Type', 'image/svg+xml'); - res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate'); console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.send(svg); + return sendSvg(res, svg); } catch (error) { console.error(error); console.timeEnd('⏱️ 전체 API 실행 시간'); - return res.status(500).json({ error: 'Internal Server Error' }); + return sendSvg(res, generateErrorSvg(errorCards.fetchFailed(CARD_TITLE), theme)); } -} \ No newline at end of file +} diff --git a/src/pages/api/user-id.ts b/src/pages/api/user-id.ts new file mode 100644 index 0000000..de5a45d --- /dev/null +++ b/src/pages/api/user-id.ts @@ -0,0 +1,30 @@ +import { NextApiRequest, NextApiResponse } from 'next'; +import { getUserId } from '../../utils/dreamhack'; + +// 처음 조회하는 닉네임은 Dreamhack 검색이 여러 번 필요해 기본 10초를 넘을 수 있음 +// (요청당 타임아웃 10초 × 최대 5단계 + 여유, Hobby 플랜 최대값) +export const config = { maxDuration: 60 }; + +// 메인 페이지에서 프로필 링크(숫자 ID 주소)를 만들 때 사용 +export default async function handler(req: NextApiRequest, res: NextApiResponse) { + const { username } = req.query; + + if (!username || typeof username !== 'string') { + return res.status(400).json({ error: 'Username is required' }); + } + + try { + const userId = await getUserId(username); + if (!userId) { + return res.status(404).json({ error: 'User not found' }); + } + + return res.status(200).json({ + id: userId, + profileUrl: `https://dreamhack.io/users/${userId}`, + }); + } catch (error) { + console.error('Error fetching user id:', error); + return res.status(500).json({ error: 'Internal Server Error' }); + } +} diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 0272762..3ad1202 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -1,6 +1,7 @@ import React, { useState, useEffect, useRef } from 'react'; import Head from 'next/head'; import styles from '../styles/Home.module.css'; +import { encodeUsername } from '../utils/encodeUsername'; type Theme = 'light' | 'dark'; type CardType = 'stats' | 'most-solved'; @@ -77,6 +78,21 @@ export default function Home() { const [selectedCard, setSelectedCard] = useState('stats'); const [previewKey, setPreviewKey] = useState(0); const [isLoading, setIsLoading] = useState(false); + // 닉네임별 프로필 주소 (찾지 못하면 null). 늦게 도착한 다른 닉네임의 응답이 현재 결과를 덮어쓰지 않도록 닉네임별로 보관 + const [profileUrls, setProfileUrls] = useState>(new Map()); + const profileUrl = profileUrls.get(confirmedUsername) ?? null; + + // Dreamhack 프로필 주소는 닉네임이 아닌 숫자 ID를 사용하므로 미리보기한 닉네임의 ID를 조회 + const loadProfileUrl = (user: string) => { + fetch(`/api/user-id?username=${encodeUsername(user)}`) + .then((response) => { + if (response.status === 404) return null; + if (!response.ok) throw new Error(`user-id ${response.status}`); + return response.json(); + }) + .then((data) => setProfileUrls((prev) => new Map(prev).set(user, data?.profileUrl ?? null))) + .catch(() => {}); + }; const cardOptions: DropdownOption[] = [ { value: 'stats', label: 'Wargame Stats' }, @@ -92,13 +108,13 @@ export default function Home() { const getApiUrl = (card: CardType, theme: Theme, user: string) => { const endpoint = card === 'stats' ? 'stats' : 'most-solved'; - return `${baseUrl}/api/${endpoint}?username=${user || '사용자명'}&theme=${theme}`; + return `${baseUrl}/api/${endpoint}?username=${user ? encodeUsername(user) : '사용자명'}&theme=${theme}`; }; const getPreviewUrl = (card: CardType, theme: Theme, user: string) => { if (!user) return ''; const endpoint = card === 'stats' ? 'stats' : 'most-solved'; - return `/api/${endpoint}?username=${user}&theme=${theme}`; + return `/api/${endpoint}?username=${encodeUsername(user)}&theme=${theme}`; }; const getMarkdownCode = () => { @@ -108,8 +124,7 @@ export default function Home() { const getHtmlCode = () => { const altText = selectedCard === 'stats' ? 'Dreamhack Stats' : 'Dreamhack Category Chart'; - const user = confirmedUsername || '사용자명'; - return ` + return ` ${altText} `; }; @@ -127,13 +142,17 @@ export default function Home() { alert('사용자명을 입력해주세요.'); return; } - setConfirmedUsername(username); + setConfirmedUsername(username.trim()); setIsLoading(true); setPreviewKey(prev => prev + 1); }; const handleImageLoad = () => { setIsLoading(false); + // 카드 요청이 서버 캐시를 채운 뒤에 조회해야 Dreamhack 검색이 중복되지 않음 + if (!profileUrls.has(confirmedUsername)) { + loadProfileUrl(confirmedUsername); + } }; const handleImageError = () => { @@ -248,6 +267,11 @@ export default function Home() { {getHtmlCode()} + {!profileUrl && ( +

+ 사용자ID는 Dreamhack 프로필 주소(https://dreamhack.io/users/12345)의 숫자입니다. 미리보기에 성공하면 자동으로 채워집니다. +

+ )} diff --git a/src/styles/Home.module.css b/src/styles/Home.module.css index 01b0b0a..76588a7 100644 --- a/src/styles/Home.module.css +++ b/src/styles/Home.module.css @@ -87,6 +87,12 @@ line-height: 1.5; } +.codeHint { + margin: 0.5rem 0 0 0; + font-size: 0.8rem; + color: #666; +} + .example { margin: 0 0 2rem 0; text-align: center; diff --git a/src/types/index.ts b/src/types/index.ts index dab1400..364d82a 100644 --- a/src/types/index.ts +++ b/src/types/index.ts @@ -54,6 +54,7 @@ export interface TgetLastRankResponse { } export interface TUserRankingResponse { + count: number; results: TUserRankingResult[]; } @@ -77,6 +78,12 @@ export interface TCategoryStats { export type Theme = 'light' | 'dark'; +export interface TErrorCard { + title: string; + message: string; + details: string[]; +} + export interface ThemeColors { background: string; cardBackground: string; diff --git a/src/utils/dreamhack.ts b/src/utils/dreamhack.ts index 8a79526..711ad86 100644 --- a/src/utils/dreamhack.ts +++ b/src/utils/dreamhack.ts @@ -1,17 +1,57 @@ import { TgetLastRankResponse, TUserRankingResponse, TuserData, TUserRankingResult } from '../types'; -import { getUserIdFromCache, saveUserIdToCache } from './redis'; +import { + getUserIdFromCache, + saveUserIdToCache, + deleteUserIdFromCache, + isUserNotFoundCached, + saveUserNotFoundToCache, +} from './redis'; + +// Dreamhack이 응답하지 않을 때 요청 하나를 기다리는 최대 시간 +const FETCH_TIMEOUT_MS = 10000; +// 랭킹 API는 limit을 100으로 보내도 50개까지만 돌려줌 +const SEARCH_PAGE_SIZE = 50; +// 검색 결과는 랭킹 순이라, 흔한 문자열이 들어간 닉네임은 뒤쪽 페이지에 있을 수 있음 (최대 250명 확인) +const SEARCH_MAX_PAGES = 5; +// 실제 닉네임은 이보다 훨씬 짧음 +const MAX_USERNAME_LENGTH = 64; // 네트워크 요청 시간 측정을 위한 래퍼 함수 async function measureFetch(url: string, name: string): Promise { console.time(`🌐 ${name} 네트워크 요청`); try { - const response = await fetch(url); + const response = await fetch(url, { signal: AbortSignal.timeout(FETCH_TIMEOUT_MS) }); return response; } finally { console.timeEnd(`🌐 ${name} 네트워크 요청`); } } +// 랭킹 검색 한 페이지 조회 (닉네임의 &, #, + 등이 쿼리를 깨뜨리지 않도록 인코딩) +async function searchRanking(username: string, offset: number): Promise { + const params = new URLSearchParams({ + filter: 'global', + limit: String(SEARCH_PAGE_SIZE), + offset: String(offset), + search: username, + scope: 'all', + name: '', + category: '', + }); + const response = await measureFetch( + `https://dreamhack.io/api/v1/ranking/wargame/?${params}`, + `getUserId(offset=${offset})` + ); + if (!response.ok) { + throw new Error(`Failed to search ranking: ${response.status}`); + } + return await response.json() as TUserRankingResponse; +} + +function findExactUser(results: TUserRankingResult[], username: string): TUserRankingResult | undefined { + return results.find((user) => user.nickname === username); +} + export async function getLastRank(): Promise { try { console.time('⚙️ getLastRank 함수 전체'); @@ -33,7 +73,13 @@ export async function getLastRank(): Promise { } } +// 사용자를 찾지 못하면 null, 검색 자체가 실패하면 예외를 던짐 (오류 카드에서 둘을 구분하기 위함) export async function getUserId(username: string): Promise { + // 실제 닉네임일 수 없는 긴 값은 Redis 키를 만들거나 Dreamhack을 검색하지 않음 + if (Array.from(username).length > MAX_USERNAME_LENGTH) { + return null; + } + try { console.time('⚙️ getUserId 함수 전체'); @@ -45,33 +91,50 @@ export async function getUserId(username: string): Promise { return cachedUserId; } + // 최근 검색에서 찾지 못한 닉네임이면 Dreamhack 검색을 반복하지 않음 + if (await isUserNotFoundCached(username)) { + console.log(`🚫 최근 검색에서 찾지 못한 사용자입니다: ${username}`); + console.timeEnd('⚙️ getUserId 함수 전체'); + return null; + } + console.log(`🔍 Redis 캐시에서 사용자 ID를 찾지 못했습니다. API 호출을 시도합니다: ${username}`); - const response = await measureFetch( - `https://dreamhack.io/api/v1/ranking/wargame/?filter=global&limit=100&offset=0&search=${username}&scope=all&name=&category=`, - 'getUserId' - ); - - console.time('⚙️ getUserId JSON 파싱'); - const data = await response.json() as TUserRankingResponse; - console.timeEnd('⚙️ getUserId JSON 파싱'); - - console.time('⚙️ getUserId 사용자 검색'); - const user = data.results.find((user: TUserRankingResult) => user.nickname === username); - console.timeEnd('⚙️ getUserId 사용자 검색'); - + const firstPage = await searchRanking(username, 0); + let user = findExactUser(firstPage.results, username); + + // 첫 페이지에 없고 검색 결과가 더 있으면 다음 페이지들을 동시에 확인 + if (!user && firstPage.count > SEARCH_PAGE_SIZE) { + const lastOffset = Math.min(firstPage.count, SEARCH_PAGE_SIZE * SEARCH_MAX_PAGES); + const offsets: number[] = []; + for (let offset = SEARCH_PAGE_SIZE; offset < lastOffset; offset += SEARCH_PAGE_SIZE) { + offsets.push(offset); + } + // 일부 페이지가 실패해도 성공한 페이지에서 찾으면 사용 + const pages = await Promise.allSettled(offsets.map((offset) => searchRanking(username, offset))); + const results = pages.flatMap((page) => (page.status === 'fulfilled' ? page.value.results : [])); + user = findExactUser(results, username); + + // 못 찾았는데 실패한 페이지가 있으면 없는 사용자라고 단정할 수 없음 + if (!user && pages.some((page) => page.status === 'rejected')) { + throw new Error('Failed to search some ranking pages'); + } + } + const userId = user ? user.id : null; - - // 사용자 ID를 찾았다면 Redis에 저장 + + // 찾았으면 ID를, 못 찾았으면 미존재 사실을 Redis에 저장 (검색 자체가 실패한 경우는 저장하지 않음) if (userId !== null) { await saveUserIdToCache(username, userId); + } else { + await saveUserNotFoundToCache(username); } - + console.timeEnd('⚙️ getUserId 함수 전체'); return userId; } catch (error) { console.error('Error fetching user ID:', error); console.timeEnd('⚙️ getUserId 함수 전체'); - return null; + throw error; } } @@ -89,10 +152,11 @@ export async function getUserData(userId: number, username?: string): Promise ${newUserId}`); // 새로운 사용자 ID로 재귀적으로 다시 호출 return getUserData(newUserId); diff --git a/src/utils/encodeUsername.ts b/src/utils/encodeUsername.ts new file mode 100644 index 0000000..584a905 --- /dev/null +++ b/src/utils/encodeUsername.ts @@ -0,0 +1,8 @@ +// 카드 URL의 username 값 인코딩 +// &, #, +, 공백, 괄호 등 URL·Markdown을 깨뜨리는 ASCII 문자만 인코딩하고, 한글 등은 README에서 읽기 쉽게 그대로 둠 +export function encodeUsername(username: string): string { + return username.replace( + /[^A-Za-z0-9\-_.~\u0080-￿]/g, + (char) => `%${char.charCodeAt(0).toString(16).toUpperCase().padStart(2, '0')}` + ); +} diff --git a/src/utils/generateCategorySvg.ts b/src/utils/generateCategorySvg.ts index 2892701..8855187 100644 --- a/src/utils/generateCategorySvg.ts +++ b/src/utils/generateCategorySvg.ts @@ -1,27 +1,7 @@ -import { TCategoryStats, Theme, ThemeColors } from '../types'; +import { TCategoryStats, Theme } from '../types'; +import { escapeXml, themes } from './svg'; import { jetBrainsMonoFontFace } from './fonts/jetbrainsMono'; -const themes: Record = { - light: { - background: '#ffffff', - cardBackground: '#f8fafc', - border: '#e2e8f0', - title: '#64748b', - text: '#0f172a', - subText: '#94a3b8', - accent: '#3b82f6', - }, - dark: { - background: '#0d1117', - cardBackground: '#21262d', - border: '#30363d', - title: '#8b949e', - text: '#e6edf3', - subText: '#7d8590', - accent: '#58a6ff', - }, -}; - export function generateCategorySvg(stats: TCategoryStats, theme: Theme = 'light'): string { const colors = themes[theme]; // SVG 크기 및 차트 설정 @@ -107,7 +87,7 @@ export function generateCategorySvg(stats: TCategoryStats, theme: Theme = 'light const capitalizedName = category.name.charAt(0).toUpperCase() + category.name.slice(1); legends += ` - ${capitalizedName} + ${escapeXml(capitalizedName)} ${percentage}% `; }); @@ -117,7 +97,7 @@ export function generateCategorySvg(stats: TCategoryStats, theme: Theme = 'light const centerCircle = ` Total - ${totalScore} + ${escapeXml(totalScore)} `; // SVG 구조 반환 diff --git a/src/utils/generateErrorSvg.ts b/src/utils/generateErrorSvg.ts new file mode 100644 index 0000000..0ab106d --- /dev/null +++ b/src/utils/generateErrorSvg.ts @@ -0,0 +1,66 @@ +import { TErrorCard, Theme } from '../types'; +import { escapeXml, themes } from './svg'; +import { jetBrainsMonoFontFace } from './fonts/jetbrainsMono'; + +// 카드 폭(390px)을 넘지 않도록 닉네임 표시 길이 제한 +const MAX_NICKNAME_LENGTH = 30; + +function truncate(value: string, maxLength: number): string { + const chars = Array.from(value); + return chars.length > maxLength ? `${chars.slice(0, maxLength - 3).join('')}...` : value; +} + +// README에서 깨진 이미지 대신 보여줄 오류 카드 문구 +export const errorCards = { + missingUsername: (title: string): TErrorCard => ({ + title, + message: 'Missing username', + details: ['Add ?username= to the card URL.'], + }), + userNotFound: (title: string, username: string): TErrorCard => ({ + title, + message: 'User not found', + details: [ + `Nickname: ${truncate(username, MAX_NICKNAME_LENGTH)}`, + 'Nicknames are case-sensitive.', + 'Only users on the wargame ranking are shown.', + ], + }), + fetchFailed: (title: string): TErrorCard => ({ + title, + message: 'Failed to load stats', + details: ['Could not load data from Dreamhack.', 'Please try again later.'], + }), +}; + +export function generateErrorSvg(error: TErrorCard, theme: Theme = 'light'): string { + const colors = themes[theme]; + + const details = error.details + .map((line, index) => `${escapeXml(line)}`) + .join('\n '); + + return ` + + + + + + + + ${escapeXml(error.title)} + + + ${escapeXml(error.message)} + ${details} + + + + + `; +} diff --git a/src/utils/generateStatsSvg.ts b/src/utils/generateStatsSvg.ts index cd3a6f3..07fbb34 100644 --- a/src/utils/generateStatsSvg.ts +++ b/src/utils/generateStatsSvg.ts @@ -1,34 +1,14 @@ -import { Tstats, Theme, ThemeColors } from '../types'; +import { Tstats, Theme } from '../types'; +import { escapeXml, themes } from './svg'; import { jetBrainsMonoFontFace } from './fonts/jetbrainsMono'; -const themes: Record = { - light: { - background: '#ffffff', - cardBackground: '#f8fafc', - border: '#e2e8f0', - title: '#64748b', - text: '#0f172a', - subText: '#94a3b8', - accent: '#3b82f6', - }, - dark: { - background: '#0d1117', - cardBackground: '#21262d', - border: '#30363d', - title: '#8b949e', - text: '#e6edf3', - subText: '#7d8590', - accent: '#58a6ff', - }, -}; - export function generateStatsSvg(stats: Tstats, theme: Theme = 'light'): string { const colors = themes[theme]; const rankParts = stats.wargame_rank.split('/'); const rankDisplay = rankParts.length === 2 - ? `${rankParts[0]}/${rankParts[1]}` - : `${stats.wargame_rank}`; + ? `${escapeXml(rankParts[0])}/${escapeXml(rankParts[1])}` + : `${escapeXml(stats.wargame_rank)}`; return ` @@ -50,19 +30,19 @@ export function generateStatsSvg(stats: Tstats, theme: Theme = 'light'): string Dreamhack Wargame Stats - ${stats.nickname} + ${escapeXml(stats.nickname)} TOP - ${stats.wargameRankPercentage}% + ${escapeXml(stats.wargameRankPercentage)}% Solved Challenges - ${stats.wargame_solved} + ${escapeXml(stats.wargame_solved)} @@ -74,7 +54,7 @@ export function generateStatsSvg(stats: Tstats, theme: Theme = 'light'): string Score - ${stats.wargame_score} + ${escapeXml(stats.wargame_score)} diff --git a/src/utils/redis.ts b/src/utils/redis.ts index 58c6e6a..5fa236a 100644 --- a/src/utils/redis.ts +++ b/src/utils/redis.ts @@ -74,6 +74,8 @@ export async function saveUserIdToCache(username: string, userId: number): Promi try { await redis.set(`userId:${username}`, userId); + // 동시에 실행된 다른 검색이 남긴 미존재 기록이 404 재시도를 막지 않도록 함께 삭제 + await redis.del(`userNotFound:${username}`); console.log(`✅ Redis에 사용자 ID 저장 완료: ${username} -> ${userId}`); } catch (error) { console.error('Redis에 사용자 ID 저장 실패:', error); @@ -100,6 +102,43 @@ export async function getUserIdFromCache(username: string): Promise { + if (!redis) return; + + try { + await redis.del(`userId:${username}`); + console.log(`🗑️ Redis에서 사용자 ID 삭제 완료: ${username}`); + } catch (error) { + console.error('Redis에서 사용자 ID 삭제 실패:', error); + } +} + +// 찾지 못한 닉네임을 잠시 기록해, README가 조회될 때마다 느린 Dreamhack 검색을 반복하지 않도록 함 +const USER_NOT_FOUND_TTL_SECONDS = 600; + +export async function saveUserNotFoundToCache(username: string): Promise { + if (!redis) return; + + try { + await redis.set(`userNotFound:${username}`, '1', 'EX', USER_NOT_FOUND_TTL_SECONDS); + console.log(`✅ Redis에 미존재 사용자 저장 완료: ${username}`); + } catch (error) { + console.error('Redis에 미존재 사용자 저장 실패:', error); + } +} + +export async function isUserNotFoundCached(username: string): Promise { + if (!redis) return false; + + try { + return (await redis.get(`userNotFound:${username}`)) !== null; + } catch (error) { + console.error('Redis에서 미존재 사용자 조회 실패:', error); + return false; + } +} + // 테스트를 위한 Redis 클라이언트 설정 함수 export function __setRedisClientForTesting(client: Redis | null): void { if (isTestEnvironment) { diff --git a/src/utils/svg.ts b/src/utils/svg.ts new file mode 100644 index 0000000..c7a5b17 --- /dev/null +++ b/src/utils/svg.ts @@ -0,0 +1,42 @@ +import type { NextApiResponse } from 'next'; +import { Theme, ThemeColors } from '../types'; + +export const themes: Record = { + light: { + background: '#ffffff', + cardBackground: '#f8fafc', + border: '#e2e8f0', + title: '#64748b', + text: '#0f172a', + subText: '#94a3b8', + accent: '#3b82f6', + }, + dark: { + background: '#0d1117', + cardBackground: '#21262d', + border: '#30363d', + title: '#8b949e', + text: '#e6edf3', + subText: '#7d8590', + accent: '#58a6ff', + }, +}; + +// SVG(XML)에 넣는 문자열의 특수문자를 이스케이프 (닉네임에 &, < 등이 있으면 SVG가 깨지거나 태그로 해석됨) +// XML에서 허용되지 않는 제어 문자는 제거 +export function escapeXml(value: string | number): string { + return String(value) + .replace(/[\u0000-\u0008\u000B\u000C\u000E-\u001F￾￿]/g, '') + .replace(/&/g, '&') + .replace(//g, '>') + .replace(/"/g, '"') + .replace(/'/g, '''); +} + +// SVG 카드 응답 (GitHub camo는 200이 아닌 응답을 이미지로 보여주지 않으므로 오류 카드도 200으로 응답) +export function sendSvg(res: NextApiResponse, svg: string) { + res.setHeader('Content-Type', 'image/svg+xml'); + res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate'); + return res.status(200).send(svg); +}