Architecting a URL Shortener
Tags: tutorial, api, beginners, productivity
Published: 2020-09-13 07:30:06

## Introduction

This is the first article of what will be a series on how to architect, code, and deploy a URL Shortener. So let's begin.

_"What is a URL Shortener?"_ you ask, you might have come across it more often than you think. In simple words, a URL Shortener converts long URLs to short ones. Upon clicking the short link, you will be redirected to the original URL.

_"Well then why do we need them in the first place?"_ Because they are easy to type, i.e., preventing typos. They also help in saving a lot of space while displaying, texting, or posting on social media.

Let us see an example:

**Input**

`https://tuls.in/prevent-opening-of-files-over-existing-tabs-in-vs-code/`

**Output**

`https://bit.ly/3h8erO6`

Some of the popular URL Shorteners are: bitly, tinyurl, etc. Some more use cases of such services include better management and analyzing the audience.

By the look of it, sounds pretty simple, right? Let's think about the requirements before jumping the gun.

## System Requirements

The below points can be treated as the static system requirements from a higher standpoint.

1. Assign a unique short link for a given URL.

2. Upon accessing a short link, redirect to the original URL with minimum latency.

3. Use encoding to prevent short links from being guessed.

4. Expire the short links after a certain timespan.

## Technical Requirements

To keep it short and straightforward, we will keep these requirements to a minimum. FYI, I will be rendering the frontend using a [template engine](https://expressjs.com/en/guide/using-template-engines.html) so that I can incorporate everything in a single backend focussed repository.

### Frontend

1. _**Home Page**_: To ask users to input a URL.

2. _**Output Page**_: To display the generated short link and provide options to the user such as copying the short link or opening it in a new tab.

3. _**Invalid Page**_: To display an appropriate message on receiving invalid requests.

4. _**Expired Page**_: To display an appropriate message when a user tries to access a short link which has expired.

### Backend

1. _**Home Page Render API**_: To render the Home page.

2. _**Assign Short Link API**_: To assign a short link from the database against the incoming URL and return an encoded string to the frontend.

3. _**Display Short Link API**_: To decode the encoded string and return the assigned short link to display it to the user.

4. _**Redirect API**_: To redirect the user to the original URL.

_"Hmm, but why do we need to send an encoded string to the frontend in the first place, only to decode it back again to send the generated short link?"_

Hang on, I will clarify this in an upcoming section when I explain the flow from a user perspective.

## Database Design

We need only one table to store about the URL mappings.

```javascript
+---------------------------+---------------------------+-----+--------------------+
| Field                     | Type                      | Key | Default            |
+---------------------------+---------------------------+-----+--------------------+
| _id                       | String                    | PRI | URL Safe String    |
| is_active                 | Boolean                   |     | true               |
| is_used                   | Boolean                   |     | false              |
| original_url              | String                    |     | null               |
| creation_date             | Date                      |     | Date.now           |
| expiration_date           | Date                      |     | Date.now           |
+---------------------------+---------------------------+-----+--------------------+
```

**_Note_** For our case, a URL Safe String will contain a combination of the following characters: `abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~`

Since we do not have any requirement of creating relationships and we might need to store several rows, a NoSQL database will be a better choice as it will be easier to scale. Hence, we will be using [MongoDB](https://www.mongodb.com).

### Purpose of Fields

1. `_id`: This will the short link which will be served. Its length can be 6 in the beginning and can be increased as per the traffic. (Number of unique combinations of length 6 from the string which will be used to generate the URL Safe String will be huge). We will be using an npm package to generate it at the time of the creation of a document.

2. `is_active`: A flag to control whether a document is active or not. It might not be helpful early on, but it is always good to have a fallback, just in case you might need to disable certain short links on an urgent basis.

3. `is_used`: A flag to check whether a document, i.e., a short link, is in use or not. 

4. `original_url`: The original URL from the user.

5. `creation_date`: The date of creation of the document.

6. `expiration_date`: The date of expiration of the document. When the document expires, the short link will expire. We will be leveraging a built-in functionality of MongoDB via [Mongoose](https://mongoosejs.com) ODM (Object Document Mapper) while coding to attach a counter for the expiration of a document.

## System Design

### The How Part

The problem we have on our hands is, how to generate a short and unique link for a given URL.

**Approach 1**

Generate a new document in the database after receiving a URL from the user. However, some of the issues with this approach are as follows:

1. Suppose the storage space allocated for the database is full. Now because the system won't be able to create new documents for incoming requests, the availability of your service goes for a toss.

2. Thinking about scale, if and when the server will serve considerable traffic, creating a document runtime will result in the consumption of more resources, in turn slowing down the system and increasing the latency.

**Approach 2**

A better solution to overcome the limitations with the first approach is to create _**x**_ number of documents beforehand using a cron that runs every _**y**_ minutes or hours, depending on the traffic.

**_Cron_** A command to an operating system or server for a job that is to be executed at a specified time.

Now, whenever a user will ask for a short link, your system will do the following:

1. Pick a document with `is_active` as `true` and `is_used` field as `false`.

2. Update the `original_url` of the document with the user's URL, `is_used` as `true` and `expiration_date` to the current timestamp.

3. Return the `_id` (short link) of the document.

### The User Perspective Part

To summarize, the user flow will be as follows:

1. The user visits the _**Home Page**_. _**Home Page Render API**_ is in action.

2. User inputs a URL and clicks on the **Submit** button. _**Assign Short Link API**_ is called, which returns an encoded version of the short link.

3. Upon successful response from _**Assign Short Link API**_, the frontend redirects to a new route that uses the encoded short link as a path parameter. _**Display Short Link API**_ is triggered on visiting of this new route.

4. _**Display Short Link API**_ decodes the encoded short link, finds the corresponding document against it in the database, and returns the short link in the rendered _**Output Page**_.

5. _**Redirect API**_ comes into action when a user clicks on a short link. It basically extracts the unique alias (which is actually the `_id`) and finds the document against it. If the document exists, it will redirect the user to the `original_url` stored against it, else it will display the _**Expired Page**_.

6. _**Invalid Page**_ will be rendered only in a particular scenario that we can address when writing the code.

**_Addressing the dangling question which was left unanswered earlier_**
There can be several reasons for the whole encoding-decoding process, some of which are:

- Increase monetization by showing ads on 2 different pages rather than one, one for inputting the URL and the other for displaying the short link.

- To rate-limit the routes with a distinct configuration.

- To prevent the short links from being predictable easily.

## Corner Cases and Improvements

Here is a list of some corner cases and improvements that I would like you to brainstorm on:

### Corner Cases

1. What if multiple users enter the same URL? They might get the same shortened URL, which is not acceptable.

2. What if parts of the URL are URL-encoded?

### Improvements

1. Users should optionally be able to pick a custom short link for their URL.

2. Users should be able to specify the expiration time.

FYI, the coding solution we will implement further in the upcoming articles might not solve all the above issues. These are for you to solve.

## Concluding Remarks

I realize that you might have some queries, but I'm sure we will resolve those when implementing the architecture. Till then, try to come up with some new and interesting corner cases and improvements that we can incorporate. And if you understood it well, go ahead and try to implement it yourself.

For the latest updates on the upcoming articles in this series, you can connect with me on LinkedIn by visiting my dev.to profile.