Bump microVersionId and add isReplica handling

lib/api/apiUtils/object/bumpMicroVersionId.js

@@ -0,0 +1,27 @@
+const { versioning } = require('arsenal');
+const { config } = require('../../../Config');
+
+/**
+ * Bump objectMD.microVersionId. microVersionId is a generic
+ * metadata-revision marker, not a CRR-specific field, but cascaded CRR
+ * is its only consumer today - so we gate on replicationInfo to avoid
+ * inflating storage on objects that wouldn't use it. The gate can be
+ * widened later if another consumer needs it on every object.
+ * Pass `force = true` to bump unconditionally.
+ *
+ * @param {object} objectMD - object MD POJO or `md.getValue()`
+ * @param {boolean} [force] - bump even without replicationInfo
+ * @return {undefined}
+ */
+function bumpMicroVersionId(objectMD, force) {
+    if (!force && !objectMD?.replicationInfo) {
+        return;
+    }
+
+    const { instanceId, replicationGroupId } = config;
+
+    // eslint-disable-next-line no-param-reassign
+    objectMD.microVersionId = versioning.VersionID.generateVersionId(instanceId, replicationGroupId);
+}
+
+module.exports = bumpMicroVersionId;

lib/api/objectDeleteTagging.js

@@ -10,6 +10,7 @@ const monitoring = require('../utilities/monitoringHandler');
 const collectCorsHeaders = require('../utilities/collectCorsHeaders');
 const metadata = require('../metadata/wrapper');
 const getReplicationInfo = require('./apiUtils/object/getReplicationInfo');
+const bumpMicroVersionId = require('./apiUtils/object/bumpMicroVersionId');
 const { data } = require('../data/wrapper');
 const { config } = require('../Config');
 const REPLICATION_ACTION = 'DELETE_TAGGING';
