Skip to content

Fix ArgumentException in OpenApiCSharpCodeGenerator.Sanitize method #1163

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 4 commits into from
Jun 11, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 19, 2025

Issue Description

When generating C# code from OpenAPI specifications, users were experiencing a System.ArgumentException with the message "String cannot be of zero length. Parameter name: oldValue". This occurred in the Sanitize method of the OpenApiCSharpCodeGenerator class.

Root Cause

The issue was in the Sanitize method where it was using null as the replacement value in the String.Replace() method:

private static string Sanitize(string code) =>
    code.Replace("using System.Net.Mime;", null);

In C#, passing null as the replacement value to String.Replace() can cause the "String cannot be of zero length" exception.

Solution

The fix was to change the null value to an empty string:

private static string Sanitize(string code) =>
    code.Replace("using System.Net.Mime;", "");

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 Sanitize method 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.com
    • Triggering command: dotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj (dns block)
    • Triggering command: dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi (dns block)
  • crl4.digicert.com
    • Triggering command: dotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj (dns block)
    • Triggering command: dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi (dns block)
  • ocsp.digicert.com
    • Triggering command: dotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj (dns block)
    • Triggering command: dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi (dns block)
    • Triggering command: /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
    • Triggering command: /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.com
    • Triggering command: dotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj (dns block)
    • Triggering command: dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi (dns block)
  • s.symcd.com
    • Triggering command: dotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj (dns block)
    • Triggering command: dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi (dns block)
  • ts-crl.ws.symantec.com
    • Triggering command: dotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj (dns block)
    • Triggering command: dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi (dns block)
  • ts-ocsp.ws.symantec.com
    • Triggering command: dotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj (dns block)
    • Triggering command: dotnet test src/Core/ApiClientCodeGen.Core.Tests/ApiClientCodeGen.Core.Tests.csproj --filter FullyQualifiedName~Rapicgen.Core.Generators.OpenApi (dns block)
  • www.microsoft.com
    • Triggering command: dotnet build src/Core/ApiClientCodeGen.Core/ApiClientCodeGen.Core.csproj (dns block)
    • Triggering command: 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.

Co-authored-by: christianhelle <710400+christianhelle@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Argument null exception Fix ArgumentException in OpenApiCSharpCodeGenerator.Sanitize method May 19, 2025
@Copilot Copilot AI requested a review from christianhelle May 19, 2025 21:34
Copilot finished work on behalf of christianhelle May 19, 2025 21:35
@christianhelle christianhelle requested a review from Copilot May 22, 2025 07:44
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.Replace to use "" instead of null
  • Add a test to confirm the Sanitize method strips the mime using statement

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 ensure Sanitize returns the original string unchanged.
[Fact]

@netpirates
Copy link

netpirates commented Jun 8, 2025

Hi, I took the latest update and try to generate client from openAPIspec. still I see same error in VS2022.
String cannot be of zero length.
Parameter name: oldValue
Severity Code Description Project File Line Suppression State
Error (active) String cannot be of zero length.
Parameter name: oldValue WebApplication1 WebApplication1\WebApplication1\APIClient 1

Severity Code Description Project File Line Suppression State
Error (active) OpenApiCSharpCodeGenerator WebApplication1 WebApplication1\WebApplication1\APIClient 1

If i try the same in VS2019 i get below error
6/8/2025 10:55:12 AM: System.ArgumentException: String cannot be of zero length.
Parameter name: oldValue
at System.String.ReplaceInternal(String oldValue, String newValue)
at System.String.Replace(String oldValue, String newValue)
at Rapicgen.Core.Generators.OpenApi.OpenApiCSharpCodeGenerator.GenerateCode(IProgressReporter pGenerateProgress) in D:\a\apiclientcodegen\apiclientcodegen\src\Core\ApiClientCodeGen.Core\Generators\OpenApi\OpenApiCSharpCodeGenerator.cs:line 84
at Rapicgen.CustomTool.SingleFileCodeGenerator.Generate(String wszInputFilePath, String bstrInputFileContents, String wszDefaultNamespace, IntPtr[] rgbOutputFileContents, UInt32& pcbOutput, IVsGeneratorProgress pGenerateProgress)
6/8/2025 10:55:12 AM: System.ArgumentException: String cannot be of zero length.
Parameter name: oldValue
at System.String.ReplaceInternal(String oldValue, String newValue)
at System.String.Replace(String oldValue, String newValue)
at Rapicgen.Core.Generators.OpenApi.OpenApiCSharpCodeGenerator.GenerateCode(IProgressReporter pGenerateProgress) in D:\a\apiclientcodegen\apiclientcodegen\src\Core\ApiClientCodeGen.Core\Generators\OpenApi\OpenApiCSharpCodeGenerator.cs:line 84
at Rapicgen.CustomTool.SingleFileCodeGenerator.Generate(String wszInputFilePath, String bstrInputFileContents, String wszDefaultNamespace, IntPtr[] rgbOutputFileContents, UInt32& pcbOutput, IVsGeneratorProgress pGenerateProgress)
6/8/2025 10:55:13 AM: Unable to generate code

…pCodeGenerator.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link

coderabbitai bot commented Jun 10, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

… ensure extension is not null before processing
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
25.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

@christianhelle christianhelle marked this pull request as ready for review June 11, 2025 14:15
@christianhelle christianhelle merged commit f632dfc into master Jun 11, 2025
39 of 46 checks passed
@christianhelle christianhelle deleted the copilot/fix-1157 branch June 11, 2025 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Argument null exception
3 participants