feat: add logging to supabase_flutter

packages/gotrue/lib/src/gotrue_client.dart

@@ -1290,7 +1290,7 @@ class GoTrueClient {
       });
     }
     final state = AuthState(event, session, fromBroadcast: !broadcast);
-    _log.fine('Notifying subscribers: $state');
+    _log.fine('onAuthStateChange: $state');
     _onAuthStateChangeController.add(state);
     _onAuthStateChangeControllerSync.add(state);
   }

packages/supabase_flutter/lib/src/supabase.dart

@@ -3,12 +3,17 @@ import 'dart:async';
 import 'package:async/async.dart';
 import 'package:flutter/foundation.dart';
 import 'package:http/http.dart';
+import 'package:logging/logging.dart';
 import 'package:supabase/supabase.dart';
 import 'package:supabase_flutter/src/constants.dart';
 import 'package:supabase_flutter/src/flutter_go_true_client_options.dart';
 import 'package:supabase_flutter/src/local_storage.dart';
 import 'package:supabase_flutter/src/supabase_auth.dart';
 
+import 'version.dart';
+
+final _log = Logger('supabase.supabase_flutter');
+
 /// Supabase instance.
 ///
 /// It must be initialized before used, otherwise an error is thrown.
@@ -82,6 +87,19 @@ class Supabase {
       !_instance._initialized,
       'This instance is already initialized',
     );
+    _instance._debugEnable = debug ?? kDebugMode;
+
+    if (_instance._debugEnable) {
+      _log.onRecord.listen((record) {
+        if (record.level >= Level.INFO) {
+          debugPrint(
+              '${record.loggerName}: ${record.level.name}: ${record.message} ${record.error ?? ""}');
+        }
+      });
+    }
+
+    _log.config("Initialize Supabase v$version");
+
     if (authOptions.pkceAsyncStorage == null) {
       authOptions = authOptions.copyWith(
         pkceAsyncStorage: SharedPreferencesGotrueAsyncStorage(),
@@ -106,8 +124,6 @@ class Supabase {
       storageOptions: storageOptions,
       accessToken: accessToken,
     );
-    _instance._debugEnable = debug ?? kDebugMode;
-    _instance.log('***** Supabase init completed *****');
 
     _instance._supabaseAuth = SupabaseAuth();
     await _instance._supabaseAuth.initialize(options: authOptions);
@@ -119,6 +135,8 @@ class Supabase {
       _instance._supabaseAuth.recoverSession(),
     );
 
+    _log.info('***** Supabase init completed *****');
+
     return _instance;
   }
 
@@ -175,13 +193,4 @@ class Supabase {
     );
     _initialized = true;
   }
-
-  void log(String msg, [StackTrace? stackTrace]) {
-    if (_debugEnable) {
-      debugPrint(msg);
-      if (stackTrace != null) {
-        debugPrintStack(stackTrace: stackTrace);
-      }
-    }
-  }
 }

packages/supabase_flutter/lib/src/supabase_auth.dart

@@ -8,6 +8,7 @@ import 'package:async/async.dart';
 import 'package:flutter/foundation.dart' show kIsWeb;
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
+import 'package:logging/logging.dart';
 import 'package:supabase_flutter/supabase_flutter.dart';
 import 'package:url_launcher/url_launcher.dart';
 
@@ -34,6 +35,8 @@ class SupabaseAuth with WidgetsBindingObserver {
 
   final _appLinks = AppLinks();
 
+  final _log = Logger('supabase.supabase_flutter');
+
   /// - Obtains session from local storage and sets it as the current session
   /// - Starts a deep link observer
   /// - Emits an initial session if there were no session stored in local storage
@@ -48,9 +51,7 @@ class SupabaseAuth with WidgetsBindingObserver {
       (data) {
         _onAuthStateChange(data.event, data.session);
       },
-      onError: (error, stackTrace) {
-        Supabase.instance.log(error.toString(), stackTrace);
-      },
+      onError: (error, stackTrace) {},
     );
 
     await _localStorage.initialize();
@@ -65,7 +66,8 @@ class SupabaseAuth with WidgetsBindingObserver {
               .setInitialSession(persistedSession);
           shouldEmitInitialSession = false;
         } catch (error, stackTrace) {
-          Supabase.instance.log(error.toString(), stackTrace);
+          _log.warning(
+              'Error while setting initial session', error, stackTrace);
         }
       }
     }
