Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

refac: implement user system #264

Merged
merged 1 commit into from
Feb 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
"@nestjs/event-emitter": "^3.0.0",
"@nestjs/jwt": "^11.0.0",
"@nestjs/platform-express": "^11.0.5",
"@nestjs/schedule": "^5.0.1",
"@nestjs/platform-socket.io": "^11.0.10",
"@nestjs/schedule": "^5.0.1",
"@nestjs/swagger": "^11.0.3",
"@nestjs/typeorm": "^11.0.0",
"@nestjs/websockets": "^11.0.10",
Expand Down
18 changes: 18 additions & 0 deletions backend/src/achievement/achievement.controller.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Test, TestingModule } from '@nestjs/testing';
import { AchievementController } from './achievement.controller';

describe('AchievementController', () => {
let controller: AchievementController;

beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [AchievementController],
}).compile();

controller = module.get<AchievementController>(AchievementController);
});

it('should be defined', () => {
expect(controller).toBeDefined();
});
});
44 changes: 13 additions & 31 deletions backend/src/achievement/achievement.controller.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
import {
Controller,
Get,
Post,
Body,
Patch,
Param,
Delete,
} from '@nestjs/common';
import { AchievementService } from './provider/achievement.service';
// src/achievement/achievement.controller.ts
import { Controller, Get, Post, Body, Param, UseGuards } from '@nestjs/common';
import { AchievementService } from './achievement.service';
import { CreateAchievementDto } from './dto/create-achievement.dto';
import { UpdateAchievementDto } from './dto/update-achievement.dto';
import { JwtAuthGuard } from '../auth/guards/jwt-auth.guard';
import { CurrentUser } from '../auth/decorators/current-user.decorator';

@Controller('achievements')
@UseGuards(JwtAuthGuard)
export class AchievementController {
constructor(private readonly achievementService: AchievementService) {}

Expand All @@ -20,26 +15,13 @@ export class AchievementController {
return this.achievementService.create(createAchievementDto);
}

@Get()
findAll() {
return this.achievementService.findAll();
@Get('user')
getUserAchievements(@CurrentUser() userId: string) {
return this.achievementService.getUserAchievements(userId);
}

@Get(':id')
findOne(@Param('id') id: string) {
return this.achievementService.findOne(id);
@Get('leaderboard')
getLeaderboard() {
return this.achievementService.getLeaderboard();
}

@Patch(':id')
update(
@Param('id') id: string,
@Body() updateAchievementDto: UpdateAchievementDto,
) {
return this.achievementService.update(id, updateAchievementDto);
}

@Delete(':id')
remove(@Param('id') id: string) {
return this.achievementService.remove(id);
}
}
}
18 changes: 18 additions & 0 deletions backend/src/achievement/achievement.gateway.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// src/achievement/achievement.gateway.ts
import { WebSocketGateway, WebSocketServer } from '@nestjs/websockets';
import { Server } from 'socket.io';
import { OnEvent } from '@nestjs/event-emitter';

@WebSocketGateway()
export class AchievementGateway {
@WebSocketServer()
server: Server;

@OnEvent('achievement.unlocked')
handleAchievementUnlocked(payload: any) {
this.server.to(payload.userId).emit('achievementUnlocked', {
achievement: payload.achievement,
unlockedAt: payload.unlockedAt,
});
}
}
15 changes: 12 additions & 3 deletions backend/src/achievement/achievement.module.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
// src/achievement/achievement.module.ts
import { Module } from '@nestjs/common';
import { AchievementService } from './provider/achievement.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import { AchievementController } from './achievement.controller';
import { AchievementService } from './achievement.service';
import { AchievementGateway } from './achievement.gateway';
import { Achievement } from './entities/achievement.entity';
import { UserAchievement } from './entities/user-achievement.entity';

@Module({
imports: [
TypeOrmModule.forFeature([Achievement, UserAchievement]),
],
controllers: [AchievementController],
providers: [AchievementService],
providers: [AchievementService, AchievementGateway],
exports: [AchievementService],
})
export class AchievementModule {}
export class AchievementModule {}
18 changes: 18 additions & 0 deletions backend/src/achievement/achievement.service.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Test, TestingModule } from '@nestjs/testing';
import { AchievementService } from './achievement.service';

describe('AchievementService', () => {
let service: AchievementService;

beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [AchievementService],
}).compile();

service = module.get<AchievementService>(AchievementService);
});

it('should be defined', () => {
expect(service).toBeDefined();
});
});
101 changes: 101 additions & 0 deletions backend/src/achievement/achievement.service.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
// src/achievement/achievement.service.ts
import { Injectable, NotFoundException } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { Achievement } from './entities/achievement.entity';
import { UserAchievement } from './entities/user-achievement.entity';
import { CreateAchievementDto } from './dto/create-achievement.dto';
import { EventEmitter2 } from '@nestjs/event-emitter';

