github-actions[bot]
commented
1 month ago API Changes
--- prev.txt 2024-09-12 19:01:01.859261628 +0000
+++ current.txt 2024-09-12 19:00:58.683242013 +0000
@@ -5512,6 +5512,49 @@
// Regular expressions and parameterized routes will be left alone regardless of this setting.
EnableStrictRoutes bool `json:"enable_strict_routes"`
+ // 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*`).
+ //
+ // The `/json` url would be matched as `^/json` against the following paths:
+ //
+ // - Full listen path and versioning URL (`/listen-path/v4/json`)
+ // - Stripped listen path URL (`/v4/json`)
+ // - Stripped version information (`/json`) - match.
+ //
+ // If versioning is disabled then the following URLs are considered:
+ //
+ // - 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 all other cases, the pattern remains unmodified.
+ //
+ // 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"`
+
+ // 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`)
+ // - Stripped listen path URL (`/v4/json`)
+ // - Stripped version information (`/json`) - match.
+ //
+ // If versioning is disabled then the following URLs are considered:
+ //
+ // - 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.
+ //
+ // 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"`
@@ -7422,10 +7465,16 @@
func CloneAPI(a *APISpec) *APISpec
func (a *APISpec) CheckSpecMatchesStatus(r *http.Request, rxPaths []URLSpec, mode URLStatus) (bool, interface{})
- CheckSpecMatchesStatus checks if a url spec has a specific status
+ CheckSpecMatchesStatus checks if a URL spec has a specific status.
+ Deprecated: The function doesn't follow go return conventions (T, ok);
+ use FindSpecMatchesStatus;
func (a *APISpec) Expired() bool
+func (a *APISpec) FindSpecMatchesStatus(r *http.Request, rxPaths []URLSpec, mode URLStatus) (*URLSpec, bool)
+ FindSpecMatchesStatus checks if a URL spec has a specific status and returns
+ the URLSpec for it.
+
func (s *APISpec) FireEvent(name apidef.TykEvent, meta interface{})
func (a *APISpec) GetSessionLifetimeRespectsKeyExpiration() bool
@@ -7447,7 +7496,13 @@
func (a *APISpec) StopSessionManagerPool()
-func (a *APISpec) StripListenPath(r *http.Request, path string) string
+func (a *APISpec) StripListenPath(reqPath string) string
+ StripListenPath will strip the listen path from the URL, keeping version in
+ tact.
+
+func (a *APISpec) StripVersionPath(reqPath string) string
+ StripVersionPath will strip the version from the URL. The input URL should
+ already have listen path stripped.
func (a *APISpec) URLAllowedAndIgnored(r *http.Request, rxPaths []URLSpec, whiteListStatus bool) (RequestStatus, interface{})
URLAllowedAndIgnored checks if a url is allowed and ignored.
@@ -10066,7 +10121,6 @@
system, return an error to have the chain fail
type URLSpec struct {
- Spec *regexp.Regexp
Status URLStatus
MethodActions map[string]apidef.EndpointMethodMeta
Whitelist apidef.EndPointMeta
@@ -10094,6 +10148,7 @@
PersistGraphQL apidef.PersistGraphQLMeta
IgnoreCase bool
+ // Has unexported fields.
}
URLSpec represents a flattened specification for URLs, used to check if
a proxy URL path is on any of the white, black or ignored lists. This is
@@ -11424,6 +11479,9 @@
func Cert(domain string) tls.Certificate
Generate cert
+func Exclusive(t *testing.T)
+ Exclusive uses a lock to gate only a single test running.
+
func Flaky(t *testing.T, fake ...func() (bool, func(...interface{})))
Flaky skips a flaky test in a CI environment
sonarcloud[bot]
Catch issues before they fail your Quality Gate with our IDE extension 
User description
TT-12865 Rename config parameter, update usage, support mux params on legacy (#6506)
enhancement
EnablePrefixMatchingandEnableSuffixMatchingtoEnablePathPrefixMatchingandEnablePathSuffixMatchingrespectively, across multiple files.config.go
Rename configuration fields for path matching optionsconfig/config.go
EnablePrefixMatchingtoEnablePathPrefixMatching.EnableSuffixMatchingtoEnablePathSuffixMatching.api_definition.go
Update API definition to use new path matching configgateway/api_definition.go
mw_granular_access.go
Refactor middleware to use updated path matching configgateway/mw_granular_access.go
PreparePathRegexp.session_manager.go
Update session manager for new path matching configgateway/session_manager.go
schema.json
Update JSON schema for path matching configurationcli/linter/schema.json - Renamed JSON schema fields for path matching options.
api_definition_test.go
Update test configuration for path prefix matchinggateway/api_definition_test.go - Modified test configuration to use `EnablePathPrefixMatching`.
mw_granular_access_test.go
Update middleware test for path prefix matchinggateway/mw_granular_access_test.go - Modified test configuration to use `EnablePathPrefixMatching`.
TT-12865: https://tyktech.atlassian.net/browse/TT-12865?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
Enhancement, Tests
EnablePathPrefixMatchingandEnablePathSuffixMatchingto enhance URL path matching capabilities.6 files
config.go
Add configuration for path prefix and suffix matchingconfig/config.go
EnablePathPrefixMatchingandEnablePathSuffixMatching.api_definition.go
Refactor URLSpec and update path matching logicgateway/api_definition.go
model_apispec.go
Refactor and deprecate CheckSpecMatchesStatusgateway/model_apispec.go
CheckSpecMatchesStatusto a separate file and deprecated it.FindSpecMatchesStatusfor improved status checking.model_urlspec.go
Add path and method matching methods to URLSpecgateway/model_urlspec.go
modeSpecificSpecmethod.mw_granular_access.go
Update GranularAccessMiddleware for new path matchinggateway/mw_granular_access.go
mux.go
Refactor path regex preparation and matchinginternal/httputil/mux.go
4 files
api_definition_test.go
Update and add test cases for path matching logicgateway/api_definition_test.go
mw_granular_access_test.go
Add tests for GranularAccessMiddleware path matchinggateway/mw_granular_access_test.go
mux_test.go
Add tests for path regex preparation and matchinginternal/httputil/mux_test.go
issue_12865_test.go
Add regression tests for issue 12865tests/regression/issue_12865_test.go
2 files
test.yml
Update test task configuration.taskfiles/test.yml
schema.json
Update schema for new path matching configurationcli/linter/schema.json - Added new schema fields for path prefix and suffix matching.
Description
Related Issue
Motivation and Context
How This Has Been Tested
Screenshots (if appropriate)
Types of changes
Checklist
PR Type
Enhancement, Tests
Description
EnablePathPrefixMatchingandEnablePathSuffixMatchingto enhance URL path matching capabilities.Changes walkthrough 📝
5 files
config.go
Add new configuration fields for path matchingconfig/config.go
EnablePathPrefixMatchingandEnablePathSuffixMatching.configurations.
api_definition.go
Refactor URLSpec and enhance path matching logicgateway/api_definition.go
mw_granular_access.go
Enhance GranularAccessMiddleware with path matching optionsgateway/mw_granular_access.go
options.
mux.go
Add utility functions for path regex handlinginternal/httputil/mux.go
strings.go
Implement concurrency-safe string mapinternal/maps/strings.go
5 files
api_definition_test.go
Update and add tests for path matching configurationsgateway/api_definition_test.go
mw_granular_access_test.go
Add tests for GranularAccessMiddleware path matchinggateway/mw_granular_access_test.go
configurations.
mux_test.go
Add tests for path regex utilitiesinternal/httputil/mux_test.go
issue_12865_test.go
Add regression tests for issue 12865tests/regression/issue_12865_test.go
regression_test.go
Refactor and test API spec loading utilitiestests/regression/regression_test.go
replacement.