В докладе Антон расскажет о транзакционном фреймворке, на котором построен новый проект студии Pushkin: батлер с асинхронным мультиплеером, синхронизацией состояния между устройствами, минимальными требованиями к сети и защитой от читеров.

1. Транзакционный фреймворк для
сингловых игр и игр с
асинхронным мультиплеером
Антон Рассадин
Pushkin Studio / MY.GAMES

2. Зачем фреймворк?
Чтобы выделить общие для нескольких проектов
части кода в отдельные модули или плагины и
переиспользовать.

3. Задачи, решаемые фреймворком
● Поддержка асинхронного мультиплеера
● Игра с нескольких устройств под одним аккаунтом
● Минимальное использование сетевого трафика
● Защита от читеров
● Единая кодовая база для клиента и сервера
● Детерминированные расчёты
● Масштабируемость серверной инфраструктуры

4. Модель данных — основа любой игры
● Хранит данные мира и игрока
● Описывает сущности, логику и правила игры
● Правильно применённая датамодель уменьшает связность
приложения

5. PsData
Плагин датамодели для Unreal Engine
https://github.com/PushkinStudio/PsData
● Const-correctness
● События
● Валидация данных
● Рефлексия и кодогенерация

6. Использование PsData
● Унаследовать тип данных от UPsData
● Объявить поля и метаданные полей с помощью макросов
UCLASS()
class UUserData : public UPsData
{
GENERATED_BODY()
DPROP(int32, LastTransactionTime);
DMETA(Event)
DPROP(FString, Uid);
DMETA(Strict)
DPROP(UMoneyData*, Money);
}

7. Использование PsData
Обращение к объекту:
/** ... */
{
UserData->SetLastTransactionTime(Timestamp);
const auto Money = UserData->GetMoney();
Money->SetGold(100);
Money->SetCredits(10);
}

8. Использование PsData
Создание объекта для неконстантного доступа:
class FUserDataAccessor
{
private:
friend UMyDataController;
static UUserData* GetMutableUserData(URootData* RootData)
{
return RootData->GetMutableUserData();
}
};

9. Использование PsData
Инициализация модели:
void UMyDataController::Init()
{
RootData = NewObject<UFooRootData>();
auto PrototypesData =
FFooPrototypesDataAccessor::GetMutablePrototypes(RootData);
// Deserialize from UDataTable asset
auto Deserializer = FPsDataTableDeserializer(MyDataTable, PrototypesData-
>GetCharacters());
PrototypesData->DataDeserialize(&Deserializer);
//...
}

10. Клиенты и сервер

11. Общий вид системы (клиент)

12. Контекст транзакции
struct FTransactionContext
{
UPROPERTY()
FString Type;
UPROPERTY()
FString Id;
UPROPERTY()
int32 Amount;
/** More transaction data */
};

13. Транзакция
struct ITransaction
{
/** Initialize transaction object from context */
virtual void Init(const FTransactionContext& Context) = 0;
/** Perform execution check */
virtual FTransactionCheckResult CheckCanApply(const URootData*
RootData) const = 0;
/** Apply transaction to data model */
virtual bool Apply(URootData* RootData, UUserInfoData* UserInfoData)
const = 0;
};

14. Конкретная транзакция
struct FTransactionSellItem final : public ITransaction
{
static FTransactionContext CreateContext(int32 CurrentTime, const FString&
ItemId);
void Init(const FTransactionContext& InContext) override;
FTransactionCheckResult CheckCanApply(const URootData* RootData) const
override;
bool Apply(URootData* RootData, UUserInfoData* UserInfoData) const override;
protected:
/** Item to sell */
FString ItemId;
};

