feat(session): returns Local Storage Data & Session Storage Data (#38)

README.md

@@ -37,11 +37,12 @@ Supported identity providers:
 
 1. Call the declared task with a set of options for the social login flow interaction
 2. Set the cookies for the test flow with the help of `Cypress.Cookies.defaults`
+3. Copy over all or some (or none) of the local & session storage objects from puppeteer to local instance
 
 ```js
 cy.clearCookies()
 
-return cy.task('GoogleSocialLogin', socialLoginOptions).then(({cookies}) => {
+return cy.task('GoogleSocialLogin', socialLoginOptions).then(({cookies,lsd,ssd}) => {
   const cookie = cookies.filter(cookie => cookie.name === cookieName).pop()
   if (cookie) {
     cy.setCookie(cookie.name, cookie.value, {
@@ -56,6 +57,17 @@ return cy.task('GoogleSocialLogin', socialLoginOptions).then(({cookies}) => {
       whitelist: cookieName
     })
   }
+
+  // ssd contains session storage data (window.sessionStorage)
+  // lsd contains local storage data (window.localStorage)
+
+  cy.window().then(window => {
+      Object.keys(ssd).forEach(key => window.sessionStorage.setItem(key, ssd[key]));
+      Object.keys(lsd).forEach(key => window.sessionStorage.setItem(key, ssd[key]));
+  });
+
+
+
 })
 ```
 

src/Plugins.js

@@ -23,7 +23,7 @@ const puppeteer = require('puppeteer')
 module.exports.GoogleSocialLogin = async function GoogleSocialLogin(options = {}) {
   validateOptions(options)
 
-  const launchOptions = {headless: !!options.headless}
+  const launchOptions = { headless: !!options.headless }
 
   if (options.args && options.args.length) {
     launchOptions.args = options.args
@@ -32,10 +32,10 @@ module.exports.GoogleSocialLogin = async function GoogleSocialLogin(options = {}
   const browser = await puppeteer.launch(launchOptions)
   let page = await browser.newPage()
   let originalPageIndex = 1
-  await page.setViewport({width: 1280, height: 800})
+  await page.setViewport({ width: 1280, height: 800 })
 
   await page.goto(options.loginUrl)
-  await login({page, options})
+  await login({ page, options })
 
   // Switch to Popup Window
   if (options.isPopup) {
@@ -50,8 +50,8 @@ module.exports.GoogleSocialLogin = async function GoogleSocialLogin(options = {}
     page = pages[pages.length - 1]
   }
 
-  await typeUsername({page, options})
-  await typePassword({page, options})
+  await typeUsername({ page, options })
+  await typePassword({ page, options })
 
   // Switch back to Original Window
   if (options.isPopup) {
@@ -66,17 +66,18 @@ module.exports.GoogleSocialLogin = async function GoogleSocialLogin(options = {}
     await delay(options.cookieDelay)
   }
 
-  const cookies = await getCookies({page, options})
-
-  await finalizeSession({page, browser, options})
+  const cookies = await getCookies({ page, options });
+  const lsd = await getLocalStorageData({ page, options });
+  const ssd = await getSessionStorageData({ page, options });
+  await finalizeSession({ page, browser, options })
 
   return {
-    cookies
+    cookies, lsd, ssd
   }
 }
 
 function delay(time) {
-  return new Promise(function(resolve) {
+  return new Promise(function (resolve) {
     setTimeout(resolve, time)
   })
 }
@@ -87,7 +88,7 @@ function validateOptions(options) {
   }
 }
 
-async function login({page, options} = {}) {
+async function login({ page, options } = {}) {
   if (options.preLoginSelector) {
     await page.waitForSelector(options.preLoginSelector)
     await page.click(options.preLoginSelector)
@@ -102,24 +103,26 @@ async function login({page, options} = {}) {
   await page.click(options.loginSelector)
 }
 
-async function typeUsername({page, options} = {}) {
+async function typeUsername({ page, options } = {}) {
   let buttonSelector = options.headless ? '#next' : '#identifierNext'
 
   await page.waitForSelector('input[type="email"]')
   await page.type('input[type="email"]', options.username)
   await page.click(buttonSelector)
 }
 
+
 async function typePassword({page, options} = {}) {
   let buttonSelectors = ['#signIn', '#passwordNext', '#submit']
 
-  await page.waitForSelector('input[type="password"]', {visible: true})
+  await page.waitForSelector('input[type="password"]', { visible: true })
   await page.type('input[type="password"]', options.password)
+
   const buttonSelector = await waitForMultipleSelectors(buttonSelectors, {visible: true}, page)
   await page.click(buttonSelector)
 }
 
-async function getCookies({page, options} = {}) {
+async function getCookies({ page, options } = {}) {
   await page.waitForSelector(options.postLoginSelector)
 
   const cookies = options.getAllBrowserCookies
@@ -133,12 +136,48 @@ async function getCookies({page, options} = {}) {
   return cookies
 }
 
+async function getLocalStorageData({ page, options } = {}) {
+  await page.waitForSelector(options.postLoginSelector)
+
+  const localStorageData = await page.evaluate(() => {
+    let json = {};
+    for (let i = 0; i < localStorage.length; i++) {
+      const key = localStorage.key(i);
+      json[key] = localStorage.getItem(key);
+    }
+    return json;
+  });
+  if (options.logs) {
+    console.log(localStorageData)
+  }
+
+  return localStorageData
+}
+
+async function getSessionStorageData({ page, options } = {}) {
+  await page.waitForSelector(options.postLoginSelector)
+
+  const sessionStorageData = await page.evaluate(() => {
+    let json = {};
+    for (let i = 0; i < sessionStorage.length; i++) {
+      const key = sessionStorage.key(i);
+      json[key] = sessionStorage.getItem(key);
+    }
+    return json;
+  });
+  if (options.logs) {
+    console.log(sessionStorageData)
+  }
+
+  return sessionStorageData
+}
+
 async function getCookiesForAllDomains(page) {
   const cookies = await page._client.send('Network.getAllCookies', {})
   return cookies.cookies
 }
 
-async function finalizeSession({page, browser, options} = {}) {
+async function finalizeSession({ page, browser, options } = {}) {
   await browser.close()
 }