purescript-contrib / purescript-concurrent-queues Goto Github PK

Is your change request related to a problem? Please describe.
As described in the documentation section of the Library Guidelines, Contributors libraries are expected to have in their README a short summary of the library's purpose, installation instructions, a quick start with a minimal usage example, and links to the documentation and contributing guide.

This library currently doesn't have a quick start in the README.

Describe the solution you'd like
The library needs a quick start section after the installation instructions. machines is one example of a library with a quick start.

Additional context
See the Governance repository for more information about requirements in the Contributors organization.

Is your change request related to a problem? Please describe.
As described in the documentation section of the Library Guidelines, Contributors libraries are expected to have some documentation in the docs directory -- specifically, a changelog and at least a short tutorial that expands on the quick start in the README.

This library currently doesn't have an up to date changelog or any extra documentation in the docs directory.

Describe the solution you'd like
The argonaut-codecs docs directory has a good example of expanded documentation for a Contributor library. But it would even be useful to add something considerably smaller and shorter to this library.

Additional context
See the Governance repository for more information about requirements in the Contributors organization.

There are several cases where deadlocks will occur if a Queue is used in any Fiber which is killed (ParAff is a common scenario).

read ∷ ∀ a. Queue a → Aff a
read (Queue q) = do
  readEnd ← AVar.take q.readEnd
  // Kill here leaves readEnd empty
  QItem a newRead ← AVar.read readEnd
  AVar.put newRead q.readEnd
  pure a

Invincibility is not a solution because that will lead to external deadlock problems. I have been long down this road with Aff, and even patched the library to fix a critical temporal issue that will also be at play here. When I am able to share the fix I will.