Add support for the attributes set in category search (#352)

Author: kried

CHANGELOG.md

@@ -7,6 +7,7 @@ Guide: https://keepachangelog.com/en/1.0.0/
 ## Unreleased
 
 - [Details] Add `SearchEngine.retrieve(mapboxID: String, options: DetailsOptions)` function.
+- [SearchOptions] Add `SearchOptions.attributeSets` option. It allows to request of additional metadata attributes besides the basic ones in category search requests.
 
 ## 2.7.1
 

Sources/Demo/Examples/SimpleCategorySearchViewController.swift

@@ -2,18 +2,21 @@ import MapboxSearch
 import UIKit
 
 class SimpleCategorySearchViewController: MapsViewController {
-    let searchEngine = CategorySearchEngine()
+    let searchEngine = CategorySearchEngine(apiType: .searchBox)
 //    let searchEngine = CategorySearchEngine(accessToken: "<#You can pass access token manually#>")
 
     override func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(animated)
 
-        searchEngine.search(categoryName: "cafe") { response in
+        let searchOptions = SearchOptions(attributeSets: [.basic, .photos, .venue, .visit])
+        searchEngine.search(categoryName: "cafe", options: searchOptions) { response in
             do {
                 let results = try response.get()
                 print("Number of category search results: \(results.count)")
 
                 for result in results {
+                    print("\tResult name: \(result.name)")
+                    print("\tResult metadata - phone: \(result.metadata?.phone ?? "null")")
                     print("\tResult coordinate: \(result.coordinate)")
                 }
 

Sources/MapboxSearch/PublicAPI/Engine/SearchRequest/RetrieveOptions.swift

@@ -16,7 +16,7 @@ public struct RetrieveOptions: Sendable {
     func toCore() -> CoreRetrieveOptions {
         CoreRetrieveOptions(
             attributeSets:
-            attributeSets.map { $0.map { NSNumber(value: $0.coreValue.rawValue) } }
+            attributeSets?.map { NSNumber(value: $0.coreValue.rawValue) }
         )
     }
 }

Sources/MapboxSearch/PublicAPI/SearchOptions.swift

@@ -38,7 +38,7 @@ public struct SearchOptions {
     /// The bounding box cannot cross the 180th meridian.
     public var boundingBox: BoundingBox?
 
-    /// In case ``SearchOptions/boundingBox`` was applied, places search will look though all available tiles,
+    /// In case ``SearchOptions/boundingBox`` was applied, places search will look through all available tiles,
     /// ignoring the bounding box. Other search types (Address, POI, Category) will no be affected by this setting.
     /// In case ``SearchOptions/boundingBox`` was not applied - this param will not be used.
     public var offlineSearchPlacesOutsideBbox: Bool
@@ -85,6 +85,10 @@ public struct SearchOptions {
      */
     public var locale: Locale?
 
+    /// Configures additional metadata attributes besides the basic ones. This property is used only in category search.
+    /// Supported in ``ApiType/searchBox`` only.
+    public var attributeSets: [AttributeSet]?
+
     /// Search request options constructor
     /// - Parameter countries: Limit results to one or more countries. Permitted values are ISO 3166 alpha 2 country
     /// codes (e.g. US, DE, GB)
@@ -94,6 +98,7 @@ public struct SearchOptions {
     /// - Parameter fuzzyMatch: Use non-strict (`true`) or strict (`false`) matching
     /// - Parameter proximity: Coordinate to search around
     /// - Parameter boundingBox: Limit search result to a region
+    /// - Parameter offlineSearchPlacesOutsideBbox: Configures if places can be looked through all available files ignoring the bounding box
     /// - Parameter origin: Search origin point. This point is used for calculation of SearchResult ETA and distance
     /// fields
     /// - Parameter navigationOptions: Navigation options used for proper calculation of ETA and results ranking
@@ -102,6 +107,8 @@ public struct SearchOptions {
     /// - Parameter ignoreIndexableRecords: Do not search external records in `IndexableDataProvider`s
     /// - Parameter indexableRecordsDistanceThreshold: Radius of circle around `proximity` to filter indexable records
     /// - Parameter unsafeParameters: Non-verified query parameters to the server API
+    /// - Parameter attributeSets: Configures additional metadata attributes besides the basic ones.  If `attributeSets`
+    /// is `nil` or empty, ``AttributeSet/basic`` will be requested.
     public init(
         countries: [String]? = nil,
         languages: [String]? = nil,
@@ -116,7 +123,8 @@ public struct SearchOptions {
         filterTypes: [SearchQueryType]? = nil,
         ignoreIndexableRecords: Bool = false,
         indexableRecordsDistanceThreshold: CLLocationDistance? = nil,
-        unsafeParameters: [String: String]? = nil
+        unsafeParameters: [String: String]? = nil,
+        attributeSets: [AttributeSet]? = nil
     ) {
         self.countries = countries
         self.languages = languages ?? Locale.defaultLanguages()
@@ -132,6 +140,7 @@ public struct SearchOptions {
         self.ignoreIndexableRecords = ignoreIndexableRecords
         self.indexableRecordsDistanceThreshold = indexableRecordsDistanceThreshold
         self.unsafeParameters = unsafeParameters
+        self.attributeSets = attributeSets
     }
 
     /// Search request options with custom proximity.
@@ -199,9 +208,11 @@ public struct SearchOptions {
             latitude: $0.value.latitude,
             longitude: $0.value.longitude
         ) }
-        let filterTypes: [SearchQueryType]? = options.types?
-            .compactMap { CoreQueryType(rawValue: $0.intValue) }
-            .compactMap { SearchQueryType.fromCoreValue($0) }
+
+        let filterTypes: [SearchQueryType]? = options.types?.compactMap {
+            CoreQueryType(rawValue: $0.intValue)
+                .flatMap { SearchQueryType.fromCoreValue($0) }
+        }
 
         var routeOptions: RouteOptions?
         let coordinates = options.route?.map(\.value)
@@ -218,6 +229,11 @@ public struct SearchOptions {
             etaType: etaType
         ) }
 
+        let attributeSets: [AttributeSet]? = options.attributeSets?.compactMap {
+            CoreAttributeSet(rawValue: $0.intValue)
+                .flatMap { AttributeSet.fromCoreValue($0) }
+        }
+
         self.init(
             countries: options.countries,
             languages: options.language,
@@ -231,7 +247,8 @@ public struct SearchOptions {
             filterTypes: filterTypes,
             ignoreIndexableRecords: options.ignoreUR,
             indexableRecordsDistanceThreshold: options.urDistanceThreshold?.doubleValue,
-            unsafeParameters: options.addonAPI
+            unsafeParameters: options.addonAPI,
+            attributeSets: attributeSets
         )
     }
 
@@ -267,8 +284,8 @@ public struct SearchOptions {
             addonAPI: unsafeParameters,
             offlineSearchPlacesOutsideBbox: offlineSearchPlacesOutsideBbox,
             ensureResultsPerCategory: nil,
-            // TODO: Support multiple categories search and ability to ensure results per category.
-            attributeSets: nil
+            // TODO: NAVIOS-2054 Support multiple categories search and ability to ensure results per category.
+            attributeSets: attributeSets?.map { NSNumber(value: $0.coreValue.rawValue) }
         )
     }
 
@@ -412,7 +429,8 @@ public struct SearchOptions {
             ignoreIndexableRecords: ignoreIndexableRecords,
             indexableRecordsDistanceThreshold: indexableRecordsDistanceThreshold ??
                 with.indexableRecordsDistanceThreshold,
-            unsafeParameters: unsafeParameters ?? with.unsafeParameters
+            unsafeParameters: unsafeParameters ?? with.unsafeParameters,
+            attributeSets: attributeSets ?? with.attributeSets
         )
     }
 }

Tests/MapboxSearchIntegrationTests/search-box/SearchBox_CategorySearchEngineIntegrationTests.swift

@@ -4,6 +4,7 @@ import XCTest
 
 final class SearchBox_CategorySearchEngineIntegrationTests: MockServerIntegrationTestCase<SearchBoxMockResponse> {
     private var searchEngine: CategorySearchEngine!
+    private var searchOptions: SearchOptions!
 
     override func setUpWithError() throws {
         try super.setUpWithError()
@@ -15,18 +16,25 @@ final class SearchBox_CategorySearchEngineIntegrationTests: MockServerIntegratio
             apiType: apiType,
             baseURL: mockServerURL()
         )
+        searchOptions = SearchOptions(attributeSets: [.basic, .photos, .venue, .visit])
     }
 
     func testCategorySearch() throws {
         try server.setResponse(.categoryCafe)
 
         let expectation = XCTestExpectation(description: "Expecting results")
-        searchEngine.search(categoryName: "cafe") { result in
+        searchEngine.search(categoryName: "cafe", options: searchOptions) { [weak self] result in
+            guard let self else { return }
             switch result {
             case .success(let searchResults):
                 XCTAssertFalse(searchResults.isEmpty)
                 let matchingNames = searchResults.compactMap(\.matchingName)
                 XCTAssertTrue(matchingNames.isEmpty)
+                let queryParams = self.server.passedRequests.last!.queryParams
+                let attributeSetsParam = queryParams.first {
+                    $0.0 == "attribute_sets"
+                }?.1
+                XCTAssertEqual(attributeSetsParam, "basic,photos,venue,visit")
                 expectation.fulfill()
             case .failure:
                 XCTFail("Error not expected")
@@ -40,7 +48,7 @@ final class SearchBox_CategorySearchEngineIntegrationTests: MockServerIntegratio
         try server.setResponse(.categoryCafe, statusCode: 500)
 
         let expectation = XCTestExpectation(description: "Expecting failure")
-        searchEngine.search(categoryName: "cafe") { result in
+        searchEngine.search(categoryName: "cafe", options: searchOptions) { result in
             switch result {
             case .success:
                 XCTFail("Not expected")

Tests/MapboxSearchTests/Legacy/SearchOptionsTests.swift

@@ -21,6 +21,7 @@ class SearchOptionsTests: XCTestCase {
         XCTAssertEqual(searchOptions.unsafeParameters, ["arg": "value"])
         XCTAssertFalse(searchOptions.ignoreIndexableRecords)
         XCTAssertEqual(searchOptions.indexableRecordsDistanceThreshold, 2_000)
+        XCTAssertEqual(searchOptions.attributeSets, [.basic, .photos])
     }
 
     func testSearchOptionBoundingBoxConstructor() {
@@ -40,6 +41,7 @@ class SearchOptionsTests: XCTestCase {
         XCTAssertNil(bbOptions.filterTypes)
         XCTAssertFalse(bbOptions.ignoreIndexableRecords)
         XCTAssertNil(bbOptions.indexableRecordsDistanceThreshold)
+        XCTAssertNil(bbOptions.attributeSets)
     }
 
     func testSearchOptionsProximityConstructors() {
@@ -58,6 +60,7 @@ class SearchOptionsTests: XCTestCase {
         XCTAssertNil(proximityOptions.filterTypes)
         XCTAssertFalse(proximityOptions.ignoreIndexableRecords)
         XCTAssertNil(proximityOptions.indexableRecordsDistanceThreshold)
+        XCTAssertNil(proximityOptions.attributeSets)
     }
 
     func testSearchOptionsNavigationConstructors() {
@@ -80,6 +83,7 @@ class SearchOptionsTests: XCTestCase {
         XCTAssertNil(navigationOptions.filterTypes)
         XCTAssertFalse(navigationOptions.ignoreIndexableRecords)
         XCTAssertNil(navigationOptions.indexableRecordsDistanceThreshold)
+        XCTAssertNil(navigationOptions.attributeSets)
     }
 
     func testSearchOptionsRouteConstructors() {
@@ -101,6 +105,7 @@ class SearchOptionsTests: XCTestCase {
         XCTAssertNil(routeOptions.filterTypes)
         XCTAssertFalse(routeOptions.ignoreIndexableRecords)
         XCTAssertNil(routeOptions.indexableRecordsDistanceThreshold)
+        XCTAssertNil(routeOptions.attributeSets)
     }
 
     func testSearchOptionsConversionForGeocodingAPI() {
@@ -125,6 +130,7 @@ class SearchOptionsTests: XCTestCase {
             fromCoreSearchOptions.indexableRecordsDistanceThreshold,
             searchOptions.indexableRecordsDistanceThreshold
         )
+        XCTAssertEqual(fromCoreSearchOptions.attributeSets, searchOptions.attributeSets)
     }
 
     func testSearchOptionsConversionForSBSAPI() {
@@ -155,6 +161,7 @@ class SearchOptionsTests: XCTestCase {
             fromCoreSearchOptions.indexableRecordsDistanceThreshold,
             searchOptions.indexableRecordsDistanceThreshold
         )
+        XCTAssertEqual(fromCoreSearchOptions.attributeSets, searchOptions.attributeSets)
     }
 
     func testSearchOptionsUsesLocale() {
@@ -184,6 +191,7 @@ class SearchOptionsTests: XCTestCase {
         XCTAssertNil(searchOptions.filterTypes)
         XCTAssertFalse(searchOptions.ignoreIndexableRecords)
         XCTAssertNil(searchOptions.indexableRecordsDistanceThreshold)
+        XCTAssertNil(searchOptions.attributeSets)
     }
 
     func testSearchOptionsConversion() throws {
@@ -206,6 +214,7 @@ class SearchOptionsTests: XCTestCase {
         XCTAssertEqual(mergedOptions.unsafeParameters, ["api": "v3"])
         XCTAssertEqual(mergedOptions.ignoreIndexableRecords, fullOptions.ignoreIndexableRecords)
         XCTAssertEqual(mergedOptions.indexableRecordsDistanceThreshold, fullOptions.indexableRecordsDistanceThreshold)
+        XCTAssertEqual(mergedOptions.attributeSets, fullOptions.attributeSets)
     }
 }
 
@@ -229,6 +238,7 @@ extension SearchOptions {
         filterTypes: [.poi, .address, .place],
         ignoreIndexableRecords: false,
         indexableRecordsDistanceThreshold: 2_000,
-        unsafeParameters: ["arg": "value"]
+        unsafeParameters: ["arg": "value"],
+        attributeSets: [.basic, .photos]
     )
 }

Tests/MockWebServer/MockWebServer.swift

@@ -4,6 +4,8 @@ import Swifter
 final class MockWebServer<Mock: MockResponse> {
     let endpoint = "http://localhost:8080"
 
+    var passedRequests: [Swifter.HttpRequest] = []
+
     private let server = HttpServer()
 
     func setResponse(_ endpoint: Mock, query: String? = nil, statusCode: Int = 200) throws {
@@ -18,10 +20,16 @@ final class MockWebServer<Mock: MockResponse> {
 
         switch method {
         case .get:
-            server.get[route] = { _ in response }
+            server.get[route] = { [weak self] request in
+                self?.passedRequests.append(request)
+                return response
+            }
 
         case .post:
-            server.post[route] = { _ in response }
+            server.post[route] = { [weak self] request in
+                self?.passedRequests.append(request)
+                return response
+            }
         }
     }