Work around an APIB parser bug (multipart/form-data) #177
Conversation
This was previously a core part of Dredd. It belongs to Dredd Transactions though as it's a format-specific bug fix. Ideally, Dredd shouldn't need to know anything about the specifics of formats, Dredd Transactions should provide a uniform interface. apiaryio/api-blueprint#401
There was a problem hiding this comment.
This makes sense to me, but I am not sure it is API Blueprint specific. If a user was to manually specify a multipart example in Swagger 2 similar to in API Blueprint I bet it won't also contain \r unless the user was really careful about adding \r on this specific lines (providing YAML parser doesn't just eat them).
That said, most users will be leaving \r out so I expect if you define manual multipart response example you'd hit the same problem.
src/compile.js
Outdated
| if (mediaType === 'text/vnd.apiblueprint') { | ||
| // Fixing 'multipart/form-data' bodies coming from the API Blueprint | ||
| // parser: https://github.com/apiaryio/api-blueprint/issues/401 | ||
| [].concat(...transactions.map(t => [t.request, t.response])) |
There was a problem hiding this comment.
Could be simpler using flat (or maybe even using reduce).
transactions
.map(t => [t.request, t.response])
.flat()
.filter(isMultipart)
.forEach...There was a problem hiding this comment.
Yes! Looks much better. I forgot about flat(). In my new commit I removed this part completely though.
|
@kylef Those are great points! I reworked the solution. I used it for Swagger as well and I promoted it from "hack at the end of the file" to an integral part of the compilation process. Let me know what you think. |
Work around apiaryio/api-blueprint#401. This was previously a core part of Dredd. It belongs to Dredd Transactions though as it's a format-specific bug fix. Ideally, Dredd shouldn't need to know anything about the specifics of formats, Dredd Transactions should provide a uniform interface.
This allows better refactoring of the HTTP client infrastructure in apiaryio/dredd#1094.