Search 2.9.0; New functionality (#325)

* CI config for snapshots

* Versions bump

* Provide default onlineRequestTimeout

* SearchResult.boundingBox

* OfflineEvSearchOptions.excludeOperators

* Offline Category Search function

* Update public API

* Changelog

Author: DzmitryFomchyn

.circleci/config.yml

@@ -430,6 +430,9 @@ workflows:
       - sample-instrumentation-tests:
           requires:
             - prepare-and-assemble
+      - publish-snapshots:
+          requires:
+            - prepare-and-assemble
 #      - pitest-validate:
 #          requires:
 #            - unit-tests

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog for the Mapbox Search SDK for Android
 
+## 2.9.0
+
+### New features
+- Added an optional property `SearchResult.boundingBox` which represents the geographical boundaries of a location.
+- Introduced a dedicated function for category search: `OfflineSearchEngine.categorySearch()`. This function can accept multiple categories. Besides that `OfflineCategorySearchOptions` has a new option `ensureResultsPerCategory`. See documentation for more information.
+- Added a new option `OfflineEvSearchOptions.excludeOperators` which allows to exclude specific operators from search results.
+
+### Mapbox dependencies
+- Search Native SDK `2.9.0`
+- Common SDK `24.11.0`
+
+
+
 ## 2.9.0-rc.1
 
 ### New features

MapboxSearch/autofill/src/androidTest/java/com/mapbox/search/autofill/AddressAutofillIntegrationTest.kt

@@ -16,6 +16,7 @@ import com.mapbox.search.base.location.LocationEngineAdapter
 import com.mapbox.search.base.location.WrapperLocationProvider
 import com.mapbox.search.base.location.defaultLocationProvider
 import com.mapbox.search.base.utils.UserAgentProvider
+import com.mapbox.search.base.utils.defaultOnlineRequestTimeoutSeconds
 import com.mapbox.search.common.IsoCountryCode
 import com.mapbox.search.common.IsoLanguageCode
 import com.mapbox.search.common.SearchRequestException
@@ -310,6 +311,7 @@ internal class AddressAutofillIntegrationTest {
                     apiType = CoreApiType.AUTOFILL,
                     sdkInformation = UserAgentProvider.sdkInformation(),
                     eventsUrl = null,
+                    onlineRequestTimeout = defaultOnlineRequestTimeoutSeconds(),
                 ),
                 WrapperLocationProvider(
                     LocationEngineAdapter(app, locationProvider), null

MapboxSearch/autofill/src/main/java/com/mapbox/search/autofill/AddressAutofillImpl.kt

@@ -20,6 +20,7 @@ import com.mapbox.search.base.result.BaseSearchResult
 import com.mapbox.search.base.result.BaseSearchSuggestion
 import com.mapbox.search.base.result.SearchResultFactory
 import com.mapbox.search.base.utils.UserAgentProvider
+import com.mapbox.search.base.utils.defaultOnlineRequestTimeoutSeconds
 import com.mapbox.search.base.utils.extension.flatMap
 import com.mapbox.search.internal.bindgen.UserActivityReporterInterface
 import java.util.concurrent.ExecutorService
@@ -124,6 +125,7 @@ internal class AddressAutofillImpl(
                     apiType = CoreApiType.AUTOFILL,
                     sdkInformation = UserAgentProvider.sdkInformation(),
                     eventsUrl = null,
+                    onlineRequestTimeout = defaultOnlineRequestTimeoutSeconds(),
                 ),
                 WrapperLocationProvider(
                     LocationEngineAdapter(app, locationProvider),

MapboxSearch/autofill/src/main/java/com/mapbox/search/autofill/AutofillSearchEngine.kt

@@ -33,6 +33,7 @@ import com.mapbox.search.base.result.SearchResultFactory
 import com.mapbox.search.base.result.mapToCore
 import com.mapbox.search.base.task.AsyncOperationTaskImpl
 import com.mapbox.search.base.utils.UserAgentProvider
+import com.mapbox.search.base.utils.defaultOnlineRequestTimeoutSeconds
 import com.mapbox.search.common.AsyncOperationTask
 import com.mapbox.search.common.concurrent.SearchSdkMainThreadWorker
 import com.mapbox.search.internal.bindgen.ApiType
@@ -257,6 +258,7 @@ internal class AutofillSearchEngine(
                     apiType = apiType,
                     sdkInformation = UserAgentProvider.sdkInformation(),
                     eventsUrl = null,
+                    onlineRequestTimeout = defaultOnlineRequestTimeoutSeconds(),
                 ),
                 WrapperLocationProvider(
                     LocationEngineAdapter(app, locationProvider),

MapboxSearch/base/src/main/java/com/mapbox/search/base/core/CoreFactoryFunctions.kt

@@ -185,10 +185,12 @@ fun createCoreEvSearchOptions(
     minChargingPower: Float? = null,
     maxChargingPower: Float? = null,
     availability: CoreChargingStatus? = null,
+    excludeOperators: List<String>? = null,
 ): CoreEvSearchOptions = CoreEvSearchOptions(
     connectorTypes = connectorTypes,
     operators = operators,
     minChargingPower = minChargingPower,
     maxChargingPower = maxChargingPower,
     availability = availability,
+    excludeOperators = excludeOperators,
 )

MapboxSearch/base/src/main/java/com/mapbox/search/base/result/BaseRawSearchResult.kt

@@ -1,12 +1,15 @@
 package com.mapbox.search.base.result
 
 import android.os.Parcelable
+import com.mapbox.geojson.BoundingBox
 import com.mapbox.geojson.Point
 import com.mapbox.search.base.assertDebug
 import com.mapbox.search.base.core.CoreResultAccuracy
 import com.mapbox.search.base.core.CoreResultMetadata
 import com.mapbox.search.base.core.CoreRoutablePoint
 import com.mapbox.search.base.core.CoreSearchResult
+import com.mapbox.search.base.utils.extension.mapToCore
+import com.mapbox.search.base.utils.extension.mapToPlatform
 import kotlinx.parcelize.IgnoredOnParcel
 import kotlinx.parcelize.Parcelize
 import java.util.HashMap
@@ -27,6 +30,7 @@ data class BaseRawSearchResult(
     val center: Point?,
     val accuracy: CoreResultAccuracy?,
     val routablePoints: List<CoreRoutablePoint>?,
+    val bbox: BoundingBox?,
     val categories: List<String>?,
     val categoryIds: List<String>?,
     val brand: List<String>?,
@@ -114,6 +118,7 @@ fun CoreSearchResult.mapToBase() = BaseRawSearchResult(
     center = center,
     accuracy = accuracy,
     routablePoints = routablePoints,
+    bbox = bbox?.mapToPlatform(),
     categories = categories,
     categoryIds = categoryIDs,
     brand = brand,
@@ -157,4 +162,5 @@ fun BaseRawSearchResult.mapToCore() = CoreSearchResult(
     userRecordPriority,
     action?.mapToCore(),
     serverIndex,
+    bbox?.mapToCore(),
 )

MapboxSearch/base/src/main/java/com/mapbox/search/base/result/BaseSearchResult.kt

@@ -1,6 +1,7 @@
 package com.mapbox.search.base.result
 
 import android.os.Parcelable
+import com.mapbox.geojson.BoundingBox
 import com.mapbox.geojson.Point
 import com.mapbox.search.base.BaseRequestOptions
 import com.mapbox.search.base.core.CoreResultAccuracy
@@ -41,6 +42,9 @@ abstract class BaseSearchResult(
     open val routablePoints: List<CoreRoutablePoint>?
         get() = rawSearchResult.routablePoints
 
+    open val bbox: BoundingBox?
+        get() = rawSearchResult.bbox
+
     open val categories: List<String>?
         get() = rawSearchResult.categories
 

MapboxSearch/base/src/main/java/com/mapbox/search/base/utils/RequestTimeoutProvider.kt

@@ -0,0 +1,6 @@
+package com.mapbox.search.base.utils
+
+import androidx.annotation.RestrictTo
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
+fun defaultOnlineRequestTimeoutSeconds(): Int? = null

MapboxSearch/base/src/test/java/com/mapbox/search/base/result/BaseRawSearchResultTest.kt

@@ -2,6 +2,7 @@ package com.mapbox.search.base.result
 
 import com.mapbox.geojson.Point
 import com.mapbox.search.base.BuildConfig
+import com.mapbox.search.base.core.CoreBoundingBox
 import com.mapbox.search.base.core.CoreResultAccuracy
 import com.mapbox.search.base.core.CoreRoutablePoint
 import com.mapbox.search.base.core.CoreSearchResult
@@ -10,6 +11,7 @@ import com.mapbox.search.base.core.createCoreResultMetadata
 import com.mapbox.search.base.logger.reinitializeLogImpl
 import com.mapbox.search.base.logger.resetLogImpl
 import com.mapbox.search.base.tests_support.createTestBaseRawSearchResult
+import com.mapbox.search.base.utils.extension.mapToPlatform
 import com.mapbox.search.common.tests.TestConstants.ASSERTIONS_KT_CLASS_NAME
 import com.mapbox.search.common.tests.catchThrowable
 import com.mapbox.search.common.tests.createCoreSearchAddress
@@ -300,7 +302,8 @@ internal class BaseRawSearchResultTest {
             null,
             -1,
             null,
-            null
+            null,
+            null,
         )
 
         val BASE_EMPTY_SEARCH_RESULT = BaseRawSearchResult(
@@ -318,6 +321,7 @@ internal class BaseRawSearchResultTest {
             center = CORE_EMPTY_SEARCH_RESULT.center,
             accuracy = CORE_EMPTY_SEARCH_RESULT.accuracy,
             routablePoints = CORE_EMPTY_SEARCH_RESULT.routablePoints,
+            bbox = CORE_EMPTY_SEARCH_RESULT.bbox?.mapToPlatform(),
             categories = CORE_EMPTY_SEARCH_RESULT.categories,
             categoryIds = CORE_EMPTY_SEARCH_RESULT.categoryIDs,
             brand = CORE_EMPTY_SEARCH_RESULT.brand,
@@ -350,6 +354,7 @@ internal class BaseRawSearchResultTest {
             center = CORE_FILLED_SEARCH_RESULT.center,
             accuracy = CORE_FILLED_SEARCH_RESULT.accuracy,
             routablePoints = CORE_FILLED_SEARCH_RESULT.routablePoints,
+            bbox = CORE_FILLED_SEARCH_RESULT.bbox?.mapToPlatform(),
             categories = CORE_FILLED_SEARCH_RESULT.categories,
             categoryIds = CORE_FILLED_SEARCH_RESULT.categoryIDs,
             brand = CORE_FILLED_SEARCH_RESULT.brand,
@@ -407,7 +412,8 @@ internal class BaseRawSearchResultTest {
                 "test user record id",
                 -1,
                 CoreSuggestAction("test endpoint", "test path", "test query", byteArrayOf(1, 2, 3), true),
-                123
+                123,
+                CoreBoundingBox(Point.fromLngLat(1.0, 2.0), Point.fromLngLat(2.0, 3.0)),
             )
         }