-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
Only set specific type of exception's data to errorInfo.Data.
#20812
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 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
7 changes: 6 additions & 1 deletion
7
...bp.ExceptionHandling/Volo/Abp/AspNetCore/ExceptionHandling/AbpExceptionHandlingOptions.cs
This file contains 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 |
|---|---|---|
| @@ -1,8 +1,13 @@ | ||
| namespace Volo.Abp.AspNetCore.ExceptionHandling; | ||
| using System; | ||
| using System.Collections.Generic; | ||
|
|
||
| namespace Volo.Abp.AspNetCore.ExceptionHandling; | ||
|
|
||
| public class AbpExceptionHandlingOptions | ||
| { | ||
| public bool SendExceptionsDetailsToClients { get; set; } = false; | ||
|
|
||
| public bool SendStackTraceToClients { get; set; } = true; | ||
|
|
||
| public List<Type> SendExceptionDataToClientTypes { get; } = new List<Type>(); | ||
| } |
This file contains 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
17 changes: 17 additions & 0 deletions
17
framework/test/Volo.Abp.ExceptionHandling.Tests/Volo.Abp.ExceptionHandling.Tests.csproj
This file contains 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,17 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <Import Project="..\..\..\common.test.props" /> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net8.0</TargetFramework> | ||
| <RootNamespace /> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\src\Volo.Abp.Autofac\Volo.Abp.Autofac.csproj" /> | ||
| <ProjectReference Include="..\..\src\Volo.Abp.ExceptionHandling\Volo.Abp.ExceptionHandling.csproj" /> | ||
| <ProjectReference Include="..\AbpTestBase\AbpTestBase.csproj" /> | ||
| <PackageReference Include="Microsoft.NET.Test.Sdk" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
11 changes: 11 additions & 0 deletions
11
...lo.Abp.ExceptionHandling.Tests/Volo/Abp/ExceptionHandling/AbpExceptionHandlingTestBase.cs
This file contains 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,11 @@ | ||
| using Volo.Abp.Testing; | ||
|
|
||
| namespace Volo.Abp.ExceptionHandling; | ||
|
|
||
| public class AbpExceptionHandlingTestBase : AbpIntegratedTest<AbpExceptionHandlingTestModule> | ||
| { | ||
| protected override void SetAbpApplicationCreationOptions(AbpApplicationCreationOptions options) | ||
| { | ||
| options.UseAutofac(); | ||
| } | ||
| } |
14 changes: 14 additions & 0 deletions
14
....Abp.ExceptionHandling.Tests/Volo/Abp/ExceptionHandling/AbpExceptionHandlingTestModule.cs
This file contains 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,14 @@ | ||
| using Volo.Abp.Autofac; | ||
| using Volo.Abp.Modularity; | ||
|
|
||
| namespace Volo.Abp.ExceptionHandling; | ||
|
|
||
| [DependsOn( | ||
| typeof(AbpExceptionHandlingModule), | ||
| typeof(AbpTestBaseModule), | ||
| typeof(AbpAutofacModule) | ||
| )] | ||
| public class AbpExceptionHandlingTestModule : AbpModule | ||
| { | ||
|
|
||
| } |
53 changes: 53 additions & 0 deletions
53
...ExceptionHandling.Tests/Volo/Abp/ExceptionHandling/ExceptionToErrorInfoConverter_Tests.cs
This file contains 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,53 @@ | ||
| using Shouldly; | ||
| using Volo.Abp.AspNetCore.ExceptionHandling; | ||
| using Xunit; | ||
|
|
||
| namespace Volo.Abp.ExceptionHandling; | ||
|
|
||
| public class ExceptionToErrorInfoConverter_Tests : AbpExceptionHandlingTestBase | ||
| { | ||
| private readonly IExceptionToErrorInfoConverter _exceptionToErrorInfoConverter; | ||
|
|
||
| public ExceptionToErrorInfoConverter_Tests() | ||
| { | ||
| _exceptionToErrorInfoConverter = GetRequiredService<IExceptionToErrorInfoConverter>(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void SendExceptionDataToClientTypes_Test() | ||
| { | ||
| var exception = new AbpException("test message") | ||
| { | ||
| Data = | ||
| { | ||
| ["my_data"] = "my_data_value", | ||
| ["my_data2"] = 42 | ||
| } | ||
| }; | ||
| var errorInfo = _exceptionToErrorInfoConverter.Convert(exception); | ||
| errorInfo.Data.ShouldBeNull(); | ||
|
|
||
| errorInfo = _exceptionToErrorInfoConverter.Convert(exception, options => | ||
| { | ||
| options.SendExceptionDataToClientTypes.Add(typeof(AbpException)); | ||
| }); | ||
| errorInfo.Data.ShouldNotBeNull(); | ||
| errorInfo.Data.Keys.Count.ShouldBe(2); | ||
| errorInfo.Data["my_data"].ShouldBe("my_data_value"); | ||
| errorInfo.Data["my_data2"].ShouldBe(42); | ||
|
|
||
| var businessException = new BusinessException("test message") | ||
| { | ||
| Data = | ||
| { | ||
| ["my_data"] = "my_data_value", | ||
| ["my_data2"] = 42 | ||
| } | ||
| }; | ||
| errorInfo = _exceptionToErrorInfoConverter.Convert(businessException); | ||
| errorInfo.Data.ShouldNotBeNull(); | ||
| errorInfo.Data.Keys.Count.ShouldBe(2); | ||
| errorInfo.Data["my_data"].ShouldBe("my_data_value"); | ||
| errorInfo.Data["my_data2"].ShouldBe(42); | ||
| } | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also pass the
SendExceptionDataToClientTypesparameter to the Convert method calls. Otherwise, we can't configure the default option as intended, since CreateDefaultOptions method only adds theIBusinessExceptioninterface.Current services that use this option:
AbpExceptionHandlingMiddleware,UserExceptionInformer,AbpExceptionFilter,AbpExceptionPageFilter, andErrorController.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bdbe95b