Skip to content

NC | Lifecycle | An internal file/folder should be blocked for deletion by the lifecycle worker #9073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

NC | Lifecycle | An internal file/folder should be blocked for deletion by the lifecycle worker #9073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 72 additions & 6 deletions src/test/unit_tests/jest_tests/test_nc_lifecycle.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,44 @@ describe('delete_multiple_objects + filter', () => {
await assert_object_deletion_failed(delete_res);
});

it('delete_multiple_objects - filter should fail on internal dir - empty prefix - versioning DISABLED bucket', async () => {
const object_upload_res = await nsfs.create_object_upload({ key: key, bucket: bucket_name }, dummy_object_sdk);
const internal_file_path = path.join(nsfs.get_bucket_tmpdir_name(), 'multipart-uploads', object_upload_res.obj_id, 'create_object_upload');
const filter_func = lifecycle_utils.build_lifecycle_filter({ filter: { prefix: '' }, expiration: 0 });
const deleted_objects_arr = [{ key: internal_file_path }];
const delete_res = await nsfs.delete_multiple_objects({ objects: deleted_objects_arr, filter_func }, dummy_object_sdk);
await assert_object_deletion_failed(delete_res, undefined, deleted_objects_arr);
});

it('delete_multiple_objects - filter should fail on internal dir - versioning DISABLED bucket', async () => {
const object_upload_res = await nsfs.create_object_upload({ key: key, bucket: bucket_name }, dummy_object_sdk);
const internal_file_path = path.join(nsfs.get_bucket_tmpdir_name(), 'multipart-uploads', object_upload_res.obj_id, 'create_object_upload');
const filter_func = lifecycle_utils.build_lifecycle_filter({ filter: { prefix: internal_file_path }, expiration: 0 });
const deleted_objects_arr = [{ key: internal_file_path }];
const delete_res = await nsfs.delete_multiple_objects({ objects: deleted_objects_arr, filter_func }, dummy_object_sdk);
await assert_object_deletion_failed(delete_res, undefined, deleted_objects_arr);
});

it('delete_multiple_objects - filter should fail on internal .folder object - empty prefix - versioning DISABLED bucket', async () => {
const directory_object_key = 'folder1/';
const data_buffer = buffer_utils.buffer_to_read_stream(data);
await nsfs.upload_object({ bucket: bucket_name, key: directory_object_key, source_stream: data_buffer }, dummy_object_sdk);
const filter_func = lifecycle_utils.build_lifecycle_filter({ filter: { prefix: '' }, expiration: 0 });
const deleted_objects_arr = [{ key: `${directory_object_key}${config.NSFS_FOLDER_OBJECT_NAME}` }];
const delete_res = await nsfs.delete_multiple_objects({ objects: deleted_objects_arr, filter_func }, dummy_object_sdk);
await assert_object_deletion_failed(delete_res, undefined, deleted_objects_arr);
});

it('delete_multiple_objects - filter should fail on internal .folder object - versioning DISABLED bucket', async () => {
const directory_object_key = 'folder1/';
const data_buffer = buffer_utils.buffer_to_read_stream(data);
await nsfs.upload_object({ bucket: bucket_name, key: directory_object_key, source_stream: data_buffer }, dummy_object_sdk);
const filter_func = lifecycle_utils.build_lifecycle_filter({ filter: { prefix: directory_object_key }, expiration: 0 });
const deleted_objects_arr = [{ key: `${directory_object_key}${config.NSFS_FOLDER_OBJECT_NAME}` }];
const delete_res = await nsfs.delete_multiple_objects({ objects: deleted_objects_arr, filter_func }, dummy_object_sdk);
await assert_object_deletion_failed(delete_res, undefined, deleted_objects_arr);
});

it('delete_multiple_objects - filter should fail on wrong object_size_less_than - versioning DISABLED bucket', async () => {
const data_buffer = buffer_utils.buffer_to_read_stream(data);
await nsfs.upload_object({ bucket: bucket_name, key: key, source_stream: data_buffer }, dummy_object_sdk);
Expand Down Expand Up @@ -180,6 +218,33 @@ describe('delete_multiple_objects + filter', () => {
await assert_object_deletion_failed(delete_res);
});

it('delete_multiple_objects - filter should fail on internal .versions file - versioning ENABLED bucket', async () => {
nsfs.versioning = 'ENABLED';
const data_buffer1 = buffer_utils.buffer_to_read_stream(data);
const data_buffer2 = buffer_utils.buffer_to_read_stream(data);
const { version_id } = await nsfs.upload_object({ bucket: bucket_name, key, source_stream: data_buffer1 }, dummy_object_sdk);
await nsfs.upload_object({ bucket: bucket_name, key, source_stream: data_buffer2 }, dummy_object_sdk);
const version_file_path = path.join('.versions', key + '_' + version_id);
const deleted_objects_arr = [{ key: version_file_path }];
const filter_func = lifecycle_utils.build_lifecycle_filter({ filter: { prefix: '' }, expiration: 0 });
const delete_res = await nsfs.delete_multiple_objects({ objects: deleted_objects_arr, filter_func }, dummy_object_sdk);
await assert_object_deletion_failed(delete_res, undefined, deleted_objects_arr);
});


it('delete_multiple_objects - filter should fail on internal .versions file - versioning ENABLED bucket', async () => {
nsfs.versioning = 'ENABLED';
const data_buffer1 = buffer_utils.buffer_to_read_stream(data);
const data_buffer2 = buffer_utils.buffer_to_read_stream(data);
const { version_id } = await nsfs.upload_object({ bucket: bucket_name, key, source_stream: data_buffer1 }, dummy_object_sdk);
await nsfs.upload_object({ bucket: bucket_name, key, source_stream: data_buffer2 }, dummy_object_sdk);
const version_file_path = path.join('.versions', key + '_' + version_id);
const deleted_objects_arr = [{ key: version_file_path }];
const filter_func = lifecycle_utils.build_lifecycle_filter({ filter: { prefix: version_file_path }, expiration: 0 });
const delete_res = await nsfs.delete_multiple_objects({ objects: deleted_objects_arr, filter_func }, dummy_object_sdk);
await assert_object_deletion_failed(delete_res, undefined, deleted_objects_arr);
});

it('delete_multiple_objects - filter should fail on wrong object_size_less_than - versioning ENABLED bucket', async () => {
nsfs.versioning = 'ENABLED';
const data_buffer = buffer_utils.buffer_to_read_stream(data);
Expand Down Expand Up @@ -561,16 +626,17 @@ describe('delete_multiple_objects + filter', () => {
* @param {{latest_delete_marker?: boolean}} [options]
* @returns {Promise<Void>}
*/
async function assert_object_deletion_failed(delete_res, { latest_delete_marker = false } = {}) {
expect(delete_res.length).toBe(1);
async function assert_object_deletion_failed(delete_res, { latest_delete_marker = false } = {}, delete_objects_arr = undefined) {
const assert_key = delete_objects_arr ? delete_objects_arr[0].key : key;
expect(delete_res.length).toBe(delete_objects_arr ? delete_objects_arr.length : 1);
expect(delete_res[0].err_code).toBeDefined();
expect(delete_res[0].err_message).toBe('file_matches_filter lifecycle - filter on file returned false ' + key);
expect(delete_res[0].err_message).toBe('file_matches_filter lifecycle - filter on file returned false ' + assert_key);
// file was not deleted
if (latest_delete_marker) {
await expect(nsfs.read_object_md({ bucket: bucket_name, key: key }, dummy_object_sdk)).rejects.toThrow('No such file or directory');
await expect(nsfs.read_object_md({ bucket: bucket_name, key: assert_key }, dummy_object_sdk)).rejects.toThrow('No such file or directory');
} else {
const object_metadata = await nsfs.read_object_md({ bucket: bucket_name, key: key }, dummy_object_sdk);
expect(object_metadata.key).toBe(key);
const object_metadata = await nsfs.read_object_md({ bucket: bucket_name, key: assert_key }, dummy_object_sdk);
expect(object_metadata.key).toBe(assert_key);
}
}

Expand Down
1 change: 0 additions & 1 deletion src/test/unit_tests/test_s3_ops.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,6 @@ mocha.describe('s3_ops', function() {

// make an OPTIONS request without the allowed header
const url = new URL(coretest.get_https_address());
console.log('ROMY DEBUG: url', url, url.hostname, url.port, url.pathname);
const response = await http_utils.make_https_request({
hostname: url.hostname,
port: url.port,
Expand Down
5 changes: 5 additions & 0 deletions src/util/lifecycle_utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,11 @@ function build_lifecycle_filter(params) {
* @param {Object} object_info
*/
return function(object_info) {
// fail if object is a temp file/part or a folder object or a versioned object
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this logic is shared with list-object. and we would need to change in both cases in case there will be a new hidden file/folder added. maybe we should add a utility function to check if file is internal directory?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you explain why would we need to change in 2 different places if this function is shared?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

they are both intended to ignore internal directories when going over files. if there is a new internal directory. we would need to ignore it in both

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indeed, since both places using this function why would we need to change in 2 different places? or I don't get your point...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean list-object in general regardless of lifecycle:

if (!ent.name.startsWith(prefix_ent) ||
    ent.name < marker_curr ||
    ent.name === this.get_bucket_tmpdir_name() ||
    (ent.name === config.NSFS_FOLDER_OBJECT_NAME && is_disabled_dir_content) ||
    this._is_hidden_version_path(ent.name)) {
    return;
}

if (object_info.key.startsWith(config.NSFS_TEMP_DIR_NAME)) return false;
if (object_info.key.includes(config.NSFS_FOLDER_OBJECT_NAME)) return false;
if (object_info.key.includes('.versions/')) return false;

if (params.filter?.prefix && !object_info.key.startsWith(params.filter.prefix)) return false;
if (params.expiration && object_info.age < params.expiration) return false;
if (params.filter?.tags && !file_contain_tags(object_info, params.filter.tags)) return false;
Expand Down