Exploring secure routes in Node.js with test cases using Mocha and Chai?

Question

Exploring secure routes in Node.js with test cases using Mocha and Chai?

The function verifies whether the route is accessible or not

function checkSessionCookieValidity(req, res, next) {
      if (!isValid(req.session)) {
        return res.status(401).json({
          isLoggedIn: false
        });
      }
        return next();
 }

Within a separate file, I make a post request to a protected route using the aforementioned function

  app
     .route('/url')
     .post(utils.checkSessionCookieValidity, (req, res, next) => {})

TESTING segment

An issue arises as I am unsure how to simulate the checkSessionCookieValidity function since it necessitates a next callback which I am unable to provide in my test:

describe('testing routes', () => {
  it('should access the route body', (done) => {
    utils.checkSessionCookieValidity(req, res, 'next should be here...');
    chai.request(server)
      .post('/url')
      .end(function (error, response, body) {
        if (error) {
          done(error);
        } else {
          done();
        }
      });
  });

});

ERROR: TypeError: next is not a function

javascript node.js express mocha.js chai

Answer 1

Answer №1

I have decided to use the mocking library sinonjs for this task. The goal is to mock the functionality of the isSessionCookieValid middleware and always allow it to proceed to the next middleware.

For example:

server.ts:

import express from 'express';
import * as utils from './utils';

const app = express();
const port = 3000;

app.route('/url').post(utils.isSessionCookieValid, (req, res, next) => {
  res.sendStatus(200);
});

if (require.main === module) {
  app.listen(port, () => {
    console.log(`Server is listening on port ${port}`);
  });
}

export { app };

utils.ts:

function isSessionCookieValid(req, res, next) {
  if (!isValid(req.session)) {
    return res.status(401).json({
      isLoggedIn: false,
    });
  }
  return next();
}

function isValid(session) {
  return true;
}

export { isSessionCookieValid };

server.test.ts:

import * as utils from './utils';
import sinon from 'sinon';
import chai, { expect } from 'chai';
import chaiHttp from 'chai-http';

chai.use(chaiHttp);

describe('testing routes', () => {
  it('should enter the route body', (done) => {
    const isSessionCookieValidStub = sinon.stub(utils, 'isSessionCookieValid').callsFake((req, res, next) => {
      next();
    });
    const { app } = require('./server');
    chai
      .request(app)
      .post('/url')
      .end((error, response) => {
        if (error) {
          return done(error);
        }
        sinon.assert.calledOnce(isSessionCookieValidStub);
        expect(response).to.have.status(200);
        done();
      });
  });
});

Outcome of the unit test:

  testing routes
    ✓ should enter the route body (500ms)


  1 passing (510ms)

-----------|---------|----------|---------|---------|-------------------
File       | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
-----------|---------|----------|---------|---------|-------------------
All files  |      60 |       25 |      25 |      60 |                   
 server.ts |      80 |       50 |      50 |      80 | 12-13             
 utils.ts  |      20 |        0 |       0 |      20 | 2-11              
-----------|---------|----------|---------|---------|-------------------

Source code can be found at: https://github.com/mrdulin/expressjs-research/tree/master/src/stackoverflow/54462600

Answer 2

I have decided to use the mocking library sinonjs for this task. The goal is to mock the functionality of the isSessionCookieValid middleware and always allow it to proceed to the next middleware.

For example:

server.ts:

import express from 'express';
import * as utils from './utils';

const app = express();
const port = 3000;

app.route('/url').post(utils.isSessionCookieValid, (req, res, next) => {
  res.sendStatus(200);
});

if (require.main === module) {
  app.listen(port, () => {
    console.log(`Server is listening on port ${port}`);
  });
}

export { app };

utils.ts:

function isSessionCookieValid(req, res, next) {
  if (!isValid(req.session)) {
    return res.status(401).json({
      isLoggedIn: false,
    });
  }
  return next();
}

function isValid(session) {
  return true;
}

export { isSessionCookieValid };

server.test.ts:

import * as utils from './utils';
import sinon from 'sinon';
import chai, { expect } from 'chai';
import chaiHttp from 'chai-http';

chai.use(chaiHttp);

describe('testing routes', () => {
  it('should enter the route body', (done) => {
    const isSessionCookieValidStub = sinon.stub(utils, 'isSessionCookieValid').callsFake((req, res, next) => {
      next();
    });
    const { app } = require('./server');
    chai
      .request(app)
      .post('/url')
      .end((error, response) => {
        if (error) {
          return done(error);
        }
        sinon.assert.calledOnce(isSessionCookieValidStub);
        expect(response).to.have.status(200);
        done();
      });
  });
});

Outcome of the unit test:

  testing routes
    ✓ should enter the route body (500ms)


  1 passing (510ms)

-----------|---------|----------|---------|---------|-------------------
File       | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
-----------|---------|----------|---------|---------|-------------------
All files  |      60 |       25 |      25 |      60 |                   
 server.ts |      80 |       50 |      50 |      80 | 12-13             
 utils.ts  |      20 |        0 |       0 |      20 | 2-11              
-----------|---------|----------|---------|---------|-------------------

Source code can be found at: https://github.com/mrdulin/expressjs-research/tree/master/src/stackoverflow/54462600

Exploring secure routes in Node.js with test cases using Mocha and Chai?

Answer №1

Similar questions

Customizing material-ui styles within a nested component

Issues with ng-show functionality occurring during the initialization of the webpage

Using conditional logic to check if a column cell is empty

Unable to attach an onClick event handler to <TableRowColumn> element using Material-UI in React

I'm facing an issue where the data I retrieved is not displaying properly in my template within nuxt 3

Having trouble with installing packages through NPM in Node.js?

What steps are involved in creating an xlsx file using Express and Exceljs, and then sending it to the client?

Connect the Vue component to the Vue instance

Effective Methods for Transferring Information from Database Applications to Theme App Extensions without Utilizing Metafields

Configuring Access-Control-Allow-Origin does not function properly in AJAX/Node.js interactions

I am facing an issue in my Nextjs project where the Array Object is not being properly displayed

Is it possible to retrieve a physical address using PHP or Javascript?

Having trouble with installing discord.js in Visual Studio Code

An error occurred - 0x800a1391 - JavaScript runtime error: The function 'SelectAllCheckBoxes' has not been defined

Having trouble integrating Socket.io with Express.js?

Include the JS file after finishing the control processing

Retrieving information from a local JSON file in Vue.js using the jQuery $.getJSON() method

The initial render in a Kanban board seems to be causing issues with the functionality of react-beautiful-dnd

What causes the command prompt script to abruptly exit when verifying the npm version?

Employ variables as a jQuery selector