From ff65198d5cc1b8b326b3a50d8c70ab03d0e662b5 Mon Sep 17 00:00:00 2001 From: KKamaa Date: Tue, 22 Mar 2022 06:53:39 +0300 Subject: [PATCH] WIP: [IMP] report_async: async printing dialog in popup after pressing regular Print button --- report_async/README.rst | 138 +++++ report_async/__init__.py | 5 + report_async/__manifest__.py | 27 + report_async/data/mail_template.xml | 73 +++ report_async/data/queue_job_function_data.xml | 6 + report_async/demo/report_async_demo.xml | 7 + report_async/models/__init__.py | 7 + report_async/models/ir_actions.py | 26 + report_async/models/ir_report.py | 35 ++ report_async/models/queue_job.py | 30 ++ report_async/models/report_async.py | 225 ++++++++ report_async/readme/CONTRIBUTORS.rst | 14 + report_async/readme/DESCRIPTION.rst | 22 + report_async/readme/USAGE.rst | 19 + report_async/security/ir.model.access.csv | 4 + report_async/security/ir_rule.xml | 25 + report_async/static/description/icon.png | Bin 0 -> 9455 bytes report_async/static/description/index.html | 479 ++++++++++++++++++ .../static/src/js/components/action_menus.js | 123 +++++ report_async/static/src/xml/report_async.xml | 40 ++ report_async/tests/__init__.py | 1 + report_async/tests/test_report_async.py | 55 ++ report_async/views/assets.xml | 15 + report_async/views/ir_actions_report.xml | 17 + report_async/views/report_async.xml | 178 +++++++ report_async/wizard/__init__.py | 4 + report_async/wizard/print_report_wizard.py | 45 ++ report_async/wizard/print_report_wizard.xml | 37 ++ .../src/js/report/action_manager_report.js | 5 +- setup/report_async/odoo/addons/report_async | 1 + setup/report_async/setup.py | 6 + 31 files changed, 1667 insertions(+), 2 deletions(-) create mode 100644 report_async/README.rst create mode 100644 report_async/__init__.py create mode 100644 report_async/__manifest__.py create mode 100644 report_async/data/mail_template.xml create mode 100644 report_async/data/queue_job_function_data.xml create mode 100644 report_async/demo/report_async_demo.xml create mode 100644 report_async/models/__init__.py create mode 100644 report_async/models/ir_actions.py create mode 100644 report_async/models/ir_report.py create mode 100644 report_async/models/queue_job.py create mode 100644 report_async/models/report_async.py create mode 100644 report_async/readme/CONTRIBUTORS.rst create mode 100644 report_async/readme/DESCRIPTION.rst create mode 100644 report_async/readme/USAGE.rst create mode 100644 report_async/security/ir.model.access.csv create mode 100644 report_async/security/ir_rule.xml create mode 100644 report_async/static/description/icon.png create mode 100644 report_async/static/description/index.html create mode 100644 report_async/static/src/js/components/action_menus.js create mode 100644 report_async/static/src/xml/report_async.xml create mode 100644 report_async/tests/__init__.py create mode 100644 report_async/tests/test_report_async.py create mode 100644 report_async/views/assets.xml create mode 100644 report_async/views/ir_actions_report.xml create mode 100644 report_async/views/report_async.xml create mode 100644 report_async/wizard/__init__.py create mode 100644 report_async/wizard/print_report_wizard.py create mode 100644 report_async/wizard/print_report_wizard.xml create mode 120000 setup/report_async/odoo/addons/report_async create mode 100644 setup/report_async/setup.py diff --git a/report_async/README.rst b/report_async/README.rst new file mode 100644 index 0000000000..94abe5a535 --- /dev/null +++ b/report_async/README.rst @@ -0,0 +1,138 @@ +============ +Report Async +============ + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github + :target: https://github.com/OCA/reporting-engine/tree/14.0/report_async + :alt: OCA/reporting-engine +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/reporting-engine-14-0/reporting-engine-14-0-report_async + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/143/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +The new menu "Report Center" is the central place to host your reports in one place. +From here, there are 2 ways to launch the report, + +1. Run Now - run report immediately as per normal. +2. Run Background - put the report execution to queue job. + +There are additional settings under *Reports* -> *Async Options* for specific reports using async options: + +- Async report - Whether the report should be async. +- Min of Records - How many records required to trigger async reports. +- Mail Recipient - This by defualt is the logged in user's email, but can be reconfigured in a popup dialog. + +By using the queue job, option 2 is great for long running report. +The report file will be saved for later use, with the option to send report +by email as soon as it is ready. + +Notes: + +* Only user with Technical Feature rights can manage the report. +* Every internal user will have right to execute the report allowed for his/her groups. +* The files created are owned and viewable only by the person who run the report. +* Job queue manager can also see all jobs for each reports. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +Menu: Dashboard > Report Center + +As Technical Feature users, you can manage reports for Report Center. + +- **Report:** choose the report (a window action). Although the option show all window actions + it only make sense for window actions that launch reports. +- **Allow Async:** check this, if you want the report to run in background too, suitable for + report that return file as result, i.e., pdf/xlsx/csv/txt. +- **Email Notification:** if checked, once the background process is completed, email with link to download + report will be sent. +- **Groups:** select user groups allowed to use this report. If left blank, all user can use. + +As normal user, you can run your reports from Report Center + +- **Run Now button:** to run report immediately as per normal. +- **Run Background button:** to run report asynchronously. Fall back to run now, if not report that produce file. +- **Job Status:** show status of the latest run job. If job fail, exception error will also shown +- **Files:** show all files being produced by the job as run by the user. +- **Jobs:** show all jobs triggered by this report as run by the user. Only job queue manager have access to this button. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Ecosoft + +Contributors +~~~~~~~~~~~~ + +* `Ecosoft `__: + + * Kitti U. + * Saran Lim. + * Tharathip Chaweewongphan + +* `Therp `__: + + - Nikos Tsirintanis + +* `Sunflower IT `__: + + * Tom Blauwendraat + * Kevin Kamau + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-kittiu| image:: https://github.com/kittiu.png?size=40px + :target: https://github.com/kittiu + :alt: kittiu + +Current `maintainer `__: + +|maintainer-kittiu| + +This module is part of the `OCA/reporting-engine `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_async/__init__.py b/report_async/__init__.py new file mode 100644 index 0000000000..d5a964721a --- /dev/null +++ b/report_async/__init__.py @@ -0,0 +1,5 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +from . import models +from . import wizard diff --git a/report_async/__manifest__.py b/report_async/__manifest__.py new file mode 100644 index 0000000000..4a0a24865b --- /dev/null +++ b/report_async/__manifest__.py @@ -0,0 +1,27 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) +{ + "name": "Report Async", + "summary": "Central place to run reports live or async", + "version": "14.0.1.0.0", + "author": "Ecosoft, Odoo Community Association (OCA)", + "license": "AGPL-3", + "website": "https://github.com/OCA/reporting-engine", + "category": "Generic Modules", + "depends": ["queue_job"], + "data": [ + "security/ir.model.access.csv", + "security/ir_rule.xml", + "views/assets.xml", + "data/mail_template.xml", + "data/queue_job_function_data.xml", + "views/report_async.xml", + "wizard/print_report_wizard.xml", + "views/ir_actions_report.xml", + ], + "qweb": ["static/src/xml/report_async.xml"], + "demo": ["demo/report_async_demo.xml"], + "installable": True, + "maintainers": ["kittiu"], + "development_status": "Beta", +} diff --git a/report_async/data/mail_template.xml b/report_async/data/mail_template.xml new file mode 100644 index 0000000000..01ea4b9d52 --- /dev/null +++ b/report_async/data/mail_template.xml @@ -0,0 +1,73 @@ + + + + + Report Async: New Report Available + + Your report is available, ${object.name} + ${object.company_id.partner_id.email_formatted|safe} + ${user.partner_id.id} + + + + + +
+ + + + + + +
+ + + + +
+ % set base_url_async = object.env['ir.config_parameter'].sudo().get_param('web.base.url.async_reports') + % set base_url = base_url_async or object.env['ir.config_parameter'].sudo().get_param('web.base.url') + % set download_url = '%s/web/content/ir.attachment/%s/datas/%s?download=true' % (base_url, object.id, object.name, ) +
+ Dear ${object.create_uid.partner_id.name or ''}, +

