finagle/finch

Better errors for missing/wrong JSON properties

Offen

#264 geöffnet am 06.05.2015

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (1 Reaktion) (1 zugewiesene Person)Scala (218 Forks)batch import
featurehacktoberfestready

Repository-Metriken

Stars
 (1.594 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

It would be nice if we could better understand what's wrong with an incoming JSON body and throw a reasonable error about it. For now, we throw NotParsed(BodyItem, ....). Would be nice if we could promote BodyItem to a case class BodyItem(name: String) and wrap missing/wrongly decoded properties in it.

This is only about the cases when JSON is decoded directly to a case class: body.as[User]. I believe, end users should handle this manually (with custom exceptions like NotFoundJsonProperty) when dealing with raw JSON types directly: body.as[Json] and then parsing them with AST API provided by a JSON library.

See discussion in #261 started by @lderks.

Contributor Guide

Research-Richtung
Untersuchen Sie, wie body.as[User] funktioniert und identifizieren Sie, wo Fehlermeldungen generiert werden. Implementieren Sie dann einen besseren Fehler, der den fehlenden oder falschen Eigenschaftsnamen enthält.
Tech Stack
scala
Domain
backend api design
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Scala
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40