Merge pull request #187 from LiskHQ/167-allow-user-to-specify-lisk-co…

…re-start-params

Allow user to specify Lisk Core start params

src/utils/node.ts

@@ -11,11 +11,13 @@
  *
  * Removal or modification of this copyright notice is prohibited.
  */
+import cli from 'cli-ux';
 import * as fs from 'fs-extra';
 import * as path from 'path';
 import { homedir } from 'os';
 import { Command } from '@oclif/command';
 import { existsSync, renameSync } from 'fs-extra';
+
 import { PartialApplicationConfig } from 'lisk-framework';
 
 import { execAsync } from './process';
@@ -32,6 +34,13 @@ const PM2_FILE_NAME = 'pm2.migrator.config.json';
 
 const LISK_V3_BACKUP_DATA_DIR = `${homedir()}/.lisk/lisk-core-v3`;
 
+const REGEX = {
+	INPUT_SEPARATOR: /[\s=]+/,
+	FLAG: /^(?:-[a-z]|--[a-z]+(?:-[a-z]+)*$)/,
+	NETWORK_FLAG: /^(?:-n|--network)/,
+	OPTION_OR_VALUE: /=<(option|value)>$/,
+};
+
 export const installLiskCore = async (): Promise<string> => execAsync(INSTALL_LISK_CORE_COMMAND);
 
 export const installPM2 = async (): Promise<string> => execAsync(INSTALL_PM2_COMMAND);
@@ -67,11 +76,98 @@ const copyLegacyDB = async (_this: Command) => {
 	_this.log(`Legacy database for Lisk Core v4 has been created at ${LEGACY_DB_PATH}`);
 };
 
-const getFinalConfigPath = async (outputDir: string, network: string) =>
+export const getFinalConfigPath = async (outputDir: string, network: string) =>
 	(await exists(`${outputDir}/config.json`))
 		? outputDir
 		: path.resolve(__dirname, '../..', 'config', network);
 
