Implement sorting with options for instances

Author: uzabanov

api/main.go

@@ -217,7 +217,6 @@ func main() {
 	serviceInstanceRepo := repositories.NewServiceInstanceRepo(
 		spaceScopedKlient,
 		conditions.NewConditionAwaiter[*korifiv1alpha1.CFServiceInstance, korifiv1alpha1.CFServiceInstanceList](conditionTimeout),
-		repositories.NewServiceInstanceSorter(),
 		cfg.RootNamespace,
 	)
 	serviceBindingRepo := repositories.NewServiceBindingRepo(

api/repositories/fake/service_instance_sorter.go

@@ -5,12 +5,10 @@ import (
 	"errors"
 	"fmt"
 	"slices"
-	"strings"
 	"time"
 
 	"code.cloudfoundry.org/korifi/api/authorization"
 	apierrors "code.cloudfoundry.org/korifi/api/errors"
-	"code.cloudfoundry.org/korifi/api/repositories/compare"
 	korifiv1alpha1 "code.cloudfoundry.org/korifi/controllers/api/v1alpha1"
 	"code.cloudfoundry.org/korifi/tools"
 
@@ -36,59 +34,17 @@ type NamespaceGetter interface {
 type ServiceInstanceRepo struct {
 	klient        Klient
 	awaiter       Awaiter[*korifiv1alpha1.CFServiceInstance]
-	sorter        ServiceInstanceSorter
 	rootNamespace string
 }
 
-//counterfeiter:generate -o fake -fake-name ServiceInstanceSorter . ServiceInstanceSorter
-type ServiceInstanceSorter interface {
-	Sort(records []ServiceInstanceRecord, order string) []ServiceInstanceRecord
-}
-
-type serviceInstanceSorter struct {
-	sorter *compare.Sorter[ServiceInstanceRecord]
-}
-
-func NewServiceInstanceSorter() *serviceInstanceSorter {
-	return &serviceInstanceSorter{
-		sorter: compare.NewSorter(ServiceInstanceComparator),
-	}
-}
-
-func (s *serviceInstanceSorter) Sort(records []ServiceInstanceRecord, order string) []ServiceInstanceRecord {
-	return s.sorter.Sort(records, order)
-}
-
-func ServiceInstanceComparator(fieldName string) func(ServiceInstanceRecord, ServiceInstanceRecord) int {
-	return func(s1, s2 ServiceInstanceRecord) int {
-		switch fieldName {
-		case "created_at":
-			return tools.CompareTimePtr(&s1.CreatedAt, &s2.CreatedAt)
-		case "-created_at":
-			return tools.CompareTimePtr(&s2.CreatedAt, &s1.CreatedAt)
-		case "updated_at":
-			return tools.CompareTimePtr(s1.UpdatedAt, s2.UpdatedAt)
-		case "-updated_at":
-			return tools.CompareTimePtr(s2.UpdatedAt, s1.UpdatedAt)
-		case "name":
-			return strings.Compare(s1.Name, s2.Name)
-		case "-name":
-			return strings.Compare(s2.Name, s1.Name)
-		}
-		return 0
-	}
-}
-
 func NewServiceInstanceRepo(
 	klient Klient,
 	awaiter Awaiter[*korifiv1alpha1.CFServiceInstance],
-	sorter ServiceInstanceSorter,
 	rootNamespace string,
 ) *ServiceInstanceRepo {
 	return &ServiceInstanceRepo{
 		klient:        klient,
 		awaiter:       awaiter,
-		sorter:        sorter,
 		rootNamespace: rootNamespace,
 	}
 }
@@ -150,6 +106,9 @@ func (m *ListServiceInstanceMessage) toListOptions() []ListOption {
 		WithLabelIn(korifiv1alpha1.SpaceGUIDLabelKey, m.SpaceGUIDs),
 		WithLabelSelector(m.LabelSelector),
 		WithPaging(m.Pagination),
+		WithOrdering(m.OrderBy,
+			"name", "Display Name",
+		),
 	}
 
 	if m.Type != "" {
@@ -424,7 +383,7 @@ func (r *ServiceInstanceRepo) ListServiceInstances(ctx context.Context, authInfo
 
 	return ListResult[ServiceInstanceRecord]{
 		PageInfo: pageInfo,
-		Records:  r.sorter.Sort(slices.Collect(it.Map(slices.Values(serviceInstanceList.Items), cfServiceInstanceToRecord)), message.OrderBy),
+		Records:  slices.Collect(it.Map(slices.Values(serviceInstanceList.Items), cfServiceInstanceToRecord)),
 	}, nil
 }
 

api/repositories/service_instance_repository.go

@@ -21,6 +21,7 @@ import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	. "github.com/onsi/gomega/gstruct"
+
 	gomega_types "github.com/onsi/gomega/types"
 	corev1 "k8s.io/api/core/v1"
 	k8serrors "k8s.io/apimachinery/pkg/api/errors"
@@ -37,7 +38,6 @@ var _ = Describe("ServiceInstanceRepository", func() {
 			korifiv1alpha1.CFServiceInstanceList,
 			*korifiv1alpha1.CFServiceInstanceList,
 		]
-		sorter *fake.ServiceInstanceSorter
 
 		org                 *korifiv1alpha1.CFOrg
 		space               *korifiv1alpha1.CFSpace
@@ -50,15 +50,10 @@ var _ = Describe("ServiceInstanceRepository", func() {
 			korifiv1alpha1.CFServiceInstanceList,
 			*korifiv1alpha1.CFServiceInstanceList,
 		]{}
-		sorter = new(fake.ServiceInstanceSorter)
-		sorter.SortStub = func(records []repositories.ServiceInstanceRecord, _ string) []repositories.ServiceInstanceRecord {
-			return records
-		}
 
 		serviceInstanceRepo = repositories.NewServiceInstanceRepo(
 			spaceScopedKlient,
 			conditionAwaiter,
-			sorter,
 			rootNamespace,
 		)
 
@@ -716,7 +711,7 @@ var _ = Describe("ServiceInstanceRepository", func() {
 			}
 			Expect(k8sClient.Create(ctx, cfServiceInstance1)).To(Succeed())
 
-			filters = repositories.ListServiceInstanceMessage{OrderBy: "foo"}
+			filters = repositories.ListServiceInstanceMessage{OrderBy: "name"}
 		})
 
 		JustBeforeEach(func() {
@@ -740,35 +735,43 @@ var _ = Describe("ServiceInstanceRepository", func() {
 				))
 			})
 
-			It("sort the service instances", func() {
-				Expect(sorter.SortCallCount()).To(Equal(1))
-				sortedServiceInstances, field := sorter.SortArgsForCall(0)
-				Expect(field).To(Equal("foo"))
-				Expect(sortedServiceInstances).To(ConsistOf(
-					MatchFields(IgnoreExtras, Fields{"GUID": Equal(cfServiceInstance1.Name)}),
-				))
-			})
+			DescribeTable("ordering",
+				func(msg repositories.ListServiceInstanceMessage, match gomega_types.GomegaMatcher) {
+					fakeKlient := new(fake.Klient)
+					instancesRepo := repositories.NewServiceInstanceRepo(fakeKlient, conditionAwaiter, rootNamespace)
+
+					_, err := instancesRepo.ListServiceInstances(ctx, authInfo, msg)
+					Expect(err).NotTo(HaveOccurred())
 
-			Describe("filtering", func() {
+					Expect(fakeKlient.ListCallCount()).To(Equal(1))
+					_, _, listOptions := fakeKlient.ListArgsForCall(0)
+					Expect(listOptions).To(match)
+				},
+				Entry("name", repositories.ListServiceInstanceMessage{OrderBy: "name"}, ContainElement(repositories.SortOpt{By: "Display Name", Desc: false})),
+				Entry("-name", repositories.ListServiceInstanceMessage{OrderBy: "-name"}, ContainElement(repositories.SortOpt{By: "Display Name", Desc: true})),
+			)
+
+			Describe("list options", func() {
 				var fakeKlient *fake.Klient
 
 				BeforeEach(func() {
 					fakeKlient = new(fake.Klient)
-					serviceInstanceRepo = repositories.NewServiceInstanceRepo(fakeKlient, conditionAwaiter, sorter, rootNamespace)
+					serviceInstanceRepo = repositories.NewServiceInstanceRepo(fakeKlient, conditionAwaiter, rootNamespace)
 					filters = repositories.ListServiceInstanceMessage{
 						Names:         []string{"instance-1", "instance-2"},
 						SpaceGUIDs:    []string{"space-guid-1", "space-guid-2"},
 						GUIDs:         []string{"guid-1", "guid-2"},
 						LabelSelector: "a-label=a-label-value",
 						PlanGUIDs:     []string{"plan-guid-1", "plan-guid-2"},
+						OrderBy:       "updated_at",
 						Pagination: repositories.Pagination{
 							PerPage: 1,
 							Page:    10,
 						},
 					}
 				})
 
-				It("translates filter parameters to klient list options", func() {
+				It("translates  parameters to klient list options", func() {
 					Expect(fakeKlient.ListCallCount()).To(Equal(1))
 					_, _, listOptions := fakeKlient.ListArgsForCall(0)
 					Expect(listOptions).To(ConsistOf(
@@ -777,6 +780,7 @@ var _ = Describe("ServiceInstanceRepository", func() {
 						repositories.WithLabelIn(korifiv1alpha1.GUIDLabelKey, []string{"guid-1", "guid-2"}),
 						repositories.WithLabelSelector("a-label=a-label-value"),
 						repositories.WithLabelIn(korifiv1alpha1.PlanGUIDLabelKey, []string{"plan-guid-1", "plan-guid-2"}),
+						repositories.WithOrdering("updated_at"),
 						repositories.WithPaging(repositories.Pagination{
 							PerPage: 1,
 							Page:    10,
@@ -1077,45 +1081,3 @@ var _ = Describe("ServiceInstanceRepository", func() {
 		})
 	})
 })
-
-var _ = DescribeTable("ServiceInstanceSorter",
-	func(s1, s2 repositories.ServiceInstanceRecord, field string, match gomega_types.GomegaMatcher) {
-		Expect(repositories.ServiceInstanceComparator(field)(s1, s2)).To(match)
-	},
-	Entry("created_at",
-		repositories.ServiceInstanceRecord{CreatedAt: time.UnixMilli(1)},
-		repositories.ServiceInstanceRecord{CreatedAt: time.UnixMilli(2)},
-		"created_at",
-		BeNumerically("<", 0),
-	),
-	Entry("-created_at",
-		repositories.ServiceInstanceRecord{CreatedAt: time.UnixMilli(1)},
-		repositories.ServiceInstanceRecord{CreatedAt: time.UnixMilli(2)},
-		"-created_at",
-		BeNumerically(">", 0),
-	),
-	Entry("updated_at",
-		repositories.ServiceInstanceRecord{UpdatedAt: tools.PtrTo(time.UnixMilli(1))},
-		repositories.ServiceInstanceRecord{UpdatedAt: tools.PtrTo(time.UnixMilli(2))},
-		"updated_at",
-		BeNumerically("<", 0),
-	),
-	Entry("-updated_at",
-		repositories.ServiceInstanceRecord{UpdatedAt: tools.PtrTo(time.UnixMilli(1))},
-		repositories.ServiceInstanceRecord{UpdatedAt: tools.PtrTo(time.UnixMilli(2))},
-		"-updated_at",
-		BeNumerically(">", 0),
-	),
-	Entry("name",
-		repositories.ServiceInstanceRecord{Name: "first-instance"},
-		repositories.ServiceInstanceRecord{Name: "second-instance"},
-		"name",
-		BeNumerically("<", 0),
-	),
-	Entry("-name",
-		repositories.ServiceInstanceRecord{Name: "first-instance"},
-		repositories.ServiceInstanceRecord{Name: "second-instance"},
-		"-name",
-		BeNumerically(">", 0),
-	),
-)

api/repositories/service_instance_repository_test.go

@@ -107,6 +107,8 @@ type LastOperation struct {
 
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
+//+kubebuilder:printcolumn:name="Created At",type="string",JSONPath=`.metadata.labels.korifi\.cloudfoundry\.org/created_at`
+//+kubebuilder:printcolumn:name="Updated At",type="string",JSONPath=`.metadata.labels.korifi\.cloudfoundry\.org/updated_at`
 //+kubebuilder:printcolumn:name="Display Name",type=string,JSONPath=`.spec.displayName`
 //+kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp`
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

controllers/api/v1alpha1/cfserviceinstance_types.go

@@ -15,6 +15,12 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
+    - jsonPath: .metadata.labels.korifi\.cloudfoundry\.org/created_at
+      name: Created At
+      type: string
+    - jsonPath: .metadata.labels.korifi\.cloudfoundry\.org/updated_at
+      name: Updated At
+      type: string
     - jsonPath: .spec.displayName
       name: Display Name
       type: string