ApiModelProperty decorator on a ManyToOne relationship looses type on one side about swagger

[Hless]

This happens because when you have two models that depend on each other, e.g. AccesToken -> User, User -> AccesToken, one of imports will be undefined when the file first runs. In order the resolve this you need to use a function in the same way the @OneToMany / @ManyToOne decorator does it.

This illustrates the problem:

// user.entity.ts
// Reference to AccessToken class will be 'undefined' at runtime 
// because User and AccessToken depend on each other
@import { AccessToken } from "./acces-token.enitity';
class User {
    ...
    
    @ApiModelProperty({ 
        // AccessToken is undefined, therefore this type resolves to an empty object
        type: AccessToken ,  
        isArray: true 
     })
    @OneToMany(type => AccessToken, accessTokens => accessTokens.user)
    accessTokens:AccessToken[]
}

---
// access-token.entity.ts

@import { User } from "./user.entity";

class AccessToken {
    ...
    @ApiModelProperty({
        // The User import can be resolved,
        // so this will actually resolve to the User enity type
        type: User, 
     }) 
     @ManyToOne(type => User, user => user.accesTokens)
     user:User
}

A proposed fix is to wrap the related Model in a callback, the same way that @OneToMany does this. E.g.:

  ...
 @ApiModelProperty({ 
        // Using a function that returns a reference to the class fixes the issue, 
        // since the AccesToken class will be resolved when the decorator runs
        type: type => AccessToken ,  
        isArray: true 
     })
    @OneToMany(type => AccessToken, accessTokens => accessTokens.user)
    accessTokens:AccessToken[]

I already requested a merge on this pull request: #179 (labibramadhan#1)

[pokkia]

+1

[milescui]

+1 On Thu, Apr 12, 2018 at 5:46 PM, pokkia <[email protected]> wrote: +1 — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub [#63 (comment)] , or mute the thread [https://github.com/notifications/unsubscribe-auth/AALr5Ns9vOussq0ifIxH-FchEU1JOrfTks5tnyJqgaJpZM4SkyWv] .

[nodren]

this is still present in 5.0.2, also this also affects @OnetoOne type relations as well. Manually specifying a type such as @ApiModelProperty({type: MyType}) has no affect.

[muyu66]

I hope this issue can be improved.

[labibramadhan]

+1

[kamilmysliwiec]

Fixed in the next version (to install run npm i @nestjs/swagger@next). Note: remember to update @nestjs/common, @nestjs/core and typescript as well to ensure that you're using the latest versions.

Steps to migrate: #355 (comment)

[kamilmysliwiec]

4.0.0 has been published

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.