Adapt SCF CustomRuntime API alpha

Author: stevapple

Examples/LocalDebugging/MyApp/MyApp/ContentView.swift

@@ -52,7 +52,7 @@ struct ContentView: View {
     }
 
     func register() {
-        guard let url = URL(string: "http://localhost:7000/invoke") else {
+        guard let url = URL(string: "http://localhost:9001/invoke") else {
             fatalError("invalid url")
         }
         var request = URLRequest(url: url)

Examples/LocalDebugging/README.md

@@ -23,8 +23,8 @@ Start with running the `MyCloudFunction` target.
 * Set the `LOCAL_SCF_SERVER_ENABLED` environment variable to `true` by editing the `MyCloudFunction` scheme Run/Arguments options.
 * Hit `Run`
 * Once it is up you should see a log message in the Xcode console saying
-`LocalSCFServer started and listening on 127.0.0.1:7000, receiving events on /invoke`
-which means the local emulator is up and receiving traffic on port `7000` and expecting events on the `/invoke` endpoint.
+`LocalSCFServer started and listening on 127.0.0.1:9001, receiving events on /invoke`
+which means the local emulator is up and receiving traffic on port `9001` and expecting events on the `/invoke` endpoint.
 
 Continue to run the `MyApp` target
 * Switch to the `MyApp` scheme and select a simulator destination.

Sources/MockServer/main.swift

@@ -33,21 +33,19 @@ internal struct MockServer {
     private let group: EventLoopGroup
     private let host: String
     private let port: Int
-    private let mode: Mode
 
     public init() {
         self.group = MultiThreadedEventLoopGroup(numberOfThreads: System.coreCount)
-        self.host = env("HOST") ?? "127.0.0.1"
-        self.port = env("PORT").flatMap(Int.init) ?? 7000
-        self.mode = env("MODE").flatMap(Mode.init) ?? .string
+        self.host = env("SCF_RUNTIME_API") ?? "127.0.0.1"
+        self.port = env("SCF_RUNTIME_API_PORT").flatMap(Int.init) ?? 9001
     }
 
     func start() throws {
         let bootstrap = ServerBootstrap(group: group)
             .serverChannelOption(ChannelOptions.socket(SocketOptionLevel(SOL_SOCKET), SO_REUSEADDR), value: 1)
             .childChannelInitializer { channel in
                 channel.pipeline.configureHTTPServerPipeline(withErrorHandling: true).flatMap { _ in
-                    channel.pipeline.addHandler(HTTPHandler(mode: self.mode))
+                    channel.pipeline.addHandler(HTTPHandler())
                 }
             }
         try bootstrap.bind(host: self.host, port: self.port).flatMap { channel -> EventLoopFuture<Void> in
@@ -64,14 +62,8 @@ internal final class HTTPHandler: ChannelInboundHandler {
     public typealias InboundIn = HTTPServerRequestPart
     public typealias OutboundOut = HTTPServerResponsePart
 
-    private let mode: Mode
-
     private var pending = CircularBuffer<(head: HTTPRequestHead, body: ByteBuffer?)>()
 
-    public init(mode: Mode) {
-        self.mode = mode
-    }
-
     func channelRead(context: ChannelHandlerContext, data: NIOAny) {
         let requestPart = unwrapInboundIn(data)
 
@@ -98,23 +90,16 @@ internal final class HTTPHandler: ChannelInboundHandler {
         var responseHeaders: [(String, String)]?
 
         if request.head.uri.hasSuffix("/next") {
-            let requestId = UUID().uuidString
+            let requestId = UUID().uuidString.lowercased()
             responseStatus = .ok
-            switch self.mode {
-            case .string:
-                responseBody = requestId
-            case .json:
-                responseBody = "{ \"body\": \"\(requestId)\" }"
-            }
-            let deadline = Int64(Date(timeIntervalSinceNow: 60).timeIntervalSince1970 * 1000)
+            responseBody = "{ \"body\": \"\(requestId)\" }"
             responseHeaders = [
-                (AmazonHeaders.requestID, requestId),
-                (AmazonHeaders.invokedFunctionARN, "arn:aws:lambda:us-east-1:123456789012:function:custom-runtime"),
-                (AmazonHeaders.traceID, "Root=1-5bef4de7-ad49b0e87f6ef6c87fc2e700;Parent=9a9197af755a6419;Sampled=1"),
-                (AmazonHeaders.deadline, String(deadline)),
+                (SCFHeaders.requestID, requestId),
+                (SCFHeaders.memoryLimit, "128"),
+                (SCFHeaders.timeLimit, "3000"),
             ]
         } else if request.head.uri.hasSuffix("/response") {
-            responseStatus = .accepted
+            responseStatus = .ok
         } else {
             responseStatus = .notFound
         }
@@ -151,13 +136,10 @@ internal enum ServerError: Error {
     case cantBind
 }
 
-internal enum AmazonHeaders {
-    static let requestID = "Lambda-Runtime-Aws-Request-Id"
-    static let traceID = "Lambda-Runtime-Trace-Id"
-    static let clientContext = "X-Amz-Client-Context"
-    static let cognitoIdentity = "X-Amz-Cognito-Identity"
-    static let deadline = "Lambda-Runtime-Deadline-Ms"
-    static let invokedFunctionARN = "Lambda-Runtime-Invoked-Function-Arn"
+internal enum SCFHeaders {
+    static let requestID = "request_id"
+    static let memoryLimit = "memory_limit_in_mb"
+    static let timeLimit = "time_limit_in_ms"
 }
 
 internal enum Mode: String {

Sources/TencentSCFEvents/COS/COSEventRecord+Codable.swift renamed to Sources/TencentSCFEvents/COS/EventRecord+Codable.swift

@@ -12,9 +12,8 @@
 //
 //===------------------------------------------------------------------------------------===//
 
-// list all available regions and zones using tccli:
+// list all available regions using tccli:
 //   $ tccli cvm DescribeRegions
-//   $ tccli cvm DescribeZones --region <Region>
 
 /// Enumeration of the Tencent Cloud regions and zones.
 public enum TencentCloud {
@@ -105,40 +104,6 @@ public enum TencentCloud {
         public static var na_siliconvalley: Self { Region(rawValue: "na-siliconvalley")! } // California, US
         public static var na_toronto: Self { Region(rawValue: "na-toronto")! } // Canada
     }
-
-    public struct Zone: RawRepresentable, CustomStringConvertible, Equatable, Hashable {
-        public typealias RawValue = String
-
-        public var rawValue: String {
-            "\(self.region)-\(self.number)"
-        }
-
-        public var description: String {
-            self.rawValue
-        }
-
-        public init?(rawValue: String) {
-            guard let (region, number) = Self.parse(rawValue: rawValue) else {
-                return nil
-            }
-            self.region = region
-            self.number = number
-        }
-
-        private static func parse(rawValue: String) -> (Region, UInt8)? {
-            let components = rawValue.split(separator: "-")
-            guard components.count > 2, let number = UInt8(components.last!) else {
-                return nil
-            }
-
-            let region = Region(rawValue: components.dropLast().joined(separator: "-"))!
-            return (region, number)
-        }
-
-        public let region: Region
-
-        public let number: UInt8
-    }
 }
 
 extension TencentCloud.Region: Codable {
@@ -153,21 +118,3 @@ extension TencentCloud.Region: Codable {
         try container.encode(self.rawValue)
     }
 }
-
-extension TencentCloud.Zone: Codable {
-    public init(from decoder: Decoder) throws {
-        let container = try decoder.singleValueContainer()
-        let zone = try container.decode(String.self)
-        guard let (region, number) = Self.parse(rawValue: zone) else {
-            throw DecodingError.dataCorruptedError(in: container, debugDescription:
-                "Expected zone format like `ap-shanghai-3` or `ap-shenzhen-fsi-1`, but `\(zone)` does not forfill format")
-        }
-        self.region = region
-        self.number = number
-    }
-
-    public func encode(to encoder: Encoder) throws {
-        var container = encoder.singleValueContainer()
-        try container.encode(self.rawValue)
-    }
-}

Sources/TencentSCFEvents/COS/COSObject+Codable.swift renamed to Sources/TencentSCFEvents/COS/Object+Codable.swift

@@ -0,0 +1,71 @@
+//===------------------------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftTencentSCFRuntime open source project
+//
+// Copyright (c) 2020 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
+//
+//===------------------------------------------------------------------------------------===//
+
+// list all available zones using tccli:
+//   $ tccli cvm DescribeZones --region <Region>
+
+/// Enumeration of the Tencent Cloud regions and zones.
+extension TencentCloud {
+    public struct Zone: RawRepresentable, CustomStringConvertible, Equatable, Hashable {
+        public typealias RawValue = String
+
+        public var rawValue: String {
+            "\(self.region)-\(self.number)"
+        }
+
+        public var description: String {
+            self.rawValue
+        }
+
+        public init?(rawValue: String) {
+            guard let (region, number) = Self.parse(rawValue: rawValue) else {
+                return nil
+            }
+            self.region = region
+            self.number = number
+        }
+
+        private static func parse(rawValue: String) -> (Region, UInt8)? {
+            let components = rawValue.split(separator: "-")
+            guard components.count > 2, let number = UInt8(components.last!) else {
+                return nil
+            }
+
+            let region = Region(rawValue: components.dropLast().joined(separator: "-"))!
+            return (region, number)
+        }
+
+        public let region: Region
+
+        public let number: UInt8
+    }
+}
+
+extension TencentCloud.Zone: Codable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        let zone = try container.decode(String.self)
+        guard let (region, number) = Self.parse(rawValue: zone) else {
+            throw DecodingError.dataCorruptedError(in: container, debugDescription:
+                "Expected zone format like `ap-shanghai-3` or `ap-shenzhen-fsi-1`, but `\(zone)` does not forfill format")
+        }
+        self.region = region
+        self.number = number
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.singleValueContainer()
+        try container.encode(self.rawValue)
+    }
+}

Sources/TencentSCFEvents/TencentCloud.swift renamed to Sources/TencentSCFEvents/TencentCloud/Region.swift

@@ -27,6 +27,7 @@
 
 #if DEBUG
 import Dispatch
+import struct Foundation.UUID
 import Logging
 import NIO
 import NIOConcurrencyHelpers
@@ -144,7 +145,7 @@ private enum LocalLambda {
                 guard let work = request.body else {
                     return self.writeResponse(context: context, response: .init(status: .badRequest))
                 }
-                let requestID = "\(DispatchTime.now().uptimeNanoseconds)" // FIXME:
+                let requestID = UUID().uuidString.lowercased()
                 let promise = context.eventLoop.makePromise(of: Response.self)
                 promise.futureResult.whenComplete { result in
                     switch result {
@@ -164,7 +165,7 @@ private enum LocalLambda {
                 }
 
             // /next endpoint is called by the lambda polling for work
-            case (.GET, let url) where url.hasSuffix(Consts.getNextInvocationURLSuffix):
+            case (.GET, let url) where url == Consts.getNextInvocationURL:
                 // check if our server is in the correct state
                 guard case .waitingForLambdaRequest = Self.invocationState else {
                     self.logger.error("invalid invocation state \(Self.invocationState)")
@@ -195,48 +196,28 @@ private enum LocalLambda {
                     self.writeResponse(context: context, response: invocation.makeResponse())
                 }
 
-            // :requestID/response endpoint is called by the lambda posting the response
-            case (.POST, let url) where url.hasSuffix(Consts.postResponseURLSuffix):
-                let parts = request.head.uri.split(separator: "/")
-                guard let requestID = parts.count > 2 ? String(parts[parts.count - 2]) : nil else {
-                    // the request is malformed, since we were expecting a requestId in the path
-                    return self.writeResponse(context: context, status: .badRequest)
-                }
+            // response endpoint is called by the lambda posting the response
+            case (.POST, let url) where url == Consts.postResponseURL:
                 guard case .waitingForLambdaResponse(let invocation) = Self.invocationState else {
                     // a response was send, but we did not expect to receive one
                     self.logger.error("invalid invocation state \(Self.invocationState)")
                     return self.writeResponse(context: context, status: .unprocessableEntity)
                 }
-                guard requestID == invocation.requestID else {
-                    // the request's requestId is not matching the one we are expecting
-                    self.logger.error("invalid invocation state request ID \(requestID) does not match expected \(invocation.requestID)")
-                    return self.writeResponse(context: context, status: .badRequest)
-                }
 
                 invocation.responsePromise.succeed(.init(status: .ok, body: request.body))
-                self.writeResponse(context: context, status: .accepted)
+                self.writeResponse(context: context, status: .ok)
                 Self.invocationState = .waitingForLambdaRequest
 
-            // :requestID/error endpoint is called by the lambda posting an error response
-            case (.POST, let url) where url.hasSuffix(Consts.postErrorURLSuffix):
-                let parts = request.head.uri.split(separator: "/")
-                guard let requestID = parts.count > 2 ? String(parts[parts.count - 2]) : nil else {
-                    // the request is malformed, since we were expecting a requestId in the path
-                    return self.writeResponse(context: context, status: .badRequest)
-                }
+            // error endpoint is called by the lambda posting an error response
+            case (.POST, let url) where url == Consts.postErrorURL:
                 guard case .waitingForLambdaResponse(let invocation) = Self.invocationState else {
                     // a response was send, but we did not expect to receive one
                     self.logger.error("invalid invocation state \(Self.invocationState)")
                     return self.writeResponse(context: context, status: .unprocessableEntity)
                 }
-                guard requestID == invocation.requestID else {
-                    // the request's requestId is not matching the one we are expecting
-                    self.logger.error("invalid invocation state request ID \(requestID) does not match expected \(invocation.requestID)")
-                    return self.writeResponse(context: context, status: .badRequest)
-                }
 
                 invocation.responsePromise.succeed(.init(status: .internalServerError, body: request.body))
-                self.writeResponse(context: context, status: .accepted)
+                self.writeResponse(context: context, status: .ok)
                 Self.invocationState = .waitingForLambdaRequest
 
             // unknown call
@@ -287,10 +268,9 @@ private enum LocalLambda {
                 response.body = self.request
                 // required headers
                 response.headers = [
-                    (AmazonHeaders.requestID, self.requestID),
-                    (AmazonHeaders.invokedFunctionARN, "arn:aws:lambda:us-east-1:\(Int16.random(in: Int16.min ... Int16.max)):function:custom-runtime"),
-                    (AmazonHeaders.traceID, "Root=\(AmazonHeaders.generateXRayTraceID());Sampled=1"),
-                    (AmazonHeaders.deadline, "\(DispatchWallTime.distantFuture.millisSinceEpoch)"),
+                    (SCFHeaders.requestID, self.requestID),
+                    (SCFHeaders.timeLimit, "3000"),
+                    (SCFHeaders.memoryLimit, "128"),
                 ]
                 return response
             }

Sources/TencentSCFEvents/TencentCloud/Zone.swift

@@ -81,12 +81,16 @@ extension Lambda {
             let requestTimeout: TimeAmount?
 
             init(address: String? = nil, keepAlive: Bool? = nil, requestTimeout: TimeAmount? = nil) {
-                let ipPort = (address ?? env("TENCENT_SCF_RUNTIME_API"))?.split(separator: ":") ?? ["127.0.0.1", "7000"]
-                guard ipPort.count == 2, let port = Int(ipPort[1]) else {
-                    preconditionFailure("invalid ip+port configuration \(ipPort)")
+                if let ipPort = address?.split(separator: ":") {
+                    guard ipPort.count == 2, let port = Int(ipPort[1]) else {
+                        preconditionFailure("invalid ip+port configuration \(ipPort)")
+                    }
+                    self.ip = String(ipPort[0])
+                    self.port = port
+                } else {
+                    self.ip = env("SCF_RUNTIME_API") ?? "127.0.0.1"
+                    self.port = env("SCF_RUNTIME_API_PORT").flatMap(Int.init) ?? 9001
                 }
-                self.ip = String(ipPort[0])
-                self.port = port
                 self.keepAlive = keepAlive ?? env("KEEP_ALIVE").flatMap(Bool.init) ?? true
                 self.requestTimeout = requestTimeout ?? env("REQUEST_TIMEOUT").flatMap(Int64.init).flatMap { .milliseconds($0) }
             }