[IMP] base: server actions: add sequence support

In order to update a record using a sequence:
- before this commit one would have to use a python expression like
  `env['ir.sequence'].next_by_code('the_sequence_code')` which was not
  very discoverable.
- after this commit there is a standard way to select a sequence through
  the server action's form view.

Task id: opw-4689501

closes odoo#208376

Signed-off-by: Lucas Perais (lpe) <[email protected]>

Author: brboi

addons/test_base_automation/tests/test_flow.py

@@ -1618,6 +1618,35 @@ def test_01_form_object_write_o2m_field(self):
         self.assertEqual(aks_partner.child_ids.ids, [])
         self.assertEqual(bs_partner.parent_id.id, False)
 
+    def test_02_form_object_write_with_sequence(self):
+        test_partner = self.env["res.partner"].create({"name": "Test Partner"})
+        test_sequence = self.env["ir.sequence"].create({
+            "name": "Test Sequence",
+            "padding": 4,
+            "prefix": "PARTNER/",
+            "suffix": "/TEST",
+        })
+
+        f = Form(self.env['ir.actions.server'], view="base.view_server_action_form")
+        f.model_id = self.env["ir.model"]._get("res.partner")
+        f.state = "object_write"
+        f.evaluation_type = "sequence"
+        self.assertEqual(f.warning, False)
+        f.update_path = "active"
+        self.assertEqual(f.warning, "A sequence must only be used with character fields.")
+        f.update_path = "ref"
+        self.assertEqual(f.warning, False)
+        f.sequence_id = test_sequence
+
+        action = f.save()
+        self.assertEqual(test_partner.ref, False)
+        action.with_context(
+            active_model="res.partner",
+            active_id=test_partner.id,
+        ).run()
+        self.assertEqual(test_partner.ref, "PARTNER/0001/TEST")
+
+
 @common.tagged("post_install", "-at_install")
 class TestHttp(common.HttpCase):
     def test_webhook_trigger(self):

odoo/addons/base/models/ir_actions.py

@@ -613,9 +613,11 @@ def _default_update_path(self):
                              "`42` or `My custom name` or the selected record.")
     evaluation_type = fields.Selection([
         ('value', 'Update'),
+        ('sequence', 'Sequence'),
         ('equation', 'Compute')
     ], 'Value Type', default='value', change_default=True)
     html_value = fields.Html()
+    sequence_id = fields.Many2one('ir.sequence', string='Sequence to use')
     resource_ref = fields.Reference(
         string='Record', selection='_selection_target_model', inverse='_set_resource_ref')
     selection_value = fields.Many2one('ir.model.fields.selection', string="Custom Value", ondelete='cascade',
@@ -624,6 +626,7 @@ def _default_update_path(self):
     value_field_to_show = fields.Selection([
         ('value', 'value'),
         ('html_value', 'html_value'),
+        ('sequence_id', 'sequence_id'),
         ('resource_ref', 'reference'),
         ('update_boolean_value', 'update_boolean_value'),
         ('selection_value', 'selection_value'),
@@ -657,6 +660,8 @@ def _warning_depends(self):
             'child_ids.model_id',
             'child_ids.group_ids',
             'update_path',
+            'update_field_type',
+            'evaluation_type',
             'webhook_field_ids'
         ]
 
@@ -680,6 +685,9 @@ def _get_warning_messages(self):
         if (relation_chain := self._get_relation_chain("update_path")) and relation_chain[0] and isinstance(relation_chain[0][-1], fields.Json):
             warnings.append(_("I'm sorry to say that JSON fields (such as '%s') are currently not supported.", relation_chain[0][-1].string))
 
+        if self.state == 'object_write' and self.evaluation_type == 'sequence' and self.update_field_type and self.update_field_type not in ('char', 'text'):
+            warnings.append(_("A sequence must only be used with character fields."))
+
         if self.state == 'webhook' and self.model_id:
             restricted_fields = []
             Model = self.env[self.model_id.model]
@@ -1108,7 +1116,9 @@ def _can_execute_action_on_records(self, records):
     @api.depends('evaluation_type', 'update_field_id')
     def _compute_value_field_to_show(self):  # check if value_field_to_show can be removed and use ttype in xml view instead
         for action in self:
-            if action.update_field_id.ttype in ('one2many', 'many2one', 'many2many'):
+            if action.evaluation_type == 'sequence':
+                action.value_field_to_show = 'sequence_id'
+            elif action.update_field_id.ttype in ('one2many', 'many2one', 'many2many'):
                 action.value_field_to_show = 'resource_ref'
             elif action.update_field_id.ttype == 'selection':
                 action.value_field_to_show = 'selection_value'
@@ -1150,6 +1160,8 @@ def _eval_value(self, eval_context=None):
             expr = action.value
             if action.evaluation_type == 'equation':
                 expr = safe_eval(action.value, eval_context)
+            elif action.evaluation_type == 'sequence':
+                expr = action.sequence_id.next_by_id()
             elif action.update_field_id.ttype in ['one2many', 'many2many']:
                 operation = action.update_m2m_operation
                 if operation == 'add':

odoo/addons/base/views/ir_actions_views.xml

@@ -382,12 +382,14 @@
                                 <span invisible="evaluation_type != 'value' or update_field_type not in ['one2many', 'many2many']">by</span>
                                 <field name="update_m2m_operation" class="oe_inline" invisible="evaluation_type != 'value' or update_field_type not in ['one2many', 'many2many']" required="update_field_type in ['one2many', 'many2many']"/>
                                 <span invisible="evaluation_type != 'value' or update_field_type in ['one2many', 'many2many']">to</span>
+                                <span invisible="evaluation_type != 'sequence'">with</span>
                                 <field name="value" class="oe_inline" placeholder="Set a value..." invisible="update_field_id == False or value_field_to_show != 'value' or evaluation_type != 'value'" string="Custom Value"/>
                                 <field name="html_value" class="w-100" placeholder="Set a value..." invisible="update_field_id == False or value_field_to_show != 'html_value' or evaluation_type != 'value'" string="Custom Value"/>
+                                <field name="sequence_id" class="oe_inline" placeholder="Select a sequence..." invisible="evaluation_type != 'sequence'" required="evaluation_type == 'sequence'"/>
                                 <field name="resource_ref" class="oe_inline" placeholder="Choose a value..." string="Custom Value" options="{'model_field': 'update_related_model_id', 'no_create': True, 'no_open': True}" invisible="update_field_id == False or value_field_to_show != 'resource_ref' or evaluation_type == 'equation' or update_m2m_operation == 'clear'"/>
                                 <field name="selection_value" class="oe_inline" placeholder="Choose a value..." options="{'no_create': True, 'no_open': True}" invisible="update_field_id == False or value_field_to_show != 'selection_value' or evaluation_type == 'equation'"/>
                                 <field name="update_boolean_value" class="oe_inline" invisible="evaluation_type != 'value' or value_field_to_show != 'update_boolean_value'" required="value_field_to_show == 'update_boolean_value'"/>
-                                <span invisible="update_field_id != False or evaluation_type == 'equation'" class="o_actions_server_set_a_value text-muted">Set a value...</span>
+                                <span invisible="update_field_id != False or evaluation_type != 'value'" class="o_actions_server_set_a_value text-muted">Set a value...</span>
                                 <span invisible="evaluation_type != 'equation'">
                                     to this Python expression:
                                 </span>