♻️ migrate objectGetLegalHold to async/await syntax

Issue: CLDSRV-823

Author: DarkIsDude

lib/api/objectGetLegalHold.js

@@ -1,4 +1,3 @@
-const async = require('async');
 const { errors, errorInstances, s3middleware } = require('arsenal');
 
 const { decodeVersionId, getVersionIdResHeader }
@@ -15,26 +14,21 @@ const { convertToXml } = s3middleware.objectLegalHold;
  * @param {AuthInfo} authInfo - Instance of AuthInfo class with requester's info
  * @param {object} request - http request object
  * @param {object} log - Werelogs logger
- * @param {function} callback - callback to server
- * @return {undefined}
+ * @return {Promise<object>} - object containing xml and additionalResHeaders
  */
-function objectGetLegalHold(authInfo, request, log, callback) {
+async function objectGetLegalHold(authInfo, request, log, callback) {
     log.debug('processing request', { method: 'objectGetLegalHold' });
 
     const { bucketName, objectKey, query } = request;
 
     const decodedVidResult = decodeVersionId(query);
     if (decodedVidResult instanceof Error) {
-        log.trace('invalid versionId query', {
-            versionId: query.versionId,
-            error: decodedVidResult,
-        });
+        log.trace('invalid versionId query', { versionId: query.versionId, error: decodedVidResult });
         return process.nextTick(() => callback(decodedVidResult));
     }
     const versionId = decodedVidResult;
 
-    // FIXME pass 'getDeleteMarker: true' option to set
-    // 'x-amz-delete-marker' header (see S3C-7592)
+    // FIXME pass 'getDeleteMarker: true' option to set 'x-amz-delete-marker' header (see S3C-7592)
     const metadataValParams = {
         authInfo,
         bucketName,
@@ -44,71 +38,69 @@ function objectGetLegalHold(authInfo, request, log, callback) {
         request,
     };
 
-    return async.waterfall([
-        next => standardMetadataValidateBucketAndObj(metadataValParams, request.actionImplicitDenies, log,
-            (err, bucket, objectMD) => {
-                if (err) {
-                    log.trace('request authorization failed',
-                    { method: 'objectGetLegalHold', error: err });
-                    return next(err);
-                }
-                if (!objectMD) {
-                    const err = versionId ? errors.NoSuchVersion :
-                        errors.NoSuchKey;
-                    log.trace('error no object metadata found',
-                        { method: 'objectGetLegalHold', error: err });
-                    return next(err, bucket);
-                }
-                if (objectMD.isDeleteMarker) {
-                    if (versionId) {
-                        log.trace('requested version is delete marker',
-                            { method: 'objectGetLegalHold' });
-                        // FIXME we should return a `x-amz-delete-marker: true` header,
-                        // see S3C-7592
-                        return next(errors.MethodNotAllowed);
+    let bucket;
+    let objectMD;
+
+    try {
+        ({ bucket, objectMD } = await new Promise((resolve, reject) => {
+            standardMetadataValidateBucketAndObj(
+                metadataValParams, request.actionImplicitDenies, log,
+                (err, bucket, objectMD) => {
+                    if (err) {
+                        log.trace('request authorization failed', { method: 'objectGetLegalHold', error: err });
+                        return reject(err);
                     }
-                    log.trace('most recent version is delete marker',
-                        { method: 'objectGetLegalHold' });
-                    // FIXME we should return a `x-amz-delete-marker: true` header,
-                    // see S3C-7592
-                    return next(errors.NoSuchKey);
-                }
-                if (!bucket.isObjectLockEnabled()) {
-                    log.trace('object lock not enabled on bucket',
-                        { method: 'objectGetRetention' });
-                    return next(errorInstances.InvalidRequest.customizeDescription(
-                        'Bucket is missing Object Lock Configuration'));
-                }
-                return next(null, bucket, objectMD);
-            }),
-        (bucket, objectMD, next) => {
-            const { legalHold } = objectMD;
-            const xml = convertToXml(legalHold);
-            if (xml === '') {
-                return next(errors.NoSuchObjectLockConfiguration);
+                    return resolve({ bucket, objectMD });
+                });
+        }));
+
+        if (!objectMD) {
+            const err = versionId ? errors.NoSuchVersion : errors.NoSuchKey;
+            log.trace('error no object metadata found', { method: 'objectGetLegalHold', error: err });
+            throw err;
+        }
+
+        if (objectMD.isDeleteMarker) {
+            if (versionId) {
+                log.trace('requested version is delete marker', { method: 'objectGetLegalHold' });
+                // FIXME we should return a `x-amz-delete-marker: true` header, see S3C-7592
+                throw errors.MethodNotAllowed;
             }
-            return next(null, bucket, xml, objectMD);
-        },
-    ], (err, bucket, xml, objectMD) => {
-        const additionalResHeaders = collectCorsHeaders(request.headers.origin,
-            request.method, bucket);
-        if (err) {
-            log.trace('error processing request', { error: err,
-                method: 'objectGetLegalHold' });
-        } else {
-            pushMetric('getObjectLegalHold', log, {
-                authInfo,
-                bucket: bucketName,
-                keys: [objectKey],
-                versionId: objectMD ? objectMD.versionId : undefined,
-                location: objectMD ? objectMD.dataStoreName : undefined,
-            });
-            const verCfg = bucket.getVersioningConfiguration();
-            additionalResHeaders['x-amz-version-id'] =
-                getVersionIdResHeader(verCfg, objectMD);
+
+            log.trace('most recent version is delete marker', { method: 'objectGetLegalHold' });
+            // FIXME we should return a `x-amz-delete-marker: true` header, see S3C-7592
+            throw errors.NoSuchKey;
+        }
+
+        if (!bucket.isObjectLockEnabled()) {
+            log.trace('object lock not enabled on bucket', { method: 'objectGetRetention' });
+            throw errorInstances.InvalidRequest.customizeDescription('Bucket is missing Object Lock Configuration');
         }
-        return callback(err, xml, additionalResHeaders);
-    });
+
+        const { legalHold } = objectMD;
+        const xml = convertToXml(legalHold);
+        if (xml === '') {
+            throw errors.NoSuchObjectLockConfiguration;
+        }
+
+        const additionalResHeaders = collectCorsHeaders(request.headers.origin, request.method, bucket);
+
+        pushMetric('getObjectLegalHold', log, {
+            authInfo,
+            bucket: bucketName,
+            keys: [objectKey],
+            versionId: objectMD ? objectMD.versionId : undefined,
+            location: objectMD ? objectMD.dataStoreName : undefined,
+        });
+        const verCfg = bucket.getVersioningConfiguration();
+        additionalResHeaders['x-amz-version-id'] = getVersionIdResHeader(verCfg, objectMD);
+
+        return callback(null, xml, additionalResHeaders);
+    } catch (err) {
+        const additionalResHeaders = collectCorsHeaders(request.headers.origin, request.method, bucket);
+        err.additionalResHeaders = additionalResHeaders;
+        return callback(err);
+    }
 }
 
 module.exports = objectGetLegalHold;