@iobroker/js-controller-cli 7.0.0 → 7.0.2-alpha.0-20241026-8055a2557

package/build/cjs/lib/setup/setupBackup.d.ts

@@ -47,6 +47,8 @@ export declare class BackupRestore {
     private readonly HOSTNAME_PLACEHOLDER_REPLACE;
     /** Regex to replace all occurrences of the HOSTNAME_PLACEHOLDER */
     private readonly HOSTNAME_PLACEHOLDER_REGEX;
+    /** Postfix for backup name */
+    private readonly BACKUP_POSTFIX;
     constructor(options: CLIBackupRestoreOptions);
     private _copyFile;
     copyDir(id: string, srcPath: string, destPath: string): Promise<void>;
@@ -138,9 +140,11 @@ export declare class BackupRestore {
      */
     listBackups(): string[];
     /**
-     * Validates the backup.json and all json files inside the backup after (in temporary directory), here we only abort if backup.json is corrupted
+     * Validates a JSONL-style backup and all json files inside the backup (in temporary directory)
+     *
+     * @param noConfig if the backup does not contain a `config.json` (used by setup custom migration)
      */
-    private _validateBackupAfterCreation;
+    private _validateTempDirectory;
     /**
      * Validate that the created JSONL files in the temporary directories are parseable
      */
@@ -150,7 +154,11 @@ export declare class BackupRestore {
      *
      * @param _name - index or name of the backup
      */
-    validateBackup(_name: string | number): Promise<void> | undefined;
+    validateBackup(_name: string | number): Promise<void>;
+    /**
+     * Validate an unpacked legacy backup in the temporary directory
+     */
+    private _validateLegacyTempDir;
     /**
      * Checks a directory for json files and validates them, steps down recursive in subdirectories
      *

package/build/cjs/lib/setup/setupBackup.js

@@ -55,6 +55,7 @@ class BackupRestore {
   HOSTNAME_PLACEHOLDER = "$$__hostname__$$";
   HOSTNAME_PLACEHOLDER_REPLACE = "$$$$__hostname__$$$$";
   HOSTNAME_PLACEHOLDER_REGEX = /\$\$__hostname__\$\$/g;
+  BACKUP_POSTFIX = `_backup${import_js_controller_common.tools.appNameLowerCase}`;
   constructor(options) {
     options = options || {};
     if (!options.states) {
@@ -179,10 +180,12 @@ class BackupRestore {
       }
     });
   }
-  async createBackup(name, noConfig) {
+  async createBackup(name, noConfig = false) {
     if (!name) {
       const d = new Date();
-      name = `${d.getFullYear()}_${`0${d.getMonth() + 1}`.slice(-2)}_${`0${d.getDate()}`.slice(-2)}-${`0${d.getHours()}`.slice(-2)}_${`0${d.getMinutes()}`.slice(-2)}_${`0${d.getSeconds()}`.slice(-2)}_backup${import_js_controller_common.tools.appName}`;
+      name = `${d.getFullYear()}_${`0${d.getMonth() + 1}`.slice(-2)}_${`0${d.getDate()}`.slice(-2)}-${`0${d.getHours()}`.slice(-2)}_${`0${d.getMinutes()}`.slice(-2)}_${`0${d.getSeconds()}`.slice(-2)}${this.BACKUP_POSTFIX}`;
+    } else if (!name.endsWith(this.BACKUP_POSTFIX) && !name.endsWith(`${this.BACKUP_POSTFIX}.tar.gz`)) {
+      name += this.BACKUP_POSTFIX;
     }
     name = name.toString().replace(/\\/g, "/");
     if (!name.includes("/")) {
@@ -260,7 +263,7 @@ class BackupRestore {
     }
     console.log(`host.${hostname} Validating backup ...`);
     try {
-      await this._validateBackupAfterCreation();
+      await this._validateTempDirectory(noConfig);
       console.log(`host.${hostname} The backup is valid!`);
       return await this._packBackup(name);
     } catch (e) {
@@ -468,8 +471,12 @@ class BackupRestore {
     const { force, dontDeleteAdapters } = options;
     const hostname = import_js_controller_common.tools.getHostName();
     const backupBaseDir = import_node_path.default.join(this.tmpDir, "backup");
-    const config = await import_fs_extra.default.readJSON(import_node_path.default.join(backupBaseDir, "config.json"));
-    const backupHostName = config.system?.hostname || hostname;
+    let backupHostName = hostname;
+    let config;
+    if (await import_fs_extra.default.pathExists(import_node_path.default.join(backupBaseDir, "config.json"))) {
+      config = await import_fs_extra.default.readJSON(import_node_path.default.join(backupBaseDir, "config.json"));
+      backupHostName = config.system?.hostname || hostname;
+    }
     const objFd = await (0, import_promises.open)(import_node_path.default.join(backupBaseDir, "objects.jsonl"));
     const rlObj = objFd.readLines();
     const hostObjArr = [];
@@ -489,8 +496,10 @@ class BackupRestore {
     if (!dontDeleteAdapters) {
       await this._removeAllAdapters();
     }
-    import_fs_extra.default.writeFileSync(import_js_controller_common.tools.getConfigFileName(), JSON.stringify(config, null, 2));
-    await this.connectToNewDatabase(config);
+    if (config) {
+      import_fs_extra.default.writeFileSync(import_js_controller_common.tools.getConfigFileName(), JSON.stringify(config, null, 2));
+      await this.connectToNewDatabase(config);
+    }
     console.log(`host.${hostname} Clear all objects and states...`);
     await this.cleanDatabase(false);
     console.log(`host.${hostname} done.`);
@@ -521,7 +530,7 @@ class BackupRestore {
   async _restoreAfterStop(options) {
     const { force, restartOnFinish, dontDeleteAdapters } = options;
     const backupBaseDir = import_node_path.default.join(this.tmpDir, "backup");
-    const isJsonl = await import_fs_extra.default.pathExists(import_node_path.default.join(backupBaseDir, "config.json"));
+    const isJsonl = await import_fs_extra.default.pathExists(import_node_path.default.join(backupBaseDir, "objects.jsonl"));
     if (isJsonl) {
       const exitCode = await this._restoreJsonlBackup(options);
       if (exitCode !== import_js_controller_common.EXIT_CODES.NO_ERROR) {
@@ -655,16 +664,22 @@ class BackupRestore {
     }
     return result;
   }
-  async _validateBackupAfterCreation() {
+  async _validateTempDirectory(noConfig = false) {
     const backupBaseDir = import_node_path.default.join(this.tmpDir, "backup");
-    await import_fs_extra.default.readJSON(import_node_path.default.join(backupBaseDir, "config.json"));
+    if (!noConfig) {
+      await import_fs_extra.default.readJSON(import_node_path.default.join(backupBaseDir, "config.json"));
+      console.log(`host.${this.hostname} "config.json" is valid`);
+    }
     if (!await import_fs_extra.default.pathExists(import_node_path.default.join(backupBaseDir, "objects.jsonl"))) {
       throw new Error("Backup does not contain valid objects");
     }
+    console.log(`host.${this.hostname} "objects.jsonl" exists`);
     if (!await import_fs_extra.default.pathExists(import_node_path.default.join(backupBaseDir, "states.jsonl"))) {
       throw new Error("Backup does not contain valid states");
     }
+    console.log(`host.${this.hostname} "states.jsonl" exists`);
     await this._validateDatabaseFiles();
+    console.log(`host.${this.hostname} JSONL lines are valid`);
     try {
       this._checkDirectory(import_node_path.default.join(backupBaseDir, "files"));
     } catch (e) {
@@ -695,7 +710,7 @@ class BackupRestore {
     }
     await statesFd.close();
   }
-  validateBackup(_name) {
+  async validateBackup(_name) {
     let backups;
     let name = typeof _name === "number" ? _name.toString() : _name;
     if (!name) {
@@ -704,12 +719,12 @@ class BackupRestore {
       if (backups.length) {
         console.log("Please specify one of the backup names:");
         for (const t in backups) {
-          console.log(`${backups[t]} or ${backups[t].replace(`_backup${import_js_controller_common.tools.appName}.tar.gz`, "")} or ${t}`);
+          console.log(`${backups[t]} or ${backups[t].replace(`${this.BACKUP_POSTFIX}.tar.gz`, "")} or ${t}`);
         }
       } else {
         console.warn(`No backups found. Create a backup, using "${import_js_controller_common.tools.appName} backup" first`);
       }
-      return void this.processExit(import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS);
+      throw new import_customError.IoBrokerError({ message: "Backup not found", code: import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS });
     }
     if (parseInt(name, 10).toString() === name.toString()) {
       backups = this.listBackups();
@@ -720,21 +735,21 @@ class BackupRestore {
         if (backups.length) {
           console.log("Please specify one of the backup names:");
           for (const t in backups) {
-            console.log(`${backups[t]} or ${backups[t].replace(`_backup${import_js_controller_common.tools.appName}.tar.gz`, "")} or ${t}`);
+            console.log(`${backups[t]} or ${backups[t].replace(`${this.BACKUP_POSTFIX}.tar.gz`, "")} or ${t}`);
           }
         } else {
           console.log(`No existing backups. Create a backup, using "${import_js_controller_common.tools.appName} backup" first`);
         }
-        return void this.processExit(import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS);
+        throw new import_customError.IoBrokerError({ message: "Backup not found", code: import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS });
       }
       console.log(`host.${this.hostname} Using backup file ${name}`);
     }
     name = name.toString().replace(/\\/g, "/");
     if (!name.includes("/")) {
       name = BackupRestore.getBackupDir() + name;
-      const regEx = new RegExp(`_backup${import_js_controller_common.tools.appName}`, "i");
+      const regEx = new RegExp(this.BACKUP_POSTFIX, "i");
       if (!regEx.test(name)) {
-        name += `_backup${import_js_controller_common.tools.appName}`;
+        name += this.BACKUP_POSTFIX;
       }
       if (!name.match(/\.tar\.gz$/i)) {
         name += ".tar.gz";
@@ -742,53 +757,60 @@ class BackupRestore {
     }
     if (!import_fs_extra.default.existsSync(name)) {
       console.error(`host.${this.hostname} Cannot find ${name}`);
-      return void this.processExit(import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS);
+      throw new import_customError.IoBrokerError({ message: "Backup not found", code: import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS });
     }
     if (import_fs_extra.default.existsSync(`${this.tmpDir}/backup/backup.json`)) {
       import_fs_extra.default.unlinkSync(`${this.tmpDir}/backup/backup.json`);
     }
-    return new Promise((resolve) => {
-      import_tar.default.extract({
+    try {
+      await import_tar.default.extract({
         file: name,
         cwd: this.tmpDir
-      }, void 0, (err) => {
-        if (err) {
-          console.error(`host.${this.hostname} Cannot extract from file "${name}": ${err.message}`);
-          return void this.processExit(import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS);
-        }
-        if (!import_fs_extra.default.existsSync(`${this.tmpDir}/backup/backup.json`)) {
-          console.error(`host.${this.hostname} Validation failed. Cannot find extracted file from file "${this.tmpDir}/backup/backup.json"`);
-          return void this.processExit(import_js_controller_common.EXIT_CODES.CANNOT_EXTRACT_FROM_ZIP);
-        }
-        console.log(`host.${this.hostname} Starting validation ...`);
-        let backupJSON;
-        try {
-          backupJSON = import_fs_extra.default.readJSONSync(`${this.tmpDir}/backup/backup.json`);
-        } catch (err2) {
-          console.error(`host.${this.hostname} Backup corrupted. Backup ${name} does not contain a valid backup.json file: ${err2.message}`);
-          this.removeTempBackupDir();
-          return void this.processExit(import_js_controller_common.EXIT_CODES.CANNOT_EXTRACT_FROM_ZIP);
-        }
-        if (!backupJSON || !backupJSON.objects || !backupJSON.objects.length) {
-          console.error(`host.${this.hostname} Backup corrupted. Backup does not contain valid objects`);
-          try {
-            this.removeTempBackupDir();
-          } catch (e) {
-            console.error(`host.${this.hostname} Cannot clear temporary backup directory: ${e.message}`);
-          }
-          return void this.processExit(import_js_controller_common.EXIT_CODES.CANNOT_EXTRACT_FROM_ZIP);
-        }
-        console.log(`host.${this.hostname} backup.json OK`);
-        try {
-          this._checkDirectory(`${this.tmpDir}/backup/files`, true);
-          this.removeTempBackupDir();
-          resolve();
-        } catch (err2) {
-          console.error(`host.${this.hostname} Backup corrupted: ${err2.message}`);
-          return void this.processExit(import_js_controller_common.EXIT_CODES.CANNOT_EXTRACT_FROM_ZIP);
-        }
       });
-    });
+    } catch (e) {
+      const errMessage = `Cannot extract from file "${name}": ${e.message}`;
+      console.error(`host.${this.hostname} ${errMessage}`);
+      throw new import_customError.IoBrokerError({ message: "Backup not found", code: import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS });
+    }
+    try {
+      if (import_fs_extra.default.existsSync(import_node_path.default.join(this.tmpDir, "backup", "backup.json"))) {
+        this._validateLegacyTempDir();
+      } else {
+        await this._validateTempDirectory();
+      }
+    } catch (e) {
+      console.error(`host.${this.hostname} ${e.message}`);
+      try {
+        this.removeTempBackupDir();
+      } catch (e2) {
+        console.error(`host.${this.hostname} Cannot clear temporary backup directory: ${e2.message}`);
+      }
+      throw new import_customError.IoBrokerError({ message: e.message, code: import_js_controller_common.EXIT_CODES.CANNOT_EXTRACT_FROM_ZIP });
+    }
+    try {
+      this.removeTempBackupDir();
+    } catch (e) {
+      console.error(`host.${this.hostname} Cannot clear temporary backup directory: ${e.message}`);
+      throw new import_customError.IoBrokerError({ message: e.message, code: import_js_controller_common.EXIT_CODES.CANNOT_EXTRACT_FROM_ZIP });
+    }
+  }
+  _validateLegacyTempDir() {
+    console.log(`host.${this.hostname} Starting validation ...`);
+    let backupJSON;
+    try {
+      backupJSON = import_fs_extra.default.readJSONSync(`${this.tmpDir}/backup/backup.json`);
+    } catch (e) {
+      throw new Error(`Backup corrupted. Backup does not contain a valid backup.json file: ${e.message}`);
+    }
+    if (!backupJSON || !backupJSON.objects || !backupJSON.objects.length) {
+      throw new Error(`host.${this.hostname} Backup corrupted. Backup does not contain valid objects`);
+    }
+    console.log(`host.${this.hostname} backup.json OK`);
+    try {
+      this._checkDirectory(`${this.tmpDir}/backup/files`, true);
+    } catch (e) {
+      throw new Error(`Backup corrupted: ${e.message}`);
+    }
   }
   _checkDirectory(path2, verbose = false) {
     if (import_fs_extra.default.existsSync(path2)) {
@@ -822,7 +844,7 @@ class BackupRestore {
       backups = this.listBackups();
       backups.sort((a, b) => b > a ? 1 : b === a ? 0 : -1);
       if (backups.length) {
-        backups.forEach((backup, i) => console.log(`${backup} or ${backup.replace(`_backup${import_js_controller_common.tools.appName}.tar.gz`, "")} or ${i}`));
+        backups.forEach((backup, i) => console.log(`${backup} or ${backup.replace(`${this.BACKUP_POSTFIX}.tar.gz`, "")} or ${i}`));
       } else {
         console.warn("No backups found");
       }
@@ -842,7 +864,7 @@ class BackupRestore {
         console.log("No matching backup found");
         if (backups.length) {
           console.log("Please specify one of the backup names:");
-          backups.forEach((backup, i) => console.log(`${backup} or ${backup.replace(`_backup${import_js_controller_common.tools.appName}.tar.gz`, "")} or ${i}`));
+          backups.forEach((backup, i) => console.log(`${backup} or ${backup.replace(`${this.BACKUP_POSTFIX}.tar.gz`, "")} or ${i}`));
         }
       } else {
         console.log(`host.${this.hostname} Using backup file ${name}`);
@@ -851,9 +873,9 @@ class BackupRestore {
     name = name.toString().replace(/\\/g, "/");
     if (!name.includes("/")) {
       name = BackupRestore.getBackupDir() + name;
-      const regEx = new RegExp(`_backup${import_js_controller_common.tools.appName}`, "i");
+      const regEx = new RegExp(this.BACKUP_POSTFIX, "i");
       if (!regEx.test(name)) {
-        name += `_backup${import_js_controller_common.tools.appName}`;
+        name += this.BACKUP_POSTFIX;
       }
       if (!name.match(/\.tar\.gz$/i)) {
         name += ".tar.gz";
@@ -876,8 +898,8 @@ class BackupRestore {
       console.error(`host.${this.hostname} Cannot extract from file "${name}": ${e.message}`);
       return { exitCode: import_js_controller_common.EXIT_CODES.CANNOT_EXTRACT_FROM_ZIP, objects: this.objects, states: this.states };
     }
-    if (!await import_fs_extra.default.pathExists(import_node_path.default.join(backupBasePath, "backup.json")) && !await import_fs_extra.default.pathExists(import_node_path.default.join(backupBasePath, "config.json"))) {
-      console.error(`host.${this.hostname} Cannot find extracted file "${import_node_path.default.join(backupBasePath, "backup.json")}" or "${import_node_path.default.join(backupBasePath, "config.json")}"`);
+    if (!await import_fs_extra.default.pathExists(import_node_path.default.join(backupBasePath, "backup.json")) && !await import_fs_extra.default.pathExists(import_node_path.default.join(backupBasePath, "objects.jsonl"))) {
+      console.error(`host.${this.hostname} Cannot find extracted file "${import_node_path.default.join(backupBasePath, "backup.json")}" or "${import_node_path.default.join(backupBasePath, "objects.jsonl")}"`);
       return { exitCode: import_js_controller_common.EXIT_CODES.CANNOT_EXTRACT_FROM_ZIP, objects: this.objects, states: this.states };
     }
     await import_cliProcess.CLIProcess.stopJSController();