o3de/Gems/Multiplayer/Code/Source/Debug/MultiplayerDebugAuditTrail.cpp

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#include "MultiplayerDebugAuditTrail.h"

#include <Atom/RPI.Public/ViewportContext.h>
#include <Atom/RPI.Public/ViewportContextBus.h>
#include <AzFramework/Entity/EntityDebugDisplayBus.h>
#include <AzFramework/Visibility/IVisibilitySystem.h>
#include <Multiplayer/Components/NetBindComponent.h>
#include <Debug/MultiplayerDebugSystemComponent.h>

#if defined(IMGUI_ENABLED)
#include <imgui/imgui.h>
#endif

namespace Multiplayer
{
    MultiplayerDebugAuditTrail::MultiplayerDebugAuditTrail()
        : m_updateDebugOverlay([this]() { UpdateDebugOverlay(); }, AZ::Name("UpdateAuditTrail"))
    {
        m_updateDebugOverlay.Enqueue(AZ::TimeMs{ 0 }, true);
    }

    AZStd::string_view MultiplayerDebugAuditTrail::GetAuditTrialFilter()
    {
        return m_filter;
    }

    void MultiplayerDebugAuditTrail::SetAuditTrailFilter(AZStd::string filter)
    {
        m_filter = AZStd::move(filter);
    }

