make showing crr location replication status configurable

- added a config param to allow enabling/disabling display
of the crr site's replication status
- Checking if a location is CRR is done in two ways:
 1. In zenko, CRR destinations are actual locations and
    have the `isCRR` flag in their details.
 2. S3C doesn't have the concept of locations, so when
    we don't find the location with `config.getLocationConstraint()`
    we know we are in S3C. The locations set in the replication
    info in the MD is built by Cloudserver after making sure all the
    locations there exist.

Issue: CLDSRV-737

Author: Kerkesni

lib/Config.js

@@ -1756,6 +1756,8 @@ class Config extends EventEmitter {
             }
         }
 
+        this.includeCrrStatusMetadata = config.includeCrrStatusMetadata ?? true;
+
         return config;
     }
 

lib/utilities/collectResponseHeaders.js

@@ -106,6 +106,11 @@ function collectResponseHeaders(objectMD, corsHeaders, versioningCfg,
     }
     if (Array.isArray(objectMD?.replicationInfo?.backends)) {
         objectMD.replicationInfo.backends.forEach(backend => {
+            const locationConstraint = config.getLocationConstraint(backend.site);
+            if (!config.includeCrrStatusMetadata &&
+                (!locationConstraint || locationConstraint.isCRR)) {
+                return;
+            }
             const { status, site, dataStoreVersionId } = backend;
             responseMetaHeaders[`x-amz-meta-${site}-replication-status`] =
                 status;

tests/unit/Config.js

@@ -933,4 +933,49 @@ describe('Config', () => {
             );
         });
     });
+
+    describe('includeCrrStatusMetadata', () => {
+        let defaultConfig;
+
+        before(() => {
+            setEnv('S3_CONFIG_FILE', 'tests/unit/testConfigs/allOptsConfig/config.json');
+            const defaultConfigPath = path.join(__dirname, './testConfigs/allOptsConfig/config.json');
+            defaultConfig = require(defaultConfigPath);
+        });
+
+        afterEach(() => {
+            sinon.restore();
+        });
+
+        it('should be enabled by default', () => {
+            const config = new ConfigObject();
+            assert.strictEqual(config.includeCrrStatusMetadata, true);
+        });
+        
+        it('should be enabled when set to true in config file', () => {
+            const originalReadFileSync = fs.readFileSync;
+            const readFileSyncStub = sinon.stub(fs, 'readFileSync');
+            readFileSyncStub
+                .withArgs(sinon.match(/\/config\.json$/))
+                .returns(JSON.stringify({ ...defaultConfig, includeCrrStatusMetadata: true }));
+            readFileSyncStub
+                .callsFake((filePath, ...args) => originalReadFileSync(filePath, ...args));
+
+            const config = new ConfigObject();
+            assert.strictEqual(config.includeCrrStatusMetadata, true);
+        });
+
+        it('should be disabled when set to false in config file', () => {
+            const originalReadFileSync = fs.readFileSync;
+            const readFileSyncStub = sinon.stub(fs, 'readFileSync');
+            readFileSyncStub
+                .withArgs(sinon.match(/\/config\.json$/))
+                .returns(JSON.stringify({ ...defaultConfig, includeCrrStatusMetadata: false }));
+            readFileSyncStub
+                .callsFake((filePath, ...args) => originalReadFileSync(filePath, ...args));
+
+            const config = new ConfigObject();
+            assert.strictEqual(config.includeCrrStatusMetadata, false);
+        });
+    });
 });

tests/unit/utils/collectResponseHeaders.js

@@ -1,15 +1,27 @@
 const assert = require('assert');
+const sinon = require('sinon');
 const collectResponseHeaders =
     require('../../../lib/utilities/collectResponseHeaders');
+const { config } = require('../../../lib/Config');
 
 describe('Middleware: Collect Response Headers', () => {
+    afterEach(() => {
+        sinon.restore();
+    });
+
     it('should be able to set replication status when config is set', () => {
         const objectMD = { replicationInfo: { status: 'REPLICA' } };
         const headers = collectResponseHeaders(objectMD);
         assert.deepStrictEqual(headers['x-amz-replication-status'], 'REPLICA');
     });
 
     it('should set the replication status of each site', () => {
+        sinon.stub(config, 'includeCrrStatusMetadata')
+            .value(true);
+        sinon.stub(config, 'getLocationConstraint')
+            .onCall(0).returns({ isCRR: false })
+            .onCall(1).returns({ isCRR: true });
+
         const objectMD = {
             replicationInfo: {
                 status: 'COMPLETED',
@@ -28,6 +40,37 @@ describe('Middleware: Collect Response Headers', () => {
             'COMPLETED');
         assert.deepStrictEqual(headers['x-amz-meta-us-west-2-version-id'], undefined);
     });
+
+    it('should skip the replication status for CRR sites', () => {
+        sinon.stub(config, 'includeCrrStatusMetadata')
+            .value(false);
+        sinon.stub(config, 'getLocationConstraint')
+            .onCall(0).returns({ isCRR: false })
+            .onCall(1).returns({ isCRR: true })
+            .onCall(1).returns(undefined);
+
+        const objectMD = {
+            replicationInfo: {
+                status: 'COMPLETED',
+                backends: [
+                    { site: 'us-east-1', status: 'COMPLETED', dataStoreVersionId: '123' },
+                    { site: 'crr', status: 'COMPLETED', dataStoreVersionId: '' },
+                    { site: 'crr-s3c', status: 'COMPLETED', dataStoreVersionId: '' },
+                ],
+            },
+        };
+        const headers = collectResponseHeaders(objectMD);
+        assert.deepStrictEqual(headers['x-amz-replication-status'], 'COMPLETED');
+        assert.deepStrictEqual(headers['x-amz-meta-us-east-1-replication-status'],
+            'COMPLETED');
+        assert.deepStrictEqual(headers['x-amz-meta-us-east-1-version-id'], '123');
+        assert.deepStrictEqual(headers['x-amz-meta-crr-replication-status'],
+            undefined);
+        assert.deepStrictEqual(headers['x-amz-meta-crr-version-id'], undefined);
+        assert.deepStrictEqual(headers['x-amz-meta-crr-s3c-replication-status'],
+            undefined);
+        assert.deepStrictEqual(headers['x-amz-meta-crr-s3c-version-id'], undefined);
+    });
 
     [
         { md: { replicationInfo: null }, test: 'when config is not set' },