api(addCookies): setCookies -> addCookies (#1367)

#1348

docs/api.md

@@ -282,6 +282,7 @@ await context.close();
 <!-- GEN:toc -->
 - [event: 'close'](#event-close)
 - [event: 'page'](#event-page)
+- [browserContext.addCookies(cookies)](#browsercontextaddcookiescookies)
 - [browserContext.addInitScript(script[, ...args])](#browsercontextaddinitscriptscript-args)
 - [browserContext.clearCookies()](#browsercontextclearcookies)
 - [browserContext.clearPermissions()](#browsercontextclearpermissions)
@@ -291,7 +292,6 @@ await context.close();
 - [browserContext.newPage()](#browsercontextnewpage)
 - [browserContext.pages()](#browsercontextpages)
 - [browserContext.route(url, handler)](#browsercontextrouteurl-handler)
-- [browserContext.setCookies(cookies)](#browsercontextsetcookiescookies)
 - [browserContext.setDefaultNavigationTimeout(timeout)](#browsercontextsetdefaultnavigationtimeouttimeout)
 - [browserContext.setDefaultTimeout(timeout)](#browsercontextsetdefaulttimeouttimeout)
 - [browserContext.setExtraHTTPHeaders(headers)](#browsercontextsetextrahttpheadersheaders)
@@ -323,6 +323,23 @@ const [event] = await Promise.all([
 const newPage = await event.page();
 ```
 
+#### browserContext.addCookies(cookies)
+- `cookies` <[Array]<[Object]>>
+  - `name` <[string]> **required**
+  - `value` <[string]> **required**
+  - `url` <[string]> either url or domain / path are **required**
+  - `domain` <[string]> either url or domain / path are **required**
+  - `path` <[string]> either url or domain / path are **required**
+  - `expires` <[number]> Unix time in seconds.
+  - `httpOnly` <[boolean]>
+  - `secure` <[boolean]>
+  - `sameSite` <"Strict"|"Lax"|"None">
+- returns: <[Promise]>
+
+```js
+await browserContext.addCookies([cookieObject1, cookieObject2]);
+```
+
 #### browserContext.addInitScript(script[, ...args])
 - `script` <[function]|[string]|[Object]> Script to be evaluated in all pages in the browser context.
   - `path` <[string]> Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd).
@@ -472,23 +489,6 @@ Page routes (set up with [page.route(url, handler)](#pagerouteurl-handler)) take
 
 > **NOTE** Enabling request interception disables http cache.
 
-#### browserContext.setCookies(cookies)
-- `cookies` <[Array]<[Object]>>
-  - `name` <[string]> **required**
-  - `value` <[string]> **required**
-  - `url` <[string]> either url or domain / path are **required**
-  - `domain` <[string]> either url or domain / path are **required**
-  - `path` <[string]> either url or domain / path are **required**
-  - `expires` <[number]> Unix time in seconds.
-  - `httpOnly` <[boolean]>
-  - `secure` <[boolean]>
-  - `sameSite` <"Strict"|"Lax"|"None">
-- returns: <[Promise]>
-
-```js
-await browserContext.setCookies([cookieObject1, cookieObject2]);
-```
-
 #### browserContext.setDefaultNavigationTimeout(timeout)
 - `timeout` <[number]> Maximum navigation time in milliseconds
 
@@ -3928,6 +3928,7 @@ const backgroundPage = await backroundPageTarget.page();
 <!-- GEN:toc-extends-BrowserContext -->
 - [event: 'close'](#event-close)
 - [event: 'page'](#event-page)
+- [browserContext.addCookies(cookies)](#browsercontextaddcookiescookies)
 - [browserContext.addInitScript(script[, ...args])](#browsercontextaddinitscriptscript-args)
 - [browserContext.clearCookies()](#browsercontextclearcookies)
 - [browserContext.clearPermissions()](#browsercontextclearpermissions)
@@ -3937,7 +3938,6 @@ const backgroundPage = await backroundPageTarget.page();
 - [browserContext.newPage()](#browsercontextnewpage)
 - [browserContext.pages()](#browsercontextpages)
 - [browserContext.route(url, handler)](#browsercontextrouteurl-handler)
-- [browserContext.setCookies(cookies)](#browsercontextsetcookiescookies)
 - [browserContext.setDefaultNavigationTimeout(timeout)](#browsercontextsetdefaultnavigationtimeouttimeout)
 - [browserContext.setDefaultTimeout(timeout)](#browsercontextsetdefaulttimeouttimeout)
 - [browserContext.setExtraHTTPHeaders(headers)](#browsercontextsetextrahttpheadersheaders)

src/browserContext.ts

@@ -44,7 +44,7 @@ export interface BrowserContext {
   pages(): Promise<Page[]>;
   newPage(): Promise<Page>;
   cookies(urls?: string | string[]): Promise<network.NetworkCookie[]>;
-  setCookies(cookies: network.SetNetworkCookieParam[]): Promise<void>;
+  addCookies(cookies: network.SetNetworkCookieParam[]): Promise<void>;
   clearCookies(): Promise<void>;
   setPermissions(origin: string, permissions: string[]): Promise<void>;
   clearPermissions(): Promise<void>;
@@ -92,7 +92,7 @@ export abstract class BrowserContextBase extends platform.EventEmitter implement
   abstract pages(): Promise<Page[]>;
   abstract newPage(): Promise<Page>;
   abstract cookies(...urls: string[]): Promise<network.NetworkCookie[]>;
-  abstract setCookies(cookies: network.SetNetworkCookieParam[]): Promise<void>;
+  abstract addCookies(cookies: network.SetNetworkCookieParam[]): Promise<void>;
   abstract clearCookies(): Promise<void>;
   abstract setPermissions(origin: string, permissions: string[]): Promise<void>;
   abstract clearPermissions(): Promise<void>;

src/chromium/crBrowser.ts

@@ -307,7 +307,7 @@ export class CRBrowserContext extends BrowserContextBase {
     }), urls);
   }
 
-  async setCookies(cookies: network.SetNetworkCookieParam[]) {
+  async addCookies(cookies: network.SetNetworkCookieParam[]) {
     await this._browser._session.send('Storage.setCookies', { cookies: network.rewriteCookies(cookies), browserContextId: this._browserContextId || undefined });
   }
 

src/firefox/ffBrowser.ts

@@ -224,7 +224,7 @@ export class FFBrowserContext extends BrowserContextBase {
     }), urls);
   }
 
-  async setCookies(cookies: network.SetNetworkCookieParam[]) {
+  async addCookies(cookies: network.SetNetworkCookieParam[]) {
     await this._browser._connection.send('Browser.setCookies', { browserContextId: this._browserContextId || undefined, cookies: network.rewriteCookies(cookies) });
   }
 

src/webkit/wkBrowser.ts

@@ -239,7 +239,7 @@ export class WKBrowserContext extends BrowserContextBase {
     }), urls);
   }
 
-  async setCookies(cookies: network.SetNetworkCookieParam[]) {
+  async addCookies(cookies: network.SetNetworkCookieParam[]) {
     const cc = network.rewriteCookies(cookies).map(c => ({
       ...c,
       session: c.expires === -1 || c.expires === undefined,

test/cookies.spec.js

@@ -124,7 +124,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
       ]);
     });
     it('should get cookies from multiple urls', async({context}) => {
-      await context.setCookies([{
+      await context.addCookies([{
         url: 'https://foo.com',
         name: 'doggo',
         value: 'woofs',
@@ -161,10 +161,10 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     });
   });
 
-  describe('BrowserContext.setCookies', function() {
+  describe('BrowserContext.addCookies', function() {
     it('should work', async({context, page, server}) => {
       await page.goto(server.EMPTY_PAGE);
-      await context.setCookies([{
+      await context.addCookies([{
         url: server.EMPTY_PAGE,
         name: 'password',
         value: '123456'
@@ -182,7 +182,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
       const cookies = await context.cookies();
       await context.clearCookies();
       expect(await context.cookies()).toEqual([]);
-      await context.setCookies(cookies);
+      await context.addCookies(cookies);
       expect(await context.cookies()).toEqual(cookies);
     });
     it('should send cookie header', async({server, context}) => {
@@ -191,15 +191,15 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
         cookie = req.headers.cookie;
         res.end();
       });
-      await context.setCookies([{url: server.EMPTY_PAGE, name: 'cookie', value: 'value'}]);
+      await context.addCookies([{url: server.EMPTY_PAGE, name: 'cookie', value: 'value'}]);
       const page = await context.newPage();
       await page.goto(server.EMPTY_PAGE);
       expect(cookie).toBe('cookie=value');
     });
     it('should isolate cookies in browser contexts', async({context, server, browser}) => {
       const anotherContext = await browser.newContext();
-      await context.setCookies([{url: server.EMPTY_PAGE, name: 'isolatecookie', value: 'page1value'}]);
-      await anotherContext.setCookies([{url: server.EMPTY_PAGE, name: 'isolatecookie', value: 'page2value'}]);
+      await context.addCookies([{url: server.EMPTY_PAGE, name: 'isolatecookie', value: 'page1value'}]);
+      await anotherContext.addCookies([{url: server.EMPTY_PAGE, name: 'isolatecookie', value: 'page2value'}]);
 
       const cookies1 = await context.cookies();
       const cookies2 = await anotherContext.cookies();
@@ -261,7 +261,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
         cookie = req.headers.cookie || '';
         res.end();
       });
-      await context.setCookies([{url: server.EMPTY_PAGE, name: 'sendcookie', value: 'value'}]);
+      await context.addCookies([{url: server.EMPTY_PAGE, name: 'sendcookie', value: 'value'}]);
       {
         const page = await context.newPage();
         await page.goto(server.EMPTY_PAGE);
@@ -278,7 +278,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     it.slow()('should isolate cookies between launches', async({server}) => {
       const browser1 = await playwright.launch(defaultBrowserOptions);
       const context1 = await browser1.newContext();
-      await context1.setCookies([{url: server.EMPTY_PAGE, name: 'cookie-in-context-1', value: 'value', expires: Date.now() / 1000 + 10000}]);
+      await context1.addCookies([{url: server.EMPTY_PAGE, name: 'cookie-in-context-1', value: 'value', expires: Date.now() / 1000 + 10000}]);
       await browser1.close();
 
       const browser2 = await playwright.launch(defaultBrowserOptions);
@@ -289,7 +289,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     });
     it('should set multiple cookies', async({context, page, server}) => {
       await page.goto(server.EMPTY_PAGE);
-      await context.setCookies([{
+      await context.addCookies([{
         url: server.EMPTY_PAGE,
         name: 'multiple-1',
         value: '123456'
@@ -307,7 +307,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
       ]);
     });
     it('should have |expires| set to |-1| for session cookies', async({context, server}) => {
-      await context.setCookies([{
+      await context.addCookies([{
         url: server.EMPTY_PAGE,
         name: 'expires',
         value: '123456'
@@ -316,7 +316,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
       expect(cookies[0].expires).toBe(-1);
     });
     it('should set cookie with reasonable defaults', async({context, server}) => {
-      await context.setCookies([{
+      await context.addCookies([{
         url: server.EMPTY_PAGE,
         name: 'defaults',
         value: '123456'
@@ -335,7 +335,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     });
     it('should set a cookie with a path', async({context, page, server}) => {
       await page.goto(server.PREFIX + '/grid.html');
-      await context.setCookies([{
+      await context.addCookies([{
         domain: 'localhost',
         path: '/grid.html',
         name: 'gridcookie',
@@ -360,7 +360,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     it('should not set a cookie with blank page URL', async function({context, server}) {
       let error = null;
       try {
-        await context.setCookies([
+        await context.addCookies([
             {url: server.EMPTY_PAGE, name: 'example-cookie', value: 'best'},
             {url: 'about:blank', name: 'example-cookie-blank', value: 'best'}
         ]);
@@ -374,7 +374,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     it('should not set a cookie on a data URL page', async function({context}) {
       let error = null;
       try {
-        await context.setCookies([{url: 'data:,Hello%2C%20World!', name: 'example-cookie', value: 'best'}]);
+        await context.addCookies([{url: 'data:,Hello%2C%20World!', name: 'example-cookie', value: 'best'}]);
       } catch (e) {
         error = e;
       }
@@ -383,7 +383,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     it('should default to setting secure cookie for HTTPS websites', async({context, page, server}) => {
       await page.goto(server.EMPTY_PAGE);
       const SECURE_URL = 'https://example.com';
-      await context.setCookies([{
+      await context.addCookies([{
         url: SECURE_URL,
         name: 'foo',
         value: 'bar',
@@ -394,7 +394,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     it('should be able to set unsecure cookie for HTTP website', async({context, page, server}) => {
       await page.goto(server.EMPTY_PAGE);
       const HTTP_URL = 'http://example.com';
-      await context.setCookies([{
+      await context.addCookies([{
         url: HTTP_URL,
         name: 'foo',
         value: 'bar',
@@ -404,7 +404,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     });
     it('should set a cookie on a different domain', async({context, page, server}) => {
       await page.goto(server.EMPTY_PAGE);
-      await context.setCookies([{
+      await context.addCookies([{
         url: 'https://www.example.com',
         name: 'example-cookie',
         value: 'best',
@@ -423,7 +423,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     });
     it('should set cookies from a frame', async({context, page, server}) => {
       await page.goto(server.PREFIX + '/grid.html');
-      await context.setCookies([
+      await context.addCookies([
         {url: server.PREFIX, name: 'localhost-cookie', value: 'best'},
         {url: server.CROSS_PROCESS_PREFIX, name: '127-cookie', value: 'worst'}
       ]);
@@ -467,7 +467,7 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
   describe('BrowserContext.clearCookies', function() {
     it('should clear cookies', async({context, page, server}) => {
       await page.goto(server.EMPTY_PAGE);
-      await context.setCookies([{
+      await context.addCookies([{
         url: server.EMPTY_PAGE,
         name: 'cookie1',
         value: '1'
@@ -480,8 +480,8 @@ module.exports.describe = function({testRunner, expect, playwright, defaultBrows
     });
     it('should isolate cookies when clearing', async({context, server, browser}) => {
       const anotherContext = await browser.newContext();
-      await context.setCookies([{url: server.EMPTY_PAGE, name: 'page1cookie', value: 'page1value'}]);
-      await anotherContext.setCookies([{url: server.EMPTY_PAGE, name: 'page2cookie', value: 'page2value'}]);
+      await context.addCookies([{url: server.EMPTY_PAGE, name: 'page1cookie', value: 'page1value'}]);
+      await anotherContext.addCookies([{url: server.EMPTY_PAGE, name: 'page2cookie', value: 'page2value'}]);
 
       expect((await context.cookies()).length).toBe(1);
       expect((await anotherContext.cookies()).length).toBe(1);

test/defaultbrowsercontext.spec.js

@@ -53,9 +53,9 @@ module.exports.describe = function ({ testRunner, expect, defaultBrowserOptions,
         sameSite: 'None',
       }]);
     });
-    it('context.setCookies() should work', async({page, server}) => {
+    it('context.addCookies() should work', async({page, server}) => {
       await page.goto(server.EMPTY_PAGE);
-      await page.context().setCookies([{
+      await page.context().addCookies([{
         url: server.EMPTY_PAGE,
         name: 'username',
         value: 'John Doe'
@@ -74,7 +74,7 @@ module.exports.describe = function ({ testRunner, expect, defaultBrowserOptions,
     });
     it('context.clearCookies() should work', async({page, server}) => {
       await page.goto(server.EMPTY_PAGE);
-      await page.context().setCookies([{
+      await page.context().addCookies([{
         url: server.EMPTY_PAGE,
         name: 'cookie1',
         value: '1'

test/interception.spec.js

@@ -103,7 +103,7 @@ module.exports.describe = function({testRunner, expect, defaultBrowserOptions, p
     it('should properly return navigation response when URL has cookies', async({context, page, server}) => {
       // Setup cookie.
       await page.goto(server.EMPTY_PAGE);
-      await context.setCookies([{ url: server.EMPTY_PAGE, name: 'foo', value: 'bar'}]);
+      await context.addCookies([{ url: server.EMPTY_PAGE, name: 'foo', value: 'bar'}]);
 
       // Setup request interception.
       await page.route('**/*', request => request.continue());