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] Add useVirtualForHooks option #20705

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sbward
Copy link

@sbward sbward commented Feb 22, 2025

When using C# OpenAPI clients with HttpClient or RestSharp from a browser via WASM (such as in Blazor WASM) it can be necessary to customize the HttpClient or RestRequest before sending it. In my case I need to invoke httpRequestMessage.SetBrowserRequestCredentials(BrowserRequestCredentials.Include) on the underlying HTTP request so that the browser's secure cookies are included with the request.

To achieve this in a backwards-compatible way I've introduced the useVirtualForHooks option for C#, which alters the definition of the InterceptRequest and InterceptResponse hooks to become public virtual methods, allowing the end-user to define custom HTTP request hooks. Technically I only need the InterceptRequest hook, but I've included InterceptResponse for consistency and because it might be useful for other situations in a browser context.

CC: @wing328 This is the result of our discussion about #20015
CC: C# technical committee (@mandrean @shibayan @Blackclaws @lucamazzanti @iBicha)

Fixes #14609

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.

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.

[REQ] csharp generators - Enable override of InterceptRequest and InterceptResponse
1 participant