Plugin doesn't not infer type properly on Watching for file changes (running nest start --watch) (typescript 5)

[msimon]

Is there an existing issue for this?

• I have searched the existing issues

Current behavior

We noticed the issue when updating to typescript 5 and updating all our nestJs packages.

Having the plugin set in ./nest-cli.json

{
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "plugins": [
      {
        "name": "@nestjs/graphql",
        "options": {
          "introspectComments": true
        }
      }
    ]
  }
}

And given a class like:

@Table
@ObjectType()
export class User extends BaseModel {
  ...

  @Column
  firstName?: string;

  @Column
  lastName?: string;

  @Unique
  @Column
  email?: string;

  @HideField()
  @HasMany(() => Availability)
  availability: Availability[];

  // @Column
  // email2?: string;
}

And another class like:

@ObjectType()
export class TokenResponse {
  constructor(accessToken: string, refreshToken: string, user: User) {
    this.accessToken = accessToken;
    this.refreshToken = refreshToken;
    this.user = user;
  }

  accessToken: string;
  refreshToken: string;
  user: User;
}

Running nest start --watch first. No issues. schema.graphql

Modifying any field in the user object, e.g: uncomment the email2 => raise the following issue:

Error SchemaGenerationError: Schema generation error (code-first approach)
   ....
   details: [
    GraphQLError: Type TokenResponse must define one or more fields.
   .... {
      path: undefined,
      locations: undefined,
      extensions: [Object: null prototype] {}
    }
  ]

What's happening is that the plugin is not inferring @Field on any variable in the Token class.

I dug a bit into what's generating and after the update on the user, the dist/token/token.entity.js has the following:

static _GRAPHQL_METADATA_FACTORY() {
        return {};
    }

instead of:

    static _GRAPHQL_METADATA_FACTORY() {
        return { accessToken: { type: () => String }, refreshToken: { type: () => String }, user: { type: () => require("../user/user.entity").User } };
    }

I tried to figure out if there was something up around:

graphql/packages/graphql/lib/plugin/visitors/model-class.visitor.ts

Line 253 in fb8a582

private updateClassDeclaration(

But I ran out of time before I get anything concrete

Minimum reproduction code

https://github.com/HeroJourneyClub/nestjs_graphql_gen_error

Steps to reproduce

1. yarn install
2. yarn start:dev
3. Edit nest_graphql_gen/src/user/user.entity.ts > Uncomment email2 code & save
4. The above error will be displayed.

Expected behavior

@field is inferred properly and no error is raised

Package version

11.0.4

Graphql version

graphql: 16.6.0
apollo-server-express: N/A
apollo-server-fastify: N/A

NestJS version

9.3.12

Node.js version

v16.14.0

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

Only noticed this issue after upgrading to Typescript 5 and upgrading all our Nestjs package.

rm -rf dist, then rebuild infer the @field properly, so it seems to be on update.
Any file that does not go through:

graphql/packages/graphql/lib/plugin/compiler-plugin.ts

Line 15 in fb8a582

return typeClassVisitor.visit(sf, ctx, program, options);

will be having an incorrect _GRAPHQL_METADATA_FACTORY in the generated JS

[nicohaenggi]

Running into the same issue, the issue occurs due to the introspectComments being enabled.

The underlying issue seems to be the following line [1], where jsDoc[0] is undefined whenever there are no comments for a specific property, thus throwing an exception. Just replacing jsDoc[0].comment with jsDoc[0]?.comment will resolve the issue.

[1]

graphql/packages/graphql/lib/plugin/utils/ast-utils.ts

Line 198 in 8a19a75

return getTextOfJSDocComment(jsDoc[0].comment);

[msimon]

@nicohaenggi Thanks!

I can confirm the code shared by @nicohaenggi is fixing the issue. I'll do a PR.

[kamilmysliwiec]

Let's track this here #2809