Complete Sentry integration (#1546)

server/src/integrations/environment/decorators/__tests__/cast-to-log-level-array.decorator.spec.ts

@@ -0,0 +1,58 @@
+import { plainToClass } from 'class-transformer';
+
+import { CastToLogLevelArray } from 'src/integrations/environment/decorators/cast-to-log-level-array.decorator';
+
+class TestClass {
+  @CastToLogLevelArray()
+  logLevels?: any;
+}
+
+describe('CastToLogLevelArray Decorator', () => {
+  it('should cast "log" to ["log"]', () => {
+    const transformedClass = plainToClass(TestClass, { logLevels: 'log' });
+    expect(transformedClass.logLevels).toStrictEqual(['log']);
+  });
+
+  it('should cast "error" to ["error"]', () => {
+    const transformedClass = plainToClass(TestClass, { logLevels: 'error' });
+    expect(transformedClass.logLevels).toStrictEqual(['error']);
+  });
+
+  it('should cast "warn" to ["warn"]', () => {
+    const transformedClass = plainToClass(TestClass, { logLevels: 'warn' });
+    expect(transformedClass.logLevels).toStrictEqual(['warn']);
+  });
+
+  it('should cast "debug" to ["debug"]', () => {
+    const transformedClass = plainToClass(TestClass, { logLevels: 'debug' });
+    expect(transformedClass.logLevels).toStrictEqual(['debug']);
+  });
+
+  it('should cast "verbose" to ["verbose"]', () => {
+    const transformedClass = plainToClass(TestClass, { logLevels: 'verbose' });
+    expect(transformedClass.logLevels).toStrictEqual(['verbose']);
+  });
+
+  it('should cast "verbose,error,warn" to ["verbose", "error", "warn"]', () => {
+    const transformedClass = plainToClass(TestClass, {
+      logLevels: 'verbose,error,warn',
+    });
+    expect(transformedClass.logLevels).toStrictEqual([
+      'verbose',
+      'error',
+      'warn',
+    ]);
+  });
+
+  it('should cast "toto" to undefined', () => {
+    const transformedClass = plainToClass(TestClass, { logLevels: 'toto' });
+    expect(transformedClass.logLevels).toBeUndefined();
+  });
+
+  it('should cast "verbose,error,toto" to undefined', () => {
+    const transformedClass = plainToClass(TestClass, {
+      logLevels: 'verbose,error,toto',
+    });
+    expect(transformedClass.logLevels).toBeUndefined();
+  });
+});

server/src/integrations/environment/decorators/cast-to-log-level-array.decorator.ts

@@ -0,0 +1,20 @@
+import { Transform } from 'class-transformer';
+
+export function CastToLogLevelArray() {
+  return Transform(({ value }: { value: string }) => toLogLevelArray(value));
+}
+
+const toLogLevelArray = (value: any) => {
+  if (typeof value === 'string') {
+    const rawLogLevels = value.split(',').map((level) => level.trim());
+    const isInvalid = rawLogLevels.some(
+      (level) => !['log', 'error', 'warn', 'debug', 'verbose'].includes(level),
+    );
+
+    if (!isInvalid) {
+      return rawLogLevels;
+    }
+  }
+
+  return undefined;
+};

server/src/integrations/environment/environment.service.ts

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { Injectable } from '@nestjs/common';
+import { Injectable, LogLevel } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 
 import { AwsRegion } from './interfaces/aws-region.interface';
 import { StorageType } from './interfaces/storage.interface';
 import { SupportDriver } from './interfaces/support.interface';
-import { LoggerType } from './interfaces/logger.interface';
+import { LoggerDriver } from './interfaces/logger.interface';
 
 @Injectable()
 export class EnvironmentService {
@@ -122,13 +122,23 @@ export class EnvironmentService {
     return this.configService.get<string>('SUPPORT_FRONT_HMAC_KEY');
   }
 
+  getLoggerDriver(): string {
+    return (
+      this.configService.get<string>('LOGGER_DRIVER') ?? LoggerDriver.Console
+    );
+  }
+
+  getLogLevels(): LogLevel[] {
+    return (
+      this.configService.get<LogLevel[]>('LOG_LEVELS') ?? [
+        'log',
+        'error',
+        'warn',
+      ]
+    );
+  }
+
   getSentryDSN(): string | undefined {
     return this.configService.get<string>('SENTRY_DSN');
   }
-
-  getLoggerDriver(): string | undefined {
-    return (
-      this.configService.get<string>('LOGGER_DRIVER') ?? LoggerType.Console
-    );
-  }
 }

server/src/integrations/environment/environment.validation.ts

@@ -1,3 +1,5 @@
+import { LogLevel } from '@nestjs/common';
+
 import { plainToClass } from 'class-transformer';
 import {
   IsEnum,
@@ -19,6 +21,8 @@ import { IsAWSRegion } from './decorators/is-aws-region.decorator';
 import { CastToBoolean } from './decorators/cast-to-boolean.decorator';
 import { SupportDriver } from './interfaces/support.interface';
 import { CastToPositiveNumber } from './decorators/cast-to-positive-number.decorator';
+import { LoggerDriver } from './interfaces/logger.interface';
+import { CastToLogLevelArray } from './decorators/cast-to-log-level-array.decorator';
 
 export class EnvironmentVariables {
   // Misc
@@ -125,6 +129,18 @@ export class EnvironmentVariables {
   @ValidateIf((env) => env.SUPPORT_DRIVER === SupportDriver.Front)
   @IsString()
   SUPPORT_FRONT_HMAC_KEY?: string;
+
+  @IsEnum(LoggerDriver)
+  @IsOptional()
+  LOGGER_DRIVER?: LoggerDriver;
+
+  @CastToLogLevelArray()
+  @IsOptional()
+  LOG_LEVELS?: LogLevel[];
+
+  @ValidateIf((env) => env.LOGGER_DRIVER === LoggerDriver.Sentry)
+  @IsString()
+  SENTRY_DSN?: string;
 }
 
 export function validate(config: Record<string, unknown>) {

server/src/integrations/environment/interfaces/logger.interface.ts

@@ -1,4 +1,4 @@
-export enum LoggerType {
+export enum LoggerDriver {
   Console = 'console',
   Sentry = 'sentry',
 }