fix(product): add sorting options (#587)

* fix(product): add sorting options

* fix(product): fix tests

* feat(product): give promotion with empty fields, when there are hits

* fix(product): review fixes

* fix(product): update changelog

* fix(product): review fixes

CHANGELOG.md

@@ -4,6 +4,10 @@
 **checkout**
 * add config `commerce.checkout.orderService.skipCartValidation` to disable cart validation that happens right before placing an order in the OrderService
 
+**search**
+* **Breaking:** fixed fake service to interpret sort options and gives away empty promotion
+* removed deprecation notice from fields `Asc` and `Desc` in `SortOption` struct
+
 ## v3.11.0
 
 **search**

product/infrastructure/fake/searchservice.go

@@ -6,6 +6,8 @@ import (
 	"os"
 	"strconv"
 
+	"flamingo.me/flamingo/v3/framework/config"
+
 	searchDomain "flamingo.me/flamingo-commerce/v3/search/domain"
 
 	"flamingo.me/flamingo-commerce/v3/product/domain"
@@ -17,27 +19,42 @@ type (
 		productService         *ProductService
 		liveSearchJSON         string
 		categoryFacetItemsJSON string
+		sortConfig             []sortConfig
 	}
 	liveSearchData struct {
 		Marketplacecodes []string                  `json:"marketplacecodes"`
 		Sugestions       []searchDomain.Suggestion `json:"sugestions"`
 		Promotions       []searchDomain.Promotion  `json:"promotions"`
 		Actions          []searchDomain.Action     `json:"actions"`
 	}
+
+	// sortConfig contains sorting configuration for search results
+	sortConfig struct {
+		Key   string
+		Label string
+		Asc   string
+		Desc  string
+	}
 )
 
 // Inject dependencies
 func (s *SearchService) Inject(
 	productService *ProductService,
 	cfg *struct {
-		LiveSearchJSON         string `inject:"config:commerce.product.fakeservice.jsonTestDataLiveSearch,optional"`
-		CategoryFacetItemsJSON string `inject:"config:commerce.product.fakeservice.jsonTestDataCategoryFacetItems,optional"`
+		LiveSearchJSON         string       `inject:"config:commerce.product.fakeservice.jsonTestDataLiveSearch,optional"`
+		CategoryFacetItemsJSON string       `inject:"config:commerce.product.fakeservice.jsonTestDataCategoryFacetItems,optional"`
+		SortConfig             config.Slice `inject:"config:commerce.product.fakeservice.sorting"`
 	},
 ) *SearchService {
 	s.productService = productService
 	if cfg != nil {
 		s.liveSearchJSON = cfg.LiveSearchJSON
 		s.categoryFacetItemsJSON = cfg.CategoryFacetItemsJSON
+
+		err := cfg.SortConfig.MapInto(&s.sortConfig)
+		if err != nil {
+			panic(err)
+		}
 	}
 
 	return s
@@ -49,6 +66,17 @@ func (s *SearchService) Search(ctx context.Context, filters ...searchDomain.Filt
 	currentPage := s.findCurrentPage(filters)
 	facets, selectedFacets := s.createFacets(filters)
 
+	var promotions []searchDomain.Promotion
+	if len(hits) > 0 {
+		promotions = append(promotions, searchDomain.Promotion{
+			Title:                "Promotion",
+			Content:              "",
+			URL:                  "http://promotion.example.com/",
+			Media:                []searchDomain.Media{{}},
+			AdditionalAttributes: nil,
+		})
+	}
+
 	documents := make([]searchDomain.Document, len(hits))
 	for i, hit := range hits {
 		documents[i] = hit
@@ -63,11 +91,12 @@ func (s *SearchService) Search(ctx context.Context, filters ...searchDomain.Filt
 				NumPages:       10,
 				NumResults:     len(hits),
 				SelectedFacets: selectedFacets,
-				SortOptions:    s.findSorts(filters),
+				SortOptions:    mapSortOptions(s.sortConfig, filters),
 			},
 			Hits:       documents,
 			Suggestion: []searchDomain.Suggestion{},
 			Facets:     facets,
+			Promotions: promotions,
 		},
 		Hits: hits,
 	}, nil
@@ -168,17 +197,26 @@ func (s *SearchService) findCurrentPage(filters []searchDomain.Filter) int {
 	return currentPage
 }
 
-func (s *SearchService) findSorts(filters []searchDomain.Filter) []searchDomain.SortOption {
-	result := make([]searchDomain.SortOption, 0)
-	// first check if the searchDomain.SortFilter is given
-	for _, v := range filters {
-		if filter, ok := v.(*searchDomain.SortFilter); ok {
-			result = append(result, searchDomain.SortOption{
-				Label:        filter.Field(),
-				Field:        filter.Field(),
-				SelectedAsc:  !filter.Descending(),
-				SelectedDesc: filter.Descending(),
-			})
+// mapSortOptions maps configured sort options to the ones potentially provided via filter
+func mapSortOptions(sortConfigs []sortConfig, filters []searchDomain.Filter) []searchDomain.SortOption {
+	lookup := make(map[string]bool, 1) // only one field expected
+
+	for _, filter := range filters {
+		if sortFiler, ok := filter.(*searchDomain.SortFilter); ok {
+			lookup[sortFiler.Field()] = true // direction always true for that filter name
+		}
+	}
+
+	result := make([]searchDomain.SortOption, len(sortConfigs))
+
+	for i, sortConfig := range sortConfigs {
+		result[i] = searchDomain.SortOption{
+			Label:        sortConfig.Label,
+			Field:        sortConfig.Key,
+			Asc:          sortConfig.Asc,
+			Desc:         sortConfig.Desc,
+			SelectedAsc:  lookup[sortConfig.Asc],
+			SelectedDesc: lookup[sortConfig.Desc],
 		}
 	}