Fix UI freeze during download of Esri layers

Signed-off-by: Taylor Smock <tsmock@meta.com>

.github/workflows/ant.yml

@@ -10,8 +10,6 @@ on:
     branches:
       - master
       - $default-branch
-  schedule:
-  - cron: "1 5 * * 6"
   workflow_dispatch:
 
 jobs:
@@ -19,7 +17,7 @@ jobs:
     strategy:
       matrix:
         josm-revision: ["", "r18877"]
-    uses: JOSM/JOSMPluginAction/.github/workflows/ant.yml@v1
+    uses: JOSM/JOSMPluginAction/.github/workflows/ant.yml@v2
     with:
       java-version: 17
       josm-revision: ${{ matrix.josm-revision }}

.github/workflows/reports.yaml

@@ -10,4 +10,4 @@ permissions:
 
 jobs:
   call-workflow:
-    uses: JOSM/JOSMPluginAction/.github/workflows/reports.yaml@v1
+    uses: JOSM/JOSMPluginAction/.github/workflows/reports.yaml@v2

build.gradle

@@ -1,9 +1,9 @@
 import groovy.xml.XmlParser
 
 plugins {
-  id "com.diffplug.spotless" version "6.20.0"
-  id "com.github.ben-manes.versions" version "0.47.0"
-  id "com.github.spotbugs" version "5.0.14"
+  id "com.diffplug.spotless" version "6.25.0"
+  id "com.github.ben-manes.versions" version "0.51.0"
+  id "com.github.spotbugs" version "6.0.8"
   // id "de.aaschmid.cpd" version "3.3"
   id "eclipse"
   id "jacoco"
@@ -12,7 +12,7 @@ plugins {
   id "maven-publish"
   id "net.ltgt.errorprone" version "3.1.0"
   id "org.openstreetmap.josm" version "0.8.2"
-  id "org.sonarqube" version "4.2.1.3168"
+  id "org.sonarqube" version "4.4.1.3373"
   id "pmd"
 }
 
@@ -29,15 +29,15 @@ repositories {
 
 def versions = [
   awaitility: "4.2.0",
-  equalsverifier: "3.15",
-  errorprone: "2.20.0",
-  findsecbugs: "1.12.0",
+  equalsverifier: "3.15.8",
+  errorprone: "2.26.0",
+  findsecbugs: "1.13.0",
   jacoco: "0.8.10",
   jmockit: "1.49.a",
   josm: properties.get("plugin.compile.version"),
-  junit: "5.9.1",
+  junit: "5.10.2",
   pmd: "6.20.0",
-  spotbugs: "4.7.3",
+  spotbugs: "4.8.3",
   wiremock: "2.35.0",
 ]
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,8 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=03ec176d388f2aa99defcadc3ac6adf8dd2bce5145a129659537c0874dea5ad1
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
+distributionSha256Sum=9631d53cf3e74bfa726893aee1f8994fee4e060c401335946dba2156f440f24c
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -85,9 +85,6 @@ done
 APP_BASE_NAME=${0##*/}
 APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
-
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
 
@@ -133,10 +130,13 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
@@ -144,7 +144,7 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
@@ -152,7 +152,7 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -197,6 +197,10 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
 # Collect all arguments for the java command;
 #   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
 #     shell script including quotes and variable substitutions, so put them in

src/main/java/org/openstreetmap/josm/plugins/mapwithai/actions/AddMapWithAILayerAction.java

@@ -84,10 +84,17 @@ public class AddMapWithAILayerAction extends JosmAction implements AdaptableActi
 
     @Override
     public void actionPerformed(ActionEvent e) {
-        if (!isEnabled()) {
-            return;
+        if (isEnabled()) {
+            MainApplication.worker.execute(() -> realRun(this.info));
         }
+    }
 
+    /**
+     * Run the download tasks. This should be run off of the EDT, see #23529.
+     *
+     * @param info The external data to download
+     */
+    private static void realRun(MapWithAIInfo info) {
         MapWithAILayer layer = MapWithAIDataUtils.getLayer(false);
         final DataSet ds;
         final OsmData<?, ?, ?, ?> boundsSource;

src/main/java/org/openstreetmap/josm/plugins/mapwithai/backend/BoundingBoxMapWithAIDownloader.java

@@ -23,6 +23,7 @@ import java.util.Comparator;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
@@ -130,14 +131,20 @@ public class BoundingBoxMapWithAIDownloader extends BoundingBoxDownloader {
             final var tile = TileXYZ.tileFromBBox(lon1, lat1, lon2, lat2);
             return getRequestForTile(tile);
         }
-        return url.replace("{bbox}", Double.toString(lon1) + ',' + lat1 + ',' + lon2 + ',' + lat2)
+        var current = url.replace("{bbox}", Double.toString(lon1) + ',' + lat1 + ',' + lon2 + ',' + lat2)
                 .replace("{xmin}", Double.toString(lon1)).replace("{ymin}", Double.toString(lat1))
-                .replace("{xmax}", Double.toString(lon2)).replace("{ymax}", Double.toString(lat2))
-                + (crop ? "&crop_bbox=" + DetectTaskingManagerUtils.getTaskingManagerBounds().toBBox().toStringCSV(",")
-                        : "")
-                + (this.info.getSourceType() == MapWithAIType.ESRI_FEATURE_SERVER && !this.info.isConflated()
-                        ? "&resultOffset=" + this.start
-                        : "");
+                .replace("{xmax}", Double.toString(lon2)).replace("{ymax}", Double.toString(lat2));
+        boolean hasQuery = !Optional.ofNullable(URI.create(current).getRawQuery()).map(String::isEmpty).orElse(true);
+
+        if (crop) {
+            current += (hasQuery ? '&' : '?') + "crop_bbox="
+                    + DetectTaskingManagerUtils.getTaskingManagerBounds().toBBox().toStringCSV(",");
+            hasQuery = true;
+        }
+        if (this.info.getSourceType() == MapWithAIType.ESRI_FEATURE_SERVER && !this.info.isConflated()) {
+            current += (hasQuery ? '&' : '?') + "resultOffset=" + this.start;
+        }
+        return current;
     }
 
     private String getRequestForTile(TileXYZ tile) {

src/main/java/org/openstreetmap/josm/plugins/mapwithai/backend/MapWithAIDataUtils.java

@@ -18,6 +18,7 @@ import java.util.Optional;
 import java.util.TreeSet;
 import java.util.concurrent.ForkJoinPool;
 import java.util.concurrent.ForkJoinTask;
+import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.stream.Collectors;
 
 import org.openstreetmap.josm.data.Bounds;
@@ -213,37 +214,26 @@ public final class MapWithAIDataUtils {
         }
     }
 
-    private static boolean confirmBigDownload(List<Bounds> realBounds) {
-        final var confirmation = new ConfirmBigDownload(realBounds);
-        GuiHelper.runInEDTAndWait(confirmation);
-        return confirmation.confirmed();
-    }
-
-    private static class ConfirmBigDownload implements Runnable {
-        Boolean bool;
-        final List<?> realBounds;
-
-        public ConfirmBigDownload(List<?> realBounds) {
-            this.realBounds = realBounds;
-        }
-
-        @Override
-        public void run() {
-            bool = ConditionalOptionPaneUtil.showConfirmationDialog(MapWithAIPlugin.NAME.concat(".alwaysdownload"),
-                    null,
+    /**
+     * Confirm a large download
+     *
+     * @param realBounds The list of bounds that will be downloaded
+     * @return {@code true} if the user still wants to download data
+     */
+    private static synchronized boolean confirmBigDownload(List<Bounds> realBounds) {
+        final var confirmation = new AtomicBoolean(false);
+        // This is not a separate class since we don't want to show multiple
+        // confirmation dialogs
+        // which is why this method is synchronized.
+        GuiHelper.runInEDTAndWait(() -> {
+            final var confirmed = ConditionalOptionPaneUtil.showConfirmationDialog(
+                    MapWithAIPlugin.NAME.concat(".alwaysdownload"), null,
                     tr("You are going to make {0} requests to the MapWithAI server. This may take some time. <br /> Continue?",
                             realBounds.size()),
                     null, JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE, JOptionPane.YES_OPTION);
-        }
-
-        /**
-         * Check if the user confirmed the download
-         *
-         * @return {@code true} if the user wants to continue
-         */
-        public boolean confirmed() {
-            return bool;
-        }
+            confirmation.set(confirmed);
+        });
+        return confirmation.get();
     }
 
     /**

src/main/java/org/openstreetmap/josm/plugins/mapwithai/data/mapwithai/MapWithAILayerInfo.java

@@ -213,9 +213,13 @@ public class MapWithAILayerInfo {
         if (this.finishListenerListenerList == null) {
             this.finishListenerListenerList = ListenerList.create();
         }
+        boolean running = this.finishListenerListenerList.hasListeners();
         if (listener != null) {
             this.finishListenerListenerList.addListener(listener);
         }
+        if (running) {
+            return;
+        }
         if (worker == null) {
             final var pleaseWaitRunnable = new PleaseWaitRunnable(tr("Update default entries")) {
                 @Override
@@ -342,11 +346,12 @@ public class MapWithAILayerInfo {
          * @param layers The layers to update
          */
         private void updateEsriLayers(@Nonnull final Collection<MapWithAIInfo> layers) {
+            final var esriInfo = new ArrayList<MapWithAIInfo>(300);
             for (var layer : layers) {
                 if (MapWithAIType.ESRI == layer.getSourceType()) {
                     for (var future : parseEsri(layer)) {
                         try {
-                            allDefaultLayers.add(future.get());
+                            esriInfo.add(future.get());
                         } catch (InterruptedException e) {
                             Logging.error(e);
                             Thread.currentThread().interrupt();
@@ -355,9 +360,10 @@ public class MapWithAILayerInfo {
                         }
                     }
                 } else {
-                    allDefaultLayers.add(layer);
+                    esriInfo.add(layer);
                 }
             }
+            layers.addAll(esriInfo);
         }
 
         protected void finish() {
@@ -365,7 +371,7 @@ public class MapWithAILayerInfo {
             synchronized (allDefaultLayers) {
                 allDefaultLayers.clear();
                 defaultLayers.addAll(newLayers);
-                this.updateEsriLayers(newLayers);
+                allDefaultLayers.addAll(newLayers);
                 allDefaultLayers.sort(new MapWithAIInfo.MapWithAIInfoCategoryComparator());
                 allDefaultLayers.sort(Comparator.comparing(TileSourceInfo::getName));
                 allDefaultLayers.sort(Comparator.comparing(info -> info.getCategory().getDescription()));
@@ -501,7 +507,7 @@ public class MapWithAILayerInfo {
         }
 
         if (changed) {
-            save();
+            MainApplication.worker.execute(this::save);
         }
     }