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

add axios abort signal #4282

Merged
merged 2 commits into from
May 3, 2023

Conversation

fmg-lydonchandra
Copy link
Contributor

@fmg-lydonchandra fmg-lydonchandra commented Dec 13, 2022

If Axios AbortSignal is checked, then use AbortSignal (instead of CancelToken)
image

image

@fmg-lydonchandra fmg-lydonchandra marked this pull request as ready for review December 13, 2022 10:05
@fmg-lydonchandra
Copy link
Contributor Author

Hi, other than unit tests (adding them tomorrow), is there anything that needs to be done as part of this PR ?

@fmg-lydonchandra
Copy link
Contributor Author

hi @RicoSuter , review please :-)

Copy link

@BenJenkinson BenJenkinson left a comment

Choose a reason for hiding this comment

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

I was going to create my own PR, but this is great, thank you!


The CancelToken type is imported from axios in the File.liquid template.

eslint flags the unused import if CancelToken isn't used in the client.

import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
{%- else -%}
import axios, { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';

Could you apply the {% if UseAbortSignal %} logic there as well?

@jontcarroll
Copy link

Would love to see this PR make it in soon, we are currently dealing with a lot of unwanted behavior when requests are aborted.

@chihabhajji
Copy link

SITREP ?

@RicoSuter RicoSuter merged commit 73ac020 into RicoSuter:master May 3, 2023
shuruev added a commit to servicetitan/NSwag that referenced this pull request Nov 16, 2023
* Update README.md

* Add nswag.cmd (RicoSuter#4255)

* v13.18.1

* v13.18.2

* Remove description from OpenApiResponse when serializing for Swagger v2 (RicoSuter#4314)

* Remove description from OpenApiResponse when serializing for Swagger v2 to prevent error "Structural error at paths.somepath.get.responses.304 should NOT have additional properties additionalProperty: description" [PR].

* Remove description from OpenApiResponse when serializing for Swagger v2 to prevent error "Structural error at paths.somepath.get.responses.304 should NOT have additional properties additionalProperty: description" [PR].

* Add check for IsBindingAllowed so that BindNever attribute works correctly

* Add CS0612 to the File.Header.liquid (RicoSuter#4409)

OpenApi which contains deprecated schemas correctly generates `[Obsolete]` attribute. If the API document does not propagate `deprecate` all the way to path/method resulting c# code produce warning CS0612: '...' is obsolete

* Update Client.Class.liquid (RicoSuter#4402)

Fix Newtonsoft.Json being used instead of System.Text.Json

* Descriptive exception for duplicate XML doc line (RicoSuter#2863) (RicoSuter#4388)

Duplicate response code in XML documentation response xml tag causes
somewhat hard to debug exception, which is now made more descriptive.

Did not yet figure out how to make an unit test for this one or if some
other other exception type would be more suitable than
InvalidOperationException.

Bug: Duplicate return code declaration causes nasty exception
id: RicoSuter#2863

Co-authored-by: Antti Viita <antti.viita@vividworks.com>

* Revert PR RicoSuter#4314

* v13.18.3

* Improve NRT support for API parameters

* Required path parameters are not nullable (when NRT is off)

* v13.18.4

* Add enforceNotNull parameter and use for required path parameters

* v13.18.5

* Add File.Footer.liquid (RicoSuter#4411)

* Swagger UI v4.18.3, closes RicoSuter#4311 and RicoSuter#4387 (v13.18.5)

* add axios abort signal (RicoSuter#4282)

* add axios abort signal

* unit test

* Add support for MSBuild transitive dependency flow RicoSuter#4026 (RicoSuter#4338)

* Use GNU tar for cache and install .NET in single step (RicoSuter#4251)

* Unwrap ValueTask<T> return types (RicoSuter#4374)

* Unwrap ValueTask<T> return types, same as Task<T>, unwrap (Value)Task<ActionResult<T>> and unify unwrapping for consistency RicoSuter#4373

* lahma suggestion for performance

* cleanup

* NJsonSchema v10.9.0

* Fix build

* Revert "Fix build"

This reverts commit 21bf926.

* Fix build

* Fix dep

* Add .NET 5 SDK

* Improve build

* v13.19.0

* fix default value docs of SerializeTypeInformation, closes RicoSuter#4480

* Add SwaggerRoutesFactory to SwaggerUi3Settings

* Disable warning CS8604 "Possible null reference argument for parameter" in generated code (RicoSuter#4422)

* Disable warning CS8604 "Possible null reference argument for parameter" in code generation file header template

* Restore warning in file footer

* Update Client.Class.liquid (RicoSuter#4471)

* Update Client.Class.liquid

fix RicoSuter#4466

* Update Client.Class.liquid

---------

Co-authored-by: Rico Suter <mail@rsuter.com>

* install .net 3.1 sdk

* v13.20.0

* Set ChocolateyPush source

* Post-merge adjustments

* Updated more Newtonsoft.Json versions, for consistency

---------

Co-authored-by: Rico Suter <mail@rsuter.com>
Co-authored-by: Patrick Hofman <PatrickHofman@users.noreply.github.com>
Co-authored-by: Jan Trejbal <jan@trejbal.land>
Co-authored-by: Jean-Luc <jeanluc1@live.de>
Co-authored-by: Antti Viita <aviita@gmail.com>
Co-authored-by: Antti Viita <antti.viita@vividworks.com>
Co-authored-by: Rico Suter <rico.suter@buhlergroup.com>
Co-authored-by: Lydon Chandra <104476360+fmg-lydonchandra@users.noreply.github.com>
Co-authored-by: Daniel Sack <danielthecoder@outlook.com>
Co-authored-by: Marko Lahma <marko.lahma@gmail.com>
Co-authored-by: Alasdair <alasdaircs@gmail.com>
Co-authored-by: Noah Stolk <noah.stolk@gmail.com>
Co-authored-by: Alireza Mahdavi <alireza.mahdavi2125@outlook.com>
lahma pushed a commit to lahma/NSwag that referenced this pull request Jan 20, 2024
* add axios abort signal

* unit test
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.

5 participants