feat(query-builder): validate unknown alias when explicitly joining

Closes #4353
mikro-orm · May 14, 2023 · 8d4a83a · 8d4a83a
1 parent ce81071
commit 8d4a83a
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/packages/knex/src/query/QueryBuilder.ts b/packages/knex/src/query/QueryBuilder.ts
@@ -788,12 +788,18 @@ export class QueryBuilder<T extends object = AnyEntity> {
   private joinReference(field: string, alias: string, cond: Dictionary, type: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string): EntityProperty {
     this.ensureNotFinalized();
     const [fromAlias, fromField] = this.helper.splitField(field);
-    const entityName = this._aliases[fromAlias]?.entityName;
+    const q = (str: string) => `'${str}'`;
+
+    if (!this._aliases[fromAlias]) {
+      throw new Error(`Trying to join ${q(fromField)} with alias ${q(fromAlias)}, but ${q(fromAlias)} is not a known alias. Available aliases are: ${Object.keys(this._aliases).map(q).join(', ')}.`);
+    }
+
+    const entityName = this._aliases[fromAlias].entityName;
     const meta = this.metadata.get(entityName);
     const prop = meta.properties[fromField];
 
     if (!prop) {
-      throw new Error(`Trying to join ${field}, but ${fromField} is not a defined relation on ${meta.className}`);
+      throw new Error(`Trying to join ${q(field)}, but ${q(fromField)} is not a defined relation on ${meta.className}.`);
     }
 
     this.createAlias(prop.type, alias);

diff --git a/tests/QueryBuilder.test.ts b/tests/QueryBuilder.test.ts
@@ -259,11 +259,17 @@ describe('QueryBuilder', () => {
     expect(qb.getParams()).toEqual([2, 1]);
   });
 
+  test('validation of unknown alias', async () => {
+    const qb = orm.em.createQueryBuilder(FooBar2, 'fb1');
+    qb.select('*').joinAndSelect('fb1.baz', 'fz');
+    expect(() => qb.join('fb0.baz', 'b')).toThrowError(`Trying to join 'baz' with alias 'fb0', but 'fb0' is not a known alias. Available aliases are: 'fb1', 'fz'.`);
+  });
+
   test('complex select with mapping of joined results', async () => {
     const qb = orm.em.createQueryBuilder(FooBar2, 'fb1');
     qb.select('*').joinAndSelect('fb1.baz', 'fz');
 
-    const err = `Trying to join fz.fooBar, but fooBar is not a defined relation on FooBaz2`;
+    const err = `Trying to join 'fz.fooBar', but 'fooBar' is not a defined relation on FooBaz2`;
     expect(() => qb.leftJoinAndSelect('fz.fooBar', 'fb2')).toThrowError(err);
 
     qb.leftJoinAndSelect('fz.bar', 'fb2')