chore: replaced kin-openapi library with libopenapi #194

Prashansa-K · 2024-08-14T10:38:49Z

deck file openapi2kong command uses kin-openapi
for all its OpenAPI requirements. This library
does not support OpenAPI 3.1, which is a
requirement from the users.
Thus, this change updates the library to libopenapi which can help us to adopt OpenAPI 3.1

For APIOps #1324
Kong/deck#1324

I didn't add much code refactoring in this PR for the aid of the review. I will take that up in a different PR.

codecov-commenter · 2024-08-14T10:51:54Z

Codecov Report

Attention: Patch coverage is 75.66667% with 73 lines in your changes missing coverage. Please review.

Project coverage is 68.19%. Comparing base (e464df7) to head (d14c3ed).

Files	Patch %	Lines
openapi2kong/openapi2kong.go	68.78%	27 Missing and 27 partials ⚠️
openapi2kong/utils.go	82.75%	8 Missing and 2 partials ⚠️
openapi2kong/jsonschema.go	78.12%	3 Missing and 4 partials ⚠️
openapi2kong/validator.go	92.85%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #194      +/-   ##
==========================================
+ Coverage   67.86%   68.19%   +0.33%     
==========================================
  Files          23       24       +1     
  Lines        2505     2550      +45     
==========================================
+ Hits         1700     1739      +39     
+ Misses        644      643       -1     
- Partials      161      168       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

deck file openapi2kong command uses kin-openapi for all its OpenAPI requirements. This library does not support OpenAPI 3.1, which is a requirement from the users. Thus, this change updates the library to libopenapi which can help us to adopt OpenAPI 3.1 For APIOps #1324 Kong/deck#1324

Prashansa-K · 2024-08-14T11:32:55Z

patch/deckpatch.go

@@ -157,6 +157,7 @@ func (patch *DeckPatch) ApplyToNodes(yamlData *yaml.Node) (err error) {
 		logbasics.Info("Patch has no selectors specified")
 	}

+	//nolint:gosimple


Unrelated to my diff.
Thus, I have added a nolint rule here.

Prashansa-K · 2024-08-14T11:33:16Z

yamlbasics/selectors.go

