Update TriggerActionFlow with additional error handling and validation messages for flow type checks.

Author: mitchspano

trigger-actions-framework/main/default/classes/TriggerActionFlow.cls

@@ -19,18 +19,24 @@
  * @description This class implements the TriggerAction interface and provides a framework for
  * executing Flows before or after the insert, update, delete, or undelete of records.
  */
-@SuppressWarnings('PMD.CyclomaticComplexity')
+@SuppressWarnings('PMD.CyclomaticComplexity, PMD.CognitiveComplexity')
 public virtual inherited sharing class TriggerActionFlow implements TriggerAction.BeforeInsert, TriggerAction.AfterInsert, TriggerAction.BeforeUpdate, TriggerAction.AfterUpdate, TriggerAction.BeforeDelete, TriggerAction.AfterDelete, TriggerAction.AfterUndelete {
 	@TestVisible
 	private static final String RECORD_VARIABLE_NOT_FOUND_ERROR = 'There must be a variable defined in this flow with api name of "record" and type of "record" that is marked as "available for output"';
 	@TestVisible
 	private static final String FLOW_INTERVIEW_PREFIX = 'Flow.Interview';
 	@TestVisible
+	private static final String TYPE_MUST_BE_PROVIDED_ERROR = 'Type must be provided to get the flow name.';
+	@TestVisible
+	private static final String TYPE_MUST_REPRESENT_FLOW_ERROR = 'Type must represent a Flow (e.g., Flow.Interview.MyFlow.class), but got: ';
+	@TestVisible
+	private static final String FLOW_DOES_NOT_EXIST_ERROR = 'Flow does not exist. Please check that the flow API name is correct.';
+	@TestVisible
 	private static Set<String> bypassedFlows = new Set<String>();
 	@TestVisible
 	private static InvocableAction invocableAction = new InvocableAction();
 	@TestVisible
-	private static NameExtractor nameExtractor = new NameExtractor();
+	private static TriggerActionFlow.NameExtractor nameExtractor = new TriggerActionFlow.NameExtractor();
 
 	public String flowName;
 	public Boolean allowRecursion;
@@ -112,18 +118,18 @@ public virtual inherited sharing class TriggerActionFlow implements TriggerActio
 	 * @throws IllegalArgumentException if the type does not represent a Flow.
 	 */
 	private static String getFlowNameFromType(System.Type flowType) {
+		if (flowType == null) {
+			throw new IllegalArgumentException(TYPE_MUST_BE_PROVIDED_ERROR);
+		}
 		String typeName = nameExtractor.extractName(flowType);
-		if (!typeName.startsWith(FLOW_INTERVIEW_PREFIX)) {
+		if (typeName == null || !typeName.startsWith(FLOW_INTERVIEW_PREFIX)) {
 			throw new IllegalArgumentException(
-				'Type must represent a Flow (e.g., Flow.Interview.MyFlow.class), but got: ' +
-				typeName
+				TYPE_MUST_REPRESENT_FLOW_ERROR + typeName
 			);
 		}
 		// If the type name is exactly "Flow.Interview", it means the flow doesn't exist
 		if (typeName.equals(FLOW_INTERVIEW_PREFIX)) {
-			throw new IllegalArgumentException(
-				'Flow does not exist. Please check that the flow API name is correct.'
-			);
+			throw new IllegalArgumentException(FLOW_DOES_NOT_EXIST_ERROR);
 		}
 		return typeName.replace(FLOW_INTERVIEW_PREFIX + '.', '');
 	}

trigger-actions-framework/main/default/classes/TriggerActionFlowTest.cls

@@ -14,7 +14,9 @@
    limitations under the License.
  */
 
-@SuppressWarnings('PMD.ApexDoc, PMD.ApexUnitTestClassShouldHaveRunAs')
+@SuppressWarnings(
+	'PMD.ApexDoc, PMD.ApexUnitTestClassShouldHaveRunAs, PMD.CyclomaticComplexity'
+)
 @IsTest(isParallel=true)
 private class TriggerActionFlowTest {
 	private static final String BOGUS = 'Bogus';
@@ -89,8 +91,7 @@ private class TriggerActionFlowTest {
 			myException = e;
 		}
 
-		System.Assert.areEqual(
-			null,
+		System.Assert.isNull(
 			myException,
 			'There should be no exception thrown and the System should do nothing when the flow is bypassed'
 		);
@@ -416,7 +417,8 @@ private class TriggerActionFlowTest {
 		System.Assert.areNotEqual(null, myException, EXCEPTION_SHOULD_BE_THROWN);
 		System.Assert.areEqual(
 			true,
-			myException.getMessage().contains('Type must represent a Flow'),
+			myException.getMessage()
+				.contains(TriggerActionFlow.TYPE_MUST_REPRESENT_FLOW_ERROR),
 			EXCEPTION_SHOULD_HAVE_THE_CORRECT_MESSAGE
 		);
 	}
@@ -432,7 +434,8 @@ private class TriggerActionFlowTest {
 		System.Assert.areNotEqual(null, myException, EXCEPTION_SHOULD_BE_THROWN);
 		System.Assert.areEqual(
 			true,
-			myException.getMessage().contains('Type must represent a Flow'),
+			myException.getMessage()
+				.contains(TriggerActionFlow.TYPE_MUST_REPRESENT_FLOW_ERROR),
 			EXCEPTION_SHOULD_HAVE_THE_CORRECT_MESSAGE
 		);
 	}
@@ -448,7 +451,8 @@ private class TriggerActionFlowTest {
 		System.Assert.areNotEqual(null, myException, EXCEPTION_SHOULD_BE_THROWN);
 		System.Assert.areEqual(
 			true,
-			myException.getMessage().contains('Type must represent a Flow'),
+			myException.getMessage()
+				.contains(TriggerActionFlow.TYPE_MUST_REPRESENT_FLOW_ERROR),
 			EXCEPTION_SHOULD_HAVE_THE_CORRECT_MESSAGE
 		);
 	}
@@ -466,7 +470,59 @@ private class TriggerActionFlowTest {
 		System.Assert.areNotEqual(null, myException, EXCEPTION_SHOULD_BE_THROWN);
 		System.Assert.areEqual(
 			true,
-			myException.getMessage().contains('Flow does not exist'),
+			myException.getMessage()
+				.contains(TriggerActionFlow.FLOW_DOES_NOT_EXIST_ERROR),
+			EXCEPTION_SHOULD_HAVE_THE_CORRECT_MESSAGE
+		);
+	}
+
+	@IsTest
+	private static void bypassWithNullTypeShouldThrowException() {
+		try {
+			TriggerActionFlow.bypass((System.Type) null);
+		} catch (Exception e) {
+			myException = e;
+		}
+
+		System.Assert.areNotEqual(null, myException, EXCEPTION_SHOULD_BE_THROWN);
+		System.Assert.areEqual(
+			true,
+			myException.getMessage()
+				.contains(TriggerActionFlow.TYPE_MUST_BE_PROVIDED_ERROR),
+			EXCEPTION_SHOULD_HAVE_THE_CORRECT_MESSAGE
+		);
+	}
+
+	@IsTest
+	private static void clearBypassWithNullTypeShouldThrowException() {
+		try {
+			TriggerActionFlow.clearBypass((System.Type) null);
+		} catch (Exception e) {
+			myException = e;
+		}
+
+		System.Assert.areNotEqual(null, myException, EXCEPTION_SHOULD_BE_THROWN);
+		System.Assert.areEqual(
+			true,
+			myException.getMessage()
+				.contains(TriggerActionFlow.TYPE_MUST_BE_PROVIDED_ERROR),
+			EXCEPTION_SHOULD_HAVE_THE_CORRECT_MESSAGE
+		);
+	}
+
+	@IsTest
+	private static void isBypassedWithNullTypeShouldThrowException() {
+		try {
+			TriggerActionFlow.isBypassed((System.Type) null);
+		} catch (Exception e) {
+			myException = e;
+		}
+
+		System.Assert.areNotEqual(null, myException, EXCEPTION_SHOULD_BE_THROWN);
+		System.Assert.areEqual(
+			true,
+			myException.getMessage()
+				.contains(TriggerActionFlow.TYPE_MUST_BE_PROVIDED_ERROR),
 			EXCEPTION_SHOULD_HAVE_THE_CORRECT_MESSAGE
 		);
 	}