From bbbbc6fbd7e1bc2d9bdc1c235120012958d263e5 Mon Sep 17 00:00:00 2001
From: Justine Doutreloux <justine.doutreloux@acsone.eu>
Date: Tue, 8 Aug 2023 13:41:34 +0200
Subject: [PATCH] [IMP] stachechat_mixin: make it possible to ignore some
 events in the has_allowed_event compute

---
 statechart/models/statechart_mixin.py      |  7 ++++-
 test_statechart/models/test_statechart.yml |  8 ++++++
 test_statechart/tests/test_basic.py        | 31 ++++++++++++++++++++++
 3 files changed, 45 insertions(+), 1 deletion(-)

diff --git a/statechart/models/statechart_mixin.py b/statechart/models/statechart_mixin.py
index 610166c..f8a1001 100644
--- a/statechart/models/statechart_mixin.py
+++ b/statechart/models/statechart_mixin.py
@@ -321,9 +321,14 @@ class can override the statechart with another one adding new events,
 
     @api.model
     def _get_sc_event_allowed_field_names(self):
+        ignore_for_has_allowed_events = self.env.context.get(
+            "ignore_for_has_allowed_events", []
+        )
         event_names = self._statechart.events_for()
         return [
-            _sc_make_event_allowed_field_name(event_name) for event_name in event_names
+            _sc_make_event_allowed_field_name(event_name)
+            for event_name in event_names
+            if event_name not in ignore_for_has_allowed_events
         ]
 
     @api.depends("sc_state")
diff --git a/test_statechart/models/test_statechart.yml b/test_statechart/models/test_statechart.yml
index 39a63a0..0b26470 100644
--- a/test_statechart/models/test_statechart.yml
+++ b/test_statechart/models/test_statechart.yml
@@ -10,10 +10,18 @@ statechart:
             target: confirmed1
           - target: confirmed1
             guard: o.amount < 1
+          - target: canceled
+            event: cancel
       - name: confirmed1
         transitions:
           - target: confirmed2
             guard: o.amount < 100
           - target: confirmed2
             event: confirm2
+          - target: canceled
+            event: cancel
       - name: confirmed2
+        transitions:
+          - target: canceled
+            event: cancel
+      - name: canceled
diff --git a/test_statechart/tests/test_basic.py b/test_statechart/tests/test_basic.py
index 9cbe202..52fe0ef 100644
--- a/test_statechart/tests/test_basic.py
+++ b/test_statechart/tests/test_basic.py
@@ -35,3 +35,34 @@ def test_automatic_transition_on_create(self):
         record = model.create({"amount": 0.5})
         # very small amount, step 1 and 2 done automatically
         self.assertScState(record.sc_state, ["confirmed2", "root"])
+
+    def test_get_sc_event_allowed_field_names(self):
+        """
+        Test that we can ignore certain events based on a context
+        key (ignore_for_has_allowed_events)
+        """
+        model = self.env["scobidoo.test.model"]
+        record = model.create({"amount": 200})
+        record.confirm1()
+        self.assertScState(record.sc_state, ["confirmed1", "root"])
+
+        # 2 events are allowed: confirmed2 and cancel
+        self.assertEqual(record.sc_has_allowed_events, True)
+
+        # 1 event is allowed: confirmed2
+        record.invalidate_cache()
+        self.assertEqual(
+            record.with_context(
+                ignore_for_has_allowed_events=["cancel"]
+            ).sc_has_allowed_events,
+            True,
+        )
+
+        # no event allowed
+        record.invalidate_cache()
+        self.assertEqual(
+            record.with_context(
+                ignore_for_has_allowed_events=["cancel", "confirm2"]
+            ).sc_has_allowed_events,
+            False,
+        )