+ Your requested report, ${object.name}, is available for + download + . +

+ Have a nice day!
+ --
${object.company_id.name} +
+
+
+
+ + + + + diff --git a/report_async/data/queue_job_function_data.xml b/report_async/data/queue_job_function_data.xml new file mode 100644 index 0000000000..e5b2a23fac --- /dev/null +++ b/report_async/data/queue_job_function_data.xml @@ -0,0 +1,6 @@ + + + + run_report + + diff --git a/report_async/demo/report_async_demo.xml b/report_async/demo/report_async_demo.xml new file mode 100644 index 0000000000..1a60a3874f --- /dev/null +++ b/report_async/demo/report_async_demo.xml @@ -0,0 +1,7 @@ + + + + + + + diff --git a/report_async/models/__init__.py b/report_async/models/__init__.py new file mode 100644 index 0000000000..5c58434bb3 --- /dev/null +++ b/report_async/models/__init__.py @@ -0,0 +1,7 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +from . import report_async +from . import ir_report +from . import ir_actions +from . import queue_job diff --git a/report_async/models/ir_actions.py b/report_async/models/ir_actions.py new file mode 100644 index 0000000000..cbab3aa318 --- /dev/null +++ b/report_async/models/ir_actions.py @@ -0,0 +1,26 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +from odoo import api, models + + +class IrActionsActWindow(models.Model): + _inherit = "ir.actions.act_window" + + @api.model + def name_search(self, name, args=None, operator="ilike", limit=100): + if self._context.get("access_sudo", False): + self = self.sudo() + return super().name_search(name, args, operator, limit) + + @api.model + def search(self, args, offset=0, limit=None, order=None, count=False): + if self._context.get("access_sudo", False): + self = self.sudo() + return super().search(args, offset, limit, order, count) + + def _read(self, fields): + """ Add permission to read analytic account for do something. """ + if self._context.get("access_sudo", False): + self = self.sudo() + return super()._read(fields) diff --git a/report_async/models/ir_report.py b/report_async/models/ir_report.py new file mode 100644 index 0000000000..0b0f87fc58 --- /dev/null +++ b/report_async/models/ir_report.py @@ -0,0 +1,35 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +from odoo import fields, models + +# Define all supported report_type +REPORT_TYPES = ["qweb-pdf", "qweb-text", "qweb-xml", "csv", "excel", "xlsx"] + + +class Report(models.Model): + _inherit = "ir.actions.report" + + async_report = fields.Boolean(default=False) + async_no_records = fields.Integer( + string="Min of Records", + default=100, + help="Min no of records to use async report functionality; e.g 100+", + ) + async_mail_recipient = fields.Char( + string="Mail Recipient", + help="The email that will receive the async report", + default=lambda self: self.env.user.email, + ) + + def report_action(self, docids, data=None, config=True): + res = super(Report, self).report_action(docids, data=data, config=config) + if res["context"].get("async_process", False): + rpt_async_id = res["context"]["active_id"] + report_async = self.env["report.async"].browse(rpt_async_id) + if res["report_type"] in REPORT_TYPES: + report_async.with_delay().run_report( + res["context"].get("active_ids", []), data, self.id, self._uid + ) + return {} + return res diff --git a/report_async/models/queue_job.py b/report_async/models/queue_job.py new file mode 100644 index 0000000000..2c5bd6b95c --- /dev/null +++ b/report_async/models/queue_job.py @@ -0,0 +1,30 @@ +# Copyright 2022 Sunflower IT (https://sunflowerweb.nl/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +from odoo import api, models + + +class QueueJob(models.Model): + _inherit = "queue.job" + + @api.model + def create(self, values): + res = super(QueueJob, self).create(values) + if ( + "model_name" in values + and values["model_name"] == "report.async" + and "kwargs" in values + and "to_email" in values["kwargs"] + ): + followers = self._find_partner(res, values["kwargs"]["to_email"]) + if followers: + res.message_subscribe(partner_ids=followers) + return res + + def _find_partner(self, record, email): + partner = self.env["res.partner"].search([("email", "=", email)], limit=1) + followers = record.message_follower_ids.mapped("partner_id") + ids = [x for x in partner.ids if x not in followers.ids] + if partner and ids: + return ids + return None diff --git a/report_async/models/report_async.py b/report_async/models/report_async.py new file mode 100644 index 0000000000..763fcc64f0 --- /dev/null +++ b/report_async/models/report_async.py @@ -0,0 +1,225 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +import base64 +import logging + +import mock + +from odoo import _, api, fields, models +from odoo.exceptions import UserError +from odoo.http import request +from odoo.tools.safe_eval import safe_eval + +_logger = logging.getLogger(__name__) + +# Define all supported report_type +REPORT_TYPES_FUNC = { + "qweb-pdf": "_render_qweb_pdf", + "qweb-text": "_render_qweb_text", + "qweb-xml": "_render_qweb_xml", + "csv": "_render_csv", + "excel": "render_excel", + "xlsx": "_render_xlsx", +} + + +class ReportAsync(models.Model): + _name = "report.async" + _description = "Report Async" + + action_id = fields.Many2one( + comodel_name="ir.actions.act_window", + string="Reports", + required=True, + ) + allow_async = fields.Boolean( + string="Allow Async", + default=False, + help="This is not automatic field, please check if you want to allow " + "this report in background process", + ) + name = fields.Char( + string="Name", + related="action_id.display_name", + ) + email_notify = fields.Boolean( + string="Email Notification", + help="Send email with link to report, when it is ready", + ) + group_ids = fields.Many2many( + string="Groups", + comodel_name="res.groups", + help="Only user in selected groups can use this report." + "If left blank, everyone can use", + ) + job_ids = fields.Many2many( + comodel_name="queue.job", + compute="_compute_job", + help="List all jobs related to this running report", + ) + job_status = fields.Selection( + selection=[ + ("pending", "Pending"), + ("enqueued", "Enqueued"), + ("started", "Started"), + ("done", "Done"), + ("failed", "Failed"), + ], + compute="_compute_job", + help="Latest Job Status", + ) + job_info = fields.Text( + compute="_compute_job", + help="Latest Job Error Message", + ) + file_ids = fields.Many2many( + comodel_name="ir.attachment", + compute="_compute_file", + help="List all files created by this report background process", + ) + + def _compute_job(self): + for rec in self: + rec.job_ids = ( + self.sudo() + .env["queue.job"] + .search( + [ + ("func_string", "like", "report.async(%s,)" % rec.id), + ("user_id", "=", self._uid), + ], + order="id desc", + ) + ) + rec.job_status = rec.job_ids[0].sudo().state if rec.job_ids else False + rec.job_info = rec.job_ids[0].sudo().exc_info if rec.job_ids else False + + def _compute_file(self): + files = self.env["ir.attachment"].search( + [ + ("res_model", "=", "report.async"), + ("res_id", "in", self.ids), + ("create_uid", "=", self._uid), + ], + order="id desc", + ) + for rec in self: + rec.file_ids = files.filtered(lambda l: l.res_id == rec.id) + + def run_now(self): + self.ensure_one() + action = self.env.ref(self.action_id.xml_id) + result = action.sudo().read()[0] + ctx = safe_eval(result.get("context", {})) + ctx.update({"async_process": False}) + result["context"] = ctx + return result + + def run_async(self): + self.ensure_one() + if not self.allow_async: + raise UserError(_("Background process not allowed.")) + action = self.env.ref(self.action_id.xml_id) + result = action.sudo().read()[0] + ctx = safe_eval(result.get("context", {})) + ctx.update({"async_process": True}) + result["context"] = ctx + return result + + def view_files(self): + self.ensure_one() + action = self.env.ref("report_async.action_view_files") + result = action.sudo().read()[0] + result["domain"] = [("id", "in", self.file_ids.ids)] + return result + + def view_jobs(self): + self.ensure_one() + action = self.env.ref("queue_job.action_queue_job") + result = action.sudo().read()[0] + result["domain"] = [("id", "in", self.job_ids.ids)] + result["context"] = {} + return result + + @api.model + def print_document_async( + self, record_ids, report_name, html=None, data=None, to_email="" + ): + """ Generate a document async, do not return the document file """ + user_email = to_email or self.env.user.email + report = self.env["ir.actions.report"]._get_report_from_name(report_name) + self.with_delay().run_report( + record_ids, + data or {}, + report.id, + self._uid, + email_notify=True, + to_email=user_email, + session_id=request.session.sid, + ) + + @api.model + def run_report( + self, + docids, + data, + report_id, + user_id, + email_notify=False, + to_email=None, + session_id=None, + ): + report = self.env["ir.actions.report"].browse(report_id) + func = REPORT_TYPES_FUNC[report.report_type] + if user_id: + report = report.with_user(user_id) + if session_id: + # necessary for correct CSS headers + with mock.patch("odoo.http.request.session") as session: + session.sid = session_id + out_file, file_ext = getattr(report, func)(docids, data) + else: + out_file, file_ext = getattr(report, func)(docids, data) + # Run report + out_file = base64.b64encode(out_file) + out_name = "{}.{}".format(report.name, file_ext) + _logger.info("ASYNC GENERATION OF REPORT %s", (out_name,)) + # Save report to attachment + attachment = ( + self.env["ir.attachment"] + .sudo() + .create( + { + "name": out_name, + "datas": out_file, + "type": "binary", + "res_model": "report.async", + "res_id": self.id, + } + ) + ) + self._cr.execute( + """ + UPDATE ir_attachment SET create_uid = %s, write_uid = %s + WHERE id = %s""", + (self._uid, self._uid, attachment.id), + ) + # Send email + if email_notify or self.email_notify: + self._send_email(attachment, to_email=to_email) + + def _send_email(self, attachment, to_email=None): + template = self.env.ref("report_async.async_report_delivery") + email_values = {} + if to_email: + email_values = { + "recipient_ids": [], + "email_to": to_email, + } + template.send_mail( + attachment.id, + notif_layout="mail.mail_notification_light", + force_send=False, + email_values=email_values, + ) diff --git a/report_async/readme/CONTRIBUTORS.rst b/report_async/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000000..684dc95ac0 --- /dev/null +++ b/report_async/readme/CONTRIBUTORS.rst @@ -0,0 +1,14 @@ +* `Ecosoft `__: + + * Kitti U. + * Saran Lim. + * Tharathip Chaweewongphan + +* `Therp `__: + + - Nikos Tsirintanis + +* `Sunflower IT `__: + + * Tom Blauwendraat + * Kevin Kamau diff --git a/report_async/readme/DESCRIPTION.rst b/report_async/readme/DESCRIPTION.rst new file mode 100644 index 0000000000..3eadb1068e --- /dev/null +++ b/report_async/readme/DESCRIPTION.rst @@ -0,0 +1,22 @@ +The new menu "Report Center" is the central place to host your reports in one place. +From here, there are 2 ways to launch the report, + +1. Run Now - run report immediately as per normal. +2. Run Background - put the report execution to queue job. + +There are additional settings under *Reports* -> *Async Options* for specific reports using async options: + +- Async report - Whether the report should be async. +- Min of Records - How many records required to trigger async reports. +- Mail Recipient - This by defualt is the logged in user's email, but can be reconfigured in a popup dialog. + +By using the queue job, option 2 is great for long running report. +The report file will be saved for later use, with the option to send report +by email as soon as it is ready. + +Notes: + +* Only user with Technical Feature rights can manage the report. +* Every internal user will have right to execute the report allowed for his/her groups. +* The files created are owned and viewable only by the person who run the report. +* Job queue manager can also see all jobs for each reports. diff --git a/report_async/readme/USAGE.rst b/report_async/readme/USAGE.rst new file mode 100644 index 0000000000..9668d579d2 --- /dev/null +++ b/report_async/readme/USAGE.rst @@ -0,0 +1,19 @@ +Menu: Dashboard > Report Center + +As Technical Feature users, you can manage reports for Report Center. + +- **Report:** choose the report (a window action). Although the option show all window actions + it only make sense for window actions that launch reports. +- **Allow Async:** check this, if you want the report to run in background too, suitable for + report that return file as result, i.e., pdf/xlsx/csv/txt. +- **Email Notification:** if checked, once the background process is completed, email with link to download + report will be sent. +- **Groups:** select user groups allowed to use this report. If left blank, all user can use. + +As normal user, you can run your reports from Report Center + +- **Run Now button:** to run report immediately as per normal. +- **Run Background button:** to run report asynchronously. Fall back to run now, if not report that produce file. +- **Job Status:** show status of the latest run job. If job fail, exception error will also shown +- **Files:** show all files being produced by the job as run by the user. +- **Jobs:** show all jobs triggered by this report as run by the user. Only job queue manager have access to this button. diff --git a/report_async/security/ir.model.access.csv b/report_async/security/ir.model.access.csv new file mode 100644 index 0000000000..6e84086764 --- /dev/null +++ b/report_async/security/ir.model.access.csv @@ -0,0 +1,4 @@ +"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink" +access_report_async,report.async.user,model_report_async,base.group_user,1,0,0,0 +access_report_async_sudo,report.async.sudo,model_report_async,base.group_no_one,1,1,1,1 +access_print_report_wizard,print.report.wizard,model_print_report_wizard,base.group_user,1,1,1,1 diff --git a/report_async/security/ir_rule.xml b/report_async/security/ir_rule.xml new file mode 100644 index 0000000000..b551c92cba --- /dev/null +++ b/report_async/security/ir_rule.xml @@ -0,0 +1,25 @@ + + + + Report Async by Groups + + + + + + + ['|', ('group_ids', '=', False), ('group_ids', 'in', [g.id for g in user.groups_id])] + + + Report Async by Groups + + + + + + + [(1,'=', 1)] + + diff --git a/report_async/static/description/icon.png b/report_async/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/report_async/static/description/index.html b/report_async/static/description/index.html new file mode 100644 index 0000000000..93e45f5eb1 --- /dev/null +++ b/report_async/static/description/index.html @@ -0,0 +1,479 @@ + + + + + + +Report Async + + + +
+

Report Async

+ + +

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

+

The new menu “Report Center” is the central place to host your reports in one place. +From here, there are 2 ways to launch the report,

+
    +
  1. Run Now - run report immediately as per normal.
    2. +
  2. Run Background - put the report execution to queue job.
    3. +
+

There are additional settings under Reports -> Async Options for specific reports using async options:

+
    +
  • Async report - Whether the report should be async.
    • +
  • Min of Records - How many records required to trigger async reports.
    • +
  • Mail Recipient - This by defualt is the logged in user’s email, but can be reconfigured in a popup dialog.
    • +
+

By using the queue job, option 2 is great for long running report. +The report file will be saved for later use, with the option to send report +by email as soon as it is ready.

+

Notes:

+
    +
  • Only user with Technical Feature rights can manage the report.
    • +
  • Every internal user will have right to execute the report allowed for his/her groups.
    • +
  • The files created are owned and viewable only by the person who run the report.
    • +
  • Job queue manager can also see all jobs for each reports.
    • +
+

Table of contents

+ +
+

Usage

+

Menu: Dashboard > Report Center

+

As Technical Feature users, you can manage reports for Report Center.

+
    +
  • Report: choose the report (a window action). Although the option show all window actions +it only make sense for window actions that launch reports.
    • +
  • Allow Async: check this, if you want the report to run in background too, suitable for +report that return file as result, i.e., pdf/xlsx/csv/txt.
    • +
  • Email Notification: if checked, once the background process is completed, email with link to download +report will be sent.
    • +
  • Groups: select user groups allowed to use this report. If left blank, all user can use.
    • +
