Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e3f39fd8b8 | ||
|
|
9cd5850d43 |
No files matched your search
@@ -53,6 +53,7 @@ function makeScheduler() {
|
||||
} as unknown as jest.Mocked<RiotRateLimiterService>;
|
||||
const enrichmentService = {
|
||||
markRefreshRequested: jest.fn().mockResolvedValue(undefined),
|
||||
refreshRiotIdentity: jest.fn().mockResolvedValue('unchanged'),
|
||||
enrichRiotAccount: jest.fn().mockResolvedValue(successResult()),
|
||||
} as unknown as jest.Mocked<RiotAccountEnrichmentService>;
|
||||
const staleAccountRepository = {
|
||||
@@ -134,7 +135,7 @@ describe('BackgroundRefreshScheduler', () => {
|
||||
expect(staleAccountRepository.findStaleAccounts).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('marks and enriches each stale candidate without background precharge', async () => {
|
||||
it('marks, refreshes identity, and enriches each stale candidate without background precharge', async () => {
|
||||
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T18:00:00.000Z'));
|
||||
const { scheduler, enrichmentService, staleAccountRepository } =
|
||||
makeScheduler();
|
||||
@@ -149,11 +150,21 @@ describe('BackgroundRefreshScheduler', () => {
|
||||
candidates[0].userId,
|
||||
'puuid-1',
|
||||
);
|
||||
expect(enrichmentService.refreshRiotIdentity).toHaveBeenNthCalledWith(1, {
|
||||
userId: candidates[0].userId,
|
||||
puuid: 'puuid-1',
|
||||
});
|
||||
expect(enrichmentService.refreshRiotIdentity).toHaveBeenCalledTimes(2);
|
||||
expect(enrichmentService.enrichRiotAccount).toHaveBeenNthCalledWith(2, {
|
||||
userId: candidates[1].userId,
|
||||
puuid: 'puuid-2',
|
||||
options: { force: false },
|
||||
});
|
||||
expect(
|
||||
enrichmentService.refreshRiotIdentity.mock.invocationCallOrder[0],
|
||||
).toBeLessThan(
|
||||
enrichmentService.enrichRiotAccount.mock.invocationCallOrder[0],
|
||||
);
|
||||
});
|
||||
|
||||
it('stops the candidate loop when the refresh gate closes mid-tick', async () => {
|
||||
@@ -202,6 +213,27 @@ describe('BackgroundRefreshScheduler', () => {
|
||||
]);
|
||||
});
|
||||
|
||||
it('continues statistics enrichment without a failure counter when identity refresh fails', async () => {
|
||||
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T18:00:00.000Z'));
|
||||
const { scheduler, rawClient, enrichmentService, staleAccountRepository } =
|
||||
makeScheduler();
|
||||
const account = candidate('puuid-1');
|
||||
staleAccountRepository.findStaleAccounts.mockResolvedValue([account]);
|
||||
enrichmentService.refreshRiotIdentity.mockResolvedValueOnce('failed');
|
||||
|
||||
await scheduler.tick();
|
||||
|
||||
expect(enrichmentService.refreshRiotIdentity).toHaveBeenCalledWith({
|
||||
userId: account.userId,
|
||||
puuid: 'puuid-1',
|
||||
});
|
||||
expect(enrichmentService.enrichRiotAccount).toHaveBeenCalledTimes(1);
|
||||
expect(rawClient.sendCommand).not.toHaveBeenCalledWith([
|
||||
'INCR',
|
||||
'riot:bg:fail:puuid-1',
|
||||
]);
|
||||
});
|
||||
|
||||
it('skips candidates already in failure backoff', async () => {
|
||||
jest.useFakeTimers().setSystemTime(new Date('2026-05-02T18:00:00.000Z'));
|
||||
const { scheduler, redis, enrichmentService, staleAccountRepository } =
|
||||
@@ -217,6 +249,7 @@ describe('BackgroundRefreshScheduler', () => {
|
||||
await scheduler.tick();
|
||||
|
||||
expect(enrichmentService.markRefreshRequested).not.toHaveBeenCalled();
|
||||
expect(enrichmentService.refreshRiotIdentity).not.toHaveBeenCalled();
|
||||
expect(enrichmentService.enrichRiotAccount).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -15,7 +15,10 @@ import {
|
||||
} from '../global/redis/distributed-lock.service';
|
||||
import { RedisService } from '../global/redis/redis.service';
|
||||
import { isInKstBackgroundWindow } from './kst-window.util';
|
||||
import { StaleAccountRepository } from './stale-account.repository';
|
||||
import {
|
||||
type StaleAccountCandidate,
|
||||
StaleAccountRepository,
|
||||
} from './stale-account.repository';
|
||||
|
||||
const TICK_INTERVAL_MS = 60_000;
|
||||
const LEADER_LOCK_KEY = 'distributed-lock:riot-background-refresh:leader';
|
||||
@@ -133,6 +136,7 @@ export class BackgroundRefreshScheduler
|
||||
candidate.userId,
|
||||
candidate.puuid,
|
||||
);
|
||||
await this.refreshRiotIdentity(candidate);
|
||||
|
||||
try {
|
||||
const result = await this.enrichmentService.enrichRiotAccount({
|
||||
@@ -165,6 +169,28 @@ export class BackgroundRefreshScheduler
|
||||
);
|
||||
}
|
||||
|
||||
private async refreshRiotIdentity(
|
||||
candidate: StaleAccountCandidate,
|
||||
): Promise<void> {
|
||||
try {
|
||||
const result = await this.enrichmentService.refreshRiotIdentity({
|
||||
userId: candidate.userId,
|
||||
puuid: candidate.puuid,
|
||||
});
|
||||
if (result !== 'failed') return;
|
||||
|
||||
this.logger.warn(
|
||||
`Background Riot identity refresh failed for ${candidate.puuid}.`,
|
||||
);
|
||||
} catch (err) {
|
||||
this.logger.warn(
|
||||
`Background Riot identity refresh failed for ${candidate.puuid}: ${
|
||||
err instanceof Error ? err.message : String(err)
|
||||
}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
private currentRefreshGatePolicy(): RefreshGatePolicy {
|
||||
const isDawn = isInKstBackgroundWindow();
|
||||
return {
|
||||
|
||||
@@ -62,6 +62,7 @@ function makeWorker() {
|
||||
processMemberJob: jest.fn(),
|
||||
} as unknown as jest.Mocked<LegacyImportService>;
|
||||
const enrichmentService = {
|
||||
refreshRiotIdentity: jest.fn().mockResolvedValue('unchanged'),
|
||||
refreshLeagueEntries: jest.fn().mockResolvedValue('updated'),
|
||||
} as unknown as jest.Mocked<RiotAccountEnrichmentService>;
|
||||
|
||||
@@ -116,9 +117,14 @@ describe('RiotJobWorkerService', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('refreshes league entries while processing user history refresh jobs', async () => {
|
||||
const { worker, enrichmentService, recentMatchesService, redisService } =
|
||||
makeWorker();
|
||||
it('refreshes Riot identity and league entries while processing user history refresh jobs', async () => {
|
||||
const {
|
||||
worker,
|
||||
enrichmentService,
|
||||
recentMatchesService,
|
||||
redisService,
|
||||
jobQueueService,
|
||||
} = makeWorker();
|
||||
const userId = new mongoose.Types.ObjectId().toString();
|
||||
const job: RiotRefreshSubJob = {
|
||||
jobId: 'job-1',
|
||||
@@ -146,11 +152,19 @@ describe('RiotJobWorkerService', () => {
|
||||
});
|
||||
|
||||
expect(recentMatchesService.ensureFreshForQueue).toHaveBeenCalledTimes(2);
|
||||
expect(enrichmentService.refreshRiotIdentity).toHaveBeenCalledWith({
|
||||
userId: expect.any(mongoose.Types.ObjectId),
|
||||
puuid: 'puuid-1',
|
||||
region: 'asia',
|
||||
});
|
||||
expect(enrichmentService.refreshLeagueEntries).toHaveBeenCalledWith({
|
||||
userId: expect.any(mongoose.Types.ObjectId),
|
||||
puuid: 'puuid-1',
|
||||
platform: 'kr',
|
||||
});
|
||||
expect(
|
||||
enrichmentService.refreshRiotIdentity.mock.invocationCallOrder[0],
|
||||
).toBeLessThan(jobQueueService.markCompleted.mock.invocationCallOrder[0]);
|
||||
expect(redisService.acknowledgeStream).toHaveBeenCalledWith(
|
||||
'riot:queue:high',
|
||||
RIOT_JOB_GROUP,
|
||||
@@ -167,6 +181,45 @@ describe('RiotJobWorkerService', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('completes successful match refresh work when Riot identity lookup throws', async () => {
|
||||
const { worker, enrichmentService, jobQueueService, refreshGateway } =
|
||||
makeWorker();
|
||||
enrichmentService.refreshRiotIdentity.mockRejectedValueOnce(
|
||||
new Error('Account-V1 unavailable'),
|
||||
);
|
||||
const job: RiotRefreshSubJob = {
|
||||
jobId: 'job-1',
|
||||
parentJobId: 'parent-1',
|
||||
userId: new mongoose.Types.ObjectId().toString(),
|
||||
puuid: 'puuid-1',
|
||||
region: 'asia',
|
||||
platform: 'kr',
|
||||
queueGroup: 'summoners-rift',
|
||||
queueIds: [420],
|
||||
requestedAt: Date.now(),
|
||||
priority: '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) },
|
||||
});
|
||||
|
||||
expect(enrichmentService.refreshRiotIdentity).toHaveBeenCalledTimes(1);
|
||||
expect(jobQueueService.markCompleted).toHaveBeenCalledWith(job);
|
||||
expect(jobQueueService.markFailed).not.toHaveBeenCalled();
|
||||
expect(refreshGateway.broadcastRefreshEvent).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ state: 'completed' }),
|
||||
);
|
||||
});
|
||||
|
||||
it('leaves a stream entry pending when another worker owns the job processing lock', async () => {
|
||||
const { worker, distributedLockService, redisService } = makeWorker();
|
||||
distributedLockService.runWithRenewedLock.mockResolvedValueOnce(null);
|
||||
|
||||
@@ -156,6 +156,7 @@ export class RiotJobWorkerService implements OnModuleInit, OnModuleDestroy {
|
||||
queueId,
|
||||
});
|
||||
}
|
||||
await this.refreshRiotIdentity(job);
|
||||
await this.refreshLeagueEntries(job);
|
||||
await this.markUserFetchedAt(job);
|
||||
const event = await this.jobQueueService.markCompleted(job);
|
||||
@@ -211,6 +212,26 @@ export class RiotJobWorkerService implements OnModuleInit, OnModuleDestroy {
|
||||
}
|
||||
}
|
||||
|
||||
private async refreshRiotIdentity(job: RiotRefreshSubJob): Promise<void> {
|
||||
try {
|
||||
const result = await this.enrichmentService.refreshRiotIdentity({
|
||||
userId: new mongoose.Types.ObjectId(job.userId),
|
||||
puuid: job.puuid,
|
||||
region: job.region,
|
||||
});
|
||||
if (result !== 'failed') return;
|
||||
this.logger.warn(
|
||||
`Riot identity refresh failed ${job.jobId}: puuid=${job.puuid}`,
|
||||
);
|
||||
} catch (error) {
|
||||
this.logger.warn(
|
||||
`Riot identity refresh failed ${job.jobId}: ${
|
||||
error instanceof Error ? error.message : error
|
||||
}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
private async refreshLeagueEntries(job: RiotRefreshSubJob): Promise<void> {
|
||||
try {
|
||||
const result = await this.enrichmentService.refreshLeagueEntries({
|
||||
|
||||
@@ -12,9 +12,12 @@ import { RiotLeagueService } from './riot-league.service';
|
||||
import { RiotRecentMatchesService } from './riot-recent-matches.service';
|
||||
import { RiotRecentStatsService } from './riot-recent-stats.service';
|
||||
import { RiotSummonerService } from './riot-summoner.service';
|
||||
import { type RiotPlatformRoute, type RiotRegionalRoute } from './riot.types';
|
||||
|
||||
interface FakeAccount {
|
||||
puuid: string;
|
||||
gameName: string;
|
||||
tagLine: string;
|
||||
profileIconId: number;
|
||||
revisionDate: number;
|
||||
summonerLevel: number;
|
||||
@@ -56,6 +59,8 @@ interface FakeAccount {
|
||||
function makeAccount(overrides: Partial<FakeAccount> = {}): FakeAccount {
|
||||
return {
|
||||
puuid: 'puuid-1',
|
||||
gameName: 'OldName',
|
||||
tagLine: 'KR1',
|
||||
profileIconId: 0,
|
||||
revisionDate: 0,
|
||||
summonerLevel: 0,
|
||||
@@ -82,6 +87,11 @@ function makeUser(account: FakeAccount) {
|
||||
|
||||
function makeService(overrides?: {
|
||||
user?: any;
|
||||
community?: {
|
||||
riotPlatform?: RiotPlatformRoute;
|
||||
riotRegion?: RiotRegionalRoute;
|
||||
seasonStartedAt?: Date;
|
||||
};
|
||||
account?: Partial<RiotAccountService>;
|
||||
summoner?: Partial<RiotSummonerService>;
|
||||
league?: Partial<RiotLeagueService>;
|
||||
@@ -98,10 +108,12 @@ function makeService(overrides?: {
|
||||
select: () => ({
|
||||
lean: () => ({
|
||||
exec: () =>
|
||||
Promise.resolve({
|
||||
riotPlatform: 'kr',
|
||||
riotRegion: 'asia',
|
||||
}),
|
||||
Promise.resolve(
|
||||
overrides?.community ?? {
|
||||
riotPlatform: 'kr',
|
||||
riotRegion: 'asia',
|
||||
},
|
||||
),
|
||||
}),
|
||||
}),
|
||||
});
|
||||
@@ -130,6 +142,7 @@ function makeService(overrides?: {
|
||||
...overrides?.summoner,
|
||||
} as unknown as RiotSummonerService;
|
||||
const accountService = {
|
||||
getByPuuid: jest.fn(),
|
||||
getRegionByPuuid: jest.fn(),
|
||||
...overrides?.account,
|
||||
} as unknown as RiotAccountService;
|
||||
@@ -177,6 +190,205 @@ function makeService(overrides?: {
|
||||
}
|
||||
|
||||
describe('RiotAccountEnrichmentService', () => {
|
||||
it('updates a changed Riot ID resolved from the stored PUUID', async () => {
|
||||
const account = makeAccount();
|
||||
const user = makeUser(account);
|
||||
const { service, accountService } = makeService({
|
||||
user,
|
||||
account: {
|
||||
getByPuuid: jest.fn().mockResolvedValue({
|
||||
puuid: 'puuid-1',
|
||||
gameName: 'NewName',
|
||||
tagLine: 'KR1',
|
||||
}),
|
||||
},
|
||||
});
|
||||
|
||||
const result = await service.refreshRiotIdentity({
|
||||
userId: user._id,
|
||||
puuid: 'puuid-1',
|
||||
region: 'europe',
|
||||
});
|
||||
|
||||
expect(result).toBe('updated');
|
||||
expect(account.gameName).toBe('NewName');
|
||||
expect(account.tagLine).toBe('KR1');
|
||||
expect(user.save).toHaveBeenCalledTimes(1);
|
||||
expect(accountService.getByPuuid).toHaveBeenCalledWith('puuid-1', {
|
||||
region: 'europe',
|
||||
});
|
||||
});
|
||||
|
||||
it('updates a changed Riot tag line resolved from the stored PUUID', async () => {
|
||||
const account = makeAccount();
|
||||
const user = makeUser(account);
|
||||
const { service } = makeService({
|
||||
user,
|
||||
account: {
|
||||
getByPuuid: jest.fn().mockResolvedValue({
|
||||
puuid: 'puuid-1',
|
||||
gameName: 'OldName',
|
||||
tagLine: 'NEW',
|
||||
}),
|
||||
},
|
||||
});
|
||||
|
||||
const result = await service.refreshRiotIdentity({
|
||||
userId: user._id,
|
||||
puuid: 'puuid-1',
|
||||
});
|
||||
|
||||
expect(result).toBe('updated');
|
||||
expect(account.gameName).toBe('OldName');
|
||||
expect(account.tagLine).toBe('NEW');
|
||||
expect(user.save).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('resolves the Riot region from the user community when none is provided', async () => {
|
||||
const account = makeAccount();
|
||||
const user = makeUser(account);
|
||||
const { service, accountService } = makeService({
|
||||
user,
|
||||
community: {
|
||||
riotPlatform: 'na1',
|
||||
riotRegion: 'americas',
|
||||
},
|
||||
account: {
|
||||
getByPuuid: jest.fn().mockResolvedValue({
|
||||
puuid: 'puuid-1',
|
||||
gameName: 'NewName',
|
||||
tagLine: 'NA1',
|
||||
}),
|
||||
},
|
||||
});
|
||||
|
||||
await service.refreshRiotIdentity({
|
||||
userId: user._id,
|
||||
puuid: 'puuid-1',
|
||||
});
|
||||
|
||||
expect(accountService.getByPuuid).toHaveBeenCalledWith('puuid-1', {
|
||||
region: 'americas',
|
||||
});
|
||||
});
|
||||
|
||||
it('falls back to the default Riot region when the community has no region', async () => {
|
||||
const account = makeAccount();
|
||||
const user = makeUser(account);
|
||||
const { service, accountService } = makeService({
|
||||
user,
|
||||
community: {
|
||||
riotPlatform: 'kr',
|
||||
},
|
||||
account: {
|
||||
getByPuuid: jest.fn().mockResolvedValue({
|
||||
puuid: 'puuid-1',
|
||||
gameName: 'NewName',
|
||||
tagLine: 'KR1',
|
||||
}),
|
||||
},
|
||||
});
|
||||
|
||||
await service.refreshRiotIdentity({
|
||||
userId: user._id,
|
||||
puuid: 'puuid-1',
|
||||
});
|
||||
|
||||
expect(accountService.getByPuuid).toHaveBeenCalledWith('puuid-1', {
|
||||
region: 'asia',
|
||||
});
|
||||
});
|
||||
|
||||
it('does not save when the Riot ID has not changed', async () => {
|
||||
const account = makeAccount();
|
||||
const user = makeUser(account);
|
||||
const { service } = makeService({
|
||||
user,
|
||||
account: {
|
||||
getByPuuid: jest.fn().mockResolvedValue({
|
||||
puuid: 'puuid-1',
|
||||
gameName: 'OldName',
|
||||
tagLine: 'KR1',
|
||||
}),
|
||||
},
|
||||
});
|
||||
|
||||
const result = await service.refreshRiotIdentity({
|
||||
userId: user._id,
|
||||
puuid: 'puuid-1',
|
||||
});
|
||||
|
||||
expect(result).toBe('unchanged');
|
||||
expect(user.save).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it.each([
|
||||
{
|
||||
name: 'a mismatched PUUID',
|
||||
response: {
|
||||
puuid: 'different-puuid',
|
||||
gameName: 'NewName',
|
||||
tagLine: 'NEW',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'a missing game name',
|
||||
response: {
|
||||
puuid: 'puuid-1',
|
||||
gameName: null,
|
||||
tagLine: 'NEW',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'a blank tag line',
|
||||
response: {
|
||||
puuid: 'puuid-1',
|
||||
gameName: 'NewName',
|
||||
tagLine: ' ',
|
||||
},
|
||||
},
|
||||
])('preserves the stored Riot ID for $name', async ({ response }) => {
|
||||
const account = makeAccount();
|
||||
const user = makeUser(account);
|
||||
const { service } = makeService({
|
||||
user,
|
||||
account: {
|
||||
getByPuuid: jest.fn().mockResolvedValue(response),
|
||||
},
|
||||
});
|
||||
|
||||
const result = await service.refreshRiotIdentity({
|
||||
userId: user._id,
|
||||
puuid: 'puuid-1',
|
||||
});
|
||||
|
||||
expect(result).toBe('failed');
|
||||
expect(account.gameName).toBe('OldName');
|
||||
expect(account.tagLine).toBe('KR1');
|
||||
expect(user.save).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('preserves the stored Riot ID when Account-V1 lookup fails', async () => {
|
||||
const account = makeAccount();
|
||||
const user = makeUser(account);
|
||||
const { service } = makeService({
|
||||
user,
|
||||
account: {
|
||||
getByPuuid: jest.fn().mockRejectedValue(new Error('Riot unavailable')),
|
||||
},
|
||||
});
|
||||
|
||||
const result = await service.refreshRiotIdentity({
|
||||
userId: user._id,
|
||||
puuid: 'puuid-1',
|
||||
});
|
||||
|
||||
expect(result).toBe('failed');
|
||||
expect(account.gameName).toBe('OldName');
|
||||
expect(account.tagLine).toBe('KR1');
|
||||
expect(user.save).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('returns failed for unknown user', async () => {
|
||||
const { service } = makeService();
|
||||
const result = await service.enrichRiotAccount({
|
||||
|
||||
@@ -59,6 +59,7 @@ export interface EnrichResult {
|
||||
}
|
||||
|
||||
export type RefreshLeagueEntriesResult = 'updated' | 'failed';
|
||||
export type RefreshRiotIdentityResult = 'updated' | 'unchanged' | 'failed';
|
||||
|
||||
@Injectable()
|
||||
export class RiotAccountEnrichmentService {
|
||||
@@ -87,6 +88,67 @@ export class RiotAccountEnrichmentService {
|
||||
).exec();
|
||||
}
|
||||
|
||||
public async refreshRiotIdentity(params: {
|
||||
userId: mongoose.Types.ObjectId;
|
||||
puuid: string;
|
||||
region?: RiotRegionalRoute;
|
||||
}): Promise<RefreshRiotIdentityResult> {
|
||||
try {
|
||||
const UserModel = await this.connectionService.getModel('user');
|
||||
const user = await UserModel.findById(params.userId).exec();
|
||||
if (!user) return 'failed';
|
||||
|
||||
const account = user.riotAccounts.find(
|
||||
(candidate) => candidate.puuid === params.puuid,
|
||||
);
|
||||
if (!account) return 'failed';
|
||||
|
||||
let region = params.region;
|
||||
if (!region) {
|
||||
const CommunityModel =
|
||||
await this.connectionService.getModel('community');
|
||||
const community = await CommunityModel.findById(user.communityId)
|
||||
.select({ riotRegion: 1 })
|
||||
.lean()
|
||||
.exec();
|
||||
region = community?.riotRegion ?? DEFAULT_REGION;
|
||||
}
|
||||
|
||||
const identity = await this.accountService.getByPuuid(params.puuid, {
|
||||
region,
|
||||
});
|
||||
if (
|
||||
identity.puuid !== params.puuid ||
|
||||
!identity.gameName?.trim() ||
|
||||
!identity.tagLine?.trim()
|
||||
) {
|
||||
this.logger.warn(
|
||||
`Riot identity response was incomplete or mismatched for ${params.puuid}.`,
|
||||
);
|
||||
return 'failed';
|
||||
}
|
||||
|
||||
if (
|
||||
account.gameName === identity.gameName &&
|
||||
account.tagLine === identity.tagLine
|
||||
) {
|
||||
return 'unchanged';
|
||||
}
|
||||
|
||||
account.gameName = identity.gameName;
|
||||
account.tagLine = identity.tagLine;
|
||||
await user.save();
|
||||
return 'updated';
|
||||
} catch (error) {
|
||||
this.logger.warn(
|
||||
`Riot identity refresh failed for ${params.puuid}: ${
|
||||
error instanceof Error ? error.message : String(error)
|
||||
}`,
|
||||
);
|
||||
return 'failed';
|
||||
}
|
||||
}
|
||||
|
||||
public async enrichRiotAccount(params: {
|
||||
userId: mongoose.Types.ObjectId;
|
||||
puuid: string;
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
# Implementation Plan: Refresh Riot ID by PUUID
|
||||
|
||||
## Overview
|
||||
|
||||
Deliver the behavior in three backend slices. First add and prove the safe
|
||||
Account-V1-to-user persistence operation. Then invoke it from the existing
|
||||
personal-history refresh worker before completion is broadcast. Finally reuse it
|
||||
from stale-account background refresh with community-aware region resolution and
|
||||
failure isolation. No database or frontend contract change is required.
|
||||
|
||||
## Task List
|
||||
|
||||
### Phase 1: Identity Refresh Boundary
|
||||
|
||||
- [x] Add failing tests for changed, unchanged, incomplete, mismatched, and failed
|
||||
PUUID identity lookups.
|
||||
- Acceptance: tests describe state outcomes and fail because the focused method
|
||||
is not implemented.
|
||||
- Verify:
|
||||
`pnpm --filter api exec jest --runInBand riot-account-enrichment.service.spec.ts`
|
||||
- Files:
|
||||
`apps/api/src/modules/riot/riot-account-enrichment.service.spec.ts`
|
||||
- [x] Implement `refreshRiotIdentity` using `RiotAccountService.getByPuuid`.
|
||||
- Acceptance: valid changed values persist together; invalid results preserve
|
||||
existing values; unchanged values avoid a write.
|
||||
- Verify: the Phase 1 focused test passes.
|
||||
- Files:
|
||||
`apps/api/src/modules/riot/riot-account-enrichment.service.ts`
|
||||
|
||||
### Checkpoint: Phase 1
|
||||
|
||||
- [x] The enrichment service has a typed three-state result and all focused tests
|
||||
pass.
|
||||
- [x] No schema, endpoint, queue payload, or frontend changes exist.
|
||||
|
||||
### Phase 2: Refresh Worker Integration
|
||||
|
||||
- [x] Add a failing worker test proving that a user-history job requests identity
|
||||
refresh with its user ID, PUUID, and region.
|
||||
- Acceptance: the test fails before worker orchestration is updated.
|
||||
- Verify:
|
||||
`pnpm --filter api exec jest --runInBand riot-job-worker.service.spec.ts`
|
||||
- Files: `apps/api/src/modules/riot-job-queue/riot-job-worker.service.spec.ts`
|
||||
- [x] Invoke best-effort identity refresh before job completion.
|
||||
- Acceptance: the worker logs identity failure without aborting successful match
|
||||
refresh work, and broadcasts completion only after identity refresh returns.
|
||||
- Verify: the Phase 2 focused test passes.
|
||||
- Files: `apps/api/src/modules/riot-job-queue/riot-job-worker.service.ts`
|
||||
|
||||
### Checkpoint: Complete
|
||||
|
||||
- [x] Focused API suites pass without skipped tests.
|
||||
- [x] API lint and build pass.
|
||||
- [x] Web lint and production build pass, confirming the existing profile
|
||||
invalidation integration remains compatible.
|
||||
- [x] Final diff contains only the specification, plan, enrichment service, worker,
|
||||
and their tests.
|
||||
|
||||
### Phase 3: Background Refresh Integration
|
||||
|
||||
- [x] Add a failing enrichment-service test proving that an omitted region is
|
||||
resolved from the user's community.
|
||||
- Acceptance: a non-Asia community route reaches Account-V1 without changing the
|
||||
public method signature.
|
||||
- Verify:
|
||||
`pnpm --filter api exec jest --runInBand riot-account-enrichment.service.spec.ts`
|
||||
- Files:
|
||||
`apps/api/src/modules/riot/riot-account-enrichment.service.spec.ts`
|
||||
- [x] Resolve the community Riot region for region-less identity refresh calls.
|
||||
- Acceptance: explicit caller regions remain unchanged; missing community routes
|
||||
use the existing `asia` fallback.
|
||||
- Verify: the focused enrichment-service test passes.
|
||||
- Files:
|
||||
`apps/api/src/modules/riot/riot-account-enrichment.service.ts`
|
||||
- [x] Add failing background scheduler tests for identity refresh ordering and
|
||||
failure isolation.
|
||||
- Acceptance: stale accounts request identity refresh before statistics
|
||||
enrichment, while identity rejection does not increment failure counters.
|
||||
- Verify:
|
||||
`pnpm --filter api exec jest --runInBand background-refresh.scheduler.spec.ts`
|
||||
- Files:
|
||||
`apps/api/src/modules/riot-background-refresh/background-refresh.scheduler.spec.ts`
|
||||
- [x] Invoke best-effort identity refresh from the stale-account loop.
|
||||
- Acceptance: each processed candidate gets one PUUID identity lookup, statistics
|
||||
enrichment still determines processed/failed/backoff state, and no new Redis or
|
||||
database contract is added.
|
||||
- Verify: the focused background scheduler tests pass.
|
||||
- Files:
|
||||
`apps/api/src/modules/riot-background-refresh/background-refresh.scheduler.ts`
|
||||
|
||||
### Checkpoint: Background Refresh Complete
|
||||
|
||||
- [x] Focused identity, manual worker, and background scheduler suites pass.
|
||||
- [x] API lint, full tests, and build pass.
|
||||
- [x] Final diff remains limited to the existing feature documents, identity
|
||||
service/tests, and background scheduler/tests.
|
||||
|
||||
## Risks and Mitigations
|
||||
|
||||
| Risk | Impact | Mitigation |
|
||||
|---|---|---|
|
||||
| Account-V1 returns an incomplete identity | High | Require matching PUUID and two non-empty Riot ID fields before mutation. |
|
||||
| Riot Account-V1 is temporarily unavailable | Medium | Preserve stored identity, log the failure, and retain existing best-effort job semantics. |
|
||||
| Multiple queue groups repeat identity lookup | Low | The personal page requests one queue group; avoid a new dedup mechanism until a measured need exists. |
|
||||
| Background community uses a non-Asia Riot route | High | Resolve omitted regions from the user's community before falling back to `asia`. |
|
||||
| Identity lookup failure triggers background backoff | Medium | Isolate identity exceptions and let existing statistics enrichment alone control failure counters. |
|
||||
| UI keeps the stale profile cached | High | Identity update completes before the existing completion event invalidates the profile query. |
|
||||
| Historical names are unexpectedly rewritten | Medium | Restrict persistence to the embedded Riot account and leave match snapshots untouched. |
|
||||
|
||||
## Dependencies
|
||||
|
||||
```text
|
||||
validated Account-V1 lookup
|
||||
-> focused identity persistence method
|
||||
-> manual refresh worker -> existing completion event -> profile invalidation
|
||||
-> background scheduler -> existing statistics enrichment and backoff policy
|
||||
```
|
||||
|
||||
## Open Questions
|
||||
|
||||
None. The user approved the specification and requested implementation.
|
||||
@@ -0,0 +1,175 @@
|
||||
# Spec: Refresh Riot ID by PUUID
|
||||
|
||||
## Objective
|
||||
|
||||
Whenever an account is refreshed manually from the personal match-history page
|
||||
or automatically by the stale-account background scheduler, resolve its current
|
||||
Riot ID through Riot Account-V1 using the stored PUUID. If the player changed
|
||||
either their game name or tag line, persist the latest values on the same embedded
|
||||
Riot account so the profile displays the new Riot ID.
|
||||
|
||||
The existing refresh job remains the single user-facing operation. It continues
|
||||
to refresh matches and ranked data, and additionally refreshes identity before
|
||||
emitting its completion event.
|
||||
|
||||
## Approved Product Decisions
|
||||
|
||||
- Use the stored PUUID as the stable identity key; never look up the account by
|
||||
the possibly stale game name and tag line.
|
||||
- Query Riot Account-V1 on every manually queued user-history refresh job and
|
||||
every selected stale-account background refresh rather than applying a name TTL.
|
||||
- Update `gameName` and `tagLine` together only when Riot returns a matching PUUID
|
||||
and both values are non-empty.
|
||||
- Preserve the previous Riot ID if the Account-V1 lookup fails or returns an
|
||||
incomplete or mismatched response.
|
||||
- Treat identity refresh as best effort, matching the existing ranked-data refresh
|
||||
policy: log a failure but allow successful match refresh work to complete.
|
||||
- When a caller does not already know the Riot regional route, resolve it from the
|
||||
user's community and fall back to `asia` only when the community has no route.
|
||||
- Do not increment the background failure counter or enter backoff solely because
|
||||
the identity lookup failed; background statistics enrichment retains its
|
||||
existing success and failure semantics.
|
||||
- Reuse the existing refresh completion event and profile-query invalidation; do
|
||||
not add a new endpoint, response field, socket event, or frontend state path.
|
||||
- Update only the embedded Riot account used by the personal profile. Historical
|
||||
match snapshots retain the names recorded by Riot for those games.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- NestJS 11, TypeScript 5, Mongoose 9, and Jest under `apps/api`
|
||||
- Riot Account-V1 through the existing `RiotAccountService`
|
||||
- Redis stream jobs through the existing `RiotJobWorkerService`
|
||||
- Scheduled stale-account refresh through `BackgroundRefreshScheduler`
|
||||
- React Query profile invalidation already present in `UserHistoryPage`
|
||||
|
||||
## Commands
|
||||
|
||||
- Focused tests:
|
||||
`pnpm --filter api exec jest --runInBand riot-account-enrichment.service.spec.ts riot-job-worker.service.spec.ts background-refresh.scheduler.spec.ts`
|
||||
- API lint: `pnpm --filter api lint`
|
||||
- API build: `pnpm --filter api build`
|
||||
- Web lint: `pnpm --filter web lint`
|
||||
- Web production build: `pnpm --filter web build:prod`
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `apps/api/src/modules/riot/riot-account.service.ts` owns the validated
|
||||
Account-V1 PUUID lookup.
|
||||
- `apps/api/src/modules/riot/riot-account-enrichment.service.ts` owns the
|
||||
persistence boundary for the embedded Riot account.
|
||||
- `apps/api/src/modules/riot/riot-account-enrichment.service.spec.ts` verifies
|
||||
update, no-op, and failure behavior.
|
||||
- `apps/api/src/modules/riot-job-queue/riot-job-worker.service.ts` orchestrates
|
||||
identity, match, and ranked refresh work before completion.
|
||||
- `apps/api/src/modules/riot-job-queue/riot-job-worker.service.spec.ts` verifies
|
||||
that a personal-history refresh job requests the PUUID-based identity refresh.
|
||||
- `apps/api/src/modules/riot-background-refresh/background-refresh.scheduler.ts`
|
||||
orchestrates best-effort identity refresh for stale accounts before statistics
|
||||
enrichment.
|
||||
- `apps/api/src/modules/riot-background-refresh/background-refresh.scheduler.spec.ts`
|
||||
verifies background invocation, ordering, and failure isolation.
|
||||
- `apps/web/src/pages/UserHistoryPage.tsx` already invalidates the profile query
|
||||
when the refresh socket reports completion and is not modified in this scope.
|
||||
|
||||
## Internal Contract
|
||||
|
||||
Add one focused method to `RiotAccountEnrichmentService`:
|
||||
|
||||
```ts
|
||||
type RefreshRiotIdentityResult = "updated" | "unchanged" | "failed";
|
||||
|
||||
refreshRiotIdentity(params: {
|
||||
userId: mongoose.Types.ObjectId;
|
||||
puuid: string;
|
||||
region?: RiotRegionalRoute;
|
||||
}): Promise<RefreshRiotIdentityResult>;
|
||||
```
|
||||
|
||||
`updated` means both persisted Riot ID fields now match Account-V1. `unchanged`
|
||||
means the validated response matched the stored values and no database write was
|
||||
needed. `failed` means no stored account could be resolved or the external lookup
|
||||
could not safely provide a complete identity; stored values remain unchanged. If
|
||||
`region` is omitted, the service resolves the user's community and uses its
|
||||
configured `riotRegion`, falling back to `asia` only when unavailable.
|
||||
|
||||
## Code Style
|
||||
|
||||
Keep the external validation and persistence decision explicit:
|
||||
|
||||
```ts
|
||||
const identity = await this.accountService.getByPuuid(puuid, { region });
|
||||
if (identity.puuid !== puuid || !identity.gameName || !identity.tagLine) {
|
||||
return "failed";
|
||||
}
|
||||
```
|
||||
|
||||
Use existing single quotes, NestJS logging, Mongoose document mutation, and
|
||||
Prettier formatting. Do not add a generic identity abstraction or new dependency.
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
- Write the enrichment-service tests first and confirm they fail before adding
|
||||
the new method.
|
||||
- Verify a changed game name and tag line are persisted together.
|
||||
- Verify identical values return `unchanged` without saving.
|
||||
- Verify missing values, PUUID mismatch, and Riot lookup errors return `failed`
|
||||
without overwriting or saving the stored identity.
|
||||
- Write the worker orchestration expectation before calling the new method.
|
||||
- Verify a region-less identity refresh uses the user's configured community
|
||||
region.
|
||||
- Write background scheduler expectations before adding identity refresh to the
|
||||
stale-account loop.
|
||||
- Verify identity refresh happens before statistics enrichment and that a rejected
|
||||
identity lookup does not increment background failure counters.
|
||||
- Run focused API tests after each slice, then API lint/build and web lint/build
|
||||
to verify the existing client integration remains valid.
|
||||
|
||||
## Boundaries
|
||||
|
||||
### Always
|
||||
|
||||
- Use the stored PUUID for Account-V1 lookup and verify the returned PUUID.
|
||||
- Validate both Riot ID fields before mutating the database.
|
||||
- Preserve the current Riot ID on any unsafe or failed response.
|
||||
- Keep the existing refresh route, enqueue response, and socket event compatible.
|
||||
- Keep background identity failures independent from enrichment failure counters.
|
||||
- Run focused tests before broader lint and build verification.
|
||||
|
||||
### Ask First
|
||||
|
||||
- Add a database field or migration.
|
||||
- Change refresh failure semantics so an identity lookup failure fails the whole
|
||||
user-history job.
|
||||
- Update historical match snapshots or active match participant display names.
|
||||
- Add a new API response field, endpoint, dependency, or Redis job type.
|
||||
- Commit, push, deploy, or alter CI configuration.
|
||||
|
||||
### Never
|
||||
|
||||
- Resolve identity from the stale stored Riot ID.
|
||||
- Partially update only the game name or only the tag line.
|
||||
- Replace a valid stored identity with empty or mismatched Account-V1 data.
|
||||
- Expose Riot API errors or credentials to the browser.
|
||||
- Mix the change with the separate past-history result-column PR.
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- Clicking `정보 갱신` causes the queued worker to call Account-V1 by the stored
|
||||
PUUID.
|
||||
- Selecting a stale account for background refresh also calls Account-V1 by the
|
||||
stored PUUID before statistics enrichment.
|
||||
- A changed Riot game name or tag line is persisted on the matching embedded
|
||||
account before the completion event is broadcast.
|
||||
- The completion event triggers the existing profile-query invalidation, so the
|
||||
personal history header displays the latest `gameName#tagLine`.
|
||||
- Failed, incomplete, or mismatched Riot identity responses do not overwrite the
|
||||
existing Riot ID and do not prevent otherwise successful match refresh work.
|
||||
- Background identity lookup failures do not increment the account failure counter
|
||||
or prevent otherwise successful background enrichment.
|
||||
- Focused tests, API lint/build, and web lint/production build pass.
|
||||
|
||||
## Open Questions
|
||||
|
||||
None. The user approved this specification and requested implementation. The
|
||||
existing queue and UI invalidation paths support the behavior without a public
|
||||
contract change.
|
||||
Reference in new issue
Block a user