liferay-theme-tasks/theme/lib/war_deployer.js

A set of tasks for building and deploying Liferay Portal themes.

/**
 * SPDX-FileCopyrightText: © 2017 Liferay, Inc. <https://liferay.com>
 * SPDX-License-Identifier: MIT
 */

const colors = require('ansi-colors');
const {EventEmitter} = require('events');
const log = require('fancy-log');
const fs = require('fs');
const inquirer = require('inquirer');
const _ = require('lodash');
const path = require('path');
const url = require('url');

const project = require('../../lib/project');

class WarDeployer extends EventEmitter {
	constructor(options) {
		super();
		this.init(options);
	}

	init(options) {
		EventEmitter.call(this);

		this._validateOptions(options);

		const siteURL = options.url || 'http://localhost:8080';

		this._setURLSettings(siteURL);

		this._validateURLSettings();

		this.fileName = options.fileName;
		this.password = options.password;
		this.username = options.username;
	}

	deploy() {
		this._promptCredentialsIfNeeded();
	}

	_getAuth() {
		return this.username + ':' + this.password;
	}

	_getBoundaryKey() {
		let boundaryKey = this.boundaryKey;

		if (!boundaryKey) {
			boundaryKey = Math.random().toString(16);

			this.boundaryKey = boundaryKey;
		}

		return boundaryKey;
	}

	_getFileHeaders() {
		const fileName = this.fileName;

		return (
			'--' +
			this._getBoundaryKey() +
			'\r\n' +
			'Content-Type: application/x-zip\r\n' +
			'Content-Disposition: form-data; name="' +
			fileName +
			'"; filename="' +
			fileName +
			'.war"\r\n' +
			'Content-Transfer-Encoding: binary\r\n\r\n'
		);
	}

	_getPostOptions() {
		return {
			auth: this._getAuth(),
			headers: {
				'Content-Type':
					'multipart/form-data; boundary="' +
					this._getBoundaryKey() +
					'"',
			},
			host: this.host,
			method: 'POST',
			path: '/server-manager-web/plugins',
			port: this.port,
		};
	}

	_getQuestion(name, defaultValue) {
		return {
			default: defaultValue,
			message: 'Enter your ' + name + ' for ' + this.host,
			name,
			type: name === 'password' ? name : 'input',
		};
	}

	_makeRequest() {
		// eslint-disable-next-line @liferay/no-dynamic-require
		const protocol = require(this.protocol);

		const req = protocol.request(this._getPostOptions(), (res) => {
			res.setEncoding('utf8');

			res.on('data', (chunk) => {
				this._onResponseData(chunk);
			});

			res.on('end', () => {
				this._onResponseEnd();
			});
		});

		req.on('error', (error) => {
			if (error) {
				throw error;
			}
		});

		this._writeWarFile(req);
	}

	_onResponseData(chunk) {
		try {
			const responseData = JSON.parse(chunk);

			if (responseData && !responseData.error) {
				this.deployed = true;
			}
		}
		catch (error) {

			// Swallow.

		}
	}

	_onResponseEnd() {
		if (this.deployed) {
			log(
				colors.cyan(this.fileName + '.war'),
				'successfully deployed to',
				this.host
			);
		}
		else {
			log(
				colors.yellow('Warning:'),
				'There was a problem deploying',
				colors.cyan(this.fileName + '.war'),
				'to',
				this.host
			);
		}
	}

	_promptCredentialsIfNeeded() {
		const questions = [];

		if (!this.username) {
			questions.push(this._getQuestion('username', 'test@liferay.com'));
		}

		if (!this.password) {
			questions.push(this._getQuestion('password', 'test'));
		}

		if (questions.length) {
			inquirer.prompt(questions, (answers) => {
				Object.keys(answers).forEach((key) => {
					this[key] = answers[key];
				});

				this._makeRequest();
			});
		}
		else {
			this._makeRequest();
		}
	}

	_setURLSettings(siteURL) {
		const parsedURL = url.parse(siteURL);

		this.host = parsedURL.hostname;
		this.port = parsedURL.port;
		this.protocol = _.trimEnd(parsedURL.protocol, ':');
	}

	_validateOptions(options) {
		if (!options.fileName) {
			throw new Error('fileName required');
		}
	}

	_validateURLSettings() {
		if (['http', 'https'].indexOf(this.protocol) < 0) {
			throw new Error('http or https must be used as protocol');
		}
	}

	_writeWarFile(req) {
		const boundaryKey = this._getBoundaryKey();

		req.write(this._getFileHeaders(this._fileName, boundaryKey));

		fs.createReadStream(
			path.join(project.dir, 'dist', this.fileName + '.war')
		)
			.on('end', () => {
				req.end('\r\n--' + boundaryKey + '--');

				this.emit('end');
			})
			.pipe(req, {
				end: false,
			});
	}
}

module.exports = WarDeployer;