mod-build 3.7.1 → 3.7.3

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.7.3
+
+- Added `grab-section-deals-components` and `grab-mhsadmin-data` tasks for section deals pages.
+
 ## 3.7.1
 
 - updated clean task.

package/gulp-tasks/grab-mhsadmin-data.js

@@ -0,0 +1,417 @@
+/* globals Promise */
+/* eslint-disable space-before-function-paren */
+const request = require('request');
+const fs = require('fs');
+
+module.exports = function(gulp, gulpPlugins, siteSettings, siteData) {
+	const lastModDateOptions = { year: 'numeric', month: '2-digit', day: '2-digit' };
+	const tradeLookUp = [];
+	const dateLocalString = 'en-US';
+	const showCostCalFor = ['windows', 'hvac'];
+	const perPageArticlesLimit = 100;
+	const articles = [];
+	let articleConfigsCount = 0, templatesCount = 0, cachedContractors = {};
+
+	const log = {
+		success: function(icon = '\u{23F3}', message = '') {
+			console.log(gulpPlugins.colors.bright, gulpPlugins.colors.fg.green, icon, ' ', message, gulpPlugins.colors.reset);
+		},
+		info: function(message = '') {
+			console.log(message);
+		},
+		error: function(message, throwError = true) {
+			console.log(gulpPlugins.colors.bg.red, gulpPlugins.colors.bright, message, gulpPlugins.colors.reset);
+			if (throwError) {
+				throw new Error(message);
+			}
+		}
+	};
+
+	function formatDate(date) {
+		const d = new Date(date);
+		const year = d.getFullYear();
+		const month = String(d.getMonth() + 1).padStart(2, '0');
+		const day = String(d.getDate()).padStart(2, '0');
+		return [year, month, day].join('-');
+	}
+
+	async function processAndSortContractorList(list, ratingPropertyName = 'reviewScore', minRating = null) {
+		list = list.sort(function(a, b) {
+			if (a[ratingPropertyName] === null && b[ratingPropertyName] === null) {
+				return a.displayName.localeCompare(b.displayName);
+			}
+			return b[ratingPropertyName] - a[ratingPropertyName];
+		});
+
+		if (minRating) {
+			list = await list.filter(data => !data[ratingPropertyName] || data[ratingPropertyName] >= minRating);
+		}
+
+		list = await list.map(function(data, i) {
+			if (data) {
+				data.index = i;
+			}
+			return data;
+		});
+
+		return list;
+	}
+
+	// helper function to create nested object dynamically
+	function assign(obj, keyPath, value) {
+		const lastKeyIndex = keyPath.length - 1;
+		for (var i = 0; i < lastKeyIndex; ++i) {
+			const key = keyPath[i];
+			if (!(key in obj)) {
+				obj[key] = {};
+			}
+			obj = obj[key];
+		}
+		obj[keyPath[lastKeyIndex]] = value;
+	}
+
+	const sortArticlesByDate = function(articlesList) {
+		if (articlesList.length) {
+			articlesList.sort(function(a, b) {
+				return new Date(b.data.published) - new Date(a.data.published);
+			});
+		}
+	};
+
+	// MARK: configureGlobalVariables
+	const configureGlobalVariables = function(siteData, siteSettings) {
+		return new Promise(resolve => {
+			const DOMAIN = `https://${siteSettings.nodeEnv === 'qa.modernize.com' ? 'qa' : ''}mhsadmin.wpenginepowered.com`;
+			const WP_ENDPOINT_BASE_URL = `${DOMAIN}/wp-json/wp/v2`;
+			siteSettings.endpoints = {};
+			siteSettings.endpoints.GET_DETAILED_ARTICLES = `${WP_ENDPOINT_BASE_URL}/article?_fields=data,meta,slug&per_page=${perPageArticlesLimit}&site=${siteData.siteName}`;
+			siteSettings.endpoints.GET_CONTRACTORS = `${WP_ENDPOINT_BASE_URL}/contractor`;
+			siteSettings.endpoints.GET_SITE_DETAILS = `${WP_ENDPOINT_BASE_URL}/site?_fields=data,slug,&site=${siteData.siteName}`;
+
+			siteData.sitemap = [];
+			siteData.page.articlesConfig = {
+				siteDetails: {},
+				articlesWithContractors: {},
+				tradeHubPagesArticlesList: {},
+				homePageArticlesList: {
+					featured: [],
+					top: [],
+					recent: []
+				}
+			};
+			resolve();
+		});
+	};
+
+	// MARK: getArticlesList
+	const getSiteDetails = async (siteData, siteSettings) => {
+		return await new Promise((resolve) => {
+			if (!siteData.page) {
+				log.error('page is not defined in siteData!');
+			}
+			const { page, sitemap } = siteData;
+			const { articlesConfig } = page;
+			const { siteDetails } = articlesConfig;
+			return request(siteSettings.endpoints.GET_SITE_DETAILS, async function(_xhr, response, body) {
+				if (response.statusCode === 200) {
+					let result = await JSON.parse(body);
+					if (result.length) {
+						result = result.filter((data) => data.slug === siteData.siteName);
+					}
+					await Object.assign(siteDetails, result[0]);
+					siteDetails.vertical = await siteDetails?.data?.homepage?.hero?.heading;
+					siteDetails.costCalculatorTheme = siteData.costCalculatorTheme ? siteData.costCalculatorTheme : siteDetails?.slug;
+					siteDetails.domain = await siteDetails?.data?.domain?.replace(/\/*?$/, '');
+					siteDetails.homepage = await siteDetails?.data?.homepage?.slug;
+					siteDetails.canonicalURL = await `${siteDetails?.domain}/${siteDetails?.homepage}/`;
+					if (siteDetails.data.favicon && Object.keys(siteDetails.data.favicon).length) {
+						page.headConfig.faviconPath = siteDetails.data.favicon.url ? siteDetails.data.favicon.url : page.headConfig.faviconPath;
+					}
+
+					sitemap.push(
+						{
+							link: `${siteDetails.domain}/${siteDetails.homepage}/`,
+							lastMod: formatDate(new Date().toLocaleDateString(dateLocalString, lastModDateOptions))
+						}
+					);
+					resolve();
+				} else {
+					log.error('GET_SITE_DETAILS - Something went wrong!');
+				}
+			});
+		});
+	};
+
+	// MARK: getDetailedArticles
+	const getDetailedArticles = async (siteSettings, page = 1) => {
+		return await new Promise((resolve) => {
+			log.info(`Fetching articles from page ${page?.toString()?.padStart(2, '0')}: ${siteSettings.endpoints.GET_DETAILED_ARTICLES}&page=${page}`);
+			return request(`${siteSettings.endpoints.GET_DETAILED_ARTICLES}&page=${page}`, async function(_xhr, response, body) {
+				if (response.statusCode === 200) {
+					const wpArticleTotalPages = await parseInt(response.headers['x-wp-totalpages']);
+					await articles.push(...JSON.parse(body));
+					if (page < wpArticleTotalPages) {
+						// recursive call to get the articles from next pages
+						await getDetailedArticles(siteSettings, page + 1);
+					} else {
+						log.success('\u{2705}', `Finished Fetching article(s) from ${wpArticleTotalPages} page(s)`);
+					}
+				} else {
+					log.error('GET_DETAILED_ARTICLES - Something went wrong!');
+				}
+				resolve();
+			});
+		});
+	};
+
+	// MARK: getContractors
+	const getContractors = async (trade, siteSettings) => {
+		if (!trade) {
+			return;
+		}
+		return await new Promise((resolve) => {
+			if (Object.keys(cachedContractors).length && cachedContractors[trade]) {
+				resolve(cachedContractors[trade]);
+				return;
+			} else {
+				return request(`${siteSettings.endpoints.GET_CONTRACTORS}?trade=${trade}`, async function(_xhr, response, body) {
+					if (response.statusCode === 200) {
+						const result = await JSON.parse(body);
+						cachedContractors = await { ...cachedContractors, [trade]: result };
+						resolve(result);
+					} else {
+						log.error('GET_CONTRACTORS - Something went wrong!', false);
+						resolve([]);
+					}
+				});
+			}
+		});
+	};
+
+	const getZipCardMarkup = async function(trade, gulpPlugins) {
+		let zipCard = null;
+
+		const _insertTrade = function(htmlString) {
+			const markup = gulpPlugins.htmlParser.parse(htmlString);
+			markup.querySelector('.btn--zip').setAttribute('data-service', trade.slug);
+			markup.querySelector('.trade').textContent = trade.displayName;
+			return markup;
+		};
+
+		return new Promise((resolve) => {
+			if (zipCard) {
+				zipCard = _insertTrade(zipCard);
+				return resolve(zipCard);
+			}
+			fs.readFile('./src/shared-components/section-deals/_partials/page-card-zip.html', 'utf-8', function(err, data) {
+				if (err) {
+					log.error('page-card-zip.html not found at "/src/shared-components/section-deals/_partials/page-card-zip.html" ');
+				}
+				zipCard = data;
+				zipCard = _insertTrade(zipCard);
+				resolve(zipCard);
+			});
+		});
+	};
+
+	// MARK: buildTemplates
+	async function buildTemplates(siteData, siteSettings, done) {
+		const { srcFolder, templatesSubfolder } = siteSettings;
+		const { page } = await siteData;
+		const { articlesConfig } = page;
+		const { articlesWithContractors, siteDetails } = articlesConfig;
+		const templatesPath = `${srcFolder}/${templatesSubfolder}/`;
+		return await new Promise(function(resolve) {
+			if (articlesWithContractors && Object.keys(articlesWithContractors).length) {
+				log.success('\u{23F3}', 'Building Article(s)...');
+				Object.entries(articlesWithContractors).forEach(async function([trade, articlesList]) {
+					Object.entries(articlesList).forEach(function([pageName, articleData]) {
+						let costCalculatorTrade = trade;
+						costCalculatorTrade = costCalculatorTrade.toLowerCase() === 'gutters' ? 'gutter' : costCalculatorTrade;
+						const tradeHubFileContent = `{{#page.articlesConfig.tradeHubPagesArticlesList.${trade}}}
+					{{fileInclude 'src/shared-components/section-deals/components/trade-hub-template.html'
+						tradeHubPageArticles = this
+						trade = '${articleData.data.trade.title}'
+						costCalculatorTrade = '${costCalculatorTrade}'
+						showCostCalculator = ${showCostCalFor.includes(trade)}
+					}}{{/page.articlesConfig.tradeHubPagesArticlesList.${trade}}}
+					<script>
+						window.siteData.trade='${trade}';
+					</script>`;
+
+						const fileName = articleData.slug;
+						const fileContent = `{{#page.articlesConfig.articlesWithContractors.${trade}.${pageName}}}
+					{{fileInclude 'src/shared-components/section-deals/components/article-template.html'
+						article = this
+						trade = '${trade}'
+					}}{{/page.articlesConfig.articlesWithContractors.${trade}.${pageName}}}`;
+						// make the directory by trade name
+						fs.mkdir(`${templatesPath}/${siteDetails.homepage}/${trade}/`, { recursive: true }, async function(error) {
+							if (error) {
+								throw error;
+							}
+							fs.writeFile(`${templatesPath}/${siteDetails.homepage}/${trade}/index.html`, tradeHubFileContent, function(err) {
+								if (err) {
+									throw err;
+								}
+								fs.writeFile(`${templatesPath}/${siteDetails.homepage}/${trade}/${fileName}.html`, fileContent, function($err) {
+									if ($err) {
+										throw $err;
+									}
+									templatesCount++;
+									log.info(`Article template ${templatesCount?.toString()?.padStart(2, '0')}: ${templatesPath}${trade}/${siteDetails.homepage}/${fileName}.html`);
+									if (articleConfigsCount === templatesCount) {
+										siteData.page.lastMod = formatDate(new Date().toLocaleDateString(dateLocalString, lastModDateOptions));
+										done();
+										log.success('\u{2705}', `Finished Building ${templatesCount} Article(s).`);
+									}
+								});
+							});
+						});
+					});
+				});
+			}
+			resolve();
+		});
+	}
+
+	// MARK: configureArticlesAndBuildTemplates
+	async function configureArticlesAndBuildTemplates(siteData, siteSettings, gulpPlugins) {
+		return await new Promise(function(done) {
+			if (!siteData.page) {
+				log.error('"page" is not defined in siteData!');
+			}
+
+			if (articles.length === 0) {
+				log.error('Articles not found!');
+			}
+
+			const { page } = siteData;
+			const { articlesConfig } = page;
+			const { homePageArticlesList, articlesWithContractors, tradeHubPagesArticlesList, siteDetails } = articlesConfig;
+
+			articles.forEach(async (article) => {
+				const templateData = article;
+				const articlesWithContractorsKey = article.slug.replaceAll(/[-|\s]/ig, '_');
+				const trade = article.data.trade.slug.toLowerCase().replaceAll(/[-|\s]/ig, '_');
+				const contractors = await getContractors(article.data.trade.slug, siteSettings);
+				const tradeDisplayName = article?.data?.trade?.title?.toLowerCase();
+				// Append contractors
+				if (contractors && contractors.length) {
+					templateData.contractors = await processAndSortContractorList(contractors, 'reviewScore');
+				}
+				const articleLink = await `${siteDetails?.homepage}/${article.data.trade.slug}/${article.slug}.html`;
+				const tradeHubLink = await `${siteDetails?.homepage}/${article.data.trade.slug}/`;
+				const categoryPageLink = await `${siteDetails?.homepage}/`;
+				templateData.data.redirectLink = await `/${articleLink}`;
+				templateData.data.tradeHubPageLink = await `/${tradeHubLink}`;
+				templateData.data.categoryPageLink = await `/${categoryPageLink}`;
+				templateData.meta.canonicalURL = await `${siteDetails?.domain}/${articleLink}`;
+				templateData.data.loc = await `${siteDetails?.domain}/${articleLink}`;
+				templateData.data.lastMod = await formatDate(new Date(article.data.published).toLocaleDateString(dateLocalString, lastModDateOptions));
+				templateData.data.vertical = siteDetails.vertical;
+				templateData.data.trade.displayName = tradeDisplayName === 'hvac' ? 'heating and cooling' : tradeDisplayName;
+
+				const lastMod = formatDate(new Date(templateData.data.published).toLocaleDateString(dateLocalString, lastModDateOptions));
+
+				if (!tradeLookUp.includes(article.data.trade.slug)) {
+					tradeLookUp.push(article.data.trade.slug);
+					siteData.sitemap.push(
+						{
+							link: `${siteDetails.domain}/${tradeHubLink}`,
+							lastMod
+						}
+					);
+				}
+
+				siteData.sitemap.push(
+					{
+						link: `${siteDetails.domain}/${articleLink}`,
+						lastMod
+					}
+				);
+
+				templateData.data.sponsoredContent = siteDetails.data.sponsoredContent.article;
+
+				const zipCard = await getZipCardMarkup(templateData.data.trade, gulpPlugins);
+				const htmlContent = gulpPlugins.htmlParser.parse(templateData.data.content);
+				const contentHeadings = htmlContent.querySelectorAll('h2[id]');
+				if (zipCard) {
+					// find the middle section index and add flag isMiddleSection
+					const middleSectionIndex = Math.floor((contentHeadings.length) / 2);
+					htmlContent.querySelectorAll('h2[id]')[middleSectionIndex].insertAdjacentHTML('beforebegin', zipCard);
+				}
+				templateData.data.content = htmlContent;
+
+				await assign(articlesWithContractors, [trade, articlesWithContractorsKey], templateData);
+
+				await articleConfigsCount++;
+
+				if (articleConfigsCount === articles.length) {
+					if (Object.keys(articlesWithContractors).length) {
+						Object.entries(articlesWithContractors).forEach(async function([tradeName, values]) {
+							await sortArticlesByDate(Object.values(values));
+							if (!tradeHubPagesArticlesList[tradeName]) {
+								tradeHubPagesArticlesList[tradeName] = {};
+							}
+
+							if (!tradeHubPagesArticlesList[tradeName].featured) {
+								tradeHubPagesArticlesList[tradeName].featured = [];
+							}
+
+							if (!tradeHubPagesArticlesList[tradeName].top) {
+								tradeHubPagesArticlesList[tradeName].top = [];
+							}
+
+							if (!tradeHubPagesArticlesList[tradeName].recent) {
+								tradeHubPagesArticlesList[tradeName].recent = [];
+							}
+
+							if (!tradeHubPagesArticlesList[tradeName].canonicalURL) {
+								tradeHubPagesArticlesList[tradeName].canonicalURL = `${siteDetails?.domain}/${tradeName}/`;
+							}
+
+							tradeHubPagesArticlesList[tradeName].page = await siteDetails?.data?.trades?.filter((data) => data.slug === tradeName)[0];
+
+							Object.entries(values).forEach(function([, data], i) {
+								if (i === 0) {
+									tradeHubPagesArticlesList[tradeName].featured.push(data.data);
+								}
+
+								if (showCostCalFor.includes(tradeName)) {
+									if (i >= 1) {
+										tradeHubPagesArticlesList[tradeName].recent.push(data.data);
+										tradeHubPagesArticlesList[tradeName].recentCount = tradeHubPagesArticlesList[tradeName].recent.length;
+									}
+								} else {
+									if (i > 0 && i < 3) {
+										tradeHubPagesArticlesList[tradeName].top.push(data.data);
+										tradeHubPagesArticlesList[tradeName].topCount = tradeHubPagesArticlesList[tradeName].top.length;
+									} else if (i >= 3) {
+										tradeHubPagesArticlesList[tradeName].recent.push(data.data);
+										tradeHubPagesArticlesList[tradeName].recentCount = tradeHubPagesArticlesList[tradeName].recent.length;
+									}
+								}
+
+								if (homePageArticlesList.featured.length === 0 && data.data.isFeatured) {
+									homePageArticlesList.featured.push(data.data);
+								} else if (homePageArticlesList.top.length < 2 && !data.data.isFeatured && data.data.isTopArticle) {
+									homePageArticlesList.top.push(data.data);
+								} else if (!data.data.isTopArticle && !data.data.isFeatured) {
+									homePageArticlesList.recent.push(data.data);
+								}
+							});
+						});
+					}
+					await buildTemplates(siteData, siteSettings, done);
+				}
+			});
+		});
+	}
+	return async function() {
+		await configureGlobalVariables(siteData, siteSettings);
+		await getSiteDetails(siteData, siteSettings);
+		await getDetailedArticles(siteSettings);
+		return await configureArticlesAndBuildTemplates(siteData, siteSettings, gulpPlugins);
+	};
+};

package/gulp-tasks/grab-section-deals-components.js

@@ -0,0 +1,47 @@
+/* globals Promise */
+var request = require('request');
+var source = require('vinyl-source-stream');
+
+function streamSharedCompsToDestination(gulp, siteSettings, folder, fileName) {
+	return new Promise(resolve => {
+		request(`https://${siteSettings.nodeEnv}/quote/resources/mod-site/shared-components/${folder}/${fileName}`)
+			.on('response', resp => {
+				if (resp.statusCode !== 200) {
+					throw new Error(`${resp.statusCode} Error while fetching ${fileName}`);
+				}
+			})
+			.pipe(source(fileName))
+			.pipe(gulp.dest(`${siteSettings.srcFolder}/shared-components/${folder}/`))
+			.on('finish', resolve);
+	});
+}
+
+function getListOfSharedComponents(gulp, gulpPlugins, siteSettings, componentFolders) {
+	return componentFolders.map(folder => {
+		return new Promise(resolve => {
+			request(`https://${siteSettings.nodeEnv}/quote/resources/mod-site/shared-components/${folder}/all.json`, function(err, resp, body) {
+				if (resp.statusCode !== 200) {
+					throw new Error(`${resp.statusCode}: Error while fetching ${folder}/all.json`);
+				}
+				var listOfComponents = JSON.parse(body);
+				const componentPromises = listOfComponents.map(function(resource) {
+					return streamSharedCompsToDestination(gulp, siteSettings, folder, `${resource}`);
+				});
+				resolve(Promise.all(componentPromises));
+			});
+		});
+	});
+}
+
+module.exports = function(gulp, gulpPlugins, siteSettings) {
+	return function() {
+		const { nodeEnv } = siteSettings;
+		if (!nodeEnv) {
+			throw new Error('Missing environment variables. Did you start with gulp instead of npm run...?');
+		}
+
+		const componentFolders = ['section-deals'];
+
+		return getListOfSharedComponents(gulp, gulpPlugins, siteSettings, componentFolders);
+	};
+};

package/gulp-tasks/tasks.js

@@ -40,7 +40,7 @@ module.exports = function() {
 					return require(opts.gulpTasksFolderPath + '/grab-cdn')(opts.gulp, opts.gulpPlugins, opts.gulpSettings, opts.siteData);
 				}
 			}
-    },
+		},
 
 		// Grab form helpers files from CDN
 		'grab-form-helpers': {
@@ -356,7 +356,7 @@ module.exports = function() {
 
 				return require(opts.gulpTasksFolderPath + '/grab-images')(opts.gulp, opts.gulpSettings, opts.siteData);
 			}
-    	},
+		},
 
 		// Get global images
 		'grab-global-images': {
@@ -430,7 +430,7 @@ module.exports = function() {
 
 				return require(opts.gulpTasksFolderPath + '/grab-tooltips-json')(opts.gulp, opts.gulpPlugins, opts.gulpSettings, opts.siteData);
 			}
-    	},
+		},
 
 		// copy resources directory into dist
 		'copy-resources-to-dist': {
@@ -488,6 +488,28 @@ module.exports = function() {
 
 				return require('./copy-xml-files-to-dist')(opts.gulp, opts.gulpSettings);
 			}
+		},
+
+		'grab-section-deals-components': {
+			subtasks: [],
+			func: function(opts) {
+				if ('undefined' === typeof opts.gulpTasksFolderPath) {
+					opts.gulpTasksFolderPath = '.';
+				}
+
+				return require('./grab-section-deals-components')(opts.gulp, opts.gulpPlugins, opts.gulpSettings, opts.siteData);
+			}
+		},
+
+		'grab-mhsadmin-data': {
+			subtasks: [],
+			func: function(opts) {
+				if ('undefined' === typeof opts.gulpTasksFolderPath) {
+					opts.gulpTasksFolderPath = '.';
+				}
+
+				return require('./grab-mhsadmin-data')(opts.gulp, opts.gulpPlugins, opts.gulpSettings, opts.siteData);
+			}
 		}
 	};
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mod-build",
-	"version": "3.7.1",
+	"version": "3.7.3",
 	"description": "Share components for S3 sites.",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",