Improve premium search enforcement and Svelte upgrade guidance

src/Exceptionless.Core/Bootstrapper.cs

@@ -157,6 +157,7 @@ public static void RegisterServices(IServiceCollection services, AppOptions appO
         services.AddSingleton<IQueryParser>(s => new ElasticQueryParser());
         services.AddSingleton<IAppQueryValidator, AppQueryValidator>();
         services.AddSingleton<PersistentEventQueryValidator>();
+        services.AddSingleton<EventStackQueryValidator>();
         services.AddSingleton<StackQueryValidator>();
 
         services.AddSingleton<MiniValidationValidator>();

src/Exceptionless.Core/Repositories/Queries/Validation/EventStackQueryValidator.cs

@@ -0,0 +1,23 @@
+using Exceptionless.Core.Repositories.Configuration;
+using Foundatio.Parsers.LuceneQueries;
+using Foundatio.Parsers.LuceneQueries.Visitors;
+using Microsoft.Extensions.Logging;
+
+namespace Exceptionless.Core.Queries.Validation;
+
+public sealed class EventStackQueryValidator : AppQueryValidator
+{
+    public EventStackQueryValidator(ExceptionlessElasticConfiguration configuration, ILoggerFactory loggerFactory)
+        : base(configuration.Events.QueryParser, loggerFactory) { }
+
+    protected override QueryProcessResult ApplyQueryRules(QueryValidationResult result)
+    {
+        return new QueryProcessResult
+        {
+            IsValid = result.IsValid,
+            UsesPremiumFeatures = !result.ReferencedFields.All(field =>
+                PersistentEventQueryValidator.IsFreeQueryField(field)
+                || StackQueryValidator.IsFreeQueryField(field))
+        };
+    }
+}

src/Exceptionless.Core/Repositories/Queries/Validation/PersistentEventQueryValidator.cs

@@ -7,7 +7,7 @@ namespace Exceptionless.Core.Queries.Validation;
 
 public sealed class PersistentEventQueryValidator : AppQueryValidator
 {
-    private readonly HashSet<string> _freeQueryFields = new(StringComparer.OrdinalIgnoreCase) {
+    private static readonly HashSet<string> _freeQueryFields = new(StringComparer.OrdinalIgnoreCase) {
             "date",
             "type",
             EventIndex.Alias.ReferenceId,
@@ -91,12 +91,17 @@ public sealed class PersistentEventQueryValidator : AppQueryValidator
 
     public PersistentEventQueryValidator(ExceptionlessElasticConfiguration configuration, ILoggerFactory loggerFactory) : base(configuration.Events.QueryParser, loggerFactory) { }
 
+    internal static bool IsFreeQueryField(string field)
+    {
+        return _freeQueryFields.Contains(field);
+    }
+
     protected override QueryProcessResult ApplyQueryRules(QueryValidationResult result)
     {
         return new QueryProcessResult
         {
             IsValid = result.IsValid,
-            UsesPremiumFeatures = !result.ReferencedFields.All(_freeQueryFields.Contains)
+            UsesPremiumFeatures = !result.ReferencedFields.All(IsFreeQueryField)
         };
     }
 

src/Exceptionless.Core/Repositories/Queries/Validation/StackQueryValidator.cs

@@ -7,7 +7,7 @@ namespace Exceptionless.Core.Queries.Validation;
 
 public sealed class StackQueryValidator : AppQueryValidator
 {
-    private readonly HashSet<string> _freeQueryFields = new(StringComparer.OrdinalIgnoreCase) {
+    private static readonly HashSet<string> _freeQueryFields = new(StringComparer.OrdinalIgnoreCase) {
             StackIndex.Alias.FirstOccurrence,
             "first_occurrence",
             StackIndex.Alias.LastOccurrence,
@@ -55,12 +55,17 @@ public sealed class StackQueryValidator : AppQueryValidator
 
     public StackQueryValidator(ExceptionlessElasticConfiguration configuration, ILoggerFactory loggerFactory) : base(configuration.Stacks.QueryParser, loggerFactory) { }
 
+    internal static bool IsFreeQueryField(string field)
+    {
+        return _freeQueryFields.Contains(field);
+    }
+
     protected override QueryProcessResult ApplyQueryRules(QueryValidationResult result)
     {
         return new QueryProcessResult
         {
             IsValid = result.IsValid,
-            UsesPremiumFeatures = !result.ReferencedFields.All(_freeQueryFields.Contains)
+            UsesPremiumFeatures = !result.ReferencedFields.All(IsFreeQueryField)
         };
     }
 

src/Exceptionless.Web/Api/Endpoints/EventEndpoints.cs

@@ -31,6 +31,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
         .RequireAuthorization(AuthorizationRoles.EventsReadPolicy)
         .Produces<CountResult>()
         .ProducesProblem(StatusCodes.Status400BadRequest)
+        .ProducesProblem(StatusCodes.Status426UpgradeRequired)
         .WithSummary("Count")
         .WithMetadata(new EndpointDocumentation {
             ParameterDescriptions = new() {
@@ -42,6 +43,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             },
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
+                ["426"] = ApiFilterPolicy.PremiumSearchUpgradeMessage,
             }
         });
 
@@ -50,6 +52,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
         .RequireAuthorization(AuthorizationRoles.EventsReadPolicy)
         .Produces<CountResult>()
         .ProducesProblem(StatusCodes.Status400BadRequest)
+        .ProducesProblem(StatusCodes.Status426UpgradeRequired)
         .WithSummary("Count by organization")
         .WithMetadata(new EndpointDocumentation {
             ParameterDescriptions = new() {
@@ -62,6 +65,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             },
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSearchUpgradeDescription,
             }
         });
 
@@ -70,6 +74,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
         .RequireAuthorization(AuthorizationRoles.EventsReadPolicy)
         .Produces<CountResult>()
         .ProducesProblem(StatusCodes.Status400BadRequest)
+        .ProducesProblem(StatusCodes.Status426UpgradeRequired)
         .WithSummary("Count by project")
         .WithMetadata(new EndpointDocumentation {
             ParameterDescriptions = new() {
@@ -82,6 +87,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             },
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSearchUpgradeDescription,
             }
         });
 
@@ -132,7 +138,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             },
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
-                ["426"] = "Unable to view event occurrences for the suspended organization.",
+                ["426"] = ApiFilterPolicy.PremiumSearchUpgradeMessage,
             }
         });
 
@@ -162,7 +168,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
                 ["404"] = "The organization could not be found.",
-                ["426"] = "Unable to view event occurrences for the suspended organization.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSearchUpgradeDescription,
             }
         });
 
@@ -192,7 +198,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
                 ["404"] = "The project could not be found.",
-                ["426"] = "Unable to view event occurrences for the suspended organization.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSearchUpgradeDescription,
             }
         });
 
@@ -222,7 +228,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
                 ["404"] = "The stack could not be found.",
-                ["426"] = "Unable to view event occurrences for the suspended organization.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSearchUpgradeDescription,
             }
         });
 
@@ -303,7 +309,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             },
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
-                ["426"] = "Unable to view event occurrences for the suspended organization.",
+                ["426"] = ApiFilterPolicy.PremiumSessionUpgradeMessage,
             }
         });
 
@@ -334,7 +340,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
                 ["404"] = "The project could not be found.",
-                ["426"] = "Unable to view event occurrences for the suspended organization.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSessionUpgradeDescription,
             }
         });
 
@@ -344,6 +350,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
         .RequireAuthorization(AuthorizationRoles.EventsReadPolicy)
         .Produces<IReadOnlyCollection<PersistentEvent>>()
         .ProducesProblem(StatusCodes.Status400BadRequest)
+        .ProducesProblem(StatusCodes.Status426UpgradeRequired)
         .WithSummary("Get a list of all sessions")
         .WithMetadata(new EndpointDocumentation {
             ParameterDescriptions = new() {
@@ -360,6 +367,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             },
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
+                ["426"] = ApiFilterPolicy.PremiumSessionUpgradeMessage,
             }
         });
 
@@ -388,8 +396,8 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             },
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
-                ["404"] = "The project could not be found.",
-                ["426"] = "Unable to view event occurrences for the suspended organization.",
+                ["404"] = "The organization could not be found.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSessionUpgradeDescription,
             }
         });
 
@@ -419,7 +427,7 @@ public static IEndpointRouteBuilder MapEventEndpoints(this IEndpointRouteBuilder
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
                 ["404"] = "The project could not be found.",
-                ["426"] = "Unable to view event occurrences for the suspended organization.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSessionUpgradeDescription,
             }
         });
 

src/Exceptionless.Web/Api/Endpoints/StackEndpoints.cs

@@ -3,6 +3,7 @@
 using Exceptionless.Core.Extensions;
 using Exceptionless.Core.Models;
 using Exceptionless.Web.Api.Filters;
+using Exceptionless.Web.Api.Infrastructure;
 using Exceptionless.Web.Api.Messages;
 using Exceptionless.Web.Api.Results;
 using Exceptionless.Web.Models;
@@ -237,6 +238,7 @@ public static IEndpointRouteBuilder MapStackEndpoints(this IEndpointRouteBuilder
         .RequireAuthorization(AuthorizationRoles.StacksReadPolicy)
         .Produces<IReadOnlyCollection<Stack>>()
         .ProducesProblem(StatusCodes.Status400BadRequest)
+        .ProducesProblem(StatusCodes.Status426UpgradeRequired)
         .WithSummary("Get all")
         .WithMetadata(new EndpointDocumentation {
             ParameterDescriptions = new() {
@@ -250,6 +252,7 @@ public static IEndpointRouteBuilder MapStackEndpoints(this IEndpointRouteBuilder
             },
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
+                ["426"] = ApiFilterPolicy.PremiumSearchUpgradeMessage,
             }
         });
 
@@ -276,7 +279,7 @@ public static IEndpointRouteBuilder MapStackEndpoints(this IEndpointRouteBuilder
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
                 ["404"] = "The organization could not be found.",
-                ["426"] = "Unable to view stack occurrences for the suspended organization.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSearchUpgradeDescription,
             }
         });
 
@@ -303,7 +306,7 @@ public static IEndpointRouteBuilder MapStackEndpoints(this IEndpointRouteBuilder
             ResponseDescriptions = new() {
                 ["400"] = "Invalid filter.",
                 ["404"] = "The organization could not be found.",
-                ["426"] = "Unable to view stack occurrences for the suspended organization.",
+                ["426"] = ApiFilterPolicy.SuspendedOrPremiumSearchUpgradeDescription,
             }
         });