Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/intelligent-branch-recomendations.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: PR Merge Suggestions
on:
pull_request:
types:
- opened
- synchronize
- reopened
- ready_for_review

permissions:
pull-requests: write
contents: read

jobs:
branch-suggestions:
uses: TykTechnologies/github-actions/.github/workflows/branch-suggestion.yml@main
secrets:
JIRA_TOKEN: ${{ secrets.JIRA_TOKEN }}
4 changes: 4 additions & 0 deletions .github/workflows/release-bot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ on:
jobs:
release_bot:
uses: TykTechnologies/github-actions/.github/workflows/release-bot.yaml@main
secrets:
APP_ID: ${{ secrets.PROBE_APP_ID }}
APP_PRIVATE_KEY: ${{ secrets.PROBE_APP_PRIVATE_KEY }}
APP_INSTALLATION_ID: ${{ secrets.PROBE_APP_INSTALLATION_ID }}
21 changes: 21 additions & 0 deletions apidef/api_definitions.go
Original file line number Diff line number Diff line change
Expand Up @@ -1262,7 +1262,7 @@
for i, version := range a.VersionData.Versions {
for j, oldSchema := range version.ExtendedPaths.ValidateJSON {

jsBytes, _ := json.Marshal(oldSchema.Schema)

Check failure on line 1265 in apidef/api_definitions.go

View workflow job for this annotation

GitHub Actions / lint

Error return value of `json.Marshal` is not checked (errcheck)
oldSchema.SchemaB64 = base64.StdEncoding.EncodeToString(jsBytes)

a.VersionData.Versions[i].ExtendedPaths.ValidateJSON[j] = oldSchema
Expand Down Expand Up @@ -1315,9 +1315,9 @@

for i, version := range a.VersionData.Versions {
for j, oldSchema := range version.ExtendedPaths.ValidateJSON {
jsBytes, _ := base64.StdEncoding.DecodeString(oldSchema.SchemaB64)

Check failure on line 1318 in apidef/api_definitions.go

View workflow job for this annotation

GitHub Actions / lint

Error return value of `base64.StdEncoding.DecodeString` is not checked (errcheck)

json.Unmarshal(jsBytes, &oldSchema.Schema)

Check failure on line 1320 in apidef/api_definitions.go

View workflow job for this annotation

GitHub Actions / lint

Error return value of `json.Unmarshal` is not checked (errcheck)
oldSchema.SchemaB64 = ""

a.VersionData.Versions[i].ExtendedPaths.ValidateJSON[j] = oldSchema
Expand Down Expand Up @@ -1423,6 +1423,27 @@
return a.Domain
}

// IsChildAPI returns true if this API is a child API in a versioning hierarchy.
// A child API is identified by having a BaseID that differs from its own APIID.
func (a *APIDefinition) IsChildAPI() bool {
return a.VersionDefinition.BaseID != "" && a.VersionDefinition.BaseID != a.APIID
}

// IsBaseAPI returns true if this API is a base API with child versions.
// A base API is identified by having versions defined and either no BaseID or BaseID equal to its own APIID.
func (a *APIDefinition) IsBaseAPI() bool {
return len(a.VersionDefinition.Versions) > 0 &&
(a.VersionDefinition.BaseID == "" || a.VersionDefinition.BaseID == a.APIID)
}

// IsBaseAPIWithVersioning returns true if this API is a base API with versioning explicitly enabled.
// This is similar to IsBaseAPI but additionally requires versioning to be enabled and have a version name.
func (a *APIDefinition) IsBaseAPIWithVersioning() bool {
return a.VersionDefinition.Enabled &&
(a.VersionDefinition.BaseID == "" || a.VersionDefinition.BaseID == a.APIID) &&
a.VersionDefinition.Name != ""
}

func DummyAPI() APIDefinition {
endpointMeta := EndPointMeta{
Path: "abc",
Expand Down
221 changes: 221 additions & 0 deletions apidef/api_definitions_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -364,3 +364,224 @@ func TestLogEventHandlerConf_Scan(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, expected, logEventConf)
}

func TestAPIDefinition_IsChildAPI(t *testing.T) {
tests := []struct {
name string
api APIDefinition
expected bool
}{
{
name: "child API - BaseID set and different from APIID",
api: APIDefinition{
APIID: "child-api-123",
VersionDefinition: VersionDefinition{
BaseID: "base-api-456",
},
},
expected: true,
},
{
name: "not a child - BaseID empty",
api: APIDefinition{
APIID: "standalone-api-123",
VersionDefinition: VersionDefinition{
BaseID: "",
},
},
expected: false,
},
{
name: "not a child - BaseID equals APIID (base API)",
api: APIDefinition{
APIID: "base-api-123",
VersionDefinition: VersionDefinition{
BaseID: "base-api-123",
},
},
expected: false,
},
{
name: "not a child - no version definition",
api: APIDefinition{
APIID: "api-123",
VersionDefinition: VersionDefinition{},
},
expected: false,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := tt.api.IsChildAPI()
assert.Equal(t, tt.expected, result)
})
}
}

func TestAPIDefinition_IsBaseAPI(t *testing.T) {
tests := []struct {
name string
api APIDefinition
expected bool
}{
{
name: "base API - has versions and no BaseID",
api: APIDefinition{
APIID: "base-api-123",
VersionDefinition: VersionDefinition{
BaseID: "",
Versions: map[string]string{
"v1": "child-api-1",
"v2": "child-api-2",
},
},
},
expected: true,
},
{
name: "base API - has versions and BaseID equals APIID",
api: APIDefinition{
APIID: "base-api-123",
VersionDefinition: VersionDefinition{
BaseID: "base-api-123",
Versions: map[string]string{
"v1": "child-api-1",
"v2": "child-api-2",
},
},
},
expected: true,
},
{
name: "not a base API - no versions",
api: APIDefinition{
APIID: "api-123",
VersionDefinition: VersionDefinition{
BaseID: "",
Versions: map[string]string{},
},
},
expected: false,
},
{
name: "not a base API - is a child (BaseID different from APIID)",
api: APIDefinition{
APIID: "child-api-123",
VersionDefinition: VersionDefinition{
BaseID: "base-api-456",
Versions: map[string]string{
"v1": "child-api-123",
},
},
},
expected: false,
},
{
name: "not a base API - nil versions",
api: APIDefinition{
APIID: "api-123",
VersionDefinition: VersionDefinition{
BaseID: "",
Versions: nil,
},
},
expected: false,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := tt.api.IsBaseAPI()
assert.Equal(t, tt.expected, result)
})
}
}

func TestAPIDefinition_IsBaseAPIWithVersioning(t *testing.T) {
tests := []struct {
name string
api APIDefinition
expected bool
}{
{
name: "base API with versioning - all conditions met",
api: APIDefinition{
APIID: "base-api-123",
VersionDefinition: VersionDefinition{
Enabled: true,
Name: "v1",
BaseID: "",
},
},
expected: true,
},
{
name: "base API with versioning - BaseID equals APIID",
api: APIDefinition{
APIID: "base-api-123",
VersionDefinition: VersionDefinition{
Enabled: true,
Name: "v1",
BaseID: "base-api-123",
},
},
expected: true,
},
{
name: "not versioned - Enabled is false",
api: APIDefinition{
APIID: "api-123",
VersionDefinition: VersionDefinition{
Enabled: false,
Name: "v1",
BaseID: "",
},
},
expected: false,
},
{
name: "not versioned - Name is empty",
api: APIDefinition{
APIID: "api-123",
VersionDefinition: VersionDefinition{
Enabled: true,
Name: "",
BaseID: "",
},
},
expected: false,
},
{
name: "is a child API - BaseID different from APIID",
api: APIDefinition{
APIID: "child-api-123",
VersionDefinition: VersionDefinition{
Enabled: true,
Name: "v2",
BaseID: "base-api-456",
},
},
expected: false,
},
{
name: "not versioned - all fields false/empty",
api: APIDefinition{
APIID: "api-123",
VersionDefinition: VersionDefinition{
Enabled: false,
Name: "",
BaseID: "",
},
},
expected: false,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := tt.api.IsBaseAPIWithVersioning()
assert.Equal(t, tt.expected, result)
})
}
}
16 changes: 0 additions & 16 deletions apidef/oas/default.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import (
"slices"
"strconv"
"strings"

"github.com/getkin/kin-openapi/openapi3"
)

const (
Expand Down Expand Up @@ -338,17 +336,3 @@ func getQueryValPtr(val string) *bool {

return &boolVal
}

// RetainOldServerURL retains the first entry from old servers provided
// tyk adds a server URL to the start of oas.Servers to add the gw URL
// RetainOldServerURL can be used when API def is patched.
func RetainOldServerURL(oldServers, newServers openapi3.Servers) openapi3.Servers {
if len(oldServers) > 0 && len(newServers) > 0 {
if oldServers[0].URL == newServers[0].URL {
return newServers
}
newServers = append(openapi3.Servers{oldServers[0]}, newServers...)
}

return newServers
}
Loading
Loading