From dbb5581eba5d765bca95585ba91f9b0eee9d1f57 Mon Sep 17 00:00:00 2001
From: Prasanta Sadhukhan <psadhukhan@openjdk.org>
Date: Mon, 27 Feb 2023 09:19:57 +0000
Subject: [PATCH] 8081474: SwingWorker calls 'done' before the 'doInBackground'
 is finished

Reviewed-by: aivanov, serb
---
 .../classes/javax/swing/SwingWorker.java      |  17 +-
 .../TestDoneBeforeDoInBackground.java         | 147 ++++++++++++++++++
 2 files changed, 155 insertions(+), 9 deletions(-)
 create mode 100644 test/jdk/javax/swing/SwingWorker/TestDoneBeforeDoInBackground.java

diff --git a/src/java.desktop/share/classes/javax/swing/SwingWorker.java b/src/java.desktop/share/classes/javax/swing/SwingWorker.java
index 0d86075be3f..5e6f2dd6545 100644
--- a/src/java.desktop/share/classes/javax/swing/SwingWorker.java
+++ b/src/java.desktop/share/classes/javax/swing/SwingWorker.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2005, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2023, 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
@@ -301,17 +301,16 @@ public abstract class SwingWorker<T, V> implements RunnableFuture<T> {
                 new Callable<T>() {
                     public T call() throws Exception {
                         setState(StateValue.STARTED);
-                        return doInBackground();
+                        try {
+                            return doInBackground();
+                        } finally {
+                            doneEDT();
+                            setState(StateValue.DONE);
+                        }
                     }
                 };
 
-        future = new FutureTask<T>(callable) {
-                       @Override
-                       protected void done() {
-                           doneEDT();
-                           setState(StateValue.DONE);
-                       }
-                   };
+       future = new FutureTask<T>(callable);
 
        state = StateValue.PENDING;
        propertyChangeSupport = new SwingWorkerPropertyChangeSupport(this);
diff --git a/test/jdk/javax/swing/SwingWorker/TestDoneBeforeDoInBackground.java b/test/jdk/javax/swing/SwingWorker/TestDoneBeforeDoInBackground.java
new file mode 100644
index 00000000000..56534928f6e
--- /dev/null
+++ b/test/jdk/javax/swing/SwingWorker/TestDoneBeforeDoInBackground.java
@@ -0,0 +1,147 @@
+/*
+ * Copyright (c) 2023, 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 8081474
+ * @summary  Verifies if SwingWorker calls 'done'
+ *           before the 'doInBackground' is finished
+ * @run main TestDoneBeforeDoInBackground
+ */
+import java.beans.PropertyChangeListener;
+import java.beans.PropertyChangeEvent;
+import javax.swing.SwingWorker;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+public class TestDoneBeforeDoInBackground {
+
+    private static final int WAIT_TIME = 200;
+    private static final long CLEANUP_TIME = 1000;
+
+    private static final AtomicBoolean doInBackgroundStarted = new AtomicBoolean(false);
+    private static final AtomicBoolean doInBackgroundFinished = new AtomicBoolean(false);
+    private static final AtomicBoolean doneFinished = new AtomicBoolean(false);
+    private static final CountDownLatch doneLatch = new CountDownLatch(1);
+
+    public static void main(String[] args) throws InterruptedException {
+        SwingWorker<String, String> worker = new SwingWorker<>() {
+            @Override
+            protected String doInBackground() throws Exception {
+                try {
+                    while (!Thread.currentThread().isInterrupted()) {
+                        System.out.println("Working...");
+                        Thread.sleep(WAIT_TIME);
+                    }
+                } catch (InterruptedException ex) {
+                    System.out.println("Got interrupted!");
+                }
+
+                try {
+                    doInBackgroundStarted.set(true);
+                    System.out.println("Cleaning up");
+                    Thread.sleep(CLEANUP_TIME);
+                    System.out.println("Done cleaning");
+                    doInBackgroundFinished.set(true);
+                } catch (InterruptedException ex) {
+                    System.out.println("Got interrupted second time!");
+                }
+
+                return null;
+            }
+
+            @Override
+            protected void done() {
+                if (!doInBackgroundFinished.get()) {
+                    throw new RuntimeException("done called before " +
+                                               "doInBackground is finished");
+                }
+                System.out.println("Done");
+                doneFinished.set(true);
+                doneLatch.countDown();
+            }
+        };
+
+        worker.addPropertyChangeListener(
+            new PropertyChangeListener() {
+                public void propertyChange(PropertyChangeEvent evt) {
+                    System.out.println("doInBackgroundStarted: " +
+                                        doInBackgroundStarted.get() +
+                                        " doInBackgroundFinished: " +
+                                        doInBackgroundFinished.get() +
+                                        " done: " + doneFinished.get() +
+                                        " state: " + worker.getState());
+                    // Before doInBackground method is invoked,
+                    // SwingWorker notifies PropertyChangeListeners about the
+                    // property change to StateValue.STARTED
+                    if (doInBackgroundStarted.get()
+                        && worker.getState() == SwingWorker.StateValue.STARTED) {
+                        throw new RuntimeException(
+                               "PropertyChangeListeners called with " +
+                               "state STARTED after doInBackground is invoked");
+                    }
+
+                    // Ensure DONE state is notified AFTER
+                    // doInBackground is finished AND done is invoked
+                    if (doInBackgroundFinished.get() && !doneFinished.get()
+                        && worker.getState() == SwingWorker.StateValue.DONE) {
+                        throw new RuntimeException(
+                              "done method is NOT executed but state is DONE");
+                    }
+
+                    // After the doInBackground method is finished
+                    // SwingWorker notifies PropertyChangeListeners
+                    // property change to StateValue.DONE
+                    if (worker.getState() != SwingWorker.StateValue.DONE
+                        && doInBackgroundFinished.get()) {
+                        throw new RuntimeException(
+                            "PropertyChangeListeners called after " +
+                            "doInBackground is finished but before State changed to DONE");
+                    }
+                }
+            });
+        worker.execute();
+        Thread.sleep(WAIT_TIME * 3);
+
+        final long start = System.currentTimeMillis();
+        worker.cancel(true);
+        final long end = System.currentTimeMillis();
+
+        if ((end - start) > 100) {
+            throw new RuntimeException("Cancel took too long: "
+                                       + ((end - start) / 1000.0d) + " s");
+        }
+        if (!doneLatch.await(CLEANUP_TIME + 1000L, TimeUnit.MILLISECONDS)) {
+            throw new RuntimeException("done didn't complete in time");
+        }
+        System.out.println("doInBackground " + doInBackgroundFinished.get() +
+                           " getState " + worker.getState());
+        if (worker.getState() != SwingWorker.StateValue.DONE
+            && doInBackgroundFinished.get()) {
+            throw new RuntimeException("doInBackground is finished " +
+                                       "but State is not DONE");
+        }
+    }
+}
+
+