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

Merging to release-5-lts: TT-13130 only mark the wg as done when the connection is stablished (#6574) #6575

Conversation

buger
Copy link
Member

@buger buger commented Sep 23, 2024

TT-13130 only mark the wg as done when the connection is stablished (#6574)

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

    Co-authored-by: sredny buitrago [email protected]

    …6574)
    
    ### **User description**
    <!-- Provide a general summary of your changes in the Title above -->
    
    ## 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
    
    <!-- Why is this change required? What problem does it solve? -->
    
    ## How This Has Been Tested
    
    <!-- Please describe in detail how you tested your changes -->
    <!-- Include details of your testing environment, and the tests -->
    <!-- you ran to see how your change affects other areas of the code,
    etc. -->
    <!-- This information is helpful for reviewers and QA. -->
    
    ## Screenshots (if appropriate)
    
    ## Types of changes
    
    <!-- What types of changes does your code introduce? Put an `x` in all
    the boxes that apply: -->
    
    - [ ] 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
    
    <!-- Go over all the following points, and put an `x` in all the boxes
    that apply -->
    <!-- If there are no documentation updates required, mark the item as
    checked. -->
    <!-- Raise up any additional concerns not covered by the 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** 📝
    <table><thead><tr><th></th><th align="left">Relevant
    files</th></tr></thead><tbody><tr><td><strong>Bug
    fix</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>rpc_client.go</strong><dd><code>Fix waitgroup
    completion logic in connection establishment</code></dd></summary>
    <hr>
    
    rpc/rpc_client.go
    
    <li>Removed the <code>Done()</code> call from the defer statement in the
    <code>Dial</code> function.<br> <li> Added <code>Done()</code> call
    after the connection is successfully established.<br> <li> Ensures the
    waitgroup is marked as done only upon successful <br>connection.<br>
    
    
    </details>
    
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6574/files#diff-3b88914c99bb9418e44e6389ce73579843562e8900730b380d7fff2e95c51033">+2/-1</a>&nbsp;
    &nbsp; &nbsp; </td>
    
    </tr>                    
    </table></td></tr></tr></tbody></table>
    
    ___
    
    > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull
    request to receive relevant information
    
    Co-authored-by: sredny buitrago <[email protected]>
    (cherry picked from commit 5c1f149)
    @buger buger enabled auto-merge (squash) September 23, 2024 15:55
    Copy link
    Contributor

    API Changes

    no api changes detected

    Copy link

    sonarcloud bot commented Sep 23, 2024

    Quality Gate Failed Quality Gate failed

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

    See analysis details on SonarCloud

    @sredxny sredxny self-requested a review September 23, 2024 16:12
    @buger buger merged commit 0636d46 into release-5-lts Sep 23, 2024
    21 of 22 checks passed
    @buger buger deleted the merge/release-5-lts/5c1f1498888e0275526da044423e3e5ae2370976 branch September 23, 2024 16:17
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants