Check TTL notification to Account for App Standby Buckets #1479

Jeasmine · 2021-11-04T16:19:51Z

Description

Details

One-line Summary

Notifications were being shown independent of the TTL due to Android App Standby Buckets

Motivation

App Standby Buckets avoid users being spammed by unused applications. If notification is not set with high priority and the app is marked as not used, the notification will be received by the app, but showed the next time the user opens it, this is not the same as restoring, since they will vibrate and behave as they were just received. Because of that we need to add a TTL check before display logic.

Scope

Notification complete logic now checks if notification is between TTL time.
HMS and GCM tests for TTL have been added

Background context

Affected code checklist

Checklist

Overview

I have filled out all REQUIRED sections above
PR does one thing
- If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
Any Public API changes are explained in the PR details and conform to existing APIs

Testing

I have included test coverage for these changes, or explained why they are not needed
All automated tests pass, or I explained why that is not possible
I have personally tested this on my device, or explained why that is not possible

Final pass

Code is as readable as possible.
- Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
I have reviewed this PR myself, ensuring it meets each checklist item
- WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

This change is

jkasten2

Reviewed 2 of 5 files at r1, 10 of 14 files at r2, 4 of 4 files at r3, all commit messages.
Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @emawby, @Jeasmine, and @nan-li)

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationController.java, line 95 at r3 (raw file):

      if (notification != null) {
         boolean display = isStringNotEmpty(notification.getBody());
         boolean ttl = isNotificationInsideTTL();

ttl doesn't read like a boolean type. Could change name to withinTtl or something else that reflects a bool type?

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationController.java, line 140 at r3 (raw file):

      int ttl;

      if (jsonPayload.has(GOOGLE_TTL_KEY)) {

I would recommending abstracting reading specific keys for HMS vs FCM to be done outside of OSNotificationController class. If there is not clear way to do this maybe we defer doing so though.

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationReceivedEvent.java, line 87 at r3 (raw file):

               processNotification(notification);
            }
         }, COMPLETE_NOTIFICATION_THREAD).start();

This change isn't related to this PR.
Also I believe @nan-li might be changing this line in a PR so best not to change if not needed.

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationWorkManager.java, line 3 at r3 (raw file):

package com.onesignal;

import static com.onesignal.OSUtils.isStringNotEmpty;

Reorder doesn't seem to be related to PR.

OneSignalSDK/unittest/src/test/java/com/onesignal/ShadowBadgeCountUpdater.java, line 46 at r3 (raw file):

   public static void resetStatics() {
      lastCount = 0;

Badge count seems unrelated to this PR.

OneSignalSDK/unittest/src/test/java/com/test/onesignal/GenerateNotificationRunner.java, line 30 at r3 (raw file):

package com.test.onesignal;

import static com.onesignal.OneSignalPackagePrivateHelper.FCMBroadcastReceiver_onReceived_withIntent;

Is this import order we want?
Also this change and these import don't seem to be related to the PR.

* Notifications where being batches and displayed by android standBy * For cases where notification sent time + ttl is more than the current time, don't display notification

Jeasmine

Reviewable status: 13 of 16 files reviewed, 6 unresolved discussions (waiting on @emawby, @jkasten2, and @nan-li)

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationController.java, line 95 at r3 (raw file):