+

As normal user, you can run your reports from Report Center

+
    +
  • Run Now button: to run report immediately as per normal.
    • +
  • Run Background button: to run report asynchronously. Fall back to run now, if not report that produce file.
    • +
  • Job Status: show status of the latest run job. If job fail, exception error will also shown
    • +
  • Files: show all files being produced by the job as run by the user.
    • +
  • Jobs: show all jobs triggered by this report as run by the user. Only job queue manager have access to this button.
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Ecosoft
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

Current maintainer:

+

kittiu

+

This module is part of the OCA/reporting-engine project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/report_async/static/src/js/components/action_menus.js b/report_async/static/src/js/components/action_menus.js new file mode 100644 index 0000000000..c20862def4 --- /dev/null +++ b/report_async/static/src/js/components/action_menus.js @@ -0,0 +1,123 @@ +odoo.define("report_async.ActionMenus", function (require) { + "use strict"; + + const {patch} = require("web.utils"); + const ActionMenus = require("web.ActionMenus"); + const Dialog = require("web.Dialog"); + const Core = require("web.core"); + const Framework = require("web.framework"); + + const _t = Core._t; + const QWeb = Core.qweb; + + function validate_email(email) { + const res = email.match( + /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z-0-9]+.)+[a-zA-Z]{2,}))$/ + ); + if (!res) { + return false; + } + return true; + } + // Patch _executeAction to use Dialog + patch(ActionMenus, "async _super report_async.ActionMenus", { + async _executeAction(action) { + const self = this; + const _super = this._super; + const args = arguments; + const records = this.props.activeIds; + var $content = $(QWeb.render("ReportAsyncConfiguration", {})); + + if (action.async_report && records.length >= action.async_no_records) { + const asyncDialog = new Dialog(self, { + title: + _t("Async Report Configuration ") + + "(" + + action.display_name + + ")", + size: "medium", + buttons: [ + { + text: _t("Print"), + classes: "btn-primary", + close: true, + click: function () { + const is_report_async = this.$( + "#async_report_checker" + ).prop("checked"); + const user_email = this.$("#async-user-email").val(); + if (user_email !== "" && is_report_async) { + // Try basic email validation + if (validate_email(user_email)) { + if ( + "report_type" in action && + action.report_type === "qweb-pdf" + ) { + Framework.unblockUI(); + // Generate report async + self.rpc({ + model: "report.async", + method: "print_document_async", + args: [records, action.report_name], + kwargs: { + to_email: user_email, + data: action.data || {}, + context: action.context || {}, + }, + }) + .then(() => { + const msg = + _t( + "Job started to generate report. Upon " + + "completion, mail sent to:" + ) + user_email; + Dialog.alert(self, msg, { + title: _t("Report"), + }); + }) + .catch(() => { + const error = _t( + "Failed, error on job creation." + ); + const title = _t("Report"); + Dialog.alert(self, error, { + title: title, + }); + }); + } else { + // Default to normal approach to generate report + return _super.apply(self, args); + } + } else { + const msg = _t( + "Please check your email syntax and try again" + ); + const title = _t("Email Validation Error"); + Dialog.alert(self, msg, {title: title}); + } + } else { + // Default to normal approach to generate report + return _super.apply(self, args); + } + }, + }, + { + text: _t("Discard"), + close: true, + }, + ], + $content: $content, + }); + // Default current user mail + asyncDialog.open().opened(function () { + asyncDialog.$el + .find("#async-user-email") + .val(action.async_mail_recipient); + }); + } else { + // Default to normal approach to generate report + return _super.apply(this, arguments); + } + }, + }); +}); diff --git a/report_async/static/src/xml/report_async.xml b/report_async/static/src/xml/report_async.xml new file mode 100644 index 0000000000..291e562cd1 --- /dev/null +++ b/report_async/static/src/xml/report_async.xml @@ -0,0 +1,40 @@ + + + +
+ +
+
+ + +
+ + Checker enables async report to be created on the background + via queue job and sent to a below email address. + +
+ +
+ + + + Email will be used to send the async report after queue job + is done on the background + +
+
+ + diff --git a/report_async/tests/__init__.py b/report_async/tests/__init__.py new file mode 100644 index 0000000000..86bbfd13b2 --- /dev/null +++ b/report_async/tests/__init__.py @@ -0,0 +1 @@ +from . import test_report_async diff --git a/report_async/tests/test_report_async.py b/report_async/tests/test_report_async.py new file mode 100644 index 0000000000..545a363606 --- /dev/null +++ b/report_async/tests/test_report_async.py @@ -0,0 +1,55 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) +from odoo.exceptions import UserError +from odoo.tests import common +from odoo.tests.common import Form + + +class TestJobChannel(common.TransactionCase): + def setUp(self): + super(TestJobChannel, self).setUp() + self.print_doc = self.env.ref("report_async.report_async_print_document") + self.test_rec = self.env.ref("base.module_mail") + self.test_rpt = self.env.ref("base.ir_module_reference_print") + + def _print_wizard(self, res): + obj = self.env[res["res_model"]] + ctx = { + "active_model": self.print_doc._name, + "active_id": self.print_doc.id, + } + ctx.update(res["context"]) + with Form(obj.with_context(ctx)) as form: + form.reference = "{},{}".format(self.test_rec._name, self.test_rec.id) + form.action_report_id = self.test_rpt + print_wizard = form.save() + return print_wizard + + def test_1_run_now(self): + """Run now will return report action as normal""" + res = self.print_doc.run_now() + report_action = self._print_wizard(res).print_report() + self.assertEquals(report_action["type"], "ir.actions.report") + + def test_2_run_async(self): + """Run background will return nothing, job started""" + with self.assertRaises(UserError): + self.print_doc.run_async() + self.print_doc.write({"allow_async": True, "email_notify": True}) + res = self.print_doc.run_async() + print_wizard = self._print_wizard(res) + report_action = print_wizard.print_report() + self.assertEquals(report_action, {}) # Do not run report yet + self.assertEquals(self.print_doc.job_status, "pending") # Job started + # Test produce file (as queue will not run in test mode) + docids = [print_wizard.reference.id] + data = None + report_id = self.test_rpt.id + user_id = self.env.user.id + self.print_doc.run_report(docids, data, report_id, user_id) + # Check name of the newly producted file + # Note: on env with test-enable, always fall back to render_qweb_html + self.assertIn(self.test_rpt.name, self.print_doc.file_ids[0].name) + # View fileds/jobs + self.print_doc.view_files() + self.print_doc.view_jobs() diff --git a/report_async/views/assets.xml b/report_async/views/assets.xml new file mode 100644 index 0000000000..a66e488f4b --- /dev/null +++ b/report_async/views/assets.xml @@ -0,0 +1,15 @@ + + +