[IMP] auditlog: replace 'Subscribed' terminology by 'Confirmed'

The concept of subscriptions is slightly misleading in the auditlog domain
because users do not 'subscribe' to individual rules and no notifications
are being sent out.

Author: StefanRijnhart

auditlog/migrations/19.0.1.0.0/post-migration.py

@@ -0,0 +1,5 @@
+def migrate(cr, version):
+    """19.0: state 'subscribed' is renamed to 'confirmed'"""
+    cr.execute(
+        "update auditlog_rule set state = 'confirmed' where state = 'subscribed';"
+    )

auditlog/models/auditlog_rule.py

@@ -201,7 +201,7 @@ class AuditlogRule(models.Model):
     )
 
     state = fields.Selection(
-        [("draft", "Draft"), ("subscribed", "Subscribed")],
+        [("draft", "Draft"), ("confirmed", "Confirmed")],
         required=True,
         default="draft",
     )
@@ -244,7 +244,7 @@ def _register_hook(self):
         if not hasattr(self.pool, "_auditlog_model_cache"):
             self.pool._auditlog_model_cache = {}
         if not self:
-            self = self.search([("state", "=", "subscribed")])
+            self = self.search([("state", "=", "confirmed")])
         return self._patch_methods()
 
     def _patch_method(self, model, method_name, check_attr):
@@ -272,7 +272,7 @@ def _patch_methods(self):
         updated = False
         model_cache = self.pool._auditlog_model_cache
         for rule in self:
-            if rule.state != "subscribed" or not self.pool.get(
+            if rule.state != "confirmed" or not self.pool.get(
                 rule.model_id.model or rule.model_model
             ):
                 continue
@@ -346,8 +346,8 @@ def write(self, vals):
         return res
 
     def unlink(self):
-        """Unsubscribe rules before removing them."""
-        self.unsubscribe()
+        """Set rules to draft before removing them."""
+        self.set_to_draft()
         return super().unlink()
 
     @api.model
@@ -839,8 +839,8 @@ def _prepare_log_line_vals_on_create(self, log_vals, field, new_values):
             ]
         return vals
 
-    def subscribe(self):
-        """Subscribe Rule for auditing changes on model and apply shortcut
+    def set_to_confirmed(self):
+        """Confirm Rule for auditing changes on model and apply shortcut
         to view logs on that model.
         """
         act_window_model = self.env["ir.actions.act_window"]
@@ -856,11 +856,11 @@ def subscribe(self):
                 "domain": domain,
             }
             act_window = act_window_model.sudo().create(vals)
-            rule.write({"state": "subscribed", "action_id": act_window.id})
+            rule.write({"state": "confirmed", "action_id": act_window.id})
         return True
 
-    def unsubscribe(self):
-        """Unsubscribe Auditing Rule on model."""
+    def set_to_draft(self):
+        """Reset Auditlog Rules state to draft."""
         # Revert patched methods
         self._revert_methods()
         for rule in self:

auditlog/tests/common.py

@@ -20,7 +20,7 @@ def create_rule(cls, vals):
     def tearDownClass(cls):
         for rule in cls.env["auditlog.rule"].search([]):
             try:
-                rule.unsubscribe()
+                rule.set_to_draft()
             except KeyError:  # pragma: no cover
                 continue  # Model not loaded yet
 

auditlog/tests/test_auditlog.py

@@ -13,7 +13,7 @@
 class AuditlogCommon:
     def test_LogCreation(self):
         """First test, caching some data."""
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
         group = self.env["res.groups"].create({"name": "testgroup1"})
         self.assertEqual(
             self.env["auditlog.log"].search_count(
@@ -29,7 +29,7 @@ def test_LogCreation(self):
     def test_LogCreation2(self):
         """Second test, using cached data of the first one."""
 
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
 
         auditlog_log = self.env["auditlog.log"]
         testgroup2 = self.env["res.groups"].create({"name": "testgroup2"})
@@ -50,7 +50,7 @@ def test_LogCreation3(self):
         representation).
         """
 
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
         auditlog_log = self.env["auditlog.log"]
         testgroup3 = self.env["res.groups"].create({"name": "testgroup3"})
         testgroup4 = self.env["res.groups"].create({"name": "testgroup4"})
@@ -98,7 +98,7 @@ def test_LogCreation4(self):
         has been generated.
         """
 
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
 
         auditlog_log = self.env["auditlog.log"]
         groups_vals = [
@@ -126,7 +126,7 @@ def test_LogCreation5(self):
         has been generated. And then delete it, check that it has created log
         with 0 fields updated.
         """
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
 
         auditlog_log = self.env["auditlog.log"]
         testgroup5 = self.env["res.groups"].create({"name": "testgroup5"})
@@ -156,7 +156,7 @@ def test_LogCreation6(self):
         has been generated. And then delete it, check that it has created log
         with x fields updated as per rule
         """
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
 
         auditlog_log = self.env["auditlog.log"]
         testgroup6 = self.env["res.groups"].create({"name": "testgroup6"})
@@ -186,7 +186,7 @@ def test_LogCreation7(self):
 
         Check that creation goes as planned (no error coming from ``deepcopy``)
         """
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
 
         auditlog_log = self.env["auditlog.log"]
         cat = self.env["ir.module.category"].create({"name": "Test Category"})
@@ -217,7 +217,7 @@ def test_LogCreation7(self):
 
     def test_LogUpdate(self):
         """Tests write results with different M2O values."""
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
         testgroup3 = self.env["res.groups"].create({"name": "testgroup3"})
         testgroup4 = self.env["res.groups"].create({"name": "testgroup4"})
         group = self.env["res.groups"].create(
@@ -270,7 +270,7 @@ def test_LogUpdate(self):
 
     def test_LogDelete(self):
         """Tests unlink results"""
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
         group = self.env["res.groups"].create({"name": "testgroup1"})
         group.unlink()
         self.assertEqual(
@@ -317,7 +317,7 @@ def setUpClass(cls):
         )
 
     def test_LogExport(self):
-        self.groups_rule.subscribe()
+        self.groups_rule.set_to_confirmed()
 
         auditlog_log = self.env["auditlog.log"]
         self.env["res.groups"].search([]).export_data(["name"])
@@ -395,7 +395,7 @@ def setUpClass(cls):
             }
         )
 
-        cls.auditlog_rule.subscribe()
+        cls.auditlog_rule.set_to_confirmed()
         # Trigger log creation
         rec = cls.env["x_test.model"].create({"x_test_field": "test value"})
         rec.write({"x_test_field": "test value 2"})
@@ -528,7 +528,7 @@ def setUpClass(cls):
         cls.auditlog_rule.users_to_exclude_ids = [[4, cls.users_to_exclude_ids]]
 
         # Subscribe auditlog.rule
-        cls.auditlog_rule.subscribe()
+        cls.auditlog_rule.set_to_confirmed()
 
         cls.auditlog_log = cls.env["auditlog.log"]
 
@@ -685,7 +685,7 @@ def setUpClass(cls):
 
         cls.auditlog_log = cls.env["auditlog.log"]
         # Subscribe auditlog.rule
-        cls.auditlog_rule.subscribe()
+        cls.auditlog_rule.set_to_confirmed()
 
     def test_01_AuditlogFull_field_group_write_log(self):
         """Change group and check successfully created log"""
@@ -736,7 +736,7 @@ def setUpClass(cls):
         cls.auditlog_rule.fields_to_exclude_ids = [[4, cls.fields_to_exclude_ids]]
 
         # Subscribe auditlog.rule
-        cls.auditlog_rule.subscribe()
+        cls.auditlog_rule.set_to_confirmed()
 
         cls.auditlog_log = cls.env["auditlog.log"]
 

auditlog/tests/test_autovacuum.py

@@ -17,7 +17,7 @@ def setUp(self):
                 "log_create": True,
                 "log_write": True,
                 "log_unlink": True,
-                "state": "subscribed",
+                "state": "confirmed",
                 "log_type": "full",
             }
         )

auditlog/views/auditlog_rule_views.xml

@@ -7,17 +7,17 @@
             <form string="Rule">
                 <header>
                     <button
-                        string="Subscribe"
-                        name="subscribe"
+                        string="Confirm"
+                        name="set_to_confirmed"
                         type="object"
                         invisible="state != 'draft'"
                         class="oe_highlight"
                     />
                     <button
-                        string="Unsubscribe"
-                        name="unsubscribe"
+                        string="Set to Draft"
+                        name="set_to_draft"
                         type="object"
-                        invisible="state != 'subscribed'"
+                        invisible="state != 'confirmed'"
                     />
                     <field name="state" widget="statusbar" />
                 </header>
@@ -27,7 +27,7 @@
                             <field
                                 name="name"
                                 placeholder="Description..."
-                                readonly="state == 'subscribed'"
+                                readonly="state == 'confirmed'"
                             />
                         </h1>
                     </div>
@@ -36,29 +36,29 @@
                             <field
                                 name="model_id"
                                 options="{'no_create': True}"
-                                readonly="state == 'subscribed'"
+                                readonly="state == 'confirmed'"
                             />
                             <field
                                 name="log_type"
                                 widget="radio"
-                                readonly="state == 'subscribed'"
+                                readonly="state == 'confirmed'"
                             />
                             <field
                                 name="capture_record"
-                                readonly="state == 'subscribed'"
+                                readonly="state == 'confirmed'"
                                 invisible="log_type != 'full' or log_unlink != True"
                             />
                             <field
                                 name="users_to_exclude_ids"
                                 widget="many2many_tags"
                                 options="{'no_create': True}"
-                                readonly="state == 'subscribed'"
+                                readonly="state == 'confirmed'"
                             />
                             <field
                                 name="fields_to_exclude_ids"
                                 widget="many2many_tags"
                                 options="{'no_create': True}"
-                                readonly="state == 'subscribed'"
+                                readonly="state == 'confirmed'"
                             />
                             <field
                                 name="action_id"
@@ -67,13 +67,13 @@
                             />
                         </group>
                         <group string="Logging">
-                            <field name="log_create" readonly="state == 'subscribed'" />
-                            <field name="log_read" readonly="state == 'subscribed'" />
-                            <field name="log_write" readonly="state == 'subscribed'" />
-                            <field name="log_unlink" readonly="state == 'subscribed'" />
+                            <field name="log_create" readonly="state == 'confirmed'" />
+                            <field name="log_read" readonly="state == 'confirmed'" />
+                            <field name="log_write" readonly="state == 'confirmed'" />
+                            <field name="log_unlink" readonly="state == 'confirmed'" />
                             <field
                                 name="log_export_data"
-                                readonly="state == 'subscribed'"
+                                readonly="state == 'confirmed'"
                             />
                         </group>
                     </group>
@@ -87,7 +87,7 @@
         <field name="arch" type="xml">
             <list
                 decoration-info="state == 'draft'"
-                decoration-bf="state == 'subscribed'"
+                decoration-bf="state == 'confirmed'"
             >
                 <field name="name" />
                 <field name="model_id" />
@@ -113,9 +113,9 @@
                     string="Draft"
                 />
                 <filter
-                    name="state_subscribed"
-                    domain="[('state','=','subscribed')]"
-                    string="Subscribed"
+                    name="state_confirmed"
+                    domain="[('state', '=', 'confirmed')]"
+                    string="Confirmed"
                 />
                 <field name="model_id" />
                 <group>