Merge branch 'main' into feat/rbac-api

Author: Mr-Leshiy

catalyst_voices/apps/voices/lib/configs/bootstrap.dart

@@ -57,6 +57,12 @@ Future<BootstrapArgs> bootstrap({
 
   Bloc.observer = AppBlocObserver();
 
+  // TODO(damian-molinski): delete it before merge.
+  // TODO(damian-molinski): enable it after after docs sync is ready.
+  /*await Dependencies.instance.get<CatalystDatabase>().clear();
+
+  Dependencies.instance.get<SyncManager>().start().ignore();*/
+
   return BootstrapArgs(routerConfig: router);
 }
 

catalyst_voices/apps/voices/lib/dependency/dependencies.dart

@@ -156,6 +156,7 @@ final class Dependencies extends DependencyProvider {
       })
       ..registerLazySingleton<CatGatewayDocumentDataSource>(() {
         return CatGatewayDocumentDataSource(
+          get<ApiServices>(),
           get<SignedDocumentManager>(),
         );
       })
@@ -225,6 +226,11 @@ final class Dependencies extends DependencyProvider {
         get<ConfigRepository>(),
       );
     });
+    registerLazySingleton<DocumentsService>(() {
+      return DocumentsService(
+        get<DocumentRepository>(),
+      );
+    });
   }
 
   void _registerStorages() {
@@ -248,6 +254,14 @@ final class Dependencies extends DependencyProvider {
 
   void _registerUtils() {
     registerLazySingleton<SignedDocumentManager>(SignedDocumentManager.new);
+    registerLazySingleton<SyncManager>(
+      () {
+        return SyncManager(
+          get<DocumentsService>(),
+        );
+      },
+      dispose: (manager) async => manager.dispose(),
+    );
     registerLazySingleton<UserObserver>(
       StreamUserObserver.new,
       dispose: (observer) async => observer.dispose(),

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/catalyst_voices_models.dart

@@ -26,6 +26,7 @@ export 'document/validation/document_validation_result.dart';
 export 'document/validation/document_validator.dart';
 export 'document/values/grouped_tags.dart';
 export 'errors/errors.dart';
+export 'errors/sync_exception.dart';
 export 'file/voices_file.dart';
 export 'hi_lo/hi_lo.dart';
 export 'hi_lo/uuid_hi_lo.dart';

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/document/document_ref.dart

@@ -90,6 +90,9 @@ final class SignedDocumentRef extends DocumentRef {
     super.version,
   });
 
+  /// Creates ref for first version of [id] document.
+  const SignedDocumentRef.first(String id) : this(id: id, version: id);
+
   factory SignedDocumentRef.generateFirstRef() {
     final id = const Uuid().v7();
     return SignedDocumentRef(

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/errors/sync_exception.dart

@@ -0,0 +1,25 @@
+import 'package:catalyst_voices_models/catalyst_voices_models.dart';
+
+final class RefsSyncException extends SyncException {
+  final List<Object> errors;
+
+  RefsSyncException(this.errors);
+
+  @override
+  String toString() => 'RefsSyncException errors[${errors.length}]';
+}
+
+final class RefSyncException extends SyncException {
+  final DocumentRef ref;
+  final Object? error;
+  final StackTrace? stack;
+
+  const RefSyncException(this.ref, {this.error, this.stack});
+
+  @override
+  String toString() => 'RefSyncException($ref) failed with $error';
+}
+
+sealed class SyncException implements Exception {
+  const SyncException();
+}

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/catalyst_voices_repositories.dart

@@ -2,6 +2,7 @@ export 'api/api.dart';
 export 'campaign/campaign_repository.dart' show CampaignRepository;
 export 'config/config_repository.dart' show ConfigRepository;
 export 'database/database.dart';
+export 'document/constants.dart';
 export 'document/document_mapper.dart' show DocumentMapperImpl;
 export 'document/document_repository.dart' show DocumentRepository;
 export 'document/exception/document_data_local_source_exception.dart';

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/database/dao/documents_dao.dart

@@ -13,12 +13,11 @@ import 'package:flutter/foundation.dart';
 abstract interface class DocumentsDao {
   /// Counts documents matching required [ref] id and optional [ref] ver.
   ///
+  /// If [ref] is null counts all documents.
+  ///
   /// If [ref] ver is not specified it will return count of all version
   /// matching [ref] id.
-  Future<int> count({required DocumentRef ref});
-
-  /// Counts all documents.
-  Future<int> countAll();
+  Future<int> count({DocumentRef? ref});
 
   /// Counts unique documents. All versions of same document are counted as 1.
   Future<int> countDocuments();
@@ -49,6 +48,9 @@ abstract interface class DocumentsDao {
   /// all will be returned.
   Future<List<DocumentEntity>> queryAll();
 
+  /// Returns all known document refs.
+  Future<List<SignedDocumentRef>> queryAllRefs();
+
   /// Returns a list of version of ref object.
   /// Can be used to get versions count.
   Future<List<String>> queryVersionIds({required String id});
@@ -91,13 +93,12 @@ class DriftDocumentsDao extends DatabaseAccessor<DriftCatalystDatabase>
   DriftDocumentsDao(super.attachedDatabase);
 
   @override
-  Future<int> count({required DocumentRef ref}) {
-    return documents.count(where: (row) => _filterRef(row, ref)).getSingle();
-  }
-
-  @override
-  Future<int> countAll() {
-    return documents.count().getSingle();
+  Future<int> count({DocumentRef? ref}) {
+    if (ref == null) {
+      return documents.count().getSingle();
+    } else {
+      return documents.count(where: (row) => _filterRef(row, ref)).getSingle();
+    }
   }
 
   @override
@@ -173,6 +174,30 @@ class DriftDocumentsDao extends DatabaseAccessor<DriftCatalystDatabase>
     return select(documents).get();
   }
 
+  @override
+  Future<List<SignedDocumentRef>> queryAllRefs() {
+    final select = selectOnly(documents)
+      ..addColumns([
+        documents.idHi,
+        documents.idLo,
+        documents.verHi,
+        documents.verLo,
+      ]);
+
+    return select.map((row) {
+      final id = UuidHiLo(
+        high: row.read(documents.idHi)!,
+        low: row.read(documents.idLo)!,
+      );
+      final version = UuidHiLo(
+        high: row.read(documents.verHi)!,
+        low: row.read(documents.verLo)!,
+      );
+
+      return SignedDocumentRef(id: id.uuid, version: version.uuid);
+    }).get();
+  }
+
   @override
   Future<List<String>> queryVersionIds({required String id}) {
     final query = select(documents)

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/database/dao/drafts_dao.dart

@@ -10,12 +10,11 @@ import 'package:flutter/foundation.dart';
 abstract interface class DraftsDao {
   /// Counts drafts matching required [ref] id and optional [ref] ver.
   ///
+  /// If ref is null it will count all drafts.
+  ///
   /// If [ref] ver is not specified it will return count of all version
   /// matching [ref] id.
-  Future<int> count({required DocumentRef ref});
-
-  /// Counts unique drafts. All versions of same document are counted as 1.
-  Future<int> countAll();
+  Future<int> count({DocumentRef? ref});
 
   /// Deletes a document draft with [ref].
   ///
@@ -29,6 +28,9 @@ abstract interface class DraftsDao {
   /// Returns all drafts
   Future<List<DocumentDraftEntity>> queryAll();
 
+  /// Returns all known document drafts refs.
+  Future<List<DraftRef>> queryAllRefs();
+
   /// Singular version of [saveAll]. Does not run in transaction.
   Future<void> save(DocumentDraftEntity draft);
 
@@ -59,13 +61,12 @@ class DriftDraftsDao extends DatabaseAccessor<DriftCatalystDatabase>
   DriftDraftsDao(super.attachedDatabase);
 
   @override
-  Future<int> count({required DocumentRef ref}) {
-    return drafts.count(where: (row) => _filterRef(row, ref)).getSingle();
-  }
-
-  @override
-  Future<int> countAll() {
-    return drafts.count().getSingle();
+  Future<int> count({DocumentRef? ref}) {
+    if (ref == null) {
+      return drafts.count().getSingle();
+    } else {
+      return drafts.count(where: (row) => _filterRef(row, ref)).getSingle();
+    }
   }
 
   @override
@@ -87,6 +88,30 @@ class DriftDraftsDao extends DatabaseAccessor<DriftCatalystDatabase>
     return select(drafts).get();
   }
 
+  @override
+  Future<List<DraftRef>> queryAllRefs() {
+    final select = selectOnly(drafts)
+      ..addColumns([
+        drafts.idHi,
+        drafts.idLo,
+        drafts.verHi,
+        drafts.verLo,
+      ]);
+
+    return select.map((row) {
+      final id = UuidHiLo(
+        high: row.read(drafts.idHi)!,
+        low: row.read(drafts.idLo)!,
+      );
+      final version = UuidHiLo(
+        high: row.read(drafts.verHi)!,
+        low: row.read(drafts.verLo)!,
+      );
+
+      return DraftRef(id: id.uuid, version: version.uuid);
+    }).get();
+  }
+
   @override
   Future<void> save(DocumentDraftEntity draft) async {
     await into(drafts).insert(draft, mode: InsertMode.insertOrReplace);

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/document/constants.dart

@@ -0,0 +1,75 @@
+import 'package:catalyst_voices_models/catalyst_voices_models.dart';
+
+/// At the moment categories are hard coded.
+/// See list in link below
+/// https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/catalyst_docs/proposal/#fund-14-defined-category-ids
+/// https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/catalyst_docs/proposal/#fund-14-defined-templates-ids
+/// https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/catalyst_docs/comment/#fund-14-defined-templates-ids
+const categoriesTemplatesRefs = <CategoryTemplatesRefs>[
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-7473-81c8-a0eaef369619'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-75b5-b4a4-5cf331cd8d1a'),
+    comment: SignedDocumentRef.first('0194d494-4402-7e0e-b8d6-171f8fea18b0'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-7043-8c5c-f0e09f8a6d8c'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-7371-8bd3-c15811b2b063'),
+    comment: SignedDocumentRef.first('0194d494-4402-7444-9058-9030815eb029'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-7e75-95c1-a6cf0e8086d9'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-79c7-a222-2c3b581443a8'),
+    comment: SignedDocumentRef.first('0194d494-4402-7351-b4f7-24938dc2c12e'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-7703-a1c0-83a916b001e7'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-716f-a04e-f422f08a99dc'),
+    comment: SignedDocumentRef.first('0194d494-4402-79ad-93ba-4d7a0b65d563'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-79d1-9a0f-84943123ef38'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-78fc-818a-bf20fc3e9b87'),
+    comment: SignedDocumentRef.first('0194d494-4402-7cee-a5a6-5739839b3b8a'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-706d-91c6-0d4707f74cdf'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-7d98-a3aa-c57d99121f78'),
+    comment: SignedDocumentRef.first('0194d494-4402-7aee-8b24-b5300c976846'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-759e-b729-304306fbaa5e'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-77be-a1a5-c238fe25fe4f'),
+    comment: SignedDocumentRef.first('0194d494-4402-7d75-be7f-1c4f3471a53c'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-7e27-b5fd-de3133b54bf6'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-7254-a512-30a4cdecfb90'),
+    comment: SignedDocumentRef.first('0194d494-4402-7a2c-8971-1b4c255c826d'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-7f9e-8a5d-91fb67c078f2'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-7de9-b535-1a0b0474ed4e'),
+    comment: SignedDocumentRef.first('0194d494-4402-7074-86ac-3efd097ba9b0'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-7676-9658-36c0b67e656e'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-7fce-84ee-b872a4661075'),
+    comment: SignedDocumentRef.first('0194d494-4402-7202-8ebb-8c4c47c286d8'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-7978-b031-7aa2ccc5e3fd'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-7878-9bcc-2c79fef0fc13'),
+    comment: SignedDocumentRef.first('0194d494-4402-7fb5-b680-c23fe4beb088'),
+  ),
+  (
+    category: SignedDocumentRef(id: '0194d490-30bf-7d34-bba9-8498094bd627'),
+    proposal: SignedDocumentRef.first('0194d492-1daa-722f-94f4-687f2c068a5d'),
+    comment: SignedDocumentRef.first('0194d494-4402-7aa5-9dbc-5fe886e60ebc'),
+  ),
+];
+
+typedef CategoryTemplatesRefs = ({
+  SignedDocumentRef category,
+  SignedDocumentRef proposal,
+  SignedDocumentRef comment,
+});