juanroldan1989 / serverless-color-tracking

[Serverless Framework] :robot: Live Events Tracking :vertical_traffic_light: Clicks & Hovers on Colors :dart: Dashboards

Serverless Color Tracking Platform

Events Tracking Platform 🚦 Clicks & Hovers on Colors 🎯 Live Graphs & Counters

Home page

Admin page

Backend

Core Features

• Create events based on user's actions (/v1/events endpoint):

$ curl -X POST \
  -H "Content-Type: application/json" \
  -H "x-api-key: <api-key>" \
  -d '{ "action" : "hover", "color" : "red" }' \
  https://<api-id>.execute-api.<region>.amazonaws.com/dev/v1/events

> {"message": "Message placed in serverless-color-tracking-dev-hoversStream successfully."}%

• Get stats filtered by action value via "polling" implementation through REST API endpoint available:

$ curl -H "Content-Type: application/json" \
  -H "x-api-key: <api-key>" \
  https://<api-id>.execute-api.<region>.amazonaws.com/dev/v1/stats?action=click

• Server broadcasts stats via websockets. This way the API can push updates across clients using an specific API Key:

$(document).ready(function() {
  var socket;

  // Websocket connection opened
  socket = new ReconnectingWebSocket("wss://<api-id>.execute-api.<region>.amazonaws.com/dev");

  // API Key associated with the connection
  socket.onopen = function(event) {
    data = {"action": "add_api_key", "api_key" : "api_key"};
    socket.send(JSON.stringify(data));
  };

  // Setup listener for messages
  socket.onmessage = function(message) {
    var data = JSON.parse(message.data);

    if (data.event_type == "hover") {
      drawDashboard(data, "hovers");
    } else if (data.event_type == "click") {
      drawDashboard(data, "clicks");
    }
  };
});

Deployment

Frontend (Home/Admin)

• Docker container running static website: https://www.back4app.com/docs-containers/run-a-static-website-on-containers

Backend

$ sls deploy

Deploying serverless-color-tracking to stage dev (<region-id>)

✔ Service deployed to stack serverless-color-tracking-dev (46s)

endpoints:
  POST - https://<api-id>.execute-api.<region-id>.amazonaws.com/dev/v1/events
  GET - https://<api-id>.execute-api.<region-id>.amazonaws.com/dev/v1/stats
  GET - https://<api-id>.execute-api.<region-id>.amazonaws.com/dev/admin/v1/stats
  wss://<wss-api-id>.execute-api.<region-id>.amazonaws.com/dev
functions:
  createEvent: serverless-color-tracking-dev-createEvent (77 MB)
  clicksConsumer: serverless-color-tracking-dev-clicksConsumer (77 MB)
  hoversConsumer: serverless-color-tracking-dev-hoversConsumer (77 MB)
  broadcastClicks: serverless-color-tracking-dev-broadcastClicks (77 MB)
  broadcastHovers: serverless-color-tracking-dev-broadcastHovers (77 MB)
  broadcastAdminStats: serverless-color-tracking-dev-broadcastAdminStats (77 MB)
  getStats: serverless-color-tracking-dev-getStats (77 MB)
  getAdminStats: serverless-color-tracking-dev-getAdminStats (77 MB)
  websocketConnections: serverless-color-tracking-dev-websocketConnections (77 MB)

Monitoring & Troubleshooting

• Lumigo end-to-end story of every request with payload data and stack traces so you can troubleshoot in a single view.

Bundling dependencies

In case you would like to include third-party dependencies, you will need to use a plugin called serverless-python-requirements. You can set it up by running the following command:

serverless plugin install -n serverless-python-requirements

Running the above will automatically add serverless-python-requirements to plugins section in your serverless.yml file and add it as a devDependency to package.json file. The package.json file will be automatically created if it doesn't exist beforehand. Now you will be able to add your dependencies to requirements.txt file (Pipfile and pyproject.toml is also supported but requires additional configuration) and they will be automatically injected to Lambda package during build process. For more details about the plugin's configuration, please refer to official documentation.

Deep Dive DynamoDB queries

https://staskoltsov.medium.com/deep-dive-into-query-and-filter-operations-in-dynamodb-ccfe4ef24e02

https://dynobase.dev/dynamodb-filterexpression/

CORS with Serverless

https://www.serverless.com/blog/cors-api-gateway-survival-guide

AWS Lazy initialization

https://pages.awscloud.com/rs/112-TZM-766/images/2020_0316-SRV_Slide-Deck.pdf

import boto3

S3_client = None
ddb_client = None

def get_objects(event, context):
  if not s3_client:
    s3_client = boto3.client("s3")
  # business logic

def get_items(event, context):
  if not ddb_client:
    ddb_client = boto3.client("dynamodb")
  # business logic

AWS Websockets

https://docs.amazonaws.cn/en_us/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-wscat.html

https://ably.com/blog/how-to-build-a-serverless-websocket-platform

10 Realtime Data sources: https://ably.com/blog/10-realtime-data-sources-you-wont-believe-are-free

https://levelup.gitconnected.com/creating-a-chat-app-with-serverless-websockets-and-python-a-tutorial-54cbc432e4f

Testing:

$ npm install -g wscat

Connect to your endpoint using the wss:// url from your deploy output:

wscat -c <YOUR_WEBSOCKET_ENDPOINT>
connected (press CTRL+C to quit)
>

Send a message. Note that the action key in the message is used for the route selection, all other keys can be changed to your liking:

> {"action": "live", "api_key": "api_key", "event_type": "click"}
> {"action": "live", "api_key": "api_key", "event_type": "hover"}

Terraform static website

https://dev.to/aws-builders/how-to-deploy-a-serverless-website-with-terraform-5677