Add (API Gateway) WebSockets Support to Swift for AWS Lambda Events

Sources/AWSLambdaEvents/APIGateway+WebSockets.swift

@@ -0,0 +1,68 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftAWSLambdaRuntime open source project
+//
+// Copyright (c) YEARS Apple Inc. and the SwiftAWSLambdaRuntime project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+/// `APIGatewayWebSocketRequest` is a variation of the`APIGatewayV2Request`
+/// and contains data coming from the WebSockets API Gateway.
+public struct APIGatewayWebSocketRequest: Codable {
+    /// `Context` contains information to identify the AWS account and resources invoking the Lambda function.
+    public struct Context: Codable {
+        public struct Identity: Codable {
+            public let sourceIp: String
+        }
+
+        public let routeKey: String
+        public let eventType: String
+        public let extendedRequestId: String
+        /// The request time in format: 23/Apr/2020:11:08:18 +0000
+        public let requestTime: String
+        public let messageDirection: String
+        public let stage: String
+        public let connectedAt: UInt64
+        public let requestTimeEpoch: UInt64
+        public let identity: Identity
+        public let requestId: String
+        public let domainName: String
+        public let connectionId: String
+        public let apiId: String
+    }
+
+    public let headers: HTTPHeaders?
+    public let multiValueHeaders: HTTPMultiValueHeaders?
+    public let context: Context
+    public let body: String?
+    public let isBase64Encoded: Bool?
+
+    enum CodingKeys: String, CodingKey {
+        case headers
+        case multiValueHeaders
+        case context = "requestContext"
+        case body
+        case isBase64Encoded
+    }
+}
+
+/// `APIGatewayWebSocketResponse` is a type alias for `APIGatewayV2Request`.
+/// Typically, lambda WebSockets servers send clients data via
+/// the ApiGatewayManagementApi mechanism. However, APIGateway does require
+/// lambda servers to return some kind of status when APIGateway invokes them.
+/// This can be as simple as always returning a 200 "OK" response for all
+/// WebSockets requests (the ApiGatewayManagementApi can return any errors to
+/// WebSockets clients).
+public typealias APIGatewayWebSocketResponse = APIGatewayV2Response
+
+#if swift(>=5.6)
+extension APIGatewayWebSocketRequest: Sendable {}
+extension APIGatewayWebSocketRequest.Context: Sendable {}
+extension APIGatewayWebSocketRequest.Context.Identity: Sendable {}
+#endif

Tests/AWSLambdaEventsTests/APIGateway+WebsocketsTests.swift

@@ -0,0 +1,78 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftAWSLambdaRuntime open source project
+//
+// Copyright (c) YEARS Apple Inc. and the SwiftAWSLambdaRuntime project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+import Testing
+
+@testable import AWSLambdaEvents
+
+@Suite
+class APIGatewayWebSocketsTests {
+    static let exampleConnectEventBody = """
+        {
+          "headers": {
+            "Host": "lqrlmblaa2.execute-api.us-east-1.amazonaws.com",
+            "Origin": "wss://lqrlmblaa2.execute-api.us-east-1.amazonaws.com",
+            "Sec-WebSocket-Extensions": "",
+            "Sec-WebSocket-Key": "am5ubWVpbHd3bmNyYXF0ag==",
+            "Sec-WebSocket-Version": "13",
+            "X-Amzn-Trace-Id": "Root=1-64b83950-42de8e247b4c2b43091ef67c",
+            "X-Forwarded-For": "24.148.42.16",
+            "X-Forwarded-Port": "443",
+            "X-Forwarded-Proto": "https"
+          },
+          "multiValueHeaders": {
+            "Host": [ "lqrlmblaa2.execute-api.us-east-1.amazonaws.com" ],
+            "Origin": [ "wss://lqrlmblaa2.execute-api.us-east-1.amazonaws.com" ],
+            "Sec-WebSocket-Extensions": [
+              "permessage-deflate; client_max_window_bits; server_max_window_bits=15"
+            ],
+            "Sec-WebSocket-Key": [ "am5ubWVpbHd3bmNyYXF0ag==" ],
+            "Sec-WebSocket-Version": [ "13" ],
+            "X-Amzn-Trace-Id": [ "Root=1-64b83950-42de8e247b4c2b43091ef67c" ],
+            "X-Forwarded-For": [ "24.148.42.16" ],
+            "X-Forwarded-Port": [ "443" ],
+            "X-Forwarded-Proto": [ "https" ]
+          },
+          "requestContext": {
+            "routeKey": "$connect",
+            "eventType": "CONNECT",
+            "extendedRequestId": "IU3kkGyEoAMFwZQ=",
+            "requestTime": "19/Jul/2023:19:28:16 +0000",
+            "messageDirection": "IN",
+            "stage": "dev",
+            "connectedAt": 1689794896145,
+            "requestTimeEpoch": 1689794896162,
+            "identity": { "sourceIp": "24.148.42.16" },
+            "requestId": "IU3kkGyEoAMFwZQ=",
+            "domainName": "lqrlmblaa2.execute-api.us-east-1.amazonaws.com",
+            "connectionId": "IU3kkeN4IAMCJwA=",
+            "apiId": "lqrlmblaa2"
+          },
+          "isBase64Encoded": false
+        }
+        """
+
+    // MARK: - Request -
+
+    // MARK: Decoding
+    @Test func testRequestDecodingExampleConnectRequest() async throws {
+        let data = APIGatewayWebSocketsTests.exampleConnectEventBody.data(using: .utf8)!
+        let req = try JSONDecoder().decode(APIGatewayWebSocketRequest.self, from: data)
+
+        #expect(req.context.routeKey == "$connect")
+        #expect(req.context.connectionId == "IU3kkeN4IAMCJwA=")
+        #expect(req.body == nil)
+    }
+}