Parameter feedback - #1 Server errors

[ranbena]

• Feature

Description

This is part 1 of "Parameter feedback" feature discussed in https://discuss.redash.io/t/query-parameter-validation-and-feedback/4759.

Changed parameter error feedback from server to be more descriptive and in preparation for showing error indication on parameter UI. It now provides per-parameter error messages.

One parameter empty

Before (client):

"job": {	
  "status": 4,
  "error": "missing value for param parameter.",	
}

After:

"job": {
  "status": 4,
  "error": "Parameter \"param\" is invalid.",
  "error_data": {
    "parameters": {
      "param": "Required parameter"
    }
  }
}

Two parameters empty

Before (client):

"job": {	
  "status": 4,
  "error": "missing values for param, param2 parameters.",	
}

After:

"job": {
  "status": 4,
  "error": "Parameters \"param\", \"param2\" are invalid.",
  "error_data": {
    "parameters": {
      "param": "Required parameter",
      "param2": "Required parameter"
    }
  }
}

Text parameter has numeric value

Before:

{
  "message": "The following parameter values are incompatible with their definitions: param"
}

After:

"job": {
  "status": 4,
  "error": "Parameter \"param\" is invalid.",
  "error_data": {
    "parameters": {
      "param": "Invalid value"
    }
  }
}

Text parameter has date range query tags

Before:

"job": {
  "status": 4,
  "error": "Missing parameter value for: param.start, param.end"
}

After:

"job": {
  "status": 4,
  "error": "Parameter \"param\" is invalid.",
  "error_data": {
    "parameters": {
      "param": "{{ param }} not found in query"
    }
  }
}

Data range param doesn't have expected query tags

Before:

"job": {
  "status": 4,
  "error": "Missing parameter value for: param"
}

After:

"job": {
  "status": 4,
  "error": "Parameter \"param\" is invalid.",
  "error_data": {
    "parameters": {
      "param": "{{ param.start }} not found in query"
    }
  }
}

Parameter name in schema not found in parameters

Before:

"job": {
  "status": 4,
  "error": "Missing parameter value for: param2"
}

After:

"job": {
  "status": 4,
  "error": "Parameter \"param2\" is missing.",
  "error_data": {
    "parameters": {
      "param2": "Missing parameter"
    }
  }
}

Two parameter names in schema not found in sent parameters

Before:

"job": {
  "status": 4,
  "error": "Missing parameter value for: param, param2"
}

After:

"job": {
  "status": 4,
  "error": "Parameters \"param\", \"param2\" are missing.",
  "error_data": {
    "parameters": {
      "param": "Missing parameter",
      "param2": "Missing parameter"
    }
  }
}

Parameter not in schema

Before:

{
  "message": "The following parameter values are incompatible with their definitions: param2"
}

After:

Ignored. Query continues to execution.

[ranbena]

Kept as safety but can not be reached since no-definition params are filtered out beforehand.

[ranbena]

I called it error_data but lmk if there's a standard naming convention.

[guidopetri]

@ranbena , thanks for the PR! We've updated a lot of things now that we're Community-driven so - if you're still interested in getting this merged - would you mind rebasing off master to re-run the CI, as well as updating merge conflicts?

We're trying to clean up our PR todo list, so if you're not interested, that's fine - we'll close the PR in about a week if we don't hear back. If you're interested in reopening the PR afterwards, we would also very much welcome that.

[justinclift]

This seems like another useful PR that would be good to merge. 😄