deprecate NIOEventLoopGroupProvider (apple#2142)

weissi · Jul 21, 2023 · e104959 · e104959
1 parent e5416f4
commit e104959
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/Sources/NIOCore/Docs.docc/index.md b/Sources/NIOCore/Docs.docc/index.md
@@ -19,7 +19,6 @@ More specialized modules provide concrete implementations of many of the abstrac
 
 - ``EventLoopGroup``
 - ``EventLoop``
-- ``NIOEventLoopGroupProvider``
 - ``EventLoopIterator``
 - ``Scheduled``
 - ``RepeatedTask``

diff --git a/Sources/NIOCore/EventLoop.swift b/Sources/NIOCore/EventLoop.swift
@@ -1273,9 +1273,18 @@ extension EventLoopGroup {
     }
 }
 
-/// This type is intended to be used by libraries which use NIO, and offer their users either the option
+/// This type was intended to be used by libraries which use NIO, and offer their users either the option
 /// to `.share` an existing event loop group or create (and manage) a new one (`.createNew`) and let it be
 /// managed by given library and its lifecycle.
+@available(*, deprecated,
+            message: """
+                     Please use a `group: any EventLoopGroup` parameter instead. If you want to default to a global
+                     singleton group instead, consider
+                     `group: any EventLoopGroup = MultiThreadedEventLoopGroup.globalSingleton` or
+                     similar. Having the option to `.createNew`
+                     EventLoopGroups causes more issues than it solves.
+                     See also: https://github.com/apple/swift-nio/issues/2142
+                     """)
 public enum NIOEventLoopGroupProvider {
     /// Use an `EventLoopGroup` provided by the user.
     /// The owner of this group is responsible for its lifecycle.

diff --git a/Tests/NIOPosixTests/EventLoopTest.swift b/Tests/NIOPosixTests/EventLoopTest.swift
@@ -1389,6 +1389,7 @@ public final class EventLoopTest : XCTestCase {
         waiter.wait()
     }
 
+    @available(*, deprecated)
     func testEventLoopGroupProvider() {
         let eventLoopGroup = MultiThreadedEventLoopGroup(numberOfThreads: 1)
         defer {