Merge branch 'cybex-dev:master' into fix-call-direction-when-ringing

Author: agent515

.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "twilio-voice-web"
+  }
+}

.github/workflows/flutter.yml

@@ -3,7 +3,7 @@
 # separate terms of service, privacy policy, and support
 # documentation.
 
-name: Flutter Analyze & Test (main)
+name: Flutter analyze, test & deploy example web app
 
 on:
   push:
@@ -24,7 +24,7 @@ jobs:
       - name: Install Flutter
         uses: subosito/flutter-action@v2
         with:
-          flutter-version: '3.7.11'
+          flutter-version: '3.10.6'
           channel: 'stable'
           cache: true
 
@@ -37,4 +37,41 @@ jobs:
         run: flutter analyze
 
       - name: Run tests
-        run: flutter test --coverage
+        run: flutter test --coverage
+
+  deploy-example-web:
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Flutter build environment
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: '3.10.6'
+          channel: 'stable'
+          cache: true
+
+      - run: flutter --version
+      - run: flutter pub get
+      - run: flutter config --enable-web
+      - run: cd ./example; flutter build web --release --target=lib/main.dart --output=build/web
+
+      - name: Update service worker
+        run: cat ./example/service-worker/twilio-sw.js >> ./example/build/web/flutter_service_worker.js
+
+      - name: Archive Production Artifact
+        uses: actions/upload-artifact@master
+        with:
+          name: web-build
+          path: example/build/web
+
+      - name: Firebase Deploy
+        uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_TWILIO_VOICE_WEB }}'
+          channelId: live
+          projectId: twilio-voice-web
+

.gitignore

@@ -45,3 +45,7 @@ build/
 
 # Lock files
 *.lock
+
+*.log
+
+.firebase/

CHANGELOG.md

@@ -1,13 +1,19 @@
 ## Next release
