orc-scripts 4.0.3 → 4.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orc-scripts",
-  "version": "4.0.3",
+  "version": "4.0.5",
   "description": "Scripts toolbox for Orckestra",
   "type": "commonjs",
   "bin": {

package/src/scripts/generateApi.js

@@ -5,6 +5,7 @@ const lodash = require("lodash");
 const occUrl = process.env.OccUrl;
 const occToken = process.env.OccToken;
 let outputFile = "";
+let requestsFile = "";
 
 if (process.argv.includes("--outputFile")) {
 	outputFile = process.argv[process.argv.indexOf("--outputFile") + 1];
@@ -14,6 +15,10 @@ if (!outputFile) {
 	throw new Error("Missing --outputFile 'file' argument.");
 }
 
+if (process.argv.includes("--requestsFile")) {
+	requestsFile = process.argv[process.argv.indexOf("--requestsFile") + 1];
+}
+
 if (!occToken) {
 	throw new Error(
 		"Missing OccToken environment variable. This environment variable needs to contains the authentication token used to access the OCC platform specified in OccUrl.",
@@ -40,7 +45,7 @@ function isVerbAllowed(verb) {
 	return lowerCaseVerb === "get" || lowerCaseVerb === "post" || lowerCaseVerb === "put" || lowerCaseVerb === "delete";
 }
 
-function generateOperationsFromPath(url, pathData) {
+function generateOperationsFromPath(url, pathData, desiredRequests) {
 	const operations = [];
 
 	for (const verb of Object.getOwnPropertyNames(pathData)) {
@@ -50,8 +55,15 @@ function generateOperationsFromPath(url, pathData) {
 
 		const operation = pathData[verb];
 
+		const operationName = extractRequestNameFromOperation(operation);
+
+		const shouldAddOperation = desiredRequests == null || desiredRequests.includes(operationName.toLowerCase());
+		if( !shouldAddOperation ){
+			continue;
+		}
+
 		operations.push({
-			name: extractRequestNameFromOperation(operation),
+			name: operationName,
 			url: url,
 			verb: verb.toUpperCase(),
 			hasQueryString: operation.parameters.filter(p => p.in === "query").length > 0,
@@ -102,51 +114,66 @@ function generateImports() {
 	return 'import { buildUrl } from "../utils/buildUrl";\n\n';
 }
 
-https
-	.get(occUrl, { headers: { "X-AUTH": occToken } }, resp => {
-		let data = "";
-		let error = "";
-
-		if (resp.statusCode !== 200) {
-			error = new Error(`Request Failed. Status Code: ${resp.statusCode}`);
-		}
-		if (error) {
-			console.error(error.message);
-			// Consume response data to free up memory
-			resp.resume();
-			return;
+if (requestsFile) {
+	fs.readFile(requestsFile, 'utf-8', (err, data) => {
+		if (err) {
+			return console.error(err);
 		}
+		const desiredRequests = data.split("\n").map(d => d.trim().toLowerCase());
+		generate(desiredRequests);
+	})
+}else {
+	generate(null);
+}
 
-		// A chunk of data has been received.
-		resp.on("data", chunk => {
-			data += chunk;
-		});
 
-		// The whole response has been received. Print out the result.
-		resp.on("end", () => {
-			const swaggerMetaData = JSON.parse(data);
-			const paths = swaggerMetaData.paths;
-			let operations = [];
+function generate(desiredRequests) {
+	https
+		.get(occUrl, { headers: { "X-AUTH": occToken } }, resp => {
+			let data = "";
+			let error = "";
 
-			for (const url of Object.getOwnPropertyNames(paths)) {
-				operations = operations.concat(generateOperationsFromPath(url, paths[url]));
+			if (resp.statusCode !== 200) {
+				error = new Error(`Request Failed. Status Code: ${resp.statusCode}`);
+			}
+			if (error) {
+				console.error(error.message);
+				// Consume response data to free up memory
+				resp.resume();
+				return;
 			}
 
-			let helperData = "/* istanbul ignore file */\n\n";
-			helperData += generateImports();
+			// A chunk of data has been received.
+			resp.on("data", chunk => {
+				data += chunk;
+			});
 
-			for (const op of lodash.sortBy(operations, [o => o.name])) {
-				helperData += generateOperation(op);
-			}
+			// The whole response has been received. Print out the result.
+			resp.on("end", () => {
+				const swaggerMetaData = JSON.parse(data);
+				const paths = swaggerMetaData.paths;
+				let operations = [];
+
+				for (const url of Object.getOwnPropertyNames(paths)) {
+					operations = operations.concat(generateOperationsFromPath(url, paths[url], desiredRequests));
+				}
+
+				let helperData = "/* istanbul ignore file */\n\n";
+				helperData += generateImports();
 
-			fs.writeFile(outputFile, helperData, function (err) {
-				if (err) {
-					return console.error(err);
+				for (const op of lodash.sortBy(operations, [o => o.name])) {
+					helperData += generateOperation(op);
 				}
-				console.log(`File '${outputFile}' has been created`);
+
+				fs.writeFile(outputFile, helperData, function (err) {
+					if (err) {
+						return console.error(err);
+					}
+					console.log(`File '${outputFile}' has been created`);
+				});
 			});
+		})
+		.on("error", err => {
+			console.log("Error: " + err.message);
 		});
-	})
-	.on("error", err => {
-		console.log("Error: " + err.message);
-	});
+}

package/src/scripts/start.js

@@ -1,5 +1,7 @@
 const DevServer = require("webpack-dev-server");
 const webpack = require("webpack");
+const path = require("path");
+const fs = require("fs");
 
 const HOST = process.env.HOSTNAME || "localhost";
 
@@ -7,6 +9,42 @@ const args = process.argv.slice(2);
 const argPort = args.indexOf("--port") !== -1 ? args[args.indexOf("--port") + 1] : null;
 const PORT = argPort || process.env.PORT || 5000;
 
+const findSslPasswordFromParametersFile = (certFile) => {
+	// reference: https://hals.app/blog/recursively-read-parent-folder-nodejs/
+
+	let parentDirectory = path.dirname(certFile);
+	while (fs.existsSync(parentDirectory)) {
+		console.log("Looking for certificate password in: " + parentDirectory)
+		const fileToFindPath = path.join(parentDirectory, "parameters.dev.xml");
+		if (fs.existsSync(fileToFindPath)) {
+			const fileContent = fs.readFileSync(fileToFindPath, "utf8");
+
+			// Using regex to parse the XML to avoid adding a dependency on an XML package
+
+			const matchResult = /<param\s+name="SSL_CertificatePfxPassword"\s+value="(?<Value>[^"]+)"\s*\/>/.exec(fileContent);
+			if (matchResult && matchResult.groups && matchResult.groups['Value']) {
+				console.log("Certificate password found");
+				return matchResult.groups['Value'];
+			}
+
+			console.warn("Could not find SSL_CertificatePfxPassword in file " + fileToFindPath)
+			return null;
+		}
+
+		// The trick is here:
+		// Using path.dirname() of a directory returns the parent directory!
+		const parentDirname = path.dirname(parentDirectory);
+		// But only to a certain point (file system root) (So to avoid infinite loops lets stop here)
+		if (parentDirectory === parentDirname) {
+			return null;
+		}
+
+		parentDirectory = parentDirname;
+	}
+
+	return null;
+}
+
 const config = require("../config/webpack.config.js");
 const options = {
 	historyApiFallback: true,
@@ -19,13 +57,20 @@ const options = {
 	},
 };
 
-if (HOST !== "localhost") {
-	options.public = HOST;
-}
 if (HOST !== "localhost" || args.indexOf("--https") !== -1 || process.env.HTTPS) {
 	options.server = 'https';
 }
 
+if (options.server === 'https' && process.env.SSL_CERT_PATH) {
+	options.server = {
+		type: 'https',
+		options: {
+			pfx: process.env.SSL_CERT_PATH,
+			passphrase: process.env.SSL_CERT_PASSWORD || findSslPasswordFromParametersFile(process.env.SSL_CERT_PATH),
+		},
+	}
+}
+
 const compiler = webpack(config);
 
 const server = new DevServer(options, compiler);