Migrate to a monorepo structure (#2909)

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

@@ -0,0 +1,66 @@
+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();
+  });
+});

packages/twenty-server/src/integrations/environment/decorators/__tests__/cast-to-positive-number.decorator.spec.ts

@@ -0,0 +1,58 @@
+import { plainToClass } from 'class-transformer';
+
+import { CastToPositiveNumber } from 'src/integrations/environment/decorators/cast-to-positive-number.decorator';
+
+class TestClass {
+  @CastToPositiveNumber()
+  numberProperty?: any;
+}
+
+describe('CastToPositiveNumber Decorator', () => {
+  it('should cast number to number', () => {
+    const transformedClass = plainToClass(TestClass, { numberProperty: 123 });
+
+    expect(transformedClass.numberProperty).toBe(123);
+  });
+
+  it('should cast string to number', () => {
+    const transformedClass = plainToClass(TestClass, { numberProperty: '123' });
+
+    expect(transformedClass.numberProperty).toBe(123);
+  });
+
+  it('should cast null to undefined', () => {
+    const transformedClass = plainToClass(TestClass, { numberProperty: null });
+
+    expect(transformedClass.numberProperty).toBe(undefined);
+  });
+
+  it('should cast negative number to undefined', () => {
+    const transformedClass = plainToClass(TestClass, { numberProperty: -12 });
+
+    expect(transformedClass.numberProperty).toBe(undefined);
+  });
+
+  it('should cast undefined to undefined', () => {
+    const transformedClass = plainToClass(TestClass, {
+      numberProperty: undefined,
+    });
+
+    expect(transformedClass.numberProperty).toBe(undefined);
+  });
+
+  it('should cast NaN string to undefined', () => {
+    const transformedClass = plainToClass(TestClass, {
+      numberProperty: 'toto',
+    });
+
+    expect(transformedClass.numberProperty).toBe(undefined);
+  });
+
+  it('should cast a negative string to undefined', () => {
+    const transformedClass = plainToClass(TestClass, {
+      numberProperty: '-123',
+    });
+
+    expect(transformedClass.numberProperty).toBe(undefined);
+  });
+});

packages/twenty-server/src/integrations/environment/decorators/cast-to-boolean.decorator.ts

@@ -0,0 +1,18 @@
+import { Transform } from 'class-transformer';
+
+export const CastToBoolean = () =>
+  Transform(({ value }: { value: string }) => toBoolean(value));
+
+const toBoolean = (value: any) => {
+  if (typeof value === 'boolean') {
+    return value;
+  }
+  if (['true', 'on', 'yes', '1'].includes(value.toLowerCase())) {
+    return true;
+  }
+  if (['false', 'off', 'no', '0'].includes(value.toLowerCase())) {
+    return false;
+  }
+
+  return undefined;
+};

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

@@ -0,0 +1,19 @@
+import { Transform } from 'class-transformer';
+
+export const CastToLogLevelArray = () =>
+  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;
+};

packages/twenty-server/src/integrations/environment/decorators/cast-to-positive-number.decorator.ts

@@ -0,0 +1,15 @@
+import { Transform } from 'class-transformer';
+
+export const CastToPositiveNumber = () =>
+  Transform(({ value }: { value: string }) => toNumber(value));
+
+const toNumber = (value: any) => {
+  if (typeof value === 'number') {
+    return value >= 0 ? value : undefined;
+  }
+  if (typeof value === 'string') {
+    return isNaN(+value) ? undefined : toNumber(+value);
+  }
+
+  return undefined;
+};

packages/twenty-server/src/integrations/environment/decorators/cast-to-string-array.decorator.ts

@@ -0,0 +1,12 @@
+import { Transform } from 'class-transformer';
+
+export const CastToStringArray = () =>
+  Transform(({ value }: { value: string }) => toStringArray(value));
+
+const toStringArray = (value: any) => {
+  if (typeof value === 'string') {
+    return value.split(',').map((item) => item.trim());
+  }
+
+  return undefined;
+};

packages/twenty-server/src/integrations/environment/decorators/is-aws-region.decorator.ts

