Skip to content

Commit 9250a8d

Browse files
MistyKuuMistyKuu
committed
Add ZibStack.NET.Query: Gridify-compatible filter/sort DSL for REST APIs
Runtime library with FilterParser, SortParser, and FilterApplier that builds LINQ expressions translatable to SQL by EF Core. Dto generator detects ZibStack.NET.Query and generates per-entity: - ApplyDslFilter() with compile-time field allowlist - ApplyDslSort() with compile-time field allowlist - Navigation property paths (dot notation → automatic JOINs) - filter/sort string params on list endpoints Supported operators: = != > >= < <= =* !* ^ !^ $ !$ with /i modifier. Sorting: -Field (desc), Field (asc), Field desc, multi-field. Relations: Team.Name=Lakers → LEFT JOIN with WHERE.
1 parent ffa13d3 commit 9250a8d

17 files changed

Lines changed: 713 additions & 31 deletions

File tree

‎ZibStack.NET.slnx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@
6565
<Project Path="packages/ZibStack.NET.UI/sample/SampleApi/SampleApi.csproj" />
6666
<Project Path="packages/ZibStack.NET.UI/sample/SampleBlazor/SampleBlazor.csproj" />
6767
</Folder>
68+
<Folder Name="/packages/ZibStack.NET.Query/" />
69+
<Folder Name="/packages/ZibStack.NET.Query/src/">
70+
<Project Path="packages/ZibStack.NET.Query/src/ZibStack.NET.Query/ZibStack.NET.Query.csproj" />
71+
</Folder>
6872
<Folder Name="/packages/ZibStack.NET.Result/" />
6973
<Folder Name="/packages/ZibStack.NET.Result/src/">
7074
<Project Path="packages/ZibStack.NET.Result/src/ZibStack.NET.Result/ZibStack.NET.Result.csproj" />

‎packages/ZibStack.NET.Dto/sample/SampleApi/SampleApi.csproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<ProjectReference Include="..\..\..\ZibStack.NET.EntityFramework\src\ZibStack.NET.EntityFramework\ZibStack.NET.EntityFramework.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
1414
<ProjectReference Include="..\..\..\ZibStack.NET.UI\src\ZibStack.NET.UI\ZibStack.NET.UI.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
1515
<ProjectReference Include="..\..\..\ZibStack.NET.Validation\src\ZibStack.NET.Validation\ZibStack.NET.Validation.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
16+
<ProjectReference Include="..\..\..\ZibStack.NET.Query\src\ZibStack.NET.Query\ZibStack.NET.Query.csproj" />
1617
</ItemGroup>
1718

1819
<ItemGroup>

‎packages/ZibStack.NET.Dto/src/ZibStack.NET.Dto/DtoGenerator.CrudExtraction.cs‎

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,9 +344,60 @@ public partial class DtoGenerator
344344
: displayType + "?";
345345
queryProps.Add(new QueryPropertyInfo(prop.Name, jsonName, displayType, nullableType, isValueType));
346346
}
347+
// Collect navigation property paths for DSL filtering
348+
var navPaths = new List<QueryNavigationPath>();
349+
foreach (var prop in GetAllProperties(symbol))
350+
{
351+
if (prop.DeclaredAccessibility != Accessibility.Public) continue;
352+
if (prop.GetMethod is null) continue;
353+
354+
var pType = prop.Type;
355+
var hasOneToOne = prop.GetAttributes().Any(a =>
356+
a.AttributeClass?.ToDisplayString() == "ZibStack.NET.Core.OneToOneAttribute");
357+
358+
var isNav = hasOneToOne;
359+
if (!isNav && pType is INamedTypeSymbol navNts)
360+
{
361+
var unwrapped = navNts.NullableAnnotation == NullableAnnotation.Annotated && navNts.TypeArguments.Length == 1
362+
? navNts.TypeArguments[0] as INamedTypeSymbol : navNts;
363+
if (unwrapped is not null && unwrapped.TypeKind == TypeKind.Class
364+
&& unwrapped.SpecialType == SpecialType.None
365+
&& unwrapped.ToDisplayString() != "string"
366+
&& !unwrapped.AllInterfaces.Any(i => i.ToDisplayString().StartsWith("System.Collections")))
367+
{
368+
isNav = true;
369+
pType = unwrapped;
370+
}
371+
}
372+
if (!isNav) continue;
373+
374+
var navTypeSymbol = pType as INamedTypeSymbol;
375+
if (navTypeSymbol is null) continue;
376+
377+
foreach (var subProp in GetAllProperties(navTypeSymbol))
378+
{
379+
if (subProp.DeclaredAccessibility != Accessibility.Public) continue;
380+
if (subProp.GetMethod is null) continue;
381+
382+
var subType = subProp.Type;
383+
var subIsValueType = subType.IsValueType;
384+
if (subType is INamedTypeSymbol subNts && subNts.NullableAnnotation == NullableAnnotation.Annotated
385+
&& subNts.TypeArguments.Length == 1)
386+
subType = subNts.TypeArguments[0];
387+
if (subType.TypeKind == TypeKind.Class && subType.SpecialType == SpecialType.None
388+
&& subType.ToDisplayString() != "string") continue;
389+
if (subType.TypeKind == TypeKind.Interface || subType.TypeKind == TypeKind.Array) continue;
390+
391+
var dotPath = $"{prop.Name.ToLowerInvariant()}.{subProp.Name.ToLowerInvariant()}";
392+
var exprPath = $"{prop.Name}.{subProp.Name}";
393+
navPaths.Add(new QueryNavigationPath(dotPath, exprPath, subProp.Type.ToDisplayString(), subIsValueType));
394+
}
395+
}
396+
347397
result.QueryDtos.Add(new QueryDtoInfo(symbol.Name, ns, fqn,
348398
$"{symbol.Name}Query", queryProps, sortable: true,
349-
defaultSort: tableDefaultSort, defaultSortDirection: 0));
399+
defaultSort: tableDefaultSort, defaultSortDirection: 0,
400+
navigationPaths: navPaths));
350401
}
351402

352403
return result;

‎packages/ZibStack.NET.Dto/src/ZibStack.NET.Dto/DtoGenerator.CrudGeneration.cs‎

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -96,40 +96,46 @@ private static string GenerateMinimalApiSource(CrudApiInfo info)
9696
? (info.Namespace is not null ? $"{info.Namespace}.{listResponseType}" : listResponseType)
9797
: null;
9898