15. Проверка возможности применить
FTransactionCheckResult FTransactionBuyClickerUpgrade::CheckCanApply(const URootData* RootData) const
{
const auto UserInfo = RootData->GetUserInfo();
const auto ClickerData = UserInfo->GetClickerData();
if (ClickerData->GetLastSimulationTime() < Timestamp)
{
return FTransactionCheckResult(FString::Printf(TEXT("%s: advance simulation to current time. (%d
< %d)"), *_FUNC_LINE, ClickerData->GetLastSimulationTime(), Timestamp));
}
const auto ClickerUpgradeInfo = UDataLibrary::GetClickerUpgradeInfo(RootData, ClickerUpgradeType);
const auto NextUpgradeData = ClickerUpgradeInfo.NextClickerUpgradeData;
if (!NextUpgradeData.IsValid())
{
return FTransactionCheckResult(FString::Printf(TEXT("%s: can't upgrade "%s" further, max
level"), *_FUNC_LINE, *(Utils::EnumToString(ClickerUpgradeType))));
}
return true;
}

16. Применение к датамодели
bool FTransactionBuyClickerUpgrade::Apply(URootData* RootData, UUserInfoData*
UserInfoData) const
{
const auto ClickerUpgradeInfo = UDataLibrary::GetClickerUpgradeInfo(RootData,
ClickerUpgradeType);
const auto NextUpgradeData = ClickerUpgradeInfo.NextClickerUpgradeData.Get();
const auto ClickerManager = FClickerManager::Create(UserInfoData, RootData);
ClickerManager->InstallClickerUpgrade(NextUpgradeData, Timestamp);
ClickerManager->SpendClickerUpgradeParts(NextUpgradeData->GetPrice(), Timestamp);
const auto QuestManager = FQuestManager::Create(UserInfoData, RootData);
QuestManager->HandleRetroactiveQuestEvent(EQuestType::ClickerUpgrade, Timestamp);
return true;
}

17. Журнал
struct FTransactionJournalEntry
{
GENERATED_BODY()
UPROPERTY()
FGuid Id;
UPROPERTY()
FTransactionContext Context;
};
struct FTransactionJournal
{
/** Array of applied transactions */
UPROPERTY()
TArray<FTransactionJournalEntry> Transactions;
/** Input events produced by player during async transactions */
UPROPERTY()
TArray<FPlayerInputEvent> PlayerInputEvents;
}

18. Контроллер журнала
class UTransactionJournalController : public UObject
{
/** ... */
static TOptional<FTransactionJournal> DeserializeJournal(const TSharedRef<FJsonObject>& Object);
/** Serialize current transaction journal to json object */
static TSharedPtr<FJsonObject> SerializeJournal(const FTransactionJournal& Journal);
void SyncJournal(const FSyncDelegate& OnCompleted, bool bForce = false);
/** Mark the transaction as completed into the journal. May initialize journal synchronization */
FGuid CommitTransaction(const FTransactionWithContext& Transaction, const FCommitDelegate&
OnCompleted = FCommitDelegate{});
/** Mark transaction as failed into the journal. May initialize journal synchronization */
FGuid FailTransaction(const FTransactionWithContext& Transaction, const FString& ErrorMessage, const
FCommitDelegate& OnCompleted = FCommitDelegate{});
};

19. Исполнитель транзакций
class UTransactionExecutor : public UObject
{
/** Check if transaction can be applied */
FTransactionCheckResult CheckCanApply(const
FTransactionConstRef& Transaction) const;
/** Apply transaction to data model */
TOptional<FExecutorError> Execute(const FTransactionConstRef&
Transaction);
};

20. Менеджер транзакций
class UTransactionManager : public UActorComponent
{
/** Create a transaction and check whether it can be executed */
bool CheckCanExecute(const FTransactionContext& Context) const;
/** Create and apply transaction using given context and commit it into transaction journal */
void Execute(const FTransactionContext& Context, const FExecuteDelegate& OnComplete);
/** Create and apply all transactions from transaction journal */
void PlayJournal(const FTransactionJournal& Journal, const FPlayJournalDelegate& OnCompleted);
/** Create and apply all transactions from transaction journal */
void RestoreJournal(const FTransactionJournal& Journal, const FRestoreJournalDelegate& OnCompleted);
/** Synchronize transaction journal */
void SyncJournal(const FSyncJournalDelegate& OnCompleted);
};

21. Синхронизация журнала
PsWebServer
https://github.com/PushkinStudio/PsWebServer
● Плагин на основе библиотеки CivetWeb
● Журнал сериализуется FJsonObjectConverter

22. Инициализация сервера
void UServer::Start(const FString& InVersion, bool bInVerbose)
{
WebServer = UPsWebServerLibrary::ConstructWebServer(this);
WebServer->StartServer();
// Register handlers
AddHandler<UServerPingHandler>(TEXT("/api/ping"));
AddHandler<UServerShutdownHandler>(TEXT("/api/shutdown"));
AddHandler<UServerJournalHandler>(TEXT("/api/journal"));
}
template <class T>
void UServer::AddHandler(const FString& Endpoint)
{
static_assert(std::is_base_of<UServerHandler, T>::value, "T must be a child of UServerHandler");
const auto ExactEndpoint = Endpoint + TEXT("$");
auto Handler = NewObject<T>(this);
Handler->SetServer(this);
WebServer->AddHandler(Handler, ExactEndpoint);
}

23. Серверный GameMode
void AMyGameModeServer::BeginPlay()
{
InitDataController();
InitTransactionManager(GetDataController()->GetRootData());
GetTransactionManager()->DisableJournal();
/** ... */
const auto OnCompleted = FBattleLevelPreloadedDelegate::CreateUObject(this,
&AGameModeServer::StartServer);
GetBattleController()->PreloadBattleLevels(OnCompleted);
}
void AMyGameModeServer::StartServer()
{
const auto Version = FString::Printf(TEXT("Server/%s"), *UMyLibrary::GetGameInstance(this)-
>GetGameVersion());
const bool bVerbose = UMyLibrary::GetBoolCommandLineParam("Verbose");
Server = NewObject<UServer>(this);
Server->Start(Version, bVerbose);
}

24. Контроль ошибок на сервере
● Сервер владеет доверенной версией состояния игрока
● Применяя транзакции из журнала, сервер выполняет
CheckCanExecute на каждой
● После применения журнала к состоянию игрока вычисляется хеш
от него
● Хеши на клиенте и сервере должны совпадать
● В случае ошибки CheckCanExecute или несовпадении хешей
возвращается ошибка, после этого клиент забирает последнее
верное состояние с сервера

25. Асинхронные транзакции
● Применяются, если на результат выполнения транзакции могут
повлиять события извне (пользовательский ввод)
● Процесс применения разделён на Begin и Commit
● Begin возвращает Promise, который получает результат
выполнения транзакции и затем вызывает метод завершения
Commit
● Между Begin и Commit события ввода добавляются в
PlayerInputEvents в журнале

26. Асинхронные транзакции
struct ITransactionAsync : ITransaction
{
ITransactionAsync()
: Promise(MakeShared<FTransactionPromise>())
{
}
/** Asynchronously apply the transaction to data model */
virtual FTransactionPromiseRef OnBeginPromise(URootData* RootData, UUserInfoData* UserInfoData)
{
OnBegin(RootData, UserInfoData);
return Promise;
}
virtual bool OnCommit(URootData* RootData, UUserInfoData* UserInfoData) const = 0;
virtual bool OnRestore(URootData* RootData, UUserInfoData* UserInfoData) const = 0;
virtual void OnFail(URootData* RootData, UUserInfoData* UserInfoData) const = 0;
protected:
virtual void OnBegin(URootData* RootData, UUserInfoData* UserInfoData) = 0;
FTransactionPromiseRef Promise;
};

27. Асинхронные транзакции
class FTransactionPromise
{
public:
void Then(const FResolveDelegate& InOnResolve, const FRejectDelegate&
InOnReject);
/** Set promise result */
void SetResult(bool bSuccess);
};

28. Планы по улучшению системы
● Избавиться от отдельного Context, перейдя на сериализацию
объекта транзакции
● Шаблонизировать создание объектов транзакции
● Выделить систему в плагин

29. Спасибо за внимание!
Антон Рассадин
anton@rassadin.net
Telegram: @antonrr

30. СПАСИБО!

31. Антон Рассадин
anton@rassadin.net
Telegram: @antonrr
https://rassadin.net