π End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
[mob][photos] Pin the OCR backend and prepare models on demand
laurenspriem6cc8381b46f0
diff --git a/mobile/apps/photos/lib/services/machine_learning/ocr/rust_ocr_backend.dart b/mobile/apps/photos/lib/services/machine_learning/ocr/rust_ocr_backend.dartindex 5316c61082..67ccd52c59 100644--- a/mobile/apps/photos/lib/services/machine_learning/ocr/rust_ocr_backend.dart+++ b/mobile/apps/photos/lib/services/machine_learning/ocr/rust_ocr_backend.dart@@ -5,6 +5,7 @@ import "package:logging/logging.dart";import "package:photos/services/machine_learning/ml_model_assets.dart";import "package:photos/services/machine_learning/ocr/ocr_backend.dart";import "package:photos/services/machine_learning/ocr/ocr_models.dart";+import "package:photos/services/remote_assets_service.dart";import "package:photos/src/rust/api/ocr_api.dart";import "package:synchronized/synchronized.dart";@@ -92,7 +93,7 @@ class RustOcrBackend implements OcrBackend {bool includeAllConfidenceScores = false,String? requestId,}) async {- final engine = _requireEngine();+ final engine = await _recognitionEngine();try {final result = await engine.detectText(imagePath: imagePath,@@ -114,7 +115,7 @@ class RustOcrBackend implements OcrBackend {required String imagePath,String? requestId,}) async {- final engine = _requireEngine();+ final engine = await _detectionEngine();try {final result = await engine.detectTextRegions(imagePath: imagePath,@@ -136,6 +137,33 @@ class RustOcrBackend implements OcrBackend {return Future.value(imagePath);}+ Future<OcrEngine> _recognitionEngine() async {+ final engine = _engine;+ if (engine != null && _enginePaths.recognition.isNotEmpty) {+ return engine;+ }+ await prepareModels(OcrModelComponent.values.toSet());+ return _requireEngine();+ }++ Future<OcrEngine> _detectionEngine() async {+ final engine = _engine;+ if (engine != null) {+ return engine;+ }+ final detectorAvailable = await RemoteAssetsService.instance.hasAsset(+ OcrDetectionModel.instance.modelRemotePath,+ );+ if (!detectorAvailable) {+ throw const OcrException(+ code: "MODEL_NOT_READY",+ message: "The OCR detector model is not available locally",+ );+ }+ await prepareModels({OcrModelComponent.detector});+ return _requireEngine();+ }+OcrEngine _requireEngine() {final engine = _engine;if (engine == null) {diff --git a/mobile/apps/photos/lib/services/machine_learning/ocr_service.dart b/mobile/apps/photos/lib/services/machine_learning/ocr_service.dartindex 2ea49cafa9..fc0f05a1ec 100644--- a/mobile/apps/photos/lib/services/machine_learning/ocr_service.dart+++ b/mobile/apps/photos/lib/services/machine_learning/ocr_service.dart@@ -39,10 +39,16 @@ class OcrService {final OcrBackend Function() _createLegacyBackend;final OcrBackend Function() _createRustBackend;final OcrBackend Function() _createVisionBackend;- final Map<OcrBackendKind, OcrBackend> _backends = {};- OcrBackendKind? _activeKind;+ late final OcrBackendKind backendKind = _chooseBackendKind();+ late final OcrBackend _backend = _createBackend(backendKind);- OcrBackendKind get backendKind {+ OcrBackendKind _chooseBackendKind() {+ final kind = _preferredBackendKind();+ _logger.info("Using the ${kind.name} OCR backend");+ return kind;+ }++ OcrBackendKind _preferredBackendKind() {if (!_rustOcrEnabled()) {return OcrBackendKind.legacy;}@@ -95,15 +101,6 @@ class OcrService {return _backend.ensureDisplayablePath(imagePath);}- OcrBackend get _backend {- final kind = backendKind;- if (kind != _activeKind) {- _logger.info("Using the ${kind.name} OCR backend");- _activeKind = kind;- }- return _backends.putIfAbsent(kind, () => _createBackend(kind));- }-OcrBackend _createBackend(OcrBackendKind kind) => switch (kind) {OcrBackendKind.legacy => _createLegacyBackend(),OcrBackendKind.rust => _createRustBackend(),diff --git a/mobile/apps/photos/test/services/machine_learning/ocr/ocr_service_test.dart b/mobile/apps/photos/test/services/machine_learning/ocr/ocr_service_test.dartindex ed773b51ba..6619010886 100644--- a/mobile/apps/photos/test/services/machine_learning/ocr/ocr_service_test.dart+++ b/mobile/apps/photos/test/services/machine_learning/ocr/ocr_service_test.dart@@ -139,19 +139,16 @@ void main() {expect(harness.service.backendKind, OcrBackendKind.legacy);});- test("creates each backend once and follows flag changes per call", () async {+ test("pins the backend chosen on first use", () async {final harness = _Harness(rustOcr: false, isAndroid: true, isIOS: false);await harness.service.cancelRequest("a");harness.rustOcr = true;await harness.service.cancelRequest("b");- await harness.service.cancelRequest("c");- harness.rustOcr = false;- await harness.service.cancelRequest("d");- expect(harness.legacy.calls, ["cancelRequest:a", "cancelRequest:d"]);- expect(harness.rust.calls, ["cancelRequest:b", "cancelRequest:c"]);- expect(harness.created, ["legacy", "rust"]);+ expect(harness.legacy.calls, ["cancelRequest:a", "cancelRequest:b"]);+ expect(harness.rust.calls, isEmpty);+ expect(harness.created, ["legacy"]);});test("detectText forwards to the backend for an existing image", () async {diff --git a/mobile/apps/photos/test/services/machine_learning/ocr/rust_ocr_backend_test.dart b/mobile/apps/photos/test/services/machine_learning/ocr/rust_ocr_backend_test.dartindex 8fff4b9596..17eed26eae 100644--- a/mobile/apps/photos/test/services/machine_learning/ocr/rust_ocr_backend_test.dart+++ b/mobile/apps/photos/test/services/machine_learning/ocr/rust_ocr_backend_test.dart@@ -134,24 +134,6 @@ void main() {group("without a prepared engine", () {final backend = RustOcrBackend();- test("detectText throws MODEL_NOT_READY", () {- expect(- backend.detectText(imagePath: "/tmp/photo.jpg"),- throwsA(- isA<OcrException>().having((e) => e.code, "code", "MODEL_NOT_READY"),- ),- );- });-- test("detectTextRegions throws MODEL_NOT_READY", () {- expect(- backend.detectTextRegions(imagePath: "/tmp/photo.jpg"),- throwsA(- isA<OcrException>().having((e) => e.code, "code", "MODEL_NOT_READY"),- ),- );- });-test("cancelRequest completes", () async {await backend.cancelRequest("request");});