purescript-deprecated / purescript-node-streams-aff Goto Github PK

I think I made a mistake designing the API for this package and I regret it.

The reading functions all return type Tuple (Array Buffer) Boolean. Instead they should return type {buffers:: Array Buffer, readagain :: Boolean}.

I don't know if it's worth a breaking change for an aesthetic mistake.

A lot of the necessary features in the Internal module will soon be available available in Node.Stream.

https://discourse.purescript.org/t/rfc-eventemitter-bindings-and-http2-bindings/3584

https://github.com/purescript-node/purescript-node-streams/blob/update-ffi-build-on-node-event-emitters/src/Node/Stream.purs#L110-L144

https://github.com/jamesdbrock/purescript-node-streams-aff/blob/96810fdfcb4b2a8e8adf1e11b7ebb7a773953838/src/Node/Stream/Aff.purs#L381

(node:130773) MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 
11 error listeners added to [Socket].
Use emitter.setMaxListeners() to increase limit

When I run the purescript-protobuf conformance test.

nodejs/node#6379

readLine :: forall m r. MonadAff m => Readable r -> m { buffers :: Array Buffer, readagain :: Boolean }

Could we use https://nodejs.org/api/readline.html ?

Instances of the InterfaceConstructor class are constructed using the readlinePromises.createInterface() or readline.createInterface() method. Every instance is associated with a single input Readable stream and a single output Writable stream. The output stream is used to print prompts for user input that arrives on, and is read from, the input stream.

The problem with this is that it requires a Writable stream “used to print prompts”? That seems stupid and I don’t want to require a Writable stream in our API.

If the InterfaceConstructor was created with output set to null or undefined the prompt is not written.

Ok so maybe we just readline.createInterface with a null Writable every time the readLine function is called, handle the 'line' event, and then destroy the interface when the readLine function completes.

The canceller stuff is all wrong. I understand how the cancellers are supposed to work now: When we receive Aff cancel event, we should cancel the onData, onDrain, et cetera.

https://github.com/jamesdbrock/purescript-node-streams-aff/blob/96810fdfcb4b2a8e8adf1e11b7ebb7a773953838/src/Node/Stream/Internal.js#L17

Should this be?

 s.once('error', (error) => f(error)()); 

From https://discord.com/channels/864614189094928394/865401680497737758/1030191301423022110