[TT-7815] ensure path params are migrated to OAS

[edsonmichaque]

User description

TT-7815

Summary	Cannot migrate API with endpoints containing path parameter
Type	Bug
Status	In Dev
Points	N/A
Labels	DoD_Fail, QA_Fail, Re_open

---

Description

This PR makes sure that path params are successfully migrated from Classic to OAS

Related Issue

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

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

---

Description

• Refactored path splitting logic for OAS conversion.

• Introduced helper functions for regex and mux template parsing.

• Added unit tests covering various path parameter scenarios.

• Provided test fixtures for classic to OAS migration.

---

Changes walkthrough 📝

	Relevant files
Enhancement	operation.go Enhance path parameter migration in OAS operations.            apidef/oas/operation.go Added import for regexp and httputil. Refactored splitPath with empty path check. Introduced parsePathSegment, parseMuxTemplate, and isIdentifier. Improved regex detection and parameter naming. +49/-18
Tests	operation_test.go Add unit tests for splitPath functionality.                            apidef/oas/operation_test.go Added TestSplitPath covering diverse scenarios. Verified correct parsing for simple, regex, and mux templates. Ensured empty and root paths are handled. +72/-0    path_params.yml Add path params test fixture for OAS migration.                    apidef/oas/testdata/fixtures/path_params.yml Created YAML fixtures for classic path parameter migration. Defined multiple test cases with varied input patterns. Mapped expected outputs for both simple and regex parameters. +144/-0

---

Need help?

Type /help how to ... in the comments thread for any questions about PR-Agent usage.

Check out the documentation for more information.

[buger]

Let's make that PR title a 💯 shall we? 💪

Your PR title and story title look slightly different. Just checking in to know if it was intentional!

Story Title	Cannot migrate API with endpoints containing path parameter
PR Title	[TT-7815] ensure path params are migrated to OAS

Check out this guide to learn more about PR best-practices.

[github-actions]

API Changes

no api changes detected

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Code Clarity The new functions (parsePathSegment, parseMuxTemplate, and isIdentifier) introduce additional routing logic. Please ensure that all edge cases (such as segments with mixed patterns or unusual characters) are handled correctly and consistently with the existing behavior. func hasMockResponse(methodActions map[string]apidef.EndpointMethodMeta) bool { for _, action := range methodActions { if action.Action == apidef.Reply { return true } } return false } // parsePathSegment parses a single path segment and determines if it contains a regex pattern. func parsePathSegment(segment string, regexCount int, hasRegex bool) (pathPart, int, bool) { if httputil.IsMuxTemplate(segment) { return parseMuxTemplate(segment, regexCount) } else if isIdentifier(segment) { return pathPart{name: segment, value: segment, isRegex: false}, regexCount, hasRegex } else { regexCount++ return pathPart{name: fmt.Sprintf("customRegex%d", regexCount), value: segment, isRegex: true}, regexCount, true } } // parseMuxTemplate parses a segment that is a mux template and extracts the name or assigns a custom regex name. func parseMuxTemplate(segment string, regexCount int) (pathPart, int, bool) { segment = strings.TrimPrefix(segment, "{") segment = strings.TrimSuffix(segment, "}") name, _, ok := strings.Cut(segment, ":") if ok || isIdentifier(segment) { return pathPart{name: name, isRegex: true}, regexCount, true } regexCount++ return pathPart{name: fmt.Sprintf("customRegex%d", regexCount), isRegex: true}, regexCount, true } func isIdentifier(value string) bool { matched, _ := regexp.MatchString(`^[a-zA-Z0-9._-]+$`, value) //nolint return matched } Test Coverage The TestSplitPath function covers a variety of cases, but double-check that all potential malformed or unexpected path formats (especially those involving mux templates and regex patterns) are adequately tested. operation := s.GetTykExtension().getOperation(operationID) assert.NotNil(t, operation.Allow) assert.False(t, operation.Allow.Enabled) }) } func TestSplitPath(t *testing.T) { tests := map[string]struct { input string wantParts []pathPart wantRegex bool }{ "simple path": { input: "/test/path", wantParts: []pathPart{ {name: "test", value: "test", isRegex: false}, {name: "path", value: "path", isRegex: false}, }, wantRegex: false, }, "path with regex": { input: "/test/.*/end", wantParts: []pathPart{ {name: "test", value: "test", isRegex: false}, {name: "customRegex1", value: ".*", isRegex: true}, {name: "end", value: "end", isRegex: false}, }, wantRegex: true, }, "path with curly braces": { input: "/users/{id}/profile", wantParts: []pathPart{ {name: "users", value: "users", isRegex: false}, {name: "id", isRegex: true}, {name: "profile", value: "profile", isRegex: false}, }, wantRegex: true, }, "path with named regex": { input: "/users/{userId:[0-9]+}/posts", wantParts: []pathPart{ {name: "users", value: "users", isRegex: false}, {name: "userId", isRegex: true}, {name: "posts", value: "posts", isRegex: false}, }, wantRegex: true, }, "path with named direct regex": { input: "/users/[0-9]+/posts", wantParts: []pathPart{ {name: "users", value: "users", isRegex: false}, {name: "customRegex1", value: "[0-9]+", isRegex: true}, {name: "posts", value: "posts", isRegex: false}, }, wantRegex: true, }, "empty path": { input: "", wantParts: []pathPart{}, wantRegex: false, }, "root path": { input: "/", wantParts: []pathPart{}, wantRegex: false, }, } for name, tc := range tests { t.Run(name, func(t *testing.T) { gotParts, gotRegex := splitPath(tc.input) assert.Equal(t, tc.wantRegex, gotRegex, "regex detection mismatch") assert.Equal(t, tc.wantParts, gotParts, "parts mismatch") }) } }

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Preserve mux template value Preserve the original segment value in mux template parsing to maintain consistency with non-mux segments. apidef/oas/operation.go [1069-1080] func parseMuxTemplate(segment string, regexCount int) (pathPart, int, bool) { segment = strings.TrimPrefix(segment, "{") segment = strings.TrimSuffix(segment, "}") - name, _, ok := strings.Cut(segment, ":") + name, remainder, ok := strings.Cut(segment, ":") if ok || isIdentifier(segment) { - return pathPart{name: name, isRegex: true}, regexCount, true + // If there's a regex pattern specified after colon, use it as the value; otherwise, fallback to the name + value := name + if ok { + value = remainder + } + return pathPart{name: name, value: value, isRegex: true}, regexCount, true } regexCount++ - return pathPart{name: fmt.Sprintf("customRegex%d", regexCount), isRegex: true}, regexCount, true + return pathPart{name: fmt.Sprintf("customRegex%d", regexCount), value: segment, isRegex: true}, regexCount, true } Suggestion importance[1-10]: 7 __ Why: The suggestion enhances consistency by preserving the original segment value when parsing mux templates, which aligns with the behavior for non-mux segments. While the improvement is sound and beneficial for clarity, it represents a moderate refinement rather than a critical fix.	Medium

[edsonmichaque]

This PR is replacing #6901 after the refinement of https://tyktech.atlassian.net/browse/TT-7815

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

[edsonmichaque]

/release to 5.8.0

[tykbot]

@edsonmichaque Release branch not found

[edsonmichaque]

/release to release-5.8.0

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@edsonmichaque Succesfully merged PR

[edsonmichaque]

/release to release-5.8

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@edsonmichaque Succesfully merged PR