mod-build 3.6.3 → 3.6.4--beta.10

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.6.5
+
+- 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.3
 
 - Updating `cache-bust` gulp task to use dashes instead of a period. For example, cached files will now be `home-51fbcbac.js` instead of `home.51fbcbac.js`

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,68 @@
+var request = require('request');
+var source = require('vinyl-source-stream');
+var replace = require('gulp-replace');
+
+function replaceModalyticsSrcInHead(gulp, gulpPlugins, siteSettings, siteData, result) {
+	if (siteData.siteData && siteData.siteData.isQuotePage === true) {
+		return gulp.src(siteSettings.srcFolder + '/shared-components/head/head.html')
+		.pipe(replace(/".*(modalytics).*"/, `"resources/scripts/mod-alytics/${result}"`))
+		.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/${result}"`))
+		.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/mod-alytics-version.txt`, function(err, resp, body) {
+			if (resp.statusCode !== 200) {
+				throw new Error(`${resp.statusCode}: Error while fetching mod-alytics-version.txt`);
+			}
+			resolve(body.replace(/\s+/g, ''));
+		})
+
+	})
+	.then((result) => {
+		// copy over main file
+		return new Promise(resolve => {
+			request(`https://${siteSettings.nodeEnv}/quote/resources/mod-alytics/${result}`)
+				.on('response', resp => {
+					if (resp.statusCode !== 200) {
+						throw new Error(`${resp.statusCode} Error while fetching ${result}`);
+					} else {
+						replaceModalyticsSrcInHead(gulp, gulpPlugins, siteSettings, siteData, result);
+					}
+				})
+				.pipe(source(result))
+				.pipe(gulp.dest(`${siteSettings.srcFolder}/resources/scripts/mod-alytics`))
+				resolve(result)
+		});
+	})
+	.then((result) => {
+		// copy over source map
+		return new Promise(resolve => {
+			request(`https://${siteSettings.nodeEnv}/quote/resources/mod-alytics/${result}.map`)
+				.on('response', resp => {
+					if (resp.statusCode !== 200) {
+						throw new Error(`${resp.statusCode} Error while fetching ${result}`);
+					}
+				})
+				.pipe(source(`${result}.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.3",
+  "version": "3.6.4--beta.10",
   "description": "Share components for S3 sites.",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/src/templates/_partials/scripts/analytics.html

@@ -1,12 +1,15 @@
 <script>
   {{ fileInclude 'node_modules/mod-build/src/scripts/has-qs-params.js' }}
   {{ fileInclude 'node_modules/mod-build/src/scripts/url-cleaner.js' }}
-  {{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-tracking.js' }}
-  if(window.Modalytics) {
-    Modalytics.init();
-  } else {
-    {{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-addeventproperties-identify.js' }}
-  }
+  {{#unless noheap}}
+    {{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-tracking.js' }}
+    if(window.Modalytics) {
+      Modalytics.init();
+    } else {
+      {{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-addeventproperties-identify.js' }}
+    }
+  {{/unless}}
+
   {{#unless nogtm}}
     {{ fileInclude 'node_modules/mod-build/src/scripts/vendor/google-tag-manager-head.js' }}
   {{/unless}}

package/src/templates/_partials/scripts/vwo-redirect-callback.html

@@ -30,13 +30,18 @@
 			if (!window.willRedirectionOccurByVWO) {
 				clearTimeout(hardLimitTimer);
 				try {
-					{{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-tracking.js' }}
-					{{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-vwo.js' }}
-					if(window.Modalytics) {
-						Modalytics.init();
-					} else {
-						{{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-addeventproperties-identify.js' }}
-					}
+					// flag to call Modalytics.initHeapVwo() method in site level js
+					window.initHeapVwo = true;
+
+					{{#unless noheap}}
+						{{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-tracking.js' }}
+						{{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-vwo.js' }}
+						if(window.Modalytics) {
+							Modalytics.init();
+						} else {
+							{{ fileInclude 'node_modules/mod-build/src/scripts/vendor/heap-addeventproperties-identify.js' }}
+						}
+					{{/unless}}
 					{{#unless nogtm}}
 						{{ fileInclude 'node_modules/mod-build/src/scripts/vendor/google-tag-manager-head.js' }}
 					{{/unless}}