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 ResumableTask to URLSessionImplementations.mustache #18438

Merged

Conversation

welshm
Copy link
Contributor

@welshm welshm commented Apr 19, 2024

Add ResumableTask to URLSessionImplementations.mustache

  • Makes it testable
  • Implementations can return something other than a URLSessionDataTask if they want to implement another request format (sockets maybe?)
  • Default implementation for URLSession provided

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.1.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.

@jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz-ah (2017/09) @4brunu (2019/11) @dydus0x14 (2023/06)

- Makes it testable
- Implementations can return something _other_ than a URLSessionDataTask if they want to implement another request format (sockets maybe?)
- Default implementation for `URLSession` provided
@welshm
Copy link
Contributor Author

welshm commented Apr 19, 2024

@jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz-ah (2017/09) @4brunu (2019/11) @dydus0x14 (2023/06)

Please review when you can - I am trying to make it a bit more testable.

Default implementation still works as-is

@4brunu
Copy link
Contributor

4brunu commented Apr 22, 2024

Hi, first of all thanks for creating this PR.
It's a nice improvement.
The idea and the implementation looks good.
I'm just not sure about the naming URLSessionTask -> CancellableResumableTask and func dataTask(...) -> URLSessionDataTask -> func resumableTask(...) -> CancellableResumableTask.
I'm not sure if we should use different names like you propose or if we should use names similar to the original like URLSessionTask -> URLSessionTaskProtocol and func dataTask(...) -> URLSessionDataTask -> func dataTask(...) -> URLSessionDataTaskProtocol.
And we already have a URLSessionProtocol which would be more similar to the second option.
What do you think?

@welshm
Copy link
Contributor Author

welshm commented Apr 22, 2024

Hi, first of all thanks for creating this PR.

It's a nice improvement.

The idea and the implementation looks good.

I'm just not sure about the naming URLSessionTask -> CancellableResumableTask and func dataTask(...) -> URLSessionDataTask -> func resumableTask(...) -> CancellableResumableTask.

I'm not sure if we should use different names like you propose or if we should use names similar to the original like URLSessionTask -> URLSessionTaskProtocol and func dataTask(...) -> URLSessionDataTask -> func dataTask(...) -> URLSessionDataTaskProtocol.

And we already have a URLSessionProtocol which would be more similar to the second option.

What do you think?

Happy to rename! I think your suggestions make sense.

URLSessionDataTaskProtocol

I think the function name needs to be different to disambiguate between the original implementation and protocol function. Otherwise how will the compiler know which to call if you do...

let task: URLSessionDataTaskProtocol = session.dataTask(...)

Both functions would be eligible - so I think it will need a different name or different argument names.

How about...

dataTaskFromProtocol(...) ?

@4brunu
Copy link
Contributor

4brunu commented Apr 22, 2024

Looks good to me 👍

Rename from `resumableTask` to `dataTaskFromProtocol`
@welshm
Copy link
Contributor Author

welshm commented Apr 22, 2024

Looks good to me 👍

Renamed and updated! Thank you for your comments and feedback 🙏

@4brunu 4brunu merged commit a724c75 into OpenAPITools:master Apr 22, 2024
32 checks passed
@4brunu
Copy link
Contributor

4brunu commented Apr 22, 2024

Looks good to me, thanks for the PR 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants