From 43f3ba3cba261ecde62c7f016d9eac0e3bfdb810 Mon Sep 17 00:00:00 2001
From: Faris Ansari <netchamp.faris@gmail.com>
Date: Sat, 17 Apr 2021 23:09:16 +0530
Subject: [PATCH] fix: Add autocompletion items in Server Script

- API to add autocompletion items in Code field
---
 frappe/cache_manager.py                       |  2 +-
 .../doctype/server_script/server_script.js    |  6 +++
 .../doctype/server_script/server_script.py    | 23 ++++++++-
 frappe/public/js/frappe/form/controls/code.js | 50 +++++++++++++++++++
 4 files changed, 79 insertions(+), 2 deletions(-)

diff --git a/frappe/cache_manager.py b/frappe/cache_manager.py
index bad879d2fa..4e0fe0cf44 100644
--- a/frappe/cache_manager.py
+++ b/frappe/cache_manager.py
@@ -18,7 +18,7 @@ global_cache_keys = ("app_hooks", "installed_apps", 'all_apps',
 		'scheduler_events', 'time_zone', 'webhooks', 'active_domains',
 		'active_modules', 'assignment_rule', 'server_script_map', 'wkhtmltopdf_version',
 		'domain_restricted_doctypes', 'domain_restricted_pages', 'information_schema:counts',
-		'sitemap_routes', 'db_tables') + doctype_map_keys
+		'sitemap_routes', 'db_tables', 'server_script_autocompletion_items') + doctype_map_keys
 
 user_cache_keys = ("bootinfo", "user_recent", "roles", "user_doc", "lang",
 		"defaults", "user_permissions", "home_page", "linked_with",
diff --git a/frappe/core/doctype/server_script/server_script.js b/frappe/core/doctype/server_script/server_script.js
index 95a63780f8..e12200b6fc 100644
--- a/frappe/core/doctype/server_script/server_script.js
+++ b/frappe/core/doctype/server_script/server_script.js
@@ -9,6 +9,12 @@ frappe.ui.form.on('Server Script', {
 		if (frm.doc.script_type != 'Scheduler Event') {
 			frm.dashboard.hide();
 		}
+
+		frm.call('get_autocompletion_items')
+			.then(r => r.message)
+			.then(items => {
+				frm.set_df_property('script', 'autocompletions', items)
+			});
 	},
 
 	setup_help(frm) {
diff --git a/frappe/core/doctype/server_script/server_script.py b/frappe/core/doctype/server_script/server_script.py
index 8838d9e954..6a8eb59c3a 100644
--- a/frappe/core/doctype/server_script/server_script.py
+++ b/frappe/core/doctype/server_script/server_script.py
@@ -5,11 +5,12 @@
 from __future__ import unicode_literals
 
 import ast
+from types import FunctionType, ModuleType
 from typing import Dict, List
 
 import frappe
 from frappe.model.document import Document
-from frappe.utils.safe_exec import safe_exec
+from frappe.utils.safe_exec import get_safe_globals, safe_exec, NamespaceDict
 from frappe import _
 
 
@@ -122,6 +123,26 @@ class ServerScript(Document):
 		if locals["conditions"]:
 			return locals["conditions"]
 
+	@frappe.whitelist()
+	def get_autocompletion_items(self):
+		def get_keys(obj):
+			out = []
+			for key in obj:
+				if key.startswith('_'):
+					continue
+				value = obj[key]
+				if isinstance(value, (FunctionType, ModuleType)):
+					out.append(key)
+				elif isinstance(value, (NamespaceDict, dict)):
+					out += [f'{key}.{subkey}' for subkey in get_keys(value)]
+			return out
+
+		items = frappe.cache().get_value('server_script_autocompletion_items')
+		if not items:
+			items = get_keys(get_safe_globals())
+			frappe.cache().set_value('server_script_autocompletion_items', items)
+		return items
+
 
 @frappe.whitelist()
 def setup_scheduler_events(script_name, frequency):
diff --git a/frappe/public/js/frappe/form/controls/code.js b/frappe/public/js/frappe/form/controls/code.js
index eec450b390..8d2609b836 100644
--- a/frappe/public/js/frappe/form/controls/code.js
+++ b/frappe/public/js/frappe/form/controls/code.js
@@ -31,6 +31,56 @@ frappe.ui.form.ControlCode = frappe.ui.form.ControlText.extend({
 			const input_value = this.get_input_value();
 			this.parse_validate_and_set_in_model(input_value);
 		}, 300));
+
+		// setup autocompletion when it is set the first time
+		Object.defineProperty(this.df, 'autocompletions', {
+			get() {
+				return this._autocompletions || [];
+			},
+			set: (value) => {
+				this.setup_autocompletion();
+				this.df._autocompletions = value;
+			}
+		});
+	},
+
+	setup_autocompletion() {
+		if (this._autocompletion_setup) return;
+
+		const ace = window.ace;
+		const get_autocompletions = () => this.df.autocompletions;
+
+		ace.config.loadModule("ace/ext/language_tools", langTools => {
+			this.editor.setOptions({
+				enableBasicAutocompletion: true,
+				enableSnippets: true,
+				enableLiveAutocompletion: true
+			});
+
+			let completer = {
+				getCompletions: function(editor, session, pos, prefix, callback) {
+					if (prefix.length === 0) {
+						callback(null, []);
+						return;
+					}
+					let autocompletions = get_autocompletions();
+					if (autocompletions.length) {
+						callback(
+							null,
+							autocompletions.map(a => ({
+								name: 'frappe',
+								value: a,
+								score: 100,
+								meta: 'Frappe API'
+							}))
+						);
+					}
+				}
+			}
+			langTools.addCompleter(completer);
+		});
+
+		this._autocompletion_setup = true;
 	},
 
 	refresh_height() {