@Injectable()
export class AchievementService {
constructor(
@InjectRepository(Achievement)
private achievementRepository: Repository<Achievement>,
@InjectRepository(UserAchievement)
private userAchievementRepository: Repository<UserAchievement>,
private eventEmitter: EventEmitter2,
) {}

async create(createAchievementDto: CreateAchievementDto): Promise<Achievement> {
const achievement = this.achievementRepository.create(createAchievementDto);
return this.achievementRepository.save(achievement);
}

async trackProgress(userId: string, eventType: string, eventData: any): Promise<void> {
const relevantAchievements = await this.achievementRepository.find({
where: {
'criteria.eventType': eventType,
},
});

for (const achievement of relevantAchievements) {
const userAchievement = await this.getUserAchievement(userId, achievement.id);
if (userAchievement.isCompleted) continue;

const newProgress = await this.calculateProgress(achievement, userAchievement, eventData);
userAchievement.progress = newProgress;

if (newProgress >= 1) {
await this.unlockAchievement(userId, achievement.id);
} else {
await this.userAchievementRepository.save(userAchievement);
}
}
}

async unlockAchievement(userId: string, achievementId: string): Promise<void> {
const userAchievement = await this.getUserAchievement(userId, achievementId);
if (userAchievement.isCompleted) return;

userAchievement.isCompleted = true;
userAchievement.progress = 1;
userAchievement.unlockedAt = new Date();
await this.userAchievementRepository.save(userAchievement);

const achievement = await this.achievementRepository.findOne(achievementId);
this.eventEmitter.emit('achievement.unlocked', {
userId,
achievement,
unlockedAt: userAchievement.unlockedAt,
});
}

private async getUserAchievement(userId: string, achievementId: string): Promise<UserAchievement> {
let userAchievement = await this.userAchievementRepository.findOne({
where: {
user: { id: userId },
achievement: { id: achievementId },
},
});

if (!userAchievement) {
userAchievement = this.userAchievementRepository.create({
user: { id: userId },
achievement: { id: achievementId },
progress: 0,
});
await this.userAchievementRepository.save(userAchievement);
}

return userAchievement;
}

private async calculateProgress(
achievement: Achievement,
userAchievement: UserAchievement,
eventData: any,
): Promise<number> {
// Implement progress calculation based on achievement criteria
// This is a simplified example
const currentProgress = userAchievement.progress;
const increment = this.evaluateCriteria(achievement.criteria, eventData);
return Math.min(1, currentProgress + increment);
}

private evaluateCriteria(criteria: Record<string, any>, eventData: any): number {
// Implement criteria evaluation logic
// This is a simplified example
return 0.1; // Return progress increment
}
}
20 changes: 13 additions & 7 deletions backend/src/achievement/dto/create-achievement.dto.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
import { IsString, IsInt, Min, IsObject, IsNotEmpty } from 'class-validator';
// src/achievement/dto/create-achievement.dto.ts
import { IsString, IsEnum, IsNumber, IsObject, IsNotEmpty } from 'class-validator';
import { AchievementCategory } from '../entities/achievement.entity';

export class CreateAchievementDto {
@IsString()
@IsNotEmpty()
name: string;
title: string;

@IsString()
@IsNotEmpty()
description: string;

@IsInt()
@Min(0)
points: number;
@IsString()
icon: string;

@IsEnum(AchievementCategory)
category: AchievementCategory;

@IsNumber()
pointsValue: number;

@IsObject()
@IsNotEmpty()
criteria: Record<string, any>;
}
}
4 changes: 0 additions & 4 deletions backend/src/achievement/dto/update-achievement.dto.ts

This file was deleted.

32 changes: 25 additions & 7 deletions backend/src/achievement/entities/achievement.entity.ts
Original file line number Diff line number Diff line change
@@ -1,24 +1,42 @@
import { User } from 'src/user/user.entity';
// import { Entity, PrimaryGeneratedColumn, Column, ManyToMany, JoinTable } from 'typeorm';
Achievement System Implementation

// src/achievement/entities/achievement.entity.ts
import { Entity, Column, PrimaryGeneratedColumn, CreateDateColumn, UpdateDateColumn } from 'typeorm';

export enum AchievementCategory {
STREAK = 'STREAK',
SCORE = 'SCORE',
GENRE = 'GENRE',
SOCIAL = 'SOCIAL',
MISC = 'MISC',
}

@Entity()
export class Achievement {
@PrimaryGeneratedColumn('uuid')
id: string;

@Column()
name: string;
title: string;

@Column('text')
description: string;

@Column()
points: number;
icon: string;

@Column({ type: 'enum', enum: AchievementCategory })
category: AchievementCategory;

@Column('int')
pointsValue: number;

@Column('json')
criteria: Record<string, any>;

@ManyToMany(() => User, (user) => user.achievements)
@JoinTable()
unlockedBy: User[];
@CreateDateColumn()
createdAt: Date;

@UpdateDateColumn()
updatedAt: Date;
}
25 changes: 25 additions & 0 deletions backend/src/achievement/entities/user-achievement.entity.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// src/achievement/entities/user-achievement.entity.ts
import { Entity, Column, PrimaryGeneratedColumn, ManyToOne, CreateDateColumn } from 'typeorm';
import { Achievement } from './achievement.entity';
import { User } from '../../user/entities/user.entity';

@Entity()
export class UserAchievement {
@PrimaryGeneratedColumn('uuid')
id: string;

@ManyToOne(() => User)
user: User;

@ManyToOne(() => Achievement)
achievement: Achievement;

@Column('float')
progress: number;

@Column({ default: false })
isCompleted: boolean;

@CreateDateColumn()
unlockedAt: Date;
}
Loading