add cliApiService

Author: zeroleak

README-dev.md

@@ -13,7 +13,7 @@ yarn
 ```
 
 ### Start in debug mode
-GUI will look for a local CLI jar in from `DL_PATH_DEV` directory. 
+GUI will look for a local CLI jar in from `DL_PATH_LOCAL` directory. 
 Edit this path for your own needs.
 ```
 cd whirlpool-gui

app/const.js

@@ -1,11 +1,16 @@
-import electron from 'electron';
 import { version } from '../package.json';
 import { computeLogPath, logger } from './utils/logger';
+import { API_MODES, CliApiService } from './mainProcess/cliApiService';
+
+export const IS_DEV = (process.env.NODE_ENV === 'development')
 
 /* shared with mainProcess */
 
-export const API_VERSION = '0.9';
-export const IS_DEVELOP_SNAPSHOT = false;
+//const API_MODE = API_MODES.RELEASE;
+const API_MODE = API_MODES.RELEASE;
+const API_VERSION = '0.9';
+export const cliApiService = new CliApiService(API_MODE, API_VERSION)
+
 export const GUI_VERSION = version;
 
 export const DEFAULT_CLI_LOCAL = true;
@@ -47,12 +52,6 @@ export const TX0_FEE_TARGET = {
 
 export const STORE_CLILOCAL = 'cli.local';
 
-const app = electron.app || electron.remote.app;
-
-export const IS_DEV = (process.env.NODE_ENV === 'development')
-const DL_PATH_DEV = '/zl/workspaces/whirlpool/whirlpool-client-cli4/target/'
-export const DL_PATH = IS_DEV ? DL_PATH_DEV : app.getPath('userData');
-
 export const CLI_LOG_FILE = computeLogPath('whirlpool-cli.log');
 export const CLI_LOG_ERROR_FILE = computeLogPath('whirlpool-cli.error.log');
 export const GUI_LOG_FILE = logger.getFile();

app/containers/App.js

@@ -36,7 +36,7 @@ import StatusPage from './StatusPage';
 import LoginPage from './LoginPage';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 import { cliLocalService } from '../services/cliLocalService';
-import { API_VERSION, GUI_VERSION } from '../const';
+import { cliApiService, GUI_VERSION } from '../const';
 import * as Icons from '@fortawesome/free-solid-svg-icons';
 import PoolsPage from './PoolsPage';
 import guiService from '../services/guiService';
@@ -120,7 +120,7 @@ class App extends React.Component<Props> {
     const cliLocalStatusIcon = cliService.isCliLocal() ? cliLocalService.getStatusIcon((icon,text)=>icon) : undefined
     const cliStatusIcon = cliService.getStatusIcon((icon,text)=>icon)
     const loginLogoutIcon = cliService.getLoginStatusIcon((icon,text)=>icon)
-    const cliInfo = cliService.isCliLocal() ? 'CLI '+cliLocalService.getCliVersionStr():'CLI_API '+API_VERSION
+    const cliInfo = cliService.isCliLocal() ? 'CLI '+cliLocalService.getCliVersionStr():'CLI_API '+cliApiService.getVersionName()
     const torIcon = cliService.isConnected() && cliService.getTorProgressIcon() ? <span className='icon'>{cliService.getTorProgressIcon()}</span> : undefined
     const dojoIcon = cliService.isConnected() && cliService.getDojoIcon() ? <span className='icon'>{cliService.getDojoIcon()}</span> : undefined
 

app/containers/StatusPage.js

@@ -4,11 +4,9 @@ import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 import { cliLocalService } from '../services/cliLocalService';
 import cliService from '../services/cliService';
 import {
-  API_VERSION,
   CLI_CONFIG_FILENAME,
   CLI_LOG_ERROR_FILE,
-  CLI_LOG_FILE,
-  DL_PATH,
+  CLI_LOG_FILE, cliApiService,
   GUI_LOG_FILE,
   GUI_VERSION
 } from '../const';
@@ -66,7 +64,7 @@ export default class StatusPage extends Component<Props> {
                   </div>
                   <div className='col-sm-10'>
                     <div><LinkExternal href={'file://'+this.guiLogFile}>{this.guiLogFile}</LinkExternal></div>
-                    <div>GUI <strong>{GUI_VERSION}</strong>, CLI API <strong>{API_VERSION}</strong></div>
+                    <div>GUI <strong>{GUI_VERSION}</strong>, CLI API <strong>{cliApiService.getVersionName()}</strong></div>
                   </div>
                 </div>
               </Card.Body>
@@ -124,11 +122,11 @@ export default class StatusPage extends Component<Props> {
                 {cliLocalService.hasCliApi() && <strong>Version:<br/></strong>}<br/>
               </div>
               <div className='col-sm-10'>
-                <LinkExternal href={'file://'+DL_PATH}>{DL_PATH}</LinkExternal><br/>
-                <LinkExternal href={'file://'+DL_PATH+CLI_CONFIG_FILENAME}>{CLI_CONFIG_FILENAME}</LinkExternal><br/>
+                <LinkExternal href={'file://'+cliApiService.getDownloadPath()}>{cliApiService.getDownloadPath()}</LinkExternal><br/>
+                <LinkExternal href={'file://'+cliApiService.getDownloadPath()+CLI_CONFIG_FILENAME}>{CLI_CONFIG_FILENAME}</LinkExternal><br/>
                 {cliLocalService.hasCliApi() && <div>{cliLocalService.getCliFilename()} ({cliLocalService.getCliChecksum()})</div>}
                 {cliLocalService.hasCliApi() && <div>{cliLocalService.getCliVersionStr()}</div>}
-                {!cliLocalService.hasCliApi() && <div><strong>CLI_API {API_VERSION} could not be resolved</strong><br/></div>}
+                {!cliLocalService.hasCliApi() && <div><strong>CLI_API {cliApiService.getVersionName()} could not be resolved</strong><br/></div>}
               </div>
             </div>
             <div className='row'>

app/mainProcess/cliApiService.js

@@ -0,0 +1,87 @@
+import { IS_DEV } from '../const';
+import electron from "electron";
+import cliVersion from './cliVersion';
+import { logger } from '../utils/logger';
+
+export const API_MODES = {
+  RELEASE: 'RELEASE',
+  LOCAL: 'LOCAL',
+  QA: 'QA'
+}
+const DL_PATH_LOCAL = '/zl/workspaces/whirlpool/whirlpool-client-cli4/target/'
+
+export class CliApiService {
+  constructor (apiMode, apiVersion) {
+    if (IS_DEV) {
+      // use local jar when started with "yarn dev"
+      apiMode = API_MODES.LOCAL
+    }
+    this.apiMode = apiMode
+    this.apiVersion = apiVersion
+    logger.info('Initializing CliApiService: '+this.getVersionName())
+  }
+
+  getApiMode() {
+    return this.apiMode
+  }
+
+  getApiVersion() {
+    return this.apiVersion
+  }
+
+  isApiModeRelease() {
+    return this.apiMode === API_MODES.RELEASE
+  }
+
+  isApiModeLocal() {
+    return this.apiMode === API_MODES.LOCAL
+  }
+
+  useChecksum() {
+    // skip checksum verification when started with "yarn dev"
+    return !IS_DEV
+  }
+
+  getDownloadPath() {
+    if (this.isApiModeLocal()) {
+      return DL_PATH_LOCAL
+    }
+    const app = electron.app || electron.remote.app;
+    return app.getPath('userData')
+  }
+
+  async fetchCliApi() {
+    if (this.isApiModeLocal()) {
+      // use local jar
+      return {
+        cliVersion: 'develop-SNAPSHOT',
+        filename: 'whirlpool-client-cli-develop-SNAPSHOT-run.jar',
+        url: false,
+        checksum: false
+      }
+    }
+    const fetchVersion = this.isApiModeRelease() ? this.apiVersion : this.getApiMode()
+    try {
+      let cliApi = await cliVersion.fetchCliApi(fetchVersion)
+      logger.info('Using CLI_API ' + fetchVersion, cliApi)
+      return {
+        cliVersion: cliApi.CLI_VERSION,
+        filename: 'whirlpool-client-cli-' + cliApi.CLI_VERSION + '-run.jar',
+        url: 'https://github.com/Samourai-Wallet/whirlpool-client-cli/releases/download/' + cliApi.CLI_VERSION + '/whirlpool-client-cli-' + cliApi.CLI_VERSION + '-run.jar',
+        checksum: cliApi.CLI_CHECKSUM
+      }
+    } catch(e) {
+      logger.error("Could not fetch CLI_API "+fetchVersion, e)
+      throw e
+    }
+  }
+
+  getVersionName() {
+    let version =  this.apiVersion
+    if (!this.isApiModeRelease()) {
+      version += " ("+this.apiMode+")"
+    }
+    return version
+  }
+
+}

app/mainProcess/cliLocal.js

@@ -1,27 +1,24 @@
 import { download } from 'electron-dl';
 import tcpPortUsed from 'tcp-port-used';
 import fs from 'fs';
-import { spawn, exec } from 'child_process';
+import { exec, spawn } from 'child_process';
 import Store from 'electron-store';
 import AwaitLock from 'await-lock';
 import ps from 'ps-node';
 import {
-  API_VERSION,
   CLI_CONFIG_FILENAME,
   CLI_LOG_ERROR_FILE,
   CLI_LOG_FILE,
+  cliApiService,
   CLILOCAL_STATUS,
   DEFAULT_CLI_LOCAL,
   DEFAULT_CLIPORT,
-  DL_PATH,
-  GUI_LOG_FILE,
   IPC_CLILOCAL,
   IS_DEV,
   STORE_CLILOCAL
 } from '../const';
 import { logger } from '../utils/logger';
 import crypto from 'crypto';
-import cliVersion from './cliVersion';
 
 const START_TIMEOUT = 10000
 const ARG_CLI_GUI = '--whirlpool-cli-gui'
@@ -33,7 +30,7 @@ export class CliLocal {
 
     this.ipcMain = ipcMain
     this.window = window
-    this.dlPath = DL_PATH
+
     this.store = new Store()
     this.ipcMutex = new AwaitLock()
 
@@ -121,7 +118,7 @@ export class CliLocal {
   }
 
   async onDeleteConfig(gotMutex=false) {
-    const cliConfigPath = this.dlPath+'/'+CLI_CONFIG_FILENAME
+    const cliConfigPath = cliApiService.getDownloadPath()+'/'+CLI_CONFIG_FILENAME
     logger.info("CLI deleting local config... "+cliConfigPath)
 
     await this.stop(gotMutex)
@@ -161,6 +158,10 @@ export class CliLocal {
   }
 
   async refreshState(downloadIfMissing=true, gotMutex=false) {
+    if (cliApiService.isApiModeLocal()) {
+      downloadIfMissing = false
+    }
+
     const javaInstalled = await this.isJavaInstalled()
     if (!javaInstalled) {
       this.state.valid = false
@@ -171,18 +172,11 @@ export class CliLocal {
     }
 
     try {
-      const cliApi = await cliVersion.fetchCliApi(API_VERSION)
-      logger.info('using CLI_API ' + API_VERSION, cliApi)
-      this.state.cliApi = {
-        cliVersion: cliApi.CLI_VERSION,
-        filename: 'whirlpool-client-cli-' + cliApi.CLI_VERSION + '-run.jar',
-        url: 'https://github.com/Samourai-Wallet/whirlpool-client-cli/releases/download/' + cliApi.CLI_VERSION + '/whirlpool-client-cli-' + cliApi.CLI_VERSION + '-run.jar',
-        checksum: cliApi.CLI_CHECKSUM
-      }
+      this.state.cliApi = await cliApiService.fetchCliApi()
     } catch(e) {
-      logger.error("Could not fetch CLI_API "+API_VERSION, e)
+      logger.error("Could not fetch CLI_API", e)
       this.state.valid = false
-      this.state.error = 'Could not fetch CLI_API '+API_VERSION
+      this.state.error = 'Could not fetch CLI_API'
       this.updateState(CLILOCAL_STATUS.ERROR)
       await this.stop(gotMutex)
       return
@@ -233,7 +227,7 @@ export class CliLocal {
   async isJavaInstalled() {
     try {
       const result = await this.execPromise('java -version')
-      console.log("[CLI_LOCAL] java seems installed: "+result)
+      console.log("[CLI_LOCAL] java seems installed. "+result)
       return true
     } catch (e) {
       console.error("[CLI_LOCAL] java is NOT installed: "+e.message)
@@ -278,7 +272,7 @@ export class CliLocal {
           if (IS_DEV) {
             args.push('--debug-client')
           }
-          myThis.startProc(cmd, args, myThis.dlPath, CLI_LOG_FILE, CLI_LOG_ERROR_FILE)
+          myThis.startProc(cmd, args, cliApiService.getDownloadPath(), CLI_LOG_FILE, CLI_LOG_ERROR_FILE)
         }, (e) => {
           // port in use => cannot start proc
           logger.error("[CLI_LOCAL] cannot start: port "+DEFAULT_CLIPORT+" already in use")
@@ -444,15 +438,15 @@ export class CliLocal {
   }
 
   async verifyChecksum() {
-    const dlPathFile = this.dlPath+'/'+this.getCliFilename()
+    const dlPathFile = cliApiService.getDownloadPath()+'/'+this.getCliFilename()
     const expectedChecksum = this.getCliChecksum()
     try {
       const checksum = await this.sha256File(dlPathFile)
       if (!checksum) {
         logger.error('CLI not found: '+dlPathFile)
         return false;
       }
-      if (!IS_DEV && checksum !== expectedChecksum) {
+      if (cliApiService.useChecksum() && checksum !== expectedChecksum) {
         logger.error('CLI is invalid: '+dlPathFile+', '+checksum+' vs '+expectedChecksum)
         return false;
       }
@@ -466,7 +460,7 @@ export class CliLocal {
 
   async download(url) {
     // delete existing file if any
-    const dlPathFile = this.dlPath+'/'+this.getCliFilename()
+    const dlPathFile = cliApiService.getDownloadPath()+'/'+this.getCliFilename()
     if (fs.existsSync(dlPathFile)) {
       logger.verbose('CLI overwriting '+dlPathFile)
       try {
@@ -485,7 +479,7 @@ export class CliLocal {
       this.updateState(CLILOCAL_STATUS.DOWNLOADING)
     }
     logger.info('CLI downloading: '+url)
-    return download(this.window, url, {directory: this.dlPath, onProgress: onProgress.bind(this)})
+    return download(this.window, url, {directory: cliApiService.getDownloadPath(), onProgress: onProgress.bind(this)})
   }
 
   updateState(status) {

app/mainProcess/cliVersion.js

@@ -1,5 +1,5 @@
 import fetch from 'node-fetch';
-import { IS_DEV, IS_DEVELOP_SNAPSHOT, VERSIONS_URL } from '../const';
+import { VERSIONS_URL } from '../const';
 
 class CliVersion {
 
@@ -12,16 +12,6 @@ class CliVersion {
   }
 
   fetchCliApi(cliApi) {
-    if (IS_DEV) {
-      // mock for DEV
-      return {
-        CLI_VERSION: 'develop-SNAPSHOT',
-        CLI_CHECKSUM: 'dev'
-      }
-    }
-    if (IS_DEVELOP_SNAPSHOT) {
-      cliApi = 'develop-SNAPSHOT'
-    }
     return this.fetchVersions().then(json => {
       console.log('cliVersions',json)
       return json.CLI_API[cliApi]

app/services/backendService.js

@@ -1,7 +1,7 @@
 import utils from './utils';
 import status from './status';
 import cliService from './cliService';
-import { API_VERSION, VERSIONS_URL } from '../const';
+import { cliApiService, VERSIONS_URL } from '../const';
 
 const HEADER_API_VERSION = 'apiVersion'
 const HEADER_API_KEY = 'apiKey'
@@ -19,7 +19,7 @@ class BackendService {
     const headers = {
       'Content-Type': 'application/json'
     }
-    headers[HEADER_API_VERSION] = API_VERSION
+    headers[HEADER_API_VERSION] = cliApiService.getApiVersion()
 
     if (apiKey === undefined) {
       apiKey = cliService.getApiKey()
@@ -177,7 +177,7 @@ class BackendService {
           const headers = {
             cache: "no-store"
           }
-          return utils.fetch(VERSIONS_URL, { method: 'GET', headers: headers }, true)
+          return utils.fetch(VERSIONS_URL, { method: 'GET', headers: headers, cache: "no-store" }, true)
         },
         'gui.versions', true
       )