NSFS | versioning | content directory versioning - list-object + tagging operations

nadavMiz · nadavMiz · commit 08fe0a3e99a6 · 2025-05-06T10:35:46.000+03:00
Signed-off-by: nadav mizrahi &lt;nadav.mizrahi16@gmail.com&gt;
diff --git a/config.js b/config.js
@@ -823,7 +823,6 @@ config.NSFS_RANDOM_DELAY_BASE = 70;
 
 config.NSFS_VERSIONING_ENABLED = true;
 config.NSFS_UPDATE_ISSUES_REPORT_ENABLED = true;
-config.NSFS_CONTENT_DIRECTORY_VERSIONING_ENABLED = false;
 
 config.NSFS_EXIT_EVENTS_TIME_FRAME_MIN = 24 * 60; // per day
 config.NSFS_MAX_EXIT_EVENTS_PER_TIME_FRAME = 10; // allow max 10 failed forks per day
diff --git a/docs/design/NsfsVersioning.md b/docs/design/NsfsVersioning.md
@@ -54,6 +54,36 @@ In the figure, each original directory contains a hidden .versions/ sub- directo
 * When A delete marker is the latest version of an object, it indicates that the object is deleted.
 * A unique version ID will be allocated to the delete marker as for regular versions.
 
+### Directory Object / Content Directory Versioning
+Versioning related xattr - 
+1. `user.noobaa.version_id` - stores the version_id string.
+2. `user.noobaa.delete_marker` - boolean.
+3. `user.noobaa.content_dir` - stores the size of the directory object.
+
+Directory object / content directory filesystem structure has two modes - 
+
+1. versioning disabled mode - 
+On this mode, the object body and the xattr (extended attributes) are splitted. The data of the directory object will be stored in `<dir_path>/.folder`, while the xattr of the directory object will be stored on the directory itself - <dir_path>. `<dir_path>/.folder` file is created only if the object's data size > 0. When size = 0, only the xattr will be stored in `<dir_path>`.
+```
+bucket
+└── dir <= directory object (dir/), includes xattr
+    └──.folder <= file containing dir/ object body
+```
+2. versioning enabled / suspended mode -
+ On this mode we always create `.folder` file. xatrr are located at the `.folder` file. the transition between the disable and enabled/disabled is lazy. meaning that we only change the key structure after a put operation for that key. non-latest versions and delete markers are saved in the directories .versions directory as `.folder-<version-id>`. versioning handling is the same as for non-directory objects. only that the object file used is the  `.folder` file
+example bucket tree:
+```
+bucket
+└── dir
+    ├── .folder <= contains both body (can be empty) and xattr - dir/
+    ├── key1 <= nested object - dir/key1
+    └── .versions
+        ├── .folder_mtime-dzdz6vlnbzblk-ino-4hbc <= version of dir/
+        ├── .folder_mtime-dzdz5vlasfsaw-ino-4hia
+        ├── key1_mtime-d6u6vlnbzklc-ino-3ehc <= version of dir/key1
+        └── key1_mtime-d6u6vnztsiyo-ino-3eik
+```   
+
 ### Posix safe rename
 
 #### In the following cases NooBaa will move files between a directory and its .versions/ directory:
diff --git a/src/sdk/namespace_fs.js b/src/sdk/namespace_fs.js
diff --git a/src/test/unit_tests/coretest.js b/src/test/unit_tests/coretest.js
@@ -27,7 +27,6 @@ config.test_mode = true;
 config.NODES_FREE_SPACE_RESERVE = 10 * 1024 * 1024;
 config.NSFS_VERSIONING_ENABLED = true;
 config.OBJECT_SDK_BUCKET_CACHE_EXPIRY_MS = 1;
-config.NSFS_CONTENT_DIRECTORY_VERSIONING_ENABLED = true;
 
 config.ROOT_KEY_MOUNT = '/tmp/noobaa-server/root_keys';
 
