Resolve issue 359

lib/extensions/load_hive_extension.dart

@@ -0,0 +1,17 @@
+import 'package:flutter/foundation.dart';
+import 'package:flutter/material.dart';
+import 'package:hive_flutter/hive_flutter.dart';
+import 'package:path/path.dart';
+
+/// Flutter extensions for Hive.
+extension HiveWithFolder on HiveInterface {
+  /// Initializes Hive with the path from [appDir].
+  ///
+  /// You can provide a [subDir] where the boxes should be stored.
+  Future<void> initHiveWithRootFolder(String appDir, [String? subDir]) async {
+    WidgetsFlutterBinding.ensureInitialized();
+    if (kIsWeb) return;
+
+    init(join(appDir, subDir));
+  }
+}

lib/main.dart

@@ -1,3 +1,5 @@
+import 'package:apidash/widgets/hive_directory_selector.dart';
+import 'package:file_selector/file_selector.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
 import 'package:google_fonts/google_fonts.dart';
@@ -8,17 +10,21 @@ import 'app.dart';
 void main() async {
   WidgetsFlutterBinding.ensureInitialized();
   GoogleFonts.config.allowRuntimeFetching = false;
-  await openBoxes();
   if (kIsLinux) {
     await setupInitialWindow();
   }
   if (kIsMacOS || kIsWindows) {
     var win = getInitialSize();
     await setupWindow(sz: win.$1, off: win.$2);
   }
+
+
   runApp(
-    const ProviderScope(
-      child: DashApp(),
+    const HiveDirectorySelector(
+      getDirectoryPath: getDirectoryPath,
+      child: ProviderScope(
+        child: DashApp(),
+      ),
     ),
   );
 }

lib/models/hive_storage_folder.dart

@@ -0,0 +1,30 @@
+// Store hive save folder path.
+// SharedPreferences dynamicall changes saving folder based on platform, which isn't null.
+// Contrary to this hive stores the data in `getApplicationDocumentsDirectory()` given by 
+// the path_provider package. Which is platform dependent and could be null. 
+// See this issue for more details:
+//  - https://github.com/foss42/apidash/issues/359
+
+import 'package:shared_preferences/shared_preferences.dart';
+
+// The key to store the folder path in shared preferences.
+const String kHiveSaveFolder = 'hive_save_folder';
+
+Future<String?> getHiveSaveFolder() async {
+  // Retrieves the folder path where hive stores data. 
+  // Which is stored in shared preferences.
+
+  // Getting the shared preferences instance.
+  final prefs = await SharedPreferences.getInstance();
+  // Getting the folder path.
+  return prefs.getString(kHiveSaveFolder);
+}
+
+Future<void> setHiveSaveFolder(String folder) async {
+  // Sets the folder path where hive stores data. 
+
+  // Getting the shared preferences instance.
+  final prefs = await SharedPreferences.getInstance();
+  // Setting the folder path.
+  await prefs.setString(kHiveSaveFolder, folder);
+}

lib/services/hive_services.dart

@@ -1,3 +1,4 @@
+import 'package:apidash/extensions/load_hive_extension.dart';
 import 'package:flutter/material.dart';
 import 'package:hive_flutter/hive_flutter.dart';
 
@@ -8,8 +9,8 @@ const String kKeyEnvironmentBoxIds = "environmentIds";
 
 const String kSettingsBox = "apidash-settings";
 
-Future<void> openBoxes() async {
-  await Hive.initFlutter();
+Future<void> openBoxes(String hiveSaveFolder) async {
+  await Hive.initHiveWithRootFolder(hiveSaveFolder);
   await Hive.openBox(kDataBox);
   await Hive.openBox(kSettingsBox);
   await Hive.openBox(kEnvironmentBox);

lib/widgets/hive_directory_selector.dart

@@ -0,0 +1,63 @@
+import 'package:apidash/models/hive_storage_folder.dart';
+import 'package:apidash/services/hive_services.dart';
+import 'package:flutter/material.dart';
+
+class HiveDirectorySelector extends StatefulWidget {
+  final Widget child;
+  final Future<String?> Function() getDirectoryPath;
+  const HiveDirectorySelector({super.key, required this.child, required this.getDirectoryPath});
+
+  @override
+  HiveDirectorySelectorState createState() => HiveDirectorySelectorState();
+}
+
+class HiveDirectorySelectorState extends State<HiveDirectorySelector> {
+  void selectFolder() async {
+    // Show the folder selection menu
+    String? selectedDirectory = await widget.getDirectoryPath();
+    // TODO: check if can write in current folder
+    // If the selected selectedDirectory isn't null save it as hive save folder
+    if (selectedDirectory != null) setHiveSaveFolder(selectedDirectory);
+    // Changing the state of application
+    setState(() {});
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    const circularLoader = MaterialApp(
+      home: Scaffold(
+        body: Center(
+          child: CircularProgressIndicator(),
+        ),
+      ),
+    );
+
+    return FutureBuilder<String?>(
+      future: getHiveSaveFolder(),
+      builder: (BuildContext context, AsyncSnapshot<String?> snapshot) {
+        if (snapshot.connectionState != ConnectionState.done) {
+          return circularLoader;
+        }
+
+        // If there isn't hive selected folder choose it
+        if (snapshot.data == null) {
+          selectFolder();
+          return circularLoader;
+        }
+
+        // Once _hiveSaveFolder is set, display DashApp after hive init
+        return FutureBuilder<void>(
+          future: openBoxes(snapshot.data!),
+          builder: (BuildContext context, AsyncSnapshot<void> snapshot) {
+            // if loading show circularLoader
+            if (snapshot.connectionState != ConnectionState.done) {
+              return circularLoader;
+            }
+            // Display widget
+            return widget.child;
+          },
+        );
+      },
+    );
+  }
+}

pubspec.lock

@@ -1121,6 +1121,62 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "0.3.8"
+  shared_preferences:
+    dependency: "direct main"
+    description:
+      name: shared_preferences
+      sha256: d3bbe5553a986e83980916ded2f0b435ef2e1893dfaa29d5a7a790d0eca12180
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.2.3"
+  shared_preferences_android:
+    dependency: transitive
+    description:
+      name: shared_preferences_android
+      sha256: "1ee8bf911094a1b592de7ab29add6f826a7331fb854273d55918693d5364a1f2"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.2.2"
+  shared_preferences_foundation:
+    dependency: transitive
+    description:
+      name: shared_preferences_foundation
+      sha256: "0a8a893bf4fd1152f93fec03a415d11c27c74454d96e2318a7ac38dd18683ab7"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.4.0"
+  shared_preferences_linux:
+    dependency: transitive
+    description:
+      name: shared_preferences_linux
+      sha256: "9f2cbcf46d4270ea8be39fa156d86379077c8a5228d9dfdb1164ae0bb93f1faa"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.3.2"
+  shared_preferences_platform_interface:
+    dependency: transitive
+    description:
+      name: shared_preferences_platform_interface
+      sha256: "22e2ecac9419b4246d7c22bfbbda589e3acf5c0351137d87dd2939d984d37c3b"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.3.2"
+  shared_preferences_web:
+    dependency: transitive
+    description:
+      name: shared_preferences_web
+      sha256: "9aee1089b36bd2aafe06582b7d7817fd317ef05fc30e6ba14bff247d0933042a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.3.0"
+  shared_preferences_windows:
+    dependency: transitive
+    description:
+      name: shared_preferences_windows
+      sha256: "841ad54f3c8381c480d0c9b508b89a34036f512482c407e6df7a9c4aa2ef8f59"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.3.2"
   shelf:
     dependency: transitive
     description:

pubspec.yaml

@@ -60,6 +60,7 @@ dependencies:
   flex_color_scheme: ^7.3.1
   data_table_2: ^2.5.15
   file_selector: ^1.0.3
+  shared_preferences: ^2.2.3
   hooks_riverpod: ^2.5.1
   flutter_hooks: ^0.20.5
   flutter_portal: ^1.1.4

test/models/hive_storage_folder_model.dart

@@ -0,0 +1,20 @@
+import 'dart:io';
+
+import 'package:apidash/models/hive_storage_folder.dart';
+import 'package:shared_preferences/shared_preferences.dart';
+import 'package:test/test.dart';
+
+void main() async{
+  Directory tempDir =
+      await Directory.systemTemp.createTemp('save_folder_path');
+
+  test('Load Hive directory', () async {
+    SharedPreferences.setMockInitialValues({kHiveSaveFolder: tempDir.path});
+    expect(await getHiveSaveFolder(), tempDir.path);
+  });
+
+  test('Saving Hive directory', () async {
+    await setHiveSaveFolder(tempDir.path);
+    expect(await getHiveSaveFolder(), tempDir.path);
+  });
+}

test/providers/ui_providers_test.dart

@@ -29,19 +29,9 @@ void main() {
   TestWidgetsFlutterBinding.ensureInitialized();
 
   setUp(() async {
-    const MethodChannel channel =
-        MethodChannel('plugins.flutter.io/path_provider');
-    TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
-        .setMockMethodCallHandler(channel, (MethodCall methodCall) async {
-      if (methodCall.method == 'getApplicationDocumentsDirectory') {
-        // Create a mock app doc directory for testing
-        Directory tempDir =
-            await Directory.systemTemp.createTemp('mock_app_doc_dir');
-        return tempDir.path; // Return the path to the mock directory
-      }
-      return null;
-    });
-    await openBoxes();
+    Directory tempDir =
+        await Directory.systemTemp.createTemp('mock_app_doc_dir');
+    await openBoxes(tempDir.path);
   });
 
   group('Testing navRailIndexStateProvider', () {

test/widgets/hive_directory_selector_test.dart

@@ -0,0 +1,62 @@
+import 'dart:io';
+
+import 'package:apidash/widgets/hive_directory_selector.dart';
+import 'package:apidash/models/hive_storage_folder.dart';
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:shared_preferences/shared_preferences.dart';
+
+void main() async {
+  Directory tempDir = await Directory.systemTemp.createTemp('hive_dir_temp');
+
+  testWidgets('Given valid path, Then load the child component', (widgetTester) async {
+    await widgetTester.runAsync(() async {
+      // Set the hive save folder
+      SharedPreferences.setMockInitialValues({});
+      await setHiveSaveFolder(tempDir.path);
+
+      // Rendering the widgets
+      await widgetTester.pumpWidget(
+        HiveDirectorySelector(
+          getDirectoryPath: () async => tempDir.path,
+          child: Container(),
+        ),
+      );
+
+      // Find the container widget in the tree
+      expect(find.byType(Container), findsOneWidget);
+    });
+  });
+
+  testWidgets('Given when no path is set, Then set hive save folder',
+      (widgetTester) async {
+    await widgetTester.runAsync(() async {
+      // Checking inital hive save folder to be null
+      SharedPreferences.setMockInitialValues({});
+      expect(await getHiveSaveFolder(), null);
+
+      // rendering the widgets
+      await widgetTester.pumpWidget(
+        HiveDirectorySelector(
+          getDirectoryPath: () async => tempDir.path,
+          child: Container(),
+        ),
+      );
+
+      // making a pump to render the widgets
+      await widgetTester.pump();
+
+      // check if CircularProgressIndicator is shown
+      expect(find.byType(CircularProgressIndicator), findsOneWidget);
+
+      // check if the function `selectFolder` is called
+      final state = widgetTester.state(find.byType(HiveDirectorySelector))
+          as HiveDirectorySelectorState;
+      expect(state.selectFolder, isNotNull,
+          reason: "The function selectFolder isn't rechable.");
+
+      // check if the hive save folder is set
+      expect(await getHiveSaveFolder(), tempDir.path);
+    });
+  });
+}