Merging to release-5.5: [TT-12762]respect response plugins contract over responsePlugin.plugins (#6441)

[buger]

User description

TT-12762respect response plugins contract over responsePlugin.plugins (#6441)

User description

Description

Fix a bug where response plugins are not loaded when using OAS APIs.

Related Issue

https://tyktech.atlassian.net/browse/TT-12762

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

---

Description

• Fixed a bug where response plugins were not loaded correctly when
  using OAS APIs by adding a return statement after extracting response
  plugins.
• Added a new test case to verify the correct extraction of response
  plugins and ensure the regression issue TT-12762 is resolved.

---

Changes walkthrough 📝

	Relevant files
Bug fix	middleware.go Fix response plugins extraction logic                                        apidef/oas/middleware.go Added a return statement after extracting response plugins to ensure correct behavior. Initialized ResponsePlugin if it is nil. +1/-0
Tests	middleware_test.go Add test for response plugins extraction                                  apidef/oas/middleware_test.go Added a new test case to verify the correct extraction of response plugins. Ensured the test case checks for the regression issue TT-12762. +56/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools
and their descriptions

---

PR Type

Bug fix, Tests

---

Description

• Fixed a bug where response plugins were not loaded correctly when using OAS APIs by adding a return statement after extracting response plugins.
• Added a new test case to verify the correct loading and extraction of response plugins.

---

Changes walkthrough 📝

	Relevant files
Bug fix	middleware.go Ensure response plugins are loaded correctly in OAS APIs  apidef/oas/middleware.go Added a return statement after extracting response plugins to ensure proper loading. +1/-0
Tests	middleware_test.go Add test cases for response plugins in middleware                apidef/oas/middleware_test.go Added a new test case for response plugins. Verified the length of response plugins after extraction. Ensured proper filling of middleware with response plugins. +56/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Reviewer Guide 🔍

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

🧪 PR contains tests

🔒 No security concerns identified

⚡ Key issues to review Early Return Logic The addition of the return statement at line 417 might cause the subsequent logic to be skipped, which could lead to unintended behavior if there are additional conditions or setups needed after the if block handling g.ResponsePlugins.

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Add detailed assertions for plugin properties in the test case The test case "response plugins" lacks assertions for the properties of the plugins within convertedAPI.CustomMiddleware.Response. To ensure that not only the count but also the content of the plugins is correctly transferred, add assertions to check individual plugin properties like Enabled, FunctionName, and Path. apidef/oas/middleware_test.go [113] assert.Equal(t, len(responsePlugins), len(convertedAPI.CustomMiddleware.Response)) +for i, plugin := range responsePlugins { + assert.Equal(t, plugin.Enabled, convertedAPI.CustomMiddleware.Response[i].Enabled) + assert.Equal(t, plugin.FunctionName, convertedAPI.CustomMiddleware.Response[i].FunctionName) + assert.Equal(t, plugin.Path, convertedAPI.CustomMiddleware.Response[i].Path) +} Suggestion importance[1-10]: 9 Why: Adding detailed assertions for the properties of the plugins ensures that the content is correctly transferred, not just the count. This improves the robustness and accuracy of the test.	9
Possible issue	Remove the premature return statement to allow further processing The return statement at line 417 might prematurely exit the extractResponsePluginsTo function, skipping any logic that might be needed for handling g.ResponsePlugin when g.ResponsePlugins is not nil. Consider removing the return statement to allow the function to continue its execution for any subsequent checks or logic. apidef/oas/middleware.go [417] -return +// return removed to allow further processing Suggestion importance[1-10]: 8 Why: Removing the return statement ensures that the function continues to process any subsequent logic, which might be necessary for handling g.ResponsePlugin. This change addresses a potential functional issue.	8
Best practice	Verify the state of convertedAPI after setting disabled flags in the test The test case "response plugins" initializes convertedAPI but does not explicitly check if SetDisabledFlags modifies any relevant properties before calling ExtractTo. To ensure clarity and correctness of the test, verify the state of convertedAPI after calling SetDisabledFlags. apidef/oas/middleware_test.go [108] var convertedAPI apidef.APIDefinition convertedAPI.SetDisabledFlags() +// Example assertion, adjust according to actual implementation details +assert.False(t, convertedAPI.Disabled) Suggestion importance[1-10]: 7 Why: Verifying the state of convertedAPI after calling SetDisabledFlags adds clarity and ensures correctness, although it is a minor enhancement to the test.	7
Maintainability	Refine assertions to target specific fields for better test maintainability The test case "response plugins" uses a hardcoded assertion for comparing entire middleware structures which might lead to fragile tests if the middleware structure is extended or modified. Use a more targeted approach to assert specific fields relevant to the test to improve test maintainability and clarity. apidef/oas/middleware_test.go [128] -assert.Equal(t, expectedMW, resultMiddleware) +assert.Equal(t, expectedMW.Global.ResponsePlugins, resultMiddleware.Global.ResponsePlugins) Suggestion importance[1-10]: 6 Why: Using more targeted assertions improves test maintainability and clarity, but the current assertion is not necessarily incorrect. This suggestion is more about improving future-proofing.	6

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud