Merge pull request #25 from contentstack/fix/log

fix: Removed duplicate log messages

Author: cs-raj

packages/contentstack-audit/src/modules/assets.ts

@@ -216,7 +216,6 @@ export default class Assets extends BaseClass {
 
           if (this.locales?.includes(pd?.locale) && this.environments?.includes(pd?.environment)) {
             log.debug(`Publish detail valid for asset ${assetUid}: locale=${pd.locale}, environment=${pd.environment}`, this.config.auditContext);
-            log.info($t(auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), this.config.auditContext);
             return true;
           } else {
             log.debug(`Publish detail invalid for asset ${assetUid}: locale=${pd.locale}, environment=${pd.environment}`, this.config.auditContext);
@@ -237,12 +236,11 @@ export default class Assets extends BaseClass {
                 publish_environment: pd.environment,
               });
             }
-            log.success($t(auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), this.config.auditContext);
             return false;
           }
         });
         }
-        
+        log.info($t(auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), this.config.auditContext);
         const remainingPublishDetails = this.assets[assetUid].publish_details?.length || 0;
         log.debug(`Asset ${assetUid} now has ${remainingPublishDetails} valid publish details`, this.config.auditContext);
 

packages/contentstack-audit/test/unit/modules/assets.test.ts

@@ -329,6 +329,29 @@ describe('Assets module', () => {
           fs.writeFileSync(chunkPath, typeof original === 'string' ? original : String(original));
         }
       });
+
+    fancy
+      .stdout({ print: process.env.PRINT === 'true' || false })
+      .it('should log scan success message exactly once per asset', async () => {
+        const infoSpy = Sinon.spy();
+        Sinon.stub(require('@contentstack/cli-utilities'), 'log').value({
+          ...mockLogger,
+          info: infoSpy,
+        });
+        const instance = new Assets(constructorParam);
+        await instance.prerequisiteData();
+        await instance.lookForReference();
+        const successMsgCalls = infoSpy.getCalls().filter(
+          (call: Sinon.SinonSpyCall) =>
+            typeof call.args[0] === 'string' && call.args[0].includes("Successfully completed the scanning of Asset with UID"),
+        );
+        const expectedAssetUids = ['asset_uid_1', 'asset_uid_invalid', 'asset_uid_two_invalid'];
+        expect(successMsgCalls).to.have.lengthOf(expectedAssetUids.length);
+        expectedAssetUids.forEach((uid) => {
+          const forUid = successMsgCalls.filter((c: Sinon.SinonSpyCall) => c.args[0].includes(uid));
+          expect(forUid).to.have.lengthOf(1, `expected exactly one success log for asset ${uid}`);
+        });
+      });
   });
 
   describe('integration-style run with real FsUtility', () => {