How to chain http calls with superagent/supertest?

Question

I am testing an express API with supertest.

I couldn't get multiple requests in a test case to work with supertest. Below is what i tried in a test case. But the test case seem to only execute the last call which is the HTTP GET.

it('should respond to GET with added items', function(done) {
    var agent = request(app);
    agent.post('/player').type('json').send({name:"Messi"});
    agent.post('/player').type('json').send({name:"Maradona"});
    agent.get('/player').set("Accept", "application/json")
        .expect(200)
        .end(function(err, res) {
            res.body.should.have.property('items').with.lengthOf(2);
            done();
    });
);

Anything i am missing here, or is there another way to chain http calls with superagent?

score 69 · Answer 1 · answered Sep 20 '14 at 05:41

69

Tried to put this in a comment above, formatting wasn't working out.

I'm using async, which is really standard and works really well.

it('should respond to only certain methods', function(done) {
    async.series([
        function(cb) { request(app).get('/').expect(404, cb); },
        function(cb) { request(app).get('/new').expect(200, cb); },
        function(cb) { request(app).post('/').send({prop1: 'new'}).expect(404, cb); },
        function(cb) { request(app).get('/0').expect(200, cb); },
        function(cb) { request(app).get('/0/edit').expect(404, cb); },
        function(cb) { request(app).put('/0').send({prop1: 'new value'}).expect(404, cb); },
        function(cb) { request(app).delete('/0').expect(404, cb); },
    ], done);
});

answered Sep 20 '14 at 05:41

Tim

1,018
1
8
12

4

This should be the accepted answer. Async works fantastically in this context. – csvan Sep 25 '15 at 19:18
1

Great approach! I extended it somewhat, check here https://stackoverflow.com/a/45198533/449227 – Tom Söderlund Jul 19 '17 at 18:37
1

I get "cannot find name async". Is there a package needed for this? I can't seem to find an answer online – perepm May 18 '22 at 19:07

score 29 · Accepted Answer · answered Jan 13 '14 at 11:21

29

The calls are made asynchronous, so you need to use callback functions to chain them.

it('should respond to GET with added items', function(done) {
    var agent = request(app);
    agent.post('/player').type('json').send({name:"Messi"}).end(function(){
        agent.post('/player').type('json').send({name:"Maradona"}).end(function(){
            agent.get('/player')
                .set("Accept", "application/json")
                .expect(200)
                .end(function(err, res) {
                    res.body.should.have.property('items').with.lengthOf(2);
                    done();
                });
        });
    });
});

answered Jan 13 '14 at 11:21

harun

1,889
18
19

9

Have a look at [supertest-as-promised](https://www.npmjs.org/package/supertest-as-promised) to reduce the nesting of callbacks – Luke H Aug 06 '14 at 11:41
Is it possible to chain them without using `mocha` or `it` ? – gurvinder372 Mar 23 '16 at 06:59
4

supertest has native promise support since version [2.0.0](https://github.com/visionmedia/supertest/blob/master/History.md#200--2016-07-29) – ricca May 07 '17 at 07:50
I couldn't get this solution to work. However, I could get the "async" solution (by Tim) below to work. – user952342 Mar 23 '18 at 13:33
2

This answer is correct, however outdated, using async/await can give the same result with a much cleaner implementation – Mazen Elkashef Mar 08 '20 at 03:08
@ricca The link you've added to multiple posts does not work anymore. – aderchox Dec 17 '21 at 10:07

score 15 · Answer 3 · answered Jun 03 '16 at 17:59

15

This can be most elegantly solved with promises, and there's a really useful library to use promises with supertest: https://www.npmjs.com/package/supertest-as-promised

Their example:

return request(app)
  .get("/user")
  .expect(200)
  .then(function (res) {
    return request(app)
      .post("/kittens")
      .send({ userId: res})
      .expect(201);
  })
  .then(function (res) {
    // ... 
  });

answered Jun 03 '16 at 17:59

Phil

180
1
5

Promises are a good option here. Just need to be weary of situations where you might need to recover from a 404 somewhere in that chain. – backdesk Aug 08 '16 at 13:22
3

supertest has native promise support since version [2.0.0](https://github.com/visionmedia/supertest/blob/master/History.md#200--2016-07-29) – ricca May 07 '17 at 07:52

Tom Söderlund · Answer 4 · 2017-07-19T18:41:49.417

I built upon Tim’s reply but used async.waterfall instead, to be able to do assert tests on the results (note: I use Tape here instead of Mocha):

test('Test the entire API', function (assert) {
    const app = require('../app/app');
    async.waterfall([
            (cb) => request(app).get('/api/accounts').expect(200, cb),
            (results, cb) => { assert.ok(results.body.length, 'Returned accounts list'); cb(null, results); },
            (results, cb) => { assert.ok(results.body[0].reference, 'account #0 has reference'); cb(null, results); },
            (results, cb) => request(app).get('/api/plans').expect(200, cb),
            (results, cb) => request(app).get('/api/services').expect(200, cb),
            (results, cb) => request(app).get('/api/users').expect(200, cb),
        ],
        (err, results) => {
            app.closeDatabase();
            assert.end();
        }
    );
});

You saved me a lot of time. Currently, it's the best answer. — andrzej1_1, Dec 30 '17 at 11:30

score 0 · Answer 5 · edited Jul 26 '22 at 11:18

0

This worked for me :

const agent = request(server.app);
const fn = (counter) => {
  agent.get('/').end((_error, res) => {
    if (res.status !== 200) {
      done();
      expect(counter).toEqual(20);
    } else
      fn(counter + 1);
  })
}

fn(1);

edited Jul 26 '22 at 11:18

Tyler2P

2,324
26
22
31

answered Jul 22 '22 at 03:02

niomu

9
4

How to chain http calls with superagent/supertest?

5 Answers5

Linked