Testing URL Parameters in JEST with an API

Question

Testing URL Parameters in JEST with an API

Seeking integration tests using Jest for an API endpoint. Here's the specific endpoint:

http://localhost/universities/ucla/class/2013/studentalis/johndoe

. When tested with a put request, it returns 201 on Postman.

However, the testing encountered a timeout issue due to an error in the updateStudent.js file. The problem lies in parsing the URL parameters:

function getQuery(req, studentid, id) {
  return {
    universityName: req.params.universityName.toString(),
    class: req.params.class.toString(),
    studentAlias: req.params.studentAlias.toString()
  };
}

The error message received is "TypeError: Cannot read properties of undefined (reading 'toString')". Upon investigation, it was found that req is indeed an object, but req.params is empty leading to undefined values in

req.params.universityName.toString()

. This indicates a probable incorrect way of setting the URL params. Any suggestions on the correct syntax?

javascript express jestjs supertest

Answer 1

Answer №1

By not specifying any route parameters, the req.params will be empty.

Route parameters act as named URL segments that capture values specified in the URL. These captured values are then stored in the req.params object, with the route parameter name serving as their keys.

To define route parameters, simply include them in the path of the route within your server.js or index.js file. For example: /path/:name, where 'name' is the route parameter.

const express = require("express");
const updateStudentRoute= require('../handlers/updateStudent');
const app = express();
app.use(express.json());
// Use `put` method instead of `use`
app.put('/university/:universityName/class/:class/studentalias/:studentAlias', updateStudentRoute);

app.listen(2000,function(){  
   console.log("Server is running on port 2000");  
});

Additionally, ensure you use app.put rather than app.use, as app.use() is meant for applying middleware to your application.

Once familiar with route parameters, learn how to test them:

In your test file:

const supertest = require("supertest");
const request = supertest("http://localhost:2000");

describe('Update Student Details in Database', () => {
    it('Update Student Details in Database', async() => {
        // const updateStudentRequestBody = require('./updateStudentRequestBody'); put method does not have a body
        const response = await request.put(`/university/ucla/class/2013/studentalias/johndoe`); // You can replace :name with actual values here
        expect(response.statusCode).toBe(201);
    });
});

It's not necessary to pass the app instance each time when testing the same host. Simply reassign the request variable with the URL initialization as a new Test is created per request.VERB() call.

Lastly, remember to set the response code as 201, as by default Express responds to all endpoints with status code 200.

Answer 2

By not specifying any route parameters, the req.params will be empty.

Route parameters act as named URL segments that capture values specified in the URL. These captured values are then stored in the req.params object, with the route parameter name serving as their keys.

To define route parameters, simply include them in the path of the route within your server.js or index.js file. For example: /path/:name, where 'name' is the route parameter.

const express = require("express");
const updateStudentRoute= require('../handlers/updateStudent');
const app = express();
app.use(express.json());
// Use `put` method instead of `use`
app.put('/university/:universityName/class/:class/studentalias/:studentAlias', updateStudentRoute);

app.listen(2000,function(){  
   console.log("Server is running on port 2000");  
});

Additionally, ensure you use app.put rather than app.use, as app.use() is meant for applying middleware to your application.

Once familiar with route parameters, learn how to test them:

In your test file:

const supertest = require("supertest");
const request = supertest("http://localhost:2000");

describe('Update Student Details in Database', () => {
    it('Update Student Details in Database', async() => {
        // const updateStudentRequestBody = require('./updateStudentRequestBody'); put method does not have a body
        const response = await request.put(`/university/ucla/class/2013/studentalias/johndoe`); // You can replace :name with actual values here
        expect(response.statusCode).toBe(201);
    });
});

It's not necessary to pass the app instance each time when testing the same host. Simply reassign the request variable with the URL initialization as a new Test is created per request.VERB() call.

Lastly, remember to set the response code as 201, as by default Express responds to all endpoints with status code 200.

Testing URL Parameters in JEST with an API

Answer №1

Similar questions

Ajax: The requested resource does not have the 'Access-Control-Allow-Origin' header. As a result, access is not permitted from origin 'null'

How can I prevent a hyperlinked element from being clicked again after it has been clicked using JavaScript or jQuery in PHP

How can you efficiently identify and resolve coding errors or typos in your code?

Calculating the hour difference between two time stamps (HH:MM:SS a) using moment.js

Customizing React components based on API data

Utilizing the same WebDriverJS instance repeatedly

`How can we access the Passport user in the main.js file and incorporate middleware?`

"Encountering a Type Error while attempting to destructure elements within ReactJS

Timeout when making an HTTP request

JavaScript ECMAScript 6 - WARNING: "Decorators can only be applied to a class when exporting"

The suspense fallback function seems to be missing in NextJS 13

What is causing this console to output twice?

Monitor the output of a spawned process that is currently in a state of awaiting user input

Converting a floating point number to a 4-byte hex string in JavaScript and reversing the process

React-easy-crop simply provides a blob url as a result

Removing a Div with Dynamic Parameters

What is the best method for retrieving data through an ajax call in my modular JavaScript setup?

Floating division element above responsive divisions

Flickering observed in AngularJS UI-Router when navigating to a new route

Is there a built-in function in Firefox that can retrieve a list of all indexedDB names stored in the