Version 2.7.0

GitOrigin-RevId: 03026c59ae6f19f630e597e8c934574255dd832b

Author: Interfaced

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change log
 
+## 2.7.0 (release date: 04.03.2020) 
+
+### Framework
+* `StatefulHtml5Video` now ensures `START_POSITION` is applied before entering `READY`
+* `IStatefulVideo.getEngine` method was added that exposes internal platform-specific engine
+* Disabled widgets no longer receive mouse clicks
+* Fix duplication of mouse listeners on widgets that get changed from one parent to another in some cases
+
+### Tools
+* Fixed several compatibility issues on Windows 
+* Added a warning against node versions not compatible with versions specified in `engines` fields of application and its dependencies.  
+* Parallelized and optimised some filesystem operations
+* Several deprecated APIs were removed, see previous versions for migration guides
+* Google Closure Compiler udpated to `20200224`
+
 ## 2.6.1 (release date: 03.02.2020)
 
 ### Tools

README.md

@@ -24,7 +24,7 @@ npm install zombiebox
 npm install zombiebox-platform-pc zombiebox-extension-cutejs
 ```
 
-Create application `config.js` and start developing or use boilerplate:
+Either create application `config.js` manually and start developing or start with a boilerplate:
 
 ```bash
 npx zombiebox init $NAME

docs/config.md

@@ -59,8 +59,8 @@ Configures CSS files processing and bundling
 | --- | --- | --- |
 | importEntryPoints | Array<string> | CSS @import entry point, if not set imports will not be processed |
 | presetEnv | Object | [postcss-preset-env options](https://github.com/csstools/postcss-preset-env#options) |
-| filePlugins | Array | Any additional plugin instances that will be run against each file. |
-| bundlePlugins | Array | Any additional plugin instances that will be run against resulting CSS bundle. |
+| filePlugins | Array | Any additional plugin instances that will be run against each file. Also run by dev server. |
+| bundlePlugins | Array | Any additional plugin instances that will be run against resulting CSS bundle. Not run by dev server |
 | url | Object | [postcss-url options](https://github.com/postcss/postcss-url#options-combinations) |
 | csso | Object | [CSSO optimizer options](https://github.com/css/csso#compressast-options) |
 

lib/application.js

@@ -150,21 +150,22 @@ class Application extends EventEmitter {
 		let files = this._codeSource.all.getJSFiles();
 
 		for (const entity of this._config.include) {
-			files = files.concat(entity.modules || []);
+			files = files.concat(entity.modules || [])
+				.map((filePath) => this._pathHelper.resolveAbsolutePath(filePath))
+				.filter(
+					(filename) => {
+						const exists = fs.existsSync(filename);
+						if (!exists) {
+							logger.warn(`File ${chalk.underline(filename)} does not exist`);
+						}
+						return exists;
+					}
+				);
 		}
 
-		files = files.map((filePath) => this._pathHelper.resolveAbsolutePath(filePath));
 		logger.silly(`Compiling js files: \n\t${files.join('\n\t')}`);
 
-		return files.filter(
-			(filename) => {
-				const exists = fs.existsSync(filename);
-				if (!exists) {
-					logger.warn(`File ${chalk.underline(filename)} does not exist`);
-				}
-				return exists;
-			}
-		);
+		return files;
 	}
 
 	/**
@@ -194,21 +195,20 @@ class Application extends EventEmitter {
 
 		// Finally anything included as extra entities
 		for (const entity of this._config.include) {
-			files = files.concat(entity.css || []);
+			files = files.concat(entity.css || [])
+				.map((filePath) => this._pathHelper.resolveAbsolutePath(filePath))
+				.filter((filename) => {
+					const exists = fs.existsSync(filename);
+					if (!exists) {
+						logger.warn(`File ${chalk.underline(filename)} does not exist`);
+					}
+					return exists;
+				});
 		}
 
-		files = files.map((filePath) => this._pathHelper.resolveAbsolutePath(filePath));
-
 		logger.silly(`Compiling css files: \n\t${files.join('\n\t')}`);
 
-		return files
-			.filter((filename) => {
-				const exists = fs.existsSync(filename);
-				if (!exists) {
-					logger.warn(`File ${chalk.underline(filename)} does not exist`);
-				}
-				return exists;
-			});
+		return files;
 	}
 
 	/**
@@ -256,8 +256,8 @@ class Application extends EventEmitter {
 	/**
 	 * Compile templates, build base classes, etc.
 	 */
-	buildCode() {
-		this._codeSource.generated.generate();
+	async buildCode() {
+		await this._codeSource.generated.generate();
 	}
 
 	/**
@@ -314,10 +314,10 @@ class Application extends EventEmitter {
 			return null;
 		}
 
-		const [componentName, ...parts] = aliasedPath.split(path.sep);
+		const [componentName, ...parts] = aliasedPath.split('/');
 		const absolutePath = map.get(componentName);
 		if (absolutePath) {
-			return [absolutePath, ...parts].join('/');
+			return path.join(absolutePath, ...parts);
 		}
 		return null;
 	}
@@ -334,174 +334,12 @@ class Application extends EventEmitter {
 
 		for (const [alias, path] of map) {
 			if (fsPath.startsWith(path)) {
-				return alias + fsPath.slice(path.length);
+				return alias + fsPath.slice(path.length).replace(/\\/g, '/');
 			}
 		}
 		return null;
 	}
 
-	/**
-	 * TODO: remove in 2.7.0
-	 * @param {Array<AbstractPlatform>} platforms
-	 * @return {Promise}
-	 */
-	compile(platforms) {
-		logger.warn(`Running deprecated Application.compile(), use Application.build() instead`);
-
-		let resolvePromise = () => {/* Noop */};
-		let rejectPromise = () => {/* Noop */};
-		const deferred = new Promise((resolve, reject) => {
-			resolvePromise = resolve;
-			rejectPromise = reject;
-		});
-
-		const mkPlatformDir = (name) => {
-			const platformDir = this._pathHelper.getDistDir({
-				baseDir: this._config.project.dist,
-				version: this.getAppVersion(),
-				platformName: name
-			});
-
-			if (fs.existsSync(platformDir)) {
-				logger.debug(`Removing old build directory ${chalk.underline(platformDir)}`);
-				fse.removeSync(platformDir);
-			}
-
-			fse.ensureDirSync(platformDir);
-
-			return platformDir;
-		};
-
-		const runExternalScript = (scriptName, buildDir, platformName, platform, callback) => {
-			if (fs.existsSync(scriptName)) {
-				logger.info(`Running hook ${chalk.underline(scriptName)}`);
-				try {
-					// eslint-disable-next-line global-require
-					const externalCallback = require(scriptName);
-					externalCallback(callback, {
-						app: this,
-						buildDir,
-						platformName,
-						platform: platform || null
-					});
-				} catch (e) {
-					logger.error(`Hook error: ${e.toString()}`);
-					logger.debug(e.trace);
-					callback(e);
-				}
-			} else {
-				callback();
-			}
-		};
-
-		this.buildCode();
-
-		/**
-		 * @param {AbstractPlatform} platform
-		 * @param {function(*)} callback
-		 */
-		const buildPlatform = (platform, callback) => {
-			const dir = mkPlatformDir(platform.getName());
-			const args = [dir, platform.getName(), platform];
-
-			logger.info(`Building application for ${chalk.bold(platform.getName())} in ${chalk.underline(dir)}`);
-
-			runExternalScript(this._pathHelper.getPreBuildHook(), ...args, (error) => {
-				if (error) {
-					callback(error);
-
-					return;
-				}
-
-				this._config.appendObject({
-					define: {
-						PLATFORM_NAME: platform.getName()
-					}
-				});
-
-				this._codeSource.generated.generateDefines();
-
-				platform.buildApp(this, dir)
-					.then((warnings) => {
-						if (warnings) {
-							const {report, truncated} = extractCompilationReport(warnings);
-
-							if (truncated) {
-								logger.warn(`Compilation finished with warnings: \n\n${truncated}`);
-							}
-
-							if (report) {
-								logger.info(`Compilation result: ${chalk.bold(report)}`);
-							}
-						}
-
-						runExternalScript(this._pathHelper.getPostBuildHook(), ...args, (error) => callback(error));
-					}, (error) => callback(error));
-			});
-		};
-
-		const buildFirstPlatform = (callback) => {
-			const platform = platforms.shift();
-			if (platform) {
-				buildPlatform(platform, callback);
-			} else {
-				callback();
-			}
-		};
-
-		const buildPlatforms = () => {
-			buildFirstPlatform(function done(error) {
-				if (error) {
-					if (error instanceof Error) {
-						logger.error(error.toString());
-					} else {
-						const {report, truncated} = extractCompilationReport(error);
-
-						if (truncated) {
-							logger.error(`Compilation finished with errors: \n\n${truncated}`);
-						}
-
-						if (report) {
-							logger.info(`Compilation result: ${chalk.bold(report)}`);
-						}
-					}
-
-					logger.error(`Build failed!`);
-
-					rejectPromise(error);
-				} else if (platforms.length === 0) {
-					logger.output(`Build done!`);
-
-					resolvePromise();
-				} else {
-					buildFirstPlatform(done);
-				}
-			});
-		};
-
-		const extractCompilationReport = (text) => {
-			const regex = /\n?\d+ error\(s\), \d+ warning\(s\)(?:, [\d.,]+% typed)?\n?/;
-			const match = text.match(regex);
-
-			let report = '';
-			let truncated = text;
-
-			if (match) {
-				report = match[0].trim();
-				truncated = text.replace(match[0], '');
-			}
-
-			return {
-				report,
-				truncated
-			};
-		};
-
-		buildPlatforms();
-
-		return deferred;
-	}
-
 	/**
 	 * @param {AbstractPlatform} platform
 	 * @return {Promise}
@@ -528,7 +366,7 @@ class Application extends EventEmitter {
 			}
 		});
 
-		this._codeSource.generated.generateDefines();
+		await this._codeSource.generated.generateDefines();
 
 		const [cssCompilationResult, jsCompilationResult] = await Promise.all([
 			buildHelper.getCompressedStyles(distDir),
@@ -548,14 +386,21 @@ class Application extends EventEmitter {
 			logger.debug(jsCompilationResult.stderr);
 			logger.debug(e.stack);
 
-			throw new Error(`Failed to parse GCC output: ${e.message}`);
+			const match = e.message.match(/Unexpected token (?:.+) in JSON at position (?<position>\d+)/);
+			let message = `Failed to parse GCC output: ${e.message}`;
+			if (match && match.groups.position) {
+				message += '\n' + jsCompilationResult.stderr.slice(parseInt(match.groups.position, 10));
+			}
+			throw new Error(message);
 		}
 
 		logger.silly(`GCC compilation report: \n${JSON.stringify(jsCompilationReport, null, '\t')}`);
 		logger.silly(`CSS compilation report: \n${JSON.stringify(cssCompilationReport, null, '\t')}`);
 
-		await fse.writeFile(indexHtmlPath, indexHtmlContent, 'utf8');
-		buildHelper.copyStaticFiles(distDir);
+		await Promise.all([
+			fse.writeFile(indexHtmlPath, indexHtmlContent, 'utf8'),
+			buildHelper.copyStaticFiles(distDir)
+		]);
 
 		cssCompilationReport.forEach((message) => {
 			// TODO: fancier output
@@ -595,18 +440,7 @@ class Application extends EventEmitter {
 		}
 
 		logger.verbose(`Packaging application`);
-		try {
-			await platform.pack(this, distDir);
-		} catch (error) {
-			// TODO: Remove catch block in 2.7.0
-			logger.error(error.toString());
-			logger.debug(error.stack);
-			logger.info(`Is the platform up to date? Trying legacy building approach`);
-
-			await fse.emptyDir(distDir);
-			const warnings = await platform.buildApp(this, distDir);
-			logger.warn(warnings);
-		}
+		await platform.pack(this, distDir);
 
 		await this._runBuildHook(this._pathHelper.getPostBuildHook(), platform);
 	}
@@ -684,8 +518,10 @@ class Application extends EventEmitter {
 
 		let platformFilter = () => true;
 		if (platform) {
-			const otherPlatforms = this.getPlatforms().filter((otherPlatform) => otherPlatform !== platform);
-			const otherIncludes = otherPlatforms.flatMap((otherPlatform) => otherPlatform.getConfig().include || []);
+			const otherIncludes = this.getPlatforms()
+				.filter((otherPlatform) => otherPlatform !== platform)
+				.map((otherPlatform) => otherPlatform.getConfig().include || [])
+				.reduce((all, other) => all.concat(other), []);
 
 			platformFilter = (entity) => {
 				const shouldExclude = otherIncludes.some((otherEntity) => otherEntity.name === entity.name);
@@ -790,7 +626,7 @@ class Application extends EventEmitter {
 				try {
 					this._addonLoader.loadAddon(pathOrAddon);
 				} catch (e) {
-					logger.debug(e.trace);
+					logger.debug(e.stack);
 					throw new Error(`Can't load addon at "${pathOrAddon}": ${e.toString()}`);
 				}
 			} else if (type === 'object') {
@@ -863,10 +699,9 @@ class Application extends EventEmitter {
 	 */
 	_checkVersions() {
 		logger.verbose(`Cross-checking ZombieBox packages dependencies`);
-		const dependencies = this.getAppPackageJson().dependencies || {};
-		const packages = [this.getZbPackageJson(), ...this._addonLoader.getPackageJsons()];
+		const packages = [this.getAppPackageJson(), this.getZbPackageJson(), ...this._addonLoader.getPackageJsons()];
 
-		const checker = new VersionsChecker(dependencies, packages);
+		const checker = new VersionsChecker(this.getAppPackageJson(), packages);
 		const {warns, errors} = checker.check();
 
 		warns.forEach((message) => logger.warn(message));