feat: add telemetry [#81]

packages/clerk_auth/lib/clerk_auth.dart

@@ -6,5 +6,6 @@ export 'src/clerk_api/api.dart';
 export 'src/clerk_auth/auth.dart';
 export 'src/clerk_auth/persistor.dart';
 export 'src/models/models.dart';
+export 'src/models/telemetry/telemetric_event.dart';
 export 'src/utils/extensions.dart';
 export 'src/utils/logging.dart';

packages/clerk_auth/lib/clerk_constants.dart

@@ -5,4 +5,10 @@ sealed class ClerkConstants {
 
   /// value for the `x-flutter-sdk-version` header in API requests
   static const flutterSdkVersion = '0.0.4-dev';
+
+  /// Name of the SDK
+  static const sdkName = '@clerk/flutter';
+
+  /// JsVersion of API
+  static const jsVersion = '4.70.0';
 }

packages/clerk_auth/lib/src/clerk_api/api.dart

@@ -72,6 +72,9 @@ class Api with Logging {
 
   static const _defaultPollDelay = Duration(seconds: 55);
 
+  static final _telemetryEndpoint =
+      Uri.parse('https://clerk-telemetry.com/v1/event');
+
   /// Initialise the API
   Future<void> initialize() async {
     await _tokenCache.initialize();
@@ -91,6 +94,21 @@ class Api with Logging {
   ///
   String get domain => _domain;
 
+  /// Sends a map of data to the telemtry endpoint
+  ///
+  Future<void> sendTelemetry(List<TelemetricEvent> events) async {
+    await _client.send(
+      HttpMethod.post,
+      _telemetryEndpoint,
+      body: json.encode({
+        'events': [...events.map((e) => e.toJson())],
+      }),
+      headers: {
+        HttpHeaders.contentTypeHeader: 'application/json',
+      },
+    );
+  }
+
   /// Returns the latest [Environment] from Clerk.
   ///
   Future<Environment> environment() async {
@@ -210,7 +228,7 @@ class Api with Logging {
         'code': code,
         'token': token,
         if (metadata is Map) //
-          'unsafe_metadata': jsonEncode(metadata!),
+          'unsafe_metadata': json.encode(metadata!),
       },
     );
   }
@@ -246,7 +264,7 @@ class Api with Logging {
         'code': code,
         'token': token,
         if (metadata is Map) //
-          'unsafe_metadata': jsonEncode(metadata!),
+          'unsafe_metadata': json.encode(metadata!),
       },
     );
   }
@@ -650,7 +668,7 @@ class Api with Logging {
   }) =>
       {
         _kIsNative: true,
-        _kClerkJsVersion: Auth.jsVersion,
+        _kClerkJsVersion: ClerkConstants.jsVersion,
         if (withSession) //
           _kClerkSessionId: _tokenCache.sessionId,
         if (method.isGet) //

packages/clerk_auth/lib/src/clerk_auth/auth.dart

@@ -24,8 +24,9 @@ export 'persistor.dart';
 class Auth {
   /// Create an [Auth] object using appropriate Clerk credentials
   Auth({
-    required String publishableKey,
+    required this.publishableKey,
     required Persistor persistor,
+    this.telemetry = true,
     HttpClient? client,
     SessionTokenPollMode pollMode = SessionTokenPollMode.onDemand,
   }) : _api = Api(
@@ -35,16 +36,26 @@ class Auth {
           pollMode: pollMode,
         );
 
+  /// The injected Clerk publishable key
+  final String publishableKey;
+
+  /// Whether or not to send telemetry data (default true)
+  final bool telemetry;
+
   final Api _api;
 
   static const _codeLength = 6;
 
-  /// JsVersion of API
-  static const jsVersion = '4.70.0';
-
   /// default redirect URL for use with oAuth
   static const oauthRedirect = 'https://www.clerk.com/oauth-redirect';
 
+  /// Are we in development mode?
+  bool get isDevMode => env.display.instanceEnvironmentType.isDevelopment;
+
+  static const _telemetryPeriod = Duration(seconds: 27);
+  static final _telemetricEvents = <TelemetricEvent>[];
+  static Timer? _telemetryTimer;
+
   /// The [Environment] object
   ///
   /// configuration of the Clerk account - rarely changes
@@ -121,6 +132,32 @@ class Auth {
     return resp;
   }
 
+  /// Send a telemetry event to the backend.
+  ///
+  Future<void> sendTelemetry(
+    String event, {
+    required Map<String, dynamic> payload,
+  }) async {
+    if (isDevMode && telemetry) {
+      _telemetricEvents.add(
+        TelemetricEvent(
+          event: event,
+          it: env.display.instanceEnvironmentType.toString(),
+          pk: publishableKey,
+          payload: payload,
+        ),
+      );
+      _telemetryTimer ??= Timer(_telemetryPeriod, _sendTelemetry);
+    }
+  }
+
+  Future<void> _sendTelemetry() async {
+    final events = [..._telemetricEvents];
+    _telemetricEvents.clear();
+    _telemetryTimer = null;
+    await _api.sendTelemetry(events);
+  }
+
   /// Sign out of all [Session]s and delete the current [Client]
   ///
   Future<void> signOut() async {

packages/clerk_auth/lib/src/clerk_auth/http_client.dart

@@ -45,6 +45,7 @@ abstract class HttpClient {
     Uri uri, {
     Map<String, String>? headers,
     Map<String, dynamic>? params,
+    String? body,
   });
 
   /// Upload a [File] to the back end, and receive a [Response]
@@ -71,6 +72,7 @@ class DefaultHttpClient implements HttpClient {
     Uri uri, {
     Map<String, String>? headers,
     Map<String, dynamic>? params,
+    String? body,
   }) async {
     final request = Request(method.toString(), uri);
 
@@ -82,6 +84,10 @@ class DefaultHttpClient implements HttpClient {
       request.bodyFields = params.toStringMap();
     }
 
+    if (body case String body) {
+      request.body = body;
+    }
+
     final streamedResponse = await request.send();
     return Response.fromStream(streamedResponse);
   }

packages/clerk_auth/lib/src/models/enums.dart

@@ -201,6 +201,25 @@ enum Field {
   String toString() => _$FieldEnumMap[this]!;
 }
 
+/// [InstanceType] Clerk object
+@JsonEnum(alwaysCreate: true)
+enum InstanceType {
+  /// unknown
+  unknown,
+
+  /// development
+  development,
+
+  /// production
+  production;
+
+  /// Is this a development instance?
+  bool get isDevelopment => this == development;
+
+  @override
+  String toString() => _$InstanceTypeEnumMap[this]!;
+}
+
 /// [IdentifierType] object
 enum IdentifierType {
   /// phone number

packages/clerk_auth/lib/src/models/environment/display_config.dart

@@ -1,3 +1,4 @@
+import 'package:clerk_auth/clerk_auth.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'display_config.g.dart';
@@ -32,7 +33,7 @@ class DisplayConfig {
     this.googleOneTapClientId = '',
     this.helpUrl = '',
     this.homeUrl = '',
-    this.instanceEnvironmentType = '',
+    this.instanceEnvironmentType = InstanceType.unknown,
     this.logoImageUrl = '',
     this.logoLinkUrl = '',
     this.logoUrl = '',
@@ -119,7 +120,7 @@ class DisplayConfig {
   final String? homeUrl;
 
   /// instance environment type
-  final String? instanceEnvironmentType;
+  final InstanceType instanceEnvironmentType;
 
   /// logo image url
   final String? logoImageUrl;