[native] feat(notifications): Send 'sync in progress' and 'sync complete' notifications

fixes #1126

Signed-off-by: Marcel Klehr <[email protected]>

Author: marcelklehr

_locales/en/messages.json

@@ -881,5 +881,20 @@
   },
   "LabelFaq":{
     "message": "Check the FAQ"
+  },
+  "StatusSyncingfailed": {
+    "message": "Syncing failed"
+  },
+  "StatusSyncingcomplete": {
+    "message": "Syncing complete"
+  },
+  "NotificationSyncingprofile": {
+    "message": "Syncing profile {0}"
+  },
+  "NotificationSyncingsucceeded": {
+    "message": "Syncing of profile {0} succeeded"
+  },
+  "NotificationSyncingfailed": {
+    "message": "Failed to sync profile {0}"
   }
 }

android/app/capacitor.build.gradle

@@ -14,6 +14,7 @@ dependencies {
     implementation project(':capacitor-browser')
     implementation project(':capacitor-device')
     implementation project(':capacitor-filesystem')
+    implementation project(':capacitor-local-notifications')
     implementation project(':capacitor-network')
     implementation project(':capacitor-preferences')
     implementation project(':capacitor-share')

android/app/src/main/assets/capacitor.plugins.json

@@ -19,6 +19,10 @@
 		"pkg": "@capacitor/filesystem",
 		"classpath": "com.capacitorjs.plugins.filesystem.FilesystemPlugin"
 	},
+	{
+		"pkg": "@capacitor/local-notifications",
+		"classpath": "com.capacitorjs.plugins.localnotifications.LocalNotificationsPlugin"
+	},
 	{
 		"pkg": "@capacitor/network",
 		"classpath": "com.capacitorjs.plugins.network.NetworkPlugin"

android/app/src/main/res/drawable-v26/notification_icon.xml

@@ -0,0 +1,9 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="108dp"
+    android:height="108dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+  <path
+      android:fillColor="#08d"
+      android:pathData="M19.35 10.04C18.67 6.59 15.64 4 12 4 9.11 4 6.6 5.64 5.35 8.04 2.34 8.36 0 10.91 0 14c0 3.31 2.69 6 6 6h13c2.76 0 5-2.24 5-5 0-2.64-2.05-4.78-4.65-4.96zM10 17l-3.5-3.5 1.41-1.41L10 14.17 15.18 9l1.41 1.41L10 17z" />
+</vector>

android/capacitor.settings.gradle

@@ -17,6 +17,9 @@ project(':capacitor-device').projectDir = new File('../node_modules/@capacitor/d
 include ':capacitor-filesystem'
 project(':capacitor-filesystem').projectDir = new File('../node_modules/@capacitor/filesystem/android')
 
+include ':capacitor-local-notifications'
+project(':capacitor-local-notifications').projectDir = new File('../node_modules/@capacitor/local-notifications/android')
+
 include ':capacitor-network'
 project(':capacitor-network').projectDir = new File('../node_modules/@capacitor/network/android')
 

ios/App/App/capacitor.config.json

@@ -31,6 +31,7 @@
 		"CAPBrowserPlugin",
 		"DevicePlugin",
 		"FilesystemPlugin",
+		"LocalNotificationsPlugin",
 		"CAPNetworkPlugin",
 		"PreferencesPlugin",
 		"SharePlugin",

ios/App/Podfile

@@ -16,6 +16,7 @@ def capacitor_pods
   pod 'CapacitorBrowser', :path => '../../node_modules/@capacitor/browser'
   pod 'CapacitorDevice', :path => '../../node_modules/@capacitor/device'
   pod 'CapacitorFilesystem', :path => '../../node_modules/@capacitor/filesystem'
+  pod 'CapacitorLocalNotifications', :path => '../../node_modules/@capacitor/local-notifications'
   pod 'CapacitorNetwork', :path => '../../node_modules/@capacitor/network'
   pod 'CapacitorPreferences', :path => '../../node_modules/@capacitor/preferences'
   pod 'CapacitorShare', :path => '../../node_modules/@capacitor/share'

package-lock.json

@@ -84,6 +84,7 @@
     "@capacitor/device": "7.x",
     "@capacitor/filesystem": "7.x",
     "@capacitor/ios": "7.x",
+    "@capacitor/local-notifications": "^7.0.2",
     "@capacitor/network": "7.x",
     "@capacitor/preferences": "7.x",
     "@capacitor/share": "7.x",

package.json

@@ -5,6 +5,8 @@ import NativeAccountStorage from './NativeAccountStorage'
 import Account from '../Account'
 import { STATUS_ALLGOOD, STATUS_DISABLED, STATUS_ERROR, STATUS_SYNCING } from '../interfaces/Controller'
 import { initSharp } from '../sentry'
+import { LocalNotifications } from '@capacitor/local-notifications'
+import { i18n } from './I18n'
 
 const INACTIVITY_TIMEOUT = 1000 * 7
 const MAX_BACKOFF_INTERVAL = 1000 * 60 * 60 // 1 hour
@@ -196,12 +198,50 @@ export default class NativeController {
     if (account.getData().syncing) {
       return
     }
+    const startTime = Date.now()
     setTimeout(() => this.updateStatus(), 500)
+    let notifications
+    if ((await LocalNotifications.checkPermissions()).display !== 'denied') {
+      ({ notifications } = await LocalNotifications.schedule({
+        notifications: [
+          {
+            id: Math.round((Math.random() * 2 - 1) * 2147483647),
+            title: i18n.getMessage('StatusSyncing'),
+            body: i18n.getMessage('NotificationSyncingprofile', [account.getLabel()]),
+            ongoing: true,
+            smallIcon: 'notification_icon',
+            largeIcon: 'notification_icon',
+          }
+        ]
+      }))
+    }
     try {
       await account.sync(strategy, forceSync)
     } catch (error) {
       console.error(error)
     }
+    if ((await LocalNotifications.checkPermissions()).display !== 'denied') {
+      // Cancel the ongoing notification
+      await LocalNotifications.cancel({ notifications })
+      // eslint-disable-next-line no-constant-condition
+      if (Date.now() - startTime > 60 * 1000) {
+        await LocalNotifications.schedule({
+          notifications: [
+            {
+              id: Math.round((Math.random() * 2 - 1) * 2147483647),
+              title: account.getData().error
+                ? i18n.getMessage('StatusSyncingfailed')
+                : i18n.getMessage('StatusSyncingcomplete'),
+              body: account.getData().error
+                ? i18n.getMessage('NotificationSyncingfailed', [account.getLabel()])
+                : i18n.getMessage('NotificationSyncingsucceeded', [account.getLabel()]),
+              smallIcon: 'notification_icon',
+              largeIcon: 'notification_icon',
+            }
+          ]
+        })
+      }
+    }
     this.updateStatus()
   }
 
@@ -249,6 +289,10 @@ export default class NativeController {
       initSharp()
     }
 
+    if ((await LocalNotifications.checkPermissions()).display !== 'denied') {
+      LocalNotifications.requestPermissions()
+    }
+
     const accounts = await Account.getAllAccounts()
     await Promise.all(
       accounts.map(async acc => {