Add CLS support

Author: stevapple

Package.swift

@@ -18,10 +18,11 @@ let package = Package(
         .library(name: "TencentSCFTesting", targets: ["TencentSCFTesting"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-nio.git", .upToNextMajor(from: "2.17.0")),
-        .package(url: "https://github.com/apple/swift-log.git", .upToNextMajor(from: "1.0.0")),
-        .package(url: "https://github.com/swift-server/swift-backtrace.git", .upToNextMajor(from: "1.1.0")),
-        .package(url: "https://github.com/stevapple/tencent-cloud-core.git", .upToNextMajor(from: "0.2.0"))
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.17.0"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
+        .package(url: "https://github.com/swift-server/swift-backtrace.git", from: "1.1.0"),
+        .package(url: "https://github.com/stevapple/tencent-cloud-core.git", .upToNextMinor(from: "0.2.0")),
+        .package(name: "Gzip", url: "https://github.com/1024jp/GzipSwift.git", from: "5.1.0")
     ],
     targets: [
         .target(name: "TencentSCFRuntime", dependencies: [
@@ -44,7 +45,9 @@ let package = Package(
             .product(name: "NIOTestUtils", package: "swift-nio"),
             .product(name: "NIOFoundationCompat", package: "swift-nio"),
         ]),
-        .target(name: "TencentSCFEvents", dependencies: []),
+        .target(name: "TencentSCFEvents", dependencies: [
+            .byName(name: "Gzip")
+        ]),
         .testTarget(name: "TencentSCFEventsTests", dependencies: ["TencentSCFEvents"]),
         // testing helper
         .target(name: "TencentSCFTesting", dependencies: [

README.md

@@ -400,6 +400,7 @@ Serverless Cloud Functions can be invoked directly from the SCF console, SCF API
 * [Timer Events](https://intl.cloud.tencent.com/document/product/583/9708)
 * [CMQ Topic Messages](https://intl.cloud.tencent.com/document/product/583/11517)
 * [CKafka Messages](https://intl.cloud.tencent.com/document/product/583/17530)
+* [CLS Logs](https://intl.cloud.tencent.com/document/product/583/38845)
 
 **Note**: Each one of the integration points mentioned above includes a set of `Decodable` structs that transform Tencent Cloud's data model for these APIs. APIGateway response is wrapped into an `Encodable` struct with three different initializers to help you build any valid response.
 

Sources/TencentSCFEvents/APIResponse.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftTencentSCFRuntime open source project
 //
-// Copyright (c) 2020 stevapple and the SwiftTencentSCFRuntime project authors
+// Copyright (c) 2020-2021 stevapple and the SwiftTencentSCFRuntime project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

Sources/TencentSCFEvents/CLS/CLSLog.swift

@@ -0,0 +1,65 @@
+//===------------------------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftTencentSCFRuntime open source project
+//
+// Copyright (c) 2021 stevapple and the SwiftTencentSCFRuntime project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftTencentSCFRuntime project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===------------------------------------------------------------------------------------===//
+
+import Gzip
+import struct Foundation.Data
+import struct Foundation.Date
+
+// https://intl.cloud.tencent.com/document/product/583/38845
+
+import class Foundation.JSONDecoder
+
+public enum CLS {
+    public struct Logs: Decodable {
+        public let topicId: String
+        public let topicName: String
+        public let records: [CLS.Record]
+
+        public init(from decoder: Decoder) throws {
+            let rawContainer = try decoder.singleValueContainer()
+            let data = try rawContainer.decode(CLS.Raw.self).data.gunzipped()
+            
+            let _self = try CLS.jsonDecoder.decode(CLS._Logs.self, from: data)
+            self.topicId = _self.topicId
+            self.topicName = _self.topicName
+            self.records = _self.records
+        }
+    }
+
+    public struct Record: Decodable {
+        public let timestamp: UInt
+        public let content: String
+
+        public var date: Date {
+            Date(timeIntervalSince1970: Double(timestamp) / 1000)
+        }
+
+        enum CodingKeys: String, CodingKey {
+            case timestamp
+            case content
+        }
+        
+        public init(from decoder: Decoder) throws {
+            let container = try decoder.container(keyedBy: CodingKeys.self)
+            let timestring = try container.decode(String.self, forKey: .timestamp)
+            guard let timestamp = UInt(timestring) else {
+                throw DecodingError.dataCorruptedError(forKey: .timestamp, in: container, debugDescription: "Expected timestamp to be unsigned numbers")
+            }
+            self.timestamp = timestamp
+            self.content = try container.decode(String.self, forKey: .content)
+        }
+    }
+
+    internal static let jsonDecoder = JSONDecoder()
+}

Sources/TencentSCFEvents/CLS/CLSRaw.swift

@@ -0,0 +1,52 @@
+//===------------------------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftTencentSCFRuntime open source project
+//
+// Copyright (c) 2021 stevapple and the SwiftTencentSCFRuntime project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftTencentSCFRuntime project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===------------------------------------------------------------------------------------===//
+
+import struct Foundation.Data
+
+// https://intl.cloud.tencent.com/document/product/583/38845
+
+extension CLS{
+    struct _Logs: Decodable {
+        let topicId: String
+        let topicName: String
+        let records: [CLS.Record]
+
+        enum CodingKeys: String, CodingKey {
+            case topicId = "topic_id"
+            case topicName = "topic_name"
+            case records
+        }
+    }
+
+    struct Raw: Decodable {
+        let data: Data
+
+        enum WrappingCodingKeys: String, CodingKey {
+            case logs = "clslogs"
+        }
+        enum CodingKeys: String, CodingKey {
+            case data
+        }
+
+        public init(from decoder: Decoder) throws {
+            let wrapperContainer = try decoder.container(keyedBy: WrappingCodingKeys.self)
+            let container = try wrapperContainer.nestedContainer(keyedBy: CodingKeys.self, forKey: .logs)
+            let rawString = try container.decode(String.self, forKey: .data)
+            guard let data = Data(base64Encoded: rawString) else {
+                throw DecodingError.dataCorruptedError(forKey: .data, in: container, debugDescription: "Base64 decoding error")
+            }
+            self.data = data
+        }
+    }
+}

Tests/TencentSCFEventsTests/CLSLogTests.swift

@@ -0,0 +1,64 @@
+//===------------------------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftTencentSCFRuntime open source project
+//
+// Copyright (c) 2021 stevapple and the SwiftTencentSCFRuntime project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftTencentSCFRuntime project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===------------------------------------------------------------------------------------===//
+
+import Gzip
+@testable import TencentSCFEvents
+import XCTest
+
+class CLSLogTests: XCTestCase {
+    static let realBody = """
+    {
+      "topic_id": "xxxx-xx-xx-xx-yyyyyyyy",
+      "topic_name": "testname",
+      "records": [{
+        "timestamp": "1605578090000020",
+        "content": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      }, {
+        "timestamp": "1605578090000040",
+        "content": "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+      }]
+    }
+    """
+    
+    static var eventBody: String {
+        let data = try! realBody.data(using: .utf8)!.gzipped().base64EncodedString()
+        return """
+        {
+          "clslogs": {
+            "data": "\(data)"
+          }
+        }
+        """
+    }
+
+    func testSimpleEventFromJSON() {
+        let data = Self.eventBody.data(using: .utf8)!
+        var event: CLS.Logs?
+        XCTAssertNoThrow(event = try JSONDecoder().decode(CLS.Logs.self, from: data))
+
+        XCTAssertEqual(event?.topicId, "xxxx-xx-xx-xx-yyyyyyyy")
+        XCTAssertEqual(event?.topicName, "testname")
+        guard let record1 = event?.records.first,
+              let record2 = event?.records.last else {
+            XCTFail("Expected to have 2 records")
+            return
+        }
+
+        XCTAssertEqual(record1.content, "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
+        XCTAssertEqual(record2.content, "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy")
+        XCTAssertEqual(record1.timestamp, 1605578090000020)
+        XCTAssertEqual(record2.timestamp, 1605578090000040)
+        XCTAssertEqual(record2.date.timeIntervalSince(record1.date), 0.02, accuracy: 0.0001)
+    }
+}