@@ -96,9 +98,9 @@ class SupabaseAuth with WidgetsBindingObserver {
         }
       }
     } on AuthException catch (error, stackTrace) {
-      Supabase.instance.log(error.message, stackTrace);
+      _log.warning(error.message, error, stackTrace);
     } catch (error, stackTrace) {
-      Supabase.instance.log(error.toString(), stackTrace);
+      _log.warning("Error while recovering session", error, stackTrace);
     }
   }
 
@@ -186,9 +188,7 @@ class SupabaseAuth with WidgetsBindingObserver {
   }
 
   void _onAuthStateChange(AuthChangeEvent event, Session? session) {
-    Supabase.instance.log('**** onAuthStateChange: $event');
     if (session != null) {
-      Supabase.instance.log(jsonEncode(session.toJson()));
       _localStorage.persistSession(jsonEncode(session.toJson()));
     } else if (event == AuthChangeEvent.signedOut) {
       _localStorage.removePersistedSession();
@@ -206,7 +206,7 @@ class SupabaseAuth with WidgetsBindingObserver {
 
   /// Enable deep link observer to handle deep links
   Future<void> _startDeeplinkObserver() async {
-    Supabase.instance.log('***** SupabaseDeepLinkingMixin startAuthObserver');
+    _log.fine('Starting deeplink observer');
     _handleIncomingLinks();
     await _handleInitialUri();
   }
@@ -216,7 +216,7 @@ class SupabaseAuth with WidgetsBindingObserver {
   /// Automatically called on dispose().
   void _stopDeeplinkObserver() {
     if (_deeplinkSubscription != null) {
-      Supabase.instance.log('***** SupabaseDeepLinkingMixin stopAuthObserver');
+      _log.fine('Stopping deeplink observer');
       _deeplinkSubscription?.cancel();
     }
   }
@@ -234,7 +234,7 @@ class SupabaseAuth with WidgetsBindingObserver {
           }
         },
         onError: (Object err, StackTrace stackTrace) {
-          _onErrorReceivingDeeplink(err.toString(), stackTrace);
+          _onErrorReceivingDeeplink(err, stackTrace);
         },
       );
     }
@@ -273,39 +273,35 @@ class SupabaseAuth with WidgetsBindingObserver {
         await _handleDeeplink(uri);
       }
     } on PlatformException catch (err, stackTrace) {
-      _onErrorReceivingDeeplink(err.message ?? err.toString(), stackTrace);
+      _onErrorReceivingDeeplink(err.message ?? err, stackTrace);
       // Platform messages may fail but we ignore the exception
     } on FormatException catch (err, stackTrace) {
       _onErrorReceivingDeeplink(err.message, stackTrace);
     } catch (err, stackTrace) {
-      _onErrorReceivingDeeplink(err.toString(), stackTrace);
+      _onErrorReceivingDeeplink(err, stackTrace);
     }
   }
 
   /// Callback when deeplink receiving succeeds
   Future<void> _handleDeeplink(Uri uri) async {
     if (!_isAuthCallbackDeeplink(uri)) return;
 
-    Supabase.instance.log('***** SupabaseAuthState handleDeeplink $uri');
-
-    // notify auth deeplink received
-    Supabase.instance.log('onReceivedAuthDeeplink uri: $uri');
+    _log.fine('handle deeplink uri: $uri');
+    _log.info('handle deeplink uri');
 
     try {
       await Supabase.instance.client.auth.getSessionFromUrl(uri);
     } on AuthException catch (error, stackTrace) {
       // ignore: invalid_use_of_internal_member
       Supabase.instance.client.auth.notifyException(error, stackTrace);
-      Supabase.instance.log(error.toString(), stackTrace);
     } catch (error, stackTrace) {
-      Supabase.instance.log(error.toString(), stackTrace);
+      _log.warning('Error while getSessionFromUrl', error, stackTrace);
     }
   }
 
   /// Callback when deeplink receiving throw error
-  void _onErrorReceivingDeeplink(String message, StackTrace stackTrace) {
-    Supabase.instance
-        .log('onErrorReceivingDeepLink message: $message', stackTrace);
+  void _onErrorReceivingDeeplink(Object error, StackTrace stackTrace) {
+    _log.warning('Error while receiving deeplink', error, stackTrace);
   }
 }
 

packages/supabase_flutter/pubspec.yaml

@@ -21,6 +21,7 @@ dependencies:
   url_launcher: ^6.1.2
   path_provider: ^2.0.0
   shared_preferences: ^2.0.0
+  logging: ^1.2.0
 
 dev_dependencies:
   dart_jsonwebtoken: ^2.4.1