chore: add some coverage ignore comments

Mostly edge cases for driver usage with table names instead of entity names.
mikro-orm · Nov 5, 2022 · 3575307 · 3575307
1 parent 8f8f820
commit 3575307
Show file tree

Hide file tree

Showing 14 changed files with 38 additions and 4 deletions.
diff --git a/packages/core/src/entity/Reference.ts b/packages/core/src/entity/Reference.ts
@@ -148,6 +148,7 @@ export class Reference<T> {
     return wrap(this.entity).toJSON!(...args);
   }
 
+  /* istanbul ignore next */
   [inspect.custom](depth: number) {
     const object = { ...this };
     const hidden = ['meta'];

diff --git a/packages/core/src/types/ArrayType.ts b/packages/core/src/types/ArrayType.ts
@@ -20,6 +20,7 @@ export class ArrayType<T extends string | number = string> extends Type<T[] | nu
       return platform.marshallArray(value as string[]);
     }
 
+    /* istanbul ignore next */
     if (typeof context === 'boolean' ? context : context?.fromQuery) {
       return value;
     }

diff --git a/packages/core/src/types/Type.ts b/packages/core/src/types/Type.ts
@@ -87,6 +87,7 @@ export abstract class Type<JSType = string, DBType = JSType> {
     const ret = inspect(object, { depth });
     const name = (this as object).constructor.name;
 
+    /* istanbul ignore next */
     return ret === '[Object]' ? `[${name}]` : name + ' ' + ret;
   }
 

diff --git a/packages/core/src/unit-of-work/ChangeSet.ts b/packages/core/src/unit-of-work/ChangeSet.ts
@@ -44,6 +44,7 @@ export class ChangeSet<T> {
     const ret = inspect(object, { depth });
     const name = `${this.constructor.name}<${this.meta.className}>`;
 
+    /* istanbul ignore next */
     return ret === '[Object]' ? `[${name}]` : name + ' ' + ret;
   }
 

diff --git a/packages/core/src/utils/Configuration.ts b/packages/core/src/utils/Configuration.ts
@@ -124,8 +124,7 @@ export class Configuration<D extends IDatabaseDriver = IDatabaseDriver> {
       fileName: (className: string) => className,
     },
     preferReadReplicas: true,
