Skip to content

Commit

Permalink
Set up Lambda for custom emails (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
ltan02 committed Mar 18, 2024
1 parent f4e411d commit c1b8521
Show file tree
Hide file tree
Showing 17 changed files with 514 additions and 18 deletions.
3 changes: 3 additions & 0 deletions backend/core/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@
CORS_ALLOWED_ORIGINS = [
"http://localhost:3000",
"http://auctions.microvaninc.com",
"http://www.auctions.microvaninc.com",
"https://auctions.microvaninc.com",
"https://www.auctions.microvaninc.com",
]

CORS_ALLOW_CREDENTIALS = True
Expand Down Expand Up @@ -177,6 +179,7 @@
"DEFAULT_AUTHENTICATION_CLASSES": (
"util.authentication.AWSCognitoIDTokenAuthentication",
),
"DEFAULT_PERMISSION_CLASSES": ("rest_framework.permissions.AllowAny",),
}

SIMPLE_JWT = {
Expand Down
27 changes: 18 additions & 9 deletions backend/user/views.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from django.shortcuts import get_object_or_404
from django.shortcuts import get_object_or_404, redirect
from rest_framework import status
from rest_framework.permissions import AllowAny
from rest_framework.response import Response
from rest_framework.views import APIView

Expand All @@ -13,7 +14,9 @@ class BidderListApiView(APIView):

def get_permissions(self):
if self.request.method == "GET":
self.permission_classes = [IsAdminUser]
self.permission_classes = [IsAuthenticated]
else:
self.permission_classes = [AllowAny]
return super().get_permissions()

def get(self, request):
Expand Down Expand Up @@ -303,6 +306,8 @@ def get(self, request):


class LoginAPIView(APIView):
permission_classes = [AllowAny]

cognitoService = AWSCognitoService()

def post(self, request, *args, **kwargs):
Expand Down Expand Up @@ -347,6 +352,8 @@ def post(self, request, *args, **kwargs):


class PasswordResetAPIView(APIView):
permission_classes = [AllowAny]

cognitoService = AWSCognitoService()

def post(self, request, *args, **kwargs):
Expand All @@ -361,6 +368,8 @@ def post(self, request, *args, **kwargs):


class PasswordResetConfirmAPIView(APIView):
permission_classes = [AllowAny]

cognitoService = AWSCognitoService()

def post(self, request, *args, **kwargs):
Expand All @@ -378,17 +387,17 @@ def post(self, request, *args, **kwargs):


class VerifyEmailAPIView(APIView):
permission_classes = [AllowAny]

cognitoService = AWSCognitoService()

def post(self, request, *args, **kwargs):
email = request.data.get("email")
verification_code = request.data.get("verification_code")
def get(self, request, *args, **kwargs):
email = request.query_params.get("email")
verification_code = request.query_params.get("code")

result = self.cognitoService.verify_email(email, verification_code)
if result:
return Response(
{"success": "Email verified successfully."}, status=status.HTTP_200_OK
)
return redirect("https://www.auction.microvaninc.com/register/verified")
else:
return Response(
{"error": "Failed to verify email"}, status=status.HTTP_400_BAD_REQUEST
Expand Down Expand Up @@ -452,7 +461,7 @@ def post(self, request, *args, **kwargs):


class RefreshTokenAPIView(APIView):
permission_classes = [IsAuthenticated]
permission_classes = [AllowAny]

cognitoService = AWSCognitoService()

Expand Down
6 changes: 5 additions & 1 deletion backend/util/authentication.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,12 @@ def has_group(self, group_name):
class AWSCognitoIDTokenAuthentication(authentication.BaseAuthentication):
def authenticate(self, request):
token = request.COOKIES.get("idToken")
unauthenticated_user = GenericAuthenticatedUser()
if not token:
return None
return (unauthenticated_user, None)

if request.path.startswith("/api/v1/auth"):
return (unauthenticated_user, None)

try:
decoded_token = self.verify_jwt_token(token)
Expand Down
6 changes: 5 additions & 1 deletion backend/util/middleware.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
import jwt
from django.utils.deprecation import MiddlewareMixin
from util.jwt import decode_token

from services import AWSCognitoService
from util.jwt import decode_token


class RefreshTokenMiddleware(MiddlewareMixin):
def process_request(self, request):
if request.path.startswith("/api/v1/auth"):
return

refresh_token = request.COOKIES.get("refreshToken")
if not refresh_token:
return
Expand Down
5 changes: 3 additions & 2 deletions backend/vehicle/helpers.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
from .models import Brand, Equipment, Supplier, Trailer, Type, UnitImage, Vehicle
from django.shortcuts import get_object_or_404
import pandas as pd
import requests
from django.shortcuts import get_object_or_404

from .models import Brand, Equipment, Supplier, Trailer, Type, UnitImage, Vehicle
from .serializers import VehicleSerializer


Expand Down
2 changes: 1 addition & 1 deletion backend/vehicle/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
from django.urls import include, path

from .views import (
UploadFileView,
VehicleDetailApiView,
VehicleFilterList,
VehicleListApiView,
VehiclePriceApiView,
UploadFileView,
)

urlpatterns = [
Expand Down
7 changes: 3 additions & 4 deletions backend/vehicle/views.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
from rest_framework import status
import pandas as pd
from rest_framework import permissions, status
from rest_framework.generics import get_object_or_404
from rest_framework.parsers import FileUploadParser
from rest_framework.response import Response
from rest_framework.views import APIView
import pandas as pd
from rest_framework.parsers import FileUploadParser
from rest_framework import permissions

from core.permissions import IsAdminUser, IsAuthenticated

Expand Down
12 changes: 12 additions & 0 deletions emailService/.aws-sam/build.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# This file is auto generated by SAM CLI build command

[function_build_definitions.c0cef097-9648-43ba-948b-22498ab66749]
codeuri = "/Users/lance/Desktop/microvan/emailService"
runtime = "nodejs18.x"
architecture = "x86_64"
handler = "src/handlers/cognitoCustomMessage.cognitoCustomMessageHandler"
manifest_hash = "70a557897a9d2205fadda31828179700"
packagetype = "Zip"
functions = ["cognitoCustomMessage"]

[layer_build_definitions]
1 change: 1 addition & 0 deletions emailService/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
Binary file added emailService/AWSCLIV2.pkg
Binary file not shown.
140 changes: 140 additions & 0 deletions emailService/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
# emailService

This project contains source code and supporting files for a serverless application that you can deploy with the AWS Serverless Application Model (AWS SAM) command line interface (CLI). It includes the following files and folders:

- `src` - Code for the application's Lambda function.
- `events` - Invocation events that you can use to invoke the function.
- `__tests__` - Unit tests for the application code.
- `template.yaml` - A template that defines the application's AWS resources.

Resources for this project are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code.

If you prefer to use an integrated development environment (IDE) to build and test your application, you can use the AWS Toolkit.
The AWS Toolkit is an open-source plugin for popular IDEs that uses the AWS SAM CLI to build and deploy serverless applications on AWS. The AWS Toolkit also adds step-through debugging for Lambda function code.

To get started, see the following:

* [CLion](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [GoLand](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [IntelliJ](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [WebStorm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [Rider](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [PhpStorm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [PyCharm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [RubyMine](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [DataGrip](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
* [VS Code](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/welcome.html)
* [Visual Studio](https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/welcome.html)

## Deploy the sample application

The AWS SAM CLI is an extension of the AWS CLI that adds functionality for building and testing Lambda applications. It uses Docker to run your functions in an Amazon Linux environment that matches Lambda. It can also emulate your application's build environment and API.

To use the AWS SAM CLI, you need the following tools:

* AWS SAM CLI - [Install the AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html).
* Node.js - [Install Node.js 18](https://nodejs.org/en/), including the npm package management tool.
* Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community).

To build and deploy your application for the first time, run the following in your shell:

```bash
sam build
sam deploy --guided
```

The first command will build the source of your application. The second command will package and deploy your application to AWS, with a series of prompts:

* **Stack Name**: The name of the stack to deploy to CloudFormation. This should be unique to your account and region, and a good starting point would be something matching your project name.
* **AWS Region**: The AWS region you want to deploy your app to.
* **Confirm changes before deploy**: If set to yes, any change sets will be shown to you before execution for manual review. If set to no, the AWS SAM CLI will automatically deploy application changes.
* **Allow SAM CLI IAM role creation**: Many AWS SAM templates, including this example, create AWS IAM roles required for the AWS Lambda function(s) included to access AWS services. By default, these are scoped down to minimum required permissions. To deploy an AWS CloudFormation stack which creates or modifies IAM roles, the `CAPABILITY_IAM` value for `capabilities` must be provided. If permission isn't provided through this prompt, to deploy this example you must explicitly pass `--capabilities CAPABILITY_IAM` to the `sam deploy` command.
* **Save arguments to samconfig.toml**: If set to yes, your choices will be saved to a configuration file inside the project, so that in the future you can just re-run `sam deploy` without parameters to deploy changes to your application.

## Use the AWS SAM CLI to build and test locally

Build your application by using the `sam build` command.

```bash
my-application$ sam build
```

The AWS SAM CLI installs dependencies that are defined in `package.json`, creates a deployment package, and saves it in the `.aws-sam/build` folder.

Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project.

Run functions locally and invoke them with the `sam local invoke` command.

```bash
my-application$ sam local invoke helloFromLambdaFunction --no-event
```

## Add a resource to your application

The application template uses AWS SAM to define application resources. AWS SAM is an extension of AWS CloudFormation with a simpler syntax for configuring common serverless application resources, such as functions, triggers, and APIs. For resources that aren't included in the [AWS SAM specification](https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md), you can use the standard [AWS CloudFormation resource types](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html).

Update `template.yaml` to add a dead-letter queue to your application. In the **Resources** section, add a resource named **MyQueue** with the type **AWS::SQS::Queue**. Then add a property to the **AWS::Serverless::Function** resource named **DeadLetterQueue** that targets the queue's Amazon Resource Name (ARN), and a policy that grants the function permission to access the queue.

```
Resources:
MyQueue:
Type: AWS::SQS::Queue
helloFromLambdaFunction:
Type: AWS::Serverless::Function
Properties:
Handler: src/handlers/hello-from-lambda.helloFromLambdaHandler
Runtime: nodejs18.x
DeadLetterQueue:
Type: SQS
TargetArn: !GetAtt MyQueue.Arn
Policies:
- SQSSendMessagePolicy:
QueueName: !GetAtt MyQueue.QueueName
```

The dead-letter queue is a location for Lambda to send events that could not be processed. It's only used if you invoke your function asynchronously, but it's useful here to show how you can modify your application's resources and function configuration.

Deploy the updated application.

```bash
my-application$ sam deploy
```

Open the [**Applications**](https://console.aws.amazon.com/lambda/home#/applications) page of the Lambda console, and choose your application. When the deployment completes, view the application resources on the **Overview** tab to see the new resource. Then, choose the function to see the updated configuration that specifies the dead-letter queue.

## Fetch, tail, and filter Lambda function logs

To simplify troubleshooting, the AWS SAM CLI has a command called `sam logs`. `sam logs` lets you fetch logs that are generated by your Lambda function from the command line. In addition to printing the logs on the terminal, this command has several nifty features to help you quickly find the bug.

**NOTE:** This command works for all Lambda functions, not just the ones you deploy using AWS SAM.

```bash
my-application$ sam logs -n helloFromLambdaFunction --stack-name sam-app --tail
```

**NOTE:** This uses the logical name of the function within the stack. This is the correct name to use when searching logs inside an AWS Lambda function within a CloudFormation stack, even if the deployed function name varies due to CloudFormation's unique resource name generation.

You can find more information and examples about filtering Lambda function logs in the [AWS SAM CLI documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-logging.html).

## Unit tests

Tests are defined in the `__tests__` folder in this project. Use `npm` to install the [Jest test framework](https://jestjs.io/) and run unit tests.

```bash
my-application$ npm install
my-application$ npm run test
```

## Cleanup

To delete the sample application that you created, use the AWS CLI. Assuming you used your project name for the stack name, you can run the following:

```bash
sam delete --stack-name emailService
```

## Resources

For an introduction to the AWS SAM specification, the AWS SAM CLI, and serverless application concepts, see the [AWS SAM Developer Guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html).

Next, you can use the AWS Serverless Application Repository to deploy ready-to-use apps that go beyond Hello World samples and learn how authors developed their applications. For more information, see the [AWS Serverless Application Repository main page](https://aws.amazon.com/serverless/serverlessrepo/) and the [AWS Serverless Application Repository Developer Guide](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/what-is-serverlessrepo.html).
20 changes: 20 additions & 0 deletions emailService/__tests__/unit/handlers/hello-from-lambda.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Import helloFromLambdaHandler function from hello-from-lambda.mjs
import { helloFromLambdaHandler } from '../../../src/handlers/hello-from-lambda.mjs';

// This includes all tests for helloFromLambdaHandler()
describe('Test for hello-from-lambda', function () {
// This test invokes helloFromLambdaHandler() and compare the result
it('Verifies successful response', async () => {
// Invoke helloFromLambdaHandler()
const result = await helloFromLambdaHandler();
/*
The expected result should match the return from your Lambda function.
e.g.
if you change from `const message = 'Hello from Lambda!';` to `const message = 'Hello World!';` in hello-from-lambda.mjs
you should change the following line to `const expectedResult = 'Hello World!';`
*/
const expectedResult = 'Hello from Lambda!';
// Compare the result with the expected result
expect(result).toEqual(expectedResult);
});
});
29 changes: 29 additions & 0 deletions emailService/buildspec.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
version: 0.2

env:
variables:
S3_BUCKET: "sam-artifacts-microvan"

phases:
install:
commands:
# Install all dependencies (including dependencies for running tests)
- npm install
pre_build:
commands:
# Discover and run unit tests in the '__tests__' directory
- npm run test
# Remove all unit tests to reduce the size of the package that will be ultimately uploaded to Lambda
- rm -rf ./__tests__
# Remove all dependencies not needed for the Lambda deployment package (the packages from devDependencies in package.json)
- npm prune --production
build:
commands:
# Use AWS SAM to package the application by using AWS CloudFormation
- aws cloudformation package --template template.yaml --s3-bucket $S3_BUCKET --output-template template-export.yml
artifacts:
type: zip
files:
- template-export.yml


24 changes: 24 additions & 0 deletions emailService/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"name": "replaced-by-user-input",
"description": "replaced-by-user-input",
"version": "0.0.1",
"private": true,
"devDependencies": {
"jest": "^29.2.1"
},
"scripts": {
"test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
},
"jest": {
"testMatch": [
"**/__tests__/**/*.[jt]s?(x)",
"**/?(*.)+(spec|test).[jt]s?(x)",
"**/__tests__/**/*.mjs?(x)",
"**/?(*.)+(spec|test).mjs?(x)"
],
"moduleFileExtensions": [
"mjs",
"js"
]
}
}
Loading

0 comments on commit c1b8521

Please sign in to comment.