haskell/aeson

Add saner ByteString instances

Open

#187 opened on Mar 5, 2014

View on GitHub
 (22 comments) (3 reactions) (0 assignees)Haskell (1,298 stars) (334 forks)batch import
blocked by upstream/should be done externallyhelp wantedneeds decision

Description

ByteString instances were removed because they allowed people to try and insert arbitrary binary data that JSON can't handle.

Could we not re-add ByteString instances that leveraged something like base64 encoding (which JSON can take I believe) to work around this limitation?

<mgsloan> Fuuzetsu: Best thing to do is to avoid putting bytestrings in json,
          but when it's unavoidable:
          https://gist.github.com/mgsloan/bfe4bf2250c1d656a2b1  [05:03]

Contributor guide

Tech stack
None
Domain
backenddata
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
HaskellByteStringJSONbase64
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Examine the linked gist (https://gist.github.com/mgsloan/bfe4bf2250c1d656a2b1) for a previous implementation of ByteString instances using base64. Review the aeson source code, particularly the Data.Aeson.Types and Data.Aeson.Encoding modules, to understand where instances are defined and how existing types handle custom encodings. Check the issue comments for any additional constraints or rejection reasons for the prior removed instances.