Add Unifiedpush support #3

p1gp1g · 2024-10-25T16:18:18Z

SDK

The SDK exposes the UnifiedPush dependency directly with a 'api' dependency so it can be used to un/register, select the default distributor etc.

The library exposes the UnifiedPush broadcast receiver by itself and forward events to a (non-exported) service the application must implement. That way, we reduce risk of any breaking change.
For that reason, I've hesitated to rewrite PushMessage, PushEndpoint, and FailedReason, to avoid passing classes defined in connector's library.

Any message that haven't been correctly decrypted is ignored. For information, the connector library doesn't do that by itself for backward compatibility, if the application doesn't use web push correctly.

Client sample

There is a MockApplicationServer that emulate a remote application server. Client<->Server calls are emulated with functions of MockApplicationServer.MockApi.

I have added some horizontal dividers to add some clarity on the UI.

I've added a new section for push messages:
if unregistered: a button to register
if registered: a button to unregister and a button to send a test notification

The application register to the distributor with VAPID enabled, the MockApplicationServer sends the push message with VAPID.

When receiving a push notification, a notification is displayed with the content of the test message.

khvMX · 2024-10-28T16:43:07Z

Hi @p1gp1g. I have questions which I hope you can shed some light on. I'm sorry if I'm asking things which have been clarified already.

This PR would embed UnifiedPush directly in "COVESA SDK", without clear separation of its implementation and dependencies from other future "libraries". Have you considered some modularization approach to avoid mixing this with previous and future changes? I'm also thinking about versioning separate libraries within COVESA SDK separately.
Should we have different sample apps for different libraries?
Is "EventBus" dependency really necessary with current Kotlin and Jetpack state of the art capabilities?

p1gp1g · 2024-10-29T09:59:57Z

Hi @khvMX,

This PR would embed UnifiedPush directly in "COVESA SDK", without clear separation of its implementation and dependencies from other future "libraries". Have you considered some modularization approach to avoid mixing this with previous and future changes? I'm also thinking about versioning separate libraries within COVESA SDK separately.

