[unified_analytics] Add NoOpAnalytics (#77)

Fixes #76

Author: christopherfujino

pkgs/unified_analytics/lib/src/analytics.dart

@@ -462,6 +462,51 @@ class AnalyticsImpl implements Analytics {
   }
 }
 
+/// An implementation that will never send events.
+///
+/// This is for clients that opt to either not send analytics, or will migrate
+/// to use [AnalyticsImpl] at a later time.
+class NoOpAnalytics implements Analytics {
+  const NoOpAnalytics._();
+
+  factory NoOpAnalytics() => const NoOpAnalytics._();
+
+  @override
+  final String getConsentMessage = '';
+
+  @override
+  final Map<String, ToolInfo> parsedTools = const <String, ToolInfo>{};
+
+  @override
+  final bool shouldShowMessage = false;
+
+  @override
+  final bool telemetryEnabled = false;
+
+  @override
+  final Map<String, Map<String, Object?>> userPropertyMap =
+      const <String, Map<String, Object?>>{};
+
+  @override
+  void clientShowedMessage() {}
+
+  @override
+  void close() {}
+
+  @override
+  LogFileStats? logFileStats() => null;
+
+  @override
+  Future<Response>? sendEvent({
+    required DashEvent eventName,
+    Map<String, Object?> eventData = const {},
+  }) =>
+      null;
+
+  @override
+  Future<void> setTelemetry(bool reportingBool) async {}
+}
+
 /// This class extends [AnalyticsImpl] and subs out any methods that
 /// are not suitable for tests; the following have been altered from the
 /// default implementation. All other methods are included

pkgs/unified_analytics/lib/src/ga_client.dart

@@ -47,17 +47,17 @@ class GAClient {
 
   /// Receive the payload in Map form and parse
   /// into JSON to send to GA
-  Future<http.Response> sendData(Map<String, Object?> body) {
-    return _client
-        .post(
-      Uri.parse(postUrl),
-      headers: <String, String>{
-        'Content-Type': 'application/json; charset=UTF-8',
-      },
-      body: jsonEncode(body),
-    )
-        .catchError((error) {
+  Future<http.Response> sendData(Map<String, Object?> body) async {
+    try {
+      return await _client.post(
+        Uri.parse(postUrl),
+        headers: <String, String>{
+          'Content-Type': 'application/json; charset=UTF-8',
+        },
+        body: jsonEncode(body),
+      );
+    } catch (error) {
       return Future<http.Response>.value(http.Response(error.toString(), 500));
-    });
+    }
   }
 }

pkgs/unified_analytics/lib/unified_analytics.dart

@@ -2,6 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-export 'src/analytics.dart' show Analytics;
+export 'src/analytics.dart' show Analytics, NoOpAnalytics;
+export 'src/config_handler.dart' show ToolInfo;
 export 'src/enums.dart';
 export 'src/log_handler.dart' show LogFileStats;

pkgs/unified_analytics/test/no_op_analytics_test.dart

@@ -0,0 +1,47 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:test/test.dart';
+import 'package:unified_analytics/unified_analytics.dart';
+
+void main() {
+  test('NoOpAnalytics.telemetryEnabled is always false', () async {
+    final NoOpAnalytics analytics = NoOpAnalytics();
+
+    expect(analytics.telemetryEnabled, isFalse);
+    await analytics.setTelemetry(true);
+    expect(analytics.telemetryEnabled, isFalse);
+  });
+
+  test('NoOpAnalytics.shouldShowMessage is always false', () async {
+    final NoOpAnalytics analytics = NoOpAnalytics();
+
+    expect(analytics.shouldShowMessage, isFalse);
+    analytics.clientShowedMessage();
+    expect(analytics.shouldShowMessage, isFalse);
+  });
+
+  test('NoOpAnalytics.sendEvent() always returns null', () async {
+    final NoOpAnalytics analytics = NoOpAnalytics();
+
+    await analytics.setTelemetry(true);
+    analytics.clientShowedMessage();
+    expect(
+      analytics.sendEvent(eventName: DashEvent.analyticsCollectionEnabled),
+      isNull,
+    );
+  });
+
+  test('NoOpAnalytics.logFileStats() always returns null', () async {
+    final NoOpAnalytics analytics = NoOpAnalytics();
+
+    expect(analytics.logFileStats(), isNull);
+
+    await analytics.setTelemetry(true);
+    analytics.clientShowedMessage();
+    await analytics.sendEvent(eventName: DashEvent.analyticsCollectionEnabled);
+
+    expect(analytics.logFileStats(), isNull);
+  });
+}