Separate CookieJar objects for WebPages

[jrollinson]

Currently, there exists a single CookieJar object for all web pages. This is in line with the usual behaviour of web pages, but causes difficulty when treating pages as separate entities.

To fix: CookieJar should not be a singleton, and objects that use a CookieJar should have one passed in on construction.

[jrollinson]

Relevant Ghostdriver issues:
https://github.com/detro/ghostdriver/issues/90
https://github.com/detro/ghostdriver/issues/170

[ariya]

Interesting. Let me come up with a hypothetical API and code:

var myJar = new CookieJar();
page.cookieJar = myJar;
myJar.save('/secret/path/to/my/locker/cookie.dat');

Does that make sense? Obviously, there can be a default cookie jar for a new page instance.

[JamesMGreene]

What about for loading an existing CookieJar? Specify a path in the constructor, maybe?

[jrollinson]

@ariya Are you suggesting a new CookieJar module like this?

var cookieJarCreator = require('cookieJar');
var myJar = cookieJarCreator.create();

[jrollinson]

I think an optional path in the constructor would be a great way for loading existing cookie jars.

[ariya]

Whether it's in its own module, conveniently constructed, etc are small details. What we need to come up with is the answer to the following question "if such an API is provided, how would your code look like".

[jrollinson]

Ok. I think the code would look like this:

var myJar = new CookieJar();
page1.cookieJar = myJar;
page2.cookieJar = myJar;
myJar.addCookie(cookie);

... do whatever ...

page1.close();
page2.close();
myJar.save(path);
myJar.close();

A new page would have the default CookieJar and then you can set the page's CookieJar to be whatever you want.
Making the user explicitly close the CookieJar would save a bit of a nightmare.

Also, I think that the CookieJar should have the same API that both the phantom and webpage objects have with cookies.
In other words it should have the following functions and properties:

addCookie(Cookie);
deleteCookie(cookieName);
cookies;
clearCookies();
save(path);
close();

We should also add a CookieJar getter on the phantom object and both a getter and a setter for the CookieJar in webpages.

[AGoblinKing]

Running into this problem with trying to run tests in parallel in CasperJS. Having the ability to set CookieJars per instance of WebPage would be extremely helpful.

[jrollinson]

I would like to be responsible for this issue. What do you think about the interface I described above?

[brokenthumbs]

Any chance that this update could be pulled in to PhantomJS? Would love to use PhantomJS with GhostDriver and run sessions in parallel, and this would help eliminate any shared cookie issues, to mitigate issues concerning logging in as different users and such.

[artkoshelev]

waiting for this issues as well, it's a show-stopper for using PhantomJS with GhostDriver in our web-tests