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.

Sign up for GitHub

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

Jump to bottom

grpc: Deprecate WithBlock, WithReturnConnectionError, FailOnNonTempDialError #7097

Merged
merged 3 commits into from
Apr 5, 2024
Merged

grpc: Deprecate WithBlock, WithReturnConnectionError, FailOnNonTempDialError #7097

merged 3 commits into from
Apr 5, 2024

Conversation

pellared
Copy link
Contributor

@pellared pellared commented Apr 4, 2024 •
edited

Fixes #7095

Notice in NewClient GoDoc comment that FailOnNonTempDialError dial option is ignored.

Deprecate options that are ignored by NewClient function.
These options are only supported by deprecated Dial and DialContext functions.

RELEASE NOTES:

  • grpc: Deprecate WithBlock, WithReturnConnectionError, FailOnNonTempDialError which are ignored by NewClient

@pellared pellared mentioned this pull request Apr 4, 2024
Closed
@codecov Codecov
Copy link

codecov bot commented Apr 4, 2024 •
edited

Codecov Report

Merging #7097 (cbdf351) into master (c31cec3) will increase coverage by 0.04%.
The diff coverage is n/a.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #7097      +/-   ##
==========================================
+ Coverage   81.28%   81.32%   +0.04%     
==========================================
  Files         345      345              
  Lines       33925    33925              
==========================================
+ Hits        27577    27591      +14     
+ Misses       5184     5175       -9     
+ Partials     1164     1159       -5
Files Coverage Δ
clientconn.go 92.70% <ø> (ø)
dialoptions.go 89.16% <ø> (ø)

... and 22 files with indirect coverage changes

@pellared
Copy link
Contributor Author

pellared commented Apr 4, 2024

I guess Type: Documentation label can be added.

@dfawley dfawley added the Type: Documentation Documentation or examples label Apr 5, 2024
@dfawley dfawley added this to the 1.64 Release milestone Apr 5, 2024
dfawley
dfawley approved these changes Apr 5, 2024
View reviewed changes
Copy link
Member

@dfawley dfawley left a comment

Choose a reason for hiding this comment

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

Thank you for the PR. Two small requests, otherwise LGTM!

dialoptions.go Outdated
Comment on lines 321 to 323
//
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
// later release.
Copy link
Member

Choose a reason for hiding this comment

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

Could you please remove this experimental warning and we'll just call it supported now ("throughout 1.x")?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

PTAL cce3000

dialoptions.go Outdated
Comment on lines 479 to 481
//
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
// later release.
Copy link
Member

Choose a reason for hiding this comment

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

For this one, I'd say we should delete "experimental", but we probably want to reserve the right to remove it. IIRC this makes its way through multiple layers of our library and might be more painful to maintain long-term.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

PTAL cbdf351

dfawley
dfawley approved these changes Apr 5, 2024
View reviewed changes
Copy link
Member

@dfawley dfawley left a comment

Choose a reason for hiding this comment

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

Looks great, thank you!

@pellared
Copy link
Contributor Author

pellared commented Apr 5, 2024 •
edited

Someone can fix vet failure for me: https://github.com/grpc/grpc-go/actions/runs/8573454634/job/23498177256?pr=7097

Otherwise I will fix it on Monday (I made changes on mobile)

@dfawley dfawley requested a review from arvindbr8 April 5, 2024 17:24
@dfawley
Copy link
Member

dfawley commented Apr 5, 2024

Someone can fix vet failure for me

This is an optional checker, and the current breakage is caused by an upstream change. No need to do anything for this PR.

arvindbr8
arvindbr8 approved these changes Apr 5, 2024
View reviewed changes
Copy link
Member

@arvindbr8 arvindbr8 left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks for the PR @pellared

@arvindbr8 arvindbr8 merged commit 59be823 into grpc:master Apr 5, 2024
13 of 14 checks passed
@pellared pellared deleted the depr-dial-opts branch April 5, 2024 17:35
@odsod odsod mentioned this pull request May 22, 2024
Merged
@masa213f masa213f mentioned this pull request Jul 11, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arvindbr8 arvindbr8 arvindbr8 approved these changes

@dfawley dfawley dfawley approved these changes

Assignees

@arvindbr8 arvindbr8

Labels
Type: Documentation Documentation or examples
Projects
None yet
Milestone
1.64 Release
Development

Successfully merging this pull request may close these issues.

Deprecate WithBlock and WithReturnConnectionError
3 participants
@pellared @dfawley @arvindbr8