Adds progress information (#30)

Author: agarcia-sf

messages/migrate.json

@@ -14,6 +14,7 @@
   "invalidOnlyFlag": "Invalid flag, valid options are: osip | fc | dr",
   "couldNotDeactivateOmniProcesses": "Could not deactivate current OmniProcesses",
   "couldNotTruncate": "Could not truncate {0}",
+  "couldNotTruncateOmnniProcess": "Could not truncate OmniProcess. Please make sure your OS/IP is not referenced in an OmniScrirpt or Flex Card.",
   "invalidNameTypeSubtypeOrLanguage": "Not a valid Name, Type, SubType or Language",
   "invalidOrRepeatingOmniscriptElementNames": "Invalid or Repeating Element Names for Same OmniScript",
   "invalidDataRaptorName": "Invalid name, can not have special characters",

package.json

@@ -114,4 +114,4 @@
       "pre-push": "sf-husky-pre-push"
     }
   }
-}
+}

src/commands/omnistudio/migration/migrate.ts

@@ -58,7 +58,7 @@ export default class Migrate extends OmniStudioBaseCommand {
     // Let's time every step
     DebugTimer.getInstance().start();
 
-    const namecheck = new MetaDataObjNameCheck(namespace, conn, this.logger, messages);
+    const namecheck = new MetaDataObjNameCheck(namespace, conn, this.logger, messages, this.ux);
 
     // Register the migration objects
     let migrationObjects: MigrationTool[] = [];
@@ -68,31 +68,31 @@ export default class Migrate extends OmniStudioBaseCommand {
       await namecheck.checkName('VlocityCard__c');
 
       migrationObjects = [
-        new CardMigrationTool(namespace, conn, this.logger, messages),
-        new OmniScriptMigrationTool(OmniScriptExportType.All, namespace, conn, this.logger, messages),
-        new DataRaptorMigrationTool(namespace, conn, this.logger, messages),
+        new DataRaptorMigrationTool(namespace, conn, this.logger, messages, this.ux),
+        new OmniScriptMigrationTool(OmniScriptExportType.All, namespace, conn, this.logger, messages, this.ux),
+        new CardMigrationTool(namespace, conn, this.logger, messages, this.ux),
       ];
     } else {
       switch (migrateOnly) {
         case 'os':
           await namecheck.checkName('OmniScript__c');
           migrationObjects.push(
-            new OmniScriptMigrationTool(OmniScriptExportType.OS, namespace, conn, this.logger, messages)
+            new OmniScriptMigrationTool(OmniScriptExportType.OS, namespace, conn, this.logger, messages, this.ux)
           );
           break;
         case 'ip':
           await namecheck.checkName('OmniScript__c');
           migrationObjects.push(
-            new OmniScriptMigrationTool(OmniScriptExportType.IP, namespace, conn, this.logger, messages)
+            new OmniScriptMigrationTool(OmniScriptExportType.IP, namespace, conn, this.logger, messages, this.ux)
           );
           break;
         case 'fc':
           await namecheck.checkName('VlocityCard__c');
-          migrationObjects.push(new CardMigrationTool(namespace, conn, this.logger, messages));
+          migrationObjects.push(new CardMigrationTool(namespace, conn, this.logger, messages, this.ux));
           break;
         case 'dr':
           await namecheck.checkName('DRBundle__c');
-          migrationObjects.push(new DataRaptorMigrationTool(namespace, conn, this.logger, messages));
+          migrationObjects.push(new DataRaptorMigrationTool(namespace, conn, this.logger, messages, this.ux));
           break;
         default:
           throw new Error(messages.getMessage('invalidOnlyFlag'));
@@ -105,8 +105,9 @@ export default class Migrate extends OmniStudioBaseCommand {
 
     // We need to truncate the standard objects first
     let allTruncateComplete = true;
-    for (const cls of migrationObjects) {
+    for (const cls of migrationObjects.reverse()) {
       try {
+        this.ux.log('Truncating: ' + cls.getName());
         debugTimer.lap('Truncating: ' + cls.getName());
         await cls.truncate();
       } catch (ex: any) {
@@ -119,8 +120,9 @@ export default class Migrate extends OmniStudioBaseCommand {
     }
 
     if (allTruncateComplete) {
-      for (const cls of migrationObjects) {
+      for (const cls of migrationObjects.reverse()) {
         try {
+          this.ux.log('Migrating: ' + cls.getName());
           debugTimer.lap('Migrating: ' + cls.getName());
           const results = await cls.migrate();
 

src/migration/base.ts

@@ -1,3 +1,4 @@
+import { UX } from '@salesforce/command';
 import { Connection, Logger, Messages } from '@salesforce/core';
 import { DebugTimer, QueryTools } from '../utils';
 
@@ -11,12 +12,14 @@ export class BaseMigrationTool {
   protected readonly namespacePrefix: string;
   protected readonly logger: Logger;
   protected readonly messages: Messages;
+  protected readonly ux: UX;
 
-  public constructor(namespace: string, connection: Connection, logger: Logger, messages: Messages) {
+  public constructor(namespace: string, connection: Connection, logger: Logger, messages: Messages, ux: UX) {
     this.namespace = namespace;
     this.connection = connection;
     this.logger = logger;
     this.messages = messages;
+    this.ux = ux;
     this.namespacePrefix = namespace ? namespace + '__' : '';
   }
 
@@ -79,4 +82,11 @@ export class BaseMigrationTool {
   protected setRecordErrors(record: unknown, ...errors: string[]): void {
     record['errors'] = errors;
   }
+
+  protected reportProgress(total: number, current: number): void {
+    const progress = ((100 * current) / total).toFixed(0);
+    if (parseInt(progress, 10) % 10 === 0) {
+      this.ux.log(`${progress}% complete...`);
+    }
+  }
 }

src/migration/dataraptor.ts

@@ -54,7 +54,11 @@ export class DataRaptorMigrationTool extends BaseMigrationTool implements Migrat
 
 		// Start transforming each dataRaptor
 		DebugTimer.getInstance().lap('Transform Data Raptor');
+		let done = 0;
+		const total = dataRaptors.length;
+
 		for (let dr of dataRaptors) {
+			this.reportProgress(total, done);
 
 			// Skip if Type is "Migration"
 			if (dr[this.namespacePrefix + 'Type__c'] === 'Migration') continue;
@@ -129,6 +133,7 @@ export class DataRaptorMigrationTool extends BaseMigrationTool implements Migrat
 				drUploadInfo.set(recordId, drUploadResponse);
 			}
 
+			done++;
 		};
 
 		return {

src/migration/flexcard.ts

@@ -96,6 +96,7 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
 	private async uploadCard(allCards: any[], card: AnyJson, cardsUploadInfo: Map<string, UploadRecordResult>, originalRecords: Map<string, any>, uniqueNames: Set<string>) {
 
 		const recordId = card['Id'];
+		this.reportProgress(allCards.length, originalRecords.size);
 
 		// If we already uploaded this card, skip
 		if (cardsUploadInfo.has(recordId)) {

src/migration/metadataobjnamecheck.ts

@@ -1,13 +1,9 @@
 /* eslint-disable */
-import { Connection, Logger, Messages } from '@salesforce/core';
 import { DebugTimer, QueryTools } from '../utils';
 import { BaseMigrationTool } from './base';
 import { NameTransformData, OriginalRecordName } from './interfaces';
 
 export class MetaDataObjNameCheck extends BaseMigrationTool {
-    constructor(namespace: string, connection: Connection, logger: Logger, messages: Messages) {
-        super(namespace, connection, logger, messages);
-    }
 
     async checkName(objName: string): Promise<any> {
         const result = await this.metaDataObjUniqueNameCheck(objName);

src/migration/omniscript.ts

@@ -10,6 +10,7 @@ import { MigrationResult, MigrationTool, TransformData, UploadRecordResult } fro
 import { ObjectMapping } from './interfaces';
 import { NetUtils, RequestMethod } from '../utils/net';
 import { Connection, Logger, Messages } from '@salesforce/core';
+import { UX } from '@salesforce/command';
 
 export class OmniScriptMigrationTool extends BaseMigrationTool implements MigrationTool {
 
@@ -25,8 +26,8 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
 	static readonly OMNIPROCESSELEMENT_NAME = 'OmniProcessElement';
 	static readonly OMNIPROCESSCOMPILATION_NAME = 'OmniProcessCompilation';
 
-	constructor(exportType: OmniScriptExportType, namespace: string, connection: Connection, logger: Logger, messages: Messages) {
-		super(namespace, connection, logger, messages);
+	constructor(exportType: OmniScriptExportType, namespace: string, connection: Connection, logger: Logger, messages: Messages, ux: UX) {
+		super(namespace, connection, logger, messages, ux);
 		this.exportType = exportType;
 	}
 
@@ -59,7 +60,7 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
 	async truncate(): Promise<void> {
 		const objectName = OmniScriptMigrationTool.OMNIPROCESS_NAME;
 
-		const allIds = await this.deactivateRecord(objectName, false);
+		const allIds = await this.deactivateRecord(objectName);
 		await this.truncateElements(objectName, allIds.os.parents);
 		await this.truncateElements(objectName, allIds.os.childs);
 		await this.truncateElements(objectName, allIds.ip.parents);
@@ -71,11 +72,11 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
 
 		let success: boolean = await NetUtils.delete(this.connection, ids);
 		if (!success) {
-			throw new Error(this.messages.getMessage('couldNotTruncate').formatUnicorn(objectName));
+			throw new Error(this.messages.getMessage('couldNotTruncateOmnniProcess').formatUnicorn(objectName));
 		}
 	}
 
-	async deactivateRecord(objectName: string, isReusable: boolean): Promise<{ os: { parents: string[], childs: string[] }, ip: { parents: string[], childs: string[] } }> {
+	async deactivateRecord(objectName: string): Promise<{ os: { parents: string[], childs: string[] }, ip: { parents: string[], childs: string[] } }> {
 		DebugTimer.getInstance().lap('Truncating ' + objectName + ' (' + this.exportType + ')');
 
 		const filters = new Map<string, any>();
@@ -88,8 +89,6 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
 			filters.set('IsIntegrationProcedure', false);
 		}
 
-		// filters.set('IsOmniScriptEmbeddable', isReusable);
-
 		// const ids: string[] = await QueryTools.queryIds(this.connection, objectName, filters);
 		const rows = await QueryTools.query(this.connection, objectName, ['Id', 'IsIntegrationProcedure', 'IsOmniScriptEmbeddable'], filters, sorting);
 		if (rows.length === 0) {
@@ -127,13 +126,17 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
 		const omniscripts = await this.getAllOmniScripts();
 
 		// Variables to be returned After Migration
-		var originalOsRecords = new Map<string, any>();
-		var osUploadInfo = new Map<string, UploadRecordResult>();
+		let done = 0;
+		let originalOsRecords = new Map<string, any>();
+		let osUploadInfo = new Map<string, UploadRecordResult>();
+		const total = omniscripts.length;
 
 		for (let omniscript of omniscripts) {
 			const mappedRecords = [],
 				originalRecords = new Map<string, AnyJson>();
 
+			this.reportProgress(total, done);
+
 			// Record is Active, Elements can't be Added, Modified or Deleted for that OS/IP
 			omniscript[`${this.namespacePrefix}IsActive__c`] = false;
 
@@ -184,6 +187,7 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
 			originalOsRecords = new Map([...Array.from(originalOsRecords.entries()), ...Array.from(originalRecords.entries())]);
 			osUploadInfo = new Map([...Array.from(osUploadInfo.entries()), ...Array.from(osUploadResponse.entries())]);
 
+			done++;
 		};
 
 		const objectMigrationResults: MigrationResult[] = [];