new module name expl_pgsql

Author: MGorkov

web/pgadmin/static/js/components/ReactCodeMirror/index.jsx

@@ -19,7 +19,8 @@ import gettext from 'sources/gettext';
 import { PgIconButton } from '../Buttons';
 import { copyToClipboard } from '../../clipboard';
 import { useDelayedCaller } from '../../custom_hooks';
-import epFormatSQL from '../../../../tools/ep/static/js/ExplainPostgreSQL/formatSQL';
+import explPgsqlFormatSQL from '../../../../tools/expl_pgsql/static/js/ExplainPostgreSQL/formatSQL';
+import Loader from '../Loader';
 
 import Editor from './components/Editor';
 import CustomPropTypes from '../../custom_prop_types';
@@ -69,9 +70,10 @@ export default function CodeMirror({className, currEditor, showCopyBtn=false, cu
   const [[showFind, isReplace, findKey], setShowFind] = useState([false, false, false]);
   const [showGoto, setShowGoto] = useState(false);
   const [showCopy, setShowCopy] = useState(false);
+  const [loading, setLoading] = useState(false);
   const preferences = usePreferences().getPreferencesForModule('sqleditor');
   const editorPrefs = usePreferences().getPreferencesForModule('editor');
-  const epPrefs = usePreferences().getPreferencesForModule('ep');
+  const explPgsqlPrefs = usePreferences().getPreferencesForModule('expl_pgsql');
 
   const formatSQL = async (view)=>{
     let selection = true, sql = view.getSelection();
@@ -98,12 +100,22 @@ export default function CodeMirror({className, currEditor, showCopyBtn=false, cu
       selection = false;
     }
     let formattedSql;
-    if (epPrefs.explain_postgresql_format) {
+    if (explPgsqlPrefs.explain_postgresql_format) {
+      let loadingTimeout;
       try {
-        formattedSql = await epFormatSQL(sql);
+        loadingTimeout = setTimeout(() => {
+          setLoading(true);
+        }, 500);
+        formattedSql = await explPgsqlFormatSQL(sql);
       } catch (e) {
         console.error('Error formatting SQL using Explain PostgreSQL API:', e);
         formattedSql = format(sql,formatPrefs);
+      } finally {
+        if (loading) {
+          setLoading(false);
+        } else {
+          clearTimeout(loadingTimeout);
+        }
       }
     } else {
       formattedSql = format(sql,formatPrefs);
@@ -207,6 +219,7 @@ export default function CodeMirror({className, currEditor, showCopyBtn=false, cu
     <Root className={[className].join(' ')} onMouseEnter={onMouseEnter} onMouseLeave={onMouseLeave} >
       <Editor currEditor={currEditorWrap} customKeyMap={finalCustomKeyMap} {...props} />
       {showCopy && <CopyButton editor={editor.current} />}
+      {loading && <Loader message={gettext('Loading...')} autoEllipsis />}
       <FindDialog key={findKey} editor={editor.current} show={showFind} replace={isReplace} onClose={closeFind} />
       <GotoDialog editor={editor.current} show={showGoto} onClose={closeGoto} />
     </Root>

web/pgadmin/tools/__init__.py

@@ -34,7 +34,7 @@ def register(self, app, options):
         from .debugger import blueprint as module
         app.register_blueprint(module)
 
-        from .ep import blueprint as module
+        from .expl_pgsql import blueprint as module
         app.register_blueprint(module)
 
         from .erd import blueprint as module

web/pgadmin/tools/ep/__init__.py web/pgadmin/tools/expl_pgsql/__init__.pyweb/pgadmin/tools/ep/__init__.py renamed to web/pgadmin/tools/expl_pgsql/__init__.py

@@ -19,43 +19,50 @@
 from pgadmin.utils.ajax import make_json_response
 from pgadmin.user_login_check import pga_login_required
 
-MODULE_NAME = 'ep'
+MODULE_NAME = 'expl_pgsql'
 
-class EPModule(PgAdminModule):
+
+class ExplPgsqlModule(PgAdminModule):
     """Explain PostgreSQL configuration module for pgAdmin."""
 
     LABEL = gettext('Explain PostgreSQL')
-    
+
     def register_preferences(self):
         """
         Register preferences for Explain PostgreSQL.
         """
 
+        self.explain_module = self.preference.register(
+            'Explain PostgreSQL', 'explain_postgresql',
+            gettext("Explain Plan"), 'boolean', False,
+            category_label=gettext('Configuration'),
+            help_str=gettext('Analyze query plan via Explain PostgreSQL API')
+        )
+
         self.explain_postgresql_api = self.preference.register(
             'Explain PostgreSQL', 'explain_postgresql_api',
-            gettext("Explain PostgreSQL API"), 'text', 'https://explain.tensor.ru',
+            gettext("Explain PostgreSQL API"), 'text',
+            'https://explain.tensor.ru',
             category_label=gettext('Configuration'),
-            help_str=gettext('Explain PostgreSQL API endpoint (e.g. https://explain-postgresql.com)'),
+            help_str=gettext(
+                'Explain PostgreSQL API endpoint '
+                '(e.g. https://explain.tensor.ru)'
+            ),
             allow_blanks=False
         )
 
         self.explain_postgresql_private = self.preference.register(
             'Explain PostgreSQL', 'explain_postgresql_private',
             gettext("Private Plans"), 'boolean', False,
             category_label=gettext('Configuration'),
-            help_str=gettext('Hide plans from public access on Explain PostgreSQL')
-        )
-
-        self.explain_module = self.preference.register(
-            'Explain PostgreSQL', 'explain_postgresql',
-            gettext("Explain Plan"), 'boolean', True,
-            category_label=gettext('Configuration'),
-            help_str=gettext('Analyze query plan via Explain PostgreSQL API')
+            help_str=gettext(
+                'Hide plans from public access on Explain PostgreSQL'
+            )
         )
 
         self.explain_postgresql_format = self.preference.register(
             'Explain PostgreSQL', 'explain_postgresql_format',
-            gettext("Format SQL"), 'boolean', True,
+            gettext("Format SQL"), 'boolean', False,
             category_label=gettext('Configuration'),
             help_str=gettext('Format SQL using Explain PostgreSQL API')
         )
@@ -65,109 +72,154 @@ def get_exposed_url_endpoints(self):
         Returns the list of URLs exposed to the client.
         """
         return [
-            'ep.explain_postgresql',
-            'ep.explain_postgresql_format',
+            'expl_pgsql.status',
+            'expl_pgsql.explain',
+            'expl_pgsql.formatSQL',
         ]
 
 
 # Initialise the module
-blueprint = EPModule(MODULE_NAME, __name__, static_url_path='/static')
+blueprint = ExplPgsqlModule(MODULE_NAME, __name__, static_url_path='/static')
+
+
+@blueprint.route("/status", methods=["GET"], endpoint='status')
+@pga_login_required
+def get_status():
+    """
+    Get the status of the Explain PostgreSQL configuration.
+    Indicates whether the analysis of query plans
+    via the Explain PostgreSQL API is currently enabled
+    """
+
+    return make_json_response(
+        success=1,
+        data={
+            'enabled': get_preference_value('explain_postgresql'),
+        }
+    )
+
 
 @blueprint.route(
-    '/explain_postgresql_format',
-    methods=["POST"], endpoint='explain_postgresql_format'
+    '/formatSQL',
+    methods=["POST"], endpoint='formatSQL'
 )
 @pga_login_required
-def explain_postgresql_format():
+def formatSQL():
     """
     This method is used to send sql to explain postgresql beatifier api.
-
     """
 
     data = request.get_json(silent=True)
     if not isinstance(data, dict):
         return make_json_response(
             success=0,
             errormsg="Invalid JSON payload. Expected an object/dictionary.",
-            info=gettext('JSON payload must be an object, not null, array, or scalar value'),
+            info=gettext(
+                'JSON payload must be an object,'
+                ' not null, array, or scalar value'
+            ),
         )
-    
+
     explain_postgresql_api = get_preference_value('explain_postgresql_api')
-    
+
     # Validate the API URL to prevent SSRF
     if not is_valid_url(explain_postgresql_api):
         return make_json_response(
             success=0,
-            errormsg="Invalid API endpoint URL. Only HTTP/HTTPS URLs are allowed.",
-            info=gettext('The provided API endpoint is not valid. Only HTTP/HTTPS URLs are permitted.')
+            errormsg=gettext(
+                'Invalid API endpoint URL. Only HTTP/HTTPS URLs are allowed.'
+            ),
+            info=gettext(
+                'The provided API endpoint is not valid. '
+                'Only HTTP/HTTPS URLs are permitted.'
+            )
         )
 
-    is_error, data = send_post_request(explain_postgresql_api + '/beautifier-api', data)
+    api_url = explain_postgresql_api + '/beautifier-api'
+    is_error, data = send_post_request(api_url, data)
     if is_error:
-        return make_json_response(success=0, errormsg=data,
-                                  info=gettext('Failed to post data to the Explain Postgresql API'),
-                                  )
+        return make_json_response(
+            success=0,
+            errormsg=data,
+            info=gettext('Failed to post data to the Explain Postgresql API'),
+        )
 
     return make_json_response(success=1, data=data)
 
 
 @blueprint.route(
-    '/explain_postgresql',
-    methods=["POST"], endpoint='explain_postgresql'
+    '/explain',
+    methods=["POST"], endpoint='explain'
 )
 @pga_login_required
-def explain_postgresql():
+def explain():
     """
     This method is used to send plan to explain postgresql api.
-
     """
 
     data = request.get_json(silent=True)
     if not isinstance(data, dict):
         return make_json_response(
             success=0,
             errormsg="Invalid JSON payload. Expected an object/dictionary.",
-            info=gettext('JSON payload must be an object, not null, array, or scalar value'),
+            info=gettext(
+                'JSON payload must be an object, '
+                'not null, array, or scalar value'
+            ),
         )
-    
+
     explain_postgresql_api = get_preference_value('explain_postgresql_api')
-    
+
     # Validate the API URL to prevent SSRF
     if not is_valid_url(explain_postgresql_api):
         return make_json_response(
             success=0,
-            errormsg="Invalid API endpoint URL. Only HTTP/HTTPS URLs are allowed.",
-            info=gettext('The provided API endpoint is not valid. Only HTTP/HTTPS URLs are permitted.')
+            errormsg=gettext(
+                'Invalid API endpoint URL. Only HTTP/HTTPS URLs are allowed.'
+            ),
+            info=gettext(
+                'The provided API endpoint is not valid. '
+                'Only HTTP/HTTPS URLs are permitted.'
+            )
         )
-    
-    explain_postgresql_private = get_preference_value('explain_postgresql_private')
+
+    pref_name = 'explain_postgresql_private'
+    explain_postgresql_private = get_preference_value(pref_name)
     data['private'] = explain_postgresql_private
 
-    is_error, response_data = send_post_request(explain_postgresql_api + '/explain', data)
+    api_url = explain_postgresql_api + '/explain'
+    is_error, response_data = send_post_request(api_url, data)
     if is_error:
-        return make_json_response(success=0, errormsg=response_data,
-                                  info=gettext('Failed to post data to the Explain Postgresql API'),
-                                  )
+        return make_json_response(
+            success=0,
+            errormsg=response_data,
+            info=gettext('Failed to post data to the Explain Postgresql API'),
+        )
 
     # response_data should be a relative path from 302 Location header
     if not response_data.startswith('/'):
-        return make_json_response(success=0, errormsg="Unexpected response format from API")
-    return make_json_response(success=1, data=explain_postgresql_api + response_data)
+        return make_json_response(
+            success=0,
+            errormsg='Unexpected response format from API'
+        )
+    res_data = explain_postgresql_api + response_data
+    return make_json_response(success=1, data=res_data)
 
 
 def is_valid_url(url):
     """
-    Validate that a URL is safe to use (HTTP/HTTPS only, localhost and private IP ranges are allowed).
-    
+    Validate that a URL is safe to use
+    (HTTP/HTTPS only, localhost and private IP ranges are allowed).
+
     Args:
         url: The URL to validate
-        
+
     Returns:
         bool: True if URL is valid, False otherwise
     """
     if not url:
         return False
-    
+
     try:
         parsed = urlparse(url)
 
@@ -184,7 +236,7 @@ def is_valid_url(url):
         return False
 
 
-def send_post_request(url_api, data, parse=False):
+def send_post_request(url_api, data):
     data = json.dumps(data).encode('utf-8')
     headers = {
         "Content-Type": "application/json; charset=utf-8",
@@ -197,13 +249,11 @@ def send_post_request(url_api, data, parse=False):
             if (response.code == 302):
                 return False, response.headers["Location"]
             response_data = response.read().decode('utf-8')
-            if (parse):
-                return False, json.loads(response_data)
-            else:
-                return False, response_data
+            return False, response_data
     except Exception as e:
         return True, str(e)
 
+
 class No302HTTPErrorProcessor(urllib.request.HTTPErrorProcessor):
 
     def http_response(self, request, response):
@@ -222,6 +272,7 @@ def http_response(self, request, response):
 
     https_response = http_response
 
+
 class NoRedirectHandler(urllib.request.HTTPRedirectHandler):
     """
     A redirect handler that prevents automatic redirects by returning None
@@ -233,14 +284,18 @@ def redirect_request(self, req, fp, code, msg, headers, newurl):
         """
         return None
 
-# Build opener without HTTPRedirectHandler so No302HTTPErrorProcessor can handle 302 responses
+
+# Build opener without HTTPRedirectHandler
+#  so No302HTTPErrorProcessor can handle 302 responses
 no302opener = urllib.request.build_opener(
     No302HTTPErrorProcessor(),
-    NoRedirectHandler(),  # Explicitly add NoRedirectHandler to prevent automatic redirects
+    # Explicitly add NoRedirectHandler to prevent automatic redirects
+    NoRedirectHandler(),
     urllib.request.HTTPHandler(),
     urllib.request.HTTPSHandler()
 )
 
+
 def get_preference_value(name):
     """
     Get a preference value, returning None if empty or not set.

…static/js/ExplainPostgreSQL/formatSQL.js …static/js/ExplainPostgreSQL/formatSQL.jsweb/pgadmin/tools/ep/static/js/ExplainPostgreSQL/formatSQL.js renamed to web/pgadmin/tools/expl_pgsql/static/js/ExplainPostgreSQL/formatSQL.js web/pgadmin/tools/ep/static/js/ExplainPostgreSQL/formatSQL.js renamed to web/pgadmin/tools/expl_pgsql/static/js/ExplainPostgreSQL/formatSQL.js

@@ -5,7 +5,7 @@ export default async function formatSQL(sql) {
   return new Promise((resolve, reject) => {
     const api = getApiInstance();
     api.post(
-      url_for('ep.explain_postgresql_format'),
+      url_for('expl_pgsql.formatSQL'),
       JSON.stringify({
         query_src: sql,
       }))