chore(notifications): add push userAgent headers to analytics calls (#2861)

* chore: add userAgent headers to anayltics calls

* chore: remove print and add update endpoint after settign user

* chore: updated mocks and added analyzer expection rule to ignore version.dart

* chore: pass testDispatcher to request permissions tes android native

* chore: update test name and useragent public

* chore: remove vesion dependency becuase user agent string does not need it

* chore: add comment on why setUser has no userAgent added

* chore: review comments

Author: Samaritan1011001

packages/notifications/push/amplify_push_notifications/android/src/main/kotlin/com/amazonaws/amplify/amplify_push_notifications/AmplifyPushNotificationsPlugin.kt

@@ -29,15 +29,11 @@ private const val TAG = "AmplifyPushNotificationsPlugin"
 
 /** AmplifyPushNotificationsPlugin */
 @InternalAmplifyApi
-open class AmplifyPushNotificationsPlugin : FlutterPlugin, ActivityAware,
+class AmplifyPushNotificationsPlugin(
+    dispatcher: CoroutineDispatcher = Dispatchers.Main
+) : FlutterPlugin, ActivityAware,
     PluginRegistry.NewIntentListener, PushNotificationsHostApi {
     companion object {
-        /**
-         * The scope in which to spawn tasks which should not be awaited from the main thread.
-         */
-        val scope =
-            CoroutineScope(Dispatchers.IO) + CoroutineName("amplify_flutter.PushNotifications")
-
         /**
          * Flutter API interface.
          */
@@ -50,6 +46,11 @@ open class AmplifyPushNotificationsPlugin : FlutterPlugin, ActivityAware,
         var launchNotification: MutableMap<Any, Any?>? = null
     }
 
+    /**
+     * The scope in which to spawn tasks which should not be awaited from the main thread.
+     */
+    private val scope =
+        CoroutineScope(dispatcher) + CoroutineName("amplify_flutter.PushNotifications")
     /**
      * The user's main activity.
      */

packages/notifications/push/amplify_push_notifications/android/src/test/kotlin/com/amazonaws/amplify/amplify_push_notifications/AmplifyPushNotificationsPluginTest.kt

@@ -9,7 +9,6 @@ import androidx.lifecycle.Lifecycle
 import com.amplifyframework.annotations.InternalAmplifyApi
 import com.amplifyframework.notifications.pushnotifications.NotificationContentProvider
 import com.amplifyframework.notifications.pushnotifications.NotificationPayload
-import com.amplifyframework.pushnotifications.pinpoint.permissions.PermissionRequestResult
 import com.amplifyframework.pushnotifications.pinpoint.permissions.PermissionRequestResult.*
 import com.amplifyframework.pushnotifications.pinpoint.permissions.PushNotificationPermission
 import com.google.android.gms.tasks.Task
@@ -22,6 +21,7 @@ import io.flutter.plugin.common.EventChannel
 import io.flutter.plugin.common.EventChannel.EventSink
 import io.mockk.*
 import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.test.StandardTestDispatcher
 import kotlinx.coroutines.test.advanceUntilIdle
 import kotlinx.coroutines.test.runTest
 import org.junit.After
@@ -49,13 +49,13 @@ class AmplifyPushNotificationsPluginTest {
     private val mockActivityBinding = mockk<ActivityPluginBinding>(relaxed = true)
     private val mockResult =
         mockk<PushNotificationsHostApiBindings.Result<PushNotificationsHostApiBindings.GetPermissionStatusResult>>()
+    private val mockFlutterBinding = mockk<FlutterPluginBinding>()
 
     @Before
     fun setUp() {
         context = mockk()
         mockEventSink = mockk()
         val mockedBinaryMessenger = mockk<BinaryMessenger>()
-        val mockFlutterBinding = mockk<FlutterPluginBinding>()
         val mockLifeCycle = mockk<Lifecycle>()
         val mockActivity = mockk<Activity>()
 
@@ -237,10 +237,13 @@ class AmplifyPushNotificationsPluginTest {
 
     @Test
     fun `requests permission`() = runTest {
-        coEvery { anyConstructed<PushNotificationPermission>().requestPermission() } returns PermissionRequestResult.Granted
+        coEvery { anyConstructed<PushNotificationPermission>().requestPermission() } returns Granted
         val mockResult = mockk<PushNotificationsHostApiBindings.Result<Boolean>>()
         every { mockResult.success(any()) } returns mockk()
-        amplifyPushNotificationsPlugin.requestPermissions(mockk(), mockResult)
+        val dispatcher = StandardTestDispatcher(testScheduler)
+        val pluginWithDispatcher  = AmplifyPushNotificationsPlugin(dispatcher)
+        pluginWithDispatcher.onAttachedToEngine(mockFlutterBinding)
+        pluginWithDispatcher.requestPermissions(mockk(), mockResult)
         advanceUntilIdle()
         verify { mockResult.success(true) }
     }
@@ -260,7 +263,10 @@ class AmplifyPushNotificationsPluginTest {
         )
         val mockResult = mockk<PushNotificationsHostApiBindings.Result<Boolean>>()
         every { mockResult.success(any()) } returns mockk()
-        amplifyPushNotificationsPlugin.requestPermissions(mockk(), mockResult)
+        val dispatcher = StandardTestDispatcher(testScheduler)
+        val pluginWithDispatcher  = AmplifyPushNotificationsPlugin(dispatcher)
+        pluginWithDispatcher.onAttachedToEngine(mockFlutterBinding)
+        pluginWithDispatcher.requestPermissions(mockk(), mockResult)
         advanceUntilIdle()
         verify {
             mockResult.success(false)

packages/notifications/push/amplify_push_notifications_pinpoint/lib/src/pinpoint_provider.dart

@@ -38,6 +38,20 @@ class PinpointProvider implements ServiceProviderClient {
       'pinpoint.campaign.treatment_id';
   bool _isInitialized = false;
 
+  /// UserAgent string for Push Notifications made public for testing
+  @visibleForTesting
+  static const userAgent = 'pushnotifications';
+
+  static R _withUserAgent<R>(R Function() fn) {
+    final globalUserAgent =
+        // ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member
+        Amplify.dependencies.getOrCreate<AmplifyUserAgent>();
+    return globalUserAgent.runWith(
+      updates: (ua) => ua.addComponent(userAgent),
+      fn,
+    );
+  }
+
   @override
   Future<void> init({
     required NotificationsPinpointPluginConfig config,
@@ -101,10 +115,15 @@ class PinpointProvider implements ServiceProviderClient {
               'Make sure Pinpoint service provider client is initialized before using this method.',
         );
       }
+
+      // setUser does not have any underlying network calls, hence not running it _withUserAgent
       await _analyticsClient.endpointClient.setUser(
         userId,
         userProfile,
       );
+      await _withUserAgent(
+        () async => _analyticsClient.endpointClient.updateEndpoint(),
+      );
     } on Exception catch (e) {
       throw PushNotificationException(
         'Unable to identify user.',
@@ -135,9 +154,12 @@ class PinpointProvider implements ServiceProviderClient {
       }
 
       final eventInfo = constructEventInfo(notification: notification);
-      await _analyticsClient.eventClient.recordEvent(
-        eventType: '${eventInfo.source}.${eventType.name}',
-        properties: eventInfo.properties,
+
+      await _withUserAgent(
+        () async => _analyticsClient.eventClient.recordEvent(
+          eventType: '${eventInfo.source}.${eventType.name}',
+          properties: eventInfo.properties,
+        ),
       );
     } on Exception catch (e) {
       _logger.error('Unable to record event: $e');
@@ -157,7 +179,9 @@ class PinpointProvider implements ServiceProviderClient {
       final channelType = _getChannelType();
       _analyticsClient.endpointClient.channelType = channelType;
       _analyticsClient.endpointClient.optOut = 'NONE';
-      await _analyticsClient.endpointClient.updateEndpoint();
+      await _withUserAgent(
+        () async => _analyticsClient.endpointClient.updateEndpoint(),
+      );
     } on AWSHttpException catch (e) {
       _logger.error('Network problem when registering device: ', e);
     }

packages/notifications/push/amplify_push_notifications_pinpoint/pubspec.yaml

@@ -24,7 +24,7 @@ dev_dependencies:
   amplify_lints: ^2.0.0
   amplify_test:
     path: ../../../test/amplify_test
-  build_runner: ^2.0.0
+  build_runner: ^2.3.3
   built_value_generator: 8.4.4
   flutter_test:
     sdk: flutter

packages/notifications/push/amplify_push_notifications_pinpoint/test/pinpoint_provider_test.dart

@@ -70,6 +70,45 @@ void main() {
       );
     });
 
+    test('identifyUser should throw exception if the underlying call throws',
+        () async {
+      when(mockAmplifyAuthProviderRepository.getAuthProvider(any))
+          .thenReturn(awsIamAmplifyAuthProvider);
+      when(
+        mockAnalyticsClient.init(
+          pinpointAppId: anyNamed('pinpointAppId'),
+          region: anyNamed('region'),
+          authProvider: anyNamed('authProvider'),
+        ),
+      ).thenAnswer((realInvocation) async {});
+
+      final mockEndpointClient = MockEndpointClient();
+
+      when(
+        mockAnalyticsClient.endpointClient,
+      ).thenReturn(mockEndpointClient);
+
+      await pinpointProvider.init(
+        config: notificationsPinpointConfig,
+        authProviderRepo: mockAmplifyAuthProviderRepository,
+        analyticsClient: mockAnalyticsClient,
+      );
+      when(mockEndpointClient.setUser(any, any)).thenThrow(Exception());
+      expect(
+        pinpointProvider.identifyUser(
+          userId: 'userId',
+          userProfile: MockUserProfile(),
+        ),
+        throwsA(
+          isA<PushNotificationException>().having(
+            (e) => e.message,
+            'Unable to identify user',
+            contains('Unable to identify user.'),
+          ),
+        ),
+      );
+    });
+
     test(
         'constructEventInfo should return journey data when there is journey details in the payload',
         () async {
@@ -135,13 +174,10 @@ void main() {
         mockAnalyticsClient.endpointClient,
       ).thenReturn(mockEndpointClient);
 
-      expect(
-        pinpointProvider.init(
-          config: notificationsPinpointConfig,
-          authProviderRepo: mockAmplifyAuthProviderRepository,
-          analyticsClient: mockAnalyticsClient,
-        ),
-        completes,
+      await pinpointProvider.init(
+        config: notificationsPinpointConfig,
+        authProviderRepo: mockAmplifyAuthProviderRepository,
+        analyticsClient: mockAnalyticsClient,
       );
 
       expect(