diff --git a/src/test/unit_tests/jest_tests/test_versioning_concurrency.test.js b/src/test/unit_tests/jest_tests/test_versioning_concurrency.test.js
@@ -10,8 +10,6 @@ const buffer_utils = require('../../../util/buffer_utils');
 const { TMP_PATH, IS_GPFS, TEST_TIMEOUT } = require('../../system_tests/test_utils');
 const { crypto_random_string } = require('../../../util/string_utils');
 const endpoint_stats_collector = require('../../../sdk/endpoint_stats_collector');
-const config = require('../../../../config');
-config.NSFS_CONTENT_DIRECTORY_VERSIONING_ENABLED = true;
 
 function make_dummy_object_sdk(nsfs_config, uid, gid) {
     return {
@@ -635,8 +633,7 @@ describe('test versioning concurrency', () => {
         expect(successful_operations).toHaveLength(num_of_concurrency);
         expect(failed_operations).toHaveLength(0);
         const versions = await nsfs.list_object_versions({ bucket: bucket }, DUMMY_OBJECT_SDK);
-        //TODO should be num_of_concurrency + 1 (the null version). list-object-version currently ignores the latest .folder file
-        expect(versions.objects.length).toBe(num_of_concurrency);
+        expect(versions.objects.length).toBe(num_of_concurrency + 1);
     }, TEST_TIMEOUT);
 });
 
diff --git a/src/test/unit_tests/nc_coretest.js b/src/test/unit_tests/nc_coretest.js
@@ -205,7 +205,6 @@ async function config_dir_setup() {
         // DO NOT CHANGE - setting VACCUM_ANALYZER_INTERVAL=1 needed for failing the tests
         // in case where vaccumAnalyzer is being called before setting process.env.NC_NSFS_NO_DB_ENV = 'true' on nsfs.js
         VACCUM_ANALYZER_INTERVAL: 1,
-        NSFS_CONTENT_DIRECTORY_VERSIONING_ENABLED: true
     }));
     await fs.promises.mkdir(FIRST_BUCKET_PATH, { recursive: true });
 }
diff --git a/src/test/unit_tests/test_bucketspace_versioning.js b/src/test/unit_tests/test_bucketspace_versioning.js
@@ -16,6 +16,7 @@ const { TMP_PATH, IS_GPFS, is_nc_coretest, set_path_permissions_and_owner, gener
     invalid_nsfs_root_permissions, generate_s3_client, get_coretest_path } = require('../system_tests/test_utils');
 const { get_process_fs_context } = require('../../util/native_fs_utils');
 const _ = require('lodash');
+const config = require('../../../config');
 
 const coretest_path = get_coretest_path();
 const coretest = require(coretest_path);
@@ -452,6 +453,7 @@ mocha.describe('bucketspace namespace_fs - versioning', function() {
             await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: head_object_key, Body: body1 });
             await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: get_object_key, Body: body1 });
             await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: delete_latest_object_key, Body: body1 });
+            await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: delete_latest_object_key_suspended, Body: body1 });
 
             await s3_uid6.putBucketVersioning({ Bucket: content_dir_bucket_name, VersioningConfiguration: { MFADelete: 'Disabled', Status: 'Enabled' } });
         });
