Merging to release-5.3: [TT-13390] Silently skip loading bundle on managment node (#6739) #6743
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### **User description** <details open> <summary><a href="https://tyktech.atlassian.net/browse/TT-13390" title="TT-13390" target="_blank">TT-13390</a></summary> <br /> <table> <tr> <th>Summary</th> <td>Security feature introduced in v5.3.1 (skip loading API) introduces problems for Cloud users (OAuth APIs)</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%20'24Bugsmash%20ORDER%20BY%20created%20DESC" title="'24Bugsmash">'24Bugsmash</a>, <a href="https://tyktech.atlassian.net/issues?jql=project%20%3D%20TT%20AND%20labels%20%3D%20Adhoc%20ORDER%20BY%20created%20DESC" title="Adhoc">Adhoc</a>, <a href="https://tyktech.atlassian.net/issues?jql=project%20%3D%20TT%20AND%20labels%20%3D%20jira_escalated%20ORDER%20BY%20created%20DESC" title="jira_escalated">jira_escalated</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 --> ## Description <!-- Describe your changes in detail --> ## Related Issue https://tyktech.atlassian.net/browse/TT-13390 ## 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, Tests ___ ### **Description** - Updated the `loadBundle` function to silently skip loading bundles when the gateway instance is a management node. - Clarified the usage of the `management_node` configuration in the comments, specifying that it should always be set to `false` in pro environments. - Added a new test case to ensure that `loadBundle` behaves correctly when the gateway is a management node. ___ ### **Changes walkthrough** 📝 <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table> <tr> <td> <details> <summary><strong>config.go</strong><dd><code>Clarify `management_node` configuration usage in comments</code></dd></summary> <hr> config/config.go <li>Added clarification in the comments regarding the <code>management_node</code> <br>configuration.<br> <li> Specified that <code>management_node</code> should always be set to <code>false</code> in pro <br>environments.<br> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6739/files#diff-fe44f09c4d5977b5f5eaea29170b6a0748819c9d02271746a20d81a5f3efca17">+3/-0</a> </td> </tr> </table></td></tr><tr><td><strong>Bug fix</strong></td><td><table> <tr> <td> <details> <summary><strong>coprocess_bundle.go</strong><dd><code>Skip bundle loading on management nodes in `loadBundle`</code> </dd></summary> <hr> gateway/coprocess_bundle.go <li>Updated <code>loadBundle</code> function to silently skip loading the bundle if the <br>node is a management node.<br> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6739/files#diff-72df0cbfd3765a5d0bff62196c11008596608a21a53dbb9c65bfc6f008dbfa29">+4/-0</a> </td> </tr> </table></td></tr><tr><td><strong>Tests</strong></td><td><table> <tr> <td> <details> <summary><strong>coprocess_bundle_test.go</strong><dd><code>Add test for skipping bundle loading on management nodes</code> </dd></summary> <hr> gateway/coprocess_bundle_test.go <li>Added a new test case to verify that <code>loadBundle</code> does not load bundles <br>or throw errors when the gateway is a management node.<br> </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6739/files#diff-7fded1570c90f7be73d562f3ebcbb32fe4d50548dc5e959d8ecadddef13941fa">+17/-0</a> </td> </tr> </table></td></tr></tr></tbody></table> ___ > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull request to receive relevant information (cherry picked from commit 7fbd718)
|
API Changes --- prev.txt 2024-12-04 09:33:47.487247098 +0000
+++ current.txt 2024-12-04 09:33:44.563206221 +0000
@@ -5046,6 +5046,9 @@
// Note:
// If you set `db_app_conf_options.node_is_segmented` to `true` for multiple Gateway nodes, you should ensure that `management_node` is set to `false`.
// This is to ensure visibility for the management node across all APIs.
+ //
+ // For pro installations, `management_node` is not a valid configuration option.
+ // Always set `management_node` to `false` in pro environments.
ManagementNode bool `json:"management_node"`
// This is used as part of the RPC / Hybrid back-end configuration in a Tyk Enterprise installation and isn’t used anywhere else. |
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨Explore these optional code suggestions:
|
|
buger
deleted the
merge/release-5.3/7fbd718594aca9e2a06c70567282e1c3c3521f51
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
User description
TT-13390 Silently skip loading bundle on managment node (#6739)
User description
TT-13390
Description
Related Issue
https://tyktech.atlassian.net/browse/TT-13390
Motivation and Context
How This Has Been Tested
Screenshots (if appropriate)
Types of changes
functionality to change)
coverage to functionality)
Checklist
why it's required
explained why
PR Type
Bug fix, Tests
Description
loadBundlefunction to silently skip loading bundleswhen the gateway instance is a management node.
management_nodeconfiguration in thecomments, specifying that it should always be set to
falsein proenvironments.
loadBundlebehaves correctlywhen the gateway is a management node.
Changes walkthrough 📝
config.go
Clarify `management_node` configuration usage in commentsconfig/config.go
management_nodeconfiguration.
management_nodeshould always be set tofalsein proenvironments.
coprocess_bundle.go
Skip bundle loading on management nodes in `loadBundle`gateway/coprocess_bundle.go
loadBundlefunction to silently skip loading the bundle if thenode is a management node.
coprocess_bundle_test.go
Add test for skipping bundle loading on management nodesgateway/coprocess_bundle_test.go
loadBundledoes not load bundlesor throw errors when the gateway is a management node.
PR Type
Bug fix, Tests
Description
loadBundlefunction to silently skip loading bundles when the gateway instance is a management node.management_nodeconfiguration in the comments, specifying that it should always be set tofalsein pro environments.loadBundlebehaves correctly when the gateway is a management node.Changes walkthrough 📝
config.go
Clarify `management_node` configuration usage in comments.config/config.go
management_nodeconfiguration.
management_nodeshould always be set tofalsein proenvironments.
coprocess_bundle.go
Skip bundle loading on management nodes in `loadBundle`.gateway/coprocess_bundle.go
loadBundlefunction to silently skip loading bundles whenthe node is a management node.
coprocess_bundle_test.go
Add test for skipping bundle loading on management nodes.gateway/coprocess_bundle_test.go
loadBundledoes not load bundles orthrow errors when the gateway is a management node.