Tank Debugger: separate sleep/think time controls and fix debugger logging (#449)

* feat: separate sleep/think time controls and fix debugger logging

* add log4j to parent pom + update child poms

---------

Co-authored-by: zkofiro <zakaria_kofiro@intuit.com>

Author: Zakaria-Kofiro

agent/http_client_4/src/main/java/com/intuit/tank/httpclient4/TankHttpClient4.java

@@ -93,8 +93,6 @@ public TankHttpClient4() {
         context.setUserToken(UUID.randomUUID());
         context.setCookieStore(new BasicCookieStore());
         context.setRequestConfig(requestConfig);
-
-        LOG.info("TANK_CONNECTION_LEAK_FIX_V2: TankHttpClient4 initialized with COMPREHENSIVE LEAK FIX (EntityUtils + explicit close)");
     }
 
     public Object createHttpClient() {

pom.xml

@@ -52,6 +52,7 @@
     <version.spring-webmvc>6.2.11</version.spring-webmvc>
     <version.wiremock>3.13.1</version.wiremock>
     <version.jackson>2.19.2</version.jackson>
+    <version.log4j>2.25.3</version.log4j>
 
     <!-- maven-compiler-plugin -->
     <version.compiler.plugin>3.14.0</version.compiler.plugin>
@@ -529,7 +530,7 @@
       <dependency>
         <groupId>org.apache.logging.log4j</groupId>
         <artifactId>log4j-core</artifactId>
-        <version>2.25.3</version>
+        <version>${version.log4j}</version>
       </dependency>
 
       <dependency>

tools/agent_debugger/pom.xml

@@ -30,4 +30,22 @@
     </dependency>
   </dependencies>
 
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <annotationProcessorPaths>
+            <path>
+              <groupId>org.apache.logging.log4j</groupId>
+              <artifactId>log4j-core</artifactId>
+              <version>${version.log4j}</version>
+            </path>
+          </annotationProcessorPaths>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
 </project>

tools/agent_debugger/src/main/java/com/intuit/tank/tools/debugger/ActionComponents.java

@@ -15,6 +15,9 @@
 
 import java.awt.FlowLayout;
 import java.awt.Insets;
+import java.io.File;
+import java.io.FileInputStream;
+import java.util.Properties;
 
 import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
@@ -34,7 +37,12 @@ public class ActionComponents implements ScriptChangedListener {
     private JMenuBar menuBar;
     private JPopupMenu popupMenu;
     private ActionProducer actions;
-    private JCheckBox runTimingStepsCB;
+    private static final String DEBUGGER_PROPERTIES = "debugger.properties";
+    private static final String PROP_RUN_SLEEP_STEPS = "run.sleep.steps";
+    private static final String PROP_RUN_THINK_STEPS = "run.think.steps";
+
+    private JCheckBox runSleepStepsCB;
+    private JCheckBox runThinkStepsCB;
     private JLabel titleLabel;
 
     /**
@@ -46,7 +54,9 @@ public class ActionComponents implements ScriptChangedListener {
     public ActionComponents(boolean standalone, JComboBox testPlanChooser, JComboBox<TankClientChoice> tankClientChooser, ActionProducer actions) {
         super();
         this.actions = actions;
-        runTimingStepsCB = new JCheckBox("Run Timing Steps", false);
+        boolean[] defaults = loadTimingStepDefaults();
+        runSleepStepsCB = new JCheckBox("Run Sleep Steps", defaults[0]);
+        runThinkStepsCB = new JCheckBox("Run Think Steps", defaults[1]);
         createMenuBar(actions, standalone);
         createToolBar(testPlanChooser, tankClientChooser, actions, standalone);
         createPopupMenu();
@@ -216,10 +226,17 @@ private void createToolBar(JComboBox testPlanChooser, JComboBox<TankClientChoice
     }
 
     /**
-     * @return the runTimingStepsCB
+     * @return the runSleepStepsCB
+     */
+    public JCheckBox getRunSleepStepsCB() {
+        return runSleepStepsCB;
+    }
+
+    /**
+     * @return the runThinkStepsCB
      */
-    public JCheckBox getRunTimingStepsCB() {
-        return runTimingStepsCB;
+    public JCheckBox getRunThinkStepsCB() {
+        return runThinkStepsCB;
     }
 
     /**
@@ -264,7 +281,8 @@ private void createMenuBar(ActionProducer actions, boolean standalone) {
             menuBar.add(runMenu);
 
             JMenu actionsMenu = new JMenu("Actions");
-            actionsMenu.add(runTimingStepsCB);
+            actionsMenu.add(runSleepStepsCB);
+            actionsMenu.add(runThinkStepsCB);
             actionsMenu.addSeparator();
             actionsMenu.add(actions.getSaveReqResponseAction());
             actionsMenu.add(actions.getSaveLogAction());
@@ -278,4 +296,25 @@ public void setCurrentTitle(String string) {
         this.titleLabel.setText(string);
     }
 
+    /**
+     * Load timing step defaults from debugger.properties
+     * @return boolean array [runSleepSteps, runThinkSteps]
+     */
+    private boolean[] loadTimingStepDefaults() {
+        boolean runSleep = false;
+        boolean runThink = false;
+        File f = new File(DEBUGGER_PROPERTIES);
+        if (f.exists()) {
+            try (FileInputStream in = new FileInputStream(f)) {
+                Properties props = new Properties();
+                props.load(in);
+                runSleep = Boolean.parseBoolean(props.getProperty(PROP_RUN_SLEEP_STEPS, "false"));
+                runThink = Boolean.parseBoolean(props.getProperty(PROP_RUN_THINK_STEPS, "false"));
+            } catch (Exception e) {
+                // Use defaults if properties can't be loaded
+            }
+        }
+        return new boolean[] { runSleep, runThink };
+    }
+
 }

tools/agent_debugger/src/main/java/com/intuit/tank/tools/debugger/AgentDebuggerFrame.java

@@ -324,8 +324,12 @@ public void addScriptChangedListener(ScriptChangedListener l) {
         scriptChangedListeners.add(l);
     }
 
-    public boolean runTimingSteps() {
-        return actionComponents.getRunTimingStepsCB().isSelected();
+    public boolean runSleepSteps() {
+        return actionComponents.getRunSleepStepsCB().isSelected();
+    }
+
+    public boolean runThinkSteps() {
+        return actionComponents.getRunThinkStepsCB().isSelected();
     }
 
     /**

tools/agent_debugger/src/main/java/com/intuit/tank/tools/debugger/DebuggerFlowController.java

@@ -118,9 +118,11 @@ public boolean shouldExecute(TestStepContext context) {
         context.setTestStep(debuggerFrame.getStep(context.getTestStep().getStepIndex()));
         TestStep step = context.getTestStep();
         if (!toSkip.contains(context.getTestStep().getStepIndex())) {// move if skiplist does not contain line
-            if (debuggerFrame.runTimingSteps()) {
-                return true;
-            } else if (!(step instanceof SleepTimeStep) && !(step instanceof ThinkTimeStep)) {
+            if (step instanceof SleepTimeStep) {
+                return debuggerFrame.runSleepSteps();
+            } else if (step instanceof ThinkTimeStep) {
+                return debuggerFrame.runThinkSteps();
+            } else {
                 return true;
             }
         }

tools/agent_debugger/src/main/resources/debugger.properties

@@ -1,2 +1,7 @@
 #Add any instances that should be included in the tank selection dropdown.
 tank.instance.TANK=http://tank-url
+
+# Timing step execution settings
+# Set to true to run sleep/think steps, false to skip them
+run.sleep.steps=false
+run.think.steps=false

tools/agent_debugger/src/test/java/com/intuit/tank/tools/debugger/ActionComponentsTest.java

@@ -56,8 +56,14 @@ public void testMenuBar() {
     }
 
     @Test
-    public void testRunTimingStepsCB() {
-        JCheckBox jCheckBox = actionComponents.getRunTimingStepsCB();
+    public void testRunSleepStepsCB() {
+        JCheckBox jCheckBox = actionComponents.getRunSleepStepsCB();
+        assertNotNull(jCheckBox);
+    }
+
+    @Test
+    public void testRunThinkStepsCB() {
+        JCheckBox jCheckBox = actionComponents.getRunThinkStepsCB();
         assertNotNull(jCheckBox);
     }