Skip to content

Throw ArgumentNullExceptions for null arguments#570

Merged
lemillermicrosoft merged 6 commits into
microsoft:mainfrom
stephentoub:argnull
Apr 27, 2023
Merged

Throw ArgumentNullExceptions for null arguments#570
lemillermicrosoft merged 6 commits into
microsoft:mainfrom
stephentoub:argnull

Conversation

@stephentoub

Copy link
Copy Markdown
Member

Motivation and Context

Use ArgumentNullException as devs expect, and avoid exception-related work when not throwing.

Description

.NET developers expect that passing null erroneously to a method will result in an ArgumentNullException, but currently it's resulting in a custom ValidationException.

There are also places where string interpolation is being used to create the error message; the work and allocation associated with that interpolation is going to happen regardless of whether the exception is thrown or not.

Contribution Checklist

.NET developers expect that passing null erroneously to a method will result in an ArgumentNullException, but currently it's resulting in a custom ValidationException.

There are also places where string interpolation is being used to create the error message; the work and allocation associated with that interpolation is going to happen regardless of whether the exception is thrown or not.
@lemillermicrosoft lemillermicrosoft added kernel.core PR: ready for review All feedback addressed, ready for reviews labels Apr 21, 2023
@MovGP0

MovGP0 commented Apr 21, 2023

Copy link
Copy Markdown

LGTM.

💡 A code weaver like Fody.NullGuard or a Roslyn code generator might be helpful in replacing all those runtime null checks.

Comment thread dotnet/src/SemanticKernel.Abstractions/Diagnostics/Verify.cs
Comment thread dotnet/src/SemanticKernel/Planning/FunctionFlowRunner.cs Outdated
@lemillermicrosoft lemillermicrosoft added PR: ready to merge PR has been approved by all reviewers, and is ready to merge. PR: feedback to address Waiting for PR owner to address comments/questions and removed PR: ready to merge PR has been approved by all reviewers, and is ready to merge. labels Apr 21, 2023
Comment thread dotnet/src/Connectors/Connectors.AI.OpenAI/AzureSdk/ClientBase.cs
@github-actions github-actions Bot added the .NET Issue or Pull requests regarding .NET code label Apr 23, 2023
@lemillermicrosoft lemillermicrosoft added PR: ready to merge PR has been approved by all reviewers, and is ready to merge. and removed PR: feedback to address Waiting for PR owner to address comments/questions labels Apr 27, 2023
@lemillermicrosoft

Copy link
Copy Markdown
Member

@stephentoub looks like there are some conflicts that need to be resolved before merging.

@stephentoub

Copy link
Copy Markdown
Member Author

looks like there are some conflicts that need to be resolved before merging.

Done. Thanks.

@lemillermicrosoft lemillermicrosoft merged commit 7e30a4e into microsoft:main Apr 27, 2023
dluc pushed a commit that referenced this pull request Apr 29, 2023
### Motivation and Context

Use ArgumentNullException as devs expect, and avoid exception-related
work when not throwing.

### Description

.NET developers expect that passing null erroneously to a method will
result in an ArgumentNullException, but currently it's resulting in a
custom ValidationException.

There are also places where string interpolation is being used to create
the error message; the work and allocation associated with that
interpolation is going to happen regardless of whether the exception is
thrown or not.
dehoward pushed a commit to lemillermicrosoft/semantic-kernel that referenced this pull request Jun 1, 2023
### Motivation and Context

Use ArgumentNullException as devs expect, and avoid exception-related
work when not throwing.

### Description

.NET developers expect that passing null erroneously to a method will
result in an ArgumentNullException, but currently it's resulting in a
custom ValidationException.

There are also places where string interpolation is being used to create
the error message; the work and allocation associated with that
interpolation is going to happen regardless of whether the exception is
thrown or not.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

.NET Issue or Pull requests regarding .NET code PR: ready for review All feedback addressed, ready for reviews PR: ready to merge PR has been approved by all reviewers, and is ready to merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants