Merge pull request #198 from OpenSPP/fix/941-program-config-ux-polish

feat(spp_programs): program config UX polish, payment zero-state, cancelable manager wizard (#941 #952 #953)

Author: emjay0921

spp_mis_demo_v2/models/mis_demo_generator.py

@@ -1424,10 +1424,12 @@ def _ensure_program_managers(self, program):
             if program[field]:
                 continue
             for mgr_obj, def_mgr_obj in mapping.items():
-                # Create the concrete manager implementation and link via wrapper
+                # Create the concrete manager implementation and link via
+                # wrapper. Each concrete model's default_get() supplies a
+                # method-specific name; we don't pass "Default" anymore —
+                # see #941 round 2 / item 3.
                 def_mgr = self.env[def_mgr_obj].create(
                     {
-                        "name": "Default",
                         "program_id": program.id,
                     }
                 )

spp_programs/__manifest__.py

@@ -4,7 +4,7 @@
     "name": "OpenSPP Programs",
     "summary": "Manage programs, cycles, beneficiary enrollment, entitlements (cash and in-kind), payments, and fund tracking for social protection.",
     "category": "OpenSPP/Core",
-    "version": "19.0.2.1.3",
+    "version": "19.0.2.2.0",
     "sequence": 1,
     "author": "OpenSPP.org",
     "website": "https://github.com/OpenSPP/OpenSPP2",
@@ -112,6 +112,7 @@
         "wizard/create_program_wizard_compliance_views.xml",
         "wizard/create_program_wizard_cel_views.xml",
         "wizard/enrollment_wizard_views.xml",
+        "wizard/exit_membership_wizard.xml",
         "wizard/prepare_entitlement_confirm_wizard.xml",
     ],
     "assets": {

spp_programs/migrations/19.0.2.2.0/post-migration.py

@@ -0,0 +1,58 @@
+# Part of OpenSPP. See LICENSE file for full copyright and licensing details.
+"""Replace placeholder `name = "Default"` on default-manager records with
+their method-specific labels — see #941 round 2 / item 3.
+
+Existing programs upgraded from a prior version still carry rows whose
+`name` literally reads "Default" (the value used by
+`SPPProgram.create_default_managers` before the cleanup). New rows are
+fine because each concrete model now seeds its own meaningful name via
+`default_get`. This migration backfills the historical rows so the Edit
+form shows e.g. "CEL Eligibility Criteria" instead of "Default".
+"""
+
+import logging
+
+from psycopg2 import sql
+
+_logger = logging.getLogger(__name__)
+
+
+# (table_name, label) pairs. Tables are derived from the concrete-manager
+# `_name` (dots replaced by underscores).
+_DEFAULT_NAME_RENAMES = (
+    ("spp_program_membership_manager_default", "CEL Eligibility Criteria"),
+    ("spp_program_entitlement_manager_default", "Basic Cash"),
+    ("spp_program_entitlement_manager_cash", "Cash Entitlement"),
+    ("spp_program_entitlement_manager_inkind", "In-kind Entitlement"),
+    ("spp_cycle_manager_default", "Default Cycle Schedule"),
+    ("spp_compliance_manager_default", "CEL Compliance Criteria"),
+    ("spp_program_payment_manager_default", "Default Payment"),
+    ("spp_program_manager_default", "Default Program Manager"),
+    ("spp_deduplication_manager_default", "Default Deduplication"),
+)
+
+
+def migrate(cr, version):
+    if not version:
+        return
+    for table, label in _DEFAULT_NAME_RENAMES:
+        # Skip tables that don't exist (modules not installed in this DB).
+        cr.execute(
+            "SELECT 1 FROM information_schema.tables WHERE table_name = %s",
+            (table,),
+        )
+        if not cr.fetchone():
+            continue
+        cr.execute(
+            sql.SQL("UPDATE {tbl} SET name = %s WHERE name = 'Default'").format(
+                tbl=sql.Identifier(table),
+            ),
+            (label,),
+        )
+        if cr.rowcount:
+            _logger.info(
+                "Renamed %d %s rows from 'Default' to %r",
+                cr.rowcount,
+                table,
+                label,
+            )

spp_programs/models/cel/eligibility_cel.py

@@ -56,6 +56,16 @@ class DefaultEligibilityManagerCEL(models.Model):
         help="True if the local expression differs from the source template",
     )
 
+    @api.model
+    def default_get(self, fields_list):
+        """Default the manager name to its method-specific label so the
+        record's actual `name` (visible on the Edit form) reads "CEL
+        Eligibility Criteria" instead of the placeholder "Default"."""
+        res = super().default_get(fields_list)
+        if "name" in fields_list:
+            res.setdefault("name", _("CEL Eligibility Criteria"))
+        return res
+
     # -------------------------------------------------------------------------
     # CEL Profile (computed for widget context)
     # -------------------------------------------------------------------------

spp_programs/models/cycle.py

@@ -610,6 +610,27 @@ def _get_approval_definition(self):
         self.ensure_one()
         return self.cycle_approval_definition_id
 
+    def _notify_thread_by_email(self, message, recipients_data, **kwargs):
+        """Suppress outgoing email when the parent program has email
+        notifications disabled. Chatter logging and in-app notifications are
+        unaffected — only the email dispatch is short-circuited."""
+        self.ensure_one()
+        if self.program_id and not self.program_id._should_send_email_notifications():
+            return
+        return super()._notify_thread_by_email(message, recipients_data, **kwargs)
+
+    def _create_approval_activity(self, definition, review):
+        """Gate the approver-email path on the parent program's toggle.
+
+        spp.approval.mixin schedules a mail.activity for each approver on
+        submit; the activity dispatch sends email through the assignee's
+        notification preferences. Skip the scheduling entirely when the
+        program has email notifications turned off."""
+        self.ensure_one()
+        if self.program_id and not self.program_id._should_send_email_notifications():
+            return
+        return super()._create_approval_activity(definition, review)
+
     @api.onchange("start_date")
     def on_start_date_change(self):
         self.program_id.get_manager(constants.MANAGER_CYCLE).on_start_date_change(self)

spp_programs/models/entitlement.py

@@ -84,7 +84,7 @@ def _generate_code(self):
 
     is_cash_entitlement = fields.Boolean("Cash Entitlement", default=False)
     currency_id = fields.Many2one("res.currency", readonly=True, related="journal_id.currency_id")
-    initial_amount = fields.Monetary(required=True, currency_field="currency_id")
+    initial_amount = fields.Monetary(string="Amount", required=True, currency_field="currency_id")
     transfer_fee = fields.Monetary(currency_field="currency_id", default=0.0)
     balance = fields.Monetary(compute="_compute_balance")  # in company currency
     # TODO: implement transactions against this entitlement
@@ -390,6 +390,29 @@ def _get_approval_definition(self):
         self.ensure_one()
         return self.entitlement_approval_definition_id
 
+    def _notify_thread_by_email(self, message, recipients_data, **kwargs):
+        """Suppress outgoing email when the parent program has email
+        notifications disabled. Chatter logging and in-app notifications are
+        unaffected — only the email dispatch is short-circuited."""
+        self.ensure_one()
+        program = self.cycle_id.program_id
+        if program and not program._should_send_email_notifications():
+            return
+        return super()._notify_thread_by_email(message, recipients_data, **kwargs)
+
+    def _create_approval_activity(self, definition, review):
+        """Gate the approver-email path on the parent program's toggle.
+
+        spp.approval.mixin schedules a mail.activity for each approver on
+        submit; the activity dispatch sends email through the assignee's
+        notification preferences. Skip the scheduling entirely when the
+        program has email notifications turned off."""
+        self.ensure_one()
+        program = self.cycle_id.program_id
+        if program and not program._should_send_email_notifications():
+            return
+        return super()._create_approval_activity(definition, review)
+
     def action_submit_for_approval(self):
         """Submit entitlement for approval using standardized workflow."""
         for record in self:
@@ -885,6 +908,24 @@ def _resolve_approval_definition(self):
         self.ensure_one()
         return self._get_approval_definition()
 
+    def _notify_thread_by_email(self, message, recipients_data, **kwargs):
+        """Suppress outgoing email when the parent program has email
+        notifications disabled. Chatter logging and in-app notifications are
+        unaffected — only the email dispatch is short-circuited."""
+        self.ensure_one()
+        program = self.cycle_id.program_id
+        if program and not program._should_send_email_notifications():
+            return
+        return super()._notify_thread_by_email(message, recipients_data, **kwargs)
+
+    def _create_approval_activity(self, definition, review):
+        """Gate the approver-email path on the parent program's toggle."""
+        self.ensure_one()
+        program = self.cycle_id.program_id
+        if program and not program._should_send_email_notifications():
+            return
+        return super()._create_approval_activity(definition, review)
+
     def action_submit_for_approval(self):
         """Submit in-kind entitlement for approval using standardized workflow."""
         for record in self:

spp_programs/models/managers/compliance_manager.py

@@ -97,6 +97,14 @@ class DefaultComplianceManager(models.Model):
     _inherit = ["spp.compliance.manager.base", "spp.manager.source.mixin"]
     _description = "Default Compliance Manager"
 
+    @api.model
+    def default_get(self, fields_list):
+        """Default the manager name to its method-specific label."""
+        res = super().default_get(fields_list)
+        if "name" in fields_list:
+            res.setdefault("name", _("CEL Compliance Criteria"))
+        return res
+
     # Mode selection
     compliance_cel_mode = fields.Selection(
         selection=[

spp_programs/models/managers/cycle_manager_base.py

@@ -407,6 +407,14 @@ class DefaultCycleManager(models.Model):
     ]
     _description = "Default Cycle Manager"
 
+    @api.model
+    def default_get(self, fields_list):
+        """Default the manager name to its method-specific label."""
+        res = super().default_get(fields_list)
+        if "name" in fields_list:
+            res.setdefault("name", _("Default Cycle Schedule"))
+        return res
+
     cycle_duration = fields.Integer(default=1, required=True, string="Recurrence")
     approver_group_id = fields.Many2one(
         comodel_name="res.groups",

spp_programs/models/managers/deduplication_manager.py

@@ -4,7 +4,7 @@
 import logging
 from datetime import date
 
-from odoo import Command, api, fields, models
+from odoo import Command, _, api, fields, models
 
 _logger = logging.getLogger(__name__)
 
@@ -53,6 +53,14 @@ class DefaultDeduplication(models.Model):
     _capability_individual = True
     _capability_group = True
 
+    @api.model
+    def default_get(self, fields_list):
+        """Default the manager name to its method-specific label."""
+        res = super().default_get(fields_list)
+        if "name" in fields_list:
+            res.setdefault("name", _("Default Deduplication"))
+        return res
+
     def deduplicate_beneficiaries(self, states):
         for rec in self:
             duplicate_beneficiaries = []

spp_programs/models/managers/entitlement_manager_base.py

@@ -329,6 +329,14 @@ class DefaultCashEntitlementManager(models.Model):
     # Set to True so that the UI will display the payment management components
     IS_CASH_ENTITLEMENT = True
 
+    @api.model
+    def default_get(self, fields_list):
+        """Default the manager name to its method-specific label."""
+        res = super().default_get(fields_list)
+        if "name" in fields_list:
+            res.setdefault("name", _("Basic Cash"))
+        return res
+
     amount_per_cycle = fields.Monetary(
         currency_field="currency_id",
         aggregator="sum",