@fontoxml/fontoxml-development-tools 3.11.0 → 3.12.0

package/src/modules/content-quality/src/command.download-self-contained.js

@@ -1,52 +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, fcqCommand) => {
-	fcqCommand
-		.addCommand(
-			'download-self-contained',
-			path.resolve(
-				__dirname,
-				'command.download-self-contained.controller.js'
-			)
-		)
-		.addAlias('dsc')
-		.setDescription('Downloads a self-contained build.')
-
-		.addOption(
-			'location',
-			'l',
-			'The directory where to save the self-contained build. This defaults to the current working directory.',
-			false
-		)
-		.addOption(
-			'runtime',
-			null,
-			'The runtime to download. Supported values: linux-x64, win-x64.',
-			true
-		)
-		.addOption(
-			'version',
-			null,
-			'The version to download. Can be either a specific version or "nightly". Be warned: nightly can be unstable or may not work at all.',
-			true
-		)
-
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} download-self-contained --runtime linux-x64 --version x.x.x`,
-			`Download the linux-x64 self-contained build into the current working directory.`
-		)
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} download-self-contained --runtime linux-x64 --version x.x.x --location /opt/my-instance/`,
-			'Download the linux-x64 self-contained build into "/opt/my-instance/".'
-		);
-};

package/src/modules/content-quality/src/command.init.controller.js

@@ -1,91 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import constants from './utilities/constants.js';
-import FontoxmlFcqManifest from './utilities/FontoxmlFcqManifest.js';
-import setEntryVisibility from './utilities/setEntryVisibility.js';
-
-export default async function initCommand(req, res) {
-	res.caption(req.command.getLongName());
-
-	// Check if the version exists.
-	const sdkVersions = await req.fdt.license.getVersionsForProduct(
-		'content-quality'
-	);
-	const version = req.options.version;
-	if (!sdkVersions.includes(version)) {
-		throw new Error(
-			`Could not initialize for version (${version}), please check if it is a valid version. The latest version is ${sdkVersions.getLatestStable()}, run \`fdt content-quality versions\` to get a list of all available versions.`
-		);
-	}
-
-	const directoryPath = path.resolve(
-		req.options.location ? req.options.location : process.cwd()
-	);
-	return fs
-		.exists(directoryPath)
-		.then((exists) => {
-			if (!exists) {
-				// Create the directory if it does not exist.
-				return fs.ensureDir(directoryPath);
-			}
-			// Ensure the directory is empty if it does exist.
-			return fs.readdir(directoryPath).then((files) => {
-				if (files.length) {
-					throw new Error(
-						`The directory "${directoryPath}" is not empty.`
-					);
-				}
-			});
-		})
-		.then(() => {
-			const destroySpinner = res.spinner(
-				`Initializing a Fonto Content Quality instance at "${directoryPath}"...`
-			);
-			return fs
-				.copy(
-					constants.INSTANCE_TEMPLATE_DIRECTORY_PATH,
-					directoryPath,
-					{
-						filter: (src, _dest) => {
-							const filename = path.basename(src);
-							return filename !== '.gitkeep';
-						},
-					}
-				)
-				.then(() => {
-					const data = new FontoxmlFcqManifest(version);
-					const manifest = path.join(
-						directoryPath,
-						constants.MANIFEST_FILENAME
-					);
-
-					return fs
-						.writeJson(manifest, data)
-						.then(() => setEntryVisibility(manifest, false));
-				})
-				.catch((error) => {
-					return fs.emptyDir(directoryPath).then(() => {
-						destroySpinner();
-						throw error;
-					});
-				})
-				.then(() =>
-					req.fdt.license.sendTelemetry({
-						product: req.command.parent.name,
-						type: 'docker',
-						version,
-						action: req.command.name,
-					})
-				)
-				.then(() => destroySpinner());
-		})
-		.then(() => {
-			res.log(
-				'Complete the configuration before building or running the instance.'
-			);
-			res.log(
-				`See ${constants.DOCUMENTATION_GETTING_STARTED_GUIDE} for more information.`
-			);
-		});
-}

package/src/modules/content-quality/src/command.init.js

