use deleteObject to expire objects in S3c

Zenko supports the "deleteObjectFromExpiration" API, which
sets the proper originOp in the metadata to trigger a nortification
when an object gets expired. S3C doesn't support that API, so we
switch to the standard deleteObject API in this case.

Issue: BB-556

extensions/lifecycle/tasks/LifecycleDeleteObjectTask.js

@@ -98,6 +98,27 @@ class LifecycleDeleteObjectTask extends BackbeatTask {
         return done();
     }
 
+    _getS3Action(actionType, accountId) {
+        let reqMethod;
+        if (actionType === 'deleteObject') {
+            const backbeatClient = this.getBackbeatClient(accountId);
+            if (!backbeatClient) {
+                return null;
+            }
+            // Zenko supports the "deleteObjectFromExpiration" API, which
+            // sets the proper originOp in the metadata to trigger a
+            // nortification when an object gets expired.
+            if (typeof backbeatClient.deleteObjectFromExpiration === 'function') {
+                return backbeatClient.deleteObjectFromExpiration.bind(backbeatClient);
+            }
+            reqMethod = 'deleteObject';
+        } else {
+            reqMethod = 'abortMultipartUpload';
+        }
+        const client = this.getS3Client(accountId);
+        return client[reqMethod].bind(client);
+    }
+
     _executeDelete(entry, startTime, log, done) {
         const { accountId } = entry.getAttribute('target');
 
@@ -115,34 +136,24 @@ class LifecycleDeleteObjectTask extends BackbeatTask {
         const transitionTime = entry.getAttribute('transitionTime');
         const location = this.objectMD?.dataStoreName || entry.getAttribute('details.dataStoreName');
         let req = null;
-        if (actionType === 'deleteObject') {
-            reqMethod = 'deleteObject';
-            const backbeatClient = this.getBackbeatClient(accountId);
-            if (!backbeatClient) {
-                log.error('failed to get backbeat client', { accountId });
-                return done(errors.InternalError
-                    .customizeDescription('Unable to obtain client'));
-            }
-
-            LifecycleMetrics.onLifecycleStarted(log, 'expiration',
-                location, startTime - transitionTime);
 
-            req = backbeatClient.deleteObjectFromExpiration(reqParams);
-        } else if (actionType === 'deleteMPU') {
+        const s3Action = this._getS3Action(actionType, accountId);
+        if (!s3Action) {
+            log.error('failed to get s3 action', {
+                accountId,
+                actionType,
+                method: 'LifecycleDeleteObjectTask._executeDelete',
+            });
+            return done(errors.InternalError
+                .customizeDescription('Unable to obtain s3 action'));
+        }
+        LifecycleMetrics.onLifecycleStarted(log,
+            actionType === 'deleteMPU' ? 'expiration:mpu' : 'expiration',
+            location, startTime - transitionTime);
+        if (actionType === 'deleteMPU') {
             reqParams.UploadId = entry.getAttribute('details.UploadId');
-            reqMethod = 'abortMultipartUpload';
-            const s3Client = this.getS3Client(accountId);
-            if (!s3Client) {
-                log.error('failed to get S3 client', { accountId });
-                return done(errors.InternalError
-                    .customizeDescription('Unable to obtain client'));
-            }
-
-            LifecycleMetrics.onLifecycleStarted(log, 'expiration:mpu',
-                location, startTime - transitionTime);
-
-            req = s3Client[reqMethod](reqParams);
         }
+        req = s3Action(reqParams);
         attachReqUids(req, log);
         return req.send(err => {
             LifecycleMetrics.onS3Request(log, reqMethod, 'expiration', err);

tests/unit/lifecycle/LifecycleDeleteObjectTask.spec.js

@@ -1,4 +1,5 @@
 const assert = require('assert');
+const sinon = require('sinon');
 const { errors } = require('arsenal');
 const werelogs = require('werelogs');
 const { ObjectMD } = require('arsenal').models;
@@ -226,4 +227,79 @@ describe('LifecycleDeleteObjectTask', () => {
             done();
         });
     });
+
+    it('should expire object using the deleteObjectFromExpiration method if supported', done => {
+        const entry = ActionQueueEntry.create('deleteObject')
+            .setAttribute('target.owner', 'testowner')
+            .setAttribute('target.bucket', 'testbucket')
+            .setAttribute('target.accountId', 'testid')
+            .setAttribute('target.key', 'testkey')
+            .setAttribute('target.version', 'testversion')
+            .setAttribute('details.lastModified', '2022-05-13T17:51:31.261Z');
+        s3Client.setResponse(null, {});
+        backbeatClient.setResponse(null, {});
+        task.processActionEntry(entry, err => {
+            assert.ifError(err);
+            assert.strictEqual(backbeatClient.times.deleteObjectFromExpiration, 1);
+            assert.strictEqual(s3Client.calls.deleteObject, 0);
+            done();
+        });
+    });
+
+    it('should expire object using the deleteObject method when not in Zenko', done => {
+        backbeatClient = new BackbeatClientMock({ isS3c: true });
+        sinon.stub(task, 'getBackbeatClient').returns(backbeatClient);
+        const entry = ActionQueueEntry.create('deleteObject')
+            .setAttribute('target.owner', 'testowner')
+            .setAttribute('target.bucket', 'testbucket')
+            .setAttribute('target.accountId', 'testid')
+            .setAttribute('target.key', 'testkey')
+            .setAttribute('target.version', 'testversion')
+            .setAttribute('details.lastModified', '2022-05-13T17:51:31.261Z');
+        s3Client.setResponse(null, {});
+        backbeatClient.setResponse(null, {});
+        task.processActionEntry(entry, err => {
+            assert.ifError(err);
+            assert.strictEqual(s3Client.calls.deleteObject, 1);
+            assert.strictEqual(backbeatClient.times.deleteObjectFromExpiration, 0);
+            done();
+        });
+    });
+
+    it('should abort an MPU using the abortMultipartUpload method', done => {
+        const entry = ActionQueueEntry.create('deleteMPU')
+            .setAttribute('target.owner', 'testowner')
+            .setAttribute('target.bucket', 'testbucket')
+            .setAttribute('target.accountId', 'testid')
+            .setAttribute('target.key', 'testkey')
+            .setAttribute('target.version', 'testversion')
+            .setAttribute('details.UploadId', 'someUploadId')
+            .setAttribute('details.lastModified', '2022-05-13T17:51:31.261Z');
+        s3Client.setResponse(null, {});
+        backbeatClient.setResponse(null, {});
+        task.processActionEntry(entry, err => {
+            assert.ifError(err);
+            assert.strictEqual(s3Client.calls.abortMultipartUpload, 1);
+            assert.strictEqual(s3Client.calls.deleteObject, 0);
+            assert.strictEqual(backbeatClient.times.deleteObjectFromExpiration, 0);
+            done();
+        });
+    });
+
+    it('should return an error when it can\'t get the BackbeatClinet', done => {
+        sinon.stub(task, 'getBackbeatClient').returns(null);
+        const entry = ActionQueueEntry.create('deleteObject')
+            .setAttribute('target.owner', 'testowner')
+            .setAttribute('target.bucket', 'testbucket')
+            .setAttribute('target.accountId', 'testid')
+            .setAttribute('target.key', 'testkey')
+            .setAttribute('target.version', 'testversion')
+            .setAttribute('details.lastModified', '2022-05-13T17:51:31.261Z');
+        s3Client.setResponse(null, {});
+        backbeatClient.setResponse(null, {});
+        task.processActionEntry(entry, err => {
+            assert(err);
+            done();
+        });
+    });
 });

tests/unit/mocks.js

@@ -61,13 +61,16 @@ class MockRequestAPI extends EventEmitter {
 }
 
 class BackbeatClientMock {
-    constructor() {
+    constructor(params) {
         this.response = null;
         this.batchDeleteResponse = {};
         this.times = {
             batchDeleteResponse: 0,
             deleteObjectFromExpiration: 0,
         };
+        if (params?.isS3c) {
+            this.deleteObjectFromExpiration = undefined;
+        }
     }
 
     deleteObjectFromExpiration() {
@@ -186,6 +189,7 @@ class S3ClientMock {
             headObject: 0,
             deleteObject: 0,
             deleteMultipartObject: 0,
+            abortMultipartUpload: 0,
         };
     }
 
@@ -218,6 +222,12 @@ class S3ClientMock {
         this.assertRespIsSet();
         return new S3RequestMock(this.response.error, this.response.data);
     }
+
+    abortMultipartUpload() {
+        this.calls.abortMultipartUpload += 1;
+        this.assertRespIsSet();
+        return new S3RequestMock(this.response.error, this.response.data);
+    }
 }
 
 module.exports = {