@fontoxml/fontoxml-development-tools 3.11.0 → 3.12.0

package/src/modules/schema-compiler/src/utilities/cleanup.js

@@ -1,70 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import constants from './constants.js';
-import executeAndLog from './executeAndLog.js';
-
-export default async function cleanup(
-	temporaryDirectoryPath,
-	projectName,
-	res,
-	verbosityLevel
-) {
-	const temporaryDirectoryExists = await fs.exists(temporaryDirectoryPath);
-	if (!temporaryDirectoryExists) {
-		return;
-	}
-
-	const destroySpinner = res.spinner('Removing temporary resources...');
-
-	try {
-		const dockerComposeFileExists = await fs.exists(
-			path.join(temporaryDirectoryPath, 'docker-compose.yml')
-		);
-
-		const errors = [];
-		const tasks = [
-			async () => {
-				if (dockerComposeFileExists && projectName) {
-					await executeAndLog(
-						res,
-						'docker-compose',
-						verbosityLevel === constants.VERBOSITY_LEVEL_DEBUG
-							? [
-									'-p',
-									projectName,
-									'--verbose',
-									'down',
-									'--rmi',
-									'local',
-							  ]
-							: ['-p', projectName, 'down', '--rmi', 'local'],
-						temporaryDirectoryPath,
-						verbosityLevel
-					);
-				}
-			},
-			async () => {
-				await fs.remove(temporaryDirectoryPath);
-			},
-		];
-
-		// Run all cleanup tasks in order. Continue on errors. But collect the errors.
-		for (let i = 0; i < tasks.length; i++) {
-			try {
-				await tasks[i]();
-			} catch (error) {
-				errors.push(error);
-			}
-		}
-
-		// Only throw if a task have failed.
-		if (errors.length > 0) {
-			throw errors[0];
-		}
-	} catch (error) {
-		throw error;
-	} finally {
-		destroySpinner();
-	}
-}

package/src/modules/schema-compiler/src/utilities/constants.js

@@ -1,43 +0,0 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export default {
-	DEFAULT_IMAGE_NAME: 'fonto-schema-compiler',
-	DEFAULT_IMAGE_TAG: 'latest',
-	VERBOSITY_LEVEL_DEBUG: 'debug',
-	VERBOSITY_LEVEL_NORMAL: 'normal',
-	VERBOSITY_LEVEL_VERBOSE: 'verbose',
-	// TODO: Update links to the correct documentation pages.
-	DOCUMENTATION_CONFIGURATION_GUIDE:
-		'https://documentation.fontoxml.com/latest/editor-b4ee7cad8e30',
-	DOCUMENTATION_GETTING_STARTED_GUIDE:
-		'https://documentation.fontoxml.com/latest/editor-b4ee7cad8e30',
-	DOCUMENTATION_EXECUTE_ERROR:
-		'https://documentation.fontoxml.com/latest/editor-b4ee7cad8e30',
-	INSTANCE_BUILD_DIRECTORY_PATH: path.join(
-		__dirname,
-		'..',
-		'..',
-		'instanceBuild'
-	),
-	INSTANCE_DEV_BUILD_DIRECTORY_PATH: path.join(
-		__dirname,
-		'..',
-		'..',
-		'instanceDevBuild'
-	),
-	INSTANCE_TEMPLATE_DIRECTORY_PATH: path.join(
-		__dirname,
-		'..',
-		'..',
-		'instanceTemplate'
-	),
-	MANIFEST_FILENAME: '.fontoxmlSchemaCompilerManifest',
-	REQUIRED_CONFIGURATION: [],
-	TEMPORARY_DIRECTORY_NAME: '.schemaCompilerTmp',
-	TEMPORARY_BUILD_DIRECTORY_NAME: '.schemaCompilerBuildTmp',
-	WHITELIST: ['nlog.config'],
-};

package/src/modules/schema-compiler/src/utilities/copyWhitelistedFiles.js

@@ -1,22 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-export default function copyWhitelistedFiles(
-	whitelistedFiles,
-	sourceDirectory,
-	destinationDirectory
-) {
-	return Promise.all(
-		whitelistedFiles.map((item) => {
-			const itemPath = path.join(sourceDirectory, item);
-			return fs.exists(itemPath).then((exists) => {
-				if (exists) {
-					return fs.copy(
-						itemPath,
-						path.join(destinationDirectory, item)
-					);
-				}
-			});
-		})
-	);
-}

package/src/modules/schema-compiler/src/utilities/executeAndLog.js

@@ -1,63 +0,0 @@
-import cp from 'child_process.js';
-
-import constants from './constants.js';
-
-export default function executeAndLog(
-	res,
-	command,
-	args,
-	currentWorkingDirectoryPath,
-	verbosityLevel,
-	showStdout,
-	processCreatedCallback
-) {
-	return new Promise((resolve, reject) => {
-		const errors = [];
-		const childProcess = cp.spawn(command, args, {
-			cwd: currentWorkingDirectoryPath,
-		});
-		const verbose = verbosityLevel !== constants.VERBOSITY_LEVEL_NORMAL;
-
-		if (processCreatedCallback) {
-			processCreatedCallback(process);
-		}
-
-		childProcess.stdout.on('data', (data) => {
-			if (verbose || showStdout) {
-				res.log(data);
-			}
-		});
-
-		childProcess.stderr.on('data', (data) => {
-			if (verbosityLevel === constants.VERBOSITY_LEVEL_DEBUG) {
-				res.log(data);
-			} else {
-				errors.push(data.toString());
-			}
-		});
-
-		childProcess.on('error', (error) => {
-			res.error(error);
-		});
-
-		childProcess.on('close', (code) => {
-			if (code === 0) {
-				if (verbose) {
-					res.debug(
-						`${command} ${args.join(' ')} exited with code ${code}`
-					);
-				}
-				resolve();
-			} else {
-				if (verbosityLevel !== constants.VERBOSITY_LEVEL_DEBUG) {
-					errors.forEach((error) => res.log(error));
-				}
-				reject(
-					new Error(
-						`${command} ${args.join(' ')} exited with code ${code}`
-					)
-				);
-			}
-		});
-	});
-}

package/src/modules/schema-compiler/src/utilities/getVerbosityLevel.js

@@ -1,11 +0,0 @@
-import constants from './constants.js';
-
-export default function getVerbosityLevel(verbose, debug) {
-	if (debug) {
-		return constants.VERBOSITY_LEVEL_DEBUG;
-	}
-	if (verbose) {
-		return constants.VERBOSITY_LEVEL_VERBOSE;
-	}
-	return constants.VERBOSITY_LEVEL_NORMAL;
-}

package/src/modules/schema-compiler/src/utilities/getWhitelist.js

@@ -1,16 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import constants from './constants.js';
-
-export default function getWhitelist() {
-	return fs
-		.readdir(constants.INSTANCE_TEMPLATE_DIRECTORY_PATH)
-		.then((entries) => {
-			return entries.map((entry) => path.basename(entry));
-		})
-		.then((whitelist) => {
-			whitelist.push(...constants.WHITELIST);
-			return whitelist;
-		});
-}

package/src/modules/schema-compiler/src/utilities/setEntryVisibility.js

@@ -1,22 +0,0 @@
-import fswin from 'fswin';
-
-export default function setEntryVisibility(entryPath, isVisible) {
-	return new Promise((resolve, reject) => {
-		if (fswin) {
-			fswin.setAttributes(
-				entryPath,
-				{ IS_HIDDEN: !isVisible },
-				(success) => {
-					if (!success) {
-						reject();
-						return;
-					}
-					resolve();
-				}
-			);
-			return;
-		}
-
-		resolve();
-	});
-}

package/src/modules/schema-compiler/src/utilities/validateInstance.js

@@ -1,47 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import constants from './constants.js';
-import FontoxmlSchemaCompilerManifest from './FontoxmlSchemaCompilerManifest.js';
-
-export default function validateInstance(directoryPath) {
-	const manifestFilePath = path.join(
-		directoryPath,
-		constants.MANIFEST_FILENAME
-	);
-	return fs
-		.exists(directoryPath)
-		.then((exists) => {
-			if (!exists) {
-				throw new Error(`Directory "${directoryPath}" does not exist.`);
-			}
-		})
-		.then(() => fs.exists(manifestFilePath))
-		.then((exists) => {
-			// Verify fontoxmlSchemaCompilerManifest file is present and valid.
-			if (!exists) {
-				throw new Error(
-					'The Fonto Schema Compiler manifest file does not exist.'
-				);
-			} else {
-				return FontoxmlSchemaCompilerManifest.fromJsonFile(
-					manifestFilePath
-				);
-			}
-		})
-		.then(() => {
-			return Promise.all(
-				constants.REQUIRED_CONFIGURATION.map((entryName) => {
-					return fs
-						.exists(path.join(directoryPath, entryName))
-						.then((exists) => {
-							if (!exists) {
-								throw new Error(
-									`Directory "${directoryPath}" does not contain a valid Fonto Schema Compiler instance. Missing "${entryName}".`
-								);
-							}
-						});
-				})
-			);
-		});
-}

package/src/modules/spell-checker/src/command.build.controller.js

@@ -1,257 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import cleanup from './utilities/cleanup.js';
-import constants from './utilities/constants.js';
-import copyWhitelistedFiles from './utilities/copyWhitelistedFiles.js';
-import executeAndLog from './utilities/executeAndLog.js';
-import FontoxmlSpellCheckerManifest from './utilities/FontoxmlSpellCheckerManifest.js';
-import getVerbosityLevel from './utilities/getVerbosityLevel.js';
-import getWhitelist from './utilities/getWhitelist.js';
-import setEntryVisibility from './utilities/setEntryVisibility.js';
-import validateInstance from './utilities/validateInstance.js';
-
-export default function buildCommand(req, res) {
-	res.caption(req.command.getLongName());
-
-	const directoryPath = path.resolve(
-		req.options.location ? req.options.location : process.cwd()
-	);
-	const temporaryDirectoryPath = path.join(
-		directoryPath,
-		constants.TEMPORARY_BUILD_DIRECTORY_NAME
-	);
-	const imageName = req.options['image-name']
-		? req.options['image-name']
-		: constants.DEFAULT_IMAGE_NAME;
-	const imageTag = req.options['image-tag']
-		? req.options['image-tag']
-		: constants.DEFAULT_IMAGE_TAG;
-	const manifestFilePath = path.join(
-		directoryPath,
-		constants.MANIFEST_FILENAME
-	);
-	const verbosityLevel = getVerbosityLevel(
-		req.options.verbose,
-		req.options.debug
-	);
-
-	let pidToKillOnForceExit = null;
-	const setPidToKillOnForceExit = (process) => {
-		pidToKillOnForceExit = process && process.pid;
-	};
-
-	// Ensure we cleanup before exiting.
-	let stopping = false;
-	process.on('SIGINT', (_code) => {
-		if (stopping) {
-			if (pidToKillOnForceExit) {
-				process.kill(pidToKillOnForceExit);
-			}
-			process.exit();
-			return;
-		}
-
-		stopping = true;
-		res.log('Gracefully stopping... (press Ctrl+C again to force)');
-		return cleanup(
-			temporaryDirectoryPath,
-			undefined,
-			res,
-			verbosityLevel
-		).then(process.exit);
-	});
-
-	return (
-		validateInstance(directoryPath)
-			// Cleanup possible remaining resources from a previous build or run.
-			.then(() =>
-				cleanup(temporaryDirectoryPath, undefined, res, verbosityLevel)
-			)
-			.then(() => {
-				const destroySpinner = res.spinner(
-					`Building the production image "${imageName}:${imageTag}" at "${directoryPath}"...`
-				);
-
-				// Retrieve data for the docker image
-				return FontoxmlSpellCheckerManifest.fromJsonFile(
-					manifestFilePath
-				).then((manifestObj) => {
-					const requestObj = {
-						'spell-checker': {
-							docker: {
-								version: manifestObj.spellCheckerVersion,
-							},
-						},
-					};
-
-					return req.fdt.license
-						.getDataForProducts(requestObj)
-						.catch((error) => {
-							if (error.statusCode === 404) {
-								error.solution =
-									'This error might be caused by requesting a nonexistent Fonto Spell Checker version, please check your version.';
-							}
-							throw error;
-						})
-						.then((productData) => {
-							const dockerData =
-								productData.products['spell-checker'].docker;
-
-							// Create a hidden temporary directory.
-							return (
-								fs
-									.mkdir(temporaryDirectoryPath)
-									.then(() =>
-										setEntryVisibility(
-											temporaryDirectoryPath,
-											false
-										)
-									)
-									// Copy the instance files into the temporary directory.
-									.then(() => {
-										// Rewrite the version in the Dockerfile.
-										return fs
-											.readFile(
-												path.join(
-													constants.INSTANCE_BUILD_DIRECTORY_PATH,
-													'Dockerfile'
-												),
-												'utf8'
-											)
-											.then((dockerContent) =>
-												dockerContent.replace(
-													'${spellCheckerImage}',
-													dockerData.image
-												)
-											)
-											.then((fixedDockerContent) =>
-												fs.writeFile(
-													path.join(
-														temporaryDirectoryPath,
-														'Dockerfile'
-													),
-													fixedDockerContent,
-													'utf8'
-												)
-											);
-									})
-									.then(() => getWhitelist())
-									.then((whitelist) =>
-										copyWhitelistedFiles(
-											whitelist,
-											directoryPath,
-											path.join(
-												temporaryDirectoryPath,
-												'instance'
-											)
-										)
-									)
-
-									// Pull the docker image
-									.then(() => {
-										return executeAndLog(
-											res,
-											'docker',
-											[
-												'login',
-												dockerData.registry,
-												'-u',
-												dockerData.login,
-												'-p',
-												dockerData.password,
-											],
-											null,
-											constants.VERBOSITY_LEVEL_NORMAL,
-											false,
-											setPidToKillOnForceExit
-										)
-											.then(() =>
-												executeAndLog(
-													res,
-													'docker',
-													['pull', dockerData.image],
-													null,
-													verbosityLevel,
-													false,
-													setPidToKillOnForceExit
-												)
-											)
-											.then(() =>
-												executeAndLog(
-													res,
-													'docker',
-													[
-														'logout',
-														dockerData.registry,
-													],
-													null,
-													constants.VERBOSITY_LEVEL_NORMAL,
-													false,
-													setPidToKillOnForceExit
-												)
-											)
-											.catch(() => {
-												throw new Error(
-													'Failed to retrieve the image file.'
-												);
-											});
-									})
-
-									// Build the docker image.
-									.then(() =>
-										executeAndLog(
-											res,
-											'docker',
-											[
-												'build',
-												'-t',
-												`${imageName}:${imageTag}`,
-												'.',
-											],
-											temporaryDirectoryPath,
-											verbosityLevel,
-											false,
-											setPidToKillOnForceExit
-										)
-									)
-									.then(() =>
-										req.fdt.license.sendTelemetry({
-											product: req.command.parent.name,
-											type: 'docker',
-											version:
-												manifestObj.spellCheckerVersion,
-											action: req.command.name,
-										})
-									)
-									.then(() => destroySpinner())
-							);
-						});
-				});
-			})
-			// Cleanup temporary directory.
-			.then(() =>
-				cleanup(temporaryDirectoryPath, undefined, res, verbosityLevel)
-			)
-			.catch((error) => {
-				if (!stopping) {
-					res.notice(
-						`See our documentation at ${constants.DOCUMENTATION_EXECUTE_ERROR} for help.`
-					);
-				}
-
-				return cleanup(
-					temporaryDirectoryPath,
-					undefined,
-					res,
-					verbosityLevel
-				)
-					.then(() => {
-						throw error;
-					})
-					.catch(() => {
-						throw error;
-					});
-			})
-	);
-}

package/src/modules/spell-checker/src/command.build.js

@@ -1,54 +0,0 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-import constants from './utilities/constants.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export default (moduleRegistration, spellCheckerCommand) => {
-	spellCheckerCommand
-		.addCommand(
-			'build',
-			path.resolve(__dirname, 'command.build.controller.js')
-		)
-		.setDescription(
-			'Build a Fonto Spell Checker Docker image for production use. Requires Docker to be installed.'
-		)
-
-		.addOption(
-			'image-name',
-			'n',
-			`The name of the Docker image which will be created. This defaults to ${constants.DEFAULT_IMAGE_NAME}.`,
-			false
-		)
-		.addOption(
-			'image-tag',
-			't',
-			`The tag of the Docker image which will be created. This defaults to ${constants.DEFAULT_IMAGE_TAG}.`,
-			false
-		)
-		.addOption(
-			'location',
-			'l',
-			'The directory where the Fonto Spell Checker instance is located.',
-			false
-		)
-		.addOption(
-			'verbose',
-			null,
-			'Output default stdout and stderr information.'
-		)
-		.addOption('debug', null, 'Output all debug information.')
-
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} spell-checker build`,
-			`Build production image "${constants.DEFAULT_IMAGE_NAME}:${constants.DEFAULT_IMAGE_NAME}" using the Fonto Spell Checker instance located at the current working directory.`
-		)
-		.addExample(
-			`${
-				moduleRegistration.getAppInfo().name
-			} spell-checker build --image-name my-spell-checker-instance --image-tag 1.0.0 --location /opt/my-instance/`,
-			'Build production image "my-spell-checker-instance:1.0.0" using the Fonto Spell Checker instance located at "/opt/my-instance/".'
-		);
-};