Replace TypeORM by Drizzle (#60)

* Replace TypeORM by Drizzle

* Remove useless code and set auto migrate optional

* Refactor environment variable handling to improve value validation

* Update README.md to reflect the transition from TypeORM to Drizzle ORM

Author: alexleboucher

.env.example

@@ -1,15 +1,19 @@
 NODE_ENV=development
 HOST=0.0.0.0
 PORT=8000
+CORS_ORIGIN_ALLOWED=
+LOGGER_TYPE=console
+JWT_SECRET=2b0dbb9e26779c2e8aec40dd29eb45b6
+JWT_EXPIRES_IN_SECONDS=
+
 DB_USER=postgres
-DB_HOST=db
-DB_NAME=api_db
 DB_PASSWORD=secret
+DB_NAME=api_db
+DB_HOST=db
 DB_PORT=5432
 DB_HOST_PORT=5433
-CORS_ORIGIN_ALLOWED=
-LOGGER_TYPE=console
-JWT_SECRET=secret
+DB_SSL=false
+DB_AUTO_MIGRATE=true
 
 TEST_DB_HOST=db_test
 TEST_DB_NAME=test_db

README.md

@@ -19,16 +19,14 @@
     "docker:down": "docker-compose --profile dev --profile test down",
     "docker:shell": "docker exec -it backend sh",
     "docker:build": "docker build . -t backend",
-    "typeorm": "typeorm-ts-node-commonjs",
-    "migration:generate": "sh -c 'yarn typeorm migration:generate -d src/infra/database/config/data-source.orm.ts src/infra/database/migrations/$0'",
-    "migration:create": "sh -c 'yarn typeorm migration:create src/infra/database/migrations/$0'",
-    "migration:revert": "yarn typeorm migration:revert -d src/infra/database/config/data-source.orm.ts",
-    "migration:run": "yarn typeorm migration:run -d src/infra/database/config/data-source.orm.ts"
+    "migration:generate": "sh -c 'yarn drizzle-kit generate --config=./src/infra/database/config/drizzle.config.ts --name=$0'",
+    "migration:run": "yarn drizzle-kit migrate --config=./src/infra/database/config/drizzle.config.ts"
   },
   "dependencies": {
     "bcryptjs": "3.0.2",
     "cors": "2.8.5",
     "dotenv": "17.2.2",
+    "drizzle-orm": "^0.44.5",
     "express": "5.1.0",
     "helmet": "8.1.0",
     "inversify": "7.9.1",
@@ -37,7 +35,6 @@
     "pg": "8.16.3",
     "reflect-metadata": "0.2.2",
     "tslib": "2.8.1",
-    "typeorm": "0.3.26",
     "zod": "4.1.7"
   },
   "devDependencies": {
@@ -51,7 +48,9 @@
     "@types/jsonwebtoken": "9.0.10",
     "@types/morgan": "1.9.10",
     "@types/node": "24.3.1",
+    "@types/pg": "^8.15.5",
     "@types/supertest": "6.0.3",
+    "drizzle-kit": "^0.31.4",
     "eslint": "9.35.0",
     "eslint-import-resolver-typescript": "4.4.4",
     "eslint-plugin-import": "2.32.0",

package.json

@@ -1,6 +1,4 @@
-import * as dotenv from 'dotenv';
 import 'reflect-metadata';
-dotenv.config();
 
 import { createServer } from '@/app/server';
 import { env } from '@/core/env/env';
@@ -13,16 +11,17 @@ import type { ILogger } from '@/core/logger/logger.interface';
 const host = env('HOST', '0.0.0.0');
 const port = env('PORT', '8080');
 
-setupContainer().then((container) => {
-  const server = createServer(container);
-  const database = container.get<IDatabase>(SERVICES_DI_TYPES.Database);
-  const logger = container.get<ILogger>(CORE_DI_TYPES.Logger);
-  database.initialize()
-    .then(() => {
-      server.listen({ host, port }, () => {
-        logger.info(`⚡️ Server is running at http://${host}:${port}`);
-      });
-    })
-    .catch(logger.error);
-})
+setupContainer()
+  .then((container) => {
+    const server = createServer(container);
+    const database = container.get<IDatabase>(SERVICES_DI_TYPES.Database);
+    const logger = container.get<ILogger>(CORE_DI_TYPES.Logger);
+    database.initialize()
+      .then(() => {
+        server.listen({ host, port }, () => {
+          logger.info(`⚡️ Server is running at http://${host}:${port}`);
+        });
+      })
+      .catch(logger.error);
+  })
   .catch((error) => { throw error; });

src/app/index.ts

@@ -11,18 +11,8 @@ import { registerRouters } from '@/container/routers/container';
 
 type ContainerRegisterAction = (container: Container) => void | Promise<void>;
 
-export type BuildContainerOptions = {
-  onlyDatabase?: boolean;
-};
-
-export const setupContainer = (options?: BuildContainerOptions) => {
-  let builder;
-
-  if (options?.onlyDatabase) {
-    builder = new ContainerBuilder().registerOnlyDatabase();
-  } else {
-    builder = new ContainerBuilder().register();
-  }
+export const setupContainer = () => {
+  const builder = new ContainerBuilder().register();
 
   return builder.build();
 };
@@ -53,17 +43,12 @@ export class ContainerBuilder {
     return this;
   }
 
-  registerOnlyDatabase() {
-    this.registerServices({ onlyDatabase: true });
-    return this;
-  }
-
   private registerCore() {
     return registerCore(this);
   }
 
-  private registerServices(options?: BuildContainerOptions) {
-    return registerServices(this, options);
+  private registerServices() {
+    return registerServices(this);
   }
 
   private registerRepositories() {

src/container/container.ts

@@ -1,7 +1,7 @@
-import type { BuildContainerOptions, ContainerBuilder } from '@/container/container';
+import type { ContainerBuilder } from '@/container/container';
 import { REPOSITORIES_DI_TYPES } from '@/container/repositories/di-types';
 import { SERVICES_DI_TYPES } from '@/container/services/di-types';
-import { integerEnv, mandatoryEnv, mandatoryIntegerEnv, booleanEnv, env } from '@/core/env/env';
+import { booleanEnv, integerEnv, mandatoryEnv, mandatoryIntegerEnv } from '@/core/env/env';
 import type { IUserRepository } from '@/domain/repositories/user-repository.interface';
 import type { IAuthenticator } from '@/domain/services/auth/authenticator.interface';
 import type { IEncryptor } from '@/domain/services/security/encryptor.interface';
@@ -10,16 +10,8 @@ import type { IDatabase, DatabaseConfig } from '@/infra/database/database';
 import { Database } from '@/infra/database/database';
 import { BcryptEncryptor } from '@/infra/security/encryptor/bcrypt-encryptor';
 
-
-export const registerServices = (containerBuilder: ContainerBuilder, options?: BuildContainerOptions) => {
-  let builder;
-
-  if (options?.onlyDatabase) {
-    builder = new ServicesContainerBuilder(containerBuilder).registerOnlyDatabase();
-  } else {
-    builder = new ServicesContainerBuilder(containerBuilder).registerServices();
-  }
-
+export const registerServices = (containerBuilder: ContainerBuilder) => {
+  const builder = new ServicesContainerBuilder(containerBuilder).registerServices();
   return builder;
 };
 
@@ -38,12 +30,6 @@ class ServicesContainerBuilder {
     return this.containerBuilder;
   }
 
-  registerOnlyDatabase() {
-    this.registerDatabaseService();
-
-    return this.containerBuilder;
-  }
-
   private registerAuthServices() {
     const config = {
       secret: mandatoryEnv('JWT_SECRET'),
@@ -81,17 +67,22 @@ class ServicesContainerBuilder {
   private getDatabaseConfig(): DatabaseConfig {
     const isTest = mandatoryEnv('NODE_ENV') === 'test';
 
+    const host = isTest ? mandatoryEnv('TEST_DB_HOST') : mandatoryEnv('DB_HOST');
+    const port = isTest ? mandatoryIntegerEnv('TEST_DB_PORT') : mandatoryIntegerEnv('DB_PORT');
+    const username = mandatoryEnv('DB_USER');
+    const password = mandatoryEnv('DB_PASSWORD');
+    const database = isTest ? mandatoryEnv('TEST_DB_NAME') : mandatoryEnv('DB_NAME');
+    const ssl = isTest ? false : booleanEnv('DB_SSL', false);
+    const autoMigrate = booleanEnv('DB_AUTO_MIGRATE', true);
+
     return {
-      type: 'postgres',
-      host: isTest ? mandatoryEnv('TEST_DB_HOST') : mandatoryEnv('DB_HOST'),
-      port: isTest ? mandatoryIntegerEnv('TEST_DB_PORT') : mandatoryIntegerEnv('DB_PORT'),
-      username: mandatoryEnv('DB_USER'),
-      password: mandatoryEnv('DB_PASSWORD'),
-      database: isTest ? mandatoryEnv('TEST_DB_NAME') : mandatoryEnv('DB_NAME'),
-      logging: booleanEnv('DB_LOGGING', false),
-      migrationsRun: isTest,
-      entities: [env('TYPEORM_ENTITIES', 'src/infra/database/models/**/*.entity.ts')],
-      migrations: [env('TYPEORM_MIGRATIONS', 'src/infra/database/migrations/**/*.ts')],
+      host,
+      port,
+      username,
+      password,
+      database,
+      ssl,
+      autoMigrate,
     };
   }
 }

src/container/services/container.ts

@@ -1,8 +1,19 @@
-export const env = (key: string, defaultValue: string): string => process.env[key] ?? defaultValue;
+import { config } from 'dotenv';
+
+config();
+
+export function isDefined<T>(value: T | undefined): value is T {
+  return value !== undefined && value !== '';
+}
+
+export const env = (key: string, defaultValue: string): string => {
+  const value = process.env[key];
+  return isDefined(value) ? value : defaultValue;
+};
 
 export const mandatoryEnv = (key: string): string => {
   const value = process.env[key];
-  if (value === undefined) {
+  if (!isDefined(value)) {
     throw new Error(`Variable ${key} not found in environment`);
   }
 
@@ -11,13 +22,13 @@ export const mandatoryEnv = (key: string): string => {
 
 export const integerEnv = (key: string, defaultValue: number): number => {
   const value = process.env[key];
-  return value === undefined ? defaultValue : parseInt(value, 10);
+  return isDefined(value) ? parseInt(value, 10) : defaultValue;
 };
 
 export const mandatoryIntegerEnv = (key: string): number => {
   const value = process.env[key];
 
-  if (value === undefined) {
+  if (!isDefined(value)) {
     throw new Error(`Variable ${key} not found in environment`);
   }
 
@@ -27,17 +38,19 @@ export const mandatoryIntegerEnv = (key: string): number => {
 export const booleanEnv = (key: string, defaultValue: boolean): boolean => {
   const value = process.env[key];
 
-  if (value !== undefined && value !== 'true' && value !== 'false') {
+  const isDefinedValue = isDefined(value);
+
+  if (isDefinedValue && value !== 'true' && value !== 'false') {
     throw new Error(`Variable ${key} must be a boolean`);
   }
 
-  return value === undefined ? defaultValue : value === 'true';
+  return isDefinedValue ? value === 'true' : defaultValue;
 };
 
 export const mandatoryBooleanEnv = (key: string): boolean => {
   const value = process.env[key];
 
-  if (value === undefined) {
+  if (!isDefined(value)) {
     throw new Error(`Variable ${key} not found in environment`);
   }
 
@@ -51,9 +64,11 @@ export const mandatoryBooleanEnv = (key: string): boolean => {
 export const unionEnv = <T extends string>(key: string, values: T[], defaultValue: T): T => {
   const value = process.env[key];
 
-  if (value !== undefined && !values.includes(value as T)) {
+  const isDefinedValue = isDefined(value);
+
+  if (isDefinedValue && !values.includes(value as T)) {
     throw new Error(`Variable ${key} must be one of ${values.join(', ')}`);
   }
 
-  return value === undefined ? defaultValue : value as T;
+  return isDefinedValue ? value as T : defaultValue;
 };

src/core/env/env.ts

@@ -0,0 +1,26 @@
+import { defineConfig } from 'drizzle-kit';
+
+import { booleanEnv, mandatoryEnv, mandatoryIntegerEnv } from '@/core/env/env';
+
+const isTest = mandatoryEnv('NODE_ENV') === 'test';
+
+const host = isTest ? mandatoryEnv('TEST_DB_HOST') : mandatoryEnv('DB_HOST');
+const port = isTest ? mandatoryIntegerEnv('TEST_DB_PORT') : mandatoryIntegerEnv('DB_PORT');
+const username = mandatoryEnv('DB_USER');
+const password = mandatoryEnv('DB_PASSWORD');
+const database = isTest ? mandatoryEnv('TEST_DB_NAME') : mandatoryEnv('DB_NAME');
+const ssl = isTest ? false : booleanEnv('DB_SSL', false);
+
+export default defineConfig({
+  schema: 'src/infra/database/schemas',
+  out: 'src/infra/database/migrations',
+  dialect: 'postgresql',
+  dbCredentials: {
+    host,
+    port,
+    user: username,
+    password,
+    database,
+    ssl,
+  }
+});