!fixup Support the new API GetObjectAttributes

Author: maeldonn

lib/api/apiUtils/object/parseAttributesHeader.js

@@ -1,6 +1,12 @@
 const { errorInstances } = require('arsenal');
 const { allowedObjectAttributes } = require('../../../../constants');
 
+/**
+ * parseAttributesHeaders - Parse and validate the x-amz-object-attributes header
+ * @param {object} headers - request headers
+ * @returns {string[]} - array of valid attribute names
+ * @throws {Error} - InvalidRequest if header is missing/empty, InvalidArgument if attribute is invalid
+ */
 function parseAttributesHeaders(headers) {
   const raw = headers['x-amz-object-attributes'] || '';
 
@@ -10,14 +16,14 @@ function parseAttributesHeaders(headers) {
     .filter(s => s !== '');
 
   if (attributes.length === 0) {
-    return errorInstances.InvalidRequest.customizeDescription(
+    throw errorInstances.InvalidRequest.customizeDescription(
       'The x-amz-object-attributes header specifying the attributes to be retrieved is either missing or empty',
     );
   }
 
   const invalids = attributes.filter(s => !allowedObjectAttributes.has(s));
   if (invalids.length > 0) {
-    return errorInstances.InvalidArgument.customizeDescription('Invalid attribute name specified.');
+    throw errorInstances.InvalidArgument.customizeDescription('Invalid attribute name specified.');
   }
 
   return attributes;

lib/api/objectGetAttributes.js

@@ -1,4 +1,4 @@
-const { waterfall } = require('async');
+const { promisify } = require('util');
 const xml2js = require('xml2js');
 const { errors } = require('arsenal');
 const { standardMetadataValidateBucketAndObj } = require('../metadata/metadataUtils');
@@ -7,9 +7,31 @@ const parseAttributesHeaders = require('./apiUtils/object/parseAttributesHeader'
 const { decodeVersionId, getVersionIdResHeader } = require('./apiUtils/object/versioning');
 const { checkExpectedBucketOwner } = require('./apiUtils/authorization/bucketOwner');
 const { pushMetric } = require('../utapi/utilities');
+const { getPartCountFromMd5 } = require('./apiUtils/object/partInfo');
 
 const OBJECT_GET_ATTRIBUTES = 'objectGetAttributes';
 
+const checkExpectedBucketOwnerPromise = promisify(checkExpectedBucketOwner);
+
+/**
+ * validateBucketAndObjPromise - Promisified wrapper for standardMetadataValidateBucketAndObj
+ * @param {object} params - validation parameters
+ * @param {boolean} actionImplicitDenies - whether action has implicit denies
+ * @param {object} log - Werelogs logger
+ * @returns {Promise<{bucket: BucketInfo, objMD: object}>} - bucket and object metadata
+ * @throws {Error} - rejects with error from standardMetadataValidateBucketAndObj
+ */
+function validateBucketAndObjPromise(params, actionImplicitDenies, log) {
+  return new Promise((resolve, reject) => {
+    standardMetadataValidateBucketAndObj(params, actionImplicitDenies, log, (err, bucket, objMD) => {
+      if (err) {
+        return reject(err);
+      }
+      return resolve({ bucket, objMD });
+    });
+  });
+}
+
 /**
  * buildXmlResponse - Build XML response for GetObjectAttributes
  * @param {object} objMD - object metadata
@@ -23,12 +45,16 @@ function buildXmlResponse(objMD, attributes) {
     attrResp.ETag = objMD['content-md5'];
   }
 
+  // NOTE: Checksum is not implemented
   if (attributes.includes('Checksum')) {
     attrResp.Checksum = {};
   }
 
   if (attributes.includes('ObjectParts')) {
-    attrResp.ObjectParts = {};
+    const partCount = getPartCountFromMd5(objMD);
+    if (partCount) {
+      attrResp.ObjectParts = { PartsCount: partCount };
+    }
   }
 
   if (attributes.includes('StorageClass')) {
@@ -51,19 +77,17 @@ function buildXmlResponse(objMD, attributes) {
  * @param {function} callback - callback to server
  * @return {undefined}
  */
-function objectGetAttributes(authInfo, request, log, callback) {
-  log.debug('processing request', { method: OBJECT_GET_ATTRIBUTES });
+async function objectGetAttributes(authInfo, request, log, callback) {
+  log.trace('processing request', { method: OBJECT_GET_ATTRIBUTES });
   const { bucketName, objectKey, headers, actionImplicitDenies } = request;
 
-  const decodedVersionId = decodeVersionId(request.query);
-  if (decodedVersionId instanceof Error) {
-    log.trace('invalid versionId query', {
-      versionId: request.query.versionId,
-      error: decodedVersionId,
-    });
-    return callback(decodedVersionId);
+  let responseHeaders = {};
+
+  const versionId = decodeVersionId(request.query);
+  if (versionId instanceof Error) {
+    log.debug('invalid versionId query', { versionId: request.query.versionId, error: versionId });
+    throw versionId;
   }
-  const versionId = decodedVersionId;
 
   const metadataValParams = {
     authInfo,
@@ -75,72 +99,48 @@ function objectGetAttributes(authInfo, request, log, callback) {
     request,
   };
 
-  let bucket = null;
-  let objMD = null;
-  let responseHeaders = null;
-  let xml = null;
-
-  return waterfall(
-    [
-      next =>
-        standardMetadataValidateBucketAndObj(metadataValParams, actionImplicitDenies, log, (err, b, o) => {
-          bucket = b;
-          objMD = o;
-          return next(err);
-        }),
-      next => checkExpectedBucketOwner(headers, bucket, log, next),
-      next => {
-        responseHeaders = collectCorsHeaders(headers.origin, request.method, bucket);
-        if (objMD) {
-          responseHeaders['x-amz-version-id'] = getVersionIdResHeader(bucket.getVersioningConfiguration(), objMD);
-          responseHeaders['Last-Modified'] = objMD['last-modified'] && new Date(objMD['last-modified']).toUTCString();
-        }
-
-        return next();
-      },
-      next => {
-        if (!objMD) {
-          const e = versionId ? errors.NoSuchVersion : errors.NoSuchKey;
-          return next(e);
-        }
-
-        if (objMD.isDeleteMarker) {
-          responseHeaders['x-amz-delete-marker'] = true;
-          return next(errors.MethodNotAllowed);
-        }
-
-        const attributes = parseAttributesHeaders(headers);
-        if (attributes instanceof Error) {
-          log.trace('invalid x-amz-object-attributes header', {
-            headers,
-            error: attributes,
-          });
-          return next(attributes);
-        }
-
-        xml = buildXmlResponse(objMD, attributes);
-        return next();
-      },
-    ],
-    err => {
-      if (err) {
-        log.debug('error processing request', {
-          error: err,
-          method: OBJECT_GET_ATTRIBUTES,
-        });
-        return callback(err, '', responseHeaders);
-      }
+  try {
+    const { bucket, objMD } = await validateBucketAndObjPromise(metadataValParams, actionImplicitDenies, log);
+    await checkExpectedBucketOwnerPromise(headers, bucket, log);
+
+    responseHeaders = collectCorsHeaders(headers.origin, request.method, bucket);
+    if (objMD) {
+      responseHeaders['x-amz-version-id'] = getVersionIdResHeader(bucket.getVersioningConfiguration(), objMD);
+      responseHeaders['Last-Modified'] = objMD['last-modified'] && new Date(objMD['last-modified']).toUTCString();
+    }
+
+    if (!objMD) {
+      const err = versionId ? errors.NoSuchVersion : errors.NoSuchKey;
+      log.debug('object not found', { bucket: bucketName, key: objectKey, versionId });
+      throw err;
+    }
+
+    if (objMD.isDeleteMarker) {
+      log.debug('attempt to get attributes of a delete marker', { bucket: bucketName, key: objectKey, versionId });
+      responseHeaders['x-amz-delete-marker'] = true;
+      throw errors.MethodNotAllowed;
+    }
+
+    const attributes = parseAttributesHeaders(headers);
+
+    pushMetric(OBJECT_GET_ATTRIBUTES, log, {
+      authInfo,
+      bucket: bucketName,
+      keys: [objectKey],
+      versionId: objMD?.versionId,
+      location: objMD?.dataStoreName,
+    });
+
+    const xml = buildXmlResponse(objMD, attributes);
+    return callback(null, xml, responseHeaders);
+  } catch (err) {
+    log.debug('error processing request', {
+      error: err,
+      method: OBJECT_GET_ATTRIBUTES,
+    });
 
-      pushMetric(OBJECT_GET_ATTRIBUTES, log, {
-        authInfo,
-        bucket: bucketName,
-        keys: [objectKey],
-        versionId: objMD?.versionId,
-        location: objMD?.dataStoreName,
-      });
-      return callback(err, xml, responseHeaders);
-    },
-  );
+    return callback(err, null, responseHeaders);
+  }
 }
 
 module.exports = objectGetAttributes;