Feat: Added Field Rules for Audit and Audit fix

Author: cs-raj

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

@@ -7,12 +7,11 @@ import { join, resolve } from 'path';
 import cloneDeep from 'lodash/cloneDeep';
 import { cliux, sanitizePath, ux } from '@contentstack/cli-utilities';
 import { createWriteStream, existsSync, mkdirSync, readFileSync, writeFileSync, rmSync } from 'fs';
-
 import config from './config';
 import { print } from './util/log';
 import { auditMsg } from './messages';
 import { BaseCommand } from './base-command';
-import { Entries, GlobalField, ContentType, Extensions, Workflows, Assets } from './modules';
+import { Entries, GlobalField, ContentType, Extensions, Workflows, Assets, FieldRule } from './modules';
 import {
   CommandNames,
   ContentTypeStruct,
@@ -60,7 +59,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingTitleFields,
       missingRefInCustomRoles,
       missingEnvLocalesInAssets,
-      missingEnvLocalesInEntries
+      missingEnvLocalesInEntries,
+      missingFieldRules
     } = await this.scanAndFix();
 
     this.showOutputOnScreen([
@@ -70,6 +70,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
     ]);
     this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Extensions', missingRefs: missingCtRefsInExtensions }]);
     this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Workflows', missingRefs: missingCtRefsInWorkflow }]);
+
     this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Entries Select Field', missingRefs: missingSelectFeild }]);
     this.showOutputOnScreenWorkflowsAndExtension([
       { module: 'Entries Mandatory Field', missingRefs: missingMandatoryFields },
@@ -80,6 +81,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
     this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Custom Roles', missingRefs: missingRefInCustomRoles }]);
     this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Assets', missingRefs: missingEnvLocalesInAssets }]);
     this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Entries Missing Locale and Environments', missingRefs: missingEnvLocalesInEntries }])
+    this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Field Rules', missingRefs: missingFieldRules }])
+    
     if (
       !isEmpty(missingCtRefs) ||
       !isEmpty(missingGfRefs) ||
@@ -90,7 +93,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       !isEmpty(missingTitleFields) ||
       !isEmpty(missingRefInCustomRoles) ||
       !isEmpty(missingEnvLocalesInAssets) ||
-      !isEmpty(missingEnvLocalesInEntries)
+      !isEmpty(missingEnvLocalesInEntries) || 
+      !isEmpty(missingSelectFeild)
     ) {
       if (this.currentCommand === 'cm:stacks:audit') {
         this.log(this.$t(auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), 'warn');
@@ -120,7 +124,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       !isEmpty(missingSelectFeild) || 
       !isEmpty(missingRefInCustomRoles) ||
       !isEmpty(missingEnvLocalesInAssets) ||
-      !isEmpty(missingEnvLocalesInEntries)
+      !isEmpty(missingEnvLocalesInEntries) ||
+      !isEmpty(missingFieldRules)
     );
   }
 
@@ -143,7 +148,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingTitleFields,
       missingRefInCustomRoles,
       missingEnvLocalesInAssets,
-      missingEnvLocalesInEntries;
+      missingEnvLocalesInEntries,
+      missingFieldRules;
 
     for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
       print([
@@ -211,6 +217,10 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
           missingRefInCustomRoles = await new CustomRoles(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingRefInCustomRoles);
           break;
+        case 'field-rules':
+          missingFieldRules = await new FieldRule(cloneDeep(constructorParam)).run();
+          await this.prepareReport(module, missingFieldRules);
+          break;
       }
 
       print([
@@ -238,7 +248,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingTitleFields,
       missingRefInCustomRoles,
       missingEnvLocalesInAssets,
-      missingEnvLocalesInEntries
+      missingEnvLocalesInEntries,
+      missingFieldRules
     };
   }
 
@@ -435,7 +446,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
    * @returns The function `prepareReport` returns a Promise that resolves to `void`.
    */
   prepareReport(
-    moduleName: keyof typeof config.moduleConfig | keyof typeof config.ReportTitleForEntries,
+    moduleName: keyof typeof config.moduleConfig | keyof typeof config.ReportTitleForEntries | 'field-rules',
     listOfMissingRefs: Record<string, any>,
   ): Promise<void> {
     if (isEmpty(listOfMissingRefs)) return Promise.resolve(void 0);
@@ -462,7 +473,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
    * @returns The function `prepareCSV` returns a Promise that resolves to `void`.
    */
   prepareCSV(
-    moduleName: keyof typeof config.moduleConfig | keyof typeof config.ReportTitleForEntries,
+    moduleName: keyof typeof config.moduleConfig | keyof typeof config.ReportTitleForEntries | 'field-rules',
     listOfMissingRefs: Record<string, any>,
   ): Promise<void> {
     if (Object.keys(config.moduleConfig).includes(moduleName) || config.feild_level_modules.includes(moduleName)) {

packages/contentstack-audit/src/config/index.ts

@@ -2,7 +2,7 @@ const config = {
   showTerminalOutput: true,
   skipRefs: ['sys_assets'],
   skipFieldTypes: ['taxonomy', 'group'],
-  modules: ['content-types', 'global-fields', 'entries', 'extensions', 'workflows', 'custom-roles', 'assets'],
+  modules: ['content-types', 'global-fields', 'entries', 'extensions', 'workflows', 'custom-roles', 'assets', 'field-rules'],
   'fix-fields': ['reference', 'global_field', 'json:rte', 'json:extension', 'blocks', 'group', 'content_types'],
   moduleConfig: {
     'content-types': {
@@ -103,7 +103,7 @@ const config = {
     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'
   },
-  feild_level_modules: ['Entries_Title_feild', 'Entries_Mandatory_feild', 'Entries_Select_feild', 'Entry_Missing_Locale_and_Env_in_Publish_Details'],
+  feild_level_modules: ['Entries_Title_feild', 'Entries_Mandatory_feild', 'Entries_Select_feild', 'Entry_Missing_Locale_and_Env_in_Publish_Details', 'field-rules'],
   fixSelectField: false
 };
 

packages/contentstack-audit/src/messages/index.ts

@@ -43,6 +43,10 @@ const auditMsg = {
   CT_REFERENCE_FIELD: `The mentioned Reference field is not Array field reference is '{reference_to}' having display name '{display_name}''`,
   ASSET_NOT_EXIST: `The publish_details either does not exist or is not an array for asset uid '{uid}'`,
   ENTRY_PUBLISH_DETAILS_NOT_EXIST: `The publish_details either does not exist or is not an array for entry uid '{uid}'`,
+  FIELD_RULE_CONDITION_ABSENT: `The operand field '{condition_field}' is not present in the schema of the content-type {ctUid}`,
+  FIELD_RULE_TARGET_ABSENT: `The target field '{target_field}' is not present in the schema of the content-type {ctUid}`,
+  FIELD_RULE_CONDITION_SCAN_MESSAGE: `Completed Scanning of Field Rule '{num}' condition of Content-type '{ctUid}'`,
+  FIELD_RULE_TARGE_SCAN_MESSAGE: `Completed Scanning of Field Rule '{num}' target of Content-type '{ctUid}'`
 };
 
 const auditFixMsg = {

packages/contentstack-audit/src/modules/content-types.ts

@@ -44,7 +44,7 @@ export default class ContentType {
   protected schema: ContentTypeStruct[] = [];
   protected missingRefs: Record<string, any> = {};
   public moduleName: keyof typeof auditConfig.moduleConfig;
-
+  public f:any = []
   constructor({ log, fix, config, moduleName, ctSchema, gfSchema }: ModuleConstructorParam & CtConstructorParam) {
     this.log = log;
     this.config = config;
@@ -91,7 +91,7 @@ export default class ContentType {
       this.currentTitle = schema.title;
       this.missingRefs[this.currentUid] = [];
       const { uid, title } = schema;
-      await this.lookForReference([{ uid, name: title }], schema);
+      await this.lookForReference([{ uid, name: title }], schema, null);
       this.log(
         $t(auditMsg.SCAN_CT_SUCCESS_MSG, { title, module: this.config.moduleConfig[this.moduleName].name }),
         'info',
@@ -179,14 +179,18 @@ export default class ContentType {
   async lookForReference(
     tree: Record<string, unknown>[],
     field: ContentTypeStruct | GlobalFieldDataType | ModularBlockType | GroupFieldDataType,
+    parent: any = null
   ): Promise<void> {
     const fixTypes = this.config.flags['fix-only'] ?? this.config['fix-fields'];
 
     if (this.fix) {
       field.schema = this.runFixOnSchema(tree, field.schema as ContentTypeSchemaType[]);
     }
-
     for (let child of field.schema ?? []) {
+      if(parent) {
+        this.f.push(parent+"."+child.uid)
+      }
+      
       if (!fixTypes.includes(child.data_type) && child.data_type !== 'json') continue;
 
       switch (child.data_type) {
@@ -317,7 +321,7 @@ export default class ContentType {
       return void 0;
     }
 
-    await this.lookForReference(tree, field);
+    await this.lookForReference(tree, field, field.uid);
   }
 
   /**
@@ -351,7 +355,7 @@ export default class ContentType {
     for (const block of blocks) {
       const { uid, title } = block;
 
-      await this.lookForReference([...tree, { uid, name: title }], block);
+      await this.lookForReference([...tree, { uid, name: title }], block, block.uid);
     }
   }
 
@@ -367,7 +371,7 @@ export default class ContentType {
    */
   async validateGroupField(tree: Record<string, unknown>[], field: GroupFieldDataType): Promise<void> {
     // NOTE Any Group Field related logic can be added here (Ex data serialization or picking any metadata for report etc.,)
-    await this.lookForReference(tree, field);
+    await this.lookForReference(tree, field, field.uid);
   }
 
   /**

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

@@ -115,6 +115,7 @@ export default class Entries {
             const { uid, title } = entry;
             this.currentUid = uid;
             this.currentTitle = title;
+            this.currentTitle = this.removeEmojiAndImages(this.currentTitle)
 
             if (!this.missingRefs[this.currentUid]) {
               this.missingRefs[this.currentUid] = [];
@@ -131,7 +132,7 @@ export default class Entries {
               this.removeMissingKeysOnEntry(ctSchema.schema as ContentTypeSchemaType[], this.entries[entryUid]);
             }
 
-            this.lookForReference([{ locale: code, uid, name: title }], ctSchema, this.entries[entryUid]);
+            this.lookForReference([{ locale: code, uid, name: this.removeEmojiAndImages(title) }], ctSchema, this.entries[entryUid]);
 
             if (this.missingRefs[this.currentUid]?.length) {
               this.missingRefs[this.currentUid].forEach((entry: any) => {
@@ -650,8 +651,8 @@ export default class Entries {
       if (!uid && reference.startsWith('blt')) {
         const refExist = find(this.entryMetaData, { uid: reference });
         if (!refExist) {
-          if(Array.isArray(reference_to) && reference_to.length===1) {
-            missingRefs.push({uid:reference, _content_type_uid: reference_to[0]});
+          if (Array.isArray(reference_to) && reference_to.length === 1) {
+            missingRefs.push({ uid: reference, _content_type_uid: reference_to[0] });
           } else {
             missingRefs.push(reference);
           }
@@ -799,6 +800,13 @@ export default class Entries {
    * @returns if there is missing field returns field and path
    * Else empty array
    */
+  removeEmojiAndImages(str: string) {
+    return str.replace(
+      /[\p{Emoji}\p{Emoji_Presentation}\p{Emoji_Modifier}\p{Emoji_Modifier_Base}\p{Emoji_Component}]+/gu,
+      '',
+    );
+  }
+
   validateSelectField(tree: Record<string, unknown>[], fieldStructure: SelectFeildStruct, field: any) {
     const { display_name, enum: selectOptions, multiple, min_instance, display_type, data_type } = fieldStructure;
     if (
@@ -1225,8 +1233,8 @@ export default class Entries {
         if (!uid && reference.startsWith('blt')) {
           const refExist = find(this.entryMetaData, { uid: reference });
           if (!refExist) {
-            if(Array.isArray(reference_to) && reference_to.length===1) {
-              missingRefs.push({uid:reference, _content_type_uid: reference_to[0]});
+            if (Array.isArray(reference_to) && reference_to.length === 1) {
+              missingRefs.push({ uid: reference, _content_type_uid: reference_to[0] });
             } else {
               missingRefs.push(reference);
             }
@@ -1399,7 +1407,7 @@ export default class Entries {
                 `error`,
               );
             }
-            this.entryMetaData.push({ uid: entryUid, title, ctUid:uid });
+            this.entryMetaData.push({ uid: entryUid, title, ctUid: uid });
           }
         }
       }