@@ -0,0 +1,27 @@
+import {
+  registerDecorator,
+  ValidationOptions,
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+} from 'class-validator';
+
+@ValidatorConstraint({ async: true })
+export class IsAWSRegionConstraint implements ValidatorConstraintInterface {
+  validate(region: string) {
+    const regex = /^[a-z]{2}-[a-z]+-\d{1}$/;
+
+    return regex.test(region); // Returns true if region matches regex
+  }
+}
+
+export const IsAWSRegion =
+  (validationOptions?: ValidationOptions) =>
+  (object: object, propertyName: string) => {
+    registerDecorator({
+      target: object.constructor,
+      propertyName: propertyName,
+      options: validationOptions,
+      constraints: [],
+      validator: IsAWSRegionConstraint,
+    });
+  };

packages/twenty-server/src/integrations/environment/decorators/is-duration.decorator.ts

@@ -0,0 +1,28 @@
+import {
+  registerDecorator,
+  ValidationOptions,
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+} from 'class-validator';
+
+@ValidatorConstraint({ async: true })
+export class IsDurationConstraint implements ValidatorConstraintInterface {
+  validate(duration: string) {
+    const regex =
+      /^-?[0-9]+(.[0-9]+)?(m(illiseconds?)?|s(econds?)?|h((ou)?rs?)?|d(ays?)?|w(eeks?)?|M(onths?)?|y(ears?)?)?$/;
+
+    return regex.test(duration); // Returns true if duration matches regex
+  }
+}
+
+export const IsDuration =
+  (validationOptions?: ValidationOptions) =>
+  (object: object, propertyName: string) => {
+    registerDecorator({
+      target: object.constructor,
+      propertyName: propertyName,
+      options: validationOptions,
+      constraints: [],
+      validator: IsDurationConstraint,
+    });
+  };

packages/twenty-server/src/integrations/environment/environment.module-definition.ts

@@ -0,0 +1,8 @@
+import { ConfigurableModuleBuilder } from '@nestjs/common';
+
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN } =
+  new ConfigurableModuleBuilder({
+    moduleName: 'Environment',
+  })
+    .setClassMethodName('forRoot')
+    .build();

packages/twenty-server/src/integrations/environment/environment.module.ts

@@ -0,0 +1,20 @@
+import { Global, Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+
+import { EnvironmentService } from './environment.service';
+import { ConfigurableModuleClass } from './environment.module-definition';
+import { validate } from './environment.validation';
+
+@Global()
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      expandVariables: true,
+      validate,
+    }),
+  ],
+  providers: [EnvironmentService],
+  exports: [EnvironmentService],
+})
+export class EnvironmentModule extends ConfigurableModuleClass {}

packages/twenty-server/src/integrations/environment/environment.service.spec.ts

