Reduce sync loads for teleporting

Essentials/pom.xml

@@ -57,7 +57,7 @@
         <dependency>
             <groupId>io.papermc</groupId>
             <artifactId>paperlib</artifactId>
-            <version>1.0.2</version>
+            <version>1.0.3</version>
             <scope>compile</scope>
         </dependency>
         <dependency>

Essentials/src/com/earth2me/essentials/AsyncTimedTeleport.java

@@ -0,0 +1,151 @@
+package com.earth2me.essentials;
+
+import net.ess3.api.IEssentials;
+import net.ess3.api.IUser;
+import org.bukkit.Location;
+import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause;
+
+import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
+
+import static com.earth2me.essentials.I18n.tl;
+
+
+public class AsyncTimedTeleport implements Runnable {
+    private static final double MOVE_CONSTANT = 0.3;
+    private final IUser teleportOwner;
+    private final IEssentials ess;
+    private final AsyncTeleport teleport;
+    private final UUID timer_teleportee;
+    private int timer_task;
+    private final long timer_started; // time this task was initiated
+    private final long timer_delay; // how long to delay the teleportPlayer
+    private double timer_health;
+    // note that I initially stored a clone of the location for reference, but...
+    // when comparing locations, I got incorrect mismatches (rounding errors, looked like)
+    // so, the X/Y/Z values are stored instead and rounded off
+    private final long timer_initX;
+    private final long timer_initY;
+    private final long timer_initZ;
+    private final ITarget timer_teleportTarget;
+    private final boolean timer_respawn;
+    private final boolean timer_canMove;
+    private final Trade timer_chargeFor;
+    private final TeleportCause timer_cause;
+
+    AsyncTimedTeleport(IUser user, IEssentials ess, AsyncTeleport teleport, long delay, IUser teleportUser, ITarget target, Trade chargeFor, TeleportCause cause, boolean respawn) {
+        this.teleportOwner = user;
+        this.ess = ess;
+        this.teleport = teleport;
+        this.timer_started = System.currentTimeMillis();
+        this.timer_delay = delay;
+        this.timer_health = teleportUser.getBase().getHealth();
+        this.timer_initX = Math.round(teleportUser.getBase().getLocation().getX() * MOVE_CONSTANT);
+        this.timer_initY = Math.round(teleportUser.getBase().getLocation().getY() * MOVE_CONSTANT);
+        this.timer_initZ = Math.round(teleportUser.getBase().getLocation().getZ() * MOVE_CONSTANT);
+        this.timer_teleportee = teleportUser.getBase().getUniqueId();
+        this.timer_teleportTarget = target;
+        this.timer_chargeFor = chargeFor;
+        this.timer_cause = cause;
+        this.timer_respawn = respawn;
+        this.timer_canMove = user.isAuthorized("essentials.teleport.timer.move");
+
+        timer_task = ess.runTaskTimerAsynchronously(this, 20, 20).getTaskId();
+    }
+
+    @Override
+    public void run() {
+
+        if (teleportOwner == null || !teleportOwner.getBase().isOnline() || teleportOwner.getBase().getLocation() == null) {
+            cancelTimer(false);
+            return;
+        }
+
+        final IUser teleportUser = ess.getUser(this.timer_teleportee);
+
+        if (teleportUser == null || !teleportUser.getBase().isOnline()) {
+            cancelTimer(false);
+            return;
+        }
+
+        final Location currLocation = teleportUser.getBase().getLocation();
+        if (currLocation == null) {
+            cancelTimer(false);
+            return;
+        }
+
+        if (!timer_canMove && (Math.round(currLocation.getX() * MOVE_CONSTANT) != timer_initX || Math.round(currLocation.getY() * MOVE_CONSTANT) != timer_initY || Math.round(currLocation.getZ() * MOVE_CONSTANT) != timer_initZ || teleportUser.getBase().getHealth() < timer_health)) {
+            // user moved, cancelTimer teleportPlayer
+            cancelTimer(true);
+            return;
+        }
+
+        class DelayedTeleportTask implements Runnable {
+            @Override
+            public void run() {
+
+                timer_health = teleportUser.getBase().getHealth();  // in case user healed, then later gets injured
+                final long now = System.currentTimeMillis();
+                if (now > timer_started + timer_delay) {
+                    try {
+                        teleport.cooldown(false);
+                    } catch (Throwable ex) {
+                        teleportOwner.sendMessage(tl("cooldownWithMessage", ex.getMessage()));
+                        if (teleportOwner != teleportUser) {
+                            teleportUser.sendMessage(tl("cooldownWithMessage", ex.getMessage()));
+                        }
+                    }
+                    try {
+                        cancelTimer(false);
+                        teleportUser.sendMessage(tl("teleportationCommencing"));
+
+                        CompletableFuture<Boolean> future = new CompletableFuture<>();
+                        future.exceptionally(e -> {
+                            ess.showError(teleportOwner.getSource(), e, "\\ teleport");
+                            return false;
+                        });
+                        if (timer_chargeFor != null) {
+                            timer_chargeFor.isAffordableFor(teleportOwner);
+                        }
+                        if (timer_respawn) {
+                            teleport.respawnNow(teleportUser, timer_cause, future);
+                        } else {
+                            teleport.nowAsync(teleportUser, timer_teleportTarget, timer_cause, future);
+                        }
+                        future.thenAccept(success -> {
+                            if (timer_chargeFor != null) {
+                                try {
+                                    timer_chargeFor.charge(teleportOwner);
+                                } catch (ChargeException ex) {
+                                    ess.showError(teleportOwner.getSource(), ex, "\\ teleport");
+                                }
+                            }
+                        });
+
+                    } catch (Exception ex) {
+                        ess.showError(teleportOwner.getSource(), ex, "\\ teleport");
+                    }
+                }
+            }
+        }
+        ess.scheduleSyncDelayedTask(new DelayedTeleportTask());
+    }
+
+    //If we need to cancelTimer a pending teleportPlayer call this method
+    void cancelTimer(boolean notifyUser) {
+        if (timer_task == -1) {
+            return;
+        }
+        try {
+            ess.getServer().getScheduler().cancelTask(timer_task);
+            if (notifyUser) {
+                teleportOwner.sendMessage(tl("pendingTeleportCancelled"));
+                if (timer_teleportee != null && !timer_teleportee.equals(teleportOwner.getBase().getUniqueId())) {
+                    ess.getUser(timer_teleportee).sendMessage(tl("pendingTeleportCancelled"));
+                }
+            }
+        } finally {
+            timer_task = -1;
+        }
+    }
+}

Essentials/src/com/earth2me/essentials/IUser.java

@@ -1,5 +1,6 @@
 package com.earth2me.essentials;
 
+import com.earth2me.essentials.api.IAsyncTeleport;
 import com.earth2me.essentials.commands.IEssentialsCommand;
 import net.ess3.api.ITeleport;
 import net.ess3.api.MaxMoneyException;
@@ -54,8 +55,14 @@ public interface IUser {
      */
     boolean hasOutstandingTeleportRequest();
 
+    /**
+     * @deprecated This API is not asynchronous. Use {@link com.earth2me.essentials.api.IAsyncTeleport IAsyncTeleport} with {@link IUser#getAsyncTeleport()}
+     */
+    @Deprecated
     ITeleport getTeleport();
 
+    IAsyncTeleport getAsyncTeleport();
+
     BigDecimal getMoney();
 
     void setMoney(final BigDecimal value) throws MaxMoneyException;

Essentials/src/com/earth2me/essentials/Jails.java

@@ -22,6 +22,7 @@
 
 import java.io.File;
 import java.util.*;
+import java.util.concurrent.CompletableFuture;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -116,7 +117,11 @@ public void removeJail(final String jail) throws Exception {
         }
     }
 
+    /**
+     * @deprecated This method does not use asynchronous teleportation. Use {@link Jails#sendToJail(IUser, String, CompletableFuture)}
+     */
     @Override
+    @Deprecated
     public void sendToJail(final IUser user, final String jail) throws Exception {
         acquireReadLock();
         try {
@@ -130,6 +135,24 @@ public void sendToJail(final IUser user, final String jail) throws Exception {
         }
     }
 
+    @Override
+    public void sendToJail(IUser user, String jail, CompletableFuture<Boolean> future) throws Exception {
+        acquireReadLock();
+        try {
+            if (user.getBase().isOnline()) {
+                Location loc = getJail(jail);
+                user.getAsyncTeleport().now(loc, false, TeleportCause.COMMAND, future);
+                future.thenAccept(success -> {
+                    user.setJail(jail);
+                });
+                return;
+            }
+            user.setJail(jail);
+        } finally {
+            unlock();
+        }
+    }
+
     @Override
     public void setJail(final String jailName, final Location loc) throws Exception {
         acquireWriteLock();
@@ -254,16 +277,22 @@ public void onJailPlayerJoin(final PlayerJoinEvent event) {
                 return;
             }
 
-            try {
-                sendToJail(user, user.getJail());
-            } catch (Exception ex) {
+            CompletableFuture<Boolean> future = new CompletableFuture<>();
+            future.exceptionally(ex -> {
                 if (ess.getSettings().isDebug()) {
                     LOGGER.log(Level.INFO, tl("returnPlayerToJailError", user.getName(), ex.getLocalizedMessage()), ex);
                 } else {
                     LOGGER.log(Level.INFO, tl("returnPlayerToJailError", user.getName(), ex.getLocalizedMessage()));
                 }
+                return false;
+            });
+            future.thenAccept(success -> user.sendMessage(tl("jailMessage")));
+
+            try {
+                sendToJail(user, user.getJail(), future);
+            } catch (Exception ex) {
+                future.completeExceptionally(ex);
             }
-            user.sendMessage(tl("jailMessage"));
         }
     }
 }