Add option to write responses from web browser to log for debugging p…

…urposes
joshua-software-dev · Aug 8, 2023 · 025a235 · 025a235
1 parent 6f581fa
commit 025a235
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 10 deletions.
diff --git a/LMeter/src/Cactbot/TotallyNotCefCactbotHttpSource.cs b/LMeter/src/Cactbot/TotallyNotCefCactbotHttpSource.cs
@@ -26,6 +26,7 @@ public class TotallyNotCefCactbotHttpSource : IDisposable
     private readonly IinactCactbotClient _iinactCactbotClient;
     private readonly CancellationTokenSource _cancelTokenSource;
     private readonly bool _enableAudio;
+    private readonly bool _enableVerboseResponseLogging;
     private readonly HttpClient _httpClient;
     private readonly HtmlParser _htmlParser;
     private readonly string _httpUrl;
@@ -46,7 +47,8 @@ public TotallyNotCefCactbotHttpSource
         bool bypassWebSocket,
         string cactbotUrl,
         ushort httpPort,
-        bool enableAudio
+        bool enableAudio,
+        bool enableVerboseResponseLogging
     )
     {
         CactbotState = new ();
@@ -72,6 +74,7 @@ bool enableAudio
 
         _cancelTokenSource = new ();
         _enableAudio = enableAudio;
+        _enableVerboseResponseLogging = enableVerboseResponseLogging;
         _htmlParser = new ();
         _httpPort = httpPort;
         _httpUrl = $"http://127.0.0.1:{httpPort}";
@@ -163,8 +166,14 @@ private async Task GetCactbotHtml()
 
             var response = await _httpClient.GetAsync(_httpUrl, cancellationToken: _cancelTokenSource.Token);
             if (response.Content == null) return;
+
             var rawHtml = await response.Content.ReadAsStringAsync(_cancelTokenSource.Token);
             if (rawHtml == null) return;
+            if (_enableVerboseResponseLogging)
+            {
+                PluginLog.LogInformation(rawHtml);
+            }
+
             _parsedResponse = await _htmlParser.ParseDocumentAsync(rawHtml, _cancelTokenSource.Token);
             CactbotState.UpdateState(_parsedResponse);
             ConnectionState = TotallyNotCefConnectionState.Connected;

diff --git a/LMeter/src/Config/CactbotConfig.cs b/LMeter/src/Config/CactbotConfig.cs
@@ -27,6 +27,7 @@ public class CactbotConfig : IConfigPage, IDisposable
     public string CactbotUrl = MagicValues.DefaultCactbotUrl;
     public int HttpPort = 8080;
     public bool BypassCactbotWebSocketUsingIPC = true;
+    public bool LogAllResponsesFromBackgroundWebBrowser = false;
 
     public bool RaidbossEnableAudio = true;
     public int RaidbossInCombatPollingRate = 10;
@@ -74,7 +75,8 @@ public void SetNewCactbotUrl(bool forceStart)
                     BypassCactbotWebSocketUsingIPC,
                     CactbotUrl,
                     (ushort) HttpPort,
-                    RaidbossEnableAudio
+                    RaidbossEnableAudio,
+                    LogAllResponsesFromBackgroundWebBrowser
                 );
                 this.Cactbot.StartBackgroundPollingThread(forceStart);
             }
@@ -268,7 +270,7 @@ private void DrawConnectionSettings(Vector2 windowSize)
         using var connectionScope = new DrawChildScope
         (
             "##ConnectionSettings",
-            windowSize with { X = windowSize.X * 0.94f, Y = 85 + (this.EnableConnection ? 166 : 0) },
+            windowSize with { X = windowSize.X * 0.94f, Y = 85 + (this.EnableConnection ? 225 : 0) },
             true
         );
         if (!connectionScope.Success) return;
@@ -397,6 +399,15 @@ private void DrawConnectionSettings(Vector2 windowSize)
             {
                 this.RaidbossOutOfCombatPollingRate = tempOutRate;
             }
+
+            ImGui.Separator();
+            ImGui.Text("Connection Debug Options");
+            ImGui.Separator();
+            ImGui.Checkbox
+            (
+                "Log all responses from browser [WARNING: HIGH PERFORMANCE IMPACT]",
+                ref LogAllResponsesFromBackgroundWebBrowser
+            );
         }
     }
 

diff --git a/Version/Version.csproj b/Version/Version.csproj
@@ -1,5 +1,5 @@
 <Project>
     <PropertyGroup>
-        <PluginVersion>0.2.0.17</PluginVersion>
+        <PluginVersion>0.2.0.18</PluginVersion>
     </PropertyGroup>
 </Project>
diff --git a/deps/txt/changelog.md b/deps/txt/changelog.md
@@ -1,3 +1,7 @@
+# Version 0.2.0.18
+- Add option to write all responses from background web browser to log file for
+  debugging purposes.
+
 # Version 0.2.0.17
 - More aggressively catch errors during basic handshake to ensure plugin never
   crashes even when communicating with out of date background web browser

diff --git a/repo.json b/repo.json
@@ -25,8 +25,8 @@
         "Name": "LMeter",
         "Description": "Plugin to display ACT combat log data. Now with Cactbot integration!",
         "InternalName": "LMeter",
-        "AssemblyVersion": "0.2.0.17",
-        "TestingAssemblyVersion": "0.2.0.17",
+        "AssemblyVersion": "0.2.0.18",
+        "TestingAssemblyVersion": "0.2.0.18",
         "RepoUrl": "https://github.com/joshua-software-dev/LMeter",
         "ApplicableVersion": "any",
         "DalamudApiLevel": 8,
@@ -35,10 +35,10 @@
         "DownloadCount": 0,
         "LastUpdate": 0,
         "LoadPriority": 69420,
-        "DownloadLinkInstall": "https://github.com/joshua-software-dev/LMeter/releases/download/v0.2.0.17/latest.zip",
-        "DownloadLinkTesting": "https://github.com/joshua-software-dev/LMeter/releases/download/v0.2.0.17/latest.zip",
-        "DownloadLinkUpdate": "https://github.com/joshua-software-dev/LMeter/releases/download/v0.2.0.17/latest.zip",
+        "DownloadLinkInstall": "https://github.com/joshua-software-dev/LMeter/releases/download/v0.2.0.18/latest.zip",
+        "DownloadLinkTesting": "https://github.com/joshua-software-dev/LMeter/releases/download/v0.2.0.18/latest.zip",
+        "DownloadLinkUpdate": "https://github.com/joshua-software-dev/LMeter/releases/download/v0.2.0.18/latest.zip",
         "IconUrl": "https://raw.githubusercontent.com/joshua-software-dev/LMeter/master/deps/img/icon.png",
-        "Changelog": "# Version 0.2.0.17\n- More aggressively catch errors during basic handshake to ensure plugin never\n  crashes even when communicating with out of date background web browser\n  versions."
+        "Changelog": "# Version 0.2.0.18\n- Add option to write all responses from background web browser to log file for\n  debugging purposes."
     }
 ]