Merge pull request #174 from Financial-Times/merge_cookies_pa11y

Merge cookies pa11y

Author: lc512k

config/.pa11yci.js

@@ -9,19 +9,41 @@ const smoke = require('./test/smoke.js');
 
 const urls = [];
 
+/**
+ * Headers can be set:
+ * - globally for all apps, in config.defaults.page.headers here
+ * - per test, in smoke.js
+ * Headers objects will be merged, cookies and flags will be concatenated
+ * No flags allowed inside the cookie for easier merging: use the FT-Flags header instead
+ */
+
+const DEFAULT_COOKIE = 'secure=true';
+const DEFAULT_FLAGS = 'ads:off,sourcepoint:off,cookieMessage:off';
+
+// Add any global config (inc headers) here
 const config = {
 	defaults: {
-		page: {},
+		page: {
+			headers: {
+				'Cookie': DEFAULT_COOKIE,
+				'FT-Flags': DEFAULT_FLAGS
+			}
+		},
 		timeout: 50000,
 		hideElements: 'iframe[src*=google],iframe[src*=proxy]',
 		rules: ['Principle1.Guideline1_3.1_3_1_AAA']
 	},
 	urls: []
 }
 
-// Override with project specifics, if any
+
+// What routes returning 200 in smoke.js should we not test?
+// set per-project in PA11Y_ROUTE_EXCEPTIONS in config-vars
 const exceptions = process.env.PA11Y_ROUTE_EXCEPTIONS ? process.env.PA11Y_ROUTE_EXCEPTIONS.split(',') : [];
-config.defaults.page.headers = process.env.PA11Y_HEADERS ? JSON.parse(process.env.PA11Y_HEADERS) : {Cookie: 'next-flags=ads:off,sourcepoint:off,cookieMessage:off; secure=true'};
+
+// What elements should we not run pa11y on (i.e. google ad iFrames)
+// set per-project in PA11Y_HIDE in config-vars
+// Use with caution. May break the experience for users.
 config.defaults.hideElements = process.env.PA11Y_HIDE ? `${process.env.PA11Y_HIDE},${config.defaults.hideElements}` : config.defaults.hideElements;
 
 console.log('PA11Y_ROUTE_EXCEPTIONS:', process.env.PA11Y_ROUTE_EXCEPTIONS);
@@ -36,7 +58,7 @@ config.defaults.page.headers['FT-Next-Backend-Key'] = process.env.FT_NEXT_BACKEN
 
 
 smoke.forEach((smokeConfig) => {
-	for (url in smokeConfig.urls) {
+	for (let url in smokeConfig.urls) {
 
 		let isException = false;
 
@@ -52,21 +74,48 @@ smoke.forEach((smokeConfig) => {
 			url: process.env.TEST_URL + url
 		}
 
-		if(process.env.TEST_URL.includes('local')) {
+		if (process.env.TEST_URL.includes('local')) {
 			thisUrl.screenCapture = './pa11y_screenCapture/' + url + '.png';
 		}
 
+		// Do we have test-specific headers?
 		if (smokeConfig.headers) {
 			thisUrl.page = {};
-			thisUrl.page.headers = smokeConfig.headers
+
+			let fullCookie;
+			let fullFlags;
+
+			// Merge the headers
+			thisUrl.page.headers = Object.assign({}, config.defaults.page.headers, smokeConfig.headers);
+
+			// concatenate any test-specific cookies
+			if (smokeConfig.headers.Cookie) {
+				console.log('• merging cookies...');
+
+				// Keep flags out of the cookie for easier merging
+				if (smokeConfig.headers.Cookie.indexOf('flags') !== -1) {
+					throw Error('please don\'t set any flags inside the Cookie. Use the \'FT-Flags\' header');
+				}
+
+				// Set the concatenated cookies
+				thisUrl.page.headers.Cookie = smokeConfig.headers.Cookie + '; ' + config.defaults.page.headers.Cookie;
+			}
+
+			// concatenate any test-specific flags
+			if (smokeConfig.headers['FT-Flags']) {
+				console.log('• merging flags...');
+
+				// Set the concatenated flags
+				thisUrl.page.headers['FT-Flags'] = smokeConfig.headers['FT-Flags'] + ',' + config.defaults.page.headers['FT-Flags'];
+			}
 		}
 
-		urls.push(thisUrl)
+		urls.push(thisUrl);
 	}
 });
 
-for (viewport of viewports) {
-	for (url of urls) {
+for (let viewport of viewports) {
+	for (let url of urls) {
 		url.viewport = viewport;
 		config.urls.push(url);
 	}