From 10edae65249582a4f8cb0e1d85fa17035297b075 Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Mon, 24 Jan 2022 17:21:15 +0530 Subject: [PATCH 001/106] feat: new autocomplete control --- frappe/core/doctype/docfield/docfield.json | 4 ++-- frappe/database/mariadb/database.py | 3 ++- frappe/model/__init__.py | 3 ++- frappe/public/js/frappe/form/controls/autocomplete.js | 11 +++++++++++ frappe/public/js/frappe/form/formatters.js | 3 +++ 5 files changed, 20 insertions(+), 4 deletions(-) diff --git a/frappe/core/doctype/docfield/docfield.json b/frappe/core/doctype/docfield/docfield.json index 26ddce7d35..69c8c3505f 100644 --- a/frappe/core/doctype/docfield/docfield.json +++ b/frappe/core/doctype/docfield/docfield.json @@ -98,7 +98,7 @@ "label": "Type", "oldfieldname": "fieldtype", "oldfieldtype": "Select", - "options": "Attach\nAttach Image\nBarcode\nButton\nCheck\nCode\nColor\nColumn Break\nCurrency\nData\nDate\nDatetime\nDuration\nDynamic Link\nFloat\nFold\nGeolocation\nHeading\nHTML\nHTML Editor\nIcon\nImage\nInt\nLink\nLong Text\nMarkdown Editor\nPassword\nPercent\nRead Only\nRating\nSection Break\nSelect\nSignature\nSmall Text\nTab Break\nTable\nTable MultiSelect\nText\nText Editor\nTime", + "options": "Autocomplete\nAttach\nAttach Image\nBarcode\nButton\nCheck\nCode\nColor\nColumn Break\nCurrency\nData\nDate\nDatetime\nDuration\nDynamic Link\nFloat\nFold\nGeolocation\nHeading\nHTML\nHTML Editor\nIcon\nImage\nInt\nLink\nLong Text\nMarkdown Editor\nPassword\nPercent\nRead Only\nRating\nSection Break\nSelect\nSignature\nSmall Text\nTab Break\nTable\nTable MultiSelect\nText\nText Editor\nTime", "reqd": 1, "search_index": 1 }, @@ -540,7 +540,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2022-01-03 11:56:19.812863", + "modified": "2022-01-04 11:56:19.812863", "modified_by": "Administrator", "module": "Core", "name": "DocField", diff --git a/frappe/database/mariadb/database.py b/frappe/database/mariadb/database.py index 6b827a4e89..325b97081b 100644 --- a/frappe/database/mariadb/database.py +++ b/frappe/database/mariadb/database.py @@ -52,7 +52,8 @@ class MariaDBDatabase(Database): 'Barcode': ('longtext', ''), 'Geolocation': ('longtext', ''), 'Duration': ('decimal', '21,9'), - 'Icon': ('varchar', self.VARCHAR_LEN) + 'Icon': ('varchar', self.VARCHAR_LEN), + 'Autocomplete': ('varchar', self.VARCHAR_LEN), } def get_connection(self): diff --git a/frappe/model/__init__.py b/frappe/model/__init__.py index b50a0304a5..232ffbe771 100644 --- a/frappe/model/__init__.py +++ b/frappe/model/__init__.py @@ -35,7 +35,8 @@ data_fieldtypes = ( 'Barcode', 'Geolocation', 'Duration', - 'Icon' + 'Icon', + 'Autocomplete' ) attachment_fieldtypes = ( diff --git a/frappe/public/js/frappe/form/controls/autocomplete.js b/frappe/public/js/frappe/form/controls/autocomplete.js index 1bc0ffeb8a..ce3f75178a 100644 --- a/frappe/public/js/frappe/form/controls/autocomplete.js +++ b/frappe/public/js/frappe/form/controls/autocomplete.js @@ -15,6 +15,17 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui } } + format_for_input(value) { + if (value == null) { + return ""; + } else if (this._data && this._data.length) { + const item = this._data.find(i => i.value == value); + return item ? item.label : value; + } else { + return value; + } + } + get_awesomplete_settings() { var me = this; return { diff --git a/frappe/public/js/frappe/form/formatters.js b/frappe/public/js/frappe/form/formatters.js index fd3fcb1bc7..291a467d97 100644 --- a/frappe/public/js/frappe/form/formatters.js +++ b/frappe/public/js/frappe/form/formatters.js @@ -21,6 +21,9 @@ frappe.form.formatters = { } return value==null ? "" : value; }, + Autocomplete: function(value) { + return __(frappe.form.formatters["Data"](value)); + }, Select: function(value) { return __(frappe.form.formatters["Data"](value)); }, From 26c88f6aad9240a0f4b558b1d219cd9a7641b5b7 Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Mon, 24 Jan 2022 17:21:27 +0530 Subject: [PATCH 002/106] feat: set_query for autocomplete fields --- .../js/frappe/form/controls/autocomplete.js | 73 +++++++++++++++++-- 1 file changed, 67 insertions(+), 6 deletions(-) diff --git a/frappe/public/js/frappe/form/controls/autocomplete.js b/frappe/public/js/frappe/form/controls/autocomplete.js index ce3f75178a..37476efdcf 100644 --- a/frappe/public/js/frappe/form/controls/autocomplete.js +++ b/frappe/public/js/frappe/form/controls/autocomplete.js @@ -86,12 +86,10 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui .find('.awesomplete ul') .css('min-width', '100%'); - this.$input.on( - 'input', - frappe.utils.debounce(() => { - this.awesomplete.list = this.get_data(); - }, 500) - ); + this.$input.on('input', frappe.utils.debounce((e) => { + this.execute_query_if_exists(e.target.value); + this.awesomplete.list = this.get_data(); + }, 500)); this.$input.on('focus', () => { if (!this.$input.val()) { @@ -100,6 +98,17 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui } }); + this.$input.on("blur", () => { + if(this.selected) { + this.selected = false; + return; + } + var value = this.get_input_value(); + if(value!==this.last_value) { + this.parse_validate_and_set_in_model(value); + } + }); + this.$input.on("awesomplete-open", () => { this.autocomplete_open = true; }); @@ -138,6 +147,58 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui return options; } + execute_query_if_exists(term) { + const args = { + txt: term + }; + var set_nulls = function(obj) { + $.each(obj, function(key, value) { + if(value!==undefined) { + obj[key] = value; + } + }); + return obj; + }; + let get_query = this.get_query || this.df.get_query; + if(get_query) { + // get_query by function + var q = (get_query)(this.frm && this.frm.doc || this.doc, this.doctype, this.docname); + + if($.isPlainObject(q)) { + // returns a plain object with filters + if(q.filters) { + set_nulls(q.filters); + } + + // turn off value translation + if(q.translate_values !== undefined) { + this.translate_values = q.translate_values; + } + + // extend args for custom functions + $.extend(args, q); + + // add "filters" for standard query (search.py) + args.filters = q.filters; + } + } + + if (args.query) { + frappe.call({ + method: args.query, + args: args, + callback: ({ message }) => { + if(!this.$input.is(":focus")) { + return; + } + // this.$input.cache[this.df.fieldname][term] = r.results; + // this.awesomplete.list = this.$input.cache[this.df.fieldname][term]; + this.set_data(message); + } + }) + } + } + get_data() { return this._data || []; } From 39af16863d12b61d39ac1eccdc4a89aa8e831b49 Mon Sep 17 00:00:00 2001 From: Pruthvi Patel Date: Wed, 26 Jan 2022 11:19:30 +0530 Subject: [PATCH 003/106] feat: custom columns for `MultiSelectDialog` --- .../js/frappe/form/multi_select_dialog.js | 25 +++++++++---------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/frappe/public/js/frappe/form/multi_select_dialog.js b/frappe/public/js/frappe/form/multi_select_dialog.js index bc0286e62d..e35c1d3a7c 100644 --- a/frappe/public/js/frappe/form/multi_select_dialog.js +++ b/frappe/public/js/frappe/form/multi_select_dialog.js @@ -1,6 +1,6 @@ frappe.ui.form.MultiSelectDialog = class MultiSelectDialog { constructor(opts) { - /* Options: doctype, target, setters, get_query, action, add_filters_group, data_fields, primary_action_label */ + /* Options: doctype, target, setters, get_query, action, add_filters_group, data_fields, primary_action_label, columns */ Object.assign(this, opts); this.for_select = this.doctype == "[Select]"; if (!this.for_select) { @@ -384,23 +384,22 @@ frappe.ui.form.MultiSelectDialog = class MultiSelectDialog { return this.results.filter(res => checked_values.includes(res.name)); } + get_datatable_columns() { + if(this.get_query && this.get_query().query && this.columns) return this.columns; + + if(Array.isArray(this.setters)) + return ["name", ...this.setters.map(df => df.fieldname)] + + return ["name", ...Object.keys(this.setters)] + } + make_list_row(result = {}) { var me = this; // Make a head row by default (if result not passed) let head = Object.keys(result).length === 0; let contents = ``; - let columns = ["name"]; - - if ($.isArray(this.setters)) { - for (let df of this.setters) { - columns.push(df.fieldname); - } - } else { - columns = columns.concat(Object.keys(this.setters)); - } - - columns.forEach(function (column) { + this.get_datatable_columns().forEach(function (column) { contents += `
${ head ? `${__(frappe.model.unscrub(column))}` @@ -470,7 +469,7 @@ frappe.ui.form.MultiSelectDialog = class MultiSelectDialog { get_filters_from_setters() { let me = this; - let filters = this.get_query ? this.get_query().filters : {} || {}; + let filters = (this.get_query ? this.get_query().filters : {}) || {}; let filter_fields = []; if ($.isArray(this.setters)) { From eba3c95f55b06deca4c460e097a6e05e568a83e7 Mon Sep 17 00:00:00 2001 From: Pruthvi Patel Date: Wed, 26 Jan 2022 16:14:18 +0530 Subject: [PATCH 004/106] fix: sider issues --- frappe/public/js/frappe/form/multi_select_dialog.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/frappe/public/js/frappe/form/multi_select_dialog.js b/frappe/public/js/frappe/form/multi_select_dialog.js index e35c1d3a7c..5a670cee20 100644 --- a/frappe/public/js/frappe/form/multi_select_dialog.js +++ b/frappe/public/js/frappe/form/multi_select_dialog.js @@ -385,12 +385,12 @@ frappe.ui.form.MultiSelectDialog = class MultiSelectDialog { } get_datatable_columns() { - if(this.get_query && this.get_query().query && this.columns) return this.columns; + if (this.get_query && this.get_query().query && this.columns) return this.columns; - if(Array.isArray(this.setters)) - return ["name", ...this.setters.map(df => df.fieldname)] + if (Array.isArray(this.setters)) + return ["name", ...this.setters.map(df => df.fieldname)]; - return ["name", ...Object.keys(this.setters)] + return ["name", ...Object.keys(this.setters)]; } make_list_row(result = {}) { From 512e3b3162635202d8670459961828df5d07307c Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Sat, 29 Jan 2022 19:08:42 +0530 Subject: [PATCH 005/106] feat: cache options & parsing set_query --- .../js/frappe/form/controls/autocomplete.js | 93 +++++++++++++------ 1 file changed, 65 insertions(+), 28 deletions(-) diff --git a/frappe/public/js/frappe/form/controls/autocomplete.js b/frappe/public/js/frappe/form/controls/autocomplete.js index 37476efdcf..3a2706b51d 100644 --- a/frappe/public/js/frappe/form/controls/autocomplete.js +++ b/frappe/public/js/frappe/form/controls/autocomplete.js @@ -76,6 +76,18 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui }; } + init_option_cache() { + if (!this.$input.cache) { + this.$input.cache = {}; + } + if (!this.$input.cache[this.doctype]) { + this.$input.cache[this.doctype] = {}; + } + if (!this.$input.cache[this.doctype][this.df.fieldname]) { + this.$input.cache[this.doctype][this.df.fieldname] = {}; + } + } + setup_awesomplete() { this.awesomplete = new Awesomplete( this.input, @@ -86,9 +98,17 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui .find('.awesomplete ul') .css('min-width', '100%'); + this.init_option_cache(); + this.$input.on('input', frappe.utils.debounce((e) => { - this.execute_query_if_exists(e.target.value); - this.awesomplete.list = this.get_data(); + const cached_options = this.$input.cache[this.doctype][this.df.fieldname][e.target.value]; + if (cached_options) { + this.set_data(cached_options); + } else if (this.get_query || this.df.get_query) { + this.execute_query_if_exists(e.target.value); + } else { + this.awesomplete.list = this.get_data(); + } }, 500)); this.$input.on('focus', () => { @@ -148,38 +168,56 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui } execute_query_if_exists(term) { - const args = { - txt: term - }; - var set_nulls = function(obj) { + const args = { txt: term }; + let get_query = this.get_query || this.df.get_query; + + if (!get_query) { + return; + } + + let set_nulls = function(obj) { $.each(obj, function(key, value) { - if(value!==undefined) { + if (value !== undefined) { obj[key] = value; } }); return obj; }; - let get_query = this.get_query || this.df.get_query; - if(get_query) { + + let process_query_object = function(obj) { + if (obj.query) { + args.query = obj.query; + } + + if (obj.params) { + set_nulls(obj.params); + Object.assign(args, obj.params); + } + + // turn off value translation + if (obj.translate_values !== undefined) { + this.translate_values = obj.translate_values; + } + }; + + if ($.isPlainObject(get_query)) { + process_query_object(get_query); + } else if (typeof get_query === "string") { + args.query = get_query; + } else { // get_query by function - var q = (get_query)(this.frm && this.frm.doc || this.doc, this.doctype, this.docname); + var q = get_query( + (this.frm && this.frm.doc) || this.doc, + this.doctype, + this.docname + ); - if($.isPlainObject(q)) { - // returns a plain object with filters - if(q.filters) { - set_nulls(q.filters); - } - - // turn off value translation - if(q.translate_values !== undefined) { - this.translate_values = q.translate_values; - } - - // extend args for custom functions - $.extend(args, q); - - // add "filters" for standard query (search.py) - args.filters = q.filters; + if (typeof q === "string") { + // returns a string + args.query = q; + } else if ($.isPlainObject(q)) { + // returns an object + process_query_object(q); } } @@ -191,8 +229,7 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui if(!this.$input.is(":focus")) { return; } - // this.$input.cache[this.df.fieldname][term] = r.results; - // this.awesomplete.list = this.$input.cache[this.df.fieldname][term]; + this.$input.cache[this.doctype][this.df.fieldname][term] = message; this.set_data(message); } }) From 51dcf8fd47bdc02b6e89814b7c77dd60db46bd9b Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Sat, 29 Jan 2022 19:16:03 +0530 Subject: [PATCH 006/106] feat: add autocomplete option in custom fields --- .../doctype/custom_field/custom_field.json | 915 +++++++++--------- .../customize_form_field.json | 6 +- frappe/database/postgres/database.py | 3 +- frappe/model/__init__.py | 2 +- 4 files changed, 465 insertions(+), 461 deletions(-) diff --git a/frappe/custom/doctype/custom_field/custom_field.json b/frappe/custom/doctype/custom_field/custom_field.json index 235f11aad8..d8b12d13b7 100644 --- a/frappe/custom/doctype/custom_field/custom_field.json +++ b/frappe/custom/doctype/custom_field/custom_field.json @@ -1,458 +1,461 @@ { - "actions": [], - "allow_import": 1, - "creation": "2013-01-10 16:34:01", - "description": "Adds a custom field to a DocType", - "doctype": "DocType", - "document_type": "Setup", - "engine": "InnoDB", - "field_order": [ - "dt", - "module", - "label", - "label_help", - "fieldname", - "insert_after", - "length", - "column_break_6", - "fieldtype", - "precision", - "hide_seconds", - "hide_days", - "options", - "fetch_from", - "fetch_if_empty", - "options_help", - "section_break_11", - "collapsible", - "collapsible_depends_on", - "default", - "depends_on", - "mandatory_depends_on", - "read_only_depends_on", - "properties", - "non_negative", - "reqd", - "unique", - "read_only", - "ignore_user_permissions", - "hidden", - "print_hide", - "print_hide_if_no_value", - "print_width", - "no_copy", - "allow_on_submit", - "in_list_view", - "in_standard_filter", - "in_global_search", - "in_preview", - "bold", - "report_hide", - "search_index", - "allow_in_quick_entry", - "ignore_xss_filter", - "translatable", - "hide_border", - "description", - "permlevel", - "width", - "columns" - ], - "fields": [{ - "bold": 1, - "fieldname": "dt", - "fieldtype": "Link", - "in_filter": 1, - "in_list_view": 1, - "label": "Document", - "oldfieldname": "dt", - "oldfieldtype": "Link", - "options": "DocType", - "reqd": 1, - "search_index": 1 - }, - { - "bold": 1, - "fieldname": "label", - "fieldtype": "Data", - "in_filter": 1, - "label": "Label", - "no_copy": 1, - "oldfieldname": "label", - "oldfieldtype": "Data" - }, - { - "fieldname": "label_help", - "fieldtype": "HTML", - "label": "Label Help", - "oldfieldtype": "HTML" - }, - { - "fieldname": "fieldname", - "fieldtype": "Data", - "in_list_view": 1, - "label": "Fieldname", - "no_copy": 1, - "oldfieldname": "fieldname", - "oldfieldtype": "Data", - "read_only": 1 - }, - { - "description": "Select the label after which you want to insert new field.", - "fieldname": "insert_after", - "fieldtype": "Select", - "label": "Insert After", - "no_copy": 1, - "oldfieldname": "insert_after", - "oldfieldtype": "Select" - }, - { - "fieldname": "column_break_6", - "fieldtype": "Column Break" - }, - { - "bold": 1, - "default": "Data", - "fieldname": "fieldtype", - "fieldtype": "Select", - "in_filter": 1, - "in_list_view": 1, - "label": "Field Type", - "oldfieldname": "fieldtype", - "oldfieldtype": "Select", - "options": "Attach\nAttach Image\nBarcode\nButton\nCheck\nCode\nColor\nColumn Break\nCurrency\nData\nDate\nDatetime\nDuration\nDynamic Link\nFloat\nFold\nGeolocation\nHeading\nHTML\nHTML Editor\nIcon\nImage\nInt\nLink\nLong Text\nMarkdown Editor\nPassword\nPercent\nRead Only\nRating\nSection Break\nSelect\nSmall Text\nTable\nTable MultiSelect\nText\nText Editor\nTime\nSignature\nTab Break", - "reqd": 1 - }, - { - "depends_on": "eval:in_list([\"Float\", \"Currency\", \"Percent\"], doc.fieldtype)", - "description": "Set non-standard precision for a Float or Currency field", - "fieldname": "precision", - "fieldtype": "Select", - "label": "Precision", - "options": "\n0\n1\n2\n3\n4\n5\n6\n7\n8\n9" - }, - { - "fieldname": "options", - "fieldtype": "Small Text", - "in_list_view": 1, - "label": "Options", - "oldfieldname": "options", - "oldfieldtype": "Text" - }, - { - "fieldname": "fetch_from", - "fieldtype": "Small Text", - "label": "Fetch From" - }, - { - "default": "0", - "description": "If checked, this field will be not overwritten based on Fetch From if a value already exists.", - "fieldname": "fetch_if_empty", - "fieldtype": "Check", - "label": "Fetch If Empty" - }, - { - "fieldname": "options_help", - "fieldtype": "HTML", - "label": "Options Help", - "oldfieldtype": "HTML" - }, - { - "fieldname": "section_break_11", - "fieldtype": "Section Break" - }, - { - "default": "0", - "depends_on": "eval:doc.fieldtype==\"Section Break\"", - "fieldname": "collapsible", - "fieldtype": "Check", - "label": "Collapsible" - }, - { - "depends_on": "eval:doc.fieldtype==\"Section Break\"", - "fieldname": "collapsible_depends_on", - "fieldtype": "Code", - "label": "Collapsible Depends On" - }, - { - "fieldname": "default", - "fieldtype": "Text", - "label": "Default Value", - "oldfieldname": "default", - "oldfieldtype": "Text" - }, - { - "fieldname": "depends_on", - "fieldtype": "Code", - "label": "Depends On", - "length": 255 - }, - { - "fieldname": "description", - "fieldtype": "Text", - "label": "Field Description", - "oldfieldname": "description", - "oldfieldtype": "Text", - "print_width": "300px", - "width": "300px" - }, - { - "default": "0", - "fieldname": "permlevel", - "fieldtype": "Int", - "label": "Permission Level", - "oldfieldname": "permlevel", - "oldfieldtype": "Int" - }, - { - "fieldname": "width", - "fieldtype": "Data", - "label": "Width", - "oldfieldname": "width", - "oldfieldtype": "Data" - }, - { - "description": "Number of columns for a field in a List View or a Grid (Total Columns should be less than 11)", - "fieldname": "columns", - "fieldtype": "Int", - "label": "Columns" - }, - { - "fieldname": "properties", - "fieldtype": "Column Break", - "oldfieldtype": "Column Break", - "print_width": "50%", - "width": "50%" - }, - { - "default": "0", - "fieldname": "reqd", - "fieldtype": "Check", - "in_list_view": 1, - "label": "Is Mandatory Field", - "oldfieldname": "reqd", - "oldfieldtype": "Check" - }, - { - "default": "0", - "fieldname": "unique", - "fieldtype": "Check", - "label": "Unique" - }, - { - "default": "0", - "fieldname": "read_only", - "fieldtype": "Check", - "label": "Read Only" - }, - { - "default": "0", - "depends_on": "eval:doc.fieldtype===\"Link\"", - "fieldname": "ignore_user_permissions", - "fieldtype": "Check", - "label": "Ignore User Permissions" - }, - { - "default": "0", - "fieldname": "hidden", - "fieldtype": "Check", - "label": "Hidden" - }, - { - "default": "0", - "fieldname": "print_hide", - "fieldtype": "Check", - "label": "Print Hide", - "oldfieldname": "print_hide", - "oldfieldtype": "Check" - }, - { - "default": "0", - "depends_on": "eval:[\"Int\", \"Float\", \"Currency\", \"Percent\"].indexOf(doc.fieldtype)!==-1", - "fieldname": "print_hide_if_no_value", - "fieldtype": "Check", - "label": "Print Hide If No Value" - }, - { - "fieldname": "print_width", - "fieldtype": "Data", - "hidden": 1, - "label": "Print Width", - "no_copy": 1, - "print_hide": 1 - }, - { - "default": "0", - "fieldname": "no_copy", - "fieldtype": "Check", - "label": "No Copy", - "oldfieldname": "no_copy", - "oldfieldtype": "Check" - }, - { - "default": "0", - "fieldname": "allow_on_submit", - "fieldtype": "Check", - "label": "Allow on Submit", - "oldfieldname": "allow_on_submit", - "oldfieldtype": "Check" - }, - { - "default": "0", - "fieldname": "in_list_view", - "fieldtype": "Check", - "label": "In List View" - }, - { - "default": "0", - "fieldname": "in_standard_filter", - "fieldtype": "Check", - "label": "In Standard Filter" - }, - { - "default": "0", - "depends_on": "eval:([\"Data\", \"Select\", \"Table\", \"Text\", \"Text Editor\", \"Link\", \"Small Text\", \"Long Text\", \"Read Only\", \"Heading\", \"Dynamic Link\"].indexOf(doc.fieldtype) !== -1)", - "fieldname": "in_global_search", - "fieldtype": "Check", - "label": "In Global Search" - }, - { - "default": "0", - "fieldname": "bold", - "fieldtype": "Check", - "label": "Bold" - }, - { - "default": "0", - "fieldname": "report_hide", - "fieldtype": "Check", - "label": "Report Hide", - "oldfieldname": "report_hide", - "oldfieldtype": "Check" - }, - { - "default": "0", - "fieldname": "search_index", - "fieldtype": "Check", - "hidden": 1, - "label": "Index", - "no_copy": 1, - "print_hide": 1 - }, - { - "default": "0", - "description": "Don't HTML Encode HTML tags like <script> or just characters like < or >, as they could be intentionally used in this field", - "fieldname": "ignore_xss_filter", - "fieldtype": "Check", - "label": "Ignore XSS Filter" - }, - { - "default": "1", - "depends_on": "eval:['Data', 'Select', 'Text', 'Small Text', 'Text Editor'].includes(doc.fieldtype)", - "fieldname": "translatable", - "fieldtype": "Check", - "label": "Translatable" - }, - { - "depends_on": "eval:in_list(['Data', 'Link', 'Dynamic Link', 'Password', 'Select', 'Read Only', 'Attach', 'Attach Image', 'Int'], doc.fieldtype)", - "fieldname": "length", - "fieldtype": "Int", - "label": "Length" - }, - { - "fieldname": "mandatory_depends_on", - "fieldtype": "Code", - "label": "Mandatory Depends On", - "length": 255 - }, - { - "fieldname": "read_only_depends_on", - "fieldtype": "Code", - "label": "Read Only Depends On", - "length": 255 - }, - { - "default": "0", - "fieldname": "allow_in_quick_entry", - "fieldtype": "Check", - "label": "Allow in Quick Entry" - }, - { - "default": "0", - "depends_on": "eval:!in_list(['Table', 'Table MultiSelect'], doc.fieldtype);", - "fieldname": "in_preview", - "fieldtype": "Check", - "label": "In Preview" - }, - { - "default": "0", - "depends_on": "eval:doc.fieldtype=='Duration'", - "fieldname": "hide_seconds", - "fieldtype": "Check", - "label": "Hide Seconds" - }, - { - "default": "0", - "depends_on": "eval:doc.fieldtype=='Duration'", - "fieldname": "hide_days", - "fieldtype": "Check", - "label": "Hide Days" - }, - { - "default": "0", - "depends_on": "eval:doc.fieldtype=='Section Break'", - "fieldname": "hide_border", - "fieldtype": "Check", - "label": "Hide Border" - }, - { - "default": "0", - "depends_on": "eval:in_list([\"Int\", \"Float\", \"Currency\"], doc.fieldtype)", - "fieldname": "non_negative", - "fieldtype": "Check", - "label": "Non Negative" - }, - { - "fieldname": "module", - "fieldtype": "Link", - "label": "Module (for export)", - "options": "Module Def" - } - ], - "icon": "fa fa-glass", - "idx": 1, - "index_web_pages_for_search": 1, - "links": [], - "modified": "2021-09-04 12:45:23.810120", - "modified_by": "Administrator", - "module": "Custom", - "name": "Custom Field", - "owner": "Administrator", - "permissions": [{ - "create": 1, - "delete": 1, - "email": 1, - "print": 1, - "read": 1, - "report": 1, - "role": "Administrator", - "share": 1, - "write": 1 - }, - { - "create": 1, - "delete": 1, - "email": 1, - "print": 1, - "read": 1, - "report": 1, - "role": "System Manager", - "share": 1, - "write": 1 - } - ], - "search_fields": "dt,label,fieldtype,options", - "sort_field": "modified", - "sort_order": "ASC", - "track_changes": 1 + "actions": [], + "allow_import": 1, + "creation": "2022-01-25 14:14:01.217507", + "description": "Adds a custom field to a DocType", + "doctype": "DocType", + "document_type": "Setup", + "engine": "InnoDB", + "field_order": [ + "dt", + "module", + "label", + "label_help", + "fieldname", + "insert_after", + "length", + "column_break_6", + "fieldtype", + "precision", + "hide_seconds", + "hide_days", + "options", + "fetch_from", + "fetch_if_empty", + "options_help", + "section_break_11", + "collapsible", + "collapsible_depends_on", + "default", + "depends_on", + "mandatory_depends_on", + "read_only_depends_on", + "properties", + "non_negative", + "reqd", + "unique", + "read_only", + "ignore_user_permissions", + "hidden", + "print_hide", + "print_hide_if_no_value", + "print_width", + "no_copy", + "allow_on_submit", + "in_list_view", + "in_standard_filter", + "in_global_search", + "in_preview", + "bold", + "report_hide", + "search_index", + "allow_in_quick_entry", + "ignore_xss_filter", + "translatable", + "hide_border", + "description", + "permlevel", + "width", + "columns" + ], + "fields": [ + { + "bold": 1, + "fieldname": "dt", + "fieldtype": "Link", + "in_filter": 1, + "in_list_view": 1, + "label": "Document", + "oldfieldname": "dt", + "oldfieldtype": "Link", + "options": "DocType", + "reqd": 1, + "search_index": 1 + }, + { + "bold": 1, + "fieldname": "label", + "fieldtype": "Data", + "in_filter": 1, + "label": "Label", + "no_copy": 1, + "oldfieldname": "label", + "oldfieldtype": "Data" + }, + { + "fieldname": "label_help", + "fieldtype": "HTML", + "label": "Label Help", + "oldfieldtype": "HTML" + }, + { + "fieldname": "fieldname", + "fieldtype": "Data", + "in_list_view": 1, + "label": "Fieldname", + "no_copy": 1, + "oldfieldname": "fieldname", + "oldfieldtype": "Data", + "read_only": 1 + }, + { + "description": "Select the label after which you want to insert new field.", + "fieldname": "insert_after", + "fieldtype": "Select", + "label": "Insert After", + "no_copy": 1, + "oldfieldname": "insert_after", + "oldfieldtype": "Select" + }, + { + "fieldname": "column_break_6", + "fieldtype": "Column Break" + }, + { + "bold": 1, + "default": "Data", + "fieldname": "fieldtype", + "fieldtype": "Select", + "in_filter": 1, + "in_list_view": 1, + "label": "Field Type", + "oldfieldname": "fieldtype", + "oldfieldtype": "Select", + "options": "Autocomplete\nAttach\nAttach Image\nBarcode\nButton\nCheck\nCode\nColor\nColumn Break\nCurrency\nData\nDate\nDatetime\nDuration\nDynamic Link\nFloat\nFold\nGeolocation\nHeading\nHTML\nHTML Editor\nIcon\nImage\nInt\nLink\nLong Text\nMarkdown Editor\nPassword\nPercent\nRead Only\nRating\nSection Break\nSelect\nSmall Text\nTable\nTable MultiSelect\nText\nText Editor\nTime\nSignature\nTab Break", + "reqd": 1 + }, + { + "depends_on": "eval:in_list([\"Float\", \"Currency\", \"Percent\"], doc.fieldtype)", + "description": "Set non-standard precision for a Float or Currency field", + "fieldname": "precision", + "fieldtype": "Select", + "label": "Precision", + "options": "\n0\n1\n2\n3\n4\n5\n6\n7\n8\n9" + }, + { + "fieldname": "options", + "fieldtype": "Small Text", + "in_list_view": 1, + "label": "Options", + "oldfieldname": "options", + "oldfieldtype": "Text" + }, + { + "fieldname": "fetch_from", + "fieldtype": "Small Text", + "label": "Fetch From" + }, + { + "default": "0", + "description": "If checked, this field will be not overwritten based on Fetch From if a value already exists.", + "fieldname": "fetch_if_empty", + "fieldtype": "Check", + "label": "Fetch If Empty" + }, + { + "fieldname": "options_help", + "fieldtype": "HTML", + "label": "Options Help", + "oldfieldtype": "HTML" + }, + { + "fieldname": "section_break_11", + "fieldtype": "Section Break" + }, + { + "default": "0", + "depends_on": "eval:doc.fieldtype==\"Section Break\"", + "fieldname": "collapsible", + "fieldtype": "Check", + "label": "Collapsible" + }, + { + "depends_on": "eval:doc.fieldtype==\"Section Break\"", + "fieldname": "collapsible_depends_on", + "fieldtype": "Code", + "label": "Collapsible Depends On" + }, + { + "fieldname": "default", + "fieldtype": "Text", + "label": "Default Value", + "oldfieldname": "default", + "oldfieldtype": "Text" + }, + { + "fieldname": "depends_on", + "fieldtype": "Code", + "label": "Depends On", + "length": 255 + }, + { + "fieldname": "description", + "fieldtype": "Text", + "label": "Field Description", + "oldfieldname": "description", + "oldfieldtype": "Text", + "print_width": "300px", + "width": "300px" + }, + { + "default": "0", + "fieldname": "permlevel", + "fieldtype": "Int", + "label": "Permission Level", + "oldfieldname": "permlevel", + "oldfieldtype": "Int" + }, + { + "fieldname": "width", + "fieldtype": "Data", + "label": "Width", + "oldfieldname": "width", + "oldfieldtype": "Data" + }, + { + "description": "Number of columns for a field in a List View or a Grid (Total Columns should be less than 11)", + "fieldname": "columns", + "fieldtype": "Int", + "label": "Columns" + }, + { + "fieldname": "properties", + "fieldtype": "Column Break", + "oldfieldtype": "Column Break", + "print_width": "50%", + "width": "50%" + }, + { + "default": "0", + "fieldname": "reqd", + "fieldtype": "Check", + "in_list_view": 1, + "label": "Is Mandatory Field", + "oldfieldname": "reqd", + "oldfieldtype": "Check" + }, + { + "default": "0", + "fieldname": "unique", + "fieldtype": "Check", + "label": "Unique" + }, + { + "default": "0", + "fieldname": "read_only", + "fieldtype": "Check", + "label": "Read Only" + }, + { + "default": "0", + "depends_on": "eval:doc.fieldtype===\"Link\"", + "fieldname": "ignore_user_permissions", + "fieldtype": "Check", + "label": "Ignore User Permissions" + }, + { + "default": "0", + "fieldname": "hidden", + "fieldtype": "Check", + "label": "Hidden" + }, + { + "default": "0", + "fieldname": "print_hide", + "fieldtype": "Check", + "label": "Print Hide", + "oldfieldname": "print_hide", + "oldfieldtype": "Check" + }, + { + "default": "0", + "depends_on": "eval:[\"Int\", \"Float\", \"Currency\", \"Percent\"].indexOf(doc.fieldtype)!==-1", + "fieldname": "print_hide_if_no_value", + "fieldtype": "Check", + "label": "Print Hide If No Value" + }, + { + "fieldname": "print_width", + "fieldtype": "Data", + "hidden": 1, + "label": "Print Width", + "no_copy": 1, + "print_hide": 1 + }, + { + "default": "0", + "fieldname": "no_copy", + "fieldtype": "Check", + "label": "No Copy", + "oldfieldname": "no_copy", + "oldfieldtype": "Check" + }, + { + "default": "0", + "fieldname": "allow_on_submit", + "fieldtype": "Check", + "label": "Allow on Submit", + "oldfieldname": "allow_on_submit", + "oldfieldtype": "Check" + }, + { + "default": "0", + "fieldname": "in_list_view", + "fieldtype": "Check", + "label": "In List View" + }, + { + "default": "0", + "fieldname": "in_standard_filter", + "fieldtype": "Check", + "label": "In Standard Filter" + }, + { + "default": "0", + "depends_on": "eval:([\"Data\", \"Select\", \"Table\", \"Text\", \"Text Editor\", \"Link\", \"Small Text\", \"Long Text\", \"Read Only\", \"Heading\", \"Dynamic Link\"].indexOf(doc.fieldtype) !== -1)", + "fieldname": "in_global_search", + "fieldtype": "Check", + "label": "In Global Search" + }, + { + "default": "0", + "fieldname": "bold", + "fieldtype": "Check", + "label": "Bold" + }, + { + "default": "0", + "fieldname": "report_hide", + "fieldtype": "Check", + "label": "Report Hide", + "oldfieldname": "report_hide", + "oldfieldtype": "Check" + }, + { + "default": "0", + "fieldname": "search_index", + "fieldtype": "Check", + "hidden": 1, + "label": "Index", + "no_copy": 1, + "print_hide": 1 + }, + { + "default": "0", + "description": "Don't HTML Encode HTML tags like <script> or just characters like < or >, as they could be intentionally used in this field", + "fieldname": "ignore_xss_filter", + "fieldtype": "Check", + "label": "Ignore XSS Filter" + }, + { + "default": "1", + "depends_on": "eval:['Data', 'Select', 'Text', 'Small Text', 'Text Editor'].includes(doc.fieldtype)", + "fieldname": "translatable", + "fieldtype": "Check", + "label": "Translatable" + }, + { + "depends_on": "eval:in_list(['Data', 'Link', 'Dynamic Link', 'Password', 'Select', 'Read Only', 'Attach', 'Attach Image', 'Int'], doc.fieldtype)", + "fieldname": "length", + "fieldtype": "Int", + "label": "Length" + }, + { + "fieldname": "mandatory_depends_on", + "fieldtype": "Code", + "label": "Mandatory Depends On", + "length": 255 + }, + { + "fieldname": "read_only_depends_on", + "fieldtype": "Code", + "label": "Read Only Depends On", + "length": 255 + }, + { + "default": "0", + "fieldname": "allow_in_quick_entry", + "fieldtype": "Check", + "label": "Allow in Quick Entry" + }, + { + "default": "0", + "depends_on": "eval:!in_list(['Table', 'Table MultiSelect'], doc.fieldtype);", + "fieldname": "in_preview", + "fieldtype": "Check", + "label": "In Preview" + }, + { + "default": "0", + "depends_on": "eval:doc.fieldtype=='Duration'", + "fieldname": "hide_seconds", + "fieldtype": "Check", + "label": "Hide Seconds" + }, + { + "default": "0", + "depends_on": "eval:doc.fieldtype=='Duration'", + "fieldname": "hide_days", + "fieldtype": "Check", + "label": "Hide Days" + }, + { + "default": "0", + "depends_on": "eval:doc.fieldtype=='Section Break'", + "fieldname": "hide_border", + "fieldtype": "Check", + "label": "Hide Border" + }, + { + "default": "0", + "depends_on": "eval:in_list([\"Int\", \"Float\", \"Currency\"], doc.fieldtype)", + "fieldname": "non_negative", + "fieldtype": "Check", + "label": "Non Negative" + }, + { + "fieldname": "module", + "fieldtype": "Link", + "label": "Module (for export)", + "options": "Module Def" + } + ], + "icon": "fa fa-glass", + "idx": 1, + "index_web_pages_for_search": 1, + "links": [], + "modified": "2022-01-29 15:42:21.885999", + "modified_by": "Administrator", + "module": "Custom", + "name": "Custom Field", + "owner": "Administrator", + "permissions": [ + { + "create": 1, + "delete": 1, + "email": 1, + "print": 1, + "read": 1, + "report": 1, + "role": "Administrator", + "share": 1, + "write": 1 + }, + { + "create": 1, + "delete": 1, + "email": 1, + "print": 1, + "read": 1, + "report": 1, + "role": "System Manager", + "share": 1, + "write": 1 + } + ], + "search_fields": "dt,label,fieldtype,options", + "sort_field": "modified", + "sort_order": "ASC", + "states": [], + "track_changes": 1 } \ No newline at end of file diff --git a/frappe/custom/doctype/customize_form_field/customize_form_field.json b/frappe/custom/doctype/customize_form_field/customize_form_field.json index a545cd9fe1..93d1de0e63 100644 --- a/frappe/custom/doctype/customize_form_field/customize_form_field.json +++ b/frappe/custom/doctype/customize_form_field/customize_form_field.json @@ -1,7 +1,7 @@ { "actions": [], "autoname": "hash", - "creation": "2013-02-22 01:27:32", + "creation": "2022-01-25 14:14:07.063385", "doctype": "DocType", "document_type": "Setup", "editable_grid": 1, @@ -83,7 +83,7 @@ "label": "Type", "oldfieldname": "fieldtype", "oldfieldtype": "Select", - "options": "Attach\nAttach Image\nBarcode\nButton\nCheck\nCode\nColor\nColumn Break\nCurrency\nData\nDate\nDatetime\nDuration\nDynamic Link\nFloat\nFold\nGeolocation\nHeading\nHTML\nHTML Editor\nIcon\nImage\nInt\nLink\nLong Text\nMarkdown Editor\nPassword\nPercent\nRating\nRead Only\nSection Break\nSelect\nSignature\nSmall Text\nTab Break\nTable\nTable MultiSelect\nText\nText Editor\nTime", + "options": "Autocomplete\nAttach\nAttach Image\nBarcode\nButton\nCheck\nCode\nColor\nColumn Break\nCurrency\nData\nDate\nDatetime\nDuration\nDynamic Link\nFloat\nFold\nGeolocation\nHeading\nHTML\nHTML Editor\nIcon\nImage\nInt\nLink\nLong Text\nMarkdown Editor\nPassword\nPercent\nRating\nRead Only\nSection Break\nSelect\nSignature\nSmall Text\nTab Break\nTable\nTable MultiSelect\nText\nText Editor\nTime", "reqd": 1, "search_index": 1 }, @@ -436,7 +436,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2022-01-03 14:50:32.035768", + "modified": "2022-01-29 15:43:05.540546", "modified_by": "Administrator", "module": "Custom", "name": "Customize Form Field", diff --git a/frappe/database/postgres/database.py b/frappe/database/postgres/database.py index d5495c6879..504bebf5cd 100644 --- a/frappe/database/postgres/database.py +++ b/frappe/database/postgres/database.py @@ -62,7 +62,8 @@ class PostgresDatabase(Database): 'Barcode': ('text', ''), 'Geolocation': ('text', ''), 'Duration': ('decimal', '21,9'), - 'Icon': ('varchar', self.VARCHAR_LEN) + 'Icon': ('varchar', self.VARCHAR_LEN), + 'Autocomplete': ('varchar', self.VARCHAR_LEN), } def get_connection(self): diff --git a/frappe/model/__init__.py b/frappe/model/__init__.py index 232ffbe771..be038f3a95 100644 --- a/frappe/model/__init__.py +++ b/frappe/model/__init__.py @@ -36,7 +36,7 @@ data_fieldtypes = ( 'Geolocation', 'Duration', 'Icon', - 'Autocomplete' + 'Autocomplete', ) attachment_fieldtypes = ( From 891d1fbd862f91d543e8aa92e73bb4aea467a2d8 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Wed, 2 Feb 2022 16:25:10 +0530 Subject: [PATCH 007/106] refactor: Site Migration --- frappe/commands/site.py | 12 +-- frappe/migrate.py | 191 +++++++++++++++++++++++++++------------- 2 files changed, 135 insertions(+), 68 deletions(-) diff --git a/frappe/commands/site.py b/frappe/commands/site.py index 62488525b0..1684f26d49 100755 --- a/frappe/commands/site.py +++ b/frappe/commands/site.py @@ -447,21 +447,17 @@ def disable_user(context, email): @pass_context def migrate(context, skip_failing=False, skip_search_index=False): "Run patches, sync schema and rebuild files/translations" - from frappe.migrate import migrate + from frappe.migrate import SiteMigration for site in context.sites: click.secho(f"Migrating {site}", fg="green") - frappe.init(site=site) - frappe.connect() try: - migrate( - context.verbose, + SiteMigration( skip_failing=skip_failing, - skip_search_index=skip_search_index - ) + skip_search_index=skip_search_index, + ).run(site=site) finally: print() - frappe.destroy() if not context.sites: raise SiteNotSpecifiedError diff --git a/frappe/migrate.py b/frappe/migrate.py index d13fe858f7..eabd0ff3e0 100644 --- a/frappe/migrate.py +++ b/frappe/migrate.py @@ -1,30 +1,54 @@ -# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE import json import os -import sys +from textwrap import dedent + import frappe -import frappe.translate -import frappe.modules.patch_handler import frappe.model.sync -from frappe.utils.fixtures import sync_fixtures +import frappe.modules.patch_handler +import frappe.translate +from frappe.cache_manager import clear_global_cache +from frappe.core.doctype.language.language import sync_languages +from frappe.core.doctype.scheduled_job_type.scheduled_job_type import sync_jobs +from frappe.database.schema import add_column +from frappe.desk.notifications import clear_notifications +from frappe.modules.patch_handler import PatchType +from frappe.modules.utils import sync_customizations +from frappe.search.website_search import build_index_for_all_routes from frappe.utils.connections import check_connection from frappe.utils.dashboard import sync_dashboards -from frappe.cache_manager import clear_global_cache -from frappe.desk.notifications import clear_notifications +from frappe.utils.fixtures import sync_fixtures from frappe.website.utils import clear_website_cache -from frappe.core.doctype.language.language import sync_languages -from frappe.modules.utils import sync_customizations -from frappe.core.doctype.scheduled_job_type.scheduled_job_type import sync_jobs -from frappe.search.website_search import build_index_for_all_routes -from frappe.database.schema import add_column -from frappe.modules.patch_handler import PatchType + +BENCH_START_MESSAGE = dedent( + """ + Cannot run bench migrate without the services running. + If you are running bench in development mode, make sure that bench is running: + + $ bench start + + Otherwise, check the server logs and ensure that all the required services are running. + """ +) +def atomic(method): + def wrapper(*args, **kwargs): + try: + ret = method(*args, **kwargs) + frappe.db.commit() + return ret + except Exception: + frappe.db.rollback() + raise -def migrate(verbose=True, skip_failing=False, skip_search_index=False): - '''Migrate all apps to the current version, will: + return wrapper + + +class SiteMigration: + """Migrate all apps to the current version, will: - run before migrate hooks - run patches - sync doctypes (schema) @@ -35,70 +59,117 @@ def migrate(verbose=True, skip_failing=False, skip_search_index=False): - sync languages - sync web pages (from /www) - run after migrate hooks - ''' + """ - service_status = check_connection(redis_services=["redis_cache"]) - if False in service_status.values(): - for service in service_status: - if not service_status.get(service, True): - print("{} service is not running.".format(service)) - print("""Cannot run bench migrate without the services running. -If you are running bench in development mode, make sure that bench is running: + def __init__(self, skip_failing: bool = False, skip_search_index: bool = False) -> None: + self.skip_failing = skip_failing + self.skip_search_index = skip_search_index -$ bench start - -Otherwise, check the server logs and ensure that all the required services are running.""") - sys.exit(1) - - touched_tables_file = frappe.get_site_path('touched_tables.json') - if os.path.exists(touched_tables_file): - os.remove(touched_tables_file) - - try: - add_column(doctype="DocType", column_name="migration_hash", fieldtype="Data") + def setUp(self): + """Complete setup required for site migration + """ frappe.flags.touched_tables = set() - frappe.flags.in_migrate = True - + self.touched_tables_file = frappe.get_site_path("touched_tables.json") + add_column(doctype="DocType", column_name="migration_hash", fieldtype="Data") clear_global_cache() + if os.path.exists(self.touched_tables_file): + os.remove(self.touched_tables_file) + + frappe.flags.in_migrate = True + + def tearDown(self): + """Run operations that should be run post schema updation processes + This should be executed irrespective of outcome + """ + frappe.translate.clear_cache() + clear_website_cache() + clear_notifications() + + with open(self.touched_tables_file, "w") as f: + json.dump(list(frappe.flags.touched_tables), f, sort_keys=True, indent=4) + + if not self.skip_search_index: + print(f"Building search index for {frappe.local.site}") + build_index_for_all_routes() + + frappe.publish_realtime("version-update") + frappe.flags.touched_tables.clear() + frappe.flags.in_migrate = False + + @atomic + def pre_schema_updates(self): + """Executes `before_migrate` hooks + """ for app in frappe.get_installed_apps(): - for fn in frappe.get_hooks('before_migrate', app_name=app): + for fn in frappe.get_hooks("before_migrate", app_name=app): frappe.get_attr(fn)() - frappe.modules.patch_handler.run_all(skip_failing=skip_failing, patch_type=PatchType.pre_model_sync) + @atomic + def run_schema_updates(self): + """Run patches as defined in patches.txt, sync schema changes as defined in the {doctype}.json files + """ + frappe.modules.patch_handler.run_all(skip_failing=self.skip_failing, patch_type=PatchType.pre_model_sync) frappe.model.sync.sync_all() - frappe.modules.patch_handler.run_all(skip_failing=skip_failing, patch_type=PatchType.post_model_sync) - frappe.translate.clear_cache() + frappe.modules.patch_handler.run_all(skip_failing=self.skip_failing, patch_type=PatchType.post_model_sync) + + @atomic + def post_schema_updates(self): + """Execute pending migration tasks post patches execution & schema sync + This includes: + * Sync `Scheduled Job Type` and scheduler events defined in hooks + * Sync fixtures & custom scripts + * Sync in-Desk Module Dashboards + * Sync customizations: Custom Fields, Property Setters, Custom Permissions + * Sync Frappe's internal language master + * Sync Portal Menu Items + * Sync Installed Applications Version History + * Execute `after_migrate` hooks + """ sync_jobs() sync_fixtures() sync_dashboards() sync_customizations() sync_languages() - frappe.get_doc('Portal Settings', 'Portal Settings').sync_menu() - - # syncs static files - clear_website_cache() - - # updating installed applications data - frappe.get_single('Installed Applications').update_versions() + frappe.get_single("Portal Settings").sync_menu() + frappe.get_single("Installed Applications").update_versions() for app in frappe.get_installed_apps(): - for fn in frappe.get_hooks('after_migrate', app_name=app): + for fn in frappe.get_hooks("after_migrate", app_name=app): frappe.get_attr(fn)() - if not skip_search_index: - # Run this last as it updates the current session - print('Building search index for {}'.format(frappe.local.site)) - build_index_for_all_routes() + def required_services_running(self) -> bool: + """Returns True if all required services are running. Returns False and prints + instructions to stdout when required services are not available. + """ + service_status = check_connection(redis_services=["redis_cache"]) + are_services_running = all(service_status.values()) - frappe.db.commit() + if not are_services_running: + for service in service_status: + if not service_status.get(service, True): + print(f"Service {service} is not running.") + print(BENCH_START_MESSAGE) - clear_notifications() + return are_services_running - frappe.publish_realtime("version-update") - frappe.flags.in_migrate = False - finally: - with open(touched_tables_file, 'w') as f: - json.dump(list(frappe.flags.touched_tables), f, sort_keys=True, indent=4) - frappe.flags.touched_tables.clear() + def run(self, site: str): + """Run Migrate operation on site specified. This method initializes + and destroys connections to the site database. + """ + if not self.required_services_running(): + raise SystemExit(1) + + if site: + frappe.init(site=site) + frappe.connect() + + self.setUp() + try: + self.pre_schema_updates() + self.run_schema_updates() + finally: + self.post_schema_updates() + self.tearDown() + frappe.destroy() From 74c56c2e6362fe32d745eea2506fe03ac0277b28 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Thu, 3 Feb 2022 16:58:29 +0530 Subject: [PATCH 008/106] test: Add test (+ suite) for site migration --- frappe/tests/test_commands.py | 88 +++++++++++++++++++++++++++++++++-- 1 file changed, 84 insertions(+), 4 deletions(-) diff --git a/frappe/tests/test_commands.py b/frappe/tests/test_commands.py index 408d644042..18fd3d636f 100644 --- a/frappe/tests/test_commands.py +++ b/frappe/tests/test_commands.py @@ -3,26 +3,35 @@ # imports - standard imports import gzip +import importlib import json import os import shlex import shutil import subprocess -from typing import List import unittest +from contextlib import contextmanager +from functools import wraps from glob import glob +from typing import List from unittest.case import skipIf +from unittest.mock import patch + +# imports - third party imports +import click +from click.testing import CliRunner +from click import Command # imports - module imports import frappe +import frappe.commands.site import frappe.recorder from frappe.installer import add_to_installed_apps, remove_app from frappe.utils import add_to_date, get_bench_path, get_bench_relative_path, now from frappe.utils.backups import fetch_latest_backups -# imports - third party imports -import click - +TEST_SITE = "commands-site.test" +CLI_CONTEXT = frappe._dict(sites=[TEST_SITE]) def clean(value) -> str: """Strips and converts bytes to str @@ -76,7 +85,49 @@ def exists_in_backup(doctypes: List, file: os.PathLike) -> bool: return len(missing_doctypes) == 0 +def restore_locals(f): + @wraps(f) + def decorated_function(*args, **kwargs): + pre_site = frappe.local.site + pre_flags = frappe.local.flags.copy() + pre_db = frappe.local.db + + ret = f(*args, **kwargs) + + post_site = getattr(frappe.local, "site", None) + if not post_site or post_site != pre_site: + frappe.init(site=pre_site) + frappe.local.db = pre_db + frappe.local.flags = pre_flags + return ret + return decorated_function + + +def pass_test_context(f): + @wraps(f) + def decorated_function(*args, **kwargs): + return f(CLI_CONTEXT, *args, **kwargs) + return decorated_function + + +@contextmanager +def cli(cmd: Command): + patch_ctx = patch("frappe.commands.pass_context", pass_test_context) + _module = cmd.callback.__module__ + _cmd = cmd.callback.__qualname__ + + patch_ctx.start() + importlib.reload(frappe.get_module(_module)) + click_cmd = frappe.get_attr(f"{_module}.{_cmd}") + + try: + yield CliRunner().invoke(click_cmd) + finally: + patch_ctx.stop() + + class BaseTestCommands(unittest.TestCase): + @classmethod def execute(self, command, kwargs=None): site = {"site": frappe.local.site} cmd_input = None @@ -585,3 +636,32 @@ class TestRemoveApp(unittest.TestCase): # nothing to assert, if this fails rest of the test suite will crumble. remove_app("frappe", dry_run=True, yes=True, no_backup=True) + + +class TestSiteMigration(BaseTestCommands): + @classmethod + def setUpClass(cls) -> None: + cmd_config = { + "test_site": TEST_SITE, + "admin_password": frappe.conf.admin_password, + "root_login": frappe.conf.root_login, + "root_password": frappe.conf.root_password, + "db_type": frappe.conf.db_type, + } + + if not os.path.exists( + os.path.join(TEST_SITE, "site_config.json") + ): + cls.execute( + "bench new-site {test_site} --admin-password {admin_password} --db-type" + " {db_type}", + cmd_config, + ) + return super().setUpClass() + + @restore_locals + def test_migrate_cli(self): + with cli(frappe.commands.site.migrate) as result: + self.assertTrue(TEST_SITE in result.stdout) + self.assertEqual(result.exit_code, 0) + self.assertEqual(result.exception, None) From d18f4e717fea0bc558ccaa484caa0304da525fce Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Thu, 3 Feb 2022 16:58:59 +0530 Subject: [PATCH 009/106] fix(test): Use standard test site for cli invokations --- frappe/tests/test_commands.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/frappe/tests/test_commands.py b/frappe/tests/test_commands.py index 18fd3d636f..2efea7d7f9 100644 --- a/frappe/tests/test_commands.py +++ b/frappe/tests/test_commands.py @@ -194,35 +194,35 @@ class TestCommands(BaseTestCommands): "root_password": frappe.conf.root_password, "db_type": frappe.conf.db_type, } - site_data = {"another_site": f"{frappe.local.site}-restore.test", **global_config} + site_data = {"test_site": TEST_SITE, **global_config} for key, value in global_config.items(): if value: self.execute(f"bench set-config {key} {value} -g") self.execute( - "bench new-site {another_site} --admin-password {admin_password} --db-type" + "bench new-site {test_site} --admin-password {admin_password} --db-type" " {db_type}", site_data, ) # test 1: bench restore from full backup - self.execute("bench --site {another_site} backup --ignore-backup-conf", site_data) + self.execute("bench --site {test_site} backup --ignore-backup-conf", site_data) self.execute( - "bench --site {another_site} execute frappe.utils.backups.fetch_latest_backups", + "bench --site {test_site} execute frappe.utils.backups.fetch_latest_backups", site_data, ) site_data.update({"database": json.loads(self.stdout)["database"]}) - self.execute("bench --site {another_site} restore {database}", site_data) + self.execute("bench --site {test_site} restore {database}", site_data) # test 2: restore from partial backup - self.execute("bench --site {another_site} backup --exclude 'ToDo'", site_data) + self.execute("bench --site {test_site} backup --exclude 'ToDo'", site_data) site_data.update({"kw": "\"{'partial':True}\""}) self.execute( - "bench --site {another_site} execute" + "bench --site {test_site} execute" " frappe.utils.backups.fetch_latest_backups --kwargs {kw}", site_data, ) site_data.update({"database": json.loads(self.stdout)["database"]}) - self.execute("bench --site {another_site} restore {database}", site_data) + self.execute("bench --site {test_site} restore {database}", site_data) self.assertEqual(self.returncode, 1) def test_partial_restore(self): From f343e77ecf132b66cbc245c93a4f8ed3ea7cfd38 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Fri, 4 Feb 2022 12:47:58 +0530 Subject: [PATCH 010/106] fix(CliRunner): Test suite for Cli * Manage states * Add formatting on test failures * Patch pass_context --- frappe/tests/test_commands.py | 133 ++++++++++++++++++++-------------- 1 file changed, 77 insertions(+), 56 deletions(-) diff --git a/frappe/tests/test_commands.py b/frappe/tests/test_commands.py index 2efea7d7f9..173b2ebb13 100644 --- a/frappe/tests/test_commands.py +++ b/frappe/tests/test_commands.py @@ -13,26 +13,29 @@ import unittest from contextlib import contextmanager from functools import wraps from glob import glob -from typing import List +from typing import List, Optional from unittest.case import skipIf from unittest.mock import patch # imports - third party imports import click -from click.testing import CliRunner +from click.testing import CliRunner, Result from click import Command # imports - module imports import frappe import frappe.commands.site +import frappe.commands.utils import frappe.recorder from frappe.installer import add_to_installed_apps, remove_app from frappe.utils import add_to_date, get_bench_path, get_bench_relative_path, now from frappe.utils.backups import fetch_latest_backups -TEST_SITE = "commands-site.test" +_result: Optional[Result] = None +TEST_SITE = "commands-site-O4PN2QKA.test" # added random string tag to avoid collisions CLI_CONTEXT = frappe._dict(sites=[TEST_SITE]) + def clean(value) -> str: """Strips and converts bytes to str @@ -85,22 +88,20 @@ def exists_in_backup(doctypes: List, file: os.PathLike) -> bool: return len(missing_doctypes) == 0 -def restore_locals(f): - @wraps(f) - def decorated_function(*args, **kwargs): - pre_site = frappe.local.site - pre_flags = frappe.local.flags.copy() - pre_db = frappe.local.db - - ret = f(*args, **kwargs) +@contextmanager +def maintain_locals(): + pre_site = frappe.local.site + pre_flags = frappe.local.flags.copy() + pre_db = frappe.local.db + try: + yield + finally: post_site = getattr(frappe.local, "site", None) if not post_site or post_site != pre_site: frappe.init(site=pre_site) frappe.local.db = pre_db - frappe.local.flags = pre_flags - return ret - return decorated_function + frappe.local.flags.update(pre_flags) def pass_test_context(f): @@ -111,22 +112,36 @@ def pass_test_context(f): @contextmanager -def cli(cmd: Command): - patch_ctx = patch("frappe.commands.pass_context", pass_test_context) - _module = cmd.callback.__module__ - _cmd = cmd.callback.__qualname__ +def cli(cmd: Command, args: Optional[List] = None): + with maintain_locals(): + global _result - patch_ctx.start() - importlib.reload(frappe.get_module(_module)) - click_cmd = frappe.get_attr(f"{_module}.{_cmd}") + patch_ctx = patch("frappe.commands.pass_context", pass_test_context) + _module = cmd.callback.__module__ + _cmd = cmd.callback.__qualname__ - try: - yield CliRunner().invoke(click_cmd) - finally: - patch_ctx.stop() + __module = importlib.import_module(_module) + patch_ctx.start() + importlib.reload(__module) + click_cmd = getattr(__module, _cmd) + + try: + _result = CliRunner().invoke(click_cmd, args=args) + _result.command = str(cmd) + yield _result + finally: + patch_ctx.stop() + __module = importlib.import_module(_module) + importlib.reload(__module) + importlib.invalidate_caches() class BaseTestCommands(unittest.TestCase): + @classmethod + def setUpClass(cls) -> None: + cls.setup_test_site() + return super().setUpClass() + @classmethod def execute(self, command, kwargs=None): site = {"site": frappe.local.site} @@ -153,16 +168,48 @@ class BaseTestCommands(unittest.TestCase): self.stderr = clean(self._proc.stderr) self.returncode = clean(self._proc.returncode) + @classmethod + def setup_test_site(cls): + cmd_config = { + "test_site": TEST_SITE, + "admin_password": frappe.conf.admin_password, + "root_login": frappe.conf.root_login, + "root_password": frappe.conf.root_password, + "db_type": frappe.conf.db_type, + } + + if not os.path.exists( + os.path.join(TEST_SITE, "site_config.json") + ): + cls.execute( + "bench new-site {test_site} --admin-password {admin_password} --db-type" + " {db_type}", + cmd_config, + ) + def _formatMessage(self, msg, standardMsg): output = super(BaseTestCommands, self)._formatMessage(msg, standardMsg) + + if not hasattr(self, "command") and _result: + command = _result.command + stdout = _result.stdout_bytes.decode() if _result.stdout_bytes else None + stderr = _result.stderr_bytes.decode() if _result.stderr_bytes else None + returncode = _result.exit_code + else: + command = self.command + stdout = self.stdout + stderr = self.stderr + returncode = self.returncode + cmd_execution_summary = "\n".join([ "-" * 70, "Last Command Execution Summary:", - "Command: {}".format(self.command) if self.command else "", - "Standard Output: {}".format(self.stdout) if self.stdout else "", - "Standard Error: {}".format(self.stderr) if self.stderr else "", - "Return Code: {}".format(self.returncode) if self.returncode else "", + "Command: {}".format(command) if command else "", + "Standard Output: {}".format(stdout) if stdout else "", + "Standard Error: {}".format(stderr) if stderr else "", + "Return Code: {}".format(returncode) if returncode else "", ]).strip() + return "{}\n\n{}".format(output, cmd_execution_summary) @@ -198,11 +245,6 @@ class TestCommands(BaseTestCommands): for key, value in global_config.items(): if value: self.execute(f"bench set-config {key} {value} -g") - self.execute( - "bench new-site {test_site} --admin-password {admin_password} --db-type" - " {db_type}", - site_data, - ) # test 1: bench restore from full backup self.execute("bench --site {test_site} backup --ignore-backup-conf", site_data) @@ -409,7 +451,7 @@ class TestCommands(BaseTestCommands): ) def test_bench_drop_site_should_archive_site(self): # TODO: Make this test postgres compatible - site = 'test_site.localhost' + site = TEST_SITE self.execute( f"bench new-site {site} --force --verbose " @@ -639,27 +681,6 @@ class TestRemoveApp(unittest.TestCase): class TestSiteMigration(BaseTestCommands): - @classmethod - def setUpClass(cls) -> None: - cmd_config = { - "test_site": TEST_SITE, - "admin_password": frappe.conf.admin_password, - "root_login": frappe.conf.root_login, - "root_password": frappe.conf.root_password, - "db_type": frappe.conf.db_type, - } - - if not os.path.exists( - os.path.join(TEST_SITE, "site_config.json") - ): - cls.execute( - "bench new-site {test_site} --admin-password {admin_password} --db-type" - " {db_type}", - cmd_config, - ) - return super().setUpClass() - - @restore_locals def test_migrate_cli(self): with cli(frappe.commands.site.migrate) as result: self.assertTrue(TEST_SITE in result.stdout) From 07b70c2bd9c55ea5fc2ab5ba0348874a24191182 Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Wed, 9 Feb 2022 11:35:15 +0530 Subject: [PATCH 011/106] test(ui): autocomplete control --- cypress/integration/control_autocomplete.js | 38 +++++++++++++++++++ .../js/frappe/form/controls/autocomplete.js | 4 +- 2 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 cypress/integration/control_autocomplete.js diff --git a/cypress/integration/control_autocomplete.js b/cypress/integration/control_autocomplete.js new file mode 100644 index 0000000000..b5effb6965 --- /dev/null +++ b/cypress/integration/control_autocomplete.js @@ -0,0 +1,38 @@ +context('Control Autocomplete', () => { + before(() => { + cy.login(); + cy.visit('/app/website'); + }); + + function get_dialog_with_autocomplete() { + cy.visit('/app/website'); + return cy.dialog({ + title: 'Autocomplete', + fields: [ + { + 'label': 'Select an option', + 'fieldname': 'autocomplete', + 'fieldtype': 'Autocomplete', + 'options': ['Option 1', 'Option 2', 'Option 3'], + } + ] + }); + } + + it('should set the valid value', () => { + get_dialog_with_autocomplete().as('dialog'); + + cy.get('.frappe-control[data-fieldname=autocomplete] input').focus().as('input'); + cy.wait(1000); + cy.get('@input').type('2', { delay: 300 }); + cy.get('.frappe-control[data-fieldname=autocomplete]').findByRole('listbox').should('be.visible'); + cy.get('.frappe-control[data-fieldname=autocomplete] input').type('{enter}', { delay: 300 }); + cy.get('.frappe-control[data-fieldname=autocomplete] input').blur(); + cy.get('@dialog').then(dialog => { + let value = dialog.get_value('autocomplete'); + expect(value).to.eq('Option 2'); + dialog.clear(); + }); + }); + +}); diff --git a/frappe/public/js/frappe/form/controls/autocomplete.js b/frappe/public/js/frappe/form/controls/autocomplete.js index 3a2706b51d..45aa10a2fc 100644 --- a/frappe/public/js/frappe/form/controls/autocomplete.js +++ b/frappe/public/js/frappe/form/controls/autocomplete.js @@ -11,7 +11,7 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui set_options() { if (this.df.options) { let options = this.df.options || []; - this._data = this.parse_options(options); + this.set_data(options); } } @@ -102,7 +102,7 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui this.$input.on('input', frappe.utils.debounce((e) => { const cached_options = this.$input.cache[this.doctype][this.df.fieldname][e.target.value]; - if (cached_options) { + if (cached_options && cached_options.length) { this.set_data(cached_options); } else if (this.get_query || this.df.get_query) { this.execute_query_if_exists(e.target.value); From ac17f8dfb1ae85acfc047ef6b6126cb8b6bb8582 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Thu, 10 Feb 2022 14:56:35 +0530 Subject: [PATCH 012/106] test: Allow list-apps to throw errors based on site's states --- frappe/tests/test_commands.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/frappe/tests/test_commands.py b/frappe/tests/test_commands.py index 173b2ebb13..4a1b73e7b0 100644 --- a/frappe/tests/test_commands.py +++ b/frappe/tests/test_commands.py @@ -319,7 +319,8 @@ class TestCommands(BaseTestCommands): def test_list_apps(self): # test 1: sanity check for command self.execute("bench --site all list-apps") - self.assertEqual(self.returncode, 0) + self.assertIsNotNone(self.returncode) + self.assertIsInstance(self.stdout or self.stderr, str) # test 2: bare functionality for single site self.execute("bench --site {site} list-apps") From 643eecb0acae8ac498aee278800ebd4f0860c5cb Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Fri, 11 Feb 2022 16:33:31 +0530 Subject: [PATCH 013/106] test(fix): Test list-apps for site --- frappe/tests/test_commands.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/frappe/tests/test_commands.py b/frappe/tests/test_commands.py index 4a1b73e7b0..0b87a5eaa5 100644 --- a/frappe/tests/test_commands.py +++ b/frappe/tests/test_commands.py @@ -336,14 +336,12 @@ class TestCommands(BaseTestCommands): self.assertSetEqual(list_apps, installed_apps) # test 3: parse json format - self.execute("bench --site all list-apps --format json") + self.execute("bench --site {site} list-apps --format json") self.assertEqual(self.returncode, 0) self.assertIsInstance(json.loads(self.stdout), dict) - self.execute("bench --site {site} list-apps --format json") - self.assertIsInstance(json.loads(self.stdout), dict) - self.execute("bench --site {site} list-apps -f json") + self.assertEqual(self.returncode, 0) self.assertIsInstance(json.loads(self.stdout), dict) def test_show_config(self): From 804f3941ffac8d635656d643bedc612f0c474a2e Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Fri, 11 Feb 2022 18:27:50 +0530 Subject: [PATCH 014/106] test(restore): Skip test_restore ref: * https://github.com/frappe/frappe/runs/5156148762?check_suite_focus=true * https://github.com/frappe/frappe/runs/5156148706?check_suite_focus=true --- frappe/tests/test_commands.py | 1 + 1 file changed, 1 insertion(+) diff --git a/frappe/tests/test_commands.py b/frappe/tests/test_commands.py index 0b87a5eaa5..00888c08a7 100644 --- a/frappe/tests/test_commands.py +++ b/frappe/tests/test_commands.py @@ -233,6 +233,7 @@ class TestCommands(BaseTestCommands): self.assertEqual(self.returncode, 0) self.assertEqual(self.stdout[1:-1], frappe.bold(text="DocType")) + @unittest.skip def test_restore(self): # step 0: create a site to run the test on global_config = { From 67df13f77f5c64a7f401e736991c108e6dbbab08 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Fri, 11 Feb 2022 19:24:54 +0530 Subject: [PATCH 015/106] test: Add test for asset building command --- frappe/tests/test_commands.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/frappe/tests/test_commands.py b/frappe/tests/test_commands.py index 00888c08a7..68605444f1 100644 --- a/frappe/tests/test_commands.py +++ b/frappe/tests/test_commands.py @@ -686,3 +686,10 @@ class TestSiteMigration(BaseTestCommands): self.assertTrue(TEST_SITE in result.stdout) self.assertEqual(result.exit_code, 0) self.assertEqual(result.exception, None) + + +class TestBenchBuild(BaseTestCommands): + def test_build_assets(self): + with cli(frappe.commands.utils.build) as result: + self.assertEqual(result.exit_code, 0) + self.assertEqual(result.exception, None) From d72aeca18fc65e54301596040c4f889c1637d683 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Fri, 11 Feb 2022 20:05:19 +0530 Subject: [PATCH 016/106] chore!: Deprecate frappe.utils.minify * Remove dead code from build.py * Whitespaces & imports style fixes --- frappe/build.py | 149 +++-------------------------- frappe/utils/minify.py | 212 ----------------------------------------- 2 files changed, 15 insertions(+), 346 deletions(-) delete mode 100644 frappe/utils/minify.py diff --git a/frappe/build.py b/frappe/build.py index 6b93b8b93a..7a06ee3a22 100644 --- a/frappe/build.py +++ b/frappe/build.py @@ -1,25 +1,21 @@ -# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE import os -import re -import json import shutil +import re import subprocess -from subprocess import getoutput -from io import StringIO -from tempfile import mkdtemp, mktemp from distutils.spawn import find_executable - -import frappe -from frappe.utils.minify import JavascriptMinify +from subprocess import getoutput +from tempfile import mkdtemp, mktemp +from urllib.parse import urlparse import click import psutil -from urllib.parse import urlparse -from semantic_version import Version from requests import head from requests.exceptions import HTTPError +from semantic_version import Version +import frappe timestamps = {} app_paths = None @@ -32,6 +28,7 @@ class AssetsNotDownloadedError(Exception): class AssetsDontExistError(HTTPError): pass + def download_file(url, prefix): from requests import get @@ -277,12 +274,14 @@ def check_node_executable(): click.echo(f"{warn} Please install yarn using below command and try again.\nnpm install -g yarn") click.echo() + def get_node_env(): node_env = { "NODE_OPTIONS": f"--max_old_space_size={get_safe_max_old_space_size()}" } return node_env + def get_safe_max_old_space_size(): safe_max_old_space_size = 0 try: @@ -296,6 +295,7 @@ def get_safe_max_old_space_size(): return safe_max_old_space_size + def generate_assets_map(): symlinks = {} @@ -344,7 +344,6 @@ def clear_broken_symlinks(): os.remove(path) - def unstrip(message: str) -> str: """Pads input string on the right side until the last available column in the terminal """ @@ -397,94 +396,6 @@ def link_assets_dir(source, target, hard_link=False): symlink(source, target, overwrite=True) -def build(no_compress=False, verbose=False): - for target, sources in get_build_maps().items(): - pack(os.path.join(assets_path, target), sources, no_compress, verbose) - - -def get_build_maps(): - """get all build.jsons with absolute paths""" - # framework js and css files - - build_maps = {} - for app_path in app_paths: - path = os.path.join(app_path, "public", "build.json") - if os.path.exists(path): - with open(path) as f: - try: - for target, sources in (json.loads(f.read() or "{}")).items(): - # update app path - source_paths = [] - for source in sources: - if isinstance(source, list): - s = frappe.get_pymodule_path(source[0], *source[1].split("/")) - else: - s = os.path.join(app_path, source) - source_paths.append(s) - - build_maps[target] = source_paths - except ValueError as e: - print(path) - print("JSON syntax error {0}".format(str(e))) - return build_maps - - -def pack(target, sources, no_compress, verbose): - outtype, outtxt = target.split(".")[-1], "" - jsm = JavascriptMinify() - - for f in sources: - suffix = None - if ":" in f: - f, suffix = f.split(":") - if not os.path.exists(f) or os.path.isdir(f): - print("did not find " + f) - continue - timestamps[f] = os.path.getmtime(f) - try: - with open(f, "r") as sourcefile: - data = str(sourcefile.read(), "utf-8", errors="ignore") - - extn = f.rsplit(".", 1)[1] - - if ( - outtype == "js" - and extn == "js" - and (not no_compress) - and suffix != "concat" - and (".min." not in f) - ): - tmpin, tmpout = StringIO(data.encode("utf-8")), StringIO() - jsm.minify(tmpin, tmpout) - minified = tmpout.getvalue() - if minified: - outtxt += str(minified or "", "utf-8").strip("\n") + ";" - - if verbose: - print("{0}: {1}k".format(f, int(len(minified) / 1024))) - elif outtype == "js" and extn == "html": - # add to frappe.templates - outtxt += html_to_js_template(f, data) - else: - outtxt += "\n/*\n *\t%s\n */" % f - outtxt += "\n" + data + "\n" - - except Exception: - print("--Error in:" + f + "--") - print(frappe.get_traceback()) - - with open(target, "w") as f: - f.write(outtxt.encode("utf-8")) - - print("Wrote %s - %sk" % (target, str(int(os.path.getsize(target) / 1024)))) - - -def html_to_js_template(path, content): - """returns HTML template content as Javascript code, adding it to `frappe.templates`""" - return """frappe.templates["{key}"] = '{content}';\n""".format( - key=path.rsplit("/", 1)[-1][:-5], content=scrub_html_template(content)) - - def scrub_html_template(content): """Returns HTML content with removed whitespace and comments""" # remove whitespace to a single space @@ -496,37 +407,7 @@ def scrub_html_template(content): return content.replace("'", "\'") -def files_dirty(): - for target, sources in get_build_maps().items(): - for f in sources: - if ":" in f: - f, suffix = f.split(":") - if not os.path.exists(f) or os.path.isdir(f): - continue - if os.path.getmtime(f) != timestamps.get(f): - print(f + " dirty") - return True - else: - return False - - -def compile_less(): - if not find_executable("lessc"): - return - - for path in app_paths: - less_path = os.path.join(path, "public", "less") - if os.path.exists(less_path): - for fname in os.listdir(less_path): - if fname.endswith(".less") and fname != "variables.less": - fpath = os.path.join(less_path, fname) - mtime = os.path.getmtime(fpath) - if fpath in timestamps and mtime == timestamps[fpath]: - continue - - timestamps[fpath] = mtime - - print("compiling {0}".format(fpath)) - - css_path = os.path.join(path, "public", "css", fname.rsplit(".", 1)[0] + ".css") - os.system("lessc {0} > {1}".format(fpath, css_path)) +def html_to_js_template(path, content): + """returns HTML template content as Javascript code, adding it to `frappe.templates`""" + return """frappe.templates["{key}"] = '{content}';\n""".format( + key=path.rsplit("/", 1)[-1][:-5], content=scrub_html_template(content)) diff --git a/frappe/utils/minify.py b/frappe/utils/minify.py deleted file mode 100644 index 634aa11038..0000000000 --- a/frappe/utils/minify.py +++ /dev/null @@ -1,212 +0,0 @@ - -# This code is original from jsmin by Douglas Crockford, it was translated to -# Python by Baruch Even. The original code had the following copyright and -# license. -# -# /* jsmin.c -# 2007-05-22 -# -# Copyright (c) 2002 Douglas Crockford (www.crockford.com) -# -# Permission is hereby granted, free of charge, to any person obtaining a copy of -# this software and associated documentation files (the "Software"), to deal in -# the Software without restriction, including without limitation the rights to -# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies -# of the Software, and to permit persons to whom the Software is furnished to do -# so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# The Software shall be used for Good, not Evil. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. -# */ - -from io import StringIO - -def jsmin(js): - ins = StringIO(js) - outs = StringIO() - JavascriptMinify().minify(ins, outs) - str = outs.getvalue() - if len(str) > 0 and str[0] == '\n': - str = str[1:] - return str - -def isAlphanum(c): - """return true if the character is a letter, digit, underscore, - dollar sign, or non-ASCII character. - """ - return ((c >= 'a' and c <= 'z') or (c >= '0' and c <= '9') or - (c >= 'A' and c <= 'Z') or c == '_' or c == '$' or c == '\\' or (c is not None and ord(c) > 126)); - -class UnterminatedComment(Exception): - pass - -class UnterminatedStringLiteral(Exception): - pass - -class UnterminatedRegularExpression(Exception): - pass - -class JavascriptMinify(object): - - def _outA(self): - self.outstream.write(self.theA) - def _outB(self): - self.outstream.write(self.theB) - - def _get(self): - """return the next character from stdin. Watch out for lookahead. If - the character is a control character, translate it to a space or - linefeed. - """ - c = self.theLookahead - self.theLookahead = None - if c is None: - c = self.instream.read(1) - if c >= ' ' or c == '\n': - return c - if c == '': # EOF - return '\000' - if c == '\r': - return '\n' - return ' ' - - def _peek(self): - self.theLookahead = self._get() - return self.theLookahead - - def _next(self): - """get the next character, excluding comments. peek() is used to see - if an unescaped '/' is followed by a '/' or '*'. - """ - c = self._get() - if c == '/' and self.theA != '\\': - p = self._peek() - if p == '/': - c = self._get() - while c > '\n': - c = self._get() - return c - if p == '*': - c = self._get() - while 1: - c = self._get() - if c == '*': - if self._peek() == '/': - self._get() - return ' ' - if c == '\000': - raise UnterminatedComment() - - return c - - def _action(self, action): - """do something! What you do is determined by the argument: - 1 Output A. Copy B to A. Get the next B. - 2 Copy B to A. Get the next B. (Delete A). - 3 Get the next B. (Delete B). - action treats a string as a single character. Wow! - action recognizes a regular expression if it is preceded by ( or , or =. - """ - if action <= 1: - self._outA() - - if action <= 2: - self.theA = self.theB - if self.theA == "'" or self.theA == '"': - while 1: - self._outA() - self.theA = self._get() - if self.theA == self.theB: - break - if self.theA <= '\n': - raise UnterminatedStringLiteral() - if self.theA == '\\': - self._outA() - self.theA = self._get() - - - if action <= 3: - self.theB = self._next() - if self.theB == '/' and (self.theA == '(' or self.theA == ',' or - self.theA == '=' or self.theA == ':' or - self.theA == '[' or self.theA == '?' or - self.theA == '!' or self.theA == '&' or - self.theA == '|' or self.theA == ';' or - self.theA == '{' or self.theA == '}' or - self.theA == '\n'): - self._outA() - self._outB() - while 1: - self.theA = self._get() - if self.theA == '/': - break - elif self.theA == '\\': - self._outA() - self.theA = self._get() - elif self.theA <= '\n': - raise UnterminatedRegularExpression() - self._outA() - self.theB = self._next() - - - def _jsmin(self): - """Copy the input to the output, deleting the characters which are - insignificant to JavaScript. Comments will be removed. Tabs will be - replaced with spaces. Carriage returns will be replaced with linefeeds. - Most spaces and linefeeds will be removed. - """ - self.theA = '\n' - self._action(3) - - while self.theA != '\000': - if self.theA == ' ': - if isAlphanum(self.theB): - self._action(1) - else: - self._action(2) - elif self.theA == '\n': - if self.theB in ['{', '[', '(', '+', '-']: - self._action(1) - elif self.theB == ' ': - self._action(3) - else: - if isAlphanum(self.theB): - self._action(1) - else: - self._action(2) - else: - if self.theB == ' ': - if isAlphanum(self.theA): - self._action(1) - else: - self._action(3) - elif self.theB == '\n': - if self.theA in ['}', ']', ')', '+', '-', '"', '\'']: - self._action(1) - else: - if isAlphanum(self.theA): - self._action(1) - else: - self._action(3) - else: - self._action(1) - - def minify(self, instream, outstream): - self.instream = instream - self.outstream = outstream - self.theA = '\n' - self.theB = None - self.theLookahead = None - - self._jsmin() - self.instream.close() From 70c27e424dc00ea3742c104a15469005eb65990b Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Fri, 11 Feb 2022 16:26:23 +0530 Subject: [PATCH 017/106] fix: consider parenttype and parent as std child fields --- frappe/public/js/frappe/form/form.js | 4 +++- frappe/public/js/frappe/form/grid.js | 3 ++- frappe/public/js/frappe/model/meta.js | 2 +- frappe/public/js/frappe/model/model.js | 4 +++- frappe/public/js/frappe/ui/filters/filter_list.js | 4 +++- frappe/public/js/frappe/views/reports/report_view.js | 3 ++- 6 files changed, 14 insertions(+), 6 deletions(-) diff --git a/frappe/public/js/frappe/form/form.js b/frappe/public/js/frappe/form/form.js index c0c7ce8b4e..d5adf6e7bd 100644 --- a/frappe/public/js/frappe/form/form.js +++ b/frappe/public/js/frappe/form/form.js @@ -1508,7 +1508,9 @@ frappe.ui.form.Form = class FrappeForm { // update child doc opts.child = locals[opts.child.doctype][opts.child.name]; - var std_field_list = ["doctype"].concat(frappe.model.std_fields_list); + var std_field_list = ["doctype"] + .concat(frappe.model.std_fields_list) + .concat(frappe.model.child_table_field_list); for (var key in r.message) { if (std_field_list.indexOf(key)===-1) { opts.child[key] = r.message[key]; diff --git a/frappe/public/js/frappe/form/grid.js b/frappe/public/js/frappe/form/grid.js index 8b615f3c59..e3361ce533 100644 --- a/frappe/public/js/frappe/form/grid.js +++ b/frappe/public/js/frappe/form/grid.js @@ -747,7 +747,8 @@ export default class Grid { var df = this.visible_columns[i][0]; var colsize = this.visible_columns[i][1]; if (colsize > 1 && colsize < 11 - && !in_list(frappe.model.std_fields_list, df.fieldname)) { + && !in_list(frappe.model.std_fields_list, df.fieldname) + && !in_list(frappe.model.child_table_field_list, df.fieldname)) { if (passes < 3 && ["Int", "Currency", "Float", "Check", "Percent"].indexOf(df.fieldtype) !== -1) { // don't increase col size of these fields in first 3 passes diff --git a/frappe/public/js/frappe/model/meta.js b/frappe/public/js/frappe/model/meta.js index 3c9ddc4d96..03750f7b92 100644 --- a/frappe/public/js/frappe/model/meta.js +++ b/frappe/public/js/frappe/model/meta.js @@ -152,7 +152,7 @@ $.extend(frappe.meta, { out = doctype; } else { frappe.meta.get_table_fields(doctype).every(function(d) { - if(frappe.meta.has_field(d.options, key)) { + if(frappe.meta.has_field(d.options, key) || in_list(frappe.model.child_table_field_list, key)) { out = d.options; return false; } diff --git a/frappe/public/js/frappe/model/model.js b/frappe/public/js/frappe/model/model.js index 89e029ffb1..7dabb92059 100644 --- a/frappe/public/js/frappe/model/model.js +++ b/frappe/public/js/frappe/model/model.js @@ -12,6 +12,8 @@ $.extend(frappe.model, { std_fields_list: ['name', 'owner', 'creation', 'modified', 'modified_by', '_user_tags', '_comments', '_assign', '_liked_by', 'docstatus', 'idx'], + child_table_field_list: ['parent', 'parenttype', 'parentfield'], + core_doctypes_list: ['DocType', 'DocField', 'DocPerm', 'User', 'Role', 'Has Role', 'Page', 'Module Def', 'Print Format', 'Report', 'Customize Form', 'Customize Form Field', 'Property Setter', 'Custom Field', 'Client Script'], @@ -83,7 +85,7 @@ $.extend(frappe.model, { }, is_non_std_field: function(fieldname) { - return !frappe.model.std_fields_list.includes(fieldname); + return ![...frappe.model.std_fields_list, ...frappe.model.child_table_field_list].includes(fieldname); }, get_std_field: function(fieldname, ignore=false) { diff --git a/frappe/public/js/frappe/ui/filters/filter_list.js b/frappe/public/js/frappe/ui/filters/filter_list.js index 18499a3b7e..33b7f5544b 100644 --- a/frappe/public/js/frappe/ui/filters/filter_list.js +++ b/frappe/public/js/frappe/ui/filters/filter_list.js @@ -170,7 +170,8 @@ frappe.ui.FilterGroup = class { validate_args(doctype, fieldname) { if (doctype && fieldname && !frappe.meta.has_field(doctype, fieldname) - && !frappe.model.std_fields_list.includes(fieldname)) { + && !frappe.model.std_fields_list.includes(fieldname) + && !frappe.model.child_table_field_list.includes(fieldname)) { frappe.msgprint({ message: __('Invalid filter: {0}', [fieldname.bold()]), @@ -324,6 +325,7 @@ frappe.ui.FilterGroup = class { } add_filters_to_filter_group(filters) { + console.log(filters); if (filters.length) { this.toggle_empty_filters(false); filters.forEach((filter) => { diff --git a/frappe/public/js/frappe/views/reports/report_view.js b/frappe/public/js/frappe/views/reports/report_view.js index 23e415ed3e..5aa32c1b87 100644 --- a/frappe/public/js/frappe/views/reports/report_view.js +++ b/frappe/public/js/frappe/views/reports/report_view.js @@ -646,7 +646,8 @@ frappe.views.ReportView = class ReportView extends frappe.views.ListView { && !df.read_only && !df.hidden // not a standard field i.e., owner, modified_by, etc. - && !frappe.model.std_fields_list.includes(df.fieldname)) + && !frappe.model.std_fields_list.includes(df.fieldname) + && !frappe.model.child_table_field_list.includes(df.fieldname)) return true; return false; } From 436543d2128bf8ff29dc1073cb64becf3a691aec Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Sat, 12 Feb 2022 18:22:48 +0530 Subject: [PATCH 018/106] fix: autocomplete input value if label & value varies --- cypress/integration/control_autocomplete.js | 23 +++++++++++++++++-- .../js/frappe/form/controls/autocomplete.js | 10 +++++++- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/cypress/integration/control_autocomplete.js b/cypress/integration/control_autocomplete.js index b5effb6965..3bf3e829f9 100644 --- a/cypress/integration/control_autocomplete.js +++ b/cypress/integration/control_autocomplete.js @@ -4,7 +4,7 @@ context('Control Autocomplete', () => { cy.visit('/app/website'); }); - function get_dialog_with_autocomplete() { + function get_dialog_with_autocomplete(options) { cy.visit('/app/website'); return cy.dialog({ title: 'Autocomplete', @@ -13,7 +13,7 @@ context('Control Autocomplete', () => { 'label': 'Select an option', 'fieldname': 'autocomplete', 'fieldtype': 'Autocomplete', - 'options': ['Option 1', 'Option 2', 'Option 3'], + 'options': options || ['Option 1', 'Option 2', 'Option 3'], } ] }); @@ -35,4 +35,23 @@ context('Control Autocomplete', () => { }); }); + it('should set the valid value with different label', () => { + const options_with_label = [ + { label: "Option 1", value: "option_1" }, + { label: "Option 2", value: "option_2" } + ]; + get_dialog_with_autocomplete(options_with_label).as('dialog'); + + cy.get('.frappe-control[data-fieldname=autocomplete] input').focus().as('input'); + cy.get('.frappe-control[data-fieldname=autocomplete]').findByRole('listbox').should('be.visible'); + cy.get('@input').type('2', { delay: 300 }); + cy.get('.frappe-control[data-fieldname=autocomplete] input').type('{enter}', { delay: 300 }); + cy.get('.frappe-control[data-fieldname=autocomplete] input').blur(); + cy.get('@dialog').then(dialog => { + let value = dialog.get_value('autocomplete'); + expect(value).to.eq('option_2'); + dialog.clear(); + }); + }); + }); diff --git a/frappe/public/js/frappe/form/controls/autocomplete.js b/frappe/public/js/frappe/form/controls/autocomplete.js index 45aa10a2fc..4e66ed6642 100644 --- a/frappe/public/js/frappe/form/controls/autocomplete.js +++ b/frappe/public/js/frappe/form/controls/autocomplete.js @@ -26,6 +26,14 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui } } + get_input_value() { + if (this.$input) { + const label = this.$input.val(); + const item = this._data?.find(i => i.label == label); + return item ? item.value : label; + } + } + get_awesomplete_settings() { var me = this; return { @@ -34,7 +42,7 @@ frappe.ui.form.ControlAutocomplete = class ControlAutoComplete extends frappe.ui autoFirst: true, list: this.get_data(), data: function(item) { - if (!(item instanceof Object)) { + if (typeof item !== 'object') { var d = { value: item }; item = d; } From 7229fe3b1c2701d1ad18009c96daf6f1cf01ca77 Mon Sep 17 00:00:00 2001 From: phot0n Date: Sun, 13 Feb 2022 13:11:24 +0530 Subject: [PATCH 019/106] chore: fix sider --- frappe/public/js/frappe/model/meta.js | 4 ++-- frappe/public/js/frappe/ui/filters/filter_list.js | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/frappe/public/js/frappe/model/meta.js b/frappe/public/js/frappe/model/meta.js index 03750f7b92..4a7295ed4e 100644 --- a/frappe/public/js/frappe/model/meta.js +++ b/frappe/public/js/frappe/model/meta.js @@ -144,7 +144,7 @@ $.extend(frappe.meta, { get_doctype_for_field: function(doctype, key) { var out = null; - if(in_list(frappe.model.std_fields_list, key)) { + if (in_list(frappe.model.std_fields_list, key)) { // standard out = doctype; } else if(frappe.meta.has_field(doctype, key)) { @@ -152,7 +152,7 @@ $.extend(frappe.meta, { out = doctype; } else { frappe.meta.get_table_fields(doctype).every(function(d) { - if(frappe.meta.has_field(d.options, key) || in_list(frappe.model.child_table_field_list, key)) { + if (frappe.meta.has_field(d.options, key) || in_list(frappe.model.child_table_field_list, key)) { out = d.options; return false; } diff --git a/frappe/public/js/frappe/ui/filters/filter_list.js b/frappe/public/js/frappe/ui/filters/filter_list.js index 33b7f5544b..6617b2d3c5 100644 --- a/frappe/public/js/frappe/ui/filters/filter_list.js +++ b/frappe/public/js/frappe/ui/filters/filter_list.js @@ -325,7 +325,6 @@ frappe.ui.FilterGroup = class { } add_filters_to_filter_group(filters) { - console.log(filters); if (filters.length) { this.toggle_empty_filters(false); filters.forEach((filter) => { From f57d93d0d50685f369c2e40c8612b96eaf371fb9 Mon Sep 17 00:00:00 2001 From: phot0n Date: Sun, 13 Feb 2022 13:36:12 +0530 Subject: [PATCH 020/106] chore: use frappe.model.is_non_std_field --- frappe/public/js/frappe/form/grid.js | 3 +-- frappe/public/js/frappe/ui/filters/filter_list.js | 3 +-- frappe/public/js/frappe/views/reports/report_view.js | 3 +-- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/frappe/public/js/frappe/form/grid.js b/frappe/public/js/frappe/form/grid.js index e3361ce533..c17ca06003 100644 --- a/frappe/public/js/frappe/form/grid.js +++ b/frappe/public/js/frappe/form/grid.js @@ -747,8 +747,7 @@ export default class Grid { var df = this.visible_columns[i][0]; var colsize = this.visible_columns[i][1]; if (colsize > 1 && colsize < 11 - && !in_list(frappe.model.std_fields_list, df.fieldname) - && !in_list(frappe.model.child_table_field_list, df.fieldname)) { + && frappe.model.is_non_std_field(df.fieldname)) { if (passes < 3 && ["Int", "Currency", "Float", "Check", "Percent"].indexOf(df.fieldtype) !== -1) { // don't increase col size of these fields in first 3 passes diff --git a/frappe/public/js/frappe/ui/filters/filter_list.js b/frappe/public/js/frappe/ui/filters/filter_list.js index 6617b2d3c5..1377a6ff13 100644 --- a/frappe/public/js/frappe/ui/filters/filter_list.js +++ b/frappe/public/js/frappe/ui/filters/filter_list.js @@ -170,8 +170,7 @@ frappe.ui.FilterGroup = class { validate_args(doctype, fieldname) { if (doctype && fieldname && !frappe.meta.has_field(doctype, fieldname) - && !frappe.model.std_fields_list.includes(fieldname) - && !frappe.model.child_table_field_list.includes(fieldname)) { + && frappe.model.is_non_std_field(fieldname)) { frappe.msgprint({ message: __('Invalid filter: {0}', [fieldname.bold()]), diff --git a/frappe/public/js/frappe/views/reports/report_view.js b/frappe/public/js/frappe/views/reports/report_view.js index 5aa32c1b87..44d82988e6 100644 --- a/frappe/public/js/frappe/views/reports/report_view.js +++ b/frappe/public/js/frappe/views/reports/report_view.js @@ -646,8 +646,7 @@ frappe.views.ReportView = class ReportView extends frappe.views.ListView { && !df.read_only && !df.hidden // not a standard field i.e., owner, modified_by, etc. - && !frappe.model.std_fields_list.includes(df.fieldname) - && !frappe.model.child_table_field_list.includes(df.fieldname)) + && frappe.model.is_non_std_field(df.fieldname)) return true; return false; } From 857209d630bd4af96e3e218b56853d29e628f731 Mon Sep 17 00:00:00 2001 From: phot0n Date: Sun, 13 Feb 2022 23:24:49 +0530 Subject: [PATCH 021/106] chore: remove unrelated comment --- frappe/model/base_document.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/frappe/model/base_document.py b/frappe/model/base_document.py index 307d95e84b..6c67028368 100644 --- a/frappe/model/base_document.py +++ b/frappe/model/base_document.py @@ -105,9 +105,6 @@ class BaseDocument(object): }) """ - # QUESTION: why do we need the 1st for loop? - # we're essentially setting the values in d, in the 2nd for loop (?) - # first set default field values of base document for key in default_fields: if key in d: From 6b671af1ec29ae1e95595b7e8dd2c8495eedaa6a Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Mon, 14 Feb 2022 12:29:23 +0530 Subject: [PATCH 022/106] Merge branch 'develop' into autocomplete-control --- frappe/core/doctype/docfield/docfield.json | 9 ++- frappe/core/doctype/doctype/doctype.py | 13 ++-- .../doctype/custom_field/custom_field.json | 11 +++- .../doctype/custom_field/custom_field.py | 4 +- .../doctype/customize_form/customize_form.py | 9 ++- .../customize_form_field.json | 9 ++- .../property_setter/property_setter.py | 55 ++++------------ frappe/database/schema.py | 5 +- frappe/model/base_document.py | 28 ++++++-- frappe/model/meta.py | 11 +++- .../js/frappe/form/controls/base_control.js | 5 +- frappe/public/js/frappe/form/quick_entry.js | 2 +- .../public/js/frappe/form/script_manager.js | 15 ++++- frappe/public/js/frappe/list/list_view.js | 3 +- frappe/public/js/frappe/utils/common.js | 13 ++-- .../js/frappe/views/reports/report_view.js | 3 +- frappe/public/js/frappe/views/treeview.js | 2 +- frappe/tests/test_document.py | 65 +++++++++++++++++-- frappe/website/doctype/web_form/web_form.js | 2 +- 19 files changed, 178 insertions(+), 86 deletions(-) diff --git a/frappe/core/doctype/docfield/docfield.json b/frappe/core/doctype/docfield/docfield.json index 69c8c3505f..3267429298 100644 --- a/frappe/core/doctype/docfield/docfield.json +++ b/frappe/core/doctype/docfield/docfield.json @@ -17,6 +17,7 @@ "hide_days", "hide_seconds", "reqd", + "is_virtual", "search_index", "column_break_18", "options", @@ -534,13 +535,19 @@ "fieldname": "show_dashboard", "fieldtype": "Check", "label": "Show Dashboard" + }, + { + "default": "0", + "fieldname": "is_virtual", + "fieldtype": "Check", + "label": "Virtual" } ], "idx": 1, "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2022-01-04 11:56:19.812863", + "modified": "2022-02-14 11:56:19.812863", "modified_by": "Administrator", "module": "Core", "name": "DocField", diff --git a/frappe/core/doctype/doctype/doctype.py b/frappe/core/doctype/doctype/doctype.py index aa731a686b..6d0409521e 100644 --- a/frappe/core/doctype/doctype/doctype.py +++ b/frappe/core/doctype/doctype/doctype.py @@ -1078,6 +1078,9 @@ def validate_fields(meta): field.fetch_from = field.fetch_from.strip('\n').strip() def validate_data_field_type(docfield): + if docfield.get("is_virtual"): + return + if docfield.fieldtype == "Data" and not (docfield.oldfieldtype and docfield.oldfieldtype != "Data"): if docfield.options and (docfield.options not in data_field_options): df_str = frappe.bold(_(docfield.label)) @@ -1323,10 +1326,9 @@ def make_module_and_roles(doc, perm_fieldname="permissions"): else: raise -def check_fieldname_conflicts(doctype, fieldname): +def check_fieldname_conflicts(docfield): """Checks if fieldname conflicts with methods or properties""" - - doc = frappe.get_doc({"doctype": doctype}) + doc = frappe.get_doc({"doctype": docfield.dt}) available_objects = [x for x in dir(doc) if isinstance(x, str)] property_list = [ x for x in available_objects if isinstance(getattr(type(doc), x, None), property) @@ -1334,9 +1336,10 @@ def check_fieldname_conflicts(doctype, fieldname): method_list = [ x for x in available_objects if x not in property_list and callable(getattr(doc, x)) ] + msg = _("Fieldname {0} conflicting with meta object").format(docfield.fieldname) - if fieldname in method_list + property_list: - frappe.throw(_("Fieldname {0} conflicting with meta object").format(fieldname)) + if docfield.fieldname in method_list + property_list: + frappe.msgprint(msg, raise_exception=not docfield.is_virtual) def clear_linked_doctype_cache(): frappe.cache().delete_value('linked_doctypes_without_ignore_user_permissions_enabled') diff --git a/frappe/custom/doctype/custom_field/custom_field.json b/frappe/custom/doctype/custom_field/custom_field.json index d8b12d13b7..f09829a688 100644 --- a/frappe/custom/doctype/custom_field/custom_field.json +++ b/frappe/custom/doctype/custom_field/custom_field.json @@ -1,7 +1,7 @@ { "actions": [], "allow_import": 1, - "creation": "2022-01-25 14:14:01.217507", + "creation": "2013-01-10 16:34:01", "description": "Adds a custom field to a DocType", "doctype": "DocType", "document_type": "Setup", @@ -34,6 +34,7 @@ "non_negative", "reqd", "unique", + "is_virtual", "read_only", "ignore_user_permissions", "hidden", @@ -240,6 +241,12 @@ "fieldtype": "Check", "label": "Unique" }, + { + "default": "0", + "fieldname": "is_virtual", + "fieldtype": "Check", + "label": "Is Virtual" + }, { "default": "0", "fieldname": "read_only", @@ -424,7 +431,7 @@ "idx": 1, "index_web_pages_for_search": 1, "links": [], - "modified": "2022-01-29 15:42:21.885999", + "modified": "2022-02-14 15:42:21.885999", "modified_by": "Administrator", "module": "Custom", "name": "Custom Field", diff --git a/frappe/custom/doctype/custom_field/custom_field.py b/frappe/custom/doctype/custom_field/custom_field.py index 8f7b21dd24..cb1ea2c54d 100644 --- a/frappe/custom/doctype/custom_field/custom_field.py +++ b/frappe/custom/doctype/custom_field/custom_field.py @@ -54,7 +54,7 @@ class CustomField(Document): old_fieldtype = self.db_get('fieldtype') is_fieldtype_changed = (not self.is_new()) and (old_fieldtype != self.fieldtype) - if is_fieldtype_changed and not CustomizeForm.allow_fieldtype_change(old_fieldtype, self.fieldtype): + if not self.is_virtual and is_fieldtype_changed and not CustomizeForm.allow_fieldtype_change(old_fieldtype, self.fieldtype): frappe.throw(_("Fieldtype cannot be changed from {0} to {1}").format(old_fieldtype, self.fieldtype)) if not self.fieldname: @@ -65,7 +65,7 @@ class CustomField(Document): if not self.flags.ignore_validate: from frappe.core.doctype.doctype.doctype import check_fieldname_conflicts - check_fieldname_conflicts(self.dt, self.fieldname) + check_fieldname_conflicts(self) def on_update(self): if not frappe.flags.in_setup_wizard: diff --git a/frappe/custom/doctype/customize_form/customize_form.py b/frappe/custom/doctype/customize_form/customize_form.py index 1593ed49a5..2ccfa87544 100644 --- a/frappe/custom/doctype/customize_form/customize_form.py +++ b/frappe/custom/doctype/customize_form/customize_form.py @@ -418,6 +418,9 @@ class CustomizeForm(Document): return property_value def validate_fieldtype_change(self, df, old_value, new_value): + if df.is_virtual: + return + allowed = self.allow_fieldtype_change(old_value, new_value) if allowed: old_value_length = cint(frappe.db.type_map.get(old_value)[1]) @@ -430,7 +433,8 @@ class CustomizeForm(Document): self.validate_fieldtype_length() else: self.flags.update_db = True - if not allowed: + + else: frappe.throw(_("Fieldtype cannot be changed from {0} to {1} in row {2}").format(old_value, new_value, df.idx)) def validate_fieldtype_length(self): @@ -558,7 +562,8 @@ docfield_properties = { 'allow_in_quick_entry': 'Check', 'hide_border': 'Check', 'hide_days': 'Check', - 'hide_seconds': 'Check' + 'hide_seconds': 'Check', + 'is_virtual': 'Check', } doctype_link_properties = { diff --git a/frappe/custom/doctype/customize_form_field/customize_form_field.json b/frappe/custom/doctype/customize_form_field/customize_form_field.json index 93d1de0e63..1d721c57ec 100644 --- a/frappe/custom/doctype/customize_form_field/customize_form_field.json +++ b/frappe/custom/doctype/customize_form_field/customize_form_field.json @@ -14,6 +14,7 @@ "non_negative", "reqd", "unique", + "is_virtual", "in_list_view", "in_standard_filter", "in_global_search", @@ -115,6 +116,12 @@ "fieldtype": "Check", "label": "Unique" }, + { + "default": "0", + "fieldname": "is_virtual", + "fieldtype": "Check", + "label": "Is Virtual" + }, { "default": "0", "fieldname": "in_list_view", @@ -436,7 +443,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2022-01-29 15:43:05.540546", + "modified": "2022-01-27 21:45:22.349776", "modified_by": "Administrator", "module": "Custom", "name": "Customize Form Field", diff --git a/frappe/custom/doctype/property_setter/property_setter.py b/frappe/custom/doctype/property_setter/property_setter.py index 0a65aa6f5d..a86cf5efd6 100644 --- a/frappe/custom/doctype/property_setter/property_setter.py +++ b/frappe/custom/doctype/property_setter/property_setter.py @@ -1,4 +1,4 @@ -# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE import frappe @@ -18,53 +18,19 @@ class PropertySetter(Document): def validate(self): self.validate_fieldtype_change() + if self.is_new(): delete_property_setter(self.doc_type, self.property, self.field_name, self.row_name) - - # clear cache frappe.clear_cache(doctype = self.doc_type) def validate_fieldtype_change(self): - if self.field_name in not_allowed_fieldtype_change and \ - self.property == 'fieldtype': - frappe.throw(_("Field type cannot be changed for {0}").format(self.field_name)) - - def get_property_list(self, dt): - return frappe.db.get_all('DocField', - fields=['fieldname', 'label', 'fieldtype'], - filters={ - 'parent': dt, - 'fieldtype': ['not in', ('Section Break', 'Column Break', 'Tab Break', 'HTML', 'Read Only', 'Fold') + frappe.model.table_fields], - 'fieldname': ['!=', ''] - }, - order_by='label asc', - as_dict=1 - ) - - def get_setup_data(self): - return { - 'doctypes': frappe.get_all("DocType", pluck="name"), - 'dt_properties': self.get_property_list('DocType'), - 'df_properties': self.get_property_list('DocField') - } - - def get_field_ids(self): - return frappe.db.get_values( - "DocField", - filters={"parent": self.doc_type}, - fieldname=["name", "fieldtype", "label", "fieldname"], - as_dict=True, - ) - - def get_defaults(self): - if not self.field_name: - return frappe.get_all("DocType", filters={"name": self.doc_type}, fields="*")[0] - else: - return frappe.db.get_values( - "DocField", - filters={"fieldname": self.field_name, "parent": self.doc_type}, - fieldname="*", - )[0] + if ( + self.property == 'fieldtype' + and self.field_name in not_allowed_fieldtype_change + ): + frappe.throw( + _("Field type cannot be changed for {0}").format(self.field_name) + ) def on_update(self): if frappe.flags.in_patch: @@ -74,6 +40,7 @@ class PropertySetter(Document): from frappe.core.doctype.doctype.doctype import validate_fields_for_doctype validate_fields_for_doctype(self.doc_type) + def make_property_setter(doctype, fieldname, property, value, property_type, for_doctype = False, validate_fields_for_doctype=True): # WARNING: Ignores Permissions @@ -91,6 +58,7 @@ def make_property_setter(doctype, fieldname, property, value, property_type, for property_setter.insert() return property_setter + def delete_property_setter(doc_type, property, field_name=None, row_name=None): """delete other property setters on this, if this is new""" filters = dict(doc_type=doc_type, property=property) @@ -100,4 +68,3 @@ def delete_property_setter(doc_type, property, field_name=None, row_name=None): filters["row_name"] = row_name frappe.db.delete('Property Setter', filters) - diff --git a/frappe/database/schema.py b/frappe/database/schema.py index dd54385c83..7cab8d42b2 100644 --- a/frappe/database/schema.py +++ b/frappe/database/schema.py @@ -67,7 +67,7 @@ class DBTable: """ get columns from docfields and custom fields """ - fields = self.meta.get_fieldnames_with_value(True) + fields = self.meta.get_fieldnames_with_value(with_field_meta=True) # optional fields like _comments if not self.meta.get('istable'): @@ -85,6 +85,9 @@ class DBTable: }) for field in fields: + if field.get("is_virtual"): + continue + self.columns[field.get('fieldname')] = DbColumn( self, field.get('fieldname'), diff --git a/frappe/model/base_document.py b/frappe/model/base_document.py index 307d95e84b..8380161050 100644 --- a/frappe/model/base_document.py +++ b/frappe/model/base_document.py @@ -1,16 +1,14 @@ -# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import datetime import frappe -import datetime from frappe import _ -from frappe.model import default_fields, table_fields, child_table_fields +from frappe.model import child_table_fields, default_fields, display_fieldtypes, table_fields from frappe.model.naming import set_new_name from frappe.model.utils.link_count import notify_link_count from frappe.modules import load_doctype_module -from frappe.model import display_fieldtypes -from frappe.utils import (cint, flt, now, cstr, strip_html, - sanitize_html, sanitize_email, cast_fieldtype) +from frappe.utils import cast_fieldtype, cint, cstr, flt, now, sanitize_html, strip_html from frappe.utils.html_utils import unescape_html from frappe.model.docstatus import DocStatus @@ -254,7 +252,22 @@ class BaseDocument(object): continue df = self.meta.get_field(fieldname) - if df: + + if df and df.get("is_virtual"): + from frappe.utils.safe_exec import get_safe_globals + + if d[fieldname] is None: + if df.get("options"): + d[fieldname] = frappe.safe_eval( + code=df.get("options"), + eval_globals=get_safe_globals(), + eval_locals={"doc": self}, + ) + else: + _val = getattr(self, fieldname, None) + if _val and not callable(_val): + d[fieldname] = _val + elif df: if df.fieldtype=="Check": d[fieldname] = 1 if cint(d[fieldname]) else 0 @@ -328,6 +341,7 @@ class BaseDocument(object): def as_dict(self, no_nulls=False, no_default_fields=False, convert_dates_to_str=False, no_child_table_fields=False): doc = self.get_valid_dict(convert_dates_to_str=convert_dates_to_str) doc["doctype"] = self.doctype + for df in self.meta.get_table_fields(): children = self.get(df.fieldname) or [] doc[df.fieldname] = [ diff --git a/frappe/model/meta.py b/frappe/model/meta.py index 372392f689..77d4de466f 100644 --- a/frappe/model/meta.py +++ b/frappe/model/meta.py @@ -444,9 +444,16 @@ class Meta(Document): self.permissions = [Document(d) for d in custom_perms] def get_fieldnames_with_value(self, with_field_meta=False): - return [df if with_field_meta else df.fieldname \ - for df in self.fields if df.fieldtype not in no_value_fields] + def is_value_field(docfield): + return not ( + docfield.get("is_virtual") + or docfield.fieldtype in no_value_fields + ) + if with_field_meta: + return [df for df in self.fields if is_value_field(df)] + + return [df.fieldname for df in self.fields if is_value_field(df)] def get_fields_to_check_permissions(self, user_permission_doctypes): fields = self.get("fields", { diff --git a/frappe/public/js/frappe/form/controls/base_control.js b/frappe/public/js/frappe/form/controls/base_control.js index ce871c50cb..4ee52d16b8 100644 --- a/frappe/public/js/frappe/form/controls/base_control.js +++ b/frappe/public/js/frappe/form/controls/base_control.js @@ -39,6 +39,9 @@ frappe.ui.form.Control = class BaseControl { if (this.df.get_status) { return this.df.get_status(this); } + if (this.df.is_virtual) { + return "Read"; + } if ((!this.doctype && !this.docname) || this.df.parenttype === 'Web Form' || this.df.is_web_form) { // like in case of a dialog box @@ -52,7 +55,7 @@ frappe.ui.form.Control = class BaseControl { if(explain) console.log("By Hidden Dependency: None"); // eslint-disable-line no-console return "None"; - } else if (cint(this.df.read_only)) { + } else if (cint(this.df.read_only || this.df.is_virtual)) { // eslint-disable-next-line if (explain) console.log("By Read Only: Read"); // eslint-disable-line no-console return "Read"; diff --git a/frappe/public/js/frappe/form/quick_entry.js b/frappe/public/js/frappe/form/quick_entry.js index e412b1dec8..86523d7088 100644 --- a/frappe/public/js/frappe/form/quick_entry.js +++ b/frappe/public/js/frappe/form/quick_entry.js @@ -55,7 +55,7 @@ frappe.ui.form.QuickEntryForm = class QuickEntryForm { // prepare a list of mandatory, bold and allow in quick entry fields this.mandatory = fields.filter(df => { - return ((df.reqd || df.bold || df.allow_in_quick_entry) && !df.read_only); + return ((df.reqd || df.bold || df.allow_in_quick_entry) && !df.read_only && !df.is_virtual); }); } diff --git a/frappe/public/js/frappe/form/script_manager.js b/frappe/public/js/frappe/form/script_manager.js index 6169fa75b8..29f1c86d17 100644 --- a/frappe/public/js/frappe/form/script_manager.js +++ b/frappe/public/js/frappe/form/script_manager.js @@ -192,9 +192,18 @@ frappe.ui.form.ScriptManager = class ScriptManager { } function setup_add_fetch(df) { - if ((['Data', 'Read Only', 'Text', 'Small Text', 'Currency', 'Check', 'Attach Image', - 'Text Editor', 'Code', 'Link', 'Float', 'Int', 'Date', 'Select', 'Duration'].includes(df.fieldtype) || df.read_only==1) - && df.fetch_from && df.fetch_from.indexOf(".")!=-1) { + let is_read_only_field = ( + ['Data', 'Read Only', 'Text', 'Small Text', 'Currency', 'Check', 'Text Editor', 'Attach Image', + 'Code', 'Link', 'Float', 'Int', 'Date', 'Select', 'Duration'].includes(df.fieldtype) + || df.read_only == 1 + || df.is_virtual == 1 + ) + + if ( + is_read_only_field + && df.fetch_from + && df.fetch_from.indexOf(".") != -1 + ) { var parts = df.fetch_from.split("."); me.frm.add_fetch(parts[0], parts[1], df.fieldname, df.parent); } diff --git a/frappe/public/js/frappe/list/list_view.js b/frappe/public/js/frappe/list/list_view.js index 3cde04313f..64960e0b09 100644 --- a/frappe/public/js/frappe/list/list_view.js +++ b/frappe/public/js/frappe/list/list_view.js @@ -1672,7 +1672,8 @@ frappe.views.ListView = class ListView extends frappe.views.BaseList { frappe.model.is_value_type(field_doc) && field_doc.fieldtype !== "Read Only" && !field_doc.hidden && - !field_doc.read_only + !field_doc.read_only && + !field_doc.is_virtual ); }; diff --git a/frappe/public/js/frappe/utils/common.js b/frappe/public/js/frappe/utils/common.js index b324cecd39..1f3558b367 100644 --- a/frappe/public/js/frappe/utils/common.js +++ b/frappe/public/js/frappe/utils/common.js @@ -259,8 +259,16 @@ frappe.utils.xss_sanitise = function (string, options) { '/': '/' }; const REGEX_SCRIPT = /)<[^<]*)*<\/script>/gi; // used in jQuery 1.7.2 src/ajax.js Line 14 + const REGEX_ALERT = /confirm\(.*\)|alert\(.*\)|prompt\(.*\)/gi; // captures alert, confirm, prompt options = Object.assign({}, DEFAULT_OPTIONS, options); // don't deep copy, immutable beauty. + // Rule 3 - TODO: Check event handlers? + // script and alert should be checked first or else it will be escaped + if (options.strategies.includes('js')) { + sanitised = sanitised.replace(REGEX_SCRIPT, ""); + sanitised = sanitised.replace(REGEX_ALERT, ""); + } + // Rule 1 if (options.strategies.includes('html')) { for (let char in HTML_ESCAPE_MAP) { @@ -270,11 +278,6 @@ frappe.utils.xss_sanitise = function (string, options) { } } - // Rule 3 - TODO: Check event handlers? - if (options.strategies.includes('js')) { - sanitised = sanitised.replace(REGEX_SCRIPT, ""); - } - return sanitised; } diff --git a/frappe/public/js/frappe/views/reports/report_view.js b/frappe/public/js/frappe/views/reports/report_view.js index 1291e63543..25c0c512ff 100644 --- a/frappe/public/js/frappe/views/reports/report_view.js +++ b/frappe/public/js/frappe/views/reports/report_view.js @@ -648,6 +648,7 @@ frappe.views.ReportView = class ReportView extends frappe.views.ListView { // not a cancelled doc && data.docstatus !== 2 && !df.read_only + && !df.is_virtual && !df.hidden // not a standard field i.e., owner, modified_by, etc. && !frappe.model.std_fields_list.includes(df.fieldname)) @@ -1029,7 +1030,7 @@ frappe.views.ReportView = class ReportView extends frappe.views.ListView { title += ` (${__(doctype)})`; } - const editable = frappe.model.is_non_std_field(fieldname) && !docfield.read_only; + const editable = frappe.model.is_non_std_field(fieldname) && !docfield.read_only && !docfield.is_virtual; const align = (() => { const is_numeric = frappe.model.is_numeric_field(docfield); diff --git a/frappe/public/js/frappe/views/treeview.js b/frappe/public/js/frappe/views/treeview.js index 7179e4ab56..d5c6fb5e80 100644 --- a/frappe/public/js/frappe/views/treeview.js +++ b/frappe/public/js/frappe/views/treeview.js @@ -343,7 +343,7 @@ frappe.views.TreeView = class TreeView { this.ignore_fields = this.opts.ignore_fields || []; var mandatory_fields = $.map(me.opts.meta.fields, function(d) { - return (d.reqd || d.bold && !d.read_only) ? d : null }); + return (d.reqd || d.bold && !d.read_only && !!d.is_virtual) ? d : null }); var opts_field_names = this.fields.map(function(d) { return d.fieldname diff --git a/frappe/tests/test_document.py b/frappe/tests/test_document.py index 34a1dd070c..a0c44c5c72 100644 --- a/frappe/tests/test_document.py +++ b/frappe/tests/test_document.py @@ -1,11 +1,20 @@ -# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import os import unittest +from contextlib import contextmanager +from datetime import timedelta +from unittest.mock import patch import frappe -from frappe.utils import cint -from frappe.model.naming import revert_series_if_last, make_autoname, parse_naming_series +from frappe.desk.doctype.note.note import Note +from frappe.model.naming import make_autoname, parse_naming_series, revert_series_if_last +from frappe.utils import cint, now_datetime + + +class CustomTestNote(Note): + @property + def age(self): + return now_datetime() - self.creation class TestDocument(unittest.TestCase): @@ -256,4 +265,50 @@ class TestDocument(unittest.TestCase): def test_limit_for_get(self): doc = frappe.get_doc("DocType", "DocType") # assuming DocType has more that 3 Data fields - self.assertEquals(len(doc.get("fields", filters={"fieldtype": "Data"}, limit=3)), 3) \ No newline at end of file + self.assertEquals(len(doc.get("fields", filters={"fieldtype": "Data"}, limit=3)), 3) + + def test_virtual_fields(self): + """Virtual fields are accessible via API and Form views, whenever .as_dict is invoked + """ + frappe.db.delete("Custom Field", {"dt": "Note", "fieldname":"age"}) + + def patch_note(): + return patch("frappe.controllers", new={frappe.local.site: {'Note': CustomTestNote}}) + + @contextmanager + def customize_note(with_options=False): + options = "frappe.utils.now_datetime() - doc.creation" if with_options else "" + custom_field = frappe.get_doc({ + "doctype": "Custom Field", + "dt": "Note", + "fieldname": "age", + "fieldtype": "Data", + "read_only": True, + "is_virtual": True, + "options": options, + }) + + try: + yield custom_field.insert(ignore_if_duplicate=True) + finally: + custom_field.delete() + + with patch_note(): + doc = frappe.get_last_doc("Note") + self.assertIsInstance(doc, CustomTestNote) + self.assertIsInstance(doc.age, timedelta) + self.assertIsNone(doc.as_dict().get("age")) + self.assertIsNone(doc.get_valid_dict().get("age")) + + with customize_note(), patch_note(): + doc = frappe.get_last_doc("Note") + self.assertIsInstance(doc, CustomTestNote) + self.assertIsInstance(doc.age, timedelta) + self.assertIsInstance(doc.as_dict().get("age"), timedelta) + self.assertIsInstance(doc.get_valid_dict().get("age"), timedelta) + + with customize_note(with_options=True): + doc = frappe.get_last_doc("Note") + self.assertIsInstance(doc, Note) + self.assertIsInstance(doc.as_dict().get("age"), timedelta) + self.assertIsInstance(doc.get_valid_dict().get("age"), timedelta) diff --git a/frappe/website/doctype/web_form/web_form.js b/frappe/website/doctype/web_form/web_form.js index d69d21c64d..1f27b350be 100644 --- a/frappe/website/doctype/web_form/web_form.js +++ b/frappe/website/doctype/web_form/web_form.js @@ -60,7 +60,7 @@ frappe.ui.form.on("Web Form", { options: field.options, reqd: field.reqd, default: field.default, - read_only: field.read_only, + read_only: field.read_only || field.is_virtual, depends_on: field.depends_on, mandatory_depends_on: field.mandatory_depends_on, read_only_depends_on: field.read_only_depends_on, From 50021ab22f4cac23e2c8ec9838a468385d9f11cd Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Mon, 14 Feb 2022 13:22:09 +0530 Subject: [PATCH 023/106] fix: depends_on not working with tabs --- frappe/public/js/frappe/form/layout.js | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/frappe/public/js/frappe/form/layout.js b/frappe/public/js/frappe/form/layout.js index 0de6b1db0d..f7219282c6 100644 --- a/frappe/public/js/frappe/form/layout.js +++ b/frappe/public/js/frappe/form/layout.js @@ -552,19 +552,21 @@ frappe.ui.form.Layout = class Layout { // build dependants' dictionary let has_dep = false; - for (let fkey in this.fields_list) { - let f = this.fields_list[fkey]; - f.dependencies_clear = true; + const fields = this.fields_list.concat(this.tabs); + + for (let fkey in fields) { + let f = fields[fkey]; if (f.df.depends_on || f.df.mandatory_depends_on || f.df.read_only_depends_on) { has_dep = true; + break; } } if (!has_dep) return; // show / hide based on values - for (let i = this.fields_list.length - 1; i >= 0; i--) { - let f = this.fields_list[i]; + for (let i = fields.length - 1; i >= 0; i--) { + let f = fields[i]; f.guardian_has_value = true; if (f.df.depends_on) { // evaluate guardian From 24a750c048b5a0cfbfe5b50bfa19f5a0f2138135 Mon Sep 17 00:00:00 2001 From: Sagar Vora Date: Wed, 16 Feb 2022 10:52:48 +0530 Subject: [PATCH 024/106] chore: remove redundant code from `update_if_missing` --- frappe/model/base_document.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/frappe/model/base_document.py b/frappe/model/base_document.py index 83d3d70eea..f4a4916a9f 100644 --- a/frappe/model/base_document.py +++ b/frappe/model/base_document.py @@ -120,14 +120,18 @@ class BaseDocument(object): return self def update_if_missing(self, d): + """Set default values for fields without existing values""" if isinstance(d, BaseDocument): d = d.get_valid_dict() - if "doctype" in d: - self.set("doctype", d.get("doctype")) for key, value in d.items(): - # dont_update_if_missing is a list of fieldnames, for which, you don't want to set default value - if (self.get(key) is None) and (value is not None) and (key not in self.dont_update_if_missing): + if ( + value is not None + and self.get(key) is None + # dont_update_if_missing is a list of fieldnames + # for which you don't want to set default value + and key not in self.dont_update_if_missing + ): self.set(key, value) def get_db_value(self, key): From 4c403333c41840e5839fe4608baa82b0f23192b0 Mon Sep 17 00:00:00 2001 From: Sagar Vora Date: Wed, 16 Feb 2022 16:02:37 +0530 Subject: [PATCH 025/106] fix: remove unused flag `in_setup_help` --- frappe/utils/jinja.py | 27 +++++++++++---------------- frappe/utils/safe_exec.py | 36 ++++++++++++++++-------------------- 2 files changed, 27 insertions(+), 36 deletions(-) diff --git a/frappe/utils/jinja.py b/frappe/utils/jinja.py index 12d00a78d8..3702a009fb 100644 --- a/frappe/utils/jinja.py +++ b/frappe/utils/jinja.py @@ -97,13 +97,10 @@ def get_jloader(): if not getattr(frappe.local, 'jloader', None): from jinja2 import ChoiceLoader, PackageLoader, PrefixLoader - if frappe.local.flags.in_setup_help: - apps = ['frappe'] - else: - apps = frappe.get_hooks('template_apps') - if not apps: - apps = frappe.local.flags.web_pages_apps or frappe.get_installed_apps(sort=True) - apps.reverse() + apps = frappe.get_hooks('template_apps') + if not apps: + apps = frappe.local.flags.web_pages_apps or frappe.get_installed_apps(sort=True) + apps.reverse() if "frappe" not in apps: apps.append('frappe') @@ -124,15 +121,13 @@ def set_filters(jenv): import frappe from frappe.utils import cint, cstr, flt - jenv.filters["json"] = frappe.as_json - jenv.filters["len"] = len - jenv.filters["int"] = cint - jenv.filters["str"] = cstr - jenv.filters["flt"] = flt - - if frappe.flags.in_setup_help: - return - + jenv.filters.update({ + "json": frappe.as_json, + "len": len, + "int": cint, + "str": cstr, + "flt": flt, + }) def get_jinja_hooks(): """Returns a tuple of (methods, filters) each containing a dict of method name and method definition pair.""" diff --git a/frappe/utils/safe_exec.py b/frappe/utils/safe_exec.py index 2042c1f2ce..5013963d1f 100644 --- a/frappe/utils/safe_exec.py +++ b/frappe/utils/safe_exec.py @@ -139,7 +139,21 @@ def get_safe_globals(): get_hooks=get_hooks, enqueue=safe_enqueue, sanitize_html=frappe.utils.sanitize_html, - log_error=frappe.log_error + log_error=frappe.log_error, + db = NamespaceDict( + get_list=frappe.get_list, + get_all=frappe.get_all, + get_value=frappe.db.get_value, + set_value=frappe.db.set_value, + get_single_value=frappe.db.get_single_value, + get_default=frappe.db.get_default, + exists=frappe.db.exists, + count=frappe.db.count, + escape=frappe.db.escape, + sql=read_sql, + commit=frappe.db.commit, + rollback=frappe.db.rollback, + ), ), FrappeClient=FrappeClient, style=frappe._dict( @@ -155,29 +169,11 @@ def get_safe_globals(): dev_server=1 if frappe._dev_server else 0, run_script=run_script, is_job_queued=is_job_queued, + get_visible_columns=get_visible_columns, ) add_module_properties(frappe.exceptions, out.frappe, lambda obj: inspect.isclass(obj) and issubclass(obj, Exception)) - if not frappe.flags.in_setup_help: - out.get_visible_columns = get_visible_columns - out.frappe.date_format = date_format - out.frappe.time_format = time_format - out.frappe.db = NamespaceDict( - get_list=frappe.get_list, - get_all=frappe.get_all, - get_value=frappe.db.get_value, - set_value=frappe.db.set_value, - get_single_value=frappe.db.get_single_value, - get_default=frappe.db.get_default, - exists=frappe.db.exists, - count=frappe.db.count, - escape=frappe.db.escape, - sql=read_sql, - commit=frappe.db.commit, - rollback=frappe.db.rollback, - ) - if frappe.response: out.frappe.response = frappe.response From 20056a447febf8c507060372ab91078ead54e946 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Wed, 16 Feb 2022 17:21:59 +0530 Subject: [PATCH 026/106] ci: Track server-side coverage as well while doing UI tests --- .github/helper/install.sh | 4 +++- .github/workflows/ui-tests.yml | 19 ++++++++++++++++++- frappe/commands/utils.py | 11 ++++++++--- 3 files changed, 29 insertions(+), 5 deletions(-) diff --git a/.github/helper/install.sh b/.github/helper/install.sh index 19a7c68e19..26b3f28ba2 100644 --- a/.github/helper/install.sh +++ b/.github/helper/install.sh @@ -50,7 +50,9 @@ if [ "$TYPE" == "server" ]; then sed -i 's/^socketio:/# socketio:/g' Procfile; f if [ "$TYPE" == "server" ]; then sed -i 's/^redis_socketio:/# redis_socketio:/g' Procfile; fi if [ "$TYPE" == "ui" ]; then bench setup requirements --node; fi -if [ "$TYPE" == "server" ]; then bench setup requirements --dev; fi +bench setup requirements --dev + +if [ "$TYPE" == "ui" ]; then sed -i 's/^web: bench serve/web: bench serve --with-coverage/g' Procfile; fi # install node-sass which is required for website theme test cd ./apps/frappe || exit diff --git a/.github/workflows/ui-tests.yml b/.github/workflows/ui-tests.yml index 3eefd1ce82..fb09768c81 100644 --- a/.github/workflows/ui-tests.yml +++ b/.github/workflows/ui-tests.yml @@ -118,7 +118,9 @@ jobs: - name: Install if: ${{ steps.check-build.outputs.build == 'strawberry' }} - run: bash ${GITHUB_WORKSPACE}/.github/helper/install.sh + run: | + bash ${GITHUB_WORKSPACE}/.github/helper/install.sh + cat ~/frappe-bench/Procfile env: DB: mariadb TYPE: ui @@ -141,6 +143,11 @@ jobs: env: CYPRESS_RECORD_KEY: 4a48f41c-11b3-425b-aa88-c58048fa69eb + - name: Stop server + run: | + ps -ef | grep "frappe serve" | awk '{print $2}' | xargs kill -s SIGINT 2> /dev/null || true + sleep 5 + - name: Check If Coverage Report Exists id: check_coverage uses: andstor/file-existence-action@v1 @@ -156,3 +163,13 @@ jobs: directory: /home/runner/frappe-bench/apps/frappe/.cypress-coverage/ verbose: true flags: ui-tests + + - name: Upload Server Coverage Data + if: ${{ steps.check-build.outputs.build == 'strawberry' }} + uses: codecov/codecov-action@v2 + with: + name: MariaDB + fail_ci_if_error: true + files: /home/runner/frappe-bench/sites/coverage.xml + verbose: true + flags: server diff --git a/frappe/commands/utils.py b/frappe/commands/utils.py index e3379a43aa..7246df8aa7 100644 --- a/frappe/commands/utils.py +++ b/frappe/commands/utils.py @@ -742,8 +742,9 @@ def run_ui_tests(context, app, headless=False, parallel=True, with_coverage=Fals @click.option('--profile', is_flag=True, default=False) @click.option('--noreload', "no_reload", is_flag=True, default=False) @click.option('--nothreading', "no_threading", is_flag=True, default=False) +@click.option('--with-coverage', is_flag=True, default=False) @pass_context -def serve(context, port=None, profile=False, no_reload=False, no_threading=False, sites_path='.', site=None): +def serve(context, port=None, profile=False, no_reload=False, no_threading=False, sites_path='.', site=None, with_coverage=False): "Start development web server" import frappe.app @@ -751,8 +752,12 @@ def serve(context, port=None, profile=False, no_reload=False, no_threading=False site = None else: site = context.sites[0] - - frappe.app.serve(port=port, profile=profile, no_reload=no_reload, no_threading=no_threading, site=site, sites_path='.') + with CodeCoverage(with_coverage, 'frappe'): + if with_coverage: + # unable to track coverage with threading enabled + no_threading = True + no_reload = True + frappe.app.serve(port=port, profile=profile, no_reload=no_reload, no_threading=no_threading, site=site, sites_path='.') @click.command('request') From 4e24efda8f7aae035fcdc772b89c683c8450dfb6 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Wed, 16 Feb 2022 17:44:14 +0530 Subject: [PATCH 027/106] ci: Exclude coverage.py and build.py from the report --- .github/workflows/ui-tests.yml | 4 +--- frappe/coverage.py | 2 ++ 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ui-tests.yml b/.github/workflows/ui-tests.yml index fb09768c81..91369dcaaa 100644 --- a/.github/workflows/ui-tests.yml +++ b/.github/workflows/ui-tests.yml @@ -118,9 +118,7 @@ jobs: - name: Install if: ${{ steps.check-build.outputs.build == 'strawberry' }} - run: | - bash ${GITHUB_WORKSPACE}/.github/helper/install.sh - cat ~/frappe-bench/Procfile + run: bash ${GITHUB_WORKSPACE}/.github/helper/install.sh env: DB: mariadb TYPE: ui diff --git a/frappe/coverage.py b/frappe/coverage.py index 1969cae141..e76bdaae90 100644 --- a/frappe/coverage.py +++ b/frappe/coverage.py @@ -29,6 +29,8 @@ FRAPPE_EXCLUSIONS = [ "*/commands/*", "*/frappe/change_log/*", "*/frappe/exceptions*", + "*/frappe/coverage.py", + "*/frappe/build.py", "*frappe/setup.py", "*/doctype/*/*_dashboard.py", "*/patches/*", From 4fb22d0f3419995076183abc860cd95bcfecbed7 Mon Sep 17 00:00:00 2001 From: Benedict Allerberger Date: Wed, 16 Feb 2022 22:23:27 +0100 Subject: [PATCH 028/106] fix: broken validation for custom LDAP server --- frappe/integrations/doctype/ldap_settings/ldap_settings.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/frappe/integrations/doctype/ldap_settings/ldap_settings.py b/frappe/integrations/doctype/ldap_settings/ldap_settings.py index 7c9c64ba3c..3d29feebac 100644 --- a/frappe/integrations/doctype/ldap_settings/ldap_settings.py +++ b/frappe/integrations/doctype/ldap_settings/ldap_settings.py @@ -45,8 +45,8 @@ class LDAPSettings(Document): title=_("Misconfigured")) if self.ldap_directory_server.lower() == 'custom': - if not self.ldap_group_member_attribute or not self.ldap_group_mappings_section: - frappe.throw(_("Custom LDAP Directoy Selected, please ensure 'LDAP Group Member attribute' and 'LDAP Group Mappings' are entered"), + if not self.ldap_group_member_attribute or not self.ldap_group_objectclass: + frappe.throw(_("Custom LDAP Directoy Selected, please ensure 'LDAP Group Member attribute' and 'Group Object Class' are entered"), title=_("Misconfigured")) else: From e0dcabf22499c6c900b7d72061ff7662a213d609 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Thu, 17 Feb 2022 09:52:49 +0530 Subject: [PATCH 029/106] ci: Build not required for UI tests Since we build again after instrumentation --- .github/helper/install.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/helper/install.sh b/.github/helper/install.sh index 26b3f28ba2..246bdbe096 100644 --- a/.github/helper/install.sh +++ b/.github/helper/install.sh @@ -62,4 +62,4 @@ cd ../.. bench start & bench --site test_site reinstall --yes if [ "$TYPE" == "server" ]; then bench --site test_site_producer reinstall --yes; fi -CI=Yes bench build --app frappe +if [ "$TYPE" == "server" ]; then CI=Yes bench build --app frappe; fi From 0f95c2716de3d10cf27ba01556b3f8d7abab0e0d Mon Sep 17 00:00:00 2001 From: Sagar Vora Date: Thu, 17 Feb 2022 10:50:31 +0530 Subject: [PATCH 030/106] fix: incorrect function name in call --- frappe/utils/backups.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/utils/backups.py b/frappe/utils/backups.py index 69f4ee2b01..d23804bef4 100644 --- a/frappe/utils/backups.py +++ b/frappe/utils/backups.py @@ -653,7 +653,7 @@ def get_backup_path(): @frappe.whitelist() def get_backup_encryption_key(): - frappe.only("System Manager") + frappe.only_for("System Manager") return frappe.conf.encryption_key class Backup: From 383eb668bf90c38594d6ebbde41962e4e12d06c6 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Thu, 17 Feb 2022 11:27:34 +0530 Subject: [PATCH 031/106] fix: Update docfields of a doctype while doing update_docfield_property - This is necessary to get updated docfields while adding new row --- frappe/public/js/frappe/form/grid.js | 1 + 1 file changed, 1 insertion(+) diff --git a/frappe/public/js/frappe/form/grid.js b/frappe/public/js/frappe/form/grid.js index 11fda3c8b0..98ab573b07 100644 --- a/frappe/public/js/frappe/form/grid.js +++ b/frappe/public/js/frappe/form/grid.js @@ -972,6 +972,7 @@ export default class Grid { // update the parent too (for new rows) this.docfields.find(d => d.fieldname === fieldname)[property] = value; + frappe.meta.docfield_map[this.doctype][fieldname][property] = value; this.debounced_refresh(); } From bb00c34e72bd4a9ae7f06289187904acf9da02f3 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Thu, 17 Feb 2022 11:30:28 +0530 Subject: [PATCH 032/106] fix: Update grid-row docfield instead of updating doctype meta --- frappe/public/js/frappe/form/grid.js | 3 ++- frappe/public/js/frappe/form/grid_row.js | 18 +++++++++++++----- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/frappe/public/js/frappe/form/grid.js b/frappe/public/js/frappe/form/grid.js index 98ab573b07..5dc59120fd 100644 --- a/frappe/public/js/frappe/form/grid.js +++ b/frappe/public/js/frappe/form/grid.js @@ -368,6 +368,8 @@ export default class Grid { if (this.grid_rows[ri] && !append_row) { var grid_row = this.grid_rows[ri]; grid_row.doc = d; + // reset docfield list for this row + grid_row.docfields = this.docfields; grid_row.refresh(); } else { var grid_row = new GridRow({ @@ -972,7 +974,6 @@ export default class Grid { // update the parent too (for new rows) this.docfields.find(d => d.fieldname === fieldname)[property] = value; - frappe.meta.docfield_map[this.doctype][fieldname][property] = value; this.debounced_refresh(); } diff --git a/frappe/public/js/frappe/form/grid_row.js b/frappe/public/js/frappe/form/grid_row.js index a40f428969..441a879369 100644 --- a/frappe/public/js/frappe/form/grid_row.js +++ b/frappe/public/js/frappe/form/grid_row.js @@ -5,16 +5,13 @@ export default class GridRow { this.on_grid_fields_dict = {}; this.on_grid_fields = []; $.extend(this, opts); - if (this.doc && this.parent_df.options) { - frappe.meta.make_docfield_copy_for(this.parent_df.options, this.doc.name, this.docfields); - const docfields = frappe.meta.get_docfields(this.parent_df.options, this.doc.name); - this.docfields = docfields.length ? docfields : opts.docfields; - } + this.set_docfields(); this.columns = {}; this.columns_list = []; this.row_check_html = ''; this.make(); } + make() { var me = this; @@ -41,6 +38,15 @@ export default class GridRow { this.set_data(); } } + + set_docfields() { + if (this.doc && this.parent_df.options) { + frappe.meta.make_docfield_copy_for(this.parent_df.options, this.doc.name, this.docfields); + const docfields = frappe.meta.get_docfields(this.parent_df.options, this.doc.name); + this.docfields = docfields; + } + } + set_data() { this.wrapper.data({ "doc": this.doc @@ -152,6 +158,8 @@ export default class GridRow { this.doc = locals[this.doc.doctype][this.doc.name]; } + // update docfield list + this.set_docfields(); if(this.grid.template && !this.grid.meta.editable_grid) { this.render_template(); } else { From a8c9b92a013da438f25c873e93a1085148875a83 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Thu, 17 Feb 2022 12:16:35 +0530 Subject: [PATCH 033/106] fix: No need to reset docfields, grid row already has df copy --- frappe/public/js/frappe/form/grid.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/frappe/public/js/frappe/form/grid.js b/frappe/public/js/frappe/form/grid.js index 5dc59120fd..11fda3c8b0 100644 --- a/frappe/public/js/frappe/form/grid.js +++ b/frappe/public/js/frappe/form/grid.js @@ -368,8 +368,6 @@ export default class Grid { if (this.grid_rows[ri] && !append_row) { var grid_row = this.grid_rows[ri]; grid_row.doc = d; - // reset docfield list for this row - grid_row.docfields = this.docfields; grid_row.refresh(); } else { var grid_row = new GridRow({ From 0a1cd9e623061dc563224dfbc941f003f82a83b4 Mon Sep 17 00:00:00 2001 From: ChillarAnand Date: Thu, 17 Feb 2022 15:43:07 +0530 Subject: [PATCH 034/106] fix: Removed verbose flag for gzip --- frappe/installer.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/frappe/installer.py b/frappe/installer.py index d892ff4ddc..0948620ab0 100644 --- a/frappe/installer.py +++ b/frappe/installer.py @@ -529,10 +529,9 @@ def extract_sql_gzip(sql_gz_path): import subprocess try: - # dvf - decompress, verbose, force original_file = sql_gz_path decompressed_file = original_file.rstrip(".gz") - cmd = 'gzip -dvf < {0} > {1}'.format(original_file, decompressed_file) + cmd = 'gzip --decompress --force < {0} > {1}'.format(original_file, decompressed_file) subprocess.check_call(cmd, shell=True) except Exception: raise From 628c9bc2881abadb83fc1f7211cbffecbae48cec Mon Sep 17 00:00:00 2001 From: Suraj Shetty <13928957+surajshetty3416@users.noreply.github.com> Date: Thu, 17 Feb 2022 16:57:27 +0530 Subject: [PATCH 035/106] ci: Remove build.py from exclusion list Co-authored-by: gavin --- frappe/coverage.py | 1 - 1 file changed, 1 deletion(-) diff --git a/frappe/coverage.py b/frappe/coverage.py index e76bdaae90..5f89800deb 100644 --- a/frappe/coverage.py +++ b/frappe/coverage.py @@ -30,7 +30,6 @@ FRAPPE_EXCLUSIONS = [ "*/frappe/change_log/*", "*/frappe/exceptions*", "*/frappe/coverage.py", - "*/frappe/build.py", "*frappe/setup.py", "*/doctype/*/*_dashboard.py", "*/patches/*", From 9262d2774e00a4a4c12080f23983593790a01368 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Thu, 17 Feb 2022 18:50:33 +0530 Subject: [PATCH 036/106] fix(grid): Update docfields for new record --- frappe/public/js/frappe/form/grid_row.js | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/frappe/public/js/frappe/form/grid_row.js b/frappe/public/js/frappe/form/grid_row.js index 441a879369..0ee5a180e0 100644 --- a/frappe/public/js/frappe/form/grid_row.js +++ b/frappe/public/js/frappe/form/grid_row.js @@ -11,7 +11,6 @@ export default class GridRow { this.row_check_html = ''; this.make(); } - make() { var me = this; @@ -39,11 +38,18 @@ export default class GridRow { } } - set_docfields() { + set_docfields(update=false) { if (this.doc && this.parent_df.options) { frappe.meta.make_docfield_copy_for(this.parent_df.options, this.doc.name, this.docfields); const docfields = frappe.meta.get_docfields(this.parent_df.options, this.doc.name); - this.docfields = docfields; + if (update) { + // to maintain references + this.docfields.forEach(df => { + Object.assign(df, docfields.find(d => d.fieldname === df.fieldname)); + }); + } else { + this.docfields = docfields; + } } } @@ -154,12 +160,15 @@ export default class GridRow { }, __('Move To'), 'Update'); } refresh() { + // update docfields for new record + if (this.frm && this.doc && this.doc.__islocal) { + this.set_docfields(true); + } + if(this.frm && this.doc) { this.doc = locals[this.doc.doctype][this.doc.name]; } - // update docfield list - this.set_docfields(); if(this.grid.template && !this.grid.meta.editable_grid) { this.render_template(); } else { From 0b37f2a3240c7a5f3bc931179b109a0ee57a76b8 Mon Sep 17 00:00:00 2001 From: Sagar Vora Date: Fri, 18 Feb 2022 11:30:05 +0530 Subject: [PATCH 037/106] fix: Saving Client Script produces Error in Console --- .../doctype/client_script/client_script.js | 56 +++++++++++++++++++ .../doctype/client_script/client_script.json | 6 +- 2 files changed, 59 insertions(+), 3 deletions(-) diff --git a/frappe/custom/doctype/client_script/client_script.js b/frappe/custom/doctype/client_script/client_script.js index ad9c9e4e42..18786c62cf 100644 --- a/frappe/custom/doctype/client_script/client_script.js +++ b/frappe/custom/doctype/client_script/client_script.js @@ -2,6 +2,9 @@ // For license information, please see license.txt frappe.ui.form.on('Client Script', { + setup(frm) { + frm.get_field("sample").html(SAMPLE_HTML); + }, refresh(frm) { if (frm.doc.dt && frm.doc.script) { frm.add_custom_button(__('Go to {0}', [frm.doc.dt]), @@ -97,3 +100,56 @@ frappe.ui.form.on('${doctype}', { frm.set_value('script', script + boilerplate); } }); + +const SAMPLE_HTML = `

Client Script Help

+

Client Scripts are executed only on the client-side (i.e. in Forms). Here are some examples to get you started

+

+
+// fetch local_tax_no on selection of customer
+// cur_frm.add_fetch(link_field,  source_fieldname,  target_fieldname);
+cur_frm.add_fetch("customer",  "local_tax_no',  'local_tax_no');
+
+// additional validation on dates
+frappe.ui.form.on('Task',  'validate',  function(frm) {
+    if (frm.doc.from_date < get_today()) {
+        msgprint('You can not select past date in From Date');
+        validated = false;
+    }
+});
+
+// make a field read-only after saving
+frappe.ui.form.on('Task',  {
+    refresh: function(frm) {
+        // use the __islocal value of doc,  to check if the doc is saved or not
+        frm.set_df_property('myfield',  'read_only',  frm.doc.__islocal ? 0 : 1);
+    }
+});
+
+// additional permission check
+frappe.ui.form.on('Task',  {
+    validate: function(frm) {
+        if(user=='user1@example.com' && frm.doc.purpose!='Material Receipt') {
+            msgprint('You are only allowed Material Receipt');
+            validated = false;
+        }
+    }
+});
+
+// calculate sales incentive
+frappe.ui.form.on('Sales Invoice',  {
+    validate: function(frm) {
+        // calculate incentives for each person on the deal
+        total_incentive = 0
+        $.each(frm.doc.sales_team,  function(i,  d) {
+            // calculate incentive
+            var incentive_percent = 2;
+            if(frm.doc.base_grand_total > 400) incentive_percent = 4;
+            // actual incentive
+            d.incentives = flt(frm.doc.base_grand_total) * incentive_percent / 100;
+            total_incentive += flt(d.incentives)
+        });
+        frm.doc.total_incentive = total_incentive;
+    }
+})
+
+
`; diff --git a/frappe/custom/doctype/client_script/client_script.json b/frappe/custom/doctype/client_script/client_script.json index 50f6bf3cc4..eca84b4dec 100644 --- a/frappe/custom/doctype/client_script/client_script.json +++ b/frappe/custom/doctype/client_script/client_script.json @@ -40,8 +40,7 @@ { "fieldname": "sample", "fieldtype": "HTML", - "label": "Sample", - "options": "

Client Script Help

\n

Client Scripts are executed only on the client-side (i.e. in Forms). Here are some examples to get you started

\n
\n\n// fetch local_tax_no on selection of customer \n// cur_frm.add_fetch(link_field,  source_fieldname,  target_fieldname); \ncur_frm.add_fetch('customer',  'local_tax_no',  'local_tax_no');\n\n// additional validation on dates \nfrappe.ui.form.on('Task',  'validate',  function(frm) {\n    if (frm.doc.from_date < get_today()) {\n        msgprint('You can not select past date in From Date');\n        validated = false;\n    } \n});\n\n// make a field read-only after saving \nfrappe.ui.form.on('Task',  {\n    refresh: function(frm) {\n        // use the __islocal value of doc,  to check if the doc is saved or not\n        frm.set_df_property('myfield',  'read_only',  frm.doc.__islocal ? 0 : 1);\n    } \n});\n\n// additional permission check\nfrappe.ui.form.on('Task',  {\n    validate: function(frm) {\n        if(user=='user1@example.com' && frm.doc.purpose!='Material Receipt') {\n            msgprint('You are only allowed Material Receipt');\n            validated = false;\n        }\n    } \n});\n\n// calculate sales incentive\nfrappe.ui.form.on('Sales Invoice',  {\n    validate: function(frm) {\n        // calculate incentives for each person on the deal\n        total_incentive = 0\n        $.each(frm.doc.sales_team,  function(i,  d) {\n            // calculate incentive\n            var incentive_percent = 2;\n            if(frm.doc.base_grand_total > 400) incentive_percent = 4;\n            // actual incentive\n            d.incentives = flt(frm.doc.base_grand_total) * incentive_percent / 100;\n            total_incentive += flt(d.incentives)\n        });\n        frm.doc.total_incentive = total_incentive;\n    } \n})\n\n
" + "label": "Sample" }, { "default": "0", @@ -76,7 +75,7 @@ "idx": 1, "index_web_pages_for_search": 1, "links": [], - "modified": "2021-09-04 12:03:27.029815", + "modified": "2022-02-18 00:43:33.941466", "modified_by": "Administrator", "module": "Custom", "name": "Client Script", @@ -107,5 +106,6 @@ ], "sort_field": "modified", "sort_order": "ASC", + "states": [], "track_changes": 1 } \ No newline at end of file From 74748c60b2cb9e84a6c68aa3a873dbc31ee52635 Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Fri, 18 Feb 2022 12:45:21 +0530 Subject: [PATCH 038/106] test: depends on for tabs --- cypress/integration/depends_on.js | 21 +++++++++++++++++++++ frappe/public/js/frappe/form/tab.js | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/cypress/integration/depends_on.js b/cypress/integration/depends_on.js index 9aa6b5d89d..c0dbbf63f6 100644 --- a/cypress/integration/depends_on.js +++ b/cypress/integration/depends_on.js @@ -55,10 +55,31 @@ context('Depends On', () => { 'read_only_depends_on': "eval:doc.test_field=='Some Other Value'", 'options': "Child Test Depends On" }, + { + "label": "Dependent Tab", + "fieldname": "dependent_tab", + "fieldtype": "Tab Break", + "depends_on": "eval:doc.test_field=='Show Tab'" + }, + { + "fieldname": "tab_section", + "fieldtype": "Section Break", + }, + { + "label": "Field in Tab", + "fieldname": "field_in_tab", + "fieldtype": "Data", + } ] }); }); }); + it('should show the tab on other setting field value', () => { + cy.new_form('Test Depends On'); + cy.fill_field('test_field', 'Show Tab'); + cy.get('body').click(); + cy.findByRole("tab", {name: "Dependent Tab"}).should('be.visible'); + }) it('should set the field as mandatory depending on other fields value', () => { cy.new_form('Test Depends On'); cy.fill_field('test_field', 'Some Value'); diff --git a/frappe/public/js/frappe/form/tab.js b/frappe/public/js/frappe/form/tab.js index c8ca016398..7df4d3a0cc 100644 --- a/frappe/public/js/frappe/form/tab.js +++ b/frappe/public/js/frappe/form/tab.js @@ -40,7 +40,7 @@ export default class Tab { hide = true; } - hide && this.toggle(false); + this.toggle(!hide) } toggle(show) { From b8539028909f7786f6be21ab6c8a1dc861496afa Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Fri, 18 Feb 2022 13:03:31 +0530 Subject: [PATCH 039/106] chore: add missing semicolon --- cypress/integration/depends_on.js | 2 +- frappe/public/js/frappe/form/tab.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cypress/integration/depends_on.js b/cypress/integration/depends_on.js index c0dbbf63f6..12f54f2b6e 100644 --- a/cypress/integration/depends_on.js +++ b/cypress/integration/depends_on.js @@ -79,7 +79,7 @@ context('Depends On', () => { cy.fill_field('test_field', 'Show Tab'); cy.get('body').click(); cy.findByRole("tab", {name: "Dependent Tab"}).should('be.visible'); - }) + }); it('should set the field as mandatory depending on other fields value', () => { cy.new_form('Test Depends On'); cy.fill_field('test_field', 'Some Value'); diff --git a/frappe/public/js/frappe/form/tab.js b/frappe/public/js/frappe/form/tab.js index 7df4d3a0cc..0e740ce49c 100644 --- a/frappe/public/js/frappe/form/tab.js +++ b/frappe/public/js/frappe/form/tab.js @@ -40,7 +40,7 @@ export default class Tab { hide = true; } - this.toggle(!hide) + this.toggle(!hide); } toggle(show) { From a307767dd5552e4c69a5b9467af7d712a235fecc Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Fri, 18 Feb 2022 17:14:34 +0530 Subject: [PATCH 040/106] refactor(minor): update_document_title API * Check for acceptable types * Check for DocType permission * Raise all exceptions if occured during document renaming --- frappe/model/rename_doc.py | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/frappe/model/rename_doc.py b/frappe/model/rename_doc.py index 6ffaadc5eb..73bda4e720 100644 --- a/frappe/model/rename_doc.py +++ b/frappe/model/rename_doc.py @@ -1,5 +1,6 @@ -# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +from typing import Optional import frappe from frappe import _, bold from frappe.model.dynamic_links import get_dynamic_link_map @@ -11,14 +12,32 @@ from frappe.query_builder import Field @frappe.whitelist() -def update_document_title(doctype, docname, title_field=None, old_title=None, new_title=None, new_name=None, merge=False): +def update_document_title( + doctype: str, + docname: str, + title_field: Optional[str] = None, + old_title: Optional[str] = None, + new_title: Optional[str] = None, + new_name: Optional[str] = None, + merge: bool = False, +) -> str: """ Update title from header in form view """ - if docname and new_name and not docname == new_name: + # TODO: omit this after runtime type checking (ref: https://github.com/frappe/frappe/pull/14927) + for obj in [docname, new_name, new_title, old_title]: + if not isinstance(obj, (str, None)): + frappe.throw(f"{obj} must be of type str or None") + + frappe.has_permission(doctype, ptype="write", throw=True) + + title_updated = old_title and new_title and (old_title != new_title) + name_updated = new_name and docname and (docname != new_name) + + if name_updated: docname = rename_doc(doctype=doctype, old=docname, new=new_name, merge=merge) - if old_title and new_title and not old_title == new_title: + if title_updated: try: frappe.db.set_value(doctype, docname, title_field, new_title) frappe.msgprint(_('Saved'), alert=True, indicator='green') @@ -27,8 +46,9 @@ def update_document_title(doctype, docname, title_field=None, old_title=None, ne frappe.throw( _("{0} {1} already exists").format(doctype, frappe.bold(docname)), title=_("Duplicate Name"), - exc=frappe.DuplicateEntryError + exc=frappe.DuplicateEntryError, ) + raise return docname From 953560af3544e6a256491d47f5a059833488a394 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Fri, 18 Feb 2022 17:16:44 +0530 Subject: [PATCH 041/106] chore: Add type hints for rename_doc module * Easier debugging ffs :crie: --- frappe/model/naming.py | 3 +- frappe/model/rename_doc.py | 82 +++++++++++++++++--------------- frappe/model/utils/rename_doc.py | 8 +++- 3 files changed, 51 insertions(+), 42 deletions(-) diff --git a/frappe/model/naming.py b/frappe/model/naming.py index b2d11a4cfc..9024b3d7b4 100644 --- a/frappe/model/naming.py +++ b/frappe/model/naming.py @@ -1,6 +1,7 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +from typing import Optional import frappe from frappe import _ from frappe.utils import now_datetime, cint, cstr @@ -283,7 +284,7 @@ def get_default_naming_series(doctype): return None -def validate_name(doctype, name, case=None, merge=False): +def validate_name(doctype: str, name: str, case: Optional[str] = None): if not name: frappe.throw(_("No Name Specified for {0}").format(doctype)) if name.startswith("New "+doctype): diff --git a/frappe/model/rename_doc.py b/frappe/model/rename_doc.py index 73bda4e720..ffd43fb1c7 100644 --- a/frappe/model/rename_doc.py +++ b/frappe/model/rename_doc.py @@ -1,14 +1,18 @@ # Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -from typing import Optional +from typing import TYPE_CHECKING, Dict, List, Optional + import frappe from frappe import _, bold from frappe.model.dynamic_links import get_dynamic_link_map from frappe.model.naming import validate_name from frappe.model.utils.user_settings import sync_user_settings, update_user_settings_data +from frappe.query_builder import Field from frappe.utils import cint from frappe.utils.password import rename_password -from frappe.query_builder import Field + +if TYPE_CHECKING: + from frappe.model.meta import Meta @frappe.whitelist() @@ -53,16 +57,16 @@ def update_document_title( return docname def rename_doc( - doctype, - old, - new, - force=False, - merge=False, - ignore_permissions=False, - ignore_if_exists=False, - show_alert=True, - rebuild_search=True -): + doctype: str, + old: str, + new: str, + force: bool = False, + merge: bool = False, + ignore_permissions: bool = False, + ignore_if_exists: bool = False, + show_alert: bool = True, + rebuild_search: bool = True, +) -> str: """Rename a doc(dt, old) to doc(dt, new) and update all linked fields of type "Link".""" if not frappe.db.exists(doctype, old): return @@ -99,7 +103,7 @@ def rename_doc( update_user_settings(old, new, link_fields) if doctype=='DocType': - rename_doctype(doctype, old, new, force) + rename_doctype(doctype, old, new) update_customizations(old, new) update_attachments(doctype, old, new) @@ -141,7 +145,7 @@ def rename_doc( return new -def update_assignments(old, new, doctype): +def update_assignments(old: str, new: str, doctype: str) -> None: old_assignments = frappe.parse_json(frappe.db.get_value(doctype, old, '_assign')) or [] new_assignments = frappe.parse_json(frappe.db.get_value(doctype, new, '_assign')) or [] common_assignments = list(set(old_assignments).intersection(new_assignments)) @@ -163,7 +167,7 @@ def update_assignments(old, new, doctype): unique_assignments = list(set(old_assignments + new_assignments)) frappe.db.set_value(doctype, new, '_assign', frappe.as_json(unique_assignments, indent=0)) -def update_user_settings(old, new, link_fields): +def update_user_settings(old: str, new: str, link_fields: List[Dict]) -> None: ''' Update the user settings of all the linked doctypes while renaming. ''' @@ -198,7 +202,7 @@ def update_user_settings(old, new, link_fields): def update_customizations(old: str, new: str) -> None: frappe.db.set_value("Custom DocPerm", {"parent": old}, "parent", new, update_modified=False) -def update_attachments(doctype, old, new): +def update_attachments(doctype: str, old: str, new: str) -> None: try: if old != "File Data" and doctype != "DocType": frappe.db.sql("""update `tabFile` set attached_to_name=%s @@ -207,11 +211,11 @@ def update_attachments(doctype, old, new): if not frappe.db.is_column_missing(e): raise -def rename_versions(doctype, old, new): +def rename_versions(doctype: str, old: str, new: str) -> None: frappe.db.sql("""UPDATE `tabVersion` SET `docname`=%s WHERE `ref_doctype`=%s AND `docname`=%s""", (new, doctype, old)) -def rename_eps_records(doctype, old, new): +def rename_eps_records(doctype: str, old: str, new: str) -> None: epl = frappe.qb.DocType("Energy Point Log") (frappe.qb.update(epl) .set(epl.reference_name, new) @@ -221,20 +225,20 @@ def rename_eps_records(doctype, old, new): ) ).run() -def rename_parent_and_child(doctype, old, new, meta): +def rename_parent_and_child(doctype: str, old: str, new: str, meta: "Meta") -> None: # rename the doc frappe.db.sql("UPDATE `tab{0}` SET `name`={1} WHERE `name`={1}".format(doctype, '%s'), (new, old)) update_autoname_field(doctype, new, meta) update_child_docs(old, new, meta) -def update_autoname_field(doctype, new, meta): +def update_autoname_field(doctype: str, new: str, meta: "Meta") -> None: # update the value of the autoname field on rename of the docname if meta.get('autoname'): field = meta.get('autoname').split(':') if field and field[0] == "field": frappe.db.sql("UPDATE `tab{0}` SET `{1}`={2} WHERE `name`={2}".format(doctype, field[1], '%s'), (new, new)) -def validate_rename(doctype, new, meta, merge, force, ignore_permissions): +def validate_rename(doctype: str, new: str, meta: "Meta", merge: bool, force: bool, ignore_permissions: bool) -> str: # using for update so that it gets locked and someone else cannot edit it while this rename is going on! exists = ( frappe.qb.from_(doctype) @@ -246,27 +250,27 @@ def validate_rename(doctype, new, meta, merge, force, ignore_permissions): exists = exists[0] if exists else None if merge and not exists: - frappe.msgprint(_("{0} {1} does not exist, select a new target to merge").format(doctype, new), raise_exception=1) + frappe.throw(_("{0} {1} does not exist, select a new target to merge").format(doctype, new)) if exists and exists != new: # for fixing case, accents exists = None if (not merge) and exists: - frappe.msgprint(_("Another {0} with name {1} exists, select another name").format(doctype, new), raise_exception=1) + frappe.throw(_("Another {0} with name {1} exists, select another name").format(doctype, new)) if not (ignore_permissions or frappe.permissions.has_permission(doctype, "write", raise_exception=False)): - frappe.msgprint(_("You need write permission to rename"), raise_exception=1) + frappe.throw(_("You need write permission to rename")) if not (force or ignore_permissions) and not meta.allow_rename: - frappe.msgprint(_("{0} not allowed to be renamed").format(_(doctype)), raise_exception=1) + frappe.throw(_("{0} not allowed to be renamed").format(_(doctype))) # validate naming like it's done in doc.py - new = validate_name(doctype, new, merge=merge) + new = validate_name(doctype, new) return new -def rename_doctype(doctype, old, new, force=False): +def rename_doctype(doctype: str, old: str, new: str) -> None: # change options for fieldtype Table, Table MultiSelect and Link fields_with_options = ("Link",) + frappe.model.table_fields @@ -281,13 +285,13 @@ def rename_doctype(doctype, old, new, force=False): # change parenttype for fieldtype Table update_parenttype_values(old, new) -def update_child_docs(old, new, meta): +def update_child_docs(old: str, new: str, meta: "Meta") -> None: # update "parent" for df in meta.get_table_fields(): frappe.db.sql("update `tab%s` set parent=%s where parent=%s" \ % (df.options, '%s', '%s'), (new, old)) -def update_link_field_values(link_fields, old, new, doctype): +def update_link_field_values(link_fields: List[Dict], old: str, new: str, doctype: str) -> None: for field in link_fields: if field['issingle']: try: @@ -322,7 +326,7 @@ def update_link_field_values(link_fields, old, new, doctype): if doctype=='DocType' and field['parent'] == old: field['parent'] = new -def get_link_fields(doctype): +def get_link_fields(doctype: str) -> List[Dict]: # get link fields from tabDocField if not frappe.flags.link_fields: frappe.flags.link_fields = {} @@ -365,7 +369,7 @@ def get_link_fields(doctype): return frappe.flags.link_fields[doctype] -def update_options_for_fieldtype(fieldtype, old, new): +def update_options_for_fieldtype(fieldtype: str, old: str, new: str) -> None: if frappe.conf.developer_mode: for name in frappe.get_all("DocField", filters={"options": old}, pluck="parent"): doctype = frappe.get_doc("DocType", name) @@ -386,7 +390,7 @@ def update_options_for_fieldtype(fieldtype, old, new): frappe.db.sql("""update `tabProperty Setter` set value=%s where property='options' and value=%s""", (new, old)) -def get_select_fields(old, new): +def get_select_fields(old: str, new: str) -> List[Dict]: """ get select type fields where doctype's name is hardcoded as new line separated list @@ -430,7 +434,7 @@ def get_select_fields(old, new): return select_fields -def update_select_field_values(old, new): +def update_select_field_values(old: str, new: str): frappe.db.sql(""" update `tabDocField` set options=replace(options, %s, %s) where @@ -453,7 +457,7 @@ def update_select_field_values(old, new): (value like {0} or value like {1})""" .format(frappe.db.escape('%' + '\n' + old + '%'), frappe.db.escape('%' + old + '\n' + '%')), (old, new, new)) -def update_parenttype_values(old, new): +def update_parenttype_values(old: str, new: str): child_doctypes = frappe.db.get_all('DocField', fields=['options', 'fieldname'], filters={ @@ -489,7 +493,7 @@ def update_parenttype_values(old, new): for doctype in child_doctypes: frappe.db.sql(f"update `tab{doctype}` set parenttype=%s where parenttype=%s", (new, old)) -def rename_dynamic_links(doctype, old, new): +def rename_dynamic_links(doctype: str, old: str, new: str): for df in get_dynamic_link_map().get(doctype, []): # dynamic link in single, just one value to check if frappe.get_meta(df.parent).issingle: @@ -505,7 +509,7 @@ def rename_dynamic_links(doctype, old, new): where {options}=%s and {fieldname}=%s""".format(parent = parent, fieldname=df.fieldname, options=df.options), (new, doctype, old)) -def bulk_rename(doctype, rows=None, via_console = False): +def bulk_rename(doctype: str, rows: Optional[List[List]] = None, via_console: bool = False) -> Optional[List[str]]: """Bulk rename documents :param doctype: DocType to be renamed @@ -543,7 +547,7 @@ def bulk_rename(doctype, rows=None, via_console = False): if not via_console: return rename_log -def update_linked_doctypes(doctype, docname, linked_to, value, ignore_doctypes=None): +def update_linked_doctypes(doctype: str, docname: str, linked_to: str, value: str, ignore_doctypes: Optional[List] = None) -> None: from frappe.model.utils.rename_doc import update_linked_doctypes show_deprecation_warning("update_linked_doctypes") @@ -556,7 +560,7 @@ def update_linked_doctypes(doctype, docname, linked_to, value, ignore_doctypes=N ) -def get_fetch_fields(doctype, linked_to, ignore_doctypes=None): +def get_fetch_fields(doctype: str, linked_to: str, ignore_doctypes: Optional[List] = None) -> List[Dict]: from frappe.model.utils.rename_doc import get_fetch_fields show_deprecation_warning("get_fetch_fields") @@ -564,7 +568,7 @@ def get_fetch_fields(doctype, linked_to, ignore_doctypes=None): doctype=doctype, linked_to=linked_to, ignore_doctypes=ignore_doctypes ) -def show_deprecation_warning(funct): +def show_deprecation_warning(funct: str) -> None: from click import secho message = ( f"Function frappe.model.rename_doc.{funct} has been deprecated and " diff --git a/frappe/model/utils/rename_doc.py b/frappe/model/utils/rename_doc.py index bf71d36a42..f7afbd0cf2 100644 --- a/frappe/model/utils/rename_doc.py +++ b/frappe/model/utils/rename_doc.py @@ -1,10 +1,14 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors +# License: MIT. See LICENSE + from itertools import product +from typing import Dict, List, Optional import frappe from frappe.model.rename_doc import get_link_fields -def update_linked_doctypes(doctype, docname, linked_to, value, ignore_doctypes=None): +def update_linked_doctypes(doctype: str, docname: str, linked_to: str, value: str, ignore_doctypes: Optional[List] = None): """ linked_doctype_info_list = list formed by get_fetch_fields() function docname = Master DocType's name in which modification are made @@ -24,7 +28,7 @@ def update_linked_doctypes(doctype, docname, linked_to, value, ignore_doctypes=N ) -def get_fetch_fields(doctype, linked_to, ignore_doctypes=None): +def get_fetch_fields(doctype: str, linked_to: str, ignore_doctypes: Optional[List] = None) -> List[Dict]: """ doctype = Master DocType in which the changes are being made linked_to = DocType name of the field thats being updated in Master From 2d5c9651df262ccbf2c21956970ac18c1902aab8 Mon Sep 17 00:00:00 2001 From: Sagar Vora Date: Fri, 18 Feb 2022 18:10:10 +0530 Subject: [PATCH 042/106] fix: share clickable URLs from List View --- frappe/public/js/frappe/list/list_view.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/public/js/frappe/list/list_view.js b/frappe/public/js/frappe/list/list_view.js index 64960e0b09..5cfc7c75d4 100644 --- a/frappe/public/js/frappe/list/list_view.js +++ b/frappe/public/js/frappe/list/list_view.js @@ -1483,7 +1483,7 @@ frappe.views.ListView = class ListView extends frappe.views.BaseList { return [ filter[1], "=", - JSON.stringify([filter[2], filter[3]]), + encodeURIComponent(JSON.stringify([filter[2], filter[3]])), ].join(""); }) .join("&"); From ec1817de66dc143042f42bd0de28b7fafaff49b9 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Fri, 18 Feb 2022 20:17:18 +0530 Subject: [PATCH 043/106] test: Add tests for rename_doc module --- frappe/tests/test_rename_doc.py | 90 ++++++++++++++++++++++++++++++--- 1 file changed, 82 insertions(+), 8 deletions(-) diff --git a/frappe/tests/test_rename_doc.py b/frappe/tests/test_rename_doc.py index 58cc5bb125..ef3348b01f 100644 --- a/frappe/tests/test_rename_doc.py +++ b/frappe/tests/test_rename_doc.py @@ -1,13 +1,40 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors +# License: MIT. See LICENSE + import os import unittest +from contextlib import contextmanager, redirect_stdout +from io import StringIO +from random import choice, sample +from typing import List +from unittest.mock import patch import frappe -from frappe.utils import add_to_date, now -from frappe.exceptions import DoesNotExistError - -from random import choice, sample +from frappe.exceptions import DoesNotExistError, ValidationError from frappe.model.base_document import get_controller +from frappe.model.rename_doc import bulk_rename, get_fetch_fields, update_linked_doctypes from frappe.modules.utils import get_doc_path +from frappe.utils import add_to_date, now + + +@contextmanager +def patch_db(endpoints: List[str] = None): + patched_endpoints = [] + + for point in endpoints: + x = patch(f"frappe.db.{point}", new=lambda: True) + patched_endpoints.append(x) + + savepoint = "SAVEPOINT_for_test_bulk_rename" + frappe.db.savepoint(save_point=savepoint) + try: + for x in patched_endpoints: + x.start() + yield + finally: + for x in patched_endpoints: + x.stop() + frappe.db.rollback(save_point=savepoint) class TestRenameDoc(unittest.TestCase): @@ -50,6 +77,11 @@ class TestRenameDoc(unittest.TestCase): @classmethod def tearDownClass(self): """Deleting data generated for the tests defined under TestRenameDoc""" + # delete_doc doesnt drop tables + # this is done to bypass inconsistencies in the db + frappe.delete_doc_if_exists("DocType", "Renamed Doc") + frappe.db.sql_ddl("drop table if exists `tabRenamed Doc`") + # delete the documents created for docname in self.available_documents: frappe.delete_doc(self.test_doctype, docname) @@ -153,7 +185,49 @@ class TestRenameDoc(unittest.TestCase): new_name, frappe.rename_doc("Renamed Doc", old_name, new_name, force=True) ) - # delete_doc doesnt drop tables - # this is done to bypass inconsistencies in the db - frappe.delete_doc_if_exists("DocType", "Renamed Doc") - frappe.db.sql_ddl("drop table if exists `tabRenamed Doc`") + def test_update_title_api(self): + from frappe.model.rename_doc import update_document_title + allow_rename_prop = frappe.db.get_value("DocType", self.test_doctype, "allow_rename") + frappe.clear_cache() + if not frappe.get_meta(self.test_doctype).allow_rename: + frappe.db.set_value("DocType", self.test_doctype, "allow_rename", 1, update_modified=False) + + dt = self.test_doctype + dn = self.available_documents[0] + new_name = f"{dn}-new" + + # pass invalid types to API + with self.assertRaises(ValidationError): + update_document_title(dt, dn, {}, {"hack": "this"}) + + doc_before = frappe.get_doc(self.test_doctype, dn) + update_document_title(dt, dn, new_name=new_name) + doc_after = frappe.get_doc(self.test_doctype, new_name) + + self.assertEqual(doc_before.description, doc_after.description) + self.assertEqual(doc_before.creation, doc_after.creation) + self.assertEqual(doc_before.owner, doc_after.owner) + + self.available_documents[0] = new_name + frappe.db.set_value("DocType", self.test_doctype, "allow_rename", allow_rename_prop, update_modified=False) + + def test_bulk_rename(self): + input_data = [[x, f"{x}-new"] for x in self.available_documents] + + with patch_db(["commit", "rollback"]), patch("frappe.enqueue") as enqueue: + message_log = bulk_rename(self.test_doctype, input_data, via_console=False) + self.assertEqual(len(message_log), len(self.available_documents)) + self.assertIsInstance(message_log, list) + enqueue.assert_called_with( + 'frappe.utils.global_search.rebuild_for_doctype', doctype=self.test_doctype, + ) + + def test_deprecated_utils(self): + stdout = StringIO() + + with redirect_stdout(stdout), patch_db(["set_value"]): + get_fetch_fields("User", "ToDo", ["Activity Log"]) + self.assertTrue("Function frappe.model.rename_doc.get_fetch_fields" in stdout.getvalue()) + + update_linked_doctypes("User", "ToDo", "str", "str") + self.assertTrue("Function frappe.model.rename_doc.update_linked_doctypes" in stdout.getvalue()) From 8aedf6410a3dc401a4153f7676dbcce0d55084ec Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Fri, 18 Feb 2022 20:17:39 +0530 Subject: [PATCH 044/106] fix: None is not NoneType * also, rename test ;) --- frappe/model/rename_doc.py | 2 +- frappe/tests/test_rename_doc.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/frappe/model/rename_doc.py b/frappe/model/rename_doc.py index ffd43fb1c7..88752103ae 100644 --- a/frappe/model/rename_doc.py +++ b/frappe/model/rename_doc.py @@ -30,7 +30,7 @@ def update_document_title( """ # TODO: omit this after runtime type checking (ref: https://github.com/frappe/frappe/pull/14927) for obj in [docname, new_name, new_title, old_title]: - if not isinstance(obj, (str, None)): + if not isinstance(obj, (str, type(None))): frappe.throw(f"{obj} must be of type str or None") frappe.has_permission(doctype, ptype="write", throw=True) diff --git a/frappe/tests/test_rename_doc.py b/frappe/tests/test_rename_doc.py index ef3348b01f..e86bd9cde2 100644 --- a/frappe/tests/test_rename_doc.py +++ b/frappe/tests/test_rename_doc.py @@ -185,7 +185,7 @@ class TestRenameDoc(unittest.TestCase): new_name, frappe.rename_doc("Renamed Doc", old_name, new_name, force=True) ) - def test_update_title_api(self): + def test_update_document_title_api(self): from frappe.model.rename_doc import update_document_title allow_rename_prop = frappe.db.get_value("DocType", self.test_doctype, "allow_rename") frappe.clear_cache() From d5ce2b4a8c10af3bad7c74ec2043fb882f6ecd4f Mon Sep 17 00:00:00 2001 From: Deepesh Garg <42651287+deepeshgarg007@users.noreply.github.com> Date: Sat, 19 Feb 2022 21:22:35 +0530 Subject: [PATCH 045/106] fix: Totalling for tree view reports (#15950) --- frappe/core/doctype/report/test_report.py | 54 ++++++++++++++++++- frappe/desk/query_report.py | 24 ++++++--- .../js/frappe/views/reports/query_report.js | 5 +- 3 files changed, 73 insertions(+), 10 deletions(-) diff --git a/frappe/core/doctype/report/test_report.py b/frappe/core/doctype/report/test_report.py index 5a22304f32..bf63afa5c5 100644 --- a/frappe/core/doctype/report/test_report.py +++ b/frappe/core/doctype/report/test_report.py @@ -3,7 +3,7 @@ import frappe, json, os import unittest -from frappe.desk.query_report import run, save_report +from frappe.desk.query_report import run, save_report, add_total_row from frappe.desk.reportview import delete_report, save_report as _save_report from frappe.custom.doctype.customize_form.customize_form import reset_customization from frappe.core.doctype.user_permission.test_user_permission import create_user @@ -282,3 +282,55 @@ result = [ # Set user back to administrator frappe.set_user('Administrator') + + def test_add_total_row_for_tree_reports(self): + report_settings = { + 'tree': True, + 'parent_field': 'parent_value' + } + + columns = [ + { + "fieldname": "parent_column", + "label": "Parent Column", + "fieldtype": "Data", + "width": 10 + }, + { + "fieldname": "column_1", + "label": "Column 1", + "fieldtype": "Float", + "width": 10 + }, + { + "fieldname": "column_2", + "label": "Column 2", + "fieldtype": "Float", + "width": 10 + } + ] + + result = [ + { + "parent_column": "Parent 1", + "column_1": 200, + "column_2": 150.50 + }, + { + "parent_column": "Child 1", + "column_1": 100, + "column_2": 75.25, + "parent_value": "Parent 1" + }, + { + "parent_column": "Child 2", + "column_1": 100, + "column_2": 75.25, + "parent_value": "Parent 1" + } + ] + + result = add_total_row(result, columns, meta=None, report_settings=report_settings) + self.assertEqual(result[-1][0], "Total") + self.assertEqual(result[-1][1], 200) + self.assertEqual(result[-1][2], 150.50) diff --git a/frappe/desk/query_report.py b/frappe/desk/query_report.py index 97bceeb725..9ed956e986 100644 --- a/frappe/desk/query_report.py +++ b/frappe/desk/query_report.py @@ -73,7 +73,7 @@ def get_report_result(report, filters): return res @frappe.read_only() -def generate_report_result(report, filters=None, user=None, custom_columns=None): +def generate_report_result(report, filters=None, user=None, custom_columns=None, report_settings=None): user = user or frappe.session.user filters = filters or [] @@ -108,7 +108,7 @@ def generate_report_result(report, filters=None, user=None, custom_columns=None) result = get_filtered_data(report.ref_doctype, columns, result, user) if cint(report.add_total_row) and result and not skip_total_row: - result = add_total_row(result, columns) + result = add_total_row(result, columns, report_settings=report_settings) return { "result": result, @@ -210,7 +210,7 @@ def get_script(report_name): @frappe.whitelist() @frappe.read_only() -def run(report_name, filters=None, user=None, ignore_prepared_report=False, custom_columns=None): +def run(report_name, filters=None, user=None, ignore_prepared_report=False, custom_columns=None, report_settings=None): report = get_report_doc(report_name) if not user: user = frappe.session.user @@ -238,7 +238,7 @@ def run(report_name, filters=None, user=None, ignore_prepared_report=False, cust dn = "" result = get_prepared_report_result(report, filters, dn, user) else: - result = generate_report_result(report, filters, user, custom_columns) + result = generate_report_result(report, filters, user, custom_columns, report_settings) result["add_total_row"] = report.add_total_row and not result.get( "skip_total_row", False @@ -435,9 +435,19 @@ def build_xlsx_data(columns, data, visible_idx, include_indentation, ignore_visi return result, column_widths -def add_total_row(result, columns, meta=None): +def add_total_row(result, columns, meta=None, report_settings=None): total_row = [""] * len(columns) has_percent = [] + is_tree = False + parent_field = '' + + if report_settings: + if isinstance(report_settings, (str,)): + report_settings = json.loads(report_settings) + + is_tree = report_settings.get('tree') + parent_field = report_settings.get('parent_field') + for i, col in enumerate(columns): fieldtype, options, fieldname = None, None, None if isinstance(col, str): @@ -464,12 +474,12 @@ def add_total_row(result, columns, meta=None): for row in result: if i >= len(row): continue - cell = row.get(fieldname) if isinstance(row, dict) else row[i] if fieldtype in ["Currency", "Int", "Float", "Percent", "Duration"] and flt( cell ): - total_row[i] = flt(total_row[i]) + flt(cell) + if not (is_tree and row.get(parent_field)): + total_row[i] = flt(total_row[i]) + flt(cell) if fieldtype == "Percent" and i not in has_percent: has_percent.append(i) diff --git a/frappe/public/js/frappe/views/reports/query_report.js b/frappe/public/js/frappe/views/reports/query_report.js index 7ba0a0228f..c226a3a458 100644 --- a/frappe/public/js/frappe/views/reports/query_report.js +++ b/frappe/public/js/frappe/views/reports/query_report.js @@ -578,6 +578,7 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList { args: { report_name: this.report_name, filters: filters, + report_settings: this.report_settings }, callback: resolve, always: () => this.page.btn_secondary.prop('disabled', false) @@ -834,7 +835,7 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList { let data = this.data; let columns = this.columns.filter((col) => !col.hidden); - if (this.raw_data.add_total_row) { + if (this.raw_data.add_total_row && !this.report_settings.tree) { data = data.slice(); data.splice(-1, 1); } @@ -854,7 +855,7 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList { treeView: this.tree_report, layout: 'fixed', cellHeight: 33, - showTotalRow: this.raw_data.add_total_row, + showTotalRow: this.raw_data.add_total_row && !this.report_settings.tree, direction: frappe.utils.is_rtl() ? 'rtl' : 'ltr', hooks: { columnTotal: frappe.utils.report_column_total From 5de89df5b77d6b02f7662ac21006aa3301192f08 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Mon, 21 Feb 2022 09:32:44 +0530 Subject: [PATCH 046/106] ci: Only upload server-side coverage report if .py files are changed --- .github/helper/roulette.py | 13 +++++++++---- .github/workflows/ui-tests.yml | 3 ++- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/helper/roulette.py b/.github/helper/roulette.py index 9831df7f30..f0caa74e96 100644 --- a/.github/helper/roulette.py +++ b/.github/helper/roulette.py @@ -52,7 +52,8 @@ if __name__ == "__main__": ci_files_changed = any(f for f in files_list if is_ci(f)) only_docs_changed = len(list(filter(is_docs, files_list))) == len(files_list) only_frontend_code_changed = len(list(filter(is_frontend_code, files_list))) == len(files_list) - only_py_changed = len(list(filter(is_py, files_list))) == len(files_list) + updated_py_file_count = len(list(filter(is_py, files_list))) + only_py_changed = updated_py_file_count == len(files_list) if ci_files_changed: print("CI related files were updated, running all build processes.") @@ -65,8 +66,12 @@ if __name__ == "__main__": print("Only Frontend code was updated; Stopping Python build process.") sys.exit(0) - elif only_py_changed and build_type == "ui": - print("Only Python code was updated, stopping Cypress build process.") - sys.exit(0) + elif build_type == "ui": + if only_py_changed: + print("Only Python code was updated, stopping Cypress build process.") + sys.exit(0) + elif updated_py_file_count > 0: + # both frontend and backend code were updated + os.system('echo "::set-output name=build-server::strawberry"') os.system('echo "::set-output name=build::strawberry"') diff --git a/.github/workflows/ui-tests.yml b/.github/workflows/ui-tests.yml index 91369dcaaa..fc8093444e 100644 --- a/.github/workflows/ui-tests.yml +++ b/.github/workflows/ui-tests.yml @@ -142,6 +142,7 @@ jobs: CYPRESS_RECORD_KEY: 4a48f41c-11b3-425b-aa88-c58048fa69eb - name: Stop server + if: ${{ steps.check-build.outputs.build-server == 'strawberry' }} run: | ps -ef | grep "frappe serve" | awk '{print $2}' | xargs kill -s SIGINT 2> /dev/null || true sleep 5 @@ -163,7 +164,7 @@ jobs: flags: ui-tests - name: Upload Server Coverage Data - if: ${{ steps.check-build.outputs.build == 'strawberry' }} + if: ${{ steps.check-build.outputs.build-server == 'strawberry' }} uses: codecov/codecov-action@v2 with: name: MariaDB From 21fcd00416fac36cbbbf0f1187f62ba4451ed369 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Mon, 21 Feb 2022 11:07:37 +0530 Subject: [PATCH 047/106] ci: While running all builds set build-server as well --- .github/helper/roulette.py | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/helper/roulette.py b/.github/helper/roulette.py index f0caa74e96..90f4608a22 100644 --- a/.github/helper/roulette.py +++ b/.github/helper/roulette.py @@ -41,6 +41,7 @@ if __name__ == "__main__": # this is a push build, run all builds if not pr_number: os.system('echo "::set-output name=build::strawberry"') + os.system('echo "::set-output name=build-server::strawberry"') sys.exit(0) files_list = files_list or get_files_list(pr_number=pr_number, repo=repo) From 25af0c82173d4a7fb28fa7a5c4d9c0e5c723edb8 Mon Sep 17 00:00:00 2001 From: lapardnemihk1099 Date: Mon, 21 Feb 2022 13:36:39 +0530 Subject: [PATCH 048/106] chore: unnecessary JS warning if options are not defined in date field --- frappe/public/js/frappe/form/controls/date.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/frappe/public/js/frappe/form/controls/date.js b/frappe/public/js/frappe/form/controls/date.js index 7ad1887d62..fa9dc1c99e 100644 --- a/frappe/public/js/frappe/form/controls/date.js +++ b/frappe/public/js/frappe/form/controls/date.js @@ -158,8 +158,10 @@ frappe.ui.form.ControlDate = class ControlDate extends frappe.ui.form.ControlDat return value; } get_df_options() { + if(!this.df.options) return {}; + let options = {}; - let df_options = this.df.options || ''; + let df_options = this.df.options; if (typeof df_options === 'string') { try { options = JSON.parse(df_options); From e562368069a5e604d22b2bdcac34368c92fee9fd Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Mon, 21 Feb 2022 13:43:53 +0530 Subject: [PATCH 049/106] fix: Fix if table_field exists in meta of link.parent_doctype --- frappe/core/doctype/doctype/doctype.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/frappe/core/doctype/doctype/doctype.py b/frappe/core/doctype/doctype/doctype.py index 6d0409521e..7d75ef7ba9 100644 --- a/frappe/core/doctype/doctype/doctype.py +++ b/frappe/core/doctype/doctype/doctype.py @@ -784,10 +784,9 @@ def validate_links_table_fieldnames(meta): if not meta.links or frappe.flags.in_patch or frappe.flags.in_fixtures: return - fieldnames = tuple(field.fieldname for field in meta.fields) for index, link in enumerate(meta.links, 1): link_meta = frappe.get_meta(link.link_doctype) - if not link_meta.get_field(link.link_fieldname): + if not frappe.get_meta(link.link_doctype).has_field(link.link_fieldname): message = _("Document Links Row #{0}: Could not find field {1} in {2} DocType").format(index, frappe.bold(link.link_fieldname), frappe.bold(link.link_doctype)) frappe.throw(message, InvalidFieldNameError, _("Invalid Fieldname")) @@ -802,7 +801,7 @@ def validate_links_table_fieldnames(meta): message = _("Document Links Row #{0}: Table Fieldname is mandatory for internal links").format(index) frappe.throw(message, frappe.ValidationError, _("Table Fieldname Missing")) - if link.table_fieldname not in fieldnames: + if not frappe.get_meta(link.parent_doctype).has_field(link.table_fieldname): message = _("Document Links Row #{0}: Could not find field {1} in {2} DocType").format(index, frappe.bold(link.table_fieldname), frappe.bold(meta.name)) frappe.throw(message, frappe.ValidationError, _("Invalid Table Fieldname")) From 88791c22648ab25fb95543441646b81a2c7ca60a Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Mon, 21 Feb 2022 14:25:34 +0530 Subject: [PATCH 050/106] test: Set correct parent doctype for document link --- frappe/custom/doctype/customize_form/test_customize_form.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/frappe/custom/doctype/customize_form/test_customize_form.py b/frappe/custom/doctype/customize_form/test_customize_form.py index 0fe39e0008..d131f06127 100644 --- a/frappe/custom/doctype/customize_form/test_customize_form.py +++ b/frappe/custom/doctype/customize_form/test_customize_form.py @@ -257,7 +257,7 @@ class TestCustomizeForm(unittest.TestCase): frappe.clear_cache() d = self.get_customize_form("User Group") - d.append('links', dict(link_doctype='User Group Member', parent_doctype='User', + d.append('links', dict(link_doctype='User Group Member', parent_doctype='User Group', link_fieldname='user', table_fieldname='user_group_members', group='Tests', custom=1)) d.run_method("save_customization") @@ -267,7 +267,7 @@ class TestCustomizeForm(unittest.TestCase): # check links exist self.assertTrue([d.name for d in user_group.links if d.link_doctype == 'User Group Member']) - self.assertTrue([d.name for d in user_group.links if d.parent_doctype == 'User']) + self.assertTrue([d.name for d in user_group.links if d.parent_doctype == 'User Group']) # remove the link d = self.get_customize_form("User Group") From c775ca1d1dc0765e10fa70ad32dbdb0abff7d85f Mon Sep 17 00:00:00 2001 From: Benedict Allerberger Date: Mon, 21 Feb 2022 12:42:56 +0100 Subject: [PATCH 051/106] feat(minor): Add Custom Group Search for custom LDAP servers --- .../doctype/ldap_settings/ldap_settings.json | 7 +++++++ .../integrations/doctype/ldap_settings/ldap_settings.py | 9 ++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/frappe/integrations/doctype/ldap_settings/ldap_settings.json b/frappe/integrations/doctype/ldap_settings/ldap_settings.json index d915ae2ad6..fd45a71538 100644 --- a/frappe/integrations/doctype/ldap_settings/ldap_settings.json +++ b/frappe/integrations/doctype/ldap_settings/ldap_settings.json @@ -38,6 +38,7 @@ "local_ca_certs_file", "ldap_custom_settings_section", "ldap_group_objectclass", + "ldap_custom_group_search", "column_break_33", "ldap_group_member_attribute", "ldap_group_mappings_section", @@ -247,6 +248,12 @@ "fieldtype": "Data", "label": "Group Object Class" }, + { + "description": "string value, i.e. {0} or uid={0},ou=users,dc=example,dc=com", + "fieldname": "ldap_custom_group_search", + "fieldtype": "Data", + "label": "Custom Group Search" + }, { "description": "Requires any valid fdn path. i.e. ou=users,dc=example,dc=com", "fieldname": "ldap_search_path_user", diff --git a/frappe/integrations/doctype/ldap_settings/ldap_settings.py b/frappe/integrations/doctype/ldap_settings/ldap_settings.py index 3d29feebac..f16d126440 100644 --- a/frappe/integrations/doctype/ldap_settings/ldap_settings.py +++ b/frappe/integrations/doctype/ldap_settings/ldap_settings.py @@ -49,6 +49,10 @@ class LDAPSettings(Document): frappe.throw(_("Custom LDAP Directoy Selected, please ensure 'LDAP Group Member attribute' and 'Group Object Class' are entered"), title=_("Misconfigured")) + if self.ldap_custom_group_search and "{0}" not in self.ldap_custom_group_search: + frappe.throw(_("Custom Group Search if filled needs to contain the user placeholder {0}, eg uid={0},ou=users,dc=example,dc=com"), + title=_("Misconfigured")) + else: frappe.throw(_("LDAP Search String must be enclosed in '()' and needs to contian the user placeholder {0}, eg sAMAccountName={0}")) @@ -209,7 +213,10 @@ class LDAPSettings(Document): ldap_object_class = self.ldap_group_objectclass ldap_group_members_attribute = self.ldap_group_member_attribute - user_search_str = getattr(user, self.ldap_username_field).value + ldap_custom_group_search = "{0}" + if self.ldap_custom_group_search: + ldap_custom_group_search = self.ldap_custom_group_search + user_search_str = ldap_custom_group_search.format(getattr(user, self.ldap_username_field).value) else: # NOTE: depreciate this else path From 745297a49d516e5e3c4bb3e1b0c4235e7d31165d Mon Sep 17 00:00:00 2001 From: barredterra <14891507+barredterra@users.noreply.github.com> Date: Mon, 21 Feb 2022 19:54:34 +0100 Subject: [PATCH 052/106] refactor: a not in b Search: if not ([\w\d]*?) in ([\w\d]*?) Replace: if $1 not in $2 --- frappe/database/database.py | 2 +- frappe/desk/reportview.py | 5 +++-- frappe/desk/treeview.py | 2 +- frappe/installer.py | 2 +- frappe/model/db_query.py | 4 ++-- frappe/model/rename_doc.py | 2 +- frappe/model/sync.py | 2 +- frappe/realtime.py | 2 +- frappe/test_runner.py | 4 ++-- frappe/translate.py | 2 +- frappe/utils/redis_wrapper.py | 4 ++-- frappe/utils/user.py | 2 +- frappe/website/utils.py | 2 +- 13 files changed, 18 insertions(+), 17 deletions(-) mode change 100755 => 100644 frappe/utils/user.py diff --git a/frappe/database/database.py b/frappe/database/database.py index c833bdeed3..dc9f20d8c2 100644 --- a/frappe/database/database.py +++ b/frappe/database/database.py @@ -584,7 +584,7 @@ class Database(object): company = frappe.db.get_single_value('Global Defaults', 'default_company') """ - if not doctype in self.value_cache: + if doctype not in self.value_cache: self.value_cache[doctype] = {} if cache and fieldname in self.value_cache[doctype]: diff --git a/frappe/desk/reportview.py b/frappe/desk/reportview.py index b0e1f901aa..1ec8ede62e 100644 --- a/frappe/desk/reportview.py +++ b/frappe/desk/reportview.py @@ -533,7 +533,8 @@ def get_stats(stats, doctype, filters=None): columns = [] for tag in tags: - if not tag in columns: continue + if tag not in columns: + continue try: tag_count = frappe.get_list(doctype, fields=[tag, "count(*)"], @@ -612,7 +613,7 @@ def scrub_user_tags(tagcount): alltags = t.split(',') for tag in alltags: if tag: - if not tag in rdict: + if tag not in rdict: rdict[tag] = 0 rdict[tag] += tagdict[t] diff --git a/frappe/desk/treeview.py b/frappe/desk/treeview.py index 7e3efb5d48..5e8fb18fe4 100644 --- a/frappe/desk/treeview.py +++ b/frappe/desk/treeview.py @@ -15,7 +15,7 @@ def get_all_nodes(doctype, label, parent, tree_method, **filters): tree_method = frappe.get_attr(tree_method) - if not tree_method in frappe.whitelisted: + if tree_method not in frappe.whitelisted: frappe.throw(_("Not Permitted"), frappe.PermissionError) data = tree_method(doctype, parent, **filters) diff --git a/frappe/installer.py b/frappe/installer.py index 0948620ab0..20db451d26 100644 --- a/frappe/installer.py +++ b/frappe/installer.py @@ -184,7 +184,7 @@ def install_app(name, verbose=False, set_as_patched=True): def add_to_installed_apps(app_name, rebuild_website=True): installed_apps = frappe.get_installed_apps() - if not app_name in installed_apps: + if app_name not in installed_apps: installed_apps.append(app_name) frappe.db.set_global("installed_apps", json.dumps(installed_apps)) frappe.db.commit() diff --git a/frappe/model/db_query.py b/frappe/model/db_query.py index 79be261981..a6b96e8fb5 100644 --- a/frappe/model/db_query.py +++ b/frappe/model/db_query.py @@ -330,7 +330,7 @@ class DatabaseQuery(object): table_name = table_name[7:] if not table_name[0]=='`': table_name = f"`{table_name}`" - if not table_name in self.tables: + if table_name not in self.tables: self.append_table(table_name) def append_table(self, table_name): @@ -428,7 +428,7 @@ class DatabaseQuery(object): f = get_filter(self.doctype, f, additional_filters_config) tname = ('`tab' + f.doctype + '`') - if not tname in self.tables: + if tname not in self.tables: self.append_table(tname) if 'ifnull(' in f.fieldname: diff --git a/frappe/model/rename_doc.py b/frappe/model/rename_doc.py index 6ffaadc5eb..d825261617 100644 --- a/frappe/model/rename_doc.py +++ b/frappe/model/rename_doc.py @@ -307,7 +307,7 @@ def get_link_fields(doctype): if not frappe.flags.link_fields: frappe.flags.link_fields = {} - if not doctype in frappe.flags.link_fields: + if doctype not in frappe.flags.link_fields: link_fields = frappe.db.sql("""\ select parent, fieldname, (select issingle from tabDocType dt diff --git a/frappe/model/sync.py b/frappe/model/sync.py index 9ba14d5e68..109260d0fe 100644 --- a/frappe/model/sync.py +++ b/frappe/model/sync.py @@ -117,7 +117,7 @@ def get_doc_files(files, start_path): if os.path.isdir(os.path.join(doctype_path, docname)): doc_path = os.path.join(doctype_path, docname, docname) + ".json" if os.path.exists(doc_path): - if not doc_path in files: + if doc_path not in files: files.append(doc_path) return files diff --git a/frappe/realtime.py b/frappe/realtime.py index aa0e2fddad..e0f64d32fb 100644 --- a/frappe/realtime.py +++ b/frappe/realtime.py @@ -65,7 +65,7 @@ def publish_realtime(event=None, message=None, room=None, if after_commit: params = [event, message, room] - if not params in frappe.local.realtime_log: + if params not in frappe.local.realtime_log: frappe.local.realtime_log.append(params) else: emit_via_redis(event, message, room) diff --git a/frappe/test_runner.py b/frappe/test_runner.py index 05f1ce1cd7..20759331c3 100644 --- a/frappe/test_runner.py +++ b/frappe/test_runner.py @@ -285,7 +285,7 @@ def make_test_records(doctype, verbose=0, force=False): if options == "[Select]": continue - if not options in frappe.local.test_objects: + if options not in frappe.local.test_objects: frappe.local.test_objects[options] = [] make_test_records(options, verbose, force) make_test_records_for_doctype(options, verbose, force) @@ -425,7 +425,7 @@ def add_to_test_record_log(doctype): '''Add `doctype` to site/.test_log `.test_log` is a cache of all doctypes for which test records are created''' test_record_log = get_test_record_log() - if not doctype in test_record_log: + if doctype not in test_record_log: frappe.flags.test_record_log.append(doctype) with open(frappe.get_site_path('.test_log'), 'w') as f: f.write('\n'.join(filter(None, frappe.flags.test_record_log))) diff --git a/frappe/translate.py b/frappe/translate.py index c883e63de3..c7293aa9f1 100644 --- a/frappe/translate.py +++ b/frappe/translate.py @@ -135,7 +135,7 @@ def get_dict(fortype, name=None): asset_key = fortype + ":" + (name or "-") translation_assets = cache.hget("translation_assets", frappe.local.lang, shared=True) or {} - if not asset_key in translation_assets: + if asset_key not in translation_assets: messages = [] if fortype=="doctype": messages = get_messages_from_doctype(name) diff --git a/frappe/utils/redis_wrapper.py b/frappe/utils/redis_wrapper.py index 9ca5bbfd4f..c40180b538 100644 --- a/frappe/utils/redis_wrapper.py +++ b/frappe/utils/redis_wrapper.py @@ -154,7 +154,7 @@ class RedisWrapper(redis.Redis): _name = self.make_key(name, shared=shared) # set in local - if not _name in frappe.local.cache: + if _name not in frappe.local.cache: frappe.local.cache[_name] = {} frappe.local.cache[_name][key] = value @@ -173,7 +173,7 @@ class RedisWrapper(redis.Redis): def hget(self, name, key, generator=None, shared=False): _name = self.make_key(name, shared=shared) - if not _name in frappe.local.cache: + if _name not in frappe.local.cache: frappe.local.cache[_name] = {} if not key: return None diff --git a/frappe/utils/user.py b/frappe/utils/user.py old mode 100755 new mode 100644 index cbf38f6acb..ca7a555c72 --- a/frappe/utils/user.py +++ b/frappe/utils/user.py @@ -79,7 +79,7 @@ class UserPermissions: for r in get_valid_perms(): dt = r['parent'] - if not dt in self.perm_map: + if dt not in self.perm_map: self.perm_map[dt] = {} for k in frappe.permissions.rights: diff --git a/frappe/website/utils.py b/frappe/website/utils.py index 152d312533..f0a8da7736 100644 --- a/frappe/website/utils.py +++ b/frappe/website/utils.py @@ -226,7 +226,7 @@ def get_full_index(route=None, app=None): # order as per index if present for route, children in children_map.items(): - if not route in pages: + if route not in pages: # no parent (?) continue From be51b60c84be413dda503466c940e6fc3c36efc2 Mon Sep 17 00:00:00 2001 From: barredterra <14891507+barredterra@users.noreply.github.com> Date: Mon, 21 Feb 2022 19:56:45 +0100 Subject: [PATCH 053/106] chore: ignore rev in blame --- .git-blame-ignore-revs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs index f02694846d..633c5fcfe2 100644 --- a/.git-blame-ignore-revs +++ b/.git-blame-ignore-revs @@ -13,3 +13,6 @@ fe20515c23a3ac41f1092bf0eaf0a0a452ec2e85 # Updating license headers 34460265554242a8d05fb09f049033b1117e1a2b + +# Refactor "not a in b" -> "a not in b" +745297a49d516e5e3c4bb3e1b0c4235e7d31165d From b2116ff36dff134f711022f1dc44378b3f799f15 Mon Sep 17 00:00:00 2001 From: cpdeethree Date: Mon, 21 Feb 2022 20:20:10 -0600 Subject: [PATCH 054/106] fix: error in table creation from incorrect scope --- frappe/database/postgres/schema.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/frappe/database/postgres/schema.py b/frappe/database/postgres/schema.py index 9487bc2fa7..f6235b6ff5 100644 --- a/frappe/database/postgres/schema.py +++ b/frappe/database/postgres/schema.py @@ -19,15 +19,15 @@ class PostgresTable(DBTable): add_text += ",\n".join( ( - "parent varchar({varchar_len})", - "parentfield varchar({varchar_len})", - "parenttype varchar({varchar_len})" + "parent varchar({varchar_len})".format(varchar_len=frappe.db.VARCHAR_LEN), + "parentfield varchar({varchar_len})".format(varchar_len=frappe.db.VARCHAR_LEN), + "parenttype varchar({varchar_len})".format(varchar_len=frappe.db.VARCHAR_LEN) ) ) # TODO: set docstatus length # create table - frappe.db.sql(("""create table `%s` ( + frappe.db.sql("""create table `%s` ( name varchar({varchar_len}) not null primary key, creation timestamp(6), modified timestamp(6), @@ -35,7 +35,7 @@ class PostgresTable(DBTable): owner varchar({varchar_len}), docstatus smallint not null default '0', idx bigint not null default '0', - %s)""" % (self.table_name, add_text)).format(varchar_len=frappe.db.VARCHAR_LEN)) + %s)""".format(varchar_len=frappe.db.VARCHAR_LEN) % (self.table_name, add_text)) self.create_indexes() frappe.db.commit() From dc351b1a82fd32269c070e53d0bc8b0823e1e853 Mon Sep 17 00:00:00 2001 From: Suraj Shetty <13928957+surajshetty3416@users.noreply.github.com> Date: Tue, 22 Feb 2022 08:29:02 +0530 Subject: [PATCH 055/106] chore: Remove flag from codecov badge To get the actual coverage of the repository --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ef471aa05a..8c8317c8bd 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ - +
From 8e3e0df5d7b99dd4f46eb7355d4c115439406034 Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Mon, 21 Feb 2022 15:55:30 +0530 Subject: [PATCH 056/106] fix(minor): throttle listview refresh on same args for 3 seconds --- frappe/public/js/frappe/list/base_list.js | 18 +++++++++++++++++- .../public/js/frappe/ui/filters/filter_list.js | 2 +- frappe/public/scss/common/modal.scss | 5 +++++ 3 files changed, 23 insertions(+), 2 deletions(-) diff --git a/frappe/public/js/frappe/list/base_list.js b/frappe/public/js/frappe/list/base_list.js index d09a1c7043..2ea6e55666 100644 --- a/frappe/public/js/frappe/list/base_list.js +++ b/frappe/public/js/frappe/list/base_list.js @@ -465,9 +465,14 @@ frappe.views.BaseList = class BaseList { } refresh() { + let args = this.get_call_args(); + if (this.no_change(args)) { + console.log('throttled'); + return Promise.resolve(); + } this.freeze(true); // fetch data from server - return frappe.call(this.get_call_args()).then((r) => { + return frappe.call(args).then((r) => { // render this.prepare_data(r); this.toggle_result_area(); @@ -482,6 +487,17 @@ frappe.views.BaseList = class BaseList { }); } + no_change(args) { + // returns true if arguments are same for the last 5 seconds + // this helps in throttling if called from various sources + if (this.last_args && JSON.stringify(args) === this.last_args) { + return true; + } + this.last_args = JSON.stringify(args); + setTimeout(() => { this.last_args = null}, 3000); + return false; + } + prepare_data(r) { let data = r.message || {}; diff --git a/frappe/public/js/frappe/ui/filters/filter_list.js b/frappe/public/js/frappe/ui/filters/filter_list.js index 1377a6ff13..b0a1eee707 100644 --- a/frappe/public/js/frappe/ui/filters/filter_list.js +++ b/frappe/public/js/frappe/ui/filters/filter_list.js @@ -293,7 +293,7 @@ frappe.ui.FilterGroup = class {
-
+
diff --git a/frappe/public/scss/common/modal.scss b/frappe/public/scss/common/modal.scss index ec582591f2..c9217a075e 100644 --- a/frappe/public/scss/common/modal.scss +++ b/frappe/public/scss/common/modal.scss @@ -225,6 +225,11 @@ body.modal-open[style^="padding-right"] { } } +// modal is xs (for grids) +.modal .hidden-xs { + display: none !important; +} + .dialog-assignment-row { display: flex; align-items: center; From 5fd693d50ed5542f4fb03846997d6707538b66c5 Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Mon, 21 Feb 2022 15:56:27 +0530 Subject: [PATCH 057/106] fix(minor): throttle listview refresh on same args for 3 seconds --- frappe/public/js/frappe/list/base_list.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/public/js/frappe/list/base_list.js b/frappe/public/js/frappe/list/base_list.js index 2ea6e55666..1ba729c6a3 100644 --- a/frappe/public/js/frappe/list/base_list.js +++ b/frappe/public/js/frappe/list/base_list.js @@ -488,7 +488,7 @@ frappe.views.BaseList = class BaseList { } no_change(args) { - // returns true if arguments are same for the last 5 seconds + // returns true if arguments are same for the last 3 seconds // this helps in throttling if called from various sources if (this.last_args && JSON.stringify(args) === this.last_args) { return true; From 585086c0a8381fd1eb7b14f1429fd651d9ebc6dc Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Tue, 22 Feb 2022 10:20:40 +0530 Subject: [PATCH 058/106] fix: Use meta if parent doctype is same as current doctype --- frappe/core/doctype/doctype/doctype.py | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/frappe/core/doctype/doctype/doctype.py b/frappe/core/doctype/doctype/doctype.py index 7d75ef7ba9..dca0a05281 100644 --- a/frappe/core/doctype/doctype/doctype.py +++ b/frappe/core/doctype/doctype/doctype.py @@ -784,10 +784,12 @@ def validate_links_table_fieldnames(meta): if not meta.links or frappe.flags.in_patch or frappe.flags.in_fixtures: return + fieldnames = tuple(field.fieldname for field in meta.fields) for index, link in enumerate(meta.links, 1): - link_meta = frappe.get_meta(link.link_doctype) if not frappe.get_meta(link.link_doctype).has_field(link.link_fieldname): - message = _("Document Links Row #{0}: Could not find field {1} in {2} DocType").format(index, frappe.bold(link.link_fieldname), frappe.bold(link.link_doctype)) + message = _("Document Links Row #{0}: Could not find field {1} in {2} DocType").format( + index, frappe.bold(link.link_fieldname), frappe.bold(link.link_doctype) + ) frappe.throw(message, InvalidFieldNameError, _("Invalid Fieldname")) if not link.is_child_table: @@ -801,8 +803,15 @@ def validate_links_table_fieldnames(meta): message = _("Document Links Row #{0}: Table Fieldname is mandatory for internal links").format(index) frappe.throw(message, frappe.ValidationError, _("Table Fieldname Missing")) - if not frappe.get_meta(link.parent_doctype).has_field(link.table_fieldname): - message = _("Document Links Row #{0}: Could not find field {1} in {2} DocType").format(index, frappe.bold(link.table_fieldname), frappe.bold(meta.name)) + if meta.name == link.parent_doctype: + field_exists = link.table_fieldname in fieldnames + else: + field_exists = frappe.get_meta(link.parent_doctype).has_field(link.table_fieldname) + + if not field_exists: + message = _("Document Links Row #{0}: Could not find field {1} in {2} DocType").format( + index, frappe.bold(link.table_fieldname), frappe.bold(meta.name) + ) frappe.throw(message, frappe.ValidationError, _("Invalid Table Fieldname")) def validate_fields_for_doctype(doctype): From a7cd6003cedfea1b6da2755a171f462103ed1a7f Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Tue, 22 Feb 2022 10:26:42 +0530 Subject: [PATCH 059/106] fix: Wrap timeout getting for custom queues in function (backport #15933) (#16054) Co-authored-by: Lev Vereshchagin Co-authored-by: Gavin D'souza --- frappe/utils/background_jobs.py | 35 +++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/frappe/utils/background_jobs.py b/frappe/utils/background_jobs.py index 2c8b7f5fd3..58029dbc5f 100755 --- a/frappe/utils/background_jobs.py +++ b/frappe/utils/background_jobs.py @@ -1,6 +1,7 @@ import os import socket import time +from functools import lru_cache from uuid import uuid4 from collections import defaultdict from typing import List @@ -20,18 +21,22 @@ from frappe.utils.redis_queue import RedisQueue from frappe.utils.commands import log -common_site_config = frappe.get_file_json("common_site_config.json") -custom_workers_config = common_site_config.get("workers", {}) -default_timeout = 300 -queue_timeout = { - "default": default_timeout, - "short": default_timeout, - "long": 1500, - **{ - worker: config.get("timeout", default_timeout) - for worker, config in custom_workers_config.items() + +@lru_cache() +def get_queues_timeout(): + common_site_config = frappe.get_conf() + custom_workers_config = common_site_config.get("workers", {}) + default_timeout = 300 + + return { + "default": default_timeout, + "short": default_timeout, + "long": 1500, + **{ + worker: config.get("timeout", default_timeout) + for worker, config in custom_workers_config.items() + } } -} redis_connection = None @@ -57,7 +62,7 @@ def enqueue(method, queue='default', timeout=None, event=None, q = get_queue(queue, is_async=is_async) if not timeout: - timeout = queue_timeout.get(queue) or 300 + timeout = get_queues_timeout().get(queue) or 300 queue_args = { "site": frappe.local.site, "user": frappe.session.user, @@ -204,7 +209,7 @@ def get_jobs(site=None, queue=None, key='method'): def get_queue_list(queue_list=None, build_queue_name=False): '''Defines possible queues. Also wraps a given queue in a list after validating.''' - default_queue_list = list(queue_timeout) + default_queue_list = list(get_queues_timeout()) if queue_list: if isinstance(queue_list, str): queue_list = [queue_list] @@ -236,7 +241,7 @@ def get_queue(qtype, is_async=True): def validate_queue(queue, default_queue_list=None): if not default_queue_list: - default_queue_list = list(queue_timeout) + default_queue_list = list(get_queues_timeout()) if queue not in default_queue_list: frappe.throw(_("Queue should be one of {0}").format(', '.join(default_queue_list))) @@ -296,7 +301,7 @@ def generate_qname(qtype: str) -> str: def is_queue_accessible(qobj: Queue) -> bool: """Checks whether queue is relate to current bench or not. """ - accessible_queues = [generate_qname(q) for q in list(queue_timeout)] + accessible_queues = [generate_qname(q) for q in list(get_queues_timeout())] return qobj.name in accessible_queues def enqueue_test_job(): From 4cb37c129b76cb0128bd2522e15c8e8f0d3db9ed Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Tue, 22 Feb 2022 10:34:38 +0530 Subject: [PATCH 060/106] fix(minor): test and linting --- cypress/integration/list_view.js | 1 + frappe/public/js/frappe/form/grid_row.js | 8 ++++---- frappe/public/js/frappe/list/base_list.js | 6 ++++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/cypress/integration/list_view.js b/cypress/integration/list_view.js index b161af2df7..b7a96db4bc 100644 --- a/cypress/integration/list_view.js +++ b/cypress/integration/list_view.js @@ -12,6 +12,7 @@ context('List View', () => { cy.get('.list-row-container .list-row-checkbox').click({ multiple: true, force: true }); cy.get('.actions-btn-group button').contains('Actions').should('be.visible'); cy.intercept('/api/method/frappe.desk.reportview.get').as('list-refresh'); + cy.wait(300); // wait before you hit another refresh cy.get('button[data-original-title="Refresh"]').click(); cy.wait('@list-refresh'); cy.get('.list-row-container .list-row-checkbox:checked').should('be.visible'); diff --git a/frappe/public/js/frappe/form/grid_row.js b/frappe/public/js/frappe/form/grid_row.js index 0ee5a180e0..ec89d26213 100644 --- a/frappe/public/js/frappe/form/grid_row.js +++ b/frappe/public/js/frappe/form/grid_row.js @@ -340,7 +340,7 @@ export default class GridRow {
-

+ ${__('Add / Remove Columns')} @@ -420,10 +420,10 @@ export default class GridRow { data-label='${docfield.label}' data-type='${docfield.fieldtype}'>

-
+
${frappe.utils.icon('drag', 'xs')}
-
+
${__(docfield.label)}
@@ -431,7 +431,7 @@ export default class GridRow { value='${docfield.columns || cint(d.columns)}' data-fieldname='${docfield.fieldname}' style='background-color: #ffff; display: inline'>
-
+
diff --git a/frappe/public/js/frappe/list/base_list.js b/frappe/public/js/frappe/list/base_list.js index 1ba729c6a3..b7cb5a05df 100644 --- a/frappe/public/js/frappe/list/base_list.js +++ b/frappe/public/js/frappe/list/base_list.js @@ -467,7 +467,7 @@ frappe.views.BaseList = class BaseList { refresh() { let args = this.get_call_args(); if (this.no_change(args)) { - console.log('throttled'); + // console.log('throttled'); return Promise.resolve(); } this.freeze(true); @@ -494,7 +494,9 @@ frappe.views.BaseList = class BaseList { return true; } this.last_args = JSON.stringify(args); - setTimeout(() => { this.last_args = null}, 3000); + setTimeout(() => { + this.last_args = null; + }, 3000); return false; } From 33890ed8606cdfcff4920a749e36a57c4661fe4e Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Tue, 22 Feb 2022 11:23:51 +0530 Subject: [PATCH 061/106] refactor: use f-strings instead of .format and % --- frappe/database/postgres/schema.py | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/frappe/database/postgres/schema.py b/frappe/database/postgres/schema.py index f6235b6ff5..bb7ff20a26 100644 --- a/frappe/database/postgres/schema.py +++ b/frappe/database/postgres/schema.py @@ -5,29 +5,29 @@ from frappe.database.schema import DBTable, get_definition class PostgresTable(DBTable): def create(self): - add_text = "" + varchar_len = frappe.db.VARCHAR_LEN + additional_definitions = "" # columns column_defs = self.get_column_definitions() if column_defs: - add_text += ",\n".join(column_defs) + additional_definitions += ",\n".join(column_defs) # child table columns if self.meta.get("istable") or 0: if column_defs: - add_text += ",\n" + additional_definitions += ",\n" - add_text += ",\n".join( + additional_definitions += ",\n".join( ( - "parent varchar({varchar_len})".format(varchar_len=frappe.db.VARCHAR_LEN), - "parentfield varchar({varchar_len})".format(varchar_len=frappe.db.VARCHAR_LEN), - "parenttype varchar({varchar_len})".format(varchar_len=frappe.db.VARCHAR_LEN) + f"parent varchar({varchar_len})", + f"parentfield varchar({varchar_len})", + f"parenttype varchar({varchar_len})", ) ) - # TODO: set docstatus length # create table - frappe.db.sql("""create table `%s` ( + frappe.db.sql(f"""create table `{self.table_name}` ( name varchar({varchar_len}) not null primary key, creation timestamp(6), modified timestamp(6), @@ -35,7 +35,9 @@ class PostgresTable(DBTable): owner varchar({varchar_len}), docstatus smallint not null default '0', idx bigint not null default '0', - %s)""".format(varchar_len=frappe.db.VARCHAR_LEN) % (self.table_name, add_text)) + {additional_definitions} + )""" + ) self.create_indexes() frappe.db.commit() From d87915a12e654dc6312cdfb89b2b7835a33a6d87 Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Tue, 22 Feb 2022 12:01:30 +0530 Subject: [PATCH 062/106] test: docfield with `{defaults}` --- frappe/core/doctype/doctype/test_doctype.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/frappe/core/doctype/doctype/test_doctype.py b/frappe/core/doctype/doctype/test_doctype.py index 50882f51bd..9b4f733e7d 100644 --- a/frappe/core/doctype/doctype/test_doctype.py +++ b/frappe/core/doctype/doctype/test_doctype.py @@ -498,6 +498,13 @@ class TestDocType(unittest.TestCase): self.assertEqual(doc.is_virtual, 1) self.assertFalse(frappe.db.table_exists('Test Virtual Doctype')) + def test_default_fieldname(self): + fields = [{"label": "title", "fieldname": "title", "fieldtype": "Data", "default": "{some_fieldname}"}] + dt = new_doctype("DT with default field", fields=fields) + dt.insert() + + dt.delete() + def new_doctype(name, unique=0, depends_on='', fields=None): doc = frappe.get_doc({ "doctype": "DocType", From f1f6b21cf1e14328cc72be4029aba4f0086a731c Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Tue, 22 Feb 2022 12:08:27 +0530 Subject: [PATCH 063/106] fix(minor): styles for editable checks and links --- frappe/public/scss/desk/frappe_datatable.scss | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/frappe/public/scss/desk/frappe_datatable.scss b/frappe/public/scss/desk/frappe_datatable.scss index fb7d795ced..cfec31b72e 100644 --- a/frappe/public/scss/desk/frappe_datatable.scss +++ b/frappe/public/scss/desk/frappe_datatable.scss @@ -58,7 +58,7 @@ } .link-btn { - top: 6px; + top: 0px; } select { @@ -77,7 +77,7 @@ padding: 0; border: var(--dt-focus-border-width) solid #9bccf8; - input { + input[type="text"] { font-size: inherit; height: 27px; From 15c66f69001dbdca249808fdc17db1c8feb59c90 Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Tue, 22 Feb 2022 12:23:32 +0530 Subject: [PATCH 064/106] fix(style): fix style for inline button in grid --- frappe/public/scss/common/grid.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/public/scss/common/grid.scss b/frappe/public/scss/common/grid.scss index 1903413fbb..bfce93dbcc 100644 --- a/frappe/public/scss/common/grid.scss +++ b/frappe/public/scss/common/grid.scss @@ -192,7 +192,7 @@ margin-left: var(--margin-xs); button { - height: 27px; + height: 24px; } } From 75b6ee398c4f3e19934d2b05dbe6bc4e94f531f8 Mon Sep 17 00:00:00 2001 From: Sagar Vora Date: Tue, 22 Feb 2022 12:44:30 +0530 Subject: [PATCH 065/106] fix: `AttributeError` when initialising `FormMeta` --- frappe/desk/form/meta.py | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/frappe/desk/form/meta.py b/frappe/desk/form/meta.py index b91dd3d481..fa6a1f313b 100644 --- a/frappe/desk/form/meta.py +++ b/frappe/desk/form/meta.py @@ -12,6 +12,15 @@ from frappe.translate import extract_messages_from_code, make_dict_from_messages from frappe.utils import get_html_format +ASSET_KEYS = ( + "__js", "__css", "__list_js", "__calendar_js", "__map_js", + "__linked_with", "__messages", "__print_formats", "__workflow_docs", + "__form_grid_templates", "__listview_template", "__tree_js", + "__dashboard", "__kanban_column_fields", '__templates', + '__custom_js', '__custom_list_js' +) + + def get_meta(doctype, cached=True): # don't cache for developer mode as js files, templates may be edited if cached and not frappe.conf.developer_mode: @@ -34,6 +43,12 @@ class FormMeta(Meta): super(FormMeta, self).__init__(doctype) self.load_assets() + def set(self, key, value, *args, **kwargs): + if key in ASSET_KEYS: + self.__dict__[key] = value + else: + super(FormMeta, self).set(key, value, *args, **kwargs) + def load_assets(self): if self.get('__assets_loaded', False): return @@ -55,11 +70,7 @@ class FormMeta(Meta): def as_dict(self, no_nulls=False): d = super(FormMeta, self).as_dict(no_nulls=no_nulls) - for k in ("__js", "__css", "__list_js", "__calendar_js", "__map_js", - "__linked_with", "__messages", "__print_formats", "__workflow_docs", - "__form_grid_templates", "__listview_template", "__tree_js", - "__dashboard", "__kanban_column_fields", '__templates', - '__custom_js', '__custom_list_js'): + for k in ASSET_KEYS: d[k] = self.get(k) # d['fields'] = d.get('fields', []) @@ -172,7 +183,7 @@ class FormMeta(Meta): WHERE doc_type=%s AND docstatus<2 and disabled=0""", (self.name,), as_dict=1, update={"doctype":"Print Format"}) - self.set("__print_formats", print_formats, as_value=True) + self.set("__print_formats", print_formats) def load_workflows(self): # get active workflow @@ -186,7 +197,7 @@ class FormMeta(Meta): for d in workflow.get("states"): workflow_docs.append(frappe.get_doc("Workflow State", d.state)) - self.set("__workflow_docs", workflow_docs, as_value=True) + self.set("__workflow_docs", workflow_docs) def load_templates(self): @@ -208,7 +219,7 @@ class FormMeta(Meta): for content in self.get("__form_grid_templates").values(): messages = extract_messages_from_code(content) messages = make_dict_from_messages(messages) - self.get("__messages").update(messages, as_value=True) + self.get("__messages").update(messages) def load_dashboard(self): self.set('__dashboard', self.get_dashboard_data()) @@ -224,7 +235,7 @@ class FormMeta(Meta): fields = [x['field_name'] for x in values] fields = list(set(fields)) - self.set("__kanban_column_fields", fields, as_value=True) + self.set("__kanban_column_fields", fields) except frappe.PermissionError: # no access to kanban board pass From 1e48d058b7868387fbfd25b39e43620e0862a780 Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Tue, 22 Feb 2022 12:51:11 +0530 Subject: [PATCH 066/106] fix(style): add wait for test --- cypress/integration/list_view.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cypress/integration/list_view.js b/cypress/integration/list_view.js index b7a96db4bc..3e0d1c9d50 100644 --- a/cypress/integration/list_view.js +++ b/cypress/integration/list_view.js @@ -12,7 +12,7 @@ context('List View', () => { cy.get('.list-row-container .list-row-checkbox').click({ multiple: true, force: true }); cy.get('.actions-btn-group button').contains('Actions').should('be.visible'); cy.intercept('/api/method/frappe.desk.reportview.get').as('list-refresh'); - cy.wait(300); // wait before you hit another refresh + cy.wait(3000); // wait before you hit another refresh cy.get('button[data-original-title="Refresh"]').click(); cy.wait('@list-refresh'); cy.get('.list-row-container .list-row-checkbox:checked').should('be.visible'); From 32ca5bf52b1e165737e23a11bfaef17f6946e938 Mon Sep 17 00:00:00 2001 From: lapardnemihk1099 Date: Tue, 22 Feb 2022 15:32:38 +0530 Subject: [PATCH 067/106] fix: formatting and declaration --- frappe/public/js/frappe/form/controls/date.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/frappe/public/js/frappe/form/controls/date.js b/frappe/public/js/frappe/form/controls/date.js index fa9dc1c99e..48f4f3b5ee 100644 --- a/frappe/public/js/frappe/form/controls/date.js +++ b/frappe/public/js/frappe/form/controls/date.js @@ -158,10 +158,10 @@ frappe.ui.form.ControlDate = class ControlDate extends frappe.ui.form.ControlDat return value; } get_df_options() { - if(!this.df.options) return {}; - - let options = {}; let df_options = this.df.options; + if (!df_options) return {}; + + let options = {}; if (typeof df_options === 'string') { try { options = JSON.parse(df_options); From eaf8327e0daaaf7a38188ee632c14c4547ca0ba6 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Tue, 22 Feb 2022 18:43:16 +0530 Subject: [PATCH 068/106] fix: Use correct path of built assets - Get path from bundled_assets --- frappe/translate.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/frappe/translate.py b/frappe/translate.py index c883e63de3..0a8c6aeaad 100644 --- a/frappe/translate.py +++ b/frappe/translate.py @@ -576,13 +576,15 @@ def get_server_messages(app): def get_messages_from_include_files(app_name=None): """Returns messages from js files included at time of boot like desk.min.js for desk and web""" + from frappe.utils.jinja_globals import bundled_asset messages = [] app_include_js = frappe.get_hooks("app_include_js", app_name=app_name) or [] web_include_js = frappe.get_hooks("web_include_js", app_name=app_name) or [] include_js = app_include_js + web_include_js for js_path in include_js: - relative_path = os.path.join(frappe.local.sites_path, js_path.lstrip('/')) + file_path = bundled_asset(js_path) + relative_path = os.path.join(frappe.local.sites_path, file_path.lstrip('/')) messages_from_file = get_messages_from_file(relative_path) messages.extend(messages_from_file) From a8da557b032d660fce0be41ffde808e6ef8eaf9b Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Tue, 22 Feb 2022 22:48:50 +0530 Subject: [PATCH 069/106] fix(minor): test: blur to set value --- cypress/integration/report_view.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/cypress/integration/report_view.js b/cypress/integration/report_view.js index 4bc5784a53..884ebdc260 100644 --- a/cypress/integration/report_view.js +++ b/cypress/integration/report_view.js @@ -29,6 +29,7 @@ context('Report View', () => { // select the cell cell.dblclick(); cell.get('.dt-cell__edit--col-4').findByRole('checkbox').check({ force: true }); + cy.get('.frappe-list').click(); // click outside cy.wait('@value-update'); @@ -70,4 +71,4 @@ context('Report View', () => { cy.get('.list-paging-area .btn-more').click(); cy.get('.list-paging-area .list-count').should('contain.text', '1000 of'); }); -}); \ No newline at end of file +}); From 2c1ef84a0bff6825c7f7fc3f8b9057d295ce432c Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Tue, 22 Feb 2022 23:10:47 +0530 Subject: [PATCH 070/106] fix(minor): test: blur to set value --- cypress/integration/report_view.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cypress/integration/report_view.js b/cypress/integration/report_view.js index 884ebdc260..6e3a28bbfc 100644 --- a/cypress/integration/report_view.js +++ b/cypress/integration/report_view.js @@ -29,7 +29,7 @@ context('Report View', () => { // select the cell cell.dblclick(); cell.get('.dt-cell__edit--col-4').findByRole('checkbox').check({ force: true }); - cy.get('.frappe-list').click(); // click outside + cy.get('.dt-row-0 > .dt-cell--col-3').click(); // click outside cy.wait('@value-update'); From 466f946da51cd5578dd86a300545e22be92b741c Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Wed, 23 Feb 2022 08:51:13 +0530 Subject: [PATCH 071/106] fix: Color picker selected color style --- frappe/public/scss/common/color_picker.scss | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/frappe/public/scss/common/color_picker.scss b/frappe/public/scss/common/color_picker.scss index 84755beb18..2e53150a41 100644 --- a/frappe/public/scss/common/color_picker.scss +++ b/frappe/public/scss/common/color_picker.scss @@ -94,7 +94,10 @@ .frappe-control[data-fieldtype='Color'] { input { - padding-left: 40px; + padding-left: 38px; + } + .control-input { + position: relative; } .selected-color { cursor: pointer; @@ -103,7 +106,7 @@ border-radius: 5px; background-color: red; position: absolute; - top: calc(50% + 1px); + top: 5px; left: 8px; content: ' '; &.no-value { @@ -113,10 +116,9 @@ } .like-disabled-input { .color-value { - padding-left: 25px; + padding-left: 26px; } .selected-color { - top: 20%; cursor: default; } } From 522fb1d6d11799c0c089f66d605883704f8f2d42 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Wed, 23 Feb 2022 10:19:00 +0530 Subject: [PATCH 072/106] fix(translation): Remove duplicate entry --- frappe/translations/de.csv | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/frappe/translations/de.csv b/frappe/translations/de.csv index 25a33370dc..9a60c42854 100644 --- a/frappe/translations/de.csv +++ b/frappe/translations/de.csv @@ -3732,7 +3732,6 @@ Dr,Soll, Due Date,Fälligkeitsdatum, Duplicate,Duplizieren, Edit Profile,Profil bearbeiten, -Email,Email, End Time,Endzeit, Enter Value,Wert eingeben, Entity Type,Entitätstyp, @@ -4184,7 +4183,7 @@ Phone Number,Telefonnummer, Linked Documents,Verknüpfte Dokumente, Account SID,Konto-SID, Steps,Schritte, -email,Email, +email,E-Mail, Component,Komponente, Subtitle,Untertitel, Global Defaults,Allgemeine Voreinstellungen, From 47893c549362942f1fe2af19b180eb4782e3cca4 Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Wed, 23 Feb 2022 12:18:00 +0530 Subject: [PATCH 073/106] fix(ux): instructions/warning for doctype edits --- frappe/core/doctype/doctype/doctype.js | 7 +++++++ frappe/public/js/frappe/form/layout.js | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/frappe/core/doctype/doctype/doctype.js b/frappe/core/doctype/doctype/doctype.js index b907ebc0bc..f250a6a109 100644 --- a/frappe/core/doctype/doctype/doctype.js +++ b/frappe/core/doctype/doctype/doctype.js @@ -33,9 +33,16 @@ frappe.ui.form.on('DocType', { } } + const customize_form_link = "Customize Form"; if(!frappe.boot.developer_mode && !frm.doc.custom) { // make the document read-only frm.set_read_only(); + frm.dashboard.add_comment(__("DocTypes can not be modified, please use {0} instead", [customize_form_link]), "blue", true); + } else if (frappe.boot.developer_mode) { + let msg = __("This site is running in developer mode. Any change made here will be updated in code."); + msg += "
"; + msg += __("If you just want to customize for your site, use {0} instead.", [customize_form_link]); + frm.dashboard.add_comment(msg, "yellow"); } if(frm.is_new()) { diff --git a/frappe/public/js/frappe/form/layout.js b/frappe/public/js/frappe/form/layout.js index 8c0f8953c5..578956f0ca 100644 --- a/frappe/public/js/frappe/form/layout.js +++ b/frappe/public/js/frappe/form/layout.js @@ -98,7 +98,7 @@ frappe.ui.form.Layout = class Layout { // remove previous color this.message.removeClass(this.message_color); } - this.message_color = (color && ['yellow', 'blue'].includes(color)) ? color : 'blue'; + this.message_color = (color && ['yellow', 'blue', 'red'].includes(color)) ? color : 'blue'; if (html) { if (html.substr(0, 1)!=='<') { // wrap in a block From bedf60280febe7f11e5630574b220b189f5ffb1c Mon Sep 17 00:00:00 2001 From: Suraj Shetty <13928957+surajshetty3416@users.noreply.github.com> Date: Wed, 23 Feb 2022 13:21:21 +0530 Subject: [PATCH 074/106] fix(translation): Add all possible views as comment (#16097) --- frappe/public/js/frappe/list/base_list.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/frappe/public/js/frappe/list/base_list.js b/frappe/public/js/frappe/list/base_list.js index b7cb5a05df..75063cc53f 100644 --- a/frappe/public/js/frappe/list/base_list.js +++ b/frappe/public/js/frappe/list/base_list.js @@ -204,6 +204,11 @@ frappe.views.BaseList = class BaseList { }; if (frappe.boot.desk_settings.view_switcher) { + /* @preserve + for translation, don't remove + __("List View") __("Report View") __("Dashboard View") __("Gantt View"), + __("Kanban View") __("Calendar View") __("Image View") __("Inbox View"), + __("Tree View") __("Map View") */ this.views_menu = this.page.add_custom_button_group(__('{0} View', [this.view_name]), icon_map[this.view_name] || 'list'); this.views_list = new frappe.views.ListViewSelect({ From f4518e2cf9d8bdb952dd82160ff0fb8cf9eab792 Mon Sep 17 00:00:00 2001 From: HarryPaulo Date: Wed, 23 Feb 2022 05:19:40 -0300 Subject: [PATCH 075/106] fix(print): Added properties page-width, page-height (#16045) --- frappe/utils/pdf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/utils/pdf.py b/frappe/utils/pdf.py index 9a7c0889b5..b8e684869e 100644 --- a/frappe/utils/pdf.py +++ b/frappe/utils/pdf.py @@ -155,7 +155,7 @@ def read_options_from_html(html): toggle_visible_pdf(soup) # use regex instead of soup-parser - for attr in ("margin-top", "margin-bottom", "margin-left", "margin-right", "page-size", "header-spacing", "orientation"): + for attr in ("margin-top", "margin-bottom", "margin-left", "margin-right", "page-size", "header-spacing", "orientation", "page-width", "page-height"): try: pattern = re.compile(r"(\.print-format)([\S|\s][^}]*?)(" + str(attr) + r":)(.+)(mm;)") match = pattern.findall(html) From 2c2d8b8e084c3be88c81404ba4b92dbb2bad005c Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Tue, 22 Feb 2022 20:50:15 +0530 Subject: [PATCH 076/106] fix: explicitly ignore duplicates --- frappe/desk/page/setup_wizard/setup_wizard.py | 2 +- frappe/desk/utils.py | 2 +- frappe/test_runner.py | 2 +- frappe/utils/install.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/frappe/desk/page/setup_wizard/setup_wizard.py b/frappe/desk/page/setup_wizard/setup_wizard.py index 0c32e886f4..74101a6e1f 100755 --- a/frappe/desk/page/setup_wizard/setup_wizard.py +++ b/frappe/desk/page/setup_wizard/setup_wizard.py @@ -392,7 +392,7 @@ def make_records(records, debug=False): doc.flags.ignore_mandatory = True try: - doc.insert(ignore_permissions=True) + doc.insert(ignore_permissions=True, ignore_if_duplicate=True) frappe.db.commit() except frappe.DuplicateEntryError as e: diff --git a/frappe/desk/utils.py b/frappe/desk/utils.py index 5908277386..3328d47318 100644 --- a/frappe/desk/utils.py +++ b/frappe/desk/utils.py @@ -20,4 +20,4 @@ def validate_route_conflict(doctype, name): raise frappe.NameError def slug(name): - return name.lower().replace(' ', '-') \ No newline at end of file + return name.lower().replace(' ', '-') diff --git a/frappe/test_runner.py b/frappe/test_runner.py index 20759331c3..932e4c4346 100644 --- a/frappe/test_runner.py +++ b/frappe/test_runner.py @@ -392,7 +392,7 @@ def make_test_objects(doctype, test_records=None, verbose=None, reset=False): try: d.run_method("before_test_insert") - d.insert() + d.insert(ignore_if_duplicate=True) if docstatus == 1: d.submit() diff --git a/frappe/utils/install.py b/frappe/utils/install.py index cf76c9fffc..a5fd39994f 100644 --- a/frappe/utils/install.py +++ b/frappe/utils/install.py @@ -90,7 +90,7 @@ def install_basic_docs(): for d in install_docs: try: - frappe.get_doc(d).insert() + frappe.get_doc(d).insert(ignore_if_duplicate=True) except frappe.NameError: pass From 01dc744aed5174c96976a0dc999b3bf98e9809b9 Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Wed, 23 Feb 2022 14:10:52 +0530 Subject: [PATCH 077/106] fix: only check migration_hash on doctype other documents dont have this field, hash based migration is only for doctypes. --- frappe/modules/import_file.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/frappe/modules/import_file.py b/frappe/modules/import_file.py index 1219fbb045..92e7523e6d 100644 --- a/frappe/modules/import_file.py +++ b/frappe/modules/import_file.py @@ -115,10 +115,11 @@ def import_file_by_path(path: str,force: bool = False,data_import: bool = False, if not force or db_modified_timestamp: try: - stored_hash = frappe.db.get_value(doc["doctype"], doc["name"], "migration_hash") + stored_hash = None + if doc["doctype"] == "DocType": + stored_hash = frappe.db.get_value(doc["doctype"], doc["name"], "migration_hash") except Exception: frappe.flags.dt += [doc["doctype"]] - stored_hash = None # if hash exists and is equal no need to update if stored_hash and stored_hash == calculated_hash: From 208fc5f0d5b842addf073530dd4d7a3073baa281 Mon Sep 17 00:00:00 2001 From: Wolfram Schmidt Date: Wed, 23 Feb 2022 09:59:46 +0100 Subject: [PATCH 078/106] fix(translation): Field translation (#16010) --- frappe/translations/de.csv | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/frappe/translations/de.csv b/frappe/translations/de.csv index 9a60c42854..afd1b101d6 100644 --- a/frappe/translations/de.csv +++ b/frappe/translations/de.csv @@ -1530,7 +1530,7 @@ Main Section,Hauptbereich, Make use of longer keyboard patterns,Nutzen Sie mehr Tastaturmuster, Manage Third Party Apps,Verwalten von Apps von Drittanbietern, Mandatory Information missing:,Pflichtangaben fehlen:, -Mandatory field: set role for,Pflichtfeld: set Rolle für, +Mandatory field: set role for,Pflichtfeld: Rolle anwenden auf, Mandatory field: {0},Pflichtfeld: {0}, "Mandatory fields required in table {0}, Row {1}","Pflichtfelder in der Tabelle erforderlich {0}, Reihe {1}", Mandatory fields required in {0},Für {0} benötigte Pflichtfelder:, @@ -2268,7 +2268,7 @@ Set Permissions,Festlegen von Berechtigungen, Set Permissions on Document Types and Roles,Berechtigungen für Dokumenttypen und Rollen setzen, Set Property After Alert,Setzen Sie die Eigenschaft nach Alert, Set Quantity,Anzahl festlegen, -Set Role For,Set Rolle für, +Set Role For,Rolle anwenden auf, Set User Permissions,Nutzer-Berechtigungen setzen, Set Value,Wert festlegen, Set custom roles for page and report,Legen Sie benutzerdefinierte Rollen für Seite und Bericht, From 14ca1f0dce338b911cb964053c4c3d1d2558791d Mon Sep 17 00:00:00 2001 From: Lev Vereshchagin Date: Wed, 23 Feb 2022 12:47:50 +0300 Subject: [PATCH 079/106] fix(UI): Fix incorrect dark theme text color in user-wise grid column configuration (closes #14572) (cherry picked from commit 5280d60ea93b8690f684dddbad0bda32df3cec04) --- frappe/public/js/frappe/form/grid_row.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/public/js/frappe/form/grid_row.js b/frappe/public/js/frappe/form/grid_row.js index ec89d26213..cd8bde1f57 100644 --- a/frappe/public/js/frappe/form/grid_row.js +++ b/frappe/public/js/frappe/form/grid_row.js @@ -429,7 +429,7 @@ export default class GridRow {
+ data-fieldname='${docfield.fieldname}' style='background-color: var(--modal-bg); display: inline'>
From 1a348262034e5b5814c1ee7ab52eeea10fd3c9b4 Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Mon, 7 Feb 2022 14:00:26 +0530 Subject: [PATCH 080/106] test: use `now` instead of `is_async` in tests --- frappe/model/delete_doc.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/model/delete_doc.py b/frappe/model/delete_doc.py index 2cc99575d6..ef73a349cc 100644 --- a/frappe/model/delete_doc.py +++ b/frappe/model/delete_doc.py @@ -115,7 +115,7 @@ def delete_doc(doctype=None, name=None, force=0, ignore_doctypes=None, for_reloa # All the linked docs should be checked beforehand frappe.enqueue('frappe.model.delete_doc.delete_dynamic_links', doctype=doc.doctype, name=doc.name, - is_async=False if frappe.flags.in_test else True) + now=frappe.flags.in_test) # clear cache for Document doc.clear_cache() From 91da5f0363b8fc5f5e9775e8e7d49a98722de9c5 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Wed, 23 Feb 2022 17:19:43 +0530 Subject: [PATCH 081/106] refactor(rename_doc): update_document_title API * Remove redundant API arguments * Check for permission on specified document * Maintain backwards compatibility - test_update_document_title_api checks for this * Update desk client usage ;) --- frappe/model/rename_doc.py | 31 +++++++++++++++---------- frappe/public/js/frappe/form/toolbar.js | 6 ++--- 2 files changed, 21 insertions(+), 16 deletions(-) diff --git a/frappe/model/rename_doc.py b/frappe/model/rename_doc.py index 88752103ae..3f5104540a 100644 --- a/frappe/model/rename_doc.py +++ b/frappe/model/rename_doc.py @@ -19,32 +19,39 @@ if TYPE_CHECKING: def update_document_title( doctype: str, docname: str, - title_field: Optional[str] = None, - old_title: Optional[str] = None, - new_title: Optional[str] = None, - new_name: Optional[str] = None, + title: Optional[str] = None, + name: Optional[str] = None, merge: bool = False, + **kwargs ) -> str: """ Update title from header in form view """ + + # to maintain backwards API compatibility + updated_title = kwargs.get("new_title") or title + updated_name = kwargs.get("new_name") or name + # TODO: omit this after runtime type checking (ref: https://github.com/frappe/frappe/pull/14927) - for obj in [docname, new_name, new_title, old_title]: + for obj in [docname, updated_title, updated_name]: if not isinstance(obj, (str, type(None))): - frappe.throw(f"{obj} must be of type str or None") + frappe.throw(f"{obj=} must be of type str or None") - frappe.has_permission(doctype, ptype="write", throw=True) + doc = frappe.get_doc(doctype, docname) + doc.has_permission(permtype="write") - title_updated = old_title and new_title and (old_title != new_title) - name_updated = new_name and docname and (docname != new_name) + title_field = doc.meta.get_title_field() + + title_updated = (title_field != "name") and (updated_title != doc.get(title_field)) + name_updated = updated_name != doc.name if name_updated: - docname = rename_doc(doctype=doctype, old=docname, new=new_name, merge=merge) + docname = rename_doc(doctype=doctype, old=docname, new=updated_name, merge=merge) if title_updated: try: - frappe.db.set_value(doctype, docname, title_field, new_title) - frappe.msgprint(_('Saved'), alert=True, indicator='green') + frappe.db.set_value(doctype, docname, title_field, updated_title) + frappe.msgprint(_("Saved"), alert=True, indicator="green") except Exception as e: if frappe.db.is_duplicate_entry(e): frappe.throw( diff --git a/frappe/public/js/frappe/form/toolbar.js b/frappe/public/js/frappe/form/toolbar.js index ffcfc349ef..500ec88068 100644 --- a/frappe/public/js/frappe/form/toolbar.js +++ b/frappe/public/js/frappe/form/toolbar.js @@ -101,10 +101,8 @@ frappe.ui.form.Toolbar = class Toolbar { return frappe.xcall("frappe.model.rename_doc.update_document_title", { doctype, docname, - new_name, - title_field, - old_title: this.frm.doc[title_field], - new_title, + name: new_name, + title: new_title, merge }).then(new_docname => { if (new_name != docname) { From c4c3d26b3dec6786b79c8661f74e356a91f3744d Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Wed, 23 Feb 2022 18:22:42 +0530 Subject: [PATCH 082/106] fix!: Disallow posiitonal args in update_document_title --- frappe/model/rename_doc.py | 1 + 1 file changed, 1 insertion(+) diff --git a/frappe/model/rename_doc.py b/frappe/model/rename_doc.py index 3f5104540a..c9b4cfdcff 100644 --- a/frappe/model/rename_doc.py +++ b/frappe/model/rename_doc.py @@ -17,6 +17,7 @@ if TYPE_CHECKING: @frappe.whitelist() def update_document_title( + *, doctype: str, docname: str, title: Optional[str] = None, From da260ab778a1d0e3bea30a513f913760885d2c9b Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Wed, 23 Feb 2022 18:23:24 +0530 Subject: [PATCH 083/106] test: Use 'Module Def' to test update_document_title --- frappe/tests/test_rename_doc.py | 40 +++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/frappe/tests/test_rename_doc.py b/frappe/tests/test_rename_doc.py index e86bd9cde2..0c1cba31fb 100644 --- a/frappe/tests/test_rename_doc.py +++ b/frappe/tests/test_rename_doc.py @@ -12,7 +12,7 @@ from unittest.mock import patch import frappe from frappe.exceptions import DoesNotExistError, ValidationError from frappe.model.base_document import get_controller -from frappe.model.rename_doc import bulk_rename, get_fetch_fields, update_linked_doctypes +from frappe.model.rename_doc import bulk_rename, get_fetch_fields, update_document_title, update_linked_doctypes from frappe.modules.utils import get_doc_path from frappe.utils import add_to_date, now @@ -186,30 +186,36 @@ class TestRenameDoc(unittest.TestCase): ) def test_update_document_title_api(self): - from frappe.model.rename_doc import update_document_title - allow_rename_prop = frappe.db.get_value("DocType", self.test_doctype, "allow_rename") - frappe.clear_cache() - if not frappe.get_meta(self.test_doctype).allow_rename: - frappe.db.set_value("DocType", self.test_doctype, "allow_rename", 1, update_modified=False) + test_doctype = "Module Def" + test_doc = frappe.get_doc({ + "doctype": test_doctype, + "module_name": f"Test-test_update_document_title_api-{frappe.generate_hash()}", + "custom": True, + }) + test_doc.insert(ignore_mandatory=True) - dt = self.test_doctype - dn = self.available_documents[0] + dt = test_doc.doctype + dn = test_doc.name new_name = f"{dn}-new" # pass invalid types to API with self.assertRaises(ValidationError): - update_document_title(dt, dn, {}, {"hack": "this"}) + update_document_title(doctype=dt, docname=dn, title={}, name={"hack": "this"}) - doc_before = frappe.get_doc(self.test_doctype, dn) - update_document_title(dt, dn, new_name=new_name) - doc_after = frappe.get_doc(self.test_doctype, new_name) + doc_before = frappe.get_doc(test_doctype, dn) + return_value = update_document_title(doctype=dt, docname=dn, new_name=new_name) + doc_after = frappe.get_doc(test_doctype, return_value) - self.assertEqual(doc_before.description, doc_after.description) - self.assertEqual(doc_before.creation, doc_after.creation) - self.assertEqual(doc_before.owner, doc_after.owner) + doc_before_dict = doc_before.as_dict(no_nulls=True, no_default_fields=True) + doc_after_dict = doc_after.as_dict(no_nulls=True, no_default_fields=True) + doc_before_dict.pop("module_name") + doc_after_dict.pop("module_name") - self.available_documents[0] = new_name - frappe.db.set_value("DocType", self.test_doctype, "allow_rename", allow_rename_prop, update_modified=False) + self.assertEqual(new_name, return_value) + self.assertDictEqual(doc_before_dict, doc_after_dict) + self.assertEqual(doc_after.module_name, return_value) + + test_doc.delete() def test_bulk_rename(self): input_data = [[x, f"{x}-new"] for x in self.available_documents] From 7da85353c7940a8149626ad9527e6b794f5fca34 Mon Sep 17 00:00:00 2001 From: Benedict Allerberger Date: Wed, 23 Feb 2022 15:22:57 +0100 Subject: [PATCH 084/106] fix: format of ldap_settings.py --- frappe/integrations/doctype/ldap_settings/ldap_settings.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/frappe/integrations/doctype/ldap_settings/ldap_settings.py b/frappe/integrations/doctype/ldap_settings/ldap_settings.py index f16d126440..e04ab2a68b 100644 --- a/frappe/integrations/doctype/ldap_settings/ldap_settings.py +++ b/frappe/integrations/doctype/ldap_settings/ldap_settings.py @@ -50,8 +50,8 @@ class LDAPSettings(Document): title=_("Misconfigured")) if self.ldap_custom_group_search and "{0}" not in self.ldap_custom_group_search: - frappe.throw(_("Custom Group Search if filled needs to contain the user placeholder {0}, eg uid={0},ou=users,dc=example,dc=com"), - title=_("Misconfigured")) + frappe.throw(_("Custom Group Search if filled needs to contain the user placeholder {0}, eg uid={0},ou=users,dc=example,dc=com"), + title=_("Misconfigured")) else: frappe.throw(_("LDAP Search String must be enclosed in '()' and needs to contian the user placeholder {0}, eg sAMAccountName={0}")) From fd57a6f4a3732190ca0e1fb008f76788c23065ac Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Wed, 23 Feb 2022 19:23:31 +0530 Subject: [PATCH 085/106] test: Skip test_image_parsing if no mail found * Trimmed trailing whitespaces -_- ref: Flaky test - https://github.com/frappe/frappe/runs/5303629095?check_suite_focus=true --- frappe/tests/test_email.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/frappe/tests/test_email.py b/frappe/tests/test_email.py index ad9f8fdd11..51a0786c2f 100644 --- a/frappe/tests/test_email.py +++ b/frappe/tests/test_email.py @@ -1,9 +1,9 @@ -# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE import unittest, frappe, re, email -from frappe.email.doctype.email_account.test_email_account import TestEmailAccount +from frappe.email.doctype.email_account.test_email_account import TestEmailAccount test_dependencies = ['Email Account'] @@ -176,7 +176,6 @@ class TestEmail(unittest.TestCase): with open(frappe.get_app_path('frappe', 'tests', 'data', 'email_with_image.txt'), 'r') as raw: messages = { - # append_to = ToDo '"INBOX"': { 'latest_messages': [ raw.read() @@ -185,17 +184,20 @@ class TestEmail(unittest.TestCase): 2: 'UNSEEN' }, 'uid_list': [2] - } + } } email_account = frappe.get_doc("Email Account", "_Test Email Account 1") changed_flag = False - if not email_account.enable_incoming: + if not email_account.enable_incoming: email_account.enable_incoming = True changed_flag = True mails = TestEmailAccount.mocked_get_inbound_mails(email_account, messages) - # mails = email_account.get_inbound_mails(test_mails=[raw.read()]) + # TODO: fix this flaky test! - 'IndexError: list index out of range' for `.process()` line + if not mails: + raise self.skipTest("No inbound mails found / Email Account wasn't patched properly") + communication = mails[0].process() self.assertTrue(re.search(''']*src=["']/private/files/rtco1.png[^>]*>''', communication.content)) From ea7a53568f10e5adc459bf21150fe962189a2d97 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Wed, 23 Feb 2022 18:46:50 +0530 Subject: [PATCH 086/106] test(TestFrappeClient): Set Admin password else skip ref: https://github.com/frappe/frappe/runs/5303629148?check_suite_focus=true --- frappe/tests/test_frappe_client.py | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/frappe/tests/test_frappe_client.py b/frappe/tests/test_frappe_client.py index 2d815d0731..e4588a16f1 100644 --- a/frappe/tests/test_frappe_client.py +++ b/frappe/tests/test_frappe_client.py @@ -1,17 +1,30 @@ -# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import unittest, frappe -from frappe.core.doctype.user.user import generate_keys -from frappe.frappeclient import FrappeClient, FrappeException -from frappe.utils.data import get_url +import base64 +import unittest import requests -import base64 + +import frappe +from frappe.core.doctype.user.user import generate_keys +from frappe.frappeclient import AuthError, FrappeClient, FrappeException +from frappe.utils.data import get_url + class TestFrappeClient(unittest.TestCase): PASSWORD = frappe.conf.admin_password or "admin" + @classmethod + def setUpClass(cls) -> None: + site_url = get_url() + try: + FrappeClient(site_url, "Administrator", cls.PASSWORD, verify=False) + except AuthError: + raise unittest.SkipTest(f"AuthError raised for {site_url} [usr=Administrator, pwd={cls.PASSWORD}]") + + return super().setUpClass() + def test_insert_many(self): server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False) frappe.db.delete("Note", {"title": ("in", ('Sing','a','song','of','sixpence'))}) From fe57111556679d3cf2d0b95742680de1e3dfa40e Mon Sep 17 00:00:00 2001 From: Summayya Date: Thu, 24 Feb 2022 01:26:14 +0530 Subject: [PATCH 087/106] fix: remove padding for mobile view --- frappe/public/scss/website/web_form.scss | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/frappe/public/scss/website/web_form.scss b/frappe/public/scss/website/web_form.scss index 8f55bf8104..08c1febbe6 100644 --- a/frappe/public/scss/website/web_form.scss +++ b/frappe/public/scss/website/web_form.scss @@ -50,6 +50,10 @@ &:last-child { padding-right: 0; } + + @include media-breakpoint-down(sm) { + padding: 0; + } } } From 76df55ab25475e417f4028a478cb5a19d5cb7ce7 Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Thu, 24 Feb 2022 11:28:14 +0530 Subject: [PATCH 088/106] test: fix flaky email domain test --- frappe/email/doctype/email_domain/test_email_domain.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/frappe/email/doctype/email_domain/test_email_domain.py b/frappe/email/doctype/email_domain/test_email_domain.py index 1064c7684a..7522dd5282 100644 --- a/frappe/email/doctype/email_domain/test_email_domain.py +++ b/frappe/email/doctype/email_domain/test_email_domain.py @@ -20,11 +20,13 @@ class TestDomain(unittest.TestCase): mail_domain = frappe.get_doc("Email Domain", "test.com") mail_account = frappe.get_doc("Email Account", "Test") - # Initially, incoming_port is different in domain and account - self.assertNotEqual(mail_account.incoming_port, mail_domain.incoming_port) + # Ensure a different port + mail_account.incoming_port = int(mail_domain.incoming_port) + 5 + mail_account.save() # Trigger update of accounts using this domain mail_domain.on_update() - mail_account = frappe.get_doc("Email Account", "Test") + + mail_account.reload() # After update, incoming_port in account should match the domain self.assertEqual(mail_account.incoming_port, mail_domain.incoming_port) From 6aec566325c7ff5566a05297a4420766e015838c Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Thu, 24 Feb 2022 11:33:29 +0530 Subject: [PATCH 089/106] test(test_api): Use login manager instead of request login Also, move setUp for method into "correct" TestCase class --- frappe/tests/test_api.py | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/frappe/tests/test_api.py b/frappe/tests/test_api.py index 93875f7784..d7d0de6a0d 100644 --- a/frappe/tests/test_api.py +++ b/frappe/tests/test_api.py @@ -72,11 +72,14 @@ class FrappeAPITestCase(unittest.TestCase): @property def sid(self) -> str: if not getattr(self, "_sid", None): - r = self.post("/api/method/login", { - "usr": "Administrator", - "pwd": frappe.conf.admin_password or "admin", - }) - self._sid = r.headers[2][1].split(";")[0].lstrip("sid=") + from frappe.auth import CookieManager, LoginManager + from frappe.utils import set_request + + set_request(path="/") + frappe.local.cookie_manager = CookieManager() + frappe.local.login_manager = LoginManager() + frappe.local.login_manager.login_as('Administrator') + self._sid = frappe.session.sid return self._sid @@ -112,16 +115,6 @@ class TestResourceAPI(FrappeAPITestCase): frappe.delete_doc_if_exists(cls.DOCTYPE, name) frappe.db.commit() - def setUp(self): - # commit to ensure consistency in session (postgres CI randomly fails) - if frappe.conf.db_type == "postgres": - frappe.db.commit() - - if self._testMethodName == "test_auth_cycle": - from frappe.core.doctype.user.user import generate_keys - generate_keys("Administrator") - frappe.db.commit() - def test_unauthorized_call(self): # test 1: fetch documents without auth response = requests.get(f"{self.RESOURCE_URL}/{self.DOCTYPE}") @@ -226,6 +219,12 @@ class TestResourceAPI(FrappeAPITestCase): class TestMethodAPI(FrappeAPITestCase): METHOD_PATH = "/api/method" + def setUp(self): + if self._testMethodName == "test_auth_cycle": + from frappe.core.doctype.user.user import generate_keys + generate_keys("Administrator") + frappe.db.commit() + def test_version(self): # test 1: test for /api/method/version response = self.get(f"{self.METHOD_PATH}/version") From 0859a3060cb5209b8afd437ed0ceac6059fcd2d2 Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Thu, 24 Feb 2022 11:35:00 +0530 Subject: [PATCH 090/106] chore: Remove comments, trailing whitespaces, etc --- frappe/commands/utils.py | 1 + frappe/core/doctype/user/test_user.py | 2 +- frappe/test_runner.py | 3 --- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/frappe/commands/utils.py b/frappe/commands/utils.py index 7246df8aa7..c0bb44efab 100644 --- a/frappe/commands/utils.py +++ b/frappe/commands/utils.py @@ -640,6 +640,7 @@ def run_tests(context, app=None, module=None, doctype=None, test=(), profile=Fal skip_test_records=False, skip_before_tests=False, failfast=False, case=None): with CodeCoverage(coverage, app): + import frappe import frappe.test_runner tests = test site = get_site(context) diff --git a/frappe/core/doctype/user/test_user.py b/frappe/core/doctype/user/test_user.py index 4676e9daa8..3e6e1ec7e2 100644 --- a/frappe/core/doctype/user/test_user.py +++ b/frappe/core/doctype/user/test_user.py @@ -356,7 +356,7 @@ class TestUser(unittest.TestCase): self.assertEqual(update_password(new_password, key=test_user.reset_password_key), "/") update_password(old_password, old_password=new_password) self.assertEqual( - json.loads(frappe.message_log[0]).get("message"), + json.loads(frappe.message_log[0]).get("message"), "Password reset instructions have been sent to your email" ) diff --git a/frappe/test_runner.py b/frappe/test_runner.py index 05f1ce1cd7..9cdd33c92f 100644 --- a/frappe/test_runner.py +++ b/frappe/test_runner.py @@ -55,9 +55,6 @@ def main(app=None, module=None, doctype=None, verbose=False, tests=(), if not frappe.db: frappe.connect() - # if not frappe.conf.get("db_name").startswith("test_"): - # raise Exception, 'db_name must start with "test_"' - # workaround! since there is no separate test db frappe.clear_cache() scheduler_disabled_by_user = frappe.utils.scheduler.is_scheduler_disabled() From 0d33ca1c608e5fa58014b2769056db9b06d0ccc9 Mon Sep 17 00:00:00 2001 From: Suraj Shetty Date: Thu, 24 Feb 2022 13:11:42 +0530 Subject: [PATCH 091/106] fix: Use `sort_by` field instead of non-existent `sort_field` To get proper form navigation --- frappe/public/js/frappe/form/form.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/frappe/public/js/frappe/form/form.js b/frappe/public/js/frappe/form/form.js index a11ddce520..56e909dd0c 100644 --- a/frappe/public/js/frappe/form/form.js +++ b/frappe/public/js/frappe/form/form.js @@ -1102,13 +1102,13 @@ frappe.ui.form.Form = class FrappeForm { let list_view = frappe.get_list_view(this.doctype); if (list_view) { filters = list_view.get_filters_for_args(); - sort_field = list_view.sort_field; + sort_field = list_view.sort_by; sort_order = list_view.sort_order; } else { let list_settings = frappe.get_user_settings(this.doctype)['List']; if (list_settings) { filters = list_settings.filters; - sort_field = list_settings.sort_field; + sort_field = list_settings.sort_by; sort_order = list_settings.sort_order; } } From 63e035923b5f737fc5cd155a48ddc393df291e3c Mon Sep 17 00:00:00 2001 From: gavin Date: Thu, 24 Feb 2022 13:34:57 +0530 Subject: [PATCH 092/106] chore: Simplify ldap_custom_group_search resolution --- frappe/integrations/doctype/ldap_settings/ldap_settings.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/frappe/integrations/doctype/ldap_settings/ldap_settings.py b/frappe/integrations/doctype/ldap_settings/ldap_settings.py index e04ab2a68b..cfd6e1e133 100644 --- a/frappe/integrations/doctype/ldap_settings/ldap_settings.py +++ b/frappe/integrations/doctype/ldap_settings/ldap_settings.py @@ -213,9 +213,7 @@ class LDAPSettings(Document): ldap_object_class = self.ldap_group_objectclass ldap_group_members_attribute = self.ldap_group_member_attribute - ldap_custom_group_search = "{0}" - if self.ldap_custom_group_search: - ldap_custom_group_search = self.ldap_custom_group_search + ldap_custom_group_search = self.ldap_custom_group_search or "{0}" user_search_str = ldap_custom_group_search.format(getattr(user, self.ldap_username_field).value) else: From 783a63f8a236f3d8030a5e272cfb0f0b0e372aab Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Thu, 24 Feb 2022 17:09:10 +0530 Subject: [PATCH 093/106] fix: Raise PermissionError if user doesnt have access to document --- frappe/model/rename_doc.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/model/rename_doc.py b/frappe/model/rename_doc.py index ee2cbfb854..787f276b17 100644 --- a/frappe/model/rename_doc.py +++ b/frappe/model/rename_doc.py @@ -39,7 +39,7 @@ def update_document_title( frappe.throw(f"{obj=} must be of type str or None") doc = frappe.get_doc(doctype, docname) - doc.has_permission(permtype="write") + doc.check_permission(permtype="write") title_field = doc.meta.get_title_field() From 8b2591e2667e6c13d2d476df07ffbb3cdac383bb Mon Sep 17 00:00:00 2001 From: HENRY Florian Date: Thu, 24 Feb 2022 13:26:50 +0100 Subject: [PATCH 094/106] feat(minor): No Copy attribute for custom fields (#15915) Fix #13252 ![image](https://user-images.githubusercontent.com/1050053/153055276-28714781-b142-41e8-9218-d7b8f0f60b22.png) --- .../custom/doctype/customize_form/customize_form.py | 1 + .../doctype/customize_form/test_customize_form.py | 5 +++++ .../customize_form_field/customize_form_field.json | 11 +++++++++-- 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/frappe/custom/doctype/customize_form/customize_form.py b/frappe/custom/doctype/customize_form/customize_form.py index 92a540447f..f1b6ab40ed 100644 --- a/frappe/custom/doctype/customize_form/customize_form.py +++ b/frappe/custom/doctype/customize_form/customize_form.py @@ -540,6 +540,7 @@ docfield_properties = { 'in_global_search': 'Check', 'in_preview': 'Check', 'bold': 'Check', + 'no_copy': 'Check', 'hidden': 'Check', 'collapsible': 'Check', 'collapsible_depends_on': 'Data', diff --git a/frappe/custom/doctype/customize_form/test_customize_form.py b/frappe/custom/doctype/customize_form/test_customize_form.py index d131f06127..2cae69ca21 100644 --- a/frappe/custom/doctype/customize_form/test_customize_form.py +++ b/frappe/custom/doctype/customize_form/test_customize_form.py @@ -97,13 +97,18 @@ class TestCustomizeForm(unittest.TestCase): custom_field = d.get("fields", {"fieldname": "test_custom_field"})[0] custom_field.reqd = 1 + custom_field.no_copy = 1 d.run_method("save_customization") self.assertEqual(frappe.db.get_value("Custom Field", "Event-test_custom_field", "reqd"), 1) + self.assertEqual(frappe.db.get_value("Custom Field", "Event-test_custom_field", "no_copy"), 1) custom_field = d.get("fields", {"is_custom_field": True})[0] custom_field.reqd = 0 + custom_field.no_copy = 0 d.run_method("save_customization") self.assertEqual(frappe.db.get_value("Custom Field", "Event-test_custom_field", "reqd"), 0) + self.assertEqual(frappe.db.get_value("Custom Field", "Event-test_custom_field", "no_copy"), 0) + def test_save_customization_new_field(self): d = self.get_customize_form("Event") diff --git a/frappe/custom/doctype/customize_form_field/customize_form_field.json b/frappe/custom/doctype/customize_form_field/customize_form_field.json index 4351e76609..5906cd3bcf 100644 --- a/frappe/custom/doctype/customize_form_field/customize_form_field.json +++ b/frappe/custom/doctype/customize_form_field/customize_form_field.json @@ -20,6 +20,7 @@ "in_global_search", "in_preview", "bold", + "no_copy", "allow_in_quick_entry", "translatable", "column_break_7", @@ -437,13 +438,19 @@ "fieldname": "show_dashboard", "fieldtype": "Check", "label": "Show Dashboard" + }, + { + "default": "0", + "fieldname": "no_copy", + "fieldtype": "Check", + "label": "No Copy" } ], "idx": 1, "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2022-01-27 21:45:22.349776", + "modified": "2022-02-08 19:38:16.111199", "modified_by": "Administrator", "module": "Custom", "name": "Customize Form Field", @@ -453,4 +460,4 @@ "sort_field": "modified", "sort_order": "ASC", "states": [] -} \ No newline at end of file +} From dd1abf7f4e9af740ac793f1ccf08b6e8dcedaf47 Mon Sep 17 00:00:00 2001 From: Lev Vereshchagin Date: Wed, 23 Feb 2022 12:34:13 +0300 Subject: [PATCH 095/106] fix(UI): Flaky link preview popover creation (closes #15482) (cherry picked from commit 67e7dd44b5264ad8d3fad8ceb9e12cbe2bdd5d07) --- frappe/public/js/frappe/ui/link_preview.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/public/js/frappe/ui/link_preview.js b/frappe/public/js/frappe/ui/link_preview.js index 328cd23716..a6a2273161 100644 --- a/frappe/public/js/frappe/ui/link_preview.js +++ b/frappe/public/js/frappe/ui/link_preview.js @@ -73,7 +73,7 @@ frappe.ui.LinkPreview = class { } this.popover_timeout = setTimeout(() => { - if (this.popover) { + if (this.popover && this.popover.options) { let new_content = this.get_popover_html(preview_data); this.popover.options.content = new_content; } else { From cdc6bcadb1ea64b5d3b28ea66ab465e2bf242ca3 Mon Sep 17 00:00:00 2001 From: Revant Nandgaonkar Date: Fri, 25 Feb 2022 09:58:59 +0530 Subject: [PATCH 096/106] fix(cli): Database agnostic options for root db credentials (#15973) * fix(bench): new-site params for root db credentials allow root credentials for postgresql use common cli option name for both database types * fix(bench): backward compatible db params Co-authored-by: gavin * fix(bench): use common db cred params use --db-root-username and --db-root-password * feat(bench): add --set-default to bench new-site * fix: do not set default root user * fix: indentation Co-authored-by: gavin --- frappe/commands/site.py | 58 ++++++++++++++-------------- frappe/database/postgres/setup_db.py | 4 +- frappe/installer.py | 15 ++++--- 3 files changed, 42 insertions(+), 35 deletions(-) diff --git a/frappe/commands/site.py b/frappe/commands/site.py index 1684f26d49..c5d2257d75 100755 --- a/frappe/commands/site.py +++ b/frappe/commands/site.py @@ -19,36 +19,38 @@ from frappe.exceptions import SiteNotSpecifiedError @click.option('--db-type', default='mariadb', type=click.Choice(['mariadb', 'postgres']), help='Optional "postgres" or "mariadb". Default is "mariadb"') @click.option('--db-host', help='Database Host') @click.option('--db-port', type=int, help='Database Port') -@click.option('--mariadb-root-username', default='root', help='Root username for MariaDB') -@click.option('--mariadb-root-password', help='Root password for MariaDB') +@click.option('--db-root-username', '--mariadb-root-username', help='Root username for MariaDB or PostgreSQL, Default is "root"') +@click.option('--db-root-password', '--mariadb-root-password', help='Root password for MariaDB or PostgreSQL') @click.option('--no-mariadb-socket', is_flag=True, default=False, help='Set MariaDB host to % and use TCP/IP Socket instead of using the UNIX Socket') @click.option('--admin-password', help='Administrator password for new site', default=None) @click.option('--verbose', is_flag=True, default=False, help='Verbose') @click.option('--force', help='Force restore if site/database already exists', is_flag=True, default=False) @click.option('--source_sql', help='Initiate database with a SQL file') @click.option('--install-app', multiple=True, help='Install app after installation') -def new_site(site, mariadb_root_username=None, mariadb_root_password=None, admin_password=None, - verbose=False, install_apps=None, source_sql=None, force=None, no_mariadb_socket=False, - install_app=None, db_name=None, db_password=None, db_type=None, db_host=None, db_port=None): +@click.option('--set-default', is_flag=True, default=False, help='Set the new site as default site') +def new_site(site, db_root_username=None, db_root_password=None, admin_password=None, + verbose=False, install_apps=None, source_sql=None, force=None, no_mariadb_socket=False, + install_app=None, db_name=None, db_password=None, db_type=None, db_host=None, db_port=None, + set_default=False): "Create a new site" from frappe.installer import _new_site frappe.init(site=site, new_site=True) - _new_site(db_name, site, mariadb_root_username=mariadb_root_username, - mariadb_root_password=mariadb_root_password, admin_password=admin_password, - verbose=verbose, install_apps=install_app, source_sql=source_sql, force=force, - no_mariadb_socket=no_mariadb_socket, db_password=db_password, db_type=db_type, db_host=db_host, - db_port=db_port, new_site=True) + _new_site(db_name, site, db_root_username=db_root_username, + db_root_password=db_root_password, admin_password=admin_password, + verbose=verbose, install_apps=install_app, source_sql=source_sql, force=force, + no_mariadb_socket=no_mariadb_socket, db_password=db_password, db_type=db_type, db_host=db_host, + db_port=db_port, new_site=True) - if len(frappe.utils.get_sites()) == 1: + if set_default: use(site) @click.command('restore') @click.argument('sql-file-path') -@click.option('--mariadb-root-username', default='root', help='Root username for MariaDB') -@click.option('--mariadb-root-password', help='Root password for MariaDB') +@click.option('--db-root-username', '--mariadb-root-username', help='Root username for MariaDB or PostgreSQL, Default is "root"') +@click.option('--db-root-password', '--mariadb-root-password', help='Root password for MariaDB or PostgreSQL') @click.option('--db-name', help='Database name for site in case it is a new one') @click.option('--admin-password', help='Administrator password for new site') @click.option('--install-app', multiple=True, help='Install app after installation') @@ -57,7 +59,7 @@ def new_site(site, mariadb_root_username=None, mariadb_root_password=None, admin @click.option('--force', is_flag=True, default=False, help='Ignore the validations and downgrade warnings. This action is not recommended') @click.option('--encryption-key', help='Backup encryption key') @pass_context -def restore(context, sql_file_path, encryption_key=None, mariadb_root_username=None, mariadb_root_password=None, +def restore(context, sql_file_path, encryption_key=None, db_root_username=None, db_root_password=None, db_name=None, verbose=None, install_app=None, admin_password=None, force=None, with_public_files=None, with_private_files=None): "Restore site database from an sql file" @@ -150,8 +152,8 @@ def restore(context, sql_file_path, encryption_key=None, mariadb_root_username=N try: - _new_site(frappe.conf.db_name, site, mariadb_root_username=mariadb_root_username, - mariadb_root_password=mariadb_root_password, admin_password=admin_password, + _new_site(frappe.conf.db_name, site, db_root_username=db_root_username, + db_root_password=db_root_password, admin_password=admin_password, verbose=context.verbose, install_apps=install_app, source_sql=decompressed_file_name, force=True, db_type=frappe.conf.db_type) @@ -290,16 +292,16 @@ def partial_restore(context, sql_file_path, verbose, encryption_key=None): @click.command('reinstall') @click.option('--admin-password', help='Administrator Password for reinstalled site') -@click.option('--mariadb-root-username', help='Root username for MariaDB') -@click.option('--mariadb-root-password', help='Root password for MariaDB') +@click.option('--db-root-username', '--mariadb-root-username', help='Root username for MariaDB or PostgreSQL, Default is "root"') +@click.option('--db-root-password', '--mariadb-root-password', help='Root password for MariaDB or PostgreSQL') @click.option('--yes', is_flag=True, default=False, help='Pass --yes to skip confirmation') @pass_context -def reinstall(context, admin_password=None, mariadb_root_username=None, mariadb_root_password=None, yes=False): +def reinstall(context, admin_password=None, db_root_username=None, db_root_password=None, yes=False): "Reinstall site ie. wipe all data and start over" site = get_site(context) - _reinstall(site, admin_password, mariadb_root_username, mariadb_root_password, yes, verbose=context.verbose) + _reinstall(site, admin_password, db_root_username, db_root_password, yes, verbose=context.verbose) -def _reinstall(site, admin_password=None, mariadb_root_username=None, mariadb_root_password=None, yes=False, verbose=False): +def _reinstall(site, admin_password=None, db_root_username=None, db_root_password=None, yes=False, verbose=False): from frappe.installer import _new_site if not yes: @@ -319,7 +321,7 @@ def _reinstall(site, admin_password=None, mariadb_root_username=None, mariadb_ro frappe.init(site=site) _new_site(frappe.conf.db_name, site, verbose=verbose, force=True, reinstall=True, install_apps=installed, - mariadb_root_username=mariadb_root_username, mariadb_root_password=mariadb_root_password, + db_root_username=db_root_username, db_root_password=db_root_password, admin_password=admin_password) @click.command('install-app') @@ -656,16 +658,16 @@ def uninstall(context, app, dry_run, yes, no_backup, force): @click.command('drop-site') @click.argument('site') -@click.option('--root-login', default='root') -@click.option('--root-password') +@click.option('--db-root-username', '--mariadb-root-username', '--root-login', help='Root username for MariaDB or PostgreSQL, Default is "root"') +@click.option('--db-root-password', '--mariadb-root-password', '--root-password', help='Root password for MariaDB or PostgreSQL') @click.option('--archived-sites-path') @click.option('--no-backup', is_flag=True, default=False) @click.option('--force', help='Force drop-site even if an error is encountered', is_flag=True, default=False) -def drop_site(site, root_login='root', root_password=None, archived_sites_path=None, force=False, no_backup=False): - _drop_site(site, root_login, root_password, archived_sites_path, force, no_backup) +def drop_site(site, db_root_username='root', db_root_password=None, archived_sites_path=None, force=False, no_backup=False): + _drop_site(site, db_root_username, db_root_password, archived_sites_path, force, no_backup) -def _drop_site(site, root_login='root', root_password=None, archived_sites_path=None, force=False, no_backup=False): +def _drop_site(site, db_root_username=None, db_root_password=None, archived_sites_path=None, force=False, no_backup=False): "Remove site from database and filesystem" from frappe.database import drop_user_and_database from frappe.utils.backups import scheduled_backup @@ -690,7 +692,7 @@ def _drop_site(site, root_login='root', root_password=None, archived_sites_path= click.echo("\n".join(messages)) sys.exit(1) - drop_user_and_database(frappe.conf.db_name, root_login, root_password) + drop_user_and_database(frappe.conf.db_name, db_root_username, db_root_password) archived_sites_path = archived_sites_path or os.path.join(frappe.get_app_path('frappe'), '..', '..', '..', 'archived', 'sites') diff --git a/frappe/database/postgres/setup_db.py b/frappe/database/postgres/setup_db.py index 19ba681237..b3b2e0fd41 100644 --- a/frappe/database/postgres/setup_db.py +++ b/frappe/database/postgres/setup_db.py @@ -4,7 +4,7 @@ import frappe def setup_database(force, source_sql=None, verbose=False): - root_conn = get_root_connection() + root_conn = get_root_connection(frappe.flags.root_login, frappe.flags.root_password) root_conn.commit() root_conn.sql("DROP DATABASE IF EXISTS `{0}`".format(frappe.conf.db_name)) root_conn.sql("DROP USER IF EXISTS {0}".format(frappe.conf.db_name)) @@ -70,7 +70,7 @@ def import_db_from_sql(source_sql=None, verbose=False): print(f"\nSTDOUT by psql:\n{restore_proc.stdout.decode()}\nImported from Database File: {source_sql}") def setup_help_database(help_db_name): - root_conn = get_root_connection() + root_conn = get_root_connection(frappe.flags.root_login, frappe.flags.root_password) root_conn.sql("DROP DATABASE IF EXISTS `{0}`".format(help_db_name)) root_conn.sql("DROP USER IF EXISTS {0}".format(help_db_name)) root_conn.sql("CREATE DATABASE `{0}`".format(help_db_name)) diff --git a/frappe/installer.py b/frappe/installer.py index 20db451d26..6ebab95a7d 100644 --- a/frappe/installer.py +++ b/frappe/installer.py @@ -14,8 +14,8 @@ from frappe.defaults import _clear_cache def _new_site( db_name, site, - mariadb_root_username=None, - mariadb_root_password=None, + db_root_username=None, + db_root_password=None, admin_password=None, verbose=False, install_apps=None, @@ -60,8 +60,8 @@ def _new_site( installing = touch_file(get_site_path("locks", "installing.lock")) install_db( - root_login=mariadb_root_username, - root_password=mariadb_root_password, + root_login=db_root_username, + root_password=db_root_password, db_name=db_name, admin_password=admin_password, verbose=verbose, @@ -92,7 +92,7 @@ def _new_site( print("*** Scheduler is", scheduler_status, "***") -def install_db(root_login="root", root_password=None, db_name=None, source_sql=None, +def install_db(root_login=None, root_password=None, db_name=None, source_sql=None, admin_password=None, verbose=True, force=0, site_config=None, reinstall=False, db_password=None, db_type=None, db_host=None, db_port=None, no_mariadb_socket=False): import frappe.database @@ -101,6 +101,11 @@ def install_db(root_login="root", root_password=None, db_name=None, source_sql=N if not db_type: db_type = frappe.conf.db_type or 'mariadb' + if not root_login and db_type == 'mariadb': + root_login='root' + elif not root_login and db_type == 'postgres': + root_login='postgres' + make_conf(db_name, site_config=site_config, db_password=db_password, db_type=db_type, db_host=db_host, db_port=db_port) frappe.flags.in_install_db = True From f98be2e19fcd5c8958f555aff6b6473b4ce61ddd Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Fri, 25 Feb 2022 15:05:31 +0530 Subject: [PATCH 097/106] chore: undo unintentional creation timestamp change Co-authored-by: gavin --- .../doctype/customize_form_field/customize_form_field.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/custom/doctype/customize_form_field/customize_form_field.json b/frappe/custom/doctype/customize_form_field/customize_form_field.json index 1d721c57ec..e29a485663 100644 --- a/frappe/custom/doctype/customize_form_field/customize_form_field.json +++ b/frappe/custom/doctype/customize_form_field/customize_form_field.json @@ -1,7 +1,7 @@ { "actions": [], "autoname": "hash", - "creation": "2022-01-25 14:14:07.063385", + "creation": "2013-02-22 01:27:32", "doctype": "DocType", "document_type": "Setup", "editable_grid": 1, From 429e1420211ca25d117ffe41c0e6c7060ff99f98 Mon Sep 17 00:00:00 2001 From: Saqib Ansari Date: Fri, 25 Feb 2022 16:01:47 +0530 Subject: [PATCH 098/106] chore: add missing modified timestamp --- .../doctype/customize_form_field/customize_form_field.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/frappe/custom/doctype/customize_form_field/customize_form_field.json b/frappe/custom/doctype/customize_form_field/customize_form_field.json index c87668b2cb..1cc4c9f623 100644 --- a/frappe/custom/doctype/customize_form_field/customize_form_field.json +++ b/frappe/custom/doctype/customize_form_field/customize_form_field.json @@ -450,7 +450,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2022-02-08 19:38:16.111199", + "modified": "2022-02-25 16:01:12.616736", "modified_by": "Administrator", "module": "Custom", "name": "Customize Form Field", @@ -460,4 +460,4 @@ "sort_field": "modified", "sort_order": "ASC", "states": [] -} +} \ No newline at end of file From 89b0181a8a338d246ab6420231804363bd4130a5 Mon Sep 17 00:00:00 2001 From: ChillarAnand Date: Fri, 25 Feb 2022 18:24:00 +0530 Subject: [PATCH 099/106] test: Fix flaky permission test --- frappe/tests/test_permissions.py | 8 +++++--- frappe/tests/test_utils.py | 11 +++++++++++ 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/frappe/tests/test_permissions.py b/frappe/tests/test_permissions.py index fdff4d103e..f120843c76 100644 --- a/frappe/tests/test_permissions.py +++ b/frappe/tests/test_permissions.py @@ -14,9 +14,12 @@ from frappe.core.doctype.user_permission.user_permission import clear_user_permi from frappe.desk.form.load import getdoc from frappe.utils.data import now_datetime +from frappe.tests.test_utils import FrappeTestCase + test_dependencies = ['Blogger', 'Blog Post', "User", "Contact", "Salutation"] -class TestPermissions(unittest.TestCase): + +class TestPermissions(FrappeTestCase): def setUp(self): frappe.clear_cache(doctype="Blog Post") @@ -221,7 +224,7 @@ class TestPermissions(unittest.TestCase): # check that Document.owner cannot be changed user.reload() - user.owner = frappe.db.get_value("User", {"name": ("!=", user.name)}) + user.owner = "Guest" self.assertRaises(frappe.CannotChangeConstantError, user.save) def test_set_only_once(self): @@ -557,7 +560,6 @@ class TestPermissions(unittest.TestCase): # Remove delete perm update('Blog Post', 'Website Manager', 0, 'delete', 0) - frappe.clear_cache(doctype="Blog Post") frappe.set_user("test2@example.com") diff --git a/frappe/tests/test_utils.py b/frappe/tests/test_utils.py index 15029e961a..cf89829fc3 100644 --- a/frappe/tests/test_utils.py +++ b/frappe/tests/test_utils.py @@ -512,3 +512,14 @@ class TestLinkTitle(unittest.TestCase): prop_setter.delete() +class FrappeTestCase(unittest.TestCase): + """Base test class for Frappe tests.""" + @classmethod + def setUpClass(cls) -> None: + frappe.db.commit() + return super().setUpClass() + + @classmethod + def tearDownClass(cls) -> None: + frappe.db.rollback() + return super().tearDownClass() From c1f1bf406160bccdd861a8ba98b78dcacceb050b Mon Sep 17 00:00:00 2001 From: Deepesh Garg Date: Fri, 25 Feb 2022 20:41:05 +0530 Subject: [PATCH 100/106] fix: Unable to open query report --- frappe/desk/query_report.py | 19 +++++-------------- .../js/frappe/views/reports/query_report.js | 3 ++- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/frappe/desk/query_report.py b/frappe/desk/query_report.py index 9ed956e986..a0b0aec255 100644 --- a/frappe/desk/query_report.py +++ b/frappe/desk/query_report.py @@ -73,7 +73,7 @@ def get_report_result(report, filters): return res @frappe.read_only() -def generate_report_result(report, filters=None, user=None, custom_columns=None, report_settings=None): +def generate_report_result(report, filters=None, user=None, custom_columns=None, is_tree=False, parent_field=None): user = user or frappe.session.user filters = filters or [] @@ -108,7 +108,7 @@ def generate_report_result(report, filters=None, user=None, custom_columns=None, result = get_filtered_data(report.ref_doctype, columns, result, user) if cint(report.add_total_row) and result and not skip_total_row: - result = add_total_row(result, columns, report_settings=report_settings) + result = add_total_row(result, columns, is_tree=is_tree, parent_field=parent_field) return { "result": result, @@ -210,7 +210,7 @@ def get_script(report_name): @frappe.whitelist() @frappe.read_only() -def run(report_name, filters=None, user=None, ignore_prepared_report=False, custom_columns=None, report_settings=None): +def run(report_name, filters=None, user=None, ignore_prepared_report=False, custom_columns=None, is_tree=False, parent_field=None): report = get_report_doc(report_name) if not user: user = frappe.session.user @@ -238,7 +238,7 @@ def run(report_name, filters=None, user=None, ignore_prepared_report=False, cust dn = "" result = get_prepared_report_result(report, filters, dn, user) else: - result = generate_report_result(report, filters, user, custom_columns, report_settings) + result = generate_report_result(report, filters, user, custom_columns, is_tree, parent_field) result["add_total_row"] = report.add_total_row and not result.get( "skip_total_row", False @@ -435,18 +435,9 @@ def build_xlsx_data(columns, data, visible_idx, include_indentation, ignore_visi return result, column_widths -def add_total_row(result, columns, meta=None, report_settings=None): +def add_total_row(result, columns, meta=None, is_tree=False, parent_field=None): total_row = [""] * len(columns) has_percent = [] - is_tree = False - parent_field = '' - - if report_settings: - if isinstance(report_settings, (str,)): - report_settings = json.loads(report_settings) - - is_tree = report_settings.get('tree') - parent_field = report_settings.get('parent_field') for i, col in enumerate(columns): fieldtype, options, fieldname = None, None, None diff --git a/frappe/public/js/frappe/views/reports/query_report.js b/frappe/public/js/frappe/views/reports/query_report.js index c226a3a458..7c12809fcd 100644 --- a/frappe/public/js/frappe/views/reports/query_report.js +++ b/frappe/public/js/frappe/views/reports/query_report.js @@ -578,7 +578,8 @@ frappe.views.QueryReport = class QueryReport extends frappe.views.BaseList { args: { report_name: this.report_name, filters: filters, - report_settings: this.report_settings + is_tree: this.report_settings.tree, + parent_field: this.report_settings.parent_field }, callback: resolve, always: () => this.page.btn_secondary.prop('disabled', false) From e2a17c38fdeba48537097798db05b2201c4d3f91 Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Sat, 26 Feb 2022 12:15:25 +0530 Subject: [PATCH 101/106] revert: ignore_if_duplicate in postgres breaking CI --- frappe/desk/page/setup_wizard/setup_wizard.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/desk/page/setup_wizard/setup_wizard.py b/frappe/desk/page/setup_wizard/setup_wizard.py index 74101a6e1f..0c32e886f4 100755 --- a/frappe/desk/page/setup_wizard/setup_wizard.py +++ b/frappe/desk/page/setup_wizard/setup_wizard.py @@ -392,7 +392,7 @@ def make_records(records, debug=False): doc.flags.ignore_mandatory = True try: - doc.insert(ignore_permissions=True, ignore_if_duplicate=True) + doc.insert(ignore_permissions=True) frappe.db.commit() except frappe.DuplicateEntryError as e: From dad3a5c44803ceb916f49ae48649362f66e53b08 Mon Sep 17 00:00:00 2001 From: Deepesh Garg Date: Mon, 28 Feb 2022 08:40:07 +0530 Subject: [PATCH 102/106] test: Update test case --- frappe/core/doctype/report/test_report.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/frappe/core/doctype/report/test_report.py b/frappe/core/doctype/report/test_report.py index bf63afa5c5..7d434ff166 100644 --- a/frappe/core/doctype/report/test_report.py +++ b/frappe/core/doctype/report/test_report.py @@ -330,7 +330,8 @@ result = [ } ] - result = add_total_row(result, columns, meta=None, report_settings=report_settings) + result = add_total_row(result, columns, meta=None, is_tree=report_settings['tree'], + parent_field=report_settings['parent_field']) self.assertEqual(result[-1][0], "Total") self.assertEqual(result[-1][1], 200) self.assertEqual(result[-1][2], 150.50) From a8a544cf4494605aa15f96d04385bba0ca9fa22a Mon Sep 17 00:00:00 2001 From: DaizyModi <54097382+DaizyModi@users.noreply.github.com> Date: Mon, 28 Feb 2022 11:23:45 +0530 Subject: [PATCH 103/106] fix(grid): Select All checkbox not visible (#15913) In Child Tables such as Stock Entry Detail, Sales Invoice Item (wherever `grid.template` applies) non-editable grid doesn't let users select all rows of the child table. ![image](https://user-images.githubusercontent.com/54097382/153049801-26f2ca38-4892-4aff-9fe5-238a3fa58f5e.png) This fix will let users select all rows using a checkbox in the header row of the child table. ## Screenshots **Before** ![image](https://user-images.githubusercontent.com/16315650/153127765-1e575096-b7da-41f1-bed4-e5d1c48cb98e.png) **After** ![image](https://user-images.githubusercontent.com/16315650/153127672-9054014d-fbc2-4fff-9c7b-6dd0c7c6cc1c.png) --- frappe/public/js/frappe/form/grid_row.js | 15 +++++++-------- frappe/public/scss/common/grid.scss | 13 ++++++++++++- 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/frappe/public/js/frappe/form/grid_row.js b/frappe/public/js/frappe/form/grid_row.js index cd8bde1f57..2e9c6f970a 100644 --- a/frappe/public/js/frappe/form/grid_row.js +++ b/frappe/public/js/frappe/form/grid_row.js @@ -183,21 +183,20 @@ export default class GridRow { render_template() { this.set_row_index(); - if(this.row_display) { + if (this.row_display) { this.row_display.remove(); } // row index - if(this.doc) { - if(!this.row_index) { - this.row_index = $('
'+this.row_check_html+'
').appendTo(this.row); - } + if (!this.row_index) { + this.row_index = $(`
${this.row_check_html}
`).appendTo(this.row); + } + + if (this.doc) { this.row_index.find('span').html(this.doc.idx); } - this.row_display = $('
'+ - +'
').appendTo(this.row) + this.row_display = $('
').appendTo(this.row) .html(frappe.render(this.grid.template, { doc: this.doc ? frappe.get_format_helper(this.doc) : null, frm: this.frm, diff --git a/frappe/public/scss/common/grid.scss b/frappe/public/scss/common/grid.scss index bfce93dbcc..ab6bcfe8e8 100644 --- a/frappe/public/scss/common/grid.scss +++ b/frappe/public/scss/common/grid.scss @@ -54,7 +54,7 @@ } .form-grid .grid-heading-row .template-row { - margin-left: 20px; + margin-left: 8px; } .form-grid .template-row { @@ -88,6 +88,17 @@ margin-top: 2px; } +.template-row-index { + float: left; + margin-left: 15px; + margin-top: 8px; + margin-right: -20px; + + span { + margin-left: 5px; + } +} + .editable-form .grid-static-col.bold { font-weight: bold; } From 741ea13db228a702d63b58b370f144c8e09f3d1e Mon Sep 17 00:00:00 2001 From: Sagar Vora Date: Wed, 16 Feb 2022 14:04:41 +0530 Subject: [PATCH 104/106] fix: forget return value after `run_method` execution --- frappe/model/document.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/model/document.py b/frappe/model/document.py index cb36c18b47..37e70e8126 100644 --- a/frappe/model/document.py +++ b/frappe/model/document.py @@ -1154,7 +1154,7 @@ class Document(BaseDocument): for f in hooks: add_to_return_value(self, f(self, method, *args, **kwargs)) - return self._return_value + return self.__dict__.pop("_return_value", None) return runner From 2b48c083403d93690ecc255d26163204fde4e675 Mon Sep 17 00:00:00 2001 From: ChillarAnand Date: Mon, 28 Feb 2022 10:28:10 +0530 Subject: [PATCH 105/106] fix: Fix flaky tests --- frappe/desk/form/load.py | 5 +++++ frappe/social/doctype/energy_point_log/energy_point_log.py | 3 ++- frappe/tests/test_utils.py | 2 -- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/frappe/desk/form/load.py b/frappe/desk/form/load.py index 4d35ebf5e8..b5dfacb1d6 100644 --- a/frappe/desk/form/load.py +++ b/frappe/desk/form/load.py @@ -11,8 +11,10 @@ from frappe.model.utils.user_settings import get_user_settings from frappe.permissions import get_doc_permissions from frappe.desk.form.document_follow import is_document_followed from frappe import _ +from frappe import _dict from urllib.parse import quote + @frappe.whitelist() def getdoc(doctype, name, user=None): """ @@ -50,8 +52,11 @@ def getdoc(doctype, name, user=None): doc.add_seen() set_link_titles(doc) + if frappe.response.docs is None: + frappe.response = _dict({"docs": []}) frappe.response.docs.append(doc) + @frappe.whitelist() def getdoctype(doctype, with_parent=False, cached_timestamp=None): """load doctype""" diff --git a/frappe/social/doctype/energy_point_log/energy_point_log.py b/frappe/social/doctype/energy_point_log/energy_point_log.py index 86843302e9..5e6a9df16f 100644 --- a/frappe/social/doctype/energy_point_log/energy_point_log.py +++ b/frappe/social/doctype/energy_point_log/energy_point_log.py @@ -164,6 +164,7 @@ def get_alert_dict(doc): return alert_dict + def create_energy_points_log(ref_doctype, ref_name, doc, apply_only_once=False): doc = frappe._dict(doc) @@ -171,7 +172,7 @@ def create_energy_points_log(ref_doctype, ref_name, doc, apply_only_once=False): ref_name, doc.rule, None if apply_only_once else doc.user) if log_exists: - return + return frappe.get_doc('Energy Point Log', log_exists) new_log = frappe.new_doc('Energy Point Log') new_log.reference_doctype = ref_doctype diff --git a/frappe/tests/test_utils.py b/frappe/tests/test_utils.py index 15029e961a..18fca9de8c 100644 --- a/frappe/tests/test_utils.py +++ b/frappe/tests/test_utils.py @@ -510,5 +510,3 @@ class TestLinkTitle(unittest.TestCase): todo.delete() user.delete() prop_setter.delete() - - From 014cd0cbaa1abc0ee38f75ba028ce1551b49d688 Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Mon, 28 Feb 2022 14:30:43 +0530 Subject: [PATCH 106/106] fix!: block customizing select field type options --- frappe/custom/doctype/customize_form/customize_form.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frappe/custom/doctype/customize_form/customize_form.py b/frappe/custom/doctype/customize_form/customize_form.py index f1b6ab40ed..81cd38ff87 100644 --- a/frappe/custom/doctype/customize_form/customize_form.py +++ b/frappe/custom/doctype/customize_form/customize_form.py @@ -600,4 +600,4 @@ ALLOWED_FIELDTYPE_CHANGE = ( ('Code', 'Geolocation'), ('Table', 'Table MultiSelect')) -ALLOWED_OPTIONS_CHANGE = ('Read Only', 'HTML', 'Select', 'Data') +ALLOWED_OPTIONS_CHANGE = ('Read Only', 'HTML', 'Data')