Add websocket per-message deflate support [RFC 7692] (#4)

Author: johnnzhou

.gitignore

@@ -28,3 +28,7 @@ Package.resolved
 .swiftpm
 
 .build/
+
+# auto-generated reports and logs
+Tests/integrationTests/autobahn/reports
+Tests/integrationTests/autobahn/scripts/*.log

NOTICE

@@ -39,3 +39,12 @@ This product contains .swift-format from apple/swift-nio.
     * https://github.com/apple/swift-nio
 
 ---
+
+This product contains compression and decompression code from apple/swift-nio-extras.
+
+  * LICENSE (Apache License 2.0):
+    * https://github.com/apple/swift-nio-extras/blob/main/LICENSE.txt
+  * HOMEPAGE:
+    * https://github.com/apple/swift-nio-extras
+
+---

Package.swift

@@ -15,7 +15,7 @@ let package = Package(
         )
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-nio.git", from: "2.76.1"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.81.0"),
         .package(url: "https://github.com/apple/swift-nio-transport-services.git", from: "1.23.0"),
         .package(url: "https://github.com/apple/swift-nio-ssl.git", from: "2.28.0"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.6.2"),
@@ -25,6 +25,7 @@ let package = Package(
         .target(
             name: "LCLWebSocket",
             dependencies: [
+                "CLCLWebSocketZlib",
                 .product(name: "NIO", package: "swift-nio"),
                 .product(name: "NIOConcurrencyHelpers", package: "swift-nio"),
                 .product(name: "NIOWebSocket", package: "swift-nio"),
@@ -40,10 +41,21 @@ let package = Package(
                 .product(name: "Atomics", package: "swift-atomics"),
             ]
         ),
+        .target(
+            name: "CLCLWebSocketZlib",
+            linkerSettings: [
+                .linkedLibrary("z")
+            ]
+        ),
         .testTarget(
             name: "LCLWebSocketTests",
             dependencies: ["LCLWebSocket"]
         ),
+        .testTarget(
+            name: "IntegrationTests",
+            dependencies: ["LCLWebSocket"],
+            exclude: ["autobahn", "Dockerfile"]
+        ),
         .executableTarget(
             name: "AutobahnClient",
             dependencies: ["LCLWebSocket"]

README.md

@@ -6,13 +6,14 @@ LCL WebSocket is a cross-platform WebSocket [[RFC 6455]](https://datatracker.iet
 
 ## Features
 
-- Conform to all [AutoBahn](https://github.com/crossbario/autobahn-testsuite) base cases
+- Conform to all [AutoBahn](https://github.com/crossbario/autobahn-testsuite) cases
 - High-performance WebSocket client and server, on top of SwiftNIO
 - TLS/SSL support
 - Thread-safe
 - Cross-platform
 - Customizable configurations
 - Comprehensive error handling
+- Support WebSocket per-message deflate extension (RFC 7692)
 
 ## Requirements
 - Swift 5.9+
@@ -89,12 +90,12 @@ try server.listen(host: "127.0.0.1", port: 8080, configuration: config).wait()
 
 
 ## TODO
-- [ ] Support Swift Concurrency
-- [ ] Support WebSocket Compression Extension
+- [x] Support Swift Concurrency
+- [x] Support WebSocket Compression Extension
 
 
 ## Contributing
 Any contribution and pull requests are welcome! However, before you plan to implement some features or try to fix an uncertain issue, it is recommended to open a discussion first. You can also join our [Discord channel](https://discord.com/invite/gn4DKF83bP), or visit our [website](https://seattlecommunitynetwork.org/).
 
 ## License
-LCLPing is released under Apache License. See [LICENSE](/LICENSE) for more details.
+lcl-websocket is released under Apache License. See [LICENSE](/LICENSE) for more details.

Sources/AutobahnClient/AutobahnClient.swift

@@ -19,7 +19,7 @@ import NIOPosix
 struct TestWebSocketClient {
 
     static let config = LCLWebSocket.Configuration(
-        maxFrameSize: 1 << 16,
+        maxFrameSize: 1 << 24,
         autoPingConfiguration: .disabled,
         leftoverBytesStrategy: .forwardBytes
     )
@@ -57,7 +57,8 @@ struct TestWebSocketClient {
             }
             try client.connect(
                 to: "ws://\(Self.serverAddress):\(Self.serverPort)/runCase?case=\(i)&agent=\(Self.agentName)",
-                configuration: Self.config
+                configuration: Self.config,
+                supportedExtensions: []
             ).wait()
         }
 

Sources/AutobahnServer/AutohahnServer.swift

@@ -19,7 +19,7 @@ import NIOPosix
 struct AutohahnServer {
 
     static let config = LCLWebSocket.Configuration(
-        maxFrameSize: 1 << 16,
+        maxFrameSize: 1 << 25,
         autoPingConfiguration: .disabled,
         leftoverBytesStrategy: .forwardBytes
     )

Sources/CLCLWebSocketZlib/empty.c

@@ -0,0 +1,11 @@
+//
+// This source file is part of the LCL open source project
+//
+// Copyright (c) 2021-2024 Local Connectivity Lab and the project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE for license information
+// See CONTRIBUTORS for the list of project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//

Sources/CLCLWebSocketZlib/include/CLCLWebSocketZlib.h

@@ -0,0 +1,47 @@
+//
+// This source file is part of the LCL open source project
+//
+// Copyright (c) 2021-2024 Local Connectivity Lab and the project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE for license information
+// See CONTRIBUTORS for the list of project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+#ifndef C_LCLWEBSOCKET_ZLIB_H
+#define C_LCLWEBSOCKET_ZLIB_H
+
+#include <zlib.h>
+
+static inline int CLCLWebSocketZlib_deflateInit2(z_streamp strm,
+                                                 int level,
+                                                 int method,
+                                                 int windowBits,
+                                                 int memLevel,
+                                                 int strategy) {
+       return deflateInit2(strm, level, method, windowBits, memLevel, strategy);
+}
+
+static inline int CLCLWebSocketZlib_inflateInit2(z_streamp strm, int windowBits) {
+    return inflateInit2(strm, windowBits);
+}
+
+static inline int CLCLWebSocketZlib_inflateReset(z_streamp strm) {
+    return inflateReset(strm);
+}
+
+static inline int CLCLWebSocketZlib_deflateReset(z_streamp strm) {
+    return deflateReset(strm);
+}
+
+static inline int CLCLWebSocketZlib_deflateBound(z_streamp strm, uLong sourceLen) {
+    return deflateBound(strm, sourceLen);
+}
+
+static inline Bytef *CLCLWebSocketZlib_voidPtr_to_BytefPtr(void *in) {
+    return (Bytef *)in;
+}
+
+#endif // C_LCLWEBSOCKET_ZLIB_H