INTEGRATION [PR#1198 > development/8.1] ft: S3C-3118-flatten-objmd-retentioninfo

lib/models/ObjectMD.js

@@ -1084,25 +1084,39 @@ class ObjectMD {
     }
 
     /**
-     * Set object retention information
-     * @param {object} retentionInfo - retention information object
+     * Set object retention mode
+     * @param {string} mode - should be one of 'GOVERNANCE', 'COMPLIANCE'
      * @return {ObjectMD} itself
      */
-    setRetentionInfo(retentionInfo) {
-        const { mode, retainUntilDate } = retentionInfo;
-        this._data.retentionInfo = {
-            mode,
-            retainUntilDate,
-        };
+    setRetentionMode(mode) {
+        this._data.retentionMode = mode;
         return this;
     }
 
     /**
-     * Returns object retention information
-     * @return {object} metadata object
+     * Set object retention retain until date
+     * @param {string} date - date in ISO-8601 format
+     * @return {ObjectMD} itself
+     */
+    setRetentionDate(date) {
+        this._data.retentionDate = date;
+        return this;
+    }
+
+    /**
+     * Returns object retention mode
+     * @return {string} retention mode string
+     */
+    getRetentionMode() {
+        return this._data.retentionMode;
+    }
+
+    /**
+     * Returns object retention retain until date
+     * @return {string} retention date string
      */
-    getRetentionInfo() {
-        return this._data.retentionInfo;
+    getRetentionDate() {
+        return this._data.retentionDate;
     }
 
     /**

lib/s3middleware/objectRetention.js

@@ -95,16 +95,14 @@ function validateRetention(parsedXml) {
         retentionObj.error = dateObj.error;
         return retentionObj;
     }
-    retentionObj.retention = {
-        mode: modeObj.mode,
-        retainUntilDate: dateObj.date,
-    };
+    retentionObj.mode = modeObj.mode;
+    retentionObj.date = dateObj.date;
     return retentionObj;
 }
 
 /**
  * parseRetentionXml - Parse and validate xml body, returning callback with
- * object retentionInfo: { mode: <value>, retainUntilDate: <value> }
+ * object retentionObj: { mode: <value>, date: <value> }
  * @param {string} xml - xml body to parse and validate
  * @param {object} log - Werelogs logger
  * @param {function} cb - callback to server
@@ -135,16 +133,16 @@ function parseRetentionXml(xml, log, cb) {
 
 /**
  * convertToXml - Convert retention info object to xml
- * @param {object} retentionInfo - retention information object
+ * @param {string} mode - retention mode
+ * @param {string} date - retention retain until date
  * @return {string} - returns retention information xml string
  */
-function convertToXml(retentionInfo) {
+function convertToXml(mode, date) {
     const xml = [];
-    const ret = retentionInfo.retention;
     xml.push('<Retention xmlns="http://s3.amazonaws.com/doc/2006-03-01/">');
-    if (ret && ret.mode && ret.retainUntilDate) {
-        xml.push(`<Mode>${ret.mode}</Mode>`);
-        xml.push(`<RetainUntilDate>${ret.retainUntilDate}</RetainUntilDate>`);
+    if (mode && date) {
+        xml.push(`<Mode>${mode}</Mode>`);
+        xml.push(`<RetainUntilDate>${date}</RetainUntilDate>`);
     } else {
         return '';
     }

tests/unit/models/ObjectMD.js

@@ -4,6 +4,8 @@ const constants = require('../../../lib/constants');
 
 const retainDate = new Date();
 retainDate.setDate(retainDate.getDate() + 1);
+const laterDate = new Date();
+laterDate.setDate(laterDate.getDate() + 5);
 
 describe('ObjectMD class setters/getters', () => {
     let md = null;
@@ -124,10 +126,8 @@ describe('ObjectMD class setters/getters', () => {
         }],
         ['LegalHold', null, false],
         ['LegalHold', true],
-        ['RetentionInfo', {
-            mode: 'GOVERNANCE',
-            retainUntilDate: retainDate.toISOString(),
-        }],
+        ['RetentionMode', 'GOVERNANCE'],
+        ['RetentionDate', retainDate.toISOString()],
     ].forEach(test => {
         const property = test[0];
         const testValue = test[1];
@@ -286,15 +286,14 @@ describe('ObjectMD class setters/getters', () => {
         });
     });
 
-    it('ObjectMD::set/getRetentionInfo', () => {
-        md.setRetentionInfo({
-            mode: 'COMPLIANCE',
-            retainUntilDate: retainDate.toISOString(),
-        });
-        assert.deepStrictEqual(md.getRetentionInfo(), {
-            mode: 'COMPLIANCE',
-            retainUntilDate: retainDate.toISOString(),
-        });
+    it('ObjectMD::set/getRetentionMode', () => {
+        md.setRetentionMode('COMPLIANCE');
+        assert.deepStrictEqual(md.getRetentionMode(), 'COMPLIANCE');
+    });
+
+    it('ObjectMD::set/getRetentionDate', () => {
+        md.setRetentionDate(laterDate.toISOString());
+        assert.deepStrictEqual(md.getRetentionDate(), laterDate.toISOString());
     });
 });
 

tests/unit/s3middleware/objectRetention.js

@@ -28,10 +28,8 @@ function buildXml(key, value) {
 }
 
 const expectedRetention = {
-    retention: {
-        mode: 'GOVERNANCE',
-        retainUntilDate: passDate.toISOString(),
-    },
+    mode: 'GOVERNANCE',
+    date: passDate.toISOString(),
 };
 
 const expectedXml =
@@ -109,21 +107,20 @@ describe('object Retention validation', () => {
 });
 
 describe('object Retention xml', () => {
-    it('should return empty string if no retention info', done => {
-        const xml = convertToXml({});
+    it('should return empty string if no retention date', done => {
+        const xml = convertToXml('GOVERNANCE', '');
         assert.equal(xml, '');
         done();
     });
 
-    it('should return empty string if retention info is empty', done => {
-        const xml = convertToXml(
-            { retention: { mode: '', retainUntilDate: '' } });
+    it('should return empty string if no retention mode', done => {
+        const xml = convertToXml('', passDate.toISOString());
         assert.equal(xml, '');
         done();
     });
 
     it('should return xml string', done => {
-        const xml = convertToXml(expectedRetention);
+        const xml = convertToXml('GOVERNANCE', passDate.toISOString());
         assert.strictEqual(xml, expectedXml);
         done();
     });