Improved logging

CHANGELOG.md

@@ -12,6 +12,8 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 ---|---|---
 Symbol Bootstrap | v0.4.1 | [symbol-bootstrap](https://www.npmjs.com/package/symbol-bootstrap)
 
+- Added `--backupSync` to `config` and `start` commands. It downloads a backup with the Mongo and RocksDb databases for faster synchronization.
+- Added `backup` command. The command backups the Mongo and RocksDb data folder into a Zip file that can be used for `--backupSync` feature.
 - Improved --password. It's only required when private keys need to be read.
 - Added `database` service to server and broker `depends_on` compose services.
 - Fixed `link --unlink` command for Voting Key Link transactions.

README.md

@@ -264,7 +264,7 @@ General users should install this tool like any other node module.
 <!-- commands -->
 # Command Topics
 
-* [`symbol-bootstrap backup`](docs/backup.md) - It backups the mongo and data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
+* [`symbol-bootstrap backup`](docs/backup.md) - The command backups the Mongo and RocksDb data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
 * [`symbol-bootstrap clean`](docs/clean.md) - It removes the target folder deleting the generated configuration and data
 * [`symbol-bootstrap compose`](docs/compose.md) - It generates the `docker-compose.yml` file from the configured network.
 * [`symbol-bootstrap config`](docs/config.md) - Command used to set up the configuration files and the nemesis block for the current network

docs/backup.md

@@ -1,15 +1,15 @@
 `symbol-bootstrap backup`
 =========================
 
-It backups the mongo and data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
+The command backups the Mongo and RocksDb data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
 
 Note: this command is designed for NGL to be used when running public main or public test networks. It's not backing up any node specific information.
 
 * [`symbol-bootstrap backup`](#symbol-bootstrap-backup)
 
 ## `symbol-bootstrap backup`
 
-It backups the mongo and data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
+The command backups the Mongo and RocksDb data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
 
 ```
 USAGE

docs/config.md

@@ -30,7 +30,7 @@ OPTIONS
   -u, --user=user                   [default: current] User used to run docker images when creating configuration files
                                     like certificates or nemesis block. "current" means the current user.
 
-  --backupSync                      It downloads a backup with the mongo and rockdb databases for faster
+  --backupSync                      It downloads a backup with the Mongo and RocksDb databases for faster
                                     synchronization.
 
   --pullImages                      It pulls the utility images from DockerHub when running the configuration. It only

docs/start.md

@@ -47,7 +47,7 @@ OPTIONS
       Add extra arguments to the docker-compose up command. Check out https://docs.docker.com/compose/reference/up.
 
   --backupSync
-      It downloads a backup with the mongo and rockdb databases for faster synchronization.
+      It downloads a backup with the Mongo and RocksDb databases for faster synchronization.
 
   --healthCheck
       It checks if the services created with docker compose are up and running.

src/commands/backup.ts

@@ -17,7 +17,7 @@ import { Command, flags } from '@oclif/command';
 import { BootstrapService, BootstrapUtils } from '../service';
 
 export default class Backup extends Command {
-    static description = `It backups the mongo and data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
+    static description = `The command backups the Mongo and RocksDb data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
 
 Note: this command is designed for NGL to be used when running public main or public test networks. It's not backing up any node specific information.`;
 

src/commands/config.ts

@@ -59,7 +59,7 @@ export default class Config extends Command {
         }),
 
         backupSync: flags.boolean({
-            description: 'It downloads a backup with the mongo and rockdb databases for faster synchronization.',
+            description: 'It downloads a backup with the Mongo and RocksDb databases for faster synchronization.',
             default: ConfigService.defaultParams.backupSync,
         }),
 

src/service/BackupSyncService.ts

@@ -85,6 +85,9 @@ export class BackupSyncService {
                 await this.unzip(fileLocation, 'data', destinationFolder);
             }),
         );
+        logger.info(
+            `Zip backup '${fileLocation}' has been restored. HINT: You can remove this file if you want to reclaim the disk space for future use.`,
+        );
     }
 
     private unzip(globalDestination: string, innerFolder: string, targetFolder: string): Promise<void> {
@@ -208,7 +211,7 @@ export class BackupSyncService {
 
     public async createBackup(passedPresetData?: ConfigPreset): Promise<void> {
         const configLoader = new ConfigLoader();
-        const presetData = passedPresetData ?? configLoader.loadExistingPresetData(this.params.target, '');
+        const presetData = passedPresetData ?? configLoader.loadExistingPresetData(this.params.target, false);
 
         const node = presetData.nodes?.find((node) => (!this.params.nodeName || node.name == this.params.nodeName) && node.api);
         if (!node && this.params.nodeName) {