TT-13130 only mark the wg as done when the connection is stablished

sredxny commented 2 months ago

User description

Description

When the gw is ran as edge we want this to wait until the connection is established with MDCB before attempting to pull policies and apis, we should only mark the connection waitgroup as done when the connection is successful not on every attempt

Related Issue

TT-13130

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

[ ] I ensured that the documentation is up to date
[ ] I explained why this PR updates go.mod in detail with reasoning why it's required
[ ] I would like a code coverage CI quality gate exception and have explained why

PR Type

Bug fix

Description

Fixed the logic in rpc_client.go to ensure the waitgroup is marked as done only when a connection is successfully established.
Removed the Done() call from the defer statement and added it after the connection is confirmed.

Changes walkthrough 📝

Relevant files

Bug fix

rpc_client.go

Fix waitgroup completion logic in connection establishment

rpc/rpc_client.go

Removed the Done() call from the defer statement in the Dial function.

Added Done() call after the connection is successfully established.

Ensures the waitgroup is marked as done only upon successful
connection.

+2/-1

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

github-actions[bot] commented 2 months ago

API Changes

no api changes detected

github-actions[bot] commented 2 months ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review

Error Handling
Ensure that the `Done()` method is called in all code paths to prevent potential deadlocks or goroutine leaks if an error occurs before reaching the new placement of `connectionDialingWG.Done()`.

github-actions[bot] commented 2 months ago

PR Code Suggestions ✨

Category	Suggestion	Score
Possible bug	Ensure proper handling of wait group decrement to avoid potential deadlocks or goroutine leaks ___ Ensure that the `connectionDialingWG.Done()` is called even if an error occurs during the connection setup. This can be achieved by using a `defer` statement at the beginning of the connection setup block. [rpc/rpc_client.go [298-302]](https://github.com/TykTechnologies/tyk/pull/6574/files#diff-3b88914c99bb9418e44e6389ce73579843562e8900730b380d7fff2e95c51033R298-R302) ```diff +defer connectionDialingWG.Done() conn.Write([]byte("proto2")) conn.Write([]byte{byte(len(connID))}) conn.Write([]byte(connID)) -// only mark as done is connection is established -connectionDialingWG.Done() ``` Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies a potential issue where `connectionDialingWG.Done()` may not be called if an error occurs before the connection is fully established. Using `defer` ensures that the wait group is decremented regardless of the outcome, preventing potential deadlocks or goroutine leaks. This is a crucial improvement for the reliability of the connection handling logic.	9

sonarcloud[bot] commented 2 months ago

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

sredxny commented 2 months ago

/release to release-5-lts