@@ -1,44 +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, fcqCommand) => {
-	fcqCommand
-		.addCommand(
-			'init',
-			path.resolve(__dirname, 'command.init.controller.js')
-		)
-		.setDescription(
-			'Initialize a Fonto Content Quality instance in an empty or nonexistent directory.'
-		)
-
-		.addOption(
-			'location',
-			'l',
-			'The directory where to initialize the instance. If not set this defaults to the current working directory. Note that the directory has to be empty or nonexistent.',
-			false
-		)
-		.addOption(
-			'version',
-			null,
-			'The version to initialize with. Can be either a specific version or "nightly". Be warned: nightly can be unstable or may not work at all.',
-			true
-		)
-
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} init --version x.x.x`,
-			'Initialize a new Fonto Content Quality instance located at the current working directory.'
-		)
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} init --location /opt/my-instance/ --version x.x.x`,
-			'Initialize a new Fonto Content Quality instance located at "/opt/my-instance/".'
-		);
-};

package/src/modules/content-quality/src/command.run.controller.js

@@ -1,444 +0,0 @@
-import fs from'fs-extra';
-import os from 'os';
-import path from 'path';
-
-import FontoxmlFcqManifest from './utilities/FontoxmlFcqManifest.js';
-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 getVerbosityLevel from './utilities/getVerbosityLevel.js';
-import getWhitelist from './utilities/getWhitelist.js';
-import setEntryVisibility from './utilities/setEntryVisibility.js';
-import validateInstance from './utilities/validateInstance.js';
-
-const verboseFcqConfigurationEntries = {
-	Logging__LogLevel__Default: 'Trace',
-};
-
-const DEFAULT_PORT = 6000;
-
-function copyFcqConfiguration(fcqConfiguration, tempDir, verbosityLevel, res) {
-	const targetFcqConfiguration = path.join(tempDir, '.env');
-
-	return fs.exists(fcqConfiguration).then((exists) => {
-		// Read the configuration entries from the .env file or initialize an empty array.
-		let deferred = exists
-			? fs.readFile(fcqConfiguration, 'utf8').then((data) => {
-					return data.split(/\r?\n/g);
-			  })
-			: new Promise((resolve, _reject) => {
-					resolve(new Array(0));
-			  });
-
-		// Replace or set the defaults for verbosity.
-		if (verbosityLevel === constants.VERBOSITY_LEVEL_DEBUG) {
-			deferred = deferred.then((configurationEntries) => {
-				Object.keys(verboseFcqConfigurationEntries).forEach((key) => {
-					const configurationEntryIndex =
-						configurationEntries.findIndex((entry) =>
-							entry.startsWith(`${key}=`)
-						);
-					const value = verboseFcqConfigurationEntries[key];
-					if (configurationEntryIndex === -1) {
-						configurationEntries.push(`${key}=${value}`);
-					} else {
-						configurationEntries[
-							configurationEntryIndex
-						] = `${key}=${value}`;
-					}
-				});
-				return configurationEntries;
-			});
-		}
-
-		// Ignore options that shouldn't be applied when running through FDT.
-		deferred = deferred.then((configurationEntries) => {
-			let i = configurationEntries.length;
-			while (i--) {
-				const configurationLine = configurationEntries[i];
-				if (
-					!configurationLine.startsWith('#') &&
-					configurationLine.indexOf('=') !== -1
-				) {
-					const [key, _value] = configurationLine.split('=', 2);
-
-					if (key === 'ASPNETCORE_URLS') {
-						configurationEntries.splice(i, 1);
-						res.notice(
-							`Notice: The '${key}' configuration option in the '.env' file will be ignored when ` +
-								"running the application using FDT. The FDT '--port' option can be used to run the application " +
-								'under a different port.'
-						);
-					}
-				}
-			}
-			return configurationEntries;
-		});
-
-		// Write the configuration to the .env file.
-		return deferred.then((configurationEntries) => {
-			const configurationData = configurationEntries.join(os.EOL);
-			return fs.writeFile(targetFcqConfiguration, configurationData);
-		});
-	});
-}
-
-export default function runCommand(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_DIRECTORY_NAME
-	);
-	const fcqConfigurationFilePath = req.options['config-location']
-		? path.resolve(req.options['config-location'])
-		: path.join(directoryPath, '.env');
-	const manifestFilePath = path.join(
-		directoryPath,
-		constants.MANIFEST_FILENAME
-	);
-	const verbosityLevel = getVerbosityLevel(
-		req.options.verbose,
-		req.options.debug
-	);
-	const port = req.options.port || DEFAULT_PORT;
-	const projectName = `${constants.DEFAULT_IMAGE_NAME}_${port}`;
-
-	let pidToKillOnForceExit = null;
-	const setPidToKillOnForceExit = (processToKill) => {
-		pidToKillOnForceExit = processToKill && processToKill.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,
-			projectName,
-			res,
-			verbosityLevel
-		).then(process.exit);
-	});
-
-	return (
-		validateInstance(directoryPath)
-			.then(() => fs.exists(fcqConfigurationFilePath))
-			.then((exists) => {
-				if (!exists) {
-					if (req.options['config-location']) {
-						throw new Error(
-							`Fonto Content Quality config "${fcqConfigurationFilePath}" does not exist.`
-						);
-					}
-					res.notice(
-						`No .env file exists in the directory "${directoryPath}". See ${constants.DOCUMENTATION_CONFIGURATION_GUIDE} to configure the .env file.`
-					);
-				}
-			})
-			.then(() => fs.exists(manifestFilePath))
-			.then((exists) => {
-				// Verify fontoxmlFcqManifest file is present and valid.
-				if (!exists) {
-					throw new Error(
-						'The Fonto Content Quality manifest file does not exist.'
-					);
-				} else {
-					return FontoxmlFcqManifest.fromJsonFile(manifestFilePath);
-				}
-			})
-			// Cleanup possible remaining resources from a previous build or run.
-			.then(() =>
-				cleanup(
-					temporaryDirectoryPath,
-					projectName,
-					res,
-					verbosityLevel
-				)
-			)
-			.then(() => {
-				const destroySpinner = res.spinner(
-					`Building development image at "${directoryPath}"...`
-				);
-
-				// Retrieve data for the docker image
-				return FontoxmlFcqManifest.fromJsonFile(manifestFilePath).then(
-					(manifestObj) => {
-						const requestObj = {
-							'content-quality': {
-								docker: {
-									version: manifestObj.fcqVersion,
-								},
-							},
-						};
-
-						return req.fdt.license
-							.getDataForProducts(requestObj)
-							.catch((error) => {
-								if (error.statusCode === 404) {
-									error.solution =
-										'This error might be caused by requesting a nonexisting Fonto Content Quality version, please check your version.';
-								}
-								throw error;
-							})
-							.then((productData) => {
-								const dockerData =
-									productData.products['content-quality']
-										.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(
-														'${fcqImage}',
-														dockerData.image
-													)
-												)
-												.then((fixedDockerContent) =>
-													fs.writeFile(
-														path.join(
-															temporaryDirectoryPath,
-															'Dockerfile'
-														),
-														fixedDockerContent
-													)
-												);
-										})
-										.then(() =>
-											fs.copy(
-												constants.INSTANCE_DEV_BUILD_DIRECTORY_PATH,
-												temporaryDirectoryPath
-											)
-										)
-										.then(() => {
-											// Rewrite the port in the docker-compose file.
-											return fs
-												.readFile(
-													path.join(
-														temporaryDirectoryPath,
-														'docker-compose.yml'
-													),
-													'utf8'
-												)
-												.then((dockerComposeContent) =>
-													dockerComposeContent
-														.replace(
-															'${containerName}',
-															projectName
-														)
-														.replace(
-															'${fcqPort}',
-															port
-														)
-												)
-												.then(
-													(
-														fixedDockerComposeContent
-													) =>
-														fs.writeFile(
-															path.join(
-																temporaryDirectoryPath,
-																'docker-compose.yml'
-															),
-															fixedDockerComposeContent
-														)
-												);
-										})
-										.then(() => [
-											path.join(
-												directoryPath,
-												'Configuration'
-											),
-										])
-										.then(() => getWhitelist())
-										.then((whitelist) =>
-											copyWhitelistedFiles(
-												whitelist,
-												directoryPath,
-												path.join(
-													temporaryDirectoryPath,
-													'instance'
-												)
-											)
-										)
-										.then(() =>
-											copyFcqConfiguration(
-												fcqConfigurationFilePath,
-												temporaryDirectoryPath,
-												verbosityLevel,
-												res
-											)
-										)
-
-										// 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.'
-													);
-												});
-										})
-
-										// Use docker-compose to build the development image.
-										.then(() =>
-											executeAndLog(
-												res,
-												'docker-compose',
-												verbosityLevel ===
-													constants.VERBOSITY_LEVEL_DEBUG
-													? [
-															'-p',
-															projectName,
-															'--verbose',
-															'build',
-													  ]
-													: [
-															'-p',
-															projectName,
-															'build',
-													  ],
-												temporaryDirectoryPath,
-												verbosityLevel,
-												false,
-												setPidToKillOnForceExit
-											)
-										)
-										.then(() =>
-											req.fdt.license.sendTelemetry({
-												product:
-													req.command.parent.name,
-												type: 'docker',
-												version: manifestObj.fcqVersion,
-												action: req.command.name,
-											})
-										)
-										.then(() => destroySpinner())
-								);
-							});
-					}
-				);
-			})
-			// Use docker-compose to run the development image. We hard-code verbose to true since docker does not yet support a --quiet or --silent flag. https://github.com/docker/compose/issues/3447
-			.then(() => {
-				res.notice(
-					`Starting Fonto Content Quality on "http://localhost:${port}"...`
-				);
-				return executeAndLog(
-					res,
-					'docker-compose',
-					verbosityLevel === constants.VERBOSITY_LEVEL_DEBUG
-						? ['-p', projectName, '--verbose', 'up']
-						: ['-p', projectName, 'up'],
-					temporaryDirectoryPath,
-					verbosityLevel,
-					true,
-					setPidToKillOnForceExit
-				);
-			})
-			// Cleanup temporary directory.
-			.then(() =>
-				cleanup(
-					temporaryDirectoryPath,
-					projectName,
-					res,
-					verbosityLevel
-				)
-			)
-			.catch((error) => {
-				if (!stopping) {
-					res.notice(
-						`See our documentation at ${constants.DOCUMENTATION_EXECUTE_ERROR} for help.`
-					);
-				}
-
-				return cleanup(
-					temporaryDirectoryPath,
-					projectName,
-					res,
-					verbosityLevel
-				)
-					.then(() => {
-						throw error;
-					})
-					.catch(() => {
-						throw error;
-					});
-			})
-	);
-};

