graphql-engine icon indicating copy to clipboard operation
graphql-engine copied to clipboard

docs: update troubleshooting guide with errors

Open marionschleifer opened this issue 5 years ago • 12 comments

We need to document Hasura error messages in docs, e.g. in what cases Hasura fails to start.

Call for action: If you receive any errors while working with Hasura, please add a comment here 🙂

marionschleifer avatar Sep 12 '19 13:09 marionschleifer

Ref: https://github.com/hasura/graphql-engine/issues/2135

marionschleifer avatar Sep 12 '19 13:09 marionschleifer

https://discordapp.com/channels/407792526867693568/428469959530643466/621396081447796736

marionschleifer avatar Sep 12 '19 13:09 marionschleifer

I would like to help with documentation.

Big-Zude avatar Oct 01 '19 08:10 Big-Zude

@Big-Zude cool 🙂 feel free to start working on this or any other documentation issue: https://github.com/hasura/graphql-engine/issues?q=is%3Aopen+is%3Aissue+label%3Ac%2Fdocs+label%3A%22help+wanted%22.

marionschleifer avatar Oct 01 '19 09:10 marionschleifer

@marionschleifer I would love to help on this. But could you link me to the error which have not been documented till now. I am not able to find them.

Thanks!

sameshl avatar Oct 01 '19 10:10 sameshl

@sameshl these errors are not yet documented. The thing that would probably help the most would be to play around with Hasura, and if you come across any errors that are not yet on the troubleshooting page, add them 🙂

marionschleifer avatar Oct 01 '19 20:10 marionschleifer

Hey, not sure this qualifies, but I've included a snapshot of an error I came across. The error message seems to be,

Not-NULL violation. null value in column "created_at" violates not-null constraint

Screenshot from 2019-10-29 17-31-26

choilmto avatar Oct 29 '19 21:10 choilmto

Here's my comment in the older issue requesting documentation ~2 years ago that was closed in favor of this issue:

Has there been any progress on this ~1.5 years later? Even just posting a CSV of the values in errors[i].extensions.code would be helpful at this point. https://github.com/hasura/graphql-engine/issues/1738#issuecomment-694478009

I first recommend just releasing documentation on what the errors are. A "troubleshooting guide" can come down the road for less advanced developers. Right now we have no idea what errors will be returned from Hasura until we encounter them, or we waste time poking & prodding the black box trying to encounter the different errors in order to handle them.

jasonferrier avatar Dec 08 '20 18:12 jasonferrier

Maybe it's not the full list and certainly not documentation, but it could be a good start: https://github.com/hasura/graphql-engine/blob/master/server/src-lib/Hasura/RQL/Types/Error.hs#L120

EDIT: https://github.com/hasura/graphql-engine/blob/master/server/src-lib/Hasura/Base/Error.hs#L119

janosroden avatar May 06 '21 07:05 janosroden

Hey team - any updates on when we can expect an exhaustive list of error codes and when they would occur?

nayeemzen avatar Feb 02 '23 15:02 nayeemzen

@nayeemzen thank you for following up with this. It's in our backlog but not an immediate priority. But we will definitely pick it up in the next few months.

marionschleifer avatar Feb 07 '23 14:02 marionschleifer

#434

Gunjan-Rajput avatar Apr 03 '24 06:04 Gunjan-Rajput