chore: remove 'package:logger' dependency & OSM unblocking flow (#2185)

Author: JaffaKetchup

.github/workflows/branch.yml

@@ -1,7 +1,7 @@
 name: "Branch & PR"
 on:
   push:
-    branches: [ '!master' ]
+    branches: ["!master"]
   pull_request:
   workflow_dispatch:
 
@@ -23,7 +23,8 @@ jobs:
       - name: Install pana
         run: dart pub global activate pana
       - name: Check package score
-        run: pana --exit-code-threshold 0 .
+        # we cannot reach the top score: we use logger that doesn't support wasm, so -10
+        run: pana --exit-code-threshold 10 .
 
   analyse-code:
     name: "Analyse Code"
@@ -49,7 +50,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        sdk: [ '3.27.0', '' ]
+        sdk: ["3.27.0", ""]
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v6
@@ -72,7 +73,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        sdk: [ '3.27.0', '' ]
+        sdk: ["3.27.0", ""]
     defaults:
       run:
         working-directory: ./example
@@ -84,7 +85,7 @@ jobs:
         with:
           distribution: "temurin"
           java-version: "21"
-          cache: 'gradle'
+          cache: "gradle"
       - name: Setup Flutter Environment
         uses: subosito/flutter-action@v2
         with:
@@ -106,7 +107,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        sdk: [ '3.27.0', '' ]
+        sdk: ["3.27.0", ""]
     defaults:
       run:
         working-directory: ./example
@@ -141,7 +142,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        sdk: [ '3.27.0', '' ]
+        sdk: ["3.27.0", ""]
     defaults:
       run:
         working-directory: ./example
@@ -161,4 +162,4 @@ jobs:
         with:
           name: web-build
           path: example/build/web
-          if-no-files-found: error
+          if-no-files-found: error

benchmark/crs.dart

@@ -1,22 +1,18 @@
+// ignore_for_file: avoid_print
+
 import 'dart:async';
 import 'dart:ui';
 
 import 'package:flutter_map/src/geo/crs.dart';
 import 'package:latlong2/latlong.dart';
-import 'package:logger/logger.dart';
-
-class NoFilter extends LogFilter {
-  @override
-  bool shouldLog(LogEvent event) => true;
-}
 
 typedef Result = ({
   String name,
   Duration duration,
 });
 
 Future<Result> timedRun(String name, dynamic Function() body) async {
-  Logger().i('running $name...');
+  print('running $name...');
   final watch = Stopwatch()..start();
   await body();
   watch.stop();
@@ -29,10 +25,6 @@ Future<Result> timedRun(String name, dynamic Function() body) async {
 //
 // If you run in JIT mode, the resulting execution times will be a lot more similar.
 Future<void> main() async {
-  Logger.level = Level.all;
-  Logger.defaultFilter = NoFilter.new;
-  Logger.defaultPrinter = SimplePrinter.new;
-
   final results = <Result>[];
   const N = 100000000;
 
@@ -103,5 +95,5 @@ Future<void> main() async {
     }));
   }
 
-  Logger().i('Results:\n${results.map((r) => r.toString()).join('\n')}');
+  print('Results:\n${results.map((r) => r.toString()).join('\n')}');
 }

benchmark/point_in_polygon.dart

@@ -1,22 +1,18 @@
+// ignore_for_file: avoid_print
+
 import 'dart:async';
 import 'dart:math' as math;
 import 'dart:ui';
 
 import 'package:flutter_map/src/misc/point_in_polygon.dart';
-import 'package:logger/logger.dart';
-
-class NoFilter extends LogFilter {
-  @override
-  bool shouldLog(LogEvent event) => true;
-}
 
 typedef Result = ({
   String name,
   Duration duration,
 });
 
 Future<Result> timedRun(String name, dynamic Function() body) async {
-  Logger().i('running $name...');
+  print('running $name...');
   final watch = Stopwatch()..start();
   await body();
   watch.stop();
@@ -39,10 +35,6 @@ List<Offset> makeCircle(int points, double radius, double phase) {
 //
 // If you run in JIT mode, the resulting execution times will be a lot more similar.
 Future<void> main() async {
-  Logger.level = Level.all;
-  Logger.defaultFilter = NoFilter.new;
-  Logger.defaultPrinter = SimplePrinter.new;
-
   final results = <Result>[];
   const N = 3000000;
 
@@ -72,5 +64,5 @@ Future<void> main() async {
     return noSir;
   }));
 
-  Logger().i('Results:\n${results.map((r) => r.toString()).join('\n')}');
+  print('Results:\n${results.map((r) => r.toString()).join('\n')}');
 }

example/pubspec.lock

@@ -219,18 +219,18 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2
+      sha256: "12956d0ad8390bbcc63ca2e1469c0619946ccb52809807067a7020d57e647aa6"
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.17"
+    version: "0.12.18"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: f7142bb1154231d7ea5f96bc7bde4bda2a0945d2806bb11670e30b850d56bdec
+      sha256: "9c337007e82b1889149c82ed242ed1cb24a66044e30979c44912381e9be4c48b"
       url: "https://pub.dev"
     source: hosted
-    version: "0.11.1"
+    version: "0.13.0"
   meta:
     dependency: transitive
     description:
@@ -456,10 +456,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: ab2726c1a94d3176a45960b6234466ec367179b87dd74f1611adb1f3b5fb9d55
+      sha256: "19a78f63e83d3a61f00826d09bc2f60e191bf3504183c001262be6ac75589fb8"
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.7"
+    version: "0.7.8"
   typed_data:
     dependency: transitive
     description:

lib/src/gestures/map_interactive_viewer.dart

@@ -1243,7 +1243,8 @@ class MapInteractiveViewerState extends State<MapInteractiveViewer>
     yield initManagerListeners(
       manager: _keyboardZoomAnimationManager,
       sum: _NumInfiniteSumAnimation.new,
-      onTick: (value) {
+      onTick: (valueParameter) {
+        num value = valueParameter;
         if (_isZoomLeaping.value) {
           value *= keyboardOptions.zoomLeapVelocityMultiplier;
         }
@@ -1260,7 +1261,8 @@ class MapInteractiveViewerState extends State<MapInteractiveViewer>
     yield initManagerListeners(
       manager: _keyboardRotateAnimationManager,
       sum: _NumInfiniteSumAnimation.new,
-      onTick: (value) {
+      onTick: (valueParameter) {
+        num value = valueParameter;
         if (_isRotateLeaping.value) {
           value *= keyboardOptions.rotateLeapVelocityMultiplier;
         }

lib/src/layer/polygon_layer/polygon_layer.dart

@@ -14,7 +14,6 @@ import 'package:flutter_map/src/misc/offsets.dart';
 import 'package:flutter_map/src/misc/point_in_polygon.dart';
 import 'package:flutter_map/src/misc/simplify.dart';
 import 'package:latlong2/latlong.dart' hide Path;
-import 'package:logger/logger.dart';
 
 part 'label/build_text_painter.dart';
 part 'painter.dart';
@@ -164,13 +163,9 @@ class _PolygonLayerState<R extends Object> extends State<PolygonLayer<R>>
         kIsWeb &&
         oldWidget.invertedFill == null &&
         widget.invertedFill != null) {
-      Logger(printer: PrettyPrinter(methodCount: 0)).w(
-        '\x1B[1m\x1B[3mflutter_map\x1B[0m\nOn the web, inverted filling may '
-        'not work as expected in some cases. It will not match the behaviour\n'
-        'seen on native platforms.\nAvoid allowing polygons to intersect, and '
-        'avoid using holes within polygons.\nThis is due to multiple '
-        'limitations/bugs within Flutter.\nSee '
-        'https://docs.fleaflet.dev/layers/polyline-layer#culling for more info.',
+      // ignore: avoid_print
+      print(
+        '''  \x1B[1;33m[flutter_map]\x1B[0;33m Inverting filling may not work correctly on web: https://docs.fleaflet.dev/layers/polygon-layer#inverted-filling''',
       );
     }
   }

lib/src/layer/tile_layer/tile_layer.dart

@@ -1,7 +1,7 @@
 import 'dart:async';
 import 'dart:math';
 
-import 'package:collection/collection.dart' show MapEquality, ListEquality;
+import 'package:collection/collection.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_map/flutter_map.dart';
@@ -12,11 +12,9 @@ import 'package:flutter_map/src/layer/tile_layer/tile_image_manager.dart';
 import 'package:flutter_map/src/layer/tile_layer/tile_range.dart';
 import 'package:flutter_map/src/layer/tile_layer/tile_range_calculator.dart';
 import 'package:flutter_map/src/layer/tile_layer/tile_scale_calculator.dart';
-import 'package:flutter_map/src/layer/tile_layer/unblock_osm.dart';
 import 'package:flutter_map/src/misc/extensions.dart';
 import 'package:http/http.dart';
 import 'package:http/retry.dart';
-import 'package:logger/logger.dart';
 
 part 'retina_mode.dart';
 part 'tile_error_evict_callback.dart';
@@ -322,48 +320,44 @@ class TileLayer extends StatefulWidget {
 
 class _TileLayerState extends State<TileLayer> with TickerProviderStateMixin {
   static const _openStreetMapUrls = {'tile.openstreetmap.org', 'tile.osm.org'};
-  bool get _isOpenStreetMapUrl =>
-      widget.urlTemplate != null &&
-      _openStreetMapUrls.any(widget.urlTemplate!.contains);
-
-  static const _unblockOSMEnvVar =
-      String.fromEnvironment('flutter.flutter_map.unblockOSM');
-  static bool get _shouldUnblockOSM => const ListEquality<int>()
-      .equals(_unblockOSMEnvVar.codeUnits, osmUnblockingString);
-
-  late final hasSetGoodUserAgent =
-      widget.tileProvider.headers['User-Agent'] != 'flutter_map (unknown)';
-  late final _blockOpenStreetMapUrl =
-      false /*&&
-      _isOpenStreetMapUrl &&
-      !hasSetGoodUserAgent &&
-      !kDebugMode &&
-      !_shouldUnblockOSM*/
-      ;
+
   void _warnOpenStreetMapUrl() {
-    if (_isOpenStreetMapUrl && kDebugMode && !_shouldUnblockOSM) {
-      final uaWarning = hasSetGoodUserAgent
-          ? ''
-          : '''
-
-When using the OSM tile servers, you must set an HTTP User-Agent which
-adequately identifies your application to the servers.
-Set `TileLayer.userAgentPackageName` appropriately, or set a UA header manually.
-OSMF (the tile server operators), and/or flutter_map in future, may block usage
-if inadequately identified.
-''';
-
-      final warning = '''\x1B[1m\x1B[3mflutter_map\x1B[0m$uaWarning
-flutter_map wants to help keep map data available for everyone.
-We use the OpenStreetMap public tile servers in our code examples & demo app,
-but they are NOT free to use by everyone. Please review whether OSM's tile
-servers are appropriate and the best choice for your app.
-See:
- * https://operations.osmfoundation.org/policies/tiles (OSM Tile Usage Policy)
- * https://docs.fleaflet.dev/osm-warn for more information about this warning''';
-
-      Logger(printer: PrettyPrinter(methodCount: 0))
-          .log(hasSetGoodUserAgent ? Level.info : Level.warning, warning);
+    if (!kDebugMode) return;
+
+    final isOSMUrl = widget.urlTemplate != null &&
+        _openStreetMapUrls.any(widget.urlTemplate!.contains);
+
+    if (!isOSMUrl) return;
+
+    final hasSetGoodUserAgent =
+        widget.tileProvider.headers['User-Agent'] != 'flutter_map (unknown)';
+
+    final hasSubdomainPart = widget.urlTemplate!.contains('{s}');
+
+    // ignore: avoid_print
+    print('''  \x1B[1m[flutter_map]\x1B[0m
+    We want to help keep OpenStreetMap available for everyone. Our examples
+    and demo app use the public tile servers, but they are NOT free to use by
+    everyone! Please review whether the OpenStreetMap tile servers are suitable
+    for your project.
+    See:
+      * https://operations.osmfoundation.org/policies/tiles (OSM Tile Usage Policy)
+      * https://docs.fleaflet.dev/osm-warn for more information about this warning''');
+
+    if (!hasSetGoodUserAgent) {
+      // ignore: avoid_print
+      print('''\x1B[0;33m    ---
+    \x1B[0;33mIt looks like you haven't set an adequate HTTP User-Agent, for example through
+    \x1B[0;33mthe `TileLayer.userAgentPackageName` argument. This may lead to your project
+    \x1B[0;33mbeing blocked.''');
+    }
+
+    if (hasSubdomainPart) {
+      // ignore: avoid_print
+      print('''\x1B[0;33m    ---
+    \x1B[0;33mAvoid using subdomains with the OpenStreetMap public tile server. Support may
+    \x1B[0;33mbecome slow or be removed in future.
+    \x1B[0;33mSee https://github.com/openstreetmap/operations/issues/737 for more info.''');
     }
   }
 
@@ -396,19 +390,6 @@ See:
     _resetSub = widget.reset?.listen(_resetStreamHandler);
     _tileRangeCalculator = TileRangeCalculator(tileDimension: _tileDimension);
     _warnOpenStreetMapUrl();
-
-    // These log strong hints in debug mode, which is more visible to users than
-    // just documentation - they should only be used where there is a specific
-    // and large risk of the user doing something wrong.
-    if (kDebugMode &&
-        widget.urlTemplate != null &&
-        widget.urlTemplate!.contains('{s}.tile.openstreetmap.org')) {
-      Logger(printer: PrettyPrinter(methodCount: 0)).w(
-        '\x1B[1m\x1B[3mflutter_map\x1B[0m\nAvoid using subdomains with OSM\'s tile '
-        'server. Support may be become slow or be removed in future.\nSee '
-        'https://github.com/openstreetmap/operations/issues/737 for more info.',
-      );
-    }
   }
 
   // This is called on every map movement so we should avoid expensive logic
@@ -543,10 +524,6 @@ See:
 
     if (_outsideZoomLimits(map.zoom.round())) return const SizedBox.shrink();
 
-    if (_blockOpenStreetMapUrl) {
-      return const SizedBox.shrink();
-    }
-
     final tileZoom = _clampToNativeZoom(map.zoom);
     final tileBoundsAtZoom = _tileBounds.atZoom(tileZoom);
     final visibleTileRange = _tileRangeCalculator.calculate(
@@ -709,10 +686,6 @@ See:
     DiscreteTileRange tileLoadRange, {
     required bool pruneAfterLoad,
   }) {
-    if (_isOpenStreetMapUrl && _blockOpenStreetMapUrl) {
-      return;
-    }
-
     final tileZoom = tileLoadRange.zoom;
     final expandedTileLoadRange = tileLoadRange.expand(widget.panBuffer);