aws-classify-server 0.1.7 → 0.1.9

package/README.md

@@ -35,6 +35,9 @@ On the client project
 ```npm install aws-classify-common, aws-classify-client```
 
 The framework has been tested with popular client software such as Expo for mobile and React Native for web.
+## Kicking the Tires
+
+Because aws-classify involves multiple sub-projects (web, mobile, aws back-end) the best way to get started is to fork or checkout this sample [chat application](https://github.com/selsamman/aws-classify-example-simple-chat) that contains some simple Lambda response classes and a mobile/web front-end. 
 
 ## Calling Lambda Functions from the Client
 
@@ -179,20 +182,17 @@ Root
 - node_modules (just bisync)
 - cloud
   - serverless.yml
-  - server-requests (contains request classes implemented on the server)
-  - server-responses (contains implementations on server)
-  - client-requests (contains request classes implented on the client)
+  - requests (request classes)
+  - responses (contains implementations of requests from client)
 - web (could be a project created with create-react-app)
-  - server-requests (contains request classes implemented on the server) 
-  - client-requests (contains request classes implented on the client)
-  - client-responses (contains implementation on client)
+  - requests (requests) 
+  - responses (contains implementation of requests from the server)
   - other files pertaining to the client and static website   
 ```
 You would then configure bisync.json to keep the shared code in sync
 ```
 [
-    ["./cloud/client-requests", "./web/client-requests"],
-    ["./clout/server-requests", "./web/server-requests"]
+    ["./cloud/requests", "./web/requests"],
 ]    
 ```
 Implementing shared code this way avoid restrictions that packaging schemes have that effectively require code to be present in project tree
@@ -304,7 +304,7 @@ resources:
 ```
 
 To deploy you need to:
-- Create AWS credentials using the AWS console as defined in the Serverless [documents](https://www.serverless.com/framework/docs/providers/aws/guide/credentials/documentation)
+- Create AWS credentials using the AWS console as defined in the Serverless [documents](https://www.serverless.com/framework/docs/providers/aws/guide/credentials)
 - Install and setup credentials You need to setup your credentials with serverless
 ```	
 serverless config credentials \
@@ -323,8 +323,13 @@ sls s3sync
 serverless deploy stage prod 
 sls s3sync 
 ```
+## Limitations
+* AWS Websockets are limited to 10 minutes
+* No locking mechanism for simultaneous lambda function execution which could cause sessions to be over-ridden with the last one to complete
+* The session key is not periodically updated as the actual database key is used
+* No mechanism to have session alternatives to DynamoDB (for example, REDIS, JWT)
 ## Roadmap
-* Create some sample applications
+* Create template/scripts for getting started (currently starting with chat) sample app is the easiest way to use this library.
 * Continued shakeout with real-world applications
 * Community feedback
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aws-classify-server",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "main": "./lib/cjs/index.js",
   "module": "./lib/esm/index.js",
   "types": "./lib/esm/index.d.ts",

package/yml/resources-custom-website.yml

@@ -50,6 +50,11 @@ Resources:
           # https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html
           OriginRequestPolicyId: 88a5eaf4-2fd4-4709-b370-b4c650ea3fcf
           ViewerProtocolPolicy: redirect-to-https
+        CustomErrorResponses:
+          - ErrorCachingMinTTL: 1
+            ErrorCode: 403
+            ResponseCode: 200
+            ResponsePagePath: "/"
   S3Bucket:
     Type: AWS::S3::Bucket
     Properties:

package/yml/resources-dynamodb-stream.yml

@@ -21,4 +21,6 @@ Resources:
           - AttributeName: userId
             KeyType: HASH
         Projection:
-          ProjectionType: KEYS_ONLY
+          ProjectionType: KEYS_ONLY
+      StreamSpecification:
+        StreamViewType: ${self:custom.SessionStreamViewType, 'NEW_AND_OLD_IMAGES'}

package/yml/resources-dynamodb.yml

@@ -21,6 +21,4 @@ Resources:
           - AttributeName: userId
             KeyType: HASH
         Projection:
-          ProjectionType: KEYS_ONLY
-      StreamSpecification:
-        StreamViewType: ${self:custom.SessionStreamViewType, 'NEW_AND_OLD_IMAGES'}
+          ProjectionType: KEYS_ONLY

package/yml/resources-website.yml

@@ -46,6 +46,11 @@ Resources:
           # https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html
           OriginRequestPolicyId: 88a5eaf4-2fd4-4709-b370-b4c650ea3fcf
           ViewerProtocolPolicy: redirect-to-https
+        CustomErrorResponses:
+          - ErrorCachingMinTTL: 1
+            ErrorCode: 403
+            ResponseCode: 200
+            ResponsePagePath: "/"
   S3Bucket:
     Type: AWS::S3::Bucket
     Properties: