feat(validation): warn when failing to get metadata of an entity

Closes #153

lib/EntityManager.ts

@@ -153,7 +153,7 @@ export class EntityManager {
   async nativeUpdate<T extends IEntityType<T>>(entityName: EntityName<T>, where: FilterQuery<T>, data: EntityData<T>): Promise<number> {
     entityName = Utils.className(entityName);
     data = SmartQueryHelper.processParams(data);
-    where = SmartQueryHelper.processWhere(where as FilterQuery<T>, entityName, this.metadata.get(entityName));
+    where = SmartQueryHelper.processWhere(where as FilterQuery<T>, entityName, this.metadata.get(entityName, false, false));
     this.validator.validateParams(data, 'update data');
     this.validator.validateParams(where, 'update condition');
     const res = await this.driver.nativeUpdate(entityName, where, data, this.transactionContext);
@@ -163,7 +163,7 @@ export class EntityManager {
 
   async nativeDelete<T extends IEntityType<T>>(entityName: EntityName<T>, where: FilterQuery<T> | string | any): Promise<number> {
     entityName = Utils.className(entityName);
-    where = SmartQueryHelper.processWhere(where as FilterQuery<T>, entityName, this.metadata.get(entityName));
+    where = SmartQueryHelper.processWhere(where as FilterQuery<T>, entityName, this.metadata.get(entityName, false, false));
     this.validator.validateParams(where, 'delete condition');
     const res = await this.driver.nativeDelete(entityName, where, this.transactionContext);
 

lib/connections/MongoConnection.ts

@@ -198,7 +198,7 @@ export class MongoConnection extends Connection {
 
   private getCollectionName(name: EntityName<IEntity>): string {
     name = Utils.className(name);
-    const meta = this.metadata.get(name);
+    const meta = this.metadata.get(name, false, false);
 
     return meta ? meta.collection : name;
   }

lib/drivers/AbstractSqlDriver.ts

@@ -96,7 +96,7 @@ export abstract class AbstractSqlDriver<C extends AbstractSqlConnection = Abstra
       res = await qb.update(data).where(where).execute('run', false);
     }
 
-    await this.processManyToMany(entityName, Utils.extractPK(data[pk] || where, this.metadata.get(entityName))!, collections, ctx);
+    await this.processManyToMany(entityName, Utils.extractPK(data[pk] || where, this.metadata.get(entityName, false, false))!, collections, ctx);
 
     return res;
   }
@@ -115,7 +115,7 @@ export abstract class AbstractSqlDriver<C extends AbstractSqlConnection = Abstra
   }
 
   protected extractManyToMany<T extends IEntityType<T>>(entityName: string, data: EntityData<T>): EntityData<T> {
-    if (!this.metadata.get(entityName)) {
+    if (!this.metadata.get(entityName, false, false)) {
       return {};
     }
 
@@ -135,7 +135,7 @@ export abstract class AbstractSqlDriver<C extends AbstractSqlConnection = Abstra
   }
 
   protected async processManyToMany<T extends IEntityType<T>>(entityName: string, pk: IPrimaryKey, collections: EntityData<T>, ctx?: Transaction) {
-    if (!this.metadata.get(entityName)) {
+    if (!this.metadata.get(entityName, false, false)) {
       return;
     }
 

lib/drivers/DatabaseDriver.ts

@@ -112,7 +112,7 @@ export abstract class DatabaseDriver<C extends Connection> implements IDatabaseD
   }
 
   protected getPrimaryKeyField(entityName: string): string {
-    const meta = this.metadata.get(entityName);
+    const meta = this.metadata.get(entityName, false, false);
     return meta ? meta.primaryKey : this.config.getNamingStrategy().referenceColumnName();
   }
 

lib/drivers/MongoDriver.ts

@@ -73,7 +73,7 @@ export class MongoDriver extends DatabaseDriver<MongoConnection> {
   private renameFields<T>(entityName: string, data: T): T {
     data = Object.assign({}, data); // copy first
     Utils.renameKey(data, 'id', '_id');
-    const meta = this.metadata.get(entityName);
+    const meta = this.metadata.get(entityName, false, false);
 
     Object.keys(data).forEach(k => {
       if (meta && meta.properties[k]) {

lib/metadata/MetadataStorage.ts

@@ -1,5 +1,5 @@
 import { EntityMetadata, IEntityType } from '../decorators';
-import { Utils } from '../utils';
+import { Utils, ValidationError } from '../utils';
 import { EntityManager } from '../EntityManager';
 import { EntityHelper } from '../entity';
 
@@ -34,7 +34,11 @@ export class MetadataStorage {
     return this.metadata;
   }
 
-  get<T extends IEntityType<T> = any>(entity: string, init = false): EntityMetadata<T> {
+  get<T extends IEntityType<T> = any>(entity: string, init = false, validate = true): EntityMetadata<T> {
+    if (entity && !this.metadata[entity] && validate && !init) {
+      throw ValidationError.missingMetadata(entity);
+    }
+
     if (!this.metadata[entity] && init) {
       this.metadata[entity] = { properties: {} } as EntityMetadata;
     }

lib/metadata/MetadataValidator.ts

@@ -49,7 +49,7 @@ export class MetadataValidator {
     }
 
     // references do have type of known entity
-    if (!metadata.get(prop.type)) {
+    if (!metadata.get(prop.type, false, false)) {
       throw ValidationError.fromWrongTypeDefinition(meta, prop);
     }
   }

lib/query/QueryBuilder.ts

@@ -109,7 +109,7 @@ export class QueryBuilder {
   where(cond: Record<string, any>, operator?: keyof typeof QueryBuilderHelper.GROUP_OPERATORS): this; // tslint:disable-next-line:lines-between-class-members
   where(cond: string, params?: any[], operator?: keyof typeof QueryBuilderHelper.GROUP_OPERATORS): this; // tslint:disable-next-line:lines-between-class-members
   where(cond: Record<string, any> | string, params?: keyof typeof QueryBuilderHelper.GROUP_OPERATORS | any[], operator?: keyof typeof QueryBuilderHelper.GROUP_OPERATORS): this {
-    cond = SmartQueryHelper.processWhere(cond, this.entityName, this.metadata.get(this.entityName));
+    cond = SmartQueryHelper.processWhere(cond, this.entityName, this.metadata.get(this.entityName, false, false));
 
     if (Utils.isString(cond)) {
       cond = { [`(${cond})`]: Utils.asArray(params) };
@@ -221,7 +221,7 @@ export class QueryBuilder {
     }
 
     this.helper.getLockSQL(qb, this.lockMode);
-    this.helper.finalize(this.type, qb, this.metadata.get(this.entityName));
+    this.helper.finalize(this.type, qb, this.metadata.get(this.entityName, false, false));
 
     return qb;
   }
@@ -237,7 +237,7 @@ export class QueryBuilder {
   async execute(method: 'all' | 'get' | 'run' = 'all', mapResults = true): Promise<any> {
     const type = this.connectionType || (method === 'run' ? 'write' : 'read');
     const res = await this.driver.getConnection(type).execute(this.getKnexQuery(), [], method);
-    const meta = this.metadata.get(this.entityName);
+    const meta = this.metadata.get(this.entityName, false, false);
 
     if (!mapResults) {
       return res;
@@ -288,7 +288,7 @@ export class QueryBuilder {
 
   private processWhere(cond: any): any {
     cond = Object.assign({}, cond); // copy first
-    const meta = this.metadata.get(this.entityName);
+    const meta = this.metadata.get(this.entityName, false, false);
 
     Object.keys(cond).forEach(field => {
       this.helper.replaceEmptyInConditions(cond, field);

lib/query/QueryBuilderHelper.ts

@@ -61,7 +61,7 @@ export class QueryBuilderHelper {
 
   processData(data: any): any {
     data = Object.assign({}, data); // copy first
-    const meta = this.metadata.get(this.entityName);
+    const meta = this.metadata.get(this.entityName, false, false);
 
     Object.keys(data).forEach(k => {
       if (meta && meta.properties[k]) {
@@ -195,7 +195,7 @@ export class QueryBuilderHelper {
   }
 
   getTableName(entityName: string): string {
-    const meta = this.metadata.get(entityName);
+    const meta = this.metadata.get(entityName, false, false);
     return meta ? meta.collection : entityName;
   }
 
@@ -412,15 +412,15 @@ export class QueryBuilderHelper {
       return void qb.forUpdate();
     }
 
-    const meta = this.metadata.get(this.entityName);
+    const meta = this.metadata.get(this.entityName, false, false);
 
     if (lockMode === LockMode.OPTIMISTIC && meta && !meta.versionProperty) {
       throw ValidationError.lockFailed(this.entityName);
     }
   }
 
   updateVersionProperty(qb: KnexQueryBuilder): void {
-    const meta = this.metadata.get(this.entityName);
+    const meta = this.metadata.get(this.entityName, false, false);
 
     if (!meta || !meta.versionProperty) {
       return;
@@ -467,7 +467,7 @@ export class QueryBuilderHelper {
 
   private fieldName(field: string, alias?: string): string {
     const entityName = this.aliasMap[alias!] || this.entityName;
-    const meta = this.metadata.get(entityName);
+    const meta = this.metadata.get(entityName, false, false);
     const prop = meta ? meta.properties[field] : false;
 
     return prop ? prop.fieldName : field;

lib/utils/ValidationError.ts

@@ -120,6 +120,10 @@ export class ValidationError extends Error {
     return new ValidationError(`${name} not found (${inspect(where)})`);
   }
 
+  static missingMetadata(entity: string): ValidationError {
+    return new ValidationError(`Metadata for entity ${entity} not found`);
+  }
+
   private static fromMessage(meta: EntityMetadata, prop: EntityProperty, message: string): ValidationError {
     return new ValidationError(`${meta.name}.${prop.name} ${message}`);
   }

tests/MetadataValidator.test.ts

@@ -103,4 +103,9 @@ describe('MetadataValidator', () => {
     })).rejects.toThrowError(`Entity 'Author2' extends unknown base entity 'BaseEntity2', please make sure to provide it in 'entities' array when initializing the ORM`);
   });
 
+  test('MetadataStorage.get throws when no metadata found', async () => {
+    const storage = new MetadataStorage({});
+    expect(() => storage.get('Test')).toThrowError('Metadata for entity Test not found');
+  });
+
 });