Switch to speakeasy-api/jsonpath

deckformat/entitypointers.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/vmware-labs/yaml-jsonpath/pkg/yamlpath"
+	"github.com/speakeasy-api/jsonpath/pkg/jsonpath"
 	"gopkg.in/yaml.v3"
 )
 
@@ -161,16 +161,12 @@ func GetEntities(deckfile *yaml.Node, entityType string) []*yaml.Node {
 	}
 
 	for _, entitySelector := range entitySelectors {
-		query, err := yamlpath.NewPath(entitySelector)
+		query, err := jsonpath.NewPath(entitySelector)
 		if err != nil {
 			panic("failed compiling " + entityType + " selector")
 		}
 
-		entities, err := query.Find(deckfile)
-		if err != nil {
-			panic("failed to collect " + entityType + " from the input data")
-		}
-
+		entities := query.Query(deckfile)
 		allEntities = append(allEntities, entities...)
 	}
 

docs/README.md

@@ -16,12 +16,6 @@ Kong will be expanding the library of available tools leading up to a GA release
 
 The below examples assume you have installed and are using the `deck` CLI tool.
 
-## Notes
-| :exclamation:  Important compatibility notes  :exclamation: |
-|:---------------------------|
-| The [jsonpath library](https://github.com/vmware-labs/yaml-jsonpath) in use has [a bug](https://github.com/vmware-labs/yaml-jsonpath/issues/54) related to the "recursive descent" operator (`..`). Filter expressions following a recursive descent will not succeed unless prefixed with a generic wilcard (`[*]`).<br/><br/>Non-recursive-descent works as expected:<br/>> `$.plugins[?(@.regex_priority>100)]`</br>where recursive-descent will fail:<br/>> `$..plugins[?(@.regex_priority>100)]`</br>The workaround is to add an extra wildcard (`[*]`) before the filter expression like this:<br/>> `$..plugins[*][?(@.regex_priority>100)]`</br><br/>To test and debug selectors, you can use the library’s built in web UI by following the [Web Application Instructions](https://github.com/vmware-labs/yaml-jsonpath/tree/main/web).|
-
-
 ## Commands
 
 ---

go.mod

@@ -12,10 +12,10 @@ require (
 	github.com/kong/go-slugify v1.0.0
 	github.com/onsi/ginkgo/v2 v2.22.2
 	github.com/onsi/gomega v1.36.2
-	github.com/pb33f/libopenapi v0.16.13
+	github.com/pb33f/libopenapi v0.24.0
+	github.com/speakeasy-api/jsonpath v0.6.2
 	github.com/spf13/cobra v1.8.1
 	github.com/stretchr/testify v1.10.0
-	github.com/vmware-labs/yaml-jsonpath v0.3.2
 	github.com/yuin/gopher-lua v1.1.1
 	golang.org/x/term v0.29.0
 	gopkg.in/yaml.v3 v3.0.1
@@ -26,15 +26,14 @@ require (
 	github.com/bahlo/generic-list-go v0.2.0 // indirect
 	github.com/buger/jsonparser v1.1.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/dprotaso/go-yit v0.0.0-20220510233725-9ba8df137936 // indirect
 	github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
 	github.com/google/pprof v0.0.0-20241210010833-40e02aabc2ad // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mozillazg/go-unidecode v0.2.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect
+	github.com/wk8/go-ordered-map/v2 v2.1.9-0.20240815153524-6ea36470d1bd // indirect
 	golang.org/x/net v0.33.0 // indirect
 	golang.org/x/sys v0.30.0 // indirect
 	golang.org/x/text v0.21.0 // indirect

patch/deckpatch.go

@@ -6,7 +6,7 @@ import (
 	"github.com/kong/go-apiops/jsonbasics"
 	"github.com/kong/go-apiops/logbasics"
 	"github.com/kong/go-apiops/yamlbasics"
-	"github.com/vmware-labs/yaml-jsonpath/pkg/yamlpath"
+	"github.com/speakeasy-api/jsonpath/pkg/jsonpath"
 	"gopkg.in/yaml.v3"
 )
 
@@ -16,7 +16,7 @@ var DefaultSelector = []string{"$"}
 type DeckPatch struct {
 	// Format         string                 // Name of the format specified
 	SelectorSources []string               // Source query for the JSONpath object
-	Selectors       []*yamlpath.Path       // JSONpath object
+	Selectors       []*jsonpath.JSONPath   // JSONpath object
 	ObjValues       map[string]interface{} // Values to set on target objects
 	ArrValues       []interface{}          // Values to set on target arrays
 	Remove          []string               // List of keys to remove from the target object
@@ -41,11 +41,11 @@ func (patch *DeckPatch) Parse(obj map[string]interface{}, breadCrumb string) (er
 	}
 
 	// compile JSONpath expressions
-	patch.Selectors = make([]*yamlpath.Path, len(patch.SelectorSources))
+	patch.Selectors = make([]*jsonpath.JSONPath, len(patch.SelectorSources))
 	for i, selector := range patch.SelectorSources {
-		patch.Selectors[i], err = yamlpath.NewPath(selector)
+		patch.Selectors[i], err = jsonpath.NewPath(selector)
 		if err != nil {
-			return fmt.Errorf("%s.selectors[%d] is not a valid JSONpath expression; %w", breadCrumb, i, err)
+			return fmt.Errorf("%s.selectors[%d] is not a valid JSONpath expression; %s", breadCrumb, i, err.Error())
 		}
 	}
 
@@ -159,9 +159,9 @@ func (patch *DeckPatch) ApplyToNodes(yamlData *yaml.Node) (err error) {
 
 	//nolint:gosimple
 	if patch.Selectors == nil || len(patch.Selectors) == 0 {
-		patch.Selectors = make([]*yamlpath.Path, len(patch.SelectorSources))
+		patch.Selectors = make([]*jsonpath.JSONPath, len(patch.SelectorSources))
 		for i, selector := range patch.SelectorSources {
-			patch.Selectors[i], err = yamlpath.NewPath(selector)
+			patch.Selectors[i], err = jsonpath.NewPath(selector)
 			if err != nil {
 				return fmt.Errorf("selector '%s' is not a valid JSONpath expression; %w", selector, err)
 			}
@@ -170,15 +170,11 @@ func (patch *DeckPatch) ApplyToNodes(yamlData *yaml.Node) (err error) {
 
 	// query the yamlData using the selector
 	nodes := make([]*yaml.Node, 0)
-	for _, selector := range patch.Selectors {
-		moreNodes, err := selector.Find(yamlData)
-		if err != nil {
-			return err
-		}
-		nodes = append(nodes, moreNodes...)
-	}
 
-	// 'nodes' is an array of nodes matching the selectors
+	for _, selector := range patch.Selectors {
+		results := selector.Query(yamlData)
+		nodes = append(nodes, results...)
+	} // 'nodes' is an array of nodes matching the selectors
 	for _, node := range nodes {
 		if len(patch.ArrValues) > 0 {
 			// since we're updating array fields, we'll skip anything that is

patch/patch_test.go

@@ -75,7 +75,7 @@ var _ = Describe("Patch", func() {
 			err := patch.Parse(data, "file1.yml:patches[1]")
 
 			Expect(err).To(MatchError("file1.yml:patches[1].selectors[0] is not a valid JSONpath " +
-				"expression; invalid character ' ' at position 3, following \"not\""))
+				"expression; Error at line 1, column 0: expected '$'\nnot valid\n^..\n"))
 		})
 
 		It("fails on non object/array 'values'", func() {
@@ -261,7 +261,7 @@ var _ = Describe("Patch", func() {
 			data := []byte(`{}`)
 			err := testPatch.ApplyToNodes(jsonbasics.ConvertToYamlNode(MustDeserialize(data)))
 			Expect(err).To(MatchError("selector 'bad JSONpath' is not a valid JSONpath expression; " +
-				"invalid character ' ' at position 3, following \"bad\""))
+				"Error at line 1, column 0: expected '$'\nbad JSONpath\n^..\n"))
 		})
 	})
 
@@ -332,6 +332,76 @@ var _ = Describe("Patch", func() {
 			}`))
 		})
 
+		It("works with plain recursive descent", func() {
+			data := []byte(`{
+				"services": [
+					{
+						"name": "one",
+						"routes": [
+							{
+								"name": "demo-route_get",
+								"methods": ["GET"]
+							}
+						]
+					}
+				]
+			}`)
+			selector := "$..routes[*]"
+			valueFlags := []string{
+				"added:\"field\"",
+			}
+
+			Expect(applyUpdates(data, selector, valueFlags)).To(MatchJSON(`{
+				"services": [
+					{
+						"name": "one",
+						"routes": [
+							{
+								"added": "field",
+								"name": "demo-route_get",
+								"methods": ["GET"]
+							}
+						]
+					}
+				]
+			}`))
+		})
+
+		It("works with recursive descent using filters", func() {
+			data := []byte(`{
+				"services": [
+					{
+						"name": "one",
+						"routes": [
+							{
+								"name": "demo-route_get",
+								"methods": ["GET"]
+							}
+						]
+					}
+				]
+			}`)
+			selector := "$..routes[?(@.name==\"demo-route_get\")]"
+			valueFlags := []string{
+				"added:\"field\"",
+			}
+
+			Expect(applyUpdates(data, selector, valueFlags)).To(MatchJSON(`{
+				"services": [
+					{
+						"name": "one",
+						"routes": [
+							{
+								"added": "field",
+								"name": "demo-route_get",
+								"methods": ["GET"]
+							}
+						]
+					}
+				]
+			}`))
+		})
+
 		It("skips non-objects", func() {
 			data := []byte(`{
 				"plugins": [

plugins/plugins.go

@@ -12,7 +12,7 @@ import (
 	"github.com/kong/go-apiops/jsonbasics"
 	"github.com/kong/go-apiops/logbasics"
 	"github.com/kong/go-apiops/yamlbasics"
-	"github.com/vmware-labs/yaml-jsonpath/pkg/yamlpath"
+	"github.com/speakeasy-api/jsonpath/pkg/jsonpath"
 	"gopkg.in/yaml.v3"
 )
 
@@ -58,7 +58,7 @@ type Plugger struct {
 	// list of JSONpointers to entities that can hold plugins, so the selector
 	// returns entities that can hold plugins, not the plugin arrays themselves.
 	// The default value is the main plugins array (at the file top-level).
-	selectors []*yamlpath.Path
+	selectors []*jsonpath.JSONPath
 	// list of Nodes (selected by the selectors) representing entities that can
 	// hold plugins, not the plugin arrays themselves
 	pluginOwners []*yaml.Node
@@ -106,12 +106,12 @@ func (ts *Plugger) SetSelectors(selectors []string) error {
 		selectors = defaultSelectors
 	}
 
-	compiledSelectors := make([]*yamlpath.Path, len(selectors))
+	compiledSelectors := make([]*jsonpath.JSONPath, len(selectors))
 	for i, selector := range selectors {
 		logbasics.Debug("compiling JSONpath", "path", selector)
-		compiledpath, err := yamlpath.NewPath(selector)
+		compiledpath, err := jsonpath.NewPath(selector)
 		if err != nil {
-			return fmt.Errorf("selector '%s' is not a valid JSONpath expression; %w", selector, err)
+			return fmt.Errorf("selector '%s' is not a valid JSONpath expression; %s", selector, err.Error())
 		}
 		compiledSelectors[i] = compiledpath
 	}
@@ -146,15 +146,13 @@ func (ts *Plugger) search() error {
 	// build list of targets by executing the selectors one by one
 	targets := make([]*yaml.Node, 0)
 	refs := make(map[*yaml.Node]bool, 0) // keeps references to prevent duplicates
+
 	for idx, selector := range ts.selectors {
-		nodes, err := selector.Find(ts.data)
-		if err != nil {
-			return err
-		}
+		results := selector.Query(ts.data)
 
-		// 'nodes' is an array of nodes matching the selector
+		// 'results' contains YAML nodes matching the selector
 		objCount := 0
-		for _, node := range nodes {
+		for _, node := range results {
 			// since we're updating object fields, we'll skip anything that is
 			// not a JSONobject
 			if node.Kind == yaml.MappingNode && !refs[node] {
@@ -163,7 +161,7 @@ func (ts *Plugger) search() error {
 				objCount++
 			}
 		}
-		logbasics.Debug("selector results", "selector", idx, "results", len(nodes), "objects", objCount)
+		logbasics.Debug("selector results", "selector", idx, "results", len(results), "objects", objCount)
 	}
 	ts.pluginOwners = targets