+
+* Fix: [Web] Multiple missed call notifications
+* Fix: [Android] `openPhoneAccountsSettings` not always opening on various Android (mainly Samsung) devices
+
+## 0.1.0
+
 * Feat: [Android] Turn off the screen when a call is active and the head is against the handset. @solid-software (https://solid.software)
 * Feat: [macOS] Added support for macOS, based on iOS implementation backed by Twilio Voice Web  (twilio-voice.js [v2.4.1-dev-custom](https://github.com/cybex-dev/twilio-voice.js/tree/2.4.1-dev-custom)).
 * Feat: [Web] Web support with notifications (via Service Worker) with live example at https://twilio-voice-web.web.app @cybex-dev
-* Feat: [Android, iOS] Add handset call status: `isMuted()`, `isOnSpeaker()` and `isHolding()` @cybex-dev
+* Feat: [Android, iOS, web] Add handset call status: `isMuted()`, `isOnSpeaker()` and `isHolding()` @cybex-dev
 * Refactor: Hold call signature changed to `holdCall({bool shouldHold = true})` @cybex-dev
 * Feat: [iOS] Add support for changing callkit icon (future plans to extended this for Flutter assets) @cybex-dev
 * [twilio_voice_mimp:0.2.5) fix 4 Null Pointer execption Android
 * [twilio_voice_mimp:0.2.4) add Android DE Local
-* [twilio_voice_mimp:0.2.4) add Android IT Local 
+* [twilio_voice_mimp:0.2.4) add Android IT Local
 * [twilio_voice_mimp:0.2.3) Upgrade to Twilio Android SDK 6.1.2 / iOS SDK 6.4.2
 * [twilio_voice_mimp:0.2.3) small Bugfix for null pointer Exception
 * [twilio_voice_mimp:0.2.2) more Magic is needed with FLAG_MUTABLE (Android 12)
@@ -34,29 +40,44 @@
 * Feat: [Android] Add CallingAccount (Phone Account) label & description via `strings.xml`. @cybex-dev
 * Feat: [Android] Add Calling Account (Phone Account) icon (using current app icon via `getApplicationInfo().getIcon()`). @cybex-dev
 * Fix: request Permissions return result via Flutter future.
+* Fix: [Android] Missing platform method channel for `getSid()`
+* Fix: [Android] Inconsistent caller/recipient names for inbound calls between ringing & connected states.
+* Fix: [Android] Incorrect call direction for incoming calls
+* Fix: call ringing event always showing `CallDirection.outgoing`
+* Fix: [Android] Updated CallKit incoming/outgoing name parameter resolution
+* Fix: [Web] Notification actions working intermittently.
+* Fix: [Web] Added suggested service worker integration with CI/CD unifying with `flutter_service_worker.js`, see [here](https://firebase.flutter.dev/docs/messaging/usage/#background-messages) for more info regarding service worker limitations.
+* Update: [Web] Remove additional service-worker files
 
 ## 0.0.9
+
 * Feat: forwarded callInvite custom parameters to flutter
 
 ## 0.0.8
+
 * Renamed callkit logo
 * Merge-Android: Fixed null pointer exception for eventSink occurs in mute call. @GKPK
 
 ## 0.0.7
+
 * Fixed from param on android
 
 ## 0.0.6
+
 * Added android extra call params
 
 ## 0.0.5
+
 * Updated Twilio SDK versions
 * Added example proguard-rules.pro for android
 
 ## 0.0.4
+
 * Fixes deprecation error with Xcode 12.5
 * removed "client" from ids
 
 ## 0.0.3
+
 * Added missed call notifications
 * Updated Android SDK
 * Added localization files

README.md

@@ -163,49 +163,72 @@ See [example](https://github.com/cybex-dev/twilio_voice/blob/master/example/andr
 
 ### Web Setup:
 
-There are 2 important files for Twilio incoming/missed call notifications to work:
+There are 4 important files for Twilio incoming/missed call notifications to work:
 
 - `notifications.js` is the main file, it handles the notifications and the service worker.
-- `twilio-sw.js` is the service worker, it is used to handle the incoming calls.
+- `twilio-sw.js` is the service worker _content_ used to work with the default `flutter_service_worker.js` (this can be found in `build/web/flutter_service_worker.js` after calling `flutter build web`). This file's contents are to be copied into the `flutter_service_worker.js` file after you've built your application.
 
 Also, the twilio javascript SDK itself, `twilio.min.js` is needed.
 
-To ensure proper/as intended setup:
+### To ensure proper/as intended setup:
 
-1. Get all 3 files (`notifications.js`, `twilio.min.js` and `twilio-sw.js`) from `example/web` folder
-2. Copy all 3 into your own project,
-3. (optional) Review & change the `notifications.js`, `twilio-sw.js) files to match your needs.
+1. Copy files `example/web/notifications.js` and `example/web/twilio.min.js` into your application's `web` folder.
+2. This step should be done AFTER you've built your application, every time the `flutter_service_worker.js` changes (this includes hot reloads on your local machine unfortunately)
+   1. Copy the contents of `example/web/twilio-sw.js` into your `build/web/flutter_service_worker.js` file, **at the end of the file**. See [service-worker](#service-worker) for more information.
+
+Note, these files can be changed to suite your needs - however the core functionality should remain the same: responding to `notificationclick`, `notificationclose`, `message` events and associated sub-functions.
 
 Finally, add the following code to your `index.html` file, **at the end of body tag**:
 
 ```html
     <body>
+        <!--Start Twilio Voice impl-->
         <!--twilio native js library-->
         <script type="text/javascript" src="./twilio.min.js"></script>
-        <!--twilio native js library-->
-        <script type="text/javascript" src="./notifications.js"></script>
+        <!--End Twilio Voice impl-->
 
         <script>
-        if ('serviceWorker' in navigator) {
-            window.addEventListener('load', async () => {
-                await navigator.serviceWorker.register('twilio-sw.js').then(value => {
-                    console.log('Twilio Voice Service worker registered successfully.');
-                }).catch((error) => {
-                    console.warn('Error registering Twilio Service Worker: ' + error.message + '. This prevents notifications from working natively');
-                });
-            });
-        }
-        </script>
+            window.addEventListener('load', function(ev) {
+              // Download main.dart.js
+              ...          
     </body>
 ```
 
 #### Web Considerations
 
-Notice should be given to using `firebase-messaging-sw.js` in addition to `twilio-sw.js` since these may cause conflict in service worker events being handled.
-
 _If you need to debug the service worker, open up Chrome Devtools, go to Application tab, and select Service Workers from the left menu. There you can see the service workers and their status.
 To review service worker `notificationclick`, `notificationclose`, `message`, etc events - do this using Chrome Devtools (Sources tab, left panel below 'site code' the service workers are listed)_
 
+##### Service Worker
+
+Unifying the service worker(s) is best done via post-compilation tools or a CI/CD pipeline (suggested).
+
+A snippet of the suggested service worker integration is as follows:
+
+```yaml
+#...
+- run: cd ./example; flutter build web --release --target=lib/main.dart --output=build/web
+
+- name: Update service worker
+  run: cat ./example/web/twilio-sw.js >> ./example/build/web/flutter_service_worker.js
+#...
+```
+
+A complete example could be found in the github workflows `.github/workflows/flutter.yml` file, see [here](https://github.com/cybex-dev/twilio_voice/blob/master/.github/workflows/flutter.yml). 
+
+##### Web Notifications
+
+2 types of notifications are shown:
+ - Incoming call notifications with 2 buttons: `Answer` and `Reject`,
+ - Missed call notifications with 1 button: `Call back`.
+
+Notifications are presented as **alerts**. These notifications may not always been shown, check:
+ - if the browser supports notifications,
+ - if the user has granted permissions to show notifications,
+ - if the notifications display method / notifications is enabled by the system (e.g. macOS notifications are disabled, or Windows notifications are disabled, etc).
+ - if there are already notifications shown (https://stackoverflow.com/a/36383155/4628115)
+ - if system is in 'Do Not Disturb' or 'Focus' mode.
+
 ### MacOS Setup:
 
 The plugin is essentially a [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview)
@@ -332,12 +355,23 @@ Caller is usually referred to as `call.from` or `callInvite.from`. This can eith
 
 The following rules are applied to determine the caller/recipient name, which is shown in the call screen and heads-up notification:
 
-- If the caller is empty/not provided, the default caller name is shown e.g. "Unknown Caller", else
-- if the caller is a number, the plugin will show the number as is, else
-- if the caller is a string, the plugin will interpret the string as follows:
-  - if the `__TWI_CALLER_NAME` parameter is provided, the plugin will show the value of `__TWI_CALLER_NAME` as is, else
-  - if the `__TWI_CALLER_ID` parameter is provided, the plugin will search for a registered client with the same id and show the client name, else
-  - if not found or not provided, the plugin will search for a registered client with the `call.from` value and show the client name, as a last resort
+##### Incoming Calls:
+
+`__TWI_CALLER_NAME` -> `resolve(__TWI_CALLER_ID)` -> (phone number) -> `registered client (from)` -> `defaultCaller name` -> `"Unknown Caller"`
+
+
+##### Outgoing Calls:
+
+`__TWI_RECIPIENT_NAME` -> `resolve(__TWI_RECIPIENT_ID)` -> (phone number) -> `registered client (to)` -> `defaultCaller name` -> `"Unknown Caller"`
+
+**Details explaination:**
+
+- if the call is an CallInvite (incoming), the plugin will interpret the string as follows or if the call is outgoing, the twilio `To` parameter field is used to:
+  - if the `__TWI_CALLER_NAME` (or `__TWI_RECIPIENT_NAME`) parameter is provided, the plugin will show the value of `__TWI_CALLER_NAME` (or `__TWI_RECIPIENT_NAME`) as is, else
+  - if the `__TWI_CALLER_ID` (or `__TWI_RECIPIENT_ID`) parameter is provided, the plugin will search for a registered client with the same id and show the client name,
+- if the caller (`from` or `to` fields) is empty/not provided, the default caller name is shown e.g. "Unknown Caller", else
+- else if the caller (`from` or `to` fields) is a number, the plugin will show the number as is, else
+- else the plugin will search for a registered client with the `callInvite.from` (or call.to) value and show the client name, as a last resort
   - the default caller name is shown e.g. "Unknown Caller"
 
 *Please note: the same approach applies to both caller and recipient name resolution.*

android/src/main/kotlin/com/twilio/twilio_voice/TwilioVoicePlugin.kt

@@ -100,7 +100,8 @@ class TwilioVoicePlugin : FlutterPlugin, MethodCallHandler, EventChannel.StreamH
     private var isBluetoothOn: Boolean = false
     private var isMuted: Boolean = false
     private var isHolding: Boolean = false
-    private var callSid: String? = null
+    private val callSid: String?
+        get() = TVConnectionService.getActiveCallHandle()
 
     private var hasStarted = false
 
@@ -1542,7 +1543,6 @@ class TwilioVoicePlugin : FlutterPlugin, MethodCallHandler, EventChannel.StreamH
             }
 
             TVBroadcastReceiver.ACTION_ACTIVE_CALL_CHANGED -> {
-                callSid = intent.getStringExtra(TVBroadcastReceiver.EXTRA_CALL_HANDLE)
                 Log.d(TAG, "handleBroadcastIntent: Active call changed to $callSid")
             }
 
@@ -1572,7 +1572,7 @@ class TwilioVoicePlugin : FlutterPlugin, MethodCallHandler, EventChannel.StreamH
                         put(key, value)
                     }
                 }.toString()
-                callSid = callHandle
+//                callSid = callHandle
                 logEvents("", arrayOf("Incoming", from, to, CallDirection.INCOMING.label, params))
                 logEvents("", arrayOf("Ringing", from, to, CallDirection.INCOMING.label, params))
             }
@@ -1586,7 +1586,7 @@ class TwilioVoicePlugin : FlutterPlugin, MethodCallHandler, EventChannel.StreamH
                         )
                         return
                     }
-                callSid = null
+//                callSid = null
                 Log.d(TAG, "handleBroadcastIntent: Call ended $callHandle")
                 logEvent("", "Call ended")
             }
@@ -1639,7 +1639,7 @@ class TwilioVoicePlugin : FlutterPlugin, MethodCallHandler, EventChannel.StreamH
                         put(key, value)
                     }
                 }.toString()
-                callSid = callHandle
+//                callSid = callHandle
                 logEvents("", arrayOf("Answer", from, to, params))
             }
 
@@ -1697,7 +1697,7 @@ class TwilioVoicePlugin : FlutterPlugin, MethodCallHandler, EventChannel.StreamH
                 val direction = intent.getIntExtra(TVBroadcastReceiver.EXTRA_CALL_DIRECTION, -1)
                 val callDirection = CallDirection.fromId(direction).toString()
 
-                callSid = callHandle
+//                callSid = callHandle
                 logEvents("", arrayOf("Ringing", from, to, callDirection))
             }
 
@@ -1726,8 +1726,8 @@ class TwilioVoicePlugin : FlutterPlugin, MethodCallHandler, EventChannel.StreamH
                     return
                 }
                 val direction = intent.getIntExtra(TVBroadcastReceiver.EXTRA_CALL_DIRECTION, -1)
-                val callDirection = CallDirection.fromId(direction).toString()
-                callSid = callHandle
+                val callDirection = CallDirection.fromId(direction)!!.label
+//                callSid = callHandle
                 logEvents("", arrayOf("Connected", from, to, callDirection))
             }