GraphQL API change failed due to blank comment

[kylekirkby]

Before opening, please confirm:

• I have installed the latest version of the Amplify CLI (see above), and confirmed that the issue still persists.
• I have searched for duplicate or closed issues.
• I have read the guide for submitting bug reports.
• I have done my best to include a minimal, self-contained set of instructions for consistently reproducing the issue.

How did you install the Amplify CLI?

npm

If applicable, what version of Node.js are you using?

15.7

Amplify CLI Version

5.0.1

What operating system are you using?

Windows 10 / Ubuntu 20.04 WSL

Amplify Categories

api

Amplify Commands

push

Describe the bug

I'd recently made some updates to my schema.graphql file but failed to fill in a comment for a field. E.g

	"""
	"""
	videoId: String
	"""
	An array of S3 UrLs
	"""
	publications: [String] @function(name: "getPublicationSignedUrl-${env}")

Running amplify api gql-compile returned a succesful compilation, but upon pushing the changes, the stack failed in Cloudformation with:

Reason: Schema Creation Status is FAILED with details: Failed to parse schema document - ensure it's a valid SDL-formatted document.

Updating the schema.graphql file with a valid comment fixed the issue.

Expected behavior

Validate for blank comments on compilation of the GraphQL schema.

Reproduction steps

1. Create a schema with a blank comment above a field.
2. Run amplify api gql-compile to check the schema is valid (which it isn't according to AppSync.
3. Try to push the changes
4. See that the push fails
5. Add a comment
6. Push again and see that it pushes the changes succesfully.

GraphQL schema(s)

# Put schemas below this line

Log output

# Put your logs below this line

Additional information

No response

[josefaidt]

Hey @kylekirkby 👋 thanks for raising this! I was able to successfully reproduce with the steps provided, and I agree that the validation could be executed during amplify api gql-compile to prevent unsuccessful push attempts.

Sample GraphQL schema used for reproduction:

type Todo @model {
  """

  """
  id: ID!
  """
  name the todo
  """
  name: String!
  """
  describe the todo
  """
  description: String
}

[josefaidt]

Hey @kylekirkby after further review this appears to be better suited as a feature-request for the validation. Please note GraphQL descriptions have an active issue in the AppSync community and another, relevant issue in this repo for GraphQL comments and descriptions.

\cc @renebrandel for bug triage visibility

[mgarabedian]

@kylekirkby Thanks for logging this, I came across this earlier and had spent a good amount of time trying to understand why my schema deployment was failing ( with a non-helpful Cloudformation error ). Blank comment was the issue. Hopefully it can be patched.

[renebrandel]

I'm closing this from the Amplify end as the tracking ticket as this requires changes on the AppSync service. (Tracked in the ticket above)