4907798: MEMORY LEAK: javax.swing.plaf.basic.BasicPopupMenuUI$MenuKeyboardHelper

Reviewed-by: psadhukhan, serb

Author: Alexander Zuev

src/java.desktop/share/classes/javax/swing/plaf/basic/BasicPopupMenuUI.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -1226,6 +1226,7 @@ public void stateChanged(ChangeEvent ev) {
                 // menu hidden -- return focus to where it had been before
                 // and uninstall menu keybindings
                    removeItems();
+                   menuInputMap = null;
             } else {
                 if (popup != lastPopup) {
                     receivedKeyPressed = false;

src/java.desktop/windows/classes/com/sun/java/swing/plaf/windows/WindowsPopupMenuUI.java

@@ -108,6 +108,7 @@ public void stateChanged(ChangeEvent ev) {
                         WindowsGraphicsUtils.repaintMnemonicsInWindow(win);
                     }
                 }
+                repaintRoot = null;
             } else {
                 Component c = (Component)path[0];
                 if (c instanceof JPopupMenu) c = ((JPopupMenu)c).getInvoker();

test/jdk/javax/swing/JMenu/PopupReferenceMemoryLeak.java

@@ -0,0 +1,213 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 4907798
+ * @key headful
+ * @summary Check for memory leak in menu subsystem
+ * @run main/othervm -Xmx8m PopupReferenceMemoryLeak
+ */
+
+import javax.swing.AbstractAction;
+import javax.swing.JFrame;
+import javax.swing.JMenu;
+import javax.swing.JMenuBar;
+import javax.swing.JMenuItem;
+import javax.swing.SwingUtilities;
+import javax.swing.UIManager;
+import javax.swing.UnsupportedLookAndFeelException;
+import javax.swing.WindowConstants;
+import java.awt.BorderLayout;
+import java.awt.Robot;
+import java.awt.event.ActionEvent;
+import java.awt.event.InputEvent;
+import java.awt.event.KeyEvent;
+import java.lang.ref.WeakReference;
+import java.util.ArrayList;
+
+import static javax.swing.UIManager.getInstalledLookAndFeels;
+
+public class PopupReferenceMemoryLeak {
+    static volatile WeakReference referenceToFrame1;
+    static JFrame frame1, frame2;
+
+    public static void main(String[] args) throws Exception {
+        Robot robot = new Robot();
+        robot.setAutoDelay(200);
+        for (UIManager.LookAndFeelInfo laf : getInstalledLookAndFeels()) {
+            String lafName = laf.getName();
+            System.out.println("Testing LaF: " + lafName);
+            if (lafName == null || lafName.startsWith("Mac OS X")) {
+                // Aqua Look and Feel uses system menus we can't really test it
+                continue;
+            }
+            setLookAndFeel(laf);
+            PopupReferenceMemoryLeak newTest = new PopupReferenceMemoryLeak();
+            SwingUtilities.invokeAndWait(newTest::createUI);
+            try {
+                boolean passed = false;
+                robot.waitForIdle();
+                Thread.sleep(2000);
+                robot.mouseMove(200, 200);
+                robot.mousePress(InputEvent.BUTTON1_DOWN_MASK);
+                robot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK);
+                robot.keyPress(KeyEvent.VK_F10);
+                robot.keyRelease(KeyEvent.VK_F10);
+                robot.keyPress(KeyEvent.VK_F);
+                robot.keyRelease(KeyEvent.VK_F);
+                robot.keyPress(KeyEvent.VK_C);
+                robot.keyRelease(KeyEvent.VK_C);
+                robot.waitForIdle();
+                Thread.sleep(2000);
+                robot.mouseMove(600, 200);
+                robot.waitForIdle();
+                Thread.sleep(2000);
+                robot.mousePress(InputEvent.BUTTON1_DOWN_MASK);
+                robot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK);
+
+                // Workaround for Linux issues when sometimes there
+                // is a ref to last opened frame from native code
+                JFrame frame3 = new JFrame("Workaround");
+                frame3.setSize(100, 100);
+                frame3.setLocation(0,0);
+                frame3.setVisible(true);
+                Thread.sleep(1000);
+                frame3.setVisible(false);
+                frame3.dispose();
+
+                // Force GC three times to see if it clears the old frame
+                for (int i = 0; i < 3; i++) {
+                    try {
+                        ArrayList gc = new ArrayList();
+                        while (true) {
+                            gc.add(new int[100000]);
+                        }
+                    } catch (Throwable ignore) {
+                    }
+                    robot.waitForIdle();
+                    Thread.sleep(1000);
+                    if (referenceToFrame1.get() == null) {
+                        // Frame was released
+                        passed = true;
+                        break;
+                    }
+                }
+                if (!passed) {
+                    robot.waitForIdle();
+                    robot.keyPress(KeyEvent.VK_F10);
+                    robot.keyRelease(KeyEvent.VK_F10);
+                    robot.keyPress(KeyEvent.VK_T);
+                    robot.keyRelease(KeyEvent.VK_T);
+                    robot.keyPress(KeyEvent.VK_M);
+                    robot.keyRelease(KeyEvent.VK_M);
+                    robot.waitForIdle();
+                    Thread.sleep(2000);
+                    for (int i = 0; i < 5; i++) {
+                        try {
+                            ArrayList gc = new ArrayList();
+                            while (true) {
+                                gc.add(new int[100000]);
+                            }
+                        } catch (Throwable ignore) {
+                        }
+                        robot.waitForIdle();
+                        Thread.sleep(1000);
+                        if (referenceToFrame1.get() == null) {
+                            // Frame was released
+                            throw new RuntimeException("Frame cleared only after menu activated on frame2");
+                        }
+                    }
+                    throw new RuntimeException("Test finished but menu has not cleared the reference!");
+                }
+            } catch (Exception re) {
+                throw new RuntimeException(re.getLocalizedMessage());
+            } finally {
+                if (frame2 != null) {
+                    frame2.setVisible(false);
+                    frame2.dispose();
+                }
+            }
+        }
+    }
+
+    private static void setLookAndFeel(UIManager.LookAndFeelInfo laf) {
+        try {
+            UIManager.setLookAndFeel(laf.getClassName());
+        } catch (UnsupportedLookAndFeelException ignored) {
+            System.out.println("Unsupported LookAndFeel: " + laf.getClassName());
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+
+    public void createUI() {
+        frame1 = new JFrame("Main test window");
+        JMenuBar menuBar1 = new JMenuBar();
+        JMenu file1 = new JMenu("File");
+        file1.setMnemonic('f');
+        JMenuItem close1 = new JMenuItem("Close");
+        close1.setMnemonic('c');
+        close1.addActionListener(new FrameCloser(frame1));
+        file1.add(close1);
+        menuBar1.add(file1);
+        frame1.setJMenuBar(menuBar1);
+        frame1.setSize(200, 200);
+        frame1.setLocation(100, 100);
+        frame1.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
+        frame1.setVisible(true);
+        referenceToFrame1 = new WeakReference(frame1);
+        frame1 = null;
+
+        frame2 = new JFrame("Secondary");
+        JMenuBar menuBar2 = new JMenuBar();
+        JMenu test = new JMenu("Test");
+        test.setMnemonic('T');
+        JMenuItem memoryTest = new JMenuItem("Memory");
+        memoryTest.setMnemonic('M');
+        test.add(memoryTest);
+        menuBar2.add(test);
+        frame2.setJMenuBar(menuBar2);
+        frame2.setLayout(new BorderLayout());
+        frame2.setSize(200, 200);
+        frame2.setLocation(500, 100);
+        frame2.setVisible(true);
+    }
+
+    class FrameCloser extends AbstractAction {
+        JFrame frame;
+        public FrameCloser(JFrame f) {
+            this.frame = f;
+        }
+
+        @Override
+        public void actionPerformed(ActionEvent e) {
+            if (frame != null) {
+                frame.setVisible(false);
+                frame.dispose();
+                this.frame = null;
+            }
+        }
+    }
+}