Query Builder Endpoint

.github/workflows/build-test-ci.yml

@@ -7,24 +7,25 @@ on:
   pull_request:
     branches:
       - main
+
 jobs:
   build-and-test:
     runs-on: ubuntu-latest  
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v3
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v3
-      with:
-        dotnet-version: 6.x 
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '6.x'
 
-    - name: Restore dependencies
-      run: dotnet restore
+      - name: Restore dependencies
+        run: dotnet restore
 
-    - name: Build
-      run: dotnet build --configuration Release 
+      - name: Build
+        run: dotnet build --configuration Release 
 
-    - name: Run tests
-      run: dotnet test --configuration Release --no-build
+      - name: Run tests
+        run: dotnet test --configuration Release --no-build

NorthwindCRUD/Controllers/QueryBuilderController.cs

@@ -0,0 +1,69 @@
+namespace QueryBuilder;
+
+using AutoMapper;
+using Microsoft.AspNetCore.Mvc;
+using Newtonsoft.Json;
+using NorthwindCRUD;
+using NorthwindCRUD.Models.Dtos;
+using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
+
+[SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1516:Elements should be separated by blank line", Justification = "...")]
+[SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1025:Code should not contain multiple whitespace in a row", Justification = "...")]
+[SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1134:Attributes should not share line", Justification = "...")]
+[SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1011:Closing square brackets should be spaced correctly", Justification = "...")]
+public class QueryBuilderResult
+{
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public AddressDto[]?     Addresses    { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public CategoryDto[]?    Categories   { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public ProductDto[]?     Products     { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public RegionDto[]?      Regions      { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public TerritoryDto[]?   Territories  { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public EmployeeDto[]?    Employees    { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public CustomerDto[]?    Customers    { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public OrderDto[]?       Orders       { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public OrderDetailDto[]? OrderDetails { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public ShipperDto[]?     Shippers     { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] public SupplierDto[]?    Suppliers    { get; set; }
+}
+
+[ApiController]
+[Route("[controller]")]
+[SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1025:Code should not contain multiple whitespace in a row", Justification = "...")]
+public class QueryBuilderController : ControllerBase
+{
+    private readonly DataContext dataContext;
+    private readonly IMapper mapper;
+    private readonly ILogger<QueryBuilderController> logger;
+
+    public QueryBuilderController(DataContext dataContext, IMapper mapper, ILogger<QueryBuilderController> logger)
+    {
+        this.dataContext = dataContext;
+        this.mapper = mapper;
+        this.logger = logger;
+    }
+
+    [HttpPost("ExecuteQuery")]
+    [Consumes("application/json")]
+    [Produces("application/json")]
+    public ActionResult<QueryBuilderResult> ExecuteQuery(Query query)
+    {
+        var sanitizedEntity = query.Entity.Replace("\r", string.Empty).Replace("\n", string.Empty);
+        logger.LogInformation("Executing query for entity: {Entity}", sanitizedEntity);
+        var t = query.Entity.ToLower(CultureInfo.InvariantCulture);
+        return Ok(new QueryBuilderResult
+        {
+            Addresses    = t == "addresses"    ? mapper.Map<AddressDto[]>(dataContext.Addresses.Run(query))        : null,
+            Categories   = t == "categories"   ? mapper.Map<CategoryDto[]>(dataContext.Categories.Run(query))      : null,
+            Products     = t == "products"     ? mapper.Map<ProductDto[]>(dataContext.Products.Run(query))         : null,
+            Regions      = t == "regions"      ? mapper.Map<RegionDto[]>(dataContext.Regions.Run(query))           : null,
+            Territories  = t == "territories"  ? mapper.Map<TerritoryDto[]>(dataContext.Territories.Run(query))    : null,
+            Employees    = t == "employees"    ? mapper.Map<EmployeeDto[]>(dataContext.Employees.Run(query))       : null,
+            Customers    = t == "customers"    ? mapper.Map<CustomerDto[]>(dataContext.Customers.Run(query))       : null,
+            Orders       = t == "orders"       ? mapper.Map<OrderDto[]>(dataContext.Orders.Run(query))             : null,
+            OrderDetails = t == "orderdetails" ? mapper.Map<OrderDetailDto[]>(dataContext.OrderDetails.Run(query)) : null,
+            Shippers     = t == "shippers"     ? mapper.Map<ShipperDto[]>(dataContext.Shippers.Run(query))         : null,
+            Suppliers    = t == "suppliers"    ? mapper.Map<SupplierDto[]>(dataContext.Suppliers.Run(query))       : null,
+        });
+    }
+}

NorthwindCRUD/Program.cs

@@ -2,12 +2,9 @@
 using AutoMapper;
 using GraphQL.AspNet.Configuration.Mvc;
 using Microsoft.AspNetCore.Authentication.JwtBearer;
-using Microsoft.Data.Sqlite;
-using Microsoft.EntityFrameworkCore;
-using Microsoft.EntityFrameworkCore.Diagnostics;
-using Microsoft.Extensions.Options;
 using Microsoft.IdentityModel.Tokens;
 using Microsoft.OpenApi.Models;
+using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 using NorthwindCRUD.Filters;
 using NorthwindCRUD.Helpers;
@@ -40,7 +37,8 @@ public static void Main(string[] args)
                 options.SuppressImplicitRequiredAttributeForNonNullableReferenceTypes = true;
             }).AddNewtonsoftJson(options =>
             {
-                options.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
+                options.SerializerSettings.DateParseHandling = DateParseHandling.None;
+                options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
                 options.SerializerSettings.Converters.Add(new StringEnumConverter());
             });
 

NorthwindCRUD/QueryBuilder/Model/FilterType.cs

@@ -0,0 +1,7 @@
+namespace QueryBuilder;
+
+public enum FilterType
+{
+    And = 0,
+    Or = 1,
+}

NorthwindCRUD/QueryBuilder/Model/Query.cs

@@ -0,0 +1,12 @@
+namespace QueryBuilder;
+
+public class Query
+{
+    public string Entity { get; set; }
+
+    public string[] ReturnFields { get; set; }
+
+    public FilterType Operator { get; set; }
+
+    public QueryFilter[] FilteringOperands { get; set; }
+}

NorthwindCRUD/QueryBuilder/Model/QueryFilter.cs

@@ -0,0 +1,20 @@
+namespace QueryBuilder;
+
+public class QueryFilter
+{
+    // Basic condition
+    public string? FieldName { get; set; }
+
+    public bool? IgnoreCase { get; set; }
+
+    public QueryFilterCondition? Condition { get; set; }
+
+    public object? SearchVal { get; set; }
+
+    public Query? SearchTree { get; set; }
+
+    // And/Or
+    public FilterType? Operator { get; set; }
+
+    public QueryFilter[] FilteringOperands { get; set; }
+}

NorthwindCRUD/QueryBuilder/Model/QueryFilterCondition.cs

@@ -0,0 +1,10 @@
+namespace QueryBuilder;
+
+public class QueryFilterCondition
+{
+    public string Name { get; set; }
+
+    public bool IsUnary { get; set; }
+
+    public string IconName { get; set; }
+}