Add Error Message for Explain and Run

[davidcui1225]

Issue #, if available:
#863
Description of changes:

• Added a generic error message in Explain for invalid queries. The error message consists of <API Response>: this query is not explainable.
• Added this query is not runnable to error messages for Run on invalid queries.

Invalid Explain on SQL:

Invalid Explain on PPL:

Invalid Run on SQL:

Invalid Run on PPL:

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[joshuali925]

LGTM

[codecov]

Codecov Report

Merging #872 (8240742) into develop (370ff6d) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             develop     #872   +/-   ##
==========================================
  Coverage      99.85%   99.85%           
  Complexity      2132     2132           
==========================================
  Files            215      215           
  Lines           4774     4774           
  Branches         313      313           
==========================================
  Hits            4767     4767           
  Misses             5        5           
  Partials           2        2           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 370ff6d...8240742. Read the comment docs.

[dai-chen]

Is there any chance to add UT for this change?

For Run error message, it would be more helpful to show the "reason" or "details" in message from backend if "status"=400.

[davidcui1225]

Is there any chance to add UT for this change?

For Run error message, it would be more helpful to show the "reason" or "details" in message from backend if "status"=400.

Do you mean display the response code in the output as well? Also I can try to add some UTs to check output matching on invalid queries/Explain

[dai-chen]

Is there any chance to add UT for this change?
For Run error message, it would be more helpful to show the "reason" or "details" in message from backend if "status"=400.

Do you mean display the response code in the output as well? Also I can try to add some UTs to check output matching on invalid queries/Explain

I meant when the "status" as below is 400, the words in "reason" or "details" would help user figure out why:

{
  "error": {
    "reason": "Invalid SQL query",
    "details": "Failed to parse query due to offending symbol [60] at: '\n         SELECT ((YEAR(DATE_ADD(FROM_DAYS(FLOOR(NULL) + 693961), INTERVAL 60' <--- HERE... More details: Expecting tokens in {'SELECT', '('}",
    "type": "SyntaxAnalysisException"
  },
  "status": 400
}

[davidcui1225]

Added more detailed error output for Run on invalid queries to include API response.

SQL example:

PPL example:

[chloe-zh]

Added more detailed error output for Run on invalid queries to include API response.

SQL example:

PPL example:

This looks good enough, but I wonder would it be better if the error reason, detail, type and status are parsed and displayed into a paragraph than put the raw exception to the console log, since the output panel looks not a json style but only a plain text box. For example:

SHOW TABLES LIKE: Bad request, this query is not explainable.

reason: "Invalid SQL query"
details: "Expected syntax example: 'SHOW TABLES LIKE <table pattern>'"
type: "IllegalArgumentException"
status: 400

[davidcui1225]

Added more detailed error output for Run on invalid queries to include API response.
SQL example:

PPL example:

This looks good enough, but I wonder would it be better if the error reason, detail, type and status are parsed and displayed into a paragraph than put the raw exception to the console log, since the output panel looks not a json style but only a plain text box. For example:

SHOW TABLES LIKE: Bad request, this query is not explainable.

reason: "Invalid SQL query"
details: "Expected syntax example: 'SHOW TABLES LIKE <table pattern>'"
type: "IllegalArgumentException"
status: 400

I like this idea, will add that

[chloe-zh]

LGTM, thanks for the changes!