✨ Introduce PathWrapper (#338)

Author: AlexV525

CHANGELOG.md

@@ -4,6 +4,14 @@ that can be found in the LICENSE file. -->
 
 # Changelog
 
+## 8.0.0-dev.1
+
+To know more about breaking changes, see [Migration Guide][].
+
+### Improvements
+
+- Introduce `PathWrapper` to improve the overall loading speed. (#338)
+
 ## 7.3.2
 
 ### Improvements

analysis_options.yaml

@@ -29,7 +29,8 @@ analyzer:
 
 linter:
   rules:
-    # This list is derived from the list of all available lints located at
+    # these rules are documented on and in the same order as
+    # the Dart Lint rules page to make maintenance easier
     # https://github.com/dart-lang/linter/blob/master/example/all.yaml
     - always_declare_return_types
     - always_put_control_body_on_new_line
@@ -40,34 +41,32 @@ linter:
     - annotate_overrides
     # - avoid_annotating_with_dynamic # conflicts with always_specify_types
     - avoid_bool_literals_in_conditional_expressions
-    # - avoid_catches_without_on_clauses # blocked on https://github.com/dart-lang/linter/issues/3023
-    # - avoid_catching_errors # blocked on https://github.com/dart-lang/linter/issues/3023
+    # - avoid_catches_without_on_clauses # we do this commonly
+    # - avoid_catching_errors # we do this commonly
     - avoid_classes_with_only_static_members
-    - avoid_double_and_int_checks
+    # - avoid_double_and_int_checks # only useful when targeting JS runtime
     - avoid_dynamic_calls
     - avoid_empty_else
     - avoid_equals_and_hash_code_on_mutable_classes
     - avoid_escaping_inner_quotes
     - avoid_field_initializers_in_const_classes
-    # - avoid_final_parameters # incompatible with prefer_final_parameters
     - avoid_function_literals_in_foreach_calls
-    - avoid_implementing_value_types
+    # - avoid_implementing_value_types # not yet tested
     - avoid_init_to_null
-    - avoid_js_rounded_ints
-    # - avoid_multiple_declarations_per_line # seems to be a stylistic choice we don't subscribe to
+    # - avoid_js_rounded_ints # only useful when targeting JS runtime
     - avoid_null_checks_in_equality_operators
-    # - avoid_positional_boolean_parameters # would have been nice to enable this but by now there's too many places that break it
-    - avoid_print
+    # - avoid_positional_boolean_parameters # not yet tested
+    # - avoid_print # not yet tested
     # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
     - avoid_redundant_argument_values
     - avoid_relative_lib_imports
     - avoid_renaming_method_parameters
     - avoid_return_types_on_setters
-    # - avoid_returning_null # still violated by some pre-nnbd code that we haven't yet migrated
-    - avoid_returning_null_for_future
+    # - avoid_returning_null # there are plenty of valid reasons to return null
+    # - avoid_returning_null_for_future # not yet tested
     - avoid_returning_null_for_void
-    # - avoid_returning_this # there are enough valid reasons to return `this` that this lint ends up with too many false positives
-    - avoid_setters_without_getters
+    # - avoid_returning_this # there are plenty of valid reasons to return this
+    # - avoid_setters_without_getters # not yet tested
     - avoid_shadowing_type_parameters
     - avoid_single_cascade_in_expression_statements
     - avoid_slow_async_io
@@ -77,28 +76,24 @@ linter:
     - avoid_unnecessary_containers
     - avoid_unused_constructor_parameters
     - avoid_void_async
-    # - avoid_web_libraries_in_flutter # we use web libraries in web-specific code, and our tests prevent us from using them elsewhere
+    # - avoid_web_libraries_in_flutter # not yet tested
     - await_only_futures
     - camel_case_extensions
     - camel_case_types
     - cancel_subscriptions
-    # - cascade_invocations # doesn't match the typical style of this repo
-    - cast_nullable_to_non_nullable
+    # - cascade_invocations # not yet tested
     # - close_sinks # not reliable enough
     # - comment_references # blocked on https://github.com/dart-lang/linter/issues/1142
-    # - conditional_uri_does_not_exist # not yet tested
     # - constant_identifier_names # needs an opt-out https://github.com/dart-lang/linter/issues/204
     - control_flow_in_finally
     # - curly_braces_in_flow_control_structures # not required by flutter style
-    - depend_on_referenced_packages
     - deprecated_consistency
-    # - diagnostic_describe_all_properties # enabled only at the framework level (packages/flutter/lib)
+    # - diagnostic_describe_all_properties # not yet tested
     - directives_ordering
-    # - do_not_use_environment # there are appropriate times to use the environment, especially in our tests and build logic
+    # - do_not_use_environment # we do this commonly
     - empty_catches
     - empty_constructor_bodies
     - empty_statements
-    - eol_at_end_of_file
     - exhaustive_cases
     - file_names
     - flutter_style_todos
@@ -110,25 +105,22 @@ linter:
     - leading_newlines_in_multiline_strings
     - library_names
     - library_prefixes
-    - library_private_types_in_public_api
     # - lines_longer_than_80_chars # not required by flutter style
     - list_remove_unrelated_type
-    # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/linter/issues/453
+    # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/sdk/issues/34181
     - missing_whitespace_between_adjacent_strings
     - no_adjacent_strings_in_list
-    - no_default_cases
+    # - no_default_cases # too many false positives
     - no_duplicate_case_values
-    - no_leading_underscores_for_library_prefixes
-    - no_leading_underscores_for_local_identifiers
     - no_logic_in_create_state
     # - no_runtimeType_toString # ok in tests; we enable this only in packages/
-    - non_constant_identifier_names
     - noop_primitive_operations
+    - non_constant_identifier_names
     - null_check_on_nullable_type_parameter
     - null_closures
     # - omit_local_variable_types # opposite of always_specify_types
     # - one_member_abstracts # too many false positives
-    - only_throw_errors # this does get disabled in a few places where we have legacy code that uses strings et al
+    # - only_throw_errors # https://github.com/flutter/flutter/issues/5792
     - overridden_fields
     - package_api_docs
     - package_names
@@ -151,7 +143,6 @@ linter:
     - prefer_final_fields
     - prefer_final_in_for_each
     - prefer_final_locals
-    # - prefer_final_parameters # we should enable this one day when it can be auto-fixed (https://github.com/dart-lang/linter/issues/3104), see also parameter_assignments
     - prefer_for_elements_to_map_fromIterable
     - prefer_foreach
     - prefer_function_declarations_over_variables
@@ -166,23 +157,20 @@ linter:
     - prefer_is_not_empty
     - prefer_is_not_operator
     - prefer_iterable_whereType
-    # - prefer_mixin # Has false positives, see https://github.com/dart-lang/linter/issues/3018
-    # - prefer_null_aware_method_calls # "call()" is confusing to people new to the language since it's not documented anywhere
+    # - prefer_mixin # https://github.com/dart-lang/language/issues/32
     - prefer_null_aware_operators
-    - prefer_relative_imports
+    # - prefer_relative_imports # incompatible with sub-package imports
     - prefer_single_quotes
     - prefer_spread_collections
     - prefer_typing_uninitialized_variables
     - prefer_void_to_null
     - provide_deprecation_message
     # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml
     - recursive_getters
-    # - require_trailing_commas # blocked on https://github.com/dart-lang/sdk/issues/47441
-    - secure_pubspec_urls
+    - require_trailing_commas
     - sized_box_for_whitespace
-    # - sized_box_shrink_expand # not yet tested
     - slash_for_doc_comments
-    - sort_child_properties_last
+    # - sort_child_properties_last # not yet tested
     - sort_constructors_first
     # - sort_pub_dependencies # prevents separating pinned transitive dependencies
     - sort_unnamed_constructors_first
@@ -191,45 +179,38 @@ linter:
     - tighten_type_of_initializing_formals
     # - type_annotate_public_apis # subset of always_specify_types
     - type_init_formals
-    # - unawaited_futures # too many false positives, especially with the way AnimationController works
+    # - unawaited_futures # too many false positives
     - unnecessary_await_in_return
     - unnecessary_brace_in_string_interps
     - unnecessary_const
-    - unnecessary_constructor_name
     # - unnecessary_final # conflicts with prefer_final_locals
     - unnecessary_getters_setters
     # - unnecessary_lambdas # has false positives: https://github.com/dart-lang/linter/issues/498
-    - unnecessary_late
     - unnecessary_new
     - unnecessary_null_aware_assignments
     - unnecessary_null_checks
     - unnecessary_null_in_if_null_operators
     - unnecessary_nullable_for_final_variable_declarations
     - unnecessary_overrides
     - unnecessary_parenthesis
-    # - unnecessary_raw_strings # what's "necessary" is a matter of opinion; consistency across strings can help readability more than this lint
+    # - unnecessary_raw_strings # not yet tested
     - unnecessary_statements
     - unnecessary_string_escapes
     - unnecessary_string_interpolations
     - unnecessary_this
     - unrelated_type_equality_checks
-    - unsafe_html
-    # - use_build_context_synchronously
-    # - use_colored_box # not yet tested
-    # - use_decorated_box # not yet tested
-    # - use_enums # not yet tested
+    # - unsafe_html # not yet tested
     - use_full_hex_values_for_flutter_colors
     - use_function_type_syntax_for_parameters
-    - use_if_null_to_convert_nulls_to_bools
+    # - use_if_null_to_convert_nulls_to_bools # not yet tested
     - use_is_even_rather_than_modulo
     - use_key_in_widget_constructors
     - use_late_for_private_fields_and_variables
     - use_named_constants
     - use_raw_strings
     - use_rethrow_when_possible
-    - use_setters_to_change_properties
+    # - use_setters_to_change_properties # not yet tested
     # - use_string_buffers # has false positives: https://github.com/dart-lang/sdk/issues/34182
-    - use_super_parameters
     - use_test_throws_matchers
     # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review
     - valid_regexps

example/lib/constants/picker_method.dart

@@ -164,9 +164,12 @@ class PickMethod {
                     final DefaultAssetPickerBuilderDelegate builder =
                         picker.builder as DefaultAssetPickerBuilderDelegate;
                     final DefaultAssetPickerProvider p = builder.provider;
-                    p.currentPath =
-                        await p.currentPath!.obtainForNewProperties();
-                    await p.switchPath(p.currentPath);
+                    await p.switchPath(
+                      PathWrapper<AssetPathEntity>(
+                        path:
+                            await p.currentPath!.path.obtainForNewProperties(),
+                      ),
+                    );
                     p.selectAsset(result);
                   },
                   child: const Center(

example/lib/customs/pickers/directory_file_asset_picker.dart

@@ -295,19 +295,24 @@ class FileAssetPickerProvider extends AssetPickerProvider<File, Directory> {
   }) : super(selectedAssets: selectedAssets) {
     Future<void>.delayed(const Duration(milliseconds: 300), () async {
       await getPaths();
-      getAssetsFromPath(0, pathsList.keys.elementAt(0));
+      getAssetsFromPath(0, paths.first.path);
     });
   }
 
   @override
   Future<void> getPaths() async {
     currentAssets = <File>[];
-    pathsList.clear();
+    paths.clear();
     final Directory? directory = await getExternalStorageDirectory();
     if (directory != null) {
-      pathsList[directory] = null;
-      currentPath = directory;
-      pathsList[directory] = await getThumbnailFromPath(directory);
+      final PathWrapper<Directory> wrapper = PathWrapper<Directory>(
+        path: directory,
+        thumbnailData: await getThumbnailFromPath(
+          PathWrapper<Directory>(path: directory),
+        ),
+      );
+      paths.add(wrapper);
+      currentPath = wrapper;
     }
   }
 
@@ -327,9 +332,9 @@ class FileAssetPickerProvider extends AssetPickerProvider<File, Directory> {
   }
 
   @override
-  Future<Uint8List?> getThumbnailFromPath(Directory path) async {
+  Future<Uint8List?> getThumbnailFromPath(PathWrapper<Directory> path) async {
     final List<FileSystemEntity> entities =
-        path.listSync().whereType<File>().toList();
+        path.path.listSync().whereType<File>().toList();
     currentAssets.clear();
     for (final FileSystemEntity entity in entities) {
       final String extension = basename(entity.path).split('.').last;
@@ -354,14 +359,14 @@ class FileAssetPickerProvider extends AssetPickerProvider<File, Directory> {
   }
 
   @override
-  Future<void> switchPath([Directory? path]) async {
+  Future<void> switchPath([PathWrapper<Directory>? path]) async {
     if (path == null) {
       return;
     }
     currentPath = path;
     totalAssetsCount = 0;
     notifyListeners();
-    await getAssetsFromPath(0, currentPath!);
+    await getAssetsFromPath(0, currentPath!.path);
   }
 }
 
@@ -839,15 +844,15 @@ class FileAssetPickerBuilder
           ),
         ),
       ),
-      child: Selector<FileAssetPickerProvider, Map<Directory, Uint8List?>>(
-        selector: (_, FileAssetPickerProvider p) => p.pathsList,
-        builder: (_, Map<Directory, Uint8List?> pathEntityList, __) {
+      child: Selector<FileAssetPickerProvider, List<PathWrapper<Directory>>>(
+        selector: (_, FileAssetPickerProvider p) => p.paths,
+        builder: (_, List<PathWrapper<Directory>> paths, __) {
           return ListView.separated(
             padding: const EdgeInsetsDirectional.only(top: 1.0),
-            itemCount: pathEntityList.length,
+            itemCount: paths.length,
             itemBuilder: (_, int index) => pathEntityWidget(
               context: context,
-              list: pathEntityList,
+              list: paths,
               index: index,
             ),
             separatorBuilder: (_, __) => Container(
@@ -877,15 +882,15 @@ class FileAssetPickerBuilder
           child: Row(
             mainAxisSize: MainAxisSize.min,
             children: <Widget>[
-              Selector<FileAssetPickerProvider, Directory?>(
+              Selector<FileAssetPickerProvider, PathWrapper<Directory>?>(
                 selector: (_, FileAssetPickerProvider p) => p.currentPath,
-                builder: (_, Directory? currentPathEntity, __) {
-                  if (currentPathEntity == null) {
+                builder: (_, PathWrapper<Directory>? currentWrapper, __) {
+                  if (currentWrapper == null) {
                     return const SizedBox.shrink();
                   }
                   return Flexible(
                     child: Text(
-                      provider.currentPath!.path,
+                      currentWrapper.path.path,
                       style: const TextStyle(
                         fontSize: 18.0,
                         fontWeight: FontWeight.normal,
@@ -929,12 +934,13 @@ class FileAssetPickerBuilder
   @override
   Widget pathEntityWidget({
     required BuildContext context,
-    required Map<Directory, Uint8List?> list,
+    required List<PathWrapper<Directory>> list,
     required int index,
     bool isAudio = false,
   }) {
-    final Directory path = list.keys.elementAt(index);
-    final Uint8List? data = list.values.elementAt(index);
+    final PathWrapper<Directory> wrapper = list[index];
+    final Directory path = wrapper.path;
+    final Uint8List? data = wrapper.thumbnailData;
 
     Widget builder() {
       if (data != null) {
@@ -951,7 +957,7 @@ class FileAssetPickerBuilder
       child: InkWell(
         splashFactory: InkSplash.splashFactory,
         onTap: () {
-          provider.switchPath(path);
+          provider.switchPath(wrapper);
           isSwitchingPath.value = false;
         },
         child: SizedBox(
@@ -978,17 +984,16 @@ class FileAssetPickerBuilder
                   ),
                 ),
               ),
-              Selector<FileAssetPickerProvider, Directory>(
+              Selector<FileAssetPickerProvider, PathWrapper<Directory>>(
                 selector: (_, FileAssetPickerProvider p) => p.currentPath!,
-                builder: (_, Directory currentPathEntity, __) {
-                  if (currentPathEntity == path) {
+                builder: (_, PathWrapper<Directory> currentPathEntity, __) {
+                  if (currentPathEntity == wrapper) {
                     return const AspectRatio(
                       aspectRatio: 1.0,
                       child: Icon(Icons.check, color: themeColor, size: 26.0),
                     );
-                  } else {
-                    return const SizedBox.shrink();
                   }
+                  return const SizedBox.shrink();
                 },
               ),
             ],