Support the new API GetObjectAttributes

Issue: CLDSRV-817

Author: maeldonn

constants.js

@@ -279,6 +279,14 @@ const constants = {
     rateLimitDefaultConfigCacheTTL: 30000, // 30 seconds
     rateLimitDefaultBurstCapacity: 1,
     rateLimitCleanupInterval: 10000, // 10 seconds
+    // Metadata allowed to be returned by getObjectAttributes API
+    allowedObjectAttributes: new Set([
+        'StorageClass',
+        'ObjectSize',
+        'ObjectParts',
+        'Checksum',
+        'ETag',
+    ]),
 };
 
 module.exports = constants;

lib/api/api.js

@@ -56,6 +56,7 @@ const { objectDelete } = require('./objectDelete');
 const objectDeleteTagging = require('./objectDeleteTagging');
 const objectGet = require('./objectGet');
 const objectGetACL = require('./objectGetACL');
+const objectGetAttributes = require('./objectGetAttributes.js');
 const objectGetLegalHold = require('./objectGetLegalHold');
 const objectGetRetention = require('./objectGetRetention');
 const objectGetTagging = require('./objectGetTagging');
@@ -471,6 +472,7 @@ const api = {
     objectDeleteTagging,
     objectGet,
     objectGetACL,
+    objectGetAttributes,
     objectGetLegalHold,
     objectGetRetention,
     objectGetTagging,

lib/api/apiUtils/object/parseAttributesHeader.js

@@ -0,0 +1,32 @@
+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'] || '';
+
+  const attributes = raw
+    .split(',')
+    .map(s => s.trim())
+    .filter(s => s !== '');
+
+  if (attributes.length === 0) {
+    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) {
+    throw errorInstances.InvalidArgument.customizeDescription('Invalid attribute name specified.');
+  }
+
+  return attributes;
+}
+
+module.exports = parseAttributesHeaders;

lib/api/objectGetAttributes.js

@@ -0,0 +1,146 @@
+const { promisify } = require('util');
+const xml2js = require('xml2js');
+const { errors } = require('arsenal');
+const { standardMetadataValidateBucketAndObj } = require('../metadata/metadataUtils');
+const collectCorsHeaders = require('../utilities/collectCorsHeaders');
+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
+ * @param {array} attributes - requested attributes
+ * @returns {string} XML response
+ */
+function buildXmlResponse(objMD, attributes) {
+  const attrResp = {};
+
+  if (attributes.includes('ETag')) {
+    attrResp.ETag = objMD['content-md5'];
+  }
+
+  // NOTE: Checksum is not implemented
+  if (attributes.includes('Checksum')) {
+    attrResp.Checksum = {};
+  }
+
+  if (attributes.includes('ObjectParts')) {
+    const partCount = getPartCountFromMd5(objMD);
+    if (partCount) {
+      attrResp.ObjectParts = { PartsCount: partCount };
+    }
+  }
+
+  if (attributes.includes('StorageClass')) {
+    attrResp.StorageClass = objMD['x-amz-storage-class'];
+  }
+
+  if (attributes.includes('ObjectSize')) {
+    attrResp.ObjectSize = objMD['content-length'];
+  }
+
+  const builder = new xml2js.Builder();
+  return builder.buildObject({ GetObjectAttributesResponse: attrResp });
+}
+
+/**
+ * objectGetAttributes - Retrieves all metadata from an object without returning the object itself
+ * @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}
+ */
+async function objectGetAttributes(authInfo, request, log, callback) {
+  log.trace('processing request', { method: OBJECT_GET_ATTRIBUTES });
+  const { bucketName, objectKey, headers, actionImplicitDenies } = request;
+
+  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 metadataValParams = {
+    authInfo,
+    bucketName,
+    objectKey,
+    versionId,
+    getDeleteMarker: true,
+    requestType: request.apiMethods || OBJECT_GET_ATTRIBUTES,
+    request,
+  };
+
+  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,
+    });
+
+    return callback(err, null, responseHeaders);
+  }
+}
+
+module.exports = objectGetAttributes;

package.json

@@ -21,7 +21,7 @@
   "dependencies": {
     "@azure/storage-blob": "^12.28.0",
     "@hapi/joi": "^17.1.1",
-    "arsenal": "git+https://github.com/scality/Arsenal#8.2.43",
+    "arsenal": "git+https://github.com/scality/Arsenal#feature/ARSN-549/get-object-attributes",
     "async": "2.6.4",
     "aws-sdk": "^2.1692.0",
     "bucketclient": "scality/bucketclient#8.2.7",