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

Merging to release-5.6: TT-13130 updated version of gorpc library and prevent panic on start edge (#6629) #6638

Merged
merged 2 commits into from
Oct 14, 2024
Merged

Merging to release-5.6: TT-13130 updated version of gorpc library and prevent panic on start edge (#6629) #6638

merged 2 commits into from
Oct 14, 2024

Conversation

buger
Copy link
Member

@buger buger commented Oct 14, 2024 •
edited by github-actions bot
Loading

User description

TT-13130 updated version of gorpc library and prevent panic on start edge (#6629)

User description

TT-13130
Summary Tyk Cloud: Panic appears when a user tried to deploy GW before Control Plane is in deployed state
Type Bug Bug
Status In Dev
Points N/A
Labels Re_open

Description

Moved the logic of waitgroup to be handled internally in the gorpc
library. GW only have to wait until done()

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, Enhancement

Description

  • Refactored the connection dialing logic in rpc_client.go to remove
    manual sync.WaitGroup handling, leveraging the internal wait group
    management provided by the gorpc library.
  • Updated the gorpc library to a newer version in go.mod and
    go.sum, ensuring compatibility and leveraging improvements.

Changes walkthrough 📝

Relevant files
Enhancement
rpc_client.go
Refactor connection dialing wait group handling                   

rpc/rpc_client.go

  • Removed manual handling of sync.WaitGroup for connection dialing.
  • Utilized clientSingleton.ConnectionDialingWG for managing connection
    readiness.
    		•  +1/-7     
    Dependencies
    go.mod
    Update gorpc library version in go.mod                                     

    go.mod

    • Updated gorpc library version to latest.
    		 +1/-1     
    go.sum
    Update go.sum for new gorpc version                                           

    go.sum

    • Updated checksums for new gorpc library version.
    		 +8/-2     

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

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

    PR Type

    Bug fix, Enhancement

    Description

    • Refactored the connection dialing logic in rpc_client.go to remove manual sync.WaitGroup handling, leveraging the internal wait group management provided by the gorpc library.
    • Updated the gorpc library to a newer version in go.mod and go.sum, ensuring compatibility and leveraging improvements.

    Changes walkthrough 📝

    Relevant files
    Enhancement
    rpc_client.go
    Refactor connection dialing wait group handling                   

    rpc/rpc_client.go

  • Removed manual handling of sync.WaitGroup for connection dialing.
  • Utilized clientSingleton.ConnectionDialingWG for managing connection
    readiness.
    		•  +1/-8     
    Dependencies
    go.mod
    Update gorpc library version in go.mod                                     

    go.mod

    • Updated gorpc library version to the latest.
    		 +1/-1     
    go.sum
    Update go.sum for new gorpc version                                           

    go.sum

    • Updated checksums for new gorpc library version.
    		 +2/-2     

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

    @sredxny
    TT-13130 updated version of gorpc library and prevent panic on start …
    386d62c 
    …edge (#6629)

<details open>
<summary><a href="https://tyktech.atlassian.net/browse/TT-13130"
title="TT-13130" target="_blank">TT-13130</a></summary>
  <br />
  <table>
    <tr>
      <th>Summary</th>
<td>Tyk Cloud: Panic appears when a user tried to deploy GW before
Control Plane is in deployed state </td>
    </tr>
    <tr>
      <th>Type</th>
      <td>
<img alt="Bug"
src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10303?size=medium"
/>
        Bug
      </td>
    </tr>
    <tr>
      <th>Status</th>
      <td>In Dev</td>
    </tr>
    <tr>
      <th>Points</th>
      <td>N/A</td>
    </tr>
    <tr>
      <th>Labels</th>
<td><a
href="https://tyktech.atlassian.net/issues?jql=project%20%3D%20TT%20AND%20labels%20%3D%20Re_open%20ORDER%20BY%20created%20DESC"
title="Re_open">Re_open</a></td>
    </tr>
  </table>
</details>
<!--
  do not remove this marker as it will break jira-lint's functionality.
  added_by_jira_lint
-->

---

<!-- Provide a general summary of your changes in the Title above -->

Moved the logic of waitgroup to be handled internally in the gorpc
library. GW only have to wait until done()

TT-13130

<!-- Why is this change required? What problem does it solve? -->

<!-- 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. -->

<!-- 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)

<!-- 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

___

Bug fix, Enhancement

___

- Refactored the connection dialing logic in `rpc_client.go` to remove
manual `sync.WaitGroup` handling, leveraging the internal wait group
management provided by the `gorpc` library.
- Updated the `gorpc` library to a newer version in `go.mod` and
`go.sum`, ensuring compatibility and leveraging improvements.

___

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>rpc_client.go</strong><dd><code>Refactor connection
dialing wait group handling</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

rpc/rpc_client.go

<li>Removed manual handling of <code>sync.WaitGroup</code> for
connection dialing.<br> <li> Utilized
<code>clientSingleton.ConnectionDialingWG</code> for managing connection
<br>readiness.<br>

</details>

  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6629/files#diff-3b88914c99bb9418e44e6389ce73579843562e8900730b380d7fff2e95c51033">+1/-7</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>
</table></td></tr><tr><td><strong>Dependencies</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>go.mod</strong><dd><code>Update gorpc library version
in go.mod</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; </dd></summary>
<hr>

go.mod

- Updated `gorpc` library version to latest.

</details>

  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6629/files#diff-33ef32bf6c23acb95f5902d7097b7a1d5128ca061167ec0716715b0b9eeaa5f6">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>go.sum</strong><dd><code>Update go.sum for new gorpc
version</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

go.sum

- Updated checksums for new `gorpc` library version.

</details>

  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6629/files#diff-3295df7234525439d778f1b282d146a4f1ff6b415248aaac074e8042d9f42d63">+8/-2</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 6b687a2)
    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Oct 14, 2024 •
    edited
    Loading

    API Changes

    no api changes detected

    @sredxny sredxny marked this pull request as ready for review October 14, 2024 15:01
    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    🎫 Ticket compliance analysis 🔶

    6629 - Partially compliant

    Fully compliant requirements:

    • Update the gorpc library to a newer version.
    • Refactor the connection dialing logic to prevent panic when deploying GW before Control Plane is deployed.

    Not compliant requirements:

    • Ensure the changes do not introduce new issues and are compatible with existing systems.
    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Connection Handling
    The removal of manual sync.WaitGroup handling and reliance on clientSingleton.ConnectionDialingWG.Wait() needs thorough testing to ensure no race conditions or deadlocks occur.

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Possible bug
    Add error handling for conn.Write operations to ensure robustness

    Ensure that the clientSingleton.Dial function handles potential errors from the
    conn.Write operations to prevent runtime panics or unhandled errors.

    rpc/rpc_client.go [294-296]

    -conn.Write([]byte("proto2"))
-conn.Write([]byte{byte(len(connID))})
-conn.Write([]byte(connID))
+if _, err := conn.Write([]byte("proto2")); err != nil {
+  return nil, err
+}
+if _, err := conn.Write([]byte{byte(len(connID))}); err != nil {
+  return nil, err
+}
+if _, err := conn.Write([]byte(connID)); err != nil {
+  return nil, err
+}
    Suggestion importance[1-10]: 9

    Why: The suggestion correctly identifies a potential issue where errors from conn.Write operations are not handled, which could lead to runtime panics or unhandled errors. Adding error handling significantly improves the robustness and reliability of the code.

    		9

    @sonarcloud SonarCloud
    Copy link

    sonarcloud bot commented Oct 14, 2024

    Quality Gate Failed Quality Gate failed

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

    See analysis details on SonarCloud

    @buger buger merged commit ceb1a51 into release-5.6 Oct 14, 2024
    13 of 17 checks passed
    @buger buger deleted the merge/release-5.6/6b687a22360c3c9fe516f4dcc2b6d834b7ae40b8 branch October 14, 2024 16:00
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers
    No reviews
    Assignees
    No one assigned
    Labels
    Bug fix enhancement Review effort [1-5]: 3
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @buger @sredxny