@W-19464589 - Data model skip logic for Use Case 2 (#409)

Author: shaurabh-tiwari-git

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 { initializeDataModelService } from '../../../utils/dataModelService';
 import { ValidatorService } from '../../../utils/validatorService';
 
 Messages.importMessagesDirectory(__dirname);
@@ -79,8 +80,11 @@ export default class Assess extends OmniStudioBaseCommand {
     const apiVersion = conn.getApiVersion();
     const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn);
 
+    // Initialize global data model service
+    initializeDataModelService(orgs);
+
     // Perform comprehensive validation using ValidatorService
-    const validator = new ValidatorService(orgs, conn, messages);
+    const validator = new ValidatorService(orgs, messages, conn);
     const isValidationPassed = await validator.validate();
 
     if (!isValidationPassed) {

src/commands/omnistudio/migration/migrate.ts

@@ -31,8 +31,9 @@ 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 { initializeDataModelService } from '../../../utils/dataModelService';
 import { NameMappingRegistry } from '../../../migration/NameMappingRegistry';
+import { ValidatorService } from '../../../utils/validatorService';
 
 // Initialize Messages with the current plugin directory
 Messages.importMessagesDirectory(__dirname);
@@ -92,10 +93,11 @@ export default class Migrate extends OmniStudioBaseCommand {
 
     const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn);
 
-    // Perform comprehensive validation using ValidatorService
-    const validator = new ValidatorService(orgs, conn, messages);
-    const isValidationPassed = await validator.validate();
+    // Initialize global data model service
+    initializeDataModelService(orgs);
 
+    const validator = new ValidatorService(orgs, messages, conn);
+    const isValidationPassed = await validator.validate();
     if (!isValidationPassed) {
       return;
     }

src/migration/postMigrate.ts

@@ -51,37 +51,6 @@ export class PostMigrate extends BaseMigrationTool {
     return userActionMessage;
   }
 
-  /**
-   * Checks if OmniStudio designers are already using the standard data model for the specific package.
-   */
-  private async isStandardDesignerEnabled(namespaceToModify: string): Promise<boolean> {
-    try {
-      const query = `SELECT DeveloperName, Value FROM OmniInteractionConfig WHERE DeveloperName IN ('TheFirstInstalledOmniPackage', 'InstalledIndustryPackage')`;
-
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-      const result = await this.connection.query(query);
-
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-      if (result?.totalSize > 0) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        const records = result.records as Array<{ DeveloperName: string; Value: string }>;
-
-        for (const record of records) {
-          if (record.Value === namespaceToModify) {
-            return true;
-          }
-        }
-        return false;
-      } else {
-        return false;
-      }
-    } catch (error) {
-      const errMsg = error instanceof Error ? error.message : String(error);
-      Logger.error(this.messages.getMessage('errorCheckingStandardDesigner', [namespaceToModify, errMsg]));
-      return false;
-    }
-  }
-
   public async enableDesignersToUseStandardDataModelIfNeeded(
     namespaceToModify: string,
     userActionMessage: string[]
@@ -91,7 +60,7 @@ export class PostMigrate extends BaseMigrationTool {
 
       // First check if standard designer is already enabled for this package
       Logger.logVerbose(this.messages.getMessage('checkingStandardDesignerStatus', [namespaceToModify]));
-      const isAlreadyEnabled = await this.isStandardDesignerEnabled(namespaceToModify);
+      const isAlreadyEnabled = await OrgPreferences.isStandardDesignerEnabled(this.connection, namespaceToModify);
 
       if (isAlreadyEnabled) {
         Logger.logVerbose(this.messages.getMessage('standardDesignerAlreadyEnabled', [namespaceToModify]));

src/utils/constants/stringContants.ts

@@ -27,6 +27,8 @@ export const Constants = {
   ApexComponentName: 'Apex Classes',
   CustomLabelComponentName: 'Custom Label',
   CustomLabelPluralName: 'Custom Labels',
+  CustomDataModel: 'custom',
+  StandardDataModel: 'standard',
 
   // artifacts persistance folder names
   AssessmentReportsFolderName: 'assessment_reports',

src/utils/dataModelService.ts

@@ -0,0 +1,53 @@
+import { OmnistudioOrgDetails } from './orgUtils';
+import { Constants } from './constants/stringContants';
+
+export class DataModelService {
+  private readonly orgs: OmnistudioOrgDetails;
+
+  public constructor(orgs: OmnistudioOrgDetails) {
+    this.orgs = orgs;
+  }
+
+  public getDataModel(): string {
+    const { omniStudioOrgPermissionEnabled } = this.orgs;
+    if (!omniStudioOrgPermissionEnabled) {
+      return Constants.CustomDataModel;
+    }
+    return Constants.StandardDataModel;
+  }
+}
+
+// Global instance and cached data model
+let globalDataModelService: DataModelService | null = null;
+let cachedDataModel: string | null = null;
+
+// Initialize the global instance
+export function initializeDataModelService(orgs: OmnistudioOrgDetails): void {
+  globalDataModelService = new DataModelService(orgs);
+  cachedDataModel = null; // Reset cache when reinitializing
+}
+
+// Get the global instance
+export function getDataModelService(): DataModelService {
+  return globalDataModelService;
+}
+
+// Convenience function to get data model info directly (with caching)
+export function getDataModelInfo(): string {
+  if (cachedDataModel === null) {
+    cachedDataModel = getDataModelService().getDataModel();
+  }
+  return cachedDataModel;
+}
+
+// Convenience function to check if data model is standard
+export function isStandardDataModel(): boolean {
+  const dataModel = getDataModelInfo();
+  return dataModel === Constants.StandardDataModel;
+}
+
+// Convenience function to check if data model is custom
+export function isCustomDataModel(): boolean {
+  const dataModel = getDataModelInfo();
+  return dataModel === Constants.CustomDataModel;
+}

src/utils/orgPreferences.ts

@@ -154,4 +154,44 @@ export class OrgPreferences {
       return false;
     }
   }
+
+  /**
+   * Checks if OmniStudio designers are already using the standard data model for the specific package.
+   *
+   * @public
+   * @static
+   * @async
+   * @param {Connection} connection - Salesforce connection instance
+   * @param {string} namespaceToModify - The namespace to check for standard designer
+   * @throws {Error} If checking the standard designer status fails
+   * @returns {Promise<boolean>} True if standard designer is enabled, false otherwise
+   */
+  public static async isStandardDesignerEnabled(connection: Connection, namespaceToModify: string): Promise<boolean> {
+    try {
+      const query = `SELECT DeveloperName, Value FROM OmniInteractionConfig
+      WHERE DeveloperName IN ('TheFirstInstalledOmniPackage', 'InstalledIndustryPackage')`;
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      const result = await connection.query(query);
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      if (result?.totalSize > 0) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        const records = result.records as Array<{ DeveloperName: string; Value: string }>;
+
+        for (const record of records) {
+          if (record.Value === namespaceToModify) {
+            return true;
+          }
+        }
+        return false;
+      } else {
+        return false;
+      }
+    } catch (error) {
+      // TODO: What should be the default behavior if the query fails?
+      const errMsg = error instanceof Error ? error.message : String(error);
+      Logger.error(`Error checking standard designer for namespace ${namespaceToModify}: ${errMsg}`);
+      return false;
+    }
+  }
 }

src/utils/orgUtils/index.ts

@@ -3,6 +3,7 @@
 import { Connection, Messages } from '@salesforce/core';
 import { QueryTools } from '../query';
 import { Logger } from '../logger';
+import { OrgPreferences } from '../orgPreferences';
 
 // Load messages
 const messages = Messages.loadMessages('@salesforce/plugin-omnistudio-migration-tool', 'migrate');
@@ -385,11 +386,8 @@ export class OrgUtils {
     try {
       return await connection.apex.get('/' + namespace + '/v1/orgPermission');
     } catch (e) {
-      // Returning false as a fallback when the endpoint is not found.
-      // As part of the 256 MVP, we don't want to block the migration just because the endpoint is missing.
-      return !(e.errorCode === 'NOT_FOUND');
+      // Any error in the apex mechanism will fallback to check the standard designer status
+      return await OrgPreferences.isStandardDesignerEnabled(connection, namespace);
     }
-
-    return true;
   }
 }

src/utils/validatorService.ts

@@ -1,25 +1,34 @@
 import { Connection, Messages } from '@salesforce/core';
 import { Logger } from '../utils/logger';
 import { OmnistudioOrgDetails } from './orgUtils';
+import { isStandardDataModel } from './dataModelService';
 
 export class ValidatorService {
-  private readonly connection: Connection;
   private readonly messages: Messages;
   private readonly orgs: OmnistudioOrgDetails;
-
-  public constructor(orgs: OmnistudioOrgDetails, connection: Connection, messages: Messages) {
+  private readonly connection: Connection;
+  public constructor(orgs: OmnistudioOrgDetails, messages: Messages, connection: Connection) {
     this.orgs = orgs;
-    this.connection = connection;
     this.messages = messages;
+    this.connection = connection;
   }
 
   public async validate(): Promise<boolean> {
-    return (
-      this.validateNamespace() &&
-      this.validatePackageInstalled() &&
-      this.validateOmniStudioOrgPermissionEnabled() &&
-      (await this.validateOmniStudioLicenses())
-    );
+    const basicValidation = this.validateNamespace() && this.validatePackageInstalled();
+    if (!basicValidation) {
+      return false;
+    }
+
+    // If data model is standard no need to check for the licences
+    // TODO: Add metadata toggle validation
+    const isStandard = isStandardDataModel();
+    if (isStandard) {
+      return true;
+    }
+
+    // For custom data model, validate if licenses are valid
+    const isLicensesValid = await this.validateOmniStudioLicenses();
+    return isLicensesValid;
   }
 
   public validatePackageInstalled(): boolean {
@@ -31,15 +40,6 @@ export class ValidatorService {
     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) {