Adopt Sendable for Types in NIOWebSocket (apple#2217)

BEDLAM520 · Jul 5, 2022 · fbe7ef4 · fbe7ef4
1 parent 927b91a
commit fbe7ef4
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 3 deletions.
diff --git a/Sources/NIOWebSocket/NIOWebSocketClientUpgrader.swift b/Sources/NIOWebSocket/NIOWebSocketClientUpgrader.swift
@@ -98,6 +98,11 @@ public final class NIOWebSocketClientUpgrader: NIOHTTPClientProtocolUpgrader {
     }
 }
 
+#if swift(>=5.6)
+@available(*, unavailable)
+extension NIOWebSocketClientUpgrader: Sendable {}
+#endif
+
 extension NIOWebSocketClientUpgrader {
     /// Generates a random WebSocket Request Key by generating 16 bytes randomly and encoding them as a base64 string as defined in RFC6455 https://tools.ietf.org/html/rfc6455#section-4.1
     /// - Parameter generator: the `RandomNumberGenerator` used as a the source of randomness

diff --git a/Sources/NIOWebSocket/NIOWebSocketFrameAggregator.swift b/Sources/NIOWebSocket/NIOWebSocketFrameAggregator.swift
@@ -136,3 +136,8 @@ public final class NIOWebSocketFrameAggregator: ChannelInboundHandler {
         self.accumulatedFrameSize = 0
     }
 }
+
+#if swift(>=5.6)
+@available(*, unavailable)
+extension NIOWebSocketFrameAggregator: Sendable {}
+#endif
diff --git a/Sources/NIOWebSocket/NIOWebSocketServerUpgrader.swift b/Sources/NIOWebSocket/NIOWebSocketServerUpgrader.swift
@@ -187,3 +187,9 @@ public final class NIOWebSocketServerUpgrader: HTTPServerProtocolUpgrader {
         }
     }
 }
+
+#if swift(>=5.6)
+@available(*, unavailable)
+extension NIOWebSocketServerUpgrader: Sendable {}
+#endif
+
diff --git a/Sources/NIOWebSocket/WebSocketErrorCodes.swift b/Sources/NIOWebSocket/WebSocketErrorCodes.swift
@@ -19,7 +19,7 @@ import NIOCore
 /// This enum provides names to all non-reserved code numbers,
 /// to avoid users needing to remember the specific numerical values
 /// of those codes.
-public enum WebSocketErrorCode {
+public enum WebSocketErrorCode: NIOSendable {
     /// Indicates a normal closure, meaning that the purpose for
     /// which the connection was established has been fulfilled.
     /// Corresponds to code 1000.

diff --git a/Sources/NIOWebSocket/WebSocketFrame.swift b/Sources/NIOWebSocket/WebSocketFrame.swift
@@ -34,7 +34,7 @@ private extension UInt8 {
 /// predictable binary sequences into websocket data streams. This structure provides
 /// a more convenient method of interacting with a masking key than simply by passing
 /// around a four-tuple.
-public struct WebSocketMaskingKey {
+public struct WebSocketMaskingKey: NIOSendable {
     @usableFromInline internal let _key: (UInt8, UInt8, UInt8, UInt8)
 
     public init?<T: Collection>(_ buffer: T) where T.Element == UInt8 {
@@ -323,6 +323,10 @@ public struct WebSocketFrame {
     }
 }
 
+#if swift(>=5.5) && canImport(_Concurrency)
+extension WebSocketFrame: @unchecked Sendable {}
+#endif
+
 extension WebSocketFrame: Equatable {}
 
 extension WebSocketFrame {
@@ -342,6 +346,11 @@ extension WebSocketFrame {
     }
 }
 
+#if swift(>=5.6)
+@available(*, unavailable)
+extension WebSocketFrame._Storage: Sendable {}
+#endif
+
 extension WebSocketFrame._Storage: Equatable {
     static func ==(lhs: WebSocketFrame._Storage, rhs: WebSocketFrame._Storage) -> Bool {
         return lhs.data == rhs.data && lhs.extensionData == rhs.extensionData

diff --git a/Sources/NIOWebSocket/WebSocketFrameDecoder.swift b/Sources/NIOWebSocket/WebSocketFrameDecoder.swift
@@ -269,3 +269,8 @@ public final class WebSocketFrameDecoder: ByteToMessageDecoder {
         }
     }
 }
+
+#if swift(>=5.6)
+@available(*, unavailable)
+extension WebSocketFrameDecoder: Sendable {}
+#endif
diff --git a/Sources/NIOWebSocket/WebSocketFrameEncoder.swift b/Sources/NIOWebSocket/WebSocketFrameEncoder.swift
@@ -115,6 +115,10 @@ public final class WebSocketFrameEncoder: ChannelOutboundHandler {
     }
 }
 
+#if swift(>=5.6)
+@available(*, unavailable)
+extension WebSocketFrameEncoder: Sendable {}
+#endif
 
 extension ByteBuffer {
     fileprivate mutating func prependFrameHeaderIfPossible(_ frameHeader: FrameHeader) -> Bool {

diff --git a/Sources/NIOWebSocket/WebSocketOpcode.swift b/Sources/NIOWebSocket/WebSocketOpcode.swift
@@ -12,8 +12,10 @@
 //
 //===----------------------------------------------------------------------===//
 
+import NIOCore
+
 /// An operation code for a websocket frame.
-public struct WebSocketOpcode {
+public struct WebSocketOpcode: NIOSendable {
     fileprivate let networkRepresentation: UInt8
 
     public static let continuation = WebSocketOpcode(rawValue: 0x0)

diff --git a/Sources/NIOWebSocket/WebSocketProtocolErrorHandler.swift b/Sources/NIOWebSocket/WebSocketProtocolErrorHandler.swift
@@ -42,3 +42,8 @@ public final class WebSocketProtocolErrorHandler: ChannelInboundHandler {
         context.fireErrorCaught(error)
     }
 }
+
+#if swift(>=5.6)
+@available(*, unavailable)
+extension WebSocketProtocolErrorHandler: Sendable {}
+#endif