Skip to content

Latest commit

 

History

History
282 lines (200 loc) · 9.61 KB

README.md

File metadata and controls

282 lines (200 loc) · 9.61 KB
Raw

Serverless TWEET

To implement this project, you need to implement a simple TWEET application using AWS Lambda and Serverless framework. Search for all comments starting with the TWEET: in the code to find the placeholders that you need to implement.

Functionality of the application

This application will allow creating/removing/updating/fetching TWEET items. Each TWEET item can optionally have an attachment image. Each user only has access to TWEET items that he/she has created.

TWEET items

The application should store TWEET items, and each TWEET item contains the following fields:

  • tweetId (string) - a unique id for an item
  • createdAt (string) - date and time when an item was created
  • thought (string) - Contents of a TWEET item (e.g. "#climateChange is real")
  • attachmentUrl (string) (optional) - a URL pointing to an image attached to a TWEET item

You might also store an id of a user who created a TWEET item.

Prerequisites

  • Auth0 account

  • GitHub account

  • NodeJS version up to 12.xx

  • Serverless

    npm install -g [email protected]
serverless --version
    • Login and configure serverless to use the AWS credentials
    # Login to your dashboard from the CLI. It will ask to open your browser and finish the process.
serverless login
# Configure serverless to use the AWS credentials to deploy the application
# You need to have a pair of Access key (YOUR_ACCESS_KEY_ID and YOUR_SECRET_KEY) of an IAM user with Admin access permissions
sls config credentials --provider aws --key YOUR_ACCESS_KEY_ID --secret YOUR_SECRET_KEY --profile serverless

Functions implemented

To implement this project, you need to implement the following functions and configure them in the serverless.yml file:

  • Auth - this function should implement a custom authorizer for API Gateway that should be added to all other functions.

  • GetTweets - should return all TWEETS for a current user. A user id can be extracted from a JWT token that is sent by the frontend

It should return data that looks like this:

{
  "items": [
    {
      "tweetId": "123",
      "createdAt": "2019-07-27T20:01:45.424Z",
      "thought": "Buy milk",
      "attachmentUrl": "http://example.com/image.png"
    },
    {
      "tweetId": "456",
      "createdAt": "2019-07-27T20:01:45.424Z",
      "thought": "Send a letter",
      "attachmentUrl": "http://example.com/image.png"
    },
  ]
}
  • CreateTweet - should create a new TWEET for a current user. A shape of data send by a client application to this function can be found in the CreateTweetRequest.ts file

It receives a new TWEET item to be created in JSON format that looks like this:

{
  "createdAt": "2019-07-27T20:01:45.424Z",
  "thought": "Buy milk",
  "attachmentUrl": "http://example.com/image.png"
}

It should return a new TWEET item that looks like this:

{
  "item": {
    "tweetId": "123",
    "createdAt": "2019-07-27T20:01:45.424Z",
    "thought": "Buy milk",
    "attachmentUrl": "http://example.com/image.png"
  }
}
  • UpdateTweet - should update a TWEET item created by a current user. A shape of data send by a client application to this function can be found in the UpdateTweetRequest.ts file

It receives an object that contains three fields that can be updated in a TWEET item:

{
  "thought": "Buy bread",
}

The id of an item that should be updated is passed as a URL parameter.

It should return an empty body.

  • DeleteTweet - should delete a TWEET item created by a current user. Expects an id of a TWEET item to remove.

It should return an empty body.

  • GenerateUploadUrl - returns a pre-signed URL that can be used to upload an attachment file for a TWEET item.

It should return a JSON object that looks like this:

{
  "uploadUrl": "https://s3-bucket-name.s3.eu-west-2.amazonaws.com/image.png"
}

  • SendUploadNotifications - sends a notification when a new imagee is attached to a tweet.

  • ConnectHandler - React to connect messages when a user connects to the API Gateway.

  • DisconnectHandler - React to when when a user disconnects from the API Gateway. this enables to us to know the list of users to send notifications to.

