added setWindowSize, renamed hooks

Author: DavertMik

README.md

@@ -4,21 +4,21 @@ Configuration hook is a function that is updates CodeceptJS configuration.
 
 Those hooks are expected to simplify configuration for common use cases.
 
-### useHeadlessWhen
+### setHeadlessWhen
 
 Toggle headless mode for Puppeteer, WebDriver, TestCafe, and Nightmare on condition.
 
 Usage:
 
 ```js
 // in codecept.conf.js
-const { useHeadlessWhen } = require('@codeceptjs/configure');
+const { setHeadlessWhen } = require('@codeceptjs/configure');
 
 // enable headless only if environment variable HEADLESS exist
-useHeadlessWhen(process.env.HEADLESS); 
+setHeadlessWhen(process.env.HEADLESS); 
 
 // or enable headless on CI
-useHeadlessWhen(process.env.CI); 
+setHeadlessWhen(process.env.CI); 
 
 exports.config = {
   helpers: {
@@ -33,7 +33,7 @@ exports.config = {
 * For Puppeteer, TestCafe, Nigthmare it enables `show: true`.
 * For WebDriver with Chrome browser adds `--headless` option to chrome options inside desiredCapabilities.
 
-### useSharedCookies
+### setSharedCookies
 
 Shares cookies between browser and REST/GraphQL helpers.
 
@@ -42,10 +42,10 @@ This function obtains cookies from an active session in WebDriver or Puppeteer h
 
 ```js
 // in codecept.conf.js
-const { useSharedCookies } = require('@codeceptjs/configure');
+const { setSharedCookies } = require('@codeceptjs/configure');
 
 // share cookies between browser helpers and REST/GraphQL
-useSharedCookies();
+setSharedCookies();
 
 exports.config = {
   helpers: {

codeceptjs.js

@@ -0,0 +1,3 @@
+const codeceptjs = require('codeceptjs');
+
+module.exports = codeceptjs;

deepMerge.js

@@ -0,0 +1,11 @@
+const merge = require('lodash.mergewith');
+
+function customizer(objValue, srcValue) {
+  if (Array.isArray(objValue)) {
+    return objValue.concat(srcValue);
+  }
+}
+
+module.exports = function (a, b) {
+  return merge(a, b, customizer); 
+}

hooks/setHeadlessWhen.js

@@ -0,0 +1,32 @@
+const { config } = require('../codeceptjs');
+const merge = require('../deepMerge');
+
+module.exports = function(when) {
+  if (!when) return;
+
+  config.addHook(cfg => {
+    if (!cfg.helpers) return;
+    if (cfg.helpers.Puppeteer) {
+      cfg.helpers.Puppeteer.show = false;
+    }
+    if (cfg.helpers.Nightmare) {
+      cfg.helpers.Nightmare.show = false;
+    }
+    if (cfg.helpers.TestCafe) {
+      cfg.helpers.TestCafe.show = false;
+    }
+    if (cfg.helpers.WebDriver) {
+      if (cfg.helpers.WebDriver.browser === 'chrome') {
+
+        cfg.helpers.WebDriver.desiredCapabilities = merge(
+          cfg.helpers.WebDriver.desiredCapabilities || {},
+          {
+            chromeOptions: {
+              args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
+            }
+          }
+        )
+      }
+    }
+  });
+}

hooks/setSharedCookies.js

@@ -0,0 +1,32 @@
+const { container, config } = require('../codeceptjs');
+
+module.exports = function() {
+  const browserHelpers = ['WebDriver','Protractor','Puppeteer','TestCafe','Nigthmare'];
+  config.addHook(cfg => {
+    const helper = detectBrowserHelper(cfg.helpers);
+    let cookies;
+    const shareCookiesFn = async (request) => {
+      if (!cookies) cookies = await container.helpers(helper).grabCookie();
+      request.headers = { Cookie: cookies.map(c => `${c.name}=${c.value}`).join('; ') };      
+    }
+    if (cfg.helpers.REST) {
+      cfg.helpers.REST.onRequest = shareCookiesFn;
+    }
+    if (cfg.helpers.ApiDataFactory) {
+      cfg.helpers.ApiDataFactory.onRequest = shareCookiesFn;
+    }
+    if (cfg.helpers.GraphQL) {
+      cfg.helpers.GraphQL.onRequest = shareCookiesFn;
+    }
+    if (cfg.helpers.GraphQLDataFactory) {
+      cfg.helpers.GraphQLDataFactory.onRequest = shareCookiesFn;
+    }
+  });
+  
+  function detectBrowserHelper(helperConfig) {
+    if (!helperConfig) return false;
+    for (const helper of browserHelpers) {
+      if (Object.keys(helperConfig).indexOf(helper) >= 0) return helper;
+    }
+  }
+}

hooks/setWindowSize.js

@@ -0,0 +1,31 @@
+const { config } = require('../codeceptjs');
+const merge = require('../deepMerge');
+
+module.exports = function(width, height) {
+  config.addHook(cfg => {
+    if (!cfg.helpers) return;
+    if (cfg.helpers.Puppeteer) {
+      const args = ['--no-sandbox', `--window-size=${width},${height}`];
+      cfg.helpers.Puppeteer.windowSize = `${width}x${height}`;
+
+      // prepare window for a browser
+      cfg.helpers.Puppeteer.chrome = merge(
+        cfg.helpers.Puppeteer.chrome || {}, 
+        { args, defaultViewport: null, } // disables viewport emualtion. See https://github.com/Codeception/CodeceptJS/issues/1209#issuecomment-522487793
+      );
+    }
+
+    if (cfg.helpers.Protractor) {
+      cfg.helpers.Protractor.windowSize = `${width}x${height}`;
+    }
+    if (cfg.helpers.Nightmare) {
+      cfg.helpers.Nightmare.windowSize = `${width}x${height}`;
+    }
+    if (cfg.helpers.TestCafe) {
+      cfg.helpers.TestCafe.windowSize = `${width}x${height}`;
+    }
+    if (cfg.helpers.WebDriver) {
+      cfg.helpers.WebDriver.windowSize = `${width}x${height}`;
+    }
+  });
+}

hooks/useHeadlessWhen.js

@@ -1,4 +1,5 @@
 module.exports = {
-  useHeadlessWhen: require('./hooks/useHeadlessWhen'),
-  useSharedCookies: require('./hooks/useSharedCookies'),
+  setHeadlessWhen: require('./hooks/setHeadlessWhen'),
+  setSharedCookies: require('./hooks/setSharedCookies'),
+  setWindowSize: require('./hooks/setWindowSize'),
 }