[12.0] Backport of 13.0 multiple improvements

queue_job/__manifest__.py

@@ -2,7 +2,7 @@
 
 
 {'name': 'Job Queue',
- 'version': '12.0.1.5.3',
+ 'version': '12.0.2.3.0',
  'author': 'Camptocamp,ACSONE SA/NV,Odoo Community Association (OCA)',
  'website': 'https://github.com/OCA/queue/tree/12.0/queue_job',
  'license': 'LGPL-3',
@@ -17,7 +17,7 @@
           'security/ir.model.access.csv',
           'views/queue_job_views.xml',
           'data/queue_data.xml',
-          ],
+          "data/queue_job_function_data.xml"],
  'installable': True,
  'development_status': 'Mature',
  'maintainers': ['guewen'],

queue_job/controllers/main.py

@@ -7,6 +7,7 @@
 from io import StringIO
 
 from psycopg2 import OperationalError
+from werkzeug.exceptions import Forbidden
 
 import odoo
 from odoo import _, http, tools
@@ -113,17 +114,64 @@ def retry_postpone(job, message, seconds=None):
             # retries are exhausted
             env.cr.rollback()
 
-        except (FailedJobError, Exception):
+        except (FailedJobError, Exception) as orig_exception:
             buff = StringIO()
             traceback.print_exc(file=buff)
-            _logger.error(buff.getvalue())
+            traceback_txt = buff.getvalue()
+            _logger.error(traceback_txt)
             job.env.clear()
             with odoo.api.Environment.manage():
                 with odoo.registry(job.env.cr.dbname).cursor() as new_cr:
                     job.env = job.env(cr=new_cr)
-                    job.set_failed(exc_info=buff.getvalue())
+                    vals = self._get_failure_values(job, traceback_txt, orig_exception)
+                    job.set_failed(**vals)
                     job.store()
                     new_cr.commit()
+                    buff.close()
             raise
 
         return ""
+
+    def _get_failure_values(self, job, traceback_txt, orig_exception):
+        """Collect relevant data from exception."""
+        exception_name = orig_exception.__class__.__name__
+        if hasattr(orig_exception, "__module__"):
+            exception_name = orig_exception.__module__ + "." + exception_name
+        exc_message = getattr(orig_exception, "name", str(orig_exception))
+        return {
+            "exc_info": traceback_txt,
+            "exc_name": exception_name,
+            "exc_message": exc_message,
+        }
+
+    @http.route("/queue_job/create_test_job", type="http", auth="user")
+    def create_test_job(
+        self, priority=None, max_retries=None, channel=None, description="Test job"
+    ):
+        if not http.request.env.user.has_group("base.group_erp_manager"):
+            raise Forbidden(_("Access Denied"))
+
+        if priority is not None:
+            try:
+                priority = int(priority)
+            except ValueError:
+                priority = None
+
+        if max_retries is not None:
+            try:
+                max_retries = int(max_retries)
+            except ValueError:
+                max_retries = None
+
+        delayed = (
+            http.request.env["queue.job"]
+            .with_delay(
+                priority=priority,
+                max_retries=max_retries,
+                channel=channel,
+                description=description,
+            )
+            ._test_job()
+        )
+
+        return delayed.db_record().uuid

queue_job/data/queue_job_function_data.xml

@@ -0,0 +1,6 @@
+<odoo noupdate="1">
+    <record id="job_function_queue_job__test_job" model="queue.job.function">
+        <field name="model_id" ref="queue_job.model_queue_job" />
+        <field name="method">_test_job</field>
+    </record>
+</odoo>

queue_job/fields.py

@@ -5,24 +5,63 @@
 from datetime import datetime, date
 
 import dateutil
+import lxml
 
 from odoo import fields, models
 
 
 class JobSerialized(fields.Field):
-    """Serialized fields provide the storage for sparse fields."""
+    """Provide the storage for job fields stored as json
+
+    A base_type must be set, it must be dict, list or tuple.
+    When the field is not set, the json will be the corresponding
+    json string ("{}" or "[]").
+
+    Support for some custom types has been added to the json decoder/encoder
+    (see JobEncoder and JobDecoder).
+    """
+
     type = 'job_serialized'
     column_type = ('text', 'text')
 
-    def convert_to_column(self, value, record, values=None):
-        return json.dumps(value, cls=JobEncoder)
+    _slots = {"_base_type": type}
+
+    _default_json_mapping = {
+        dict: "{}",
+        list: "[]",
+        tuple: "[]",
+        models.BaseModel: lambda env: json.dumps(
+            {"_type": "odoo_recordset", "model": "base", "ids": [], "uid": env.uid}
+        ),
+    }
+
+    def __init__(self, string=fields.Default, base_type=fields.Default, **kwargs):
+        super().__init__(string=string, _base_type=base_type, **kwargs)
+
+    def _setup_attrs(self, model, name):
+        super()._setup_attrs(model, name)
+        if self._base_type not in self._default_json_mapping:
+            raise ValueError("%s is not a supported base type" % (self._base_type))
+
+    def _base_type_default_json(self, env):
+        default_json = self._default_json_mapping.get(self._base_type)
+        if not isinstance(default_json, str):
+            default_json = default_json(env)
+        return default_json
+
+    def convert_to_column(self, value, record, values=None, validate=True):
+        return self.convert_to_cache(value, record, validate=validate)
 
     def convert_to_cache(self, value, record, validate=True):
-        # cache format: dict
-        value = value or {}
-        if isinstance(value, dict):
-            return value
-        return json.loads(value, cls=JobDecoder, env=record.env)
+        # cache format: json.dumps(value) or None
+        if isinstance(value, self._base_type):
+            return json.dumps(value, cls=JobEncoder)
+        else:
+            return value or None
+
+    def convert_to_record(self, value, record):
+        default = self._base_type_default_json(record.env)
+        return json.loads(value or default, cls=JobDecoder, env=record.env)
 
 
 class JobEncoder(json.JSONEncoder):
@@ -41,6 +80,11 @@ def default(self, obj):
         elif isinstance(obj, date):
             return {'_type': 'date_isoformat',
                     'value': obj.isoformat()}
+        elif isinstance(obj, lxml.etree._Element):
+            return {
+                "_type": "etree_element",
+                "value": lxml.etree.tostring(obj, encoding=str),
+            }
         return json.JSONEncoder.default(self, obj)
 
 
@@ -63,9 +107,12 @@ def object_hook(self, obj):
             model = self.env[obj['model']]
             if obj.get('uid'):
                 model = model.sudo(obj['uid'])
+
             return model.browse(obj['ids'])
         elif type_ == 'datetime_isoformat':
             return dateutil.parser.parse(obj['value'])
         elif type_ == 'date_isoformat':
             return dateutil.parser.parse(obj['value']).date()
+        elif type_ == "etree_element":
+            return lxml.etree.fromstring(obj["value"])
         return obj

queue_job/i18n/queue_job.pot

@@ -481,8 +481,8 @@ msgid "Queue Job"
 msgstr ""
 
 #. module: queue_job
-#: model:ir.model.fields,field_description:queue_job.field_queue_job__record_ids
-msgid "Record"
+#: model:ir.model.fields,field_description:queue_job.field_queue_job__records
+msgid "Record(s)"
 msgstr ""
 
 #. module: queue_job