Add validation of CDN URL

Author: bdukes

gulpfile.js

@@ -6,13 +6,16 @@ const chalk = require('chalk');
 const del = require('del');
 const ejs = require('gulp-ejs');
 const zip = require('gulp-zip');
+const path = require('path');
+const globby = require('globby');
 const mergeStream = require('merge-stream');
 const {
 	formatVersionFolder,
 	compareStrings,
 	formatPackageUpgrades,
 	getLibraries,
 	getUpgradeVersions,
+	validatePackage,
 } = require('./utility');
 
 const libraries = getLibraries();
@@ -66,9 +69,33 @@ function makePackageTask(library) {
 	return packageFn;
 }
 
+/**
+ * A Gulp task which validates the packages
+ *
+ * @returns {Promise} A Promise which resolves when done
+ */
+async function validatePackages() {
+	let invalidCount = 0;
+	const zipFiles = await globby('./_InstallPackages/**/*.zip');
+	for (const zipFile of zipFiles) {
+		const fileName = path.basename(zipFile);
+		const validationResult = await validatePackage(zipFile);
+		if (validationResult.length > 0) {
+			invalidCount++;
+			log.error(`${fileName} was invalid:`);
+			validationResult.forEach(msg => log.error(msg));
+		}
+	}
+
+	if (invalidCount > 0) {
+		throw new Error(`${invalidCount} invalid package(s)`);
+	}
+}
+
 const defaultTask = gulp.series(
 	clean,
-	gulp.parallel(...libraries.map(makePackageTask))
+	gulp.parallel(...libraries.map(makePackageTask)),
+	validatePackages
 );
 
 /**

package.json

@@ -81,18 +81,22 @@
     "chalk": "^2.4.2",
     "cliui": "5.0.0",
     "cross-spawn": "6.0.5",
+    "decompress": "4.2.0",
     "del": "5.1.0",
     "end-of-stream": "1.4.1",
     "fancy-log": "1.3.3",
     "glob": "^7.1.3",
-    "globby": "^10.0.1",
+    "globby": "10.0.1",
+    "got": "9.6.0",
     "gulp": "^4.0.0",
     "gulp-ejs": "^4.1.1",
     "gulp-zip": "^5.0.0",
     "lodash": "4.17.14",
     "merge-stream": "^2.0.0",
     "package-json": "^6.0.0",
     "semver": "6.2.0",
+    "xmldom": "0.1.27",
+    "xpath.js": "1.1.0",
     "yeoman-generator": "^4.0.1",
     "yo": "^3.1.0"
   }

utility/index.js

@@ -3,6 +3,7 @@
 const { padStart } = require('lodash');
 const { formatPackageUpgrades } = require('./ui');
 const { getLibraries, getUpgradeVersions } = require('./packages');
+const { validatePackage } = require('./validate');
 
 /**
  * Format a version number in the format used by DNN JS library folders
@@ -46,4 +47,5 @@ module.exports = {
 	formatPackageUpgrades,
 	getLibraries,
 	getUpgradeVersions,
+	validatePackage,
 };

utility/validate.js

@@ -0,0 +1,58 @@
+'use strict';
+
+const path = require('path');
+const decompress = require('decompress');
+const select = require('xpath.js');
+const { DOMParser } = require('xmldom');
+const got = require('got');
+
+/**
+ * Validates a package
+ *
+ * @param {String} file - Path to a zip package file
+ * @returns {Promise<String[]>} Resolves to a list of error messages
+ */
+async function validatePackage(file) {
+	const validationMessages = [];
+	try {
+		const files = await decompress(file);
+		const manifestFiles = files.filter(
+			file => path.extname(file.path) === '.dnn'
+		);
+		if (manifestFiles.length > 1) {
+			return ['Too many .dnn manifest files'];
+		} else if (manifestFiles.length === 0) {
+			return ['Missing .dnn manifest file'];
+		}
+
+		const manifestFile = manifestFiles[0];
+		const manifestContents = manifestFile.data.toString('utf-8');
+		const parser = new DOMParser();
+
+		const doc = parser.parseFromString(manifestContents);
+		const cdnPathNodes = select(
+			doc,
+			'/dotnetnuke/packages/package/components/component/javaScriptLibrary/CDNPath/text()'
+		);
+		const cdnResponses = cdnPathNodes
+			.map(({ data }) => data)
+			.filter(data => Boolean(data))
+			.map(url => got.head(url));
+		for (const response of cdnResponses) {
+			try {
+				await response;
+			} catch (e) {
+				validationMessages.push('Error checking CDN URL: ' + e);
+			}
+		}
+
+		return validationMessages;
+	} catch (e) {
+		validationMessages.push('Unexpected error: ' + e);
+		return validationMessages;
+	}
+}
+
+module.exports = {
+	validatePackage,
+};