fix: node stability improvements & design fixes (#663)

* optimized node status updating for start/stop

* improved status handling, added stopping status

* added starting status to signify starting but before pulling podman images

* if user stops all services, stop node package too

* added lowPeerCount, synchronized

* added noConnection logic

* updated sidebar item to handle updated node status

* fixed bug where starting/stopping second node with same name, affected the first node

* fix status for sidebar

* fixed node version retrieval

* continuously retrieve version, show empty string when stopped

* added CL check

* removed query node version, added CL check for sync status

* added updateNodePackage to mark nodePackage after successful initial sync

* refactored state for node package

* made similar refactoring to node screen

* refactored sidebarNodeItemWrapper

* added context, and hooks to centralize queries in one place

* added getSyncData

* const consistency

* changed consts, fixed client card status

* fixed client card styling

* added url param for remote execution

* block scoped, more strict sync

* added removing node state

* added support for slots from consensus

* node status fix

* fixed synchronized state for client card

* fixed sync progress, prepare to move complex sync logic into getSyncData

* fixed synced client card, apply same complex isSyncing logic check for individual nodes

* improved sync logic

* improved sync logic

* added percent to progress bar on clientcard

* support non-ethereum clients

* fixed lastRunningTimestampMs

* math floor for %

* stronger nodescreen latest synced block logic

* prioritize synchornized over running for node screen

* added same syncData logic from nodePackage to sidebar, better offline handling

* check if isSyncing for catchingUp

* banner shows up now after synchronization

* fixed service name

* flexible support for node packages with 2 services

* dynamic port support for OP nodes

* added stopping state to node package

* moved controller version into devmode

* added starting state to header

* added l2executionEndpoint, mouse states

* show number of notification items that are unread

* removed cursor, added text highlighting

* changed beta label style, padding

* single clientcard support

* fixed link colors

* decreased shadow opacity, dont display tabs when just 1

* changed to show other node types, removed other

* changed to black40/white40

* added useTheme to use correct artworks

* show minutes and seconds for podman install

* added notification deeplink to preferences

* fixed checkbox to spec

* start work on update modal

* completed update modal

* updated strings

* added skip button to update callout

* backdrop click on modal closes the modal

* refactor across components

* add support for labels + progressbar

* dont show update for nodepackage screen

* fixed syncing status for optimism

* add httpPort to l2RpcUrl

* optimism_syncStatus support

* added peer and latestBlock support for op-node

* add specId support for executeTranslations

* enable card height for OP

* removed lastblock related logic from node package, only needed on nodescreen

* simplified polling to rely on running status(?)

* fixed test to support new status

* added special case for reth to check latestBlock when syncing

* besu should check latestBlock too

* wait longer after node start for containers to download

---------

Co-authored-by: Johns Gresham <[email protected]>

Author: corn-potage

assets/locales/en/genericComponents.json

@@ -1,5 +1,6 @@
 {
   "AboutSecondsRemaining": "About {{seconds}} seconds remaining",
+  "AboutMinutesAndSecondsRemaining": "{{minutes}} minutes and {{remainingSeconds}} seconds remaining",
   "CheckForUpdates": "Check for updates...",
   "Confirm": "Confirm",
   "FinishingUp": "Finishing up...",
@@ -48,7 +49,12 @@
   "Syncing": "Syncing",
   "CatchingUp": "Catching up...",
   "InProgress": "In progress...",
+  "Starting": "Starting",
+  "Starting...": "Starting...",
   "Stopped": "Stopped",
+  "Stopping": "Stopping",
+  "Stopping...": "Stopping...",
+  "Removing": "Removing",
   "CurrentlyOffline": "Currently offline",
   "PleaseReconnect": "Please reconnect to the internet",
   "PodmanIsNotInstalled": "Podman is not installed",

assets/locales/en/translation.json

@@ -18,7 +18,6 @@
   "Peers": "peers",
   "created": "created",
   "initializing": "initializing",
-  "checkingForUpdates": "checking for updates",
   "download": "download",
   "downloading": "downloading",
   "downloaded": "downloaded",
@@ -145,6 +144,8 @@
   "loadingDotDotDot": "loading...",
   "Preferences": "Preferences",
   "ShowAdvancedOptions": "Show advanced options",
+  "ShowOtherNodeTypes": "Show other node types",
+  "HideOtherNodeTypes": "Hide other node types",
   "SaveChanges": "Save changes",
   "Continue": "Continue",
   "Back": "Back",
@@ -174,5 +175,10 @@
   "CurrentPodman": "Your current Podman installation ({{currentPodmanVersion}}) is incompatible with NiceNode and requires version {{requiredPodmanVersion}} or higher for it to run.",
   "PodmanIsRequiredComponent": "Podman is a required component for NiceNode to run the many client options. Podman facilitates the running of containers within a virtualised Linux environment and will operate in the background.",
   "DownloadAndUpdate": "Download and update",
-  "PodmanUpdate": "Podman update"
+  "PodmanUpdate": "Podman update",
+  "CheckingForUpdates": "Checking for updates...",
+  "RunningLatestVersion": "You are running the latest version",
+  "SuccessfullyUpdated": "Successfully updated",
+  "Done": "Done",
+  "Close": "Close"
 }

src/common/NodeSpecs/arbitrum/arbitrum-v1.0.0.json

@@ -2,7 +2,7 @@
   "specId": "arbitrum",
   "version": "1.0.0",
   "displayName": "Arbitrum One",
-  "displayTagline": "Non-Validating Node",
+  "displayTagline": "Ethereum L2 - Arbitrum",
   "execution": {
     "executionTypes": ["nodePackage"],
     "defaultExecutionType": "nodePackage",

src/common/NodeSpecs/base/base-v1.0.0.json

@@ -1,7 +1,7 @@
 {
   "specId": "base",
-  "version": "1.0.0",
-  "displayName": "Base",
+  "version": "1.0.1",
+  "displayTagline": "Ethereum L2 - Base",
   "execution": {
     "executionTypes": ["nodePackage"],
     "services": [

src/common/NodeSpecs/op-node/op-node-v1.0.0.json

@@ -9,7 +9,7 @@
       "defaultConfig": {
         "l1": "",
         "l1Beacon": "",
-        "l2": "http://host.containers.internal:8553",
+        "executionEndpoint": "http://host.containers.internal",
         "l1TrustRpc": "Enabled",
         "httpPort": "8549",
         "p2pPorts": "9222",
@@ -110,13 +110,13 @@
       "defaultValue": "",
       "infoDescription": "Provider with historical blob API enabled or a local node http://host.containers.internal:5052"
     },
-    "l2": {
+    "executionEndpoint": {
       "displayName": "Optimism RPC Endpoint (local node or provider)",
       "cliConfigPrefix": "--l2 ",
       "uiControl": {
         "type": "text"
       },
-      "defaultValue": "http://host.containers.internal:8553",
+      "defaultValue": "http://host.containers.internal",
       "addNodeFlow": "advanced",
       "infoDescription": "engine and eth namespace required",
       "documentation": "https://github.com/jgresham/superhack/blob/main/README.md#op-node-settings"

src/common/node.ts

@@ -22,6 +22,7 @@ export enum NodeStatus {
   running = 'running',
   stopping = 'stopping',
   stopped = 'stopped',
+  removing = 'removing',
   errorRunning = 'error running',
   errorStarting = 'error starting',
   errorStopping = 'error stopping',

src/main/ipc.ts

@@ -57,7 +57,10 @@ import { checkPorts } from './ports';
 import { getBenchmarks } from './state/benchmark';
 import { getAppClientId } from './state/eventReporting';
 import { getNodeLibrary, getNodePackageLibrary } from './state/nodeLibrary';
-import { getUserNodePackages } from './state/nodePackages';
+import {
+  getUserNodePackages,
+  updateNodePackageProperties,
+} from './state/nodePackages';
 import { getNodes, getUserNodes, updateNodeProperties } from './state/nodes';
 import {
   addNotification,
@@ -145,6 +148,12 @@ export const initialize = () => {
   ipcMain.handle('stopNodePackage', (_event, nodeId: NodeId) => {
     return stopNodePackage(nodeId, NodeStoppedBy.user);
   });
+  ipcMain.handle(
+    'updateNodePackage',
+    (_event, nodeId: NodeId, propertiesToUpdate: any) => {
+      return updateNodePackageProperties(nodeId, propertiesToUpdate);
+    },
+  );
   ipcMain.handle(
     'addNode',
     (_event, nodeSpec: NodeSpecification, storageLocation?: string) => {

src/main/nodeManager.ts

@@ -113,9 +113,8 @@ export const getNodeStartCommand = (nodeId: NodeId): string => {
 
 export const startNode = async (nodeId: NodeId) => {
   const node = nodeStore.getNode(nodeId);
-  if (!node) {
-    throw new Error(`Unable to start node ${nodeId}. Node not found.`);
-  }
+  if (!node) throw new Error(`Unable to start node ${nodeId}. Node not found.`);
+
   logger.info(`Starting node ${JSON.stringify(node)}`);
   node.status = NodeStatus.starting;
   node.lastStartedTimestampMs = Date.now();
@@ -124,30 +123,24 @@ export const startNode = async (nodeId: NodeId) => {
 
   try {
     if (isDockerNode(node)) {
-      const dockerNode = node;
-      // startPodmanNode(dockerNode);
-      const containerIds = await startPodmanNode(dockerNode);
-      dockerNode.runtime.processIds = containerIds;
-      dockerNode.status = NodeStatus.running;
+      const containerIds = await startPodmanNode(node);
+      node.runtime.processIds = containerIds;
+      node.status = NodeStatus.running;
       setLastRunningTime(nodeId, 'nodeService');
-      if (getSetPortHasChanged(dockerNode)) {
-        checkNodePortsAndNotify(dockerNode);
-      }
-      nodeStore.updateNode(dockerNode);
+      if (getSetPortHasChanged(node)) checkNodePortsAndNotify(node);
     }
   } catch (err) {
     logger.error(err);
     node.status = NodeStatus.errorStarting;
+  } finally {
     nodeStore.updateNode(node);
-    throw err;
   }
 };
 
 export const stopNode = async (nodeId: NodeId, stoppedBy: NodeStoppedBy) => {
   const node = nodeStore.getNode(nodeId);
-  if (!node) {
-    throw new Error(`Unable to stop node ${nodeId}. Node not found.`);
-  }
+  if (!node) throw new Error(`Unable to stop node ${nodeId}. Node not found.`);
+
   logger.info(`Stopping node ${JSON.stringify(node)}`);
   node.status = NodeStatus.stopping;
   node.lastStoppedTimestampMs = Date.now();
@@ -156,14 +149,12 @@ export const stopNode = async (nodeId: NodeId, stoppedBy: NodeStoppedBy) => {
 
   try {
     if (isDockerNode(node)) {
-      const containerIds = await stopPodmanNode(node);
-      logger.info(`${containerIds} stopped`);
+      await stopPodmanNode(node);
       node.status = NodeStatus.stopped;
-      nodeStore.updateNode(node);
     }
+  } catch (err) {
+    logger.error(err);
   } finally {
-    // don't catch the error, but mark node as stopped
-    // todoo: fix this, but for testing it is useful
     node.status = NodeStatus.stopped;
     nodeStore.updateNode(node);
   }
@@ -204,6 +195,8 @@ export const removeNode = async (
     );
   }
   const node = nodeStore.getNode(nodeId);
+  node.status = NodeStatus.removing;
+  nodeStore.updateNode(node);
 
   // if docker, remove container
   if (isDockerNode(node)) {

src/main/nodePackageManager.ts

@@ -135,62 +135,45 @@ export const addNodePackage = async (
 
 export const startNodePackage = async (nodeId: NodeId) => {
   const node = nodePackageStore.getNodePackage(nodeId);
-  if (!node) {
+  if (!node)
     throw new Error(`Unable to start node package ${nodeId}. Not found.`);
-  }
-  logger.info(`Starting node ${JSON.stringify(node)}`);
-  let nodePackageStatus = NodeStatus.starting;
-  node.status = nodePackageStatus;
+
+  logger.info(`Starting node package ${JSON.stringify(node)}`);
+  node.status = NodeStatus.starting;
   node.lastStartedTimestampMs = Date.now();
   node.stoppedBy = undefined;
   nodePackageStore.updateNodePackage(node);
-  let allServicesStarted = true;
-
-  const isEthereumPackage = node.spec.specId === 'ethereum';
 
   const startService = async (service: any) => {
     try {
       await startNode(service.node.id);
     } catch (e) {
       logger.error(`Unable to start node service: ${JSON.stringify(service)}`);
-      nodePackageStatus = NodeStatus.errorStarting;
-      allServicesStarted = false;
-      // try to start all services, or stop other services?
-      // todo: set as partially started?
-      // throw e;
+      node.status = NodeStatus.errorStarting;
+      nodePackageStore.updateNodePackage(node);
+      return Promise.reject(e);
     }
   };
 
-  // Make sure Ethereum clients run sequentially so that the correct
-  // engine and other ports can be assigned correctly
-  if (isEthereumPackage) {
+  if (node.services.length === 2) {
+    //TODO: support clients that don't have the following serviceIds
     const executionClient = node.services.find(
-      (service) => service.serviceId === 'executionClient',
+      (s) => s.serviceId === 'executionClient',
     );
     const consensusClient = node.services.find(
-      (service) => service.serviceId === 'consensusClient',
+      (s) => s.serviceId === 'consensusClient',
     );
 
-    if (executionClient) {
-      await startService(executionClient);
-    }
-
-    if (consensusClient) {
-      await startService(consensusClient);
-    }
+    if (executionClient) await startService(executionClient);
+    if (consensusClient) await startService(consensusClient);
   } else {
-    const startPromises = node.services.map(startService);
-    await Promise.all(startPromises);
+    await Promise.all(node.services.map(startService));
   }
 
-  // If all node services start without error, the package is considered running
-  if (allServicesStarted) {
-    nodePackageStatus = NodeStatus.running;
+  if (node.status !== NodeStatus.errorStarting) {
+    node.status = NodeStatus.running;
     setLastRunningTime(nodeId, 'node');
   }
-
-  // set node status
-  node.status = nodePackageStatus;
   nodePackageStore.updateNodePackage(node);
 };
 
@@ -199,31 +182,30 @@ export const stopNodePackage = async (
   stoppedBy: NodeStoppedBy,
 ) => {
   const node = nodePackageStore.getNodePackage(nodeId);
-  if (!node) {
+  if (!node)
     throw new Error(`Unable to stop node package ${nodeId}. Not found.`);
-  }
-  logger.info(`Stopping node ${JSON.stringify(node)}`);
-  let nodePackageStatus = NodeStatus.stopping;
-  node.status = nodePackageStatus;
+
+  logger.info(`Stopping node package ${JSON.stringify(node)}`);
+  node.status = NodeStatus.stopping;
   node.lastStoppedTimestampMs = Date.now();
   node.stoppedBy = stoppedBy;
   nodePackageStore.updateNodePackage(node);
 
-  nodePackageStatus = NodeStatus.stopped;
-  for (let i = 0; i < node.services.length; i++) {
-    const service = node.services[i];
-    try {
-      await stopNode(service.node.id, stoppedBy);
-    } catch (e) {
-      logger.error(`Unable to stop node service: ${JSON.stringify(service)}`);
-      nodePackageStatus = NodeStatus.errorStopping;
-      // try to start all services, or stop other services?
-      // what to do here?
-      // throw e;
-    }
+  await Promise.all(
+    node.services.map(async (service) => {
+      try {
+        await stopNode(service.node.id, stoppedBy);
+      } catch (e) {
+        logger.error(`Unable to stop node service: ${JSON.stringify(service)}`);
+        node.status = NodeStatus.errorStopping;
+        nodePackageStore.updateNodePackage(node);
+      }
+    }),
+  );
+
+  if (node.status !== NodeStatus.errorStopping) {
+    node.status = NodeStatus.stopped;
   }
-  // set node status
-  node.status = nodePackageStatus;
   nodePackageStore.updateNodePackage(node);
 };
 
@@ -252,6 +234,8 @@ export const removeNodePackage = async (
     );
   }
   const node = nodePackageStore.getNodePackage(nodeId);
+  node.status = NodeStatus.removing;
+  nodePackageStore.updateNodePackage(node);
   for (let i = 0; i < node.services.length; i++) {
     const service = node.services[i];
     try {