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

context cancellation semantics, errors, etc..., are incomplete #1272

Closed
necro351 opened this issue May 22, 2021 · 5 comments
Closed

context cancellation semantics, errors, etc..., are incomplete #1272

necro351 opened this issue May 22, 2021 · 5 comments
Labels
bug This issue is a bug. documentation This is a problem with documentation. p3 This is a minor priority issue s Effort estimation: small

Comments

@necro351
Copy link

Describe the issue with documentation
The documentation does not describe how to use contexts with the API. When an API call is interrupted because the caller cancels the context the documentation does not describe which error is returned. The documentation does not describe whether the error is only returned IFF the context which was passed in returns non-nil if you call its Err() method.

To Reproduce (observed behavior)
Google search context canceled error with golang sdk v2 and read through sdk's docs and find no information on the topic.

Expected behavior
Should find example code showing how to check if an API call failed because its context was canceled. Should find clear rules about the relationship between the ctx which was passed in and the error returned by the API, e.g., ctx.Err() != nil IFF the API returns an error that wraps smithy.CanceledError.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.

@necro351 necro351 added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels May 22, 2021
@KaibaLopez
Copy link
Contributor

Hmmm yea I think this is a reasonable ask, we'll look into adding to our documentation.

@KaibaLopez KaibaLopez removed the needs-triage This issue or PR still needs to be triaged. label Jul 15, 2021
@github-actions
Copy link

We have noticed this issue has not received attention in 1 year. We will close this issue for now. If you think this is in error, please feel free to comment and reopen the issue.

@github-actions github-actions bot added the closing-soon This issue will automatically close in 4 days unless further comments are made. label Jul 16, 2022
@yerke
Copy link

yerke commented Jul 19, 2022

I think this is still a problem. Is it possible to address it please?

@github-actions github-actions bot removed the closing-soon This issue will automatically close in 4 days unless further comments are made. label Jul 20, 2022
@RanVaknin RanVaknin added p3 This is a minor priority issue s Effort estimation: small labels Nov 7, 2022
@RanVaknin RanVaknin added the bug This issue is a bug. label Mar 12, 2024
@RanVaknin
Copy link
Contributor

Hi there,

We have a section in our developer guide about timeouts and context. https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/retries-timeouts/#timeouts

Since context is a general and broad Golang concept and not SDK specific Im going to close this issue.

Thanks,
Ran~

@RanVaknin RanVaknin closed this as not planned Won't fix, can't repro, duplicate, stale May 2, 2024
Copy link

github-actions bot commented May 2, 2024

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. documentation This is a problem with documentation. p3 This is a minor priority issue s Effort estimation: small
Projects
None yet
Development

No branches or pull requests

4 participants