Update APIs and comments for SCF

Author: stevapple

Examples/CloudFunctions/Sources/APIGateway/main.swift

@@ -31,17 +31,17 @@ import TencentSCFRuntime
 
 // MARK: - Run SCF function
 
-Lambda.run(APIGatewayProxyLambda())
+SCF.run(APIGatewayProxySCF())
 
 // MARK: - Handler, Request and Response
 
 // FIXME: Use proper Event abstractions once added to TencentSCFRuntime
-struct APIGatewayProxyLambda: EventLoopLambdaHandler {
+struct APIGatewayProxySCF: EventLoopSCFHandler {
     public typealias In = APIGateway.Request
     public typealias Out = APIGateway.Response
 
-    public func handle(context: Lambda.Context, event: APIGateway.Request) -> EventLoopFuture<APIGateway.Response> {
+    public func handle(context: SCF.Context, event: APIGateway.Request) -> EventLoopFuture<APIGateway.Response> {
         context.logger.debug("hello, api gateway!")
-        return context.eventLoop.makeSucceededFuture(APIGateway.Response(statusCode: .ok, body: "hello, world!"))
+        return context.eventLoop.makeSucceededFuture(APIGateway.Response(statusCode: .ok, body: "Hello, world!"))
     }
 }

Examples/CloudFunctions/Sources/Benchmark/main.swift

@@ -28,17 +28,16 @@
 import NIO
 import TencentSCFRuntimeCore
 
-// If you would like to benchmark Swift's SCF Runtime,
-// use this example which is more performant.
-// `EventLoopLambdaHandler` does not offload the cloud function processing to a separate thread
+// If you would like to benchmark Swift's SCF Runtime, use this example which is more performant.
+// `EventLoopSCFHandler` does not offload the cloud function processing to a separate thread
 // while the Closure-based handlers do.
-Lambda.run(BenchmarkHandler())
+SCF.run(BenchmarkHandler())
 
-struct BenchmarkHandler: EventLoopLambdaHandler {
+struct BenchmarkHandler: EventLoopSCFHandler {
     typealias In = String
     typealias Out = String
 
-    func handle(context: Lambda.Context, event: String) -> EventLoopFuture<String> {
-        context.eventLoop.makeSucceededFuture("hello, world!")
+    func handle(context: SCF.Context, event: String) -> EventLoopFuture<String> {
+        context.eventLoop.makeSucceededFuture("Hello, world!")
     }
 }

Examples/CloudFunctions/Sources/CurrencyExchange/main.swift

@@ -34,16 +34,17 @@ import FoundationXML
 #endif
 import Logging
 
-// MARK: - Run Lambda
+// MARK: - Run SCF function
 
-Lambda.run { (context: Lambda.Context, _: Request, callback: @escaping (Result<[Exchange], Error>) -> Void) in
+SCF.run { (context: SCF.Context, _: Request, callback: @escaping (Result<[Exchange], Error>) -> Void) in
     let calculator = ExchangeRatesCalculator()
     calculator.run(logger: context.logger, callback: callback)
 }
 
 // MARK: - Business Logic
 
-// This is a contrived example performing currency exchange rate lookup and conversion using URLSession and XML parsing
+// This is a contrived example performing currency exchange rate lookup and conversion using
+// URLSession and XML parsing.
 struct ExchangeRatesCalculator {
     static let currencies = ["EUR", "USD", "JPY"]
     static let currenciesEmojies = [
@@ -56,7 +57,8 @@ struct ExchangeRatesCalculator {
     let calendar: Calendar
 
     init() {
-        // This is data from HMRC, the UK tax authority. Therefore we want to use their locale when interpreting data from the server.
+        // This is data from HMRC, the UK tax authority. Therefore we want to use their
+        // locale when interpreting data from the server.
         self.locale = Locale(identifier: "en_GB")
         // Use the UK calendar, not the system one.
         var calendar = self.locale.calendar

Examples/CloudFunctions/Sources/ErrorHandling/main.swift

@@ -29,19 +29,19 @@ import TencentSCFRuntime
 
 // MARK: - Run SCF function
 
-// switch over the error type "requested" by the request, and trigger such error accordingly
-Lambda.run { (context: Lambda.Context, request: Request, callback: (Result<Response, Error>) -> Void) in
+// Switch over the error type "requested" by the request, and trigger such error accordingly.
+SCF.run { (context: SCF.Context, request: Request, callback: (Result<Response, Error>) -> Void) in
     switch request.error {
-    // no error here!
+    // No error here!
     case .none:
         callback(.success(Response(scfRequestID: context.requestID, requestID: request.requestID, status: .ok)))
-    // trigger a "managed" error - domain specific business logic failure
+    // Trigger a "managed" error - domain specific business logic failure.
     case .managed:
         callback(.success(Response(scfRequestID: context.requestID, requestID: request.requestID, status: .error)))
-    // trigger an "unmanaged" error - an unexpected Swift Error triggered while processing the request
+    // Trigger an "unmanaged" error - an unexpected Swift Error triggered while processing the request.
     case .unmanaged(let error):
         callback(.failure(UnmanagedError(description: error)))
-    // trigger a "fatal" error - a panic type error which will crash the process
+    // Trigger a "fatal" error - a panic type error which will crash the process.
     case .fatal:
         fatalError("crash!")
     }

Examples/CloudFunctions/Sources/HelloWorld/main.swift

@@ -27,7 +27,7 @@
 
 import TencentSCFRuntime
 
-// introductory example, the obligatory "hello, world!"
-Lambda.run { (_: Lambda.Context, _: String, callback: (Result<String, Error>) -> Void) in
-    callback(.success("hello, world!"))
+// Introductory example, the obligatory "Hello, world!"
+SCF.run { (_: SCF.Context, _: String, callback: (Result<String, Error>) -> Void) in
+    callback(.success("Hello, world!"))
 }

Examples/LocalDebugging/MyCloudFunction/Sources/MyCloudFunction/main.swift

@@ -28,9 +28,9 @@
 import Shared
 import TencentSCFRuntime
 
-// set LOCAL_SCF_SERVER_ENABLED env variable to "true" to start
-// a local server simulator which will allow local debugging
-Lambda.run { (_, request: Request, callback: @escaping (Result<Response, Error>) -> Void) in
+// Set LOCAL_SCF_SERVER_ENABLED env variable to "true" to start a local server simulator
+// which will allow local debugging.
+SCF.run { (_, request: Request, callback: @escaping (Result<Response, Error>) -> Void) in
     // TODO: something useful
     callback(.success(Response(message: "Hello, \(request.name)!")))
 }

Sources/CodableSample/main.swift

@@ -36,24 +36,24 @@ struct Response: Codable {
     let body: String
 }
 
-// in this example we are receiving and responding with codables. Request and Response above are examples of how to use
-// codables to model your reqeuest and response objects
-struct Handler: EventLoopLambdaHandler {
+// In this example we are receiving and responding with codables.  Request and Response
+// above are examples of how to use codables to model your reqeuest and response objects.
+struct Handler: EventLoopSCFHandler {
     typealias In = Request
     typealias Out = Response
 
-    func handle(context: Lambda.Context, event: Request) -> EventLoopFuture<Response> {
-        // as an example, respond with the input event's reversed body
+    func handle(context: SCF.Context, event: Request) -> EventLoopFuture<Response> {
+        // As an example, respond with the input event's reversed body.
         context.eventLoop.makeSucceededFuture(Response(body: String(event.body.reversed())))
     }
 }
 
-Lambda.run(Handler())
+SCF.run(Handler())
 
 // MARK: - this can also be expressed as a closure:
 
 /*
- Lambda.run { (_, request: Request, callback) in
-   callback(.success(Response(body: String(request.body.reversed()))))
+ SCF.run { (_, request: Request, callback) in
+     callback(.success(Response(body: String(request.body.reversed()))))
  }
  */

Sources/StringSample/main.swift

@@ -28,23 +28,23 @@
 import NIO
 import TencentSCFRuntimeCore
 
-// in this example we are receiving and responding with strings
-struct Handler: EventLoopLambdaHandler {
+// In this example we are receiving and responding with strings.
+struct Handler: EventLoopSCFHandler {
     typealias In = String
     typealias Out = String
 
-    func handle(context: Lambda.Context, event: String) -> EventLoopFuture<String> {
-        // as an example, respond with the event's reversed body
+    func handle(context: SCF.Context, event: String) -> EventLoopFuture<String> {
+        // As an example, respond with the event's reversed body.
         context.eventLoop.makeSucceededFuture(String(event.reversed()))
     }
 }
 
-Lambda.run(Handler())
+SCF.run(Handler())
 
 // MARK: - this can also be expressed as a closure:
 
 /*
- Lambda.run { (_, event: String, callback) in
-   callback(.success(String(event.reversed())))
+ SCF.run { (_, event: String, callback) in
+     callback(.success(String(event.reversed())))
  }
  */

Sources/TencentSCFEvents/APIGateway.swift

@@ -16,8 +16,8 @@ import struct Foundation.Data
 
 // https://cloud.tencent.com/document/product/583/12513
 
+/// `APIGateway.Request` contains data coming from the API Gateway.
 public enum APIGateway {
-    /// APIGatewayRequest contains data coming from the API Gateway
     public struct Request: Codable {
         public struct Context: Codable {
             public let identity: [String: String]

Sources/TencentSCFEvents/TencentCloud/Region.swift

@@ -12,10 +12,10 @@
 //
 //===------------------------------------------------------------------------------------===//
 
-// list all available regions using tccli:
+// List all available regions using tccli:
 //   $ tccli cvm DescribeRegions
 
-/// Enumeration of the Tencent Cloud regions and zones.
+/// Enumeration of the Tencent Cloud regions.
 public enum TencentCloud {
     public struct Region: RawRepresentable, CustomStringConvertible, Equatable, Hashable {
         public typealias RawValue = String