An id of a user can be extracted from a JWT token passed by a client.

You also need to add any necessary resources to the resources section of the serverless.yml file such as DynamoDB table and S3 bucket.

Frontend

The client folder contains a web application that can use the API that should be developed in the project.

This frontend should work with your serverless application once it is developed, you don't need to make any changes to the code. The only file that you need to edit is the config.ts file in the client folder. This file configures your client application just as it was done in the course and contains an API endpoint and Auth0 configuration:

const apiId = '...' API Gateway id
export const apiEndpoint = `https://${apiId}.execute-api.us-east-1.amazonaws.com/dev`

export const authConfig = {
  domain: '...',    // Domain from Auth0
  clientId: '...',  // Client id from an Auth0 application
  callbackUrl: 'http://localhost:3000/callback'
}

Authentication

To implement authentication in your application, you would have to create an Auth0 application and copy "domain" and "client id" to the config.ts file in the client folder. We recommend using asymmetrically encrypted JWT tokens.

Best practices

To complete this exercise, please follow the best practices from the 6th lesson of this course.

Logging

The starter code comes with a configured Winston logger that creates JSON formatted log statements. You can use it to write log messages like this:

import { createLogger } from '../../utils/logger'
const logger = createLogger('auth')

// You can provide additional information with every log statement
// This information can then be used to search for log statements in a log storage system
logger.info('User was authorized', {
  // Additional information stored with a log statement
  key: 'value'
})

Grading the submission

Once you have finished developing your application, please set apiId and Auth0 parameters in the config.ts file in the client folder. A reviewer would start the React development server to run the frontend that should be configured to interact with your serverless application.

IMPORTANT

Please leave your application running until a submission is reviewed. If implemented correctly it will cost almost nothing when your application is idle.

Suggestions

To store TWEET items, you might want to use a DynamoDB table with local secondary index(es). A create a local secondary index you need to create a DynamoDB resource like this:

TweetsTable:
  Type: AWS::DynamoDB::Table
  Properties:
    AttributeDefinitions:
      - AttributeName: partitionKey
        AttributeType: S
      - AttributeName: sortKey
        AttributeType: S
      - AttributeName: indexKey
        AttributeType: S
    KeySchema:
      - AttributeName: partitionKey
        KeyType: HASH
      - AttributeName: sortKey
        KeyType: RANGE
    BillingMode: PAY_PER_REQUEST
    TableName: ${self:provider.environment.TWEETS_TABLE}
    LocalSecondaryIndexes:
      - IndexName: ${self:provider.environment.INDEX_NAME}
        KeySchema:
          - AttributeName: partitionKey
            KeyType: HASH
          - AttributeName: indexKey
            KeyType: RANGE
        Projection:
          ProjectionType: ALL # What attributes will be copied to an index

To query an index you need to use the query() method like:

await this.dynamoDBClient
  .query({
    TableName: 'table-name',
    IndexName: 'index-name',
    KeyConditionExpression: 'paritionKey = :paritionKey',
    ExpressionAttributeValues: {
      ':paritionKey': partitionKeyValue
    }
  })
  .promise()

How to run the application

Backend

To deploy an application run the following commands:

cd backend
npm install
sls deploy -v

Frontend

To run a client application first edit the client/src/config.ts file to set correct parameters. And then run the following commands:

cd client
npm install
npm run start

This should start a development server with the React application that will interact with the serverless TWEET application.

Postman collection

An alternative way to test your API, you can use the Postman collection that contains sample requests. You can find a Postman collection in this project. To import this collection, do the following.

Click on the import button:

Alt text

Click on the "Choose Files":

Alt text

Select a file to import:

Alt text

Right click on the imported collection to set variables for the collection:

Alt text

Provide variables for the collection (similarly to how this was done in the course):

Alt text