How can you use cookies with superagent?

Question

I'm doing cookie session management with express with something like this:

req.session.authentication = auth;

And I verify the authenticated urls with something like

if(!req.session.authentication){res.send(401);}

Now I'm building tests for the URLs with mocha, superagent and should, however I can't seem to find a way to get/set the cookie with superagent. I even tried to request the login before the authenticated test but it is not working,

I have tried adding the request to the login in the before statement for the mocha BDD suite, however it is still telling me that the request is unauthorized, I have tested the authentication doing the requests from the browser, however it is not working from the suite any ideas why?

BrDaHa · Accepted Answer · 2023-01-30 23:19:08Z

35

Use superagent.agent() (instead of plain old superagent) to make requests have persistent cookies. See 'Saving cookies' in the superagent docs, or the code examples: agency.js, controller.test.js.

edited Jan 30, 2023 at 23:19

BrDaHa

5,9206 gold badges36 silver badges53 bronze badges

answered Oct 4, 2012 at 20:04

Gaurav

9949 silver badges13 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Stuart P. Bentley Over a year ago

Note that superagent.agent() has serious, undocumented issues in how it handles cookies for most request definitions - anything more complicated than a get(url,opts,cb) requires hooking into undocumented private methods.

Steve Over a year ago

In fact the documentation has no mention of cookies either. I was really starting to like this library and had high hopes because of the author, but it turns out to be useless if you want to use a session cookie.

Zargold Over a year ago

this did not work / if it did it isn't really sufficient... can someone provide an example of how that works....

Vikramaditya · Accepted Answer · 2017-03-20 14:11:25Z

23

Seems like following code works fine;

req.set('Cookie', "cookieName1=cookieValue1;cookieName2=cookieValue2");

edited Mar 20, 2017 at 14:11

Vikramaditya

5,5947 gold badges37 silver badges47 bronze badges

answered Jan 14, 2016 at 16:55

Teoman shipahi

23.5k16 gold badges147 silver badges175 bronze badges

1 Comment

Kevin H Over a year ago

This did not work for me using Django {"Cookie": "csrftoken=token here"}

Denys Feshchenko · Accepted Answer · 2016-09-28 10:05:22Z

If the issue is in sending cookies for CORS requests use .withCredentials() method described here

request .get('http://localhost:4001/') .withCredentials() .end(function(err, res) { })

BAR · Accepted Answer · 2016-07-06 21:28:19Z

Since you mentioned you need to both get and set the cookie:

Get:

const request = await Superagent.get('...') const cookie = request.header['set-cookie']

Set:

Superagent.post('...').set('Cookie', 'cookie_info')

Sebastien Horin · Accepted Answer · 2020-05-02 02:13:41Z

2020 +

A clean way to do it is:

create a simple cookie store
abstract set Cookie to send it in each request
update the cookie only when needed

Note I keep the same URL because I use graphql but you can make it a parameter:

const graph = agent => agent.post('/graph') .set('cookie', cookieStore.get()); const handleCookie = res => cookieStore.set(res.headers['set-cookie'][0]); let currentCookie=""; const cookieStore = { set: cookie=>{currentCookie=cookie}, get: cookie=>currentCookie, }; module.exports = {graph,connectTestUser,handleCookieResponse};

You can now just use graph(agent) to send a request and handleCookie(response) when you have a response that may update your cookie (set or clear), example:

graph(agent).end((err,res) => { if (err) return done(err); res.statusCode.should.equal(200); handleCookie(res); return done(); });

Shouldn't it be res.header['set-cookie'] rather than res.headers['set-cookie']?

pguardiario · Accepted Answer · 2022-02-28 02:17:55Z

Add a cookie to agent cookiejar:

const request = require('superagent'); const {Cookie} = require('cookiejar') const agent = request.agent() agent.jar.setCookie(new Cookie("foo=bar"))

Collectives™ on Stack Overflow

How can you use cookies with superagent?

6 Answers 6

3 Comments

1 Comment

Comments

Comments

2020 +

1 Comment

Comments

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

3 Comments

1 Comment

Comments

Comments

2020 +

1 Comment

Comments

Related