@suitegeezus/suitecloud-cli 3.1.4 → 3.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@suitegeezus/suitecloud-cli",
-	"version": "3.1.4",
+	"version": "3.1.5",
 	"license": "UPL-1.0",
 	"description": "SuiteCloud CLI for Node.js",
 	"keywords": [

package/src/CLI.js

@@ -148,7 +148,7 @@ module.exports = class CLI {
 						"name": "customflag",
 						"option": "customflag",
 						"description": "A custom boolean that will be passed into the hooks. Has no effect unless you implement the logic in a hook",
-						"mandatory": false,
+						"mandatory": true,
 						"type": "FLAG",
 						"usage": "",
 						"defaultOption": false,
@@ -168,11 +168,21 @@ module.exports = class CLI {
 						"name": "debug",
 						"option": "debug",
 						"description": "Directory to dump debug data for debugging. Creates a unique {command}.{datetime}.json file per run",
-						"mandatory": false,
+						"mandatory": true,
 						"type": "SINGLE",
 						"usage": "\"./debug-output\"",
 						"defaultOption": false,
 						"disableInIntegrationMode": false
+					},
+					"skiphooks": {
+						"name": "skiphooks",
+						"option": "skiphooks",
+						"description": "Skip hook execution. Values: 'pre' (skip beforeExecuting), 'post' (skip onCompleted/onError), 'all' (skip all hooks)",
+						"mandatory": true,
+						"type": "SINGLE",
+						"usage": "\"pre|post|all|none\"",
+						"defaultOption": "none",
+						"disableInIntegrationMode": false
 					}
 				}
 			);

package/src/commands/Command.js

@@ -24,7 +24,8 @@ const NEVER_PARAMS = {
 	'NOCONFIG': 'noconfig',
 	'CUSTOMFLAG': 'customflag',
 	'CUSTOMOPTIONS': 'customoptions',
-	'DEBUG': 'debug'
+	'DEBUG': 'debug',
+	'SKIPHOOKS': 'skiphooks'
 };
 
 /** @type {import('./Command')} */
@@ -71,7 +72,7 @@ class Command {
 
 		const preExec = await this._action.preExecute(execParams);
 
-		this._validateActionParameters(preExec);
+		this._validateActionParameters(preExec, Object.values(NEVER_PARAMS));
 
 		const exec = await this._action.execute(preExec);
 		const actionResult = await this._action.postExecute(exec);
@@ -91,12 +92,19 @@ class Command {
 		})
 	}
 
