feat(@nestjs/typeorm): added connectionFactory option

Added a connectionFactory option to TypeOrmModuleAsyncOptions that allows providing a custom connection factory.
nestjs · Jul 7, 2021 · 8e87f25 · 8e87f25
1 parent 1c75a77
commit 8e87f25
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 9 deletions.
diff --git a/lib/interfaces/typeorm-options.interface.ts b/lib/interfaces/typeorm-options.interface.ts
@@ -1,6 +1,6 @@
 import { Type } from '@nestjs/common';
 import { ModuleMetadata } from '@nestjs/common/interfaces';
-import { ConnectionOptions } from 'typeorm';
+import { Connection, ConnectionOptions } from 'typeorm';
 
 export type TypeOrmModuleOptions = {
   /**
@@ -41,6 +41,10 @@ export interface TypeOrmOptionsFactory {
   ): Promise<TypeOrmModuleOptions> | TypeOrmModuleOptions;
 }
 
+export type TypeOrmConnectionFactory = (
+  options?: ConnectionOptions,
+) => Promise<Connection>;
+
 export interface TypeOrmModuleAsyncOptions
   extends Pick<ModuleMetadata, 'imports'> {
   name?: string;
@@ -49,5 +53,6 @@ export interface TypeOrmModuleAsyncOptions
   useFactory?: (
     ...args: any[]
   ) => Promise<TypeOrmModuleOptions> | TypeOrmModuleOptions;
+  connectionFactory?: TypeOrmConnectionFactory;
   inject?: any[];
 }
diff --git a/lib/typeorm-core.module.ts b/lib/typeorm-core.module.ts
@@ -25,6 +25,7 @@ import {
 } from './common/typeorm.utils';
 import { EntitiesMetadataStorage } from './entities-metadata.storage';
 import {
+  TypeOrmConnectionFactory,
   TypeOrmModuleAsyncOptions,
   TypeOrmModuleOptions,
   TypeOrmOptionsFactory,
@@ -70,12 +71,18 @@ export class TypeOrmCoreModule implements OnApplicationShutdown {
       provide: getConnectionToken(options as ConnectionOptions) as string,
       useFactory: async (typeOrmOptions: TypeOrmModuleOptions) => {
         if (options.name) {
-          return await this.createConnectionFactory({
-            ...typeOrmOptions,
-            name: options.name,
-          });
+          return await this.createConnectionFactory(
+            {
+              ...typeOrmOptions,
+              name: options.name,
+            },
+            options.connectionFactory,
+          );
         }
-        return await this.createConnectionFactory(typeOrmOptions);
+        return await this.createConnectionFactory(
+          typeOrmOptions,
+          options.connectionFactory,
+        );
       },
       inject: [TYPEORM_MODULE_OPTIONS],
     };
@@ -166,6 +173,7 @@ export class TypeOrmCoreModule implements OnApplicationShutdown {
 
   private static async createConnectionFactory(
     options: TypeOrmModuleOptions,
+    connectionFactory?: TypeOrmConnectionFactory,
   ): Promise<Connection> {
     try {
       if (options.keepConnectionAlive) {
@@ -181,12 +189,13 @@ export class TypeOrmCoreModule implements OnApplicationShutdown {
     } catch {}
 
     const connectionToken = getConnectionName(options as ConnectionOptions);
+    const createTypeormConnection = connectionFactory ?? createConnection;
     return await defer(() => {
       if (!options.type) {
-        return createConnection();
+        return createTypeormConnection();
       }
       if (!options.autoLoadEntities) {
-        return createConnection(options as ConnectionOptions);
+        return createTypeormConnection(options as ConnectionOptions);
       }
 
       let entities = options.entities;
@@ -199,7 +208,7 @@ export class TypeOrmCoreModule implements OnApplicationShutdown {
           connectionToken,
         );
       }
-      return createConnection({
+      return createTypeormConnection({
         ...options,
         entities,
       } as ConnectionOptions);