fix(query-typeorm): Escape the aggregated group by and sort by

Fixes the "unknown column" error of Postgres

examples/helpers/typeorm.helpers.ts

@@ -33,6 +33,8 @@ export const typeormPostgresOptions = (
     autoLoadEntities: true,
     synchronize: true,
     dropSchema: true,
+    logger: 'simple-console',
+    logging: ['error'],
     ...overrides
   } as TypeOrmModuleOptions)
 

examples/typeorm/src/app.module.ts

@@ -14,7 +14,7 @@ import { TodoItemModule } from './todo-item/todo-item.module'
     TypeOrmModule.forRoot(typeormOrmConfig('typeorm')),
     GraphQLModule.forRoot({
       driver: ApolloDriver,
-      autoSchemaFile: 'schema.gql',
+      autoSchemaFile: 'examples/typeorm/schema.gql',
       context: ({ req }: { req: { headers: Record<string, string> } }): GqlContext => ({ request: req }),
       formatError: formatGraphqlError
     }),

packages/query-typeorm/src/query/filter-query.builder.ts

@@ -202,21 +202,31 @@ export class FilterQueryBuilder<Entity> {
     }, qb)
   }
 
-  public applyAggregateGroupBy<T extends Groupable<Entity>>(qb: T, groupBy?: AggregateQueryField<Entity>[], alias?: string): T {
-    if (!groupBy) {
+  public applyAggregateGroupBy<T extends Groupable<Entity>>(
+    qb: T,
+    aggregatedGroupBy?: AggregateQueryField<Entity>[],
+    alias?: string
+  ): T {
+    if (!aggregatedGroupBy) {
       return qb
     }
-    return groupBy.reduce((prevQb, { field }) => {
-      return prevQb.addGroupBy(AggregateBuilder.getGroupByAlias(field))
+
+    return aggregatedGroupBy.reduce((prevQb, aggregatedField) => {
+      return prevQb.addGroupBy(prevQb.escape(AggregateBuilder.getGroupByAlias(aggregatedField.field)))
     }, qb)
   }
 
-  public applyAggregateSorting<T extends Sortable<Entity>>(qb: T, groupBy?: AggregateQueryField<Entity>[], alias?: string): T {
-    if (!groupBy) {
+  public applyAggregateSorting<T extends Sortable<Entity>>(
+    qb: T,
+    aggregatedGroupBy?: AggregateQueryField<Entity>[],
+    alias?: string
+  ): T {
+    if (!aggregatedGroupBy) {
       return qb
     }
-    return groupBy.reduce((prevQb, { field }) => {
-      return prevQb.addOrderBy(AggregateBuilder.getGroupByAlias(field), 'ASC')
+
+    return aggregatedGroupBy.reduce((prevQb, aggregatedField) => {
+      return prevQb.addOrderBy(prevQb.escape(AggregateBuilder.getGroupByAlias(aggregatedField.field)), 'ASC')
     }, qb)
   }
 

packages/query-typeorm/src/services/typeorm-query.service.ts

@@ -60,7 +60,7 @@ export class TypeOrmQueryService<Entity>
   }
 
   // eslint-disable-next-line @typescript-eslint/naming-convention
-  get EntityClass(): Class<Entity> {
+  public get EntityClass(): Class<Entity> {
     return this.repo.target as Class<Entity>
   }
 
@@ -77,17 +77,17 @@ export class TypeOrmQueryService<Entity>
    * ```
    * @param query - The Query used to filter, page, and sort rows.
    */
-  async query(query: Query<Entity>): Promise<Entity[]> {
+  public async query(query: Query<Entity>): Promise<Entity[]> {
     return this.filterQueryBuilder.select(query).getMany()
   }
 
-  async aggregate(filter: Filter<Entity>, aggregate: AggregateQuery<Entity>): Promise<AggregateResponse<Entity>[]> {
+  public async aggregate(filter: Filter<Entity>, aggregate: AggregateQuery<Entity>): Promise<AggregateResponse<Entity>[]> {
     return AggregateBuilder.asyncConvertToAggregateResponse(
       this.filterQueryBuilder.aggregate({ filter }, aggregate).getRawMany<Record<string, unknown>>()
     )
   }
 
-  async count(filter: Filter<Entity>): Promise<number> {
+  public async count(filter: Filter<Entity>): Promise<number> {
     return this.filterQueryBuilder.select({ filter }).getCount()
   }
 
@@ -101,7 +101,7 @@ export class TypeOrmQueryService<Entity>
    * @param id - The id of the record to find.
    * @param opts
    */
-  async findById(id: string | number, opts?: FindByIdOptions<Entity>): Promise<Entity | undefined> {
+  public async findById(id: string | number, opts?: FindByIdOptions<Entity>): Promise<Entity | undefined> {
     const qb = this.filterQueryBuilder.selectById(id, opts ?? {})
     if (opts?.withDeleted) {
       qb.withDeleted()
@@ -124,7 +124,7 @@ export class TypeOrmQueryService<Entity>
    * @param id - The id of the record to find.
    * @param opts
    */
-  async getById(id: string | number, opts?: GetByIdOptions<Entity>): Promise<Entity> {
+  public async getById(id: string | number, opts?: GetByIdOptions<Entity>): Promise<Entity> {
     const entity = await this.findById(id, opts)
     if (!entity) {
       throw new NotFoundException(`Unable to find ${this.EntityClass.name} with id: ${id}`)
@@ -141,7 +141,7 @@ export class TypeOrmQueryService<Entity>
    * ```
    * @param record - The entity to create.
    */
-  async createOne(record: DeepPartial<Entity>): Promise<Entity> {
+  public async createOne(record: DeepPartial<Entity>): Promise<Entity> {
     const entity = await this.ensureIsEntityAndDoesNotExist(record)
 
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -161,7 +161,7 @@ export class TypeOrmQueryService<Entity>
    * ```
    * @param records - The entities to create.
    */
-  async createMany(records: DeepPartial<Entity>[]): Promise<Entity[]> {
+  public async createMany(records: DeepPartial<Entity>[]): Promise<Entity[]> {
     const entities = await Promise.all(records.map((r) => this.ensureIsEntityAndDoesNotExist(r)))
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
@@ -200,7 +200,7 @@ export class TypeOrmQueryService<Entity>
    * @param update - A `Partial` of entity with the fields to update
    * @param filter - A Filter used to find the records to update
    */
-  async updateMany(update: DeepPartial<Entity>, filter: Filter<Entity>): Promise<UpdateManyResponse> {
+  public async updateMany(update: DeepPartial<Entity>, filter: Filter<Entity>): Promise<UpdateManyResponse> {
     this.ensureIdIsNotPresent(update)
     let updateResult: UpdateResult
 
@@ -240,7 +240,7 @@ export class TypeOrmQueryService<Entity>
    * @param filter Additional filter to use when finding the entity to delete.
    * @param opts - Additional options.
    */
-  async deleteOne(id: string | number, opts?: DeleteOneOptions<Entity>): Promise<Entity> {
+  public async deleteOne(id: string | number, opts?: DeleteOneOptions<Entity>): Promise<Entity> {
     const entity = await this.getById(id, opts)
     if (this.useSoftDelete || opts?.useSoftDelete) {
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -265,7 +265,7 @@ export class TypeOrmQueryService<Entity>
    * @param filter - A `Filter` to find records to delete.
    * @param opts - Additional delete many options
    */
-  async deleteMany(filter: Filter<Entity>, opts?: DeleteManyOptions<Entity>): Promise<DeleteManyResponse> {
+  public async deleteMany(filter: Filter<Entity>, opts?: DeleteManyOptions<Entity>): Promise<DeleteManyResponse> {
     let deleteResult = {} as DeleteResult
 
     if (this.filterQueryBuilder.filterHasRelations(filter)) {
@@ -306,7 +306,7 @@ export class TypeOrmQueryService<Entity>
    * @param id - The `id` of the entity to restore.
    * @param opts Additional filter to use when finding the entity to restore.
    */
-  async restoreOne(id: string | number, opts?: Filterable<Entity>): Promise<Entity> {
+  public async restoreOne(id: string | number, opts?: Filterable<Entity>): Promise<Entity> {
     this.ensureSoftDeleteEnabled()
     await this.repo.restore(id)
     return this.getById(id, opts)
@@ -325,7 +325,7 @@ export class TypeOrmQueryService<Entity>
    *
    * @param filter - A `Filter` to find records to delete.
    */
-  async restoreMany(filter: Filter<Entity>): Promise<UpdateManyResponse> {
+  public async restoreMany(filter: Filter<Entity>): Promise<UpdateManyResponse> {
     this.ensureSoftDeleteEnabled()
     const result = await this.filterQueryBuilder.softDelete({ filter }).restore().execute()
     return { updatedCount: result.affected || 0 }