Extension of bug fix: SQL result tab header marks:

gerdwagner · gerdwagner · commit c21c113b3a00 · 2024-12-14T20:14:18.000+01:00
Fixed performance problem when the SQL editor contained SQLs that were longer than 8000 characters.
  For SQLs that are longer than 8000 characters marking of result tab headers is skipped.
  The maximum number of characters can be configured at menu File --&gt; Global Preferences
  --&gt; tab SQL --&gt; section "SQL result tab header". The default value is 8000.
diff --git a/sql12/core/doc/changes.txt b/sql12/core/doc/changes.txt
@@ -107,6 +107,8 @@ Bug fixes:
 SQL result tab header marks:
   Fixed performance problem when the SQL editor contained SQLs that were longer than 8000 characters.
   For SQLs that are longer than 8000 characters marking of result tab headers is skipped.
+  The maximum number of characters can be configured at menu File --> Global Preferences
+  --> tab SQL --> section "SQL result tab header". The default value is 8000.
 
 Improved the performance of SQL result tab header marking for large SQL editor content.
 
diff --git a/sql12/core/src/net/sourceforge/squirrel_sql/client/preferences/SquirrelPreferences.java b/sql12/core/src/net/sourceforge/squirrel_sql/client/preferences/SquirrelPreferences.java
@@ -52,7 +52,7 @@
  */
 public class SquirrelPreferences implements Serializable
 {
-	public interface IPropertyNames
+   public interface IPropertyNames
    {
       String ACTION_KEYS = "actionKeys";
       String CONFIRM_SESSION_CLOSE = "confirmSessionClose";
@@ -71,6 +71,7 @@ public interface IPropertyNames
 		String RESULT_TAB_HEADER_MARK_THICKNESS = "resultTabHeaderMarkThickness";
 		String RESULT_TAB_HEADER_COMPARE_SQLS_NORMALIZED = "resultTabHeaderCompareSqlsNormalized";
 		String RESULT_TAB_HEADER_MARK_LAST_ONLY = "resultTabHeaderMarkLastOnly";
+		String RESULT_TAB_HEADER_MARK_MAX_SQL_LENGTH_TO_CHECK = "resultTabHeaderMarkMaxSqlLengthToCheck";
 
 		String USE_STATEMENT_SEPARATOR_AS_SQL_TO_EXECUTE_BOUNDS = "useStatementSeparatorAsSqlToExecuteBounds";
       String MAIN_FRAME_STATE = "mainFrameWindowState";
@@ -357,6 +358,7 @@ public interface IJdbcDebugTypes
 	private int _resultTabHeaderMarkThickness = 2;
 	private boolean _resultTabHeaderCompareSqlsNormalized;
 	private boolean _resultTabHeaderMarkLastOnly;
+	private int _resultTabHeaderMarkMaxSqlLengthToCheck = 8000;
 
 	public SquirrelPreferences()
 	{
@@ -1726,4 +1728,15 @@ public void setResultTabHeaderMarkLastOnly(boolean resultTabHeaderMarkLastOnly)
 	{
 		_resultTabHeaderMarkLastOnly = resultTabHeaderMarkLastOnly;
 	}
+
+	public int getResultTabHeaderMarkMaxSqlLengthToCheck()
+	{
+		return _resultTabHeaderMarkMaxSqlLengthToCheck;
+	}
+
+	public void setResultTabHeaderMarkMaxSqlLengthToCheck(int resultTabHeaderMarkMaxSqlLengthToCheck)
+	{
+		_resultTabHeaderMarkMaxSqlLengthToCheck = resultTabHeaderMarkMaxSqlLengthToCheck;
+	}
+
 }
diff --git a/sql12/core/src/net/sourceforge/squirrel_sql/client/preferences/SquirrelPreferencesBeanInfo.java b/sql12/core/src/net/sourceforge/squirrel_sql/client/preferences/SquirrelPreferencesBeanInfo.java
@@ -67,6 +67,7 @@ public PropertyDescriptor[] getPropertyDescriptors()
             prop(RESULT_TAB_HEADER_MARK_THICKNESS, SquirrelPreferences.class, "getResultTabHeaderMarkThickness", "setResultTabHeaderMarkThickness"),
             prop(RESULT_TAB_HEADER_COMPARE_SQLS_NORMALIZED, SquirrelPreferences.class, "isResultTabHeaderCompareSqlsNormalized", "setResultTabHeaderCompareSqlsNormalized"),
             prop(RESULT_TAB_HEADER_MARK_LAST_ONLY, SquirrelPreferences.class, "isResultTabHeaderMarkLastOnly", "setResultTabHeaderMarkLastOnly"),
+            prop(RESULT_TAB_HEADER_MARK_MAX_SQL_LENGTH_TO_CHECK, SquirrelPreferences.class, "getResultTabHeaderMarkMaxSqlLengthToCheck", "setResultTabHeaderMarkMaxSqlLengthToCheck"),
 
             prop(USE_STATEMENT_SEPARATOR_AS_SQL_TO_EXECUTE_BOUNDS, SquirrelPreferences.class, "isUseStatementSeparatorAsSqlToExecuteBounds", "setUseStatementSeparatorAsSqlToExecuteBounds"),
 
diff --git a/sql12/core/src/net/sourceforge/squirrel_sql/client/session/mainpanel/resulttabheader/I18NStrings.properties b/sql12/core/src/net/sourceforge/squirrel_sql/client/session/mainpanel/resulttabheader/I18NStrings.properties
@@ -13,4 +13,7 @@ ResultTabHeaderPrefsPanel.automatically.select.manually.by.shortcut=Note: The la
 
 ResultTabHeaderPrefsPanelController.result.mark.color.choose=Choose result mark color
 
-MarkResultTabHeaderMatchingCurSqlAction.tools.popup.descr=Activate result tab matching current SQL
+MarkResultTabHeaderMatchingCurSqlAction.tools.popup.descr=Activate result tab matching current SQL
+
+ResultTabHeaderPrefsPanel.MaxSqlLengthToCheck.label.start=To avoid SQL editor performance issues process SQLs shorter than
+ResultTabHeaderPrefsPanel.MaxSqlLengthToCheck.label.end=characters only.
diff --git a/sql12/core/src/net/sourceforge/squirrel_sql/client/session/mainpanel/resulttabheader/ResultTabHeaderPrefsPanel.java b/sql12/core/src/net/sourceforge/squirrel_sql/client/session/mainpanel/resulttabheader/ResultTabHeaderPrefsPanel.java
@@ -1,6 +1,7 @@
 package net.sourceforge.squirrel_sql.client.session.mainpanel.resulttabheader;
 
 import net.sourceforge.squirrel_sql.client.preferences.ColorIcon;
+import net.sourceforge.squirrel_sql.fw.gui.IntegerField;
 import net.sourceforge.squirrel_sql.fw.gui.MultipleLineLabel;
 import net.sourceforge.squirrel_sql.fw.util.StringManager;
 import net.sourceforge.squirrel_sql.fw.util.StringManagerFactory;
@@ -29,6 +30,9 @@ public class ResultTabHeaderPrefsPanel extends JPanel
    final JSpinner spnThickness;
    final JCheckBox chkMarkLastTabHeaderOnly;
    final JCheckBox chkCompareSqlsNormalized;
+   final JLabel lblMaxSqlLengthToCheckStart;
+   final IntegerField txtMaxSqlLengthToCheck;
+   final JLabel lblMaxSqlLengthToCheckEnd;
 
    final MultipleLineLabel lblNoteManualActivate;
 
@@ -80,7 +84,20 @@ public ResultTabHeaderPrefsPanel()
       add(chkCompareSqlsNormalized, gbc);
 
 
-      gbc = new GridBagConstraints(0,4,GridBagConstraints.REMAINDER,1,1,0,GridBagConstraints.NORTHWEST, GridBagConstraints.HORIZONTAL, new Insets(10,5,5,5), 0,0);
+      gbc = new GridBagConstraints(0,4,1,1,0,0,GridBagConstraints.WEST, GridBagConstraints.NONE, new Insets(5,5,0,0), 0,0);
+      lblMaxSqlLengthToCheckStart = new JLabel(s_stringMgr.getString("ResultTabHeaderPrefsPanel.MaxSqlLengthToCheck.label.start"));
+      add(lblMaxSqlLengthToCheckStart, gbc);
+
+      gbc = new GridBagConstraints(1,4,1,1,0,0,GridBagConstraints.WEST, GridBagConstraints.NONE, new Insets(5,2,0,0), 0,0);
+      txtMaxSqlLengthToCheck = new IntegerField(6);
+      add(txtMaxSqlLengthToCheck, gbc);
+
+      gbc = new GridBagConstraints(2,4,1,1,0,0,GridBagConstraints.WEST, GridBagConstraints.NONE, new Insets(5,2,0,0), 0,0);
+      lblMaxSqlLengthToCheckEnd = new JLabel(s_stringMgr.getString("ResultTabHeaderPrefsPanel.MaxSqlLengthToCheck.label.end"));
+      add(lblMaxSqlLengthToCheckEnd, gbc);
+
+
+      gbc = new GridBagConstraints(0,5,GridBagConstraints.REMAINDER,1,1,0,GridBagConstraints.NORTHWEST, GridBagConstraints.HORIZONTAL, new Insets(10,5,5,5), 0,0);
       lblNoteManualActivate = new MultipleLineLabel(s_stringMgr.getString("ResultTabHeaderPrefsPanel.automatically.select.manually.by.shortcut"));
       add(lblNoteManualActivate, gbc);
 
diff --git a/sql12/core/src/net/sourceforge/squirrel_sql/client/session/mainpanel/resulttabheader/ResultTabHeaderPrefsPanelController.java b/sql12/core/src/net/sourceforge/squirrel_sql/client/session/mainpanel/resulttabheader/ResultTabHeaderPrefsPanelController.java
@@ -42,6 +42,11 @@ private void onMarkCurrentSQLsResultTabHeader()
       _panel.chkCompareSqlsNormalized.setEnabled(_panel.chkMarkCurrentSQLsResultTabHeader.isSelected());
 
       _panel.lblMarkLineThickness.setEnabled(_panel.chkMarkCurrentSQLsResultTabHeader.isSelected());
+      _panel.txtMaxSqlLengthToCheck.setEnabled(_panel.chkMarkCurrentSQLsResultTabHeader.isSelected());
+
+      _panel.lblMaxSqlLengthToCheckStart.setEnabled(_panel.chkMarkCurrentSQLsResultTabHeader.isSelected());
+      _panel.lblMaxSqlLengthToCheckEnd.setEnabled(_panel.chkMarkCurrentSQLsResultTabHeader.isSelected());
+
       _panel.lblNoteManualActivate.setEnabled(_panel.chkMarkCurrentSQLsResultTabHeader.isSelected());
    }
 
@@ -54,6 +59,7 @@ public void loadData(SquirrelPreferences prefs)
       _panel.spnThickness.setValue(prefs.getResultTabHeaderMarkThickness());
       _panel.chkMarkLastTabHeaderOnly.setSelected(prefs.isResultTabHeaderMarkLastOnly());
       _panel.chkCompareSqlsNormalized.setSelected(prefs.isResultTabHeaderCompareSqlsNormalized());
+      _panel.txtMaxSqlLengthToCheck.setInt(prefs.getResultTabHeaderMarkMaxSqlLengthToCheck());
 
       onMarkCurrentSQLsResultTabHeader();
    }
