Ticket #3494: t3494_oos_error_after_each_failed rejoin_v1.patch

source/network/NetServer.cpp

@@ -1018 +1018 @@
     CRejoinedMessage* message = (CRejoinedMessage*)event->GetParamRef();
 
     message->m_GUID = session->GetGUID();
 
     server.Broadcast(message);
+    server.m_ServerTurnManager->ResetOOSCheck();
 
     return true;
 }
 
 bool CNetServerWorker::OnDisconnect(void* context, CFsmEvent* event)

source/network/NetTurnManager.cpp

@@ -221 +221 @@
 
 void CNetTurnManager::OnSyncError(u32 turn, const CStr& expectedHash, std::vector<CSyncErrorMessage::S_m_PlayerNames>& playerNames)
 {
     NETTURN_LOG((L"OnSyncError(%d, %hs)\n", turn, Hexify(expectedHash).c_str()));
 
-    // Only complain the first time
-    if (m_HasSyncError)
-        return;
-
     bool quick = !TurnNeedsFullHash(turn);
     std::string hash;
     ENSURE(m_Simulation2.ComputeStateHash(hash, quick));
 
     OsPath path = psLogDir()/"oos_dump.txt";
@@ -237 +233 @@
     file.close();
 
     hash = Hexify(hash);
     const std::string& expectedHashHex = Hexify(expectedHash);
 
-    DisplayOOSError(turn, hash, expectedHashHex, false, &playerNames, &path);
+    DisplayOOSError(turn, hash, expectedHashHex, false, &playerNames);
 }
 
-void CNetTurnManager::DisplayOOSError(u32 turn, const CStr& hash, const CStr& expectedHash, bool isReplay, std::vector<CSyncErrorMessage::S_m_PlayerNames>* playerNames = NULL, OsPath* path = NULL)
+void CNetTurnManager::DisplayOOSError(u32 turn, const CStr& hash, const CStr& expectedHash, bool isReplay, std::vector<CSyncErrorMessage::S_m_PlayerNames>* playerNames = NULL)
 {
     m_HasSyncError = true;
 
     std::stringstream msg;
     msg << "Out of sync on turn " << turn;
@@ -252 +248 @@
     if (playerNames)
         for (size_t i = 0; i < playerNames->size(); ++i)
             msg << (i == 0 ? "\nPlayers: " : ", ") << utf8_from_wstring((*playerNames)[i].m_Name);
 
     if (isReplay)
+    {
         msg << "\n\n" << "The current game state is different from the original game state.";
+        msg << "\n\n" << "Did you try to load an incompatible replay?";
+    }
     else
+    {
         msg << "\n\n" << "Your game state is " << (expectedHash == hash ? "identical to" : "different from") << " the hosts game state.";
-
-    if (path)
-        msg << "\n\n" << "Dumping current state to " << utf8_from_wstring(OsPath(*path).string());
+        msg << "\n\n" << "Please report this error and provide the commands.txt file of the host.";
+    }
 
     LOGERROR("%s", msg.str());
 
     if (g_GUI)
         g_GUI->DisplayMessageBox(600, 350, L"Sync error", wstring_from_utf8(msg.str()));
@@ -424 +423 @@
 
     NETTURN_LOG((L"NotifyFinishedUpdate(%d, %hs)\n", turn, Hexify(hash).c_str()));
 
     m_Replay.Hash(hash, quick);
 
-    // Don't send the hash if OOS
-    if (m_HasSyncError)
-        return;
-
     // Send message to the server
     CSyncCheckMessage msg;
     msg.m_Turn = turn;
     msg.m_Hash = hash;
     m_NetClient.SendMessage(&msg);

source/network/NetTurnManager.h

@@ -111 +111 @@
     virtual void OnSyncError(u32 turn, const CStr& expectedHash, std::vector<CSyncErrorMessage::S_m_PlayerNames>& playerNames);
 
     /**
      * Shows a message box when an out of sync error has been detected in the session or visual replay.
      */
-    virtual void DisplayOOSError(u32 turn, const CStr& hash, const CStr& expectedHash, bool isReplay, std::vector<CSyncErrorMessage::S_m_PlayerNames>* playerNames, OsPath* path);
+    virtual void DisplayOOSError(u32 turn, const CStr& hash, const CStr& expectedHash, bool isReplay, std::vector<CSyncErrorMessage::S_m_PlayerNames>* playerNames);
 
     /**
      * Called by simulation code, to add a new command to be distributed to all clients and executed soon.
      */
     virtual void PostCommand(JS::HandleValue data) = 0;
@@ -319 +319 @@
      * Returns the turn length that was used for the given turn.
      * Requires turn <= GetReadyTurn().
      */
     u32 GetSavedTurnLength(u32 turn);
 
+    /**
+     * Start doing OOS checks again.
+     */
+    void ResetOOSCheck() { m_HasSyncError = false; }
+
 protected:
     void CheckClientsReady();
 
     /// The latest turn for which we have received all commands from all clients
     u32 m_ReadyTurn;