Merge pull request #44 from CheckmarxDev/other/benalvo/adding-indicative-error-when-using-proxy

ADO | Add indicative msg to add Checkmarx download domain when request through proxy failed

Author: cx-ben-alvo

CODEOWNERS

@@ -2,4 +2,4 @@
 # Each line is a file pattern followed by one or more owners
 
 # Specify the default owners for the entire repository
-*       @OrShamirCM @AlvoBen @pedrompflopes
+*       @OrShamirCM @AlvoBen @pedrompflopes @miryamfoiferCX

src/main/client/AstClient.ts

@@ -2,6 +2,7 @@ import {logger} from '../wrapper/loggerConfig';
 import * as fs from 'fs';
 import {finished} from 'stream/promises';
 import {Client} from "./Client";
+import {CxError} from "../errors/CxError";
 
 export class AstClient {
     private client: Client;
@@ -20,10 +21,9 @@ export class AstClient {
             logger.info(`Download completed successfully. File saved to: ${outputPath}`);
         } catch (error) {
             logger.error(`Error downloading file from ${url}: ${error.message || error}`);
-            throw error;
+            throw new CxError(error.message || error);
         } finally {
             writer.close();
-            logger.info('Write stream closed.');
         }
     }
 }

src/main/client/HttpClient.ts

@@ -4,6 +4,7 @@ import {Client} from "./Client";
 
 export class HttpClient implements Client {
     private readonly axiosConfig: AxiosRequestConfig;
+    private readonly domainErrMsg = 'Unable to download the CLI from the URL. Try adding the domain: \'download.checkmarx.com\' to your allow list.';
 
     constructor() {
         this.axiosConfig = {
@@ -45,6 +46,9 @@ export class HttpClient implements Client {
             return response;
         } catch (error) {
             logger.error(`Error sending ${method} request to ${url}: ${error.message || error}`);
+            if (this.axiosConfig.proxy!==undefined) {
+                throw new Error(`${this.domainErrMsg} \nError: ${error.message || error}`);
+            }
             throw error;
         }
     }

src/main/errors/CxError.ts

@@ -0,0 +1,6 @@
+export class CxError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = "CxError";
+    }
+}

src/main/osinstaller/CxInstaller.ts

@@ -5,6 +5,7 @@ import * as tar from 'tar';
 import * as unzipper from 'unzipper';
 import {logger} from "../wrapper/loggerConfig";
 import {AstClient} from "../client/AstClient";
+import {CxError} from "../errors/CxError";
 
 const linuxOS = 'linux';
 const macOS = 'darwin';
@@ -41,7 +42,7 @@ export class CxInstaller {
         const platformData = CxInstaller.PLATFORMS[this.platform];
 
         if (!platformData) {
-            throw new Error('Unsupported platform or architecture');
+            throw new CxError('Unsupported platform or architecture');
         }
 
         const architecture = this.getArchitecture();
@@ -103,6 +104,9 @@ export class CxInstaller {
             logger.info('Extracted CLI to:', this.resourceDirPath);
         } catch (error) {
             logger.error('Error during installation:', error);
+            if (error instanceof CxError) {
+                process.exit(1);
+            }
         }
     }