-    /* istanbul ignore next */
-    dynamicImportProvider: (id: string) => import(id),
+    dynamicImportProvider: /* istanbul ignore next */ (id: string) => import(id),
   };
 
   static readonly PLATFORMS = {

diff --git a/packages/core/src/utils/ConfigurationLoader.ts b/packages/core/src/utils/ConfigurationLoader.ts
@@ -102,6 +102,7 @@ export class ConfigurationLoader {
 
     const distDir = pathExistsSync(process.cwd() + '/dist');
     const buildDir = pathExistsSync(process.cwd() + '/build');
+    /* istanbul ignore next */
     const path = distDir ? 'dist' : (buildDir ? 'build' : 'src');
     paths.push(`./${path}/mikro-orm.config.js`);
     paths.push('./mikro-orm.config.js');
@@ -245,7 +246,7 @@ export class ConfigurationLoader {
   }
 
   /** @internal */
-  static async commonJSCompat(options: Partial<Options> = {}): Promise<void> {
+  static async commonJSCompat(options: Partial<Options>): Promise<void> {
     if (await this.isESM()) {
       return;
     }

diff --git a/packages/core/src/utils/TransactionContext.ts b/packages/core/src/utils/TransactionContext.ts
@@ -27,7 +27,7 @@ export class TransactionContext {
   /**
    * Returns current EntityManager (if available).
    */
-  static getEntityManager(name = 'default'): EntityManager | undefined {
+  static getEntityManager(name = /* istanbul ignore next */ 'default'): EntityManager | undefined {
     const context = TransactionContext.currentTransactionContext();
     return context?.em.name === name ? context.em : undefined;
   }

diff --git a/packages/knex/src/AbstractSqlDriver.ts b/packages/knex/src/AbstractSqlDriver.ts
@@ -301,6 +301,7 @@ export abstract class AbstractSqlDriver<C extends AbstractSqlConnection = Abstra
     if (pks.length > 1) { // owner has composite pk
       pk = Utils.getPrimaryKeyCond(data as T, pks);
     } else {
+      /* istanbul ignore next */
       res.insertId = data[pks[0]] ?? res.insertId ?? res.row[pks[0]];
       pk = [res.insertId];
     }
@@ -322,6 +323,7 @@ export abstract class AbstractSqlDriver<C extends AbstractSqlConnection = Abstra
     const fields = Utils.flatten(props.map(prop => prop.fieldNames));
     const params: unknown[] = [];
 
+    /* istanbul ignore next */
     const tableName = meta ? this.getTableName(meta, options) : this.platform.quoteIdentifier(entityName);
     let sql = `insert into ${tableName} `;
     sql += fields.length > 0 ? '(' + fields.map(k => this.platform.quoteIdentifier(k)).join(', ') + ')' : `(${this.platform.quoteIdentifier(pks[0])})`;
@@ -388,6 +390,7 @@ export abstract class AbstractSqlDriver<C extends AbstractSqlConnection = Abstra
     let res = { affectedRows: 0, insertId: 0, row: {} } as QueryResult<T>;
 
     if (Utils.isPrimaryKey(where) && pks.length === 1) {
+      /* istanbul ignore next */
       where = { [meta?.primaryKeys[0] ?? pks[0]]: where } as FilterQuery<T>;
     }
 
@@ -396,7 +399,9 @@ export abstract class AbstractSqlDriver<C extends AbstractSqlConnection = Abstra
         .withSchema(this.getSchemaName(meta, options));
 
       if (options.upsert) {
+        /* istanbul ignore next */
         const uniqueFields = Utils.isPlainObject(where) ? Object.keys(where) : meta!.primaryKeys;
+        /* istanbul ignore next */
         qb.insert(data as T)
           .onConflict(uniqueFields.map(p => meta?.properties[p]?.fieldNames[0] ?? p))
           .merge(Object.keys(data).filter(f => !uniqueFields.includes(f)));

diff --git a/packages/knex/src/query/QueryBuilder.ts b/packages/knex/src/query/QueryBuilder.ts
@@ -817,6 +817,7 @@ export class QueryBuilder<T extends object = AnyEntity> {
       const [a, f] = this.helper.splitField(field);
       const prop = this.helper.getProperty(f, a);
 
+      /* istanbul ignore next */
       if (prop && [ReferenceType.ONE_TO_MANY, ReferenceType.MANY_TO_MANY].includes(prop.reference)) {
         return;
       }

diff --git a/packages/mariadb/src/MariaDbPlatform.ts b/packages/mariadb/src/MariaDbPlatform.ts
@@ -78,6 +78,7 @@ export class MariaDbPlatform extends AbstractSqlPlatform {
   }
 
   getFullTextIndexExpression(indexName: string, schemaName: string | undefined, tableName: string, columns: SimpleColumnMeta[]): string {
+    /* istanbul ignore next */
     const quotedTableName = this.quoteIdentifier(schemaName ? `${schemaName}.${tableName}` : tableName);
     const quotedColumnNames = columns.map(c => this.quoteIdentifier(c.name));
     const quotedIndexName = this.quoteIdentifier(indexName);

diff --git a/packages/mongodb/src/MongoDriver.ts b/packages/mongodb/src/MongoDriver.ts
@@ -41,6 +41,7 @@ export class MongoDriver extends DatabaseDriver<MongoConnection> {
   async findOne<T extends object, P extends string = never>(entityName: string, where: FilterQuery<T>, options: FindOneOptions<T, P> = { populate: [], orderBy: {} }): Promise<EntityData<T> | null> {
     if (this.metadata.find(entityName)?.virtual) {
       const [item] = await this.findVirtual(entityName, where, options as FindOptions<T, any>);
+      /* istanbul ignore next */
       return item ?? null;
     }
 

diff --git a/packages/mysql/src/MySqlPlatform.ts b/packages/mysql/src/MySqlPlatform.ts
@@ -75,6 +75,7 @@ export class MySqlPlatform extends AbstractSqlPlatform {
   }
 
   getFullTextIndexExpression(indexName: string, schemaName: string | undefined, tableName: string, columns: SimpleColumnMeta[]): string {
+    /* istanbul ignore next */
     const quotedTableName = this.quoteIdentifier(schemaName ? `${schemaName}.${tableName}` : tableName);
     const quotedColumnNames = columns.map(c => this.quoteIdentifier(c.name));
     const quotedIndexName = this.quoteIdentifier(indexName);

diff --git a/packages/mysql/src/MySqlSchemaHelper.ts b/packages/mysql/src/MySqlSchemaHelper.ts
@@ -261,6 +261,7 @@ export class MySqlSchemaHelper extends SchemaHelper {
     return ret;
   }
 
+  /* istanbul ignore next kept for BC */
   getForeignKeysSQL(tableName: string, schemaName?: string): string {
     return `select distinct k.constraint_name as constraint_name, k.column_name as column_name, k.referenced_table_name as referenced_table_name, k.referenced_column_name as referenced_column_name, c.update_rule as update_rule, c.delete_rule as delete_rule `
       + `from information_schema.key_column_usage k `

diff --git a/tests/QueryBuilder.test.ts b/tests/QueryBuilder.test.ts
@@ -2419,6 +2419,26 @@ describe('QueryBuilder', () => {
       expect(qb.getParams()).toEqual(['baz', 1]);
     }
 
+    {
+      const qb = pg.em.createQueryBuilder(FooBar2, 'fb1');
+      qb.select('*')
+        .distinct()
+        .joinAndSelect('fb1.baz', 'fz')
+        .leftJoinAndSelect('fz.bar', 'fb2')
+        .where({ 'fz.name': 'baz' })
+        .limit(1);
+      const sql = 'select distinct "fb1".*, ' +
+        '"fz"."id" as "fz__id", "fz"."name" as "fz__name", "fz"."version" as "fz__version", ' +
+        '"fb2"."id" as "fb2__id", "fb2"."name" as "fb2__name", "fb2"."name with space" as "fb2__name with space", "fb2"."baz_id" as "fb2__baz_id", "fb2"."foo_bar_id" as "fb2__foo_bar_id", "fb2"."version" as "fb2__version", "fb2"."blob" as "fb2__blob", "fb2"."array" as "fb2__array", "fb2"."object_property" as "fb2__object_property", (select 123) as "fb2__random", ' +
+        '(select 123) as "random" from "foo_bar2" as "fb1" ' +
+        'inner join "foo_baz2" as "fz" on "fb1"."baz_id" = "fz"."id" ' +
+        'left join "foo_bar2" as "fb2" on "fz"."id" = "fb2"."baz_id" ' +
+        'where "fz"."name" = $1 ' +
+        'limit $2';
+      expect(qb.getQuery()).toEqual(sql);
+      expect(qb.getParams()).toEqual(['baz', 1]);
+    }
+
     const qb01 = pg.em.createQueryBuilder(FooBar2);
     qb01.insert({ array: [] } as any);
     expect(qb01.getFormattedQuery()).toEqual(`insert into "foo_bar2" ("array") values ('{}') returning "id", "version"`);