Merge pull request #395 from sf-kishore-kurri/u/kkurri/W-19081579

feat: @W-19081579: Omnistudio License validation and additional fixes

Author: snehaljha-sf

messages/assess.json

@@ -33,9 +33,10 @@
   "angularOSWarning": " Angular Omniscript will not be migrated, please convert this to LWC based Omniscript",
   "relatedObjectGA": "Please select the type of component to assess: 'apex' for Apex classes, 'lwc' for Lightning Web Components, 'flexipage' for FlexiPages, or 'apex,lwc,flexipage' if you want to include all types.",
   "apexLwc": "Please select the type of component to assess: 'apex' for Apex classes.",
-  "invalidNamespace": "The namespace you have passed is not valid namespace, the valid namespace of your org is ",
+  "unknownNamespace": "Org doesn't have Omnistudio namespace(s) configured",
   "noPackageInstalled": "No package installed on given org.",
   "alreadyStandardModel": "The org is already on standard data model.",
+  "noOmniStudioLicenses": "OmniStudio licenses are not found in the org. OmniStudio licenses are required for migration assessment",
   "invalidRelatedObjectsOption": "Invalid option provided for -r: %s. Valid options are apex, lwc, expsites, flexipage.",
   "formulaSyntaxError": "There was some problem while updating the formula syntax, please check the all the formula's syntax once : %s",
   "errorDuringFlexCardAssessment": "Error during FlexCard assessment",

messages/migrate.json

@@ -33,9 +33,10 @@
   "allVersionsDescription": "Migrate all versions of a component",
   "relatedObjectGA": "Please select the type of components to migrate: 'apex' for Apex classes, 'lwc' for Lightning Web Components, 'flexipage' for FlexiPages, 'expsites' for Experience Sites, or 'apex,lwc,flexipage,expsites' if you want to include all types.",
   "apexLwc": "Please select the type of components to migrate: 'apex' for Apex classes.",
-  "invalidNamespace": "The namespace you have passed is not valid namespace, the valid namespace of your org is ",
+  "unknownNamespace": "Org doesn't have Omnistudio namespace(s) configured",
   "noPackageInstalled": "No package installed on given org.",
   "alreadyStandardModel": "The org is already on standard data model.",
+  "noOmniStudioLicenses": "OmniStudio licenses are not found in the org. OmniStudio licenses are required for migration",
   "invalidRelatedObjectsOption": "Invalid option provided for -r: %s. Valid options are apex, lwc, expsites, flexipage.",
   "userConsentMessage": "By proceeding further, you hereby consent to the use, accept changes to your custom code and the accompanying terms and conditions associated with the use of the OmniStudio Migration Tool. Do you want to proceed? [y/n]",
   "userDeclinedConsent": "User declined consent, will not process %s .",
@@ -132,15 +133,15 @@
   "flexipagesWithChanges": "Found %s FlexiPages with changes",
   "omniGlobalAutoNumberPrefEnabled": "Successfully enabled OmniGlobalAutoNumberPref org preference",
   "errorEnablingOmniGlobalAutoNumberPref": "We couldn't enable the Omni Global Auto Number setting. Turn on the Omni Global Auto Number setting manually, and try again. See <a href='https://help.salesforce.com/s/articleView?id=xcloud.os_standard_global_auto_number.htm&type=5' target='_blank'>Set Up Omni Global Auto Number</a>.",
-  "performingPreMigrationChecks": "Performing pre-migration checks for Omni Global Auto Number...",
+  "performingPreMigrationChecks": "Performing pre-migration checks for Omni Global Auto Number",
   "preMigrationChecksPassed": "Pre-migration checks passed. Proceeding with Omni Global Auto Number migration.",
   "preMigrationChecksFailed": "Pre-migration checks failed. Migration cannot proceed.",
   "globalAutoNumberPrefEnabledError": "The Omni Global Auto Number setting is enabled and global auto numbers have already been migrated.",
   "bothRollbackFlagsEnabledError": "We couldn't turn on Omni Global Auto Number. Disable the RollBackDRChanges and RollBackIPChanges <a href='https://help.salesforce.com/s/articleView?id=xcloud.os_standard_global_auto_number.htm&type=5' target='_blank'>Omni Interaction Configurations</a>, and try again.",
   "rollbackIPFlagEnabledError": "We couldn't turn on Omni Global Auto Number. Disable the RollBackIPChanges <a href='https://help.salesforce.com/s/articleView?id=xcloud.os_standard_global_auto_number.htm&type=5' target='_blank'>Omni Interaction Configurations</a> and try again.",
   "rollbackDRFlagEnabledError": "We couldn't turn on Omni Global Auto Number. Disable the RollBackDRChanges <a href='https://help.salesforce.com/s/articleView?id=xcloud.os_standard_global_auto_number.htm&type=5' target='_blank'>Omni Interaction Configurations</a> and try again.",
   "errorCheckingRollbackFlags": "Error checking rollback flags status.",
-  "startingPostMigrationCleanup": "Starting post-migration cleanup for Omni Global Auto Number...",
+  "startingPostMigrationCleanup": "Starting post-migration cleanup for Omni Global Auto Number",
   "postMigrationCleanupCompleted": "Post-migration cleanup completed successfully.",
   "errorDuringPostMigrationCleanup": "We’ve encountered an error during the post-migration cleanup. Try again later.",
   "duplicatedGlobalAutoNumberName": "Duplicated Omni Global Auto Number name",

src/commands/omnistudio/migration/assess.ts

@@ -20,6 +20,7 @@ import { ProjectPathUtil } from '../../../utils/projectPathUtil';
 import { PreMigrate } from '../../../migration/premigrate';
 import { PostMigrate } from '../../../migration/postMigrate';
 import { CustomLabelsUtil } from '../../../utils/customLabels';
