feat: add logging

Author: mcquenji

analysis_options.yaml

@@ -1,3 +1,8 @@
+analyzer:
+  exclude:
+    - example/**
+    - lib/src/generated/**
+
 linter:
   rules:
     package_api_docs: true

lib/flutter_single_instance.dart

@@ -38,6 +38,7 @@ import 'package:flutter_single_instance/src/focus.dart';
 import 'package:flutter_single_instance/src/generated/focus.pbgrpc.dart';
 import 'package:flutter_single_instance/src/instance.dart';
 import 'package:grpc/grpc.dart';
+import 'package:logging/logging.dart';
 import 'package:path_provider/path_provider.dart';
 import 'src/linux.dart';
 import 'src/macos.dart';
@@ -56,16 +57,20 @@ abstract class FlutterSingleInstance {
   Server? _server;
   Instance? _instance;
 
+  /// Logger for this class.
+  @protected
+  Logger get logger => Logger('FlutterSingleInstance.$runtimeType');
+
   /// Provides utilities for checking if this is the first instance of the app.
   /// Make sure to call `WidgetsFlutterBinding.ensureInitialized()` before using this class.
   factory FlutterSingleInstance() {
     _singelton ??= Platform.isMacOS
-        ? FlutterSingleInstanceMacOS()
+        ? MacOS()
         : Platform.isLinux
-            ? FlutterSingleInstanceLinux()
+            ? Linux()
             : Platform.isWindows
-                ? FlutterSingleInstanceWindows()
-                : FlutterSingleInstanceUnsopported();
+                ? Windows()
+                : Unsupported();
 
     return _singelton!;
   }
@@ -82,6 +87,7 @@ abstract class FlutterSingleInstance {
   /// Automatically writes a pid file to the temp directory if this is the first instance.
   Future<bool> isFirstInstance() async {
     if (debugMode) {
+      logger.finest("Debug mode enabled, reporting as first instance");
       return true;
     }
 
@@ -92,6 +98,8 @@ abstract class FlutterSingleInstance {
     pidFile!;
 
     if (!pidFile.existsSync()) {
+      logger.finest("No pid file found, activating instance");
+
       // No pid file, so this is the first instance.
       await activateInstance(processName);
       return true;
@@ -101,13 +109,19 @@ abstract class FlutterSingleInstance {
 
     _instance = Instance.fromJson(jsonDecode(data));
 
+    logger.finest("Pid file found, verifying instance: $_instance");
+
     final pidName = await getProcessName(_instance!.pid);
 
     if (processName == pidName) {
+      logger.finest("Process name matches, reporting as second instance");
+
       // Process exists, so this is not the first instance.
       return false;
     }
 
+    logger.finest("Process name does not match, activating instance");
+
     // Process does not exist, so we can activate this instance.
     await activateInstance(processName);
 
@@ -127,6 +141,8 @@ abstract class FlutterSingleInstance {
     );
 
     await pidFile?.writeAsString(jsonEncode(instance.toJson()));
+
+    logger.finest("Instance activated: $instance at ${pidFile?.path}");
   }
 
   /// Returns the pid file.
@@ -140,6 +156,8 @@ abstract class FlutterSingleInstance {
   /// Starts an RPC server that listens for focus requests.
   @protected
   Future<int> startRpcServer() async {
+    logger.finest("Starting RPC server");
+
     _server = Server.create(
       services: [FocusService()],
       codecRegistry: CodecRegistry(
@@ -152,6 +170,8 @@ abstract class FlutterSingleInstance {
 
     await _server!.serve(port: 0);
 
+    logger.finest("RPC server started on port ${_server!.port}");
+
     return _server!.port!;
   }
 
@@ -161,6 +181,8 @@ abstract class FlutterSingleInstance {
     if (_instance == null) return "No instance to focus";
     if (_server != null) return "This is the first instance";
 
+    logger.finest("Focusing instance: $_instance");
+
     try {
       final channel = ClientChannel(
         'localhost',
@@ -180,8 +202,17 @@ abstract class FlutterSingleInstance {
 
       final response = await client.focus(FocusRequest());
 
-      return response.success ? null : response.error;
+      if (response.success) {
+        logger.finest("Instance focused");
+
+        return null;
+      } else {
+        logger.finest('Failed to focus instance', response.error);
+
+        return response.error;
+      }
     } catch (e) {
+      logger.finest('Failed to focus instance', e);
       return e.toString();
     }
   }

lib/src/focus.dart

@@ -1,15 +1,25 @@
+import 'package:flutter_single_instance/flutter_single_instance.dart';
 import 'package:flutter_single_instance/src/generated/focus.pbgrpc.dart';
 import 'package:grpc/grpc.dart';
-import 'package:window_manager/window_manager.dart';
 
+/// Handles focus requests from other instances.
 class FocusService extends FocusServiceBase {
   @override
   Future<FocusResponse> focus(ServiceCall call, FocusRequest request) async {
+    // ignore: invalid_use_of_protected_member
+    final logger = FlutterSingleInstance().logger;
+
+    logger.finest('Received focus request from ${call.remoteAddress?.address}');
+
     try {
       await windowManager.focus();
 
+      logger.finest('Window focused');
+
       return FocusResponse(success: true);
     } catch (e) {
+      logger.finest('Failed to focus window', e);
+
       return FocusResponse(success: false, error: e.toString());
     }
   }

lib/src/linux.dart

@@ -2,9 +2,9 @@ import 'dart:io';
 import 'package:flutter_single_instance/flutter_single_instance.dart';
 
 /// Implementation of [FlutterSingleInstance] for Linux.
-class FlutterSingleInstanceLinux extends FlutterSingleInstance {
+class Linux extends FlutterSingleInstance {
   /// Implementation of [FlutterSingleInstance] for Linux.
-  FlutterSingleInstanceLinux() : super.internal();
+  Linux() : super.internal();
 
   @override
   Future<String?> getProcessName(pid) async {
@@ -28,4 +28,9 @@ class FlutterSingleInstanceLinux extends FlutterSingleInstance {
       return parts.last;
     }
   }
+
+  @override
+  Future<File?> getPidFile(String processName) async {
+    return File('/tmp/$processName.pid');
+  }
 }

lib/src/macos.dart

@@ -2,9 +2,9 @@ import 'dart:io';
 import 'package:flutter_single_instance/flutter_single_instance.dart';
 
 /// Implementation of [FlutterSingleInstance] for MacOS.
-class FlutterSingleInstanceMacOS extends FlutterSingleInstance {
+class MacOS extends FlutterSingleInstance {
   /// Implementation of [FlutterSingleInstance] for MacOS.
-  FlutterSingleInstanceMacOS() : super.internal();
+  MacOS() : super.internal();
   @override
   Future<String?> getProcessName(pid) async {
     var result = await Process.run("ps", ["-p", "$pid"]);

lib/src/unsupported.dart

@@ -3,9 +3,9 @@ import 'dart:io';
 import 'package:flutter_single_instance/flutter_single_instance.dart';
 
 /// Implementation of [FlutterSingleInstance] for unsupported platforms.
-class FlutterSingleInstanceUnsopported extends FlutterSingleInstance {
+class Unsupported extends FlutterSingleInstance {
   /// Implementation of [FlutterSingleInstance] for unsupported platforms.
-  FlutterSingleInstanceUnsopported() : super.internal();
+  Unsupported() : super.internal();
 
   @override
   Future<String?> getProcessName(int pid) async => null;

lib/src/windows.dart

@@ -2,9 +2,9 @@ import 'dart:io';
 import 'package:flutter_single_instance/flutter_single_instance.dart';
 
 /// Implementation of [FlutterSingleInstance] for Windows.
-class FlutterSingleInstanceWindows extends FlutterSingleInstance {
+class Windows extends FlutterSingleInstance {
   /// Implementation of [FlutterSingleInstance] for Windows.
-  FlutterSingleInstanceWindows() : super.internal();
+  Windows() : super.internal();
 
   @override
   Future<String?> getProcessName(pid) async {

pubspec.yaml

@@ -4,12 +4,12 @@ description: A simple way to check if your application is already running.
 version: 1.1.2
 repository: https://github.com/necodeIT/flutter_single_instance
 platforms:
-  linux:
-  macos:
-  windows:
-  ios:
-  android:
-  web:
+  ? linux
+  ? macos
+  ? windows
+  ? ios
+  ? android
+  ? web
 
 environment:
   sdk: ">=2.16.2 <4.0.0"
@@ -21,6 +21,7 @@ dependencies:
   freezed_annotation: ^2.4.4
   grpc: ^4.0.1
   json_annotation: ^4.9.0
+  logging: ^1.3.0
   path_provider: ^2.0.13
   window_manager: ^0.4.3