Rename RequestWork to GetNextInvocation (#74)

fabianfett · web-flow · commit 9df8a1a4685e · 2020-05-07T08:37:07.000-07:00
diff --git a/Sources/AWSLambdaRuntime/LambdaRunner.swift b/Sources/AWSLambdaRuntime/LambdaRunner.swift
@@ -45,13 +45,13 @@ extension Lambda {
 
         func run(logger: Logger, handler: Handler) -> EventLoopFuture<Void> {
             logger.debug("lambda invocation sequence starting")
-            // 1. request work from lambda runtime engine
-            return self.runtimeClient.requestWork(logger: logger).peekError { error in
-                logger.error("could not fetch work from lambda runtime engine: \(error)")
+            // 1. request invocation from lambda runtime engine
+            return self.runtimeClient.getNextInvocation(logger: logger).peekError { error in
+                logger.error("could not fetch invocation from lambda runtime engine: \(error)")
             }.flatMap { invocation, payload in
-                // 2. send work to handler
+                // 2. send invocation to handler
                 let context = Context(logger: logger, eventLoop: self.eventLoop, invocation: invocation)
-                logger.debug("sending work to lambda handler \(handler)")
+                logger.debug("sending invocation to lambda handler \(handler)")
                 return handler.handle(context: context, payload: payload)
                     .mapResult { result in
                         if case .failure(let error) = result {
diff --git a/Sources/AWSLambdaRuntime/LambdaRuntimeClient.swift b/Sources/AWSLambdaRuntime/LambdaRuntimeClient.swift
@@ -32,9 +32,9 @@ extension Lambda {
             self.httpClient = HTTPClient(eventLoop: eventLoop, configuration: configuration)
         }
 
-        /// Requests work from the Runtime Engine.
-        func requestWork(logger: Logger) -> EventLoopFuture<(Invocation, ByteBuffer)> {
-            let url = Consts.invocationURLPrefix + Consts.requestWorkURLSuffix
+        /// Requests invocation from the control plane.
+        func getNextInvocation(logger: Logger) -> EventLoopFuture<(Invocation, ByteBuffer)> {
+            let url = Consts.invocationURLPrefix + Consts.getNextInvocationURLSuffix
             logger.debug("requesting work from lambda runtime engine using \(url)")
             return self.httpClient.get(url: url).flatMapThrowing { response in
                 guard response.status == .ok else {
diff --git a/Sources/AWSLambdaRuntime/Utils.swift b/Sources/AWSLambdaRuntime/Utils.swift
@@ -18,7 +18,7 @@ import NIO
 internal enum Consts {
     private static let apiPrefix = "/2018-06-01"
     static let invocationURLPrefix = "\(apiPrefix)/runtime/invocation"
-    static let requestWorkURLSuffix = "/next"
+    static let getNextInvocationURLSuffix = "/next"
     static let postResponseURLSuffix = "/response"
     static let postErrorURLSuffix = "/error"
     static let postInitErrorURL = "\(apiPrefix)/runtime/init/error"
diff --git a/Tests/AWSLambdaRuntimeTests/Lambda+CodeableTest.swift b/Tests/AWSLambdaRuntimeTests/Lambda+CodeableTest.swift
@@ -211,7 +211,7 @@ private struct Behavior: LambdaServerBehavior {
         self.result = result
     }
 
-    func getWork() -> GetWorkResult {
+    func getInvocation() -> GetInvocationResult {
         guard let payload = try? JSONEncoder().encode(Request(requestId: requestId)) else {
             XCTFail("encoding error")
             return .failure(.internalServerError)
diff --git a/Tests/AWSLambdaRuntimeTests/Lambda+StringTest.swift b/Tests/AWSLambdaRuntimeTests/Lambda+StringTest.swift
@@ -210,7 +210,7 @@ private struct Behavior: LambdaServerBehavior {
         self.result = result
     }
 
-    func getWork() -> GetWorkResult {
+    func getInvocation() -> GetInvocationResult {
         .success((requestId: self.requestId, payload: self.payload))
     }
 
diff --git a/Tests/AWSLambdaRuntimeTests/LambdaRunnerTest.swift b/Tests/AWSLambdaRuntimeTests/LambdaRunnerTest.swift
@@ -20,7 +20,7 @@ class LambdaRunnerTest: XCTestCase {
         struct Behavior: LambdaServerBehavior {
             let requestId = UUID().uuidString
             let payload = "hello"
-            func getWork() -> GetWorkResult {
+            func getInvocation() -> GetInvocationResult {
                 .success((self.requestId, self.payload))
             }
 
@@ -47,7 +47,7 @@ class LambdaRunnerTest: XCTestCase {
         struct Behavior: LambdaServerBehavior {
             static let error = "boom"
             let requestId = UUID().uuidString
-            func getWork() -> GetWorkResult {
+            func getInvocation() -> GetInvocationResult {
                 .success((requestId: self.requestId, payload: "hello"))
             }
 
diff --git a/Tests/AWSLambdaRuntimeTests/LambdaRuntimeClientTest.swift b/Tests/AWSLambdaRuntimeTests/LambdaRuntimeClientTest.swift
@@ -36,9 +36,9 @@ class LambdaRuntimeClientTest: XCTestCase {
         XCTAssertEqual(behavior.state, 1)
     }
 
-    func testGetWorkServerInternalError() {
+    func testGetInvocationServerInternalError() {
         struct Behavior: LambdaServerBehavior {
-            func getWork() -> GetWorkResult {
+            func getInvocation() -> GetInvocationResult {
                 .failure(.internalServerError)
             }
 
@@ -62,9 +62,9 @@ class LambdaRuntimeClientTest: XCTestCase {
         }
     }
 
-    func testGetWorkServerNoBodyError() {
+    func testGetInvocationServerNoBodyError() {
         struct Behavior: LambdaServerBehavior {
-            func getWork() -> GetWorkResult {
+            func getInvocation() -> GetInvocationResult {
                 .success(("1", ""))
             }
 
@@ -88,9 +88,9 @@ class LambdaRuntimeClientTest: XCTestCase {
         }
     }
 
-    func testGetWorkServerMissingHeaderRequestIDError() {
+    func testGetInvocationServerMissingHeaderRequestIDError() {
         struct Behavior: LambdaServerBehavior {
-            func getWork() -> GetWorkResult {
+            func getInvocation() -> GetInvocationResult {
                 // no request id -> no context
                 .success(("", "hello"))
             }
@@ -117,7 +117,7 @@ class LambdaRuntimeClientTest: XCTestCase {
 
     func testProcessResponseInternalServerError() {
         struct Behavior: LambdaServerBehavior {
-            func getWork() -> GetWorkResult {
+            func getInvocation() -> GetInvocationResult {
                 .success((requestId: "1", payload: "payload"))
             }
 
@@ -142,7 +142,7 @@ class LambdaRuntimeClientTest: XCTestCase {
 
     func testProcessErrorInternalServerError() {
         struct Behavior: LambdaServerBehavior {
-            func getWork() -> GetWorkResult {
+            func getInvocation() -> GetInvocationResult {
                 .success((requestId: "1", payload: "payload"))
             }
 
@@ -167,8 +167,8 @@ class LambdaRuntimeClientTest: XCTestCase {
 
     func testProcessInitErrorOnBootstrapFailure() {
         struct Behavior: LambdaServerBehavior {
-            func getWork() -> GetWorkResult {
-                XCTFail("should not get work")
+            func getInvocation() -> GetInvocationResult {
+                XCTFail("should not get invocation")
                 return .failure(.internalServerError)
             }
 
@@ -217,7 +217,7 @@ class LambdaRuntimeClientTest: XCTestCase {
             return .success(())
         }
 
-        func getWork() -> GetWorkResult {
+        func getInvocation() -> GetInvocationResult {
             self.state += 2
             return .success(("1", "hello"))
         }
diff --git a/Tests/AWSLambdaRuntimeTests/LambdaTest.swift b/Tests/AWSLambdaRuntimeTests/LambdaTest.swift
@@ -100,8 +100,8 @@ class LambdaTest: XCTestCase {
 
     func testBootstrapFailureAndReportErrorFailure() {
         struct Behavior: LambdaServerBehavior {
-            func getWork() -> GetWorkResult {
-                XCTFail("should not get work")
+            func getInvocation() -> GetInvocationResult {
+                XCTFail("should not get invocation")
                 return .failure(.internalServerError)
             }
 
@@ -212,7 +212,7 @@ class LambdaTest: XCTestCase {
         defer { XCTAssertNoThrow(try server.stop().wait()) }
 
         struct Behavior: LambdaServerBehavior {
-            func getWork() -> GetWorkResult {
+            func getInvocation() -> GetInvocationResult {
                 .failure(.internalServerError)
             }
 
@@ -299,7 +299,7 @@ private struct Behavior: LambdaServerBehavior {
         self.result = result
     }
 
-    func getWork() -> GetWorkResult {
+    func getInvocation() -> GetInvocationResult {
         .success((requestId: self.requestId, payload: self.payload))
     }
 
@@ -334,8 +334,8 @@ private struct Behavior: LambdaServerBehavior {
 }
 
 struct FailedBootstrapBehavior: LambdaServerBehavior {
-    func getWork() -> GetWorkResult {
-        XCTFail("should not get work")
+    func getInvocation() -> GetInvocationResult {
+        XCTFail("should not get invocation")
         return .failure(.internalServerError)
     }
 
diff --git a/Tests/AWSLambdaRuntimeTests/MockLambdaServer.swift b/Tests/AWSLambdaRuntimeTests/MockLambdaServer.swift
@@ -130,8 +130,8 @@ internal final class HTTPHandler: ChannelInboundHandler {
             case .failure(let error):
                 responseStatus = .init(statusCode: error.rawValue)
             }
-        } else if request.head.uri.hasSuffix(Consts.requestWorkURLSuffix) {
-            switch self.behavior.getWork() {
+        } else if request.head.uri.hasSuffix(Consts.getNextInvocationURLSuffix) {
+            switch self.behavior.getInvocation() {
             case .success(let (requestId, result)):
                 if requestId == "timeout" {
                     usleep((UInt32(result) ?? 0) * 1000)
@@ -213,13 +213,13 @@ internal final class HTTPHandler: ChannelInboundHandler {
 }
 
 internal protocol LambdaServerBehavior {
-    func getWork() -> GetWorkResult
+    func getInvocation() -> GetInvocationResult
     func processResponse(requestId: String, response: String?) -> Result<Void, ProcessResponseError>
     func processError(requestId: String, error: ErrorResponse) -> Result<Void, ProcessErrorError>
     func processInitError(error: ErrorResponse) -> Result<Void, ProcessErrorError>
 }
 
-internal typealias GetWorkResult = Result<(String, String), GetWorkError>
+internal typealias GetInvocationResult = Result<(String, String), GetWorkError>
 
 internal enum GetWorkError: Int, Error {
     case badRequest = 400

Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ private struct Behavior: LambdaServerBehavior {`
`211`	`211`	`self.result = result`
`212`	`212`	`}`
`213`	`213`
`214`		`- func getWork() -> GetWorkResult {`
	`214`	`+ func getInvocation() -> GetInvocationResult {`
`215`	`215`	`guard let payload = try? JSONEncoder().encode(Request(requestId: requestId)) else {`
`216`	`216`	`XCTFail("encoding error")`
`217`	`217`	`return .failure(.internalServerError)`
Original file line number	Diff line number	Diff line change
`@@ -210,7 +210,7 @@ private struct Behavior: LambdaServerBehavior {`
`210`	`210`	`self.result = result`
`211`	`211`	`}`
`212`	`212`
`213`		`- func getWork() -> GetWorkResult {`
	`213`	`+ func getInvocation() -> GetInvocationResult {`
`214`	`214`	`.success((requestId: self.requestId, payload: self.payload))`
`215`	`215`	`}`
`216`	`216`
Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,9 @@ class LambdaRuntimeClientTest: XCTestCase {`
`36`	`36`	`XCTAssertEqual(behavior.state, 1)`
`37`	`37`	`}`
`38`	`38`
`39`		`- func testGetWorkServerInternalError() {`
	`39`	`+ func testGetInvocationServerInternalError() {`
`40`	`40`	`struct Behavior: LambdaServerBehavior {`
`41`		`- func getWork() -> GetWorkResult {`
	`41`	`+ func getInvocation() -> GetInvocationResult {`
`42`	`42`	`.failure(.internalServerError)`
`43`	`43`	`}`
`44`	`44`
`@@ -62,9 +62,9 @@ class LambdaRuntimeClientTest: XCTestCase {`
`62`	`62`	`}`
`63`	`63`	`}`
`64`	`64`
`65`		`- func testGetWorkServerNoBodyError() {`
	`65`	`+ func testGetInvocationServerNoBodyError() {`
`66`	`66`	`struct Behavior: LambdaServerBehavior {`
`67`		`- func getWork() -> GetWorkResult {`
	`67`	`+ func getInvocation() -> GetInvocationResult {`
`68`	`68`	`.success(("1", ""))`
`69`	`69`	`}`
`70`	`70`
`@@ -88,9 +88,9 @@ class LambdaRuntimeClientTest: XCTestCase {`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`
`91`		`- func testGetWorkServerMissingHeaderRequestIDError() {`
	`91`	`+ func testGetInvocationServerMissingHeaderRequestIDError() {`
`92`	`92`	`struct Behavior: LambdaServerBehavior {`
`93`		`- func getWork() -> GetWorkResult {`
	`93`	`+ func getInvocation() -> GetInvocationResult {`
`94`	`94`	`// no request id -> no context`
`95`	`95`	`.success(("", "hello"))`
`96`	`96`	`}`
`@@ -117,7 +117,7 @@ class LambdaRuntimeClientTest: XCTestCase {`
`117`	`117`
`118`	`118`	`func testProcessResponseInternalServerError() {`
`119`	`119`	`struct Behavior: LambdaServerBehavior {`
`120`		`- func getWork() -> GetWorkResult {`
	`120`	`+ func getInvocation() -> GetInvocationResult {`
`121`	`121`	`.success((requestId: "1", payload: "payload"))`
`122`	`122`	`}`
`123`	`123`
`@@ -142,7 +142,7 @@ class LambdaRuntimeClientTest: XCTestCase {`
`142`	`142`
`143`	`143`	`func testProcessErrorInternalServerError() {`
`144`	`144`	`struct Behavior: LambdaServerBehavior {`
`145`		`- func getWork() -> GetWorkResult {`
	`145`	`+ func getInvocation() -> GetInvocationResult {`
`146`	`146`	`.success((requestId: "1", payload: "payload"))`
`147`	`147`	`}`
`148`	`148`
`@@ -167,8 +167,8 @@ class LambdaRuntimeClientTest: XCTestCase {`
`167`	`167`
`168`	`168`	`func testProcessInitErrorOnBootstrapFailure() {`
`169`	`169`	`struct Behavior: LambdaServerBehavior {`
`170`		`- func getWork() -> GetWorkResult {`
`171`		`- XCTFail("should not get work")`
	`170`	`+ func getInvocation() -> GetInvocationResult {`
	`171`	`+ XCTFail("should not get invocation")`
`172`	`172`	`return .failure(.internalServerError)`
`173`	`173`	`}`
`174`	`174`
`@@ -217,7 +217,7 @@ class LambdaRuntimeClientTest: XCTestCase {`
`217`	`217`	`return .success(())`
`218`	`218`	`}`
`219`	`219`
`220`		`- func getWork() -> GetWorkResult {`
	`220`	`+ func getInvocation() -> GetInvocationResult {`
`221`	`221`	`self.state += 2`
`222`	`222`	`return .success(("1", "hello"))`
`223`	`223`	`}`
Original file line number	Diff line number	Diff line change
`@@ -100,8 +100,8 @@ class LambdaTest: XCTestCase {`
`100`	`100`
`101`	`101`	`func testBootstrapFailureAndReportErrorFailure() {`
`102`	`102`	`struct Behavior: LambdaServerBehavior {`
`103`		`- func getWork() -> GetWorkResult {`
`104`		`- XCTFail("should not get work")`
	`103`	`+ func getInvocation() -> GetInvocationResult {`
	`104`	`+ XCTFail("should not get invocation")`
`105`	`105`	`return .failure(.internalServerError)`
`106`	`106`	`}`
`107`	`107`
`@@ -212,7 +212,7 @@ class LambdaTest: XCTestCase {`
`212`	`212`	`defer { XCTAssertNoThrow(try server.stop().wait()) }`
`213`	`213`
`214`	`214`	`struct Behavior: LambdaServerBehavior {`
`215`		`- func getWork() -> GetWorkResult {`
	`215`	`+ func getInvocation() -> GetInvocationResult {`
`216`	`216`	`.failure(.internalServerError)`
`217`	`217`	`}`
`218`	`218`
`@@ -299,7 +299,7 @@ private struct Behavior: LambdaServerBehavior {`
`299`	`299`	`self.result = result`
`300`	`300`	`}`
`301`	`301`
`302`		`- func getWork() -> GetWorkResult {`
	`302`	`+ func getInvocation() -> GetInvocationResult {`
`303`	`303`	`.success((requestId: self.requestId, payload: self.payload))`
`304`	`304`	`}`
`305`	`305`
`@@ -334,8 +334,8 @@ private struct Behavior: LambdaServerBehavior {`
`334`	`334`	`}`
`335`	`335`
`336`	`336`	`struct FailedBootstrapBehavior: LambdaServerBehavior {`
`337`		`- func getWork() -> GetWorkResult {`
`338`		`- XCTFail("should not get work")`
	`337`	`+ func getInvocation() -> GetInvocationResult {`
	`338`	`+ XCTFail("should not get invocation")`
`339`	`339`	`return .failure(.internalServerError)`
`340`	`340`	`}`
`341`	`341`