BC-8092 - implement config validation #21
Conversation
| @@ -1,9 +1,11 @@ | |||
| import { Module } from '@nestjs/common'; | |||
| import { PassportModule } from '@nestjs/passport'; | |||
| import { ConfigurationModule } from '../configuration/configuration.module.js'; | |||
There was a problem hiding this comment.
configuration und config sind sich zu ähnlich um ausdrücken zu können was für was ist.
| export class XApiKeyConfig { | ||
| @Transform(({ value }) => value.split(',').map((part: string) => (part.split(':').pop() ?? '').trim())) | ||
| @IsArray() | ||
| public ADMIN_API__ALLOWED_API_KEYS = ['randomString']; |
There was a problem hiding this comment.
Sollte der default Wert wirklich bei der Anforderung festgelegt werden? Ich finde das der bessere Ort die Validierung, bzw. das lesen/zuweisen ist.
| @@ -1,5 +1,4 @@ | |||
| import { Injectable, UnauthorizedException } from '@nestjs/common'; | |||
| import { ConfigService } from '@nestjs/config'; | |||
| import { PassportStrategy } from '@nestjs/passport'; | |||
| import { Strategy } from 'passport-headerapikey/lib/Strategy.js'; | |||
| import { XApiKeyConfig } from '../config/index.js'; | |||
|
|
||
| export class AuthorizationConfig { | ||
| @IsUrl({ require_tld: false }) | ||
| public API_HOST = 'http://localhost:3030'; |
There was a problem hiding this comment.
Die verschiedenen Werte für prod, test, local sollten aus einer anderen Quelle kommen. Den default als local zu nutzen finde ich nicht gut. Man könnte sicher argumentieren das test eh im test file definiert werden muss. Nur gibt es einzelne envs die immer wieder gesetzt werden müssten und einmalig definiert einfach praktischer sind.
src/infra/redis/redis.config.ts
Outdated
| public REDIS!: string; | ||
|
|
||
| @IsString() | ||
| @IsOptional() |
There was a problem hiding this comment.
Ist das nicht ein Wiederspruch? Es muss string sein, es ist optional, aber ! sagt das es nicht undefined, oder null ist am Ende.
| config.REDIS_SENTINEL_SERVICE_NAME = sentinelServiceName; | ||
| config.REDIS_PREFIX = redisPrefix; | ||
| config.REDIS_SENTINEL_NAME = sentinelName; | ||
| config.REDIS_SENTINEL_PASSWORD = sentinelPassword; |
There was a problem hiding this comment.
Wäre ein überschreiben zu einem späteren Zeitpunkt an anderen Stellen auch möglich?
There was a problem hiding this comment.
ja mit jest.replaceProperty(config, 'REDIS_SENTINEL_SERVICE_NAME', undefined);
| import { App } from 'uws'; | ||
| import { createMock } from '@golevelup/ts-jest'; | ||
| import { RedisService } from '../../../../infra/redis/redis.service.js'; |
There was a problem hiding this comment.
Der Pfad ist unglücklich. In dem Repo auch mit @infra zu arbeiten ist denke ich sinnvoller.
There was a problem hiding this comment.
Ja es soll auch so sein, leider wegen ESM Module ist das nicht so einfach wie im server. bzw noch nicht nachgeforscht
| } | ||
|
|
||
| private validate<T extends object>(config: Record<string, unknown>, Constructor: new () => T): T { | ||
| const validatedConfig = plainToInstance(Constructor, config); |
There was a problem hiding this comment.
vs doku
const validatedConfig = plainToInstance(
EnvironmentVariables,
config,
{ enableImplicitConversion: true },
);
const errors = validateSync(validatedConfig, { skipMissingProperties: false });
| public getAllValidConfigsByType<T extends object>(Constructor: new () => T): T { | ||
| const config = new Constructor(); | ||
| const configKeys = Object.keys(config); | ||
|
|
||
| const configValues = configKeys.reduce((acc: Record<string, unknown>, key) => { | ||
| const value = this.configService.get(key); | ||
|
|
||
| if (value) { | ||
| acc[key] = value; | ||
| } | ||
|
|
||
| return acc; | ||
| }, {}); | ||
|
|
||
| const validatedConfig = this.validate(configValues, Constructor); | ||
|
|
||
| return validatedConfig; | ||
| } |
There was a problem hiding this comment.
Kompliziert, brauchen wir das wirklich.
There was a problem hiding this comment.
Wie gesagtes ist nur so möglich auf eingelesene Werte vom ConfigService zuzugreifen und nur die keys zu holen die wir brauchen für dieses Config
| @Module({}) | ||
| export class ConfigurationModule { | ||
| public static register<T extends object>(Constructor: new () => T): DynamicModule { | ||
| return { | ||
| imports: [ConfigModule.forRoot({ cache: true })], | ||
| imports: [ConfigModule.forRoot({ cache: true, ...getEnvConfig() })], |
There was a problem hiding this comment.
Hier könnte man das cache: true auch noch nach getEnvConfig verschieben und einfach das ganze object den root übergeben.
src/infra/redis/redis.config.ts
Outdated
| @@ -16,6 +16,6 @@ export class RedisConfig { | |||
| public REDIS_SENTINEL_NAME = 'mymaster'; | |||
|
|
|||
| @IsString() | |||
| @IsOptional() | |||
| @ValidateIf((o) => o.REDIS_SENTINEL_SERVICE_NAME !== undefined) | |||
There was a problem hiding this comment.
Meintest du hier evtl. o.REDIS_SENTINEL_SERVICE_NAME === undefined
There was a problem hiding this comment.
Nein, wenn REDIS_SENTINEL_SERVICE_NAME gesetzt ist soll validieren @ValidateIf
|
Description
Links to Tickets or other pull requests
Changes
Datasecurity
Deployment
New Repos, NPM pakages or vendor scripts
Screenshots of UI changes
Approval for review