Merge pull request #5820 from aws-lumberyard-dev/LYN-8025_PipeEditorServerLogsToEditor

Pipe Editor-Server Logs Back to the Editor

Code/Framework/AzFramework/AzFramework/Process/ProcessCommunicatorTracePrinter.cpp

@@ -0,0 +1,87 @@
+/*
+ * 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 "ProcessCommunicatorTracePrinter.h"
+
+
+ProcessCommunicatorTracePrinter::ProcessCommunicatorTracePrinter(AzFramework::ProcessCommunicator* communicator, const char* window) :
+    m_communicator(communicator),
+    m_window(window)
+{
+    m_stringBeingConcatenated.reserve(1024);
+}
+
+ProcessCommunicatorTracePrinter::~ProcessCommunicatorTracePrinter()
+{
+    // flush stdout
+    WriteCurrentString(false);
+    
+    // flush stderr
+    WriteCurrentString(true);
+}
+
+void ProcessCommunicatorTracePrinter::Pump()
+{
+    if (m_communicator->IsValid())
+    {
+        // Don't call readOutput unless there is output or else it will block...
+        while (m_communicator->PeekOutput())
+        {
+            AZ::u32 readSize = m_communicator->ReadOutput(m_streamBuffer, AZ_ARRAY_SIZE(m_streamBuffer));
+            ParseDataBuffer(readSize, false);
+        }
+        while (m_communicator->PeekError())
+        {
+            AZ::u32 readSize = m_communicator->ReadError(m_streamBuffer, AZ_ARRAY_SIZE(m_streamBuffer));
+            ParseDataBuffer(readSize, true);
+        }
+    }
+}
+
+void ProcessCommunicatorTracePrinter::ParseDataBuffer(AZ::u32 readSize, bool isFromStdErr)
+{
+    if (readSize > AZ_ARRAY_SIZE(m_streamBuffer))
+    {
+        AZ_ErrorOnce("ERROR", false, "Programmer bug:  Read size is overflowing in traceprintf communicator.");
+        return;
+    }
+
+    // we cannot write the string to the same buffer, as stdError and stdOut are different streams and could
+    // have different cutting points as buffers empty.
+    AZStd::string& bufferToUse = isFromStdErr ? m_errorStringBeingConcatenated : m_stringBeingConcatenated;
+
+    for (size_t pos = 0; pos < readSize; ++pos)
+    {
+        if ((m_streamBuffer[pos] == '\n') || (m_streamBuffer[pos] == '\r'))
+        {
+            WriteCurrentString(isFromStdErr);
+        }
+        else
+        {
+            bufferToUse.push_back(m_streamBuffer[pos]);
+        }
+    }
+}
+
+void ProcessCommunicatorTracePrinter::WriteCurrentString(bool isFromStdErr)
+{
+    AZStd::string& bufferToUse = isFromStdErr ? m_errorStringBeingConcatenated : m_stringBeingConcatenated;
+
+    if (!bufferToUse.empty())
+    {
+        if (isFromStdErr)
+        {
+            AZ_Error(m_window.c_str(), false, "%s", bufferToUse.c_str());
+        }
+        else
+        {
+            AZ_TracePrintf(m_window.c_str(), "%s", bufferToUse.c_str());
+        }
+        bufferToUse.clear();
+    }
+}

Code/Framework/AzFramework/AzFramework/Process/ProcessCommunicatorTracePrinter.h

@@ -0,0 +1,36 @@
+/*
+ * 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
+ *
+ */
+
+#pragma once
+
+#include <AzFramework/Process/ProcessCommunicator.h>
+
+//! ProcessCommunicatorTracePrinter listens to stderr and stdout of a running process and writes its output to the AZ_Trace system
+//! Importantly, it does not do any blocking operations.
+class ProcessCommunicatorTracePrinter
+{
+public:
+    ProcessCommunicatorTracePrinter(AzFramework::ProcessCommunicator* communicator, const char* window);
+    ~ProcessCommunicatorTracePrinter();
+
+    //! Call this periodically to drain the buffers and write them.
+    void Pump();
+
+    //! Drains the buffer into the string that's being built, then traces the string when it hits a newline.
+    void ParseDataBuffer(AZ::u32 readSize, bool isFromStdErr);
+
+    //! Prints the current buffer to AZ_Error or AZ_TracePrintf so that it can be picked up by AZ::Debug::Trace
+    void WriteCurrentString(bool isFromStdError);
+
+private:
+    AZStd::string m_window;
+    AzFramework::ProcessCommunicator* m_communicator;
+    char m_streamBuffer[128];
+    AZStd::string m_stringBeingConcatenated;
+    AZStd::string m_errorStringBeingConcatenated;
+};

Code/Framework/AzFramework/AzFramework/azframework_files.cmake

@@ -277,6 +277,8 @@ set(FILES
     Process/ProcessWatcher.cpp
     Process/ProcessWatcher.h
     Process/ProcessCommon_fwd.h
+    Process/ProcessCommunicatorTracePrinter.cpp
+    Process/ProcessCommunicatorTracePrinter.h
     ProjectManager/ProjectManager.h
     ProjectManager/ProjectManager.cpp
     Render/GameIntersectorComponent.h