@fontoxml/fontoxml-development-tools 3.11.0 → 3.12.0-beta.1

package/src/modules/document-history/src/command.build.controller.js

@@ -1,260 +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 FontoxmlFdhManifest from './utilities/FontoxmlFdhManifest.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 FontoxmlFdhManifest.fromJsonFile(manifestFilePath).then(
-					(manifestObj) => {
-						const requestObj = {
-							'document-history': {
-								docker: {
-									version: manifestObj.fdhVersion,
-								},
-							},
-						};
-
-						return req.fdt.license
-							.getDataForProducts(requestObj)
-							.catch((error) => {
-								if (error.statusCode === 404) {
-									error.solution =
-										'This error might be caused by requesting a nonexistent Fonto Document History version, please check your version.';
-								}
-								throw error;
-							})
-							.then((productData) => {
-								const dockerData =
-									productData.products['document-history']
-										.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(
-														'${fdhImage}',
-														dockerData.image
-													)
-												)
-												.then((fixedDockerContent) =>
-													fs.writeFile(
-														path.join(
-															temporaryDirectoryPath,
-															'Dockerfile'
-														),
-														fixedDockerContent
-													)
-												);
-										})
-										.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.fdhVersion,
-												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/document-history/src/command.build.js

@@ -1,56 +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, fdhCommand) => {
-	fdhCommand
-		.addCommand(
-			'build',
-			path.resolve(__dirname, 'command.build.controller.js')
-		)
-		.setDescription(
-			'Build a Fonto Document History 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 Document History instance is located. Defaults to the current working directory.',
-			false
-		)
-		.addOption(
-			'verbose',
-			null,
-			'Output default stdout and stderr information.'
-		)
-		.addOption('debug', null, 'Output all debug information.')
-
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} build`,
-			`Build production image "${constants.DEFAULT_IMAGE_NAME}:${constants.DEFAULT_IMAGE_NAME}" using the Fonto Document History instance located at the current working directory.`
-		)
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} build --image-name my-fdh-instance --image-tag 1.0.0 --location /opt/my-instance/`,
-			'Build production image "my-fdh-instance:1.0.0" using the Fonto Document History instance located at "/opt/my-instance/".'
-		);
-};

package/src/modules/document-history/src/command.download-self-contained.controller.js

@@ -1,110 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-import requestPromise from 'request-promise-native';
-import url from 'url';
-
-export default function buildCommand(req, res) {
-	res.caption(req.command.getLongName());
-
-	const directoryPath = path.resolve(
-		req.options.location ? req.options.location : process.cwd()
-	);
-	const version = req.options.version;
-	const runtime = req.options.runtime;
-
-	const requestObj = {
-		'document-history': {
-			selfContained: {
-				runtime,
-				version,
-			},
-		},
-	};
-
-	const destroySpinner = res.spinner(`Downloading self-contained build...`);
-
-	return req.fdt.license
-		.getDataForProducts(requestObj)
-		.catch(async (error) => {
-			if (error.statusCode === 404) {
-				try {
-					const sdkVersions =
-						await req.fdt.license.getVersionsForProduct(
-							'document-history'
-						);
-					error = new res.ErrorWithSolution(
-						`Could not download self-contained for version (${version}) and runtime environment (${runtime}). Please check if it is a valid version and runtime environment.`,
-						`The latest version is ${sdkVersions.getLatestStable()}, run \`fdt document-history versions\` to get a list of all available versions and run \`fdt document-history download-self-contained --help\` to get a list of all available runtime environments.`,
-						error
-					);
-				} catch (_error) {
-					error = new res.ErrorWithSolution(
-						`Could not download self-contained for version (${version}) and runtime environment (${runtime}). Please check if it is a valid version and runtime environment.`,
-						`Run \`fdt document-history versions\` to get a list of all available versions and run \`fdt document-history download-self-contained --help\` to get a list of all available runtime environments.`,
-						error
-					);
-				}
-			}
-			throw error;
-		})
-		.then((productData) => {
-			const downloadUri =
-				productData.products['document-history'].selfContained.uri;
-			const parsed = url.parse(downloadUri);
-			const filename = path.basename(parsed.pathname);
-			const filePath = path.join(directoryPath, filename);
-			return requestPromise
-				.get(downloadUri, {
-					resolveWithFullResponse: true,
-					simple: false,
-					encoding: null,
-				})
-				.then((response) => {
-					switch (response.statusCode) {
-						case 200:
-							return response.body;
-						case 401:
-						case 403:
-							throw new Error(
-								'You are currently not allowed to download this self-contained build, even though you might have the license for it.'
-							);
-						case 404:
-							throw new Error(
-								'The file for the requested self-contained build could not be found.'
-							);
-						default:
-							throw new Error(
-								`Invalid response from the self-contained builds server (${response.statusCode}).`
-							);
-					}
-				})
-				.then((data) => {
-					return fs.outputFile(filePath, data).catch((_error) => {
-						throw new Error(
-							'Could not save self-contained build download to disk.'
-						);
-					});
-				})
-				.then(() =>
-					req.fdt.license.sendTelemetry({
-						product: req.command.parent.name,
-						type: 'selfContained',
-						runtime: req.options.runtime,
-						version,
-						action: req.command.name,
-					})
-				)
-				.then(() => {
-					destroySpinner();
-					res.break();
-					const locationString = req.options.location
-						? path.isAbsolute(req.options.location)
-							? filePath
-							: path.join(req.options.location, filename)
-						: filename;
-					res.notice(
-						`Saved self-contained build to ${locationString}`
-					);
-				});
-		});
-}

package/src/modules/document-history/src/command.download-self-contained.js

@@ -1,50 +0,0 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export default (moduleRegistration, connectorsCommand) => {
-	connectorsCommand
-		.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. If not set 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
-			} document-history 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
-			} document-history 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/document-history/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 FontoxmlFdhManifest from './utilities/FontoxmlFdhManifest.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(
-		'document-history'
-	);
-	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 document-history 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 Document History 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 FontoxmlFdhManifest(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/document-history/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, fdhCommand) => {
-	fdhCommand
-		.addCommand(
-			'init',
-			path.resolve(__dirname, 'command.init.controller.js')
-		)
-		.setDescription(
-			'Initialize a Fonto Document History 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 Document History 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 Document History instance located at "/opt/my-instance/".'
-		);
-};