added docker option, logger and tests

Author: asomoza

.dockerignore

@@ -0,0 +1,7 @@
+.directory
+.eslintrc.json
+.prettierrc
+.gitignore
+.vscode
+storage
+data

.gitignore

@@ -1,6 +1,7 @@
 .vscode/
 node_modules/
-store/
+storage/
+data/
 dist/
 
 .directory

Dockerfile

@@ -0,0 +1,23 @@
+FROM node:lts-alpine AS base
+
+RUN apk add --no-cache openssl ffmpeg
+
+ENV DOCKERIZE_VERSION v0.6.1
+RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
+    && tar -C /usr/local/bin -xzvf dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
+    && rm dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz
+
+RUN mkdir -p ~/zhomemedia
+
+WORKDIR ~/zhomemedia
+
+COPY package.json .
+COPY yarn.lock .
+
+FROM base AS dependencies
+
+RUN yarn
+
+FROM dependencies AS runtime
+
+COPY . .

docker-compose.override.yml

@@ -0,0 +1,25 @@
+version: '3.9'
+
+services:
+  mongo:
+    command: mongod --quiet --logpath /var/log/mongodb/mongodb.log
+    ports:
+      - 27017:27017
+  api:
+      environment:
+        DEVELOPMENT: true
+      volumes:
+        - ./:/~/zhomemedia
+  api-tests:
+    build: .
+    image: zhomemedia
+    environment:
+      DEVELOPMENT: true
+      MONGO_HOST: mongo
+      REDIS_SERVER: redis
+    command: dockerize
+        -wait tcp://mongo:27017 -wait tcp://redis:6379 -timeout 10s
+        sh -c "yarn test"
+    depends_on:
+      - mongo
+      - redis

docker-compose.yml

@@ -0,0 +1,31 @@
+version: '3.9'
+
+services:
+  mongo:
+    image: mongo
+    restart: always
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: ${MONGO_USER}
+      MONGO_INITDB_ROOT_PASSWORD: ${MONGO_PASSWORD}
+      MONGO_INITDB_DATABASE: zHomeMedia
+    volumes:
+      - ${MONGO_DATA_DIR}:/data/db
+      - ./initdb:/docker-entrypoint-initdb.d
+  redis:
+    image: "redis:alpine"
+  api:
+    build: .
+    image: zhomemedia
+    environment:
+      DEVELOPMENT: false
+      MONGO_HOST: mongo
+      REDIS_SERVER: redis
+      STORAGE: /storage
+    volumes:
+      - ${STORAGE}:/storage
+    command: yarn start
+    ports:
+      - ${PORT}:${PORT}
+    depends_on:
+      - mongo
+      - redis

initdb/initialize.js

@@ -0,0 +1,8 @@
+// @ts-nocheck
+db.createCollection('users');
+db.users.insertOne({
+  username: 'admin',
+  email: '[email protected]',
+  password: '$2b$10$D5xuub32dNxuBeUj3xRbquCjWcpfGYCFYSXGxfkJSnWHoxhkaXdYy',
+  profile: '1',
+});

jest.config.ts

@@ -0,0 +1,16 @@
+import type {InitialOptionsTsJest} from 'ts-jest';
+
+const config: InitialOptionsTsJest = {
+  preset: 'ts-jest/presets/default-esm',
+  testEnvironment: 'node',
+  globals: {
+    'ts-jest': {
+      useESM: true,
+    },
+  },
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+};
+
+export default config;

package.json

@@ -4,38 +4,50 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "build": "npx tsc",
+    "test": "jest",
+    "build": "npx tsc -p tsconfig.build.json",
     "start": "nodemon --config nodemon.json src/server.ts"
   },
   "dependencies": {
     "bcrypt": "^5.0.1",
     "connect-redis": "^6.1.3",
     "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
+    "date-fns": "^2.29.1",
     "dotenv": "^16.0.1",
     "express": "^4.18.1",
     "express-fileupload": "^1.4.0",
     "express-session": "^1.17.3",
     "mongodb": "4.7",
+    "pino": "^8.3.1",
     "redis": "^4.1.1"
   },
   "devDependencies": {
     "@types/bcrypt": "^5.0.0",
     "@types/connect-redis": "^0.0.18",
     "@types/cookie-parser": "^1.4.3",
     "@types/cors": "^2.8.12",
+    "@types/date-fns": "^2.6.0",
     "@types/dotenv": "^8.2.0",
     "@types/express": "^4.17.13",
     "@types/express-fileupload": "^1.2.2",
     "@types/express-session": "^1.17.4",
+    "@types/jest": "^28.1.6",
     "@types/mongodb": "^4.0.7",
     "@types/node": "^18.0.1",
+    "@types/pino": "^7.0.5",
+    "@types/pino-pretty": "^4.7.5",
+    "@types/supertest": "^2.0.12",
     "@typescript-eslint/eslint-plugin": "^5.30.6",
     "@typescript-eslint/parser": "^5.30.6",
     "eslint": "^8.20.0",
     "eslint-config-google": "^0.14.0",
     "eslint-plugin-jsdoc": "^39.3.3",
+    "jest": "^28.1.3",
     "nodemon": "^2.0.16",
+    "pino-pretty": "^8.1.0",
+    "supertest": "^6.2.4",
+    "ts-jest": "^28.0.7",
     "ts-node": "^10.8.1",
     "typescript": "^4.7.4"
   }

src/app.ts

@@ -11,6 +11,9 @@ import video from './endpoints/video.js';
 import videos from './endpoints/videos.js';
 import image from './endpoints/image.js';
 import requireAuth from './middleware/requireAuth.js';
