ksf-media / haskell-vcr Goto Github PK

As more functionality and integrations are added the dependency footprint and scope of library grows. Originally Data.Vcr module was supposed to only contain data definitions, json encode/decoder and some helpers. But now it also integrates with http-client. My plan is to rename this repo to haskell-vcr and split the big module into several modules/libraries with different dependencies. The Data.Vcr will remain the core module containing data definitions, while the integrations would go to their own modules:

• data-vcr: Data.Vcr
• http-client-vcr: Network.HTTP.Client.Vcr
• tasty-vcr: Tasty.Vcr
• req-vcr: Network.HTTP.Req.Vcr

This is pretty urgent, as right now we have to have them as git dependencies in stack.yaml in every project.

Currently, as soon as withCassette finishes it dumps the accumulated cassettes to it's FilePath. This of course means that if several threads are recording to cassette which should be on the same path they'll overwrite each other. This is a common scenario as tests are often run in parallel.

• Regardless of the solution, the thing should be more paranoid and error out if somebody have touched the file while it was running and it doesn't know hot to handle it.
• If several recorders are writing to the same cassette those interactions should be merged together. This can be done either when
  • we save the cassette, by noticing that somebody have written to the file after we have started, reading that file and merging with it; or when
  • we add new recordings, by sharing the cassette for multiple threads if they are binded to the same path

Most request/response conversions are now implemented. Converting to Http.Request is only needed for replays and I haven't implemented it yet.

See TODOs here

• Always
• Once
• NewEpisodes
• All

Canonical behaviors are documented here

A tasty ingredient that allows to configure VCR with command line options would have been lovely to have.

Given http-reverse-proxy it should be relatively easy to make a VCR-on-the-wire thing.

For the mainstream discussion see vcr/vcr#187