99-
if (info.HasQueryDto && info.QueryName is not null)
99+
// DSL filter/sort params (when ZibStack.NET.Query is referenced)
100+
var dslParams = info.HasQueryDsl ? ", string? filter = null, string? sort = null" : "";
101+
var fqQuery = info.HasQueryDto && info.QueryName is not null
102+
? (info.Namespace is not null ? $"{info.Namespace}.{info.QueryName}" : info.QueryName)
103+
: null;
104+
105+
if (fqQuery is not null)
100106
{
101-
var fqQuery = info.Namespace is not null ? $"{info.Namespace}.{info.QueryName}" : info.QueryName;
102107
sb.AppendLine($" group.MapGet(\"\", ([Microsoft.AspNetCore.Http.AsParameters] {fqQuery} query,");
103-
sb.AppendLine($" {storeType} store, int page = 1, int pageSize = 20, CancellationToken ct = default) =>");
108+
sb.AppendLine($" {storeType} store, int page = 1, int pageSize = 20{dslParams}, CancellationToken ct = default) =>");
104109
sb.AppendLine(" {");
105110
sb.AppendLine(" var q = query.Apply(store.Query());");
106-
if (fqListResponse is not null)
111+
if (info.HasQueryDsl)
107112
{
108-
sb.AppendLine($" var projected = {fqListResponse}.ProjectFrom(q);");
109-
sb.AppendLine($" return PaginatedResponse<{fqListResponse}>.CreateAsync(projected, page, pageSize, ct);");
113+
sb.AppendLine($" q = {fqQuery}.ApplyDslFilter(q, filter);");
114+
sb.AppendLine($" q = {fqQuery}.ApplyDslSort(q, sort);");
110115
}
111-
else
112-
{
113-
sb.AppendLine($" return PaginatedResponse<{fqEntity}>.CreateAsync(q, page, pageSize, ct);");
114-
}
115-
sb.AppendLine($" }}).WithName(\"Get{entity}List\"){(info.GetListPolicy is not null ? $".RequireAuthorization(\"{info.GetListPolicy}\")" : "")};");
116116
}
117117
else
118118
{
119-
sb.AppendLine($" group.MapGet(\"\", ({storeType} store, int page = 1, int pageSize = 20, CancellationToken ct = default) =>");
119+
sb.AppendLine($" group.MapGet(\"\", ({storeType} store, int page = 1, int pageSize = 20{dslParams}, CancellationToken ct = default) =>");
120120
sb.AppendLine(" {");
121121
sb.AppendLine(" var q = store.Query();");
122-
if (fqListResponse is not null)
123-
{
124-
sb.AppendLine($" var projected = {fqListResponse}.ProjectFrom(q);");
125-
sb.AppendLine($" return PaginatedResponse<{fqListResponse}>.CreateAsync(projected, page, pageSize, ct);");
126-
}
127-
else
122+
if (info.HasQueryDsl && fqQuery is null)
128123
{
129-
sb.AppendLine($" return PaginatedResponse<{fqEntity}>.CreateAsync(q, page, pageSize, ct);");
124+
// No QueryDto but has DSL — need to generate inline (edge case)
125+
sb.AppendLine(" // DSL filtering without QueryDto is not yet supported");
130126
}
131-
sb.AppendLine($" }}).WithName(\"Get{entity}List\"){(info.GetListPolicy is not null ? $".RequireAuthorization(\"{info.GetListPolicy}\")" : "")};");
132127
}
128+
129+
if (fqListResponse is not null)
130+
{
131+
sb.AppendLine($" var projected = {fqListResponse}.ProjectFrom(q);");
132+
sb.AppendLine($" return PaginatedResponse<{fqListResponse}>.CreateAsync(projected, page, pageSize, ct);");
133+
}
134+
else
135+
{
136+
sb.AppendLine($" return PaginatedResponse<{fqEntity}>.CreateAsync(q, page, pageSize, ct);");
137+
}
138+
sb.AppendLine($" }}).WithName(\"Get{entity}List\"){(info.GetListPolicy is not null ? $".RequireAuthorization(\"{info.GetListPolicy}\")" : "")};");
133139
sb.AppendLine();
134140
}
135141

‎packages/ZibStack.NET.Dto/src/ZibStack.NET.Dto/DtoGenerator.Extraction.cs‎

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,69 @@ a.ConstructorArguments[0].Value is string from &&
453453
properties.Add(new QueryPropertyInfo(prop.Name, jsonName, displayType, nullableType, isValueType));
454454
}
455455

