From b01b8ef5616e635eeef71cceb796bfff76b138b7 Mon Sep 17 00:00:00 2001
From: Brian Pond <brian@datahenge.com>
Date: Thu, 22 Feb 2024 14:32:12 -0800
Subject: [PATCH] Add enum validation to Result class.

---
 temporal/result.py | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/temporal/result.py b/temporal/result.py
index d5d8c2c..4b2d104 100644
--- a/temporal/result.py
+++ b/temporal/result.py
@@ -6,6 +6,7 @@
 from typing import NamedTuple
 
 import frappe
+
 from temporal import validate_datatype
 from temporal.helpers import dict_to_dateless_dict
 
@@ -36,8 +37,30 @@ def __friendly__(self):
 # Define a Message
 # ========
 
-# NOTE: Define enum classes as both (str, Enum), so they are JSON serializable.
+def validate_enum_value(any_value, enum_type, raise_on_errors=True):
+	"""
+	Ensure that an enumerated Value is a member of the specific enumerated data Type.
+	"""
+
+	# Validate the arguments -themselves- are of the correct types.
+	if not isinstance(any_value, (str, Enum)):
+		raise TypeError(f"Expected argument 'any_value' with value = '{any_value}' to be either String or Enum type.")
+	if not issubclass(enum_type, Enum):
+		raise TypeError(f"Argument '{enum_type}' must be a subclass of Enum.")
+
+	# Next, if the first argument is a String, verify it will successfully coerce into an Enum variant.
+	if isinstance(any_value, str):
+		try:
+			enum_type[any_value.upper()]
+		except Exception as ex:
+			message = f"Argument value '{any_value}' is not a type of Enum '{enum_type.__name__}'"
+			print(message)
+			if raise_on_errors:
+				raise TypeError(message) from ex
+			return False
+	return True
 
+# NOTE: Should always define Enum classes as both (str, Enum), so they are JSON serializable.
 class MessageLevel(str, Enum):
 	INFO = 'Info'
 	WARNING = 'Warning'
@@ -138,6 +161,9 @@ def as_json(self):
 			"messages": dict_to_dateless_dict(self._messages)
 		})
 
+	def __str__(self):
+		return self.as_json()
+
 	def should_raise_exceptions(self) -> bool:
 		if self.outcome in (OutcomeType.ERROR, OutcomeType.INTERNAL_ERROR):
 			return True
@@ -150,6 +176,9 @@ def should_raise_exceptions(self) -> bool:
 	# Message Functions
 	def add_message(self, audience, message_level, message_string, tags=None):
 
+		validate_enum_value(audience, MessageAudience)
+		validate_enum_value(message_level, MessageLevel)
+
 		# Validate the tags
 		if tags:
 			if isinstance(tags, str):
@@ -187,6 +216,7 @@ def add_result_to_crs(self, crs_instance):
 			crs_instance.add_data(key, value)  # important to send as JSON, to convert things like Date and DateTime to string.
 
 		for each_message in self.get_all_messages():
+
 			if each_message.audience in (MessageAudience.ALL, MessageAudience.INTERNAL):
 				crs_instance.add_internal_message(str(each_message))
 			if each_message.audience in (MessageAudience.ALL, MessageAudience.CUSTOMER):