stream spec

[nichoth]

Thanks everyone for working on pull streams. It's a cool pattern. There are some details to being a proper source or sink, a "contract" that each follows. Is there a re-usable test suite that any source or sink should pass? I might make one. Maybe it is not useful or possible.

[ahdinosaur]

hey @nichoth, yeah i reckon a re-usable test suite (kinda like abstract-leveldown, abstract-blob-store, interface-pull-blob-store, etc) would be awesome! was actually mentioned in passing a few days ago: pull-stream/pull-file#4 (comment).

[dominictarr]

@nichoth that would be a very valuable contribution!

I made one of those for classic streams, https://github.com/dominictarr/stream-spec
and it totally helped me understand everything about how they worked.

A reusable test suit might be difficult, since there are so many ways to use pull-streams,
but it might be very useful to have a validator stream, that say, wrapped a stream, and checked thinks like, no calls out of turn, never callback twice, etc. With this approach you still need to write test cases, though, but it would help. Also, you could drop it into production code, when you suspect something isn't working right.

[nichoth]

I've started something here. It's pretty new code, just to get started, but everyone feel free to use or patch as you like. https://github.com/nichoth/pull-stream-spec