Skip to content

fix(online): make lobby and social async state thread-safe #569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tintinhamans wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(online): make lobby and social async state thread-safe #569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions ...ralsMD/Code/GameEngine/Include/GameNetwork/GeneralsOnline/OnlineServices_LobbyInterface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#include "Common/Player.h"
#include "GameClient/InGameUI.h"
#include "GameLogic/VictoryConditions.h"
#include <atomic>

extern NGMPGame* TheNGMPGame;

Expand Down Expand Up @@ -196,17 +197,17 @@ class NGMP_OnlineServices_LobbyInterface

void SetLobbyListDirty()
{
m_bLobbyListDirty = true;
m_bLobbyListDirty.store(true);
}

void ConsumeLobbyListDirtyFlag()
{
m_bLobbyListDirty = false;
m_bLobbyListDirty.store(false);
}

bool IsLobbyListDirty()
bool IsLobbyListDirty() const
{
return m_bLobbyListDirty;
return m_bLobbyListDirty.load();
}

UnicodeString m_PendingCreation_LobbyName;
Expand Down Expand Up @@ -463,7 +464,7 @@ class NGMP_OnlineServices_LobbyInterface
// TODO_NGMP: cleanup
NetworkMesh* m_pLobbyMesh = nullptr;

bool m_bLobbyListDirty = false;
std::atomic_bool m_bLobbyListDirty = false;


#if !defined(GENERALS_ONLINE_DISABLE_AUTO_ACCEPT)
Expand All @@ -473,7 +474,7 @@ class NGMP_OnlineServices_LobbyInterface
bool m_bAttemptingToJoinLobby = false;
LobbyEntry m_LobbyTryingToJoin;

bool m_bSearchInProgress = false;
std::atomic_bool m_bSearchInProgress = false;

bool m_bMarkedGameAsFinished = false;

Expand Down
6 changes: 5 additions & 1 deletion ...alsMD/Code/GameEngine/Include/GameNetwork/GeneralsOnline/OnlineServices_SocialInterface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ class NGMP_OnlineServices_SocialInterface
m_cbOnChatMessage = cbOnChatMessage;
}

std::unordered_map<int64_t, FriendsEntry> GetRecentlyPlayedWithList()
const std::unordered_map<int64_t, FriendsEntry>& GetRecentlyPlayedWithList()
{
// is it stale? clear it out
const int64_t recentPlayersListLifespan = 600000; // 10 minutes
Expand All @@ -110,11 +110,13 @@ class NGMP_OnlineServices_SocialInterface

std::unordered_map<int64_t, FriendsEntry> GetCachedFriendsList()
{
std::scoped_lock<std::mutex> lock(m_friendsMapMutex);
return m_mapFriends;
}

std::unordered_map<int64_t, FriendsEntry> GetCachedRequestsList()
{
std::scoped_lock<std::mutex> lock(m_friendsMapMutex);
return m_mapPendingRequests;
}

Expand Down Expand Up @@ -177,6 +179,8 @@ class NGMP_OnlineServices_SocialInterface
std::function<void(int64_t source_user_id, int64_t target_user_id, UnicodeString unicodeStr)> m_cbOnChatMessage = nullptr;

// Cached, may be out of date if friends UI isnt active, optimized for lookup
// Rebuilt on the HTTP thread and read from the main thread, so all access goes through m_friendsMapMutex.
mutable std::mutex m_friendsMapMutex;
std::unordered_map<int64_t, FriendsEntry> m_mapFriends;
std::unordered_map<int64_t, FriendsEntry> m_mapPendingRequests;
std::unordered_map<int64_t, FriendsEntry> m_mapBlocked;
Expand Down
51 changes: 36 additions & 15 deletions ...alsMD/Code/GameEngine/Source/GameNetwork/GeneralsOnline/OnlineServices_LobbyInterface.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,24 +519,35 @@ NGMP_OnlineServices_LobbyInterface::NGMP_OnlineServices_LobbyInterface()

void NGMP_OnlineServices_LobbyInterface::SearchForLobbies(std::function<void()> onStartCallback, std::function<void(std::vector<LobbyEntry>)> onCompleteCallback)
{
if (m_bSearchInProgress)
const bool lobbyListWasDirty = m_bLobbyListDirty.exchange(false);
if (m_bSearchInProgress.exchange(true))
{
if (lobbyListWasDirty)
{
m_bLobbyListDirty.store(true);
}
return;
}

// A notification received after the exchange above stays set and triggers a later refresh.
m_fnCallbackSearchForLobbiesComplete = onCompleteCallback;

m_bSearchInProgress = true;
m_vecLobbies.clear();
if (onStartCallback != nullptr)
{
onStartCallback();
}

std::string strURI = NGMP_OnlineServicesManager::GetAPIEndpoint("Lobbies");
std::map<std::string, std::string> mapHeaders;

NGMP_OnlineServicesManager::GetInstance()->GetHTTPManager()->SendGETRequest(strURI.c_str(), EIPProtocolVersion::DONT_CARE, mapHeaders, [=](bool bSuccess, int statusCode, std::string strBody, HTTPRequest* pReq)
{
try
bool bSearchSucceeded = false;
if (bSuccess && statusCode == 200)
{
try
{
nlohmann::json jsonObject = nlohmann::json::parse(strBody);
std::vector<LobbyEntry> parsedLobbies;

std::vector<int> vecLatencies;
std::map<int64_t, int> mapPlayerLatencies;
Expand Down Expand Up @@ -632,19 +643,29 @@ void NGMP_OnlineServices_LobbyInterface::SearchForLobbies(std::function<void()>
lobbyEntry.members.push_back(memberEntry);
}

m_vecLobbies.push_back(lobbyEntry);
parsedLobbies.push_back(std::move(lobbyEntry));
}
}
catch (...)
{
m_vecLobbies = std::move(parsedLobbies);
bSearchSucceeded = true;
}
catch (...)
{

}
}
}

if (m_fnCallbackSearchForLobbiesComplete != nullptr)
{
m_fnCallbackSearchForLobbiesComplete(m_vecLobbies);
}
m_bSearchInProgress = false;
if (!bSearchSucceeded)
{
m_bLobbyListDirty.store(true);
}

const std::function<void(std::vector<LobbyEntry>)> completionCallback = m_fnCallbackSearchForLobbiesComplete;
const std::vector<LobbyEntry> lobbies = m_vecLobbies;
m_bSearchInProgress.store(false);
if (completionCallback != nullptr)
{
completionCallback(lobbies);
}
});
}

Expand Down
29 changes: 16 additions & 13 deletions ...lsMD/Code/GameEngine/Source/GameNetwork/GeneralsOnline/OnlineServices_SocialInterface.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,12 @@ void NGMP_OnlineServices_SocialInterface::GetFriendsList(bool bUseCache, std::fu

try
{
// Note: m_mapFriends and m_mapPendingRequests access happens in HTTP thread context
// This is a design issue but adding lock would be too invasive at this point
// The callback execution uses localCallback which is safe
NGMP_OnlineServices_SocialInterface* pThis = NGMP_OnlineServicesManager::GetInterface<NGMP_OnlineServices_SocialInterface>();
if (pThis == nullptr)
return;

pThis->m_mapFriends.clear();
pThis->m_mapPendingRequests.clear();
std::unordered_map<int64_t, FriendsEntry> mapFriends{};
std::unordered_map<int64_t, FriendsEntry> mapPendingRequests{};

nlohmann::json jsonObject = nlohmann::json::parse(strBody);

Expand All @@ -70,7 +67,7 @@ void NGMP_OnlineServices_SocialInterface::GetFriendsList(bool bUseCache, std::fu
friendsResult.vecFriends.push_back(newFriend);

// cache
pThis->m_mapFriends[newFriend.user_id] = newFriend;
mapFriends.insert_or_assign(newFriend.user_id, newFriend);
}

// pending requests
Expand All @@ -85,8 +82,12 @@ void NGMP_OnlineServices_SocialInterface::GetFriendsList(bool bUseCache, std::fu
friendsResult.vecPendingRequests.push_back(newEntry);

// cache
pThis->m_mapPendingRequests[newEntry.user_id] = newEntry;
mapPendingRequests.insert_or_assign(newEntry.user_id, newEntry);
}

std::scoped_lock<std::mutex> lock(pThis->m_friendsMapMutex);
pThis->m_mapFriends.swap(mapFriends);
pThis->m_mapPendingRequests.swap(mapPendingRequests);
}
catch (...)
{
Expand All @@ -112,10 +113,9 @@ void NGMP_OnlineServices_SocialInterface::GetBlockList(std::function<void(Blocke
{
BlockedResult blockedResult;

m_mapBlocked.clear();

try
{
std::unordered_map<int64_t, FriendsEntry> mapBlocked{};
nlohmann::json jsonObject = nlohmann::json::parse(strBody);

for (const auto& blockedEntryIter : jsonObject["blocked"])
Expand All @@ -129,8 +129,11 @@ void NGMP_OnlineServices_SocialInterface::GetBlockList(std::function<void(Blocke
blockedResult.vecBlocked.push_back(newEntry);

// cache
m_mapBlocked[newEntry.user_id] = newEntry;
mapBlocked.insert_or_assign(newEntry.user_id, newEntry);
}

std::scoped_lock<std::mutex> lock(m_friendsMapMutex);
m_mapBlocked.swap(mapBlocked);
}
catch (...)
{
Expand Down Expand Up @@ -285,7 +288,6 @@ void NGMP_OnlineServices_SocialInterface::OnChatMessage(int64_t source_user_id,
}
}
m_mapCachedMessages[user_id_to_store].push_back(unicodeStr);

if (m_cbOnChatMessage != nullptr)
{
m_cbOnChatMessage(source_user_id, target_user_id, unicodeStr);
Expand Down Expand Up @@ -346,16 +348,17 @@ void NGMP_OnlineServices_SocialInterface::OnFriendRequestAccepted(std::string st

bool NGMP_OnlineServices_SocialInterface::IsUserIgnored(int64_t target_user_id)
{
const std::scoped_lock<std::mutex> lock(m_friendsMapMutex);
return m_mapBlocked.contains(target_user_id);
}

bool NGMP_OnlineServices_SocialInterface::IsUserFriend(int64_t target_user_id)
{
const std::scoped_lock<std::mutex> lock(m_friendsMapMutex);
return m_mapFriends.contains(target_user_id);
}

bool NGMP_OnlineServices_SocialInterface::IsUserPendingRequest(int64_t target_user_id)
{
std::scoped_lock<std::mutex> lock(m_friendsMapMutex);
return m_mapPendingRequests.contains(target_user_id);
}

Expand Down
Loading