[DDW-780] Daedalus start impovement (#2716)

* [DDW-780] Added more checks before restarting cardano-node

* [DDW-780] Added new entry in CHANGELOG

* [DDW-780] Unused file

* [DDW-780] Added try/catch on restart

* [DDW-780] Extend the node exit/kill/update timeouts to 5 mins

* [DDW-780] Fixed cardanoNode restart if diskspace problems happens at the first time

* [DDW-780] Added code review suggestions

* [DDW-780] Code refactoring

* [DDW-780] Increase kill node timeout

* [DDW-780] DISK_SPACE_REQUIRED back to original value

* [DDW-780] Removed unused code

* [DDW-780] handling errors like other places

* [DDW-780] Refactoring

* [DDW-780] Fix CardanoNode start

* [DDW-780] Rebuilds menus after start-recovery

* [DDW-780] Refactoring of logic depending on the situation

* [DDW-780] Fix condition

* [DDW-780] Added logs

* [DDW-780] Fixed first cardano-node start

* [DDW-780] Reorder menu build handlers

* [DDW-780] removed logs

* [DDW-780] removed more logs

* [DDW-780] fixed prettier errors

* [DDW-780] Fix state dir path channel

Co-authored-by: Nikola Glumac <[email protected]>
Co-authored-by: Daniel Main <[email protected]>

Author: 3 people

.nonsense

@@ -3,6 +3,7 @@
 ## vNext
 
 ### Features
+
 - Implemented "Catalyst Fund7" voting registration changes ([PR 2732](https://github.com/input-output-hk/daedalus/pull/2732))
 - Added Over-saturation warning in delegation wizard ([PR 2733](https://github.com/input-output-hk/daedalus/pull/2733))
 - Added Catalyst footer links ([PR 2721](https://github.com/input-output-hk/daedalus/pull/2721))
@@ -18,6 +19,7 @@
 
 ### Chores
 
+- Improves the Daedalus startup by avoiding unnecessary cardano-node restarts ([PR 2716](https://github.com/input-output-hk/daedalus/pull/2716))
 - Updated `cardano-launcher` to version `0.20211105.1` and added Cardano Node RTS flags which improve resource usage ([PR 2734](https://github.com/input-output-hk/daedalus/pull/2734))
 - Updated README with solution steps for the nix SSL issue ([PR 2727](https://github.com/input-output-hk/daedalus/pull/2727))
 - Covered LedgerJS v4.0.0 breaking changes ([PR 2697](https://github.com/input-output-hk/daedalus/pull/2697))

CHANGELOG.md

@@ -5,4 +5,5 @@ export type CheckDiskSpaceResponse = {
   diskSpaceMissing: string,
   diskSpaceRecommended: string,
   diskSpaceAvailable: string,
+  hadNotEnoughSpaceLeft: boolean,
 };

source/common/types/no-disk-space.types.js

@@ -240,11 +240,18 @@ export class CardanoNode {
    * @param log
    * @param actions
    * @param transitions
+   * @param config {CardanoNodeConfig}
    */
-  constructor(log: Logger, actions: Actions, transitions: StateTransitions) {
+  constructor(
+    log: Logger,
+    actions: Actions,
+    transitions: StateTransitions,
+    config: CardanoNodeConfig
+  ) {
     this._log = log;
     this._actions = actions;
     this._transitionListeners = transitions;
+    this._config = config;
   }
 
   /**
@@ -254,14 +261,10 @@ export class CardanoNode {
    * Asks the node to reply with the current port.
    * Transitions into STARTING state.
    *
-   * @param config {CardanoNodeConfig}
    * @param isForced {boolean}
    * @returns {Promise<void>} resolves if the node could be started, rejects with error otherwise.
    */
-  start = async (
-    config: CardanoNodeConfig,
-    isForced: boolean = false
-  ): Promise<void> => {
+  start = async (isForced: boolean = false): Promise<void> => {
     const { _log } = this;
 
     // Guards
@@ -273,29 +276,13 @@ export class CardanoNode {
       });
       return Promise.reject(new Error('CardanoNode: Cannot be started'));
     }
-    if (this._isUnrecoverable(config) && !isForced) {
+    if (this._isUnrecoverable(this._config) && !isForced) {
       _log.error('CardanoNode#start: Too many startup retries', {
         startupTries: this._startupTries,
       });
       return Promise.reject(new Error('CardanoNode: Too many startup retries'));
     }
 
-    // Setup
-    const {
-      // startupTimeout,
-      nodeConfig,
-      stateDir,
-      cluster,
-      tlsPath,
-      configPath,
-      syncTolerance,
-      cliBin,
-      isStaging,
-      metadataUrl,
-    } = config;
-
-    this._config = config;
-
     this._startupTries++;
     this._changeToState(CardanoNodeStates.STARTING);
     _log.info(
@@ -313,7 +300,7 @@ export class CardanoNode {
         },
         {
           size: '5M',
-          path: config.logFilePath,
+          path: this._config.logFilePath,
           maxFiles: 4,
         }
       );
@@ -328,7 +315,7 @@ export class CardanoNode {
         },
         {
           size: '5M',
-          path: config.logFilePath,
+          path: this._config.logFilePath,
           maxFiles: 4,
         }
       );
@@ -356,7 +343,7 @@ export class CardanoNode {
             { error }
           );
           const { code, signal } = error || {};
-          this._handleCardanoNodeError(code, signal);
+          await this._handleCardanoNodeError(code, signal);
           reject(
             new Error(
               'CardanoNode#start: Unable to initialize cardano-launcher'
@@ -366,18 +353,10 @@ export class CardanoNode {
       } else {
         try {
           const node = await CardanoWalletLauncher({
+            ...this._config,
             nodeImplementation,
-            nodeConfig,
-            cluster,
-            stateDir,
-            tlsPath,
-            configPath,
-            syncTolerance,
             nodeLogFile,
             walletLogFile,
-            cliBin,
-            isStaging,
-            metadataUrl,
           });
 
           this._node = node;
@@ -424,15 +403,15 @@ export class CardanoNode {
               });
               resolve();
             })
-            .catch((exitStatus) => {
+            .catch(async (exitStatus) => {
               _log.error(
                 'CardanoNode#start: Error while spawning cardano-node',
                 {
                   exitStatus,
                 }
               );
               const { code, signal } = exitStatus.wallet || {};
-              this._handleCardanoNodeError(code, signal);
+              await this._handleCardanoNodeError(code, signal);
               reject(
                 new Error(
                   'CardanoNode#start: Error while spawning cardano-node'
@@ -447,7 +426,7 @@ export class CardanoNode {
             }
           );
           const { code, signal } = error || {};
-          this._handleCardanoNodeError(code, signal);
+          await this._handleCardanoNodeError(code, signal);
           reject(
             new Error(
               'CardanoNode#start: Unable to initialize cardano-launcher'
@@ -477,6 +456,7 @@ export class CardanoNode {
       if (_node) await _node.stop(_config.shutdownTimeout / 1000);
       await this._waitForNodeProcessToExit(_config.shutdownTimeout);
       await this._storeProcessStates();
+      this._changeToState(CardanoNodeStates.STOPPED);
       this._reset();
       return Promise.resolve();
     } catch (error) {
@@ -529,7 +509,7 @@ export class CardanoNode {
    * @returns {Promise<void>} resolves if the node could be restarted, rejects with error otherwise.
    */
   async restart(isForced: boolean = false): Promise<void> {
-    const { _log, _config } = this;
+    const { _log } = this;
     try {
       // Stop cardano nicely if it is still awake
       if (this._isConnected()) {
@@ -546,14 +526,13 @@ export class CardanoNode {
         });
         safeExitWithCode(0);
       } else {
-        await this.start(_config, isForced);
+        await this.start(isForced);
       }
     } catch (error) {
-      _log.error('CardanoNode#restart: Could not restart cardano-node', {
-        error,
-      });
+      _log.error('CardanoNode#restart: Could not restart cardano-node', error);
       if (this._state !== CardanoNodeStates.UNRECOVERABLE) {
-        this._changeToState(CardanoNodeStates.ERRORED);
+        const { code, signal } = error || {};
+        this._changeToState(CardanoNodeStates.ERRORED, code, signal);
       }
       return Promise.reject(error);
     }
@@ -706,7 +685,12 @@ export class CardanoNode {
     } else {
       this._changeToState(CardanoNodeStates.ERRORED);
       this._transitionListeners.onError(code, signal);
-      await this.restart();
+      try {
+        _log.info('CardanoNode: restarting');
+        await this.restart();
+      } catch (error) {
+        _log.error('CardanoNode: cannot be restarted', error);
+      }
     }
   };
 
@@ -780,6 +764,8 @@ export class CardanoNode {
         return _transitionListeners.onUpdated();
       case CardanoNodeStates.CRASHED:
         return _transitionListeners.onCrashed(...args);
+      case CardanoNodeStates.ERRORED:
+        return _transitionListeners.onError(...args);
       case CardanoNodeStates.UNRECOVERABLE:
         return _transitionListeners.onUnrecoverable();
       default:

source/main/cardano/CardanoNode.js

@@ -34,10 +34,25 @@ import {
 } from '../ipc/cardano.ipc';
 import { safeExitWithCode } from '../utils/safeExitWithCode';
 
-const startCardanoNode = (
-  node: CardanoNode,
-  launcherConfig: LauncherConfig
-) => {
+const restartCardanoNode = async (node: CardanoNode) => {
+  try {
+    await node.restart();
+  } catch (error) {
+    logger.error('Could not restart CardanoNode', { error });
+  }
+};
+
+/**
+ * Configures, starts and manages the CardanoNode responding to node
+ * state changes, app events and IPC messages coming from the renderer.
+ *
+ * @param launcherConfig {LauncherConfig}
+ * @param mainWindow
+ */
+export const setupCardanoNode = (
+  launcherConfig: LauncherConfig,
+  mainWindow: BrowserWindow
+): CardanoNode => {
   const {
     logsPrefix,
     nodeImplementation,
@@ -70,28 +85,7 @@ const startCardanoNode = (
     killTimeout: NODE_KILL_TIMEOUT,
     updateTimeout: NODE_UPDATE_TIMEOUT,
   };
-  return node.start(config);
-};
-
-const restartCardanoNode = async (node: CardanoNode) => {
-  try {
-    await node.restart();
-  } catch (error) {
-    logger.error('Could not restart CardanoNode', { error });
-  }
-};
 
-/**
- * Configures, starts and manages the CardanoNode responding to node
- * state changes, app events and IPC messages coming from the renderer.
- *
- * @param launcherConfig {LauncherConfig}
- * @param mainWindow
- */
-export const setupCardanoNode = (
-  launcherConfig: LauncherConfig,
-  mainWindow: BrowserWindow
-): CardanoNode => {
   const cardanoNode = new CardanoNode(
     logger,
     {
@@ -100,9 +94,9 @@ export const setupCardanoNode = (
       exec,
       readFileSync,
       createWriteStream,
-      broadcastTlsConfig: (config: ?TlsConfig) => {
+      broadcastTlsConfig: (tlsConfig: ?TlsConfig) => {
         if (!mainWindow.isDestroyed())
-          cardanoTlsConfigChannel.send(config, mainWindow);
+          cardanoTlsConfigChannel.send(tlsConfig, mainWindow);
       },
       broadcastStateChange: (state: CardanoNodeState) => {
         if (!mainWindow.isDestroyed())
@@ -127,11 +121,10 @@ export const setupCardanoNode = (
       },
       onError: () => {},
       onUnrecoverable: () => {},
-    }
+    },
+    config
   );
 
-  startCardanoNode(cardanoNode, launcherConfig);
-
   getCachedCardanoStatusChannel.onRequest(() => {
     logger.info('ipcMain: Received request from renderer for cardano status', {
       status: cardanoNode.status,

source/main/cardano/setup.js

@@ -154,9 +154,9 @@ export const MAX_LAUNCHER_LOGS_ALLOWED = 3;
 // CardanoNode config
 export const NODE_STARTUP_TIMEOUT = 5000;
 export const NODE_STARTUP_MAX_RETRIES = 5;
-export const NODE_SHUTDOWN_TIMEOUT = isTest ? 5000 : 10000;
-export const NODE_KILL_TIMEOUT = isTest ? 5000 : 10000;
-export const NODE_UPDATE_TIMEOUT = isTest ? 10000 : 60000;
+export const NODE_SHUTDOWN_TIMEOUT = isTest ? 5000 : 5 * 60 * 1000; // 5 minutes | unit: milliseconds
+export const NODE_KILL_TIMEOUT = isTest ? 5000 : 5 * 60 * 1000; // 5 minutes | unit: milliseconds
+export const NODE_UPDATE_TIMEOUT = isTest ? 10000 : 5 * 60 * 1000; // 5 minutes | unit: milliseconds
 
 export const DISK_SPACE_REQUIRED = 2 * 1073741274; // 2 GB | unit: bytes
 export const DISK_SPACE_REQUIRED_MARGIN_PERCENTAGE = 10; // 10% of the available disk space