@@ -67,6 +73,11 @@ public void applyChanges(SquirrelPreferences prefs)
       prefs.setResultTabHeaderMarkThickness((Integer) _panel.spnThickness.getValue());
       prefs.setResultTabHeaderMarkLastOnly(_panel.chkMarkLastTabHeaderOnly.isSelected());
       prefs.setResultTabHeaderCompareSqlsNormalized(_panel.chkCompareSqlsNormalized.isSelected());
+
+      if(0 < _panel.txtMaxSqlLengthToCheck.getInt())
+      {
+         prefs.setResultTabHeaderMarkMaxSqlLengthToCheck(_panel.txtMaxSqlLengthToCheck.getInt());
+      }
    }
 
    public ResultTabHeaderPrefsPanel getPanel()
diff --git a/sql12/core/src/net/sourceforge/squirrel_sql/client/session/mainpanel/resulttabheader/ResultTabMatchingCurrentSqlHandler.java b/sql12/core/src/net/sourceforge/squirrel_sql/client/session/mainpanel/resulttabheader/ResultTabMatchingCurrentSqlHandler.java
@@ -1,12 +1,5 @@
 package net.sourceforge.squirrel_sql.client.session.mainpanel.resulttabheader;
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Comparator;
-import java.util.List;
-import javax.swing.JTabbedPane;
-import javax.swing.Timer;
-
 import net.sourceforge.squirrel_sql.client.Main;
 import net.sourceforge.squirrel_sql.client.session.ISQLEntryPanel;
 import net.sourceforge.squirrel_sql.client.session.editorpaint.TextAreaPaintListener;
