Merge pull request #631 from android/tj/notifications

Backend triggered sync

Author: tunjid

core/data/build.gradle.kts

@@ -36,6 +36,7 @@ dependencies {
     implementation(project(":core:datastore"))
     implementation(project(":core:model"))
     implementation(project(":core:network"))
+    implementation(project(":core:notifications"))
     implementation(libs.androidx.core.ktx)
     implementation(libs.kotlinx.coroutines.android)
     implementation(libs.kotlinx.datetime)

core/data/src/main/java/com/google/samples/apps/nowinandroid/core/data/repository/OfflineFirstNewsRepository.kt

@@ -30,7 +30,9 @@ import com.google.samples.apps.nowinandroid.core.datastore.ChangeListVersions
 import com.google.samples.apps.nowinandroid.core.model.data.NewsResource
 import com.google.samples.apps.nowinandroid.core.network.NiaNetworkDataSource
 import com.google.samples.apps.nowinandroid.core.network.model.NetworkNewsResource
+import com.google.samples.apps.nowinandroid.core.notifications.Notifier
 import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.flow.map
 import javax.inject.Inject
 
@@ -46,6 +48,7 @@ class OfflineFirstNewsRepository @Inject constructor(
     private val newsResourceDao: NewsResourceDao,
     private val topicDao: TopicDao,
     private val network: NiaNetworkDataSource,
+    private val notifier: Notifier,
 ) : NewsRepository {
 
     override fun getNewsResources(
@@ -69,6 +72,16 @@ class OfflineFirstNewsRepository @Inject constructor(
             },
             modelDeleter = newsResourceDao::deleteNewsResources,
             modelUpdater = { changedIds ->
+                // TODO: Make this more efficient, there is no need to retrieve populated
+                //  news resources when all that's needed are the ids
+                val existingNewsResourceIds = newsResourceDao.getNewsResources(
+                    useFilterNewsIds = true,
+                    filterNewsIds = changedIds.toSet(),
+                )
+                    .first()
+                    .map { it.entity.id }
+                    .toSet()
+
                 changedIds.chunked(SYNC_BATCH_SIZE).forEach { chunkedIds ->
                     val networkNewsResources = network.getNewsResources(ids = chunkedIds)
 
@@ -92,6 +105,20 @@ class OfflineFirstNewsRepository @Inject constructor(
                             .flatten(),
                     )
                 }
+
+                val addedNewsResources = newsResourceDao.getNewsResources(
+                    useFilterNewsIds = true,
+                    filterNewsIds = changedIds.toSet(),
+                )
+                    .first()
+                    .filter { !existingNewsResourceIds.contains(it.entity.id) }
+                    .map(PopulatedNewsResource::asExternalModel)
+
+                // TODO: Define business logic for notifications on first time sync.
+                //  we probably do not want to send notifications on first install.
+                //  We can easily check if the change list version is 0 and not send notifications
+                // if it is.
+                if (addedNewsResources.isNotEmpty()) notifier.onNewsAdded(addedNewsResources)
             },
         )
 }

…roid/core/data/util/SyncStatusMonitor.kt …winandroid/core/data/util/SyncManager.ktcore/data/src/main/java/com/google/samples/apps/nowinandroid/core/data/util/SyncStatusMonitor.kt renamed to core/data/src/main/java/com/google/samples/apps/nowinandroid/core/data/util/SyncManager.kt core/data/src/main/java/com/google/samples/apps/nowinandroid/core/data/util/SyncStatusMonitor.kt renamed to core/data/src/main/java/com/google/samples/apps/nowinandroid/core/data/util/SyncManager.kt

@@ -21,6 +21,7 @@ import kotlinx.coroutines.flow.Flow
 /**
  * Reports on if synchronization is in progress
  */
-interface SyncStatusMonitor {
+interface SyncManager {
     val isSyncing: Flow<Boolean>
+    fun requestSync()
 }

core/data/src/test/java/com/google/samples/apps/nowinandroid/core/data/repository/OfflineFirstNewsRepositoryTest.kt

@@ -36,6 +36,7 @@ import com.google.samples.apps.nowinandroid.core.datastore.test.testUserPreferen
 import com.google.samples.apps.nowinandroid.core.model.data.NewsResource
 import com.google.samples.apps.nowinandroid.core.network.model.NetworkChangeList
 import com.google.samples.apps.nowinandroid.core.network.model.NetworkNewsResource
+import com.google.samples.apps.nowinandroid.core.testing.notifications.TestNotifier
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.test.TestScope
 import kotlinx.coroutines.test.UnconfinedTestDispatcher
@@ -58,6 +59,8 @@ class OfflineFirstNewsRepositoryTest {
 
     private lateinit var network: TestNiaNetworkDataSource
 
+    private lateinit var notifier: TestNotifier
+
     private lateinit var synchronizer: Synchronizer
 
     @get:Rule
@@ -68,6 +71,7 @@ class OfflineFirstNewsRepositoryTest {
         newsResourceDao = TestNewsResourceDao()
         topicDao = TestTopicDao()
         network = TestNiaNetworkDataSource()
+        notifier = TestNotifier()
         synchronizer = TestSynchronizer(
             NiaPreferencesDataSource(
                 tmpFolder.testUserPreferencesDataStore(testScope),
@@ -78,6 +82,7 @@ class OfflineFirstNewsRepositoryTest {
             newsResourceDao = newsResourceDao,
             topicDao = topicDao,
             network = network,
+            notifier = notifier,
         )
     }
 
@@ -145,6 +150,12 @@ class OfflineFirstNewsRepositoryTest {
                 expected = network.latestChangeListVersion(CollectionType.NewsResources),
                 actual = synchronizer.getChangeListVersions().newsResourceVersion,
             )
+
+            // Notifier should have been called with new news resources
+            assertEquals(
+                expected = newsResourcesFromDb.map(NewsResource::id).sorted(),
+                actual = notifier.addedNewsResources.first().map(NewsResource::id).sorted(),
+            )
         }
 
     @Test
@@ -186,6 +197,13 @@ class OfflineFirstNewsRepositoryTest {
                 expected = network.latestChangeListVersion(CollectionType.NewsResources),
                 actual = synchronizer.getChangeListVersions().newsResourceVersion,
             )
+
+            // Notifier should have been called with news resources from network that are not
+            // deleted
+            assertEquals(
+                expected = (newsResourcesFromNetwork.map(NewsResource::id) - deletedItems).sorted(),
+                actual = notifier.addedNewsResources.first().map(NewsResource::id).sorted(),
+            )
         }
 
     @Test
@@ -225,6 +243,12 @@ class OfflineFirstNewsRepositoryTest {
                 expected = changeList.last().changeListVersion,
                 actual = synchronizer.getChangeListVersions().newsResourceVersion,
             )
+
+            // Notifier should have been called with only added news resources from network
+            assertEquals(
+                expected = newsResourcesFromNetwork.map(NewsResource::id).sorted(),
+                actual = notifier.addedNewsResources.first().map(NewsResource::id).sorted(),
+            )
         }
 
     @Test

core/notifications/.gitignore

@@ -0,0 +1 @@
+/build

core/notifications/build.gradle.kts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2023 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.
+ */
+plugins {
+    id("nowinandroid.android.library")
+    id("nowinandroid.android.library.compose")
+    id("nowinandroid.android.hilt")
+}
+
+android {
+    namespace = "com.google.samples.apps.nowinandroid.core.notifications"
+}
+
+dependencies {
+    implementation(project(":core:model"))
+
+    implementation(libs.kotlinx.coroutines.android)
+    implementation(libs.androidx.compose.runtime)
+    implementation(libs.androidx.core.ktx)
+
+    implementation(platform(libs.firebase.bom))
+    implementation(libs.firebase.cloud.messaging)
+}

core/notifications/src/demo/java/com/google/samples/apps/nowinandroid/core/notifications/NotificationsModule.kt

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2023 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.google.samples.apps.nowinandroid.core.notifications
+
+import dagger.Binds
+import dagger.Module
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+
+@Module
+@InstallIn(SingletonComponent::class)
+abstract class NotificationsModule {
+    @Binds
+    abstract fun bindNotifier(
+        notifier: NoOpNotifier,
+    ): Notifier
+}

core/notifications/src/main/AndroidManifest.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+     Copyright 2023 The Android Open Source Project
+
+     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.
+-->
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"/>

core/notifications/src/main/java/com/google/samples/apps/nowinandroid/core/notifications/AndroidSystemNotifier.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2023 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.google.samples.apps.nowinandroid.core.notifications
+
+import com.google.samples.apps.nowinandroid.core.model.data.NewsResource
+import javax.inject.Inject
+import javax.inject.Singleton
+
+/**
+ * Implementation of [Notifier] that displays notifications in the system tray.
+ */
+@Singleton
+class AndroidSystemNotifier @Inject constructor() : Notifier {
+
+    override fun onNewsAdded(newsResources: List<NewsResource>) {
+        // TODO, create notification and display to the user
+    }
+}

core/notifications/src/main/java/com/google/samples/apps/nowinandroid/core/notifications/NoOpNotifier.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2023 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.google.samples.apps.nowinandroid.core.notifications
+
+import com.google.samples.apps.nowinandroid.core.model.data.NewsResource
+import javax.inject.Inject
+
+/**
+ * Implementation of [Notifier] which does nothing. Useful for tests and previews.
+ */
+class NoOpNotifier @Inject constructor() : Notifier {
+    override fun onNewsAdded(newsResources: List<NewsResource>) = Unit
+}