Compare commits

..
17 changed files with 692 additions and 189 deletions

No files matched your search

+9 -3
View File
@@ -103,6 +103,12 @@ git push origin main:release/66
pnpm deploy:web:staging
```
staging Pages 배포 스크립트는 `CF_PAGES_STAGING_BRANCH`가 있으면 그 값을
사용하고, 없으면 최신 `release/*` 브랜치를 자동으로 선택합니다. 최신 기준은
브랜치가 가리키는 커밋 시각이며, 동률이면 브랜치명 내림차순입니다.
staging/prod Pages 배포 스크립트는 명시 릴리즈 브랜치 환경변수가 있으면 그
값을 사용하고, 없으면 최신 `release/*` 브랜치를 자동으로 선택합니다. 최신
기준은 브랜치가 가리키는 커밋 시각이며, 동률이면 브랜치명 내림차순입니다.
staging은 선택된 릴리즈 브랜치로 preview 배포를 만들고, prod는 Cloudflare
Pages production branch로 업로드해 production 배포를 만듭니다.
명시 릴리즈 브랜치는 staging은 `CF_PAGES_STAGING_BRANCH`, prod는
`CF_PAGES_RELEASE_BRANCH`로 지정합니다. Cloudflare Pages production branch가
`main`이 아니면 `CF_PAGES_PRODUCTION_BRANCH`로 지정합니다.
+2 -2
View File
@@ -27,8 +27,8 @@
## Riot Background Refresh
Set `RIOT_BG_REFRESH_ENABLED=true` to refresh stale Riot accounts automatically
between KST 03:00 and 10:00. The scheduler picks active users whose
Stale Riot accounts refresh automatically between KST 03:00 and 10:00.
The scheduler picks active users whose
`lastRefreshRequestedAt` is older than 6 hours, oldest first, and uses a
background-only Riot token bucket capped at roughly 40% of the app rate limit.
@@ -1,9 +1,4 @@
import {
Inject,
Injectable,
Logger,
OnModuleDestroy,
} from '@nestjs/common';
import { Inject, Injectable, Logger, OnModuleDestroy } from '@nestjs/common';
import type { createClient } from 'redis';
import { GARNET_CLIENT } from './garnet.constants';
@@ -203,6 +198,13 @@ export class GarnetService implements OnModuleDestroy {
return this.client.xAck(key, group, ids);
}
public async deleteStreamEntries(
key: string,
ids: string | string[],
): Promise<number> {
return this.client.xDel(key, ids);
}
public async streamLength(key: string): Promise<number> {
return this.client.xLen(key);
}
@@ -1,4 +1,3 @@
import { ConfigService } from '@nestjs/config';
import mongoose from 'mongoose';
import { GarnetService } from '../global/garnet/garnet.service';
import { RiotAccountEnrichmentService } from '../riot/riot-account-enrichment.service';
@@ -30,7 +29,7 @@ function candidate(puuid: string): StaleAccountCandidate {
};
}
function makeScheduler(enabled = true) {
function makeScheduler() {
const rawClient = {
sendCommand: jest.fn().mockResolvedValue(1),
};
@@ -42,7 +41,7 @@ function makeScheduler(enabled = true) {
raw: jest.fn().mockReturnValue(rawClient),
} as unknown as jest.Mocked<GarnetService> & { raw: jest.Mock };
const rateLimiter = {
acquireBackground: jest.fn().mockResolvedValue(undefined),
isRefreshWindowOpen: jest.fn().mockResolvedValue(true),
} as unknown as jest.Mocked<RiotRateLimiterService>;
const enrichmentService = {
markRefreshRequested: jest.fn().mockResolvedValue(undefined),
@@ -51,16 +50,11 @@ function makeScheduler(enabled = true) {
const staleAccountRepository = {
findStaleAccounts: jest.fn().mockResolvedValue([]),
} as unknown as jest.Mocked<StaleAccountRepository>;
const config = {
get: jest.fn().mockReturnValue(enabled ? 'true' : 'false'),
} as unknown as ConfigService;
const scheduler = new BackgroundRefreshScheduler(
garnet,
rateLimiter,
enrichmentService,
staleAccountRepository,
config,
) as SchedulerInternals;
return {
@@ -79,19 +73,40 @@ describe('BackgroundRefreshScheduler', () => {
jest.restoreAllMocks();
});
it('does not schedule ticks when disabled', () => {
it('schedules ticks without requiring RIOT_BG_REFRESH_ENABLED', () => {
jest.useFakeTimers();
const setIntervalSpy = jest.spyOn(global, 'setInterval');
const { scheduler } = makeScheduler(false);
const { scheduler } = makeScheduler();
scheduler.onModuleInit();
expect(setIntervalSpy).not.toHaveBeenCalled();
expect(setIntervalSpy).toHaveBeenCalledTimes(2);
scheduler.onModuleDestroy();
});
it('does not query stale accounts outside the KST window', async () => {
it('uses the dawn refresh gate ratio inside the KST background window', async () => {
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T18:00:00.000Z'));
const { scheduler, rateLimiter } = makeScheduler();
await scheduler.tick();
expect(rateLimiter.isRefreshWindowOpen).toHaveBeenCalledWith(0.8);
});
it('uses the opportunistic refresh gate ratio outside the KST background window', async () => {
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T17:59:59.000Z'));
const { scheduler, staleAccountRepository } = makeScheduler();
const { scheduler, rateLimiter, staleAccountRepository } = makeScheduler();
await scheduler.tick();
expect(rateLimiter.isRefreshWindowOpen).toHaveBeenCalledWith(0.5);
expect(staleAccountRepository.findStaleAccounts).toHaveBeenCalledTimes(1);
});
it('does not query stale accounts when the refresh gate is closed', async () => {
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T18:00:00.000Z'));
const { scheduler, rateLimiter, staleAccountRepository } = makeScheduler();
rateLimiter.isRefreshWindowOpen.mockResolvedValue(false);
await scheduler.tick();
@@ -108,21 +123,15 @@ describe('BackgroundRefreshScheduler', () => {
expect(staleAccountRepository.findStaleAccounts).not.toHaveBeenCalled();
});
it('marks and enriches each stale candidate with background rate tokens', async () => {
it('marks and enriches each stale candidate without background precharge', async () => {
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T18:00:00.000Z'));
const {
scheduler,
rateLimiter,
enrichmentService,
staleAccountRepository,
} = makeScheduler();
const { scheduler, enrichmentService, staleAccountRepository } =
makeScheduler();
const candidates = [candidate('puuid-1'), candidate('puuid-2')];
staleAccountRepository.findStaleAccounts.mockResolvedValue(candidates);
await scheduler.tick();
expect(rateLimiter.acquireBackground).toHaveBeenCalledTimes(2);
expect(rateLimiter.acquireBackground).toHaveBeenCalledWith(8);
expect(enrichmentService.markRefreshRequested).toHaveBeenCalledTimes(2);
expect(enrichmentService.markRefreshRequested).toHaveBeenNthCalledWith(
1,
@@ -136,6 +145,28 @@ describe('BackgroundRefreshScheduler', () => {
});
});
it('stops the candidate loop when the refresh gate closes mid-tick', async () => {
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T18:00:00.000Z'));
const {
scheduler,
rateLimiter,
enrichmentService,
staleAccountRepository,
} = makeScheduler();
staleAccountRepository.findStaleAccounts.mockResolvedValue([
candidate('puuid-1'),
candidate('puuid-2'),
]);
rateLimiter.isRefreshWindowOpen
.mockResolvedValueOnce(true)
.mockResolvedValueOnce(true)
.mockResolvedValueOnce(false);
await scheduler.tick();
expect(enrichmentService.enrichRiotAccount).toHaveBeenCalledTimes(1);
});
it('continues after a candidate throws and records a failure counter', async () => {
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T18:00:00.000Z'));
const { scheduler, rawClient, enrichmentService, staleAccountRepository } =
@@ -162,13 +193,8 @@ describe('BackgroundRefreshScheduler', () => {
it('skips candidates already in failure backoff', async () => {
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T18:00:00.000Z'));
const {
scheduler,
garnet,
rateLimiter,
enrichmentService,
staleAccountRepository,
} = makeScheduler();
const { scheduler, garnet, enrichmentService, staleAccountRepository } =
makeScheduler();
staleAccountRepository.findStaleAccounts.mockResolvedValue([
candidate('skip-me'),
]);
@@ -179,7 +205,6 @@ describe('BackgroundRefreshScheduler', () => {
await scheduler.tick();
expect(rateLimiter.acquireBackground).not.toHaveBeenCalled();
expect(enrichmentService.markRefreshRequested).not.toHaveBeenCalled();
expect(enrichmentService.enrichRiotAccount).not.toHaveBeenCalled();
});
@@ -4,7 +4,6 @@ import {
OnModuleDestroy,
OnModuleInit,
} from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import {
type EnrichResult,
RiotAccountEnrichmentService,
@@ -20,11 +19,17 @@ const LEADER_TTL_SECONDS = 90;
const LEADER_RENEW_INTERVAL_MS = 30_000;
const STALE_THRESHOLD_MS = 6 * 60 * 60 * 1000;
const PER_TICK_CANDIDATE_LIMIT = 20;
const ENRICH_COST_TOKENS = 8;
const DAWN_USAGE_RATIO = 0.8;
const OPPORTUNISTIC_USAGE_RATIO = 0.5;
const FAILURE_BACKOFF_KEY_PREFIX = 'riot:bg:fail';
const FAILURE_BACKOFF_THRESHOLD = 3;
const FAILURE_BACKOFF_TTL_SECONDS = 24 * 60 * 60;
interface RefreshGatePolicy {
mode: 'dawn' | 'opportunistic';
usageRatio: number;
}
@Injectable()
export class BackgroundRefreshScheduler
implements OnModuleInit, OnModuleDestroy
@@ -34,26 +39,15 @@ export class BackgroundRefreshScheduler
private leaderRenewTimer?: NodeJS.Timeout;
private tickInProgress = false;
private readonly consumer = `${process.pid}:${Math.random().toString(36).slice(2)}`;
private readonly enabled: boolean;
constructor(
private readonly garnet: GarnetService,
private readonly rateLimiter: RiotRateLimiterService,
private readonly enrichmentService: RiotAccountEnrichmentService,
private readonly staleAccountRepository: StaleAccountRepository,
config: ConfigService,
) {
this.enabled = config.get<string>('RIOT_BG_REFRESH_ENABLED') === 'true';
}
) {}
public onModuleInit(): void {
if (!this.enabled) {
this.logger.log(
'Background Riot refresh is disabled (RIOT_BG_REFRESH_ENABLED).',
);
return;
}
this.tickTimer = setInterval(() => void this.safeTick(), TICK_INTERVAL_MS);
this.leaderRenewTimer = setInterval(
() => void this.renewLeaderIfHeld(),
@@ -87,7 +81,11 @@ export class BackgroundRefreshScheduler
}
private async tick(): Promise<void> {
if (!isInKstBackgroundWindow()) return;
const initialGate = this.currentRefreshGatePolicy();
if (!(await this.rateLimiter.isRefreshWindowOpen(initialGate.usageRatio))) {
return;
}
const isLeader = await this.tryBecomeLeader();
if (!isLeader) return;
@@ -101,15 +99,20 @@ export class BackgroundRefreshScheduler
let processed = 0;
let failed = 0;
let skipped = 0;
let currentGate = initialGate;
for (const candidate of candidates) {
if (!isInKstBackgroundWindow()) break;
currentGate = this.currentRefreshGatePolicy();
if (
!(await this.rateLimiter.isRefreshWindowOpen(currentGate.usageRatio))
) {
break;
}
if (await this.isInFailureBackoff(candidate.puuid)) {
skipped += 1;
continue;
}
await this.rateLimiter.acquireBackground(ENRICH_COST_TOKENS);
await this.enrichmentService.markRefreshRequested(
candidate.userId,
candidate.puuid,
@@ -142,10 +145,18 @@ export class BackgroundRefreshScheduler
}
this.logger.debug(
`Background refresh tick: processed=${processed} failed=${failed} skipped=${skipped} candidates=${candidates.length}`,
`Background refresh tick: processed=${processed} failed=${failed} skipped=${skipped} candidates=${candidates.length} mode=${currentGate.mode} ratio=${currentGate.usageRatio}`,
);
}
private currentRefreshGatePolicy(): RefreshGatePolicy {
const isDawn = isInKstBackgroundWindow();
return {
mode: isDawn ? 'dawn' : 'opportunistic',
usageRatio: isDawn ? DAWN_USAGE_RATIO : OPPORTUNISTIC_USAGE_RATIO,
};
}
private async tryBecomeLeader(): Promise<boolean> {
const current = await this.garnet.getString(LEADER_KEY);
if (current === this.consumer) {
@@ -17,6 +17,7 @@ function execResult<T>(value: T) {
function makeWorker() {
const garnetService = {
acknowledgeStream: jest.fn().mockResolvedValue(undefined),
deleteStreamEntries: jest.fn().mockResolvedValue(undefined),
} as unknown as jest.Mocked<GarnetService>;
const jobQueueService = {
markProcessing: jest.fn().mockResolvedValue(undefined),
@@ -74,6 +75,32 @@ function makeWorker() {
}
describe('RiotJobWorkerService', () => {
it('acknowledges and deletes invalid stream entries', async () => {
const { worker, garnetService } = makeWorker();
await (
worker as unknown as {
processEntry: (
stream: string,
entry: { id: string; message: Record<string, string> },
) => Promise<void>;
}
).processEntry('riot:queue:high', {
id: 'bad-1',
message: { job: 'not-json' },
});
expect(garnetService.acknowledgeStream).toHaveBeenCalledWith(
'riot:queue:high',
RIOT_JOB_GROUP,
'bad-1',
);
expect(garnetService.deleteStreamEntries).toHaveBeenCalledWith(
'riot:queue:high',
'bad-1',
);
});
it('refreshes league entries while processing user history refresh jobs', async () => {
const { worker, enrichmentService, recentMatchesService, garnetService } =
makeWorker();
@@ -91,12 +118,14 @@ describe('RiotJobWorkerService', () => {
priority: 'high',
};
await (worker as unknown as {
processEntry: (
stream: string,
entry: { id: string; message: Record<string, string> },
) => Promise<void>;
}).processEntry('riot:queue:high', {
await (
worker as unknown as {
processEntry: (
stream: string,
entry: { id: string; message: Record<string, string> },
) => Promise<void>;
}
).processEntry('riot:queue:high', {
id: '1-0',
message: { job: JSON.stringify(job) },
});
@@ -112,5 +141,14 @@ describe('RiotJobWorkerService', () => {
RIOT_JOB_GROUP,
'1-0',
);
expect(garnetService.deleteStreamEntries).toHaveBeenCalledWith(
'riot:queue:high',
'1-0',
);
expect(
garnetService.acknowledgeStream.mock.invocationCallOrder[0],
).toBeLessThan(
garnetService.deleteStreamEntries.mock.invocationCallOrder[0],
);
});
});
@@ -79,10 +79,13 @@ export class RiotJobWorkerService implements OnModuleInit, OnModuleDestroy {
}
}
private async processEntry(stream: string, entry: StreamEntry): Promise<void> {
private async processEntry(
stream: string,
entry: StreamEntry,
): Promise<void> {
const job = this.parseJob(entry);
if (!job) {
await this.garnetService.acknowledgeStream(stream, RIOT_JOB_GROUP, entry.id);
await this.acknowledgeAndDelete(stream, entry.id);
return;
}
@@ -134,7 +137,30 @@ export class RiotJobWorkerService implements OnModuleInit, OnModuleDestroy {
}`,
);
} finally {
await this.garnetService.acknowledgeStream(stream, RIOT_JOB_GROUP, entry.id);
await this.acknowledgeAndDelete(stream, entry.id);
}
}
private async acknowledgeAndDelete(
stream: string,
id: string,
): Promise<void> {
await this.garnetService.acknowledgeStream(stream, RIOT_JOB_GROUP, id);
await this.deleteAcknowledgedEntry(stream, id);
}
private async deleteAcknowledgedEntry(
stream: string,
id: string,
): Promise<void> {
try {
await this.garnetService.deleteStreamEntries(stream, id);
} catch (error) {
this.logger.warn(
`Failed to delete acknowledged Riot job stream entry ${stream} ${id}: ${
error instanceof Error ? error.message : error
}`,
);
}
}
@@ -192,9 +218,7 @@ export class RiotJobWorkerService implements OnModuleInit, OnModuleDestroy {
return job.kind === 'poll-tournament-result';
}
private isLegacyImportJob(
job: RiotJobPayload,
): job is LegacyImportMemberJob {
private isLegacyImportJob(job: RiotJobPayload): job is LegacyImportMemberJob {
return job.kind === 'legacy-import-member';
}
@@ -219,7 +243,8 @@ export class RiotJobWorkerService implements OnModuleInit, OnModuleDestroy {
try {
await this.garnetService.createConsumerGroup(stream, RIOT_JOB_GROUP);
} catch (error) {
const message = error instanceof Error ? error.message : String(error);
const message =
error instanceof Error ? error.message : String(error);
if (!message.includes('BUSYGROUP')) throw error;
}
}),
@@ -0,0 +1,47 @@
import { RiotClientService } from './riot.client.service';
import { RiotLeagueService } from './riot-league.service';
import type { RiotLeagueEntryDto, RiotResponseParser } from './riot.types';
describe('RiotLeagueService', () => {
it('accepts Riot league entries without optional leagueId', async () => {
const client = {
get: jest.fn(
async <T>(
_path: string,
_options: unknown,
parser?: RiotResponseParser<T>,
) =>
parser
? parser([
{
queueType: 'RANKED_SOLO_5x5',
tier: 'EMERALD',
rank: 'I',
puuid: 'puuid-1',
leaguePoints: 75,
wins: 160,
losses: 148,
},
])
: ([] as T),
),
} as unknown as RiotClientService;
const service = new RiotLeagueService(client);
const result = await service.getEntriesByPuuid('puuid-1', {
platform: 'kr',
});
expect(result).toEqual<RiotLeagueEntryDto[]>([
{
queueType: 'RANKED_SOLO_5x5',
tier: 'EMERALD',
rank: 'I',
puuid: 'puuid-1',
leaguePoints: 75,
wins: 160,
losses: 148,
},
]);
});
});
@@ -36,7 +36,10 @@ function parseEntry(value: unknown, index: number): RiotLeagueEntryDto {
throw new TypeError(`leagueEntries[${index}] must be an object.`);
}
return {
leagueId: requireString(value.leagueId, `leagueEntries[${index}].leagueId`),
leagueId: optionalString(
value.leagueId,
`leagueEntries[${index}].leagueId`,
),
queueType: requireString(
value.queueType,
`leagueEntries[${index}].queueType`,
@@ -71,6 +74,11 @@ function requireString(value: unknown, path: string): string {
return value;
}
function optionalString(value: unknown, path: string): string | undefined {
if (value === undefined || value === null) return undefined;
return requireString(value, path);
}
function requireNumber(value: unknown, path: string): number {
if (typeof value !== 'number' || !Number.isFinite(value)) {
throw new TypeError(`${path} must be a finite number.`);
@@ -3,63 +3,156 @@ import { RiotRateLimiterService } from './riot-rate-limiter.service';
function makeService(sendCommand = jest.fn().mockResolvedValue(0)) {
const garnet = {
getString: jest.fn().mockResolvedValue(null),
raw: jest.fn().mockReturnValue({ sendCommand }),
} as unknown as GarnetService;
setString: jest.fn().mockResolvedValue(undefined),
} as unknown as jest.Mocked<GarnetService>;
return {
service: new RiotRateLimiterService(garnet),
garnet,
sendCommand,
};
}
describe('RiotRateLimiterService background limiter', () => {
function observedState(params: {
count120: number;
limit120?: number;
observedAt: number;
windowStartAt: number;
}) {
return JSON.stringify({
count120: params.count120,
limit120: params.limit120 ?? 100,
observedAt: params.observedAt,
windowStartAt: params.windowStartAt,
});
}
describe('RiotRateLimiterService', () => {
afterEach(() => {
jest.restoreAllMocks();
});
it('uses the background key namespace and passes cost to the Lua script', async () => {
it('uses global app rate keys and passes cost to the Lua script', async () => {
jest.spyOn(Date, 'now').mockReturnValue(1_000);
const { service, sendCommand } = makeService();
await service.acquireBackground(8);
await service.acquire('asia', 3);
expect(sendCommand).toHaveBeenCalledTimes(1);
const command = sendCommand.mock.calls[0][0] as string[];
expect(command[0]).toBe('EVAL');
expect(command[2]).toBe('2');
expect(command[3]).toBe('riot:bg:rl:1000');
expect(command[4]).toBe('riot:bg:rl:120000');
expect(command[3]).toBe('riot:rl:app:1000');
expect(command[4]).toBe('riot:rl:app:120000');
expect(command[5]).toBe('1000');
expect(command[7]).toBe('8');
expect(command[7]).toBe('3');
});
it('reads cleaned background usage for both windows', async () => {
jest.spyOn(Date, 'now').mockReturnValue(200_000);
const sendCommand = jest
.fn()
.mockImplementation(async (command: string[]) => {
if (command[0] === 'ZREMRANGEBYSCORE') return 0;
if (command[1] === 'riot:bg:rl:1000') return 3;
if (command[1] === 'riot:bg:rl:120000') return 24;
return 0;
});
const { service } = makeService(sendCommand);
it('records the 120 second app rate observation from Riot headers', async () => {
jest.spyOn(Date, 'now').mockReturnValue(1_000_000);
const { service, garnet } = makeService();
await expect(service.getBackgroundUsage()).resolves.toEqual({
used1s: 3,
used2m: 24,
await service.recordAppRateLimitObservation('47:120,3:1', '100:120,20:1');
expect(garnet.setString).toHaveBeenCalledTimes(1);
const [key, raw, ttl] = garnet.setString.mock.calls[0];
expect(key).toBe('riot:app:rl:observed');
expect(ttl).toBe(300);
expect(JSON.parse(raw)).toEqual({
count120: 47,
limit120: 100,
observedAt: 1_000_000,
windowStartAt: 1_000_000,
});
});
it('resets the inferred window when Riot count decreases or observation is stale', async () => {
const { service, garnet } = makeService();
jest.spyOn(Date, 'now').mockReturnValue(1_060_000);
garnet.getString.mockResolvedValueOnce(
observedState({
count120: 80,
observedAt: 1_050_000,
windowStartAt: 1_000_000,
}),
);
await service.recordAppRateLimitObservation('2:120', null);
expect(JSON.parse(garnet.setString.mock.calls[0][1])).toMatchObject({
count120: 2,
windowStartAt: 1_060_000,
});
expect(sendCommand).toHaveBeenCalledWith([
'ZREMRANGEBYSCORE',
'riot:bg:rl:1000',
'-inf',
'199000',
]);
expect(sendCommand).toHaveBeenCalledWith([
'ZREMRANGEBYSCORE',
'riot:bg:rl:120000',
'-inf',
'80000',
]);
jest.spyOn(Date, 'now').mockReturnValue(1_240_000);
garnet.getString.mockResolvedValueOnce(
observedState({
count120: 20,
observedAt: 1_120_000,
windowStartAt: 1_000_000,
}),
);
await service.recordAppRateLimitObservation('25:120', null);
expect(JSON.parse(garnet.setString.mock.calls[1][1])).toMatchObject({
count120: 25,
windowStartAt: 1_240_000,
});
});
it('opens the refresh gate when there is no active observation', async () => {
const { service, garnet } = makeService();
await expect(service.isRefreshWindowOpen(0.5)).resolves.toBe(true);
garnet.getString.mockResolvedValueOnce(
observedState({
count120: 90,
observedAt: 1_000_000,
windowStartAt: 900_000,
}),
);
jest.spyOn(Date, 'now').mockReturnValue(1_120_000);
await expect(service.isRefreshWindowOpen(0.5)).resolves.toBe(true);
});
it.each([
{ ratio: 0.5, count120: 49, expected: true },
{ ratio: 0.5, count120: 50, expected: false },
{ ratio: 0.8, count120: 79, expected: true },
{ ratio: 0.8, count120: 80, expected: false },
])(
'checks tail headroom for refresh gate ratio=$ratio count=$count120',
async ({ ratio, count120, expected }) => {
jest.spyOn(Date, 'now').mockReturnValue(1_070_000);
const { service, garnet } = makeService();
garnet.getString.mockResolvedValue(
observedState({
count120,
observedAt: 1_069_000,
windowStartAt: 1_000_000,
}),
);
await expect(service.isRefreshWindowOpen(ratio)).resolves.toBe(expected);
},
);
it('keeps the refresh gate closed before the 120 second window tail', async () => {
jest.spyOn(Date, 'now').mockReturnValue(1_050_000);
const { service, garnet } = makeService();
garnet.getString.mockResolvedValue(
observedState({
count120: 10,
observedAt: 1_049_000,
windowStartAt: 1_000_000,
}),
);
await expect(service.isRefreshWindowOpen(0.8)).resolves.toBe(false);
});
});
@@ -7,11 +7,19 @@ const APP_LIMITS = [
{ windowMs: 120_000, max: 90 },
] as const;
const BACKGROUND_LIMITS = [
{ windowMs: 1_000, max: 6 },
{ windowMs: 120_000, max: 36 },
] as const;
const BACKGROUND_KEY_PREFIX = 'riot:bg:rl';
const APP_KEY_PREFIX = 'riot:rl:app';
const APP_WINDOW_MS = 120_000;
const TAIL_MS = 60_000;
const APP_OBSERVED_KEY = 'riot:app:rl:observed';
const APP_OBSERVED_TTL_SECONDS = 300;
const DEFAULT_APP_LIMIT_120 = 100;
interface AppRateObservation {
count120: number;
limit120: number;
observedAt: number;
windowStartAt: number;
}
const ACQUIRE_SCRIPT = `
local now = tonumber(ARGV[1])
@@ -81,85 +89,78 @@ export class RiotRateLimiterService {
public async acquire(
route: RiotRegionalRoute | RiotPlatformRoute,
cost = 1,
): Promise<void> {
for (;;) {
const now = Date.now();
const waitMs = await this.checkAndAdd(route, now, 1);
if (waitMs <= 0) return;
if (waitMs >= 100) {
this.logger.warn(
`Riot API throttle waiting ${waitMs}ms for route=${route}.`,
);
}
await sleep(waitMs);
}
}
public async acquireBackground(cost = 1): Promise<void> {
const normalizedCost = normalizeCost(cost);
for (;;) {
const now = Date.now();
const waitMs = await this.checkAndAddBackground(now, normalizedCost);
const waitMs = await this.checkAndAdd(now, normalizedCost);
if (waitMs <= 0) return;
if (waitMs >= 100) {
this.logger.warn(
`Background Riot throttle waiting ${waitMs}ms (cost=${normalizedCost}).`,
`Riot API throttle waiting ${waitMs}ms for route=${route} cost=${normalizedCost}.`,
);
}
await sleep(waitMs);
}
}
public async getBackgroundUsage(): Promise<{
used1s: number;
used2m: number;
}> {
const client = this.garnet.raw();
const now = Date.now();
const usages = await Promise.all(
BACKGROUND_LIMITS.map(async (limit) => {
const key = `${BACKGROUND_KEY_PREFIX}:${limit.windowMs}`;
await client.sendCommand([
'ZREMRANGEBYSCORE',
key,
'-inf',
String(now - limit.windowMs),
]);
const response = await client.sendCommand(['ZCARD', key]);
const count = Number(response ?? 0);
return Number.isFinite(count) && count > 0 ? count : 0;
}),
);
public async recordAppRateLimitObservation(
countHeader: string | null,
limitHeader?: string | null,
): Promise<void> {
const count120 = parseRateLimitHeader(countHeader, 120);
if (count120 === null) return;
return {
used1s: usages[0] ?? 0,
used2m: usages[1] ?? 0,
const limit120 =
parseRateLimitHeader(limitHeader ?? null, 120) ?? DEFAULT_APP_LIMIT_120;
const now = Date.now();
const previous = await this.getAppRateObservation();
const windowStartAt =
!previous ||
now - previous.observedAt >= APP_WINDOW_MS ||
count120 < previous.count120
? now
: previous.windowStartAt;
const observation: AppRateObservation = {
count120,
limit120,
observedAt: now,
windowStartAt,
};
// Concurrent responses can race here. This observation is advisory, so
// last-writer-wins is acceptable and self-corrects on the next Riot header.
await this.garnet.setString(
APP_OBSERVED_KEY,
JSON.stringify(observation),
APP_OBSERVED_TTL_SECONDS,
);
}
private async checkAndAdd(
route: RiotRegionalRoute | RiotPlatformRoute,
now: number,
cost: number,
): Promise<number> {
public async isRefreshWindowOpen(
usageRatio: number,
now = Date.now(),
): Promise<boolean> {
const observation = await this.getAppRateObservation();
if (!observation) return true;
if (now - observation.observedAt >= APP_WINDOW_MS) return true;
const ratio = Number.isFinite(usageRatio) ? usageRatio : 0;
const headroomOk = observation.count120 < observation.limit120 * ratio;
const inTail = now >= observation.windowStartAt + APP_WINDOW_MS - TAIL_MS;
return headroomOk && inTail;
}
private async checkAndAdd(now: number, cost: number): Promise<number> {
const keys = APP_LIMITS.map(
(limit) => `riot:rl:${route}:${limit.windowMs}`,
(limit) => `${APP_KEY_PREFIX}:${limit.windowMs}`,
);
return this.checkAndAddWithLimits(keys, APP_LIMITS, now, cost);
}
private async checkAndAddBackground(
now: number,
cost: number,
): Promise<number> {
const keys = BACKGROUND_LIMITS.map(
(limit) => `${BACKGROUND_KEY_PREFIX}:${limit.windowMs}`,
);
return this.checkAndAddWithLimits(keys, BACKGROUND_LIMITS, now, cost);
}
private async checkAndAddWithLimits(
keys: string[],
limits: ReadonlyArray<{ windowMs: number; max: number }>,
@@ -187,6 +188,32 @@ export class RiotRateLimiterService {
if (!Number.isFinite(waitMs) || waitMs < 0) return 0;
return waitMs;
}
private async getAppRateObservation(): Promise<AppRateObservation | null> {
const raw = await this.garnet.getString(APP_OBSERVED_KEY);
if (!raw) return null;
try {
const parsed = JSON.parse(raw) as Partial<AppRateObservation>;
if (
typeof parsed.count120 !== 'number' ||
typeof parsed.limit120 !== 'number' ||
typeof parsed.observedAt !== 'number' ||
typeof parsed.windowStartAt !== 'number'
) {
return null;
}
return {
count120: parsed.count120,
limit120: parsed.limit120,
observedAt: parsed.observedAt,
windowStartAt: parsed.windowStartAt,
};
} catch {
return null;
}
}
}
function normalizeCost(cost: number): number {
@@ -194,6 +221,24 @@ function normalizeCost(cost: number): number {
return Math.max(1, Math.floor(cost));
}
function parseRateLimitHeader(
header: string | null,
windowSeconds: number,
): number | null {
if (!header) return null;
for (const rawEntry of header.split(',')) {
const [rawCount, rawWindow] = rawEntry.trim().split(':');
const count = Number(rawCount);
const window = Number(rawWindow);
if (window === windowSeconds && Number.isFinite(count) && count >= 0) {
return count;
}
}
return null;
}
function sleep(ms: number): Promise<void> {
return new Promise((resolve) => setTimeout(resolve, ms));
}
@@ -0,0 +1,43 @@
import { SecretService } from '../global/secret/secret.service';
import { RiotClientService } from './riot.client.service';
import { RiotRateLimiterService } from './riot-rate-limiter.service';
describe('RiotClientService', () => {
const originalFetch = global.fetch;
afterEach(() => {
global.fetch = originalFetch;
jest.restoreAllMocks();
});
it('records Riot app rate limit headers after a response', async () => {
const secretService = {
get: jest.fn().mockResolvedValue('riot-key'),
} as unknown as jest.Mocked<SecretService>;
const rateLimiter = {
acquire: jest.fn().mockResolvedValue(undefined),
recordAppRateLimitObservation: jest.fn().mockResolvedValue(undefined),
} as unknown as jest.Mocked<RiotRateLimiterService>;
global.fetch = jest.fn().mockResolvedValue({
headers: {
get: jest.fn((name: string) => {
if (name === 'X-App-Rate-Limit-Count') return '47:120,3:1';
if (name === 'X-App-Rate-Limit') return '100:120,20:1';
return null;
}),
},
json: jest.fn().mockResolvedValue({ ok: true }),
ok: true,
status: 200,
} as unknown as Response);
const service = new RiotClientService(secretService, rateLimiter);
await service.get('/lol/status/v4/platform-data', { platform: 'kr' });
expect(rateLimiter.acquire).toHaveBeenCalledWith('kr');
expect(rateLimiter.recordAppRateLimitObservation).toHaveBeenCalledWith(
'47:120,3:1',
'100:120,20:1',
);
});
});
@@ -140,16 +140,18 @@ export class RiotClientService {
});
const appRateLimitCount = response.headers.get('X-App-Rate-Limit-Count');
const appRateLimit = response.headers.get('X-App-Rate-Limit');
void this.rateLimiter.recordAppRateLimitObservation(
appRateLimitCount,
appRateLimit,
);
if (appRateLimitCount && Math.random() < 0.05) {
this.logger.debug(`Riot rate usage ${routeKey}: ${appRateLimitCount}`);
}
if (!response.ok) {
const error = await this.createApiError(response, url);
if (
error.status === 429 &&
attempt === 0
) {
if (error.status === 429 && attempt === 0) {
await sleep((error.retryAfterSeconds ?? 1) * 1000);
return this.fetchWithRetry(
url,
+1 -1
View File
@@ -89,7 +89,7 @@ export interface RiotSummonerDto {
// League-V4 entries by-puuid 응답
export interface RiotLeagueEntryDto {
leagueId: string;
leagueId?: string;
queueType: string;
tier: string;
rank: string;
+60 -1
View File
@@ -1,10 +1,69 @@
import { defineConfig } from "vite";
import react from "@vitejs/plugin-react";
import tailwindcss from "@tailwindcss/vite";
import { createRequire } from "node:module";
import fs from "node:fs";
import path from "node:path";
const ES_TOOLKIT_COMPAT_RE = /^es-toolkit\/compat\/[A-Za-z0-9_$]+$/;
const VIRTUAL_ES_TOOLKIT_COMPAT_PREFIX = "\0es-toolkit-compat-esm:";
function esToolkitCompatEsm() {
return {
name: "es-toolkit-compat-esm",
enforce: "pre" as const,
resolveId(source: string, importer?: string) {
if (!importer || !ES_TOOLKIT_COMPAT_RE.test(source)) {
return null;
}
const requireFromImporter = createRequire(importer);
const wrapperPath = requireFromImporter.resolve(source);
const wrapperSource = fs.readFileSync(wrapperPath, "utf8");
const wrapperMatch = wrapperSource.match(
/require\(['"](\.\.\/dist\/compat\/[^'"]+)\.js['"]\)\.([A-Za-z0-9_$]+)/,
);
if (!wrapperMatch) {
return null;
}
const [, esmPathWithoutExtension, exportName] = wrapperMatch;
const esmPath = path.resolve(
path.dirname(wrapperPath),
`${esmPathWithoutExtension}.mjs`,
);
return `${VIRTUAL_ES_TOOLKIT_COMPAT_PREFIX}${encodeURIComponent(
exportName,
)}:${encodeURIComponent(esmPath)}`;
},
load(id: string) {
if (!id.startsWith(VIRTUAL_ES_TOOLKIT_COMPAT_PREFIX)) {
return null;
}
const [encodedExportName, encodedEsmPath] = id
.slice(VIRTUAL_ES_TOOLKIT_COMPAT_PREFIX.length)
.split(":");
const exportName = decodeURIComponent(encodedExportName);
const esmPath = decodeURIComponent(encodedEsmPath);
return `export { ${exportName} as default, ${exportName} } from ${JSON.stringify(
esmPath,
)};`;
},
};
}
// https://vite.dev/config/
export default defineConfig({
plugins: [react(), tailwindcss()],
plugins: [esToolkitCompatEsm(), react(), tailwindcss()],
optimizeDeps: {
rolldownOptions: {
plugins: [esToolkitCompatEsm()],
},
},
server: {
host: "0.0.0.0",
allowedHosts: ["126.dahyeon.us"],
+52 -16
View File
@@ -26,12 +26,23 @@ export function main(args = process.argv.slice(2), env = process.env) {
env.CF_PAGES_PROJECT_NAME ??
env.CLOUDFLARE_PAGES_PROJECT_NAME ??
"lolympus";
const stagingBranch =
target === "staging" ? resolveStagingBranch(env) : undefined;
const deployPlan = resolveDeployPlan(target, env);
validateEnv(viteMode, env);
run("pnpm", ["--filter", "web", "run", `build:${target}`], repoRoot);
const deployArgs = createPagesDeployArgs(projectName, deployPlan.pagesBranch);
console.error(
[
`Deploying ${target} from ${deployPlan.sourceBranch}`,
`to Cloudflare Pages branch ${deployPlan.pagesBranch}`,
].join(" "),
);
run("pnpm", deployArgs, webDir);
}
export function createPagesDeployArgs(projectName, branch) {
const deployArgs = [
"exec",
"wrangler",
@@ -42,37 +53,62 @@ export function main(args = process.argv.slice(2), env = process.env) {
projectName,
];
if (target === "staging") {
deployArgs.push("--branch", stagingBranch);
console.error(
`Deploying staging to Cloudflare Pages branch ${stagingBranch}`,
);
}
run("pnpm", deployArgs, webDir);
if (branch) deployArgs.push("--branch", branch);
return deployArgs;
}
export function resolveStagingBranch(env = process.env) {
const configuredBranch = env.CF_PAGES_STAGING_BRANCH?.trim();
return resolveDeployPlan("staging", env).pagesBranch;
}
export function resolveDeployPlan(
target,
env = process.env,
releaseBranchRowsProvider = () => {
refreshRemoteReleaseBranches();
return listReleaseBranchRefs();
},
) {
const sourceBranch = resolveSourceBranch(
target,
env,
releaseBranchRowsProvider,
);
const pagesBranch =
target === "prod" ? resolveProductionBranch(env) : sourceBranch;
return { sourceBranch, pagesBranch };
}
function resolveSourceBranch(target, env, releaseBranchRowsProvider) {
const sourceEnvKey =
target === "prod" ? "CF_PAGES_RELEASE_BRANCH" : "CF_PAGES_STAGING_BRANCH";
const configuredBranch = env[sourceEnvKey]?.trim();
if (configuredBranch) return configuredBranch;
refreshRemoteReleaseBranches();
const latestReleaseBranch = selectLatestReleaseBranch(
listReleaseBranchRefs(),
releaseBranchRowsProvider(),
);
if (latestReleaseBranch) return latestReleaseBranch;
console.error(
[
"No release/* branch found for staging deploy.",
`No release/* branch found for ${target} deploy.`,
"Create a release branch, for example: git push origin main:release/66",
"Or set CF_PAGES_STAGING_BRANCH explicitly.",
`Or set ${sourceEnvKey} explicitly.`,
].join("\n"),
);
process.exit(1);
}
function resolveProductionBranch(env) {
return (
env.CF_PAGES_PRODUCTION_BRANCH?.trim() ||
env.CF_PAGES_PROD_BRANCH?.trim() ||
"main"
);
}
export function selectLatestReleaseBranch(refRows) {
const latestByBranch = new Map();
+63
View File
@@ -0,0 +1,63 @@
import assert from "node:assert/strict";
import { describe, it } from "node:test";
import {
createPagesDeployArgs,
resolveDeployPlan,
} from "./deploy-cloudflare-pages.mjs";
describe("deploy-cloudflare-pages", () => {
it("deploys prod to the production branch using the latest release branch as source", () => {
const plan = resolveDeployPlan("prod", {}, () => [
"1710000000\torigin/release/66",
"1720000000\torigin/release/67",
]);
assert.deepEqual(plan, {
sourceBranch: "release/67",
pagesBranch: "main",
});
assert.deepEqual(
createPagesDeployArgs("lolympus", plan.pagesBranch),
[
"exec",
"wrangler",
"pages",
"deploy",
"dist",
"--project-name",
"lolympus",
"--branch",
"main",
],
);
});
it("keeps explicit staging branch override behavior", () => {
const plan = resolveDeployPlan(
"staging",
{ CF_PAGES_STAGING_BRANCH: "release/manual" },
() => {
throw new Error("should not inspect git refs when branch is explicit");
},
);
assert.deepEqual(plan, {
sourceBranch: "release/manual",
pagesBranch: "release/manual",
});
});
it("allows overriding the Cloudflare Pages production branch", () => {
const plan = resolveDeployPlan(
"prod",
{ CF_PAGES_PRODUCTION_BRANCH: "production" },
() => ["1720000000\torigin/release/67"],
);
assert.deepEqual(plan, {
sourceBranch: "release/67",
pagesBranch: "production",
});
});
});