Added "sf texei source flow convert" command

Author: FabienTaillon

messages/texei.source.flow.convert.md

@@ -0,0 +1,31 @@
+# summary
+
+Convert a Flow to a Subflow
+
+# description
+
+Convert a Flow to a Subflow
+
+# flags.name.summary
+
+Name of the Flow to convert
+
+# flags.path.summary
+
+Path of flows folder (default: force-app/main/default/flows)
+
+# flags.path.save-to-file-name
+
+Name of for new Flow file. If not provided, converted source Flow is overridden
+
+# examples
+
+- sf texei source flow convert --name My_Flow
+
+# warning.beta
+
+This command is in BETA, test the converted Flow, and report any issue at https://github.com/texei/texei-sfdx-plugin/issues
+
+# warning.filters
+
+The source Flow has Entry Conditions that can't be moved to Subflow, review them and add them either as a decision node or to the parent Flow according to the needs

package.json

@@ -105,8 +105,17 @@
           },
           "data": {
             "description": "Commands to manage data"
+          },
+          "source": {
+            "external": true,
+            "subtopics": {
+              "flow": {
+                "description": "Convert a Flow to a Subflow"
+              }
+            }
           }
-        }
+        },
+        "external": true
       }
     }
   },

src/commands/texei/source/flow/MetadataTypes.d.ts

@@ -0,0 +1,42 @@
+export type FlowMetadataType = {
+  Flow: Flow;
+};
+
+export type Flow = {
+  interviewLabel: string;
+  label: string;
+  status: string;
+  start?: {
+    locationX: number;
+    locationY: number;
+    connector: {
+      targetReference: string;
+    };
+    object?: string;
+    recordTriggerType?: string;
+    triggerType?: string;
+    filterFormula?: string;
+    filters?: FlowRecordFilter[];
+  };
+  variables?: FlowVariable[];
+};
+
+export type FlowVariable = {
+  name: string;
+  dataType: string;
+  isCollection: boolean;
+  isInput: boolean;
+  isOutput: true;
+  objectType: string;
+};
+
+export type FlowRecordFilter = {
+  field: string;
+  operator: string;
+  value: FlowElementReferenceOrValue;
+};
+
+export type FlowElementReferenceOrValue = {
+  apexValue?: string;
+  booleanValue?: boolean;
+};

src/commands/texei/source/flow/convert.ts

@@ -0,0 +1,162 @@
+/* eslint-disable no-console */
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { XMLParser, XMLBuilder } from 'fast-xml-parser';
+import { getDefaultPackagePath } from '../../../../shared/sfdxProjectFolder';
+import { FlowMetadataType, FlowVariable } from './MetadataTypes';
+
+Messages.importMessagesDirectory(__dirname);
+const messages = Messages.loadMessages('texei-sfdx-plugin', 'texei.source.flow.convert');
+
+export type TexeiSourceFlowConvertResult = {
+  convertedFlowPath: string;
+};
+
+export default class TexeiSourceFlowConvert extends SfCommand<TexeiSourceFlowConvertResult> {
+  public static readonly summary = messages.getMessage('summary');
+  public static readonly description = messages.getMessage('description');
+  public static readonly examples = messages.getMessages('examples');
+
+  // TODO: add flag for converted flow name
+  public static readonly flags = {
+    name: Flags.string({
+      summary: messages.getMessage('flags.name.summary'),
+      char: 'n',
+      required: true,
+    }),
+    path: Flags.string({ char: 'p', required: false, summary: messages.getMessage('flags.path.summary') }),
+    'save-to-file-name': Flags.string({
+      char: 's',
+      required: false,
+      summary: messages.getMessage('flags.path.save-to-file-name'),
+    }),
+  };
+
+  public async run(): Promise<TexeiSourceFlowConvertResult> {
+    const { flags } = await this.parse(TexeiSourceFlowConvert);
+
+    let savedFlowPath = '';
+
+    this.warn(messages.getMessage('warning.beta'));
+
+    const flowName = flags.name.endsWith('.flow-meta.xml') ? flags.name : `${flags.name}.flow-meta.xml`;
+    const flowFolderPath: string = flags.path
+      ? path.join(flags.path, 'flows')
+      : path.join(await getDefaultPackagePath(), 'flows');
+    const flowPath: string = path.join(flowFolderPath, flowName);
+
+    // Check if flow exists
+    if (fs.existsSync(flowPath)) {
+      // Read data file
+      const data = fs.readFileSync(flowPath, 'utf8');
+
+      // Parsing file
+      const xmlParserBuilderOptions = {
+        ignoreAttributes: false,
+        removeNSPrefix: false,
+        numberParseOptions: {
+          hex: false,
+          leadingZeros: false,
+          skipLike: /\.[0-9]*0/,
+        },
+        format: true,
+      };
+
+      const parser = new XMLParser(xmlParserBuilderOptions);
+      let flowJson: FlowMetadataType = parser.parse(data) as FlowMetadataType;
+
+      const targetObject = flowJson?.Flow?.start?.object as string;
+
+      // Check if $Record or $ Record__Prior are used, if so create variables to replace them
+      let flowAsString = JSON.stringify(flowJson);
+      const variables: FlowVariable[] = [];
+
+      // Converting $Record__Prior to 'RecordPrior' variable if needed
+      if (flowAsString.includes('$Record__Prior')) {
+        const recordPriorVariable: FlowVariable = {
+          name: 'RecordPrior',
+          dataType: 'SObject',
+          isCollection: false,
+          isInput: true,
+          isOutput: true,
+          objectType: targetObject,
+        };
+        variables.push(recordPriorVariable);
+
+        // Replace $Record__Prior variable in Flow by new RecordPrior variable
+        flowAsString = flowAsString.replaceAll('$Record__Prior', 'RecordPrior');
+      }
+
+      // Converting $Record to 'Record' variable if needed
+      if (flowAsString.includes('$Record')) {
+        const recordVariable: FlowVariable = {
+          name: 'Record',
+          dataType: 'SObject',
+          isCollection: false,
+          isInput: true,
+          isOutput: true,
+          objectType: targetObject,
+        };
+        variables.push(recordVariable);
+
+        // Replace $Record variable in Flow by new Record variable
+        flowAsString = flowAsString.replaceAll('$Record', 'Record');
+      }
+
+      flowJson = JSON.parse(flowAsString) as FlowMetadataType;
+
+      if (variables) {
+        // Check if variables were already part of the existing metadata
+        if (flowJson.Flow?.variables === undefined) {
+          // No variables, just add them
+          flowJson.Flow.variables = variables;
+        } else if (Array.isArray(flowJson.Flow?.variables)) {
+          // variables are already an array, just add the new values to it
+          flowJson.Flow.variables = flowJson.Flow.variables.concat(variables);
+        } else {
+          // there was only one variable, put them all together in an array
+          variables.push(flowJson.Flow?.variables);
+          flowJson.Flow.variables = variables;
+        }
+      }
+
+      // Deleting nodes not part of a subflow metadata
+      delete flowJson.Flow?.start?.object;
+      delete flowJson.Flow?.start?.recordTriggerType;
+      delete flowJson.Flow?.start?.triggerType;
+
+      if (flowJson.Flow?.start?.filterFormula || flowJson.Flow?.start?.filters) {
+        delete flowJson.Flow?.start?.filterFormula;
+        delete flowJson.Flow?.start?.filters;
+
+        this.warn(messages.getMessage('warning.filters'));
+      }
+
+      // Writing the new flow;
+      const builder = new XMLBuilder(xmlParserBuilderOptions);
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      const flowXml = builder.build(flowJson);
+
+      if (flags['save-to-file-name']) {
+        const newFlowName = flags['save-to-file-name'].endsWith('.flow-meta.xml')
+          ? flags['save-to-file-name']
+          : `${flags['save-to-file-name']}.flow-meta.xml`;
+        savedFlowPath = path.join(flowFolderPath, newFlowName);
+      } else {
+        savedFlowPath = flowPath;
+      }
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+      fs.writeFileSync(savedFlowPath, flowXml, 'utf8');
+    } else {
+      this.warn(`Flow ${flowPath} doesn't exist`);
+    }
+
+    this.log(`Flow converted at ${savedFlowPath}`);
+
+    return {
+      convertedFlowPath: savedFlowPath,
+    };
+  }
+}

test/helpers/init.js

@@ -1,2 +1,2 @@
-const path = require('path')
-process.env.TS_NODE_PROJECT = path.resolve('test/tsconfig.json')
+const path = require('path');
+process.env.TS_NODE_PROJECT = path.resolve('test/tsconfig.json');

tsconfig.json

@@ -5,7 +5,7 @@
     "rootDir": "src",
     "strictNullChecks": true,
     "skipLibCheck": true,
-    "lib": ["dom"]
+    "lib": ["dom", "ES2023"]
   },
   "include": ["./src/**/*.ts"]
 }