binding: Add pickImage, wrapping image_picker.pickImage

Author: chrisbobbe

lib/model/binding.dart

@@ -4,6 +4,7 @@ import 'package:firebase_core/firebase_core.dart' as firebase_core;
 import 'package:firebase_messaging/firebase_messaging.dart' as firebase_messaging;
 import 'package:flutter/foundation.dart';
 import 'package:flutter_local_notifications/flutter_local_notifications.dart';
+import 'package:image_picker/image_picker.dart' as image_picker;
 import 'package:package_info_plus/package_info_plus.dart' as package_info_plus;
 import 'package:url_launcher/url_launcher.dart' as url_launcher;
 
@@ -13,6 +14,7 @@ import '../widgets/store.dart';
 import 'store.dart';
 
 export 'package:file_picker/file_picker.dart' show FilePickerResult, FileType, PlatformFile;
+export 'package:image_picker/image_picker.dart' show ImageSource, XFile;
 
 /// Alias for [url_launcher.LaunchMode].
 typedef UrlLaunchMode = url_launcher.LaunchMode;
@@ -164,6 +166,14 @@ abstract class ZulipBinding {
  bool withReadStream,
  file_picker.FileType type,
  });
+
+ /// Pick files from the camera or media library, via package:image_picker.
+ ///
+ /// This wraps [image_picker.pickImage].
+ Future<image_picker.XFile?> pickImage({
+ required image_picker.ImageSource source,
+ bool requestFullMetadata,
+ });
 }
 
 /// Like [device_info_plus.BaseDeviceInfo], but without things we don't use.
@@ -414,4 +424,13 @@ class LiveZulipBinding extends ZulipBinding {
  type: type,
  );
  }
+
+ @override
+ Future<image_picker.XFile?> pickImage({
+ required image_picker.ImageSource source,
+ bool requestFullMetadata = true,
+ }) async {
+ return image_picker.ImagePicker()
+ .pickImage(source: source, requestFullMetadata: requestFullMetadata);
+ }
 }

lib/widgets/compose_box.dart

@@ -2,7 +2,6 @@ import 'package:app_settings/app_settings.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_gen/gen_l10n/zulip_localizations.dart';
-import 'package:image_picker/image_picker.dart';
 
 import '../api/exception.dart';
 import '../api/model/model.dart';
@@ -624,15 +623,15 @@ class _AttachFromCameraButton extends _AttachUploadsButton {
  @override
  Future<Iterable<_File>> getFiles(BuildContext context) async {
  final zulipLocalizations = ZulipLocalizations.of(context);
- final picker = ImagePicker();
  final XFile? result;
  try {
  // Ideally we'd open a platform interface that lets you choose between
  // taking a photo and a video. `image_picker` doesn't yet have that
  // option: https://github.com/flutter/flutter/issues/89159
  // so just stick with images for now. We could add another button for
  // videos, but we don't want too many buttons.
- result = await picker.pickImage(source: ImageSource.camera, requestFullMetadata: false);
+ result = await ZulipBinding.instance.pickImage(
+ source: ImageSource.camera, requestFullMetadata: false);
  } catch (e) {
  if (!context.mounted) return [];
  if (e is PlatformException && e.code == 'camera_access_denied') {

test/model/binding.dart

@@ -74,6 +74,7 @@ class TestZulipBinding extends ZulipBinding {
  _resetFirebase();
  _resetNotifications();
  _resetPickFiles();
+ _resetPickImage();
  }
 
  /// The current global store offered to a [GlobalStoreWidget].
@@ -328,6 +329,45 @@ class TestZulipBinding extends ZulipBinding {
  (_pickFilesCalls ??= []).add((allowMultiple: allowMultiple, withReadStream: withReadStream, type: type));
  return pickFilesResult;
  }
+
+ /// The value that `ZulipBinding.instance.pickImage()` should return.
+ ///
+ /// See also [takePickImageCalls].
+ XFile? pickImageResult;
+
+ void _resetPickImage() {
+ pickImageResult = null;
+ _pickImageCalls = null;
+ }
+
+ /// Consume the log of calls made to `ZulipBinding.instance.pickImage()`.
+ ///
+ /// This returns a list of the arguments to all calls made
+ /// to `ZulipBinding.instance.pickImage()` since the last call to
+ /// either this method or [reset].
+ ///
+ /// See also [pickImageResult].
+ List<({
+ ImageSource source,
+ bool requestFullMetadata,
+ })> takePickImageCalls() {
+ final result = _pickImageCalls;
+ _pickImageCalls = null;
+ return result ?? [];
+ }
+ List<({
+ ImageSource source,
+ bool requestFullMetadata,
+ })>? _pickImageCalls;
+
+ @override
+ Future<XFile?> pickImage({
+ required ImageSource source,
+ bool requestFullMetadata = true,
+ }) async {
+ (_pickImageCalls ??= []).add((source: source, requestFullMetadata: requestFullMetadata));
+ return pickImageResult;
+ }
 }
 
 class FakeFirebaseMessaging extends Fake implements FirebaseMessaging {