API Refactoring #273

tomerd · 2022-10-07T16:45:37Z

refactoring the API for 1.0

motivation: define stable API in preperation 1.0 release changes: * require swift 5.7, remove redundant backwards compatibility code * make LambdaHandler, EventLoopLambdaHandler, and ByteBufferLambdaHandler disjointed protocols to reduce API surface area * create coding wrappers for LambdaHandler and EventLoopLambdaHandler to provide coding bridge * reuse output ByteBuffer to reduce allocationsi * add no-op initializer for simple landa use cases * update callsites and tests

tomerd · 2022-10-08T00:18:38Z

@fabianfett ptal

Examples/ErrorHandling/Lambda.swift

Examples/JSON/Lambda.swift

Examples/LocalDebugging/MyLambda/Lambda.swift

Sources/AWSLambdaRuntime/Lambda+Codable.swift

Sources/AWSLambdaRuntimeCore/LambdaHandler.swift

fabianfett

Great progress! Love the Handlers that don't depend on each other anymore. However we should preserve the types were feasible. And also I don't think we can get rid of the required initializer that easily.

Sources/AWSLambdaRuntimeCore/LambdaContext.swift

Sources/AWSLambdaRuntimeCore/Terminator.swift

Sources/AWSLambdaRuntimeCore/LambdaHandler.swift

fabianfett · 2022-10-10T08:22:51Z

Sources/AWSLambdaRuntimeCore/LambdaRunner.swift

