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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Close idle conns when closing consul topo #15975

Closed

Conversation

timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented May 18, 2024

Description

The *api.Config struct for the Consul client (in go/vt/topo/consultopo) holds a *http.Transport in the config, which is long-lived 馃槙

This object being in the "config" can cause idle connections to be left open when .Close() is called on the Consul topo implementation, which currently does nothing with the *http.Transport. This usually won't matter - the idle conn will eventually get closed, but the fact all connections are not closed on .Close() can cause unit test failures Slack sees on a yet-to-upstream patch

This PR:

  1. Calls .CloseIdleConnections() on the *http.Transport in the .Close() of the consul topo. This ensures that the idle connections the long-lived *http.Transport holds are closed
  2. Add a defer topoServer.Close() to the .Setup() method in go/vt/vttest/topoctl.go - this topoServer is only used in .Setup() and has no .Close() call today

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Copy link
Contributor

vitess-bot bot commented May 18, 2024

Review Checklist

Hello reviewers! 馃憢 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels May 18, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 18, 2024
@timvaillancourt timvaillancourt removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels May 18, 2024
@timvaillancourt timvaillancourt marked this pull request as draft May 18, 2024 23:37
@timvaillancourt timvaillancourt marked this pull request as draft May 18, 2024 23:37
@timvaillancourt timvaillancourt deleted the vttest-close-topo branch June 3, 2024 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsIssue A linked issue is missing for this Pull Request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant