[TT-11684] OAS-to-UDG converter - import paths & cleanup by buraksezer · Pull Request #6181 · TykTechnologies/tyk

buraksezer · 2024-03-25T09:57:32Z

User description

See https://tyktech.atlassian.net/browse/TT-11684

OpenAPI and AsyncAPI translator implementations were moved to https://github.com/TykTechnologies/graphql-translator
This PR updates graphql-go-tools library.

Type

enhancement, dependencies

Description

Updated import paths for AsyncAPI and OpenAPI adapters to use the new graphql-translator library.
Updated graphql-go-tools dependency to the latest version.
Added graphql-translator as a new dependency.
Adjusted checksums in go.sum for the updated and new dependencies.

Changes walkthrough

Relevant files

Enhancement

asyncapi.go `Update AsyncAPI Import Path to Use graphql-translator` apidef/adapter/asyncapi.go Replaced `graphql-go-tools/pkg/asyncapi` import with `graphql-translator/asyncapi`.	+1/-1
openapi.go `Update OpenAPI Import Path and Reorder Imports` apidef/adapter/openapi.go Removed `graphql-go-tools/pkg/openapi` import. Added `graphql-translator/openapi` import. Reordered imports to place `getkin/kin-openapi/openapi3` at the end.	+2/-3

Dependencies

go.mod `Update graphql-go-tools and Add graphql-translator Dependency` go.mod Updated `graphql-go-tools` dependency to a newer version. Added `graphql-translator` dependency.	+2/-1
go.sum `Update Checksums for Dependencies` go.sum Updated checksums for `graphql-go-tools`. Added checksums for `graphql-translator`.	+4/-2

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

…paths-cleanup

github-actions · 2024-03-25T09:58:12Z

API Changes

no api changes detected

github-actions · 2024-03-25T09:58:21Z

PR Description updated to latest commit (60ab66c)

github-actions · 2024-03-25T09:58:49Z

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are mostly about updating import paths and dependencies, which are straightforward. However, ensuring compatibility and no side effects with the new versions requires some attention.
🧪 Relevant tests	No
🔍 Possible issues	Dependency Version Compatibility: The update to `graphql-go-tools` and addition of `graphql-translator` might introduce compatibility issues if not properly tested with existing code.
🔒 Security concerns	No

Code feedback:

relevant file	apidef/adapter/asyncapi.go
suggestion	Ensure that the new `graphql-translator/asyncapi` package is fully compatible with the existing codebase and does not introduce breaking changes. Consider running integration tests that cover AsyncAPI functionality. [important]
relevant line	"github.com/TykTechnologies/graphql-translator/asyncapi"

relevant file	apidef/adapter/openapi.go
suggestion	Verify that the updated import path to `graphql-translator/openapi` does not affect the OpenAPI functionality, especially if there are any specific customizations or extensions previously relying on `graphql-go-tools/pkg/openapi`. [important]
relevant line	"github.com/TykTechnologies/graphql-translator/openapi"

relevant file	go.mod
suggestion	After updating `graphql-go-tools` to a newer version and adding `graphql-translator`, ensure to test the entire application for any unexpected behavior or deprecations that might have been introduced. [important]
relevant line	github.com/TykTechnologies/graphql-translator v0.0.0-20240319092712-4ba87e4c06ff

relevant file	go.sum
suggestion	After updating dependencies, it's a good practice to run `go mod tidy` to clean up any unnecessary entries in `go.sum` to keep the project clean and manageable. [medium]
relevant line	github.com/TykTechnologies/graphql-translator v0.0.0-20240319092712-4ba87e4c06ff h1:kFA240S1Y4snsEL4Ng4Ch1Ib2N04A15Y+9KYumK6uCg=

✨ Review tool usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

github-actions · 2024-03-25T09:58:50Z

PR Code Suggestions

Category	Suggestions
Maintainability	Organize imports by grouping them for better readability. Consider organizing your imports by grouping them into standard library, external libraries, and internal packages for better readability. apidef/adapter/asyncapi.go [10-17] "github.com/buger/jsonparser" "github.com/TykTechnologies/graphql-go-tools/pkg/astprinter" "github.com/TykTechnologies/graphql-go-tools/pkg/engine/datasource/kafka_datasource" "github.com/TykTechnologies/graphql-go-tools/pkg/operationreport" + "github.com/TykTechnologies/graphql-translator/asyncapi" "github.com/TykTechnologies/tyk/apidef"
Possible issue	Verify the usage of newly added imports to avoid unnecessary package imports. Ensure that the newly added imports are used within the file to avoid importing packages unnecessarily which can lead to increased compilation time and binary size. apidef/adapter/openapi.go [12-17] -"github.com/TykTechnologies/graphql-go-tools/pkg/astprinter" -"github.com/TykTechnologies/graphql-go-tools/pkg/operationreport" -"github.com/TykTechnologies/graphql-translator/openapi" -"github.com/TykTechnologies/tyk/apidef" -"github.com/getkin/kin-openapi/openapi3" +"Ensure that all imported packages are used within the file."
Enhancement	Update to the latest stable version of `github.com/TykTechnologies/graphql-go-tools`. Update the version of `github.com/TykTechnologies/graphql-go-tools` to the latest stable version if possible, to ensure you have the latest features and bug fixes. go.mod [17-18] -github.com/TykTechnologies/graphql-go-tools v1.6.2-0.20240325095122-27642576e0c2 +github.com/TykTechnologies/graphql-go-tools vX.Y.Z
Best practice	Use `go mod tidy` to clean up the `go.sum` file after updating dependencies. After updating dependencies in `go.mod`, run `go mod tidy` to clean up the `go.sum` file and remove any unnecessary checksums for unused dependencies. go.sum [50-55] -github.com/TykTechnologies/graphql-go-tools v1.6.2-0.20240325095122-27642576e0c2 h1:3txS7U6fY4sNtSzhdDhTQYXZz6kEZOjs3+4OLAolpac= -github.com/TykTechnologies/graphql-go-tools v1.6.2-0.20240325095122-27642576e0c2/go.mod h1:DCYkq1ZoUZ/pGESE+j3C7wuyDPSt1Mlu0jVgIoDABJY= -github.com/TykTechnologies/graphql-translator v0.0.0-20240319092712-4ba87e4c06ff h1:kFA240S1Y4snsEL4Ng4Ch1Ib2N04A15Y+9KYumK6uCg= -github.com/TykTechnologies/graphql-translator v0.0.0-20240319092712-4ba87e4c06ff/go.mod h1:K3KhGG9CmvXv1lJhKZpnLb1tC8N1oIzXTunQsc6N9og= +"Run `go mod tidy` to clean up unnecessary checksums."

✨ Improve tool usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.

github-actions · 2024-03-25T09:59:37Z

💥 CI tests failed 🙈

git-state

diff --git a/apidef/adapter/openapi.go b/apidef/adapter/openapi.go
index dd5b054..fa7278b 100644
--- a/apidef/adapter/openapi.go
+++ b/apidef/adapter/openapi.go
@@ -9,11 +9,12 @@ import (
 	"net/url"
 	"path"
 
+	"github.com/getkin/kin-openapi/openapi3"
+
 	"github.com/TykTechnologies/graphql-go-tools/pkg/astprinter"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/operationreport"
 	"github.com/TykTechnologies/graphql-translator/openapi"
 	"github.com/TykTechnologies/tyk/apidef"
-	"github.com/getkin/kin-openapi/openapi3"
 )
 
 const defaultRequestBodyMimeType = "application/json"

Please look at the run or in the Checks tab.

github-actions · 2024-03-25T09:59:40Z

💥 CI tests failed 🙈

git-state

diff --git a/apidef/adapter/openapi.go b/apidef/adapter/openapi.go
index dd5b054..fa7278b 100644
--- a/apidef/adapter/openapi.go
+++ b/apidef/adapter/openapi.go
@@ -9,11 +9,12 @@ import (
 	"net/url"
 	"path"
 
+	"github.com/getkin/kin-openapi/openapi3"
+
 	"github.com/TykTechnologies/graphql-go-tools/pkg/astprinter"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/operationreport"
 	"github.com/TykTechnologies/graphql-translator/openapi"
 	"github.com/TykTechnologies/tyk/apidef"
-	"github.com/getkin/kin-openapi/openapi3"
 )
 
 const defaultRequestBodyMimeType = "application/json"

Please look at the run or in the Checks tab.

github-actions · 2024-03-25T09:59:58Z

💥 CI tests failed 🙈

git-state

diff --git a/apidef/adapter/openapi.go b/apidef/adapter/openapi.go
index dd5b054..fa7278b 100644
--- a/apidef/adapter/openapi.go
+++ b/apidef/adapter/openapi.go
@@ -9,11 +9,12 @@ import (
 	"net/url"
 	"path"
 
+	"github.com/getkin/kin-openapi/openapi3"
+
 	"github.com/TykTechnologies/graphql-go-tools/pkg/astprinter"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/operationreport"
 	"github.com/TykTechnologies/graphql-translator/openapi"
 	"github.com/TykTechnologies/tyk/apidef"
-	"github.com/getkin/kin-openapi/openapi3"
 )
 
 const defaultRequestBodyMimeType = "application/json"

Please look at the run or in the Checks tab.

github-actions · 2024-03-25T10:00:00Z

💥 CI tests failed 🙈

git-state

diff --git a/apidef/adapter/openapi.go b/apidef/adapter/openapi.go
index dd5b054..fa7278b 100644
--- a/apidef/adapter/openapi.go
+++ b/apidef/adapter/openapi.go
@@ -9,11 +9,12 @@ import (
 	"net/url"
 	"path"
 
+	"github.com/getkin/kin-openapi/openapi3"
+
 	"github.com/TykTechnologies/graphql-go-tools/pkg/astprinter"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/operationreport"
 	"github.com/TykTechnologies/graphql-translator/openapi"
 	"github.com/TykTechnologies/tyk/apidef"
-	"github.com/getkin/kin-openapi/openapi3"
 )
 
 const defaultRequestBodyMimeType = "application/json"

Please look at the run or in the Checks tab.

sonarqubecloud · 2024-03-25T10:15:22Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

buraksezer added 2 commits March 22, 2024 12:13

[TT-11684] OAS-to-UDG converter - import paths & cleanup

f0083d8

[TT-11684] Update graphql-go-tools dependency.

bd83d1e

buraksezer requested review from kofoworola and rhianeKobar March 25, 2024 09:57

Merge branch 'master' into feat/TT-11684/OAS-to-UDG-converter-import-…

60ab66c

…paths-cleanup

github-actions Bot added enhancement dependencies Pull requests that update a dependency file labels Mar 25, 2024

github-actions Bot added the Review effort [1-5]: 2 label Mar 25, 2024

[TT-11684] Run make lint

45e83c1

rhianeKobar approved these changes Mar 25, 2024

View reviewed changes

buraksezer merged commit d6309e7 into master Mar 26, 2024

buraksezer deleted the feat/TT-11684/OAS-to-UDG-converter-import-paths-cleanup branch March 26, 2024 07:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[TT-11684] OAS-to-UDG converter - import paths & cleanup#6181

[TT-11684] OAS-to-UDG converter - import paths & cleanup#6181
buraksezer merged 4 commits into
masterfrom
feat/TT-11684/OAS-to-UDG-converter-import-paths-cleanup

buraksezer commented Mar 25, 2024 •

edited by github-actions Bot

Loading

Uh oh!

github-actions Bot commented Mar 25, 2024

Uh oh!

github-actions Bot commented Mar 25, 2024

Uh oh!

github-actions Bot commented Mar 25, 2024

Uh oh!

github-actions Bot commented Mar 25, 2024 •

edited

Loading

Uh oh!

github-actions Bot commented Mar 25, 2024

Uh oh!

github-actions Bot commented Mar 25, 2024

Uh oh!

github-actions Bot commented Mar 25, 2024

Uh oh!

github-actions Bot commented Mar 25, 2024

Uh oh!

sonarqubecloud Bot commented Mar 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

buraksezer commented Mar 25, 2024 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

Type

Description

Changes walkthrough

Uh oh!

github-actions Bot commented Mar 25, 2024

Uh oh!

github-actions Bot commented Mar 25, 2024

Uh oh!

github-actions Bot commented Mar 25, 2024

PR Review

Uh oh!

github-actions Bot commented Mar 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions

Uh oh!

github-actions Bot commented Mar 25, 2024

💥 CI tests failed 🙈

git-state

Uh oh!

github-actions Bot commented Mar 25, 2024

💥 CI tests failed 🙈

git-state

Uh oh!

github-actions Bot commented Mar 25, 2024

💥 CI tests failed 🙈

git-state

Uh oh!

github-actions Bot commented Mar 25, 2024

💥 CI tests failed 🙈

git-state

Uh oh!

sonarqubecloud Bot commented Mar 25, 2024

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

buraksezer commented Mar 25, 2024 •

edited by github-actions Bot

Loading

github-actions Bot commented Mar 25, 2024 •

edited

Loading