Merge pull request #2410 from leancodepl/allow-user-to-disable-patrol…

…-logging

Add option to disable printing patrol logs in patrol finders

packages/patrol_finders/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.3.0
+
+- Add option to disable printing patrol logs. Default value is disabled.
+
 ## 2.2.0+1
 
 - Bump `patrol_log` version.

packages/patrol_finders/lib/src/custom_finders/patrol_tester.dart

@@ -14,6 +14,7 @@ class PatrolTesterConfig {
     this.settlePolicy = SettlePolicy.trySettle,
     this.dragDuration = const Duration(milliseconds: 100),
     this.settleBetweenScrollsTimeout = const Duration(seconds: 5),
+    this.printLogs = false,
   });
 
   /// Time after which [PatrolFinder.waitUntilExists] fails if it doesn't find
@@ -53,6 +54,9 @@ class PatrolTesterConfig {
   /// [settlePolicy]).
   final Duration settleBetweenScrollsTimeout;
 
+  /// If true, patrol finders logs will be printed to the console.
+  final bool printLogs;
+
   /// Creates a copy of this config but with the given fields replaced with the
   /// new values.
   PatrolTesterConfig copyWith({
@@ -61,13 +65,18 @@ class PatrolTesterConfig {
     Duration? settleTimeout,
     SettlePolicy? settlePolicy,
     Duration? dragDuration,
+    Duration? settleBetweenScrollsTimeout,
+    bool? printLogs,
   }) {
     return PatrolTesterConfig(
       existsTimeout: existsTimeout ?? this.existsTimeout,
       visibleTimeout: visibleTimeout ?? this.visibleTimeout,
       settleTimeout: settleTimeout ?? this.settleTimeout,
       settlePolicy: settlePolicy ?? this.settlePolicy,
       dragDuration: dragDuration ?? this.dragDuration,
+      settleBetweenScrollsTimeout:
+          settleBetweenScrollsTimeout ?? this.settleBetweenScrollsTimeout,
+      printLogs: printLogs ?? this.printLogs,
     );
   }
 }
@@ -140,7 +149,7 @@ class PatrolTester {
     required Future<T> Function() function,
     bool enablePatrolLog = true,
   }) async {
-    if (!enablePatrolLog) {
+    if (!(config.printLogs && enablePatrolLog)) {
       return function();
     }
 

packages/patrol_finders/pubspec.yaml

@@ -1,6 +1,6 @@
 name: patrol_finders
 description: Streamlined, high-level API on top of flutter_test.
-version: 2.2.0+1
+version: 2.3.0
 homepage: https://patrol.leancode.co
 repository: https://github.com/leancodepl/patrol/tree/master/packages/patrol_finders
 issue_tracker: https://github.com/leancodepl/patrol/issues?q=is%3Aopen+is%3Aissue+label%3Apackage%3Apatrol_finders