Mr2011/issue 310/im ordering

internal/api/graphql/graph/baseResolver/common.go

@@ -103,5 +103,6 @@ func GetListOptions(requestedFields []string) *entity.ListOptions {
 		ShowTotalCount:      lo.Contains(requestedFields, "totalCount"),
 		ShowPageInfo:        lo.Contains(requestedFields, "pageInfo"),
 		IncludeAggregations: lo.Contains(requestedFields, "edges.node.objectMetadata"),
+		Order:               []entity.Order{},
 	}
 }

internal/api/graphql/graph/baseResolver/issue_match.go

@@ -54,7 +54,7 @@ func SingleIssueMatchBaseResolver(app app.Heureka, ctx context.Context, parent *
 	return &issueMatch, nil
 }
 
-func IssueMatchBaseResolver(app app.Heureka, ctx context.Context, filter *model.IssueMatchFilter, first *int, after *string, parent *model.NodeParent) (*model.IssueMatchConnection, error) {
+func IssueMatchBaseResolver(app app.Heureka, ctx context.Context, filter *model.IssueMatchFilter, first *int, after *string, orderBy []*model.IssueMatchOrderBy, parent *model.NodeParent) (*model.IssueMatchConnection, error) {
 	requestedFields := GetPreloads(ctx)
 	logrus.WithFields(logrus.Fields{
 		"requestedFields": requestedFields,
@@ -119,6 +119,9 @@ func IssueMatchBaseResolver(app app.Heureka, ctx context.Context, filter *model.
 	}
 
 	opt := GetListOptions(requestedFields)
+	for _, o := range orderBy {
+		opt.Order = append(opt.Order, o.ToOrderEntity())
+	}
 
 	issueMatches, err := app.ListIssueMatches(f, opt)
 

internal/api/graphql/graph/model/models.go

@@ -49,6 +49,32 @@ var AllIssueMatchStatusValuesOrdered = []IssueMatchStatusValues{
 	IssueMatchStatusValuesMitigated,
 }
 
+type HasToEntity interface {
+	ToOrderEntity() entity.Order
+}
+
+func (od *OrderDirection) ToOrderDirectionEntity() entity.OrderDirection {
+	direction := entity.OrderDirectionAsc
+	if *od == OrderDirectionDesc {
+		direction = entity.OrderDirectionDesc
+	}
+	return direction
+}
+
+func (imo *IssueMatchOrderBy) ToOrderEntity() entity.Order {
+	var order entity.Order
+	switch *imo.By {
+	case IssueMatchOrderByFieldPrimaryName:
+		order.By = entity.IssuePrimaryName
+	case IssueMatchOrderByFieldComponentInstanceCcrn:
+		order.By = entity.ComponentInstanceCcrn
+	case IssueMatchOrderByFieldTargetRemediationDate:
+		order.By = entity.IssueMatchTargetRemediationDate
+	}
+	order.Direction = imo.Direction.ToOrderDirectionEntity()
+	return order
+}
+
 func NewPageInfo(p *entity.PageInfo) *PageInfo {
 	if p == nil {
 		return nil

internal/api/graphql/graph/queryCollection/issueMatch/withOrder.graphql

@@ -0,0 +1,47 @@
+# SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Greenhouse contributors
+# SPDX-License-Identifier: Apache-2.0
+
+query ($filter: IssueMatchFilter, $first: Int, $after: String, $orderBy: [IssueMatchOrderBy]) {
+    IssueMatches (
+        filter: $filter,
+        first: $first,
+        after: $after
+        orderBy: $orderBy
+    ) {
+        totalCount
+        edges { 
+            node { 
+                id
+                targetRemediationDate
+                severity {
+                    value
+                    score
+                }
+                issueId
+                issue { 
+                    id
+                    primaryName
+                }
+                componentInstanceId
+                componentInstance { 
+                    id
+                    ccrn
+                }
+            }
+            cursor
+        }
+        pageInfo {
+            hasNextPage
+            hasPreviousPage
+            isValidPage
+            pageNumber
+            nextPageAfter
+            pages {
+                after
+                isCurrent
+                pageNumber
+                pageCount
+            }
+        }
+    }
+}

internal/api/graphql/graph/schema/common.graphqls

@@ -114,3 +114,8 @@ type Metadata {
     updated_at: DateTime
     updated_by: String
 }
+
+enum OrderDirection {
+    asc
+    desc
+}

internal/api/graphql/graph/schema/issue_match.graphqls

@@ -65,3 +65,14 @@ enum IssueMatchStatusValues {
     false_positive
     mitigated
 }
+
+input IssueMatchOrderBy {
+    by: IssueMatchOrderByField
+    direction: OrderDirection
+}
+
+enum IssueMatchOrderByField {
+    primaryName
+    targetRemediationDate
+    componentInstanceCcrn
+}

internal/api/graphql/graph/schema/query.graphqls

@@ -3,7 +3,7 @@
 
 type Query {
     Issues(filter: IssueFilter, first: Int, after: String): IssueConnection
-    IssueMatches(filter: IssueMatchFilter, first: Int, after: String): IssueMatchConnection
+    IssueMatches(filter: IssueMatchFilter, first: Int, after: String, orderBy: [IssueMatchOrderBy]): IssueMatchConnection
     IssueMatchChanges(filter: IssueMatchChangeFilter, first: Int, after: String): IssueMatchChangeConnection
     Services(filter: ServiceFilter, first: Int, after: String): ServiceConnection
     Components(filter: ComponentFilter, first: Int, after: String): ComponentConnection

internal/app/issue/issue_handler_events.go

@@ -158,7 +158,7 @@ func createIssueMatches(
 		issue_matches, err := db.GetIssueMatches(&entity.IssueMatchFilter{
 			IssueId:             []*int64{&issueId},
 			ComponentInstanceId: []*int64{&componentInstanceId},
-		})
+		}, []entity.Order{})
 
 		if err != nil {
 			l.WithField("event-step", "FetchIssueMatches").WithError(err).Error("Error while fetching issue matches related to assigned Component Instance")

internal/app/issue/issue_handler_events_test.go

@@ -88,7 +88,7 @@ var _ = Describe("OnComponentVersionAttachmentToIssue", Label("app", "ComponentV
 			db.On("GetIssueMatches", &entity.IssueMatchFilter{
 				ComponentInstanceId: []*int64{&componentInstance.Id},
 				IssueId:             []*int64{&issueEntity.Id},
-			}).Return([]entity.IssueMatch{}, nil)
+			}, []entity.Order{}).Return([]entity.IssueMatch{}, nil)
 
 			db.On("GetServiceIssueVariants", &entity.ServiceIssueVariantFilter{
 				ComponentInstanceId: []*int64{&componentInstance.Id},
@@ -123,7 +123,7 @@ var _ = Describe("OnComponentVersionAttachmentToIssue", Label("app", "ComponentV
 			db.On("GetIssueMatches", &entity.IssueMatchFilter{
 				ComponentInstanceId: []*int64{&componentInstance.Id},
 				IssueId:             []*int64{&issueEntity.Id},
-			}).Return([]entity.IssueMatch{existingMatch}, nil)
+			}, []entity.Order{}).Return([]entity.IssueMatch{existingMatch}, nil)
 
 			issue.OnComponentVersionAttachmentToIssue(db, event)
 			db.AssertNotCalled(GinkgoT(), "CreateIssueMatch", mock.Anything)

internal/app/issue_match/issue_match_handler.go

@@ -42,9 +42,9 @@ func (e *IssueMatchHandlerError) Error() string {
 	return e.message
 }
 
-func (h *issueMatchHandler) getIssueMatchResults(filter *entity.IssueMatchFilter) ([]entity.IssueMatchResult, error) {
+func (h *issueMatchHandler) getIssueMatchResults(filter *entity.IssueMatchFilter, order []entity.Order) ([]entity.IssueMatchResult, error) {
 	var results []entity.IssueMatchResult
-	ims, err := h.database.GetIssueMatches(filter)
+	ims, err := h.database.GetIssueMatches(filter, order)
 	if err != nil {
 		return nil, err
 	}
@@ -65,7 +65,8 @@ func (im *issueMatchHandler) GetIssueMatch(issueMatchId int64) (*entity.IssueMat
 		"id":    issueMatchId,
 	})
 	issueMatchFilter := entity.IssueMatchFilter{Id: []*int64{&issueMatchId}}
-	issueMatches, err := im.ListIssueMatches(&issueMatchFilter, &entity.ListOptions{})
+	options := entity.ListOptions{Order: []entity.Order{}}
+	issueMatches, err := im.ListIssueMatches(&issueMatchFilter, &options)
 
 	if err != nil {
 		l.Error(err)
@@ -95,7 +96,7 @@ func (im *issueMatchHandler) ListIssueMatches(filter *entity.IssueMatchFilter, o
 		"filter": filter,
 	})
 
-	res, err := im.getIssueMatchResults(filter)
+	res, err := im.getIssueMatchResults(filter, options.Order)
 
 	if err != nil {
 		l.Error(err)

internal/app/issue_match/issue_match_handler_events.go

@@ -171,7 +171,7 @@ func OnComponentVersionAssignmentToComponentInstance(db database.Database, compo
 		issue_matches, err := db.GetIssueMatches(&entity.IssueMatchFilter{
 			IssueId:             []*int64{&issueId},
 			ComponentInstanceId: []*int64{&componentInstanceID},
-		})
+		}, nil)
 
 		if err != nil {
 			l.WithField("event-step", "FetchIssueMatches").WithError(err).Error("Error while fetching issue matches related to assigned Component Instance")

internal/app/issue_match/issue_match_handler_test.go

@@ -71,7 +71,7 @@ var _ = Describe("When listing IssueMatches", Label("app", "ListIssueMatches"),
 
 		BeforeEach(func() {
 			options.ShowTotalCount = true
-			db.On("GetIssueMatches", filter).Return([]entity.IssueMatch{}, nil)
+			db.On("GetIssueMatches", filter, []entity.Order{}).Return([]entity.IssueMatch{}, nil)
 			db.On("CountIssueMatches", filter).Return(int64(1337), nil)
 		})
 
@@ -97,7 +97,7 @@ var _ = Describe("When listing IssueMatches", Label("app", "ListIssueMatches"),
 				i++
 				ids = append(ids, i)
 			}
-			db.On("GetIssueMatches", filter).Return(matches, nil)
+			db.On("GetIssueMatches", filter, []entity.Order{}).Return(matches, nil)
 			db.On("GetAllIssueMatchIds", filter).Return(ids, nil)
 			issueMatchHandler = im.NewIssueMatchHandler(db, er, nil)
 			res, err := issueMatchHandler.ListIssueMatches(filter, options)
@@ -121,7 +121,7 @@ var _ = Describe("When listing IssueMatches", Label("app", "ListIssueMatches"),
 		Context("and the given filter does not have any matches in the database", func() {
 
 			BeforeEach(func() {
-				db.On("GetIssueMatches", filter).Return([]entity.IssueMatch{}, nil)
+				db.On("GetIssueMatches", filter, []entity.Order{}).Return([]entity.IssueMatch{}, nil)
 			})
 			It("should return an empty result", func() {
 
@@ -134,7 +134,7 @@ var _ = Describe("When listing IssueMatches", Label("app", "ListIssueMatches"),
 		})
 		Context("and the filter does have results in the database", func() {
 			BeforeEach(func() {
-				db.On("GetIssueMatches", filter).Return(test.NNewFakeIssueMatches(15), nil)
+				db.On("GetIssueMatches", filter, []entity.Order{}).Return(test.NNewFakeIssueMatches(15), nil)
 			})
 			It("should return the expected matches in the result", func() {
 				issueMatchHandler = im.NewIssueMatchHandler(db, er, nil)
@@ -146,7 +146,7 @@ var _ = Describe("When listing IssueMatches", Label("app", "ListIssueMatches"),
 
 		Context("and the database operations throw an error", func() {
 			BeforeEach(func() {
-				db.On("GetIssueMatches", filter).Return([]entity.IssueMatch{}, errors.New("some error"))
+				db.On("GetIssueMatches", filter, []entity.Order{}).Return([]entity.IssueMatch{}, errors.New("some error"))
 			})
 
 			It("should return the expected matches in the result", func() {
@@ -250,7 +250,7 @@ var _ = Describe("When updating IssueMatch", Label("app", "UpdateIssueMatch"), f
 			issueMatch.Status = entity.NewIssueMatchStatusValue("new")
 		}
 		filter.Id = []*int64{&issueMatch.Id}
-		db.On("GetIssueMatches", filter).Return([]entity.IssueMatch{issueMatch}, nil)
+		db.On("GetIssueMatches", filter, []entity.Order{}).Return([]entity.IssueMatch{issueMatch}, nil)
 		updatedIssueMatch, err := issueMatchHandler.UpdateIssueMatch(&issueMatch)
 		Expect(err).To(BeNil(), "no error should be thrown")
 		By("setting fields", func() {
@@ -273,6 +273,7 @@ var _ = Describe("When deleting IssueMatch", Label("app", "DeleteIssueMatch"), f
 		issueMatchHandler im.IssueMatchHandler
 		id                int64
 		filter            *entity.IssueMatchFilter
+		options           *entity.ListOptions
 	)
 
 	BeforeEach(func() {
@@ -287,17 +288,18 @@ var _ = Describe("When deleting IssueMatch", Label("app", "DeleteIssueMatch"), f
 				After: &after,
 			},
 		}
+		options = entity.NewListOptions()
 	})
 
 	It("deletes issueMatch", func() {
 		db.On("DeleteIssueMatch", id).Return(nil)
 		issueMatchHandler = im.NewIssueMatchHandler(db, er, nil)
-		db.On("GetIssueMatches", filter).Return([]entity.IssueMatch{}, nil)
+		db.On("GetIssueMatches", filter, []entity.Order{}).Return([]entity.IssueMatch{}, nil)
 		err := issueMatchHandler.DeleteIssueMatch(id)
 		Expect(err).To(BeNil(), "no error should be thrown")
 
 		filter.Id = []*int64{&id}
-		issueMatches, err := issueMatchHandler.ListIssueMatches(filter, &entity.ListOptions{})
+		issueMatches, err := issueMatchHandler.ListIssueMatches(filter, options)
 		Expect(err).To(BeNil(), "no error should be thrown")
 		Expect(issueMatches.Elements).To(BeEmpty(), "no error should be thrown")
 	})
@@ -330,7 +332,7 @@ var _ = Describe("When modifying relationship of evidence and issueMatch", Label
 
 	It("adds evidence to issueMatch", func() {
 		db.On("AddEvidenceToIssueMatch", issueMatch.Id, evidence.Id).Return(nil)
-		db.On("GetIssueMatches", filter).Return([]entity.IssueMatch{issueMatch}, nil)
+		db.On("GetIssueMatches", filter, []entity.Order{}).Return([]entity.IssueMatch{issueMatch}, nil)
 		issueMatchHandler = im.NewIssueMatchHandler(db, er, nil)
 		issueMatch, err := issueMatchHandler.AddEvidenceToIssueMatch(issueMatch.Id, evidence.Id)
 		Expect(err).To(BeNil(), "no error should be thrown")
@@ -339,7 +341,7 @@ var _ = Describe("When modifying relationship of evidence and issueMatch", Label
 
 	It("removes evidence from issueMatch", func() {
 		db.On("RemoveEvidenceFromIssueMatch", issueMatch.Id, evidence.Id).Return(nil)
-		db.On("GetIssueMatches", filter).Return([]entity.IssueMatch{issueMatch}, nil)
+		db.On("GetIssueMatches", filter, []entity.Order{}).Return([]entity.IssueMatch{issueMatch}, nil)
 		issueMatchHandler = im.NewIssueMatchHandler(db, er, nil)
 		issueMatch, err := issueMatchHandler.RemoveEvidenceFromIssueMatch(issueMatch.Id, evidence.Id)
 		Expect(err).To(BeNil(), "no error should be thrown")
@@ -467,7 +469,7 @@ var _ = Describe("OnComponentInstanceCreate", Label("app", "OnComponentInstanceC
 			})
 
 			It("should create issue matches for each issue", func() {
-				db.On("GetIssueMatches", mock.Anything).Return([]entity.IssueMatch{}, nil)
+				db.On("GetIssueMatches", mock.Anything, mock.Anything).Return([]entity.IssueMatch{}, nil)
 				// Mock CreateIssueMatch
 				db.On("CreateIssueMatch", mock.AnythingOfType("*entity.IssueMatch")).Return(&entity.IssueMatch{}, nil).Twice()
 				im.OnComponentVersionAssignmentToComponentInstance(db, componentInstanceID, componentVersionID)
@@ -482,7 +484,7 @@ var _ = Describe("OnComponentInstanceCreate", Label("app", "OnComponentInstanceC
 					issueMatch := test.NewFakeIssueMatch()
 					issueMatch.IssueId = 2 // issue2.Id
 					//when issueid is 2 return a fake issue match
-					db.On("GetIssueMatches", mock.Anything).Return([]entity.IssueMatch{issueMatch}, nil).Once()
+					db.On("GetIssueMatches", mock.Anything, mock.Anything).Return([]entity.IssueMatch{issueMatch}, nil).Once()
 				})
 
 				It("should should not create new issues", func() {

internal/database/interface.go

@@ -35,7 +35,7 @@ type Database interface {
 	GetDefaultIssuePriority() int64
 	GetDefaultRepositoryName() string
 
-	GetIssueMatches(*entity.IssueMatchFilter) ([]entity.IssueMatch, error)
+	GetIssueMatches(*entity.IssueMatchFilter, []entity.Order) ([]entity.IssueMatch, error)
 	GetAllIssueMatchIds(*entity.IssueMatchFilter) ([]int64, error)
 	CountIssueMatches(filter *entity.IssueMatchFilter) (int64, error)
 	CreateIssueMatch(*entity.IssueMatch) (*entity.IssueMatch, error)

internal/database/mariadb/database.go

@@ -391,3 +391,11 @@ func getCursor(p entity.Paginated, filterStr string, stmt string) entity.Cursor
 		Limit:     limit,
 	}
 }
+
+func GetDefaultOrder(order []entity.Order, by entity.DbColumnName, direction entity.OrderDirection) []entity.Order {
+	if len(order) == 0 {
+		order = append([]entity.Order{{By: by, Direction: direction}}, order...)
+	}
+
+	return order
+}