Add CompilerMessage warning to groupBy and groupByAsync for parallel consumption requirement (#235)

Adds FS9999 warning to both groupBy and groupByAsync to alert callers that
the resulting sequence must be consumed with a parallel combinator (e.g.
AsyncSeq.mapAsyncParallel) to avoid deadlocks.

Closes #125

Co-authored-by: Repo Assist <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

src/FSharp.Control.AsyncSeq/AsyncSeq.fs

@@ -1983,6 +1983,7 @@ module AsyncSeq =
       toAsyncSeqImpl s.tail.Value
 
 
+  [<CompilerMessage("The result of groupByAsync must be consumed with a parallel combinator such as AsyncSeq.mapAsyncParallel. Sequential consumption will deadlock because sub-sequence completion depends on other sub-sequences being consumed concurrently.", 9999)>]
   let groupByAsync (p:'a -> Async<'k>) (s:AsyncSeq<'a>) : AsyncSeq<'k * AsyncSeq<'a>> = asyncSeq {
     let groups = Dictionary<'k, AsyncSeqSrc< 'a>>()
     let close group =
@@ -2014,6 +2015,7 @@ module AsyncSeq =
         raise ex }
     yield! go () }
 
+  [<CompilerMessage("The result of groupBy must be consumed with a parallel combinator such as AsyncSeq.mapAsyncParallel. Sequential consumption will deadlock because sub-sequence completion depends on other sub-sequences being consumed concurrently.", 9999)>]
   let groupBy (p:'a -> 'k) (s:AsyncSeq<'a>) : AsyncSeq<'k * AsyncSeq<'a>> =
     groupByAsync (p >> async.Return) s
   #endif

src/FSharp.Control.AsyncSeq/AsyncSeq.fsi

@@ -562,13 +562,15 @@ module AsyncSeq =
     ///
     /// Note that the resulting async sequence has to be processed in parallel (e.g AsyncSeq.mapAsyncParallel) becaused
     /// completion of sub-sequences depends on completion of other sub-sequences.
+    [<CompilerMessage("The result of groupByAsync must be consumed with a parallel combinator such as AsyncSeq.mapAsyncParallel. Sequential consumption will deadlock because sub-sequence completion depends on other sub-sequences being consumed concurrently.", 9999)>]
     val groupByAsync<'T, 'Key when 'Key : equality> : projection:('T -> Async<'Key>) -> source:AsyncSeq<'T> -> AsyncSeq<'Key * AsyncSeq<'T>>
 
     /// Applies a key-generating function to each element and returns an async sequence containing unique keys
     /// and async sequences containing elements corresponding to the key.
     ///
     /// Note that the resulting async sequence has to be processed in parallel (e.g AsyncSeq.mapAsyncParallel) becaused
     /// completion of sub-sequences depends on completion of other sub-sequences.
+    [<CompilerMessage("The result of groupBy must be consumed with a parallel combinator such as AsyncSeq.mapAsyncParallel. Sequential consumption will deadlock because sub-sequence completion depends on other sub-sequences being consumed concurrently.", 9999)>]
     val groupBy<'T, 'Key when 'Key : equality> : projection:('T -> 'Key) -> source:AsyncSeq<'T> -> AsyncSeq<'Key * AsyncSeq<'T>>
 
     #if (NETSTANDARD || NET)