PROD-2709 Fix Email Connector logs so they use configuration key instead of name

CHANGELOG.md

@@ -19,6 +19,7 @@ The types of changes are:
 
 ### Fixed
 - Ignore `400` errors from Talkable's `person` endpoint. [#5317](https://github.com/ethyca/fides/pull/5317)
+- Fix Email Connector logs so they use configuration key instead of name [#5286](https://github.com/ethyca/fides/pull/5286)
 
 ## [2.45.2](https://github.com/ethyca/fides/compare/2.45.1...2.45.2)
 

src/fides/api/models/connectionconfig.py

@@ -203,6 +203,11 @@ def authorized(self) -> bool:
 
         return bool(self.secrets and self.secrets.get("access_token"))
 
+    @property
+    def name_or_key(self) -> str:
+        """Returns the ConnectionConfig name if it exists, or its key otherwise."""
+        return self.name or self.key
+
     @classmethod
     def create_without_saving(
         cls: Type[ConnectionConfig], db: Session, *, data: dict[str, Any]

src/fides/api/service/connectors/base_erasure_email_connector.py

@@ -73,12 +73,12 @@ def add_skipped_log(self, db: Session, privacy_request: PrivacyRequest) -> None:
             db=db,
             data={
                 "connection_key": self.configuration.key,
-                "dataset_name": self.configuration.name,
-                "collection_name": self.configuration.name,
+                "dataset_name": self.configuration.name_or_key,
+                "collection_name": self.configuration.name_or_key,
                 "privacy_request_id": privacy_request.id,
                 "action_type": ActionType.erasure,
                 "status": ExecutionLogStatus.skipped,
-                "message": f"Erasure email skipped for '{self.configuration.name}'",
+                "message": f"Erasure email skipped for '{self.configuration.name_or_key}'",
             },
         )
 

src/fides/api/service/connectors/consent_email_connector.py

@@ -83,7 +83,7 @@ def test_connection(self) -> Optional[ConnectionTestStatus]:
         try:
             if not self.config.test_email_address:
                 raise MessageDispatchException(
-                    f"Cannot test connection. No test email defined for {self.configuration.name}"
+                    f"Cannot test connection. No test email defined for {self.configuration.key}"
                 )
 
             logger.info("Starting test connection to {}", self.configuration.key)
@@ -137,7 +137,11 @@ def test_connection(self) -> Optional[ConnectionTestStatus]:
             )
 
         except MessageDispatchException as exc:
-            logger.info("Email consent connector test failed with exception {}", exc)
+            logger.info(
+                "Email consent connector test for {} failed with exception {}",
+                self.configuration.key,
+                exc,
+            )
             return ConnectionTestStatus.failed
         return ConnectionTestStatus.succeeded
 
@@ -177,12 +181,12 @@ def add_skipped_log(self, db: Session, privacy_request: PrivacyRequest) -> None:
             db=db,
             data={
                 "connection_key": self.configuration.key,
-                "dataset_name": self.configuration.name,
-                "collection_name": self.configuration.name,
+                "dataset_name": self.configuration.name_or_key,
+                "collection_name": self.configuration.name_or_key,
                 "privacy_request_id": privacy_request.id,
                 "action_type": ActionType.consent,
                 "status": ExecutionLogStatus.skipped,
-                "message": f"Consent email skipped for '{self.configuration.name}'",
+                "message": f"Consent email skipped for '{self.configuration.name_or_key}'",
             },
         )
         for pref in privacy_request.privacy_preferences:  # type: ignore[attr-defined]
@@ -197,12 +201,12 @@ def add_errored_log(self, db: Session, privacy_request: PrivacyRequest) -> None:
             db=db,
             data={
                 "connection_key": self.configuration.key,
-                "dataset_name": self.configuration.name,
-                "collection_name": self.configuration.name,
+                "dataset_name": self.configuration.name_or_key,
+                "collection_name": self.configuration.name_or_key,
                 "privacy_request_id": privacy_request.id,
                 "action_type": ActionType.consent,
                 "status": ExecutionLogStatus.error,
-                "message": f"Consent email send error for '{self.configuration.name}'",
+                "message": f"Consent email send error for '{self.configuration.name_or_key}'",
             },
         )
         add_errored_system_status_for_consent_reporting(
@@ -265,13 +269,13 @@ def batch_email_send(self, privacy_requests: Query) -> None:
             logger.info(
                 "Skipping consent email send for connector: '{}'. "
                 "No corresponding user identities found for pending privacy requests.",
-                self.configuration.name,
+                self.configuration.key,
             )
             return
 
         logger.info(
             "Sending batched consent email for connector {}...",
-            self.configuration.name,
+            self.configuration.key,
         )
 
         db = Session.object_session(self.configuration)
@@ -286,7 +290,11 @@ def batch_email_send(self, privacy_requests: Query) -> None:
                 test_mode=False,
             )
         except MessageDispatchException as exc:
-            logger.info("Consent email failed with exception {}", exc)
+            logger.info(
+                "Consent email for connector {} failed with exception {}",
+                self.configuration.key,
+                exc,
+            )
             for privacy_request in privacy_requests:
                 if privacy_request.id not in skipped_privacy_requests:
                     self.add_errored_log(db, privacy_request)
@@ -298,12 +306,12 @@ def batch_email_send(self, privacy_requests: Query) -> None:
                     db=db,
                     data={
                         "connection_key": self.configuration.key,
-                        "dataset_name": self.configuration.name,
+                        "dataset_name": self.configuration.name_or_key,
                         "privacy_request_id": privacy_request.id,
-                        "collection_name": self.configuration.name,
+                        "collection_name": self.configuration.name_or_key,
                         "action_type": ActionType.consent,
                         "status": ExecutionLogStatus.complete,
-                        "message": f"Consent email instructions dispatched for '{self.configuration.name}'",
+                        "message": f"Consent email instructions dispatched for '{self.configuration.name_or_key}'",
                     },
                 )
                 add_complete_system_status_for_consent_reporting(

src/fides/api/service/connectors/dynamic_erasure_email_connector.py

@@ -174,14 +174,12 @@ def batch_email_send(self, privacy_requests: Query) -> None:
                     db=db,
                     data={
                         "connection_key": self.configuration.key,
-                        "dataset_name": self.configuration.name
-                        or self.configuration.key,
-                        "collection_name": self.configuration.name
-                        or self.configuration.key,
+                        "dataset_name": self.configuration.name_or_key,
+                        "collection_name": self.configuration.name_or_key,
                         "privacy_request_id": privacy_request.id,
                         "action_type": ActionType.erasure,
                         "status": ExecutionLogStatus.complete,
-                        "message": f"Erasure email instructions dispatched for '{self.configuration.name or self.configuration.key}'",
+                        "message": f"Erasure email instructions dispatched for '{self.configuration.name_or_key}'",
                     },
                 )
 
@@ -496,8 +494,8 @@ def error_privacy_request(
             db=db,
             data={
                 "connection_key": self.configuration.key,
-                "dataset_name": self.configuration.name or self.configuration.key,
-                "collection_name": self.configuration.name or self.configuration.key,
+                "dataset_name": self.configuration.name_or_key,
+                "collection_name": self.configuration.name_or_key,
                 "privacy_request_id": privacy_request.id,
                 "action_type": ActionType.erasure,
                 "status": ExecutionLogStatus.error,

src/fides/api/service/connectors/erasure_email_connector.py

@@ -47,7 +47,7 @@ def test_connection(self) -> Optional[ConnectionTestStatus]:
         try:
             if not self.config.test_email_address:
                 raise MessageDispatchException(
-                    f"Cannot test connection. No test email defined for {self.configuration.name}"
+                    f"Cannot test connection. No test email defined for {self.configuration.key}"
                 )
             # synchronous for now since failure to send is considered a connection test failure
             send_single_erasure_email(
@@ -58,7 +58,11 @@ def test_connection(self) -> Optional[ConnectionTestStatus]:
                 test_mode=True,
             )
         except MessageDispatchException as exc:
-            logger.info("Email connector test failed with exception {}", exc)
+            logger.info(
+                "Email connector test for {} failed with exception {}",
+                self.configuration.key,
+                exc,
+            )
             return ConnectionTestStatus.failed
         return ConnectionTestStatus.succeeded
 
@@ -82,13 +86,13 @@ def batch_email_send(self, privacy_requests: Query) -> None:
             logger.info(
                 "Skipping erasure email send for connector: '{}'. "
                 "No corresponding user identities found for pending privacy requests.",
-                self.configuration.name,
+                self.configuration.key,
             )
             return
 
         logger.info(
             "Sending batched erasure email for connector {}...",
-            self.configuration.name,
+            self.configuration.key,
         )
 
         try:
@@ -100,7 +104,11 @@ def batch_email_send(self, privacy_requests: Query) -> None:
                 test_mode=False,
             )
         except MessageDispatchException as exc:
-            logger.info("Erasure email failed with exception {}", exc)
+            logger.info(
+                "Erasure email for connector {} failed with exception {}",
+                self.configuration.key,
+                exc,
+            )
             raise
 
         # create an audit event for each privacy request ID
@@ -110,11 +118,11 @@ def batch_email_send(self, privacy_requests: Query) -> None:
                     db=db,
                     data={
                         "connection_key": self.configuration.key,
-                        "dataset_name": self.configuration.name,
-                        "collection_name": self.configuration.name,
+                        "dataset_name": self.configuration.name_or_key,
+                        "collection_name": self.configuration.name_or_key,
                         "privacy_request_id": privacy_request.id,
                         "action_type": ActionType.erasure,
                         "status": ExecutionLogStatus.complete,
-                        "message": f"Erasure email instructions dispatched for '{self.configuration.name}'",
+                        "message": f"Erasure email instructions dispatched for '{self.configuration.name_or_key}'",
                     },
                 )