456+
// Collect navigation property paths for DSL filtering (1 level deep)
457+
var navigationPaths = new List<QueryNavigationPath>();
458+
foreach (var prop in GetAllProperties(symbol))
459+
{
460+
if (prop.DeclaredAccessibility != Accessibility.Public) continue;
461+
if (prop.GetMethod is null) continue;
462+
463+
// Detect navigation properties: [OneToOne] or non-collection class types (not string)
464+
var propType = prop.Type;
465+
466+
// Check for [OneToOne] attribute (single navigation)
467+
var hasOneToOne = prop.GetAttributes().Any(a =>
468+
a.AttributeClass?.ToDisplayString() == "ZibStack.NET.Core.OneToOneAttribute");
469+
470+
// Also detect by type: non-collection, non-string class with public properties
471+
var isNavigation = hasOneToOne;
472+
if (!isNavigation && propType is INamedTypeSymbol navNts)
473+
{
474+
var unwrapped = navNts.NullableAnnotation == NullableAnnotation.Annotated && navNts.TypeArguments.Length == 1
475+
? navNts.TypeArguments[0] as INamedTypeSymbol
476+
: navNts;
477+
if (unwrapped is not null
478+
&& unwrapped.TypeKind == TypeKind.Class
479+
&& unwrapped.SpecialType == SpecialType.None
480+
&& unwrapped.ToDisplayString() != "string"
481+
&& !unwrapped.AllInterfaces.Any(i => i.ToDisplayString().StartsWith("System.Collections")))
482+
{
483+
isNavigation = true;
484+
propType = unwrapped;
485+
}
486+
}
487+
488+
if (!isNavigation) continue;
489+
490+
// Extract sub-properties of the navigation type
491+
var navTypeSymbol = propType as INamedTypeSymbol;
492+
if (navTypeSymbol is null) continue;
493+
494+
foreach (var subProp in GetAllProperties(navTypeSymbol))
495+
{
496+
if (subProp.DeclaredAccessibility != Accessibility.Public) continue;
497+
if (subProp.GetMethod is null) continue;
498+
499+
var subType = subProp.Type;
500+
var subIsValueType = subType.IsValueType;
501+
502+
// Only include primitive/filterable sub-properties
503+
if (subType is INamedTypeSymbol subNts && subNts.NullableAnnotation == NullableAnnotation.Annotated
504+
&& subNts.TypeArguments.Length == 1)
505+
subType = subNts.TypeArguments[0];
506+
507+
if (subType.TypeKind == TypeKind.Class && subType.SpecialType == SpecialType.None
508+
&& subType.ToDisplayString() != "string")
509+
continue;
510+
if (subType.TypeKind == TypeKind.Interface || subType.TypeKind == TypeKind.Array)
511+
continue;
512+
513+
var dotPath = $"{prop.Name.ToLowerInvariant()}.{subProp.Name.ToLowerInvariant()}";
514+
var exprPath = $"{prop.Name}.{subProp.Name}";
515+
navigationPaths.Add(new QueryNavigationPath(dotPath, exprPath, subProp.Type.ToDisplayString(), subIsValueType));
516+
}
517+
}
518+
456519
var ns = symbol.ContainingNamespace.IsGlobalNamespace
457520
? null
458521
: symbol.ContainingNamespace.ToDisplayString();
@@ -464,7 +527,8 @@ a.ConstructorArguments[0].Value is string from &&
464527
properties,
465528
sortable,
466529
defaultSort,
467-
defaultSortDirection);
530+
defaultSortDirection,
531+
navigationPaths);
468532
} catch { return null; } }
469533

470534
private static IEnumerable<IPropertySymbol> GetAllProperties(INamedTypeSymbol symbol)

‎packages/ZibStack.NET.Dto/src/ZibStack.NET.Dto/DtoGenerator.Generation.cs‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -718,6 +718,69 @@ private static string GenerateQueryDtoSource(QueryDtoInfo info)
718718
sb.AppendLine(" }");
719719
}
720720

