Merge branch 'feature/47-dropdown-shows-very-limited-number-of' into develop

Author: sds100

app/build.gradle

@@ -8,13 +8,13 @@ plugins {
 
 android {
     namespace 'com.mapcode'
-    compileSdk 32
+    compileSdk 33
 
     defaultConfig {
         applicationId "com.mapcode"
         minSdk 21
         //noinspection OldTargetApi wait for sources to be released before upgrading
-        targetSdk 32
+        targetSdk 33
         versionCode 3
         versionName "1.1.0"
 
@@ -64,6 +64,8 @@ dependencies {
     //google
     implementation 'com.google.maps.android:maps-compose:2.2.0'
     implementation 'com.google.android.gms:play-services-maps:18.1.0'
+    implementation 'com.google.android.libraries.places:places:2.6.0'
+    implementation 'com.google.maps.android:places-ktx:2.0.0'
     implementation "com.google.dagger:hilt-android:2.42"
     implementation 'androidx.hilt:hilt-navigation-compose:1.0.0'
     implementation 'com.google.android.gms:play-services-location:20.0.0'
@@ -77,15 +79,15 @@ dependencies {
     implementation 'androidx.activity:activity-compose:1.5.1'
     //noinspection GradleDependency
     implementation "androidx.compose.ui:ui:1.2.0"
-    implementation "androidx.compose.ui:ui-tooling-preview:1.2.0"
-    implementation 'androidx.compose.material:material:1.2.0'
+    implementation "androidx.compose.ui:ui-tooling-preview:1.2.1"
+    implementation 'androidx.compose.material:material:1.2.1'
     implementation "androidx.navigation:navigation-compose:2.5.1"
-    implementation "androidx.compose.foundation:foundation:1.3.0-alpha02"
+    implementation "androidx.compose.foundation:foundation:1.3.0-alpha03"
     implementation 'com.google.accompanist:accompanist-permissions:0.24.10-beta'
     implementation "com.google.accompanist:accompanist-systemuicontroller:0.17.0"
     implementation "androidx.datastore:datastore-preferences:1.0.0"
     implementation "androidx.core:core-splashscreen:1.0.0"
-    implementation "androidx.compose.material3:material3-window-size-class:1.0.0-alpha15"
+    implementation "androidx.compose.material3:material3-window-size-class:1.0.0-alpha16"
 
     //other
     implementation 'com.jakewharton.timber:timber:5.0.1'
@@ -94,8 +96,8 @@ dependencies {
     implementation "com.squareup.okhttp3:okhttp:4.10.0"
 
     //debug
-    debugImplementation "androidx.compose.ui:ui-tooling:1.2.0"
-    debugImplementation "androidx.compose.ui:ui-test-manifest:1.2.0"
+    debugImplementation "androidx.compose.ui:ui-tooling:1.2.1"
+    debugImplementation "androidx.compose.ui:ui-test-manifest:1.2.1"
 
     //testing
     testImplementation 'junit:junit:4.13.2'
@@ -110,7 +112,7 @@ dependencies {
     androidTestImplementation 'com.willowtreeapps.assertk:assertk-jvm:0.25'
     androidTestImplementation 'androidx.test.ext:junit:1.1.3'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
-    androidTestImplementation "androidx.compose.ui:ui-test-junit4:1.2.0"
+    androidTestImplementation "androidx.compose.ui:ui-test-junit4:1.2.1"
     androidTestImplementation 'org.mockito.kotlin:mockito-kotlin:4.0.0'
     androidTestImplementation 'org.mockito:mockito-android:4.6.1'
     androidTestImplementation 'androidx.test:rules:1.4.0'

app/src/androidTest/java/com/mapcode/map/FakeShowMapcodeUseCase.kt

@@ -97,11 +97,16 @@ class FakeShowMapcodeUseCase : ShowMapcodeUseCase {
         sharedText = text
     }
 
-    override fun launchDirectionsToLocation(location: Location, zoom: Float): Boolean {
-        return isMapsAppInstalled
+    override suspend fun getMatchingAddresses(
+        query: String,
+        maxResults: Int,
+        southwest: Location,
+        northeast: Location
+    ): Result<List<String>> {
+        return success(matchingAddresses[query] ?: emptyList())
     }
 
-    override suspend fun getMatchingAddresses(query: String): Result<List<String>> {
-        return success(matchingAddresses[query] ?: emptyList())
+    override fun launchDirectionsToLocation(location: Location, zoom: Float): Boolean {
+        return isMapsAppInstalled
     }
 }

app/src/androidTest/java/com/mapcode/map/MapScreenTest.kt

@@ -183,7 +183,6 @@ class MapScreenTest {
         composeTestRule.waitForIdle()
 
         composeTestRule.onNodeWithText("Street, City, Country").assertIsDisplayed()
-
         composeTestRule.onNodeWithText("City, Country").assertIsDisplayed()
     }
 
@@ -530,6 +529,10 @@ class MapScreenTest {
             performTextInput("address")
         }
 
+        composeTestRule.waitUntil(2000) {
+            viewModel.uiState.value.addressUi.matchingAddresses.isNotEmpty()
+        }
+
         composeTestRule.waitForIdle()
         composeTestRule.onNodeWithTag("address_dropdown").assertIsDisplayed()
         composeTestRule.onNodeWithText("Street 1").assertIsDisplayed()
@@ -572,7 +575,10 @@ class MapScreenTest {
             performTextInput("address")
         }
 
-        composeTestRule.waitForIdle()
+        composeTestRule.waitUntil(2000) {
+            viewModel.uiState.value.addressUi.matchingAddresses.isNotEmpty()
+        }
+
         composeTestRule.onNodeWithText("Street 1").performClick()
         composeTestRule.onNodeWithText("Enter address or mapcode").assertIsNotFocused()
     }

app/src/main/java/com/mapcode/MainActivity.kt

@@ -28,6 +28,7 @@ import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
 import androidx.core.view.WindowCompat
 import androidx.navigation.compose.rememberNavController
 import com.google.android.gms.maps.MapsInitializer
+import com.google.android.libraries.places.api.Places
 import com.mapcode.map.MapViewModel
 import com.mapcode.theme.MapcodeTheme
 import dagger.hilt.android.AndroidEntryPoint
@@ -48,6 +49,7 @@ class MainActivity : ComponentActivity() {
             MapcodeApp(viewModel, windowSizeClass)
         }
 
+        Places.initialize(applicationContext, BuildConfig.MAPS_API_KEY)
         MapsInitializer.initialize(this)
         viewModel.isGoogleMapsSdkLoaded = true
     }

app/src/main/java/com/mapcode/map/MapViewModel.kt

@@ -34,11 +34,8 @@ import com.mapcode.data.Keys
 import com.mapcode.data.PreferenceRepository
 import com.mapcode.util.*
 import dagger.hilt.android.lifecycle.HiltViewModel
-import kotlinx.coroutines.Job
-import kotlinx.coroutines.delay
+import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.*
-import kotlinx.coroutines.launch
-import kotlinx.coroutines.runBlocking
 import java.io.IOException
 import java.math.RoundingMode
 import java.text.DecimalFormat
@@ -56,7 +53,8 @@ class MapViewModel @Inject constructor(
 
     companion object {
         private const val UNKNOWN_ADDRESS_ERROR_TIMEOUT: Long = 3000
-        const val ANIMATE_CAMERA_UPDATE_DURATION_MS = 200
+        const val ANIMATE_CAMERA_UPDATE_DURATION_MS: Int = 200
+        private const val AUTOCOMPLETE_ADDRESS_DELAY_MS: Long = 1500
     }
 
     private val latLngNumberFormat: NumberFormat by lazy { NumberFormat.getNumberInstance(Locale.getDefault()) }
@@ -217,12 +215,49 @@ class MapViewModel @Inject constructor(
     }
 
     fun onAddressTextChange(text: String) {
-        addressUi.update { it.copy(address = text) }
+        //if the user is continuing the same search query then do not clear the matching addresses
+        val clearMatchingAddresses = text.dropLast(1) != addressUi.value.address
+
+        addressUi.update {
+            if (clearMatchingAddresses) {
+                it.copy(address = text, matchingAddresses = emptyList())
+            } else {
+                it.copy(address = text)
+            }
+        }
 
         getMatchingAddressesJob?.cancel()
-        getMatchingAddressesJob = viewModelScope.launch {
-            useCase.getMatchingAddresses(text).onSuccess { result ->
-                addressUi.update { it.copy(matchingAddresses = result) }
+
+        if (text.isNotEmpty()) {
+            getMatchingAddressesJob = viewModelScope.launch(dispatchers.default) {
+                delay(AUTOCOMPLETE_ADDRESS_DELAY_MS)
+
+                val latLngBounds = withContext(dispatchers.main) {
+                    cameraPositionState.projection?.visibleRegion?.latLngBounds
+                }
+                val maxResults = 10
+
+                val matchingAddresses = if (latLngBounds != null) {
+                    useCase.getMatchingAddresses(
+                        text,
+                        maxResults = maxResults,
+                        southwest = Location(latLngBounds.southwest.latitude, latLngBounds.southwest.longitude),
+                        northeast = Location(latLngBounds.northeast.latitude, latLngBounds.northeast.longitude)
+                    ).getOrNull()
+                } else {
+                    useCase.getMatchingAddresses(
+                        text,
+                        maxResults = maxResults,
+                        southwest = Location.GLOBE_SOUTH_WEST,
+                        northeast = Location.GLOBE_NORTH_EAST
+                    ).getOrNull()
+                }
+
+                if (matchingAddresses == null) {
+                    return@launch
+                }
+
+                addressUi.update { it.copy(matchingAddresses = matchingAddresses.distinct()) }
             }
         }
     }

app/src/main/java/com/mapcode/map/ShowMapcodeUseCase.kt

@@ -21,8 +21,14 @@ import android.content.*
 import android.location.Geocoder
 import android.net.Uri
 import androidx.core.content.getSystemService
+import com.google.android.gms.common.api.ApiException
 import com.google.android.gms.location.FusedLocationProviderClient
 import com.google.android.gms.location.LocationServices
+import com.google.android.gms.maps.model.LatLng
+import com.google.android.libraries.places.api.Places
+import com.google.android.libraries.places.api.model.RectangularBounds
+import com.google.android.libraries.places.api.net.PlacesClient
+import com.google.android.libraries.places.ktx.api.net.awaitFindAutocompletePredictions
 import com.mapcode.Mapcode
 import com.mapcode.MapcodeCodec
 import com.mapcode.UnknownMapcodeException
@@ -31,10 +37,7 @@ import com.mapcode.util.Location
 import com.mapcode.util.NoAddressException
 import com.mapcode.util.UnknownAddressException
 import dagger.hilt.android.qualifiers.ApplicationContext
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.launch
-import kotlinx.coroutines.withContext
+import kotlinx.coroutines.*
 import okhttp3.HttpUrl
 import okhttp3.OkHttpClient
 import okhttp3.Request
@@ -62,6 +65,8 @@ class ShowMapcodeUseCaseImpl @Inject constructor(
      */
     private var cachedLastLocation: Location? = null
 
+    private val placesClient: PlacesClient by lazy { Places.createClient(ctx) }
+
     override fun getMapcodes(lat: Double, long: Double): List<Mapcode> {
         coroutineScope.launch(Dispatchers.IO) {
             try {
@@ -103,7 +108,7 @@ class ShowMapcodeUseCaseImpl @Inject constructor(
             }
 
             val matchingAddress = withContext(Dispatchers.Default) {
-                geocoder.getFromLocationName(address, 10).firstOrNull()
+                geocoder.getFromLocationName(address, 10)?.firstOrNull()
             }
 
             if (matchingAddress == null) {
@@ -119,7 +124,7 @@ class ShowMapcodeUseCaseImpl @Inject constructor(
     override suspend fun reverseGeocode(lat: Double, long: Double): Result<String> {
         try {
             val addressList = withContext(Dispatchers.Default) {
-                geocoder.getFromLocation(lat, long, 1)
+                geocoder.getFromLocation(lat, long, 1) ?: emptyList()
             }
 
             if (addressList.isEmpty()) {
@@ -193,23 +198,36 @@ class ShowMapcodeUseCaseImpl @Inject constructor(
         ctx.startActivity(shareIntent)
     }
 
-    override suspend fun getMatchingAddresses(query: String): Result<List<String>> {
-        try {
-            val addressList = withContext(Dispatchers.Default) {
-                geocoder.getFromLocationName(query, 3)
-            }
-
-            val addressStringList = addressList.map { address ->
-                buildString {
-                    for (i in 0..address.maxAddressLineIndex) {
-                        append(address.getAddressLine(i))
-                    }
+    @OptIn(ExperimentalCoroutinesApi::class)
+    override suspend fun getMatchingAddresses(
+        query: String,
+        maxResults: Int,
+        southwest: Location,
+        northeast: Location
+    ): Result<List<String>> {
+        val locationBias = RectangularBounds.newInstance(
+            LatLng(southwest.latitude, southwest.longitude),
+            LatLng(northeast.latitude, northeast.longitude)
+        )
+
+        val responseResult = withContext(Dispatchers.Default) {
+            try {
+                val response = placesClient.awaitFindAutocompletePredictions {
+                    this.query = query
+                    this.locationBias = locationBias
                 }
+
+                success(response)
+            } catch (e: ApiException) {
+                Timber.e(e.status.toString())
+                failure(e)
             }
+        }
 
-            return success(addressStringList)
-        } catch (e: IOException) {
-            return failure(e)
+        return responseResult.map { response ->
+            response.autocompletePredictions
+                .map { it.getFullText(null) }
+                .map { it.toString() }
         }
     }
 }
@@ -267,7 +285,12 @@ interface ShowMapcodeUseCase {
     fun shareText(text: String, description: String)
 
     /**
-     * Get a list of addresses that might correspond to the [query].
+     * Get a list of addresses within the [northeast] and [southwest] bounds that might correspond to the [query].
      */
-    suspend fun getMatchingAddresses(query: String): Result<List<String>>
+    suspend fun getMatchingAddresses(
+        query: String,
+        maxResults: Int,
+        southwest: Location,
+        northeast: Location
+    ): Result<List<String>>
 }

app/src/main/java/com/mapcode/util/Location.kt

@@ -16,4 +16,9 @@
 
 package com.mapcode.util
 
-data class Location(val latitude: Double, val longitude: Double)
+data class Location(val latitude: Double, val longitude: Double) {
+    companion object {
+        val GLOBE_SOUTH_WEST: Location = Location(-90.0, -180.0)
+        val GLOBE_NORTH_EAST: Location = Location(90.0, 180.0)
+    }
+}

app/src/test/java/com/mapcode/LocalAddressQuery.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright (C) 2022, Stichting Mapcode Foundation (http://www.mapcode.com)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mapcode
+
+import com.mapcode.util.Location
+
+data class LocalAddressQuery(val query: String, val southwest: Location, val northeast: Location)

app/src/test/java/com/mapcode/map/FakeShowMapcodeUseCase.kt

@@ -103,8 +103,13 @@ class FakeShowMapcodeUseCase : ShowMapcodeUseCase {
     override fun shareText(text: String, description: String) {
         sharedText = text
     }
-    
-    override suspend fun getMatchingAddresses(query: String): Result<List<String>> {
-        return success(matchingAddresses[query] ?: emptyList())
+
+    override suspend fun getMatchingAddresses(
+        query: String,
+        maxResults: Int,
+        southwest: Location,
+        northeast: Location
+    ): Result<List<String>> {
+        return success((matchingAddresses[query] ?: emptyList()))
     }
 }