chore: Shared common scanner (#3883)

* First movement

* devcotainer

* Lint fixes

* Shared visor

* Final moves

* Final lint fixes

* Empty widget, moved scan header

* Update scanner_ml_kit.dart

---------

Co-authored-by: Marvin Moeltgen

.devcontainer/devcontainer.json

@@ -1,14 +1,15 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.224.3/containers/ubuntu
 {
-    "image": "docker.io/cirrusci/flutter:beta",
+    "image": "docker.io/cirrusci/flutter:stable",
 	"forwardPorts": [
 		3000
 	],
 	"customizations": {
 		"vscode": {
 			"extensions": [
-				"Dart-Code.flutter"
+				"Dart-Code.flutter",
+				"dart-code.dart-code"
 			]
 		}
 	}

packages/scanner/ml_kit/.gitignore

@@ -0,0 +1,26 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+
+# Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+.packages
+build/

packages/scanner/ml_kit/.metadata

@@ -0,0 +1,30 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled.
+
+version:
+  revision: eb6d86ee27deecba4a83536aa20f366a6044895c
+  channel: stable
+
+project_type: plugin
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: eb6d86ee27deecba4a83536aa20f366a6044895c
+      base_revision: eb6d86ee27deecba4a83536aa20f366a6044895c
+    - platform: android
+      create_revision: eb6d86ee27deecba4a83536aa20f366a6044895c
+      base_revision: eb6d86ee27deecba4a83536aa20f366a6044895c
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'

packages/scanner/ml_kit/analysis_options.yaml

@@ -0,0 +1,2 @@
+# Shared rules
+include: package:openfoodfacts_flutter_lints/flutter.yaml

packages/scanner/ml_kit/lib/scanner_ml_kit.dart

@@ -0,0 +1,3 @@
+library app_store_uri;
+
+export 'src/scanner_ml_kit.dart';

packages/smooth_app/lib/pages/scan/smooth_barcode_scanner_mlkit.dart → packages/scanner/ml_kit/lib/src/scanner_ml_kit.dart

@@ -2,30 +2,59 @@ import 'dart:async';
 
 import 'package:flutter/material.dart';
 import 'package:mobile_scanner/mobile_scanner.dart';
-import 'package:smooth_app/generic_lib/design_constants.dart';
-import 'package:smooth_app/helpers/analytics_helper.dart';
-import 'package:smooth_app/helpers/camera_helper.dart';
-import 'package:smooth_app/helpers/haptic_feedback_helper.dart';
-import 'package:smooth_app/pages/scan/scan_header.dart';
-import 'package:smooth_app/pages/scan/smooth_barcode_scanner_visor.dart';
-import 'package:smooth_app/widgets/screen_visibility.dart';
+import 'package:scanner_shared/scanner_shared.dart';
 import 'package:visibility_detector/visibility_detector.dart';
 
+/// Scanner implementation using ML Kit
+class ScannerMLKit extends Scanner {
+  const ScannerMLKit();
+
+  @override
+  String getType() => 'ML Kit';
+
+  @override
+  Widget getScanner({
+    required Future<bool> Function(String) onScan,
+    required Future<void> Function() hapticFeedback,
+    required Function(BuildContext)? onCameraFlashError,
+    required Function(String msg, String category,
+            {int? eventValue, String? barcode})
+        trackCustomEvent,
+    required bool hasMoreThanOneCamera,
+  }) {
+    return _SmoothBarcodeScannerMLKit(
+      onScan: onScan,
+      hapticFeedback: hapticFeedback,
+      trackCustomEvent: trackCustomEvent,
+      onCameraFlashError: onCameraFlashError,
+      hasMoreThanOneCamera: hasMoreThanOneCamera,
+    );
+  }
+}
+
 /// Barcode scanner based on MLKit.
-class SmoothBarcodeScannerMLKit extends StatefulWidget {
-  const SmoothBarcodeScannerMLKit(
-    this.onScan, {
-    this.onCameraFlashError,
+class _SmoothBarcodeScannerMLKit extends StatefulWidget {
+  const _SmoothBarcodeScannerMLKit({
+    required this.onScan,
+    required this.hapticFeedback,
+    required this.trackCustomEvent,
+    required this.onCameraFlashError,
+    required this.hasMoreThanOneCamera,
   });
 
   final Future<bool> Function(String) onScan;
+  final Future<void> Function() hapticFeedback;
+
+  final Function(String msg, String category,
+      {int? eventValue, String? barcode}) trackCustomEvent;
   final Function(BuildContext)? onCameraFlashError;
+  final bool hasMoreThanOneCamera;
 
   @override
   State<StatefulWidget> createState() => _SmoothBarcodeScannerMLKitState();
 }
 
-class _SmoothBarcodeScannerMLKitState extends State<SmoothBarcodeScannerMLKit>
+class _SmoothBarcodeScannerMLKitState extends State<_SmoothBarcodeScannerMLKit>
     with SingleTickerProviderStateMixin {
   // just 1D formats and ios supported
   static const List<BarcodeFormat> _barcodeFormats = <BarcodeFormat>[
@@ -43,7 +72,7 @@ class _SmoothBarcodeScannerMLKitState extends State<SmoothBarcodeScannerMLKit>
 
   bool _isStarted = true;
 
-  bool get _showFlipCameraButton => CameraHelper.hasMoreThanOneCamera;
+  bool get _showFlipCameraButton => widget.hasMoreThanOneCamera;
 
   final MobileScannerController _controller = MobileScannerController(
     torchEnabled: false,
@@ -67,9 +96,8 @@ class _SmoothBarcodeScannerMLKitState extends State<SmoothBarcodeScannerMLKit>
       await _controller.start();
       _isStarted = true;
     } on Exception {
-      AnalyticsHelper.trackEvent(
-        AnalyticsEvent.scanStrangeRestart,
-      );
+      widget.trackCustomEvent(
+          Scanner.ANALYTICS_STRANGE_RESTART, Scanner.ANALYTICS_CATEGORY);
     }
   }
 
@@ -81,17 +109,16 @@ class _SmoothBarcodeScannerMLKitState extends State<SmoothBarcodeScannerMLKit>
       await _controller.stop();
       _isStarted = false;
     } on Exception {
-      AnalyticsHelper.trackEvent(
-        AnalyticsEvent.scanStrangeRestop,
-      );
+      widget.trackCustomEvent(
+          Scanner.ANALYTICS_STRANGE_RESTOP, Scanner.ANALYTICS_CATEGORY);
     }
   }
 
   @override
   Widget build(BuildContext context) => VisibilityDetector(
         key: const ValueKey<String>('VisibilityDetector'),
         onVisibilityChanged: (final VisibilityInfo info) async {
-          if (info.visible) {
+          if (info.visibleBounds.height > 0.0) {
             await _start();
           } else {
             await _stop();
@@ -123,10 +150,6 @@ class _SmoothBarcodeScannerMLKitState extends State<SmoothBarcodeScannerMLKit>
                 child: SmoothBarcodeScannerVisor(),
               ),
             ),
-            const Align(
-              alignment: Alignment.topCenter,
-              child: ScanHeader(),
-            ),
             Align(
               alignment: Alignment.bottomCenter,
               child: Padding(
@@ -156,7 +179,7 @@ class _SmoothBarcodeScannerMLKitState extends State<SmoothBarcodeScannerMLKit>
                           },
                         ),
                         onPressed: () async {
-                          SmoothHapticFeedback.click();
+                          widget.hapticFeedback.call();
                           await _controller.switchCamera();
                         },
                       ),
@@ -168,7 +191,7 @@ class _SmoothBarcodeScannerMLKitState extends State<SmoothBarcodeScannerMLKit>
                         Widget? child,
                       ) {
                         if (state != true) {
-                          return EMPTY_WIDGET;
+                          return const SizedBox.shrink();
                         }
                         return IconButton(
                           color: Colors.white,
@@ -194,7 +217,7 @@ class _SmoothBarcodeScannerMLKitState extends State<SmoothBarcodeScannerMLKit>
                             },
                           ),
                           onPressed: () async {
-                            SmoothHapticFeedback.click();
+                            widget.hapticFeedback.call();
 
                             try {
                               await _controller.toggleTorch();

packages/scanner/ml_kit/pubspec.yaml

@@ -0,0 +1,23 @@
+name: scanner_ml_kit
+description: Scanner implementation using ML Kit
+version: 1.0.0
+publish_to: "none"
+
+environment:
+  sdk: ">=2.19.0 <3.0.0"
+
+dependencies:
+  flutter:
+    sdk: flutter
+
+  visibility_detector: 0.4.0+2
+  mobile_scanner: 3.2.0
+  scanner_shared:
+    path: ../shared
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+  flutter_lints: 2.0.1
+  openfoodfacts_flutter_lints:
+    git: https://github.com/openfoodfacts/openfoodfacts_flutter_lints.git

packages/scanner/ml_kit/test/scanner_ml_kit_test.dart

@@ -0,0 +1,8 @@
+import 'package:flutter_test/flutter_test.dart';
+
+// The CI needs at least one test
+void main() {
+  testWidgets('Fake test', (WidgetTester tester) async {
+    expect(true, true);
+  });
+}

packages/scanner/shared/.gitignore

@@ -0,0 +1,30 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+.packages
+build/

packages/scanner/shared/.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: eb6d86ee27deecba4a83536aa20f366a6044895c
+  channel: stable
+
+project_type: package

packages/scanner/shared/analysis_options.yaml

@@ -0,0 +1,2 @@
+# Shared rules
+include: package:openfoodfacts_flutter_lints/flutter.yaml

packages/scanner/shared/lib/scanner_shared.dart

@@ -0,0 +1,6 @@
+library app_store_shared;
+
+export 'src/scanner.dart';
+export 'src/scanner_mocked.dart';
+export 'src/scanner_visor.dart';
+export 'src/utils.dart';

packages/scanner/shared/lib/src/scanner.dart

@@ -0,0 +1,22 @@
+import 'package:flutter/material.dart';
+
+/// Base class for the Scanner interface…
+abstract class Scanner {
+  const Scanner();
+
+  static const String ANALYTICS_CATEGORY = 'scanning';
+  static const String ANALYTICS_STRANGE_RESTART = 'strange restart';
+  static const String ANALYTICS_STRANGE_RESTOP = 'strange restop';
+
+  String getType();
+
+  Widget getScanner({
+    required Future<bool> Function(String) onScan,
+    required Future<void> Function() hapticFeedback,
+    required Function(BuildContext)? onCameraFlashError,
+    required Function(String msg, String category,
+            {int? eventValue, String? barcode})
+        trackCustomEvent,
+    required bool hasMoreThanOneCamera,
+  });
+}

packages/scanner/shared/lib/src/scanner_mocked.dart

@@ -0,0 +1,23 @@
+import 'package:flutter/material.dart';
+
+import 'package:scanner_shared/scanner_shared.dart';
+
+/// Empty implementation for an [AppStore]
+class MockedScanner extends Scanner {
+  const MockedScanner();
+
+  @override
+  String getType() => 'Mocked';
+
+  @override
+  Widget getScanner({
+    required Future<bool> Function(String) onScan,
+    required Future<void> Function() hapticFeedback,
+    required Function(BuildContext)? onCameraFlashError,
+    required Function(String msg, String category,
+            {int? eventValue, String? barcode})
+        trackCustomEvent,
+    required bool hasMoreThanOneCamera,
+  }) =>
+      Container();
+}