Harden Playerbot event processing and diagnostics (#479)

* Harden Playerbot action logging

* Preserve Playerbot event arrival order

* Guard Playerbot packet dispatch

* Instrument Playerbot performance hot paths

Author: MadMaxMangos

src/game/Server/WorldSession.cpp

@@ -82,6 +82,9 @@
 #endif /* ENABLE_ELUNA */
 #ifdef ENABLE_PLAYERBOTS
 #include "playerbot.h"
+#include "PlayerbotAIConfig.h"
+#include "PlayerbotPacketPolicy.h"
+#include "PlayerbotPerformanceMonitor.h"
 #endif
 
 #include <cstdarg>
@@ -285,6 +288,10 @@ void WorldSession::SendPacket(WorldPacket const* packet)
     {
         if (GetPlayer()->GetPlayerbotAI())
         {
+            if (sPlayerbotAIConfig.performanceMetricsInterval)
+            {
+                ai::sPlayerbotPerformanceMonitor.RecordBuiltPacket(packet->size());
+            }
             GetPlayer()->GetPlayerbotAI()->HandleBotOutgoingPacket(*packet);
         }
         else if (GetPlayer()->GetPlayerbotMgr())
@@ -1121,12 +1128,35 @@ bool WorldSession::Update(PacketFilter& updater)
  */
 void WorldSession::HandleBotPackets()
 {
-    WorldPacket* packet;
+    WorldPacket* packet = NULL;
     while (m_mailbox->Next(packet))
     {
-        OpcodeHandler const& opHandle = opcodeTable[packet->GetOpcode()];
-        (this->*opHandle.handler)(*packet);
-        delete packet;
+        std::unique_ptr<WorldPacket> packetHolder(packet);
+        if (!packet || !_player || !_player->IsInWorld())
+        {
+            continue;
+        }
+
+        OpcodeHandler const* opHandle = ai::FindDispatchablePlayerbotOpcodeHandler(
+            opcodeTable, packet->GetOpcode(), STATUS_LOGGEDIN);
+        if (!opHandle)
+        {
+            sLog.outError(
+                "PLAYERBOT: rejected queued opcode %s (0x%.4X): not a dispatchable logged-in opcode",
+                LookupOpcodeName(packet->GetOpcode()), packet->GetOpcode());
+            continue;
+        }
+
+        try
+        {
+            ExecuteOpcode(*opHandle, packet);
+        }
+        catch (ByteBufferException&)
+        {
+            sLog.outError(
+                "WorldSession::HandleBotPackets ByteBufferException while parsing opcode %s (0x%.4X)",
+                LookupOpcodeName(packet->GetOpcode()), packet->GetOpcode());
+        }
     }
 }
 #endif

src/game/WorldHandlers/World.cpp

@@ -113,6 +113,7 @@
 
 #include "PlayerbotAIConfig.h"
 #include "PlayerbotMgr.h"
+#include "PlayerbotPerformanceMonitor.h"
 #include "RandomPlayerbotMgr.h"
 #endif
 
@@ -1434,6 +1435,10 @@ void World::Update(uint32 diff)
 #ifdef ENABLE_PLAYERBOTS
     sRandomPlayerbotMgr.UpdateAI(diff);
     sRandomPlayerbotMgr.UpdateSessions(diff);
+    if (sPlayerbotAIConfig.performanceMetricsInterval)
+    {
+        ai::ReportPlayerbotPerformanceIfDue(sPlayerbotAIConfig.performanceMetricsInterval);
+    }
 #endif
 
     /// <li> Handle session updates

src/modules/Bots/CMakeLists.txt

@@ -38,6 +38,8 @@ set(BOT_SRCS
     playerbot/PlayerbotAIBase.h
     playerbot/PlayerbotAIConfig.cpp
     playerbot/PlayerbotAIConfig.h
+    playerbot/PlayerbotPerformanceMonitor.cpp
+    playerbot/PlayerbotPerformanceMonitor.h
     playerbot/playerbotDefs.h
     playerbot/PlayerbotFactory.cpp
     playerbot/PlayerbotFactory.h

src/modules/Bots/playerbot/PlayerbotAI.cpp

@@ -62,7 +62,7 @@ void PacketHandlingHelper::Handle(ExternalEventHelper &helper)
 {
     while (!queue.empty())
     {
-        helper.HandlePacket(handlers, queue.top());
+        helper.HandlePacket(handlers, queue.front());
         queue.pop();
     }
 }
@@ -437,7 +437,7 @@ void PlayerbotAI::UpdateAIInternal(uint32 elapsed)
     ExternalEventHelper helper(aiObjectContext);
     while (!chatCommands.empty())
     {
-        ChatCommandHolder holder = chatCommands.top();
+        ChatCommandHolder holder = chatCommands.front();
         string command = holder.GetCommand();
         Player* owner = holder.GetOwner();
         if (!helper.ParseChatCommand(command, owner) && holder.GetType() == CHAT_MSG_WHISPER)

src/modules/Bots/playerbot/PlayerbotAI.h

@@ -6,6 +6,7 @@
 #include "strategy/Engine.h"
 #include "strategy/ExternalEventHelper.h"
 #include "ChatFilter.h"
+#include "PlayerbotEventQueue.h"
 #include "PlayerbotSecurity.h"
 
 class Player;
@@ -92,7 +93,7 @@ class PacketHandlingHelper
 
     private:
         map<uint16, string> handlers;
-        stack<WorldPacket> queue;
+        ai::PlayerbotEventQueue<WorldPacket> queue;
 };
 
 /**
@@ -280,7 +281,7 @@ class PlayerbotAI : public PlayerbotAIBase
         BotState currentState;
         uint32 m_targetContextRevision; ///< Invalidates target observations across AI context changes.
         ChatHelper chatHelper;
-        stack<ChatCommandHolder> chatCommands;
+        ai::PlayerbotEventQueue<ChatCommandHolder> chatCommands;
         PacketHandlingHelper botOutgoingPacketHandlers;
         PacketHandlingHelper masterIncomingPacketHandlers;
         PacketHandlingHelper masterOutgoingPacketHandlers;

src/modules/Bots/playerbot/PlayerbotAIBase.cpp

@@ -1,6 +1,7 @@
 #include "../botpch.h"
 #include "playerbot.h"
 #include "PlayerbotAIConfig.h"
+#include "PlayerbotPerformanceMonitor.h"
 
 using namespace ai;
 using namespace std;
@@ -32,11 +33,22 @@ void PlayerbotAIBase::UpdateAI(uint32 elapsed)
     // Check if the AI can be updated
     if (!CanUpdateAI())
     {
+        if (sPlayerbotAIConfig.performanceMetricsInterval)
+        {
+            ai::sPlayerbotPerformanceMonitor.RecordAiDeferred();
+        }
         return;
     }
 
     // Update the AI internal state
+    std::uint64_t const evaluationStartedAtMicros = sPlayerbotAIConfig.performanceMetricsInterval ?
+        ai::PlayerbotPerformanceNowMicros() : 0;
     UpdateAIInternal(elapsed);
+    if (sPlayerbotAIConfig.performanceMetricsInterval)
+    {
+        ai::sPlayerbotPerformanceMonitor.RecordAiEvaluation(
+            ai::PlayerbotPerformanceNowMicros() - evaluationStartedAtMicros);
+    }
     // Yield the current thread
     YieldThread();
 }

src/modules/Bots/playerbot/PlayerbotAIConfig.cpp

@@ -77,6 +77,7 @@ PlayerbotAIConfig::PlayerbotAIConfig()
     randomBotStarterZoneQuota(0),
     logInGroupOnly(false),
     logValuesPerTick(false),
+    performanceMetricsInterval(0),
     fleeingEnabled(false),
     randomBotMinLevel(0),
     randomBotMaxLevel(0),
@@ -242,6 +243,14 @@ bool PlayerbotAIConfig::Initialize()
     randomBotJoinLfg = config.GetBoolDefault("AiPlayerbot.RandomBotJoinLfg", true);
     logInGroupOnly = config.GetBoolDefault("AiPlayerbot.LogInGroupOnly", true);
     logValuesPerTick = config.GetBoolDefault("AiPlayerbot.LogValuesPerTick", false);
+    int32 configuredPerformanceMetricsInterval = config.GetIntDefault("AiPlayerbot.PerformanceMetricsInterval", 0);
+    if (configuredPerformanceMetricsInterval < 0)
+    {
+        sLog.outError("AiPlayerbot.PerformanceMetricsInterval cannot be negative; %d given, disabling instrumentation",
+            configuredPerformanceMetricsInterval);
+        configuredPerformanceMetricsInterval = 0;
+    }
+    performanceMetricsInterval = static_cast<uint32>(configuredPerformanceMetricsInterval);
     fleeingEnabled = config.GetBoolDefault("AiPlayerbot.FleeingEnabled", true);
     randomBotMinLevel = config.GetIntDefault("AiPlayerbot.RandomBotMinLevel", 1);
     randomBotMaxLevel = config.GetIntDefault("AiPlayerbot.RandomBotMaxLevel", 255);

src/modules/Bots/playerbot/PlayerbotAIConfig.h

@@ -81,6 +81,7 @@ class PlayerbotAIConfig
         uint32 randomBotStarterZoneQuota; ///< Active residents each starting zone should hold before the roster fills at random. 0 disables.
         uint32 randomBotHomeAreaMaxLevel; ///< Bots at or below this level stay in the starting SUB-AREA -- Shadowglen, Northshire. 0 disables.
         bool logInGroupOnly, logValuesPerTick;
+        uint32 performanceMetricsInterval; ///< Seconds between aggregate performance reports; 0 disables instrumentation.
         bool fleeingEnabled; ///< Indicates if fleeing is enabled for bots.
         std::string randomBotCombatStrategies, randomBotNonCombatStrategies;
         std::string botTankStrategies, botDpsStrategies, botHealStrategies, botGroupNonCombatStrategies;

src/modules/Bots/playerbot/PlayerbotEventQueue.h

@@ -0,0 +1,34 @@
+/**
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ * MaNGOS is a full featured server for World of Warcraft, supporting
+ * the following clients: 1.12.x, 2.4.3, 3.3.5a, 4.3.4a and 5.4.8
+ *
+ * Copyright (C) 2005-2026 MaNGOS <https://www.getmangos.eu>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * World of Warcraft, and all World of Warcraft or Warcraft art, images,
+ * and lore are copyrighted by Blizzard Entertainment, Inc.
+ */
+
+#pragma once
+
+#include <queue>
+
+namespace ai
+{
+    template <typename T>
+    using PlayerbotEventQueue = std::queue<T>;
+}

src/modules/Bots/playerbot/PlayerbotLogPolicy.h

@@ -0,0 +1,59 @@
+/**
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ * MaNGOS is a full featured server for World of Warcraft, supporting
+ * the following clients: 1.12.x, 2.4.3, 3.3.5a, 4.3.4a and 5.4.8
+ *
+ * Copyright (C) 2005-2026 MaNGOS <https://www.getmangos.eu>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * World of Warcraft, and all World of Warcraft or Warcraft art, images,
+ * and lore are copyrighted by Blizzard Entertainment, Inc.
+ */
+
+#pragma once
+
+#include <cstdarg>
+#include <cstddef>
+#include <cstdio>
+#include <string>
+
+namespace ai
+{
+    constexpr std::size_t PLAYERBOT_LOG_MESSAGE_CAPACITY = 1024;
+
+    inline std::string FormatPlayerbotLogMessage(char const* format, va_list args)
+    {
+        if (!format)
+        {
+            return std::string();
+        }
+
+        char buffer[PLAYERBOT_LOG_MESSAGE_CAPACITY] = {};
+        int const result = std::vsnprintf(buffer, sizeof(buffer), format, args);
+        buffer[sizeof(buffer) - 1] = '\0';
+        return result < 0 ? std::string() : std::string(buffer);
+    }
+
+    inline bool WritePlayerbotLogLine(FILE* file, std::string const& message)
+    {
+        if (!file || std::fputs(message.c_str(), file) == EOF)
+        {
+            return false;
+        }
+
+        return std::fputc('\n', file) != EOF;
+    }
+}