changeset c9a5103e09bd in trytond:default
details: https://hg.tryton.org/trytond?cmd=changeset;node=c9a5103e09bd
description:
        Run trigger in the queue

        This ensures that internal changes that are reverted later in the same
        transaction does not trigger an action.
        Also we ensure that a record is triggered by the same trigger only
        once per transaction.

        issue8342
        review280971002
diffstat:

 CHANGELOG                     |   1 +
 doc/ref/transaction.rst       |   2 +
 doc/topics/triggers.rst       |   3 +-
 trytond/ir/trigger.py         |  80 +++++++++++++++++++++++-------------------
 trytond/model/modelstorage.py |  23 ++----------
 trytond/tests/test_trigger.py |  75 +++++++++++++++++++++++++++++++--------
 trytond/transaction.py        |   4 ++
 7 files changed, 116 insertions(+), 72 deletions(-)

diffs (508 lines):

diff -r 64260c389ec1 -r c9a5103e09bd CHANGELOG
--- a/CHANGELOG Sat Mar 28 16:57:05 2020 +0100
+++ b/CHANGELOG Sat Mar 28 17:13:12 2020 +0100
@@ -1,3 +1,4 @@
+* Run trigger in the queue
 * Do not copy Binary content with file_id
 * Replace memoize with functools.lru_cache
 * Add support for Python 3.8
diff -r 64260c389ec1 -r c9a5103e09bd doc/ref/transaction.rst
--- a/doc/ref/transaction.rst   Sat Mar 28 16:57:05 2020 +0100
+++ b/doc/ref/transaction.rst   Sat Mar 28 17:13:12 2020 +0100
@@ -35,6 +35,8 @@
 
 .. attribute:: Transaction.delete
 
+.. attribute:: Transaction.trigger_records
+
 .. attribute:: Transaction.timestamp
 
 .. attribute:: Transaction.started_at
diff -r 64260c389ec1 -r c9a5103e09bd doc/topics/triggers.rst
--- a/doc/topics/triggers.rst   Sat Mar 28 16:57:05 2020 +0100
+++ b/doc/topics/triggers.rst   Sat Mar 28 17:13:12 2020 +0100
@@ -5,7 +5,8 @@
 ========
 
 Triggers allow to define methods of :class:`trytond.model.model.Model` that are
-called when one of those events happen to a record:
+called at the end of the transaction when one of those events happen to a
+record:
 
 * On Creation
 * On Modification
diff -r 64260c389ec1 -r c9a5103e09bd trytond/ir/trigger.py
--- a/trytond/ir/trigger.py     Sat Mar 28 16:57:05 2020 +0100
+++ b/trytond/ir/trigger.py     Sat Mar 28 17:13:12 2020 +0100
@@ -2,8 +2,9 @@
 # this repository contains the full copyright notices and license terms.
 import datetime
 import time
-from sql import Literal, Null
+from sql import Literal, Null, Select
 from sql.aggregate import Count, Max
+from sql.functions import CurrentTimestamp
 
 from trytond.model.exceptions import ValidationError
 from trytond.i18n import gettext
@@ -162,8 +163,7 @@
         cls._get_triggers_cache.set(key, list(map(int, triggers)))
         return triggers
 
-    @staticmethod
-    def eval(trigger, record):
+    def eval(self, record):
         """
         Evaluate the condition of trigger
         """
@@ -172,49 +172,73 @@
         env['time'] = time
         env['context'] = Transaction().context
         env['self'] = EvalEnvironment(record, record.__class__)
-        return bool(PYSONDecoder(env).decode(trigger.condition))
+        return bool(PYSONDecoder(env).decode(self.condition))
 
-    @classmethod
-    def trigger_action(cls, records, trigger):
+    def queue_trigger_action(self, records):
+        trigger_records = Transaction().trigger_records[self.id]
+        ids = set(map(int, records)) - trigger_records
+        self.__class__.__queue__.trigger_action(self, list(ids))
+        trigger_records.update(ids)
+
+    def trigger_action(self, ids):
         """
         Trigger the action define on trigger for the records
         """
         pool = Pool()
         TriggerLog = pool.get('ir.trigger.log')
-        Model = pool.get(trigger.model.model)
-        ActionModel = pool.get(trigger.action_model.model)
+        Model = pool.get(self.model.model)
+        ActionModel = pool.get(self.action_model.model)
         cursor = Transaction().connection.cursor()
         trigger_log = TriggerLog.__table__()
-        ids = list(map(int, records))
+
+        ids = [r.id for r in Model.browse(ids) if self.eval(r)]
 
         # Filter on limit_number
-        if trigger.limit_number:
+        if self.limit_number:
             new_ids = []
             for sub_ids in grouped_slice(ids):
                 sub_ids = list(sub_ids)
                 red_sql = reduce_ids(trigger_log.record_id, sub_ids)
                 cursor.execute(*trigger_log.select(
                         trigger_log.record_id, Count(Literal(1)),
-                        where=red_sql & (trigger_log.trigger == trigger.id),
+                        where=red_sql & (trigger_log.trigger == self.id),
                         group_by=trigger_log.record_id))
                 number = dict(cursor.fetchall())
                 for record_id in sub_ids:
                     if record_id not in number:
                         new_ids.append(record_id)
                         continue
-                    if number[record_id] < trigger.limit_number:
+                    if number[record_id] < self.limit_number:
                         new_ids.append(record_id)
             ids = new_ids
 
+        def cast_datetime(value):
+            datepart, timepart = value.split(" ")
+            year, month, day = map(int, datepart.split("-"))
+            timepart_full = timepart.split(".")
+            hours, minutes, seconds = map(
+                int, timepart_full[0].split(":"))
+            if len(timepart_full) == 2:
+                microseconds = int(timepart_full[1])
+            else:
+                microseconds = 0
+            return datetime.datetime(
+                year, month, day, hours, minutes, seconds, microseconds)
+
         # Filter on minimum_time_delay
-        if trigger.minimum_time_delay:
+        if self.minimum_time_delay:
             new_ids = []
+            # Use now from the transaction to compare with create_date
+            cursor.execute(*Select([CurrentTimestamp()]))
+            now, = cursor.fetchone()
+            if isinstance(now, str):
+                now = cast_datetime(now)
             for sub_ids in grouped_slice(ids):
                 sub_ids = list(sub_ids)
                 red_sql = reduce_ids(trigger_log.record_id, sub_ids)
                 cursor.execute(*trigger_log.select(
                         trigger_log.record_id, Max(trigger_log.create_date),
-                        where=(red_sql & (trigger_log.trigger == trigger.id)),
+                        where=(red_sql & (trigger_log.trigger == self.id)),
                         group_by=trigger_log.record_id))
                 delay = dict(cursor.fetchall())
                 for record_id in sub_ids:
@@ -223,30 +247,19 @@
                         continue
                     # SQLite return string for MAX
                     if isinstance(delay[record_id], str):
-                        datepart, timepart = delay[record_id].split(" ")
-                        year, month, day = map(int, datepart.split("-"))
-                        timepart_full = timepart.split(".")
-                        hours, minutes, seconds = map(
-                            int, timepart_full[0].split(":"))
-                        if len(timepart_full) == 2:
-                            microseconds = int(timepart_full[1])
-                        else:
-                            microseconds = 0
-                        delay[record_id] = datetime.datetime(year, month,
-                            day, hours, minutes, seconds, microseconds)
-                    if (datetime.datetime.now() - delay[record_id]
-                            >= trigger.minimum_time_delay):
+                        delay[record_id] = cast_datetime(delay[record_id])
+                    if now - delay[record_id] >= self.minimum_time_delay:
                         new_ids.append(record_id)
             ids = new_ids
 
         records = Model.browse(ids)
         if records:
-            getattr(ActionModel, trigger.action_function)(records, trigger)
-        if trigger.limit_number or trigger.minimum_time_delay:
+            getattr(ActionModel, self.action_function)(records, self)
+        if self.limit_number or self.minimum_time_delay:
             to_create = []
             for record in records:
                 to_create.append({
-                        'trigger': trigger.id,
+                        'trigger': self.id,
                         'record_id': record.id,
                         })
             if to_create:
@@ -263,14 +276,9 @@
                 ])
         for trigger in triggers:
             Model = pool.get(trigger.model.model)
-            triggered = []
             # TODO add a domain
             records = Model.search([])
-            for record in records:
-                if cls.eval(trigger, record):
-                    triggered.append(record)
-            if triggered:
-                cls.trigger_action(triggered, trigger)
+            trigger.trigger_action(records)
 
     @classmethod
     def create(cls, vlist):
