chore(): Readme improvment and refactor

Author: jacopobonomi

.env.example

@@ -0,0 +1,5 @@
+PORT=3000
+BASE_URL=http://localhost:3000
+AWS_REGION=eu-south-1
+LINKS_TABLE_NAME=links
+CACHE_TTL=60

README.md

@@ -1,2 +1,54 @@
 # SHORTEN
+
 Simple shortener service with DynamoDB, Express and nanoid.
+
+Features:
+
+- DynamoDB with AWS SDK as database provider (no configuration)
+- Create (same api for update) short URL
+- Delete short URL
+- Swagger documentation
+- Clustering mode (for high traffic)
+- Redirects
+- Caching for redirects on memory with custom TTL
+- Rate limit on apis
+- Error handling
+- Compression response with gzip
+- nanoID generator
+
+## Start
+
+```bash
+git clone <repo>
+cd <repo>
+yarn install
+yarn start
+```
+
+## Development
+
+```bash
+git clone <repo>
+cd <repo>
+yarn install
+yarn start:dev
+```
+
+## Cluster start
+
+```bash
+git clone <repo>
+cd <repo>
+yarn install
+yarn start:cluster
+```
+
+TODO:
+
+- Authentication with API Key for POST/DELETE/PUT
+- Add readble slug for short URL optional parameter
+- Add domain on model, to manage multiple domains
+- Manage wrapper to run on Lambda AWS
+- Add analytics for short URL
+- Add auto exctract short slug from redirect url
+- Add another provider for database (Redis, MongoDB, Firebase(?))>

package-lock.json

@@ -34,7 +34,9 @@
     "@types/cors": "^2.8.12",
     "@types/express": "^4.17.13",
     "@types/morgan": "^1.9.3",
+    "@types/nanoid": "^3.0.0",
     "@types/node": "^18.6.2",
+    "@types/node-cache": "^4.2.5",
     "@types/swagger-ui-express": "^4.1.3",
     "cpy-cli": "^4.1.0",
     "nodemon": "^2.0.19",

package.json

@@ -3,13 +3,16 @@ import { Request, Response } from "express";
 import { CacheContainer } from "node-ts-cache";
 import { param } from "express-validator";
 import swaggerUi from "swagger-ui-express";
+import { env } from "process";
 
 import { putLink, getLink, deleteLink } from "../services/links";
 
 import { ILink } from "../models/ILink";
 
 const { linksDocs } = require("../../docs/links.doc");
 
+const CACHE_TTL: any = parseInt(env.CACHE_TTL as string) || 60;
+
 export default class LinksController {
   private cacheNode;
 
@@ -43,7 +46,7 @@ export default class LinksController {
   public insertLink = async (req: Request, res: Response) => {
     const { body: link } = req;
     const createdLink = (await putLink(link)) as ILink;
-    await this.cacheNode.setItem(createdLink.slug, null, { ttl: 60 });
+    await this.cacheNode.setItem(createdLink.slug, null, { ttl: CACHE_TTL });
     res.json(createdLink);
   };
 

src/controllers/links.ts

@@ -3,6 +3,7 @@ import { MemoryStorage } from "node-ts-cache-storage-memory";
 
 const NodeCache = require("node-cache");
 new NodeCache();
+
 const linksCache = new CacheContainer(new MemoryStorage());
 
 export default linksCache;

src/libs/cache.ts

@@ -1,7 +1,7 @@
 import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
 
 if (!process.env.AWS_REGION) {
-  throw new Error("AWS_REGION is not set");
+  throw new Error("AWS_REGION is not set on .env file");
 }
 
 export const ddbClient = new DynamoDBClient({ region: process.env.AWS_REGION });

src/libs/ddbClient.ts

@@ -12,6 +12,6 @@ const unmarshallOptions = {
 };
 
 const translateConfig = { marshallOptions, unmarshallOptions };
-const ddbDocClient = DynamoDBDocumentClient.from(ddbClient, translateConfig);
+const db = DynamoDBDocumentClient.from(ddbClient, translateConfig);
 
-export { ddbDocClient };
+export { db };

src/libs/ddbDocClient.ts

@@ -1,9 +1,12 @@
 import { PutCommand, GetCommand, DeleteCommand } from "@aws-sdk/lib-dynamodb";
-import { ddbDocClient } from "../libs/ddbDocClient";
+import { db } from "../libs/ddbDocClient";
+
 import { ILink, ILinkDTO } from "../models/ILink";
 
+//FIX: Strange import bug
 const { nanoid } = require("nanoid");
-const TABLE_NAME = "links";
+
+const TABLE_NAME = process.env.LINKS_TABLE_NAME || "links";
 const BASE_PATH = process.env.BASE_URL;
 
 export const putLink = async ({ redirect, slug }: ILinkDTO) => {
@@ -21,7 +24,7 @@ export const putLink = async ({ redirect, slug }: ILinkDTO) => {
   };
 
   try {
-    await ddbDocClient.send(new PutCommand(params));
+    await db.send(new PutCommand(params));
     return newLink;
   } catch (err) {
     console.error(err);
@@ -36,9 +39,9 @@ export const getLink = async (slug: string): Promise<ILink | undefined> => {
     },
   };
   try {
-    const data = await ddbDocClient.send(new GetCommand(params));
-    const link: ILink = data.Item as ILink;
-    return link;
+    return (await (
+      await db.send(new GetCommand(params))
+    ).Item) as ILink;
   } catch (err) {
     console.error(err);
   }
@@ -52,7 +55,7 @@ export const deleteLink = async (slug: string) => {
     },
   };
   try {
-    await ddbDocClient.send(new DeleteCommand(params));
+    await db.send(new DeleteCommand(params));
     return { message: "Link deleted", status: "success" };
   } catch (err) {
     console.error(err);