From 4f3622e3802cbd27d2b28b29e42f88164df0feae Mon Sep 17 00:00:00 2001 From: Jeffy Mathew Date: Mon, 18 Nov 2024 14:57:55 +0100 Subject: [PATCH] [TT-13535/TT-13566] Make upstream oauth flow client secret omitempty (#6708) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### **User description**
TT-13566
Summary Make upstream auth oauth password client secret not required in oas schema
Type Sub-task Sub-task
Status Ready for Testing
Points N/A
Labels -
--- ## Description Make upstream oauth flow client secret omitempty to not break when an API is created without `clientSecret` and saved later. ## Related Issue Parent: https://tyktech.atlassian.net/browse/TT-13535 Subtask: https://tyktech.atlassian.net/browse/TT-13566 ## 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** enhancement ___ ### **Description** - Updated the `ClientAuthData` struct in `apidef/api_definitions.go` to make the `ClientSecret` field optional by adding the `omitempty` tag. - This change prevents errors when an API is created without a `clientSecret` and saved later. ___ ### **Changes walkthrough** 📝
Relevant files
Enhancement
api_definitions.go
Make `ClientSecret` optional in OAuth client auth data     
apidef/api_definitions.go
  • Made ClientSecret field optional by adding omitempty tag.
  • Updated JSON and BSON tags for ClientSecret to reflect optional
    status.
    		•  +1/-1     
    ___ > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull request to receive relevant information (cherry picked from commit c8f21dcd77bc48da511628e67a43a691e29407f8) --- apidef/api_definitions.go | 2 +- apidef/api_definitions_test.go | 22 ++++++++++++++++++++++ apidef/oas/upstream.go | 2 +- apidef/schema.go | 1 - 4 files changed, 24 insertions(+), 3 deletions(-) diff --git a/apidef/api_definitions.go b/apidef/api_definitions.go index 53a536c0807..d8bc35864ec 100644 --- a/apidef/api_definitions.go +++ b/apidef/api_definitions.go @@ -849,7 +849,7 @@ type ClientAuthData struct { // ClientID is the application's ID. ClientID string `bson:"client_id" json:"client_id"` // ClientSecret is the application's secret. - ClientSecret string `bson:"client_secret" json:"client_secret"` + ClientSecret string `bson:"client_secret,omitempty" json:"client_secret,omitempty"` // client secret is optional for password flow } // ClientCredentials holds the client credentials for upstream OAuth2 authentication. diff --git a/apidef/api_definitions_test.go b/apidef/api_definitions_test.go index b3408b7ec98..8b488c9b2cc 100644 --- a/apidef/api_definitions_test.go +++ b/apidef/api_definitions_test.go @@ -15,6 +15,17 @@ func TestSchema(t *testing.T) { schemaLoader := schema.NewBytesLoader([]byte(Schema)) spec := DummyAPI() + spec.UpstreamAuth = UpstreamAuth{ + Enabled: true, + OAuth: UpstreamOAuth{ + Enabled: true, + ClientCredentials: ClientCredentials{ + ClientAuthData: ClientAuthData{ + ClientSecret: "dummy", // workaround to fix schema error + }, + }, + }, + } goLoader := schema.NewGoLoader(spec) result, err := schema.Validate(schemaLoader, goLoader) if err != nil { @@ -100,6 +111,17 @@ func TestSchemaGraphqlConfig(t *testing.T) { schemaLoader := schema.NewBytesLoader([]byte(Schema)) spec := DummyAPI() + spec.UpstreamAuth = UpstreamAuth{ + Enabled: true, + OAuth: UpstreamOAuth{ + Enabled: true, + ClientCredentials: ClientCredentials{ + ClientAuthData: ClientAuthData{ + ClientSecret: "dummy", // workaround to fix schema error + }, + }, + }, + } spec.GraphQL.ExecutionMode = "" goLoader := schema.NewGoLoader(spec) diff --git a/apidef/oas/upstream.go b/apidef/oas/upstream.go index 84e503a6061..6a5505a8cf8 100644 --- a/apidef/oas/upstream.go +++ b/apidef/oas/upstream.go @@ -681,7 +681,7 @@ type ClientAuthData struct { // ClientID is the application's ID. ClientID string `bson:"clientId" json:"clientId"` // ClientSecret is the application's secret. - ClientSecret string `bson:"clientSecret" json:"clientSecret"` + ClientSecret string `bson:"clientSecret,omitempty" json:"clientSecret,omitempty"` // client secret is optional for password flow } // ClientCredentials holds the configuration for OAuth2 Client Credentials flow. diff --git a/apidef/schema.go b/apidef/schema.go index 34c48674e61..f3c62b8576b 100644 --- a/apidef/schema.go +++ b/apidef/schema.go @@ -1107,7 +1107,6 @@ const Schema = `{ }, "required": [ "client_id", - "client_secret", "token_url", "username", "password"