package/src/modules/content-quality/src/command.run.js

@@ -1,64 +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, fcqCommand) => {
-	fcqCommand
-		.addCommand('run', path.resolve(__dirname, 'command.run.controller.js'))
-		.setDescription(
-			'Run a Fonto Content Quality instance for development purposes. Requires Docker to be installed.'
-		)
-
-		.addOption(
-			'port',
-			'p',
-			'Listen on the specified port instead of listening on the default port (default=6000).'
-		)
-
-		.addOption(
-			'location',
-			'l',
-			'The directory where the instance is located.',
-			false
-		)
-		.addOption(
-			'config-location',
-			'c',
-			`The path where the configuration file (.env) is located. Information about the .env file can be found at ${constants.DOCUMENTATION_CONFIGURATION_GUIDE}.`,
-			false
-		)
-
-		.addOption(
-			'verbose',
-			null,
-			'Output default stdout and stderr information.'
-		)
-		.addOption(
-			'debug',
-			null,
-			'Output all debug information. This also overrides the Logging__LogLevel__Default if set.'
-		)
-
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} run`,
-			'Build and run a development image using the Fonto Content Quality instance and configuration located at the current working directory.'
-		)
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} run --port 7455`,
-			'Build and run a development image using the Fonto Content Quality instance and configuration located at the current working directory on the non-default port 7455. '
-		)
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} run --location /opt/my-instances/specific-instance/ --config-location /opt/my-instances/.env`,
-			'Build and run a development image using the Fonto Content Quality instance located at "/opt/my-instances/specific-instance/" using the configuration located at "/opt/my-instances/.env".'
-		);
-};