feat: sortyBy (#153)

* feat: added SortBy feature with support for String, Int, Float and Bool

On-behalf-of: @SAP a.shcherbatiuk@sap.com
Signed-off-by: Artem Shcherbatiuk <vertex451@gmail.com>

Author: vertex451

README.md

@@ -206,7 +206,7 @@ curl \
   -H "Accept: text/event-stream" \
   -H "Content-Type: application/json" \
   -H "Authorization: 7f41d4ea-6809-4714-b345-f9281981b2dd" \
-  -d '{"query": "subscription { core_openmfp_io_account(name: \"root-account\", namespace: \"default\") { spec { displayName }}}"}' \
+  -d '{"query": "subscription { core_openmfp_org_account(name: \"root-account\") { spec { displayName }}}"}' \
   http://localhost:8080/root/graphql
 ```
 Fields that will be listened are defined in the graphql query within the `{}` brackets.
@@ -219,7 +219,7 @@ curl \
   -H "Accept: text/event-stream" \
   -H "Content-Type: application/json" \
   -H "Authorization: 7f41d4ea-6809-4714-b345-f9281981b2dd" \
-  -d '{"query": "subscription { core_openmfp_io_account(name: \"root-account\", namespace: \"default\", subscribeToAll: true) { metadata { name } }}"}' \
+  -d '{"query": "subscription { core_openmfp_org_account(name: \"root-account\", subscribeToAll: true) { metadata { name } }}"}' \
   http://localhost:8080/root/graphql
 ```
 P.S. Note, that only fields specified in `{}` brackets will be returned.
@@ -230,7 +230,7 @@ curl \
   -H "Accept: text/event-stream" \
   -H "Content-Type: application/json" \
   -H "Authorization: 7f41d4ea-6809-4714-b345-f9281981b2dd" \
-  -d '{"query": "subscription { core_openmfp_io_accounts(namespace: \"default\") { spec { displayName }}}"}' \
+  -d '{"query": "subscription { core_openmfp_org_accounts { spec { displayName }}}"}' \
   http://localhost:8080/root/graphql
 ```
 

Taskfile.yml

@@ -16,6 +16,12 @@ tasks:
     internal: true
     cmds:
       - test -s {{.LOCAL_BIN}}/setup-envtest || GOBIN=$(pwd)/{{.LOCAL_BIN}} go install sigs.k8s.io/controller-runtime/tools/setup-envtest@{{.ENVTEST_VERSION}}
+  update:crd:
+    desc: "Download the latest CRD from OpenMFP"
+    cmds:
+      - mkdir -p tests/gateway_test/testdata/crd
+      - curl -sSLo tests/gateway_test/testdata/crd/core.openmfp.org_accounts.yaml https://raw.githubusercontent.com/openmfp/account-operator/main/config/crd/core.openmfp.org_accounts.yaml
+      - echo "CRD updated successfully."
   setup:golangci-lint:
     internal: true
     cmds:
@@ -50,24 +56,30 @@ tasks:
     cmds:
       - go test ./... {{.ADDITIONAL_COMMAND_ARGS}}
   test:
-    deps: [setup:envtest]
+    deps: [setup:envtest, update:crd]
     cmds:
       - task: envtest
         vars:
           ADDITIONAL_COMMAND_ARGS: -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
   cover:
-    deps: [setup:envtest, setup:go-test-coverage]
+    deps: [ setup:envtest, setup:go-test-coverage ]
     cmds:
       - task: envtest
         vars:
           ADDITIONAL_COMMAND_ARGS: -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
       - "{{.LOCAL_BIN}}/go-test-coverage --profile cover.out --config ./.testcoverage.yml"
+  cover-html:
+    desc: "Generate and open HTML coverage report"
+    deps: [cover]
+    cmds:
+      - go tool cover -html=cover.out -o coverage.html
+      - open coverage.html || xdg-open coverage.html || start coverage.html
   validate:
     cmds:
       - task: mockery
       - task: lint
       - task: test
-        
+
   # start uses deprecated gateway
   start:
     cmds:

gateway/resolver/arguments.go

@@ -2,7 +2,9 @@ package resolver
 
 import (
 	"errors"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"maps"
+	"strings"
 
 	"github.com/graphql-go/graphql"
 	"github.com/rs/zerolog/log"
@@ -15,6 +17,7 @@ const (
 	NamespaceArg      = "namespace"
 	ObjectArg         = "object"
 	SubscribeToAllArg = "subscribeToAll"
+	SortByArg         = "sortBy"
 )
 
 // FieldConfigArgumentsBuilder helps construct GraphQL field config arguments
@@ -29,15 +32,15 @@ func NewFieldConfigArguments() *FieldConfigArgumentsBuilder {
 	}
 }
 
-func (b *FieldConfigArgumentsBuilder) WithNameArg() *FieldConfigArgumentsBuilder {
+func (b *FieldConfigArgumentsBuilder) WithName() *FieldConfigArgumentsBuilder {
 	b.arguments[NameArg] = &graphql.ArgumentConfig{
 		Type:        graphql.NewNonNull(graphql.String),
 		Description: "The name of the object",
 	}
 	return b
 }
 
-func (b *FieldConfigArgumentsBuilder) WithNamespaceArg() *FieldConfigArgumentsBuilder {
+func (b *FieldConfigArgumentsBuilder) WithNamespace() *FieldConfigArgumentsBuilder {
 	b.arguments[NamespaceArg] = &graphql.ArgumentConfig{
 		Type:        graphql.String,
 		Description: "The namespace in which to search for the objects",
@@ -46,23 +49,23 @@ func (b *FieldConfigArgumentsBuilder) WithNamespaceArg() *FieldConfigArgumentsBu
 	return b
 }
 
-func (b *FieldConfigArgumentsBuilder) WithLabelSelectorArg() *FieldConfigArgumentsBuilder {
+func (b *FieldConfigArgumentsBuilder) WithLabelSelector() *FieldConfigArgumentsBuilder {
 	b.arguments[LabelSelectorArg] = &graphql.ArgumentConfig{
 		Type:        graphql.String,
 		Description: "A label selector to filter the objects by",
 	}
 	return b
 }
 
-func (b *FieldConfigArgumentsBuilder) WithObjectArg(resourceInputType *graphql.InputObject) *FieldConfigArgumentsBuilder {
+func (b *FieldConfigArgumentsBuilder) WithObject(resourceInputType *graphql.InputObject) *FieldConfigArgumentsBuilder {
 	b.arguments[ObjectArg] = &graphql.ArgumentConfig{
 		Type:        graphql.NewNonNull(resourceInputType),
 		Description: "The object to create or update",
 	}
 	return b
 }
 
-func (b *FieldConfigArgumentsBuilder) WithSubscribeToAllArg() *FieldConfigArgumentsBuilder {
+func (b *FieldConfigArgumentsBuilder) WithSubscribeToAll() *FieldConfigArgumentsBuilder {
 	b.arguments[SubscribeToAllArg] = &graphql.ArgumentConfig{
 		Type:         graphql.Boolean,
 		DefaultValue: false,
@@ -71,6 +74,15 @@ func (b *FieldConfigArgumentsBuilder) WithSubscribeToAllArg() *FieldConfigArgume
 	return b
 }
 
+func (b *FieldConfigArgumentsBuilder) WithSortBy() *FieldConfigArgumentsBuilder {
+	b.arguments[SortByArg] = &graphql.ArgumentConfig{
+		Type:         graphql.String,
+		Description:  "The field to sort the results by",
+		DefaultValue: "metadata.name",
+	}
+	return b
+}
+
 // Complete returns the constructed arguments and dereferences the builder
 func (b *FieldConfigArgumentsBuilder) Complete() graphql.FieldConfigArgument {
 	return maps.Clone(b.arguments)
@@ -129,3 +141,22 @@ func getBoolArg(args map[string]interface{}, key string, required bool) (bool, e
 func isResourceNamespaceScoped(resourceScope apiextensionsv1.ResourceScope) bool {
 	return resourceScope == apiextensionsv1.NamespaceScoped
 }
+
+func validateSortBy(items []unstructured.Unstructured, fieldPath string) error {
+	if len(items) == 0 {
+		return nil // No items to validate against, assume valid
+	}
+
+	sample := items[0]
+	segments := strings.Split(fieldPath, ".")
+
+	_, found, err := unstructured.NestedFieldNoCopy(sample.Object, segments...)
+	if !found {
+		return errors.New("specified sortBy field does not exist")
+	}
+	if err != nil {
+		return errors.Join(errors.New("error accessing specified sortBy field"), err)
+	}
+
+	return nil
+}

gateway/resolver/arguments_test.go

@@ -0,0 +1,70 @@
+package resolver_test
+
+import (
+	"errors"
+	"github.com/openmfp/kubernetes-graphql-gateway/gateway/resolver"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestGetStrArg(t *testing.T) {
+	tests := []struct {
+		name  string
+		args  map[string]interface{}
+		error error
+	}{
+		{
+			name: "invalid_type_ERROR",
+			args: map[string]interface{}{
+				"arg1": false,
+			},
+			error: errors.New("invalid type for argument: arg1"),
+		},
+		{
+			name: "empty_value_ERROR",
+			args: map[string]interface{}{
+				"arg1": "",
+			},
+			error: errors.New("empty value for argument: arg1"),
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_, err := resolver.GetStringArg(tt.args, "arg1", true)
+			if tt.error != nil {
+				assert.EqualError(t, err, tt.error.Error())
+			}
+		})
+	}
+}
+
+func TestGetBoolArg(t *testing.T) {
+	tests := []struct {
+		name  string
+		args  map[string]interface{}
+		error error
+	}{
+		{
+			name:  "missing_required_argument_ERROR",
+			args:  map[string]interface{}{},
+			error: errors.New("missing required argument: arg1"),
+		},
+		{
+			name: "invalid_type_ERROR",
+			args: map[string]interface{}{
+				"arg1": "MUST_BE_BOOL",
+			},
+			error: errors.New("invalid type for argument: arg1"),
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_, err := resolver.GetBoolArg(tt.args, "arg1", true)
+			if tt.error != nil {
+				assert.EqualError(t, err, tt.error.Error())
+			}
+		})
+	}
+}

gateway/resolver/export_test.go

@@ -1,5 +1,7 @@
 package resolver
 
+import "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+
 func (r *Service) GetOriginalGroupName(key string) string {
 	return r.getOriginalGroupName(key)
 }
@@ -11,3 +13,15 @@ func (r *Service) GetGroupName(key string) string {
 func (r *Service) SetGroupNames(names map[string]string) {
 	r.groupNames = names
 }
+
+func GetStringArg(args map[string]interface{}, key string, required bool) (string, error) {
+	return getStringArg(args, key, required)
+}
+
+func GetBoolArg(args map[string]interface{}, key string, required bool) (bool, error) {
+	return getBoolArg(args, key, required)
+}
+
+func CompareUnstructured(a, b unstructured.Unstructured, fieldPath string) int {
+	return compareUnstructured(a, b, fieldPath)
+}

gateway/resolver/resolver.go

@@ -8,6 +8,8 @@ import (
 	"gopkg.in/yaml.v3"
 	v1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"regexp"
+	"sort"
+	"strings"
 
 	"github.com/graphql-go/graphql"
 	"go.opentelemetry.io/otel"
@@ -109,6 +111,21 @@ func (r *Service) ListItems(gvk schema.GroupVersionKind, scope v1.ResourceScope)
 			return nil, err
 		}
 
+		sortBy, err := getStringArg(p.Args, SortByArg, false)
+		if err != nil {
+			return nil, err
+		}
+
+		err = validateSortBy(list.Items, sortBy)
+		if err != nil {
+			log.Error().Err(err).Str(SortByArg, sortBy).Msg("Invalid sortBy field path")
+			return nil, err
+		}
+
+		sort.Slice(list.Items, func(i, j int) bool {
+			return compareUnstructured(list.Items[i], list.Items[j], sortBy) < 0
+		})
+
 		items := make([]map[string]any, len(list.Items))
 		for i, item := range list.Items {
 			items[i] = item.Object
@@ -183,7 +200,7 @@ func (r *Service) GetItemAsYAML(gvk schema.GroupVersionKind, scope v1.ResourceSc
 		}
 
 		var returnYaml bytes.Buffer
-		if err := yaml.NewEncoder(&returnYaml).Encode(out); err != nil {
+		if err = yaml.NewEncoder(&returnYaml).Encode(out); err != nil {
 			return "", err
 		}
 
@@ -351,3 +368,63 @@ func (r *Service) getOriginalGroupName(groupName string) string {
 
 	return groupName
 }
+
+func compareUnstructured(a, b unstructured.Unstructured, fieldPath string) int {
+	segments := strings.Split(fieldPath, ".")
+
+	aVal, foundA, errA := unstructured.NestedFieldNoCopy(a.Object, segments...)
+	bVal, foundB, errB := unstructured.NestedFieldNoCopy(b.Object, segments...)
+	if errA != nil || errB != nil || !foundA || !foundB {
+		return 0 // fallback if fields are missing or inaccessible
+	}
+
+	switch av := aVal.(type) {
+	case string:
+		if bv, ok := bVal.(string); ok {
+			return strings.Compare(av, bv)
+		}
+	case int64:
+		if bv, ok := bVal.(int64); ok {
+			return compareNumbers(av, bv)
+		}
+	case int32:
+		if bv, ok := bVal.(int32); ok {
+			return compareNumbers(int64(av), int64(bv))
+		} else if bv, ok := bVal.(int64); ok {
+			return compareNumbers(int64(av), bv)
+		}
+	case float64:
+		if bv, ok := bVal.(float64); ok {
+			return compareNumbers(av, bv)
+		}
+	case float32:
+		if bv, ok := bVal.(float32); ok {
+			return compareNumbers(float64(av), float64(bv))
+		} else if bv, ok := bVal.(float64); ok {
+			return compareNumbers(float64(av), bv)
+		}
+	case bool:
+		if bv, ok := bVal.(bool); ok {
+			switch {
+			case av && !bv:
+				return -1
+			case !av && bv:
+				return 1
+			default:
+				return 0
+			}
+		}
+	}
+	return 0 // unhandled or non-comparable types
+}
+
+func compareNumbers[T int64 | float64](a, b T) int {
+	switch {
+	case a < b:
+		return -1
+	case a > b:
+		return 1
+	default:
+		return 0
+	}
+}