    void MultiplayerDebugAuditTrail::OnImGuiUpdate([[maybe_unused]] const AZStd::deque<AuditTrailInput>& auditTrailElems)
    {
#if defined(IMGUI_ENABLED)
        if (ImGui::Button("Refresh"))
        {
            m_canPumpTrail = true;
        }
        ImGui::SameLine();
        const ImGuiInputTextFlags inputTextFlags = ImGuiInputTextFlags_EnterReturnsTrue;
        ImGui::Text("| Search:");
        ImGui::SameLine();
        const bool textWasInput = ImGui::InputText("", m_inputBuffer, IM_ARRAYSIZE(m_inputBuffer), inputTextFlags);
        if (textWasInput)
        {
            SetAuditTrailFilter(m_inputBuffer);
            ImGui::SetKeyboardFocusHere(-1);
        }

        // Focus on the text input field.
        if (ImGui::IsWindowAppearing())
        {
            ImGui::SetKeyboardFocusHere(-1);
        }
        ImGui::SetItemDefaultFocus();

        ImGui::Separator();

        const float TEXT_BASE_WIDTH = ImGui::CalcTextSize("A").x;
        const ImGuiTableFlags flags = ImGuiTableFlags_BordersV
            | ImGuiTableFlags_BordersOuterH
            | ImGuiTableFlags_Resizable
            | ImGuiTableFlags_SizingStretchSame
            | ImGuiTableFlags_RowBg
            | ImGuiTableFlags_NoBordersInBody;

        float tableHeight = ImGui::GetStyle().ItemSpacing.y + ImGui::GetStyle().FramePadding.y + ImGui::GetFrameHeightWithSpacing();
        ImGui::BeginChild("DesyncEntriesScrollBox", ImVec2(0, -tableHeight), false, ImGuiWindowFlags_HorizontalScrollbar);
        if (ImGui::BeginTable("", 5, flags))
        {
            ImGui::TableSetupColumn("Name", ImGuiTableColumnFlags_WidthStretch, 2.0f);
            ImGui::TableSetupColumn("Input ID", ImGuiTableColumnFlags_WidthFixed | ImGuiTableColumnFlags_NoResize, TEXT_BASE_WIDTH * 12.0f);
            ImGui::TableSetupColumn("HostFrame", ImGuiTableColumnFlags_WidthFixed | ImGuiTableColumnFlags_NoResize, TEXT_BASE_WIDTH * 12.0f);
            ImGui::TableSetupColumn("Client Value", ImGuiTableColumnFlags_WidthStretch, 1.0f);
            ImGui::TableSetupColumn("Server Value", ImGuiTableColumnFlags_WidthStretch, 1.0f);

            ImGui::TableHeadersRow();

            bool atRootLevel = true;

            for (auto elem = auditTrailElems.begin(); elem != auditTrailElems.end(); ++elem)
            {
                if (elem == auditTrailElems.begin() && elem->m_category != AuditCategory::Desync)
                {
                    ImGui::TableNextRow();
                    ImGui::TableNextColumn();
                    atRootLevel = !ImGui::TreeNodeEx("HEAD", ImGuiTreeNodeFlags_SpanFullWidth);
                    ImGui::TableNextColumn();
                    ImGui::TableNextColumn();
                    ImGui::TableNextColumn();
                    ImGui::TableNextColumn();
                }
                else if (!atRootLevel && elem != auditTrailElems.begin() && elem->m_category == AuditCategory::Desync)
                {
                    atRootLevel = true;
                    ImGui::TreePop();
                }

                if (!atRootLevel || elem->m_category == AuditCategory::Desync)
                {
                    ImGui::TableNextRow();
                    ImGui::TableNextColumn();

                    const char* nodeTitle = elem->m_category == AuditCategory::Desync
                        ? DESYNC_TITLE
                        : (elem->m_category == AuditCategory::Input ? INPUT_TITLE : EVENT_TITLE);

                    // Draw Events as a single line entry, they should only have one line item
                    if (elem->m_category == AuditCategory::Event)
                    {
                        if (elem->m_children.size() > 0 && elem->m_children.front().m_elements.size() > 0)
                        {
                            AZStd::pair<AZStd::string, AZStd::string> cliServValues =
                                elem->m_children.front().m_elements.front()->GetClientServerValues();
                            ImGui::TreeNodeEx(
                                AZStd::string::format(nodeTitle, elem->m_name.c_str()).c_str(),
                                (ImGuiTreeNodeFlags_Leaf | ImGuiTreeNodeFlags_NoTreePushOnOpen | ImGuiTreeNodeFlags_SpanFullWidth));
                            ImGui::TableNextColumn();
                            ImGui::Text("%hu", static_cast<unsigned short>(elem->m_inputId));
                            ImGui::TableNextColumn();
                            ImGui::Text("%d", static_cast<int>(elem->m_hostFrameId));
                            ImGui::TableNextColumn();
                            ImGui::Text("%s", cliServValues.first.c_str());
                            ImGui::TableNextColumn();
                            ImGui::Text("%s", cliServValues.second.c_str());

                        }
                    }
                    // Draw desyncs and inputs as a collapsable node, they can contain multiple line items
                    else if (ImGui::TreeNodeEx(
                            AZStd::string::format(nodeTitle, elem->m_name.c_str()).c_str(),
                            ImGuiTreeNodeFlags_SpanFullWidth))
                    {
                        atRootLevel = false;
                        ImGui::TableNextColumn();
                        ImGui::Text("%hu", static_cast<unsigned short>(elem->m_inputId));
                        ImGui::TableNextColumn();
                        ImGui::Text("%d", static_cast<int>(elem->m_hostFrameId));
                        ImGui::TableNextColumn();
                        ImGui::TableNextColumn();

                        for (const auto& child : elem->m_children)
                        {
                            ImGui::TableNextRow();
                            ImGui::TableNextColumn();
                            if (child.m_elements.size() > 0)
                            {
                                const ImGuiTableFlags childFlags = elem->m_category == AuditCategory::Desync
                                    ? ImGuiTreeNodeFlags_SpanFullWidth | ImGuiTreeNodeFlags_DefaultOpen
                                    : ImGuiTreeNodeFlags_SpanFullWidth;
                                if (ImGui::TreeNodeEx(child.m_name.c_str(), childFlags))
                                {
                                    ImGui::TableNextColumn();
                                    ImGui::TableNextColumn();
                                    ImGui::TableNextColumn();
                                    ImGui::TableNextColumn();
                                    for (const auto& childElem : child.m_elements)
                                    {
                                        AZStd::pair<AZStd::string, AZStd::string> cliServValues = childElem->GetClientServerValues();
                                        ImGui::TableNextRow();
                                        ImGui::TableNextColumn();
                                        ImGui::TreeNodeEx(
                                            childElem->GetName().c_str(),
                                            (ImGuiTreeNodeFlags_Leaf | ImGuiTreeNodeFlags_NoTreePushOnOpen |
                                             ImGuiTreeNodeFlags_SpanFullWidth));
                                        ImGui::TableNextColumn();
                                        ImGui::TableNextColumn();
                                        ImGui::TableNextColumn();
                                        ImGui::Text("%s", cliServValues.first.c_str());
                                        ImGui::TableNextColumn();
                                        ImGui::Text("%s", cliServValues.second.c_str());
                                    }
                                    ImGui::TreePop();
                                }
                            }
                            else
                            {
                                ImGui::Text("%s", child.m_name.c_str());
                                ImGui::TableNextColumn();
                                ImGui::TableNextColumn();
                                ImGui::TableNextColumn();
                                ImGui::TableNextColumn();
                            }
                        }
                        if (elem->m_category != AuditCategory::Desync)
                        {
                            ImGui::TreePop();
                        }
                    }
                    else
                    {
                        ImGui::TableNextColumn();
                        ImGui::Text("%hu", static_cast<unsigned short>(elem->m_inputId));
                        ImGui::TableNextColumn();
                        ImGui::Text("%d", static_cast<int>(elem->m_hostFrameId));
                        ImGui::TableNextColumn();
                        ImGui::TableNextColumn();
                        ImGui::TableNextRow();
                    }
                }
            }

            if (!atRootLevel)
            {
                // Make sure to pop back to root on the way out
                ImGui::TreePop();
            }

            ImGui::EndTable();
            ImGui::NewLine();
        }
        ImGui::EndChild();
#endif
    }

    void MultiplayerDebugAuditTrail::UpdateDebugOverlay()
    {
        if (m_debugDisplay == nullptr)
        {
            AzFramework::DebugDisplayRequestBus::BusPtr debugDisplayBus;
            AzFramework::DebugDisplayRequestBus::Bind(debugDisplayBus, AzFramework::g_defaultSceneEntityDebugDisplayId);
            m_debugDisplay = AzFramework::DebugDisplayRequestBus::FindFirstHandler(debugDisplayBus);
        }

        if (m_debugDisplay)
        {
            const AZ::u32 stateBefore = m_debugDisplay->GetState();
            m_debugDisplay->SetColor(AZ::Colors::White);

            m_debugDisplay->SetState(stateBefore);
        }
    }

    bool MultiplayerDebugAuditTrail::TryPumpAuditTrail()
    {
        bool canPump = m_canPumpTrail;
        m_canPumpTrail = false;
        return canPump;
    }
}