Merge pull request #8997 from shirady/fix-list-object-versions

`ListObjects` `ListObjectVersions` API | Fix encoded url of `undefined` value

Author: shirady

src/endpoint/s3/ops/s3_get_bucket_versions.js

@@ -37,11 +37,11 @@ async function get_bucket_versions(req) {
     return {
         ListVersionsResult: [{
             Name: req.params.bucket,
-            Prefix: field_encoder(req.query.prefix),
+            Prefix: field_encoder(req.query.prefix) || '',
             Delimiter: field_encoder(req.query.delimiter),
             MaxKeys: max_keys_received,
-            KeyMarker: field_encoder(req.query['key-marker']),
-            VersionIdMarker: version_id_marker,
+            KeyMarker: field_encoder(req.query['key-marker']) || '',
+            VersionIdMarker: version_id_marker || '',
             IsTruncated: reply.is_truncated,
             NextKeyMarker: field_encoder(reply.next_marker),
             NextVersionIdMarker: reply.next_version_id_marker,

src/endpoint/s3/s3_utils.js

@@ -695,6 +695,7 @@ function response_field_encoder_none(value) {
 * with plus (+) instead of spaces (and not %20 as encodeURIComponent() does)
 */
 function response_field_encoder_url(value) {
+    if (value === undefined) return undefined; // else the undefined value will be a string of 'undefined'
     return new URLSearchParams({ 'a': value }).toString().slice(2); // slice the leading 'a='
 }
 
@@ -864,6 +865,7 @@ exports.get_http_response_from_resp = get_http_response_from_resp;
 exports.get_http_response_date = get_http_response_date;
 exports.XATTR_SORT_SYMBOL = XATTR_SORT_SYMBOL;
 exports.get_response_field_encoder = get_response_field_encoder;
+exports.response_field_encoder_url = response_field_encoder_url;
 exports.parse_decimal_int = parse_decimal_int;
 exports.parse_restore_request_days = parse_restore_request_days;
 exports.parse_version_id = parse_version_id;

src/test/unit_tests/jest_tests/test_s3_utils.test.js

@@ -200,4 +200,32 @@ describe('s3_utils', () => {
             expect(res.restrict_public_buckets).toBe(false);
         });
     });
+
+    describe('response_field_encoder_url', () => {
+        it('should return undefined value', () => {
+            const value = undefined;
+            const field_encoded = s3_utils.response_field_encoder_url(value);
+            expect(field_encoded).toBe(undefined);
+            expect(typeof field_encoded).not.toBe('string');
+
+        });
+        it('should encode value without spaces (no special characters)', () => {
+            const value = 'test';
+            const field_encoded = s3_utils.response_field_encoder_url(value);
+            expect(typeof field_encoded).toBe('string');
+            expect(field_encoded).toBe(value);
+        });
+        it('should encode value without spaces (with special characters)', () => {
+            const value = 'photos/';
+            const field_encoded = s3_utils.response_field_encoder_url(value);
+            expect(typeof field_encoded).toBe('string');
+            expect(field_encoded).toBe('photos%2F');
+        });
+        it('should encode value with spaces', () => {
+            const value = 'my test';
+            const field_encoded = s3_utils.response_field_encoder_url(value);
+            expect(typeof field_encoded).toBe('string');
+            expect(field_encoded).toBe('my+test');
+        });
+    });
 });