Merge pull request #288 from RedisBot/madhur.singhal/disableRollBackFlagsPrefAddition-new-correct

feat: added utility class to enable rollback flags disable pref

Author: Shailesh Pachbhai

src/commands/omnistudio/migration/assess.ts

@@ -11,6 +11,7 @@ import { DebugTimer } from '../../../utils';
 import { Logger } from '../../../utils/logger';
 import OmnistudioRelatedObjectMigrationFacade from '../../../migration/related/OmnistudioRelatedObjectMigrationFacade';
 import { OmnistudioOrgDetails, OrgUtils } from '../../../utils/orgUtils';
+import { OrgPreferences } from '../../../utils/orgpreferences';
 import { Constants } from '../../../utils/constants/stringContants';
 
 Messages.importMessagesDirectory(__dirname);
@@ -108,7 +109,11 @@ export default class Assess extends OmniStudioBaseCommand {
       assesmentInfo.lwcAssessmentInfos = relatedObjectAssessmentResult.lwcAssessmentInfos;
       assesmentInfo.apexAssessmentInfos = relatedObjectAssessmentResult.apexAssessmentInfos;
     }
-
+    try {
+      orgs.rollbackFlags = await OrgPreferences.checkRollbackFlags(conn);
+    } catch (error) {
+      this.ux.log(error.message);
+    }
     await AssessmentReporter.generate(assesmentInfo, conn.instanceUrl, orgs, assessOnly, objectsToProcess);
     return assesmentInfo;
   }

src/commands/omnistudio/migration/migrate.ts

@@ -23,6 +23,7 @@ import OmnistudioRelatedObjectMigrationFacade from '../../../migration/related/O
 import { generatePackageXml } from '../../../utils/generatePackageXml';
 import { OmnistudioOrgDetails, OrgUtils } from '../../../utils/orgUtils';
 import { Constants } from '../../../utils/constants/stringContants';
+import { OrgPreferences } from '../../../utils/orgpreferences';
 
 // Initialize Messages with the current plugin directory
 Messages.importMessagesDirectory(__dirname);
