graphql-code-generator: Docblocks disappeared in versions ^1.10.0

any update on this? I think we have a pretty solid repro here ⬆️

@ardatan https://codesandbox.io/s/solitary-butterfly-yhmfn

in index.js:

const typeDefs = gql`
  """
  All our queries
  """
  type Query {
    "Hello description"
    hello: String
  }
`;

./codegen.yml

overwrite: true
schema: ${GRAPHQL_URL:http://0.0.0.0:4000/}
generates:
  ./graphql.schema.json:
    plugins:
      - introspection
  ./graphql.types.ts:
    plugins:
      - typescript

diff between 1.9.1 and 1.12.1:

./graphql.types.ts

@@ -6,19 +6,15 @@
   Boolean: boolean,
   Int: number,
   Float: number,
-  /** The `Upload` scalar type represents a file upload. */
   Upload: any,
 };

-
 export enum CacheControlScope {
   Public = 'PUBLIC',
   Private = 'PRIVATE'
 }

-/** All our queries */
 export type Query = {
    __typename?: 'Query',
-  /** Hello description */
   hello?: Maybe<Scalars['String']>,
 };

./graphql.schema.json

@@ -9,11 +9,11 @@
       {
         "kind": "OBJECT",
         "name": "Query",
-        "description": "All our queries",
+        "description": "",
         "fields": [
           {
             "name": "hello",
-            "description": "Hello description",
+            "description": "",
             "args": [],
             "type": {
               "kind": "SCALAR",
@@ -871,17 +871,7 @@
       {
         "kind": "SCALAR",
         "name": "Upload",
-        "description": "The `Upload` scalar type represents a file upload.",
-        "fields": null,
-        "inputFields": null,
-        "interfaces": null,
-        "enumValues": null,
-        "possibleTypes": null
-      },
-      {
-        "kind": "SCALAR",
-        "name": "Int",
-        "description": "The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.",
+        "description": null,
         "fields": null,
         "inputFields": null,
         "interfaces": null,
@@ -891,37 +881,6 @@
     ],
     "directives": [
       {
-        "name": "cacheControl",
-        "description": "",
-        "locations": [
-          "FIELD_DEFINITION",
-          "OBJECT",
-          "INTERFACE"
-        ],
-        "args": [
-          {
-            "name": "maxAge",
-            "description": "",
-            "type": {
-              "kind": "SCALAR",
-              "name": "Int",
-              "ofType": null
-            },
-            "defaultValue": null
-          },
-          {
-            "name": "scope",
-            "description": "",
-            "type": {
-              "kind": "ENUM",
-              "name": "CacheControlScope",
-              "ofType": null
-            },
-            "defaultValue": null
-          }
-        ]
-      },
-      {
         "name": "skip",
         "description": "Directs the executor to skip this field or fragment when the `if` argument is true.",
         "locations": [

Fixed in v1.13.2

@dotansimha I tried it. The generated schema has documentations now. Thanks!

The GraphQL framework I’m using comes with a way to dump the schema to JSON. When I run the codegen against that JSON file, I get docblocks. When I run the codegen against a URL, I don’t get docblocks.

This indicates that maybe there is a problem with the introspection query that is being sent to the server? This is the query that is being run when I dump the schema to JSON: https://github.com/absinthe-graphql/absinthe/blob/v1.4.16/priv/graphql/introspection.graphql.

https://github.com/ardatan/graphql-toolkit/blob/master/packages/loaders/url/tests/url-loader.spec.ts We have tests for URL endpoint as well. It has descriptions and a custom schema declaration to be specific.

I’d love to, but I am swamped at the moment… I can share my codegen config file, if that’s of any help:

overwrite: true
schema: ${GRAPHQL_URL:http://micro.test/api/graphql}
config:
  namingConvention:
    enumValues: change-case#upperCase
generates:
  ./graphql.schema.json:
    plugins:
      - introspection
  packages/common/gen/graphql.fragments.json:
    plugins:
      - fragment-matcher
  packages/common/src/service.graphql.ts:
    plugins:
      - typescript
hooks:
  afterOneFileWrite:
    - prettier --write

And I have comments attached to my fields in my schema e.g.

type User {
  "Some description for the field"
  something: Boolean
}

Descriptions are missing from both graphql.schema.json (as “description” property of an entity) and service.graphql.ts (as docblock comments, as @toverux reported in the first post):

          {
            "name": "something",
            // in 1.9.1: "description": "Some description for the field",
            "description": "",
            "args": [],
            "type": { (...) },
            "isDeprecated": false,
            "deprecationReason": null
          },

It seems that “descriptions” are not being retrieved properly from an url endpoint. The last version I had this working was 1.9.1, so I am staying on that for the time being.