Noah for Shortcutter's Coding Challenge

Task

URL Shortener

Develop a service that lets users create short URLs (like Bitly, Rebrandly, etc.) for their original links.

Consider this as MVP that is ready for deployment, but try to keep in mind future maintenance and improvements. Don't spend too much time on perfecting it, as long as you can discuss the choices you made, what parts could be improved, etc.

Functional requirements

• Service should let users register a new account and authenticate themselves.
• Service should let authenticated users create shortened URLs.
• Service should let any user use shortened URLs (e.g., follow redirects to original URLs).

Technical requirements

• Service has to serve requests over HTTP API.
• We don't expect UI for this task.
• User registration could be very simple with just a login(email) and password.
• You can use any tech solution for storing data but consider that your project has to be easy to launch. For example, if you use any DB consider including deploy scripts or containerization scripts.
• The same rule for dependencies and libraries. If you use packages that other people are unlikely to have, consider including deploy or containerization scripts.

Solution

Functionless URL Shortener

This is forked from Eric Johnson@AWS

This app creates a URL shortener without using any compute. All business logic is handled at the Amazon API Gateway level. The basic app will create an API Gateway instance utilizing Cognito for authentication and authorization. It will also create an Amazon DynamoDB table for data storage. It will also create a simple Vuejs application as a demo client.

The Backend

Services Used

• Amazon API Gateway
• Amazon Cognito
• Amazon DynamoDB
• AWS Amplify Console
• Amazon CloudFront *Will cause a lengthy deployment time. See note under Deploying
• Amazon S3

Requirements for deployment

• AWS CLI
• AWS SAM CLI v0.37.0+

Deploying

Note: This stack includes an Amazon CloudFront distribution which can take around 30 minutes to create. Don't be alarmed if the deploy seems to hang for a long time. In the terminal, use the SAM CLI guided deployment the first time you deploy

sam deploy -guided  # Deploy your application

Choose options

You can choose the default for all options except GithubRepository and **

## The name of the CloudFormation stack
Stack Name [URLShortener]:

## The region you want to deploy in
AWS Region [eu-north-1]:

## The name of the application (lowercase no spaces). This must be globally unique
Parameter AppName [shortener]:

## Enables public client and local client for testing. (Less secure)
Parameter UseLocalClient [false]:

## GitHub forked repository URL
Parameter GithubRepository [https://github.com/noahliukyiv/amazon-api-gateway-url-shortener.git]:

## Github Personal access token
Parameter PersonalAccessToken:

## Shows you resources changes to be deployed and requires a 'Y' to initiate deploy
Confirm changes before deploy [y/N]: 

## SAM needs permission to be able to create roles to connect to the resources in your template
Allow SAM CLI IAM role creation [Y/n]:

## Save your choice for later deployments
Save arguments to samconfig.toml [Y/n]:

AWS SAM will then deploy the AWS CloudFormation stack to your AWS account and provide required outputs for the included client.

After the first deploy you may re-deploy using sam deploy or redeploy with different options using sam deploy -g.

The Client

The client can also be run locally for debugging. Instructions can be found here.

The client is a Vue.js application that interfaces with the backend and allows you to authenticate and manage URL links. The client is hosted using Amplify Console. To avoid circular dependencies, we need to provide some information for the client after stack is built. The information needed is provided at the end of the deploy process. If you do not have the information you can run the following:

aws cloudformation describe-stacks --stack-name URLShortener

We need to add this information to the environment variables for the Amplify Console app. There are two options for adding the variables.

Option 1: using the AWS CLI (Update the <values> to reflect the information returned from the deployment.)

aws amplify update-app --app-id <MyAmplifyAppId> --environment-variables \
VUE_APP_NAME=<VueAppName>\
,VUE_APP_CLIENT_ID=<VUE_APP_CLIENT_ID>\
,VUE_APP_API_ROOT=<VUE_APP_API_ROOT>\
,VUE_APP_AUTH_DOMAIN=<VUE_APP_AUTH_DOMAIN>

Also available in the stack output as AmplifyEnvironmentUpdateCommand

Option 2: Amplify Console page

1. Open the Amplify Console page
2. On the left side, under All apps, choose Url-Shortner-Client
3. Under App settings choose Environment variables
4. Choose the manage variables button
5. Choose add variable
6. Fill in the variable and it's corresponding Value
7. Leave defaults for Branches and Actions
8. Repeat for all four variables
9. Choose save

Starting the first deployment

After deploying the CloudFormation template, you need to go into the Amplify Console and trigger a build. The CloudFormation template can provision the resources, but can’t trigger a build since it creates resources but cannot trigger actions. This can be done via the AWS CLI.

Option 1: Using the AWS CLI (Update the <values> to reflect the information returned from the deployment.)

aws amplify start-job --app-id <MyAmplifyAppId> --branch-name master --job-type RELEASE

Also available in the stack output as AmplifyDeployCommand

To check on the status, you can view it on the AWS Amplify Console or run:

aws amplify get-job --app-id <MyAmplifyAppId> --branch-name master --job-id <JobId>

Option 2: Amplify Console page

1. Open the Amplify Console page
2. On the left side, under All apps, choose Url-Shortner-Client
3. Click Run build

*Note: this is only required for the first build subsequent client builds will be triggered when updates are committed to your forked repository.

Cleanup

1. Open the CloudFormation console
2. Locate a stack named URLShortener
3. Select the radio option next to it
4. Select Delete
5. Select Delete stack to confirm

*Note: If you opted to have access logs (on by default), you may have to delete the S3 bucket manually.