CR

Signed-off-by: Romy <[email protected]>

Author: romayalon

src/cmd/nsfs.js

@@ -264,10 +264,15 @@ async function init_nc_system(config_root) {
         };
     }
     try {
-        await config_fs.create_system_config_file(JSON.stringify(updated_system_json));
-        console.log('created NSFS system data with version: ', pkg.version);
+        if (system_data) {
+            await config_fs.update_system_config_file(JSON.stringify(updated_system_json));
+            console.log('updated NC system data with version: ', pkg.version);
+        } else {
+            await config_fs.create_system_config_file(JSON.stringify(updated_system_json));
+            console.log('created NC system data with version: ', pkg.version);
+        }
     } catch (err) {
-        const msg = 'failed to create NSFS system data due to - ' + err.message;
+        const msg = 'failed to create/update NC system data due to - ' + err.message;
         const error = new Error(msg);
         console.error(msg, err);
         throw error;

src/manage_nsfs/manage_nsfs_cli_errors.js

@@ -474,6 +474,12 @@ ManageCLIError.UpgradeHistoryFailed = Object.freeze({
     http_code: 500,
 });
 
+ManageCLIError.ConfigDirUpdateBlocked = Object.freeze({
+    code: 'ConfigDirUpdateBlocked',
+    message: 'Config directory updates are not allowed on mismatch of the config directory version mentioned in system.json and the config directory version of the source code',
+    http_code: 500,
+});
+
 ///////////////////////////////
 //       ERRORS MAPPING      //
 ///////////////////////////////
@@ -495,7 +501,8 @@ ManageCLIError.RPC_ERROR_TO_MANAGE = Object.freeze({
     INVALID_SCHEMA: ManageCLIError.InvalidSchema,
     NO_SUCH_USER: ManageCLIError.InvalidAccountDistinguishedName,
     INVALID_MASTER_KEY: ManageCLIError.InvalidMasterKey,
-    INVALID_BUCKET_NAME: ManageCLIError.InvalidBucketName
+    INVALID_BUCKET_NAME: ManageCLIError.InvalidBucketName,
+    CONFIG_DIR_VERSION_MISMATCH: ManageCLIError.ConfigDirUpdateBlocked
 });
 
 const NSFS_CLI_ERROR_EVENT_MAP = {

src/manage_nsfs/manage_nsfs_constants.js

@@ -78,7 +78,7 @@ const VALID_OPTIONS_DIAGNOSE = {
 };
 
 const VALID_OPTIONS_UPGRADE = {
-    'start': new Set([ 'force', 'expected_version', 'custom_upgrade_scripts_dir', ...CLI_MUTUAL_OPTIONS]),
+    'start': new Set([ 'skip_verification', 'expected_version', 'custom_upgrade_scripts_dir', ...CLI_MUTUAL_OPTIONS]),
     'status': new Set([ ...CLI_MUTUAL_OPTIONS]),
     'history': new Set([...CLI_MUTUAL_OPTIONS])
 };
@@ -132,7 +132,8 @@ const OPTION_TYPE = {
     debug: 'number',
     // upgrade options
     expected_version: 'string',
-    custom_upgrade_scripts_dir: 'string'
+    custom_upgrade_scripts_dir: 'string',
+    skip_verification: 'boolean'
 };
 
 const BOOLEAN_STRING_VALUES = ['true', 'false'];

src/manage_nsfs/upgrade.js

@@ -39,11 +39,11 @@ async function manage_upgrade_operations(action, user_input, config_fs) {
  */
 async function exec_config_dir_upgrade(user_input, config_fs) {
     try {
-        const force = user_input.force;
+        const skip_verification = user_input.skip_verification;
         const expected_version = user_input.expected_version;
         const custom_upgrade_scripts_dir = user_input.custom_upgrade_scripts_dir;
 
-        const upgrade_res = await upgrade_config_dir(config_fs, { custom_upgrade_scripts_dir, expected_version, force });
+        const upgrade_res = await upgrade_config_dir(config_fs, { custom_upgrade_scripts_dir, expected_version, skip_verification });
         if (!upgrade_res) throw new Error('Upgrade config directory failed', { cause: upgrade_res });
         write_stdout_response(ManageCLIResponse.UpgradeSuccessful, upgrade_res);
     } catch (err) {

src/sdk/config_fs.js

@@ -14,6 +14,7 @@ const native_fs_utils = require('../util/native_fs_utils');
 const { RpcError } = require('../rpc');
 const nc_mkm = require('../manage_nsfs/nc_master_key_manager').get_instance();
 const nsfs_schema_utils = require('../manage_nsfs/nsfs_schema_utils');
+const { version_compare } = require('../upgrade/upgrade_utils');
 
 /** @typedef {import('fs').Dirent} Dirent */
 
@@ -57,6 +58,15 @@ const SYMLINK_SUFFIX = '.symlink';
 // need to find a better way for atomic unlinking of symbolic links
 // handle atomicity for symlinks
 
+
+/**
+ * config_dir_version is a semver that describes the config directory's version.  
+ * config_dir_version is planned to be upgraded when a change that can not be solved only by backward compatibility 
+ * and must require a use of an upgrade script.
+ * The config directory upgrade script will handle config directory changes of the structure or content of the config files.
+ * The upgrade script will run via `noobaa-cli upgrade run command`
+ */
+
 class ConfigFS {
 
     /**
@@ -987,8 +997,16 @@ class ConfigFS {
     async _throw_if_config_dir_locked() {
         const system_data = await this.get_system_config_file({silent_if_missing: true});
         if (!system_data) return;
-        if (this.config_dir_version !== system_data.config_directory.config_dir_version) {
-            throw new RpcError('BAD_REQUEST');
+        const running_code_config_dir_version = this.config_dir_version;
+        const system_config_dir_version = system_data.config_directory.config_dir_version;
+        const ver_comparison = version_compare(running_code_config_dir_version, system_config_dir_version);
+        if (ver_comparison > 0) {
+            throw new RpcError('CONFIG_DIR_VERSION_MISMATCH', `running code config_dir_version=${running_code_config_dir_version} is higher than the config dir version` +
+                `mentioned in system.json =${system_config_dir_version}, any updates to the config directory are blocked until the config dir upgrade`);
+        }
+        if (ver_comparison < 0) {
+            throw new RpcError('CONFIG_DIR_VERSION_MISMATCH', `running code config_dir_version=${running_code_config_dir_version} is lower than the config dir version` +
+                `mentioned in system.json =${system_config_dir_version}, any updates to the config directory are blocked until the source code upgrade`);
         }
     }
 }

src/upgrade/nc_upgrade_manager.js

@@ -78,7 +78,7 @@ async function update_rpm_upgrade(config_fs) {
  *    4.4. moves the current upgrade from in_progress_upgrade to the upgrade_history.successful_upgrades 
  *    4.5. is 5.17.0 is a good default for from_version?
  * @param {import('../sdk/config_fs').ConfigFS} config_fs
- * @param {{custom_upgrade_scripts_dir?: string, expected_version?: string, force?: boolean}} [upgrade_options]
+ * @param {{custom_upgrade_scripts_dir?: string, expected_version?: string, skip_verification?: boolean}} [upgrade_options]
  * @returns {Promise<Object>}
  */
 async function upgrade_config_dir(config_fs, upgrade_options = {}) {
@@ -91,11 +91,11 @@ async function upgrade_config_dir(config_fs, upgrade_options = {}) {
     const package_from_version = system_data.config_directory.upgrade_package_version;
     const package_to_version = pkg.version;
     const this_upgrade_versions = { config_dir_from_version, config_dir_to_version, package_from_version, package_to_version };
-    const { custom_upgrade_scripts_dir, expected_version, force } = upgrade_options;
+    const { custom_upgrade_scripts_dir, expected_version, skip_verification } = upgrade_options;
 
     if (!should_upgrade(config_dir_from_version, config_dir_to_version)) return { message: 'config_dir_version on system.json and config_fs.config_dir_version match, nothing to upgrade' };
 
-    if (!force) await _verify_config_dir_upgrade(system_data, expected_version);
+    if (!skip_verification) await _verify_config_dir_upgrade(system_data, expected_version);
 
     system_data = await _update_config_dir_upgrade_start(config_fs, system_data, this_upgrade_versions);
     const this_upgrade = system_data.config_directory.in_progress_upgrade;

src/upgrade/upgrade_utils.js

@@ -109,3 +109,4 @@ async function load_required_scripts(server_version, container_version, upgrade_
 
 exports.should_upgrade = should_upgrade;
 exports.load_required_scripts = load_required_scripts;
+exports.version_compare = version_compare;