Introduce built-in node troubleshooting (#877)

* Add troubleshooting components * Add troubleshooting logic * Update vscode linting settings * Use cjs exports at main process * Update [email protected] * Update gh actions node version@14 * Handle troubleshooting cases * Consider runInternalNode when detecting offline * Drop null exit codes
idena-network · Jan 18, 2023 · df80226 · df80226
1 parent c801083
commit df80226
Show file tree

Hide file tree

Showing 12 changed files with 3,024 additions and 1,690 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -23,7 +23,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 14
 
       - name: Install Linux canvas deps
         if: matrix.os == 'ubuntu-latest'

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,10 +1,29 @@
 {
-  // turn it off for JS and JSX, we will do this via eslint
   "[javascript]": {
-    "editor.formatOnSave": true
+    "editor.formatOnPaste": false,
+    "editor.formatOnSave": false
   },
   "[javascriptreact]": {
-    "editor.formatOnSave": true
+    "editor.formatOnPaste": false,
+    "editor.formatOnSave": false
   },
-  "editor.formatOnSave": true
+  "[typescript]": {
+    "editor.formatOnPaste": false,
+    "editor.formatOnSave": false
+  },
+  "[typescriptreact]": {
+    "editor.formatOnPaste": false,
+    "editor.formatOnSave": false
+  },
+  "editor.formatOnSaveMode": "modificationsIfAvailable",
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  },
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ]
 }
diff --git a/main/idena-node.js b/main/idena-node.js
@@ -10,6 +10,7 @@ const lineReader = require('reverse-line-reader')
 // eslint-disable-next-line import/no-extraneous-dependencies
 const appDataPath = require('./app-data-path')
 const {sleep} = require('./utils')
+const logger = require('./logger')
 
 const idenaBin = 'idena-go'
 const idenaNodeReleasesUrl =
@@ -32,6 +33,8 @@ const getTempNodeFile = () =>
 const getNodeChainDbFolder = () =>
   path.join(getNodeDataDir(), idenaChainDbFolder)
 
+const getNodeIpfsDir = () => path.join(getNodeDataDir(), 'ipfs')
+
 const getNodeLogsFile = () => path.join(getNodeDataDir(), 'logs', 'output.log')
 
 const getNodeErrorFile = () => path.join(getNodeDataDir(), 'logs', 'error.log')
@@ -307,6 +310,23 @@ function getLastLogs() {
   })
 }
 
+async function tryStopNode(node, {onSuccess, onFail}) {
+  try {
+    if (node) {
+      const log = await stopNode(node)
+      logger.info(log)
+      if (onSuccess) {
+        onSuccess()
+      }
+    }
+  } catch (e) {
+    logger.error('error while stopping node', e.toString())
+    if (onFail) {
+      onFail()
+    }
+  }
+}
+
 module.exports = {
   downloadNode,
   getCurrentVersion,
@@ -317,4 +337,8 @@ module.exports = {
   nodeExists,
   cleanNodeState,
   getLastLogs,
+  getNodeFile,
+  getNodeChainDbFolder,
+  getNodeIpfsDir,
+  tryStopNode,
 }
diff --git a/main/index.js b/main/index.js
@@ -53,6 +53,10 @@ const {
   getCurrentVersion,
   cleanNodeState,
   getLastLogs,
+  getNodeChainDbFolder,
+  getNodeFile,
+  getNodeIpfsDir,
+  tryStopNode,
 } = require('./idena-node')
 
 const NodeUpdater = require('./node-updater')
@@ -384,9 +388,9 @@ ipcMain.on(NODE_COMMAND, async (_event, command, data) => {
   switch (command) {
     case 'init-local-node': {
       if (macosVersion.isMacOS && macosVersion.is('<10.15')) {
-        sendMainWindowMsg(NODE_EVENT, 'unsupported-macos-version')
-        return
+        return sendMainWindowMsg(NODE_EVENT, 'unsupported-macos-version')
       }
+
       getCurrentVersion()
         .then(version => {
           sendMainWindowMsg(NODE_EVENT, 'node-ready', version)
@@ -497,6 +501,7 @@ ipcMain.on(NODE_COMMAND, async (_event, command, data) => {
           sendMainWindowMsg(NODE_EVENT, 'node-failed')
           logger.error('error while stopping node', e.toString())
         })
+
       break
     }
     case 'get-last-logs': {
@@ -509,6 +514,66 @@ ipcMain.on(NODE_COMMAND, async (_event, command, data) => {
         })
       break
     }
+
+    case 'troubleshooting-restart-node': {
+      await tryStopNode(node, {
+        onSuccess() {
+          node = null
+        },
+      })
+
+      return sendMainWindowMsg(NODE_EVENT, 'troubleshooting-restart-node')
+    }
+
+    case 'troubleshooting-update-node': {
+      if (nodeDownloadPromise) return
+
+      await tryStopNode(node, {
+        onSuccess() {
+          node = null
+        },
+      })
+
+      sendMainWindowMsg(NODE_EVENT, 'troubleshooting-update-node')
+
+      nodeDownloadPromise = downloadNode(info => {
+        sendMainWindowMsg(AUTO_UPDATE_EVENT, 'node-download-progress', info)
+      })
+        .then(async () => {
+          await updateNode()
+          sendMainWindowMsg(NODE_EVENT, 'node-ready')
+        })
+        .catch(err => {
+          sendMainWindowMsg(NODE_EVENT, 'node-failed')
+          logger.error('error while downloading node', err.toString())
+        })
+        .finally(() => {
+          nodeDownloadPromise = null
+        })
+
+      break
+    }
+
+    case 'troubleshooting-reset-node': {
+      await tryStopNode(node, {
+        onSuccess() {
+          node = null
+        },
+      })
+
+      try {
+        await fs.remove(getNodeFile())
+        await fs.remove(getNodeChainDbFolder())
+        await fs.remove(getNodeIpfsDir())
+
+        sendMainWindowMsg(NODE_EVENT, 'troubleshooting-reset-node')
+      } catch (e) {
+        logger.error('error deleting idenachain.db', e.toString())
+        sendMainWindowMsg(NODE_EVENT, 'node-failed')
+      }
+
+      break
+    }
     default:
   }
 })