haskell/aeson

JSON parsing with accumulative errors

Open

#578 opened on 2017年8月24日

GitHub で見る
 (8 comments) (1 reaction) (0 assignees)Haskell (1,298 stars) (334 forks)batch import
help wanted

説明

When parsing an incorrect JSON with Aeson, you only get the first error instead of all the errors like so:

Data.Aeson> eitherDecode "[1,19,\"a\", 20]" :: Either String [Text]
Left "Error in $[0]: expected Text, encountered Number"

It would be better to have another function to return all the errors instead of just the first one, for example:

Data.Aeson> eitherDecode "[1,19,\"a\", 20]" :: Either [(String, String)] [Text]
Left [("$[0]", "Expected Text, encountered Number"), ("$[1]", "Expected Text, encountered Number"), ("$[3]", "Expected Text, encountered Number")]

This kind of feature would be very useful in web development where errors in request payload are all checked at once to save network round trip.

I'm thinking maybe this library can be used instead of Either https://hackage.haskell.org/package/Validation-0.2.0/docs/Data-Validation.html

コントリビューターガイド

技術スタック
なし
領域
backenddeveloper experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Haskell programmingAeson libraryJSON parsing
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50
調査方針
Investigate the current error handling in Aeson's parser, likely in Data/Aeson/Types.hs or Data/Aeson/Parser.hs. Review the issue comments for additional discussion on implementation approach. Consider using a Validation type to accumulate errors as suggested in the issue. Look at existing functions like 'eitherDecode' and 'eitherDecodeWith' to understand the current error reporting mechanism.