@@ -640,7 +642,135 @@ mocha.describe('bucketspace namespace_fs - versioning', function() {
 
             const get_res = await s3_uid6.getObject({ Bucket: content_dir_bucket_name, Key: key });
             assert.equal(get_res.VersionId, res2.VersionId);
+        });
+
+        mocha.it('content directory - object tagging - versioning enabled', async function() {
+            const dir_tagging_key = 'dir_tagging/';
+            const tag_set1 = { TagSet: [{ Key: "key1", Value: "Value1" }] };
+            const tag_set2 = { TagSet: [{ Key: "key2", Value: "Value2" }] };
+
+            await s3_uid6.putBucketVersioning({ Bucket: content_dir_bucket_name, VersioningConfiguration: { MFADelete: 'Disabled', Status: 'Enabled' } });
+            const res_put = await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, Body: body1 });
+            await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, Body: body1 });
+            const version_id = res_put.VersionId;
+
+            await s3_uid6.putObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, Tagging: tag_set1 });
+            let res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key });
+            assert.deepEqual(res.TagSet, tag_set1.TagSet);
+
+            await s3_uid6.putObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key,
+                Tagging: tag_set2, VersionId: version_id });
+            res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key });
+            assert.notDeepEqual(res.TagSet, tag_set2);
+
+            const version_res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name,
+                Key: dir_tagging_key, VersionId: version_id });
+            assert.deepEqual(version_res.TagSet, tag_set2.TagSet);
+
+            await s3_uid6.deleteObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key });
+            res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key });
+            assert.equal(res.TagSet.length, 0);
+
+            await s3_uid6.deleteObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, VersionId: version_id });
+            res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, VersionId: version_id });
+            assert.equal(res.TagSet.length, 0);
+        });
+
+        mocha.it('content directory - object tagging - versioning suspended', async function() {
+            const dir_tagging_key = 'dir_tagging/';
+            const tag_set1 = { TagSet: [{ Key: "key1", Value: "Value1" }] };
+            const tag_set2 = { TagSet: [{ Key: "key2", Value: "Value2" }] };
+
+            await s3_uid6.putBucketVersioning({ Bucket: content_dir_bucket_name, VersioningConfiguration: { MFADelete: 'Disabled', Status: 'Suspended' } });
+            const res_put = await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, Body: body1 });
+            await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, Body: body1 });
+            const version_id = res_put.VersionId;
+
+            await s3_uid6.putObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, Tagging: tag_set1 });
+            let res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key });
+            assert.deepEqual(res.TagSet, tag_set1.TagSet);
+
+            await s3_uid6.putObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key,
+                Tagging: tag_set2, VersionId: version_id });
+            res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key });
+            assert.notDeepEqual(res.TagSet, tag_set2);
 
+            const version_res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name,
+                Key: dir_tagging_key, VersionId: version_id });
+            assert.deepEqual(version_res.TagSet, tag_set2.TagSet);
+
+            await s3_uid6.deleteObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key });
+            res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key });
+            assert.equal(res.TagSet.length, 0);
+
+            await s3_uid6.deleteObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, VersionId: version_id });
+            res = await s3_uid6.getObjectTagging({ Bucket: content_dir_bucket_name, Key: dir_tagging_key, VersionId: version_id });
+            assert.equal(res.TagSet.length, 0);
+        });
+
+        mocha.it('content directory - list object', async function() {
+            const res = await s3_uid6.listObjects({ Bucket: content_dir_bucket_name });
+            assert.equal(res.Contents.length, 10);
+        });
+
+        mocha.it('content directory - list object versions - enabled mode', async function() {
+            await s3_uid6.putBucketVersioning({ Bucket: content_dir_bucket_name, VersioningConfiguration: { MFADelete: 'Disabled', Status: 'Enabled' } });
+            const key = "list_key/";
+            const version_ids = new Set();
+            let push_res = await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: key, Body: body1 });
+            version_ids.add(push_res.VersionId);
+            push_res = await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: key, Body: body1 });
+            version_ids.add(push_res.VersionId);
+            push_res = await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: key, Body: body1 });
+            version_ids.add(push_res.VersionId);
+            const list_res = await s3_uid6.listObjectVersions({ Bucket: content_dir_bucket_name });
+            const key_list_versions = list_res.Versions.filter(v => v.Key === key);
+            assert.equal(key_list_versions.length, version_ids.size);
+            key_list_versions.forEach(v => {
+                assert(version_ids.has(v.VersionId));
+                if (v.VersionId === push_res.VersionId) {
+                    assert.equal(v.IsLatest, true);
+                    assert(!v.Key.includes(config.NSFS_FOLDER_OBJECT_NAME));
+                    assert(!v.VersionId.includes(config.NSFS_FOLDER_OBJECT_NAME));
+                }
+            });
+        });
+
+        mocha.it('content directory - list object versions - delete marker', async function() {
+            const key = "list_key/";
+            const delete_res = await s3_uid6.deleteObject({ Bucket: content_dir_bucket_name, Key: key });
+            const list_res = await s3_uid6.listObjectVersions({ Bucket: content_dir_bucket_name });
+            const key_list_versions = list_res.Versions.filter(v => v.Key === key);
+            assert.equal(key_list_versions.length, 3);
+            assert.equal(list_res.DeleteMarkers.length, 3); // 2 previous delete markers + 1 new delete marker 
+            let is_delete_marker_present = false;
+            for (const delete_marker of list_res.DeleteMarkers) {
+                if (delete_marker.versionId === delete_res.created_version_id) {
+                    is_delete_marker_present = true;
+                    assert.equal(delete_marker.versionId, delete_res.created_version_id);
+                    assert.equal(delete_marker.IsLatest, true);
+                    assert(!delete_marker.Key.includes(config.NSFS_FOLDER_OBJECT_NAME));
+                    assert(!delete_marker.VersionId.includes(config.NSFS_FOLDER_OBJECT_NAME));
+                }
+            }
+            assert(is_delete_marker_present);
+        });
+
+        mocha.it('content directory - list object versions - suspended mode', async function() {
+            const key = "list_key/";
+            await s3_uid6.putBucketVersioning({ Bucket: content_dir_bucket_name, VersioningConfiguration: { MFADelete: 'Disabled', Status: 'Suspended' } });
+            const push_res = await s3_uid6.putObject({ Bucket: content_dir_bucket_name, Key: key, Body: body1 });
+            const list_res = await s3_uid6.listObjectVersions({ Bucket: content_dir_bucket_name });
+            const key_list_versions = list_res.Versions.filter(v => v.Key === key);
+            assert.equal(key_list_versions.length, 4); //3 from before + 1 new key
+            key_list_versions.forEach(v => {
+                if (v.VersionId === push_res.VersionId) {
+                    assert.equal(v.VersionId, 'null');
+                    assert.equal(v.IsLatest, true);
+                    assert(!v.key.includes(config.NSFS_FOLDER_OBJECT_NAME));
+                    assert(!v.VersionId.includes(config.NSFS_FOLDER_OBJECT_NAME));
+                }
+            });
         });
     });
 
