back: validation d'env, transaction setCurrent, fix N+1 catégories, logging
- ConfigModule.forRoot({ validate }) : schéma class-validator des variables
d'env, l'app refuse de démarrer si une var manque/mal typée ; suppression
des fallbacks de credentials DB (getOrThrow)
- setCurrent() enveloppé dans une transaction (plus de fenêtre incohérente
sur isCurrent entre les 2 updates)
- browse() : compteurs de toutes les catégories en 2 requêtes + calcul en
mémoire au lieu d'un N+1 récursif par enfant
- console.* -> Logger Nest partout (apis, uploads, seeder, bootstrap) ;
.catch(console.error) -> logger.error avec contexte
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -7,19 +7,20 @@ import { UploadsModule } from './modules/uploads/uploads.module';
|
||||
import { DocsGenerationModule } from './modules/docs-generation/docs-generation.module';
|
||||
import { CategoriesModule } from './modules/categories/categories.module';
|
||||
import { SeederModule } from './modules/seeder/seeder.module';
|
||||
import { validateEnv } from './config/env.validation';
|
||||
|
||||
@Module({
|
||||
imports: [
|
||||
ConfigModule.forRoot({ isGlobal: true }),
|
||||
ConfigModule.forRoot({ isGlobal: true, validate: validateEnv }),
|
||||
TypeOrmModule.forRootAsync({
|
||||
inject: [ConfigService],
|
||||
useFactory: (config: ConfigService) => ({
|
||||
type: 'postgres',
|
||||
host: config.get('DATABASE_HOST', 'localhost'),
|
||||
port: config.get<number>('DATABASE_PORT', 5432),
|
||||
username: config.get('DATABASE_USER', 'datacat'),
|
||||
password: config.get('DATABASE_PASSWORD', 'datacat'),
|
||||
database: config.get('DATABASE_NAME', 'datacat'),
|
||||
host: config.getOrThrow<string>('DATABASE_HOST'),
|
||||
port: config.getOrThrow<number>('DATABASE_PORT'),
|
||||
username: config.getOrThrow<string>('DATABASE_USER'),
|
||||
password: config.getOrThrow<string>('DATABASE_PASSWORD'),
|
||||
database: config.getOrThrow<string>('DATABASE_NAME'),
|
||||
entities: [__dirname + '/**/*.entity{.ts,.js}'],
|
||||
synchronize: config.get('NODE_ENV') !== 'production',
|
||||
logging: config.get('NODE_ENV') === 'development',
|
||||
|
||||
76
back/src/config/env.validation.ts
Normal file
76
back/src/config/env.validation.ts
Normal file
@@ -0,0 +1,76 @@
|
||||
import { plainToInstance, Type } from 'class-transformer';
|
||||
import {
|
||||
IsEnum,
|
||||
IsInt,
|
||||
IsNotEmpty,
|
||||
IsOptional,
|
||||
IsString,
|
||||
Max,
|
||||
Min,
|
||||
validateSync,
|
||||
} from 'class-validator';
|
||||
|
||||
export enum NodeEnv {
|
||||
Development = 'development',
|
||||
Production = 'production',
|
||||
Test = 'test',
|
||||
}
|
||||
|
||||
/**
|
||||
* Schéma des variables d'environnement. Validé au démarrage via `validateEnv`
|
||||
* (branché sur `ConfigModule.forRoot({ validate })`) : l'app refuse de démarrer
|
||||
* si une variable requise manque ou est mal typée, plutôt que d'utiliser
|
||||
* silencieusement des valeurs par défaut (ex. credentials DB).
|
||||
*/
|
||||
export class EnvironmentVariables {
|
||||
@IsEnum(NodeEnv)
|
||||
@IsOptional()
|
||||
NODE_ENV: NodeEnv = NodeEnv.Development;
|
||||
|
||||
@IsString()
|
||||
@IsNotEmpty()
|
||||
DATABASE_HOST!: string;
|
||||
|
||||
@Type(() => Number)
|
||||
@IsInt()
|
||||
@Min(1)
|
||||
@Max(65535)
|
||||
DATABASE_PORT!: number;
|
||||
|
||||
@IsString()
|
||||
@IsNotEmpty()
|
||||
DATABASE_USER!: string;
|
||||
|
||||
@IsString()
|
||||
@IsNotEmpty()
|
||||
DATABASE_PASSWORD!: string;
|
||||
|
||||
@IsString()
|
||||
@IsNotEmpty()
|
||||
DATABASE_NAME!: string;
|
||||
|
||||
@Type(() => Number)
|
||||
@IsInt()
|
||||
@Min(1)
|
||||
@Max(65535)
|
||||
@IsOptional()
|
||||
PORT = 3000;
|
||||
|
||||
@IsString()
|
||||
@IsOptional()
|
||||
DOCS_OUTPUT_DIR?: string;
|
||||
}
|
||||
|
||||
export function validateEnv(config: Record<string, unknown>): EnvironmentVariables {
|
||||
const validated = plainToInstance(EnvironmentVariables, config, {
|
||||
enableImplicitConversion: true,
|
||||
});
|
||||
const errors = validateSync(validated, { skipMissingProperties: false });
|
||||
if (errors.length > 0) {
|
||||
const details = errors
|
||||
.map((e) => Object.values(e.constraints ?? {}).join(', '))
|
||||
.join('\n - ');
|
||||
throw new Error(`Configuration d'environnement invalide:\n - ${details}`);
|
||||
}
|
||||
return validated;
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
import { NestFactory } from '@nestjs/core';
|
||||
import { ValidationPipe, RequestMethod } from '@nestjs/common';
|
||||
import { Logger, ValidationPipe, RequestMethod } from '@nestjs/common';
|
||||
import { AppModule } from './app.module';
|
||||
import { AllExceptionsFilter } from './common/filters/all-exceptions.filter';
|
||||
|
||||
@@ -16,7 +16,7 @@ async function bootstrap() {
|
||||
|
||||
const port = process.env.PORT ?? 3000;
|
||||
await app.listen(port);
|
||||
console.log(`Datacat API running on port ${port}`);
|
||||
Logger.log(`Datacat API running on port ${port}`, 'Bootstrap');
|
||||
}
|
||||
|
||||
bootstrap();
|
||||
|
||||
@@ -170,11 +170,17 @@ const mockRepo = {
|
||||
|
||||
const mockDocsService = { generate: vi.fn() };
|
||||
|
||||
const mockDataSource = {
|
||||
transaction: vi.fn(async (cb: (m: unknown) => unknown) =>
|
||||
cb({ getRepository: () => mockRepo }),
|
||||
),
|
||||
};
|
||||
|
||||
let service: ApisService;
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
service = new ApisService(mockRepo as any, mockDocsService as any);
|
||||
service = new ApisService(mockRepo as any, mockDataSource as any, mockDocsService as any);
|
||||
});
|
||||
|
||||
function makeEntity(overrides: Record<string, unknown> = {}) {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { Injectable, NotFoundException, ConflictException, Inject, forwardRef } from '@nestjs/common';
|
||||
import { Injectable, NotFoundException, ConflictException, Inject, forwardRef, Logger } from '@nestjs/common';
|
||||
import { InjectRepository } from '@nestjs/typeorm';
|
||||
import { Repository } from 'typeorm';
|
||||
import { DataSource, Repository } from 'typeorm';
|
||||
import { ApiEntryEntity } from './api-entry.entity';
|
||||
import { CreateApiEntryDto } from './dto/create-api-entry.dto';
|
||||
import { UpdateApiEntryDto } from './dto/update-api-entry.dto';
|
||||
@@ -17,9 +17,12 @@ interface InternalUpdateFields {
|
||||
|
||||
@Injectable()
|
||||
export class ApisService {
|
||||
private readonly logger = new Logger(ApisService.name);
|
||||
|
||||
constructor(
|
||||
@InjectRepository(ApiEntryEntity)
|
||||
private readonly repo: Repository<ApiEntryEntity>,
|
||||
private readonly dataSource: DataSource,
|
||||
@Inject(forwardRef(() => DocsGenerationService))
|
||||
private readonly docsService: DocsGenerationService,
|
||||
) {}
|
||||
@@ -213,20 +216,24 @@ export class ApisService {
|
||||
|
||||
async setCurrent(id: string): Promise<ApiEntry> {
|
||||
const entry = await this.findOneOrThrow(id);
|
||||
// Mettre tous les siblings à false
|
||||
await this.repo.update(
|
||||
{ name: entry.name, convention: entry.convention },
|
||||
{ isCurrent: false },
|
||||
);
|
||||
// Mettre cet entry à true
|
||||
await this.repo.update({ id }, { isCurrent: true });
|
||||
// Transaction : éviter une fenêtre où aucun (ou deux) sibling n'est courant.
|
||||
await this.dataSource.transaction(async (manager) => {
|
||||
const repo = manager.getRepository(ApiEntryEntity);
|
||||
await repo.update(
|
||||
{ name: entry.name, convention: entry.convention },
|
||||
{ isCurrent: false },
|
||||
);
|
||||
await repo.update({ id }, { isCurrent: true });
|
||||
});
|
||||
return this.findOneOrThrow(id);
|
||||
}
|
||||
|
||||
async regenerate(id: string): Promise<ApiEntry> {
|
||||
await this.findOneOrThrow(id);
|
||||
await this.updateInternal(id, { status: 'PENDING', errorMessage: null });
|
||||
this.docsService.generate(id).catch(console.error);
|
||||
this.docsService
|
||||
.generate(id)
|
||||
.catch((err) => this.logger.error(`Génération docs échouée pour ${id}`, err));
|
||||
return this.findOneOrThrow(id);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -98,11 +98,51 @@ export class CategoriesService {
|
||||
await this.categoryRepo.delete(id);
|
||||
}
|
||||
|
||||
private async countApisRecursively(categoryId: string): Promise<number> {
|
||||
const direct = await this.apiRepo.count({ where: { categoryId } });
|
||||
const children = await this.categoryRepo.find({ where: { parentId: categoryId }, select: ['id'] });
|
||||
const childCounts = await Promise.all(children.map((c) => this.countApisRecursively(c.id)));
|
||||
return direct + childCounts.reduce((sum, n) => sum + n, 0);
|
||||
/**
|
||||
* Comptages pour TOUTES les catégories en 2 requêtes (au lieu d'un N+1
|
||||
* récursif par enfant) : la hiérarchie et les APIs directes sont chargées en
|
||||
* une fois, puis les compteurs récursifs sont calculés en mémoire.
|
||||
*/
|
||||
private async computeCategoryCounts(): Promise<{
|
||||
subcategoryCount: Map<string, number>;
|
||||
recursiveApiCount: Map<string, number>;
|
||||
}> {
|
||||
const categories = await this.categoryRepo.find({ select: ['id', 'parentId'] });
|
||||
const directRows = await this.apiRepo
|
||||
.createQueryBuilder('api')
|
||||
.select('api.categoryId', 'categoryId')
|
||||
.addSelect('COUNT(*)', 'count')
|
||||
.where('api.categoryId IS NOT NULL')
|
||||
.groupBy('api.categoryId')
|
||||
.getRawMany<{ categoryId: string; count: string }>();
|
||||
|
||||
const directApiCount = new Map(directRows.map((r) => [r.categoryId, Number(r.count)]));
|
||||
const childrenOf = new Map<string, string[]>();
|
||||
for (const c of categories) {
|
||||
if (c.parentId) {
|
||||
const siblings = childrenOf.get(c.parentId) ?? [];
|
||||
siblings.push(c.id);
|
||||
childrenOf.set(c.parentId, siblings);
|
||||
}
|
||||
}
|
||||
|
||||
const recursiveApiCount = new Map<string, number>();
|
||||
const computeRecursive = (id: string): number => {
|
||||
const cached = recursiveApiCount.get(id);
|
||||
if (cached !== undefined) return cached;
|
||||
let total = directApiCount.get(id) ?? 0;
|
||||
for (const childId of childrenOf.get(id) ?? []) total += computeRecursive(childId);
|
||||
recursiveApiCount.set(id, total);
|
||||
return total;
|
||||
};
|
||||
|
||||
const subcategoryCount = new Map<string, number>();
|
||||
for (const c of categories) {
|
||||
subcategoryCount.set(c.id, (childrenOf.get(c.id) ?? []).length);
|
||||
computeRecursive(c.id);
|
||||
}
|
||||
|
||||
return { subcategoryCount, recursiveApiCount };
|
||||
}
|
||||
|
||||
async browse(categoryId: string | null): Promise<CategoryBrowseResponse> {
|
||||
@@ -132,13 +172,12 @@ export class CategoriesService {
|
||||
order: { orderIndex: 'ASC', name: 'ASC' },
|
||||
});
|
||||
|
||||
const subcategories: CategoryWithCounts[] = await Promise.all(
|
||||
directChildren.map(async (child) => {
|
||||
const subcategoryCount = await this.categoryRepo.count({ where: { parentId: child.id } });
|
||||
const apiCount = await this.countApisRecursively(child.id);
|
||||
return { ...toCategory(child), subcategoryCount, apiCount };
|
||||
}),
|
||||
);
|
||||
const { subcategoryCount, recursiveApiCount } = await this.computeCategoryCounts();
|
||||
const subcategories: CategoryWithCounts[] = directChildren.map((child) => ({
|
||||
...toCategory(child),
|
||||
subcategoryCount: subcategoryCount.get(child.id) ?? 0,
|
||||
apiCount: recursiveApiCount.get(child.id) ?? 0,
|
||||
}));
|
||||
|
||||
/* 4. APIs directement dans cette catégorie */
|
||||
const apiEntities = await this.apiRepo.find({
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { Injectable, OnApplicationBootstrap } from '@nestjs/common';
|
||||
import { Injectable, Logger, OnApplicationBootstrap } from '@nestjs/common';
|
||||
import { InjectRepository } from '@nestjs/typeorm';
|
||||
import { Repository, DataSource } from 'typeorm';
|
||||
import * as fs from 'fs/promises';
|
||||
@@ -587,6 +587,8 @@ components:
|
||||
|
||||
@Injectable()
|
||||
export class SeederService implements OnApplicationBootstrap {
|
||||
private readonly logger = new Logger(SeederService.name);
|
||||
|
||||
constructor(
|
||||
@InjectRepository(ApiEntryEntity)
|
||||
private readonly apiRepo: Repository<ApiEntryEntity>,
|
||||
@@ -648,7 +650,7 @@ export class SeederService implements OnApplicationBootstrap {
|
||||
const docsDir = process.env.DOCS_OUTPUT_DIR ?? '/app/docs-output';
|
||||
await fs.rm(docsDir, { recursive: true, force: true });
|
||||
await fs.mkdir(docsDir, { recursive: true });
|
||||
console.log('[Seeder] Reset complet — données supprimées, docs nettoyées.');
|
||||
this.logger.log('Reset complet — données supprimées, docs nettoyées.');
|
||||
}
|
||||
|
||||
private async seed(): Promise<void> {
|
||||
@@ -864,11 +866,13 @@ export class SeederService implements OnApplicationBootstrap {
|
||||
}),
|
||||
]);
|
||||
|
||||
console.log('[Seeder] 8 catégories et 7 APIs de démo créées — génération docs en cours...');
|
||||
this.logger.log('8 catégories et 7 APIs de démo créées — génération docs en cours...');
|
||||
|
||||
/* Déclenche la génération de docs en fire-and-forget pour chaque API */
|
||||
for (const entry of entries) {
|
||||
this.docsService.generate(entry.id).catch(console.error);
|
||||
this.docsService
|
||||
.generate(entry.id)
|
||||
.catch((err) => this.logger.error(`Génération docs échouée pour ${entry.id}`, err));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -253,7 +253,9 @@ export class UploadsController {
|
||||
|
||||
/* Fire-and-forget : génération asynchrone (seulement si YAML fourni) */
|
||||
if (yamlContent) {
|
||||
this.docsService.generate(entry.id).catch(console.error);
|
||||
this.docsService
|
||||
.generate(entry.id)
|
||||
.catch((err) => this.logger.error(`Génération docs échouée pour ${entry.id}`, err));
|
||||
}
|
||||
|
||||
return entry;
|
||||
|
||||
Reference in New Issue
Block a user