haskell/aeson

Add saner ByteString instances

Open

#187 opened on Mar 5, 2014

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

Repository metrics

Stars
 (1,298 stars)
PR merge metrics
 (Avg merge 935d 9h) (5 merged PRs in 30d)

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

Research direction
Study the commit that removed ByteString instances, understand the base64 encoding approach in the linked gist, and implement new instances for ByteString that encode via base64.
Tech stack
None
Domain
backend
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HaskellGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70