Merge pull request #2890 from BentoBoxWorld/copilot/fix-players-fall-into-void

Add safe-spot checking to island-based homeTeleportAsync

Author: tastybento

src/main/java/world/bentobox/bentobox/managers/IslandsManager.java

@@ -1885,17 +1885,41 @@ public CompletableFuture<Void> homeTeleportAsync(Island island, User user, boole
         Location loc = island.getHome("");
         user.sendMessage("commands.island.go.teleport");
         goingHome.add(user.getUniqueId());
-        readyPlayer(user.getPlayer());
-        return Util.teleportAsync(Objects.requireNonNull(user.getPlayer()), loc).thenAccept(b -> {
-            // Only run the commands if the player is successfully teleported
-            if (b != null && b) {
-                teleported(island.getWorld(), user, "", newIsland, island);
-                this.setPrimaryIsland(user.getUniqueId(), island);
+        Player player = Objects.requireNonNull(user.getPlayer());
+        readyPlayer(player);
+        CompletableFuture<Void> result = new CompletableFuture<>();
+        isSafeLocationAsync(loc).thenAccept(safe -> {
+            if (Boolean.TRUE.equals(safe)) {
+                Util.teleportAsync(player, loc).thenAccept(b -> {
+                    if (b != null && b) {
+                        teleported(island.getWorld(), user, "", newIsland, island);
+                        this.setPrimaryIsland(user.getUniqueId(), island);
+                    } else {
+                        goingHome.remove(user.getUniqueId());
+                    }
+                    result.complete(null);
+                });
             } else {
-                // Remove from mid-teleport set
-                goingHome.remove(user.getUniqueId());
+                // Location is not safe, use SafeSpotTeleport to find a safe spot
+                new SafeSpotTeleport.Builder(plugin).entity(player).island(island)
+                        .thenRun(() -> {
+                            teleported(island.getWorld(), user, "", newIsland, island);
+                            this.setPrimaryIsland(user.getUniqueId(), island);
+                        })
+                        .ifFail(() -> {
+                            plugin.logError(user.getName()
+                                    + " could not be teleported to home on island "
+                                    + island.getCenter());
+                            goingHome.remove(user.getUniqueId());
+                        }).buildFuture().thenAccept(b -> result.complete(null));
             }
+        }).exceptionally(e -> {
+            plugin.logError("Error checking safe location for " + user.getName() + ": " + e.getMessage());
+            goingHome.remove(user.getUniqueId());
+            result.complete(null);
+            return null;
         });
+        return result;
     }
 
 }

src/test/java/world/bentobox/bentobox/managers/IslandsManagerTest.java

@@ -1504,6 +1504,29 @@ void testsetMaxHomes() {
         verify(island).setMaxHomes(40);
     }
 
+    /**
+     * Helper to set up a mock home location with safe blocks for homeTeleportAsync tests.
+     * Returns the mocked home Location with block/chunk/world configured.
+     */
+    private Location setupSafeHomeLoc() {
+        Location homeLoc = mock(Location.class);
+        when(homeLoc.getWorld()).thenReturn(world);
+        Block homeBlock = mock(Block.class);
+        Block homeGround = mock(Block.class);
+        Block homeSpace2 = mock(Block.class);
+        when(homeLoc.getBlock()).thenReturn(homeBlock);
+        when(homeBlock.getRelative(BlockFace.DOWN)).thenReturn(homeGround);
+        when(homeBlock.getRelative(BlockFace.UP)).thenReturn(homeSpace2);
+        // Safe location: solid ground, air above
+        when(homeGround.getType()).thenReturn(Material.STONE);
+        when(homeBlock.getType()).thenReturn(Material.AIR);
+        when(homeSpace2.getType()).thenReturn(Material.AIR);
+        // Mock chunk loading
+        Chunk homeChunk = mock(Chunk.class);
+        mockedUtil.when(() -> Util.getChunkAtAsync(homeLoc)).thenReturn(CompletableFuture.completedFuture(homeChunk));
+        return homeLoc;
+    }
+
     /**
      * Test method for
      * {@link world.bentobox.bentobox.managers.IslandsManager#homeTeleportAsync(Island, User)}.
@@ -1512,7 +1535,7 @@ void testsetMaxHomes() {
     void testHomeTeleportAsyncIslandUser() throws Exception {
         // Setup
         Island island = mock(Island.class);
-        Location homeLoc = mock(Location.class);
+        Location homeLoc = setupSafeHomeLoc();
         when(island.getHome("")).thenReturn(homeLoc);
         when(island.getWorld()).thenReturn(world);
         when(user.getPlayer()).thenReturn(player);
@@ -1547,7 +1570,7 @@ void testHomeTeleportAsyncIslandUser() throws Exception {
     void testHomeTeleportAsyncIslandUserBooleanWithDefaultHome() throws Exception {
         // Setup
         Island island = mock(Island.class);
-        Location homeLoc = mock(Location.class);
+        Location homeLoc = setupSafeHomeLoc();
         when(island.getHome("")).thenReturn(homeLoc);
         when(island.getWorld()).thenReturn(world);
         when(user.getPlayer()).thenReturn(player);
@@ -1584,7 +1607,7 @@ void testHomeTeleportAsyncIslandUserBooleanWithDefaultHome() throws Exception {
     void testHomeTeleportAsyncIslandUserBooleanNewIsland() throws Exception {
         // Setup
         Island island = mock(Island.class);
-        Location homeLoc = mock(Location.class);
+        Location homeLoc = setupSafeHomeLoc();
         when(island.getHome("")).thenReturn(homeLoc);
         when(island.getWorld()).thenReturn(world);
         when(user.getPlayer()).thenReturn(player);
@@ -1621,7 +1644,7 @@ void testHomeTeleportAsyncIslandUserBooleanNewIsland() throws Exception {
     void testHomeTeleportAsyncIslandUserBooleanFailedTeleport() throws Exception {
         // Setup
         Island island = mock(Island.class);
-        Location homeLoc = mock(Location.class);
+        Location homeLoc = setupSafeHomeLoc();
         when(island.getHome("")).thenReturn(homeLoc);
         when(island.getWorld()).thenReturn(world);
         when(user.getPlayer()).thenReturn(player);
@@ -1646,4 +1669,49 @@ void testHomeTeleportAsyncIslandUserBooleanFailedTeleport() throws Exception {
         verify(user).sendMessage("commands.island.go.teleport");
         verify(island).getHome("");
     }
+
+    /**
+     * Test method for
+     * {@link world.bentobox.bentobox.managers.IslandsManager#homeTeleportAsync(Island, User, boolean)}.
+     * Test with unsafe home location - should use SafeSpotTeleport fallback instead of direct teleport.
+     */
+    @Test
+    void testHomeTeleportAsyncIslandUserBooleanUnsafeLocation() throws Exception {
+        // Setup
+        Island island = mock(Island.class);
+        Location homeLoc = mock(Location.class);
+        when(homeLoc.getWorld()).thenReturn(world);
+        Block homeBlock = mock(Block.class);
+        Block homeGround = mock(Block.class);
+        Block homeSpace2 = mock(Block.class);
+        when(homeLoc.getBlock()).thenReturn(homeBlock);
+        when(homeBlock.getRelative(BlockFace.DOWN)).thenReturn(homeGround);
+        when(homeBlock.getRelative(BlockFace.UP)).thenReturn(homeSpace2);
+        // Unsafe location: no solid ground (all AIR)
+        when(homeGround.getType()).thenReturn(Material.AIR);
+        when(homeBlock.getType()).thenReturn(Material.AIR);
+        when(homeSpace2.getType()).thenReturn(Material.AIR);
+        // Mock chunk loading
+        Chunk homeChunk = mock(Chunk.class);
+        mockedUtil.when(() -> Util.getChunkAtAsync(homeLoc)).thenReturn(CompletableFuture.completedFuture(homeChunk));
+
+        when(island.getHome("")).thenReturn(homeLoc);
+        when(island.getWorld()).thenReturn(world);
+        when(island.getProtectionCenter()).thenReturn(location);
+        when(user.getPlayer()).thenReturn(player);
+        when(user.getUniqueId()).thenReturn(uuid);
+
+        // Mock player methods called by readyPlayer
+        when(player.isInsideVehicle()).thenReturn(false);
+
+        // Test
+        IslandsManager localIM = new IslandsManager(plugin);
+        // homeTeleportAsync should NOT call Util.teleportAsync directly for unsafe locations
+        // It should fall back to SafeSpotTeleport
+        localIM.homeTeleportAsync(island, user, true);
+
+        // Verify that direct teleportAsync was NOT called (SafeSpotTeleport handles it instead)
+        mockedUtil.verify(() -> Util.teleportAsync(eq(player), eq(homeLoc)), never());
+        verify(user).sendMessage("commands.island.go.teleport");
+    }
 }