@@ -67,6 +68,7 @@ export default class Migrate extends OmniStudioBaseCommand {
 
     Logger.initialiseLogger(this.ux, this.logger);
     this.logger = Logger.logger;
+
     // this.org is guaranteed because requiresUsername=true, as opposed to supportsUsername
     const conn = this.org.getConnection();
     conn.setApiVersion(apiVersion);
@@ -87,6 +89,15 @@ export default class Migrate extends OmniStudioBaseCommand {
       return;
     }
 
+    // Enable Omni preferences
+    try {
+      orgs.rollbackFlags = await OrgPreferences.checkRollbackFlags(conn);
+      await OrgPreferences.enableOmniPreferences(conn);
+    } catch (error) {
+      const errMsg = error instanceof Error ? error.message : String(error);
+      this.ux.log(`Could not enable Omni preferences: ${errMsg}`);
+    }
+
     const namespace = orgs.packageDetails.namespace;
     // Let's time every step
     DebugTimer.getInstance().start();

src/utils/interfaces.ts

@@ -144,3 +144,23 @@ export interface oldNew {
   old: string;
   new: string;
 }
+
+export interface OmniStudioSettingsMetadata {
+  fullName: string;
+  disableRollbackFlagsPref: boolean;
+}
+
+export interface QueryResult {
+  DeveloperName: string;
+  Value: string;
+  totalSize: number;
+  done: boolean;
+  records: Array<{
+    attributes: {
+      type: string;
+      url: string;
+    };
+    DeveloperName: string;
+    Value: string;
+  }>
+}

src/utils/orgPreferences.ts

@@ -0,0 +1,74 @@
+import { Connection } from '@salesforce/core';
+import { OmniStudioSettingsMetadata, QueryResult } from './interfaces';
+
+/**
+ * Class to manage OmniStudio organization preferences
+ *
+ * @class OrgPreferences
+ * @description Provides functionality to enable OmniStudio preferences and check rollback flags
+ */
+export class OrgPreferences {
+  /**
+   * List of rollback flags to check in OmniInteractionConfig
+   *
+   * @private
+   * @static
+   * @readonly
+   * @type {string[]}
+   */
+  private static readonly ROLLBACK_FLAGS: string[] = ['RollbackIPChanges', 'RollbackDRChanges', 'RollbackOSChanges'];
+
+  /**
+   * Enables the disableRollbackFlagsPref setting in OmniStudio
+   *
+   * @public
+   * @static
+   * @async
+   * @param {Connection} connection - Salesforce connection instance
+   * @throws {Error} If enabling the preference fails
+   * @returns {Promise<void>}
+   */
+  public static async enableOmniPreferences(connection: Connection): Promise<void> {
+    try {
+      await connection.metadata.update('OmniStudioSettings', [
+        {
+          fullName: 'OmniStudio',
+          disableRollbackFlagsPref: true,
+        } as OmniStudioSettingsMetadata,
+      ]);
+    } catch (error) {
+      throw new Error(
+        `Failed to enable disableRollbackFlagsPref: ${error instanceof Error ? error.message : String(error)}`
+      );
+    }
+  }
+
+  /**
+   * Checks which rollback flags are enabled in OmniInteractionConfig
+   *
+   * @public
+   * @static
+   * @async
+   * @param {Connection} connection - Salesforce connection instance
+   * @throws {Error} If checking rollback flags fails
+   * @returns {Promise<string[]>} Array of enabled rollback flag names
+   */
+  public static async checkRollbackFlags(connection: Connection): Promise<string[]> {
+    try {
+      const result = await connection.query<QueryResult>(
+        `SELECT DeveloperName, Value FROM OmniInteractionConfig WHERE DeveloperName IN ('${this.ROLLBACK_FLAGS.join(
+          "','"
+        )}')`
+      );
+      const enabledFlags: string[] = [];
+      for (const record of result.records) {
+        if (record.Value === 'true') {
+          enabledFlags.push(record.DeveloperName);
+        }
+      }
+      return enabledFlags;
+    } catch (error) {
+      throw new Error(`Failed to check rollback flags: ${error instanceof Error ? error.message : String(error)}`);
+    }
+  }
+}

src/utils/orgUtils/index.ts

@@ -21,6 +21,7 @@ export interface OmnistudioOrgDetails {
   orgDetails: OrgDetails;
   dataModel: string;
   hasValidNamespace: boolean;
+  rollbackFlags?: string[];
 }
 
 export interface PackageDetail {

src/utils/reportGenerator/reportGenerator.css

@@ -0,0 +1,39 @@
+.rollback-flags-section {
+  margin: 20px 0;
+  padding: 16px 24px;
+  background-color: #fff3e0;
+  border: 1px solid #ffb74d;
+  border-radius: 6px;
+  display: flex;
+  align-items: flex-start;
+  gap: 16px;
+}
+
+.rollback-flags-icon {
+  flex-shrink: 0;
+  margin-top: 2px;
+}
+
+.rollback-flags-content {
+  flex: 1;
+}
+
+.rollback-flags-header {
+  font-size: 1.1rem;
+  font-weight: 600;
+  color: #e65100;
+  margin-bottom: 8px;
+  display: flex;
+  align-items: center;
+}
+
+.rollback-flags-list {
+  list-style-type: disc;
+  margin-left: 20px;
+  color: #e65100;
+}
+
+.rollback-flags-list li {
+  margin: 5px 0;
+  font-weight: 500;
+} 

src/utils/reportGenerator/reportGenerator.ts

@@ -21,6 +21,9 @@ export function generateHtmlTable<T>(reportFrameworkParameters: ReportFrameworkP
   const reportHeaderLabel: string = reportFrameworkParameters.reportHeaderLabel;
   const indexedKey: string = reportFrameworkParameters.indexedKey;
   const showMigrationBanner: boolean = reportFrameworkParameters.showMigrationBanner;
+  const rollbackFlags: string[] = reportFrameworkParameters.rollbackFlags || [];
+  const rollbackFlagName: string = reportFrameworkParameters.rollbackFlagName;
+  const commandType: 'assess' | 'migrate' = reportFrameworkParameters.commandType || 'assess';
 
   const transformedHeader: TableHeaderCell[][] = transform(headerColumns);
   const tableId = `report-table-${reportTableInstance++}`;
@@ -202,6 +205,15 @@ export function generateHtmlTable<T>(reportFrameworkParameters: ReportFrameworkP
       ${ctaSummary && ctaSummary.length > 0 ? ctaButton : ''}
   </div>`;
 
+  let rollbackFlagsHtml = '';
+  if (rollbackFlags && rollbackFlagName) {
+    const flagNames = rollbackFlagName.split(',').map(flag => flag.trim());
+    const matchingFlags = flagNames.filter(flag => rollbackFlags.includes(flag));
+    if (matchingFlags.length > 0) {
+      rollbackFlagsHtml = generateRollbackFlagsHtml(rollbackFlags, matchingFlags.join(', '), commandType);
+    }
+  }
+
   return `
    <div class="report-wrapper">
     <div id="scrollable-wrapper" class="scrollable-wrapper">
@@ -231,6 +243,7 @@ export function generateHtmlTable<T>(reportFrameworkParameters: ReportFrameworkP
     <script src="./reportGeneratorUtility.js" defer></script>
     <link rel="stylesheet" href="./reportGenerator.css">
   </div>
+    ${rollbackFlagsHtml}
   `;
 }
 
@@ -301,3 +314,27 @@ function createIndexedRow<T>(row: T, indexedKey: string, columns: Array<TableCol
   }
   return rows;
 }
+export function generateRollbackFlagsHtml(rollbackFlags: string[], flagNames: string, commandType: 'assess' | 'migrate' = 'assess'): string {
+  const flagNameArray = flagNames.split(',').map(flag => flag.trim());
+  const matchingFlags = flagNameArray.filter(flag => rollbackFlags.includes(flag));
+  
+  if (matchingFlags.length === 0) {
+    return '';
+  }
+  
+  const actionText = commandType === 'migrate' ? matchingFlags.length > 1 ? 'were' : 'was' : 'will be';
+  
+  return `
+    <div class="slds-box" style="background-color: white; margin-top: 20px;">
+      <div class="slds-text-heading_medium">Rollback Flags Disabled</div>
+      <div style="margin-block: 15px">
+        <p>The following rollback flag${matchingFlags.length > 1 ? 's' : ''} ${actionText} disabled during migration:</p>
+        <ul class="slds-list_dotted">
+          ${matchingFlags.map(flag => `<li class="slds-item slds-text-color_destructive">${flag}</li>`).join('')}
+        </ul>
+        <p>
+          <strong>Note:</strong> ${matchingFlags.length > 1 ? 'These ' : 'This '} flag${matchingFlags.length > 1 ? 's will' : ' will'} no longer be supported after migration. For assistance, please contact support.
+        </p>
+      </div>
+    </div>`;
+}

src/utils/reportGenerator/reportInterfaces.ts

@@ -76,4 +76,7 @@ export interface ReportFrameworkParameters<T> {
   reportHeaderLabel: string;
   indexedKey?: string;
   showMigrationBanner: boolean;
+  rollbackFlags?: string[];
+  rollbackFlagName?: string;
+  commandType?: 'assess' | 'migrate';
 }

src/utils/resultsbuilder/DRAssessmentReporter.ts

@@ -13,7 +13,8 @@ export class DRAssessmentReporter {
   public static generateDRAssesment(
     dataRaptorAssessmentInfos: DataRaptorAssessmentInfo[],
     instanceUrl: string,
-    org: ReportHeaderFormat[]
+    orgDetails: ReportHeaderFormat[],
+    rollbackFlags: string[]
   ): string {
     // Header Column
     const headerColumn: HeaderColumn[] = [
@@ -123,15 +124,18 @@ export class DRAssessmentReporter {
       },
     ];
 
-    const reportFrameworkParameters: ReportFrameworkParameters<DRAssessmentReporter> = {
+    const reportFrameworkParameters: ReportFrameworkParameters<DataRaptorAssessmentInfo> = {
       headerColumns: headerColumn,
       columns,
       rows: dataRaptorAssessmentInfos,
-      orgDetails: org,
+      orgDetails: orgDetails,
       filters,
       ctaSummary: [],
       reportHeaderLabel: 'Data Mapper Assessment',
       showMigrationBanner: true,
+      rollbackFlags,
+      rollbackFlagName: 'RollbackDRChanges',
+      commandType: 'assess',
     };
     // Render table
     const tableHtml = generateHtmlTable(reportFrameworkParameters);

src/utils/resultsbuilder/IPAssessmentReporter.ts

@@ -12,7 +12,8 @@ export class IPAssessmentReporter {
   public static generateIPAssesment(
     ipAssessmentInfos: IPAssessmentInfo[],
     instanceUrl: string,
-    org: ReportHeaderFormat[]
+    orgDetails: ReportHeaderFormat[],
+    rollbackFlags: string[]
   ): string {
     // Define multi-row headers
     const headerColumn: HeaderColumn[] = [
@@ -107,11 +108,14 @@ export class IPAssessmentReporter {
       headerColumns: headerColumn,
       columns,
       rows: ipAssessmentInfos,
-      orgDetails: org,
+      orgDetails: orgDetails,
       filters: [],
       ctaSummary: [],
       reportHeaderLabel: 'Integration Procedure Assessment',
       showMigrationBanner: true,
+      rollbackFlags,
+      rollbackFlagName: 'RollbackIPChanges',
+      commandType: 'assess',
     };
     // Render table
     const tableHtml = generateHtmlTable(reportFrameworkParameters);