+import { ValidatorService } from '../../../utils/validatorService';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-omnistudio-migration-tool', 'assess');
@@ -78,16 +79,11 @@ export default class Assess extends OmniStudioBaseCommand {
     const apiVersion = conn.getApiVersion();
     const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn);
 
-    if (!orgs.hasValidNamespace) {
-      Logger.warn(messages.getMessage('invalidNamespace') + orgs.packageDetails.namespace);
-    }
+    // Perform comprehensive validation using ValidatorService
+    const validator = new ValidatorService(orgs, conn, messages);
+    const isValidationPassed = await validator.validate();
 
-    if (!orgs.packageDetails) {
-      Logger.error(messages.getMessage('noPackageInstalled'));
-      return;
-    }
-    if (orgs.omniStudioOrgPermissionEnabled) {
-      Logger.error(messages.getMessage('alreadyStandardModel'));
+    if (!isValidationPassed) {
       return;
     }
 

src/commands/omnistudio/migration/migrate.ts

@@ -31,6 +31,7 @@ import { YES_SHORT, YES_LONG, NO_SHORT, NO_LONG } from '../../../utils/projectPa
 import { PostMigrate } from '../../../migration/postMigrate';
 import { PreMigrate } from '../../../migration/premigrate';
 import { GlobalAutoNumberMigrationTool } from '../../../migration/globalautonumber';
+import { ValidatorService } from '../../../utils/validatorService';
 import { NameMappingRegistry } from '../../../migration/NameMappingRegistry';
 
 // Initialize Messages with the current plugin directory
@@ -91,16 +92,11 @@ export default class Migrate extends OmniStudioBaseCommand {
 
     const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn);
 
-    if (!orgs.hasValidNamespace) {
-      Logger.warn(messages.getMessage('invalidNamespace') + orgs.packageDetails.namespace);
-    }
+    // Perform comprehensive validation using ValidatorService
+    const validator = new ValidatorService(orgs, conn, messages);
+    const isValidationPassed = await validator.validate();
 
-    if (!orgs.packageDetails) {
-      Logger.error(messages.getMessage('noPackageInstalled'));
-      return;
-    }
-    if (orgs.omniStudioOrgPermissionEnabled) {
-      Logger.error(messages.getMessage('alreadyStandardModel'));
+    if (!isValidationPassed) {
       return;
     }
 

src/utils/orgUtils/index.ts

@@ -350,6 +350,15 @@ export class OrgUtils {
       const pkg = installedOmniPackages[0];
       packageDetails.version = `${pkg.MajorVersion}.${pkg.MinorVersion}`;
       packageDetails.namespace = pkg.NamespacePrefix;
+    } else {
+      // return to validate the org information
+      return {
+        packageDetails: undefined,
+        omniStudioOrgPermissionEnabled: false,
+        orgDetails: orgDetails[0],
+        dataModel: undefined,
+        hasValidNamespace: false,
+      };
     }
 
     //Execute apex rest resource to get omnistudio org permission

src/utils/validatorService.ts

@@ -0,0 +1,78 @@
+import { Connection, Messages } from '@salesforce/core';
+import { Logger } from '../utils/logger';
+import { OmnistudioOrgDetails } from './orgUtils';
+
+export class ValidatorService {
+  private readonly connection: Connection;
+  private readonly messages: Messages;
+  private readonly orgs: OmnistudioOrgDetails;
+
+  public constructor(orgs: OmnistudioOrgDetails, connection: Connection, messages: Messages) {
+    this.orgs = orgs;
+    this.connection = connection;
+    this.messages = messages;
+  }
+
+  public async validate(): Promise<boolean> {
+    return (
+      this.validateNamespace() &&
+      this.validatePackageInstalled() &&
+      this.validateOmniStudioOrgPermissionEnabled() &&
+      (await this.validateOmniStudioLicenses())
+    );
+  }
+
+  public validatePackageInstalled(): boolean {
+    const { packageDetails } = this.orgs;
+    if (!packageDetails) {
+      Logger.error(this.messages.getMessage('noPackageInstalled'));
+      return false;
+    }
+    return true;
+  }
+
+  public validateOmniStudioOrgPermissionEnabled(): boolean {
+    const { omniStudioOrgPermissionEnabled } = this.orgs;
+    if (omniStudioOrgPermissionEnabled) {
+      Logger.error(this.messages.getMessage('alreadyStandardModel'));
+      return false;
+    }
+    return true;
+  }
+
+  public validateNamespace(): boolean {
+    const { hasValidNamespace } = this.orgs;
+    if (!hasValidNamespace) {
+      Logger.error(this.messages.getMessage('unknownNamespace'));
+      return false;
+    }
+    return true;
+  }
+
+  public async validateOmniStudioLicenses(): Promise<boolean> {
+    try {
+      const query =
+        "SELECT count(DeveloperName) total FROM PermissionSetLicense WHERE PermissionSetLicenseKey LIKE 'OmniStudio%' AND Status = 'Active'";
+      const result = await this.connection.query<{ total: string }>(query);
+
+      // Salesforce returns records as an array in result.records
+      if (result?.records && result?.records?.length > 0) {
+        // Since we only get one record with the total count, check if count > 0
+        const totalCount = Number(result.records[0].total);
+        if (totalCount > 0) {
+          return true;
+        }
+      }
+
+      Logger.error(this.messages.getMessage('noOmniStudioLicenses'));
+      return false;
+    } catch (error) {
+      if (error instanceof Error && error.message) {
+        Logger.error(`Error validating OmniStudio licenses: ${error.message}`);
+      } else {
+        Logger.error('Error validating OmniStudio licenses: Unknown error');
+      }
+      return false;
+    }
+  }
+}