Strange formatting of input types with descriptions

Question

Strange formatting of input types with descriptions

nightroman opened this issue a year ago · 16 comments

If an input type has field descriptions then formatting produces unexpected extra new lines and extra indentation of fields.

Please find attached the project for reproducing the issue.
TryGraphQLParser.zip

Test1

No issues for type types:

dotnet run -- x1-type.graphql

input x1-type.graphql contains a type with fields with descriptions.
output x1-type.graphql.output.graphql is formatted as expected.

Test2

Formatting issues with input with descriptions:

dotnet run -- x2-input.graphql

input x2-input.graphql contains an input with fields with descriptions.
output x2-input.graphql.output.graphql shows unexpected new lines and extra indentations.

Test3

No issues with input without descriptions:

dotnet run -- x3-input.graphql

input x3-input.graphql contains an input with no descriptions.
output x3-input.graphql.output.graphql is formatted as expected.

Answer 1 · 2023-01-21T07:58:03.000Z

Example input:

"A component contains the parametric details of a PCB part."
input DesComponentFilterInput {
    and: [DesComponentFilterInput!]
    or: [DesComponentFilterInput!]
    "The library label for this component."
    name: StringOperationFilterInput
    "The additional information for this component."
    comment: StringOperationFilterInput
    "The summary of function or other performance details for this component."
    description: StringOperationFilterInput
    "The component revision."
    revision: DesRevisionFilterInput
}

Example result with unexpected new lines and indentations:

"A component contains the parametric details of a PCB part."
input DesComponentFilterInput {
  and: [DesComponentFilterInput!]
  or: [DesComponentFilterInput!]

  "The library label for this component."
    name: StringOperationFilterInput

  "The additional information for this component."
    comment: StringOperationFilterInput

  "The summary of function or other performance details for this component."
    description: StringOperationFilterInput

  "The component revision."
    revision: DesRevisionFilterInput
}

Answer 2 · 2023-01-21T08:43:05.000Z

Indeed, I struggled with indentation (both horizontal and vertical) a lot when I rewrote the parser a long time ago. I will try to look at this problem today, but for now I am away from my home PC.

Answer 3 · 2023-01-24T15:51:03.000Z

OK. I reproduced this and I have an idea how to fix this. It requires some internal redesign of AST printing.

Answer 4 · 2023-02-26T01:42:04.000Z

@sungam3r Any progress? No pressure, just wondering when to expect the improvement, approximately.

Answer 5 · 2023-03-01T21:02:56.000Z

Nope. I can’t say when it will be ready. I remember this task. Recently I have been littered with household chores.

Answer 6 · 2023-04-16T22:03:52.000Z

I want to return to this task in the near future after I finish the adjacent changes in v8.2/v8.3.

Answer 7 · 2023-04-18T16:36:11.000Z

In process. There is some progress. I need to delicately tune practically each method of parser.

Answer 8 · 2023-04-18T16:52:28.000Z

@sungam3r Thank you for the good news, cannot wait to try it out!

Answer 9 · 2023-04-19T16:42:04.000Z

Fixed in #304 but I'm sure there are more issues to fix internally.

Answer 10 · 2023-04-20T09:20:41.000Z

@sungam3r Thank you! Will the nuget package be updated soon?

Answer 11 · 2023-04-20T10:22:58.000Z

Today or tomorrow.

Answer 12 · 2023-04-20T23:35:06.000Z

https://www.nuget.org/packages/GraphQL-Parser/9.0.1

Answer 13 · 2023-04-21T04:44:23.000Z

@sungam3r Thank you.
Input type formatting is fixed, great!

There is a regression though (I think).
We lost indentation of field/query parameters in object types.

Example before (normal indentation)

type Query {
  "Fetches an object given its ID."
  node(
    "ID of the object."
    id: ID!): Node
  "Lookup nodes by a list of IDs."
  nodes(
    "The list of node IDs."
    ids: [ID!]!): [Node]!
  "Search for workspaces associated with this account."
  desWorkspaces(where: DesWorkspaceFilterInput): [DesWorkspace!]!
  "Search a specific workspace by its unique identifier."
  desWorkspaceById(
    "The node identifier for a workspace."
    id: ID!): DesWorkspace

Example now (no indentation)

type Query {
  "Fetches an object given its ID."
  node(
  "ID of the object."
  id: ID!): Node
  "Lookup nodes by a list of IDs."
  nodes(
  "The list of node IDs."
  ids: [ID!]!): [Node]!
  "Search for workspaces associated with this account."
  desWorkspaces(where: DesWorkspaceFilterInput): [DesWorkspace!]!
  "Search a specific workspace by its unique identifier."
  desWorkspaceById(
  "The node identifier for a workspace."
  id: ID!): DesWorkspace

Should I submit another issue or this comment is enough for an action?

Answer 14 · 2023-04-21T05:25:40.000Z

Submit, please, in parser repo.

Answer 15 · 2023-04-21T05:27:00.000Z

With new design of indentation it should not take much time to fix.

Answer 16 · 2023-04-21T06:01:56.000Z

Here is the new issue -- #311