@@ -0,0 +1,26 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { ConfigService } from '@nestjs/config';
+
+import { EnvironmentService } from './environment.service';
+
+describe('EnvironmentService', () => {
+  let service: EnvironmentService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        EnvironmentService,
+        {
+          provide: ConfigService,
+          useValue: {},
+        },
+      ],
+    }).compile();
+
+    service = module.get<EnvironmentService>(EnvironmentService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

packages/twenty-server/src/integrations/environment/environment.service.ts

@@ -0,0 +1,211 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { Injectable, LogLevel } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+
+import { LoggerDriverType } from 'src/integrations/logger/interfaces';
+import { ExceptionHandlerDriver } from 'src/integrations/exception-handler/interfaces';
+import { StorageDriverType } from 'src/integrations/file-storage/interfaces';
+import { MessageQueueDriverType } from 'src/integrations/message-queue/interfaces';
+
+import { AwsRegion } from './interfaces/aws-region.interface';
+import { SupportDriver } from './interfaces/support.interface';
+
+@Injectable()
+export class EnvironmentService {
+  constructor(private configService: ConfigService) {}
+
+  isDebugMode(): boolean {
+    return this.configService.get<boolean>('DEBUG_MODE') ?? false;
+  }
+
+  isSignInPrefilled(): boolean {
+    return this.configService.get<boolean>('SIGN_IN_PREFILLED') ?? false;
+  }
+
+  isTelemetryEnabled(): boolean {
+    return this.configService.get<boolean>('TELEMETRY_ENABLED') ?? true;
+  }
+
+  isTelemetryAnonymizationEnabled(): boolean {
+    return (
+      this.configService.get<boolean>('TELEMETRY_ANONYMIZATION_ENABLED') ?? true
+    );
+  }
+
+  getPort(): number {
+    return this.configService.get<number>('PORT') ?? 3000;
+  }
+
+  getPGDatabaseUrl(): string {
+    return this.configService.get<string>('PG_DATABASE_URL')!;
+  }
+
+  getRedisHost(): string {
+    return this.configService.get<string>('REDIS_HOST') ?? '127.0.0.1';
+  }
+
+  getRedisPort(): number {
+    return +(this.configService.get<string>('REDIS_PORT') ?? 6379);
+  }
+
+  getFrontBaseUrl(): string {
+    return this.configService.get<string>('FRONT_BASE_URL')!;
+  }
+
+  getServerUrl(): string {
+    return this.configService.get<string>('SERVER_URL')!;
+  }
+
+  getAccessTokenSecret(): string {
+    return this.configService.get<string>('ACCESS_TOKEN_SECRET')!;
+  }
+
+  getAccessTokenExpiresIn(): string {
+    return this.configService.get<string>('ACCESS_TOKEN_EXPIRES_IN') ?? '30m';
+  }
+
+  getRefreshTokenSecret(): string {
+    return this.configService.get<string>('REFRESH_TOKEN_SECRET')!;
+  }
+
+  getRefreshTokenExpiresIn(): string {
+    return this.configService.get<string>('REFRESH_TOKEN_EXPIRES_IN') ?? '90d';
+  }
+
+  getRefreshTokenCoolDown(): string {
+    return this.configService.get<string>('REFRESH_TOKEN_COOL_DOWN') ?? '1m';
+  }
+
+  getLoginTokenSecret(): string {
+    return this.configService.get<string>('LOGIN_TOKEN_SECRET')!;
+  }
+
+  getLoginTokenExpiresIn(): string {
+    return this.configService.get<string>('LOGIN_TOKEN_EXPIRES_IN') ?? '15m';
+  }
+
+  getTransientTokenExpiresIn(): string {
+    return (
+      this.configService.get<string>('SHORT_TERM_TOKEN_EXPIRES_IN') ?? '5m'
+    );
+  }
+
+  getApiTokenExpiresIn(): string {
+    return this.configService.get<string>('API_TOKEN_EXPIRES_IN') ?? '1000y';
+  }
+
+  getFrontAuthCallbackUrl(): string {
+    return (
+      this.configService.get<string>('FRONT_AUTH_CALLBACK_URL') ??
+      this.getFrontBaseUrl() + '/verify'
+    );
+  }
+
+  isMessagingProviderGmailEnabled(): boolean {
+    return (
+      this.configService.get<boolean>('MESSAGING_PROVIDER_GMAIL_ENABLED') ??
+      false
+    );
+  }
+
+  getMessagingProviderGmailCallbackUrl(): string | undefined {
+    return this.configService.get<string>(
+      'MESSAGING_PROVIDER_GMAIL_CALLBACK_URL',
+    );
+  }
+
+  isAuthGoogleEnabled(): boolean {
+    return this.configService.get<boolean>('AUTH_GOOGLE_ENABLED') ?? false;
+  }
+
+  getAuthGoogleClientId(): string | undefined {
+    return this.configService.get<string>('AUTH_GOOGLE_CLIENT_ID');
+  }
+
+  getAuthGoogleClientSecret(): string | undefined {
+    return this.configService.get<string>('AUTH_GOOGLE_CLIENT_SECRET');
+  }
+
+  getAuthGoogleCallbackUrl(): string | undefined {
+    return this.configService.get<string>('AUTH_GOOGLE_CALLBACK_URL');
+  }
+
+  getStorageDriverType(): StorageDriverType {
+    return (
+      this.configService.get<StorageDriverType>('STORAGE_TYPE') ??
+      StorageDriverType.Local
+    );
+  }
+
+  getMessageQueueDriverType(): MessageQueueDriverType {
+    return (
+      this.configService.get<MessageQueueDriverType>('MESSAGE_QUEUE_TYPE') ??
+      MessageQueueDriverType.PgBoss
+    );
+  }
+
+  getStorageS3Region(): AwsRegion | undefined {
+    return this.configService.get<AwsRegion>('STORAGE_S3_REGION');
+  }
+
+  getStorageS3Name(): string | undefined {
+    return this.configService.get<string>('STORAGE_S3_NAME');
+  }
+
+  getStorageS3Endpoint(): string | undefined {
+    return this.configService.get<string>('STORAGE_S3_ENDPOINT');
+  }
+
+  getStorageLocalPath(): string {
+    return (
+      this.configService.get<string>('STORAGE_LOCAL_PATH') ?? '.local-storage'
+    );
+  }
+
+  getSupportDriver(): string {
+    return (
+      this.configService.get<string>('SUPPORT_DRIVER') ?? SupportDriver.None
+    );
+  }
+
+  getSupportFrontChatId(): string | undefined {
+    return this.configService.get<string>('SUPPORT_FRONT_CHAT_ID');
+  }
+
+  getSupportFrontHMACKey(): string | undefined {
+    return this.configService.get<string>('SUPPORT_FRONT_HMAC_KEY');
+  }
+
+  getLoggerDriverType(): LoggerDriverType {
+    return (
+      this.configService.get<LoggerDriverType>('LOGGER_DRIVER') ??
+      LoggerDriverType.Console
+    );
+  }
+
+  getExceptionHandlerDriverType(): ExceptionHandlerDriver {
+    return (
+      this.configService.get<ExceptionHandlerDriver>(
+        'EXCEPTION_HANDLER_DRIVER',
+      ) ?? ExceptionHandlerDriver.Console
+    );
+  }
+
+  getLogLevels(): LogLevel[] {
+    return (
+      this.configService.get<LogLevel[]>('LOG_LEVELS') ?? [
+        'log',
+        'error',
+        'warn',
+      ]
+    );
+  }
+
+  getSentryDSN(): string | undefined {
+    return this.configService.get<string>('SENTRY_DSN');
+  }
+
+  getDemoWorkspaceIds(): string[] {
+    return this.configService.get<string[]>('DEMO_WORKSPACE_IDS') ?? [];
+  }
+}

packages/twenty-server/src/integrations/environment/environment.validation.ts

@@ -0,0 +1,174 @@
+import { LogLevel } from '@nestjs/common';
+
+import { plainToClass } from 'class-transformer';
+import {
+  IsEnum,
+  IsOptional,
+  IsString,
+  IsUrl,
+  ValidateIf,
+  validateSync,
+  IsBoolean,
+  IsNumber,
+} from 'class-validator';
+
+import { assert } from 'src/utils/assert';
+import { CastToStringArray } from 'src/integrations/environment/decorators/cast-to-string-array.decorator';
+import { ExceptionHandlerDriver } from 'src/integrations/exception-handler/interfaces';
+import { StorageDriverType } from 'src/integrations/file-storage/interfaces';
+import { LoggerDriverType } from 'src/integrations/logger/interfaces';
+
+import { IsDuration } from './decorators/is-duration.decorator';
+import { AwsRegion } from './interfaces/aws-region.interface';
+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 { CastToLogLevelArray } from './decorators/cast-to-log-level-array.decorator';
+
+export class EnvironmentVariables {
+  // Misc
+  @CastToBoolean()
+  @IsOptional()
+  @IsBoolean()
+  DEBUG_MODE?: boolean;
+
+  @CastToBoolean()
+  @IsOptional()
+  @IsBoolean()
+  SIGN_IN_PREFILLED?: boolean;
+
+  @CastToBoolean()
+  @IsOptional()
+  @IsBoolean()
+  TELEMETRY_ENABLED?: boolean;
+
+  @CastToBoolean()
+  @IsOptional()
+  @IsBoolean()
+  TELEMETRY_ANONYMIZATION_ENABLED?: boolean;
+
+  @CastToPositiveNumber()
+  @IsNumber()
+  @IsOptional()
+  PORT: number;
+
+  // Database
+  @IsUrl({ protocols: ['postgres'], require_tld: false })
+  PG_DATABASE_URL: string;
+
+  // Frontend URL
+  @IsUrl({ require_tld: false })
+  FRONT_BASE_URL: string;
+
+  // Server URL
+  @IsUrl({ require_tld: false })
+  @IsOptional()
+  SERVER_URL: string;
+
+  // Json Web Token
+  @IsString()
+  ACCESS_TOKEN_SECRET: string;
+  @IsDuration()
+  @IsOptional()
+  ACCESS_TOKEN_EXPIRES_IN: string;
+
+  @IsString()
+  REFRESH_TOKEN_SECRET: string;
+  @IsDuration()
+  @IsOptional()
+  REFRESH_TOKEN_EXPIRES_IN: string;
+  @IsDuration()
+  @IsOptional()
+  REFRESH_TOKEN_COOL_DOWN: string;
+
+  @IsString()
+  LOGIN_TOKEN_SECRET: string;
+  @IsDuration()
+  @IsOptional()
+  LOGIN_TOKEN_EXPIRES_IN: string;
+
+  // Auth
+  @IsUrl({ require_tld: false })
+  @IsOptional()
+  FRONT_AUTH_CALLBACK_URL: string;
+
+  @CastToBoolean()
+  @IsOptional()
+  @IsBoolean()
+  AUTH_GOOGLE_ENABLED?: boolean;
+
+  @IsString()
+  @ValidateIf((env) => env.AUTH_GOOGLE_ENABLED === true)
+  AUTH_GOOGLE_CLIENT_ID?: string;
+
+  @IsString()
+  @ValidateIf((env) => env.AUTH_GOOGLE_ENABLED === true)
+  AUTH_GOOGLE_CLIENT_SECRET?: string;
+
+  @IsUrl({ require_tld: false })
+  @ValidateIf((env) => env.AUTH_GOOGLE_ENABLED === true)
+  AUTH_GOOGLE_CALLBACK_URL?: string;
+
+  // Storage
+  @IsEnum(StorageDriverType)
+  @IsOptional()
+  STORAGE_TYPE?: StorageDriverType;
+
+  @ValidateIf((env) => env.STORAGE_TYPE === StorageDriverType.S3)
+  @IsAWSRegion()
+  STORAGE_S3_REGION?: AwsRegion;
+
+  @ValidateIf((env) => env.STORAGE_TYPE === StorageDriverType.S3)
+  @IsString()
+  STORAGE_S3_NAME?: string;
+
+  @IsString()
+  @ValidateIf((env) => env.STORAGE_TYPE === StorageDriverType.Local)
+  STORAGE_LOCAL_PATH?: string;
+
+  // Support
+  @IsEnum(SupportDriver)
+  @IsOptional()
+  SUPPORT_DRIVER?: SupportDriver;
+
+  @ValidateIf((env) => env.SUPPORT_DRIVER === SupportDriver.Front)
+  @IsString()
+  SUPPORT_FRONT_CHAT_ID?: string;
+
+  @ValidateIf((env) => env.SUPPORT_DRIVER === SupportDriver.Front)
+  @IsString()
+  SUPPORT_FRONT_HMAC_KEY?: string;
+
+  @IsEnum(LoggerDriverType)
+  @IsOptional()
+  LOGGER_DRIVER?: LoggerDriverType;
+
+  @IsEnum(ExceptionHandlerDriver)
+  @IsOptional()
+  EXCEPTION_HANDLER_DRIVER?: ExceptionHandlerDriver;
+
+  @CastToLogLevelArray()
+  @IsOptional()
+  LOG_LEVELS?: LogLevel[];
+
+  @CastToStringArray()
+  @IsOptional()
+  DEMO_WORKSPACE_IDS?: string[];
+
+  @ValidateIf(
+    (env) => env.EXCEPTION_HANDLER_DRIVER === ExceptionHandlerDriver.Sentry,
+  )
+  @IsString()
+  SENTRY_DSN?: string;
+}
+
+export const validate = (config: Record<string, unknown>) => {
+  const validatedConfig = plainToClass(EnvironmentVariables, config);
+
+  const errors = validateSync(validatedConfig);
+
+  assert(!errors.length, errors.toString());
+
+  return validatedConfig;
+};

packages/twenty-server/src/integrations/environment/interfaces/aws-region.interface.ts

@@ -0,0 +1 @@
+export type AwsRegion = `${string}-${string}-${number}`;

packages/twenty-server/src/integrations/environment/interfaces/support.interface.ts

@@ -0,0 +1,4 @@
+export enum SupportDriver {
+  None = 'none',
+  Front = 'front',
+}