Org preference to disable rollback flags and test

Author: RedisBot

src/commands/omnistudio/migration/assess.ts

@@ -94,7 +94,8 @@ export default class Assess extends OmniStudioBaseCommand {
       flexCardAssessmentInfos,
       omniAssessmentInfo,
     };
-    await AssessmentReporter.generate(assesmentInfo, conn.instanceUrl);
+
+    await AssessmentReporter.generate(assesmentInfo, conn.instanceUrl, conn, orgs);
     return assesmentInfo;
   }
 }

src/commands/omnistudio/migration/migrate.ts

@@ -23,6 +23,7 @@ import { Logger } from '../../../utils/logger';
 import OmnistudioRelatedObjectMigrationFacade from '../../../migration/related/OmnistudioRelatedObjectMigrationFacade';
 import { generatePackageXml } from '../../../utils/generatePackageXml';
 import { OmnistudioOrgDetails, OrgUtils } from '../../../utils/orgUtils';
+import { OrgPreferences } from '../../../utils/orgpreferences';
 
 // Initialize Messages with the current plugin directory
 Messages.importMessagesDirectory(__dirname);
@@ -68,6 +69,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);
@@ -84,6 +86,17 @@ export default class Migrate extends OmniStudioBaseCommand {
       return;
     }
 
+    // Enable Omni preferences
+    try {
+      this.ux.log('Enabling Omni preferences...');
+      await OrgPreferences.enableOmniPreferences(conn);
+      this.ux.log('Omni preferences enabled successfully.');
+    } catch (error) {
+      const errMsg = error instanceof Error ? error.message : String(error);
+      this.ux.log(`Error: Could not enable Omni preferences: ${errMsg}`);
+      throw error;
+    }
+
     // Let's time every step
     DebugTimer.getInstance().start();
     let projectPath: string;

src/utils/orgpreferences.ts

@@ -0,0 +1,110 @@
+import { Connection } from '@salesforce/core';
+
+/**
+ * Interface representing the metadata structure for OmniStudio settings
+ *
+ * @interface OmniStudioSettingsMetadata
+ * @property {string} fullName - The full name of the OmniStudio settings
+ * @property {boolean} disableRollbackFlagsPref - Flag to disable rollback preferences
+ */
+interface OmniStudioSettingsMetadata {
+  fullName: string;
+  disableRollbackFlagsPref: boolean;
+}
+
+/**
+ * Interface representing the structure of query results from OmniInteractionConfig
+ *
+ * @interface QueryResult
+ * @property {string} DeveloperName - Name of the configuration
+ * @property {string} Value - Value of the configuration
+ * @property {number} totalSize - Total number of records returned
+ * @property {boolean} done - Whether the query is complete
+ * @property {Array<{attributes: {type: string, url: string}, DeveloperName: string, Value: string}>} records - Array of query result records
+ */
+interface QueryResult {
+  DeveloperName: string;
+  Value: string;
+  totalSize: number;
+  done: boolean;
+  records: Array<{
+    attributes: {
+      type: string;
+      url: string;
+    };
+    DeveloperName: string;
+    Value: string;
+  }>;
+}
+
+/**
+ * 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/resultsbuilder/assessmentReporter.ts

@@ -1,21 +1,29 @@
 /* eslint-disable prettier/prettier */
 /* eslint-disable @typescript-eslint/restrict-template-expressions */
 import fs from 'fs';
+import path from 'path';
 import open from 'open';
+import { Connection } from '@salesforce/core';
 import {
   ApexAssessmentInfo,
   AssessmentInfo,
   LWCAssessmentInfo,
-  OmniAssessmentInfo,
   FlexCardAssessmentInfo,
   nameLocation,
 } from '../interfaces';