@@ -33,7 +33,7 @@ internal final class LambdaRunner {
    /// Run the user provided initializer. This *must* only be called once.
    ///
    /// - Returns: An `EventLoopFuture<LambdaHandler>` fulfilled with the outcome of the initialization.
-    func initialize<Handler: ByteBufferLambdaHandler>(logger: Logger, terminator: LambdaTerminator, handlerType: Handler.Type) -> EventLoopFuture<Handler> {
+    func initialize(handlerType: (some ByteBufferLambdaHandler).Type, logger: Logger, terminator: LambdaTerminator) -> EventLoopFuture<any ByteBufferLambdaHandler> {


We must enforce 5.7 if we want to use this syntax. Currently we require 5.6. Also IMO we def. should not return any here. We should preserve the type.

this PR already changes the requirement to 5.7, unless I missed something?

It only changes this for all the examples. It also drops the 5.4 and 5.5 Package.swift. But the Package.swift without version only requires 5.6.

Also I think you are required to use the old generic syntax here, if we don't want to drop the types. Since we need create a connection between the input and the output type.

But the Package.swift without version only requires 5.6.

good catch

Also I think you are required to use the old generic syntax here, if we don't want to drop the types. Since we need create a connection between the input and the output type.

I don't think this can work with the old syntax. the Handler type is stored in LambdaRuntime which needs to loose it old generic signature, so they do not align any more

fabianfett · 2022-10-10T08:23:53Z

Sources/AWSLambdaRuntimeCore/LambdaRunner.swift

-        return Handler.makeHandler(context: context)
+
+        return handlerType.makeHandler(context: context)
+            .map { $0 as any ByteBufferLambdaHandler }


don't drop types here.

this was required to make the type system happy. do you have a better way to do this?

we don't need to drop here, if we keep the old syntax above.

fabianfett · 2022-10-10T08:24:06Z

Sources/AWSLambdaRuntimeCore/LambdaRunner.swift

@@ -58,7 +60,7 @@ internal final class LambdaRunner {
            }
    }

-    func run<Handler: ByteBufferLambdaHandler>(logger: Logger, handler: Handler) -> EventLoopFuture<Void> {
+    func run(logger: Logger, handler: any ByteBufferLambdaHandler) -> EventLoopFuture<Void> {


no type dropping here.

fabianfett · 2022-10-10T08:24:38Z

Sources/AWSLambdaRuntimeCore/LambdaRuntime.swift

@@ -19,34 +19,58 @@ import NIOCore
 /// `LambdaRuntime` manages the Lambda process lifecycle.
 ///
 /// Use this API, if you build a higher level web framework which shall be able to run inside the Lambda environment.
-public final class LambdaRuntime<Handler: ByteBufferLambdaHandler> {
+public final class LambdaRuntime {


We did we drop the type here?

this was required to remove the conformance to ByteBufferLambdaHandler from the other protocols, as otherwise initializing LambdaRuntime would require it. Do you have a better solution in mind?

Co-authored-by: Yim Lee <yim_lee@apple.com>

Sources/AWSLambdaRuntimeCore/Lambda+String.swift

* Preserve Types. * Go inline!

tomerd · 2022-10-19T18:11:17Z

@fabianfett now with your changes. thank you

benrosen78 · 2023-01-11T16:14:55Z

Hi there. Is there any update on when v1.0 will be released with the Swift async/await support? I am excited to use this in my software!

tomerd · 2023-01-11T22:28:35Z

hi @benrosen78 we are planning to tag the first 1.0 alpha in the next few weeks. you can use it already by pulling the "main" branch in your dependency

tomerd marked this pull request as draft October 7, 2022 16:45

tomerd mentioned this pull request Oct 7, 2022

Improves Developer Ergonomics for LambdaHandler Conformances #272

Closed

tomerd added the ⚠️ needs-major-version-bump For PRs that when merged cause a bump of the major version, ie. x.0.0 -> (x+1).0.0 label Oct 7, 2022

tomerd added this to the 1.0.0-alpha.1 milestone Oct 7, 2022

tomerd force-pushed the api-refactor branch from 5e74dad to 9f7cf33 Compare October 7, 2022 23:48

tomerd changed the title ~~RFC: API Refactoring~~ API Refactoring Oct 7, 2022

tomerd force-pushed the api-refactor branch 5 times, most recently from 0fe7b23 to 4f01da2 Compare October 8, 2022 00:04

tomerd force-pushed the api-refactor branch from 4f01da2 to 457e0c3 Compare October 8, 2022 00:05

tomerd marked this pull request as ready for review October 8, 2022 00:18

update examples

9258f8e

tomerd mentioned this pull request Oct 8, 2022

add new abstraction for simple Lambda that does not need explicit initialization #259

Closed

tomerd requested review from fabianfett and yim-lee and removed request for fabianfett October 8, 2022 01:01

yim-lee reviewed Oct 8, 2022

View reviewed changes

stevapple reviewed Oct 8, 2022

View reviewed changes

Sources/AWSLambdaRuntimeCore/LambdaHandler.swift Show resolved Hide resolved

Sources/AWSLambdaRuntimeCore/LambdaHandler.swift Show resolved Hide resolved

fabianfett requested changes Oct 10, 2022

View reviewed changes

Apply suggestions from code review

2ed058b

Co-authored-by: Yim Lee <yim_lee@apple.com>

tomerd force-pushed the api-refactor branch from b45bc9b to 8b6569e Compare October 11, 2022 01:02

separate protocol for simpler lambda (no init)

17ed17b

tomerd force-pushed the api-refactor branch from 8b6569e to 17ed17b Compare October 11, 2022 01:23

fabianfett reviewed Oct 12, 2022

View reviewed changes

Sources/AWSLambdaRuntimeCore/Lambda+String.swift Outdated Show resolved Hide resolved

tomerd force-pushed the api-refactor branch from 4a44503 to 2624578 Compare October 13, 2022 18:09

tomerd force-pushed the api-refactor branch from 2624578 to 29244f3 Compare October 13, 2022 18:52

cleanup

91b3a48

tomerd force-pushed the api-refactor branch from 29244f3 to 91b3a48 Compare October 13, 2022 19:55

Preserve Types. (#2)

7745274

* Preserve Types. * Go inline!

fabianfett approved these changes Nov 9, 2022

View reviewed changes

tomerd merged commit c915322 into swift-server:main Nov 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API Refactoring #273

API Refactoring #273

tomerd commented Oct 7, 2022

tomerd commented Oct 8, 2022

fabianfett left a comment

fabianfett Oct 10, 2022

tomerd Oct 10, 2022

fabianfett Oct 12, 2022

fabianfett Oct 12, 2022

tomerd Oct 12, 2022

tomerd Oct 12, 2022

fabianfett Oct 10, 2022

tomerd Oct 10, 2022

fabianfett Oct 12, 2022

fabianfett Oct 10, 2022

tomerd Oct 10, 2022

fabianfett Oct 10, 2022

tomerd Oct 10, 2022 •

edited

Loading

tomerd commented Oct 19, 2022

benrosen78 commented Jan 11, 2023

tomerd commented Jan 11, 2023

API Refactoring #273

API Refactoring #273

Conversation

tomerd commented Oct 7, 2022

tomerd commented Oct 8, 2022

fabianfett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomerd Oct 10, 2022 • edited Loading

Choose a reason for hiding this comment

tomerd commented Oct 19, 2022

benrosen78 commented Jan 11, 2023

tomerd commented Jan 11, 2023

tomerd Oct 10, 2022 •

edited

Loading