perf(query-builder): remove unnecessary join branches when pagination…

… is applied
mikro-orm · Apr 6, 2024 · d228976 · d228976
1 parent 8f32a05
commit d228976
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 2 deletions.
diff --git a/packages/knex/src/dialects/mssql/MsSqlTableCompiler.ts b/packages/knex/src/dialects/mssql/MsSqlTableCompiler.ts
@@ -31,6 +31,7 @@ export class MsSqlTableCompiler extends MonkeyPatchable.MsSqlTableCompiler {
   }
 
   dropForeign(this: any, columns: any, constraintName: any) {
+    /* istanbul ignore next */
     constraintName = constraintName
       ? this.formatter.wrap(constraintName)
       : this._indexCommand('foreign', this.tableNameRaw, columns);

diff --git a/packages/knex/src/query/QueryBuilder.ts b/packages/knex/src/query/QueryBuilder.ts
@@ -1229,7 +1229,7 @@ export class QueryBuilder<T extends object = AnyEntity> {
     }
 
     for (const f of Object.keys(this._populateMap)) {
-      if (type === 'where') {
+      if (type === 'where' && this._joins[f]) {
         const cols = this.helper.mapJoinColumns(this.type ?? QueryType.SELECT, this._joins[f]);
 
         for (const col of cols) {
@@ -1548,6 +1548,34 @@ export class QueryBuilder<T extends object = AnyEntity> {
     (subSubQuery as Dictionary).__raw = true; // tag it as there is now way to check via `instanceof`
     this._limit = undefined;
     this._offset = undefined;
+
+    // remove joins that are not used for population or ordering to improve performance
+    const populate = new Set<string>();
+    const orderByAliases = this._orderBy
+      .flatMap(hint => Object.keys(hint))
+      .map(k => k.split('.')[0]);
+
+    function addPath(hints: PopulateOptions<any>[], prefix = '') {
+      for (const hint of hints) {
+        const field = hint.field.split(':')[0];
+        populate.add((prefix ? prefix + '.' : '') + field);
+
+        if (hint.children) {
+          addPath(hint.children, (prefix ? prefix + '.' : '') + field);
+        }
+      }
+    }
+
+    addPath(this._populate);
+
+    for (const [key, join] of Object.entries(this._joins)) {
+      const path = join.path?.replace(/\[populate]|\[pivot]|:ref/g, '').replace(new RegExp(`^${meta.className}.`), '');
+
+      if (!populate.has(path ?? '') && !orderByAliases.includes(join.alias)) {
+        delete this._joins[key];
+      }
+    }
+
     this.select(this._fields!).where({ [Utils.getPrimaryKeyHash(meta.primaryKeys)]: { $in: subSubQuery } });
   }
 

diff --git a/tests/QueryBuilder.test.ts b/tests/QueryBuilder.test.ts
@@ -701,7 +701,7 @@ describe('QueryBuilder', () => {
       .orderBy({ booksTotal: QueryOrder.ASC });
 
     await qb;
-    expect(qb.getQuery()).toEqual('select `a`.*, (select count(distinct `b`.`uuid_pk`) as `count` from `book2` as `b` where `b`.`author_id` = `a`.`id`) as `books_total` from `author2` as `a` left join `book2` as `e1` on `a`.`id` = `e1`.`author_id` where `a`.`id` in (select `a`.`id` from (select `a`.`id`, (select count(distinct `b`.`uuid_pk`) as `count` from `book2` as `b` where `b`.`author_id` = `a`.`id`) as `books_total` from `author2` as `a` left join `book2` as `e1` on `a`.`id` = `e1`.`author_id` where `e1`.`title` = ? group by `a`.`id` order by min(`books_total`) asc limit ?) as `a`) order by `books_total` asc');
+    expect(qb.getQuery()).toEqual('select `a`.*, (select count(distinct `b`.`uuid_pk`) as `count` from `book2` as `b` where `b`.`author_id` = `a`.`id`) as `books_total` from `author2` as `a` where `a`.`id` in (select `a`.`id` from (select `a`.`id`, (select count(distinct `b`.`uuid_pk`) as `count` from `book2` as `b` where `b`.`author_id` = `a`.`id`) as `books_total` from `author2` as `a` left join `book2` as `e1` on `a`.`id` = `e1`.`author_id` where `e1`.`title` = ? group by `a`.`id` order by min(`books_total`) asc limit ?) as `a`) order by `books_total` asc');
     expect(qb.getParams()).toEqual(['foo', 1]);
   });