Merge pull request #192 from akvo/feature/191-mt-004-single-language-onboarding

[#191] Dynamic Onboarding - Single Language Bypass & Configurable Data Consent

Author: wayangalihpratama

backend/config.py

@@ -285,6 +285,11 @@ def default_language(self) -> str:
         codes = self.supported_language_codes
         return codes[0] if codes else "en"
 
+    @property
+    def is_single_language(self) -> bool:
+        """Return True if 1 or 0 supported languages are configured."""
+        return len(self.supported_language_codes) <= 1
+
     # Dynamic Age Groups
     age_groups: list = _config.get(
         "age_groups",

backend/config.template.json

@@ -88,9 +88,21 @@
     "delimiter": " > ",
     "levels": [
       { "level_index": 0, "name": "country", "display": { "en": "Country" } },
-      { "level_index": 1, "name": "region", "display": { "en": "Region", "sw": "Mkoa" } },
-      { "level_index": 2, "name": "district", "display": { "en": "District", "sw": "Wilaya" } },
-      { "level_index": 3, "name": "ward", "display": { "en": "Ward", "sw": "Kata" } }
+      {
+        "level_index": 1,
+        "name": "region",
+        "display": { "en": "Region", "sw": "Mkoa" }
+      },
+      {
+        "level_index": 2,
+        "name": "district",
+        "display": { "en": "District", "sw": "Wilaya" }
+      },
+      {
+        "level_index": 3,
+        "name": "ward",
+        "display": { "en": "Ward", "sw": "Kata" }
+      }
     ]
   },
   "onboarding": {
@@ -115,12 +127,52 @@
           "sw": "Vizuri! Lugha uliyopendelea imewekwa kuwa Kiswahili."
         }
       },
