Should I expect relations to be included in GQL results automatically when using this library?

[abrenoch]

Hi, a bit new to nestjs and this library.

I am having a rough time getting my relationships to be included in my gql query results. I have gone through the docs several times and it is not clear to me if nestjs-query should be including these relations automatically or if a dataloader (or something like that) needs to be used.

assets.entity.ts

@Entity({ name: 'assets' })
export class AssetEntity {

  @PrimaryGeneratedColumn()
  id: number;

  @Column({ nullable: true, name: 'file_id' })
  fileId: number;

  @Column({ name: 'asset_name' })
  assetName: string;

  @ManyToOne(() => FileEntity, (fileEntity) => fileEntity.assets)
  @JoinColumn({ name: 'file_id' })
  file?: FileEntity;

  @OneToMany(() => AssetCategoriesEntity, (entity) => entity.asset)
  @JoinColumn({ name: 'asset_id' })
  categories: AssetCategoriesEntity[];
}

assets.model.ts

@ObjectType('Asset', {
  description: 'Asset model',
})
@UnPagedRelation('categories', () => AssetCategoriesModel, {
  nullable: true,
})
@Relation('file', () => FileModel, {
  nullable: true,
  enableLookAhead: true,
})
@InputType()
export class AssetModel {

  @IDField(() => Int)
  id!: number;

  @Field(() => Int, { nullable: true })
  fileId: number;

  @Field({ nullable: true })
  assetName: string;
}

asset-categories.entity.ts

@Entity({ name: 'asset_categories' })
export class AssetCategoriesEntity {
  @PrimaryGeneratedColumn()
  id: number;

  @Column({ name: 'asset_id' })
  assetId: number;

  @ManyToOne(
    () => AssetEntity,
    (entity) => entity.categories,
  )
  @JoinColumn([{ name: 'asset_id' }])
  asset: AssetEntity;
}

asset-categories.model.ts

@ObjectType('AssetCategories', {
  description: 'Asset Categories model',
})
export class AssetCategoriesModel {
  @IDField(() => ID)
  id!: number;
}

I can see the query for the categories actually being used:

SELECT DISTINCT `categories`.`id` AS `categories_id`, `categories`.`asset_id` AS `categories_asset_id` FROM `asset_categories` `categories` WHERE `categories`.`asset_id` IN (?)

But nothing is returned:

query {
  getAsset(
    id: 1127728
  ) {
    id
    assetName
    categories {
      __typename
      id
    }
  }
}
======
{
  "data": {
    "getAsset": {
      "id": 1127728,
      "assetName": "<asset_name>",
      "categories": []
    }
  }
}

Clearly I'm missing something; I'll happily provide more details if it would help.

Should I be making custom dataloaders for these? I just wanted to clarify before going down that path.

Any help is appreciated, even if it to point out something obvious I missed 😄

[TriPSs]

Everything looks ok, stupid questions:

1. That asset does have categories?
2. If you run the query yourself does it than return data?

And could you try removing the @JoinColumn({ name: 'asset_id' }) inside the AssetEntity, the JoinColumn should only be applied to one side of the relation.

[TriPSs]

Maybe it's related to #89, example repo would be great!

Could you maybe give this a try, just to test?

@Entity({ name: 'asset_categories' })
export class AssetCategoriesEntity {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  asset_id: number;

  @ManyToOne(() => AssetEntity)
  @JoinColumn([{ name: 'asset_id' }])
  asset: AssetEntity;
}

[abrenoch]

I'll take a look at that issue - I've tried some different values and renaming the relation but that didnt get me anywhere.

I did notice my @JoinColumn is passed an array rather than an object, which gave me a glimmer of hope that was quickly dashed away
when changing it didnt fix anything 😄.

[abrenoch]

@TriPSs here is a minimal example still producing the same issue for me: https://github.com/abrenoch/nest-query-test

Any insight or feedback is greatly appreciated!

[TriPSs]

Thanks for the repo, I have found the issue: The mapper expects all the types to be correct, your database is using bigint which causes the rawRelations to look like this:

[
  { categories_id: '1', categories_asset_id: '1' },
  { categories_id: '2', categories_asset_id: '1' }
]

As you can see all the id's are now string, if we change the big int to integer the raw relations look like this:

[
  { categories_id: 1, categories_asset_id: 1 },
  { categories_id: 2, categories_asset_id: 1 }
]

Now all the id's are numbers, which is can than correctly be mapped back to the real entities values.

So, long story short, you can disable this behaviour by setting bigNumberStrings in your TypeORM config to false.

[abrenoch]

@TriPSs My hero! Where do I send the tip?

Thanks a ton, I wouldn't have suspected a bigint would cast to a string. Makes sense now!