diff --git a/src/app.module.ts b/src/app.module.ts index 410a2e3..eec4ec9 100644 --- a/src/app.module.ts +++ b/src/app.module.ts @@ -69,9 +69,11 @@ import { LegalDocumentsModule } from './legal-documents/legal-documents.module'; import { TrackSuggestionsModule } from './track-suggestions/track-suggestions.module'; import { RankingSnapshotsModule } from './ranking-snapshots/ranking-snapshots.module'; +import { AuditLogsModule } from './audit-logs/audit-logs.module'; @Module({ imports: [ + AuditLogsModule, RankingSnapshotsModule, TrackSuggestionsModule, LegalDocumentsModule, diff --git a/src/audit-logs/audit-logs.controller.ts b/src/audit-logs/audit-logs.controller.ts new file mode 100644 index 0000000..8b1b1c3 --- /dev/null +++ b/src/audit-logs/audit-logs.controller.ts @@ -0,0 +1,39 @@ +import { Controller, Get, Query, UseGuards } from '@nestjs/common'; +import { ApiBearerAuth, ApiTags, ApiOperation } from '@nestjs/swagger'; +import { Roles } from '../roles/roles.decorator'; +import { RoleEnum } from '../roles/roles.enum'; +import { AuthGuard } from '@nestjs/passport'; +import { RolesGuard } from '../roles/roles.guard'; +import { AuditLogsService } from './audit-logs.service'; +import { FindAllAuditLogsDto } from './dto/find-all-audit-logs.dto'; +import { infinityPagination } from '../utils/infinity-pagination'; +import { InfinityPaginationResponseDto } from '../utils/dto/infinity-pagination-response.dto'; +import { AuditLog } from './domain/audit-log'; + +@ApiBearerAuth() +@Roles(RoleEnum.admin) +@UseGuards(AuthGuard('jwt'), RolesGuard) +@ApiTags('Audit Logs') +@Controller({ + path: 'audit-logs', + version: '1', +}) +export class AuditLogsController { + constructor(private readonly auditLogsService: AuditLogsService) {} + + @Get() + @ApiOperation({ summary: 'Find all audit logs (Admin only)' }) + async findAll( + @Query() query: FindAllAuditLogsDto, + ): Promise> { + const page = query?.page ?? 1; + let limit = query?.limit ?? 10; + if (limit > 50) { + limit = 50; + } + + const result = await this.auditLogsService.findAll({ page, limit }, query); + + return infinityPagination(result, { page, limit }); + } +} diff --git a/src/audit-logs/audit-logs.module.ts b/src/audit-logs/audit-logs.module.ts new file mode 100644 index 0000000..fa1b21c --- /dev/null +++ b/src/audit-logs/audit-logs.module.ts @@ -0,0 +1,14 @@ +import { Module } from '@nestjs/common'; +import { AuditLogsService } from './audit-logs.service'; +import { AuditLogsController } from './audit-logs.controller'; +import { RelationalAuditLogPersistenceModule } from './infrastructure/persistence/relational/relational-persistence.module'; + +const infrastructurePersistenceModule = RelationalAuditLogPersistenceModule; + +@Module({ + imports: [infrastructurePersistenceModule], + controllers: [AuditLogsController], + providers: [AuditLogsService], + exports: [AuditLogsService], +}) +export class AuditLogsModule {} diff --git a/src/audit-logs/audit-logs.service.spec.ts b/src/audit-logs/audit-logs.service.spec.ts new file mode 100644 index 0000000..7ad2b68 --- /dev/null +++ b/src/audit-logs/audit-logs.service.spec.ts @@ -0,0 +1,82 @@ +import { Test, TestingModule } from '@nestjs/testing'; +import { AuditLogsService } from './audit-logs.service'; +import { AuditLogRepository } from './infrastructure/persistence/audit-log.repository'; +import { AuditActionEnum } from './domain/audit-action.enum'; +import { Logger } from '@nestjs/common'; + +describe('AuditLogsService', () => { + let service: AuditLogsService; + let repository: AuditLogRepository; + let loggerErrorSpy: jest.SpyInstance; + + beforeEach(async () => { + const module: TestingModule = await Test.createTestingModule({ + providers: [ + AuditLogsService, + { + provide: AuditLogRepository, + useValue: { + create: jest.fn(), + findAllWithPagination: jest.fn(), + }, + }, + ], + }).compile(); + + service = module.get(AuditLogsService); + repository = module.get(AuditLogRepository); + loggerErrorSpy = jest + .spyOn(Logger.prototype, 'error') + .mockImplementation(() => {}); + }); + + afterEach(() => { + jest.clearAllMocks(); + }); + + it('should be defined', () => { + expect(service).toBeDefined(); + }); + + describe('record', () => { + it('should successfully record an audit log', async () => { + const data = { + action: AuditActionEnum.USER_BANNED, + entityType: 'user', + entityId: '123', + }; + + await service.record(data); + expect(repository.create).toHaveBeenCalledWith(data); + expect(loggerErrorSpy).not.toHaveBeenCalled(); + }); + + it('should not throw if repository.create fails, but should log error', async () => { + const data = { + action: AuditActionEnum.USER_BANNED, + entityType: 'user', + entityId: '123', + }; + const error = new Error('DB connection failed'); + jest.spyOn(repository, 'create').mockRejectedValue(error); + + await expect(service.record(data)).resolves.not.toThrow(); + expect(repository.create).toHaveBeenCalledWith(data); + expect(loggerErrorSpy).toHaveBeenCalled(); + }); + }); + + describe('findAll', () => { + it('should pass correct params to repository.findAllWithPagination', async () => { + const options = { page: 1, limit: 10 }; + const filters = { action: AuditActionEnum.USER_BANNED }; + + await service.findAll(options, filters); + + expect(repository.findAllWithPagination).toHaveBeenCalledWith( + options, + filters, + ); + }); + }); +}); diff --git a/src/audit-logs/audit-logs.service.ts b/src/audit-logs/audit-logs.service.ts new file mode 100644 index 0000000..1df06cb --- /dev/null +++ b/src/audit-logs/audit-logs.service.ts @@ -0,0 +1,32 @@ +import { Injectable, Logger } from '@nestjs/common'; +import { AuditLogRepository } from './infrastructure/persistence/audit-log.repository'; +import { CreateAuditLogDto } from './dto/create-audit-log.dto'; +import { FindAllAuditLogsDto } from './dto/find-all-audit-logs.dto'; +import { IPaginationOptions } from '../utils/types/pagination-options'; +import { AuditLog } from './domain/audit-log'; + +@Injectable() +export class AuditLogsService { + private readonly logger = new Logger(AuditLogsService.name); + + constructor(private readonly auditLogRepository: AuditLogRepository) {} + + async record(data: CreateAuditLogDto): Promise { + try { + await this.auditLogRepository.create(data); + } catch (error) { + this.logger.error( + `Failed to record audit log: ${error.message}`, + error.stack, + { data }, + ); + } + } + + async findAll( + options: IPaginationOptions, + filters: FindAllAuditLogsDto, + ): Promise { + return this.auditLogRepository.findAllWithPagination(options, filters); + } +} diff --git a/src/audit-logs/domain/audit-action.enum.ts b/src/audit-logs/domain/audit-action.enum.ts new file mode 100644 index 0000000..30523d6 --- /dev/null +++ b/src/audit-logs/domain/audit-action.enum.ts @@ -0,0 +1,12 @@ +export enum AuditActionEnum { + SUBMISSION_APPROVED = 'SUBMISSION_APPROVED', + SUBMISSION_REJECTED = 'SUBMISSION_REJECTED', + EVENT_APPROVED = 'EVENT_APPROVED', + EVENT_REJECTED = 'EVENT_REJECTED', + EVENT_CANCELLED = 'EVENT_CANCELLED', + CONTRIBUTION_REPORT_REVIEWED = 'CONTRIBUTION_REPORT_REVIEWED', + USER_ROLE_CHANGED = 'USER_ROLE_CHANGED', + USER_BANNED = 'USER_BANNED', + USER_UNBANNED = 'USER_UNBANNED', + XP_MANUAL_ADJUSTMENT = 'XP_MANUAL_ADJUSTMENT', +} diff --git a/src/audit-logs/domain/audit-log.ts b/src/audit-logs/domain/audit-log.ts new file mode 100644 index 0000000..5640823 --- /dev/null +++ b/src/audit-logs/domain/audit-log.ts @@ -0,0 +1,12 @@ +import { AuditActionEnum } from './audit-action.enum'; + +export class AuditLog { + id: string; + actorUserId: number | null; + action: AuditActionEnum; + entityType: string; + entityId: string; + targetUserId: number | null; + metadata: any | null; + createdAt: Date; +} diff --git a/src/audit-logs/dto/create-audit-log.dto.ts b/src/audit-logs/dto/create-audit-log.dto.ts new file mode 100644 index 0000000..f96e904 --- /dev/null +++ b/src/audit-logs/dto/create-audit-log.dto.ts @@ -0,0 +1,34 @@ +import { AuditActionEnum } from '../domain/audit-action.enum'; +import { + IsEnum, + IsInt, + IsNotEmpty, + IsObject, + IsOptional, + IsString, +} from 'class-validator'; + +export class CreateAuditLogDto { + @IsOptional() + @IsInt() + actorUserId?: number | null; + + @IsEnum(AuditActionEnum) + action: AuditActionEnum; + + @IsString() + @IsNotEmpty() + entityType: string; + + @IsString() + @IsNotEmpty() + entityId: string; + + @IsOptional() + @IsInt() + targetUserId?: number | null; + + @IsOptional() + @IsObject() + metadata?: any | null; +} diff --git a/src/audit-logs/dto/find-all-audit-logs.dto.ts b/src/audit-logs/dto/find-all-audit-logs.dto.ts new file mode 100644 index 0000000..f36a270 --- /dev/null +++ b/src/audit-logs/dto/find-all-audit-logs.dto.ts @@ -0,0 +1,33 @@ +import { IsEnum, IsInt, IsOptional, IsString } from 'class-validator'; +import { Type } from 'class-transformer'; +import { AuditActionEnum } from '../domain/audit-action.enum'; + +export class FindAllAuditLogsDto { + @IsOptional() + @Type(() => Number) + @IsInt() + page?: number; + + @IsOptional() + @Type(() => Number) + @IsInt() + limit?: number; + + @IsOptional() + @IsEnum(AuditActionEnum) + action?: AuditActionEnum; + + @IsOptional() + @IsString() + entityType?: string; + + @IsOptional() + @Type(() => Number) + @IsInt() + actorUserId?: number; + + @IsOptional() + @Type(() => Number) + @IsInt() + targetUserId?: number; +} diff --git a/src/audit-logs/infrastructure/persistence/audit-log.repository.ts b/src/audit-logs/infrastructure/persistence/audit-log.repository.ts new file mode 100644 index 0000000..860b192 --- /dev/null +++ b/src/audit-logs/infrastructure/persistence/audit-log.repository.ts @@ -0,0 +1,12 @@ +import { AuditLog } from '../../domain/audit-log'; +import { CreateAuditLogDto } from '../../dto/create-audit-log.dto'; +import { FindAllAuditLogsDto } from '../../dto/find-all-audit-logs.dto'; +import { IPaginationOptions } from '../../../utils/types/pagination-options'; + +export abstract class AuditLogRepository { + abstract create(data: CreateAuditLogDto): Promise; + abstract findAllWithPagination( + options: IPaginationOptions, + filters: FindAllAuditLogsDto, + ): Promise; +} diff --git a/src/audit-logs/infrastructure/persistence/relational/entities/audit-log.entity.ts b/src/audit-logs/infrastructure/persistence/relational/entities/audit-log.entity.ts new file mode 100644 index 0000000..f4d0f93 --- /dev/null +++ b/src/audit-logs/infrastructure/persistence/relational/entities/audit-log.entity.ts @@ -0,0 +1,39 @@ +import { + Column, + CreateDateColumn, + Entity, + Index, + PrimaryGeneratedColumn, +} from 'typeorm'; +import { AuditActionEnum } from '../../../../domain/audit-action.enum'; +import { EntityRelationalHelper } from '../../../../../utils/relational-entity-helper'; + +@Entity({ name: 'audit_log' }) +@Index(['entityType', 'entityId']) +export class AuditLogEntity extends EntityRelationalHelper { + @PrimaryGeneratedColumn('uuid') + id: string; + + @Index() + @Column({ type: 'int', nullable: true }) + actorUserId: number | null; + + @Column({ type: 'varchar', length: 100 }) + action: AuditActionEnum; + + @Column({ type: 'varchar', length: 100 }) + entityType: string; + + @Column({ type: 'varchar', length: 100 }) + entityId: string; + + @Column({ type: 'int', nullable: true }) + targetUserId: number | null; + + @Column({ type: 'jsonb', nullable: true }) + metadata: any | null; + + @Index() + @CreateDateColumn() + createdAt: Date; +} diff --git a/src/audit-logs/infrastructure/persistence/relational/mappers/audit-log.mapper.ts b/src/audit-logs/infrastructure/persistence/relational/mappers/audit-log.mapper.ts new file mode 100644 index 0000000..997e2c6 --- /dev/null +++ b/src/audit-logs/infrastructure/persistence/relational/mappers/audit-log.mapper.ts @@ -0,0 +1,32 @@ +import { AuditLog } from '../../../../domain/audit-log'; +import { AuditLogEntity } from '../entities/audit-log.entity'; + +export class AuditLogMapper { + static toDomain(raw: AuditLogEntity): AuditLog { + const domainEntity = new AuditLog(); + domainEntity.id = raw.id; + domainEntity.actorUserId = raw.actorUserId; + domainEntity.action = raw.action; + domainEntity.entityType = raw.entityType; + domainEntity.entityId = raw.entityId; + domainEntity.targetUserId = raw.targetUserId; + domainEntity.metadata = raw.metadata; + domainEntity.createdAt = raw.createdAt; + return domainEntity; + } + + static toPersistence(domainEntity: AuditLog): AuditLogEntity { + const persistenceEntity = new AuditLogEntity(); + if (domainEntity.id) { + persistenceEntity.id = domainEntity.id; + } + persistenceEntity.actorUserId = domainEntity.actorUserId; + persistenceEntity.action = domainEntity.action; + persistenceEntity.entityType = domainEntity.entityType; + persistenceEntity.entityId = domainEntity.entityId; + persistenceEntity.targetUserId = domainEntity.targetUserId; + persistenceEntity.metadata = domainEntity.metadata; + persistenceEntity.createdAt = domainEntity.createdAt; + return persistenceEntity; + } +} diff --git a/src/audit-logs/infrastructure/persistence/relational/relational-persistence.module.ts b/src/audit-logs/infrastructure/persistence/relational/relational-persistence.module.ts new file mode 100644 index 0000000..d175bb9 --- /dev/null +++ b/src/audit-logs/infrastructure/persistence/relational/relational-persistence.module.ts @@ -0,0 +1,17 @@ +import { Module } from '@nestjs/common'; +import { AuditLogRepository } from '../audit-log.repository'; +import { AuditLogRelationalRepository } from './repositories/audit-log.repository'; +import { TypeOrmModule } from '@nestjs/typeorm'; +import { AuditLogEntity } from './entities/audit-log.entity'; + +@Module({ + imports: [TypeOrmModule.forFeature([AuditLogEntity])], + providers: [ + { + provide: AuditLogRepository, + useClass: AuditLogRelationalRepository, + }, + ], + exports: [AuditLogRepository], +}) +export class RelationalAuditLogPersistenceModule {} diff --git a/src/audit-logs/infrastructure/persistence/relational/repositories/audit-log.repository.ts b/src/audit-logs/infrastructure/persistence/relational/repositories/audit-log.repository.ts new file mode 100644 index 0000000..c8118c7 --- /dev/null +++ b/src/audit-logs/infrastructure/persistence/relational/repositories/audit-log.repository.ts @@ -0,0 +1,57 @@ +import { Injectable } from '@nestjs/common'; +import { InjectRepository } from '@nestjs/typeorm'; +import { Repository } from 'typeorm'; +import { AuditLogEntity } from '../entities/audit-log.entity'; +import { AuditLog } from '../../../../domain/audit-log'; +import { AuditLogRepository } from '../../audit-log.repository'; +import { AuditLogMapper } from '../mappers/audit-log.mapper'; +import { CreateAuditLogDto } from '../../../../dto/create-audit-log.dto'; +import { FindAllAuditLogsDto } from '../../../../dto/find-all-audit-logs.dto'; +import { IPaginationOptions } from '../../../../../utils/types/pagination-options'; + +@Injectable() +export class AuditLogRelationalRepository implements AuditLogRepository { + constructor( + @InjectRepository(AuditLogEntity) + private readonly auditLogRepository: Repository, + ) {} + + async create(data: CreateAuditLogDto): Promise { + const persistenceModel = this.auditLogRepository.create(data); + const saved = await this.auditLogRepository.save(persistenceModel); + // saved can be an array if save takes multiple entities, but here it is single + return AuditLogMapper.toDomain(saved as AuditLogEntity); + } + + async findAllWithPagination( + options: IPaginationOptions, + filters: FindAllAuditLogsDto, + ): Promise { + const qb = this.auditLogRepository.createQueryBuilder('audit_log'); + + if (filters.action) { + qb.andWhere('audit_log.action = :action', { action: filters.action }); + } + if (filters.entityType) { + qb.andWhere('audit_log.entityType = :entityType', { + entityType: filters.entityType, + }); + } + if (filters.actorUserId !== undefined) { + qb.andWhere('audit_log.actorUserId = :actorUserId', { + actorUserId: filters.actorUserId, + }); + } + if (filters.targetUserId !== undefined) { + qb.andWhere('audit_log.targetUserId = :targetUserId', { + targetUserId: filters.targetUserId, + }); + } + + qb.orderBy('audit_log.createdAt', 'DESC'); + qb.skip((options.page - 1) * options.limit).take(options.limit); + + const entities = await qb.getMany(); + return entities.map((entity) => AuditLogMapper.toDomain(entity)); + } +} diff --git a/src/contribution-reports/contribution-reports.module.ts b/src/contribution-reports/contribution-reports.module.ts index 5047c52..589f51d 100644 --- a/src/contribution-reports/contribution-reports.module.ts +++ b/src/contribution-reports/contribution-reports.module.ts @@ -4,11 +4,13 @@ import { ContributionReportsService } from './contribution-reports.service'; import { ContributionReportsController } from './contribution-reports.controller'; import { ContributionReportEntity } from './infrastructure/persistence/relational/entities/contribution-report.entity'; import { NotificationsModule } from '../notifications/notifications.module'; +import { AuditLogsModule } from '../audit-logs/audit-logs.module'; @Module({ imports: [ TypeOrmModule.forFeature([ContributionReportEntity]), NotificationsModule, + AuditLogsModule, ], controllers: [ContributionReportsController], providers: [ContributionReportsService], diff --git a/src/contribution-reports/contribution-reports.service.ts b/src/contribution-reports/contribution-reports.service.ts index 254383d..74de850 100644 --- a/src/contribution-reports/contribution-reports.service.ts +++ b/src/contribution-reports/contribution-reports.service.ts @@ -19,6 +19,8 @@ import { NotificationType } from '../notifications/domain/notification-type.enum import { CreateContributionReportDto } from './dto/create-report.dto'; import { ReviewContributionReportDto } from './dto/review-report.dto'; import { SubmissionStatus } from '../submissions/domain/submission-status.enum'; +import { AuditLogsService } from '../audit-logs/audit-logs.service'; +import { AuditActionEnum } from '../audit-logs/domain/audit-action.enum'; @Injectable() export class ContributionReportsService { @@ -27,6 +29,7 @@ export class ContributionReportsService { constructor( @InjectDataSource() private readonly dataSource: DataSource, private readonly notificationsService: NotificationsService, + private readonly auditLogsService: AuditLogsService, ) {} async create(dto: CreateContributionReportDto, reporterUserId: number) { @@ -193,6 +196,14 @@ export class ContributionReportsService { }); } + void this.auditLogsService.record({ + actorUserId: reviewerUserId, + action: AuditActionEnum.CONTRIBUTION_REPORT_REVIEWED, + entityType: 'contribution_report', + entityId: reportId, + metadata: { status: dto.status, adminNote: dto.adminNote }, + }); + return this.dataSource .getRepository(ContributionReportEntity) .findOne({ where: { id: reportId } }); diff --git a/src/database/migrations/1785263866476-CreateAuditLog.ts b/src/database/migrations/1785263866476-CreateAuditLog.ts new file mode 100644 index 0000000..50a684e --- /dev/null +++ b/src/database/migrations/1785263866476-CreateAuditLog.ts @@ -0,0 +1,29 @@ +import { MigrationInterface, QueryRunner } from 'typeorm'; + +export class CreateAuditLog1785263866476 implements MigrationInterface { + name = 'CreateAuditLog1785263866476'; + + public async up(queryRunner: QueryRunner): Promise { + await queryRunner.query( + `CREATE TABLE "audit_log" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "actorUserId" integer, "action" character varying(100) NOT NULL, "entityType" character varying(100) NOT NULL, "entityId" character varying(100) NOT NULL, "targetUserId" integer, "metadata" jsonb, "createdAt" TIMESTAMP NOT NULL DEFAULT now(), CONSTRAINT "PK_audit_log_id" PRIMARY KEY ("id"))`, + ); + await queryRunner.query( + `CREATE INDEX "IDX_audit_log_actorUserId" ON "audit_log" ("actorUserId")`, + ); + await queryRunner.query( + `CREATE INDEX "IDX_audit_log_createdAt" ON "audit_log" ("createdAt")`, + ); + await queryRunner.query( + `CREATE INDEX "IDX_audit_log_entityType_entityId" ON "audit_log" ("entityType", "entityId")`, + ); + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query( + `DROP INDEX "public"."IDX_audit_log_entityType_entityId"`, + ); + await queryRunner.query(`DROP INDEX "public"."IDX_audit_log_createdAt"`); + await queryRunner.query(`DROP INDEX "public"."IDX_audit_log_actorUserId"`); + await queryRunner.query(`DROP TABLE "audit_log"`); + } +} diff --git a/src/events/events.module.ts b/src/events/events.module.ts index 0b49e22..64ab050 100644 --- a/src/events/events.module.ts +++ b/src/events/events.module.ts @@ -8,6 +8,7 @@ import { RelationalEventPersistenceModule } from './infrastructure/persistence/r import { UsersModule } from '../users/users.module'; import { MailModule } from '../mail/mail.module'; import { FilesModule } from '../files/files.module'; +import { AuditLogsModule } from '../audit-logs/audit-logs.module'; import { NotificationsModule } from '../notifications/notifications.module'; @Module({ @@ -18,6 +19,7 @@ import { NotificationsModule } from '../notifications/notifications.module'; FilesModule, NotificationsModule, ScheduleModule.forRoot(), + AuditLogsModule, ], controllers: [EventsController], providers: [EventsService, EventsIcsService, EventsCleanupCronService], diff --git a/src/events/events.service.spec.ts b/src/events/events.service.spec.ts index 865de17..b40e817 100644 --- a/src/events/events.service.spec.ts +++ b/src/events/events.service.spec.ts @@ -11,6 +11,7 @@ import { EventsIcsService } from './events-ics.service'; import { NotificationsService } from '../notifications/notifications.service'; import { UsersService } from '../users/users.service'; import { MailService } from '../mail/mail.service'; +import { AuditLogsService } from '../audit-logs/audit-logs.service'; import { FilesService } from '../files/files.service'; import { Event } from './domain/event'; import { EventCategory } from './domain/event-category.enum'; @@ -100,6 +101,9 @@ describe('EventsService', () => { mailService as unknown as MailService, filesService as unknown as FilesService, notificationsService as unknown as NotificationsService, + { + record: jest.fn().mockResolvedValue(undefined), + } as unknown as AuditLogsService, ); }); diff --git a/src/events/events.service.ts b/src/events/events.service.ts index 18cdf12..92a851c 100644 --- a/src/events/events.service.ts +++ b/src/events/events.service.ts @@ -22,6 +22,8 @@ import { EventsIcsService } from './events-ics.service'; import { UsersService } from '../users/users.service'; import { MailService } from '../mail/mail.service'; import { FilesService } from '../files/files.service'; +import { AuditLogsService } from '../audit-logs/audit-logs.service'; +import { AuditActionEnum } from '../audit-logs/domain/audit-action.enum'; import { NotificationsService } from '../notifications/notifications.service'; import { NotificationType } from '../notifications/domain/notification-type.enum'; @@ -48,6 +50,7 @@ export class EventsService { private readonly mailService: MailService, private readonly filesService: FilesService, private readonly notificationsService: NotificationsService, + private readonly auditLogsService: AuditLogsService, ) {} private validateStartAtNotInPast(startAt?: string) { @@ -268,7 +271,7 @@ export class EventsService { ); } - return this.eventRepository.update(id, { + const updated = await this.eventRepository.update(id, { status: reviewEventDto.status, rejectionReason: reviewEventDto.status === EventStatus.REJECTED @@ -277,6 +280,23 @@ export class EventsService { reviewerId, reviewedAt: new Date(), }); + + void this.auditLogsService.record({ + actorUserId: reviewerId, + action: + reviewEventDto.status === EventStatus.APPROVED + ? AuditActionEnum.EVENT_APPROVED + : AuditActionEnum.EVENT_REJECTED, + entityType: 'event', + entityId: id, + targetUserId: event.organizerId, + metadata: + reviewEventDto.status === EventStatus.REJECTED + ? { rejectionReason: reviewEventDto.rejectionReason } + : {}, + }); + + return updated; } async cancel(id: Event['id'], userId: number, canManageAny: boolean) { @@ -308,6 +328,13 @@ export class EventsService { err, ); } + void this.auditLogsService.record({ + actorUserId: userId, + action: AuditActionEnum.EVENT_CANCELLED, + entityType: 'event', + entityId: id, + targetUserId: event.organizerId, + }); } return cancelledEvent; diff --git a/src/submissions/submissions.module.ts b/src/submissions/submissions.module.ts index e15c981..6c7af1e 100644 --- a/src/submissions/submissions.module.ts +++ b/src/submissions/submissions.module.ts @@ -12,6 +12,7 @@ import { NotificationsModule } from '../notifications/notifications.module'; import { TrackItemsModule } from '../track-items/track-items.module'; import { TrackItemCompletionsModule } from '../track-item-completions/track-item-completions.module'; import { LearningTracksModule } from '../learning-tracks/learning-tracks.module'; +import { AuditLogsModule } from '../audit-logs/audit-logs.module'; import { MailModule } from '../mail/mail.module'; @Module({ @@ -25,6 +26,7 @@ import { MailModule } from '../mail/mail.module'; TrackItemsModule, TrackItemCompletionsModule, LearningTracksModule, + AuditLogsModule, MailModule, ], controllers: [SubmissionsController], diff --git a/src/submissions/submissions.service.spec.ts b/src/submissions/submissions.service.spec.ts index b7a128c..987b9c4 100644 --- a/src/submissions/submissions.service.spec.ts +++ b/src/submissions/submissions.service.spec.ts @@ -12,6 +12,7 @@ import { TrackItemsService } from '../track-items/track-items.service'; import { TrackItemCompletionsService } from '../track-item-completions/track-item-completions.service'; import { TrackItemCompletionStatus } from '../track-item-completions/domain/track-item-completion-status.enum'; import { LearningTracksService } from '../learning-tracks/learning-tracks.service'; +import { AuditLogsService } from '../audit-logs/audit-logs.service'; import { Submission } from './domain/submission'; import { SubmissionStatus } from './domain/submission-status.enum'; import { GamificationProfile } from '../gamification-profiles/domain/gamification-profile'; @@ -213,6 +214,10 @@ describe('SubmissionsService', () => { provide: NotificationsService, useValue: { create: jest.fn().mockResolvedValue(undefined) }, }, + { + provide: AuditLogsService, + useValue: { record: jest.fn().mockResolvedValue(undefined) }, + }, { provide: TrackItemsService, useValue: mockTrackItemsService }, { provide: TrackItemCompletionsService, diff --git a/src/submissions/submissions.service.ts b/src/submissions/submissions.service.ts index b430f71..e97b72a 100644 --- a/src/submissions/submissions.service.ts +++ b/src/submissions/submissions.service.ts @@ -33,6 +33,8 @@ import { TrackItemCompletionStatus } from '../track-item-completions/domain/trac import { LearningTracksService } from '../learning-tracks/learning-tracks.service'; import { Activity } from '../activities/domain/activity'; import { PublicSubmissionDetail } from './domain/public-submission-detail'; +import { AuditLogsService } from '../audit-logs/audit-logs.service'; +import { AuditActionEnum } from '../audit-logs/domain/audit-action.enum'; import { MailService } from '../mail/mail.service'; import { UserEntity } from '../users/infrastructure/persistence/relational/entities/user.entity'; import { NotificationPreferenceEntity } from '../notifications/infrastructure/persistence/relational/entities/notification-preference.entity'; @@ -53,6 +55,7 @@ export class SubmissionsService { private readonly trackItemCompletionsService: TrackItemCompletionsService, private readonly learningTracksService: LearningTracksService, private readonly mailService: MailService, + private readonly auditLogsService: AuditLogsService, @InjectDataSource() private readonly dataSource: DataSource, ) {} @@ -652,6 +655,34 @@ export class SubmissionsService { } } + if ( + reviewDto.status === SubmissionStatus.APPROVED || + reviewDto.status === SubmissionStatus.REJECTED + ) { + const isApproved = reviewDto.status === SubmissionStatus.APPROVED; + let targetUserId: number | null = null; + const fallbackProfile = await this.dataSource + .getRepository(GamificationProfileEntity) + .findOne({ where: { id: submission.profileId } }); + if (fallbackProfile) targetUserId = fallbackProfile.userId; + + void this.auditLogsService.record({ + actorUserId: reviewerUserId, + action: isApproved + ? AuditActionEnum.SUBMISSION_APPROVED + : AuditActionEnum.SUBMISSION_REJECTED, + entityType: 'submission', + entityId: id, + targetUserId: targetUserId, + metadata: { + awardedXp: isApproved + ? this.resolveAwardedXp(activity, submission, reviewDto) + : 0, + feedback: reviewDto.feedback ?? null, + }, + }); + } + return this.submissionRepository.findById(id); } diff --git a/src/users/users.module.ts b/src/users/users.module.ts index 68edd9f..5a9e78b 100644 --- a/src/users/users.module.ts +++ b/src/users/users.module.ts @@ -9,6 +9,7 @@ import { UsersService } from './users.service'; import { UsersCronService } from './users-cron.service'; import { RelationalUserPersistenceModule } from './infrastructure/persistence/relational/relational-persistence.module'; import { FilesModule } from '../files/files.module'; +import { AuditLogsModule } from '../audit-logs/audit-logs.module'; const infrastructurePersistenceModule = RelationalUserPersistenceModule; @@ -17,6 +18,7 @@ const infrastructurePersistenceModule = RelationalUserPersistenceModule; // import modules, etc. infrastructurePersistenceModule, FilesModule, + AuditLogsModule, ], controllers: [UsersController], providers: [UsersService, UsersCronService], diff --git a/src/users/users.service.ts b/src/users/users.service.ts index 41669a9..76a9a54 100644 --- a/src/users/users.service.ts +++ b/src/users/users.service.ts @@ -19,12 +19,15 @@ import { Role } from '../roles/domain/role'; import { Status } from '../statuses/domain/status'; import { UpdateUserDto } from './dto/update-user.dto'; import { CURRENT_LEGAL_DOCUMENTS_VERSION } from '../legal-documents/legal-documents.constants'; +import { AuditLogsService } from '../audit-logs/audit-logs.service'; +import { AuditActionEnum } from '../audit-logs/domain/audit-action.enum'; @Injectable() export class UsersService { constructor( private readonly usersRepository: UserRepository, private readonly filesService: FilesService, + private readonly auditLogsService: AuditLogsService, ) {} async create(createUserDto: CreateUserDto): Promise { @@ -176,6 +179,10 @@ export class UsersService { id: User['id'], updateUserDto: UpdateUserDto, ): Promise { + const oldUserObject = await this.usersRepository.findById(id); + const oldRole = oldUserObject?.role?.id; + const oldIsBanned = oldUserObject?.isBanned; + // Do not remove comment below. // @@ -270,7 +277,7 @@ export class UsersService { }; } - return this.usersRepository.update(id, { + const updatedUser = await this.usersRepository.update(id, { // Do not remove comment below. // firstName: updateUserDto.firstName, @@ -284,6 +291,36 @@ export class UsersService { provider: updateUserDto.provider, socialId: updateUserDto.socialId, }); + + if (updatedUser) { + if ( + updateUserDto.role?.id !== undefined && + oldRole !== updateUserDto.role.id + ) { + void this.auditLogsService.record({ + actorUserId: null, + action: AuditActionEnum.USER_ROLE_CHANGED, + entityType: 'user', + entityId: String(id), + metadata: { oldRole, newRole: updateUserDto.role.id }, + }); + } + if ( + updateUserDto.isBanned !== undefined && + oldIsBanned !== updateUserDto.isBanned + ) { + void this.auditLogsService.record({ + actorUserId: null, + action: updateUserDto.isBanned + ? AuditActionEnum.USER_BANNED + : AuditActionEnum.USER_UNBANNED, + entityType: 'user', + entityId: String(id), + }); + } + } + + return updatedUser; } async remove(id: User['id']): Promise {