lsp/hover: Use link overrides if set

Other engines may expose custom builtins with does not on openpolicyagent.org, see https://github.com/StyraInc/enterprise-opa/blob/v1.29.1/capabilities/v1.29.1.json#L5110 This PR supports loading them from the Categories for a builtin. Signed-off-by: Charlie Egan <[email protected]>
StyraInc · Nov 6, 2024 · d0a25d6 · d0a25d6
1 parent aba5ef4
commit d0a25d6
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 3 deletions.
diff --git a/internal/lsp/hover/hover.go b/internal/lsp/hover/hover.go
@@ -60,13 +60,24 @@ func CreateHoverContent(builtin *ast.Builtin) string {
 	}
 	builtinCacheLock.Unlock()
 
-	title := fmt.Sprintf(
-		"[%s](https://www.openpolicyagent.org/docs/latest/policy-reference/#builtin-%s-%s)",
-		builtin.Name,
+	link := fmt.Sprintf(
+		"https://www.openpolicyagent.org/docs/latest/policy-reference/#builtin-%s-%s",
 		rego.BuiltinCategory(builtin),
 		strings.ReplaceAll(builtin.Name, ".", ""),
 	)
 
+	// Enterprise OPA supports custom links via categories from 1.29.1
+	// https://github.com/StyraInc/enterprise-opa/blob/v1.29.1/capabilities/v1.29.1.json#L5110
+	for _, category := range builtin.Categories {
+		if strings.HasPrefix(category, "url=") {
+			link = category[4:]
+
+			break
+		}
+	}
+
+	title := fmt.Sprintf("[%s](%s)", builtin.Name, link)
+
 	sb := &strings.Builder{}
 
 	sb.WriteString("### ")

diff --git a/internal/lsp/hover/hover_test.go b/internal/lsp/hover/hover_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/open-policy-agent/opa/ast"
+	"github.com/open-policy-agent/opa/types"
 )
 
 func TestCreateHoverContent(t *testing.T) {
@@ -26,6 +27,18 @@ func TestCreateHoverContent(t *testing.T) {
 			ast.JSONFilter,
 			"testdata/hover/jsonfilter.md",
 		},
+		{
+			&ast.Builtin{
+				Name:        "foo.bar",
+				Description: "Description for Foo Bar",
+				Decl: types.NewFunction(
+					types.Args(),
+					types.Named("bar", types.A),
+				),
+				Categories: []string{"foo", "url=https://example.com"},
+			},
+			"testdata/hover/foobar.md",
+		},
 	}
 
 	for _, c := range cases {

diff --git a/internal/lsp/hover/testdata/hover/foobar.md b/internal/lsp/hover/testdata/hover/foobar.md
@@ -0,0 +1,7 @@
+### [foo.bar](https://example.com)
+
+```rego
+bar := foo.bar()
+```
+
+Description for Foo Bar