feat: add option to set cookies before visiting loginUrl (#122)

README.md

@@ -101,6 +101,7 @@ Options passed to the task include:
 | screenshotOnError           | Optional: will grab a screen shot if an error occurs on the username, password, or post-login page and saves in the Cypress screenshots folder.                                                                                                                                                                                                                       | false                                                                                                                             |
 | additionalSteps             | Optional: function, to define any additional steps which may be required after executing functions for username and password, such as answering security questions, PIN, or anything which may be required to fill out after username and password process. The function and this property must be defined or referenced from index.js for Cypress Plugins directory. | `async function moreSteps({page, options} = {}) { await page.waitForSelector('#pin_Field') await page.click('#pin_Field') }`      |
 | trackingConsentSelectors    | Optional: selectors to find and click on after clicking the login button, but before entering details on the third-party site (useful for accepting third-party cookies e.g. Facebook login). Provide multiple if wanting to accept only essential cookies and it requires multiple clicks                                                                            | `['button[data-testid="cookie-policy-dialog-manage-button"]', 'button-data-testid="cookie-policy-manage-dialog-accept-button"]']` |
+| preVisitLoginUrlSetCookies   | Optional: array of cookies to set before visiting the `loginUrl` | `[{name: 'enable-social-login', value: 'true', domain: '.cypress.io'}]` |
 
 ## Install
 

src/Plugins.js

@@ -11,6 +11,7 @@ const fs = require('fs')
  * @param {options.password} string password
  * @param {options.loginUrl} string password
  * @param {options.loginUrlCredentials} Object Basic Authentication credentials for the `loginUrl`
+ * @param {options.preVisitLoginUrlSetCookies} array[{name: string, value: string, domain: string}] cookies to set before visiting `loginUrl`
  * @param {options.args} array[string] string array which allows providing further arguments to puppeteer
  * @param {options.loginSelector} string a selector on the loginUrl page for the social provider button
  * @param {options.loginSelectorDelay} number delay a specific amount of time before clicking on the login button, defaults to 250ms. Pass a boolean false to avoid completely.
@@ -203,6 +204,11 @@ async function baseLoginConnect(
   if (options.loginUrlCredentials) {
     await page.authenticate(options.loginUrlCredentials)
   }
+
+  if (options.preVisitLoginUrlSetCookies && options.preVisitLoginUrlSetCookies.length > 0) {
+    await page.setCookie(...options.preVisitLoginUrlSetCookies)
+  }
+
   await page.goto(options.loginUrl)
   await login({page, options})