v7.1.2: Minor bug fixes and improvements (JaffaKetchup#102)

* Fixed migrator bug Fixed image provider bug * Updated pubspec version Updated CHANGELOG * Built Example Applications * Fixed equality bug within `FMTCImageProvider` * Removed unnecessary `await` keyword * Built Example Applications --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Author: JaffaKetchup

CHANGELOG.md

@@ -13,6 +13,10 @@ Many thanks to my sponsors, no matter how much or how little they donated. Spons
 
 # Changelog
 
+## [7.1.2] - 2023/02/18
+
+* Minor bug fixes
+
 ## [7.1.1] - 2023/02/16
 
 * Major bug fixes

lib/src/providers/image_provider.dart

@@ -38,18 +38,14 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
  /// Used internally to safely and efficiently update the cache misses statistic
  static final Queue cacheMissesQueue = Queue();
 
- /// Shorthand for `provider.settings`
- late final FMTCTileProviderSettings settings;
-
  final Isar _db;
 
  /// Create a specialised [ImageProvider] dedicated to 'flutter_map_tile_caching'
  FMTCImageProvider({
  required this.provider,
  required this.options,
  required this.coords,
- }) : settings = provider.settings,
- _db = FMTCRegistry.instance(provider.storeDirectory.storeName);
+ }) : _db = FMTCRegistry.instance(provider.storeDirectory.storeName);
 
  @override
  ImageStreamCompleter loadBuffer(
@@ -103,7 +99,7 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
  try {
  throw FMTCBrowsingError(throwError, throwErrorType!);
  } on FMTCBrowsingError catch (e) {
- settings.errorHandler?.call(e);
+ provider.settings.errorHandler?.call(e);
  rethrow;
  }
  }
@@ -125,26 +121,28 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
  final bool needsCreating = existingTile == null;
  final bool needsUpdating = needsCreating
  ? false
- : settings.behavior == CacheBehavior.onlineFirst ||
- (settings.cachedValidDuration != Duration.zero &&
+ : provider.settings.behavior == CacheBehavior.onlineFirst ||
+ (provider.settings.cachedValidDuration != Duration.zero &&
  DateTime.now().millisecondsSinceEpoch -
  existingTile.lastModified.millisecondsSinceEpoch >
- settings.cachedValidDuration.inMilliseconds);
+ provider.settings.cachedValidDuration.inMilliseconds);
 
- /*print('---------');
+ /* DEBUG ONLY
+ print('---------');
  print(networkUrl);
  print(matcherUrl);
- print(' Existing ID: ' + (existingTile?.id ?? 'None').toString());
- print(' Needs Creating: ' + needsCreating.toString());
- print(' Needs Updating: ' + needsUpdating.toString());
+ print(' Store: ${provider.storeDirectory.storeName}');
+ print(' Existing ID: ${existingTile?.id ?? 'None'}');
+ print(' Needs Updating & Not Creating: $needsUpdating');
  */
 
  // Get any existing bytes from the tile, if it exists
  Uint8List? bytes;
  if (!needsCreating) bytes = Uint8List.fromList(existingTile.bytes);
 
  // IF network is disabled & the tile does not exist THEN throw an error
- if (settings.behavior == CacheBehavior.cacheOnly && needsCreating) {
+ if (provider.settings.behavior == CacheBehavior.cacheOnly &&
+ needsCreating) {
  return finish(
  throwError:
  'Failed to load the tile from the cache because it was missing.',
@@ -208,12 +206,15 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
  );
 
  // If an new tile was created over the tile limit, delete the oldest tile
- if (needsCreating && settings.maxStoreLength != 0) {
+ if (needsCreating && provider.settings.maxStoreLength != 0) {
  unawaited(
  removeOldestQueue.add(
  () => compute(
  _removeOldestTile,
- [provider.storeDirectory.storeName, settings.maxStoreLength],
+ [
+ provider.storeDirectory.storeName,
+ provider.settings.maxStoreLength,
+ ],
  ),
  ),
  );
@@ -233,15 +234,23 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
  @override
  bool operator ==(Object other) =>
  identical(this, other) ||
- (other is FMTCImageProvider && other.coords == coords);
+ (other is FMTCImageProvider &&
+ other.runtimeType == runtimeType &&
+ other.coords == coords &&
+ other.provider == provider &&
+ other.options == options);
 
  @override
- int get hashCode => coords.hashCode;
+ int get hashCode => Object.hashAllUnordered([
+ coords.hashCode,
+ provider.hashCode,
+ options.hashCode,
+ ]);
 }
 
 Future<void> _removeOldestTile(List<Object> args) async {
  final db = Isar.openSync(
- [DbTileSchema, DbMetadataSchema],
+ [DbStoreDescriptorSchema, DbTileSchema, DbMetadataSchema],
  name: DatabaseTools.hash(args[0] as String).toString(),
  inspector: false,
  );

lib/src/providers/tile_provider.dart

@@ -72,4 +72,22 @@ class FMTCTileProvider extends TileProvider {
  required TileLayer options,
  }) async =>
  await _tiles.get(DatabaseTools.hash(getTileUrl(coords, options))) != null;
+
+ @override
+ bool operator ==(Object other) =>
+ identical(this, other) ||
+ (other is FMTCTileProvider &&
+ other.runtimeType == runtimeType &&
+ other.httpClient == httpClient &&
+ other.settings == settings &&
+ other.storeDirectory == storeDirectory &&
+ other.headers == headers);
+
+ @override
+ int get hashCode => Object.hashAllUnordered([
+ httpClient.hashCode,
+ settings.hashCode,
+ storeDirectory.hashCode,
+ headers.hashCode,
+ ]);
 }

lib/src/root/migrator.dart

@@ -197,7 +197,9 @@ class RootMigrator {
  }
 
  // Delete store files
- if (deleteOldStructure) await oldStores.delete(recursive: true);
+ if (deleteOldStructure && await oldStores.exists()) {
+ await oldStores.delete(recursive: true);
+ }
 
  return results;
  }

lib/src/settings/tile_provider_settings.dart

@@ -95,12 +95,15 @@ class FMTCTileProviderSettings {
  other.behavior == behavior &&
  other.cachedValidDuration == cachedValidDuration &&
  other.maxStoreLength == maxStoreLength &&
- other.errorHandler == errorHandler);
+ other.errorHandler == errorHandler &&
+ other.obscuredQueryParams == obscuredQueryParams);
 
  @override
- int get hashCode =>
- behavior.hashCode ^
- cachedValidDuration.hashCode ^
- maxStoreLength.hashCode ^
- errorHandler.hashCode;
+ int get hashCode => Object.hashAllUnordered([
+ behavior.hashCode,
+ cachedValidDuration.hashCode,
+ maxStoreLength.hashCode,
+ errorHandler.hashCode,
+ obscuredQueryParams.hashCode,
+ ]);
 }

prebuiltExampleApplications/AndroidApplication.apk

@@ -1,7 +1,7 @@
 name: flutter_map_tile_caching
 description: Plugin for 'flutter_map' providing advanced caching functionality,
  with ability to download map regions for offline use.
-version: 7.1.1
+version: 7.1.2
 repository: https://github.com/JaffaKetchup/flutter_map_tile_caching
 issue_tracker: https://github.com/JaffaKetchup/flutter_map_tile_caching/issues
 documentation: https://fmtc.jaffaketchup.dev