Stack and Events API improvements (#1794)

* Stack Controller Improvements

* Added const for event index search error field

* Doc fixes

* Fixed incorrect response type

* Fixed docs

* Added ability to return total from event controller aggs.

Author: niemyjski

src/Exceptionless.Core/Configuration/AppOptions.cs

@@ -1,4 +1,4 @@
-using System.Diagnostics;
+using System.Diagnostics;
 using Exceptionless.Core.Configuration;
 using Exceptionless.Core.Extensions;
 using Microsoft.Extensions.Configuration;
@@ -22,7 +22,7 @@ public class AppOptions
     public string? ExceptionlessApiKey { get; internal set; }
 
     /// <summary>
-    /// Configures the exceptionless client server url, which logs all internal errors and log messages.
+    /// Configures the Exceptionless client server url, which logs all internal errors and log messages.
     /// </summary>
     public string? ExceptionlessServerUrl { get; internal set; }
 

src/Exceptionless.Core/Extensions/IdentityUtils.cs

@@ -130,7 +130,6 @@ public static bool IsUserAuthType(this ClaimsPrincipal principal)
     /// Gets the token id that authenticated the current user. If null, user logged in via oauth.
     /// </summary>
     /// <param name="principal"></param>
-    /// <returns></returns>
     public static string? GetLoggedInUsersTokenId(this ClaimsPrincipal principal)
     {
         return IsUserAuthType(principal) ? GetClaimValue(principal, LoggedInUsersTokenId) : null;

src/Exceptionless.Core/Repositories/Configuration/Indexes/EventIndex.cs

@@ -307,6 +307,7 @@ public sealed class Alias
         public const string LocationLevel2 = "level2";
         public const string LocationLocality = "locality";
 
+        public const string Error = "error";
         public const string ErrorCode = "error.code";
         public const string ErrorType = "error.type";
         public const string ErrorMessage = "error.message";
@@ -322,7 +323,7 @@ public static PropertiesDescriptor<PersistentEvent> AddCopyToMappings(this Prope
         return descriptor
             .Text(f => f.Name(EventIndex.Alias.IpAddress).Analyzer(EventIndex.COMMA_WHITESPACE_ANALYZER))
             .Text(f => f.Name(EventIndex.Alias.OperatingSystem).Analyzer(EventIndex.WHITESPACE_LOWERCASE_ANALYZER).AddKeywordField())
-            .Object<object>(f => f.Name("error").Properties(p1 => p1
+            .Object<object>(f => f.Name(EventIndex.Alias.Error).Properties(p1 => p1
                 .Keyword(f3 => f3.Name("code").IgnoreAbove(1024))
                 .Text(f3 => f3.Name("message").AddKeywordField())
                 .Text(f3 => f3.Name("type").Analyzer(EventIndex.TYPENAME_ANALYZER).SearchAnalyzer(EventIndex.WHITESPACE_LOWERCASE_ANALYZER).AddKeywordField())

src/Exceptionless.Core/Repositories/EventRepository.cs

@@ -26,7 +26,7 @@ public EventRepository(ExceptionlessElasticConfiguration configuration, AppOptio
         // copy to fields
         AddDefaultExclude(EventIndex.Alias.IpAddress);
         AddDefaultExclude(EventIndex.Alias.OperatingSystem);
-        AddDefaultExclude("error");
+        AddDefaultExclude(EventIndex.Alias.Error);
 
         AddPropertyRequiredForRemove(e => e.Date);
     }

src/Exceptionless.Core/Repositories/StackRepository.cs

@@ -49,7 +49,7 @@ public Task<FindResults<Stack>> GetSoftDeleted()
     public async Task<bool> IncrementEventCounterAsync(string organizationId, string projectId, string stackId, DateTime minOccurrenceDateUtc, DateTime maxOccurrenceDateUtc, int count, bool sendNotifications = true)
     {
         // If total occurrences are zero (stack data was reset), then set first occurrence date
-        // Only update the LastOccurrence if the new date is greater then the existing date.
+        // Only update the LastOccurrence if the new date is greater than the existing date.
         const string script = @"
 Instant parseDate(def dt) {
   if (dt != null) {

src/Exceptionless.Web/Controllers/Base/ModelActionResults.cs

@@ -1,9 +1,9 @@
 namespace Exceptionless.Web.Controllers;
 
-public class ModelActionResults : WorkInProgressResult
+public record ModelActionResults : WorkInProgressResult
 {
-    public List<string> Success { get; set; } = new();
-    public List<PermissionResult> Failure { get; set; } = new();
+    public List<string> Success { get; } = new();
+    public List<PermissionResult> Failure { get; } = new();
 
     public void AddNotFound(IEnumerable<string> ids)
     {

src/Exceptionless.Web/Controllers/Base/WorkInProgressResult.cs

@@ -1,16 +1,15 @@
 namespace Exceptionless.Web.Controllers;
 
-public class WorkInProgressResult
+public record WorkInProgressResult
 {
     public WorkInProgressResult()
     {
-        Workers = new List<string>();
     }
 
     public WorkInProgressResult(IEnumerable<string> workers) : this()
     {
-        Workers.AddRange(workers ?? new List<string>());
+        Workers.AddRange(workers);
     }
 
-    public List<string> Workers { get; set; }
+    public List<string> Workers { get; } = new();
 }

src/Exceptionless.Web/Controllers/EventController.cs

@@ -346,7 +346,9 @@ private async Task<ActionResult<ICollection<PersistentEvent>>> GetInternalAsync(
                     var stacks = (await _stackRepository.GetByIdsAsync(stackIds)).Select(s => s.ApplyOffset(ti.Offset)).ToList();
 
                     var summaries = await GetStackSummariesAsync(stacks, stackTerms.Buckets, sf, ti);
-                    return OkWithResourceLinks(summaries.Take(limit).ToList(), summaries.Count > limit, resolvedPage);
+
+                    long total = (stackTerms.Data?.GetValueOrDefault("SumOtherDocCount") as long? ?? 0L) + stackTerms.Buckets.Count;
+                    return OkWithResourceLinks(summaries.Take(limit).ToList(), summaries.Count > limit && !NextPageExceedsSkipLimit(resolvedPage, limit), resolvedPage, total);
                 default:
                     events = await GetEventsInternalAsync(sf, ti, filter, sort, page, limit, before, after);
                     return OkWithResourceLinks(events.Documents.ToArray(), events.HasMore && !NextPageExceedsSkipLimit(page, limit), page, events.Total, events.Hits.FirstOrDefault()?.GetSortToken(), events.Hits.LastOrDefault()?.GetSortToken());

src/Exceptionless.Web/Controllers/OrganizationController.cs

@@ -140,7 +140,6 @@ public async Task<ActionResult<ViewOrganization>> GetAsync(string id, string? mo
     /// Create
     /// </summary>
     /// <param name="organization">The organization.</param>
-    /// <returns></returns>
     /// <response code="400">An error occurred while creating the organization.</response>
     /// <response code="409">The organization already exists.</response>
     [HttpPost]

src/Exceptionless.Web/Controllers/ProjectController.cs

@@ -152,7 +152,6 @@ public async Task<ActionResult<ViewProject>> GetAsync(string id, string? mode =
     /// Create
     /// </summary>
     /// <param name="project">The project.</param>
-    /// <returns></returns>
     /// <response code="400">An error occurred while creating the project.</response>
     /// <response code="409">The project already exists.</response>
     [HttpPost]