Persist settings of the ethchain during the eth client migration

Author: dapplion

build/src/src/db/ethClient.ts

@@ -4,7 +4,8 @@ import {
   EthClientTarget,
   UserSettings,
   EthClientFallback,
-  EthClientStatus
+  EthClientStatus,
+  EthClientTargetPackage
 } from "../types";
 import { joinWithDot, stripDots } from "./dbUtils";
 import { EthClientInstallStatus } from "../modules/ethClient/types";
@@ -18,6 +19,8 @@ const ETH_CLIENT_USER_SETTINGS = "eth-client-user-settings";
 const ETH_CLIENT_INSTALL_STATUS = "eth-client-install-status";
 const ETH_CLIENT_STATUS = "eth-client-status";
 const ETH_PROVIDER_URL = "eth-provider-url";
+// Cached temp status
+const ETH_CLIENT_MIGRATION_TEMP_SETTINGS = "eth-client-migration-temp-status";
 
 // Re-export to consider the first value (when it's not set)
 // but do not allow to set null again. Using to express intentionality
@@ -96,3 +99,13 @@ function interceptOnSet<F extends Function, T extends { set: F }>(
     }
   };
 }
+
+/**
+ * Temporal cache settings that must survive a reset
+ * Store settings in the cache. It is possible that the migration is stopped
+ * because the DAPPMANAGER resets and then the eth client will not be installed
+ */
+export const ethClientMigrationTempSettings = dbCache.staticKey<{
+  target: EthClientTargetPackage;
+  EXTRA_OPTS: string;
+} | null>(ETH_CLIENT_MIGRATION_TEMP_SETTINGS, null);

build/src/src/modules/ethClient/migrateEthchain.ts

@@ -1,4 +1,5 @@
 import fs from "fs";
+import * as db from "../../db";
 import { changeEthMultiClient } from "./changeEthMultiClient";
 import { listContainerNoThrow } from "../../modules/docker/listContainers";
 import { dockerVolumesList, dockerDf } from "../../modules/docker/dockerApi";
@@ -8,6 +9,7 @@ import { getUserSettingsSafe } from "../../utils/dockerComposeFile";
 import * as getPath from "../../utils/getPath";
 import shell from "../../utils/shell";
 import Logs from "../../logs";
+import { EthClientTargetPackage } from "../../types";
 const logs = Logs(module);
 
 const ethchainDnpName = "ethchain.dnp.dappnode.eth";
@@ -46,6 +48,14 @@ export async function migrateEthchain(): Promise<void> {
     ...(userSettings.environment || {})
   };
   const isNextOpenEthereum = /parity/i.test(envs.DEFAULT_CLIENT || "");
+  let target: EthClientTargetPackage = isNextOpenEthereum
+    ? "openethereum"
+    : "geth";
+  let EXTRA_OPTS =
+    (isNextOpenEthereum ? envs.EXTRA_OPTS : envs.EXTRA_OPTS_GETH) || "";
+  // Store settings in the cache. It is possible that the migration is stopped
+  // because the DAPPMANAGER resets and then the eth client will not be installed
+  db.ethClientMigrationTempSettings.set({ target, EXTRA_OPTS });
 
   const volumesToMigrate = [
     {
@@ -142,16 +152,23 @@ export async function migrateEthchain(): Promise<void> {
   }
 
   // Install new package. fullnode.dappnode is assigned after install
-  if (ethchain) {
-    const target = isNextOpenEthereum ? "openethereum" : "geth";
-    const EXTRA_OPTS = isNextOpenEthereum
-      ? envs.EXTRA_OPTS
-      : envs.EXTRA_OPTS_GETH;
-    logs.info(`Installing eth multi-client ${target}: ${JSON.stringify(envs)}`);
+  const migrationTempSettings = db.ethClientMigrationTempSettings.get();
+  if (ethchain || migrationTempSettings) {
+    logs.info(
+      `Installing eth multi-client ${target}: with EXTRA_OPTS ${EXTRA_OPTS}`
+    );
+
+    if (migrationTempSettings) {
+      target = migrationTempSettings.target || target;
+      EXTRA_OPTS = migrationTempSettings.EXTRA_OPTS || EXTRA_OPTS;
+    }
 
     await changeEthMultiClient(target, false, {
       portMappings: userSettings.portMappings,
       environment: EXTRA_OPTS ? { EXTRA_OPTS } : undefined
     });
+
+    // Once the client has been successfully changed, delete temp migration settings
+    db.ethClientMigrationTempSettings.set(null);
   }
 }