ente/mobile/lib/services/magic_cache_service.dart

import "dart:async";
import "dart:convert";
import "dart:io";

import "package:computer/computer.dart";
import "package:flutter/foundation.dart";
import "package:logging/logging.dart";
import "package:path_provider/path_provider.dart";
import "package:photos/db/files_db.dart";
import "package:photos/extensions/stop_watch.dart";
import "package:photos/models/file/file.dart";
import "package:photos/models/ml/discover/prompt.dart";
import "package:photos/models/search/generic_search_result.dart";
import "package:photos/models/search/search_types.dart";
import "package:photos/service_locator.dart";
import "package:photos/services/machine_learning/semantic_search/semantic_search_service.dart";
import "package:photos/services/remote_assets_service.dart";
import "package:photos/ui/viewer/search/result/magic_result_screen.dart";
import "package:photos/utils/navigation_util.dart";
import "package:shared_preferences/shared_preferences.dart";

class MagicCache {
  final String title;
  final List<int> fileUploadedIDs;
  MagicCache(this.title, this.fileUploadedIDs);

  factory MagicCache.fromJson(Map<String, dynamic> json) {
    return MagicCache(
      json['title'],
      List<int>.from(json['fileUploadedIDs']),
    );
  }
  Map<String, dynamic> toJson() {
    return {
      'title': title,
      'fileUploadedIDs': fileUploadedIDs,
    };
  }

  static String encodeListToJson(List<MagicCache> magicCaches) {
    final jsonList = magicCaches.map((cache) => cache.toJson()).toList();
    return jsonEncode(jsonList);
  }

  static List<MagicCache> decodeJsonToList(String jsonString) {
    final jsonList = jsonDecode(jsonString) as List;
    return jsonList.map((json) => MagicCache.fromJson(json)).toList();
  }
}

extension MagicCacheServiceExtension on MagicCache {
  Future<GenericSearchResult?> toGenericSearchResult() async {
    final enteFilesInMagicCache = <EnteFile>[];
    await FilesDB.instance
        .getFilesFromIDs(fileUploadedIDs)
        .then((idToEnteFile) {
      for (int uploadedID in fileUploadedIDs) {
        if (idToEnteFile[uploadedID] != null) {
          enteFilesInMagicCache.add(idToEnteFile[uploadedID]!);
        }
      }
    });
    if (enteFilesInMagicCache.isEmpty) {
      return null;
    }
    return GenericSearchResult(
      ResultType.magic,
      title,
      enteFilesInMagicCache,
      onResultTap: (ctx) {
        routeToPage(
          ctx,
          MagicResultScreen(
            enteFilesInMagicCache,
            name: title,
            heroTag: GenericSearchResult(
              ResultType.magic,
              title,
              enteFilesInMagicCache,
            ).heroTag(),
          ),
        );
      },
    );
  }
}

class MagicCacheService {
  static const _lastMagicCacheUpdateTime = "last_magic_cache_update_time";
  static const _kMagicPromptsDataUrl = "https://discover.ente.io/v1.json";

  /// Delay is for cache update to be done not during app init, during which a
  /// lot of other things are happening.
  static const _kCacheUpdateDelay = Duration(seconds: 10);

  late SharedPreferences _prefs;
  final Logger _logger = Logger((MagicCacheService).toString());
  MagicCacheService._privateConstructor();

  Future<List<MagicCache>>? _magicCacheFuture;

  static final MagicCacheService instance =
      MagicCacheService._privateConstructor();

  void init(SharedPreferences preferences) {
    _logger.info("Initializing MagicCacheService");
    _prefs = preferences;
    _updateCacheIfTheTimeHasCome();
  }

  Future<void> _resetLastMagicCacheUpdateTime() async {
    await _prefs.setInt(
      _lastMagicCacheUpdateTime,
      DateTime.now().millisecondsSinceEpoch,
    );
  }

  int get lastMagicCacheUpdateTime {
    return _prefs.getInt(_lastMagicCacheUpdateTime) ?? 0;
  }

  Future<void> _updateCacheIfTheTimeHasCome() async {
    if (!localSettings.isMLIndexingEnabled) {
      return;
    }
    final updatedJSONFile = await RemoteAssetsService.instance
        .getAssetIfUpdated(_kMagicPromptsDataUrl);
    if (updatedJSONFile != null) {
      Future.delayed(_kCacheUpdateDelay, () {
        unawaited(updateCache());
      });
      return;
    }
    if (lastMagicCacheUpdateTime <
        DateTime.now()
            .subtract(const Duration(days: 3))
            .millisecondsSinceEpoch) {
      Future.delayed(_kCacheUpdateDelay, () {
        unawaited(updateCache());
      });
    }
  }

