Merge pull request #2285 from contentstack/feat/DX-3810

added composable studio validation in audit plugin

Author: shafeeqd959

.gitignore

@@ -3,7 +3,7 @@ node_modules
 .env
 .dccache
 logs
-contents
+/contents
 lerna-debug.log
 .DS_Store
 contentTest

.talismanrc

@@ -1,8 +1,8 @@
 fileignoreconfig:
   - filename: package-lock.json
-    checksum: 25bcbb12c701b53f222c599fa8ce53f347853a1d96257cee79b5cf5878e50015
+    checksum: 0cac869eb2f174e45751388de3eb46d48fbc8f5dbc56faf06000dbad7b5e8466
   - filename: pnpm-lock.yaml
-    checksum: 448638c016e13e936e2dfa8297076162b0662de198908d994665579bab8f4b36
+    checksum: cf7ddbd499ceb5d26ceb94381db0ecd576745b96b4deedd7442d3c8aa820ba92
   - filename: packages/contentstack-import-setup/test/unit/backup-handler.test.ts
     checksum: 0582d62b88834554cf12951c8690a73ef3ddbb78b82d2804d994cf4148e1ef93
   - filename: packages/contentstack-import-setup/test/config.json
@@ -95,8 +95,6 @@ fileignoreconfig:
     checksum: bbe1130f5f5ebf2fa452daef743fe4d40ae9f8fc05c7f8c59c82a3d3d1ed69e8
   - filename: packages/contentstack-audit/src/modules/extensions.ts
     checksum: 32af019f0df8288448d11559fe9f7ef61d3e43c3791d45eeec25fd0937c6baad
-  - filename: packages/contentstack-audit/src/modules/modulesData.ts
-    checksum: bac8f1971ac2e39bc04d9297b81951fe34ed265dfc985137135f9bbe775cd63c
   - filename: packages/contentstack-audit/src/modules/assets.ts
     checksum: 5a007804c75976dd192ed2284b7b7edbc5b5fc269fc0e883908b52e4d4f206a8
   - filename: packages/contentstack-audit/src/modules/workflows.ts
@@ -118,7 +116,7 @@ fileignoreconfig:
   - filename: packages/contentstack-import/test/unit/import/modules/mock-data/entries/environments.json
     checksum: 17f94f500dcb265575b60f8d2cb7464372a234e452527b3bdec6052c606cee28
   - filename: packages/contentstack-import/test/unit/import/modules/entries.test.ts
-    checksum: 7b984d292a534f9d075d801de2aeff802b2832bc5e2efadf8613a7059f4317fc
+    checksum: d8e4f6ad185b36b6f84b38dce169144e7d5a195668aac11f914eed5e1e4b5478
   - filename: packages/contentstack-import/test/unit/import/modules/labels.test.ts
     checksum: 46fe0d1602ab386f7eaee9839bc376b98ab8d4262f823784eda9cfa2bf893758
   - filename: packages/contentstack-export/test/unit/export/modules/assets.test.ts
@@ -269,4 +267,10 @@ fileignoreconfig:
     checksum: e8714ef41940f3a9be782dfaa43a15df57bd1eb4c3f0e4d5f305e68681c1bd93
   - filename: packages/contentstack-import/src/import/modules-js/environments.js
     checksum: d484342c25462a7052c8aae6cad0baed9a01e1eaa67d6a09f175981c53092301
+  - filename: packages/contentstack-audit/test/unit/mock/contents/composable_studio/environments/environments.json
+    checksum: 0402604e5919a7e38ecb5ff0916d6ae5ab7d98fe78ff6ac9eba8a9b8130af34d
+  - filename: packages/contentstack-audit/test/unit/mock/contents/composable_studio/composable_studio.json
+    checksum: 6912e5ea32b4456ad04d1645750c72bbb29ab1895368c3a242ab39e9350ec531
+  - filename: packages/contentstack-audit/test/unit/mock/contents/composable_studio/invalid_composable_studio.json
+    checksum: e6465aa0011d1565a2de848d9cca74395d11419e6ac840e7dfb52e1d255b1c4f
 version: '1.0'

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.16.2",
+  "version": "1.17.0",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",

packages/contentstack-audit/package.json

@@ -5,7 +5,15 @@ import { v4 as uuid } from 'uuid';
 import isEmpty from 'lodash/isEmpty';
 import { join, resolve } from 'path';
 import cloneDeep from 'lodash/cloneDeep';
-import { cliux, sanitizePath, TableFlags, TableHeader, log, configHandler, createLogContext } from '@contentstack/cli-utilities';
+import {
+  cliux,
+  sanitizePath,
+  TableFlags,
+  TableHeader,
+  log,
+  configHandler,
+  createLogContext,
+} from '@contentstack/cli-utilities';
 import { createWriteStream, existsSync, mkdirSync, readFileSync, writeFileSync, rmSync } from 'fs';
 import config from './config';
 import { print } from './util/log';
@@ -21,6 +29,7 @@ import {
   FieldRule,
   ModuleDataReader,
   CustomRoles,
+  ComposableStudio,
 } from './modules';
 
 import {
@@ -50,7 +59,6 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
     };
   }
 
-
   /**
    * The `start` function performs an audit on content types, global fields, entries, and workflows and displays
    * any missing references.
@@ -65,7 +73,6 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
     log.debug(`Starting audit command: ${command}`, this.auditContext);
     log.info(`Starting audit command: ${command}`, this.auditContext);
 
-    
     await this.promptQueue();
     await this.createBackUp();
     this.sharedConfig.reportPath = resolve(this.flags['report-path'] || process.cwd(), 'audit-report');
@@ -86,6 +93,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingEnvLocalesInEntries,
       missingFieldRules,
       missingMultipleFields,
+      missingRefsInComposableStudio,
     } = await this.scanAndFix();
 
     if (this.flags['show-console-output']) {
@@ -116,6 +124,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       this.showOutputOnScreenWorkflowsAndExtension([
         { module: 'Entries Changed Multiple Fields', missingRefs: missingMultipleFields },
       ]);
+      this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Studio', missingRefs: missingRefsInComposableStudio }]);
     }
     this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Summary', missingRefs: this.summaryDataToPrint }]);
 
@@ -131,12 +140,16 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       !isEmpty(missingEnvLocalesInAssets) ||
       !isEmpty(missingEnvLocalesInEntries) ||
       !isEmpty(missingFieldRules) ||
-      !isEmpty(missingMultipleFields)
+      !isEmpty(missingMultipleFields) ||
+      !isEmpty(missingRefsInComposableStudio)
     ) {
       if (this.currentCommand === 'cm:stacks:audit') {
         log.warn(this.$t(auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), this.auditContext);
       } else {
-        log.warn(this.$t(this.messages.FIXED_CONTENT_PATH_MAG, { path: this.sharedConfig.basePath }), this.auditContext);
+        log.warn(
+          this.$t(this.messages.FIXED_CONTENT_PATH_MAG, { path: this.sharedConfig.basePath }),
+          this.auditContext,
+        );
       }
     } else {
       log.info(this.messages.NO_MISSING_REF_FOUND, this.auditContext);
@@ -162,7 +175,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       !isEmpty(missingRefInCustomRoles) ||
       !isEmpty(missingEnvLocalesInAssets) ||
       !isEmpty(missingEnvLocalesInEntries) ||
-      !isEmpty(missingFieldRules)
+      !isEmpty(missingFieldRules) ||
+      !isEmpty(missingRefsInComposableStudio)
     );
   }
 
@@ -175,8 +189,11 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
   async scanAndFix() {
     log.debug('Starting scan and fix process', this.auditContext);
     let { ctSchema, gfSchema } = this.getCtAndGfSchema();
-    log.info(`Retrieved ${ctSchema?.length || 0} content types and ${gfSchema?.length || 0} global fields`, this.auditContext);
-    
+    log.info(
+      `Retrieved ${ctSchema?.length || 0} content types and ${gfSchema?.length || 0} global fields`,
+      this.auditContext,
+    );
+
     let missingCtRefs,
       missingGfRefs,
       missingEntryRefs,
@@ -197,7 +214,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingEnvLocalesInAssets,
       missingEnvLocalesInEntries,
       missingFieldRules,
-      missingMultipleFields;
+      missingMultipleFields,
+      missingRefsInComposableStudio;
 
     const constructorParam: ModuleConstructorParam & CtConstructorParam = {
       ctSchema,
@@ -233,21 +251,30 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
           missingEnvLocalesInAssets = await new Assets(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingEnvLocalesInAssets);
           this.getAffectedData('assets', dataModuleWise['assets'], missingEnvLocalesInAssets);
-          log.success(`Assets audit completed. Found ${Object.keys(missingEnvLocalesInAssets || {}).length} issues`, this.auditContext);
+          log.success(
+            `Assets audit completed. Found ${Object.keys(missingEnvLocalesInAssets || {}).length} issues`,
+            this.auditContext,
+          );
           break;
         case 'content-types':
           log.info('Executing content-types audit', this.auditContext);
           missingCtRefs = await new ContentType(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingCtRefs);
           this.getAffectedData('content-types', dataModuleWise['content-types'], missingCtRefs);
-          log.success(`Content-types audit completed. Found ${Object.keys(missingCtRefs || {}).length} issues`, this.auditContext);
+          log.success(
+            `Content-types audit completed. Found ${Object.keys(missingCtRefs || {}).length} issues`,
+            this.auditContext,
+          );
           break;
         case 'global-fields':
           log.info('Executing global-fields audit', this.auditContext);
           missingGfRefs = await new GlobalField(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingGfRefs);
           this.getAffectedData('global-fields', dataModuleWise['global-fields'], missingGfRefs);
-          log.success(`Global-fields audit completed. Found ${Object.keys(missingGfRefs || {}).length} issues`, this.auditContext);
+          log.success(
+            `Global-fields audit completed. Found ${Object.keys(missingGfRefs || {}).length} issues`,
+            this.auditContext,
+          );
           break;
         case 'entries':
           log.info('Executing entries audit', this.auditContext);
@@ -270,7 +297,10 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
 
           await this.prepareReport('Entry_Multiple_Fields', missingMultipleFields);
           this.getAffectedData('entries', dataModuleWise['entries'], missingEntry);
-          log.success(`Entries audit completed. Found ${Object.keys(missingEntryRefs || {}).length} reference issues`, this.auditContext);
+          log.success(
+            `Entries audit completed. Found ${Object.keys(missingEntryRefs || {}).length} reference issues`,
+            this.auditContext,
+          );
 
           break;
         case 'workflows':
@@ -283,34 +313,62 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
           }).run();
           await this.prepareReport(module, missingCtRefsInWorkflow);
           this.getAffectedData('workflows', dataModuleWise['workflows'], missingCtRefsInWorkflow);
-          log.success(`Workflows audit completed. Found ${Object.keys(missingCtRefsInWorkflow || {}).length} issues`, this.auditContext);
+          log.success(
+            `Workflows audit completed. Found ${Object.keys(missingCtRefsInWorkflow || {}).length} issues`,
+            this.auditContext,
+          );
 
           break;
         case 'extensions':
           log.info('Executing extensions audit', this.auditContext);
           missingCtRefsInExtensions = await new Extensions(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingCtRefsInExtensions);
           this.getAffectedData('extensions', dataModuleWise['extensions'], missingCtRefsInExtensions);
-          log.success(`Extensions audit completed. Found ${Object.keys(missingCtRefsInExtensions || {}).length} issues`, this.auditContext);
+          log.success(
+            `Extensions audit completed. Found ${Object.keys(missingCtRefsInExtensions || {}).length} issues`,
+            this.auditContext,
+          );
           break;
         case 'custom-roles':
           log.info('Executing custom-roles audit', this.auditContext);
           missingRefInCustomRoles = await new CustomRoles(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingRefInCustomRoles);
           this.getAffectedData('custom-roles', dataModuleWise['custom-roles'], missingRefInCustomRoles);
-          log.success(`Custom-roles audit completed. Found ${Object.keys(missingRefInCustomRoles || {}).length} issues`, this.auditContext);
+          log.success(
+            `Custom-roles audit completed. Found ${Object.keys(missingRefInCustomRoles || {}).length} issues`,
+            this.auditContext,
+          );
 
           break;
         case 'field-rules':
           log.info('Executing field-rules audit', this.auditContext);
           // NOTE: We are using the fixed content-type for validation of field rules
-          const data =  this.getCtAndGfSchema();
+          const data = this.getCtAndGfSchema();
           constructorParam.ctSchema = data.ctSchema;
           constructorParam.gfSchema = data.gfSchema;
           missingFieldRules = await new FieldRule(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingFieldRules);
           this.getAffectedData('field-rules', dataModuleWise['content-types'], missingFieldRules);
-          log.success(`Field-rules audit completed. Found ${Object.keys(missingFieldRules || {}).length} issues`, this.auditContext);
+          log.success(
+            `Field-rules audit completed. Found ${Object.keys(missingFieldRules || {}).length} issues`,
+            this.auditContext,
+          );
+          break;
+        case 'composable-studio':
+          log.info('Executing composable-studio audit', this.auditContext);
+          missingRefsInComposableStudio = await new ComposableStudio(cloneDeep(constructorParam)).run();
+          await this.prepareReport(module, missingRefsInComposableStudio);
+          this.getAffectedData(
+            'composable-studio',
+            dataModuleWise['composable-studio'] || { Total: Object.keys(missingRefsInComposableStudio || {}).length },
+            missingRefsInComposableStudio,
+          );
+          log.success(
+            `Composable-studio audit completed. Found ${
+              Object.keys(missingRefsInComposableStudio || {}).length
+            } issues`,
+            this.auditContext,
+          );
           break;
       }
 
@@ -345,6 +403,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingEnvLocalesInEntries,
       missingFieldRules,
       missingMultipleFields,
+      missingRefsInComposableStudio,
     };
   }
 
@@ -488,7 +547,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       }
 
       print([{ bold: true, color: 'cyan', message: ` ${module}` }]);
-      
+
       const tableValues = Object.values(missingRefs).flat();
       missingRefs = Object.values(missingRefs).flat();
       const tableKeys = Object.keys(missingRefs[0]);
@@ -542,7 +601,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
     log.debug(`Preparing report for module: ${moduleName}`, this.auditContext);
     log.debug(`Report path: ${this.sharedConfig.reportPath}`, this.auditContext);
     log.info(`Missing references count: ${Object.keys(listOfMissingRefs).length}`, this.auditContext);
-    
+
     if (isEmpty(listOfMissingRefs)) {
       log.debug(`No missing references found for ${moduleName}, skipping report generation`, this.auditContext);
       return Promise.resolve(void 0);

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

@@ -11,9 +11,10 @@ const config = {
     'custom-roles',
     'assets',
     'field-rules',
+    'composable-studio',
   ],
   'fix-fields': ['reference', 'global_field', 'json:rte', 'json:extension', 'blocks', 'group', 'content_types'],
-  'schema-fields-data-type': ['blocks','group','global_field'],
+  'schema-fields-data-type': ['blocks', 'group', 'global_field'],
   moduleConfig: {
     'content-types': {
       name: 'content type',
@@ -60,6 +61,11 @@ const config = {
       dirName: 'environments',
       fileName: 'environments.json',
     },
+    'composable-studio': {
+      name: 'composable-studio',
+      dirName: 'composable_studio',
+      fileName: 'composable_studio.json',
+    },
   },
   entries: {
     systemKeys: [
@@ -107,21 +113,22 @@ const config = {
     'selectedValue',
     'ct_uid',
     'action',
-    "Module",
-    "Total",
-    "Fixable",
-    "Non-Fixable",
-    "Fixed",
-    "Not-Fixed",
-    "Passed",
+    'Module',
+    'Total',
+    'Fixable',
+    'Non-Fixable',
+    'Fixed',
+    'Not-Fixed',
+    'Passed',
+    'issues',
   ],
   ReportTitleForEntries: {
     Entries_Select_field: 'Entries_Select_field',
     Entries_Mandatory_field: 'Entries_Mandatory_field',
     Entries_Title_field: 'Entries_Title_field',
     Entry_Missing_Locale_and_Env: 'Entry_Missing_Locale_and_Env',
     Entry_Missing_Locale_and_Env_in_Publish_Details: 'Entry_Missing_Locale_and_Env_in_Publish_Details',
-    Entry_Multiple_Fields:"Entry_Multiple_Fields"
+    Entry_Multiple_Fields: 'Entry_Multiple_Fields',
   },
   feild_level_modules: [
     'Entries_Title_field',
@@ -130,7 +137,7 @@ const config = {
     'Entry_Missing_Locale_and_Env_in_Publish_Details',
     'field-rules',
     'Entry_Multiple_Fields',
-    'Summary'
+    'Summary',
   ],
   fixSelectField: false,
 };