Fix ArgumentException in OpenApiCSharpCodeGenerator.Sanitize method #1163
Conversation
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
Co-authored-by: christianhelle <710400+christianhelle@users.noreply.github.com>
Copilot
AI
changed the title
Copilot finished work on behalf of
christianhelle
May 19, 2025 21:35
|
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an ArgumentException in the Sanitize method by switching from a null replacement to an empty string and adds a unit test to verify removal of the using System.Net.Mime; line.
- Change
String.Replaceto use""instead ofnull - Add a test to confirm the
Sanitizemethod strips the mimeusingstatement
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Core/ApiClientCodeGen.Core/Generators/OpenApi/OpenApiCSharpCodeGenerator.cs | Replace null with "" in Sanitize to prevent exception |
| src/Core/ApiClientCodeGen.Core.Tests/Generators/OpenApi/OpenApiCSharpCodeGeneratorSanitizeTests.cs | Introduce a unit test for the Sanitize method |
Comments suppressed due to low confidence (1)
src/Core/ApiClientCodeGen.Core.Tests/Generators/OpenApi/OpenApiCSharpCodeGeneratorSanitizeTests.cs:9
- Add a test case where the input code does not contain
using System.Net.Mime;to ensureSanitizereturns the original string unchanged.
[Fact]
| @@ -167,6 +167,6 @@ public string GenerateCode(IProgressReporter? pGenerateProgress) | |||
| } | |||
|
|
|||
| private static string Sanitize(string code) => | |||
| code.Replace("using System.Net.Mime;", null); | |||
| code.Replace("using System.Net.Mime;", ""); | |||
There was a problem hiding this comment.
[nitpick] Consider using string.Empty instead of "" to improve readability and express intent more clearly.
Suggested change
| code.Replace("using System.Net.Mime;", ""); | |
| code.Replace("using System.Net.Mime;", string.Empty); |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue Description
When generating C# code from OpenAPI specifications, users were experiencing a
System.ArgumentExceptionwith the message "String cannot be of zero length. Parameter name: oldValue". This occurred in theSanitizemethod of theOpenApiCSharpCodeGeneratorclass.Root Cause
The issue was in the
Sanitizemethod where it was usingnullas the replacement value in theString.Replace()method:In C#, passing
nullas the replacement value toString.Replace()can cause the "String cannot be of zero length" exception.Solution
The fix was to change the
nullvalue to an empty string:This ensures that the
String.Replace()method works as expected and removes the "using System.Net.Mime;" statement from the generated code without throwing an exception.Testing
A unit test was added to verify that the
Sanitizemethod correctly removes the "using System.Net.Mime;" statement from the generated code.Fixes #1157.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
crl3.digicert.comdotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj(dns block)dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi(dns block)crl4.digicert.comdotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj(dns block)dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi(dns block)ocsp.digicert.comdotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj(dns block)dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi(dns block)/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)petstore.swagger.io/usr/lib/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/apiclientcodegen/apiclientcodegen/src/Core/ApiClientCodeGen.Core.Tests/bin/Debug/net8.0/ApiClientCodeGen.Core.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/apiclientcodegen/apiclientcodegen/src/Core/ApiClientCodeGen.Core.Tests/bin/Debug/net8.0/ApiClientCodeGen.Core.Tests.deps.json /home/REDACTED/work/apiclientcodegen/apiclientcodegen/src/Core/ApiClientCodeGen.Core.Tests/bin/Debug/net8.0/testhost.dll --port 39373 --endpoint 127.0.0.1:039373 --role client --parentprocessid 3545 --telemetryoptedin false(dns block)s.symcb.comdotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj(dns block)dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi(dns block)s.symcd.comdotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj(dns block)dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi(dns block)ts-crl.ws.symantec.comdotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj(dns block)dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi(dns block)ts-ocsp.ws.symantec.comdotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj(dns block)dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi(dns block)www.microsoft.comdotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj(dns block)dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.