  Future<String> _getCachePath() async {
    return (await getApplicationSupportDirectory()).path + "/cache/magic_cache";
  }

  Future<List<int>> _getMatchingFileIDsForPromptData(
    Prompt promptData,
  ) async {
    final result = await SemanticSearchService.instance.getMatchingFileIDs(
      promptData.query,
      promptData.minScore,
    );

    return result;
  }

  Future<void> updateCache() async {
    try {
      _logger.info("updating magic cache");
      final EnteWatch? w = kDebugMode ? EnteWatch("magicCacheWatch") : null;
      w?.start();
      final String path = await RemoteAssetsService.instance
          .getAssetPath(_kMagicPromptsDataUrl);
      final magicPromptsData = await Computer.shared().compute(
        _loadMagicPrompts,
        param: <String, dynamic>{
          "path": path,
        },
      );
      w?.log("loadedPrompts");
      final List<MagicCache> magicCaches =
          await _nonEmptyMagicResults(magicPromptsData);
      w?.log("resultComputed");
      final file = File(await _getCachePath());
      if (!file.existsSync()) {
        file.createSync(recursive: true);
      }
      _magicCacheFuture = Future.value(magicCaches);
      await file
          .writeAsBytes(MagicCache.encodeListToJson(magicCaches).codeUnits);
      w?.log("cacheWritten");
      await _resetLastMagicCacheUpdateTime();
      w?.logAndReset('done');
    } catch (e, s) {
      _logger.info("Error updating magic cache", e, s);
    }
  }

  Future<List<MagicCache>> _getMagicCache() async {
    if (_magicCacheFuture != null) {
      return _magicCacheFuture!;
    }
    _magicCacheFuture = _readResultFromDisk();
    return _magicCacheFuture!;
  }

  Future<List<MagicCache>> _readResultFromDisk() async {
    _logger.info("Reading magic cache result from disk");
    final file = File(await _getCachePath());
    if (!file.existsSync()) {
      _logger.info("No magic cache found");
      return [];
    }
    final jsonString = file.readAsStringSync();
    return MagicCache.decodeJsonToList(jsonString);
  }

  Future<void> clearMagicCache() async {
    await File(await _getCachePath()).delete();
  }

  Future<List<GenericSearchResult>> getMagicGenericSearchResult() async {
    try {
      final EnteWatch? w =
          kDebugMode ? EnteWatch("magicGenericSearchResult") : null;
      w?.start();
      final magicCaches = await _getMagicCache();
      if (magicCaches.isEmpty) {
        w?.log("noCacheFound");
        _logger.info("No magic cache found");
        return [];
      } else {
        w?.log("cacheFound");
      }

      final List<GenericSearchResult> genericSearchResults = [];
      for (MagicCache magicCache in magicCaches) {
        final genericSearchResult = await magicCache.toGenericSearchResult();
        if (genericSearchResult != null) {
          genericSearchResults.add(genericSearchResult);
        }
      }
      w?.logAndReset("done");
      return genericSearchResults;
    } catch (e) {
      _logger.info("Error getting magic generic search result", e);
      return [];
    }
  }

  static Future<List<Prompt>> _loadMagicPrompts(
    Map<String, dynamic> args,
  ) async {
    final String path = args["path"] as String;
    final File file = File(path);
    final String contents = await file.readAsString();
    final Map<String, dynamic> promptsJson = jsonDecode(contents);
    final List<dynamic> promptData = promptsJson['prompts'];
    return promptData
        .map<Prompt>((jsonItem) => Prompt.fromJson(jsonItem))
        .toList();
  }

  ///Returns non-empty magic results from magicPromptsData
  ///Length is number of prompts, can be less if there are not enough non-empty
  ///results
  Future<List<MagicCache>> _nonEmptyMagicResults(
    List<Prompt> magicPromptsData,
  ) async {
    final results = <MagicCache>[];
    for (Prompt prompt in magicPromptsData) {
      final fileUploadedIDs = await _getMatchingFileIDsForPromptData(
        prompt,
      );
      if (fileUploadedIDs.isNotEmpty) {
        results.add(
          MagicCache(
            prompt.title,
            fileUploadedIDs,
          ),
        );
      }
    }
    return results;
  }
}