feat: add logLevel parameter to RealtimeClientOptions (supabase#592)

* feat: add realtime log level parameter

* append log_level parameter on realtime client rather than Supabase client initialization

* minor edit of the comments

* update test expected value

* remove log_level parameter from supabase test

* pass log level to realtime client

* update test

* remove unnecessary changes

Author: dshukertjr

packages/realtime_client/lib/realtime_client.dart

@@ -2,3 +2,4 @@ export 'src/realtime_channel.dart' hide ToType;
 export 'src/realtime_client.dart';
 export 'src/realtime_presence.dart';
 export 'src/transformers.dart' hide getEnrichedPayload, getPayloadRecords;
+export 'src/constants.dart' show RealtimeLogLevel;

packages/realtime_client/lib/src/constants.dart

@@ -53,3 +53,5 @@ extension ChannelEventsExtended on ChannelEvents {
 class Transports {
   static const String websocket = 'websocket';
 }
+
+enum RealtimeLogLevel { info, debug, warn, error }

packages/realtime_client/lib/src/realtime_client.dart

@@ -87,7 +87,13 @@ class RealtimeClient {
     Map<String, String>? headers,
     this.params = const {},
     this.longpollerTimeout = 20000,
-  })  : endPoint = '$endPoint/${Transports.websocket}',
+    RealtimeLogLevel? logLevel,
+  })  : endPoint = Uri.parse('$endPoint/${Transports.websocket}')
+            .replace(
+              queryParameters:
+                  logLevel == null ? null : {'log_level': logLevel.name},
+            )
+            .toString(),
         headers = {
           ...Constants.defaultHeaders,
           if (headers != null) ...headers,
@@ -415,9 +421,10 @@ class RealtimeClient {
     }
 
     var endpoint = Uri.parse(url);
-    final searchParams = Map<String, dynamic>.from(endpoint.queryParameters);
-    params.forEach((k, v) => searchParams[k] = v);
-    endpoint = endpoint.replace(queryParameters: searchParams);
+    endpoint = endpoint.replace(queryParameters: {
+      ...endpoint.queryParameters,
+      ...params,
+    });
 
     return endpoint.toString();
   }

packages/supabase/lib/src/realtime_client_options.dart

@@ -1,3 +1,5 @@
+import 'package:realtime_client/realtime_client.dart';
+
 /// {@template realtime_client_options}
 /// Options to pass to the RealtimeClient.
 /// {@endtemplate}
@@ -7,6 +9,12 @@ class RealtimeClientOptions {
   /// Defaults to 10 events per second
   final int? eventsPerSecond;
 
+  /// Level of realtime server logs to to be logged
+  final RealtimeLogLevel? logLevel;
+
   /// {@macro realtime_client_options}
-  const RealtimeClientOptions({this.eventsPerSecond});
+  const RealtimeClientOptions({
+    this.eventsPerSecond,
+    this.logLevel,
+  });
 }

packages/supabase/lib/src/supabase_client.dart

@@ -278,6 +278,7 @@ class SupabaseClient {
         if (eventsPerSecond != null) 'eventsPerSecond': '$eventsPerSecond'
       },
       headers: headers,
+      logLevel: options.logLevel,
     );
   }
 

packages/supabase/test/client_test.dart

@@ -8,8 +8,9 @@ import 'utils.dart';
 
 void main() {
   group('Standard Header', () {
-    const supabaseUrl = '';
-    const supabaseKey = '';
+    const supabaseUrl = 'https://nlbsnpoablmsiwndbmer.supabase.co';
+    const supabaseKey =
+        'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6Im53emxkenlsb2pyemdqemloZHJrIiwicm9sZSI6ImFub24iLCJpYXQiOjE2ODQxMzI2ODAsImV4cCI6MTk5OTcwODY4MH0.MU-LVeAPic93VLcRsHktxzYtBKBUMWAQb8E-0AQETPs';
     late SupabaseClient client;
 
     setUp(() {
@@ -31,6 +32,29 @@ void main() {
           client.storage.headers['X-Client-Info']!.split('/').first;
       expect(xClientHeaderBeforeSlash, 'supabase-dart');
     });
+
+    test('realtime URL is properly being set', () {
+      var realtimeWebsocketURL = Uri.parse(client.realtime.endPointURL);
+      expect(
+        realtimeWebsocketURL.queryParameters,
+        containsPair('apikey', supabaseKey),
+      );
+      expect(realtimeWebsocketURL.queryParameters['log_level'], isNull);
+
+      client = SupabaseClient(supabaseUrl, supabaseKey,
+          realtimeClientOptions:
+              RealtimeClientOptions(logLevel: RealtimeLogLevel.info));
+
+      realtimeWebsocketURL = Uri.parse(client.realtime.endPointURL);
+      expect(
+        realtimeWebsocketURL.queryParameters,
+        containsPair('apikey', supabaseKey),
+      );
+      expect(
+        realtimeWebsocketURL.queryParameters,
+        containsPair('log_level', 'info'),
+      );
+    });
   });
 
   group('auth', () {