From 2fbab9a7b7063970b39acda6983a778a15a29922 Mon Sep 17 00:00:00 2001 From: "Nuno \"Omega Leo\" Diogo" Date: Sun, 14 Dec 2025 16:27:48 +0000 Subject: [PATCH] Fixed DocumentationHelper package dependencies --- .../OmegaLeo.HelperLib.Changelog.csproj | 2 +- ...OmegaLeo.HelperLib.ChangelogHandler.csproj | 4 + .../OmegaLeo.HelperLib.ConsoleApp.csproj | 4 + .../Controllers/HomeController.cs | 214 +++++++++++++++++- OmegaLeo.HelperLib.Web/Program.cs | 4 + OmegaLeo.HelperLib.sln.DotSettings.user | 2 + 6 files changed, 220 insertions(+), 10 deletions(-) diff --git a/OmegaLeo.HelperLib.Changelog/OmegaLeo.HelperLib.Changelog.csproj b/OmegaLeo.HelperLib.Changelog/OmegaLeo.HelperLib.Changelog.csproj index b630f41..59f998f 100644 --- a/OmegaLeo.HelperLib.Changelog/OmegaLeo.HelperLib.Changelog.csproj +++ b/OmegaLeo.HelperLib.Changelog/OmegaLeo.HelperLib.Changelog.csproj @@ -19,7 +19,7 @@ - + diff --git a/OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj b/OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj index 5550538..762352a 100644 --- a/OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj +++ b/OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj @@ -13,4 +13,8 @@ + + + + diff --git a/OmegaLeo.HelperLib.ConsoleApp/OmegaLeo.HelperLib.ConsoleApp.csproj b/OmegaLeo.HelperLib.ConsoleApp/OmegaLeo.HelperLib.ConsoleApp.csproj index ca1ddff..9332042 100644 --- a/OmegaLeo.HelperLib.ConsoleApp/OmegaLeo.HelperLib.ConsoleApp.csproj +++ b/OmegaLeo.HelperLib.ConsoleApp/OmegaLeo.HelperLib.ConsoleApp.csproj @@ -13,4 +13,8 @@ + + + + diff --git a/OmegaLeo.HelperLib.Web/Controllers/HomeController.cs b/OmegaLeo.HelperLib.Web/Controllers/HomeController.cs index 3eec54e..88f7524 100644 --- a/OmegaLeo.HelperLib.Web/Controllers/HomeController.cs +++ b/OmegaLeo.HelperLib.Web/Controllers/HomeController.cs @@ -1,9 +1,12 @@ // File: `OmegaLeo.HelperLib.Web/Controllers/HomeController.cs` + using System.Diagnostics; using System.Reflection; +using System.Runtime.ExceptionServices; using GameDevLibrary.Helpers; using Microsoft.AspNetCore.Mvc; using NetFlow.DocumentationHelper.Library.Helpers; +using NetFlow.DocumentationHelper.Library.Models; using OmegaLeo.HelperLib.Changelog.Tools; using OmegaLeo.HelperLib.Web.Models; @@ -76,17 +79,209 @@ public class HomeController : Controller return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier }); } - private LibraryDocumentationViewModel GenerateLibraryDocs(Assembly assembly, string changelogPath, string displayName, string description, string nugetPackageId) + private void LogDocumentationHelperInfo() { try { - var allDocumentation = DocumentationHelperTool.GenerateDocumentation(); + var assemblies = AppDomain.CurrentDomain.GetAssemblies(); + var target = assemblies.FirstOrDefault(a => + a.GetName().Name.Equals("NetFlow.DocumentationHelper.Library", StringComparison.OrdinalIgnoreCase)); + + if (target == null) + { + _logger.LogWarning("NetFlow.DocumentationHelper.Library not loaded. Loaded assemblies ({Count}):", + assemblies.Length); + foreach (var a in assemblies.OrderBy(a => a.GetName().Name)) + { + _logger.LogInformation(" {Name} {Version} => {Location}", a.GetName().Name, a.GetName().Version, + SafeLocation(a)); + } + + return; + } + + _logger.LogInformation("Found {Name} {Version} at {Location}", target.GetName().Name, + target.GetName().Version, SafeLocation(target)); + + Type attrType = null; + try + { + attrType = target.GetType("NetFlow.DocumentationHelper.Library.Attributes.DocumentationAttribute", + false, true); + } + catch (Exception ex) + { + _logger.LogWarning(ex, "Failed to GetType for DocumentationAttribute in {Assembly}", + target.GetName().Name); + } + + if (attrType == null) + { + _logger.LogWarning("Type 'DocumentationAttribute' not found in {Assembly}.", target.GetName().Name); + } + else + { + var ctors = attrType.GetConstructors(BindingFlags.Public | BindingFlags.Instance | + BindingFlags.NonPublic); + if (!ctors.Any()) + _logger.LogWarning("No constructors found on DocumentationAttribute in {Assembly}.", + target.GetName().Name); + foreach (var ctor in ctors) + { + var sig = string.Join(", ", ctor.GetParameters().Select(p => p.ParameterType.Name + " " + p.Name)); + _logger.LogInformation("DocumentationAttribute ctor: ({Signature})", sig); + } + } + } + catch (Exception ex) + { + _logger.LogError(ex, "Failed to log DocumentationHelper assembly info."); + } + + static string SafeLocation(Assembly a) + { + try + { + return string.IsNullOrEmpty(a.Location) ? "" : a.Location; + } + catch + { + return ""; + } + } + } + + private void InspectDocumentationHelperMethod() + { + try + { + var assemblies = AppDomain.CurrentDomain.GetAssemblies(); + Type helperType = null; + foreach (var asm in assemblies) + { + try + { + var t = asm.GetTypes().FirstOrDefault(tt => + tt.Name.Equals("DocumentationHelperTool", StringComparison.OrdinalIgnoreCase) + || tt.FullName?.EndsWith(".DocumentationHelperTool") == true); + if (t != null) + { + helperType = t; + break; + } + } + catch (ReflectionTypeLoadException rtlex) + { + _logger.LogDebug(rtlex, "Could not enumerate types in {Assembly}", asm.GetName().Name); + foreach (var loaderEx in rtlex.LoaderExceptions ?? Array.Empty()) + _logger.LogDebug(loaderEx, "Loader exception for {Assembly}", asm.GetName().Name); + } + catch (Exception ex) + { + _logger.LogDebug(ex, "Failed enumerating types in {Assembly}", asm.GetName().Name); + } + } + + if (helperType == null) + { + _logger.LogWarning("DocumentationHelperTool type not found in loaded assemblies."); + return; + } + + _logger.LogInformation("DocumentationHelperTool found: {Type} in {Assembly} ({Location})", + helperType.FullName, helperType.Assembly.GetName().Name, SafeLocation(helperType.Assembly)); + + var method = helperType.GetMethod("GenerateDocumentation", + BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance); + if (method == null) + { + _logger.LogWarning("GenerateDocumentation method not found on {Type}.", helperType.FullName); + } + else + { + var parameters = string.Join(", ", + method.GetParameters().Select(p => p.ParameterType.Name + " " + p.Name)); + _logger.LogInformation("Method: {Name} ({Parameters}) -> {ReturnType}", method.Name, parameters, + method.ReturnType.FullName); + } + } + catch (Exception ex) + { + _logger.LogError(ex, "Failed to inspect DocumentationHelperTool type/method."); + } + + static string SafeLocation(Assembly a) + { + try + { + return string.IsNullOrEmpty(a.Location) ? "" : a.Location; + } + catch + { + return ""; + } + } + } + + private LibraryDocumentationViewModel GenerateLibraryDocs(Assembly assembly, string changelogPath, + string displayName, string description, string nugetPackageId) + { + // diagnostics before calling into the library + LogDocumentationHelperInfo(); + + IEnumerable allDocumentation = Enumerable.Empty(); + try + { + // Call inside try so we can capture MethodNotFound and log diagnostics + var result = DocumentationHelperTool.GenerateDocumentation(); + // prefer safe cast / defensive assignment + allDocumentation = (result as IEnumerable) ?? + (result is IEnumerable e ? e : Enumerable.Empty()); + } + catch (MissingMethodException mmex) + { + _logger.LogError(mmex, + "Missing method when calling DocumentationHelperTool.GenerateDocumentation(). Possible assembly mismatch."); + InspectDocumentationHelperMethod(); + // rethrow so debugger still sees the original error + ExceptionDispatchInfo.Capture(mmex).Throw(); + } + catch (Exception ex) + { + _logger.LogError(ex, "DocumentationHelperTool.GenerateDocumentation threw an exception."); + InspectDocumentationHelperMethod(); + throw; + } + + try + { var assemblyName = assembly.GetName().Name; - var filteredDocumentation = allDocumentation - .Where(d => d.AssemblyName.Equals(assemblyName, StringComparison.OrdinalIgnoreCase)) - .OrderBy(d => d.ClassName) - .ToList(); + List filteredDocumentation = allDocumentation + .Where(d => + { + try + { + var prop = d.GetType().GetProperty("AssemblyName"); + return prop != null && string.Equals(prop.GetValue(d)?.ToString(), assemblyName, + StringComparison.OrdinalIgnoreCase); + } + catch + { + return false; + } + }) + .OrderBy(d => + { + try + { + return d.GetType().GetProperty("ClassName")?.GetValue(d)?.ToString() ?? ""; + } + catch + { + return ""; + } + }).ToList(); string changelogMarkdown = ""; if (System.IO.File.Exists(changelogPath)) @@ -94,7 +289,8 @@ public class HomeController : Controller changelogMarkdown = ChangelogTool.GetMarkdown(assembly); } - string version = assembly.GetCustomAttribute()?.InformationalVersion + string version = assembly.GetCustomAttribute() + ?.InformationalVersion ?? assembly.GetName().Version?.ToString() ?? "1.0.0"; @@ -115,7 +311,7 @@ public class HomeController : Controller } catch (Exception e) { - Console.WriteLine($"Failed to Generate Library Docs for {assembly.FullName}: {e.Message}"); + _logger.LogError(e, "Failed to process documentation for {Assembly}", assembly.FullName); return new LibraryDocumentationViewModel(); } } @@ -125,4 +321,4 @@ public class HomeController : Controller { return Assembly.GetEntryAssembly().Location; } -} +} \ No newline at end of file diff --git a/OmegaLeo.HelperLib.Web/Program.cs b/OmegaLeo.HelperLib.Web/Program.cs index 5cd7c7e..56339e9 100644 --- a/OmegaLeo.HelperLib.Web/Program.cs +++ b/OmegaLeo.HelperLib.Web/Program.cs @@ -3,6 +3,10 @@ var builder = WebApplication.CreateBuilder(args); // Add services to the container. builder.Services.AddControllersWithViews(); +// Configure logging +builder.Logging.ClearProviders(); +builder.Logging.AddConsole(); + var app = builder.Build(); // Configure the HTTP request pipeline. diff --git a/OmegaLeo.HelperLib.sln.DotSettings.user b/OmegaLeo.HelperLib.sln.DotSettings.user index b792ae4..eb58d7e 100644 --- a/OmegaLeo.HelperLib.sln.DotSettings.user +++ b/OmegaLeo.HelperLib.sln.DotSettings.user @@ -1,7 +1,9 @@  ForceIncluded + ForceIncluded ForceIncluded ForceIncluded + ForceIncluded ForceIncluded ForceIncluded ForceIncluded