PR Comments

Author: fjnoyp

packages/analytics/amplify_analytics_pinpoint/example/integration_test/auto_session_tracking_test.dart

@@ -26,51 +26,55 @@ void main() {
   IntegrationTestWidgetsFlutterBinding.ensureInitialized();
 
   group('auto session tracking', () {
-    final mockLifecycleObserver = MockLifecycleProvider();
+    final mockLifecycleProvider = MockLifecycleProvider();
 
     late Stream<TestEvent> eventsStream;
 
     setUp(() async {
-      eventsStream = await configureAnalytics(
-        appLifecycleProvider: mockLifecycleObserver,
+      await configureAnalytics(
+        appLifecycleProvider: mockLifecycleProvider,
       );
+      eventsStream = await subscribeToEvents();
     });
 
     testWidgets(
       'manual trigger of onBackground/onForeground triggers session '
       'start/end events ',
       (_) async {
-        mockLifecycleObserver.triggerOnBackgroundListener();
+        mockLifecycleProvider.triggerOnBackgroundListener();
 
         TestSession? sessionStop;
 
         // Verify new session has newer values than old session
         final streamSubscription = eventsStream.listen(
           expectAsync1(
             count: 2,
-            (event) {
+            (event) async {
               if (sessionStop == null) {
                 expect(event.eventType, zSessionStopEventType);
                 sessionStop = event.session;
-                return;
+                mockLifecycleProvider.triggerOnForegroundListener();
+                await Amplify.Analytics.flushEvents();
+              } else {
+                expect(event.eventType, zSessionStartEventType);
+                final sessionStart = event.session;
+                expect(
+                  sessionStop!.sessionId,
+                  isNot(sessionStart.sessionId),
+                );
+                expect(
+                  sessionStart.startTimestamp
+                      .isAfter(sessionStop!.stopTimestamp!),
+                  isTrue,
+                  reason: 'onForeground was called after onBackground',
+                );
               }
-              expect(event.eventType, zSessionStartEventType);
-              final sessionStart = event.session;
-              expect(
-                sessionStop!.sessionId,
-                isNot(sessionStart.sessionId),
-              );
-              expect(
-                sessionStart.startTimestamp
-                    .isAfter(sessionStop!.stopTimestamp!),
-                isTrue,
-                reason: 'onForeground was called after onBackground',
-              );
             },
           ),
         );
         addTearDown(streamSubscription.cancel);
 
+        /*
         await expectLater(
           eventsStream,
           emits(
@@ -82,7 +86,7 @@ void main() {
           ),
         );
 
-        mockLifecycleObserver.triggerOnForegroundListener();
+        mockLifecycleProvider.triggerOnForegroundListener();
 
         await Amplify.Analytics.flushEvents();
 
@@ -96,6 +100,8 @@ void main() {
             ),
           ),
         );
+
+         */
       },
       timeout: const Timeout(Duration(minutes: 3)),
     );

packages/analytics/amplify_analytics_pinpoint/example/integration_test/enable_disable_test.dart

@@ -25,14 +25,15 @@ void main() {
   IntegrationTestWidgetsFlutterBinding.ensureInitialized();
 
   group('enable/disable', () {
-    final mockLifecycleObserver = MockLifecycleProvider();
+    final mockLifecycleProvider = MockLifecycleProvider();
 
     late Stream<TestEvent> eventsStream;
 
     setUp(() async {
-      eventsStream = await configureAnalytics(
-        appLifecycleProvider: mockLifecycleObserver,
+      await configureAnalytics(
+        appLifecycleProvider: mockLifecycleProvider,
       );
+      eventsStream = await subscribeToEvents();
     });
 
     testWidgets(
@@ -51,8 +52,9 @@ void main() {
 
         await Amplify.Analytics.recordEvent(event: customEvent);
 
-        mockLifecycleObserver.triggerOnBackgroundListener();
-        mockLifecycleObserver.triggerOnForegroundListener();
+        // Ensure app background/foreground does not auto send event
+        mockLifecycleProvider.triggerOnBackgroundListener();
+        mockLifecycleProvider.triggerOnForegroundListener();
 
         // Give time for events to propagate if they were sent to remote server
         // to ensure the failure is not triggered

packages/analytics/amplify_analytics_pinpoint/example/integration_test/events_test.dart

@@ -28,7 +28,8 @@ void main() {
     late Stream<TestEvent> eventsStream;
 
     setUp(() async {
-      eventsStream = await configureAnalytics();
+      await configureAnalytics();
+      eventsStream = await subscribeToEvents();
     });
 
     testWidgets(

packages/analytics/amplify_analytics_pinpoint/example/integration_test/identify_user_test.dart

@@ -30,7 +30,8 @@ void main() {
     late Stream<TestEvent> eventsStream;
 
     setUpAll(() async {
-      eventsStream = await configureAnalytics();
+      await configureAnalytics();
+      eventsStream = await subscribeToEvents();
     });
 
     testWidgets(

packages/analytics/amplify_analytics_pinpoint/example/integration_test/utils/mock_key_value_store.dart

@@ -21,14 +21,14 @@ import 'package:amplify_flutter/amplify_flutter.dart';
 ///
 /// Should be static to mimic the behavior of iOS/Android which persist keys
 /// between relaunches (e.g. between test groups).
-final SecureStorageInterface mockKeyValueStore = _MockKeyValueStore()
+final SecureStorageInterface mockEndpointInfoStore = _MockEndpointInfoStore()
   ..write(
     key: AmplifyAnalyticsPinpointDart.endpointIdStorageKey,
     value: mockEndpointId,
   );
 final String mockEndpointId = uuid();
 
-class _MockKeyValueStore extends SecureStorageInterface {
+class _MockEndpointInfoStore extends SecureStorageInterface {
   final _storage = <String, String>{};
 
   @override

packages/analytics/amplify_analytics_pinpoint/example/integration_test/utils/setup_utils.dart

@@ -27,7 +27,7 @@ import 'package:flutter_test/flutter_test.dart';
 import 'mock_key_value_store.dart';
 import 'test_event.dart';
 
-Future<Stream<TestEvent>> configureAnalytics({
+Future<void> configureAnalytics({
   AppLifecycleProvider? appLifecycleProvider,
 }) async {
   await Amplify.addPlugins([
@@ -41,7 +41,7 @@ Future<Stream<TestEvent>> configureAnalytics({
     ),
     AmplifyAnalyticsPinpoint(
       appLifecycleProvider: appLifecycleProvider,
-      keyValueStore: mockKeyValueStore,
+      endpointInfoStore: mockEndpointInfoStore,
     ),
     AmplifyAPI(),
   ]);
@@ -57,7 +57,9 @@ Future<Stream<TestEvent>> configureAnalytics({
     }
     await Amplify.reset();
   });
+}
 
+Future<Stream<TestEvent>> subscribeToEvents() async {
   final subscriptionEstablished = Completer<void>.sync();
 
   final eventsStream = Amplify.API

packages/analytics/amplify_analytics_pinpoint/lib/src/analytics_plugin_impl.dart

@@ -25,7 +25,7 @@ import 'package:meta/meta.dart';
 class AmplifyAnalyticsPinpoint extends AmplifyAnalyticsPinpointDart {
   /// {@macro amplify_analytics_pinpoint.analytics_plugin_impl}
   AmplifyAnalyticsPinpoint({
-    @visibleForTesting super.keyValueStore,
+    @visibleForTesting super.endpointInfoStore,
     @visibleForTesting CachedEventsPathProvider? pathProvider,
     @visibleForTesting AppLifecycleProvider? appLifecycleProvider,
     @visibleForTesting DeviceContextInfoProvider? deviceContextInfoProvider,

packages/analytics/amplify_analytics_pinpoint_dart/lib/src/analytics_plugin_impl.dart

@@ -48,12 +48,12 @@ const zSessionStopEventType = '_session.stop';
 class AmplifyAnalyticsPinpointDart extends AnalyticsPluginInterface {
   /// {@macro amplify_analytics_pinpoint_dart.amplify_analytics_pinpoint_dart}
   AmplifyAnalyticsPinpointDart({
-    SecureStorageInterface? keyValueStore,
+    SecureStorageInterface? endpointInfoStore,
     CachedEventsPathProvider? pathProvider,
     AppLifecycleProvider? appLifecycleProvider,
     DeviceContextInfoProvider? deviceContextInfoProvider,
     required Connect dbConnectFunction,
-  })  : _keyValueStore = keyValueStore ??
+  })  : _endpointInfoStore = endpointInfoStore ??
             AmplifySecureStorageWorker(
               config: AmplifySecureStorageConfig(
                 scope: 'analyticsPinpoint',
@@ -77,9 +77,8 @@ class AmplifyAnalyticsPinpointDart extends AnalyticsPluginInterface {
   var _isConfigured = false;
   var _analyticsEnabled = false;
 
-  @visibleForTesting
-
   /// Storage key for the static Pinpoint endpoint id
+  @visibleForTesting
   static const String endpointIdStorageKey = 'UniqueId';
   static const String _endpointGlobalAttrsKey = 'EndpointGlobalAttributesKey';
   static const String _endpointGlobalMetricsKey = 'EndpointGlobalMetricsKey';
@@ -94,7 +93,7 @@ class AmplifyAnalyticsPinpointDart extends AnalyticsPluginInterface {
   late final EventStorageAdapter _eventStorageAdapter;
   late final StoppableTimer _autoEventSubmitter;
 
-  final SecureStorageInterface _keyValueStore;
+  final SecureStorageInterface _endpointInfoStore;
 
   /// External Flutter Provider implementations
   final CachedEventsPathProvider? _pathProvider;
@@ -151,10 +150,10 @@ class AmplifyAnalyticsPinpointDart extends AnalyticsPluginInterface {
 
     // Retrieve Unique ID
     final savedFixedEndpointId =
-        await _keyValueStore.read(key: endpointIdStorageKey);
+        await _endpointInfoStore.read(key: endpointIdStorageKey);
     final fixedEndpointId = savedFixedEndpointId ?? const Uuid().v1();
     if (savedFixedEndpointId == null) {
-      await _keyValueStore.write(
+      await _endpointInfoStore.write(
         key: endpointIdStorageKey,
         value: fixedEndpointId,
       );
@@ -179,22 +178,22 @@ class AmplifyAnalyticsPinpointDart extends AnalyticsPluginInterface {
 
     /// Retrieve stored GlobalAttributes
     final cachedAttributes =
-        await _keyValueStore.read(key: _endpointGlobalAttrsKey);
+        await _endpointInfoStore.read(key: _endpointGlobalAttrsKey);
     final globalAttributes = cachedAttributes == null
         ? <String, String>{}
         : (jsonDecode(cachedAttributes) as Map<String, Object?>)
             .cast<String, String>();
 
     /// Retrieve stored GlobalMetrics
     final cachedMetrics =
-        await _keyValueStore.read(key: _endpointGlobalMetricsKey);
+        await _endpointInfoStore.read(key: _endpointGlobalMetricsKey);
     final globalMetrics = cachedMetrics == null
         ? <String, double>{}
         : (jsonDecode(cachedMetrics) as Map<String, Object?>)
             .cast<String, double>();
 
     _endpointGlobalFieldsManager = EndpointGlobalFieldsManager(
-      _keyValueStore,
+      _endpointInfoStore,
       globalAttributes,
       globalMetrics,
     );

packages/analytics/amplify_analytics_pinpoint_dart/lib/src/impl/analytics_client/endpoint_client/endpoint_global_fields_manager.dart

@@ -29,12 +29,12 @@ import 'package:amplify_secure_storage_dart/amplify_secure_storage_dart.dart';
 class EndpointGlobalFieldsManager {
   /// {@macro amplify_analytics_pinpoint_dart.endpoint_global_fields_manager}
   EndpointGlobalFieldsManager(
-    this._keyValueStore,
+    this._endpointInfoStore,
     this._globalAttributes,
     this._globalMetrics,
   );
 
-  final SecureStorageInterface _keyValueStore;
+  final SecureStorageInterface _endpointInfoStore;
   final Map<String, String> _globalAttributes;
   final Map<String, double> _globalMetrics;
 
@@ -118,7 +118,7 @@ class EndpointGlobalFieldsManager {
   }
 
   Future<void> _saveAttributes() async {
-    await _keyValueStore.write(
+    await _endpointInfoStore.write(
       key: _endpointGlobalAttrsKey,
       value: jsonEncode(_globalAttributes),
     );
@@ -154,7 +154,7 @@ class EndpointGlobalFieldsManager {
   }
 
   Future<void> _saveMetrics() async {
-    await _keyValueStore.write(
+    await _endpointInfoStore.write(
       key: _endpointGlobalMetricsKey,
       value: jsonEncode(_globalMetrics),
     );