JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Convert database constraint errors to validation errors

Open
#1,309 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
Ruby
Stars
2.3k
Forks
546
PR merge metrics
No merged PRs in 30d

Description

This issue is a (choose one):

  • Problem/bug report.
  • Feature request.
  • Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.

Checklist before submitting:

  • I've searched for an existing issue.
  • I've asked my question on Gitter and have not received a satisfactory answer.
  • I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
  • The feature I'm asking for is compliant with the JSON:API spec.

Description

Currently, when an error comes from the database, the only way to handle it is to use on_server_error :first_callback. This is not easy to use when we are only talking about invalid attributes.

Features:

Sometimes, db constraints are more efficient that validation. Then why not transform database constraint error into validation error.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by tracing the existing on_server_error :first_callback path and how database errors are currently surfaced by the Rails library. Determine which database constraint errors should become validation errors and what the resulting JSON:API error behavior should be; done means the behavior is defined and covered by the relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, backend, databases
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.