721+
// DSL filter/sort methods (when ZibStack.NET.Query is referenced)
722+
if (info.HasQueryDsl)
723+
{
724+
sb.AppendLine();
725+
sb.AppendLine($" /// <summary>Applies a Gridify-compatible filter string (e.g. \"Name=*ski,Level&gt;25\").</summary>");
726+
sb.AppendLine($" public static IQueryable<{info.ClassName}> ApplyDslFilter(IQueryable<{info.ClassName}> query, string? filter)");
727+
sb.AppendLine(" {");
728+
sb.AppendLine(" if (string.IsNullOrWhiteSpace(filter)) return query;");
729+
sb.AppendLine(" foreach (var clause in ZibStack.NET.Query.FilterParser.Parse(filter))");
730+
sb.AppendLine(" {");
731+
sb.AppendLine(" query = clause.Field.ToLowerInvariant() switch");
732+
sb.AppendLine(" {");
733+
foreach (var prop in info.Properties)
734+
{
735+
var lower = prop.PropertyName.ToLowerInvariant();
736+
sb.AppendLine($" \"{lower}\" => ZibStack.NET.Query.FilterApplier.Apply(query, x => x.{prop.PropertyName}, clause),");
737+
}
738+
// Navigation property paths (e.g. "team.name" → x => x.Team.Name)
739+
foreach (var nav in info.NavigationPaths)
740+
{
741+
sb.AppendLine($" \"{nav.DotPath}\" => ZibStack.NET.Query.FilterApplier.Apply(query, x => x.{nav.ExpressionPath}, clause),");
742+
}
743+
sb.AppendLine(" _ => query,");
744+
sb.AppendLine(" };");
745+
sb.AppendLine(" }");
746+
sb.AppendLine(" return query;");
747+
sb.AppendLine(" }");
748+
749+
sb.AppendLine();
750+
sb.AppendLine($" /// <summary>Applies a sort string (e.g. \"-Name\" or \"Level desc\").</summary>");
751+
sb.AppendLine($" public static IQueryable<{info.ClassName}> ApplyDslSort(IQueryable<{info.ClassName}> query, string? sort)");
752+
sb.AppendLine(" {");
753+
sb.AppendLine(" if (string.IsNullOrWhiteSpace(sort)) return query;");
754+
sb.AppendLine(" var clauses = ZibStack.NET.Query.SortParser.Parse(sort);");
755+
sb.AppendLine(" var first = true;");
756+
sb.AppendLine(" foreach (var clause in clauses)");
757+
sb.AppendLine(" {");
758+
sb.AppendLine(" query = (clause.Field.ToLowerInvariant(), clause.Descending, first) switch");
759+
sb.AppendLine(" {");
760+
foreach (var prop in info.Properties)
761+
{
762+
var lower = prop.PropertyName.ToLowerInvariant();
763+
sb.AppendLine($" (\"{lower}\", false, true) => query.OrderBy(x => x.{prop.PropertyName}),");
764+
sb.AppendLine($" (\"{lower}\", true, true) => query.OrderByDescending(x => x.{prop.PropertyName}),");
765+
sb.AppendLine($" (\"{lower}\", false, false) => ((IOrderedQueryable<{info.ClassName}>)query).ThenBy(x => x.{prop.PropertyName}),");
766+
sb.AppendLine($" (\"{lower}\", true, false) => ((IOrderedQueryable<{info.ClassName}>)query).ThenByDescending(x => x.{prop.PropertyName}),");
767+
}
768+
// Navigation property paths for sorting
769+
foreach (var nav in info.NavigationPaths)
770+
{
771+
sb.AppendLine($" (\"{nav.DotPath}\", false, true) => query.OrderBy(x => x.{nav.ExpressionPath}),");
772+
sb.AppendLine($" (\"{nav.DotPath}\", true, true) => query.OrderByDescending(x => x.{nav.ExpressionPath}),");
773+
sb.AppendLine($" (\"{nav.DotPath}\", false, false) => ((IOrderedQueryable<{info.ClassName}>)query).ThenBy(x => x.{nav.ExpressionPath}),");
774+
sb.AppendLine($" (\"{nav.DotPath}\", true, false) => ((IOrderedQueryable<{info.ClassName}>)query).ThenByDescending(x => x.{nav.ExpressionPath}),");
775+
}
776+
sb.AppendLine(" _ => query,");
777+
sb.AppendLine(" };");
778+
sb.AppendLine(" first = false;");
779+
sb.AppendLine(" }");
780+
sb.AppendLine(" return query;");
781+
sb.AppendLine(" }");
782+
}
783+
721784
sb.AppendLine("}");
722785
return sb.ToString();
723786
}

0 commit comments

Comments
 (0)