-	_validateActionParameters(params) {
+	_validateActionParameters(params, ignores=[]) {
 		const commandOptionsValidator = new CommandOptionsValidator();
-		const validationErrors = commandOptionsValidator.validate({
-			commandOptions: this._commandMetadata.options,
-			arguments: params,
-		});
+
+		// remove NEVER_PARAMS from this validation as they don't get passed down to the exec layer
+		const options = ignores.reduce((acc,ignore)=> {
+			 delete acc.commandOptions[ignore];
+			 return acc;
+		},{
+				commandOptions: this._commandMetadata.options,
+					arguments: params,
+			}
+		);
+		const validationErrors = commandOptionsValidator.validate(options);
 		if (validationErrors.length > 0) {
 			throwValidationException(validationErrors, this._runInInteractiveMode, this._commandMetadata);
 		}

package/src/core/CommandActionExecutor.js

@@ -52,6 +52,7 @@ module.exports = class CommandActionExecutor {
 		let commandUserExtension;
 		const commandName = context.commandName;
 		const debugFilePath = this._getDebugFilePath(context.arguments.debug, commandName);
+		const skipHooks = context.arguments.skiphooks;
 		try {
 			const commandMetadata = this._commandsMetadataService.getCommandMetadataByName(commandName);
 			if (context.arguments.config) {
@@ -68,6 +69,7 @@ module.exports = class CommandActionExecutor {
 			const runInInteractiveMode = context.runInInteractiveMode;
 			const commandArguments = this._extractOptionValuesFromArguments(commandMetadata.options, context.arguments);
 
+
 			// need the
 			const projectFolder = this._cliConfigurationService.getProjectFolder(commandName, commandArguments?.project);
 			const projectPath = this._cliConfigurationService.getProjectPath(projectFolder);
@@ -144,9 +146,12 @@ module.exports = class CommandActionExecutor {
 			process.env[ENV_VARS.SUITECLOUD_PROJECT_ROOT] = this._executionPath;
 			// this might modified but we need the user's hooks to take advantage of their current values
 			process.env[ENV_VARS.SUITECLOUD_AUTHID] = authId;
-			this._dumpDebugFile(debugFilePath, undefined, 'FIRST');
-			this._dumpDebugFile(debugFilePath, 'beforeExecuting', beforeExecutingOptions, runInInteractiveMode);
-			const beforeExecutingOutput = await commandUserExtension.beforeExecuting(beforeExecutingOptions);
+			const skipPre = skipHooks === 'pre' || skipHooks === 'all';
+			this._dumpDebugFile(debugFilePath, undefined, 'FIRST', runInInteractiveMode, skipPre);
+			this._dumpDebugFile(debugFilePath, 'beforeExecuting', beforeExecutingOptions, runInInteractiveMode, skipPre);
+			const beforeExecutingOutput = skipPre
+				? { arguments: beforeExecutingOptions.arguments }
+				: await commandUserExtension.beforeExecuting(beforeExecutingOptions);
 			const overriddenArguments = beforeExecutingOutput.arguments;
 
 			// do not allow this argument to be overwritten (i.e. change it back)
@@ -156,7 +161,7 @@ module.exports = class CommandActionExecutor {
 			// update the authid as well (not recommended but possible) -- should this be in the isSetupRequired check?
 			// EXPERIMENTAL: ALLOW UPDATE OF THE AUTHID AT THIS TIME
 			if (commandMetadata.isSetupRequired)
-				authId = beforeExecutingOutput?.arguments?.authid || authId;
+				authId = beforeExecutingOutput?.['arguments']?.authid || authId;
 
 			if (commandMetadata.isSetupRequired && !context.arguments[AUTHORIZATION_PROPERTIES_KEYS.SKIP_AUHTORIZATION_CHECK]) {
 				// check if reauthz is needed to show proper message before continuing with the execution
@@ -173,6 +178,7 @@ module.exports = class CommandActionExecutor {
 			// command execution
 			// src/commands/Command.js, run(inputParams) => execution flow for all commands
 			const actionResult = await command.run(overriddenArguments);
+			const skipPost = skipHooks === 'post' || skipHooks === 'all';
 
 			if (context.runInInteractiveMode) {
 				// generate non-interactive equivalent
@@ -182,22 +188,23 @@ module.exports = class CommandActionExecutor {
 
 			if (actionResult.isSuccess() && commandUserExtension.onCompleted) {
 				// run onCompleted(output) from suitecloud.config.js
-				this._dumpDebugFile(debugFilePath, 'onCompleted', actionResult, runInInteractiveMode);
-				commandUserExtension.onCompleted(actionResult);
+				this._dumpDebugFile(debugFilePath, 'onCompleted', actionResult, runInInteractiveMode, skipPost);
+				if (!skipPost) commandUserExtension.onCompleted(actionResult);
 			} else if (!actionResult.isSuccess() && commandUserExtension.onError) {
 				// run onError(error) from suitecloud.config.js
 				const errorData = ActionResultUtils.getErrorMessagesString(actionResult);
-				this._dumpDebugFile(debugFilePath, 'onError', errorData, runInInteractiveMode);
-				commandUserExtension.onError(errorData);
+				this._dumpDebugFile(debugFilePath, 'onError', errorData, runInInteractiveMode, skipPost);
+				if (!skipPost) commandUserExtension.onError(errorData);
 			}
 			return actionResult;
 
 		} catch (error) {
 			let errorMessage = this._logGenericError(error);
+			const skipPostHooksCatch = skipHooks === 'post' || skipHooks === 'all';
 			if (commandUserExtension && commandUserExtension.onError) {
 				// run onError(error) from suitecloud.config.js
-				this._dumpDebugFile(debugFilePath, 'onError', error, context.runInInteractiveMode);
-				commandUserExtension.onError(error);
+				this._dumpDebugFile(debugFilePath, 'onError', error, context.runInInteractiveMode, skipPostHooksCatch);
+				if (!skipPostHooksCatch) commandUserExtension.onError(error);
 			}
 			return ActionResult.Builder.withErrors(Array.isArray(errorMessage) ? errorMessage : [errorMessage]).build();
 		}
@@ -245,8 +252,19 @@ module.exports = class CommandActionExecutor {
 	_extractOptionValuesFromArguments(options, args) {
 		const optionValues = {};
 		for (const optionId in options) {
-			if (options.hasOwnProperty(optionId) && args.hasOwnProperty(optionId)) {
-				optionValues[optionId] = args[optionId];
+			const optionMeta = options[optionId];
+			// apply defaults first
+			if (options.hasOwnProperty(optionId)){
+				if(optionMeta?.mandatory) {
+					if (optionMeta?.type === "FLAG") {
+						optionValues[optionId] = Boolean(optionMeta.defaultOption)
+					} else if(!["undefined"].includes( typeof optionMeta?.defaultOption)){
+						optionValues[optionId] = optionMeta.defaultOption;
+					}
+				}
+			    if(args.hasOwnProperty(optionId)) {
+					optionValues[optionId] = args[optionId];
+				}
 			}
 		}
 
@@ -297,8 +315,7 @@ module.exports = class CommandActionExecutor {
 	_getDebugFilePath(debugDir, commandName) {
 		if (!debugDir) return null;
 		const sanitizedCommandName = commandName.replace(/:/g, '-');
-		const datetime = new Date().toISOString().replace(/[:.]/g, '-');
-		const filename = `${sanitizedCommandName}.${datetime}.json`;
+		const filename = `${sanitizedCommandName}.json`;
 		return path.join(debugDir, filename);
 	}
 
@@ -308,9 +325,10 @@ module.exports = class CommandActionExecutor {
 	 * @param hookName
 	 * @param {'FIRST'|'LAST'|*} data
 	 * @param {boolean} runInInteractiveMode
+	 * @param {boolean} skipped
 	 * @private
 	 */
-	_dumpDebugFile(debugFilePath, hookName, data, runInInteractiveMode = false) {
+	_dumpDebugFile(debugFilePath, hookName, data, runInInteractiveMode = false, skipped=false) {
 		if (!debugFilePath || !data ) return;
 		if (data === 'FIRST') {
 			fs.writeFileSync(debugFilePath, '[]');
@@ -323,9 +341,10 @@ module.exports = class CommandActionExecutor {
 			.forEach(key => { envVars[key] = process.env[key]; });
 		const entry = {
 			hook: hookName,
+			skipped,
 			timestamp: new Date().toISOString(),
 			env: envVars,
-			data: data
+			data: data,
 		};
 
 		// Print to console in interactive mode