@@ -19,6 +12,13 @@
 import net.sourceforge.squirrel_sql.fw.util.log.LoggerController;
 import org.apache.commons.lang3.StringUtils;
 
+import javax.swing.JTabbedPane;
+import javax.swing.Timer;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
+
 public class ResultTabMatchingCurrentSqlHandler
 {
    private static final ILogger s_log = LoggerController.createLogger(ResultTabMatchingCurrentSqlHandler.class);
@@ -33,7 +33,7 @@ public class ResultTabMatchingCurrentSqlHandler
    private Timer _paintTimer;
 
    private NormalizedSqlCompareCache _normalizedSqlCompareCache = new NormalizedSqlCompareCache();
-   private long _lastEditorSqlToLongWarningMillis = 0;
+   private long _lastEditorSqlTooLongWarningMillis = 0;
 
    public ResultTabMatchingCurrentSqlHandler(ISQLEntryPanel entryPanel, SQLResultExecutorPanel sqlExecPanel)
    {
@@ -81,18 +81,19 @@ private void onTextAreaPaint(boolean activateLastMarked)
       resultTabsBufList.sort(Comparator.comparingInt(rt -> rt.getIdentifier().getIntValue()));
       Collections.reverse(resultTabsBufList);
 
+      int resultTabHeaderMarkMaxSqlLengthToCheck = Main.getApplication().getSquirrelPreferences().getResultTabHeaderMarkMaxSqlLengthToCheck();
       boolean activationOfLastDone = false;
       for(IResultTab sqlResultTab : resultTabsBufList)
       {
          boolean tabMatchesSqlToBeExecuted;
 
-         if( null != sqlToBeExecuted && 8000 < sqlToBeExecuted.length() )
+         if( null != sqlToBeExecuted && resultTabHeaderMarkMaxSqlLengthToCheck < sqlToBeExecuted.length() )
          {
             // Editor-SQL to long. Will skip search for matching result tab
             long currentTimeMillis = System.currentTimeMillis();
-            if( currentTimeMillis - _lastEditorSqlToLongWarningMillis > 5000L)
+            if( currentTimeMillis - _lastEditorSqlTooLongWarningMillis > 5000L)
             {
-               _lastEditorSqlToLongWarningMillis = currentTimeMillis;
+               _lastEditorSqlTooLongWarningMillis = currentTimeMillis;
                s_log.warn("Editor SQL too long (" + sqlToBeExecuted.length()  + " chars) to perform matching result tab search without severe editor performance impact.");
             }
 
