v7.0.1: Minor bug fixes and improvements (#88)

JaffaKetchup · github-actions[bot] · web-flow · commit 999cc4c8ba23 · 2023-02-11T19:11:25.000Z
* Increased protection from null check errors triggered by incorrect usage Hidden Isar Inspector console links * Built Example Applications * Minor bug fix * Built Example Applications * Improved GitHub issue tracker configuration * Added `_StoreDb` to simplify structural feature classes * Built Example Applications * Updated changelog --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Former-commit-id: b4f3a31c4bd33940312c1c69d8d026186ab2a903 [formerly 7dcf2d1] Former-commit-id: be83319a553be4c247fe6906318776dd60480614
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml
@@ -34,8 +34,6 @@ body:
       description: |
         Please include a [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example) (preferable), otherwise detail the exact steps to reproduce this issue.
         If you do not include any information here, it will take longer for us to verify your issue.
-      placeholder: Text automatically formatted as Dart code, on submission
-      render: dart
   - type: textarea
     id: solution
     attributes:
@@ -63,7 +61,6 @@ body:
         - Windows
         - MacOS
         - Linux
-        - Other
     validations:
       required: true
   - type: dropdown
@@ -97,15 +94,13 @@ body:
     id: terms
     attributes:
       label: Requirements
-      description: These are in place to prevent spam and unnecessary reports.
+      description: These are in place to prevent spam and unnecessary reports. Please read and understand them fully before posting.
       options:
         - label: I agree to follow this project's [Code of Conduct](https://github.com/jaffaketchup/flutter_map_tile_caching/blob/main/CODE_OF_CONDUCT.md)
           required: true
-        - label: My Flutter/Dart installation is unaltered, and `flutter doctor` finds no relevant issues
+        - label: I have checked for known issues in the GitHub tracker and [on the docs site](https://fmtc.jaffaketchup.dev/known-issues-and-reporting#known-issues)
           required: true
-        - label: I am using the [latest stable version](https://pub.dev/packages/flutter_map_tile_caching) of this package
+        - label: I have completed the pre-report checks listed [on the docs site](https://fmtc.jaffaketchup.dev/known-issues-and-reporting#reporting-a-bug)
           required: true
-        - label: I have checked the FAQs section on the documentation website
-          required: true
-        - label: I have checked for similar issues which may be duplicates
+        - label: If I am using FMTC in a proprietary project, I have read and understood [this important legal notice](https://fmtc.jaffaketchup.dev/#proprietary-licensing)
           required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,8 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-  - name: Official Discord Server
+  - name: Official 'flutter_map' Discord Server
     url: https://discord.gg/egEGeByf4q
-    about: Need more generalised help, or just want to talk? Join the Discord server, which has a dedicated channel for plugins!
-  - name: flutter_map Issues
-    url: https://github.com/fleaflet/flutter_map/issues
-    about: If your issue is due to a problem in 'flutter_map', please post your issue there instead
+    about: Need more generalised help? Join the Discord server, which has a dedicated channel for plugins!
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml
@@ -47,7 +47,6 @@ body:
         - Windows
         - MacOS
         - Linux
-        - Other
     validations:
       required: true
   - type: dropdown
@@ -68,11 +67,13 @@ body:
     id: terms
     attributes:
       label: Requirements
-      description: These are in place to prevent spam and unnecessary reports.
+      description: These are in place to prevent spam. Please read and understand them fully before posting.
       options:
         - label: I agree to follow this project's [Code of Conduct](https://github.com/jaffaketchup/flutter_map_tile_caching/blob/main/CODE_OF_CONDUCT.md)
           required: true
+        - label: I have checked for similar feature requests which may be duplicates
+          required: true
         - label: I am using the [latest stable version](https://pub.dev/packages/flutter_map_tile_caching) of this package
           required: true
-        - label: I have checked for similar feature requests which may be duplicates
+        - label: If I am using FMTC in a proprietary project, I have read and understood [this important legal notice](https://fmtc.jaffaketchup.dev/#proprietary-licensing)
           required: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,12 @@ Many thanks to my sponsors, no matter how much or how little they donated. Spons
 
 # Changelog
 
-## [7.0.0] - 2023/01/XX
+## [7.0.1] - 2023/02/11
+
+* Minor bug fixes
+* Minor improvements
+
+## [7.0.0] - 2023/02/04
 
 * Migrated to Isar database
 * Major performance improvements, thanks to Isar
diff --git a/README.md b/README.md
@@ -43,4 +43,4 @@ However, I am willing to sell alternative (proprietary) licenses on a case-by-ca
 
 I learnt (and am still learning) to code with free, open-source software due to my age and lack of money, and for that reason, I believe in promoting open-source wherever possible to give equal opportunities to everybody, no matter their age or financial position. I'm not sure it's fair for commercial proprietary applications to use software made by people for free out of generosity. On the other hand, I am also trying to make a small amount of money from my projects, by donations or by selling licenses. And I recognise that commercial businesses may want to use my projects for their own proprietary applications.
 
-Therefore, if you would like a license to use this software within a proprietary, I am willing to sell a (preferably yearly or usage based) license for a reasonable price. If this seems like what you want/need, please do not hesitate to get in touch via [github@jaffaketchup.com](mailto://github@jaffaketchup.com).
+Therefore, if you would like a license to use this software within a proprietary, I am willing to sell a (preferably yearly or usage based) license for a reasonable price. If this seems like what you want/need, please do not hesitate to get in touch via [fmtc@jaffaketchup.com](mailto:fmtc@jaffaketchup.com).
diff --git a/example/currentAppVersion.txt b/example/currentAppVersion.txt
@@ -1 +1 @@
-7.0.0
+7.0.1
diff --git a/example/lib/screens/main/pages/settingsAndAbout/settings_and_about.dart b/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 v6.0.0\n(on ${Platform().operatingSystemFormatted})',
+                              'for v7.0.0\n(on ${Platform().operatingSystemFormatted})',
                           applicationIcon: Image.asset(
                             'assets/icons/ProjectIcon.png',
                             height: 48,
diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -3,7 +3,7 @@ description: The example application for 'flutter_map_tile_caching', showcasing
   it's functionality and use-cases.
 publish_to: "none"
 
-version: 7.0.0
+version: 7.0.1
 
 environment:
   sdk: ">=2.18.0 <3.0.0"
diff --git a/lib/flutter_map_tile_caching.dart b/lib/flutter_map_tile_caching.dart
@@ -52,6 +52,7 @@ export 'src/settings/tile_provider_settings.dart';
 
 part 'src/bulk_download/download_progress.dart';
 part 'src/fmtc.dart';
+part 'src/misc/store_db_impl.dart';
 part 'src/misc/typedefs.dart';
 part 'src/providers/tile_provider.dart';
 part 'src/regions/base_region.dart';
diff --git a/lib/fmtc_module_api.dart b/lib/fmtc_module_api.dart
@@ -6,8 +6,25 @@
 /// Restricted API which exports internal functionality, necessary for the FMTC
 /// modules to work correctly
 ///
-/// **Do not use in normal applications. Prefer importing
-/// 'flutter_map_tile_caching.dart'.**
+/// When importing this library, also import 'flutter_map_tile_caching.dart' for
+/// the full functionality set.
+///
+/// ---
+///
+/// "With great power comes great responsibility" - Someone
+///
+/// This library forms part of a layer of abstraction between you, FMTC
+/// internals, and underlying databases. Importing this library removes that
+/// abstraction, making it easy to disrupt FMTC's normal operations with
+/// incorrect usage. For example, it is possible to force close an open Isar
+/// database, leading to an erroneous & invalid state.
+///
+/// If you are using this to create a custom module, go ahead! Please do get in
+/// touch, I'm always interested to hear what the community is making, and I may
+/// be able to offer some insight into the darker corners and workings of FMTC.
+/// Note that not necessarily all internal APIs are exposed through this library.
+///
+/// **Do not use in normal applications. I may be unable to offer support.**
 library fmtc_module_api;
 
 export 'src/db/defs/metadata.dart';
diff --git a/lib/src/bulk_download/downloader.dart b/lib/src/bulk_download/downloader.dart
@@ -72,8 +72,7 @@ Future<TileProgress> _getAndSaveTile({
   required int downloadID,
   required InternalProgressTimingManagement progressManagement,
 }) async {
-  final Isar tiles = FMTCRegistry.instance
-      .storeDatabases[DatabaseTools.hash(provider.storeDirectory.storeName)]!;
+  final Isar tiles = FMTCRegistry.instance(provider.storeDirectory.storeName);
 
   final String url = provider.getTileUrl(coord, options);
   final DbTile? existingTile = await tiles.tiles.get(DatabaseTools.hash(url));
diff --git a/lib/src/db/registry.dart b/lib/src/db/registry.dart
@@ -14,25 +14,26 @@ import 'defs/metadata.dart';
 import 'defs/recovery.dart';
 import 'defs/store_descriptor.dart';
 import 'defs/tile.dart';
+import 'tools.dart';
 
 /// Manages the stores available
 ///
-/// It is very important for the [storeDatabases] state to remain in sync with
+/// It is very important for the [_storeDatabases] state to remain in sync with
 /// the actual state of the [directory], otherwise unexpected behaviour may
 /// occur.
 @internal
 class FMTCRegistry {
   const FMTCRegistry._({
     required this.directory,
     required this.recoveryDatabase,
-    required this.storeDatabases,
-  });
+    required Map<int, Isar> storeDatabases,
+  }) : _storeDatabases = storeDatabases;
 
   static late FMTCRegistry instance;
 
   final Directory directory;
   final Isar recoveryDatabase;
-  final Map<int, Isar> storeDatabases;
+  final Map<int, Isar> _storeDatabases;
 
   static Future<FMTCRegistry> initialise({
     required Directory directory,
@@ -42,10 +43,12 @@ class FMTCRegistry {
     IOSink? initialisationSafetyWriteSink,
     List<String>? safeModeSuccessfulIDs,
   }) async {
+    final recoveryFile = directory >>> '.recovery.isar';
+
     bool hasLocatedCorruption = false;
 
-    if (safeModeSuccessfulIDs != null) {
-      await (directory >>> '.recovery.isar').delete();
+    if (safeModeSuccessfulIDs != null && await recoveryFile.exists()) {
+      await recoveryFile.delete();
     }
 
     await directory
@@ -62,6 +65,7 @@ class FMTCRegistry {
         directory: directory.absolute.path,
         maxSizeMiB: databaseMaxSize,
         compactOnLaunch: databaseCompactCondition,
+        inspector: false,
       ),
       storeDatabases: Map.fromEntries(
         await directory
@@ -98,6 +102,7 @@ class FMTCRegistry {
                     directory: directory.absolute.path,
                     maxSizeMiB: databaseMaxSize,
                     compactOnLaunch: databaseCompactCondition,
+                    inspector: false,
                   ),
                 );
                 initialisationSafetyWriteSink?.writeln(id);
@@ -124,4 +129,20 @@ class FMTCRegistry {
       recoveryDatabase.close(deleteFromDisk: delete),
     ]);
   }
+
+  Isar call(String storeName) {
+    final id = DatabaseTools.hash(storeName);
+    final isRegistered = _storeDatabases.containsKey(id);
+    if (!(isRegistered && _storeDatabases[id]!.isOpen)) {
+      throw FMTCStoreNotReady(
+        storeName: storeName,
+        registered: isRegistered,
+      );
+    }
+    return _storeDatabases[id]!;
+  }
+
+  Isar register(int id, Isar db) => _storeDatabases[id] = db;
+  Isar? unregister(int id) => _storeDatabases.remove(id);
+  Map<int, Isar> get storeDatabases => _storeDatabases;
 }
diff --git a/lib/src/misc/store_db_impl.dart b/lib/src/misc/store_db_impl.dart
@@ -0,0 +1,8 @@
+part of flutter_map_tile_caching;
+
+abstract class _StoreDb {
+  const _StoreDb(this._store);
+
+  final StoreDirectory _store;
+  Isar get _db => FMTCRegistry.instance(_store.storeName);
+}
diff --git a/lib/src/providers/image_provider.dart b/lib/src/providers/image_provider.dart
@@ -48,6 +48,8 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
   /// 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,
@@ -56,10 +58,7 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
     required this.httpClient,
     required this.headers,
   })  : settings = provider.settings,
-        _storeId = DatabaseTools.hash(provider.storeDirectory.storeName);
-
-  final int _storeId;
-  Isar get _tiles => FMTCRegistry.instance.storeDatabases[_storeId]!;
+        _db = FMTCRegistry.instance(provider.storeDirectory.storeName);
 
   @override
   ImageStreamCompleter loadBuffer(
@@ -90,13 +89,11 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
       required bool hit,
     }) =>
         (hit ? cacheHitsQueue : cacheMissesQueue).add(() async {
-          final db = FMTCRegistry.instance.storeDatabases[_storeId]!;
-
-          await db.writeTxn(() async {
-            final store = (await db.storeDescriptor.get(0))!;
+          await _db.writeTxn(() async {
+            final store = (await _db.storeDescriptor.get(0))!;
             if (hit) store.hits += 1;
             if (!hit) store.misses += 1;
-            await db.storeDescriptor.put(store);
+            await _db.storeDescriptor.put(store);
           });
         });
 
@@ -133,8 +130,7 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
     }
 
     final String url = provider.getTileUrl(coords, options);
-    final DbTile? existingTile =
-        await _tiles.tiles.get(DatabaseTools.hash(url));
+    final DbTile? existingTile = await _db.tiles.get(DatabaseTools.hash(url));
 
     // Logic to check whether the tile needs creating or updating
     final bool needsCreating = existingTile == null;
@@ -208,8 +204,7 @@ class FMTCImageProvider extends ImageProvider<FMTCImageProvider> {
 
       // Cache the tile asynchronously
       unawaited(
-        _tiles
-            .writeTxn(() => _tiles.tiles.put(DbTile(url: url, bytes: bytes!))),
+        _db.writeTxn(() => _db.tiles.put(DbTile(url: url, bytes: bytes!))),
       );
 
       // If an new tile was created over the tile limit, delete the oldest tile
@@ -248,6 +243,7 @@ Future<void> _removeOldestTile(List<Object> args) async {
   final db = Isar.openSync(
     [DbTileSchema, DbMetadataSchema],
     name: DatabaseTools.hash(args[0] as String).toString(),
+    inspector: false,
   );
 
   db.writeTxnSync(
diff --git a/lib/src/providers/tile_provider.dart b/lib/src/providers/tile_provider.dart
@@ -54,8 +54,8 @@ class FMTCTileProvider extends TileProvider {
         },
       );
 
-  IsarCollection<DbTile> get _tiles => FMTCRegistry.instance
-      .storeDatabases[DatabaseTools.hash(storeDirectory.storeName)]!.tiles;
+  IsarCollection<DbTile> get _tiles =>
+      FMTCRegistry.instance(storeDirectory.storeName).tiles;
 
   /// Check whether a specified tile is cached in the current store synchronously
   bool checkTileCached({
diff --git a/lib/src/root/directory.dart b/lib/src/root/directory.dart
@@ -12,7 +12,7 @@ part of flutter_map_tile_caching;
 ///
 /// Reach through [FlutterMapTileCaching.rootDirectory].
 class RootDirectory {
-  RootDirectory._(this.directory);
+  const RootDirectory._(this.directory);
 
   /// The real directory beneath which FMTC places all data - usually located
   /// within the application's directories
@@ -28,22 +28,22 @@ class RootDirectory {
   ///
   /// To create, initialise FMTC. Assume that FMTC is ready after initialisation
   /// and before [RootManagement.delete] is called.
-  RootManagement get manage => RootManagement._();
+  RootManagement get manage => const RootManagement._();
 
   /// Get statistics about this root (and all sub-stores)
-  RootStats get stats => RootStats._();
+  RootStats get stats => const RootStats._();
 
   /// Manage the download recovery of all sub-stores
   RootRecovery get recovery => RootRecovery.instance ?? RootRecovery._();
 
   /// Manage migration for file structure across FMTC versions
-  RootMigrator get migrator => RootMigrator._();
+  RootMigrator get migrator => const RootMigrator._();
 
   /// Provides store import functionality for this root
   ///
   /// The 'fmtc_plus_sharing' module must be installed to add the functionality,
   /// without it, this object provides no functionality.
-  RootImport get import => RootImport._();
+  RootImport get import => const RootImport._();
 
   @override
   bool operator ==(Object other) =>
diff --git a/lib/src/root/import.dart b/lib/src/root/import.dart
@@ -8,5 +8,5 @@ part of flutter_map_tile_caching;
 ///
 /// Does not include any functionality without the module.
 class RootImport {
-  RootImport._();
+  const RootImport._();
 }
diff --git a/lib/src/root/manage.dart b/lib/src/root/manage.dart
@@ -6,7 +6,7 @@ part of flutter_map_tile_caching;
 /// Manages a [RootDirectory]'s representation on the filesystem, such as
 /// creation and deletion
 class RootManagement {
-  RootManagement._();
+  const RootManagement._();
 
   /// Delete the root directory, database, and stores
   ///
diff --git a/lib/src/root/migrator.dart b/lib/src/root/migrator.dart
diff --git a/lib/src/root/statistics.dart b/lib/src/root/statistics.dart
diff --git a/lib/src/store/export.dart b/lib/src/store/export.dart
diff --git a/lib/src/store/manage.dart b/lib/src/store/manage.dart
diff --git a/lib/src/store/metadata.dart b/lib/src/store/metadata.dart
diff --git a/lib/src/store/statistics.dart b/lib/src/store/statistics.dart
diff --git a/prebuiltExampleApplications/AndroidApplication.apk.REMOVED.git-id b/prebuiltExampleApplications/AndroidApplication.apk.REMOVED.git-id
diff --git a/prebuiltExampleApplications/WindowsApplication.exe.REMOVED.git-id b/prebuiltExampleApplications/WindowsApplication.exe.REMOVED.git-id
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,4 @@ However, I am willing to sell alternative (proprietary) licenses on a case-by-ca`
`43`	`43`
`44`	`44`	I learnt (and am still learning) to code with free, open-source software due to my age and lack of money, and for that reason, I believe in promoting open-source wherever possible to give equal opportunities to everybody, no matter their age or financial position. I'm not sure it's fair for commercial proprietary applications to use software made by people for free out of generosity. On the other hand, I am also trying to make a small amount of money from my projects, by donations or by selling licenses. And I recognise that commercial businesses may want to use my projects for their own proprietary applications.
`45`	`45`
`46`		`-Therefore, if you would like a license to use this software within a proprietary, I am willing to sell a (preferably yearly or usage based) license for a reasonable price. If this seems like what you want/need, please do not hesitate to get in touch via [github@jaffaketchup.com](mailto://github@jaffaketchup.com).`
	`46`	`+Therefore, if you would like a license to use this software within a proprietary, I am willing to sell a (preferably yearly or usage based) license for a reasonable price. If this seems like what you want/need, please do not hesitate to get in touch via [fmtc@jaffaketchup.com](mailto:fmtc@jaffaketchup.com).`