Record & replay binary file response correctly

[gr2m]

The way nock currently implements the loading of previously recorded fixtures does not support proper binary responses, as nock cannot differentiate between a binary file encoded as hex string and a simple string. To work around that I've added a new flag to fixtures (nockDef): responseIsBinary.

I could not find a better workaround for it, but this works.

closes #1021, closes #1001, closes #524

[gr2m]

@n30n0v could you have a look at this? Any thoughts?

I wish I could avoid the addition of the new flag but I don’t see a way around it

[gr2m]

An alternatively could be to prefix the hex-encoded string with something like binary: and then check for that instead of the additional responseIsBinary flag. Maybe that's more elegant?

I also realised that this is only testing the response case, not the request case, I'll extend the test & implementation to cover a binary file upload, too

[gr2m]

I've updated the test to also record a binary upload but that seems to work just fine without any extra handling

I'll squash the PR commits once it's good to merge

[gr2m]

Okay this is ready for review. @n30n0v @ierceg

In summary, nock recorder now adds a responseIsBinary flag to fixture definitions, besides scope, method, path, status, etc. It is only set to true if the response string (which is hex encoded) is a binary buffer, it is not set to false otherwise.

The only alternative I can think of is to prefix the hex string value of body with something like binary: or NOCKBINARYHEX:

[simlu]

I'm super exited about this pr! Thank you!

[gr2m]

Thanks for the review @simlu 👍

I’ll move forward and merge that in

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue and add a reference to this one if it’s related. Thank you!