fix(core): respect read replica options

Closes #1963
mikro-orm · Aug 26, 2021 · 0d203d5 · 0d203d5
1 parent 544583b
commit 0d203d5
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 11 deletions.
diff --git a/packages/core/src/connections/Connection.ts b/packages/core/src/connections/Connection.ts
@@ -12,14 +12,20 @@ export abstract class Connection {
 
   protected metadata!: MetadataStorage;
   protected platform!: Platform;
+  protected readonly options: ConnectionOptions;
   protected abstract client: any;
 
   constructor(protected readonly config: Configuration,
-              protected readonly options?: ConnectionOptions,
+              options?: ConnectionOptions,
               protected readonly type: 'read' | 'write' = 'write') {
-    if (!this.options) {
+    if (options) {
+      this.options = options;
+    } else {
       const props = ['dbName', 'clientUrl', 'host', 'port', 'user', 'password', 'multipleStatements', 'pool'] as const;
-      this.options = props.reduce((o, i) => { (o[i] as any) = this.config.get(i); return o; }, {} as ConnectionOptions);
+      this.options = props.reduce((o, i) => {
+        (o[i] as any) = this.config.get(i);
+        return o;
+      }, {} as ConnectionOptions);
     }
   }
 
@@ -36,7 +42,11 @@ export abstract class Connection {
   /**
    * Closes the database connection (aka disconnect)
    */
-  abstract close(force?: boolean): Promise<void>;
+  async close(force?: boolean): Promise<void> {
+    Object.keys(this.options)
+      .filter(k => k !== 'name')
+      .forEach(k => delete this.options[k]);
+  }
 
   /**
    * Returns default client url for given driver (e.g. mongodb://127.0.0.1:27017 for mongodb)
@@ -63,12 +73,12 @@ export abstract class Connection {
 
   getConnectionOptions(): ConnectionConfig {
     const ret: ConnectionConfig = {};
-    const url = new URL(this.options!.clientUrl || this.config.getClientUrl());
-    this.options!.host = ret.host = this.config.get('host', url.hostname);
-    this.options!.port = ret.port = this.config.get('port', +url.port);
-    this.options!.user = ret.user = this.config.get('user', url.username);
-    this.options!.password = ret.password = this.config.get('password', url.password);
-    this.options!.dbName = ret.database = this.config.get('dbName', url.pathname.replace(/^\//, ''));
+    const url = new URL(this.options.clientUrl ?? this.config.getClientUrl());
+    this.options.host = ret.host = this.options.host ?? this.config.get('host', url.hostname);
+    this.options.port = ret.port = this.options.port ?? this.config.get('port', +url.port);
+    this.options.user = ret.user = this.options.user ?? this.config.get('user', url.username);
+    this.options.password = ret.password = this.options.password ?? this.config.get('password', url.password);
+    this.options.dbName = ret.database = this.options.dbName ?? this.config.get('dbName', url.pathname.replace(/^\//, ''));
 
     return ret;
   }
@@ -120,7 +130,7 @@ export abstract class Connection {
     let msg = query + (Utils.isDefined(took) ? c.grey(` [took ${took} ms]`) : '');
 
     if (this.config.get('replicas', []).length > 0) {
-      msg += c.cyan(` (via ${this.type} connection '${this.options!.name || this.config.get('name') || this.options!.host}')`);
+      msg += c.cyan(` (via ${this.type} connection '${this.options.name || this.config.get('name') || this.options.host}')`);
     }
 
     logger.log('query', msg);

diff --git a/packages/knex/src/AbstractSqlConnection.ts b/packages/knex/src/AbstractSqlConnection.ts
@@ -28,6 +28,7 @@ export abstract class AbstractSqlConnection extends Connection {
   }
 
   async close(force?: boolean): Promise<void> {
+    await super.close(force);
     await this.client.destroy();
   }
 

diff --git a/packages/knex/src/schema/SchemaGenerator.ts b/packages/knex/src/schema/SchemaGenerator.ts
@@ -41,6 +41,8 @@ export class SchemaGenerator {
       this.config.set('dbName', this.helper.getManagementDbName());
       await this.driver.reconnect();
       await this.createDatabase(dbName);
+      this.config.set('dbName', dbName);
+      await this.driver.reconnect();
     }
   }
 

diff --git a/tests/EntityManager.postgre.test.ts b/tests/EntityManager.postgre.test.ts
@@ -1824,6 +1824,36 @@ describe('EntityManagerPostgre', () => {
     expect(updates).toHaveLength(0);
   });
 
+  test('getConnection() with replicas (GH issue #1963)', async () => {
+    const config = new Configuration({
+      type: 'postgresql',
+      clientUrl: 'postgre://root@127.0.0.1:1234/db_name',
+      host: '127.0.0.10',
+      password: 'secret',
+      user: 'user',
+      logger: jest.fn(),
+      forceUtcTimezone: true,
+      replicas: [
+        { name: 'read-1', host: 'read_host_1', user: 'read_user' },
+      ],
+    } as any, false);
+    const driver = new PostgreSqlDriver(config);
+    expect(driver.getConnection('write').getConnectionOptions()).toEqual({
+      database: 'db_name',
+      host: '127.0.0.10',
+      password: 'secret',
+      user: 'user',
+      port: 1234,
+    });
+    expect(driver.getConnection('read').getConnectionOptions()).toEqual({
+      database: 'db_name',
+      host: 'read_host_1',
+      password: 'secret',
+      user: 'read_user',
+      port: 1234,
+    });
+  });
+
   // this should run in ~600ms (when running single test locally)
   test('perf: one to many', async () => {
     const author = new Author2('Jon Snow', 'snow@wall.st');