Use static method for fake instance (#262)

* Swap `Analytics.test` for `Analytics.fake`

* Remove default constructor for `FakeAnalytics`

Author: eliasyishak

pkgs/unified_analytics/CHANGELOG.md

@@ -6,6 +6,8 @@
 - Exposing new method for `FakeAnalytics.sendPendingErrorEvents` to send error events on command
 - Added `Event.fromJson` static method to generate instance of `Event` from JSON
 - Remove unused parameters `measurementId` and `apiSecret` from the `Analytics.test` constructor
+- Remove `Analytics.test` factory constructor in favor of `Analytics.fake` static method to return a `FakeAnalytics` instance
+- Remove `FakeAnalytics` default constructor in favor of `Analytics.fake`
 
 ## 5.8.8
 

pkgs/unified_analytics/example/serving_surveys.dart

@@ -14,7 +14,7 @@ import 'package:unified_analytics/unified_analytics.dart';
 
 /// This example code is intended to only be used as guidance for
 /// clients using this package. Clients using this package should avoid
-/// the use of the [Analytics.test] constructor.
+/// the use of the [Analytics.fake] static method.
 ///
 /// It was used in this example file so that the real [FileSystem] was swapped
 /// out for a [MemoryFileSystem] so that repeated runs of this script yield
@@ -36,7 +36,7 @@ void main() async {
     // send events after its first run; this instance won't be used below
     //
     // ignore: invalid_use_of_visible_for_testing_member
-    final initialAnalytics = Analytics.test(
+    final initialAnalytics = Analytics.fake(
       tool: DashTool.flutterTool,
       homeDirectory: home,
       dartVersion: 'dartVersion',
@@ -47,7 +47,7 @@ void main() async {
     initialAnalytics.clientShowedMessage();
 
     // ignore: invalid_use_of_visible_for_testing_member
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
         tool: DashTool.flutterTool,
         homeDirectory: home,
         dartVersion: 'dartVersion',

pkgs/unified_analytics/lib/src/analytics.dart

@@ -184,51 +184,6 @@ abstract class Analytics {
     );
   }
 
-  /// Factory constructor to return the [AnalyticsImpl] class with a
-  /// [MemoryFileSystem] to use for testing.
-  @visibleForTesting
-  factory Analytics.test({
-    required DashTool tool,
-    required Directory homeDirectory,
-    required String dartVersion,
-    required FileSystem fs,
-    required DevicePlatform platform,
-    String? flutterChannel,
-    String? flutterVersion,
-    String? clientIde,
-    String? enabledFeatures,
-    SurveyHandler? surveyHandler,
-    GAClient? gaClient,
-    int toolsMessageVersion = kToolsMessageVersion,
-    String toolsMessage = kToolsMessage,
-  }) {
-    final firstRun = runInitialization(homeDirectory: homeDirectory, fs: fs);
-
-    return FakeAnalytics(
-      tool: tool,
-      homeDirectory: homeDirectory,
-      flutterChannel: flutterChannel,
-      toolsMessageVersion: toolsMessageVersion,
-      flutterVersion: flutterVersion,
-      dartVersion: dartVersion,
-      platform: platform,
-      fs: fs,
-      surveyHandler: surveyHandler ??
-          FakeSurveyHandler.fromList(
-            dismissedSurveyFile: fs.file(p.join(
-              homeDirectory.path,
-              kDartToolDirectoryName,
-              kDismissedSurveyFileName,
-            )),
-            initializedSurveys: [],
-          ),
-      gaClient: gaClient ?? const FakeGAClient(),
-      clientIde: clientIde,
-      enabledFeatures: enabledFeatures,
-      firstRun: firstRun,
-    );
-  }
-
   /// The shared identifier for Flutter and Dart related tooling using
   /// package:unified_analytics.
   String get clientId;
@@ -333,6 +288,53 @@ abstract class Analytics {
   ///
   /// The snooze period is defined by the [Survey.snoozeForMinutes] field.
   void surveyShown(Survey survey);
+
+  /// Returns an instance of [FakeAnalytics] which can be used in tests to check
+  /// for certain [Event] instances within [FakeAnalytics.sentEvents].
+  @visibleForTesting
+  static FakeAnalytics fake({
+    required DashTool tool,
+    required Directory homeDirectory,
+    required String dartVersion,
+    required MemoryFileSystem fs,
+    String? flutterChannel,
+    String? flutterVersion,
+    String? clientIde,
+    String? enabledFeatures,
+    SurveyHandler? surveyHandler,
+    GAClient? gaClient,
+    DevicePlatform platform = DevicePlatform.linux,
+    int toolsMessageVersion = kToolsMessageVersion,
+    String toolsMessage = kToolsMessage,
+    bool enableAsserts = true,
+  }) {
+    final firstRun = runInitialization(homeDirectory: homeDirectory, fs: fs);
+
+    return FakeAnalytics._(
+      tool: tool,
+      homeDirectory: homeDirectory,
+      flutterChannel: flutterChannel,
+      toolsMessageVersion: toolsMessageVersion,
+      flutterVersion: flutterVersion,
+      dartVersion: dartVersion,
+      platform: platform,
+      fs: fs,
+      surveyHandler: surveyHandler ??
+          FakeSurveyHandler.fromList(
+            dismissedSurveyFile: fs.file(p.join(
+              homeDirectory.path,
+              kDartToolDirectoryName,
+              kDismissedSurveyFileName,
+            )),
+            initializedSurveys: [],
+          ),
+      gaClient: gaClient ?? const FakeGAClient(),
+      clientIde: clientIde,
+      enabledFeatures: enabledFeatures,
+      firstRun: firstRun,
+      enableAsserts: enableAsserts,
+    );
+  }
 }
 
 class AnalyticsImpl implements Analytics {
@@ -763,7 +765,7 @@ class FakeAnalytics extends AnalyticsImpl {
   final List<Event> sentEvents = [];
 
   /// Class to use when you want to see which events were sent
-  FakeAnalytics({
+  FakeAnalytics._({
     required super.tool,
     required super.homeDirectory,
     required super.dartVersion,

pkgs/unified_analytics/test/error_handler_test.dart

@@ -13,7 +13,7 @@ import 'package:unified_analytics/src/enums.dart';
 import 'package:unified_analytics/unified_analytics.dart';
 
 void main() {
-  late FileSystem fs;
+  late MemoryFileSystem fs;
   late Directory home;
   late FakeAnalytics initializationAnalytics;
   late FakeAnalytics analytics;
@@ -41,7 +41,7 @@ void main() {
 
     // This is the first analytics instance that will be used to demonstrate
     // that events will not be sent with the first run of analytics
-    initializationAnalytics = Analytics.test(
+    initializationAnalytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -51,7 +51,7 @@ void main() {
       dartVersion: dartVersion,
       fs: fs,
       platform: platform,
-    ) as FakeAnalytics;
+    );
     expect(initializationAnalytics.shouldShowMessage, true);
     initializationAnalytics.clientShowedMessage();
     expect(initializationAnalytics.shouldShowMessage, false);
@@ -61,7 +61,7 @@ void main() {
     //
     // This instance should have the same parameters as the one above for
     // [initializationAnalytics]
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -72,7 +72,7 @@ void main() {
       fs: fs,
       platform: platform,
       clientIde: clientIde,
-    ) as FakeAnalytics;
+    );
     analytics.clientShowedMessage();
 
     // The files that should have been generated that will be used for tests
@@ -93,7 +93,7 @@ void main() {
       expect(analytics.telemetryEnabled, false);
       expect(sessionFile.readAsStringSync(), isEmpty);
 
-      final secondAnalytics = Analytics.test(
+      final secondAnalytics = Analytics.fake(
         tool: initialTool,
         homeDirectory: home,
         flutterChannel: flutterChannel,
@@ -104,7 +104,7 @@ void main() {
         fs: fs,
         platform: platform,
         clientIde: clientIde,
-      ) as FakeAnalytics;
+      );
       expect(sessionFile.readAsStringSync(), isEmpty);
       expect(secondAnalytics.telemetryEnabled, false);
 

pkgs/unified_analytics/test/events_with_fake_test.dart

@@ -18,7 +18,7 @@ void main() {
   // are being sent when invoking methods on the `Analytics` instance
 
   late FakeAnalytics fakeAnalytics;
-  late FileSystem fs;
+  late MemoryFileSystem fs;
   late Directory homeDirectory;
   late File dismissedSurveyFile;
 
@@ -58,7 +58,7 @@ void main() {
       kDismissedSurveyFileName,
     ));
 
-    final initialAnalytics = Analytics.test(
+    final initialAnalytics = Analytics.fake(
       tool: DashTool.flutterTool,
       homeDirectory: homeDirectory,
       dartVersion: 'dartVersion',
@@ -72,7 +72,7 @@ void main() {
     // the first run
     withClock(Clock.fixed(DateTime(2022, 3, 3)), () {
       final toolsMessageVersion = kToolsMessageVersion;
-      fakeAnalytics = FakeAnalytics(
+      fakeAnalytics = Analytics.fake(
         tool: DashTool.flutterTool,
         homeDirectory: homeDirectory,
         dartVersion: 'dartVersion',
@@ -83,7 +83,6 @@ void main() {
           dismissedSurveyFile: dismissedSurveyFile,
           initializedSurveys: [testSurvey],
         ),
-        firstRun: false,
       );
     });
   });

pkgs/unified_analytics/test/legacy_analytics_test.dart

@@ -12,7 +12,7 @@ import 'package:unified_analytics/src/enums.dart';
 import 'package:unified_analytics/unified_analytics.dart';
 
 void main() {
-  late FileSystem fs;
+  late MemoryFileSystem fs;
   late Directory home;
   late Analytics analytics;
 
@@ -49,7 +49,7 @@ void main() {
 
     // The main analytics instance, other instances can be spawned within tests
     // to test how to instances running together work
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -80,7 +80,7 @@ void main() {
 
     // The main analytics instance, other instances can be spawned within tests
     // to test how to instances running together work
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -110,7 +110,7 @@ void main() {
 
     // The main analytics instance, other instances can be spawned within tests
     // to test how to instances running together work
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -140,7 +140,7 @@ void main() {
 
     // The main analytics instance, other instances can be spawned within tests
     // to test how to instances running together work
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -174,7 +174,7 @@ void main() {
 
     // The main analytics instance, other instances can be spawned within tests
     // to test how to instances running together work
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -208,7 +208,7 @@ void main() {
 
     // The main analytics instance, other instances can be spawned within tests
     // to test how to instances running together work
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -240,7 +240,7 @@ NOT VALID JSON
 
     // The main analytics instance, other instances can be spawned within tests
     // to test how to instances running together work
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -276,7 +276,7 @@ NOT VALID JSON
 
     // The main analytics instance, other instances can be spawned within tests
     // to test how to instances running together work
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,
@@ -308,7 +308,7 @@ NOT VALID JSON
 
     // The main analytics instance, other instances can be spawned within tests
     // to test how to instances running together work
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: initialTool,
       homeDirectory: home,
       flutterChannel: flutterChannel,

pkgs/unified_analytics/test/log_handler_test.dart

@@ -15,7 +15,7 @@ import 'package:unified_analytics/unified_analytics.dart';
 void main() {
   late FakeAnalytics analytics;
   late Directory homeDirectory;
-  late FileSystem fs;
+  late MemoryFileSystem fs;
   late File logFile;
 
   final testEvent = Event.hotReloadTime(timeMs: 10);
@@ -30,7 +30,7 @@ void main() {
     ));
 
     // Create the initialization analytics instance to onboard the tool
-    final initializationAnalytics = Analytics.test(
+    final initializationAnalytics = Analytics.fake(
       tool: DashTool.flutterTool,
       homeDirectory: homeDirectory,
       dartVersion: 'dartVersion',
@@ -41,13 +41,13 @@ void main() {
 
     // This instance is free to send events since the instance above
     // has confirmed that the client has shown the message
-    analytics = Analytics.test(
+    analytics = Analytics.fake(
       tool: DashTool.flutterTool,
       homeDirectory: homeDirectory,
       dartVersion: 'dartVersion',
       fs: fs,
       platform: DevicePlatform.macos,
-    ) as FakeAnalytics;
+    );
   });
 
   test('Ensure that log file is created', () {