Omit gateway tags if empty #4127

titpetric · 2022-06-14T14:49:44Z

Description

The gateway provided segmentation tags behavior as an always-enabled option. In order to implement a config flag that wouldn't change existing behavior, "tags_disabled" was implemented. When converting between OAS and the Tyk API Definition, this means that the configuration flag for the tags is copied between the two API definitions. This means what is disabled=false for tags in the tyk apidef becomes enabled=true in the OAS document.

This adds a cleanup for the OAS document that removes the gatewayTags entry if either the tags are disabled, or if they are enabled and no tags are defined (length=0).

Related Issue

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

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

furkansenharputlu · 2022-06-14T14:55:46Z

apidef/oas/server.go

@@ -60,6 +60,11 @@ func (s *Server) ExtractTo(api *apidef.APIDefinition) {
 	}
 	if s.GatewayTags != nil {
 		s.GatewayTags.ExtractTo(api)
+
+		// Omit gateway tags if empty or disabled
+		if !s.GatewayTags.Enabled || len(s.GatewayTags.Tags) == 0 {


Please use ShouldOmit function.

Also, nil set should be done after fill function, not extract.

I just removed a case, because it doesn't work for this structure. I think it doesn't handle the case where the GatewayTags are allocated (Tags field). As we do a nil check, this is type-safe and doesn't use reflection.

Correction: it didn't handle {Enabled: true}...

I added tags validation to require at least 1 array item, verified validation in validation tests. Also removed this from extract and left only in fill as suggested.

Tyk-ITS · 2022-06-14T15:06:31Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit:
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-14T15:15:30Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: d0a32c9
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-14T15:22:30Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: b6d2d8e
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-14T16:04:33Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: a42b23b
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-14T16:18:42Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 3dcb182
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-14T16:54:15Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: b1cc9cf
Triggered by: pull_request (@titpetric)
Execution page

github-actions · 2022-06-14T17:15:55Z

💥 CI tests failed 🙈

CI test log

all ok

gofmt

all ok

goimports

all ok

gogenerate

:100644 100644 2cf51f5d8c2a45fd6f87883dcf58b4084eb9a19a de2bc36c1eb6a5fc662f8cac1d508b8076b72aae M apidef/oas/schema/schema.gen.go

If the above are ok, please look at the run or in the Checks tab.

Tyk-ITS · 2022-06-14T17:21:20Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 20d5a35
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-14T17:22:15Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: cd31343
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-14T17:30:15Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 1503e13
Triggered by: pull_request (@titpetric)
Execution page

github-actions · 2022-06-14T18:41:42Z

💥 CI tests failed 🙈

CI test log

all ok

gofmt

all ok

goimports

all ok

gogenerate

:100644 100644 2cf51f5d8c2a45fd6f87883dcf58b4084eb9a19a de2bc36c1eb6a5fc662f8cac1d508b8076b72aae M apidef/oas/schema/schema.gen.go

If the above are ok, please look at the run or in the Checks tab.

github-actions · 2022-06-14T18:50:17Z

💥 CI tests failed 🙈

CI test log

all ok

gofmt

all ok

goimports

all ok

gogenerate

:100644 100644 2cf51f5d8c2a45fd6f87883dcf58b4084eb9a19a de2bc36c1eb6a5fc662f8cac1d508b8076b72aae M apidef/oas/schema/schema.gen.go

If the above are ok, please look at the run or in the Checks tab.

Tyk-ITS · 2022-06-14T18:56:32Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: bfaed2f
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-14T19:05:21Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 58c1aea
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-14T21:02:20Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 1e24359
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-15T06:31:30Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 5503b32
Triggered by: pull_request (@titpetric)
Execution page

furkansenharputlu · 2022-06-15T07:25:57Z

apidef/oas/server.go

@@ -42,7 +42,7 @@ func (s *Server) Fill(api apidef.APIDefinition) {
 		s.GatewayTags = &GatewayTags{}
 	}
 	s.GatewayTags.Fill(api)
-	if ShouldOmit(s.GatewayTags) {
+	if len(s.GatewayTags.Tags) == 0 {


Can you please explain why we change it ?

Think that the object will have more fields in future. That’s why we should continue with shouldomit.

shouldOmit won't omit s.GatewayTags when s.GatewayTags.Enabled is true and len(s.GatewayTags.Tags) is 0. I think this is required in such cases

It is a valid case why would you omit if enabled true. If you don't want 0 length tags with enabled, you would handle it in schema.

Tyk-ITS · 2022-06-15T07:29:35Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 92ac66f
Triggered by: pull_request (@titpetric)
Execution page

furkansenharputlu · 2022-06-15T08:22:01Z

apidef/oas/server.go

@@ -42,7 +42,7 @@ func (s *Server) Fill(api apidef.APIDefinition) {
 		s.GatewayTags = &GatewayTags{}
 	}
 	s.GatewayTags.Fill(api)
-	if ShouldOmit(s.GatewayTags) {
+	if ShouldOmit(s.GatewayTags.Tags) {


it should stay as it is. ShouldOmit(s.GatewayTags). I wouldn't push ShouldOmit if it was just and array length check.

Tyk-ITS · 2022-06-15T08:48:00Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 493ec32
Triggered by: pull_request (@titpetric)
Execution page

apidef/oas/server_test.go

Tyk-ITS · 2022-06-15T09:22:07Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 9c0a1df
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-15T09:52:00Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: e5f8922
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-15T09:57:56Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 24218f8
Triggered by: pull_request (@titpetric)
Execution page

… fix tests

sonarcloud · 2022-06-15T11:46:36Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

100.0% Coverage
0.0% Duplication

Tyk-ITS · 2022-06-15T11:46:59Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: 43dbef2
Triggered by: pull_request (@titpetric)
Execution page

Tyk-ITS · 2022-06-15T11:53:27Z

API tests result: success ✅
Branch used: refs/pull/4127/merge
Commit: c093096
Triggered by: pull_request (@titpetric)
Execution page

titpetric · 2022-06-15T14:12:28Z

/release to release-4

tykbot · 2022-06-15T14:12:42Z

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

* Omit gateway tags if empty * Fix existing omit tags case in Fill * Remove some gatewayTags invalid values in tests * Remove second omitEmpty case for gateway tags * Remove allocation of Tags, not required * Disable duplicate test for gatewayTags disabled * Verify gatewayTags array count with schema * Implement furkans suggestions as per PR #4129 * Add test case for Fill/ExtractTo behaviour * Update API schema (go generate) * Add test to validate GatewayTags in Tyk extension * Return enabled:false in oas document, don't omit * Adjust gatewayTags tests to account for ShouldOmit * Remove test, we test for gwtags fill in apidef * Remove duplicate tests for gatewaytags * Remove duplicate tests for gatewaytags * Remove gatewayTags.Tags minItems=1 from validation, pass along as-is, fix tests (cherry picked from commit f86f019)

tykbot · 2022-06-15T14:13:02Z

@titpetric Succesfully merged f86f01955daebde421b09387eb30446fe4667fcd to release-4 branch.

Tyk-ITS · 2022-06-15T14:27:45Z

API tests result: success ✅
Branch used: refs/heads/master
Commit: f86f019 Omit gateway tags if empty (#4127)

Omit gateway tags if empty
Fix existing omit tags case in Fill
Remove some gatewayTags invalid values in tests
Remove second omitEmpty case for gateway tags
Remove allocation of Tags, not required
Disable duplicate test for gatewayTags disabled
Verify gatewayTags array count with schema
Implement furkans suggestions as per PR Cleanup oas gateway tags #4129
Add test case for Fill/ExtractTo behaviour
Update API schema (go generate)
Add test to validate GatewayTags in Tyk extension
Return enabled:false in oas document, don't omit
Adjust gatewayTags tests to account for ShouldOmit
Remove test, we test for gwtags fill in apidef
Remove duplicate tests for gatewaytags
Remove duplicate tests for gatewaytags
Remove gatewayTags.Tags minItems=1 from validation, pass along as-is, fix tests
Triggered by: push (@titpetric)
Execution page

furkansenharputlu reviewed Jun 14, 2022

View reviewed changes

TykTechnologies deleted a comment from github-actions bot Jun 14, 2022

titpetric requested review from furkansenharputlu and jeffy-mathew June 14, 2022 15:30

titpetric force-pushed the fix/tt-5718/omit-gateway-tags-if-empty branch from bfaed2f to 58c1aea Compare June 14, 2022 18:48

furkansenharputlu reviewed Jun 15, 2022

View reviewed changes

furkansenharputlu approved these changes Jun 15, 2022

View reviewed changes

jeffy-mathew approved these changes Jun 15, 2022

View reviewed changes

furkansenharputlu reviewed Jun 15, 2022

View reviewed changes

titpetric force-pushed the fix/tt-5718/omit-gateway-tags-if-empty branch from edb9b67 to 9668e64 Compare June 15, 2022 08:22

titpetric added 2 commits June 15, 2022 10:23

Omit gateway tags if empty

ada5cd7

Fix existing omit tags case in Fill

e68fd7c

Adjust gatewayTags tests to account for ShouldOmit

9c0a1df

titpetric commented Jun 15, 2022

View reviewed changes

apidef/oas/server_test.go Outdated Show resolved Hide resolved

Remove test, we test for gwtags fill in apidef

24218f8

titpetric force-pushed the fix/tt-5718/omit-gateway-tags-if-empty branch from e5f8922 to 24218f8 Compare June 15, 2022 09:42

titpetric added 2 commits June 15, 2022 11:45

Remove duplicate tests for gatewaytags

0964557

Remove duplicate tests for gatewaytags

961b67e

Remove gatewayTags.Tags minItems=1 from validation, pass along as-is,…

c093096

… fix tests

titpetric force-pushed the fix/tt-5718/omit-gateway-tags-if-empty branch from 43dbef2 to c093096 Compare June 15, 2022 11:36

TykTechnologies deleted a comment from github-actions bot Jun 15, 2022

titpetric merged commit f86f019 into master Jun 15, 2022

titpetric deleted the fix/tt-5718/omit-gateway-tags-if-empty branch June 15, 2022 14:12

This was referenced Nov 29, 2022

release 4.3 #4449

Closed

merge/cf54fe538d59c059df4e858f0faa1a7535ba970b #4450

Closed

merge/cf54fe538d59c059df4e858f0faa1a7535ba970b #4451

Closed

Omit gateway tags if empty #4127

Omit gateway tags if empty #4127

Conversation

titpetric commented Jun 14, 2022 • edited

Description

Related Issue

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

Checklist

furkansenharputlu Jun 14, 2022

Choose a reason for hiding this comment

furkansenharputlu Jun 14, 2022 • edited

Choose a reason for hiding this comment

titpetric Jun 14, 2022 • edited

Choose a reason for hiding this comment

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 14, 2022

github-actions bot commented Jun 14, 2022

💥 CI tests failed 🙈

CI test log

gofmt

goimports

gogenerate

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 14, 2022

github-actions bot commented Jun 14, 2022

💥 CI tests failed 🙈

CI test log

gofmt

goimports

gogenerate

github-actions bot commented Jun 14, 2022

💥 CI tests failed 🙈

CI test log

gofmt

goimports

gogenerate

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 14, 2022

Tyk-ITS commented Jun 15, 2022

furkansenharputlu Jun 15, 2022

Choose a reason for hiding this comment

furkansenharputlu Jun 15, 2022

Choose a reason for hiding this comment

jeffy-mathew Jun 15, 2022 • edited

Choose a reason for hiding this comment

furkansenharputlu Jun 15, 2022

Choose a reason for hiding this comment

Tyk-ITS commented Jun 15, 2022

furkansenharputlu Jun 15, 2022 • edited

Choose a reason for hiding this comment

Tyk-ITS commented Jun 15, 2022

Tyk-ITS commented Jun 15, 2022

Tyk-ITS commented Jun 15, 2022

Tyk-ITS commented Jun 15, 2022

sonarcloud bot commented Jun 15, 2022

Tyk-ITS commented Jun 15, 2022

Tyk-ITS commented Jun 15, 2022

titpetric commented Jun 15, 2022

tykbot bot commented Jun 15, 2022

tykbot bot commented Jun 15, 2022

Tyk-ITS commented Jun 15, 2022

titpetric commented Jun 14, 2022 •

edited

furkansenharputlu Jun 14, 2022 •

edited

titpetric Jun 14, 2022 •

edited

jeffy-mathew Jun 15, 2022 •

edited

furkansenharputlu Jun 15, 2022 •

edited