-import { OSAssesmentReporter } from './OSAssessmentReporter';
+import { OrgPreferences } from '../orgpreferences';
+import { ReportHeaderFormat } from '../reportGenerator/reportInterfaces';
+import { OmnistudioOrgDetails } from '../orgUtils';
+import { OSAssessmentReporter } from './OSAssessmentReporter';
 import { IPAssessmentReporter } from './IPAssessmentReporter';
 import { DRAssessmentReporter } from './DRAssessmentReporter';
 
 export class AssessmentReporter {
-  public static async generate(result: AssessmentInfo, instanceUrl: string): Promise<void> {
+  public static async generate(
+    result: AssessmentInfo,
+    instanceUrl: string, connection: Connection,
+    omnistudioOrgDetails: OmnistudioOrgDetails
+  ): Promise<void> {
     const basePath = process.cwd() + '/assessment_reports';
     fs.mkdirSync(basePath, { recursive: true });
     const omniscriptAssessmentFilePath = basePath + '/omniscript_assessment.html';
@@ -24,25 +32,28 @@ export class AssessmentReporter {
     const dataMapperAssessmentFilePath = basePath + '/datamapper_assessment.html';
     const apexAssessmentFilePath = basePath + '/apex_assessment.html';
     const lwcAssessmentFilePath = basePath + '/lwc_assessment.html';
+    const rollbackFlagsReportPath = basePath + '/rollback_flags_report.html';
+    const orgDetails: ReportHeaderFormat[] = this.formattedOrgDetails(omnistudioOrgDetails);
 
     this.createDocument(
       omniscriptAssessmentFilePath,
-      this.generateOmniAssesment(result.omniAssessmentInfo, instanceUrl)
+      OSAssessmentReporter.generateOSAssesment(result.omniAssessmentInfo.osAssessmentInfos, instanceUrl, orgDetails)
     );
     this.createDocument(
       flexcardAssessmentFilePath,
       this.generateCardAssesment(result.flexCardAssessmentInfos, instanceUrl)
     );
     this.createDocument(
       integrationProcedureAssessmentFilePath,
-      IPAssessmentReporter.generateIPAssesment(result.omniAssessmentInfo.ipAssessmentInfos, instanceUrl)
+      IPAssessmentReporter.generateIPAssesment(result.omniAssessmentInfo.ipAssessmentInfos, instanceUrl, orgDetails)
     );
     this.createDocument(
       dataMapperAssessmentFilePath,
       DRAssessmentReporter.generateDRAssesment(result.dataRaptorAssessmentInfos, instanceUrl)
     );
     this.createDocument(apexAssessmentFilePath, this.generateApexAssesment(result.apexAssessmentInfos));
     this.createDocument(lwcAssessmentFilePath, this.generateLwcAssesment(result.lwcAssessmentInfos));
+
     const nameUrls = [
       {
         name: 'omnscript assessment report',
@@ -69,7 +80,88 @@ export class AssessmentReporter {
         location: 'lwc_assessment.html',
       },
     ];
+
+    // Check rollback flags
+    const enabledFlags = await OrgPreferences.checkRollbackFlags(connection);
+    if (enabledFlags.length > 0) {
+      this.createDocument(rollbackFlagsReportPath, this.generateRollbackFlagsReport(enabledFlags));
+      nameUrls.push({
+        name: 'Rollback Flags Report',
+        location: 'rollback_flags_report.html',
+      });
+    }
+
+
     await this.createMasterDocument(nameUrls, basePath);
+    this.pushAssestUtilites('javascripts', basePath);
+    this.pushAssestUtilites('styles', basePath);
+  }
+
+  private static formattedOrgDetails(orgDetails: OmnistudioOrgDetails): ReportHeaderFormat[] {
+    return [
+      {
+        key: 'Org Name',
+        value: orgDetails.orgDetails.Name,
+      },
+      {
+        key: 'Org Id',
+        value: orgDetails.orgDetails.Id,
+      },
+      {
+        key: 'Package Name',
+        value: orgDetails.packageDetails[0].namespace,
+      },
+      {
+        key: 'Data Model',
+        value: orgDetails.dataModel,
+      },
+      {
+        key: 'Assessment Date and Time',
+        value: new Date() as unknown as string,
+      },
+    ];
+  }
+
+  /**
+   * Copies `.js` and `.css` files from a source directory (based on `folderName`)
+   * to a specified destination directory.
+   *
+   * @param folderName - The subdirectory under `/src/` where source asset files are located (e.g., `'javascripts'`, `'styles'`).
+   * @param destDir - The absolute or relative path to the destination directory where the assets should be copied.
+   *
+   * @remarks
+   * - If the destination directory does not exist, the method logs a warning and exits.
+   * - Only `.js` and `.css` files are copied.
+   * - The source files remain in place after copying.
+   */
+  private static pushAssestUtilites(folderName: string, destDir: string): void {
+    const sourceDir = path.join(process.cwd(), 'src', folderName);
+
+    if (!fs.existsSync(destDir)) {
+      // Destination directory does not exist. Skipping file copy.
+      return;
+    }
+
+    fs.readdir(sourceDir, (readDirErr, files) => {
+      if (readDirErr) {
+        // Error reading source directory: readDirErr.message
+        return;
+      }
+
+      files.forEach((file) => {
+        const ext = path.extname(file);
+        if (ext === '.js' || ext === '.css') {
+          const srcPath = path.join(sourceDir, file);
+          const destPath = path.join(destDir, file);
+
+          fs.copyFile(srcPath, destPath, (copyErr) => {
+            if (copyErr) {
+              // Failed to copy file: copyErr.message
+            }
+          });
+        }
+      });
+    });
   }
 
   private static async createMasterDocument(reports: nameLocation[], basePath: string): Promise<void> {
@@ -195,11 +287,6 @@ export class AssessmentReporter {
       </div>`;
     return tableBody;
   }
-  private static generateOmniAssesment(omniAssessmentInfo: OmniAssessmentInfo, instanceUrl: string): string {
-    let htmlBody = '';
-    htmlBody += '<br />' + OSAssesmentReporter.generateOSAssesment(omniAssessmentInfo.osAssessmentInfos, instanceUrl);
-    return htmlBody;
-  }
 
   private static generateCardAssesment(flexCardAssessmentInfos: FlexCardAssessmentInfo[], instanceUrl: string): string {
     let tableBody = '';
@@ -246,7 +333,6 @@ export class AssessmentReporter {
             </head>
             <body>
             <div style="margin: 20px;">
-                <div class="slds-text-heading_large">OmniStudio Migration Assessment </div>
                     ${resultsAsHtml}
                 </div>
             </div>
@@ -311,4 +397,19 @@ export class AssessmentReporter {
       </div>`;
     return tableBody;
   }
+
+  private static generateRollbackFlagsReport(enabledFlags: string[]): string {
+    return `
+      <div class="slds-box slds-theme_warning" style="margin-bottom: 20px;">
+        <div class="slds-text-heading_medium slds-m-bottom_small">⚠️ Warning: Rollback Flags Enabled</div>
+        <p>The following rollback flags are currently enabled and will be disabled during migration:</p>
+        <ul class="slds-m-top_small">
+          ${enabledFlags.map((flag) => `<li>${flag}</li>`).join('')}
+        </ul>
+        <p class="slds-m-top_small">
+          <strong>Note:</strong> These flags will not be supported after migration. For assistance, please contact support.
+        </p>
+      </div>
+    `;
+  }
 }