Migrate Stat Tracker

Author: rayliverified

lib/codelessly_sdk.dart

@@ -15,7 +15,6 @@ export 'src/data/network_data_repository.dart';
 export 'src/data/web_data_repository.dart';
 export 'src/functions/functions.dart';
 export 'src/functions/functions_repository.dart';
-export 'src/logging/stat_tracker.dart';
 export 'src/model/asset_model.dart';
 export 'src/model/auth_data.dart';
 export 'src/model/custom_component.dart';

lib/src/codelessly.dart

@@ -11,6 +11,7 @@ import 'package:http/http.dart';
 import '../codelessly_sdk.dart';
 import 'logging/debug_logger.dart';
 import 'logging/error_logger.dart';
+import 'logging/stat_tracker.dart';
 import 'utils/codelessly_http_client.dart';
 
 typedef NavigationListener = void Function(
@@ -150,11 +151,6 @@ class Codelessly {
   final StreamController<CStatus> _statusStreamController =
       StreamController.broadcast()..add(CStatus.empty());
 
-  late final StatTracker _tracker = StatTracker(client: _client);
-
-  /// Tracks statistics of various operations in the SDK.
-  StatTracker get tracker => _tracker;
-
   /// Returns a stream of status updates for this SDK instance.
   Stream<CStatus> get statusStream => _statusStreamController.stream;
 
@@ -592,15 +588,13 @@ class Codelessly {
             authManager: _authManager!,
             networkDataRepository: FirebaseDataRepository(
               firestore: firebaseFirestore,
-              tracker: _tracker,
               config: _config!,
             ),
             localDataRepository: LocalDataRepository(
               cacheManager: _cacheManager!,
             ),
             firebaseFirestore: firebaseFirestore,
             errorLogger: errorLogger,
-            tracker: _tracker,
           );
 
       // Create the preview data manager.
@@ -613,14 +607,12 @@ class Codelessly {
             networkDataRepository: FirebaseDataRepository(
               firestore: firebaseFirestore,
               config: _config!,
-              tracker: _tracker,
             ),
             localDataRepository: LocalDataRepository(
               cacheManager: _cacheManager!,
             ),
             firebaseFirestore: firebaseFirestore,
             errorLogger: errorLogger,
-            tracker: _tracker,
           );
 
       // Create the template data manager. This is always automatically
@@ -637,14 +629,12 @@ class Codelessly {
             networkDataRepository: FirebaseDataRepository(
               firestore: firebaseFirestore,
               config: _config!,
-              tracker: _tracker,
             ),
             localDataRepository: LocalDataRepository(
               cacheManager: _cacheManager!,
             ),
             firebaseFirestore: firebaseFirestore,
             errorLogger: errorLogger,
-            tracker: _tracker,
           );
 
       status = CStatus.loading(CLoadingState.createdManagers);
@@ -666,7 +656,7 @@ class Codelessly {
         _config!.publishSource = _authManager!.getBestPublishSource(_config!);
 
         if (_authManager?.authData?.projectId case String projectId) {
-          tracker.init(
+          StatTracker.instance.init(
             projectId: projectId,
             serverUrl: Uri.parse(
                 '${_config!.firebaseCloudFunctionsBaseURL}/api/trackStatsRequest'),
@@ -720,7 +710,7 @@ class Codelessly {
           if (_authManager!.authData == null) return;
 
           if (_authManager?.authData?.projectId case String projectId) {
-            tracker.init(
+            StatTracker.instance.init(
               projectId: projectId,
               serverUrl: Uri.parse(
                   '${_config!.firebaseCloudFunctionsBaseURL}/api/trackStatsRequest'),

lib/src/data/cloud_database.dart

@@ -6,6 +6,7 @@ import 'package:flutter/widgets.dart';
 
 import '../../codelessly_sdk.dart';
 import '../logging/debug_logger.dart';
+import '../logging/stat_tracker.dart';
 import '../utils/constants.dart';
 
 const List<String> privateDocumentFields = [
@@ -198,9 +199,6 @@ class FirestoreCloudDatabase extends CloudDatabase {
   /// Reference to the Firestore instance.
   final FirebaseFirestore firestore;
 
-  /// Reference to the StatTracker instance, used to track reads and writes.
-  final StatTracker tracker;
-
   /// Subscriptions to the streams that are being listened to.
   final List<StreamSubscription> _subscriptions = [];
 
@@ -210,7 +208,6 @@ class FirestoreCloudDatabase extends CloudDatabase {
     super.identifier,
     super.publishSource, {
     required this.firestore,
-    required this.tracker,
   });
 
   /// Initializes the cloud storage for the given [identifier]. This must be
@@ -228,14 +225,14 @@ class FirestoreCloudDatabase extends CloudDatabase {
 
     // Create project doc if missing.
     final snapshot = await rootRef.get();
-    tracker.trackRead('cloudDatabase/init');
+    StatTracker.instance.trackRead('cloudDatabase/init');
 
     // Do nothing if project doc exists.
     if (snapshot.exists) return;
 
     // Create project doc if it does not exist.
     await rootRef.set({'project': identifier});
-    tracker.trackWrite('cloudDatabase/init');
+    StatTracker.instance.trackWrite('cloudDatabase/init');
 
     DebugLogger.instance
         .printInfo('Done initializing for $identifier', name: name);
@@ -317,7 +314,7 @@ class FirestoreCloudDatabase extends CloudDatabase {
     // Auto generate id if desired.
     if (autoGenerateId) {
       final document = await rootRef.collection(path).add(value);
-      tracker.trackWrite('cloudDatabase/addDocument');
+      StatTracker.instance.trackWrite('cloudDatabase/addDocument');
 
       DebugLogger.instance.printInfo(
         'Document added: ${document.path}',
@@ -340,7 +337,7 @@ class FirestoreCloudDatabase extends CloudDatabase {
 
     // Get snapshot to check if document exists.
     final snapshot = await docRef.get();
-    tracker.trackRead('cloudDatabase/addDocument');
+    StatTracker.instance.trackRead('cloudDatabase/addDocument');
 
     if (skipCreationIfDocumentExists && snapshot.exists) {
       DebugLogger.instance.printInfo(
@@ -352,7 +349,7 @@ class FirestoreCloudDatabase extends CloudDatabase {
 
     // Set document.
     await docRef.set(value);
-    tracker.trackWrite('cloudDatabase/addDocument');
+    StatTracker.instance.trackWrite('cloudDatabase/addDocument');
 
     DebugLogger.instance.printInfo(
       'Document added: ${docRef.path}/$documentId',
@@ -384,7 +381,7 @@ class FirestoreCloudDatabase extends CloudDatabase {
 
     // TODO: Should we do update instead of set?
     await docRef.set(value, SetOptions(merge: true));
-    tracker.trackWrite('cloudDatabase/updateDocument');
+    StatTracker.instance.trackWrite('cloudDatabase/updateDocument');
 
     DebugLogger.instance.printInfo(
       'Document updated: ${docRef.path}',
@@ -398,13 +395,13 @@ class FirestoreCloudDatabase extends CloudDatabase {
     final docRef = getDocPath(path, documentId);
 
     final snapshot = await docRef.get();
-    tracker.trackRead('cloudDatabase/removeDocument');
+    StatTracker.instance.trackRead('cloudDatabase/removeDocument');
 
     // TODO: Do we have to check for existence?
     if (!snapshot.exists) return false;
 
     await docRef.delete();
-    tracker.trackWrite('cloudDatabase/removeDocument');
+    StatTracker.instance.trackWrite('cloudDatabase/removeDocument');
 
     return true;
   }
@@ -415,7 +412,7 @@ class FirestoreCloudDatabase extends CloudDatabase {
     final docRef = getDocPath(path, documentId);
 
     final snapshot = await docRef.get();
-    tracker.trackRead('cloudDatabase/getDocumentData');
+    StatTracker.instance.trackRead('cloudDatabase/getDocumentData');
 
     final data = snapshot.data() ?? {};
     return sanitizeCloudDataForUse(data, docId: snapshot.id);
@@ -425,7 +422,7 @@ class FirestoreCloudDatabase extends CloudDatabase {
   Stream<Map<String, dynamic>> streamDocument(String path, String documentId) {
     final docRef = getDocPath(path, documentId);
     return docRef.snapshots().map((snapshot) {
-      tracker.trackRead('cloudDatabase/streamDocument');
+      StatTracker.instance.trackRead('cloudDatabase/streamDocument');
 
       return snapshot.data()?.let(
               (value) => sanitizeCloudDataForUse(value, docId: snapshot.id)) ??
@@ -453,7 +450,8 @@ class FirestoreCloudDatabase extends CloudDatabase {
     // Listen to the stream and update the variable.
     final subscription = stream.listen(
       (data) {
-        tracker.trackRead('cloudDatabase/streamDocumentToVariable');
+        StatTracker.instance
+            .trackRead('cloudDatabase/streamDocumentToVariable');
 
         DebugLogger.instance.printInfo(
           'Document stream update from cloud storage: $path/$documentId',
@@ -536,7 +534,8 @@ class FirestoreCloudDatabase extends CloudDatabase {
     // Listen to the stream and update the variable.
     final subscription = stream.listen(
       (snapshot) {
-        tracker.trackRead('cloudDatabase/streamCollectionToVariable');
+        StatTracker.instance
+            .trackRead('cloudDatabase/streamCollectionToVariable');
 
         final docs = snapshot.docs
             .map((doc) => sanitizeCloudDataForUse(doc.data(), docId: doc.id))

lib/src/data/data_manager.dart

@@ -9,6 +9,7 @@ import 'package:logging/logging.dart';
 import '../../codelessly_sdk.dart';
 import '../logging/debug_logger.dart';
 import '../logging/error_logger.dart';
+import '../logging/stat_tracker.dart';
 
 /// Orchestrates the data flow for the SDK.
 class DataManager {
@@ -59,10 +60,6 @@ class DataManager {
   /// The error handler to use.
   final ErrorLogger errorLogger;
 
-  /// The stat tracker to use, used to track various reads and writes in this
-  /// data manager.
-  final StatTracker tracker;
-
   SDKPublishModel? _publishModel;
 
   // TODO(Saad): LocalDatabase is only initialized and never truly accessed by
@@ -121,7 +118,6 @@ class DataManager {
     required this.localDataRepository,
     required this.firebaseFirestore,
     required this.errorLogger,
-    required this.tracker,
     SDKPublishModel? publishModel,
   }) : _publishModel = publishModel;
 
@@ -617,7 +613,6 @@ class DataManager {
       projectId,
       config.publishSource,
       firestore: firebaseFirestore,
-      tracker: tracker,
     );
     // initialize cloud storage.
     await instance.init();
@@ -1521,7 +1516,7 @@ class DataManager {
           .printInfo('\tLayout [$layoutID] has no fonts.', name: name);
     }
 
-    tracker.trackPopulatedLayoutDownload(layoutID);
+    StatTracker.instance.trackPopulatedLayoutDownload(layoutID);
     return true;
   }
 

lib/src/data/firebase_data_repository.dart

@@ -4,6 +4,7 @@ import 'package:cloud_firestore/cloud_firestore.dart';
 
 import '../../codelessly_sdk.dart';
 import '../logging/error_logger.dart';
+import '../logging/stat_tracker.dart';
 
 /// Handles the data flow of [SDKPublishModel] from the server.
 class FirebaseDataRepository extends NetworkDataRepository {
@@ -15,7 +16,6 @@ class FirebaseDataRepository extends NetworkDataRepository {
   FirebaseDataRepository({
     required this.firestore,
     required super.config,
-    required super.tracker,
   });
 
   @override
@@ -27,7 +27,7 @@ class FirebaseDataRepository extends NetworkDataRepository {
         firestore.collection(source.serverPath).doc(projectID);
 
     return publishModelDoc.snapshots().map((event) {
-      tracker.trackRead('${source.serverPath}/streamPublishModel');
+      StatTracker.instance.trackRead('${source.serverPath}/streamPublishModel');
 
       final Map<String, dynamic>? data = event.data();
       if (data == null || data.isEmpty) {
@@ -69,7 +69,8 @@ class FirebaseDataRepository extends NetworkDataRepository {
         );
         return null;
       }
-      tracker.trackRead('${source.serverPath}/downloadLayoutModel');
+      StatTracker.instance
+          .trackRead('${source.serverPath}/downloadLayoutModel');
 
       final Map<String, dynamic> data = value.data() ?? {};
 
@@ -104,7 +105,7 @@ class FirebaseDataRepository extends NetworkDataRepository {
         .doc(fontID);
 
     return fontDoc.get().then((value) {
-      tracker.trackRead('${source.serverPath}/downloadFontModel');
+      StatTracker.instance.trackRead('${source.serverPath}/downloadFontModel');
 
       final Map<String, dynamic> data = value.data() ?? {};
 
@@ -138,7 +139,7 @@ class FirebaseDataRepository extends NetworkDataRepository {
         .doc(apiId);
 
     return apiDoc.get().then((value) {
-      tracker.trackRead('${source.serverPath}/downloadApi');
+      StatTracker.instance.trackRead('${source.serverPath}/downloadApi');
 
       final Map<String, dynamic> data = value.data() ?? {};
 
@@ -172,7 +173,8 @@ class FirebaseDataRepository extends NetworkDataRepository {
         .doc(layoutID);
 
     return variablesDoc.get().then((value) {
-      tracker.trackRead('${source.serverPath}/downloadLayoutVariables');
+      StatTracker.instance
+          .trackRead('${source.serverPath}/downloadLayoutVariables');
 
       final Map<String, dynamic> data = value.data() ?? {};
 
@@ -207,7 +209,8 @@ class FirebaseDataRepository extends NetworkDataRepository {
         .doc(layoutID);
 
     return conditionsDoc.get().then((value) {
-      tracker.trackRead('${source.serverPath}/downloadLayoutConditions');
+      StatTracker.instance
+          .trackRead('${source.serverPath}/downloadLayoutConditions');
 
       final Map<String, dynamic> data = value.data() ?? {};
 

lib/src/data/network_data_repository.dart

@@ -8,6 +8,7 @@ import 'package:logging/logging.dart';
 import '../../codelessly_sdk.dart';
 import '../logging/debug_logger.dart';
 import '../logging/error_logger.dart';
+import '../logging/stat_tracker.dart';
 
 /// An abstract class that represents the operations that a [DataManager] will
 /// need to utilize to offer a complete usage experience of a [Codelessly]
@@ -18,13 +19,9 @@ abstract class NetworkDataRepository {
   /// The [CodelesslyConfig] instance that is used to configure the SDK.
   final CodelesslyConfig config;
 
-  /// The [StatTracker] instance to track the statistics of the data repository.
-  final StatTracker tracker;
-
   /// Creates a new instance of [NetworkDataRepository].
   NetworkDataRepository({
     required this.config,
-    required this.tracker,
   });
 
   /// Calls a cloud function that searches for the project associated with the
@@ -62,7 +59,7 @@ abstract class NetworkDataRepository {
         return null;
       }
 
-      tracker.trackBundleDownload();
+      StatTracker.instance.trackBundleDownload();
 
       final Map<String, dynamic> modelDoc =
           jsonDecode(utf8.decode(result.bodyBytes));
@@ -177,7 +174,7 @@ abstract class NetworkDataRepository {
     try {
       final http.Response response = await http.get(Uri.parse(url));
       if (response.statusCode != 200) return null;
-      tracker.trackFontDownload();
+      StatTracker.instance.trackFontDownload();
 
       return Uint8List.view(response.bodyBytes.buffer);
     } catch (e) {