Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Customizing the error grid page #223

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Customizing the error grid page #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d6caa7
Added the possibility to add custom headers to the error grid page an…
IhorSysak Jul 17, 2023
7d4105f
removed useless methods
IhorSysak Jul 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/StackExchange.Exceptional.Shared/Internal/ExceptionalSettingsBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,18 @@ public void Register(IErrorNotifier notifier)
/// </summary>
public Action<Exception, Dictionary<string, string>> GetCustomData { get; set; }

/// <summary>
/// Method to filter errors.
/// The method takes an `Error` object as input and returns a boolean value indicating whether the object should be filtered.
/// </summary>
public Func<Error, bool> FilterDataInErrorGrid { get; set; }

/// <summary>
/// Method to get the default columns for a list of strings.
/// The list of strings can be manipulated to remove or add columns.
/// </summary>
public Action<List<string>> GetColumns { get; set; }

/// <summary>
/// Settings for the rendering of pages.
/// </summary>
Expand Down
115 changes: 76 additions & 39 deletions src/StackExchange.Exceptional.Shared/Pages/ErrorListPage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using StackExchange.Exceptional.Internal;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
Expand All @@ -22,7 +23,14 @@ public class ErrorListPage : WebPage
public ErrorListPage(ErrorStore store, ExceptionalSettingsBase settings, string baseURL, List<Error> errors)
: base(null, settings, store, baseURL, "Error Log")
{
Errors = errors.OrderByDescending(e => e.LastLogDate ?? e.CreationDate).ToList();
if (Settings.FilterDataInErrorGrid != null)
{
Errors = errors.Where(settings.FilterDataInErrorGrid).ToList();
}
else
{
Errors = errors.OrderByDescending(e => e.LastLogDate ?? e.CreationDate).ToList();
}
}

/// <summary>
Expand Down Expand Up @@ -64,6 +72,10 @@ protected override void RenderInnerHtml(StringBuilder sb)
}
else
{
var headers = new List<string>()
{
"Type", "Error", "Url", "Remote IP", "Time", "Site", "Server"
};
var last = Errors.FirstOrDefault(); // oh the irony
sb.Append(" <h1>")
.Append("<span class=\"js-error-count\">")
Expand All @@ -77,17 +89,55 @@ protected override void RenderInnerHtml(StringBuilder sb)
.AppendLine(@" <table class=""js-error-list hover alt-rows error-list"">
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Error</th>
<th>Url</th>
<th>Remote IP</th>
<th>Time</th>
<th>Site</th>
<th>Server</th>
</tr>
<th></th>");

Settings.GetColumns?.Invoke(headers);

foreach (var header in headers)
{
sb.AppendLine($" <th>{header}</th>");
}

var displayLogic = new Dictionary<string, Action<Error, StringBuilder>>()
{
{ "Type", (e, sb) => sb.Append(" <td title=\"").AppendHtmlEncode(e.Type).Append("\">")
.AppendHtmlEncode(e.Type.ToShortTypeName())
.AppendLine("</td>") },
{ "Error", (e, sb) => {
sb.Append(" <td class=\"wrap\"><a href=\"").Append(Url(KnownRoutes.Info)).Append("?guid=").Append(e.GUID.ToString())
.Append("\">").Append(e.Message.HasValue() ? e.Message.EncodeTruncateWithEllipsis(250) : "(no message)").Append("</a>");
if (e.DuplicateCount > 1)
{
sb.Append(" <span class=\"duplicate-count\" title=\"number of similar errors occurring close to this error\">(")
.Append(e.DuplicateCount.ToString())
.Append(")</span>");
}
sb.AppendLine("</td>");
} },
{ "Url", (e, sb) => {
sb.Append(" <td>");
if (e.UrlPath.HasValue())
{
sb.Append("<span title=\"").AppendHtmlEncode(e.Host).AppendHtmlEncode(e.UrlPath).Append("\">")
.Append(e.UrlPath.EncodeTruncateWithEllipsis(40))
.Append("</span>");
}
sb.AppendLine("</td>");
} },
{ "Remote IP", (e, sb) => sb.Append(" <td>").AppendHtmlEncode(e.IPAddress).AppendLine("</td>") },
{ "Time", (e, sb) => sb.Append(" <td title=\"")
.Append((e.LastLogDate ?? e.CreationDate).ToUniversalTime().ToString("u"))
.Append("\">")
.AppendHtmlEncode((e.LastLogDate ?? e.CreationDate).ToRelativeTime())
.AppendLine("</td>") },
{ "Site", (e, sb) => sb.Append(" <td>").AppendHtmlEncode(e.Host).AppendLine("</td>") },
{ "Server", (e, sb) => sb.Append(" <td>").AppendHtmlEncode(e.MachineName).AppendLine("</td>") },
};

sb.AppendLine(@" </tr>
</thead>
<tbody>");

foreach (var e in Errors)
{
sb.Append(" <tr data-id=\"").Append(e.GUID.ToString()).Append("\" class=\"error").Append(e.IsProtected ? " js-protected" : "").AppendLine("\">")
Expand All @@ -101,36 +151,23 @@ protected override void RenderInnerHtml(StringBuilder sb)
{
sb.Append(" <span title=\"This error is protected\">").Append(IconLock).Append("</span>");
}
sb.AppendLine("</td>")
.Append(" <td title=\"").AppendHtmlEncode(e.Type).Append("\">")
.AppendHtmlEncode(e.Type.ToShortTypeName())
.AppendLine("</td>")
.Append(" <td class=\"wrap\"><a href=\"").Append(Url(KnownRoutes.Info)).Append("?guid=").Append(e.GUID.ToString())
.Append("\">").Append(e.Message.HasValue() ? e.Message.EncodeTruncateWithEllipsis(250) : "(no message)").Append("</a>");
if (e.DuplicateCount > 1)
{
sb.Append(" <span class=\"duplicate-count\" title=\"number of similar errors occurring close to this error\">(")
.Append(e.DuplicateCount.ToString())
.Append(")</span>");
}
sb.AppendLine("</td>")
.Append(" <td>");
if (e.UrlPath.HasValue())
sb.AppendLine("</td>");

foreach (var header in headers)
{
sb.Append("<span title=\"").AppendHtmlEncode(e.Host).AppendHtmlEncode(e.UrlPath).Append("\">")
.Append(e.UrlPath.EncodeTruncateWithEllipsis(40))
.Append("</span>");
if (displayLogic.TryGetValue(header, out var displayAction))
{
displayAction.Invoke(e, sb);
}
else if (e.CustomData != null && e.CustomData.TryGetValue(header, out var customValue))
{
sb.Append(" <td>").AppendHtmlEncode(customValue).AppendLine("</td>");
}
else
{
sb.Append(" <td></td>");
}
}
sb.AppendLine("</td>")
.Append(" <td>").AppendHtmlEncode(e.IPAddress).AppendLine("</td>")
.Append(" <td title=\"")
.Append((e.LastLogDate ?? e.CreationDate).ToUniversalTime().ToString("u"))
.Append("\">")
.AppendHtmlEncode((e.LastLogDate ?? e.CreationDate).ToRelativeTime())
.AppendLine("</td>")
.Append(" <td>").AppendHtmlEncode(e.Host).AppendLine("</td>")
.Append(" <td>").AppendHtmlEncode(e.MachineName).AppendLine("</td>")
.AppendLine(" </tr>");
}
sb.AppendLine(" </tbody>")
.AppendLine(" </table>");
Expand All @@ -145,4 +182,4 @@ protected override void RenderInnerHtml(StringBuilder sb)
}
}
}
}
}