@@ -46,6 +46,7 @@ func NewSelectorSet(selectors []string) (SelectorSet, error) {

 // IsEmpty returns true if the selector set is empty.
 func (set *SelectorSet) IsEmpty() bool {
+	//nolint:gosimple


Unrelated to my diff.
Thus, I have added a nolint rule here.
Same for L71

aboudreault

nice work @Prashansa-K !! Added some minor comments. Note that I don't know this go-apiops library so I think this work seems safe if the test suite and coverage are good.

aboudreault · 2024-08-16T12:17:20Z

namespace/namespace_host.go

@@ -15,6 +15,7 @@ func ApplyNamespaceHost(
 	deckfile *yaml.Node, // the deckFile to operate on
 	selectors yamlbasics.SelectorSet, // the selectors to use to select the routes
 	hosts []string, // the hosts to add to the routes
+	//nolint:predeclared


CI doesn't seem to complain, but locally I am getting this error:

namespace/namespace_host.go:18:2: directive `//nolint:predeclared` is unused for linter "predeclared" (nolintlint) //nolint:predeclared ``

It could be because of the differences in the golangci-lint version we are using in the CI and the one used locally.
Let me check with same versions, because I added all the //nolint comments after checking the CI. I wasn't getting any warnings in my local setup.

aboudreault · 2024-08-16T12:30:48Z

openapi2kong/jsonschema.go

+	for _, schema := range s.AllOf {
+		dereferenceSchema(schema, seenBefore)
+	}
+
+	for _, schema := range s.AnyOf {
+		dereferenceSchema(schema, seenBefore)
+	}
+
+	for _, schema := range s.OneOf {
+		dereferenceSchema(schema, seenBefore)
+	}


nit: could probably also be a single for as before

The types had changed in the two underlying libraries.
In kin-openapi (older lib), s.AllOf and others were of type SchemaProxy
In the new one, all these are of type []*SchemaProxy
So, I had to use different for loops. Though, I have changed them to a nested one now. Makes things more readable.

aboudreault · 2024-08-16T12:44:02Z

openapi2kong/jsonschema.go

+	finalSchema := make(map[string]interface{})
+
+	if s.IsReference() {
+		// Add ref key and string


nit: I would avoid comments that don't add more useful details than what we can read from the code itself.

aboudreault · 2024-08-16T12:55:01Z

openapi2kong/openapi2kong.go

-	default:
-		return nil, fmt.Errorf("expected 'x-kong-tags' to be an array of strings")
+	kongTags, ok := doc.Extensions.Get("x-kong-tags")
+


Suggested change

aboudreault · 2024-08-16T12:56:09Z

openapi2kong/openapi2kong.go

-	for i := 0; i < len(tagsArray); i++ {
-		switch tag := tagsArray[i].(type) {
+	resultArray := make([]string, len(kongTags.Content))
+


Suggested change

aboudreault · 2024-08-16T13:02:16Z

openapi2kong/openapi2kong.go

+	}
+
+	var jsonBlob interface{}
+	_ = yaml.Unmarshal(xKongObjectBytes, &jsonBlob)


any particular reason to not handle the error here?

This is because we error out in the upcoming line where we check it the jsonBlob can be safely converted to an object of type map[string]interface{}. If not, we are returning a user-specific error.

aboudreault · 2024-08-16T13:03:33Z

openapi2kong/openapi2kong.go

-		default:
-			return nil, fmt.Errorf("expected '/components/x-kong' to be a JSON object")
-		}
+	if !ok || xKongComponents == nil {


same question about the !ok handling

This is similar to the above !ok handling.
A component may not have any extensions added via x-kong
Here's an example from this repo itself: https://github.com/Kong/go-apiops/blob/main/docs/mock-a-rena-oas.yml
This spec doesn't use any extensions (top level or component level), but it is still a valid spec and we can generate its equivalent kong config.

aboudreault · 2024-08-16T13:04:04Z

openapi2kong/openapi2kong.go

+	}
+
+	var xKong interface{}
+	_ = yaml.Unmarshal(xKongComponentsBytes, &xKong)


same question about the error handling

Same reason as above error handling comment. I have changed this one's handling to how we handle things above as well.

aboudreault · 2024-08-16T13:08:52Z

openapi2kong/openapi2kong.go

+			var pluginConfig map[string]interface{}
+			err = json.Unmarshal(jsonstr, &pluginConfig)
+			if err != nil {
+				return nil, fmt.Errorf(fmt.Sprintf("failed to parse JSON object for '%s': %%w", extensionName), err)


Suggested change

return nil, fmt.Errorf(fmt.Sprintf("failed to parse JSON object for '%s': %%w", extensionName), err)

return nil, fmt.Errorf("failed to parse JSON object for '%s': %w", extensionName, err)

aboudreault · 2024-08-16T13:31:31Z

openapi2kong/openapi2kong.go

 		kongComponents, kongTags, opts.SkipID)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create plugins list from document root: %w", err)
 	}

-	// get the OIDC stuff from top level, bail out if the requirements are unsupported
+	// // get the OIDC stuff from top level, bail out if the requirements are unsupported


Suggested change

// // get the OIDC stuff from top level, bail out if the requirements are unsupported

// get the OIDC stuff from top level, bail out if the requirements are unsupported

Prashansa-K · 2024-08-19T07:00:30Z

nice work @Prashansa-K !! Added some minor comments. Note that I don't know this go-apiops library so I think this work seems safe if the test suite and coverage are good.

Thank you! I will also test this out with some more examples to be thorough.

This version of go-apiops has replaced kin-openapi with libopenapi to add further support of OpenAPI 3.1 Refer: Kong/go-apiops#194 This change would not affect users using OpenAPI 3.0 spec with deck command. Fix for #1324: #1324

Prashansa-K force-pushed the chore/move-to-libopenapi branch from e6359e0 to fcd8764 Compare August 14, 2024 10:48

Prashansa-K requested review from mheap and Tieske August 14, 2024 10:58

Prashansa-K force-pushed the chore/move-to-libopenapi branch from b8cf0bf to 3c66c66 Compare August 14, 2024 11:27

chore: lint check corrections

4af8ef3

Prashansa-K commented Aug 14, 2024

View reviewed changes

hbagdi requested a review from GGabriele August 16, 2024 09:48

aboudreault reviewed Aug 16, 2024

View reviewed changes

chore: corrections for line spaces, error handling, stray comments

d14c3ed

Prashansa-K requested a review from aboudreault August 19, 2024 07:03

aboudreault approved these changes Aug 19, 2024

View reviewed changes

Prashansa-K requested a review from hbagdi August 21, 2024 06:22

hbagdi approved these changes Aug 22, 2024

View reviewed changes

Prashansa-K merged commit 66febca into main Aug 22, 2024
3 checks passed

Prashansa-K deleted the chore/move-to-libopenapi branch August 22, 2024 06:07

Prashansa-K mentioned this pull request Aug 22, 2024

chore: updated go-apiops to latest version Kong/deck#1373

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: replaced kin-openapi library with libopenapi #194

chore: replaced kin-openapi library with libopenapi #194

Prashansa-K commented Aug 14, 2024

codecov-commenter commented Aug 14, 2024 •

edited

Loading

Prashansa-K Aug 14, 2024

Prashansa-K Aug 14, 2024

aboudreault left a comment

aboudreault Aug 16, 2024

Prashansa-K Aug 19, 2024

aboudreault Aug 16, 2024

Prashansa-K Aug 19, 2024

aboudreault Aug 16, 2024

aboudreault Aug 16, 2024

aboudreault Aug 16, 2024

aboudreault Aug 16, 2024

Prashansa-K Aug 19, 2024

aboudreault Aug 16, 2024

Prashansa-K Aug 19, 2024

aboudreault Aug 16, 2024

Prashansa-K Aug 19, 2024

aboudreault Aug 16, 2024

aboudreault Aug 16, 2024

Prashansa-K commented Aug 19, 2024

	return nil, fmt.Errorf(fmt.Sprintf("failed to parse JSON object for '%s': %%w", extensionName), err)
	return nil, fmt.Errorf("failed to parse JSON object for '%s': %w", extensionName, err)

	// // get the OIDC stuff from top level, bail out if the requirements are unsupported
	// get the OIDC stuff from top level, bail out if the requirements are unsupported

chore: replaced kin-openapi library with libopenapi #194

chore: replaced kin-openapi library with libopenapi #194

Conversation

Prashansa-K commented Aug 14, 2024

codecov-commenter commented Aug 14, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aboudreault left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Prashansa-K commented Aug 19, 2024

codecov-commenter commented Aug 14, 2024 •

edited

Loading