Add logging and crash handling

Author: yogwoggf

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0] - 2024-12-27
+
+### Added
+
+- Added logging to better troubleshoot issues.
+
 ## [1.1.0] - 2024-12-26
 
 ### Changed

CMakeLists.txt

@@ -52,6 +52,10 @@ add_executable(gelly_installer WIN32
         src/gui/popups/fatal-error.cpp
         src/helpers/launch-gmod.cpp
         src/helpers/launch-gmod.hpp
+        src/logging/log.hpp
+        src/logging/log.cpp
+        src/logging/crash-logging.cpp
+        src/logging/crash-logging.hpp
 )
 
 target_link_libraries(gelly_installer

src/curl.cpp

@@ -1,13 +1,23 @@
 #include "curl.hpp"
 
+#include "logging/log.hpp"
+
 namespace gelly {
 namespace {
 constexpr auto USER_AGENT = "gelly-installer/1.0";
 }
-Curl::Curl() { curl_global_init(CURL_GLOBAL_ALL); }
-Curl::~Curl() { curl_global_cleanup(); }
+Curl::Curl() {
+  Log::Info("Initializing CURL");
+  curl_global_init(CURL_GLOBAL_ALL);
+}
+
+Curl::~Curl() {
+  Log::Info("Shutting down CURL");
+  curl_global_cleanup();
+}
 
 std::shared_ptr<Response> Curl::Get(const std::string &url) const {
+  Log::Info("Performing GET request to '{}'", url);
   const auto handle = curl_easy_init();
   if (!handle) {
     return nullptr;
@@ -25,6 +35,8 @@ std::shared_ptr<Response> Curl::Get(const std::string &url) const {
 
   const auto code = curl_easy_perform(handle);
   if (code != CURLE_OK) {
+    Log::Error("Failed to perform GET request to '{}': {}", url,
+               curl_easy_strerror(code));
     response->responseCode = code;
   } else {
     curl_easy_getinfo(handle, CURLINFO_RESPONSE_CODE, &response->responseCode);

src/gui.cpp

@@ -1,5 +1,7 @@
 #include "gui.hpp"
 
+#include "logging/log.hpp"
+
 #include <backends/imgui_impl_sdl2.h>
 #include <backends/imgui_impl_sdlrenderer2.h>
 #include <imgui.h>
@@ -63,12 +65,15 @@ void GUI::InitializeImGUI() const {
 
   ImGui_ImplSDL2_InitForSDLRenderer(window->GetWindow(), window->GetRenderer());
   ImGui_ImplSDLRenderer2_Init(window->GetRenderer());
+
+  Log::Info("Initialized ImGUI");
 }
 
 void GUI::ShutdownImGUI() {
   ImGui_ImplSDLRenderer2_Shutdown();
   ImGui_ImplSDL2_Shutdown();
   ImGui::DestroyContext();
+  Log::Info("Shutdown ImGUI");
 }
 
 } // namespace gelly

src/gui/main-installer-window.cpp

@@ -7,6 +7,7 @@
 #include "install/get-latest-gelly.hpp"
 #include "install/install-gelly.hpp"
 #include "install/uninstall-gelly.hpp"
+#include "logging/log.hpp"
 
 #include <imgui.h>
 
@@ -17,7 +18,14 @@ constexpr auto HEADER = "Gelly Installer";
 
 MainInstallerWindow::MainInstallerWindow(std::shared_ptr<Curl> curl)
     : curl(std::move(curl)), latestGellyInfo(GetLatestGellyInfo(this->curl)) {
+  Log::Info("Latest Gelly version: {}",
+            latestGellyInfo.has_value() ? latestGellyInfo->version : "N/A");
+
   DetectGellyInstallation();
+  Log::Info("Gelly installation detected: {}",
+            gellyInstallation.has_value() ? "yes" : "no");
+  Log::Info("Gelly version: {}",
+            gellyInstallation.has_value() ? gellyInstallation->version : "N/A");
 }
 
 void MainInstallerWindow::Render() {
@@ -58,6 +66,7 @@ void MainInstallerWindow::Render() {
     ImGui::TextColored(ImVec4(0.1f, 0.8f, 0.1f, 1.0f), "%s",
                        gellyInstallation->version.c_str());
   }
+
   ImGui::Separator();
   ImGui::PopFont();
 
@@ -117,6 +126,8 @@ void MainInstallerWindow::DetectGellyInstallation() {
     return;
   }
 
+  Log::Info("Garry's Mod directory: {}", gmodPath->string());
+  Log::Info("Steam directory: {}", steamPath->string());
   gellyInstallation = gelly::DetectGellyInstallation(*gmodPath);
 }
 

src/install/get-latest-gelly.cpp

@@ -1,4 +1,7 @@
 #include "get-latest-gelly.hpp"
+
+#include "logging/log.hpp"
+
 #include <nlohmann/json.hpp>
 
 namespace gelly {
@@ -11,6 +14,8 @@ std::optional<LatestGellyInfo>
 GetLatestGellyInfo(const std::shared_ptr<Curl> &curl) {
   const auto response = curl->Get(LATEST_RELEASE_URL);
   if (response->responseCode != 200) {
+    Log::Error("Failed to get latest Gelly release info: status code {}",
+               response->responseCode);
     return std::nullopt;
   }
 

src/install/install-gelly.cpp

@@ -2,6 +2,7 @@
 
 #include "helpers/find-gmod-directory.hpp"
 #include "helpers/find-steam-directory.hpp"
+#include "logging/log.hpp"
 #include "uninstall-gelly.hpp"
 
 #include <fstream>
@@ -47,8 +48,10 @@ void ExtractReleaseToDir(const std::filesystem::path &dir,
     throw std::runtime_error("Failed to open zip archive.");
   }
 
+  Log::Info("Extracting Gelly release to {}", dir.string());
   try {
     zip_int64_t numFiles = zip_get_num_files(archive);
+    Log::Info("Extracting {} files from zip archive.", numFiles);
     for (zip_int64_t i = 0; i < numFiles; i++) {
       auto *file = zip_fopen_index(archive, i, 0);
       if (!file) {
@@ -94,22 +97,27 @@ void ExtractReleaseToDir(const std::filesystem::path &dir,
       zip_fclose(file);
     }
   } catch (...) {
+    Log::Error("Failed to extract Gelly release.");
     zip_discard(archive);
     throw;
   }
 
   zip_discard(archive);
+  Log::Info("Extracted Gelly release to {}", dir.string());
 }
 } // namespace
 
 void InstallGelly(const LatestGellyInfo &info,
                   const std::shared_ptr<Curl> &curl,
                   std::optional<GellyInstallation> priorInstallation) {
+  Log::Info("Installing Gelly version {}", info.version);
   if (priorInstallation.has_value()) {
     UninstallGelly(*priorInstallation);
+    Log::Info("Uninstalled prior Gelly installation.");
   }
 
   const auto release = DownloadRelease(info.downloadUrl, curl);
+  Log::Info("Downloading Gelly release.");
   if (release.IsEmpty()) {
     throw std::runtime_error("Failed to download Gelly release.");
   }
@@ -120,6 +128,7 @@ void InstallGelly(const LatestGellyInfo &info,
     throw std::runtime_error("Failed to find Garry's Mod directory.");
   }
 
+  Log::Info("Extracting Gelly release to Garry's Mod directory.");
   ExtractReleaseToDir(*gmodDir, release);
 }
 

src/install/uninstall-gelly.cpp

@@ -1,8 +1,11 @@
 #include "uninstall-gelly.hpp"
 
+#include "logging/log.hpp"
+
 namespace gelly {
 void UninstallGelly(const GellyInstallation &installation) {
   remove_all(installation.addonPath);
   remove(installation.binaryModulePath);
+  Log::Info("Uninstalled Gelly at {}", installation.addonPath.string());
 }
 } // namespace gelly

src/logging/crash-logging.cpp

@@ -0,0 +1,49 @@
+#include "crash-logging.hpp"
+
+#include "log.hpp"
+
+#include <Windows.h>
+
+namespace gelly {
+namespace {
+// ReSharper disable once CppParameterMayBeConstPtrOrRef
+LONG CrashHandler(_EXCEPTION_POINTERS *info) {
+  Log::Error("Crash detected, writing crash dump");
+
+  Log::Error("RIP: 0x{:X}", info->ContextRecord->Rip);
+  Log::Error("RSP: 0x{:X}", info->ContextRecord->Rsp);
+  Log::Error("RBP: 0x{:X}", info->ContextRecord->Rbp);
+  Log::Error("RAX: 0x{:X}", info->ContextRecord->Rax);
+  Log::Error("RBX: 0x{:X}", info->ContextRecord->Rbx);
+  Log::Error("RCX: 0x{:X}", info->ContextRecord->Rcx);
+
+  switch (info->ExceptionRecord->ExceptionCode) {
+  case EXCEPTION_ACCESS_VIOLATION:
+    Log::Error("Access violation");
+    Log::Error("Attempted to {}", info->ExceptionRecord->ExceptionInformation[0]
+                                      ? "write"
+                                      : "read");
+    Log::Error("Address: 0x{:X}",
+               info->ExceptionRecord->ExceptionInformation[1]);
+    break;
+  case 0xE06D7363: {
+    Log::Error("C++ exception");
+    const auto exception = reinterpret_cast<std::exception *>(
+        info->ExceptionRecord->ExceptionInformation[1]);
+    Log::Error("Exception: {}", exception->what());
+  } break;
+  default:
+    Log::Error("Unknown exception code: 0x{:X}",
+               info->ExceptionRecord->ExceptionCode);
+  }
+
+  Log::SaveToFile();
+
+  return EXCEPTION_CONTINUE_SEARCH;
+}
+} // namespace
+
+void SetupCrashLogging() { AddVectoredExceptionHandler(1, CrashHandler); }
+void ShutdownCrashLogging() { RemoveVectoredExceptionHandler(CrashHandler); }
+
+} // namespace gelly

src/logging/crash-logging.hpp

@@ -0,0 +1,6 @@
+#pragma once
+
+namespace gelly {
+void SetupCrashLogging();
+void ShutdownCrashLogging();
+} // namespace gelly