+      {
+        "field_name": "consent",
+        "db_field": "data_consent",
+        "enabled": true,
+        "required": true,
+        "priority": 1,
+        "field_type": "boolean",
+        "extraction_method": "extract_consent",
+        "max_attempts": 3,
+        "labels": {
+          "en": "Data Consent",
+          "sw": "Idhini ya Data"
+        },
+        "questions": {
+          "en": "Before we begin, do you agree to allow us to store and use your information to provide personalized agricultural advice and support?\n\nReply with *Yes* to continue or *No* to decline.",
+          "sw": "Kabla ya kuanza, je, unakubali kuturuhusu kuhifadhi na kutumia taarifa zako ili kutoa ushauri na usaidizi wa kibinafsi wa kilimo?\n\nJibu *Ndio* kuendelea au *Hapana* kukataa."
+        },
+        "affirmative_keywords": {
+          "en": [
+            "yes",
+            "ok",
+            "okay",
+            "agree",
+            "i agree",
+            "accepted",
+            "accept",
+            "1",
+            "y"
+          ],
+          "sw": ["ndio", "ndiyo", "sawa", "kubali", "nakubali", "1"]
+        },
+        "declined_keywords": {
+          "en": ["no", "decline", "reject", "2", "n"],
+          "sw": ["hapana", "2"]
+        },
+        "success_messages": {
+          "en": "Thank you for your consent!",
+          "sw": "Asante kwa idhini yako!"
+        }
+      },
       {
         "field_name": "full_name",
         "db_field": "full_name",
         "enabled": true,
         "required": true,
-        "priority": 1,
+        "priority": 2,
         "field_type": "string",
         "max_attempts": 1,
         "labels": {
@@ -141,7 +193,7 @@
         "db_field": "customer_administrative",
         "enabled": true,
         "required": true,
-        "priority": 2,
+        "priority": 3,
         "field_type": "location",
         "extraction_method": "extract_location",
         "matching_method": "resolve_administration_ambiguity",
@@ -164,7 +216,7 @@
         "db_field": "crop_type",
         "enabled": true,
         "required": true,
-        "priority": 3,
+        "priority": 4,
         "field_type": "string",
         "extraction_method": "extract_crop_type",
         "matching_method": "resolve_crop_ambiguity",
@@ -187,7 +239,7 @@
         "db_field": "gender",
         "enabled": true,
         "required": false,
-        "priority": 4,
+        "priority": 5,
         "field_type": "enum",
         "extraction_method": "extract_gender",
         "max_attempts": 2,
@@ -209,7 +261,7 @@
         "db_field": "birth_year",
         "enabled": true,
         "required": false,
-        "priority": 5,
+        "priority": 6,
         "field_type": "integer",
         "extraction_method": "extract_birth_year",
         "max_attempts": 2,

backend/models/customer.py

@@ -173,6 +173,15 @@ def data_consent_given(self) -> bool | None:
     def data_consent_given(self, value: bool | None):
         self.set_profile_field("data_consent_given", value)
 
+    @property
+    def data_consent(self) -> bool | None:
+        """Alias for data_consent_given for dynamic field lookups."""
+        return self.data_consent_given
+
+    @data_consent.setter
+    def data_consent(self, value: bool | None):
+        self.data_consent_given = value
+
     # Account deletion request tracking
     @property
     def delete_requested(self) -> bool:

backend/routers/whatsapp.py

@@ -331,61 +331,6 @@ async def whatsapp_webhook(
             # Don't record the "delete" message - return early
             return {"status": "success", "message": "Delete confirmation sent"}
 
-        # ========================================
-        # DATA CONSENT CHECK (after language, before other fields)
-        # ========================================
-        # Handle consent response if consent was asked (language already set)
-        if (
-            customer.data_consent_asked
-            and not customer.data_consent_given
-            and customer.language is not None
-        ):
-            whatsapp_service = WhatsAppService()
-            lang = customer.language_code
-
-            # Check for affirmative response
-            consent_responses = [
-                "yes",
-                "ok",
-                "okay",
-                "ndio",
-                "ndiyo",
-                "sawa",
-                "agree",
-                "i agree",
-                "accepted",
-                "accept",
-                "kubali",
-                "nakubali",
-                "ya",
-                "setuju",
-                "oke",
-                "y",
-            ]
-            if Body.lower().strip() in consent_responses:
-                # Consent given - mark and continue to onboarding
-                customer.data_consent_given = True
-                db.commit()
-
-                whatsapp_service.send_message(
-                    phone_number, t("consent.data_sharing.accepted", lang)
-                )
-                # Fall through to continue onboarding
-            else:
-                # Not affirmative - send decline message and DELETE customer
-                whatsapp_service.send_message(
-                    phone_number, t("consent.data_sharing.declined", lang)
-                )
-
-                # Delete customer row (fresh start on next message)
-                db.delete(customer)
-                db.commit()
-
-                return {
-                    "status": "success",
-                    "message": "Consent declined, customer deleted",
-                }
-
         # ========================================
         # GENERIC ONBOARDING: Collect all required profile fields
         # ========================================
@@ -420,6 +365,16 @@ async def whatsapp_webhook(
                 f"field: {customer.current_onboarding_field})"
             )
 
+            # If onboarding was aborted (e.g. consent declined),
+            # delete customer
+            if onboarding_response.status == "aborted":
+                db.delete(customer)
+                db.commit()
+                return {
+                    "status": "success",
+                    "message": "Onboarding aborted, customer deleted",
+                }
+
             # If onboarding still in progress, don't process message further
             # Note: "awaiting_selection" is a response status,
             # not in OnboardingStatus enum

backend/schemas/onboarding_schemas.py

@@ -127,6 +127,10 @@ class OnboardingFieldConfig:
     questions: Optional[Union[Dict[str, str], str]] = None
     success_messages: Optional[Union[Dict[str, str], str]] = None
     success_message_template: Optional[str] = None  # Legacy template fallback
+    affirmative_keywords: Optional[Union[Dict[str, List[str]], List[str]]] = (
+        None
+    )
+    declined_keywords: Optional[Union[Dict[str, List[str]], List[str]]] = None
 
     def get_label(self, lang: Optional[str] = None) -> str:
         """Get localized field label or fall back to title-cased name."""
@@ -304,6 +308,14 @@ def load_onboarding_fields() -> List[OnboardingFieldConfig]:
                     "success_message_template",
                     base.success_message_template if base else None,
                 ),
+                affirmative_keywords=(
+                    cfg.get("affirmative_keywords")
+                    or (base.affirmative_keywords if base else None)
+                ),
+                declined_keywords=(
+                    cfg.get("declined_keywords")
+                    or (base.declined_keywords if base else None)
+                ),
             )
         )
 

backend/services/customer_service.py

@@ -42,6 +42,9 @@ def create_customer(
         language: Optional[str] = None,
     ) -> Customer:
         """Create a new customer with minimal fields."""
+        if language is None and settings.is_single_language:
+            language = settings.default_language
+
         customer = Customer(phone_number=phone_number, language=language)
         try:
             self.db.add(customer)