Merge pull request #19 from contentstack/fix/DX-4902

fix: progress manager / audit summary fixes + Assets module unit tests (90% coverage)

Author: cs-raj

packages/contentstack-audit/.gitignore

@@ -1,6 +1,7 @@
 *-debug.log
 *-error.log
 /.nyc_output
+/coverage
 /dist
 /lib
 /package-lock.json

packages/contentstack-audit/.nycrc.json

@@ -0,0 +1,13 @@
+{
+  "extension": [".ts"],
+  "include": ["src/**/*.ts"],
+  "exclude": [
+    "lib/**",
+    "**/*.test.ts",
+    "**/*.d.ts",
+    "node_modules/**",
+    "test/**"
+  ],
+  "reporter": ["text"],
+  "all": true
+}

packages/contentstack-audit/src/audit-base-command.ts

@@ -174,8 +174,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       }
     }
 
-    // Print comprehensive summary at the end
-    CLIProgressManager.printGlobalSummary();
+    // Print comprehensive summary at the end (commented out - Summary table above has the counts; progress bars show completion)
+    // CLIProgressManager.printGlobalSummary();
 
     // Clear progress module setting now that audit is complete
     clearProgressModuleSetting();

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

@@ -204,12 +204,14 @@ export default class Assets extends BaseClass {
         if (this.assets[assetUid]?.publish_details && !Array.isArray(this.assets[assetUid].publish_details)) {
           log.debug(`Asset ${assetUid} has invalid publish_details format`, this.config.auditContext);
           cliux.print($t(auditMsg.ASSET_NOT_EXIST, { uid: assetUid }), { color: 'red' });
+          this.assets[assetUid].publish_details = [];
         }
 
         const publishDetails = this.assets[assetUid]?.publish_details;
         log.debug(`Asset ${assetUid} has ${publishDetails?.length || 0} publish details`, this.config.auditContext);
 
-        this.assets[assetUid].publish_details = this.assets[assetUid]?.publish_details.filter((pd: any) => {
+        if (Array.isArray(this.assets[assetUid].publish_details)) {
+        this.assets[assetUid].publish_details = this.assets[assetUid].publish_details.filter((pd: any) => {
           log.debug(`Checking publish detail: locale=${pd?.locale}, environment=${pd?.environment}`, this.config.auditContext);
 
           if (this.locales?.includes(pd?.locale) && this.environments?.includes(pd?.environment)) {
@@ -239,6 +241,7 @@ export default class Assets extends BaseClass {
             return false;
           }
         });
+        }
 
         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/src/modules/content-types.ts

@@ -91,8 +91,13 @@ export default class ContentType extends BaseClass {
       this.schema = this.moduleName === 'content-types' ? this.ctSchema : this.gfSchema;
       log.debug(`Found ${this.schema?.length || 0} ${this.moduleName} schemas to audit`, this.config.auditContext);
 
-      // Load prerequisite data with loading spinner
-      await this.withLoadingSpinner(`${this.moduleName.toUpperCase()}: Loading prerequisite data...`, async () => {
+      // Load prerequisite data with loading spinner.
+      // When run as prerequisite (returnFixSchema), use a neutral message so the global
+      // progress summary is not overwritten with 0 items for this module.
+      const spinnerMessage = returnFixSchema
+        ? 'Loading schema for entries...'
+        : `${this.moduleName.toUpperCase()}: Loading prerequisite data...`;
+      await this.withLoadingSpinner(spinnerMessage, async () => {
         await this.prerequisiteData();
       });
 

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

@@ -119,7 +119,7 @@ export default class FieldRule extends BaseClass {
 
       // Create progress manager if we have a total count
       if (totalCount && totalCount > 0) {
-        const progress = this.createSimpleProgress(this.moduleName, totalCount);
+        const progress = this.createSimpleProgress('field-rules', totalCount);
         progress.updateStatus('Validating field rules...');
       }
 
@@ -155,6 +155,10 @@ export default class FieldRule extends BaseClass {
           $t(auditMsg.SCAN_CT_SUCCESS_MSG, { title, module: this.config.moduleConfig[this.moduleName].name }),
           this.config.auditContext,
         );
+
+        if (this.progressManager) {
+          this.progressManager.tick(true, `field-rules: ${title}`, null);
+        }
       }
 
       if (this.fix) {

packages/contentstack-audit/test/unit/audit-base-command.test.ts

@@ -486,10 +486,10 @@ describe('AuditBaseCommand class', () => {
       }))
       .stub(AuditBaseCommand.prototype, 'showOutputOnScreenWorkflowsAndExtension', () => {})
       .stub(fs, 'createWriteStream', () => new PassThrough())
-      .it('should print global summary at the end of start method', async () => {
+      .it('should complete without printing global summary (summary display commented out)', async () => {
         await AuditCMD.run(['--data-dir', resolve(__dirname, 'mock', 'contents')]);
-        
-        expect(printGlobalSummarySpy.calledOnce).to.be.true;
+
+        expect(printGlobalSummarySpy.called).to.be.false;
       });
 
   });

packages/contentstack-audit/test/unit/mock/contents/assets/assets.json

@@ -0,0 +1 @@
+{"1": "chunk0-assets.json"}

packages/contentstack-audit/test/unit/mock/contents/assets/chunk0-assets.json

@@ -0,0 +1,25 @@
+{
+  "asset_uid_1": {
+    "uid": "asset_uid_1",
+    "title": "Test Asset",
+    "publish_details": [
+      { "locale": "en-us", "environment": "env1" }
+    ]
+  },
+  "asset_uid_invalid": {
+    "uid": "asset_uid_invalid",
+    "title": "Invalid Env Locale",
+    "publish_details": [
+      { "locale": "en-us", "environment": "env1" },
+      { "locale": "de-de", "environment": "env99" }
+    ]
+  },
+  "asset_uid_two_invalid": {
+    "uid": "asset_uid_two_invalid",
+    "title": "Two Invalid Pds",
+    "publish_details": [
+      { "locale": "de-de", "environment": "env99" },
+      { "locale": "fr-fr", "environment": "env99" }
+    ]
+  }
+}

packages/contentstack-audit/test/unit/mock/contents/environments/environments.json

@@ -0,0 +1,10 @@
+{
+  "env1": {
+    "name": "Environment 1",
+    "uid": "env-uid-1"
+  },
+  "env2": {
+    "name": "Environment 2",
+    "uid": "env-uid-2"
+  }
+}