Implemented initial tile loading debug system

Deprecated `obscuredQueryParams`
Added `urlTransformer` & `urlTransformerOmitKeyValues` [as replacement for above
Refactored `_FMTCImageProvider` internals

Author: JaffaKetchup

example/lib/src/screens/home/config_view/panels/behaviour/behaviour.dart

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:flutter_map_tile_caching/flutter_map_tile_caching.dart';
 import 'package:provider/provider.dart';
 
 import '../../../../../shared/state/general_provider.dart';
@@ -9,42 +10,43 @@ class ConfigPanelBehaviour extends StatelessWidget {
   });
 
   @override
-  Widget build(BuildContext context) => Selector<GeneralProvider, bool?>(
-        selector: (context, provider) => provider.behaviourPrimary,
-        builder: (context, behaviourPrimary, _) => Column(
+  Widget build(BuildContext context) =>
+      Selector<GeneralProvider, CacheBehavior>(
+        selector: (context, provider) => provider.cacheBehavior,
+        builder: (context, cacheBehavior, _) => Column(
           mainAxisSize: MainAxisSize.min,
           children: [
             SizedBox(
               width: double.infinity,
               child: SegmentedButton(
                 segments: const [
                   ButtonSegment(
-                    value: null,
+                    value: CacheBehavior.cacheOnly,
                     icon: Icon(Icons.download_for_offline_outlined),
                     label: Text('Cache Only'),
                   ),
                   ButtonSegment(
-                    value: false,
+                    value: CacheBehavior.cacheFirst,
                     icon: Icon(Icons.storage_rounded),
                     label: Text('Cache'),
                   ),
                   ButtonSegment(
-                    value: true,
+                    value: CacheBehavior.onlineFirst,
                     icon: Icon(Icons.public_rounded),
                     label: Text('Network'),
                   ),
                 ],
-                selected: {behaviourPrimary},
+                selected: {cacheBehavior},
                 onSelectionChanged: (value) => context
                     .read<GeneralProvider>()
-                    .behaviourPrimary = value.single,
+                    .cacheBehavior = value.single,
                 style: const ButtonStyle(
                   visualDensity: VisualDensity.comfortable,
                 ),
               ),
             ),
             const SizedBox(height: 6),
-            Selector<GeneralProvider, bool>(
+            /*Selector<GeneralProvider, bool>(
               selector: (context, provider) =>
                   provider.behaviourUpdateFromNetwork,
               builder: (context, behaviourUpdateFromNetwork, _) => Row(
@@ -53,9 +55,8 @@ class ConfigPanelBehaviour extends StatelessWidget {
                   const Text('Update cache when network used'),
                   const Spacer(),
                   Switch.adaptive(
-                    value:
-                        behaviourPrimary != null && behaviourUpdateFromNetwork,
-                    onChanged: behaviourPrimary == null
+                    value: cacheBehavior != null && behaviourUpdateFromNetwork,
+                    onChanged: cacheBehavior == null
                         ? null
                         : (value) => context
                             .read<GeneralProvider>()
@@ -69,7 +70,7 @@ class ConfigPanelBehaviour extends StatelessWidget {
                   const SizedBox(width: 8),
                 ],
               ),
-            ),
+            ),*/
           ],
         ),
       );

example/lib/src/shared/state/general_provider.dart

@@ -28,28 +28,19 @@ class GeneralProvider extends ChangeNotifier {
     notifyListeners();
   }
 
-  CacheBehavior get behaviour =>
-      switch ((_behaviourPrimary, _behaviourUpdateFromNetwork)) {
-        (null, _) => CacheBehavior.cacheOnly,
-        (false, false) => CacheBehavior.cacheFirstNoUpdate,
-        (false, true) => CacheBehavior.cacheFirst,
-        (true, false) => CacheBehavior.onlineFirstNoUpdate,
-        (true, true) => CacheBehavior.onlineFirst,
-      };
-
-  bool? _behaviourPrimary = false;
-  bool? get behaviourPrimary => _behaviourPrimary;
-  set behaviourPrimary(bool? newBehaviourPrimary) {
-    _behaviourPrimary = newBehaviourPrimary;
+  CacheBehavior _cacheBehavior = CacheBehavior.onlineFirst;
+  CacheBehavior get cacheBehavior => _cacheBehavior;
+  set cacheBehavior(CacheBehavior newCacheBehavior) {
+    _cacheBehavior = newCacheBehavior;
     notifyListeners();
   }
 
-  bool _behaviourUpdateFromNetwork = true;
+  /*bool _behaviourUpdateFromNetwork = true;
   bool get behaviourUpdateFromNetwork => _behaviourUpdateFromNetwork;
   set behaviourUpdateFromNetwork(bool newBehaviourUpdateFromNetwork) {
     _behaviourUpdateFromNetwork = newBehaviourUpdateFromNetwork;
     notifyListeners();
-  }
+  }*/
 
   bool _displayDebugOverlay = true;
   bool get displayDebugOverlay => _displayDebugOverlay;

lib/flutter_map_tile_caching.dart

@@ -35,7 +35,6 @@ import 'src/bulk_download/instance.dart';
 import 'src/bulk_download/rate_limited_stream.dart';
 import 'src/bulk_download/tile_loops/shared.dart';
 import 'src/misc/int_extremes.dart';
-import 'src/misc/obscure_query_params.dart';
 import 'src/providers/browsing_errors.dart';
 
 export 'src/backend/export_external.dart';
@@ -46,7 +45,9 @@ part 'src/bulk_download/download_progress.dart';
 part 'src/bulk_download/manager.dart';
 part 'src/bulk_download/thread.dart';
 part 'src/bulk_download/tile_event.dart';
+part 'src/providers/allowed_notify_value_notifier.dart';
 part 'src/providers/image_provider.dart';
+part 'src/providers/internal_get_bytes.dart';
 part 'src/providers/tile_provider.dart';
 part 'src/providers/tile_provider_settings.dart';
 part 'src/regions/base_region.dart';

lib/src/backend/interfaces/models.dart

@@ -5,17 +5,16 @@ import 'dart:typed_data';
 
 import 'package:meta/meta.dart';
 
-import '../../misc/obscure_query_params.dart';
+import '../../../flutter_map_tile_caching.dart';
 
 /// Represents a tile (which is never directly exposed to the user)
 ///
 /// Note that the relationship between stores and tiles is many-to-many, and
 /// backend implementations should fully support this.
 abstract base class BackendTile {
-  /// The representative URL of the tile
+  /// The storage-suitable UID of the tile
   ///
-  /// This is passed through [obscureQueryParams] before storage here, and so
-  /// may not be the same as the network URL.
+  /// This is the result of [FMTCTileProviderSettings.urlTransformer].
   String get url;
 
   /// The time at which the [bytes] of this tile were last changed

lib/src/bulk_download/manager.dart

@@ -14,7 +14,7 @@ Future<void> _downloadManager(
     bool skipSeaTiles,
     Duration? maxReportInterval,
     int? rateLimit,
-    List<RegExp> obscuredQueryParams,
+    String Function(String) urlTransformer,
     int? recoveryId,
     FMTCBackendInternalThreadSafe backend,
   }) input,
@@ -223,7 +223,7 @@ Future<void> _downloadManager(
             maxBufferLength: threadBufferLength,
             skipExistingTiles: input.skipExistingTiles,
             seaTileBytes: seaTileBytes,
-            obscuredQueryParams: input.obscuredQueryParams,
+            urlTransformer: input.urlTransformer,
             headers: headers,
             backend: threadBackend,
           ),

lib/src/bulk_download/thread.dart

@@ -11,7 +11,7 @@ Future<void> _singleDownloadThread(
     int maxBufferLength,
     bool skipExistingTiles,
     Uint8List? seaTileBytes,
-    Iterable<RegExp> obscuredQueryParams,
+    String Function(String) urlTransformer,
     Map<String, String> headers,
     FMTCBackendInternalThreadSafe backend,
   }) input,
@@ -65,10 +65,7 @@ Future<void> _singleDownloadThread(
     // Get new tile URL & any existing tile
     final networkUrl =
         input.options.tileProvider.getTileUrl(coordinates, input.options);
-    final matcherUrl = obscureQueryParams(
-      url: networkUrl,
-      obscuredQueryParams: input.obscuredQueryParams,
-    );
+    final matcherUrl = input.urlTransformer(networkUrl);
 
     final existingTile = await input.backend.readTile(
       url: matcherUrl,

lib/src/misc/obscure_query_params.dart

@@ -0,0 +1,13 @@
+// Copyright © Luka S (JaffaKetchup) under GPL-v3
+// A full license can be found at .\LICENSE
+
+part of '../../flutter_map_tile_caching.dart';
+
+class _AllowedNotifyValueNotifier<T> extends ValueNotifier<T> {
+  _AllowedNotifyValueNotifier(super._value);
+
+  // Removes the `@protected` annotation, as we want to perform this operation
+  // ourselves
+  @override
+  void notifyListeners() => super.notifyListeners();
+}