@@ -3419,10 +3549,10 @@ function _extract_version_info_from_xattr(version_id_str) {
 
 /**
  * version_file_exists returns path of version in .versions
- * @param {String} full_path 
- * @param {String} key 
- * @param {String} dir 
- * @param {String} version_id 
+ * @param {String} full_path
+ * @param {String} key
+ * @param {String} dir
+ * @param {String} version_id
  * @returns {Promise<Boolean>}
  */
 async function version_file_exists(full_path, key, dir, version_id) {
diff --git a/src/test/unit_tests/test_namespace_fs.js b/src/test/unit_tests/test_namespace_fs.js
@@ -42,8 +42,6 @@ const DEFAULT_FS_CONFIG = get_process_fs_context();
 const empty_data = crypto.randomBytes(0);
 const empty_stream = () => buffer_utils.buffer_to_read_stream(empty_data);
 
-config.NSFS_CONTENT_DIRECTORY_VERSIONING_ENABLED = true;
-
 function make_dummy_object_sdk(config_root) {
     return {
         requesting_account: {

Original file line number	Diff line number	Diff line change
`@@ -205,7 +205,6 @@ async function config_dir_setup() {`
`205`	`205`	`// DO NOT CHANGE - setting VACCUM_ANALYZER_INTERVAL=1 needed for failing the tests`
`206`	`206`	`// in case where vaccumAnalyzer is being called before setting process.env.NC_NSFS_NO_DB_ENV = 'true' on nsfs.js`
`207`	`207`	`VACCUM_ANALYZER_INTERVAL: 1,`
`208`		`- NSFS_CONTENT_DIRECTORY_VERSIONING_ENABLED: true`
`209`	`208`	`}));`
`210`	`209`	`await fs.promises.mkdir(FIRST_BUCKET_PATH, { recursive: true });`
`211`	`210`	`}`