Change to a different stat tracking paradigm.

SaadArdati · SaadArdati · commit 16dc1966e4ea · 2024-08-30T14:34:49.000+03:00
diff --git a/lib/src/auth/codelessly_auth_manager.dart b/lib/src/auth/codelessly_auth_manager.dart
@@ -371,6 +371,7 @@ class CodelesslyAuthManager extends AuthManager {
     );
 
     try {
+      // TODO(Saad): Use an HTTP client.
       // Make a POST request to the server to verify the token.
       final Response result = await post(
         Uri.parse(
diff --git a/lib/src/codelessly.dart b/lib/src/codelessly.dart
@@ -10,8 +10,6 @@ import 'package:flutter/widgets.dart';
 import '../codelessly_sdk.dart';
 import 'logging/reporter.dart';
 
-const String clientType = String.fromEnvironment('client_type');
-
 typedef NavigationListener = void Function(BuildContext context);
 typedef BreakpointsListener = void Function(
     BuildContext context, Breakpoint breakpoint);
@@ -128,7 +126,7 @@ class Codelessly {
   final StreamController<CStatus> _statusStreamController =
       StreamController.broadcast()..add(CStatus.empty());
 
-  final StatTracker _tracker = FirestoreStatTracker();
+  final StatTracker _tracker = CodelesslyStatTracker();
 
   /// Tracks statistics of various operations in the SDK.
   StatTracker get tracker => _tracker;
@@ -641,7 +639,10 @@ class Codelessly {
         _config!.publishSource = _authManager!.getBestPublishSource(_config!);
 
         if (_authManager?.authData?.projectId case String projectId) {
-          tracker.init(projectId);
+          tracker.init(
+            projectId: projectId,
+            serverUrl: Uri.parse(_config!.firebaseCloudFunctionsBaseURL),
+          );
         }
 
         _updateStatus(CStatus.loading(CLoadingState.initializedAuth));
@@ -692,7 +693,10 @@ class Codelessly {
           if (_authManager!.authData == null) return;
 
           if (_authManager?.authData?.projectId case String projectId) {
-            tracker.init(projectId);
+            tracker.init(
+              projectId: projectId,
+              serverUrl: Uri.parse(_config!.firebaseCloudFunctionsBaseURL),
+            );
           }
 
           log('[POST-INIT] Background authentication succeeded. Initializing layout storage.');
diff --git a/lib/src/constants.dart b/lib/src/constants.dart
@@ -1,3 +1,5 @@
+const String clientType = String.fromEnvironment('client_type');
+
 const String kCodelesslyFirebaseApp = 'codelessly';
 
 const String defaultFirebaseProjectId = String.fromEnvironment(
diff --git a/lib/src/data/network_data_repository.dart b/lib/src/data/network_data_repository.dart
@@ -15,7 +15,7 @@ abstract class NetworkDataRepository {
   /// The [CodelesslyConfig] instance that is used to configure the SDK.
   final CodelesslyConfig config;
 
-  /// The [FirestoreStatTracker] instance to track the statistics of the data repository.
+  /// The [StatTracker] instance to track the statistics of the data repository.
   final StatTracker tracker;
 
   /// Creates a new instance of [NetworkDataRepository].
@@ -69,40 +69,6 @@ abstract class NetworkDataRepository {
     }
   }
 
-  /// Calls a cloud function that searches for the project associated with the
-  /// given unique slug and returns a completely populated [SDKPublishModel]
-  /// instance.
-  // Future<SDKPublishModel?> downloadCompletePublishBundle({
-  //   required String slug,
-  //   required PublishSource source,
-  // }) async {
-  //   logger.log(_label, 'Downloading publish bundle with slug: $slug and source: $source');
-  //   final http.Response result = await http.post(
-  //     Uri.parse(
-  //         '${config.firebaseCloudFunctionsBaseURL}/getPublishBundleBySlugRequest'),
-  //     headers: <String, String>{'Content-Type': 'application/json'},
-  //     body: jsonEncode({'slug': slug, 'source': source.serverPath}),
-  //     encoding: utf8,
-  //   );
-  //
-  //   if (result.statusCode != 200) {
-  //     logger.log(_label, 'Error downloading publish bundle.');
-  //     logger.log(_label, 'Status code: ${result.statusCode}');
-  //     logger.log(_label, 'Message: ${result.body}');
-  //     CodelesslyErrorHandler.instance.captureException(CodelesslyException(
-  //       'Error downloading publish bundle from slug [$slug]',
-  //       stacktrace: StackTrace.current,
-  //     ));
-  //     return null;
-  //   }
-  //
-  //   final Map<String, dynamic> modelDoc = jsonDecode(result.body);
-  //   final SDKPublishModel model = SDKPublishModel.fromJson(modelDoc);
-  //
-  //   logger.log(_label, 'Finished downloading publish bundle with slug: $slug and source: $source.');
-  //   return model;
-  // }
-
   /// Streams a given [projectID]'s associated [SDKPublishModel] from the
   /// network with preferably live updates.
   Stream<SDKPublishModel?> streamPublishModel({
diff --git a/lib/src/data/web_data_repository.dart b/lib/src/data/web_data_repository.dart
@@ -24,6 +24,7 @@ class WebDataRepository extends NetworkDataRepository {
     required String projectID,
     required PublishSource source,
   }) async* {
+    // TODO(Saad): Use an HTTP client.
     final Response result = await post(
       Uri.parse(
           '${config.firebaseCloudFunctionsBaseURL}/api/getPublishModelRequest'),
@@ -56,6 +57,7 @@ class WebDataRepository extends NetworkDataRepository {
     required String layoutID,
     required PublishSource source,
   }) async {
+    // TODO(Saad): Use an HTTP client.
     final Response result = await post(
       Uri.parse(
           '${config.firebaseCloudFunctionsBaseURL}/api/getLayoutModelRequest'),
@@ -92,6 +94,7 @@ class WebDataRepository extends NetworkDataRepository {
     required PublishSource source,
   }) async {
     try {
+      // TODO(Saad): Use an HTTP client.
       final Response result = await post(
         Uri.parse(
             '${config.firebaseCloudFunctionsBaseURL}/api/getFontModelRequest'),
@@ -129,6 +132,7 @@ class WebDataRepository extends NetworkDataRepository {
     required PublishSource source,
   }) async {
     try {
+      // TODO(Saad): Use an HTTP client.
       final Response result = await post(
         Uri.parse(
             '${config.firebaseCloudFunctionsBaseURL}/api/getPublishedApiRequest'),
@@ -168,6 +172,7 @@ class WebDataRepository extends NetworkDataRepository {
     required PublishSource source,
   }) async {
     try {
+      // TODO(Saad): Use an HTTP client.
       final Response result = await post(
         Uri.parse(
             '${config.firebaseCloudFunctionsBaseURL}/api/getPublishedLayoutVariablesRequest'),
@@ -209,6 +214,7 @@ class WebDataRepository extends NetworkDataRepository {
   }) async {
     log('[WebDataRepo] Downloading conditions for $layoutID');
     try {
+      // TODO(Saad): Use an HTTP client.
       final Response result = await post(
         Uri.parse(
             '${config.firebaseCloudFunctionsBaseURL}/api/getPublishedLayoutConditionsRequest'),
diff --git a/lib/src/functions/functions_repository.dart b/lib/src/functions/functions_repository.dart
@@ -422,6 +422,7 @@ class FunctionsRepository {
           reasonPhrase: actualResponse['reasonPhrase']?.toString(),
         );
       } else {
+        // TODO(Saad): Use an HTTP client.
         final Uri uri = Uri.parse(url);
         response = switch (method) {
           HttpMethod.get => await http.get(uri, headers: headers),
@@ -522,6 +523,7 @@ ${response.body.contains('{') ? const JsonEncoder.withIndent('  ').convert(json.
     required Object? body,
     required String cloudFunctionsURL,
   }) async {
+    // TODO(Saad): Use an HTTP client.
     return http.post(
       Uri.parse('$cloudFunctionsURL/makeApiRequest'),
       headers: {'content-type': 'application/json'},
diff --git a/lib/src/logging/stat_tracker.dart b/lib/src/logging/stat_tracker.dart
@@ -1,16 +1,30 @@
+import 'dart:convert';
+
 import 'package:codelessly_api/codelessly_api.dart';
+import 'package:collection/collection.dart';
+import 'package:http/http.dart';
+import 'package:meta/meta.dart';
 
-import '../constants.dart';
+import '../../codelessly_sdk.dart';
 import '../utils/debouncer.dart';
 
 /// A class that tracks statistics of various operations in the SDK.
 abstract class StatTracker {
+  Uri? serverUrl;
+
   /// The project ID to track the statistics for.
   String? projectId;
 
   bool get didInitialize => projectId != null;
 
-  void init(String projectId) => this.projectId = projectId;
+  @mustCallSuper
+  void init({
+    required String projectId,
+    required Uri serverUrl,
+  }) {
+    this.projectId = projectId;
+    this.serverUrl = serverUrl;
+  }
 
   /// Tracks one document read operation.
   Future<void> trackRead(String label);
@@ -31,21 +45,50 @@ abstract class StatTracker {
   Future<void> trackCloudAction(ActionModel action);
 }
 
-/// A [StatTracker] implementation that utilizes Firestore to track the
-/// statistics.
-final class FirestoreStatTracker extends StatTracker {
+/// A [StatTracker] implementation that sends the stats to Codelessly's server.
+final class CodelesslyStatTracker extends StatTracker {
+  @override
+  void init({
+    required String projectId,
+    required Uri serverUrl,
+  }) {
+    super.init(projectId: projectId, serverUrl: serverUrl);
+
+    // Send a batch if stats were tracked while this wasn't initialized yet.
+    if (statBatch.isNotEmpty && !disabled) {
+      sendBatch();
+    }
+  }
 
   /// The field name to track the number of each operation.
   final Map<String, int> statBatch = {};
 
-  /// Debounces the batch sending of the stats to prevent spamming the Firestore
+  /// Debounces the batch sending of the stats to prevent spamming the server
   /// with too many writes.
   final DeBouncer debouncer = DeBouncer(const Duration(seconds: 1));
 
-  /// Sends the batch of stats to the Firestore.
+  bool get disabled =>
+      clientType == kCodelesslyEditor || projectId == null || serverUrl == null;
+
+  /// Sends the batch of stats to the server.
   Future<void> sendBatch() => debouncer.run(
         () async {
-          // TODO: call api endpoint.
+          // TODO(Saad): Use an HTTP client.
+          post(
+            serverUrl!,
+            body: jsonEncode({
+              'projectId': projectId,
+              'stats': {
+                for (final entry in statBatch.entries
+                    .whereNot((entry) => entry.key == writesField))
+                  entry.key: entry.value,
+
+                // Account for this stat tracking operation as an additional write
+                // operation.
+                writesField: (statBatch[writesField] ?? 0) + 1,
+              },
+            }),
+          );
           statBatch.clear();
         },
         forceRunAfter: 20,
@@ -57,36 +100,48 @@ final class FirestoreStatTracker extends StatTracker {
 
   @override
   Future<void> trackRead(String label) {
+    if (disabled) return Future.value();
+
     incrementField('$readsField/$label');
     return sendBatch();
   }
 
   @override
   Future<void> trackWrite(String label) {
+    if (disabled) return Future.value();
+
     incrementField('$writesField/$label');
     return sendBatch();
   }
 
   @override
   Future<void> trackBundleDownload() {
+    if (disabled) return Future.value();
+
     incrementField(bundleDownloadsField);
     return sendBatch();
   }
 
   @override
   Future<void> trackFontDownload() {
+    if (disabled) return Future.value();
+
     incrementField(fontDownloadsField);
     return sendBatch();
   }
 
   @override
   Future<void> trackAction(ActionModel action) {
+    if (disabled) return Future.value();
+
     incrementField('$actionsField/${action.type.name}');
     return sendBatch();
   }
 
   @override
   Future<void> trackCloudAction(ActionModel action) {
+    if (disabled) return Future.value();
+
     incrementField('$cloudActionsField/${action.type.name}');
     return sendBatch();
   }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+const String clientType = String.fromEnvironment('client_type');`
	`2`	`+`
`1`	`3`	`const String kCodelesslyFirebaseApp = 'codelessly';`
`2`	`4`
`3`	`5`	`const String defaultFirebaseProjectId = String.fromEnvironment(`