PR feedback

- use schema to strip whitespace
- remove optional pending email fields from update record
- add type hint for datetime

Author: landonshumway-ia

backend/compact-connect/lambdas/python/common/cc_common/data_model/data_client.py

@@ -1,5 +1,5 @@
 import time
-from datetime import date
+from datetime import date, datetime
 from urllib.parse import quote
 from uuid import uuid4
 
@@ -2572,7 +2572,7 @@ def update_provider_email_verification_data(
         provider_id: str,
         pending_email_address: str,
         verification_code: str,
-        verification_expiry,
+        verification_expiry: datetime,
     ) -> None:
         """
         Update the provider record with email verification data.

backend/compact-connect/lambdas/python/common/cc_common/data_model/schema/common.py

@@ -6,12 +6,53 @@
 from hashlib import md5
 from typing import Any
 
-from marshmallow import Schema, ValidationError, validates_schema
+from marshmallow import Schema, ValidationError, pre_load, validates_schema
 from marshmallow.fields import Dict, String, Url
 
 from cc_common.config import config
 
 
+class CCRequestSchema(Schema):
+    """
+    Base class for Compact Connect request schemas.
+
+    This schema provides common request processing functionality such as
+    whitespace trimming and other input sanitization that should be applied
+    to all incoming API requests.
+
+    All request schemas should inherit from this class instead of directly
+    from marshmallow.Schema to ensure consistent input processing.
+    """
+
+    @pre_load
+    def strip_whitespace(self, in_data, **kwargs):  # noqa: ARG002 unused-argument
+        """
+        Pre-load hook that strips whitespace from all string values in the request data.
+
+        This method recursively processes the input data and strips leading and trailing
+        whitespace from all string values. This ensures consistent input sanitization
+        across all request schemas.
+
+        :param in_data: Input data dictionary from the request
+        :param kwargs: Additional keyword arguments from marshmallow
+        :return: Processed data with whitespace stripped from string values
+        """
+        if not isinstance(in_data, dict):
+            return in_data
+
+        def strip_strings(data):
+            """Recursively strip whitespace from string values in nested data structures."""
+            if isinstance(data, dict):
+                return {key: strip_strings(value) for key, value in data.items()}
+            if isinstance(data, list):
+                return [strip_strings(item) for item in data]
+            if isinstance(data, str):
+                return data.strip()
+            return data
+
+        return strip_strings(in_data)
+
+
 class CCDataClass:
     """
     Base class for Compact Connect data classes

backend/compact-connect/lambdas/python/common/cc_common/data_model/schema/provider/api.py

@@ -4,6 +4,7 @@
 from marshmallow.validate import Length, Regexp
 
 from cc_common.data_model.schema.base_record import ForgivingSchema
+from cc_common.data_model.schema.common import CCRequestSchema
 from cc_common.data_model.schema.fields import (
     ActiveInactive,
     Compact,
@@ -147,7 +148,7 @@ class ProviderRegistrationRequestSchema(Schema):
     token = String(required=True, allow_none=False)
 
 
-class ProviderEmailUpdateRequestSchema(Schema):
+class ProviderEmailUpdateRequestSchema(CCRequestSchema):
     """
     Schema for provider email update requests.
 
@@ -160,7 +161,7 @@ class ProviderEmailUpdateRequestSchema(Schema):
     newEmailAddress = Email(required=True, allow_none=False)
 
 
-class ProviderEmailVerificationRequestSchema(Schema):
+class ProviderEmailVerificationRequestSchema(CCRequestSchema):
     """
     Schema for provider email verification requests.
 

backend/compact-connect/lambdas/python/common/cc_common/data_model/schema/provider/record.py

@@ -202,11 +202,6 @@ class ProviderUpdatePreviousRecordSchema(ForgivingSchema):
     dateOfBirth = Date(required=True, allow_none=False)
     compactConnectRegisteredEmailAddress = Email(required=False, allow_none=False)
 
-    # Optional Email verification fields (only present if the provider has requested an email change)
-    pendingEmailAddress = Email(required=False, allow_none=False)
-    emailVerificationCode = String(required=False, allow_none=False, validate=Length(4, 4))
-    emailVerificationExpiry = DateTime(required=False, allow_none=False)
-
     currentHomeJurisdiction = CurrentHomeJurisdictionField(required=False, allow_none=False)
     dateOfUpdate = DateTime(required=True, allow_none=False)
 

backend/compact-connect/lambdas/python/provider-data-v1/handlers/provider_users.py

@@ -223,9 +223,6 @@ def _patch_provider_email(event: dict, context: LambdaContext):  # noqa: ARG001
     # Parse and validate the request body
     try:
         event_body = json.loads(event['body'])
-        # Trim whitespace from email before validation
-        if 'newEmailAddress' in event_body:
-            event_body['newEmailAddress'] = event_body['newEmailAddress'].strip()
         validated_data = ProviderEmailUpdateRequestSchema().load(event_body)
         new_email_address = validated_data['newEmailAddress']
     except (json.JSONDecodeError, ValidationError) as e: