Merge pull request #32 from Andrea-Scuderi/feature/Redis

Feature/redis

Author: Andrea-Scuderi

.travis.yml

@@ -50,6 +50,11 @@ script:
   - make invoke_lambda_local SWIFT_EXECUTABLE=S3Test SWIFT_PROJECT_PATH=Examples/S3Test LAMBDA_FUNCTION_NAME=S3Test LAMBDA_HANDLER=S3Test.getObject
   - make stop_docker_compose_env SWIFT_EXECUTABLE=S3Test SWIFT_PROJECT_PATH=Examples/S3Test LAMBDA_FUNCTION_NAME=S3Test LAMBDA_HANDLER=S3Test.getObject
   - make test_lambda_local_output SWIFT_EXECUTABLE=S3Test SWIFT_PROJECT_PATH=Examples/S3Test LAMBDA_FUNCTION_NAME=S3Test LAMBDA_HANDLER=S3Test.getObject
+  - make build_lambda_local SWIFT_EXECUTABLE=RedisDemo SWIFT_PROJECT_PATH=Examples/RedisDemo LAMBDA_FUNCTION_NAME=RedisDemo LAMBDA_HANDLER=$(SWIFT_EXECUTABLE).setGet
+  - make start_docker_compose_env SWIFT_EXECUTABLE=RedisDemo SWIFT_PROJECT_PATH=Examples/RedisDemo LAMBDA_FUNCTION_NAME=RedisDemo LAMBDA_HANDLER=$(SWIFT_EXECUTABLE).setGet
+  - make invoke_lambda_local SWIFT_EXECUTABLE=RedisDemo SWIFT_PROJECT_PATH=Examples/RedisDemo LAMBDA_FUNCTION_NAME=RedisDemo LAMBDA_HANDLER=$(SWIFT_EXECUTABLE).setGet
+  - make stop_docker_compose_env SWIFT_EXECUTABLE=RedisDemo SWIFT_PROJECT_PATH=Examples/RedisDemo LAMBDA_FUNCTION_NAME=RedisDemo LAMBDA_HANDLER=$(SWIFT_EXECUTABLE).setGet
+  - make test_lambda_local_output SWIFT_EXECUTABLE=RedisDemo SWIFT_PROJECT_PATH=Examples/RedisDemo LAMBDA_FUNCTION_NAME=RedisDemo LAMBDA_HANDLER=$(SWIFT_EXECUTABLE).setGet
 
 deploy:
   provider: releases

Examples/HTTPSRequest/Makefile

@@ -5,4 +5,4 @@ start_docker_compose_env:
 	cd $(SWIFT_PROJECT_PATH); docker-compose up -d; sleep 5
 
 stop_docker_compose_env:
-	cd $(SWIFT_PROJECT_PATH); sleep 5; docker-compose stop
+	cd $(SWIFT_PROJECT_PATH); docker-compose stop

Examples/HTTPSRequest/docker-compose.yml

@@ -8,7 +8,7 @@ services:
         - ../../swift-shared-libs:/opt/swift-shared-libs:ro,delegated
     environment:
       - DOCKER_LAMBDA_STAY_OPEN=1
-      - AWS_LAMBDA_FUNCTION_TIMEOUT=3
+      - AWS_LAMBDA_FUNCTION_TIMEOUT=10
       - LAMB_CI_EXEC=1
     command:
       - HTTPSRequest.getHttps

Examples/HelloWorld/docker-compose.yml

@@ -8,7 +8,7 @@ services:
         - ../../swift-shared-libs:/opt/swift-shared-libs:ro,delegated
     environment:
       - DOCKER_LAMBDA_STAY_OPEN=1
-      - AWS_LAMBDA_FUNCTION_TIMEOUT=3
+      - AWS_LAMBDA_FUNCTION_TIMEOUT=10
       - LAMB_CI_EXEC=1
     command:
       - HelloWorld.helloWorld

Examples/RedisDemo/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.build
+/Packages
+*.xcodeproj

Examples/RedisDemo/.swiftlint.yml

@@ -0,0 +1,49 @@
+disabled_rules: # rule identifiers to exclude from running
+  - superfluous_disable_command
+  - trailing_comma
+#  - colon
+#  - comma
+#  - control_statement
+#opt_in_rules: # some rules are only opt-in
+#  - empty_count
+#  - missing_docs
+  # Find all the available rules by running:
+  # swiftlint rules
+#included: # paths to include during linting. `--path` is ignored if present.
+#  - Source
+excluded: # paths to ignore during linting. Takes precedence over `included`.
+  - Carthage
+  - Pods
+  - .build
+# configurable rules can be customized from this configuration file
+# binary rules can set their severity level
+force_cast: warning # implicitly
+force_try:
+  severity: warning # explicitly
+# rules that have both warning and error levels, can set just the warning level
+# implicitly
+line_length: 150
+# they can set both implicitly with an array
+#type_body_length:
+#  - 300 # warning
+#  - 400 # error
+# or they can set both explicitly
+#file_length:
+#  warning: 500
+#  error: 1200
+# naming rules can set warnings/errors for min_length and max_length
+# additionally they can set excluded names
+#type_name#
+#  min_length: 4 # only warning
+#  max_length: # warning and error
+#    warning: 40
+#    error: 50
+#  excluded: iPhone # excluded via string
+#variable_name:
+#  min_length: # only min_length
+#    error: 4 # only error
+#  excluded: # excluded via string array
+#    - id
+#    - URL
+#    - GlobalAPIKey
+reporter: "xcode" # reporter type (xcode, json, csv, checkstyle)

Examples/RedisDemo/Makefile

@@ -0,0 +1,8 @@
+# Note: This must be launched from the root path
+SWIFT_PROJECT_PATH=Examples/RedisDemo
+
+start_docker_compose_env:
+	cd $(SWIFT_PROJECT_PATH); docker-compose up -d; sleep 5
+
+stop_docker_compose_env:
+	cd $(SWIFT_PROJECT_PATH); docker-compose stop

Examples/RedisDemo/Package.resolved

@@ -0,0 +1,25 @@
+// swift-tools-version:5.1
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "RedisDemo",
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        // .package(url: /* package url */, from: "1.0.0"),
+        .package(url: "https://github.com/swift-sprinter/aws-lambda-swift-sprinter-nio-plugin", from: "1.0.0-alpha.3"),
+        .package(url: "https://gitlab.com/mordil/swift-redi-stack.git", from: "1.0.0-alpha.5"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A starget can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages which this package depends on.
+        .target(
+            name: "RedisDemo",
+            dependencies: ["LambdaSwiftSprinterNioPlugin", "Logging", "RediStack"]),
+        .testTarget(
+            name: "RedisDemoTests",
+            dependencies: ["RedisDemo"]),
+    ]
+)

Examples/RedisDemo/Package.swift

@@ -0,0 +1,152 @@
+# RedisDemo
+
+[![Swift 5](https://img.shields.io/badge/Swift-5.0-blue.svg)](https://swift.org/download/) [![Swift 5.1.3](https://img.shields.io/badge/Swift-5.1.3-blue.svg)](https://swift.org/download/)
+
+This example shows the usage of the [LambdaSwiftSprinter](https://github.com/swift-sprinter/aws-lambda-swift-sprinter-core) framework and the plugin [LambdaSwiftSprinterNioPlugin](https://github.com/swift-sprinter/aws-lambda-swift-sprinter-nio-plugin) to build a lambda capable to perform an Redis request using
+[RediStack](https://gitlab.com/mordil/swift-redi-stack.git).
+
+## Swift code
+
+Define an Event and a Response as Codable.
+```swift
+import AsyncHTTPClient
+import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
+import LambdaSwiftSprinter
+import LambdaSwiftSprinterNioPlugin
+import Logging
+import NIO
+import NIOFoundationCompat
+import RediStack
+
+struct Event: Codable {
+    let key: String
+    let value: String
+}
+
+struct Response: Codable {
+    let value: String
+}
+```
+
+
+
+Add a loger:
+```swift
+let logger = Logger(label: "AWS.Lambda.Redis")
+```
+
+Add a redis connection:
+```swift
+let elasticacheConfigEndpoint = "redis"
+
+let eventLoop = httpClient.eventLoopGroup.next()
+let connection = try? RedisConnection.connect(
+        to: try .makeAddressResolvingHost(elasticacheConfigEndpoint,
+                                          port: RedisConnection.defaultPort),
+        on: eventLoop
+    ).wait()
+
+
+
+enum LambdaError: Error {
+    case redisConnectionFailed
+}
+```
+
+Define the Lambda:
+```swift
+let syncCodableNIOLambda: SyncCodableNIOLambda<Event, Response> = { (event, context) throws -> EventLoopFuture<Response> in
+    
+    guard let connection = connection else {
+        throw LambdaError.redisConnectionFailed
+    }
+    
+    let future = connection.set(event.key, to: event.value)
+        .flatMap {
+            return connection.get(event.key)
+        }
+        .map { content -> Response in
+            return Response(value: content ?? "")
+        }
+    return future
+}
+```
+
+If there are not error, the Event will be automatically decoded inside the lambda and then used to perform a `set` and a `get` to Redis.
+The value of the `get` is returned into the Response.
+
+Then use this boilerplate code to run the lambda:
+```swift
+do {
+    
+    let sprinter = try SprinterNIO()
+    sprinter.register(handler: "setGet", lambda: syncCodableNIOLambda)
+    
+    try sprinter.run()
+} catch {
+    logger.error("\(String(describing: error))")
+}
+```
+
+This will initialize the Sprinter with a Sprinter based on NIO 2 library.
+
+Then the internal handler `setGet` is being registered.
+
+Finally the sprinter run.
+
+Any error will be logged.
+
+Note
+
+In this example we used [swift-log](https://github.com/apple/swift-log.git) to log the output.
+
+## Deployment
+
+To build this example make sure the following lines on the `Makefile` are not commented and the other example configurations are commented.
+
+```
+...
+
+# HelloWorld Example Configuration
+# SWIFT_EXECUTABLE=HelloWorld
+# SWIFT_PROJECT_PATH=Examples/HelloWorld
+# LAMBDA_FUNCTION_NAME=HelloWorld
+# LAMBDA_HANDLER=$(SWIFT_EXECUTABLE).helloWorld
+
+....
+
+# RedisDemo Example Configuration
+SWIFT_EXECUTABLE?=RedisDemo
+SWIFT_PROJECT_PATH?=Examples/RedisDemo
+LAMBDA_FUNCTION_NAME?=RedisDemo
+LAMBDA_HANDLER?=$(SWIFT_EXECUTABLE).setGet
+
+...
+```
+
+Then follow the main [README](https://github.com/swift-sprinter/aws-lambda-swift-sprinter) to build and test the code.
+
+## Test
+
+The test event is defined in the file `event.json`
+```json
+{
+    "key": "language",
+    "value": "Swift"
+}
+```
+
+expected response:
+
+```json
+{"value":"Swift"}
+```
+
+Change it to try different output and error conditions.
+
+# LambdaSwiftSprinter
+
+To know more refer to [LambdaSwiftSprinter](https://github.com/swift-sprinter/aws-lambda-swift-sprinter-core).