Indeed, I think there are 2 ways to expose the feature: directly as an api dependency, and the service uses intent with the library classes (https://github.com/COVESA/covesa-aosp-sdk/pull/3/files#diff-dbdd43b7bfea8a29b76c088d80d8d17974ee18ddb299a354f0084cea5f853a49R9-R11) or write new classes that call the library ones. The first solution takes advantage of new features (if any) more easily, the second improves control on the updates.

I asked Maximilian, and he said that one or the other is fine to open the PR, then we can discuss about it.

Let me know if you prefer the 2nd option, it is very fast to do

Should we have different sample apps for different libraries?

Both solution make sense. Having a different sample per feature would probably make it clearer. Let me know if you want to split the sample

Is "EventBus" dependency really necessary with current Kotlin and Jetpack state of the art capabilities?

I've removed it, also it wasn't very clean how the PushUiState was updated, I've fixed that

Remove eventBus dependency

khvMX · 2024-10-29T13:55:16Z

Indeed, I think there are 2 ways to expose the feature: directly as an api dependency, and the service uses intent with the library classes (https://github.com/COVESA/covesa-aosp-sdk/pull/3/files#diff-dbdd43b7bfea8a29b76c088d80d8d17974ee18ddb299a354f0084cea5f853a49R9-R11) or write new classes that call the library ones. The first solution takes advantage of new features (if any) more easily, the second improves control on the updates.

I asked Maximilian, and he said that one or the other is fine to open the PR, then we can discuss about it.

Let me know if you prefer the 2nd option, it is very fast to do

Good point, let's create an issue for that here? It would be great if others would join the discussion. On some of the meetings someone said that "COVESA SDK clients' efforts must be reduced to the absolute minimum", which I support too. Also, reducing API surface would allow for easier under-the-hood changes, albeit for the cost of client flexibility.

khvMX · 2024-10-29T13:58:11Z

3. Should we have different sample apps for different libraries?

Both solution make sense. Having a different sample per feature would probably make it clearer. Let me know if you want to split the sample

Similar to the above, we probably should create another issue for that, simply to come back to this question once we have at least 3 different SDK features to see any commonalities between them.

p1gp1g · 2024-10-31T15:22:41Z

Do you prefer issues or github discussions ? and would you like me to open them?

khvMX · 2024-11-04T16:43:50Z

Do you prefer issues or github discussions ? and would you like me to open them?

Let's move these to (potentially separate) discussions. Could you please create them stating how you have done it for UnifiedPush for now?

As for this PR, it LGTM.

p1gp1g · 2024-11-04T18:38:28Z

Discussions for the 2 subjects:
#4
#5

khvMX

Sorry I did not take time before to properly review.
I have left some comments, which are mostly my concerns.
What is also missing is updating the READMEs to reflect the fact that we now have 2 different kinds of services and 2 quite different examples of APIs for apps to use. I will upload some README changes to this branch, so that we can get it reviewed together.

khvMX · 2024-12-12T12:35:25Z

api/client/src/main/kotlin/global/covesa/sdk/api/client/internal/PushReceiver.kt

+class PushReceiver: MessagingReceiver() {
+
+    override fun onUnregistered(context: Context, instance: String) {
+        CoroutineScope(Dispatchers.IO).launch {


Memory leak? Is this scope ever destroyed? Concerns all methods in this file.

khvMX · 2024-12-12T12:38:12Z

api/client/src/main/kotlin/global/covesa/sdk/api/client/push/LinkActivityHelper.kt

+ *
+ * ```
+ * class MyActivity: Activity() {
+ *     /* ... */


https://kotlinlang.org/docs/kotlin-doc.html#kdoc-syntax
*/ is the end of comment started on line 8. Some parsers may break. Maybe remove this line?

khvMX · 2024-12-12T12:38:18Z

api/client/src/main/kotlin/global/covesa/sdk/api/client/push/LinkActivityHelper.kt

+ *            // An error occurred, consider no distributor found for the moment
+ *         }
+ *     }
+ * /* ... */


khvMX · 2024-12-12T12:44:18Z

api/client/src/main/kotlin/global/covesa/sdk/api/client/push/LinkActivityHelper.kt

+ * }
+ * ```
+ */
+class LinkActivityHelper(activity: Activity) {


We do not have a sample which uses this class. I have found this comment here:

* Be aware that [tryUseDefaultDistributor][org.unifiedpush.android.connector.UnifiedPush.tryUseDefaultDistributor] * starts a new translucent activity in order to get the result of the distributor activity. You may prefer to use * [LinkActivityHelper][org.unifiedpush.android.connector.LinkActivityHelper] directly in your own activity instead.

So which API is recommended? Maybe at least mention this in documentation to this class?

khvMX · 2024-12-12T12:44:43Z

api/client/src/main/kotlin/global/covesa/sdk/api/client/push/PushManager.kt

+/**
+ * Object containing functions to interact with the distributor
+ *
+ * <!-- Note: This must be mirrored in Module.md -->


Which Module.md?

khvMX · 2024-12-12T13:44:40Z

samples/client/src/main/java/global/covesa/sdk/client/push/PushServiceImpl.kt

+     * Update the UI
+     */
+    private fun updateRegistrationState(registered: Boolean) {
+        CoroutineScope(Dispatchers.IO).launch {


again, memory leak?
you probably need scope injected here

khvMX · 2024-12-12T13:46:29Z

samples/client/src/main/java/global/covesa/sdk/client/ui/MainUi.kt

        if (lightsUiState.installedServiceVersion is LightServiceVersion.Installed) {
            LightStates(lightsUiState.lights)
        }
+
+        HorizontalDivider(


On a smaller screen, this content does not fit, maybe make the whole screen scrollable with Scaffold?

khvMX · 2024-12-12T13:47:23Z

samples/client/src/main/java/global/covesa/sdk/client/ui/PushUiState.kt

+data class PushUiState (
+    val registered: Boolean = false
+) {
+    constructor(context: Context) : this(


probably can be injected with a boolean instead, see above

khvMX · 2024-12-12T13:47:49Z

samples/client/src/main/java/global/covesa/sdk/client/MainActivity.kt

@@ -18,6 +23,7 @@ class MainActivity : ComponentActivity() {
        setContent {
            val viewModel: MainViewModel = viewModel {
                MainViewModel(
+                    context = this@MainActivity,


can be avoided (see other comments)

khvMX · 2024-12-12T13:50:49Z

samples/client/src/main/java/global/covesa/sdk/client/MainActivity.kt

+    private fun subscribeActions() {
+        CoroutineScope(Dispatchers.IO).launch {
+            ActionEvent.events.collect {
+                it.handleAction(this@MainActivity)


You are giving a reference to an object (MainActivity) which may be destroyed to a global event queue, which may try to use it when it's already destroyed. We need some common scope for these.

…receiver

p1gp1g · 2024-12-13T13:59:46Z

Thank you @khvMX , most of the comments have been resolved

p1gp1g added 4 commits October 25, 2024 12:32

Add UnifiedPush to client lib

16076ec

Un/register for push notifications

dc70e5f

Emulate application server and register with VAPID

4c310f9

Add test notification

eaa4af1

p1gp1g force-pushed the unifiedpush branch from 10c382c to 7eecbb9 Compare October 29, 2024 10:01

Properly update push state and request actions

77c5bcb

Remove eventBus dependency

p1gp1g force-pushed the unifiedpush branch from 7eecbb9 to 77c5bcb Compare October 29, 2024 10:02

p1gp1g added 3 commits December 3, 2024 17:19

Use wrapper classes for UnifiedPush classes

dc23247

Use bound service

e06e39b

Reorganize client sample, remove EventBus

1c10979

p1gp1g force-pushed the unifiedpush branch 2 times, most recently from 718026a to f6c02d2 Compare December 11, 2024 18:00

Use CovesaServiceClient to connect to PushService

8026ff4

p1gp1g force-pushed the unifiedpush branch from f6c02d2 to 8026ff4 Compare December 12, 2024 08:28

Store static instance of PushService

ee28bac

khvMX suggested changes Dec 12, 2024

View reviewed changes

p1gp1g added 7 commits December 13, 2024 10:48

Remove */ from kdoc

f29c1e7

Remove JvmStatic

967273a

Fix PushManager documentation

0d6bd69

Fix FailedReason doc

27acb96

Rename FakeApplicationService, and highlight its deps

0801863

Remove unused dependency

50e7452

Init PushUiState in Activity

03a5913

p1gp1g added 3 commits December 13, 2024 13:39

Make PushService functions suspend, and cancel corountine context in …

60cc4af

…receiver

Cancel ActionEvent handler when activity is destroyed

705486f

Make the UI scrollable

0a41ab0

Add missing check when registering

0c87044

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Unifiedpush support #3

Add Unifiedpush support #3

p1gp1g commented Oct 25, 2024

khvMX commented Oct 28, 2024

p1gp1g commented Oct 29, 2024

khvMX commented Oct 29, 2024

khvMX commented Oct 29, 2024

p1gp1g commented Oct 31, 2024

khvMX commented Nov 4, 2024

p1gp1g commented Nov 4, 2024

khvMX left a comment

khvMX Dec 12, 2024

khvMX Dec 12, 2024

khvMX Dec 12, 2024

khvMX Dec 12, 2024

khvMX Dec 12, 2024

khvMX Dec 12, 2024

khvMX Dec 12, 2024

khvMX Dec 12, 2024

khvMX Dec 12, 2024

khvMX Dec 12, 2024

p1gp1g commented Dec 13, 2024

Add Unifiedpush support #3

Are you sure you want to change the base?

Add Unifiedpush support #3

Conversation

p1gp1g commented Oct 25, 2024

SDK

Client sample

khvMX commented Oct 28, 2024

p1gp1g commented Oct 29, 2024

khvMX commented Oct 29, 2024

khvMX commented Oct 29, 2024

p1gp1g commented Oct 31, 2024

khvMX commented Nov 4, 2024

p1gp1g commented Nov 4, 2024

khvMX left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

p1gp1g commented Dec 13, 2024