JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

aborted destroy turned into JSONAPI::Exceptions::ValidationErrors without error message

Offen
#1,253 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Ruby
Sterne
2.3k
Forks
546
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Choose one section below and delete the other:

Bug reports:

JR version 0.9.3

  1. Given a record with before_destroy :something_that_may_abort
  2. Define def something_that_may_abort; throw :abort if condition?; end
  3. POST a DELETE by id to the corresponding resource
  4. Get
    NoMethodError: undefined method `code' for nil:NilClass

The problem stems from the JR processor

    def process
      run_callbacks :operation do
        run_callbacks operation_type do
          @result = send(operation_type)
        end
      end

    rescue JSONAPI::Exceptions::Error => e
      @result = JSONAPI::ErrorsOperationResult.new(e.errors[0].code, e.errors)
    end

Where the rescued JSONAPI::Exceptions::Error is a JSONAPI::Exceptions::ValidationErrors and the error_messages attribute is an empty hash. This can be observed in Rails code as

record.destroy
=> false
 record.errors.messages
=> {}

I suspect this isn't an altogether unusual case. Until this is addressed in JR, I'm looking at handling this by adding validation errors to the model before throwing the abort

Proposal

I wonder if there may be a place in JR to add a default validation error message to JSONAPI::Exceptions::ValidationErrors when none are given (i.e. when resource.model_error_messages is empty

https://github.com/cerebris/jsonapi-resources/blob/v0.9.7/lib/jsonapi/resource.rb#L224-L231

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der process-Methode des JR-Prozessors und lib/jsonapi/resource.rb ungefähr in den Zeilen 224-231, die der Issue als mit Fehlermeldungen des Models zusammenhängend identifiziert. Reproduziere einen Rails-Destroy-Callback, der :abort auslöst, und verfolge dann, wie leere Fehler ValidationErrors erreichen. Erledigt ist die Aufgabe, wenn der abgebrochene Destroy eine verwendbare Validierungsfehlermeldung erzeugt, statt des durch einen fehlenden Code verursachten NoMethodError.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rails, ruby
Bereich
api, backend
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.