first bang implementation

2024-06-10 03:08:23 +02:00
parent 9ae08409fe
commit 388eba93b7
47 changed files with 3809 additions and 34 deletions
@@ -0,0 +1,40 @@
+import 'package:bang_navigator/features/bangs/data/models/bang_data.dart';
+import 'package:bang_navigator/features/bangs/domain/repositories/bang.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'providers.g.dart';
+
+@Riverpod()
+Stream<BangData?> bang(BangRef ref, String? trigger) {
+  final repository = ref.watch(bangRepositoryProvider.notifier);
+  return repository.watchBang(trigger);
+}
+
+@Riverpod(keepAlive: true)
+Stream<BangData?> kagiSearchBang(KagiSearchBangRef ref) {
+  final repository = ref.watch(bangRepositoryProvider.notifier);
+  return repository.watchBang('kagi');
+}
+
+@Riverpod()
+Stream<List<BangData>> allBangs(AllBangsRef ref) {
+  final repository = ref.watch(bangRepositoryProvider.notifier);
+  return repository.watchBangs();
+}
+
+@Riverpod()
+Stream<List<BangData>> frequentBangs(FrequentBangsRef ref) {
+  final repository = ref.watch(bangRepositoryProvider.notifier);
+  return repository.watchFrequentBangs();
+}
+
+@Riverpod()
+Future<BangData> ensureIconAvailable(
+  EnsureIconAvailableRef ref,
+  BangData bang,
+) {
+  final repository = ref.watch(bangRepositoryProvider.notifier);
+  return repository.ensureIconAvailable(bang).then(
+        (value) => value.value,
+      );
+}
@@ -0,0 +1,330 @@
+// GENERATED CODE - DO NOT MODIFY BY HAND
+
+part of 'providers.dart';
+
+// **************************************************************************
+// RiverpodGenerator
+// **************************************************************************
+
+String _$bangHash() => r'e3d44af52e27831b568f292d38b447a443acec95';
+
+/// Copied from Dart SDK
+class _SystemHash {
+  _SystemHash._();
+
+  static int combine(int hash, int value) {
+    // ignore: parameter_assignments
+    hash = 0x1fffffff & (hash + value);
+    // ignore: parameter_assignments
+    hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10));
+    return hash ^ (hash >> 6);
+  }
+
+  static int finish(int hash) {
+    // ignore: parameter_assignments
+    hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3));
+    // ignore: parameter_assignments
+    hash = hash ^ (hash >> 11);
+    return 0x1fffffff & (hash + ((0x00003fff & hash) << 15));
+  }
+}
+
+/// See also [bang].
+@ProviderFor(bang)
+const bangProvider = BangFamily();
+
+/// See also [bang].
+class BangFamily extends Family<AsyncValue<BangData?>> {
+  /// See also [bang].
+  const BangFamily();
+
+  /// See also [bang].
+  BangProvider call(
+    String? trigger,
+  ) {
+    return BangProvider(
+      trigger,
+    );
+  }
+
+  @override
+  BangProvider getProviderOverride(
+    covariant BangProvider provider,
+  ) {
+    return call(
+      provider.trigger,
+    );
+  }
+
+  static const Iterable<ProviderOrFamily>? _dependencies = null;
+
+  @override
+  Iterable<ProviderOrFamily>? get dependencies => _dependencies;
+
+  static const Iterable<ProviderOrFamily>? _allTransitiveDependencies = null;
+
+  @override
+  Iterable<ProviderOrFamily>? get allTransitiveDependencies =>
+      _allTransitiveDependencies;
+
+  @override
+  String? get name => r'bangProvider';
+}
+
+/// See also [bang].
+class BangProvider extends AutoDisposeStreamProvider<BangData?> {
+  /// See also [bang].
+  BangProvider(
+    String? trigger,
+  ) : this._internal(
+          (ref) => bang(
+            ref as BangRef,
+            trigger,
+          ),
+          from: bangProvider,
+          name: r'bangProvider',
+          debugGetCreateSourceHash:
+              const bool.fromEnvironment('dart.vm.product') ? null : _$bangHash,
+          dependencies: BangFamily._dependencies,
+          allTransitiveDependencies: BangFamily._allTransitiveDependencies,
+          trigger: trigger,
+        );
+
+  BangProvider._internal(
+    super._createNotifier, {
+    required super.name,
+    required super.dependencies,
+    required super.allTransitiveDependencies,
+    required super.debugGetCreateSourceHash,
+    required super.from,
+    required this.trigger,
+  }) : super.internal();
+
+  final String? trigger;
+
+  @override
+  Override overrideWith(
+    Stream<BangData?> Function(BangRef provider) create,
+  ) {
+    return ProviderOverride(
+      origin: this,
+      override: BangProvider._internal(
+        (ref) => create(ref as BangRef),
+        from: from,
+        name: null,
+        dependencies: null,
+        allTransitiveDependencies: null,
+        debugGetCreateSourceHash: null,
+        trigger: trigger,
+      ),
+    );
+  }
+
+  @override
+  AutoDisposeStreamProviderElement<BangData?> createElement() {
+    return _BangProviderElement(this);
+  }
+
+  @override
+  bool operator ==(Object other) {
+    return other is BangProvider && other.trigger == trigger;
+  }
+
+  @override
+  int get hashCode {
+    var hash = _SystemHash.combine(0, runtimeType.hashCode);
+    hash = _SystemHash.combine(hash, trigger.hashCode);
+
+    return _SystemHash.finish(hash);
+  }
+}
+
+mixin BangRef on AutoDisposeStreamProviderRef<BangData?> {
+  /// The parameter `trigger` of this provider.
+  String? get trigger;
+}
+
+class _BangProviderElement extends AutoDisposeStreamProviderElement<BangData?>
+    with BangRef {
+  _BangProviderElement(super.provider);
+
+  @override
+  String? get trigger => (origin as BangProvider).trigger;
+}
+
+String _$kagiSearchBangHash() => r'ec830f26cf1d23e1e75747e1523cb1868e77d40b';
+
+/// See also [kagiSearchBang].
+@ProviderFor(kagiSearchBang)
+final kagiSearchBangProvider = StreamProvider<BangData?>.internal(
+  kagiSearchBang,
+  name: r'kagiSearchBangProvider',
+  debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product')
+      ? null
+      : _$kagiSearchBangHash,
+  dependencies: null,
+  allTransitiveDependencies: null,
+);
+
+typedef KagiSearchBangRef = StreamProviderRef<BangData?>;
+String _$allBangsHash() => r'212201f81e21fd0c1b5fb192359fb6ff8269a2a6';
+
+/// See also [allBangs].
+@ProviderFor(allBangs)
+final allBangsProvider = AutoDisposeStreamProvider<List<BangData>>.internal(
+  allBangs,
+  name: r'allBangsProvider',
+  debugGetCreateSourceHash:
+      const bool.fromEnvironment('dart.vm.product') ? null : _$allBangsHash,
+  dependencies: null,
+  allTransitiveDependencies: null,
+);
+
+typedef AllBangsRef = AutoDisposeStreamProviderRef<List<BangData>>;
+String _$frequentBangsHash() => r'12867819c6e2bbc5f2b6342aacc286f62d3a1803';
+
+/// See also [frequentBangs].
+@ProviderFor(frequentBangs)
+final frequentBangsProvider =
+    AutoDisposeStreamProvider<List<BangData>>.internal(
+  frequentBangs,
+  name: r'frequentBangsProvider',
+  debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product')
+      ? null
+      : _$frequentBangsHash,
+  dependencies: null,
+  allTransitiveDependencies: null,
+);
+
+typedef FrequentBangsRef = AutoDisposeStreamProviderRef<List<BangData>>;
+String _$ensureIconAvailableHash() =>
+    r'2e112c88da8cf9bf12bdc5e5d525d59fe97a9419';
+
+/// See also [ensureIconAvailable].
+@ProviderFor(ensureIconAvailable)
+const ensureIconAvailableProvider = EnsureIconAvailableFamily();
+
+/// See also [ensureIconAvailable].
+class EnsureIconAvailableFamily extends Family<AsyncValue<BangData>> {
+  /// See also [ensureIconAvailable].
+  const EnsureIconAvailableFamily();
+
+  /// See also [ensureIconAvailable].
+  EnsureIconAvailableProvider call(
+    BangData bang,
+  ) {
+    return EnsureIconAvailableProvider(
+      bang,
+    );
+  }
+
+  @override
+  EnsureIconAvailableProvider getProviderOverride(
+    covariant EnsureIconAvailableProvider provider,
+  ) {
+    return call(
+      provider.bang,
+    );
+  }
+
+  static const Iterable<ProviderOrFamily>? _dependencies = null;
+
+  @override
+  Iterable<ProviderOrFamily>? get dependencies => _dependencies;
+
+  static const Iterable<ProviderOrFamily>? _allTransitiveDependencies = null;
+
+  @override
+  Iterable<ProviderOrFamily>? get allTransitiveDependencies =>
+      _allTransitiveDependencies;
+
+  @override
+  String? get name => r'ensureIconAvailableProvider';
+}
+
+/// See also [ensureIconAvailable].
+class EnsureIconAvailableProvider extends AutoDisposeFutureProvider<BangData> {
+  /// See also [ensureIconAvailable].
+  EnsureIconAvailableProvider(
+    BangData bang,
+  ) : this._internal(
+          (ref) => ensureIconAvailable(
+            ref as EnsureIconAvailableRef,
+            bang,
+          ),
+          from: ensureIconAvailableProvider,
+          name: r'ensureIconAvailableProvider',
+          debugGetCreateSourceHash:
+              const bool.fromEnvironment('dart.vm.product')
+                  ? null
+                  : _$ensureIconAvailableHash,
+          dependencies: EnsureIconAvailableFamily._dependencies,
+          allTransitiveDependencies:
+              EnsureIconAvailableFamily._allTransitiveDependencies,
+          bang: bang,
+        );
+
+  EnsureIconAvailableProvider._internal(
+    super._createNotifier, {
+    required super.name,
+    required super.dependencies,
+    required super.allTransitiveDependencies,
+    required super.debugGetCreateSourceHash,
+    required super.from,
+    required this.bang,
+  }) : super.internal();
+
+  final BangData bang;
+
+  @override
+  Override overrideWith(
+    FutureOr<BangData> Function(EnsureIconAvailableRef provider) create,
+  ) {
+    return ProviderOverride(
+      origin: this,
+      override: EnsureIconAvailableProvider._internal(
+        (ref) => create(ref as EnsureIconAvailableRef),
+        from: from,
+        name: null,
+        dependencies: null,
+        allTransitiveDependencies: null,
+        debugGetCreateSourceHash: null,
+        bang: bang,
+      ),
+    );
+  }
+
+  @override
+  AutoDisposeFutureProviderElement<BangData> createElement() {
+    return _EnsureIconAvailableProviderElement(this);
+  }
+
+  @override
+  bool operator ==(Object other) {
+    return other is EnsureIconAvailableProvider && other.bang == bang;
+  }
+
+  @override
+  int get hashCode {
+    var hash = _SystemHash.combine(0, runtimeType.hashCode);
+    hash = _SystemHash.combine(hash, bang.hashCode);
+
+    return _SystemHash.finish(hash);
+  }
+}
+
+mixin EnsureIconAvailableRef on AutoDisposeFutureProviderRef<BangData> {
+  /// The parameter `bang` of this provider.
+  BangData get bang;
+}
+
+class _EnsureIconAvailableProviderElement
+    extends AutoDisposeFutureProviderElement<BangData>
+    with EnsureIconAvailableRef {
+  _EnsureIconAvailableProviderElement(super.provider);
+
+  @override
+  BangData get bang => (origin as EnsureIconAvailableProvider).bang;
+}
+// ignore_for_file: type=lint
+// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member
@@ -0,0 +1,154 @@
+import 'package:bang_navigator/domain/services/generic_website.dart';
+import 'package:bang_navigator/features/bangs/data/database/database.dart';
+import 'package:bang_navigator/features/bangs/data/models/bang.dart';
+import 'package:bang_navigator/features/bangs/data/models/bang_data.dart';
+import 'package:bang_navigator/features/bangs/data/providers.dart';
+import 'package:bang_navigator/features/bangs/data/services/bang_source.dart';
+import 'package:bang_navigator/utils/image_helper.dart';
+import 'package:drift/isolate.dart';
+import 'package:exceptions/exceptions.dart';
+import 'package:riverpod/riverpod.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'bang.g.dart';
+
+Future<Result<void>> _syncBangGroupStatic(
+  BangSource source,
+  BangDatabase db,
+  Uri url,
+  BangGroup? group,
+) async {
+  final result = await source.getBangs(url, group);
+
+  return result.flatMapAsync(
+    (value) async {
+      final sourcedBangMap =
+          Map.fromEntries(value.map((e) => MapEntry(e.trigger, e)));
+      final localBangMap =
+          await db.bangDao.getBangs(groups: [group]).get().then(
+                (bangs) =>
+                    Map.fromEntries(bangs.map((e) => MapEntry(e.trigger, e))),
+              );
+
+      final sourcedBangTriggers = sourcedBangMap.keys.toSet();
+      final localBangTriggers = localBangMap.keys.toSet();
+
+      final removedBangs = localBangTriggers.difference(sourcedBangTriggers);
+      final addedBangs = sourcedBangTriggers.difference(localBangTriggers).map(
+            (e) => sourcedBangMap[e]!,
+          );
+
+      final changedBangs = sourcedBangTriggers
+          .intersection(localBangTriggers)
+          .where((e) => sourcedBangMap[e] != localBangMap[e])
+          .map(
+            (e) => sourcedBangMap[e]!,
+          );
+
+      await db.bangDao.deleteBangs(removedBangs);
+      await db.bangDao.insertBangs(addedBangs);
+      await db.bangDao.replaceBangs(changedBangs);
+
+      await db.optimizeFtsIndex();
+    },
+  );
+}
+
+@Riverpod(keepAlive: true)
+class BangRepository extends _$BangRepository {
+  late BangDatabase _db;
+
+  @override
+  void build() {
+    _db = ref.watch(bangDatabaseProvider);
+  }
+
+  Stream<BangData?> watchBang(String? trigger) {
+    if (trigger != null) {
+      return _db.bangDao.getBangData(trigger).watchSingleOrNull();
+    } else {
+      return Stream.value(null);
+    }
+  }
+
+  Stream<List<BangData>> watchBangs({Iterable<BangGroup?>? groups}) {
+    return _db.bangDao.getBangDataList(groups: groups).watch();
+  }
+
+  Stream<List<BangData>> watchFrequentBangs({Iterable<BangGroup?>? groups}) {
+    return _db.bangDao.getFrequentBangDataList(groups: groups).watch();
+  }
+
+  Future<void> increaseFrequency(String trigger) {
+    return _db.bangDao.increaseFrequency(trigger);
+  }
+
+  Future<Result<BangData>> ensureIconAvailable(BangData bang) async {
+    if (bang.iconData != null) {
+      return Result.success(bang);
+    }
+
+    final result = await ref
+        .read(genericWebsiteServiceProvider.notifier)
+        .getFaviconBytes(Uri.parse(bang.getUrl('').origin));
+
+    return result.flatMapAsync(
+      (faviconBytes) async {
+        if (faviconBytes != null && await isImageValid(faviconBytes)) {
+          await _db.bangDao.upsertIcon(bang.trigger, faviconBytes);
+          return bang.copyWith.iconData(faviconBytes);
+        }
+
+        return bang;
+      },
+    );
+  }
+
+  Future<Result<void>> syncBangGroup(
+    Uri url,
+    BangGroup? group,
+  ) =>
+      _syncBangGroupStatic(
+        ref.read(bangSourceProvider.notifier),
+        _db,
+        url,
+        group,
+      );
+
+  Future<void> syncAllBangGroups() async {
+    await _db.computeWithDatabase(
+      connect: BangDatabase.new,
+      computation: (db) async {
+        final ref = ProviderContainer();
+        final source = ref.read(bangSourceProvider.notifier);
+
+        await _syncBangGroupStatic(
+          source,
+          db,
+          Uri.parse(
+            'https://raw.githubusercontent.com/kagisearch/bangs/main/data/bangs.json',
+          ),
+          null,
+        );
+
+        await _syncBangGroupStatic(
+          source,
+          db,
+          Uri.parse(
+            'https://raw.githubusercontent.com/kagisearch/bangs/main/data/kagi_bangs.json',
+          ),
+          BangGroup.kagi,
+        );
+
+        await _syncBangGroupStatic(
+          source,
+          db,
+          Uri.parse(
+            'https://raw.githubusercontent.com/kagisearch/bangs/main/data/assistant_bangs.json',
+          ),
+          BangGroup.assistant,
+        );
+      },
+    );
+  }
+}
@@ -0,0 +1,25 @@
+// GENERATED CODE - DO NOT MODIFY BY HAND
+
+part of 'bang.dart';
+
+// **************************************************************************
+// RiverpodGenerator
+// **************************************************************************
+
+String _$bangRepositoryHash() => r'd405550e2ad11c57f3644f18390348efb71bdf0f';
+
+/// See also [BangRepository].
+@ProviderFor(BangRepository)
+final bangRepositoryProvider = NotifierProvider<BangRepository, void>.internal(
+  BangRepository.new,
+  name: r'bangRepositoryProvider',
+  debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product')
+      ? null
+      : _$bangRepositoryHash,
+  dependencies: null,
+  allTransitiveDependencies: null,
+);
+
+typedef _$BangRepository = Notifier<void>;
+// ignore_for_file: type=lint
+// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member
@@ -0,0 +1,32 @@
+import 'dart:async';
+
+import 'package:bang_navigator/features/bangs/data/database/database.dart';
+import 'package:bang_navigator/features/bangs/data/models/bang_data.dart';
+import 'package:bang_navigator/features/bangs/data/providers.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'bang_search.g.dart';
+
+@Riverpod()
+class BangSearch extends _$BangSearch {
+  late StreamController<List<BangData>> _streamController;
+  late BangDatabase _db;
+
+  Future<void> search(String input) async {
+    if (input.isNotEmpty) {
+      await _db.bangDao.queryBangs(input).get().then(_streamController.add);
+    }
+  }
+
+  @override
+  Stream<List<BangData>> build() {
+    _db = ref.watch(bangDatabaseProvider);
+    _streamController = StreamController();
+
+    ref.onDispose(() async {
+      await _streamController.close();
+    });
+
+    return _streamController.stream;
+  }
+}
@@ -0,0 +1,25 @@
+// GENERATED CODE - DO NOT MODIFY BY HAND
+
+part of 'bang_search.dart';
+
+// **************************************************************************
+// RiverpodGenerator
+// **************************************************************************
+
+String _$bangSearchHash() => r'abd71f10288ac1f559e66fc11035f9f2b027c353';
+
+/// See also [BangSearch].
+@ProviderFor(BangSearch)
+final bangSearchProvider =
+    AutoDisposeStreamNotifierProvider<BangSearch, List<BangData>>.internal(
+  BangSearch.new,
+  name: r'bangSearchProvider',
+  debugGetCreateSourceHash:
+      const bool.fromEnvironment('dart.vm.product') ? null : _$bangSearchHash,
+  dependencies: null,
+  allTransitiveDependencies: null,
+);
+
+typedef _$BangSearch = AutoDisposeStreamNotifier<List<BangData>>;
+// ignore_for_file: type=lint
+// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member