diff --git a/src/components/src/main/java/org/apache/jmeter/visualizers/ResultViewportAnchor.java b/src/components/src/main/java/org/apache/jmeter/visualizers/ResultViewportAnchor.java new file mode 100644 index 0000000000..ba38f748a9 --- /dev/null +++ b/src/components/src/main/java/org/apache/jmeter/visualizers/ResultViewportAnchor.java @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to you under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.jmeter.visualizers; + +import java.awt.Dimension; +import java.awt.Point; +import java.awt.Rectangle; + +import javax.swing.JComponent; +import javax.swing.JTable; +import javax.swing.JTree; +import javax.swing.JViewport; +import javax.swing.tree.DefaultMutableTreeNode; + +/** Keeps the first visible result in place across result list rebuilds. Used on the EDT. */ +record ResultViewportAnchor(JComponent view, Object result, Point position, int rowOffset) { + static ResultViewportAnchor capture(JComponent view) { + Point position = ((JViewport) view.getParent()).getViewPosition(); + int row = view instanceof JTable table ? table.rowAtPoint(position) + : ((JTree) view).getClosestRowForLocation(0, position.y); + Object result = row < 0 ? null : resultAtViewRow(view, row); + Rectangle bounds = row < 0 ? null : resultRowBounds(view, row); + return new ResultViewportAnchor(view, result, position, bounds == null ? 0 : position.y - bounds.y); + } + + private static Object resultAtViewRow(JComponent view, int row) { + if (view instanceof JTable table) { + return ((ResultTableModel) table.getModel()).sampleAt(table.convertRowIndexToModel(row)); + } + return ((DefaultMutableTreeNode) ((JTree) view).getPathForRow(row).getLastPathComponent()).getUserObject(); + } + + private static Rectangle resultRowBounds(JComponent view, int row) { + return view instanceof JTable table ? table.getCellRect(row, 0, true) : ((JTree) view).getRowBounds(row); + } + + void restore() { + JViewport viewport = (JViewport) view.getParent(); + Point restoredPosition = new Point(position); + int rowCount = view instanceof JTable table ? table.getRowCount() : ((JTree) view).getRowCount(); + // Keep the same visible result in place when older rows are evicted or change height. + for (int row = 0; result != null && row < rowCount; row++) { + if (resultAtViewRow(view, row) == result) { + restoredPosition.y = resultRowBounds(view, row).y + rowOffset; + break; + } + } + Dimension size = view.getPreferredSize(); + Dimension extent = viewport.getExtentSize(); + restoredPosition.x = Math.max(0, Math.min(restoredPosition.x, size.width - extent.width)); + restoredPosition.y = Math.max(0, Math.min(restoredPosition.y, size.height - extent.height)); + viewport.setViewPosition(restoredPosition); + } +} diff --git a/src/components/src/main/java/org/apache/jmeter/visualizers/ViewResultsFullVisualizer.java b/src/components/src/main/java/org/apache/jmeter/visualizers/ViewResultsFullVisualizer.java index 8e1e50d075..9d358af8e5 100644 --- a/src/components/src/main/java/org/apache/jmeter/visualizers/ViewResultsFullVisualizer.java +++ b/src/components/src/main/java/org/apache/jmeter/visualizers/ViewResultsFullVisualizer.java @@ -333,11 +333,16 @@ public boolean needsSampleResultMetadata() { * Update the visualizer with new data. */ private void updateGui() { + ResultViewportAnchor anchor = autoScrollCB.isSelected() ? null + : ResultViewportAnchor.capture(isTableMode() ? resultTable : jTree); liveTreeView.setUpdating(true); updatingResults = true; try { rebuildResultTree(); } finally { + if (anchor != null) { + anchor.restore(); + } liveTreeView.setUpdating(false); updatingResults = false; } @@ -357,10 +362,11 @@ private void rebuildResultTree() { oldExpandedElements = liveTreeView.expandedObjects(); Set nextRunningResults = transactions.runningResults(); - followLatest = validationResults && !isTableMode() + followLatest = autoScrollCB.isSelected() && validationResults && !isTableMode() && (liveResultsChanged || !runningResults.isEmpty() || !nextRunningResults.isEmpty()); liveTreeView.prepareExpansion(oldExpandedElements, transactions, - validationResults && (liveResultsChanged || !nextRunningResults.isEmpty())); + autoScrollCB.isSelected() && validationResults + && (liveResultsChanged || !nextRunningResults.isEmpty())); Object selected = getSelectedObject(); oldSelectedElement = transactions.carryOverViewState(oldExpandedElements, selected); selectedFinished = selected != null && runningResults.contains(selected) diff --git a/src/components/src/test/java/org/apache/jmeter/visualizers/ViewResultsFullVisualizerTest.java b/src/components/src/test/java/org/apache/jmeter/visualizers/ViewResultsFullVisualizerTest.java index 0d07d407c9..1954380dda 100644 --- a/src/components/src/test/java/org/apache/jmeter/visualizers/ViewResultsFullVisualizerTest.java +++ b/src/components/src/test/java/org/apache/jmeter/visualizers/ViewResultsFullVisualizerTest.java @@ -24,6 +24,8 @@ import static org.junit.jupiter.api.Assertions.assertSame; import static org.junit.jupiter.api.Assertions.assertTrue; +import java.awt.Dimension; +import java.awt.Point; import java.awt.event.MouseEvent; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; @@ -42,10 +44,12 @@ import java.util.zip.ZipOutputStream; import javax.swing.JCheckBox; +import javax.swing.JComponent; import javax.swing.JMenuItem; import javax.swing.JTabbedPane; import javax.swing.JTable; import javax.swing.JTree; +import javax.swing.JViewport; import javax.swing.SwingUtilities; import javax.swing.tree.DefaultMutableTreeNode; import javax.swing.tree.TreePath; @@ -1014,6 +1018,7 @@ public void liveTreeFollowsSamplesAndPreservesOnlyManualExpansion(boolean manual SwingUtilities.invokeAndWait(() -> { ViewResultsFullVisualizer visualizer = new ViewResultsFullVisualizer(); try { + ((JCheckBox) visualizerField(visualizer, "autoScrollCB")).setSelected(true); var treeField = ViewResultsFullVisualizer.class.getDeclaredField("jTree"); treeField.setAccessible(true); JTree tree = (JTree) treeField.get(visualizer); @@ -1067,6 +1072,7 @@ public void fastLiveSampleIsSelectedButImportedResultsDoNotMoveSelection() throw SwingUtilities.invokeAndWait(() -> { ViewResultsFullVisualizer visualizer = new ViewResultsFullVisualizer(); try { + ((JCheckBox) visualizerField(visualizer, "autoScrollCB")).setSelected(true); var treeField = ViewResultsFullVisualizer.class.getDeclaredField("jTree"); treeField.setAccessible(true); JTree tree = (JTree) treeField.get(visualizer); @@ -1094,6 +1100,149 @@ public void fastLiveSampleIsSelectedButImportedResultsDoNotMoveSelection() throw }); } + @ParameterizedTest + @CsvSource({"false,false", "false,true", "true,false", "true,true"}) + public void disablingAutoScrollPreservesLiveSelectionAndViewport( + boolean validation, boolean initiallyFollowing) throws Exception { + JMeterContextService.setValidationRun(validation); + SwingUtilities.invokeAndWait(() -> { + ViewResultsFullVisualizer visualizer = new ViewResultsFullVisualizer(); + try { + JCheckBox autoScroll = (JCheckBox) visualizerField(visualizer, "autoScrollCB"); + autoScroll.setSelected(initiallyFollowing); + SampleResult selected = childSample("selected", null); + visualizer.addStartedSample(new SampleEvent(selected, "tg")); + for (int i = 0; i < 50; i++) { + visualizer.add(childSample("request " + i, null)); + } + refresh(visualizer); + autoScroll.setSelected(false); + JTree tree = (JTree) visualizerField(visualizer, "jTree"); + DefaultMutableTreeNode root = (DefaultMutableTreeNode) tree.getModel().getRoot(); + tree.setSelectionPath(new TreePath(((DefaultMutableTreeNode) root.getChildAt(0)).getPath())); + JViewport viewport = (JViewport) tree.getParent(); + viewport.setExtentSize(new Dimension(200, 100)); + viewport.setViewSize(tree.getPreferredSize()); + Point position = new Point(0, 200); + viewport.setViewPosition(position); + + visualizer.addStartedSample(new SampleEvent(childSample("latest", null), "tg")); + refresh(visualizer); + assertSame(selected, ((DefaultMutableTreeNode) tree.getLastSelectedPathComponent()).getUserObject()); + assertSame(selected, visualizerField(visualizer, "resultsObject")); + assertEquals(position, viewport.getViewPosition()); + + SampleResult finished = childSample("selected", null); + SampleEvent event = new SampleEvent(finished, "tg"); + event.setStartedSample(selected); + visualizer.add(event); + refresh(visualizer); + assertSame(finished, ((DefaultMutableTreeNode) tree.getLastSelectedPathComponent()).getUserObject()); + assertEquals(position, viewport.getViewPosition()); + + tree.clearSelection(); + visualizer.addStartedSample(new SampleEvent(childSample("another", null), "tg")); + refresh(visualizer); + assertNull(tree.getSelectionPath()); + assertEquals(position, viewport.getViewPosition()); + } catch (ReflectiveOperationException ex) { + throw new AssertionError(ex); + } finally { + visualizer.clearData(); + } + }); + } + + @ParameterizedTest + @ValueSource(booleans = {false, true}) + public void viewportTracksVisibleResultOnEvictionAndClampsAfterFiltering(boolean tableMode) throws Exception { + JMeterContextService.setValidationRun(true); + SwingUtilities.invokeAndWait(() -> { + ViewResultsFullVisualizer visualizer = new ViewResultsFullVisualizer(); + try { + int limit = (int) visualizerField(visualizer, "maxResults"); + SampleResult selected = null; + for (int i = 0; i < limit; i++) { + SampleResult sample = childSample("request " + i, null); + visualizer.add(sample); + if (i == limit / 2) { + selected = sample; + } + } + refresh(visualizer); + JTree tree = (JTree) visualizerField(visualizer, "jTree"); + JTable table = (JTable) visualizerField(visualizer, "resultTable"); + if (tableMode) { + ((JTabbedPane) visualizerField(visualizer, "resultListTabs")).setSelectedIndex(1); + table.setRowSelectionInterval(limit / 2, limit / 2); + } else { + tree.setSelectionRow(limit / 2); + } + JComponent view = tableMode ? table : tree; + JViewport viewport = (JViewport) view.getParent(); + viewport.setExtentSize(new Dimension(200, 100)); + viewport.setViewSize(view.getPreferredSize()); + int rowY = tableMode ? table.getCellRect(limit / 2, 0, true).y : tree.getRowBounds(limit / 2).y; + viewport.setViewPosition(new Point(0, rowY + 3)); + + visualizer.addStartedSample(new SampleEvent(childSample("latest", null), "tg")); + refresh(visualizer); + int selectedRow = tableMode ? table.getSelectedRow() : tree.getMinSelectionRow(); + assertEquals(limit / 2 - 1, selectedRow); + assertSame(selected, visualizerField(visualizer, "resultsObject")); + int newRowY = tableMode ? table.getCellRect(selectedRow, 0, true).y : tree.getRowBounds(selectedRow).y; + assertEquals(newRowY + 3, viewport.getViewPosition().y); + + var filter = ViewResultsFullVisualizer.class.getDeclaredMethod("filterByLabel", String.class); + filter.setAccessible(true); + filter.invoke(visualizer, selected.getSampleLabel()); + assertEquals(0, viewport.getViewPosition().y, "A shorter filtered list must not leave blank space"); + assertSame(selected, visualizerField(visualizer, "resultsObject")); + filter.invoke(visualizer, "latest"); + assertEquals(0, viewport.getViewPosition().y); + } catch (ReflectiveOperationException ex) { + throw new AssertionError(ex); + } finally { + visualizer.clearData(); + } + }); + } + + @Test + public void validationInTableModeClearsOnlyAutomaticTreeExpansion() throws Exception { + JMeterContextService.setValidationRun(true); + SwingUtilities.invokeAndWait(() -> { + ViewResultsFullVisualizer visualizer = new ViewResultsFullVisualizer(); + try { + ((JCheckBox) visualizerField(visualizer, "autoScrollCB")).setSelected(true); + TransactionRef first = TransactionRef.start("first", null); + visualizer.addStartedTransaction(new SampleEvent(transactionSample(first), "tg")); + visualizer.addStartedSample(new SampleEvent(childSample("first request", first), "tg")); + refresh(visualizer); + JTree tree = (JTree) visualizerField(visualizer, "jTree"); + assertTrue(tree.isExpanded(0)); + JTabbedPane tabs = (JTabbedPane) visualizerField(visualizer, "resultListTabs"); + tabs.setSelectedIndex(1); + TransactionRef next = TransactionRef.start("next", null); + visualizer.addStartedTransaction(new SampleEvent(transactionSample(next), "tg")); + visualizer.addStartedSample(new SampleEvent(childSample("next request", next), "tg")); + refresh(visualizer); + tabs.setSelectedIndex(0); + assertFalse(tree.isExpanded(0)); + tree.expandRow(0); + tabs.setSelectedIndex(1); + visualizer.addStartedSample(new SampleEvent(childSample("another request", next), "tg")); + refresh(visualizer); + tabs.setSelectedIndex(0); + assertTrue(tree.isExpanded(0), "Manually expanded branches must stay open"); + } catch (ReflectiveOperationException ex) { + throw new AssertionError(ex); + } finally { + visualizer.clearData(); + } + }); + } + @Test public void normalTestRunDoesNotFollowOrExpandResults() throws Exception { JMeterContextService.setValidationRun(false); @@ -1209,6 +1358,7 @@ public void validationFollowsOwningRequestAndPreservesNestedSelectionAfterwards( SwingUtilities.invokeAndWait(() -> { ViewResultsFullVisualizer visualizer = new ViewResultsFullVisualizer(); try { + ((JCheckBox) visualizerField(visualizer, "autoScrollCB")).setSelected(true); TransactionRef transaction = inTransaction ? TransactionRef.start("transaction", null) : null; if (transaction != null) { visualizer.addStartedTransaction(new SampleEvent(transactionSample(transaction), "tg"));