feat: show permission denied message, addressing #2403 (comment)

singerdmx · Dec 2, 2024 · 230d8f9 · 230d8f9
1 parent ef4968d
commit 230d8f9
Show file tree

Hide file tree

Showing 47 changed files with 353 additions and 60 deletions.
diff --git a/flutter_quill_extensions/lib/src/editor/image/image_menu.dart b/flutter_quill_extensions/lib/src/editor/image/image_menu.dart
@@ -149,11 +149,21 @@ class ImageOptionsMenu extends StatelessWidget {
               final localizations = context.loc;
               Navigator.of(context).pop();
 
-              final result = await imageSaver.saveImage(
-                imageUrl: imageSource,
-                imageProvider: imageProvider,
-                prefersGallerySave: prefersGallerySave,
-              );
+              SaveImageResult? result;
+              try {
+                result = await imageSaver.saveImage(
+                  imageUrl: imageSource,
+                  imageProvider: imageProvider,
+                  prefersGallerySave: prefersGallerySave,
+                );
+              } on GalleryImageSaveAccessDeniedException {
+                messenger.showSnackBar(SnackBar(
+                    content: Text(
+                  localizations.saveImagePermissionDenied,
+                )));
+                return;
+              }
+
               if (result == null) {
                 messenger.showSnackBar(SnackBar(
                     content: Text(

diff --git a/flutter_quill_extensions/lib/src/editor/image/image_save_utils.dart b/flutter_quill_extensions/lib/src/editor/image/image_save_utils.dart
@@ -107,6 +107,18 @@ Future<bool> shouldSaveToGallery({required bool prefersGallerySave}) async {
   return supportsGallerySave && prefersGallerySave;
 }
 
+/// Thrown when the gallery image save operation is denied
+/// due to insufficient or denied permissions.
+class GalleryImageSaveAccessDeniedException implements Exception {
+  GalleryImageSaveAccessDeniedException([this.message]);
+
+  final String? message;
+
+  @override
+  String toString() =>
+      message ?? 'Permission to save the image was denied or insufficient.';
+}
+
 ImageSaver _imageSaver = ImageSaver();
 
 ImageSaver get imageSaver => _imageSaver;
@@ -115,7 +127,8 @@ ImageSaver get imageSaver => _imageSaver;
 set imageSaver(ImageSaver value) => _imageSaver = value;
 
 class ImageSaver {
-// Returns `null` on failure.
+  // Returns `null` on failure.
+  // Throws [GalleryImageSaveAccessDeniedException] in case permission was denied or insuffeicnet.
   Future<SaveImageResult?> saveImage({
     required String imageUrl,
     required ImageProvider imageProvider,
@@ -192,7 +205,7 @@ class ImageSaver {
             rethrow;
           }
 
-          return null;
+          throw GalleryImageSaveAccessDeniedException(e.toString());
         }
         rethrow;
       }

diff --git a/flutter_quill_extensions/test/editor/image/image_save_utils_test.dart b/flutter_quill_extensions/test/editor/image/image_save_utils_test.dart
@@ -529,21 +529,28 @@ void main() {
       },
     );
 
-    test('returns null in case permission is denied', () async {
+    test(
+        'throws $GalleryImageSaveAccessDeniedException in case permission is denied',
+        () async {
       await mockShouldSaveToGallery(true);
 
       mockLoadImageBytesValue(Uint8List.fromList([1, 2, 2]));
 
+      final platformException = PlatformException(code: 'PERMISSION_DENIED');
       when(() => mockQuillNativeBridge.saveImageToGallery(any(),
-              options: any(named: 'options')))
-          .thenThrow(PlatformException(code: 'PERMISSION_DENIED'));
+          options: any(named: 'options'))).thenThrow(platformException);
 
-      final result = await imageSaver.saveImage(
-        imageProvider: FakeImageProvider(),
-        imageUrl: '/foo/bar',
-        prefersGallerySave: false,
+      await expectLater(
+        imageSaver.saveImage(
+          imageProvider: FakeImageProvider(),
+          imageUrl: '/foo/bar',
+          prefersGallerySave: false,
+        ),
+        throwsA(
+          isA<GalleryImageSaveAccessDeniedException>().having(
+              (e) => e.message, 'message', platformException.toString()),
+        ),
       );
-      expect(result, isNull);
     });
 
     test(

diff --git a/flutter_quill_extensions/test/editor/image/widgets/image_menu_test.dart b/flutter_quill_extensions/test/editor/image/widgets/image_menu_test.dart
@@ -58,6 +58,14 @@ void main() {
             ),
           ).thenAnswer((_) async => result);
 
+      void mockSaveImageThrows(Exception exception) => when(
+            () => mockImageSaver.saveImage(
+              imageUrl: any(named: 'imageUrl'),
+              imageProvider: any(named: 'imageProvider'),
+              prefersGallerySave: any(named: 'prefersGallerySave'),
+            ),
+          ).thenThrow(exception);
+
       Future<void> tapTargetWidget(WidgetTester tester) async {
         await tester.tap(findTargetWidget());
         await tester.pump();
@@ -100,6 +108,46 @@ void main() {
         );
       }
 
+      testWidgets(
+          'shows permission denied message only when permission is denied',
+          (tester) async {
+        mockSaveImageThrows(GalleryImageSaveAccessDeniedException());
+
+        await pumpTargetWidget(tester);
+        await tapTargetWidget(tester);
+
+        final localizations = tester.localizationsFromElement(ImageOptionsMenu);
+
+        expect(
+          find.text(localizations.saveImagePermissionDenied),
+          findsOneWidget,
+        );
+        expect(
+          find.text(localizations.errorUnexpectedSavingImage),
+          findsNothing,
+        );
+        expect(
+          find.text(localizations.successImageDownloaded),
+          findsNothing,
+        );
+        expect(
+          find.text(localizations.successImageSavedGallery),
+          findsNothing,
+        );
+        expect(
+          find.text(localizations.successImageSaved),
+          findsNothing,
+        );
+        expect(
+          find.text(localizations.openFileLocation),
+          findsNothing,
+        );
+        expect(
+          find.text(localizations.openGallery),
+          findsNothing,
+        );
+      });
+
       testWidgets('shows error message when saving fails', (tester) async {
         mockSaveImageResult(null);
 

diff --git a/lib/src/l10n/generated/quill_localizations.dart b/lib/src/l10n/generated/quill_localizations.dart
@@ -804,6 +804,12 @@ abstract class FlutterQuillLocalizations {
   /// In en, this message translates to:
   /// **'Open File Location'**
   String get openFileLocation;
+
+  /// Message shown when the app is unable to save an image because a required permission was denied or skipped.
+  ///
+  /// In en, this message translates to:
+  /// **'Couldn’t save the image due to missing permission.'**
+  String get saveImagePermissionDenied;
 }
 
 class _FlutterQuillLocalizationsDelegate

diff --git a/lib/src/l10n/generated/quill_localizations_ar.dart b/lib/src/l10n/generated/quill_localizations_ar.dart
@@ -323,4 +323,8 @@ class FlutterQuillLocalizationsAr extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_bg.dart b/lib/src/l10n/generated/quill_localizations_bg.dart
@@ -325,4 +325,8 @@ class FlutterQuillLocalizationsBg extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_bn.dart b/lib/src/l10n/generated/quill_localizations_bn.dart
@@ -331,4 +331,8 @@ class FlutterQuillLocalizationsBn extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_ca.dart b/lib/src/l10n/generated/quill_localizations_ca.dart
@@ -327,4 +327,8 @@ class FlutterQuillLocalizationsCa extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_cs.dart b/lib/src/l10n/generated/quill_localizations_cs.dart
@@ -325,4 +325,8 @@ class FlutterQuillLocalizationsCs extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_da.dart b/lib/src/l10n/generated/quill_localizations_da.dart
@@ -323,4 +323,8 @@ class FlutterQuillLocalizationsDa extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_de.dart b/lib/src/l10n/generated/quill_localizations_de.dart
@@ -329,4 +329,8 @@ class FlutterQuillLocalizationsDe extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_el.dart b/lib/src/l10n/generated/quill_localizations_el.dart
@@ -330,4 +330,8 @@ class FlutterQuillLocalizationsEl extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_en.dart b/lib/src/l10n/generated/quill_localizations_en.dart
@@ -325,6 +325,10 @@ class FlutterQuillLocalizationsEn extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
 
 /// The translations for English, as used in the United States (`en_US`).

diff --git a/lib/src/l10n/generated/quill_localizations_es.dart b/lib/src/l10n/generated/quill_localizations_es.dart
@@ -325,4 +325,8 @@ class FlutterQuillLocalizationsEs extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_fa.dart b/lib/src/l10n/generated/quill_localizations_fa.dart
@@ -326,4 +326,8 @@ class FlutterQuillLocalizationsFa extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_fr.dart b/lib/src/l10n/generated/quill_localizations_fr.dart
@@ -331,4 +331,8 @@ class FlutterQuillLocalizationsFr extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_he.dart b/lib/src/l10n/generated/quill_localizations_he.dart
@@ -325,4 +325,8 @@ class FlutterQuillLocalizationsHe extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_hi.dart b/lib/src/l10n/generated/quill_localizations_hi.dart
@@ -328,4 +328,8 @@ class FlutterQuillLocalizationsHi extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_hu.dart b/lib/src/l10n/generated/quill_localizations_hu.dart
@@ -330,4 +330,8 @@ class FlutterQuillLocalizationsHu extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_id.dart b/lib/src/l10n/generated/quill_localizations_id.dart
@@ -328,4 +328,8 @@ class FlutterQuillLocalizationsId extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_it.dart b/lib/src/l10n/generated/quill_localizations_it.dart
@@ -329,4 +329,8 @@ class FlutterQuillLocalizationsIt extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_ja.dart b/lib/src/l10n/generated/quill_localizations_ja.dart
@@ -322,4 +322,8 @@ class FlutterQuillLocalizationsJa extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_km.dart b/lib/src/l10n/generated/quill_localizations_km.dart
@@ -326,4 +326,8 @@ class FlutterQuillLocalizationsKm extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_ko.dart b/lib/src/l10n/generated/quill_localizations_ko.dart
@@ -322,4 +322,8 @@ class FlutterQuillLocalizationsKo extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_ku.dart b/lib/src/l10n/generated/quill_localizations_ku.dart
@@ -326,6 +326,10 @@ class FlutterQuillLocalizationsKu extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
 
 /// The translations for Kurdish (`ku_CKB`).

diff --git a/lib/src/l10n/generated/quill_localizations_ms.dart b/lib/src/l10n/generated/quill_localizations_ms.dart
@@ -326,4 +326,8 @@ class FlutterQuillLocalizationsMs extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_ne.dart b/lib/src/l10n/generated/quill_localizations_ne.dart
@@ -329,4 +329,8 @@ class FlutterQuillLocalizationsNe extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }
diff --git a/lib/src/l10n/generated/quill_localizations_nl.dart b/lib/src/l10n/generated/quill_localizations_nl.dart
@@ -327,4 +327,8 @@ class FlutterQuillLocalizationsNl extends FlutterQuillLocalizations {
 
   @override
   String get openFileLocation => 'Open File Location';
+
+  @override
+  String get saveImagePermissionDenied =>
+      'Couldn’t save the image due to missing permission.';
 }