mod-build 3.6.5 → 3.6.7--beta.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.6.7
+
+- Adding a new `grab-shared-scripts` gulp task grab the most recent version from `mod-analytics`. It will copy this version into the site's `resources/scripts/mod-alytics` folder & then update the src in the `head` shared component. Also updated `cache-bust` to ignore this file on build.
+
 ## 3.6.5
 
 - Updating `settings_tolerance` & `library_tolerance` parameters default values in the VWO script to help reduce Heap-VWO undefined properties (for more information on these parameters you can read here -> https://help.vwo.com/hc/en-us/articles/900001789546-Why-Does-VWO-SmartCode-Time-out-and-How-to-Resolve-It-)

package/gulp-tasks/build.js

@@ -5,15 +5,15 @@ module.exports = function(gulp, gulpPlugins, siteSettings, siteData) {
 		var sequenceOpts;
 
 		if (siteData.useTypescript) {
-			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'templates', 'styles', 'compile-prod', 'js-lint', 'html-min', 'css-min', 'js-min', 'img-min', 'extras', 'brand', 'cache-bust', 'build-stat'];
+			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'grab-shared-scripts', 'templates', 'styles', 'compile-prod', 'js-lint', 'html-min', 'css-min', 'js-min', 'img-min', 'extras', 'brand', 'cache-bust', 'build-stat'];
 		} else if (siteData.isWhiteLabel) {
 			if (siteData.isQSPage) {
-				sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'templates', 'styles', 'grab-theme-json', 'combine-files', 'grab-images', 'copy-json', 'js-lint', 'html-min', 'css-min', 'js-min', 'img-min', 'extras', 'brand', 'copy-files-to-build-path', 'cache-bust', 'grab-tooltips-json', 'build-stat'];
+				sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'grab-shared-scripts', 'templates', 'styles', 'grab-theme-json', 'combine-files', 'grab-images', 'copy-json', 'js-lint', 'html-min', 'css-min', 'js-min', 'img-min', 'extras', 'brand', 'copy-files-to-build-path', 'cache-bust', 'grab-tooltips-json', 'build-stat'];
 			} else {
-				sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'templates', 'styles', 'combine-files', 'grab-images', 'js-lint', 'html-min', 'css-min', 'js-min', 'img-min', 'extras', 'brand', 'cache-bust', 'grab-tooltips-json', 'build-stat'];
+				sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'grab-shared-scripts', 'templates', 'styles', 'combine-files', 'grab-images', 'js-lint', 'html-min', 'css-min', 'js-min', 'img-min', 'extras', 'brand', 'cache-bust', 'grab-tooltips-json', 'build-stat'];
 			}
 		} else {
-			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'templates', 'styles', 'js-lint', 'html-min', 'css-min', 'js-min', 'img-min', 'extras', 'brand', 'cache-bust', 'build-stat'];
+			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'grab-shared-scripts', 'templates', 'styles', 'js-lint', 'html-min', 'css-min', 'js-min', 'img-min', 'extras', 'brand', 'cache-bust', 'build-stat'];
 		}
 
 		runSequence(...sequenceOpts, function() {

package/gulp-tasks/cache-bust.js

@@ -3,8 +3,8 @@ module.exports = function(gulp, gulpPlugins, siteSettings) {
 	return function() {
 		return gulp.src(siteSettings.distFolder + '/**')
 			.pipe(gulpPlugins.revAll.revision({
-				dontRenameFile: [/^\/favicon.ico$/g, '.html', '.txt', /modlogo([\w|\s|-])*\.(?:svg)/g],
-				dontUpdateReference: [/^\/favicon.ico$/g, '.html', '.txt', /modlogo([\w|\s|-])*\.(?:svg)/g],
+				dontRenameFile: [/^\/favicon.ico$/g, '.html', '.txt', /modlogo([\w|\s|-])*\.(?:svg)/g, /.*modalytics.*/],
+				dontUpdateReference: [/^\/favicon.ico$/g, '.html', '.txt', /modlogo([\w|\s|-])*\.(?:svg)/g, /.*modalytics.*/],
 				transformFilename: function (file, hash) {
 					var ext = path.extname(file.path);
 					return path.basename(file.path, ext) + '-' + hash.substr(0, 8) + ext;

package/gulp-tasks/grab-shared-scripts.js

@@ -0,0 +1,66 @@
+var request = require('request');
+var source = require('vinyl-source-stream');
+var replace = require('gulp-replace');
+var hash = require('gulp-hash');
+var tap = require('gulp-tap');
+var path = require('path');
+
+var modAlyticsFileName = '';
+
+function replaceModalyticsSrcInHead(gulp, gulpPlugins, siteSettings, siteData) {
+	if (siteData.siteData && siteData.siteData.isQuotePage === true || siteData.siteData && siteData.siteData.useRelativePathForResources === true) {
+		return gulp.src(siteSettings.srcFolder + '/shared-components/head/head.html')
+		.pipe(replace(/".*(modalytics).*"/, '"resources/scripts/mod-alytics/' + modAlyticsFileName + '"'))
+		.pipe(gulp.dest(siteSettings.srcFolder + '/shared-components/head'));
+	} else {
+		return gulp.src(siteSettings.srcFolder + '/shared-components/head/head.html')
+		.pipe(replace(/".*(modalytics).*"/, '"/resources/scripts/mod-alytics/' + modAlyticsFileName + '"'))
+		.pipe(gulp.dest(siteSettings.srcFolder + '/shared-components/head'));
+	}
+}
+
+function copyCurrentModalytics(gulp, gulpPlugins, siteSettings, siteData) {
+	return new Promise(resolve => {
+		request(`https://${siteSettings.nodeEnv}/quote/resources/mod-alytics/modalytics.min.js`)
+			.on('response', resp => {
+				if (resp.statusCode !== 200) {
+					throw new Error(`${resp.statusCode} Error while fetching modalytics.min.js`);
+				}
+			})
+			.pipe(source('modalytics.min.js'))
+			.pipe(hash({
+				hashLength: 20,
+				template: 'modalytics-<%= hash %>.min.js'
+			}))
+			.pipe(tap(function(file, t){
+				modAlyticsFileName = path.basename(file.path);
+			}))
+			.pipe(gulp.dest(`${siteSettings.srcFolder}/resources/scripts/mod-alytics`))
+			.on('finish', resolve);
+	})
+	.then(() => {
+		return new Promise(resolve => {
+			request(`https://${siteSettings.nodeEnv}/quote/resources/mod-alytics/modalytics.min.js.map`)
+				.on('response', resp => {
+					if (resp.statusCode !== 200) {
+						throw new Error(`${resp.statusCode} Error while fetching modalytics.min.js.map`);
+					} else {
+						replaceModalyticsSrcInHead(gulp, gulpPlugins, siteSettings, siteData);
+					}
+				})
+				.pipe(source('modalytics.min.js.map'))
+				.pipe(gulp.dest(`${siteSettings.srcFolder}/resources/scripts/mod-alytics`))
+				.on('finish', resolve);
+		});
+	});
+}
+module.exports = function(gulp, gulpPlugins, siteSettings, siteData) {
+	return function() {
+		const { nodeEnv } = siteSettings;
+		if (!nodeEnv) {
+			throw new Error('Missing environment variables. Did you start with gulp instead of npm run...?');
+		}
+
+		return copyCurrentModalytics(gulp, gulpPlugins, siteSettings, siteData);
+	};
+};

package/gulp-tasks/js-lint.js

@@ -14,6 +14,7 @@ module.exports = function(gulp, gulpPlugins, siteSettings) {
 			'gulpfile.babel.js',
 			'gulp-tasks/*.js',
 			'!' + siteSettings.srcFolder + '/' + siteSettings.scriptsSubfolder + '/vendor/**/*.js', // do not lint 3rd party scripts,
+			'!' + siteSettings.srcFolder + '/' + siteSettings.scriptsSubfolder + '/resources/**/*.js', // do not lint copied shared resource scripts,
 			'!' + siteSettings.srcFolder + '/' + siteSettings.scriptsCompiledFolder + '**/*.js' // do not lint compiled scripts
 		])
 			.pipe(gulpPlugins.eslint(siteSettings.jsLint))

package/gulp-tasks/serve.js

@@ -4,11 +4,11 @@ module.exports.src = function(gulp, gulpPlugins, siteSettings, siteData) {
 		var runSequence = require('run-sequence');
 		var sequenceOpts;
 		if (siteData.useTypescript) {
-			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'templates', 'styles', 'compile', 'grab-tooltips-json', 'combine-files', 'grab-images', 'js-lint'];
+			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'grab-shared-scripts', 'templates', 'styles', 'compile', 'grab-tooltips-json', 'combine-files', 'grab-images', 'js-lint'];
 		} else if (siteData.isQSPage) {
-			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'templates', 'styles', 'grab-theme-json', 'grab-tooltips-json', 'combine-files', 'grab-images', 'js-lint'];
+			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'grab-shared-scripts', 'templates', 'styles', 'grab-theme-json', 'grab-tooltips-json', 'combine-files', 'grab-images', 'js-lint'];
 		} else {
-			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'templates', 'styles', 'grab-tooltips-json', 'combine-files', 'grab-images', 'js-lint'];
+			sequenceOpts = ['clean', 'grab-cdn', 'grab-shared-components', 'grab-shared-scripts', 'templates', 'styles', 'grab-tooltips-json', 'combine-files', 'grab-images', 'js-lint'];
 		}
 		runSequence(...sequenceOpts, () => {
 			// Run a BrowserSync server

package/gulp-tasks/tasks.js

@@ -42,7 +42,7 @@ module.exports = function() {
 			}
 		},
 
-		// Grab component scss files from CDN so they can be swapped into build
+		// Grab component files from CDN so they can be swapped into build
 		'grab-shared-components': {
 			subtasks: [],
 			func: function(opts) {
@@ -56,6 +56,20 @@ module.exports = function() {
 			}
 		},
 
+		// Grab shared scripts from CDN so they can swapped into build
+		'grab-shared-scripts': {
+			subtasks: [],
+			func: function(opts) {
+				if ('undefined' === typeof opts.gulpTasksFolderPath) {
+					opts.gulpTasksFolderPath = '.';
+				}
+
+				if (opts.siteData.useCDN) {
+					return require(opts.gulpTasksFolderPath + '/grab-shared-scripts')(opts.gulp, opts.gulpPlugins, opts.gulpSettings, opts.siteData);
+				}
+			}
+		},
+
 		// Link scss files
 		'sass-lint': {
 			subtasks: [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mod-build",
-  "version": "3.6.5",
+  "version": "3.6.7--beta.1",
   "description": "Share components for S3 sites.",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -25,6 +25,7 @@
     "gulp-eslint-threshold": "^0.1.1",
     "gulp-filter": "^5.0.0",
     "gulp-handlebars-file-include": "^1.0.0",
+    "gulp-hash": "^4.2.2",
     "gulp-htmlmin": "^3.0.0",
     "gulp-if": "^2.0.2",
     "gulp-imagemin": "^3.2.0",
@@ -44,6 +45,7 @@
     "gulp-sass-variables": "^1.2.0",
     "gulp-size": "^2.1.0",
     "gulp-sourcemaps": "^2.6.0",
+    "gulp-tap": "^2.0.0",
     "gulp-uglify": "^2.1.2",
     "gulp-useref": "^5.0.0",
     "husky": "^1.3.1",