fix(engine): Rework logout behaviour (2004Scape#1281)

Source is a combination of memory, old discord channels, osrs testing and
this video: https://youtu.be/2NJa6WoXlMk?t=116

Co-authored-by: henrik <>
Co-authored-by: Pazaz <ItsPazaz@gmail.com>

Author: henke96

data/src/scripts/_test/scripts/engine/debug_logout.rs2

@@ -0,0 +1,4 @@
+[debugproc,antilog](int $duration)
+if (p_finduid(uid) = true) {
+    p_preventlogout("Antilog test", $duration);
+}

data/src/scripts/_test/scripts/engine/debug_longqueue.rs2

@@ -0,0 +1,23 @@
+[debugproc,longqueue]
+longqueue(testqueueint, 100000, ^accelerate, 123);
+longqueue(testqueueint, 100000, ^discard, 456);
+longqueue(testqueuestr, 100000, ^accelerate, "accelerate ran");
+longqueue(testqueuestr, 100000, ^discard, "long discard ran (!)");
+longqueue(testqueuestr, 5, ^discard, "short discard ran");
+
+[debugproc,queue](int $duration)
+queue(testqueueint, $duration, 123);
+queue(testqueuestr, $duration, "queue ran");
+
+[queue,testqueueint](int $test)
+console("int: <tostring($test)>");
+
+[queue,testqueuestr](string $msg)
+console("str: <$msg>");
+
+// blocks safe logout!
+[debugproc,dangerous_requeue]
+queue(dangerous_requeue, 0);
+
+[queue,dangerous_requeue]
+queue(dangerous_requeue, 0);

data/src/scripts/_test/scripts/engine/debug_queue.rs2

@@ -202,10 +202,11 @@
 // Get the player's UID to use in finduid/p_finduid later
 [command,uid]()(player_uid)
 [command,.uid]()(player_uid)
-// Requires protected access - request the player to log out
+// Request the player to log out
 [command,p_logout]
-// Check if the player is marked as "logged out" but not removed yet
-[command,loggedout]()(boolean)
+// Prevent logout for a duration
+[command,p_preventlogout](string $message, int $duration)
+[command,.p_preventlogout](string $message, int $duration)
 // Set a component's colour
 [command,if_setcolour](component $component, int $colour)
 // Open a modal in the chat box

data/src/scripts/engine.rs2

@@ -1,24 +1,8 @@
+// TODO: Change compiler to remove return value
 [logout,_]()(boolean)
-if (busy = true) {
-    return(false);
-}
-
-// if not an engine logout, and the player was hit within the last 10s, don't logout
-if (loggedout = false & map_clock > 17 & add(%lastcombat, 17) > map_clock) {
-    return(false);
-}
-
-// logging out mid-trade, restore inv and cancel trade
-if (%tradepartner ! null) {
-    ~moveallinv(tempinv, inv);
-    if (.finduid(%tradepartner) = true) {
-        .if_close;
-    }
-    %tradepartner = null;
-}
 ~set_pk_skull_logout;
-~set_antifire_logout;
-~set_antipoison_logout;
+~set_antifire_logout; // TODO: should be timer
+~set_antipoison_logout; // TODO: should be timer
 ~set_cannon_vars_logout;
 ~follower_logout;
 ~rashiliyia_door_logout;
@@ -39,9 +23,5 @@ if (p_finduid(uid) = true) {
         return;
     }
 
-    if (map_clock > 17 & add(%lastcombat, 17) > map_clock) {
-        mes("You can't logout until 10 seconds after the end of combat."); // todo: confirm this message for 2004
-        return;
-    }
     p_logout;
 }

data/src/scripts/login_logout/logout.rs2

@@ -282,6 +282,7 @@ if (inv_getobj(worn, ^wearpos_ring) = ring_of_recoil & npc_finduid(%aggressive_n
     npc_queue(2, $recoil_damage, 0);
     ~ring_of_recoil_lose_charge($recoil_damage);
 }
+p_preventlogout("You can't log out until 10 seconds after the end of combat.", 16);
 ~damage_self($damage);
 
 [proc,npc_retaliate](int $queue_delay)

data/src/scripts/skill_combat/scripts/npc/npc_combat.rs2

@@ -22,6 +22,7 @@ if (%auto_retaliate = ^player_auto_retaliate_on & npc_finduid($nid) = true & bus
 
 // this needs fixing, and .queue support
 [queue,pvp_retaliate](player_uid $uid)
+p_preventlogout("You can't log out until 10 seconds after the end of combat.", 16);
 if (%auto_retaliate = ^player_auto_retaliate_on & .finduid($uid) = true & busy2 = false) {
     // npc flinches player
     if (%action_delay < map_clock) {

data/src/scripts/skill_combat/scripts/player/auto_retaliate.rs2

@@ -55,7 +55,7 @@ import Player from '#/engine/entity/Player.js';
 import EntityLifeCycle from '#/engine/entity/EntityLifeCycle.js';
 import { NpcList, PlayerList } from '#/engine/entity/EntityList.js';
 import { isClientConnected, NetworkPlayer } from '#/engine/entity/NetworkPlayer.js';
-import { EntityQueueState } from '#/engine/entity/EntityQueueRequest.js';
+import { EntityQueueState, PlayerQueueType } from '#/engine/entity/EntityQueueRequest.js';
 import { PlayerTimerType } from '#/engine/entity/EntityTimer.js';
 
 import UpdateRebootTimer from '#/network/server/model/UpdateRebootTimer.js';
@@ -122,8 +122,8 @@ class World {
     private static readonly PLAYER_SAVERATE: number = 500; // 5m
     private static readonly PLAYER_COORDLOGRATE: number = 50; // 30s
 
-    private static readonly TIMEOUT_SOCKET_IDLE: number = Environment.NODE_DEBUG_SOCKET ? 60000 : 50; // 30s with no data- disconnect client
-    private static readonly TIMEOUT_SOCKET_LOGOUT: number = Environment.NODE_DEBUG_SOCKET ? 60000 : 100; // 60s with no client- remove player from processing
+    private static readonly TIMEOUT_NO_CONNECTION: number = Environment.NODE_DEBUG_SOCKET ? 60000 : 50; // 30s with no connection (16 ticks in osrs)
+    private static readonly TIMEOUT_NO_RESPONSE: number = Environment.NODE_DEBUG_SOCKET ? 60000 : 100; // 60s without any response
 
     // the game/zones map
     readonly gameMap: GameMap;
@@ -712,14 +712,6 @@ class World {
                     }
                 }
 
-                if (this.currentTick - player.lastResponse >= World.TIMEOUT_SOCKET_LOGOUT) {
-                    // x-logged / timed out for 60s: logout
-                    player.loggedOut = true;
-                } else if (this.currentTick - player.lastResponse >= World.TIMEOUT_SOCKET_IDLE) {
-                    // x-logged / timed out for 30s: attempt logout
-                    player.tryLogout = true;
-                }
-
                 // - client input tracking
                 player.processInputTracking();
 
@@ -728,7 +720,10 @@ class World {
                 }
             } catch (err) {
                 console.error(err);
-                this.removePlayer(player);
+                if (isClientConnected(player)) {
+                    player.logout();
+                    player.client.close();
+                }
             }
         }
 
@@ -841,7 +836,7 @@ class World {
                 // - primary queue
                 // - weak queue
                 player.processQueues();
-                if (!player.loggedOut) {
+                if (!player.loggingOut) {
                     // - timers
                     player.processTimers(PlayerTimerType.NORMAL);
                     // - soft timers
@@ -861,7 +856,10 @@ class World {
                 }
             } catch (err) {
                 console.error(err);
-                this.removePlayer(player);
+                if (isClientConnected(player)) {
+                    player.logout();
+                    player.client.close();
+                }
             }
         }
 
@@ -872,33 +870,54 @@ class World {
         const start: number = Date.now();
 
         for (const player of this.players) {
-            if (player.loggedOut) {
-                player.tryLogout = true;
-                player.clearInteraction();
-            }
-
-            if (!player.tryLogout) {
-                continue;
+            let force = false;
+            if (this.shutdown || this.currentTick - player.lastResponse >= World.TIMEOUT_NO_RESPONSE) {
+                // world shutdown or x-logged / timed out for 60s: force logout
+                player.loggingOut = true;
+                force = true;
+            } else if (this.currentTick - player.lastConnected >= World.TIMEOUT_NO_CONNECTION) {
+                // connection lost for 30s: request idle logout
+                player.requestIdleLogout = true;
+            }
+
+            if (player.requestLogout || player.requestIdleLogout) {
+                if (this.currentTick >= player.preventLogoutUntil) {
+                    player.loggingOut = true;
+                } else if (player.requestLogout && player.preventLogoutMessage !== null) {
+                    player.messageGame(player.preventLogoutMessage); // engine message type in osrs
+                    player.preventLogoutMessage = null;
+                }
+                player.requestLogout = false;
+                player.requestIdleLogout = false;
             }
 
-            player.closeModal();
+            if (player.loggingOut && (force || this.currentTick >= player.preventLogoutUntil)) {
+                player.closeModal();
 
-            if (player.canAccess() && player.queue.head() === null && player.engineQueue.head() === null) {
-                const script = ScriptProvider.getByTriggerSpecific(ServerTriggerType.LOGOUT, -1, -1);
-                if (!script) {
-                    printError('LOGOUT TRIGGER IS BROKEN!');
-                    continue;
+                let queueDiscardable = true;
+                for (let request = player.queue.head(); request !== null; request = player.queue.next()) {
+                    if (request.type === PlayerQueueType.LONG) {
+                        const logoutAction = request.args[0];
+                        if (logoutAction === 1) {
+                            // ^discard
+                            continue;
+                        }
+                    }
+                    queueDiscardable = false;
+                    break;
                 }
-
-                const state = ScriptRunner.init(script, player);
-                state.pointerAdd(ScriptPointer.ProtectedActivePlayer);
-                ScriptRunner.execute(state);
-
-                const result = state.popInt();
-                if (result === 1) {
+                if (player.canAccess() && player.engineQueue.head() === null && queueDiscardable) {
+                    const script = ScriptProvider.getByTriggerSpecific(ServerTriggerType.LOGOUT, -1, -1);
+                    if (!script) {
+                        printError('LOGOUT TRIGGER IS BROKEN!');
+                        continue;
+                    }
+    
+                    const state = ScriptRunner.init(script, player);
+                    state.pointerAdd(ScriptPointer.ProtectedActivePlayer);
+                    ScriptRunner.execute(state);
+    
                     this.removePlayer(player);
-                } else {
-                    player.tryLogout = false;
                 }
             }
         }
@@ -1112,7 +1131,10 @@ class World {
                 player.encodeOut();
             } catch (err) {
                 console.error(err);
-                this.removePlayer(player);
+                if (isClientConnected(player)) {
+                    player.logout();
+                    player.client.close();
+                }
             }
         }
         this.cycleStats[WorldStat.CLIENT_OUT] = Date.now() - start;
@@ -1199,23 +1221,23 @@ class World {
     }
 
     private processShutdown(): void {
+        for (const player of this.players) {
+            if (isClientConnected(player)) {
+                player.logout();
+                player.client.close();
+            }
+        }
+
         const duration = this.currentTick - this.shutdownTick;
         if (duration >= 1024) {
             // force remove all players, they had their chances to finish processing
             for (const player of this.players) {
+                player.addSessionLog(LoggerEventType.ENGINE, 'Player force removed!');
+                printError(`Player '${player.username}' force removed!`);
                 this.removePlayer(player);
             }
         }
 
-        for (const player of this.players) {
-            player.loggedOut = true;
-
-            if (isClientConnected(player)) {
-                player.logout(); // see ya
-                player.client.close();
-            }
-        }
-
         const online = this.getTotalPlayers();
         if (online === 0 && this.logoutRequests.size === 0) {
             printInfo('Server shutdown complete');
@@ -1592,11 +1614,6 @@ class World {
             return null;
         }
 
-        if (player.loggedOut) {
-            // todo: proper?
-            return null;
-        }
-
         return player;
     }
 

src/engine/World.ts

@@ -66,6 +66,7 @@ export class NetworkPlayer extends Player {
             return false;
         }
 
+        this.lastConnected = World.currentTick;
         this.userLimit = 0;
         this.clientLimit = 0;