improve release train error messages (axonivy#782)

Author: ivy-lmu

extension/src/engine/engine-manager.ts

@@ -57,7 +57,7 @@ export class IvyEngineManager {
     const releaseTrainValidator = new ReleaseTrainValidator(extensionVersion);
     const validationResult = await releaseTrainValidator.validate(releaseTrain);
     if (!validationResult.valid) {
-      return this.handleInvalidReleaseTrain(releaseTrain, validationResult.reason);
+      return this.handleInvalidReleaseTrain(validationResult.reason);
     }
     if (validationResult.isDirectory) {
       return releaseTrain;
@@ -76,9 +76,10 @@ export class IvyEngineManager {
     vscode.window.showErrorMessage(`Downloaded engine is invalid: ${newEngineDir}`);
   }
 
-  private async handleInvalidReleaseTrain(releaseTrain: string, reason?: string) {
-    outputChannel.appendLine(`Engine release train validation failed: ${reason}`);
-    const newTrain = await switchEngineReleaseTrain(`Provided engine release train is invalid: '${reason}'`);
+  private async handleInvalidReleaseTrain(reason?: string) {
+    const errorMessage = `Engine release train validation failed: ${reason}`;
+    outputChannel.appendLine(errorMessage);
+    const newTrain = await switchEngineReleaseTrain(errorMessage);
     if (!newTrain) {
       return vscode.window.showErrorMessage('No engine release train selected.');
     }

extension/src/engine/engine-release-train.ts

@@ -40,9 +40,9 @@ export const switchEngineReleaseTrain = async (reason?: string) => {
       validateInput: async (value: string) => {
         const result = await releaseTrainValidator.validate(value);
         if (result.valid) {
-          return undefined;
+          return;
         }
-        return result.isDirectory && result.reason ? result.reason : 'Invalid release train tag';
+        return result.reason ?? 'Invalid release train tag';
       },
       ignoreFocusOut: true
     });

extension/src/engine/release-train-validator.test.ts

@@ -44,8 +44,7 @@ test('wrong patch', async () => {
 test('invalid when engine directory is does not exist', async () => {
   expect(await validator.validate('path/to/nowhere')).toEqual({
     valid: false,
-    isDirectory: false,
-    reason: "Failed to determine engine version, directory does not exist 'path/to/nowhere/system/plugins'."
+    reason: "Invalid release train tag or engine directory 'path/to/nowhere'"
   });
 });
 
@@ -61,8 +60,7 @@ test('preview train', async () => {
 
   expect(await validator.validate('Dev')).toEqual({
     valid: false,
-    isDirectory: false,
-    reason: "Failed to determine engine version, directory does not exist 'Dev/system/plugins'."
+    reason: "Invalid release train tag or engine directory 'Dev'"
   });
   expect((await validator.validate('13')).valid).toBeFalsy();
   expect((await validator.validate('13.2')).valid).toBeFalsy();
@@ -78,8 +76,7 @@ test('lts train', async () => {
 
   expect(await customValidator.validate('14.b')).toEqual({
     valid: false,
-    isDirectory: false,
-    reason: "Failed to determine engine version, directory does not exist '14.b/system/plugins'."
+    reason: "Invalid release train tag or engine directory '14.b'"
   });
   expect((await customValidator.validate('14.0')).valid).toBeFalsy();
   expect((await customValidator.validate('14.0.0.')).valid).toBeFalsy();

extension/src/engine/release-train-validator.ts

@@ -18,8 +18,7 @@ export class ReleaseTrainValidator {
     if (this.isValidReleaseTrainTag(releaseTrain)) {
       return { valid: true };
     }
-    const result = await this.isValidEngineDir(releaseTrain);
-    return { isDirectory: result.valid, ...result };
+    return await this.isValidEngineDir(releaseTrain);
   };
 
   private isDirectory = (engineDir: string) => {
@@ -33,7 +32,7 @@ export class ReleaseTrainValidator {
   public isValidEngineDir = async (engineDir: string) => {
     const pluginsDir = path.join(engineDir, 'system', 'plugins');
     if (!this.isDirectory(pluginsDir)) {
-      return { valid: false, reason: `Failed to determine engine version, directory does not exist '${pluginsDir}'.` };
+      return { valid: false, reason: `Invalid release train tag or engine directory '${engineDir}'` };
     }
     const isDirectory = true;
     const utilBundleFileName = await fs.promises