diff -r 64260c389ec1 -r c9a5103e09bd trytond/model/modelstorage.py
--- a/trytond/model/modelstorage.py     Sat Mar 28 16:57:05 2020 +0100
+++ b/trytond/model/modelstorage.py     Sat Mar 28 17:13:12 2020 +0100
@@ -166,12 +166,7 @@
         if not triggers:
             return
         for trigger in triggers:
-            triggers = []
-            for record in records:
-                if Trigger.eval(trigger, record):
-                    triggers.append(record)
-            if triggers:
-                Trigger.trigger_action(triggers, trigger)
+            trigger.queue_trigger_action(records)
 
     @classmethod
     def read(cls, ids, fields_names):
@@ -251,14 +246,8 @@
         Trigger write actions.
         eligibles is a dictionary of the lists of eligible records by triggers
         '''
-        Trigger = Pool().get('ir.trigger')
         for trigger, records in eligibles.items():
-            triggered = []
-            for record in records:
-                if Trigger.eval(trigger, record):
-                    triggered.append(record)
-            if triggered:
-                Trigger.trigger_action(triggered, trigger)
+            trigger.queue_trigger_action(records)
 
     @classmethod
     def index_set_field(cls, name):
@@ -314,12 +303,8 @@
         if not triggers:
             return
         for trigger in triggers:
-            triggered = []
-            for record in records:
-                if Trigger.eval(trigger, record):
-                    triggered.append(record)
-            if triggered:
-                Trigger.trigger_action(triggered, trigger)
+            # Do not queue because records will be deleted
+            trigger.trigger_action(records)
 
     @classmethod
     def copy(cls, records, default=None):
diff -r 64260c389ec1 -r c9a5103e09bd trytond/tests/test_trigger.py
--- a/trytond/tests/test_trigger.py     Sat Mar 28 16:57:05 2020 +0100
+++ b/trytond/tests/test_trigger.py     Sat Mar 28 17:13:12 2020 +0100
@@ -23,6 +23,18 @@
     def setUpClass(cls):
         activate_module('tests')
 
+    def setUp(self):
+        TRIGGER_LOGS.clear()
+
+    def run_tasks(self):
+        pool = Pool()
+        Queue = pool.get('ir.queue')
+        transaction = Transaction()
+        self.assertTrue(transaction.tasks)
+        while transaction.tasks:
+            task = Queue(transaction.tasks.pop())
+            task.run()
+
     @with_transaction()
     def test_constraints(self):
         'Test constraints'
@@ -99,6 +111,7 @@
                     'name': 'Test',
                     }])
 
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
@@ -113,6 +126,7 @@
         triggered, = Triggered.create([{
                     'name': 'Bar',
                     }])
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
@@ -120,6 +134,7 @@
         triggered, = Triggered.create([{
                     'name': 'Foo',
                     }])
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [])
 
         # With limit number
@@ -130,6 +145,7 @@
         triggered, = Triggered.create([{
                     'name': 'Test',
                     }])
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
@@ -141,6 +157,7 @@
         triggered, = Triggered.create([{
                     'name': 'Test',
                     }])
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
@@ -148,11 +165,12 @@
         Trigger._get_triggers_cache.clear()
 
     @with_transaction()
-    def test0030on_write(self):
+    def test_on_write(self):
         'Test on_write'
         pool = Pool()
         Model = pool.get('ir.model')
         Trigger = pool.get('ir.trigger')
+        TriggerLog = pool.get('ir.trigger.log')
         Triggered = pool.get('test.triggered')
 
         model, = Model.search([
@@ -178,6 +196,7 @@
         Triggered.write([triggered], {
                 'name': 'Foo',
                 })
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [])
 
         # Trigger with condition
@@ -191,6 +210,7 @@
         Triggered.write([triggered], {
                 'name': 'Bar',
                 })
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
@@ -198,12 +218,14 @@
         Triggered.write([triggered], {
                 'name': 'Bar',
                 })
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [])
 
         # Different change in condition
         Triggered.write([triggered], {
                 'name': 'Foo',
                 })
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [])
 
         # With limit number
@@ -225,6 +247,7 @@
         Triggered.write([triggered], {
                 'name': 'Bar',
                 })
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
@@ -240,6 +263,7 @@
             Triggered.write([triggered], {
                     'name': name,
                     })
+        self.run_tasks()
         self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
@@ -251,22 +275,33 @@
                     }])
         for name in ('Bar', 'Foo'):
             Triggered.write([triggered], {
-                    'name': name,
-                    })
-        time.sleep(1.2)
+                'name': name,
+                })
+            self.run_tasks()
+        self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
+        TRIGGER_LOGS.pop()
+        Transaction().trigger_records.clear()
+
+        # Make time pass by moving back in time the log creation
+        trigger_log = TriggerLog.__table__()
+        cursor = Transaction().connection.cursor()
+        cursor.execute(*trigger_log.update(
+                [trigger_log.create_date],
+                [datetime.datetime.now() - datetime.timedelta(days=1)],
+                where=trigger_log.record_id == triggered.id))
+
         Triggered.write([triggered], {
                 'name': 'Bar',
                 })
-        self.assertEqual(TRIGGER_LOGS,
-            [([triggered], trigger), ([triggered], trigger)])
-        TRIGGER_LOGS.pop()
+        self.run_tasks()
+        self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
         # Restart the cache on the get_triggers method of ir.trigger
         Trigger._get_triggers_cache.clear()
 
     @with_transaction()
-    def test0040on_delete(self):
+    def test_on_delete(self):
         'Test on_delete'
         pool = Pool()
         Model = pool.get('ir.model')
@@ -389,7 +424,7 @@
                     'name': 'Test',
                     }])
         Trigger.trigger_time()
-        self.assertTrue(TRIGGER_LOGS == [([triggered], trigger)])
+        self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
         # Trigger with condition
@@ -404,7 +439,7 @@
                 'name': 'Bar',
                 })
         Trigger.trigger_time()
-        self.assertTrue(TRIGGER_LOGS == [([triggered], trigger)])
+        self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
         # Non matching condition
@@ -412,7 +447,7 @@
                 'name': 'Foo',
                 })
         Trigger.trigger_time()
-        self.assertTrue(TRIGGER_LOGS == [])
+        self.assertEqual(TRIGGER_LOGS, [])
 
         # With limit number
         Trigger.write([trigger], {
@@ -421,7 +456,7 @@
                 })
         Trigger.trigger_time()
         Trigger.trigger_time()
-        self.assertTrue(TRIGGER_LOGS == [([triggered], trigger)])
+        self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
 
         # Delete trigger logs of limit number test
@@ -436,7 +471,7 @@
                 })
         Trigger.trigger_time()
         Trigger.trigger_time()
-        self.assertTrue(TRIGGER_LOGS == [([triggered], trigger)])
+        self.assertEqual(TRIGGER_LOGS, [([triggered], trigger)])
         TRIGGER_LOGS.pop()
         Transaction().delete = {}
 
@@ -449,10 +484,18 @@
                 'minimum_time_delay': datetime.timedelta(seconds=1),
                 })
         Trigger.trigger_time()
-        time.sleep(1.2)
+
+        # Make time pass by moving back in time the log creation
+        trigger_log = TriggerLog.__table__()
+        cursor = Transaction().connection.cursor()
+        cursor.execute(*trigger_log.update(
+                [trigger_log.create_date],
+                [datetime.datetime.now() - datetime.timedelta(days=1)],
+                where=trigger_log.record_id == triggered.id))
+
         Trigger.trigger_time()
-        self.assertTrue(TRIGGER_LOGS == [([triggered], trigger),
-                ([triggered], trigger)])
+        self.assertEqual(
+            TRIGGER_LOGS, [([triggered], trigger), ([triggered], trigger)])
         TRIGGER_LOGS.pop()
         TRIGGER_LOGS.pop()
         Transaction().delete = {}
diff -r 64260c389ec1 -r c9a5103e09bd trytond/transaction.py
--- a/trytond/transaction.py    Sat Mar 28 16:57:05 2020 +0100
+++ b/trytond/transaction.py    Sat Mar 28 17:13:12 2020 +0100
@@ -2,6 +2,7 @@
 # this repository contains the full copyright notices and license terms.
 import logging
 import time
+from collections import defaultdict
 from threading import local
 from sql import Flavor
 
@@ -54,6 +55,7 @@
     create_records = None
     delete_records = None
     delete = None  # TODO check to merge with delete_records
+    trigger_records = None
     timestamp = None
     started_at = None
 
@@ -114,6 +116,7 @@
         self.create_records = {}
         self.delete_records = {}
         self.delete = {}
+        self.trigger_records = defaultdict(set)
         self.timestamp = {}
         self.counter = 0
         self._datamanagers = []
@@ -157,6 +160,7 @@
                     self.create_records = None
                     self.delete_records = None
                     self.delete = None
+                    self.trigger_records = None
                     self.timestamp = None
                     self._datamanagers = []
 

Reply via email to