[TT-12865] Rename config parameter, update usage, support mux params on legacy

[titpetric]

PR Type

enhancement

---

Description

• Renamed configuration fields EnablePrefixMatching and EnableSuffixMatching to EnablePathPrefixMatching and EnablePathSuffixMatching respectively, across multiple files.
• Updated comments and documentation to reflect the new naming conventions.
• Modified test cases to use the updated configuration fields.
• Refactored middleware and session manager logic to accommodate the new path matching configuration.

---

Changes walkthrough 📝

	Relevant files
Enhancement	config.go Rename configuration fields for path matching options        config/config.go Renamed EnablePrefixMatching to EnablePathPrefixMatching. Renamed EnableSuffixMatching to EnablePathSuffixMatching. Updated comments to reflect the new naming conventions. +12/-12  api_definition.go Update API definition to use new path matching config        gateway/api_definition.go Updated variable names to use new path matching configuration fields. +2/-2      mw_granular_access.go Refactor middleware to use updated path matching config    gateway/mw_granular_access.go Updated variable names to use new path matching configuration fields. Refactored pattern preparation using PreparePathRegexp. +3/-9      session_manager.go Update session manager for new path matching config            gateway/session_manager.go Updated variable names to use new path matching configuration fields. +2/-2      schema.json Update JSON schema for path matching configuration              cli/linter/schema.json Renamed JSON schema fields for path matching options. +2/-2
Tests	api_definition_test.go Update test configuration for path prefix matching              gateway/api_definition_test.go Modified test configuration to use EnablePathPrefixMatching. +1/-1      mw_granular_access_test.go Update middleware test for path prefix matching                    gateway/mw_granular_access_test.go Modified test configuration to use EnablePathPrefixMatching. +1/-1

---

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

[github-actions]

API Changes

--- prev.txt	2024-09-12 07:26:28.458302148 +0000
+++ current.txt	2024-09-12 07:26:25.238280392 +0000
@@ -5905,7 +5905,7 @@
 	// Regular expressions and parameterized routes will be left alone regardless of this setting.
 	EnableStrictRoutes bool `json:"enable_strict_routes"`
 
-	// EnablePrefixMatching changes the URL matching from wildcard mode to prefix mode.
+	// EnablePathPrefixMatching changes the URL matching from wildcard mode to prefix mode.
 	// For example, `/json` matches `*/json*` by current default behaviour.
 	// If prefix matching is enabled, the match will be performed as a prefix match (`/json*`).
 	//
@@ -5920,16 +5920,16 @@
 	// - Full listen path and endpoint (`/listen-path/json`)
 	// - Stripped listen path (`/json`) - match.
 	//
-	// For inputs that start with `/`, a prefix match is ensured by prepending
-	// the start of string `^` caret.
+	// For inputs that start with `/`, a prefix match is ensured by
+	// prepending the start of string `^` caret.
 	//
 	// For all other cases, the pattern remains unmodified.
 	//
-	// Combine this option with EnableSuffixMatching to achieve strict
-	// url matching with `/json` being evaluated as `^/json$`.
-	EnablePrefixMatching bool `json:"enable_prefix_matching"`
+	// Combine this option with `enable_path_suffix_matching` to achieve
+	// exact url matching with `/json` being evaluated as `^/json$`.
+	EnablePathPrefixMatching bool `json:"enable_path_prefix_matching"`
 
-	// EnableSuffixMatching changes the URL matching to match as a suffix.
+	// EnablePathSuffixMatching changes the URL matching to match as a suffix.
 	// For example: `/json` is matched as `/json$` against the following paths:
 	//
 	// - Full listen path and versioning URL (`/listen-path/v4/json`)
@@ -5941,12 +5941,12 @@
 	// - Full listen path and endpoint (`/listen-path/json`)
 	// - Stripped listen path (`/json`) - match.
 	//
-	// If the input pattern already ends with a `$` (`/json$`) then
-	// the pattern remains unmodified.
+	// If the input pattern already ends with a `$` (`/json$`)
+	// then the pattern remains unmodified.
 	//
-	// Combine this option with EnablePrefixMatching to achieve strict
-	// url matching with `/json` being evaluated as `^/json$`.
-	EnableSuffixMatching bool `json:"enable_suffix_matching"`
+	// Combine this option with `enable_path_prefix_matching` to achieve
+	// exact url matching with `/json` being evaluated as `^/json$`.
+	EnablePathSuffixMatching bool `json:"enable_path_suffix_matching"`
 
 	// Disable TLS verification. Required if you are using self-signed certificates.
 	SSLInsecureSkipVerify bool `json:"ssl_insecure_skip_verify"`

[github-actions]

PR Reviewer Guide 🔍

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

🧪 PR contains tests

🔒 No security concerns identified

⚡ No key issues to review

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible bug	Add error handling for the regex preparation function to enhance robustness Refactor the generateRegex function to handle errors that may arise from the PreparePathRegexp function, ensuring robust error handling. gateway/api_definition.go [831] -pattern = httputil.PreparePathRegexp(stringSpec, isPrefixMatch, isSuffixMatch) +pattern, err = httputil.PreparePathRegexp(stringSpec, isPrefixMatch, isSuffixMatch) +if err != nil { + return nil, err +} Suggestion importance[1-10]: 9 Why: Adding error handling for the PreparePathRegexp function is important for robustness, as it ensures that any errors during regex preparation are properly managed, preventing potential runtime issues.	9
	Check for empty URL paths array to prevent runtime errors Add a check to ensure that the urlPaths array is not empty before proceeding with URL matching, to avoid runtime errors. gateway/mw_granular_access.go [237-238] urlPaths := []string{ m.Spec.StripListenPath(r.URL.Path), } +if len(urlPaths) == 0 { + return nil, http.StatusBadRequest +} Suggestion importance[1-10]: 8 Why: Adding a check for an empty urlPaths array can prevent runtime errors, enhancing the stability and reliability of the URL matching process.	8
Possible issue	Ensure new configuration options are mutually exclusive to prevent conflicts Ensure that the new configuration options EnablePathPrefixMatching and EnablePathSuffixMatching are mutually exclusive to prevent conflicting URL matching behaviors. config/config.go [433-452] +// Add logic to ensure these options are mutually exclusive EnablePathPrefixMatching bool `json:"enable_path_prefix_matching"` EnablePathSuffixMatching bool `json:"enable_path_suffix_matching"` Suggestion importance[1-10]: 8 Why: Ensuring that EnablePathPrefixMatching and EnablePathSuffixMatching are mutually exclusive can prevent conflicting URL matching behaviors, which is crucial for maintaining correct application logic.	8
Best practice	Add a default value for the new configuration option to ensure consistent behavior Consider adding a default value for EnablePathPrefixMatching in the struct definition to ensure consistent behavior when this configuration is not explicitly set by the user. config/config.go [433] -EnablePathPrefixMatching bool `json:"enable_path_prefix_matching"` +EnablePathPrefixMatching bool `json:"enable_path_prefix_matching" default:"false"` Suggestion importance[1-10]: 7 Why: Adding a default value for EnablePathPrefixMatching can help ensure consistent behavior when the configuration is not explicitly set, improving code robustness and maintainability.	7

[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

[titpetric]

/release to release-5.3

[tykbot]

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

[tykbot]

@titpetric Succesfully merged PR