-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Improve batch state checker performance and add RequireFeaturesSimpleBatchStateChecker #25276
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
729b4de
Improve batch state checker performance by sharing a single DI scope
maliming b255437
Resolve global state checkers from evaluation scope for consistency
maliming 3c52892
Add early-exit guard for states with no non-batch checkers in batch path
maliming c432374
Add batch feature checking support with RequireFeaturesSimpleBatchSta…
maliming 6505dc0
Optimize batch state checker model lookup from O(N²) to O(N)
maliming File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
111 changes: 111 additions & 0 deletions
111
....Abp.Core.Tests/Volo/Abp/SimpleStateChecking/SimpleStateChecker_BatchSingleScope_Tests.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| using System; | ||
| using System.Globalization; | ||
| using System.Threading.Tasks; | ||
| using Shouldly; | ||
| using Xunit; | ||
|
|
||
| namespace Volo.Abp.SimpleStateChecking; | ||
|
|
||
| /// <summary> | ||
| /// Tests that batch IsEnabledAsync evaluates non-batch state checkers correctly | ||
| /// when reusing a single DI scope (instead of creating N scopes via InternalIsEnabledAsync). | ||
| /// </summary> | ||
| public class SimpleStateChecker_BatchSingleScope_Tests : SimpleStateCheckerTestBase | ||
| { | ||
| [Fact] | ||
| public async Task Batch_Should_Evaluate_NonBatch_Checkers_Correctly() | ||
| { | ||
| var enabled = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| enabled.AddSimpleStateChecker(new MySimpleStateChecker()); | ||
|
|
||
| var disabled = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2001-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| disabled.AddSimpleStateChecker(new MySimpleStateChecker()); | ||
|
|
||
| var result = await SimpleStateCheckerManager.IsEnabledAsync(new[] { enabled, disabled }); | ||
|
|
||
| result[enabled].ShouldBeTrue(); | ||
| result[disabled].ShouldBeFalse(); | ||
| enabled.CheckCount.ShouldBe(1); | ||
| disabled.CheckCount.ShouldBe(1); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task Batch_Should_Skip_NonBatch_Check_When_BatchChecker_Already_Disabled() | ||
| { | ||
| // Entity disabled by batch checker should not have non-batch checker invoked | ||
| var entity = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2001-01-01", CultureInfo.InvariantCulture) // fails batch checker | ||
| }; | ||
| entity.AddSimpleStateChecker(new MySimpleBatchStateChecker()); | ||
| entity.AddSimpleStateChecker(new MySimpleStateChecker()); | ||
|
|
||
| var result = await SimpleStateCheckerManager.IsEnabledAsync(new[] { entity }); | ||
|
|
||
| result[entity].ShouldBeFalse(); | ||
| entity.MultipleCheckCount.ShouldBe(1); // batch checker was called | ||
| entity.CheckCount.ShouldBe(0); // non-batch checker was NOT called (skipped because batch disabled it) | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task Batch_Should_Handle_Mix_Of_Entities_With_And_Without_Checkers() | ||
| { | ||
| var noChecker = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
|
|
||
| var withChecker = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| withChecker.AddSimpleStateChecker(new MySimpleStateChecker()); | ||
|
|
||
| var failingChecker = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2001-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| failingChecker.AddSimpleStateChecker(new MySimpleStateChecker()); | ||
|
|
||
| var result = await SimpleStateCheckerManager.IsEnabledAsync( | ||
| new[] { noChecker, withChecker, failingChecker }); | ||
|
|
||
| result[noChecker].ShouldBeTrue(); | ||
| result[withChecker].ShouldBeTrue(); | ||
| result[failingChecker].ShouldBeFalse(); | ||
|
|
||
| noChecker.CheckCount.ShouldBe(0); | ||
| withChecker.CheckCount.ShouldBe(1); | ||
| failingChecker.CheckCount.ShouldBe(1); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task Batch_Should_Handle_Large_Number_Of_Entities() | ||
| { | ||
| var entities = new MyStateEntity[1000]; | ||
| for (int i = 0; i < 1000; i++) | ||
| { | ||
| entities[i] = new MyStateEntity | ||
| { | ||
| CreationTime = i % 2 == 0 | ||
| ? DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| : DateTime.Parse("2001-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| entities[i].AddSimpleStateChecker(new MySimpleStateChecker()); | ||
| } | ||
|
|
||
| var result = await SimpleStateCheckerManager.IsEnabledAsync(entities); | ||
|
|
||
| for (int i = 0; i < 1000; i++) | ||
| { | ||
| result[entities[i]].ShouldBe(i % 2 == 0); | ||
| entities[i].CheckCount.ShouldBe(1); | ||
| } | ||
| } | ||
| } |
179 changes: 179 additions & 0 deletions
179
...lo.Abp.Core.Tests/Volo/Abp/SimpleStateChecking/SimpleStateChecker_ScopeIsolation_Tests.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| using System; | ||
| using System.Collections.Concurrent; | ||
| using System.Globalization; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Shouldly; | ||
| using Xunit; | ||
|
|
||
| namespace Volo.Abp.SimpleStateChecking; | ||
|
|
||
| /// <summary> | ||
| /// Probe-based tests that verify: | ||
| /// 1. Batch path shares a single DI scope but isolates CachedServiceProvider per state. | ||
| /// 2. Single-state path uses separate scopes (original behavior). | ||
| /// 3. Nested single-state calls from within batch checkers get their own scope. | ||
| /// </summary> | ||
| public class SimpleStateChecker_ScopeIsolation_Tests : SimpleStateCheckerTestBase | ||
| { | ||
| protected override void AfterAddApplication(IServiceCollection services) | ||
| { | ||
| services.AddScoped<ScopeIdProbe>(); | ||
| services.AddTransient<TransientIdProbe>(); | ||
| base.AfterAddApplication(services); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task Batch_Should_Share_Scope_But_Isolate_CachedProvider_Across_States() | ||
| { | ||
| var observations = new ConcurrentDictionary<MyStateEntity, Observation>(); | ||
| var checker = new ScopeProbeStateChecker(observations); | ||
|
|
||
| var stateA = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| stateA.AddSimpleStateChecker(checker); | ||
|
|
||
| var stateB = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| stateB.AddSimpleStateChecker(checker); | ||
|
|
||
| var stateC = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| stateC.AddSimpleStateChecker(checker); | ||
|
|
||
| await SimpleStateCheckerManager.IsEnabledAsync(new[] { stateA, stateB, stateC }); | ||
|
|
||
| observations.Count.ShouldBe(3); | ||
|
|
||
| // All states in the batch should see the same scoped service (shared DI scope) | ||
| observations[stateA].ScopeId.ShouldBe(observations[stateB].ScopeId); | ||
| observations[stateB].ScopeId.ShouldBe(observations[stateC].ScopeId); | ||
|
|
||
| // Each state should get its own transient instance (isolated cached provider) | ||
| observations[stateA].TransientId.ShouldNotBe(observations[stateB].TransientId); | ||
| observations[stateB].TransientId.ShouldNotBe(observations[stateC].TransientId); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task Single_State_Calls_Should_Use_Separate_Scopes() | ||
| { | ||
| var observations = new ConcurrentDictionary<MyStateEntity, Observation>(); | ||
| var checker = new ScopeProbeStateChecker(observations); | ||
|
|
||
| var stateA = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| stateA.AddSimpleStateChecker(checker); | ||
|
|
||
| var stateB = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| stateB.AddSimpleStateChecker(checker); | ||
|
|
||
| await SimpleStateCheckerManager.IsEnabledAsync(stateA); | ||
| await SimpleStateCheckerManager.IsEnabledAsync(stateB); | ||
|
|
||
| observations.Count.ShouldBe(2); | ||
|
|
||
| // Single-state calls should each get their own scope | ||
| observations[stateA].ScopeId.ShouldNotBe(observations[stateB].ScopeId); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task Nested_Single_State_Call_From_Batch_Checker_Should_Get_Own_Scope() | ||
| { | ||
| var observations = new ConcurrentDictionary<MyStateEntity, Observation>(); | ||
|
|
||
| // This state will be evaluated via a nested single-state call during batch evaluation | ||
| var nestedState = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| nestedState.AddSimpleStateChecker(new ScopeProbeStateChecker(observations)); | ||
|
|
||
| // This checker triggers a nested IsEnabledAsync(state) during batch evaluation | ||
| var nestedCallChecker = new NestedSingleCallChecker( | ||
| SimpleStateCheckerManager, nestedState, observations); | ||
|
|
||
| var batchState = new MyStateEntity | ||
| { | ||
| CreationTime = DateTime.Parse("2021-01-01", CultureInfo.InvariantCulture) | ||
| }; | ||
| batchState.AddSimpleStateChecker(nestedCallChecker); | ||
|
|
||
| await SimpleStateCheckerManager.IsEnabledAsync(new[] { batchState }); | ||
|
|
||
| observations.Count.ShouldBe(2); | ||
|
|
||
| // The nested single-state call should get its own scope, not the batch scope | ||
| observations[batchState].ScopeId.ShouldNotBe(observations[nestedState].ScopeId); | ||
| } | ||
|
|
||
| public record Observation(Guid ScopeId, Guid TransientId); | ||
|
|
||
| public class ScopeIdProbe | ||
| { | ||
| public Guid Id { get; } = Guid.NewGuid(); | ||
| } | ||
|
|
||
| public class TransientIdProbe | ||
| { | ||
| public Guid Id { get; } = Guid.NewGuid(); | ||
| } | ||
|
|
||
| public class ScopeProbeStateChecker : ISimpleStateChecker<MyStateEntity> | ||
| { | ||
| private readonly ConcurrentDictionary<MyStateEntity, Observation> _observations; | ||
|
|
||
| public ScopeProbeStateChecker( | ||
| ConcurrentDictionary<MyStateEntity, Observation> observations) | ||
| { | ||
| _observations = observations; | ||
| } | ||
|
|
||
| public Task<bool> IsEnabledAsync(SimpleStateCheckerContext<MyStateEntity> context) | ||
| { | ||
| var scopeProbe = context.ServiceProvider.GetRequiredService<ScopeIdProbe>(); | ||
| var transientProbe = context.ServiceProvider.GetRequiredService<TransientIdProbe>(); | ||
| _observations[context.State] = new Observation(scopeProbe.Id, transientProbe.Id); | ||
| return Task.FromResult(true); | ||
| } | ||
| } | ||
|
|
||
| public class NestedSingleCallChecker : ISimpleStateChecker<MyStateEntity> | ||
| { | ||
| private readonly ISimpleStateCheckerManager<MyStateEntity> _manager; | ||
| private readonly MyStateEntity _nestedState; | ||
| private readonly ConcurrentDictionary<MyStateEntity, Observation> _observations; | ||
|
|
||
| public NestedSingleCallChecker( | ||
| ISimpleStateCheckerManager<MyStateEntity> manager, | ||
| MyStateEntity nestedState, | ||
| ConcurrentDictionary<MyStateEntity, Observation> observations) | ||
| { | ||
| _manager = manager; | ||
| _nestedState = nestedState; | ||
| _observations = observations; | ||
| } | ||
|
|
||
| public async Task<bool> IsEnabledAsync(SimpleStateCheckerContext<MyStateEntity> context) | ||
| { | ||
| var scopeProbe = context.ServiceProvider.GetRequiredService<ScopeIdProbe>(); | ||
| var transientProbe = context.ServiceProvider.GetRequiredService<TransientIdProbe>(); | ||
| _observations[context.State] = new Observation(scopeProbe.Id, transientProbe.Id); | ||
|
|
||
| // Trigger a nested single-state call during batch evaluation | ||
| await _manager.IsEnabledAsync(_nestedState); | ||
|
|
||
| return true; | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.