@@ -76,13 +77,18 @@ function objectDeleteTagging(authInfo, request, log, callback) {
             // eslint-disable-next-line no-param-reassign
             objectMD.tags = {};
             const params = getVersionSpecificMetadataOptions(objectMD, config.nullVersionCompatMode);
+            if (objectMD.replicationInfo?.isReplica) {
+                // eslint-disable-next-line no-param-reassign
+                objectMD.replicationInfo.isReplica = false;
+            }
             const replicationInfo = getReplicationInfo(config,
                 objectKey, bucket, true, 0, REPLICATION_ACTION, objectMD);
             if (replicationInfo) {
                 // eslint-disable-next-line no-param-reassign
                 objectMD.replicationInfo = Object.assign({},
                     objectMD.replicationInfo, replicationInfo);
             }
+            bumpMicroVersionId(objectMD);
             // eslint-disable-next-line no-param-reassign
             objectMD.originOp = 's3:ObjectTagging:Delete';
             metadata.putObjectMD(bucket.getName(), objectKey, objectMD, params,

lib/api/objectPutLegalHold.js

@@ -5,6 +5,7 @@ const collectCorsHeaders = require('../utilities/collectCorsHeaders');
 const { decodeVersionId, getVersionIdResHeader, getVersionSpecificMetadataOptions } =
   require('./apiUtils/object/versioning');
 const getReplicationInfo = require('./apiUtils/object/getReplicationInfo');
+const bumpMicroVersionId = require('./apiUtils/object/bumpMicroVersionId');
 const metadata = require('../metadata/wrapper');
 const { standardMetadataValidateBucketAndObj } = require('../metadata/metadataUtils');
 const { pushMetric } = require('../utapi/utilities');
@@ -87,13 +88,18 @@ function objectPutLegalHold(authInfo, request, log, callback) {
             // eslint-disable-next-line no-param-reassign
             objectMD.legalHold = legalHold;
             const params = getVersionSpecificMetadataOptions(objectMD, config.nullVersionCompatMode);
+            if (objectMD.replicationInfo?.isReplica) {
+                // eslint-disable-next-line no-param-reassign
+                objectMD.replicationInfo.isReplica = false;
+            }
             const replicationInfo = getReplicationInfo(config,
                 objectKey, bucket, true, 0, REPLICATION_ACTION, objectMD);
             if (replicationInfo) {
                 // eslint-disable-next-line no-param-reassign
                 objectMD.replicationInfo = Object.assign({},
                     objectMD.replicationInfo, replicationInfo);
             }
+            bumpMicroVersionId(objectMD);
             // eslint-disable-next-line no-param-reassign
             objectMD.originOp = 's3:ObjectLegalHold:Put';
             metadata.putObjectMD(bucket.getName(), objectKey, objectMD, params,

lib/api/objectPutRetention.js

@@ -8,6 +8,7 @@ const { ObjectLockInfo, hasGovernanceBypassHeader } =
 const { standardMetadataValidateBucketAndObj } = require('../metadata/metadataUtils');
 const { pushMetric } = require('../utapi/utilities');
 const getReplicationInfo = require('./apiUtils/object/getReplicationInfo');
+const bumpMicroVersionId = require('./apiUtils/object/bumpMicroVersionId');
 const collectCorsHeaders = require('../utilities/collectCorsHeaders');
 const metadata = require('../metadata/wrapper');
 const { config } = require('../Config');
@@ -112,12 +113,16 @@ function objectPutRetention(authInfo, request, log, callback) {
             objectMD.retentionMode = retentionInfo.mode;
             objectMD.retentionDate = retentionInfo.date;
             const params = getVersionSpecificMetadataOptions(objectMD, config.nullVersionCompatMode);
+            if (objectMD.replicationInfo?.isReplica) {
+                objectMD.replicationInfo.isReplica = false;
+            }
             const replicationInfo = getReplicationInfo(config,
                 objectKey, bucket, true, 0, REPLICATION_ACTION, objectMD);
             if (replicationInfo) {
                 objectMD.replicationInfo = Object.assign({},
                     objectMD.replicationInfo, replicationInfo);
             }
+            bumpMicroVersionId(objectMD);
             objectMD.originOp = 's3:ObjectRetention:Put';
             /* eslint-enable no-param-reassign */
             metadata.putObjectMD(bucket.getName(), objectKey, objectMD, params,

lib/api/objectPutTagging.js

@@ -8,6 +8,7 @@ const { standardMetadataValidateBucketAndObj } = require('../metadata/metadataUt
 const { pushMetric } = require('../utapi/utilities');
 const monitoring = require('../utilities/monitoringHandler');
 const getReplicationInfo = require('./apiUtils/object/getReplicationInfo');
+const bumpMicroVersionId = require('./apiUtils/object/bumpMicroVersionId');
 const collectCorsHeaders = require('../utilities/collectCorsHeaders');
 const metadata = require('../metadata/wrapper');
 const { data } = require('../data/wrapper');
@@ -80,13 +81,18 @@ function objectPutTagging(authInfo, request, log, callback) {
             // eslint-disable-next-line no-param-reassign
             objectMD.tags = tags;
             const params = getVersionSpecificMetadataOptions(objectMD, config.nullVersionCompatMode);
+            if (objectMD.replicationInfo?.isReplica) {
+                // eslint-disable-next-line no-param-reassign
+                objectMD.replicationInfo.isReplica = false;
+            }
             const replicationInfo = getReplicationInfo(config,
                 objectKey, bucket, true, 0, REPLICATION_ACTION, objectMD);
             if (replicationInfo) {
                 // eslint-disable-next-line no-param-reassign
                 objectMD.replicationInfo = Object.assign({},
                     objectMD.replicationInfo, replicationInfo);
             }
+            bumpMicroVersionId(objectMD);
             // eslint-disable-next-line no-param-reassign
             objectMD.originOp = 's3:ObjectTagging:Put';
             metadata.putObjectMD(bucket.getName(), objectKey, objectMD, params,

lib/metadata/acl.js

@@ -1,6 +1,7 @@
 const { errors } = require('arsenal');
 
 const getReplicationInfo = require('../api/apiUtils/object/getReplicationInfo');
+const bumpMicroVersionId = require('../api/apiUtils/object/bumpMicroVersionId');
 const aclUtils = require('../utilities/aclUtils');
 const constants = require('../../constants');
 const metadata = require('../metadata/wrapper');
@@ -44,6 +45,10 @@ const acl = {
             objectMD.acl = addACLParams;
             objectMD.originOp = 's3:ObjectAcl:Put';
 
+            if (objectMD.replicationInfo?.isReplica) {
+                objectMD.replicationInfo.isReplica = false;
+            }
+
             // Use storageType to determine if replication update is needed, as it is set only for
             // "cloud" locations. This  ensures that we reset replication when CRR is used, but not
             // when multi-backend replication (i.e. Zenko) is used.
@@ -57,6 +62,8 @@ const acl = {
                 };
             }
 
+            bumpMicroVersionId(objectMD);
+
             return metadata.putObjectMD(bucket.getName(), objectKey, objectMD, params, log, cb);
         }
         return cb();

lib/services.js

@@ -16,6 +16,7 @@ const metadata = require('./metadata/wrapper');
 const { setObjectLockInformation }
     = require('./api/apiUtils/object/objectLockHelpers');
 const removeAWSChunked = require('./api/apiUtils/object/removeAWSChunked');
+const bumpMicroVersionId = require('./api/apiUtils/object/bumpMicroVersionId');
 const { parseTagFromQuery } = s3middleware.tagging;
 
 const usersBucket = constants.usersBucket;
@@ -190,9 +191,7 @@ const services = {
             options.replayId = uploadId;
         }
         // update microVersionId when overwriting metadata.
-        if (updateMicroVersionId) {
-            md.updateMicroVersionId();
-        }
+        bumpMicroVersionId(md.getValue(), updateMicroVersionId);
         // update restore
         if (archive) {
             md.setAmzStorageClass(amzStorageClass);

lib/utilities/collectResponseHeaders.js

@@ -100,9 +100,11 @@ function collectResponseHeaders(objectMD, corsHeaders, versioningCfg,
         responseMetaHeaders['x-amz-object-lock-legal-hold']
             = objectMD.legalHold ? 'ON' : 'OFF';
     }
-    if (objectMD.replicationInfo && objectMD.replicationInfo.status) {
-        responseMetaHeaders['x-amz-replication-status'] =
-            objectMD.replicationInfo.status;
+    if (objectMD.replicationInfo) {
+        const { isReplica, status } = objectMD.replicationInfo;
+        if (isReplica || status) {
+            responseMetaHeaders['x-amz-replication-status'] = isReplica ? 'REPLICA' : status;
+        }
     }
     if (Array.isArray(objectMD?.replicationInfo?.backends)) {
         objectMD.replicationInfo.backends.forEach(backend => {

package.json

@@ -33,7 +33,7 @@
         "@azure/storage-blob": "^12.28.0",
         "@hapi/joi": "^17.1.1",
         "@smithy/node-http-handler": "^3.0.0",
-        "arsenal": "git+https://github.com/scality/Arsenal#8.4.2",
+        "arsenal": "git+https://github.com/scality/Arsenal#improvement/ARSN-578/micro-version-id",
         "async": "2.6.4",
         "bucketclient": "scality/bucketclient#8.2.7",
         "bufferutil": "^4.0.8",

tests/unit/api/apiUtils/object/bumpMicroVersionId.js

@@ -0,0 +1,31 @@
+const assert = require('assert');
+
+const bumpMicroVersionId = require('../../../../../lib/api/apiUtils/object/bumpMicroVersionId');
+
+describe('bumpMicroVersionId', () => {
+    it('sets a fresh microVersionId when replicationInfo is present', () => {
+        const objectMD = { replicationInfo: {} };
+        bumpMicroVersionId(objectMD);
+        assert(objectMD.microVersionId, 'expected microVersionId to be set');
+    });
+
+    it('produces a different value on each call', () => {
+        const objectMD = { replicationInfo: {} };
+        bumpMicroVersionId(objectMD);
+        const first = objectMD.microVersionId;
+        bumpMicroVersionId(objectMD);
+        assert.notStrictEqual(objectMD.microVersionId, first);
+    });
+
+    it('does nothing when replicationInfo is absent', () => {
+        const objectMD = {};
+        bumpMicroVersionId(objectMD);
+        assert.strictEqual(objectMD.microVersionId, undefined);
+    });
+
+    it('bumps unconditionally when force is true', () => {
+        const objectMD = {};
+        bumpMicroVersionId(objectMD, true);
+        assert(objectMD.microVersionId, 'expected microVersionId to be set when force=true');
+    });
+});

tests/unit/api/objectReplicationMD.js

@@ -1,6 +1,7 @@
 const assert = require('assert');
 const async = require('async');
 const crypto = require('crypto');
+const { promisify } = require('util');
 
 const BucketInfo = require('arsenal').models.BucketInfo;
 
@@ -718,3 +719,55 @@ describe('Replication object MD without bucket replication config', () => {
         });
     });
 });
+
+describe('microVersionId is bumped on every object metadata write', () => {
+    const getMD = key => metadata.keyMaps.get(bucketName).get(key);
+    const objectPutAsync = promisify(objectPut);
+    const objectPutTaggingAsync = promisify(objectPutTagging);
+
+    beforeEach(() => {
+        cleanup();
+        createBucket();
+    });
+
+    afterEach(() => cleanup());
+
+    it('sets microVersionId on objectPut', async () => {
+        await objectPutAsync(authInfo, getObjectPutReq(keyA, true), undefined, log);
+        assert(getMD(keyA).microVersionId, 'expected microVersionId to be set');
+    });
+
+    it('bumps microVersionId on subsequent objectPutTagging', async () => {
+        await objectPutAsync(authInfo, getObjectPutReq(keyA, true), undefined, log);
+        const before = getMD(keyA).microVersionId;
+        await objectPutTaggingAsync(authInfo, taggingPutReq, log);
+        const after = getMD(keyA).microVersionId;
+        assert(after && after !== before, 'expected microVersionId to change after tagging');
+    });
+});
+
+describe('isReplica is cleared on direct user writes overwriting a replica', () => {
+    const getMD = key => metadata.keyMaps.get(bucketName).get(key);
+    const objectPutAsync = promisify(objectPut);
+    const objectPutTaggingAsync = promisify(objectPutTagging);
+
+    beforeEach(() => {
+        cleanup();
+        createBucket();
+    });
+
+    afterEach(() => cleanup());
+
+    it('clears isReplica when prior MD has it true', async () => {
+        await objectPutAsync(authInfo, getObjectPutReq(keyA, true), undefined, log);
+        getMD(keyA).replicationInfo.isReplica = true;
+        await objectPutTaggingAsync(authInfo, taggingPutReq, log);
+        assert.strictEqual(getMD(keyA).replicationInfo.isReplica, false);
+    });
+
+    it('leaves isReplica untouched when prior MD does not have it', async () => {
+        await objectPutAsync(authInfo, getObjectPutReq(keyA, true), undefined, log);
+        await objectPutTaggingAsync(authInfo, taggingPutReq, log);
+        assert.strictEqual(getMD(keyA).replicationInfo.isReplica, undefined);
+    });
+});

tests/unit/utils/collectResponseHeaders.js

@@ -9,6 +9,22 @@ describe('Middleware: Collect Response Headers', () => {
         assert.deepStrictEqual(headers['x-amz-replication-status'], 'REPLICA');
     });
 
+    it('should set REPLICA header from isReplica even when status is PENDING', () => {
+        const objectMD = {
+            replicationInfo: { status: 'PENDING', isReplica: true },
+        };
+        const headers = collectResponseHeaders(objectMD);
+        assert.deepStrictEqual(headers['x-amz-replication-status'], 'REPLICA');
+    });
+
+    it('should use replicationInfo.status when isReplica is false', () => {
+        const objectMD = {
+            replicationInfo: { status: 'PENDING', isReplica: false },
+        };
+        const headers = collectResponseHeaders(objectMD);
+        assert.deepStrictEqual(headers['x-amz-replication-status'], 'PENDING');
+    });
+
     it('should set the replication status of each site', () => {
         const objectMD = {
             replicationInfo: {

yarn.lock

@@ -6143,9 +6143,9 @@ arraybuffer.prototype.slice@^1.0.4:
   optionalDependencies:
     ioctl "^2.0.2"
 
-"arsenal@git+https://github.com/scality/Arsenal#8.4.2":
+"arsenal@git+https://github.com/scality/Arsenal#improvement/ARSN-578/micro-version-id":
   version "8.4.2"
-  resolved "git+https://github.com/scality/Arsenal#2312744c5e6bdd4d0cc9d60bf4cdcf10f32461e6"
+  resolved "git+https://github.com/scality/Arsenal#7be6414628ae9c3cf4ee4fe1b91990363bf0fa28"
   dependencies:
     "@aws-sdk/client-kms" "^3.975.0"
     "@aws-sdk/client-s3" "^3.975.0"