Skip to content
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

[csharp] Address MaxTimeout obsolete build warning #19875

Conversation

alec-petersen
Copy link
Contributor

@alec-petersen alec-petersen commented Oct 15, 2024

@wing328 , this adds that option to enable use of MaxTimeout over Timeout, but it defaults to the non-obsolete option by default. Fix #19525.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@alec-petersen alec-petersen marked this pull request as ready for review October 15, 2024 13:03
@wing328 wing328 added Breaking change (with fallback) Client: C-Sharp Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc. labels Oct 15, 2024
@alec-petersen alec-petersen force-pushed the address-timeout-obsolete-build-warning branch from 379d455 to 69b59eb Compare October 15, 2024 17:43
@alec-petersen
Copy link
Contributor Author

Good news @wing328! We can actually simplify down and lose the fallback config option. RestSharp already disregards MaxTimeout and uses the Timeout value, so setting Timeout will have the desired effect of using MaxTimeout.

[Obsolete("Use Timeout instead.")]
public int MaxTimeout {
    get => (int) (Timeout?.TotalMilliseconds ?? 0);
    set => Timeout = TimeSpan.FromMilliseconds(value);
}

@alec-petersen alec-petersen force-pushed the address-timeout-obsolete-build-warning branch from 4ecccc6 to ec8bda4 Compare October 16, 2024 01:36
@wing328
Copy link
Member

wing328 commented Oct 16, 2024

/// </summary>
public virtual int Timeout { get; set; }
public virtual TimeSpan Timeout { get; set; }
Copy link
Member

Choose a reason for hiding this comment

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

if users call the getter of Timeout in their code, they will need to update their code accordingly updating the C# client to a newer version including this change, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Correct, if they use the 7.10.0 version of the generator to generate their client, they will need to update usages of Timeout.

@alec-petersen alec-petersen force-pushed the address-timeout-obsolete-build-warning branch from 3783085 to ec8bda4 Compare October 16, 2024 19:35
@wing328 wing328 merged commit bbccd28 into OpenAPITools:master Nov 9, 2024
33 of 37 checks passed
@wing328
Copy link
Member

wing328 commented Nov 9, 2024

Added an option useIntForTimeout for fallback via #20069, e.g. --addititional-properties useIntForTimeout=true in CLI

@wing328 wing328 added this to the 7.10.0 milestone Nov 9, 2024
@alec-petersen alec-petersen deleted the address-timeout-obsolete-build-warning branch November 9, 2024 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking change (with fallback) Client: C-Sharp Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] [csharp] Obsolete build warnings after PR to update to RestSharp 112.0.0
2 participants