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

fix: allow filter values to be saved in custom report (#20623)

Browse source
This commit is contained in:
Anand Baburajan 2023-04-13 17:42:21 +05:30 • committed by GitHub
parent d635467c7e
commit b62bb8b0ec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 46 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -148,11 +148,13 @@
{
"collapsible": 1,
"collapsible_depends_on": "filters",
"depends_on": "eval:doc.report_type != \"Custom Report\"",
"fieldname": "filters_section",
"fieldtype": "Section Break",
"label": "Filters"
},
{
"depends_on": "eval:doc.report_type != \"Custom Report\"",
"fieldname": "filters",
"fieldtype": "Table",
"label": "Filters",
@ -161,11 +163,13 @@
{
"collapsible": 1,
"collapsible_depends_on": "columns",
"depends_on": "eval:doc.report_type != \"Custom Report\"",
"fieldname": "columns_section",
"fieldtype": "Section Break",
"label": "Columns"
},
{
"depends_on": "eval:doc.report_type != \"Custom Report\"",
"fieldname": "columns",
"fieldtype": "Table",
"label": "Columns",
@ -182,7 +186,7 @@
"idx": 1,
"index_web_pages_for_search": 1,
"links": [],
"modified": "2022-11-20 14:56:36.578412",
"modified": "2023-04-07 18:18:11.782178",
"modified_by": "Administrator",
"module": "Core",
"name": "Report",

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

@ -169,7 +169,7 @@ class Report(Document):
return columns, result
def run_query_report(self, filters, user, ignore_prepared_report=False):
def run_query_report(self, filters=None, user=None, ignore_prepared_report=False):
columns, result = [], []
data = frappe.desk.query_report.run(
self.name, filters=filters, user=user, ignore_prepared_report=ignore_prepared_report

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

@ -118,11 +118,10 @@ class TestReport(FrappeTestCase):
}
]
),
json.dumps({"user": "Administrator", "doctype": "User"}),
)
custom_report = frappe.get_doc("Report", custom_report_name)
columns, result = custom_report.run_query_report(
filters={"user": "Administrator", "doctype": "User"}, user=frappe.session.user
)
columns, result = custom_report.run_query_report(user=frappe.session.user)
self.assertListEqual(["email"], [column.get("fieldname") for column in columns])
admin_dict = frappe.core.utils.find(result, lambda d: d["name"] == "Administrator")

18
frappe/desk/query_report.py
View file

@ -15,12 +15,13 @@ from frappe.model.utils import render_include
from frappe.modules import get_module_path, scrub
from frappe.monitor import add_data_to_monitor
from frappe.permissions import get_role_permissions
from frappe.utils import cint, cstr, flt, format_duration, get_html_format
from frappe.utils import cint, cstr, flt, format_duration, get_html_format, sbool
def get_report_doc(report_name):
doc = frappe.get_doc("Report", report_name)
doc.custom_columns = []
doc.custom_filters = []
if doc.report_type == "Custom Report":
custom_report_doc = doc
@ -30,7 +31,8 @@ def get_report_doc(report_name):
if custom_report_doc.json:
data = json.loads(custom_report_doc.json)
if data:
doc.custom_columns = data["columns"]
doc.custom_columns = data.get("columns")
doc.custom_filters = data.get("filters")
doc.is_custom_report = True
if not doc.is_permitted():
@ -182,6 +184,7 @@ def run(
custom_columns=None,
is_tree=False,
parent_field=None,
are_default_filters=True,
):
report = get_report_doc(report_name)
if not user:
@ -194,6 +197,9 @@ def run(
result = None
if sbool(are_default_filters) and report.custom_filters:
filters = report.custom_filters
if report.prepared_report and not ignore_prepared_report and not custom_columns:
if filters:
if isinstance(filters, str):
@ -209,6 +215,9 @@ def run(
result["add_total_row"] = report.add_total_row and not result.get("skip_total_row", False)
if sbool(are_default_filters) and report.custom_filters:
result["custom_filters"] = report.custom_filters
return result
@ -463,7 +472,7 @@ def get_data_for_custom_report(columns):
@frappe.whitelist()
def save_report(reference_report, report_name, columns):
def save_report(reference_report, report_name, columns, filters):
report_doc = get_report_doc(reference_report)
docname = frappe.db.exists(
@ -479,6 +488,7 @@ def save_report(reference_report, report_name, columns):
report = frappe.get_doc("Report", docname)
existing_jd = json.loads(report.json)
existing_jd["columns"] = json.loads(columns)
existing_jd["filters"] = json.loads(filters)
report.update({"json": json.dumps(existing_jd, separators=(",", ":"))})
report.save()
frappe.msgprint(_("Report updated successfully"))
@ -489,7 +499,7 @@ def save_report(reference_report, report_name, columns):
{
"doctype": "Report",
"report_name": report_name,
"json": f'{{"columns":{columns}}}',
"json": f'{{"columns":{columns},"filters":{filters}}}',
"ref_doctype": report_doc.ref_doctype,
"is_standard": "No",
"report_type": "Custom Report",

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

@ -542,7 +542,7 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
if (this.prepared_report) {
this.reset_report_view();
} else if (!this._no_refresh) {
this.refresh();
this.refresh(true);
}
}
};
@ -598,10 +598,25 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
this.page.clear_fields();
}
refresh() {
refresh(have_filters_changed) {
this.toggle_message(true);
this.toggle_report(false);
let filters = this.get_filter_values(true);
// for custom reports,
// are_default_filters is true if the filters haven't been modified and for all filters,
// the filter value is the default value or there's no default value for the filter and the current value is empty.
// are_default_filters is false otherwise.
let are_default_filters = this.filters
.map((filter) => {
return (
!have_filters_changed &&
(filter.default === filter.value || (!filter.default && !filter.value))
);
})
.every((res) => res === true);
this.show_loading_screen();
// only one refresh at a time
@ -624,6 +639,7 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
filters: filters,
is_tree: this.report_settings.tree,
parent_field: this.report_settings.parent_field,
are_default_filters: are_default_filters,
},
callback: resolve,
always: () => this.page.btn_secondary.prop("disabled", false),
@ -636,6 +652,11 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
this.execution_time = data.execution_time || 0.1;
if (data.custom_filters) {
this.set_filters(data.custom_filters);
this.previous_filters = data.custom_filters;
}
if (data.prepared_report) {
this.prepared_report = true;
this.prepared_report_document = data.doc;
@ -1715,6 +1736,7 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList {
reference_report: this.report_name,
report_name: values.report_name,
columns: this.get_visible_columns(),
filters: this.get_filter_values(),
},
callback: function (r) {
this.show_save = false;