+export const validateStartCommandFlags = async (
+	allowedFlags: string[],
+	userInputString: string,
+): Promise<boolean> => {
+	try {
+		let isOptionOrValueExpected = false;
+
+		const userInputs = userInputString.split(REGEX.INPUT_SEPARATOR);
+		for (let i = 0; i < userInputs.length; i += 1) {
+			const input = userInputs[i];
+
+			// Since network is determined automatically, user shouldn't pass the network flag
+			if (REGEX.NETWORK_FLAG.test(input)) return false;
+
+			if (REGEX.FLAG.test(input)) {
+				const correspondingFlag = allowedFlags.find(f => f.includes(input));
+
+				// If unknown flag specified or expected a value for prev flag or if no value provided when expected
+				if (!correspondingFlag || isOptionOrValueExpected || i === userInputs.length - 1) {
+					return false;
+				}
+
+				if (REGEX.OPTION_OR_VALUE.test(correspondingFlag)) {
+					isOptionOrValueExpected = true;
+				}
+			} else if (isOptionOrValueExpected) {
+				isOptionOrValueExpected = false;
+			} else {
+				return false;
+			}
+		}
+
+		return true;
+	} catch (error) {
+		return false;
+	}
+};
+
+const resolveLiskCoreStartCommand = async (_this: Command, network: string, configPath: string) => {
+	const isUserConfirmed = await cli.confirm(
+		'Would you like to customize the Lisk Core v4 start command? [yes/no]',
+	);
+
+	const baseStartCommand = `lisk core start --network ${network}`;
+
+	if (!isUserConfirmed) {
+		const defaultStartCommand = `${baseStartCommand} --config ${configPath}/config.json`;
+		return defaultStartCommand;
+	}
+
+	// Let user customize the start command
+	let customStartCommand = baseStartCommand;
+
+	_this.log('Customizing Lisk Core start command');
+	let userInput = await cli.prompt(
+		"Please provide the Lisk Core start command flags (e.g. --api-ws), except the '--network (-n)' flag:",
+	);
+
+	const command = "lisk-core start --help | grep -- '^\\s\\+-' | cut -d ' ' -f 3,4";
+	const allowedFlags = await execAsync(command);
+	const allowedFlagsArray = allowedFlags.split(/\n+/).filter(e => !!e);
+
+	let numTriesLeft = 3;
+	while (numTriesLeft) {
+		numTriesLeft -= 1;
+
+		const isValid = await validateStartCommandFlags(allowedFlagsArray, userInput);
+		if (isValid) {
+			/* eslint-disable-next-line @typescript-eslint/restrict-template-expressions */
+			customStartCommand = `${baseStartCommand} ${userInput}`;
+			break;
+		}
+
+		if (numTriesLeft >= 0) {
+			userInput = await cli.prompt(
+				"Invalid flags passed. Please provide the Lisk Core start command flags (e.g. --api-ws), except the '--network (-n)' flag again:",
+			);
+		} else {
+			throw new Error(
+				'Invalid Lisk Core start command flags provided. Cannot proceed with Lisk Core v4 auto-start. Please continue manually. Exiting!!!',
+			);
+		}
+	}
+
+	return customStartCommand;
+};
+
 export const startLiskCore = async (
 	_this: Command,
 	liskCoreV3DataPath: string,
@@ -92,24 +188,35 @@ export const startLiskCore = async (
 	await backupDefaultDirectoryIfExists(_this, liskCoreV3DataPath);
 	await copyLegacyDB(_this);
 
-	_this.log('Installing pm2...');
-	await installPM2();
-	_this.log('Finished installing pm2.');
-
-	const pm2FilePath = path.resolve(outputDir, PM2_FILE_NAME);
-	_this.log(`Creating PM2 config at ${pm2FilePath}`);
 	const configPath = await getFinalConfigPath(outputDir, network);
-	fs.writeFileSync(
-		pm2FilePath,
-		JSON.stringify(
-			{
-				name: 'lisk-core-v4',
-				script: `lisk-core start --network ${network} --config ${configPath}/config.json`,
-			},
+	const liskCoreStartCommand = await resolveLiskCoreStartCommand(_this, network, configPath);
+
+	const pm2Config = {
+		name: 'lisk-core-v4',
+		script: liskCoreStartCommand,
+	};
+
+	const isUserConfirmed = await cli.confirm(
+		`Start Lisk Core with the following pm2 configuration? [yes/no]\n${JSON.stringify(
+			pm2Config,
 			null,
 			'\t',
-		),
+		)}`,
 	);
+
+	if (!isUserConfirmed) {
+		_this.error(
+			'User did not confirm to start Lisk Core v4 with the customized PM2 config. Skipping the Lisk Core v4 auto-start process. Please start the node manually.',
+		);
+	}
+
+	_this.log('Installing PM2...');
+	await installPM2();
+	_this.log('Finished installing PM2.');
+
+	const pm2FilePath = path.resolve(outputDir, PM2_FILE_NAME);
+	_this.log(`Creating PM2 config at ${pm2FilePath}`);
+	fs.writeFileSync(pm2FilePath, JSON.stringify(pm2Config, null, '\t'));
 	_this.log(`Successfully created the PM2 config at ${pm2FilePath}`);
 
 	const PM2_COMMAND_START = `pm2 start ${pm2FilePath}`;

test/unit/fixtures/customConfig.json

@@ -0,0 +1,33 @@
+{
+	"system": {
+		"dataPath": "~/.customNode"
+	},
+	"rpc": {
+		"modes": ["ws"],
+		"port": 7000,
+		"host": "0.0.0.0",
+		"allowedMethods": []
+	},
+	"genesis": {
+		"block": {
+			"fromFile": "./config/genesis_block.blob"
+		},
+		"blockTime": 10,
+		"chainID": "00000000",
+		"maxTransactionsSize": 15360,
+		"minimumCertifyHeight": 1
+	},
+	"network": {
+		"version": "4.0",
+		"seedPeers": [],
+		"port": 7667
+	},
+	"transactionPool": {
+		"maxTransactions": 4096,
+		"maxTransactionsPerAccount": 64,
+		"transactionExpiryTime": 10800000,
+		"minEntranceFeePriority": "0",
+		"minReplacementFeeDifference": "10"
+	},
+	"plugins": {}
+}

test/unit/fixtures/lisk-core/config/mainnet/config.json

@@ -0,0 +1,33 @@
+{
+	"system": {
+		"dataPath": "~/.lisk"
+	},
+	"rpc": {
+		"modes": ["ws"],
+		"port": 7887,
+		"host": "127.0.0.1",
+		"allowedMethods": []
+	},
+	"genesis": {
+		"block": {
+			"fromFile": "./config/genesis_block.blob"
+		},
+		"blockTime": 10,
+		"chainID": "00000000",
+		"maxTransactionsSize": 15360,
+		"minimumCertifyHeight": 1
+	},
+	"network": {
+		"version": "4.0",
+		"seedPeers": [],
+		"port": 7667
+	},
+	"transactionPool": {
+		"maxTransactions": 4096,
+		"maxTransactionsPerAccount": 64,
+		"transactionExpiryTime": 10800000,
+		"minEntranceFeePriority": "0",
+		"minReplacementFeeDifference": "10"
+	},
+	"plugins": {}
+}

test/unit/utils/config.spec.ts

@@ -14,6 +14,7 @@
 import * as fs from 'fs-extra';
 import { resolve, join } from 'path';
 import { ApplicationConfig } from 'lisk-framework';
+import Command from '@oclif/command';
 import { configV3, configV4 } from '../fixtures/config';
 import { NETWORK_CONSTANT } from '../../../src/constants';
 import {
@@ -23,6 +24,7 @@ import {
 	writeConfig,
 	resolveConfigPathByNetworkID,
 	createBackup,
+	getConfig,
 } from '../../../src/utils/config';
 import { ApplicationConfigV3 } from '../../../src/types';
 
@@ -94,3 +96,88 @@ describe('Test createBackup method', () => {
 		expect(fs.existsSync(expectedBackupPath)).toBe(true);
 	});
 });
+
+describe('Test getConfig method', () => {
+	const networkIdentifier = '4c09e6a781fc4c7bdb936ee815de8f94190f8a7519becd9de2081832be309a99';
+	const configPath = join(__dirname, '../../..', 'test/unit/fixtures/lisk-core');
+
+	it('should return valid config when custom config is not available', async () => {
+		const config = await getConfig(Command as any, configPath, networkIdentifier, undefined);
+		const expectedConfig = {
+			system: {
+				dataPath: '~/.lisk',
+			},
+			rpc: {
+				modes: ['ws'],
+				port: 7887,
+				host: '127.0.0.1',
+				allowedMethods: [],
+			},
+			genesis: {
+				block: {
+					fromFile: './config/genesis_block.blob',
+				},
+				blockTime: 10,
+				chainID: '00000000',
+				maxTransactionsSize: 15360,
+				minimumCertifyHeight: 1,
+			},
+			network: {
+				version: '4.0',
+				seedPeers: [],
+				port: 7667,
+			},
+			transactionPool: {
+				maxTransactions: 4096,
+				maxTransactionsPerAccount: 64,
+				transactionExpiryTime: 10800000,
+				minEntranceFeePriority: '0',
+				minReplacementFeeDifference: '10',
+			},
+			plugins: {},
+		};
+
+		expect(config).toEqual(expectedConfig);
+	});
+
+	it('should return valid config when custom config is available', async () => {
+		const customConfig = join(__dirname, '../../..', 'test/unit/fixtures/customConfig.json');
+		const config = await getConfig(Command as any, configPath, networkIdentifier, customConfig);
+
+		const expectedConfig = {
+			system: {
+				dataPath: '~/.customNode',
+			},
+			rpc: {
+				modes: ['ws'],
+				port: 7000,
+				host: '0.0.0.0',
+				allowedMethods: [],
+			},
+			genesis: {
+				block: {
+					fromFile: './config/genesis_block.blob',
+				},
+				blockTime: 10,
+				chainID: '00000000',
+				maxTransactionsSize: 15360,
+				minimumCertifyHeight: 1,
+			},
+			network: {
+				version: '4.0',
+				seedPeers: [],
+				port: 7667,
+			},
+			transactionPool: {
+				maxTransactions: 4096,
+				maxTransactionsPerAccount: 64,
+				transactionExpiryTime: 10800000,
+				minEntranceFeePriority: '0',
+				minReplacementFeeDifference: '10',
+			},
+			plugins: {},
+		};
+
+		expect(config).toEqual(expectedConfig);
+	});
+});