JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
BUG: malformed includes raises NoMethodError
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.3k
- Forks
- 546
- PR merge metrics
- No merged PRs in 30d
Description
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:
The CSV gem raises a NoMethodError when passed an array
e.g. CSV.parse_line(["memberships"]) raises
private method `gets' called for ["memberships"]:Array
And JR in 0.9.x and 0.10.x in a few places uses CSV.parse_line but only rescues CSV::MalformedCSVError
making a request like v1/users/:id?include[]=memberships with call e.g. JSONAPI::RequestParser#parse_include_directives with ["memberships"] and raise an unhandled error.
My proposal is 1) encapsulate wherever CSV.parse_line is called and 2) ensure any errors are handled and raises as JSONAPI::Exceptions
I could possibly make PRs to 0.9 and 0.10
(We're still on 0.9 due to bugs changes in handling of polymorphic types and plain old resources, but I'd like to help however I can)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at JSONAPI::RequestParser#parse_include_directives and trace the places where CSV.parse_line is called in the 0.9 and 0.10 code paths. Reproduce the array input from include[]=memberships, then verify malformed input no longer raises an unhandled NoMethodError and is surfaced as a JSONAPI::Exceptions error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100