fix(spp_mis_demo_v2): ensure HH debug GIS layer for MIS demo

Author: jeremi

spp_mis_demo_v2/models/indicator_providers.py

@@ -34,6 +34,14 @@
 
 _logger = logging.getLogger(__name__)
 
+DEBUG_HH_POINTS_LAYER_NAME = "HH Points (Debug)"
+DEBUG_HH_POINTS_LAYER_DOMAIN = (
+    "[('is_registrant', '=', True), "
+    "('is_group', '=', True), "
+    "('coordinates', '!=', False), "
+    "('active', '=', True)]"
+)
+
 # Standard variables from spp_studio to activate (module.xml_id format)
 STANDARD_VARIABLES = [
     # Demographics (computed)
@@ -128,6 +136,93 @@ def _activate_variables(env, xml_ids, source_name):
     return activated, skipped, errors
 
 
+def _find_debug_layer_view(env):
+    """Find the most useful GIS view for debug household points."""
+    view_model = env["ir.ui.view"]
+
+    # Prefer geofence map when available (best fit for geofence query debugging)
+    geofence_view = view_model.search(
+        [
+            ("model", "=", "spp.gis.geofence"),
+            ("type", "=", "gis"),
+        ],
+        limit=1,
+    )
+    if geofence_view:
+        return geofence_view
+
+    # Fallback to the standard area map
+    return view_model.search(
+        [
+            ("model", "=", "spp.area"),
+            ("type", "=", "gis"),
+        ],
+        limit=1,
+    )
+
+
+def _ensure_household_points_debug_layer(env):
+    """Create/update the HH points debug GIS layer (hidden on startup)."""
+    coordinates_field = env["ir.model.fields"].search(
+        [
+            ("model", "=", "res.partner"),
+            ("name", "=", "coordinates"),
+        ],
+        limit=1,
+    )
+    if not coordinates_field:
+        _logger.info(
+            "[spp.mis.demo] Skipping HH debug layer: res.partner.coordinates not available"
+        )
+        return False
+
+    view = _find_debug_layer_view(env)
+    if not view:
+        _logger.info(
+            "[spp.mis.demo] Skipping HH debug layer: no GIS view found for geofence/area"
+        )
+        return False
+
+    layer_model = env["spp.gis.data.layer"]
+    layer = layer_model.search(
+        [
+            ("name", "=", DEBUG_HH_POINTS_LAYER_NAME),
+            ("geo_field_id", "=", coordinates_field.id),
+            ("view_id", "=", view.id),
+        ],
+        limit=1,
+    )
+
+    vals = {
+        "name": DEBUG_HH_POINTS_LAYER_NAME,
+        "geo_field_id": coordinates_field.id,
+        "view_id": view.id,
+        "geo_repr": "basic",
+        "active_on_startup": False,
+        "layer_opacity": 0.9,
+        "begin_color": "#0057B8",
+        "sequence": 25,
+        "domain": DEBUG_HH_POINTS_LAYER_DOMAIN,
+    }
+
+    if layer:
+        layer.write(vals)
+        _logger.info(
+            "[spp.mis.demo] Updated HH debug layer '%s' on view %s",
+            layer.name,
+            view.display_name,
+        )
+        return layer
+
+    layer = layer_model.create(vals)
+    _logger.info(
+        "[spp.mis.demo] Created HH debug layer '%s' on view %s",
+        layer.name,
+        view.display_name,
+    )
+    return layer
+
+
 def post_init_hook(env_or_cr, registry=None):
     """Post-initialization hook for demo module.
 
@@ -162,3 +257,5 @@ def post_init_hook(env_or_cr, registry=None):
         total_skipped,
         total_errors,
     )
+
+    _ensure_household_points_debug_layer(env)

spp_mis_demo_v2/models/mis_demo_generator.py

@@ -561,7 +561,10 @@ def action_generate(self):
                 _logger.info("Generating GPS coordinates for registrants...")
                 self._generate_coordinates(stats)
 
-            # Step 12: Refresh GIS reports so map data is available immediately
+            # Step 12: Ensure debug GIS layers are present (idempotent)
+            self._ensure_debug_gis_layers(stats)
+
+            # Step 13: Refresh GIS reports so map data is available immediately
             self._refresh_gis_reports(stats)
 
             # Step 13: Create PRISM API client with known credentials
@@ -577,6 +580,18 @@ def action_generate(self):
             self.state = "draft"
             raise UserError(_("Error generating demo data: %s") % e) from e
 
+    def _ensure_debug_gis_layers(self, stats):
+        """Ensure optional debug GIS layers exist after demo generation."""
+        try:
+            from .indicator_providers import _ensure_household_points_debug_layer
+
+            layer = _ensure_household_points_debug_layer(self.env)
+            stats["debug_hh_points_layer_ready"] = bool(layer)
+        except Exception as e:
+            # Debug layer should never block demo generation.
+            _logger.warning("Could not ensure debug GIS layers: %s", e)
+            stats["debug_hh_points_layer_ready"] = False
+
     def _ensure_demo_stories_exist(self, stats):
         """Check if demo story registrants exist and create them if not."""
         try:

spp_mis_demo_v2/tests/__init__.py

@@ -6,6 +6,7 @@
 from . import test_claim169_demo
 from . import test_demo_programs
 from . import test_formula_configuration
+from . import test_gis_debug_layer
 from . import test_mis_demo_generator
 from . import test_registry_variables
 from . import test_demo_statistics

spp_mis_demo_v2/tests/test_gis_debug_layer.py

@@ -0,0 +1,51 @@
+# Part of OpenSPP. See LICENSE file for full copyright and licensing details.
+"""Tests for MIS demo household-points debug GIS layer."""
+
+from odoo.tests import TransactionCase, tagged
+
+from odoo.addons.spp_mis_demo_v2.models.indicator_providers import (
+    DEBUG_HH_POINTS_LAYER_DOMAIN,
+    DEBUG_HH_POINTS_LAYER_NAME,
+    _ensure_household_points_debug_layer,
+)
+
+
+@tagged("post_install", "-at_install")
+class TestGISDebugLayer(TransactionCase):
+    """Validate HH points debug layer creation and defaults."""
+
+    def test_household_points_debug_layer_exists_and_disabled_on_startup(self):
+        """Post-init should provide HH points debug layer in a safe default state."""
+        layer = self.env["spp.gis.data.layer"].search(
+            [("name", "=", DEBUG_HH_POINTS_LAYER_NAME)],
+            limit=1,
+        )
+        self.assertTrue(layer, "Expected HH points debug layer to be created")
+        self.assertEqual(layer.geo_field_id.model, "res.partner")
+        self.assertEqual(layer.geo_field_id.name, "coordinates")
+        self.assertFalse(layer.active_on_startup, "Debug layer must be disabled by default")
+        self.assertEqual(layer.domain, DEBUG_HH_POINTS_LAYER_DOMAIN)
+
+    def test_household_points_debug_layer_setup_is_idempotent(self):
+        """Running helper repeatedly should update existing layer, not duplicate it."""
+        layer_model = self.env["spp.gis.data.layer"]
+        before_count = layer_model.search_count([("name", "=", DEBUG_HH_POINTS_LAYER_NAME)])
+
+        _ensure_household_points_debug_layer(self.env)
+
+        after_count = layer_model.search_count([("name", "=", DEBUG_HH_POINTS_LAYER_NAME)])
+        self.assertEqual(before_count, after_count)
+
+    def test_generator_reensures_household_points_debug_layer(self):
+        """Generator flow should re-ensure debug layer for --generate workflows."""
+        layer_model = self.env["spp.gis.data.layer"]
+        layer_model.search([("name", "=", DEBUG_HH_POINTS_LAYER_NAME)]).unlink()
+
+        generator = self.env["spp.mis.demo.generator"].create({"name": "GIS Debug Layer Ensure"})
+        stats = {}
+        generator._ensure_debug_gis_layers(stats)
+
+        layer = layer_model.search([("name", "=", DEBUG_HH_POINTS_LAYER_NAME)], limit=1)
+        self.assertTrue(layer)
+        self.assertFalse(layer.active_on_startup)
+        self.assertTrue(stats.get("debug_hh_points_layer_ready"))