vassili/seitime-frappe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

feat: provision to enable/disable prepared report from permission for page and report document (#6831)

Browse source 
* feat: provision to enable/disable prepared report from permission for page and report document

* Added progress bar in the report

* Removed cache and fixed message

* Show progress bar if execution time is greater than 2 seconds
This commit is contained in:
rohitwaghchaure 2019-01-30 12:25:29 +05:30 • committed by Rushabh Mehta
parent f5ded9fd56
commit e458d7d0a7
7 changed files with 210 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
frappe/core/doctype/report/report.json
View file

@ -1,5 +1,6 @@
{
"allow_copy": 0,
"allow_events_in_timeline": 0,
"allow_guest_to_view": 0,
"allow_import": 0,
"allow_rename": 0,
@ -42,7 +43,7 @@
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
"unique": 1
},
{
"allow_bulk_edit": 0,
@ -562,7 +563,7 @@
"bold": 0,
"collapsible": 0,
"columns": 0,
"fieldname": "prepared_report",
"fieldname": "disable_prepared_report",
"fieldtype": "Check",
"hidden": 0,
"ignore_user_permissions": 0,
@ -571,15 +572,47 @@
"in_global_search": 0,
"in_list_view": 0,
"in_standard_filter": 0,
"label": "Disable Prepared Report",
"length": 0,
"no_copy": 0,
"permlevel": 0,
"precision": "",
"print_hide": 0,
"print_hide_if_no_value": 0,
"read_only": 0,
"remember_last_selected_value": 0,
"report_hide": 0,
"reqd": 0,
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
},
{
"allow_bulk_edit": 0,
"allow_in_quick_entry": 0,
"allow_on_submit": 0,
"bold": 0,
"collapsible": 0,
"columns": 0,
"fieldname": "prepared_report",
"fieldtype": "Check",
"hidden": 1,
"ignore_user_permissions": 0,
"ignore_xss_filter": 0,
"in_filter": 0,
"in_global_search": 0,
"in_list_view": 0,
"in_standard_filter": 0,
"label": "Prepared Report",
"length": 0,
"no_copy": 0,
"options": "Yes\nNo",
"options": "",
"permlevel": 0,
"precision": "",
"print_hide": 0,
"print_hide_if_no_value": 0,
"read_only": 0,
"read_only": 1,
"remember_last_selected_value": 0,
"report_hide": 0,
"reqd": 0,
@ -600,7 +633,7 @@
"issingle": 0,
"istable": 0,
"max_attachments": 0,
"modified": "2018-06-27 14:48:49.989952",
"modified": "2019-01-25 12:04:50.833264",
"modified_by": "Administrator",
"module": "Core",
"name": "Report",

5
frappe/core/doctype/report/report.py
View file

@ -193,3 +193,8 @@ class Report(Document):
@Document.whitelist
def toggle_disable(self, disable):
self.db_set("disabled", cint(disable))
@frappe.whitelist()
def is_prepared_report_disabled(report):
return frappe.db.get_value('Report',
report, 'disable_prepared_report') or 0

24
frappe/core/doctype/role_permission_for_page_and_report/role_permission_for_page_and_report.js
View file

@ -9,10 +9,14 @@ frappe.ui.form.on('Role Permission for Page and Report', {
refresh: function(frm) {
frm.disable_save();
frm.role_area.hide();
frm.add_custom_button(__("Reset to defaults"),
function(){ frm.trigger("reset_roles") });
frm.add_custom_button(__("Update"),
function(){ frm.trigger("update_roles") }).addClass('btn-primary');
frm.add_custom_button(__("Reset to defaults"), function() {
frm.trigger("reset_roles");
});
frm.add_custom_button(__("Update"), function() {
frm.trigger("update_report_page_data");
}).addClass('btn-primary');
},
onload: function(frm) {
@ -45,22 +49,22 @@ frappe.ui.form.on('Role Permission for Page and Report', {
page: function(frm) {
if(frm.doc.page) {
frm.trigger("get_roles")
frm.trigger("set_report_page_data");
}
},
report: function(frm){
if(frm.doc.report) {
frm.trigger("get_roles")
frm.trigger("set_report_page_data");
}
},
get_roles: function(frm) {
set_report_page_data: function(frm) {
frm.toggle_display('roles_html', true)
frm.role_area.show();
return frm.call({
method:"get_custom_roles",
method:"set_report_page_data",
doc: frm.doc,
callback: function(r) {
refresh_field('roles')
@ -69,14 +73,14 @@ frappe.ui.form.on('Role Permission for Page and Report', {
})
},
update_roles: function(frm) {
update_report_page_data: function(frm) {
frm.trigger("validate_mandatory_fields")
if(frm.roles_editor) {
frm.roles_editor.set_roles_in_table()
}
return frm.call({
method:"set_custom_roles",
method:"update_report_page_data",
doc: frm.doc,
callback: function(r) {
refresh_field('roles')

92
frappe/core/doctype/role_permission_for_page_and_report/role_permission_for_page_and_report.json
View file

@ -1,5 +1,6 @@
{
"allow_copy": 1,
"allow_events_in_timeline": 0,
"allow_guest_to_view": 0,
"allow_import": 0,
"allow_rename": 0,
@ -13,6 +14,8 @@
"engine": "InnoDB",
"fields": [
{
"allow_bulk_edit": 0,
"allow_in_quick_entry": 0,
"allow_on_submit": 0,
"bold": 0,
"collapsible": 0,
@ -24,7 +27,7 @@
"ignore_xss_filter": 0,
"in_filter": 0,
"in_global_search": 0,
"in_list_view": 0,
"in_list_view": 1,
"in_standard_filter": 0,
"label": "Set Role For",
"length": 0,
@ -40,9 +43,12 @@
"reqd": 1,
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
},
{
"allow_bulk_edit": 0,
"allow_in_quick_entry": 0,
"allow_on_submit": 0,
"bold": 0,
"collapsible": 0,
@ -71,9 +77,12 @@
"reqd": 0,
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
},
{
"allow_bulk_edit": 0,
"allow_in_quick_entry": 0,
"allow_on_submit": 0,
"bold": 0,
"collapsible": 0,
@ -102,9 +111,77 @@
"reqd": 0,
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
},
{
"allow_bulk_edit": 0,
"allow_in_quick_entry": 0,
"allow_on_submit": 0,
"bold": 0,
"collapsible": 0,
"columns": 0,
"fieldname": "column_break_4",
"fieldtype": "Column Break",
"hidden": 0,
"ignore_user_permissions": 0,
"ignore_xss_filter": 0,
"in_filter": 0,
"in_global_search": 0,
"in_list_view": 0,
"in_standard_filter": 0,
"length": 0,
"no_copy": 0,
"permlevel": 0,
"precision": "",
"print_hide": 0,
"print_hide_if_no_value": 0,
"read_only": 0,
"remember_last_selected_value": 0,
"report_hide": 0,
"reqd": 0,
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
},
{
"allow_bulk_edit": 0,
"allow_in_quick_entry": 0,
"allow_on_submit": 0,
"bold": 0,
"collapsible": 0,
"columns": 0,
"depends_on": "report",
"fetch_from": "",
"fieldname": "disable_prepared_report",
"fieldtype": "Check",
"hidden": 0,
"ignore_user_permissions": 0,
"ignore_xss_filter": 0,
"in_filter": 0,
"in_global_search": 0,
"in_list_view": 0,
"in_standard_filter": 0,
"label": "Disable Prepared Report",
"length": 0,
"no_copy": 0,
"permlevel": 0,
"precision": "",
"print_hide": 0,
"print_hide_if_no_value": 0,
"read_only": 0,
"remember_last_selected_value": 0,
"report_hide": 0,
"reqd": 0,
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
},
{
"allow_bulk_edit": 0,
"allow_in_quick_entry": 0,
"allow_on_submit": 0,
"bold": 0,
"collapsible": 0,
@ -131,9 +208,12 @@
"reqd": 0,
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
},
{
"allow_bulk_edit": 0,
"allow_in_quick_entry": 0,
"allow_on_submit": 0,
"bold": 0,
"collapsible": 0,
@ -161,9 +241,12 @@
"reqd": 0,
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
},
{
"allow_bulk_edit": 0,
"allow_in_quick_entry": 0,
"allow_on_submit": 0,
"bold": 0,
"collapsible": 0,
@ -191,6 +274,7 @@
"reqd": 0,
"search_index": 0,
"set_only_once": 0,
"translatable": 0,
"unique": 0
}
],
@ -204,7 +288,7 @@
"issingle": 1,
"istable": 0,
"max_attachments": 0,
"modified": "2017-03-11 02:35:32.369043",
"modified": "2019-01-25 12:08:57.250719",
"modified_by": "Administrator",
"module": "Core",
"name": "Role Permission for Page and Report",
@ -213,7 +297,6 @@
"permissions": [
{
"amend": 0,
"apply_user_permissions": 0,
"cancel": 0,
"create": 1,
"delete": 1,
@ -239,5 +322,6 @@
"sort_field": "modified",
"sort_order": "DESC",
"track_changes": 0,
"track_seen": 0
"track_seen": 0,
"track_views": 0
}

26
frappe/core/doctype/role_permission_for_page_and_report/role_permission_for_page_and_report.py
View file

@ -4,10 +4,15 @@
from __future__ import unicode_literals
import frappe
from frappe.core.doctype.report.report import is_prepared_report_disabled
from frappe.model.document import Document
class RolePermissionforPageandReport(Document):
def get_custom_roles(self):
def set_report_page_data(self):
self.set_custom_roles()
self.check_prepared_report_disabled()
def set_custom_roles(self):
args = self.get_args()
self.set('roles', [])
@ -19,7 +24,11 @@ class RolePermissionforPageandReport(Document):
roles = self.get_standard_roles()
self.set('roles', roles)
def check_prepared_report_disabled(self):
if self.report:
self.disable_prepared_report = is_prepared_report_disabled(self.report)
def get_standard_roles(self):
doctype = self.set_role_for
docname = self.page if self.set_role_for == 'Page' else self.report
@ -29,9 +38,14 @@ class RolePermissionforPageandReport(Document):
def reset_roles(self):
roles = self.get_standard_roles()
self.set('roles', roles)
self.set_custom_roles()
self.update_custom_roles()
self.update_disable_prepared_report()
def set_custom_roles(self):
def update_report_page_data(self):
self.update_custom_roles()
self.update_disable_prepared_report()
def update_custom_roles(self):
args = self.get_args()
name = frappe.db.get_value('Custom Role', args, "name")
@ -50,6 +64,10 @@ class RolePermissionforPageandReport(Document):
else:
frappe.get_doc(args).insert()
def update_disable_prepared_report(self):
if self.report:
frappe.db.set_value('Report', self.report, 'disable_prepared_report', self.disable_prepared_report)
def get_args(self, row=None):
name = self.page if self.set_role_for == 'Page' else self.report
check_for_field = self.set_role_for.replace(" ","_").lower()

16
frappe/desk/query_report.py
View file

@ -58,7 +58,7 @@ def generate_report_result(report, filters=None, user=None):
module = report.module or frappe.db.get_value("DocType", report.ref_doctype, "module")
if report.is_standard == "Yes":
method_name = get_report_module_dotted_path(module, report.name) + ".execute"
threshold = 60
threshold = 30
res = []
start_time = datetime.datetime.now()
@ -67,9 +67,13 @@ def generate_report_result(report, filters=None, user=None):
end_time = datetime.datetime.now()
if (end_time - start_time).seconds > threshold and not report.prepared_report:
execution_time = (end_time - start_time).seconds
if execution_time > threshold and not report.prepared_report:
report.db_set('prepared_report', 1)
frappe.cache().hset('report_execution_time', report.name, execution_time)
columns, result = res[0], res[1]
if len(res) > 2:
message = res[2]
@ -90,7 +94,8 @@ def generate_report_result(report, filters=None, user=None):
"message": message,
"chart": chart,
"data_to_be_printed": data_to_be_printed,
"status": status
"status": status,
"execution_time": frappe.cache().hget('report_execution_time', report.name) or 0
}
@frappe.whitelist()
@ -148,7 +153,8 @@ def get_script(report_name):
return {
"script": render_include(script),
"html_format": html_format
"html_format": html_format,
"execution_time": frappe.cache().hget('report_execution_time', report_name) or 0
}
@ -165,7 +171,7 @@ def run(report_name, filters=None, user=None):
result = None
if report.prepared_report:
if report.prepared_report and not report.disable_prepared_report:
if filters:
if isinstance(filters, string_types):
filters = json.loads(filters)

38
frappe/public/js/frappe/views/reports/query_report.js
View file

@ -51,7 +51,13 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
this.primary_action = null;
this.secondary_action = {
label: __('Refresh'),
action: () => this.refresh()
action: () => {
if(this.execution_time > 2) {
this.setup_progress_bar();
}
this.refresh();
}
};
// throttle refresh for 300ms
@ -84,7 +90,7 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
return;
}
if (this.report_name !== frappe.get_route()[1]) {
this.toggle_loading(true);
// this.toggle_loading(true);
// different report
this.load_report();
} else {
@ -106,6 +112,7 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
frappe.run_serially([
() => this.get_report_doc(),
() => this.get_report_settings(),
() => this.setup_progress_bar(),
() => this.setup_page_head(),
() => this.refresh_report(),
() => this.add_make_chart_button()
@ -155,12 +162,24 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
return frappe.after_ajax(() => {
this.report_settings = frappe.query_reports[this.report_name];
this.report_settings.html_format = r.message.html_format;
this.report_settings.execution_time = r.message.execution_time || 0;
});
});
return this._load_script;
}
setup_progress_bar() {
let seconds_elapsed = 0;
const execution_time = this.report_settings.execution_time < 10
? 10 : this.report_settings.execution_time;
this.interval = setInterval(function() {
seconds_elapsed += 1;
frappe.show_progress(__('Preparing Report'), seconds_elapsed, execution_time);
}, 1000);
}
setup_filters() {
this.clear_filters();
const { filters = [] } = this.report_settings;
@ -272,8 +291,10 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
})
}).then(r => {
let data = r.message;
this.hide_status();
clearInterval(this.interval);
this.execution_time = data.execution_time || 0.1;
if (data.prepared_report) {
this.prepared_report = true;
@ -308,6 +329,9 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
} else {
this.toggle_nothing_to_show(true);
}
this.show_footer_message();
frappe.hide_progress();
});
}
@ -953,7 +977,6 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
this.$status = $(`<div class="form-message text-muted small"></div>`)
.hide().insertAfter(page_form);
this.show_tip();
this.$chart = $('<div class="chart-wrapper">').hide().appendTo(this.page.main);
this.$report = $('<div class="report-wrapper">').appendTo(this.page.main);
this.$message = $(this.message_div('')).hide().appendTo(this.page.main);
@ -967,9 +990,12 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
this.$status.hide();
}
show_tip() {
show_footer_message() {
const message = __('For comparison, use >5, <10 or =324. For ranges, use 5:10 (for values between 5 & 10).');
this.page.footer.removeClass('hide').addClass('text-muted text-center').html(`<p>${message}</p>`);
const execution_time_msg = __('Exection Time: {0} sec', [this.execution_time || 0.1]);
this.page.footer.removeClass('hide').addClass('text-muted col-md-12')
.html(`<span class="text-left col-md-6">${message}</span><span class="text-right col-md-6">${execution_time_msg}</span>`);
}
message_div(message) {