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

Deprecate WithBlock and WithReturnConnectionError #7095

Closed
pellared opened this issue Apr 4, 2024 · 3 comments · Fixed by #7097
Closed

Deprecate WithBlock and WithReturnConnectionError #7095

pellared opened this issue Apr 4, 2024 · 3 comments · Fixed by #7097
Labels
Status: Help Wanted Type: Feature New features or improvements in behavior

Comments

@pellared
Copy link
Contributor

pellared commented Apr 4, 2024

Use case(s) - what problem will this feature solve?

#7029 has deprecated Dial and DialContext.
NewClient ignores WithBlock, WithTimeout, WithReturnConnectionError.

grpc.WithTimeout is already deprecated.

WithBlock and WithReturnConnectionError have a GoDoc comment which discourages its usage.

Proposed Solution

Deprecate WithBlock and WithReturnConnectionError so to better notify that these options should not be used and additionally that they are ignored by NewClient.

Deprecation is more visible in https://pkg.go.dev/google.golang.org/grpc and more usable for static analysis tools such as golangci-lint.

@dfawley
Copy link
Member

dfawley commented Apr 4, 2024

Thank you for creating this issue. I had not realized these functions were not already tagged as "deprecated" properly. Let's do that.

@pellared
Copy link
Contributor Author

pellared commented Apr 4, 2024

@dfawley I think that FailOnNonTempDialError can also be deprecated. Can you please double-check that?

EDIT: I created #7097

@dfawley
Copy link
Member

dfawley commented Apr 4, 2024

@dfawley I think that FailOnNonTempDialError can also be deprecated. Can you please double-check that?

Yes, that sounds right to me, thanks!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Status: Help Wanted Type: Feature New features or improvements in behavior
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants