v7.1.1: Major bug fixes and improvements (#98)

* Major bug fixes
Added start of `debugMode`
Other minor improvements

* Built Example Applications

* Minor documentation improvements

* Built Example Applications

* Updated version to v7.1.1
Updated CHANGELOG

* Built Example Applications

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Former-commit-id: bc8b7e6bec3e473c601fe633d65223a4e8678ddd [formerly fa43b1e]
Former-commit-id: e289815a8818cbe45de1a3fddb03d5a29d219ef5

Author: JaffaKetchup

CHANGELOG.md

@@ -13,7 +13,12 @@ Many thanks to my sponsors, no matter how much or how little they donated. Spons
 
 # Changelog
 
-## [7.1.0] - 2023/02/12
+## [7.1.1] - 2023/02/16
+
+* Major bug fixes
+* Added debug mode
+
+## [7.1.0] - 2023/02/14
 
 * Added URL query params obscurer feature
 * Added `headers` and `httpClient` parameters to `getTileProvider`

example/lib/main.dart

@@ -26,6 +26,7 @@ void main() async {
   bool damagedDatabaseDeleted = false;
   await FlutterMapTileCaching.initialise(
     errorHandler: (error) => damagedDatabaseDeleted = error.wasFatal,
+    debugMode: true,
   );
 
   await FMTC.instance.rootDirectory.migrator.fromV6(urlTemplates: []);

example/lib/screens/main/pages/settingsAndAbout/settings_and_about.dart

@@ -80,7 +80,7 @@ class _SettingsAndAboutPageState extends State<SettingsAndAboutPage> {
                           context: context,
                           applicationName: 'FMTC Demo',
                           applicationVersion:
-                              'for v7.0.0\n(on ${Platform().operatingSystemFormatted})',
+                              'for v7.1.0\n(on ${Platform().operatingSystemFormatted})',
                           applicationIcon: Image.asset(
                             'assets/icons/ProjectIcon.png',
                             height: 48,

lib/src/bulk_download/downloader.dart

@@ -119,7 +119,9 @@ Future<TileProgress> _getAndSaveTile({
       );
     }
 
-    BulkTileWriter.instance.sendPort.send(List.unmodifiable([url, bytes]));
+    BulkTileWriter.instance.sendPort.send(
+      List.unmodifiable([provider.settings.obscureQueryParams(url), bytes]),
+    );
     bulkTileWriterResponse = await BulkTileWriter.instance.events.next;
   } catch (e) {
     if (errorHandler != null) errorHandler(e);

lib/src/db/registry.dart

@@ -39,9 +39,10 @@ class FMTCRegistry {
     required Directory directory,
     required int databaseMaxSize,
     required CompactCondition? databaseCompactCondition,
-    void Function(FMTCInitialisationException error)? errorHandler,
-    IOSink? initialisationSafetyWriteSink,
-    List<String>? safeModeSuccessfulIDs,
+    required void Function(FMTCInitialisationException error)? errorHandler,
+    required IOSink? initialisationSafetyWriteSink,
+    required List<String>? safeModeSuccessfulIDs,
+    required bool debugMode,
   }) async {
     final recoveryFile = directory >>> '.recovery.isar';
 
@@ -60,12 +61,19 @@ class FMTCRegistry {
     return instance = FMTCRegistry._(
       directory: directory,
       recoveryDatabase: await Isar.open(
-        [DbRecoverableRegionSchema],
+        [
+          DbRecoverableRegionSchema,
+          if (debugMode) ...[
+            DbStoreDescriptorSchema,
+            DbTileSchema,
+            DbMetadataSchema,
+          ],
+        ],
         name: '.recovery',
         directory: directory.absolute.path,
         maxSizeMiB: databaseMaxSize,
         compactOnLaunch: databaseCompactCondition,
-        inspector: false,
+        inspector: debugMode,
       ),
       storeDatabases: Map.fromEntries(
         await directory
@@ -102,7 +110,7 @@ class FMTCRegistry {
                     directory: directory.absolute.path,
                     maxSizeMiB: databaseMaxSize,
                     compactOnLaunch: databaseCompactCondition,
-                    inspector: false,
+                    inspector: debugMode,
                   ),
                 );
                 initialisationSafetyWriteSink?.writeln(id);

lib/src/fmtc.dart

@@ -26,11 +26,19 @@ class FlutterMapTileCaching {
   /// See [FMTCSettings]' properties for more information
   final FMTCSettings settings;
 
+  final bool _debugMode;
+
+  /// Whether FMTC should perform extra reporting and console logging
+  ///
+  /// Depends on [_debugMode] (set via [initialise]) and [kDebugMode].
+  bool get debugMode => _debugMode && kDebugMode;
+
   /// Internal constructor, to be used by [initialise]
-  FlutterMapTileCaching._({
+  const FlutterMapTileCaching._({
     required this.rootDirectory,
     required this.settings,
-  });
+    required bool debugMode,
+  }) : _debugMode = debugMode;
 
   /// Initialise and prepare FMTC, by creating all neccessary directories/files
   /// and configuring the [FlutterMapTileCaching] singleton
@@ -57,6 +65,14 @@ class FlutterMapTileCaching {
   /// initialisation safety system, and is not recommended, as this may leave the
   /// application unable to launch if any database becomes corrupted.
   ///
+  /// Setting [debugMode] `true` can be useful to diagnose issues, either within
+  /// your application or FMTC itself. It enables the Isar inspector and causes
+  /// extra console logging in important areas. Prefer to leave disabled to
+  /// prevent console pollution and to maximise performance. Whether FMTC chooses
+  /// to listen to this value is also dependent on [kDebugMode] - see
+  /// [FlutterMapTileCaching.debugMode] for more information.
+  /// _Extra logging is currently limited._
+  ///
   /// This returns a configured [FlutterMapTileCaching], the same object as
   /// [FlutterMapTileCaching.instance]. Note that [FMTC] is an alias for this
   /// object.
@@ -65,6 +81,7 @@ class FlutterMapTileCaching {
     FMTCSettings? settings,
     void Function(FMTCInitialisationException error)? errorHandler,
     bool disableInitialisationSafety = false,
+    bool debugMode = false,
   }) async {
     final directory = await ((rootDirectory == null
                 ? await getApplicationDocumentsDirectory()
@@ -90,6 +107,7 @@ class FlutterMapTileCaching {
         initialisationSafetyWriteSink: writeSink,
         safeModeSuccessfulIDs:
             needsRescue ? await initialisationSafetyFile.readAsLines() : null,
+        debugMode: debugMode && kDebugMode,
       );
 
       await writeSink.close();
@@ -100,12 +118,16 @@ class FlutterMapTileCaching {
         databaseMaxSize: fmtcSettings.databaseMaxSize,
         databaseCompactCondition: fmtcSettings.databaseCompactCondition,
         errorHandler: errorHandler,
+        initialisationSafetyWriteSink: null,
+        safeModeSuccessfulIDs: null,
+        debugMode: debugMode && kDebugMode,
       );
     }
 
     return _instance = FMTC._(
       rootDirectory: RootDirectory._(directory),
       settings: fmtcSettings,
+      debugMode: debugMode,
     );
   }
 

lib/src/providers/image_provider.dart

@@ -117,25 +117,11 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
       );
     }
 
-    final String networkUrl = provider.getTileUrl(coords, options);
-    final String matcherUrl;
-
-    if (networkUrl.contains('?') &&
-        provider.settings.obscuredQueryParams.isNotEmpty) {
-      String secondPartUrl = networkUrl.split('?')[1];
-      for (final r in provider.settings.obscuredQueryParams) {
-        secondPartUrl = secondPartUrl.replaceAll(r, '');
-      }
-
-      matcherUrl = '${networkUrl.split('?')[0]}?$secondPartUrl';
-    } else {
-      matcherUrl = networkUrl;
-    }
+    final networkUrl = provider.getTileUrl(coords, options);
+    final matcherUrl = provider.settings.obscureQueryParams(networkUrl);
 
-    final DbTile? existingTile =
-        await _db.tiles.get(DatabaseTools.hash(matcherUrl));
+    final existingTile = await _db.tiles.get(DatabaseTools.hash(matcherUrl));
 
-    // Logic to check whether the tile needs creating or updating
     final bool needsCreating = existingTile == null;
     final bool needsUpdating = needsCreating
         ? false
@@ -145,8 +131,7 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
                         existingTile.lastModified.millisecondsSinceEpoch >
                     settings.cachedValidDuration.inMilliseconds);
 
-    /* DEBUG ONLY
-    print('---------');
+    /*print('---------');
     print(networkUrl);
     print(matcherUrl);
     print('   Existing ID: ' + (existingTile?.id ?? 'None').toString());

lib/src/settings/tile_provider_settings.dart

@@ -1,6 +1,8 @@
 // Copyright © Luka S (JaffaKetchup) under GPL-v3
 // A full license can be found at .\LICENSE
 
+import 'package:meta/meta.dart';
+
 import '../../flutter_map_tile_caching.dart';
 import '../providers/image_provider.dart';
 
@@ -51,8 +53,10 @@ class FMTCTileProviderSettings {
   /// Defaults to 0 disabled.
   final int maxStoreLength;
 
-  /// A list of keys in the query part of the source URL (after the '?'), who's
-  /// values will not be stored
+  /// A list of regular expressions indicating key-value pairs to be remove from
+  /// a URL's query parameter list
+  ///
+  /// Used by [obscureQueryParams] to apply to a URL.
   ///
   /// See the online documentation for more information.
   final Iterable<RegExp> obscuredQueryParams;
@@ -71,6 +75,19 @@ class FMTCTileProviderSettings {
     this.errorHandler,
   }) : obscuredQueryParams = obscuredQueryParams.map((e) => RegExp('$e=[^&]*'));
 
+  /// Apply the [obscuredQueryParams] to the input [url]
+  @internal
+  String obscureQueryParams(String url) {
+    if (!url.contains('?') || obscuredQueryParams.isEmpty) return url;
+
+    String secondPartUrl = url.split('?')[1];
+    for (final r in obscuredQueryParams) {
+      secondPartUrl = secondPartUrl.replaceAll(r, '');
+    }
+
+    return '${url.split('?')[0]}?$secondPartUrl';
+  }
+
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||

prebuiltExampleApplications/AndroidApplication.apk.REMOVED.git-id

@@ -1 +1 @@
-f036026a51a5aac16b9bbea4e08b55c417e28a1f
+8dabf01a39e9ac151ce0b2c274c9031c4666e13f

prebuiltExampleApplications/WindowsApplication.exe.REMOVED.git-id

@@ -1 +1 @@
-cd8dd9ee2df97ddc57a3060546972d933df91a34
+61a6c17168569271fe64208142fa93eb65e01d5a