+import logger from './utils/logger.js';
+
+let isDevelopment = false;
 
 const app = express();
 
@@ -21,25 +24,33 @@ const options: cors.CorsOptions = {
 };
 
 const RedisStore = connectRedis(session);
-const redisClient = createClient({legacyMode: true});
+const redisClient = createClient({
+  legacyMode: true,
+  url: `redis://${env.REDIS_SERVER}:${env.REDIS_PORT}`,
+});
+
+if (env.DEVELOPMENT === 'true') {
+  isDevelopment = true;
+  logger.info('Development mode');
+}
 
 redisClient.connect().then(() => {
-  console.log('Successfully connected to redis.');
+  logger.info('Successfully connected to redis.');
 }).catch((_error:any) => {
-  console.log('Failed to connect to redis, server not running...');
+  logger.error('Failed to connect to redis, server not running');
   process.exitCode = 1;
   process.exit();
 });
 
 app.use(cors(options));
 app.use(cookieParser());
 app.use(session({
-  store: new RedisStore({client: redisClient}),
+  store: new RedisStore({client: redisClient, unref: true}),
   secret: env.SESSION_SECRET,
   resave: false,
   saveUninitialized: false,
   cookie: {
-    secure: false, // Change in production
+    secure: isDevelopment ? false : true,
     httpOnly: true,
   },
 }));
@@ -56,3 +67,4 @@ app.use('/api/videos', videos);
 app.use('/api/image', image);
 
 export default app;
+export {redisClient};

src/db/mongo.ts

@@ -1,35 +1,38 @@
 import {MongoClient} from 'mongodb';
+import env from '..//utils/env.js';
+import logger from '../utils/logger.js';
 
-const uri = 'mongodb://localhost:27017/?readPreference=primary&ssl=false';
+const uri = `mongodb://${env.MONGO_USER}:${env.MONGO_PASSWORD}@${env.MONGO_HOST}:${env.MONGO_PORT}/`;
 
 const client = new MongoClient(uri);
 
-let dbConnection: any;
+let database: any;
 
 /**
- * @param {Function} callback callback function
- * @returns {any} Callback
+ * Connects to mongodb server
  */
-function connectToServer(callback: Function): any {
-  client.connect((err, db) => {
-    if (err || !db) {
-      return callback(err);
-    }
-
-    dbConnection = db.db('zHomeMedia');
-    console.log('Successfully connected to MongoDB.');
-
-    return callback();
-  });
-
-  return null;
+async function connect() {
+  try {
+    const connection = await client.connect();
+    database = connection.db('zHomeMedia');
+    logger.info('Connected to mongodb');
+  } catch (e) {
+    logger.error(`Couldn't connect to database ${e}`);
+  }
 }
 
 /**
  * @returns {any} Database connection object
  */
 function getDb(): any {
-  return dbConnection;
+  return database;
+}
+
+/**
+ * Disconnects from mongodb server
+ */
+async function disconnect() {
+  await client.close();
 }
 
-export {connectToServer, getDb};
+export {connect, disconnect, getDb};

src/endpoints/auth.test.ts

@@ -0,0 +1,80 @@
+import app, {redisClient} from '../app';
+import supertest from 'supertest';
+import * as mongodb from '../db/mongo.js';
+// import logger from '../utils/logger.js';
+
+beforeAll(async () => {
+  await mongodb.connect();
+});
+
+describe('Test auth without credentials', () => {
+  it('should return a 400 status code', async () => {
+    const response = await supertest(app)
+        .post('/api/auth')
+        .expect(400);
+    expect((response.error as any).text).toEqual('Invalid credentials');
+  });
+});
+
+describe('Test auth with bad credentials', () => {
+  it('It should return a 400 status code', async () => {
+    const response = await supertest(app)
+        .post('/api/auth')
+        .send({
+          user: 'bad user',
+          password: 'bad password',
+        })
+        .expect(400);
+    expect((response.error as any).text).toEqual('Invalid credentials');
+  });
+});
+
+describe('Test auth with good credentials', () => {
+  it('should return a 200 page with user info', async () => {
+    const response = await supertest(app)
+        .post('/api/auth')
+        .send({
+          user: 'admin',
+          password: 'admin',
+        })
+        .expect(200);
+    expect(response.type).toEqual('application/json');
+    expect(response.body).toEqual({'profile': '1', 'user': 'admin'});
+  });
+});
+
+describe('Test logged user info when logged out', () => {
+  it('should return a 400 status code', async () => {
+    const response = await supertest(app)
+        .get('/api/auth/info')
+        .expect(400);
+    expect((response.error as any).text).toEqual('Invalid user');
+  });
+});
+
+describe('Test get logged user info', () => {
+  it('should return a 200 page with user info', async () => {
+    let response = await supertest(app)
+        .post('/api/auth')
+        .send({
+          user: 'admin',
+          password: 'admin',
+        })
+        .expect(200);
+
+    expect(response.headers).toHaveProperty('set-cookie');
+    const cookies = response.headers['set-cookie'].pop().split(';')[0];
+
+    response = await supertest(app)
+        .get('/api/auth/info')
+        .set('Cookie', [cookies])
+        .expect(200);
+    expect(response.type).toEqual('application/json');
+    expect(response.body).toEqual({'profile': '1', 'user': 'admin'});
+  });
+});
+
+afterAll(async () => {
+  await mongodb.disconnect();
+  await redisClient.disconnect();
+});