Have HTTP 4xx instead of 5xx on SQL syntax error

Open
#10,615 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
postgresql, python
Domain
api, database

Research direction

The payload names no source files, so start by reproducing: run a query with a SQL syntax error in the pgAdmin Query Tool and note the HTTP status returned (500) and the JSON body. Then find where the server converts PostgreSQL errors into HTTP responses, and check how the linked upstream issue #9872 handled similar errors. Done means a syntax error returns a 4xx status such as 400 with the same JSON body, and other server errors keep their current status.

Written by the indexing model from the issue text.

Description

Feature

Describe the solution you'd like

Hi,

I create this ticket to follow https://github.com/pgadmin-org/pgadmin4/issues/9872, I'm in case of a corporate IT infra where proxy security cannot be changed and this last replace JSON body response for request whose response code is HTTP 5xx by a proxy specific response.
The security reason is to avoid potentiel technical leak from backend.
In addition in a Rest API design, it is not semantically correct to have a HTTP 500 when pgadmin user enter an incorrect SQL request, a HTTP 400 Bad Request should be more appropriate.

Describe alternatives you've considered

The alternative should be to have pgadmin server answer HTTP 400 Bad Request code and pgadmin webapp interpret JSON as before.

Dominant language
Python
Stars
3.9k
Forks
922
Avg merge
2d 3h
Merged PRs (30d)
33

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pgadmin-org/pgadmin4

All issues in pgadmin-org/pgadmin4

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.