feat: setup Project sync table

Author: WoodenMaiden

lib/data_providers/data/database_provider.dart

@@ -17,6 +17,7 @@ import 'dart:io';
 import 'package:flutter/material.dart';
 import 'package:random_color/random_color.dart';
 import 'package:sqflite/sqflite.dart';
+import 'package:sqflite_common/sqflite_logger.dart';
 import 'package:timecop/data_providers/data/data_provider.dart';
 import 'package:timecop/models/timer_entry.dart';
 import 'package:timecop/models/project.dart';
@@ -65,6 +66,18 @@ class DatabaseProvider extends DataProvider {
     await db.execute('''
       create index if not exists timers_start_time on timers(start_time)
     ''');
+    await db.execute('''
+      create table project_sync (
+        sync_id text not null,
+        internal_id int not null,
+        status text default 'SYNCING',
+        tasks_sha text default 'null',
+        last_updated int,
+        unique (internal_id),
+        primary key (sync_id),
+        foreign key (internal_id) references projects(id)
+      )
+    ''');
   }
 
   static void _onUpgrade(Database db, int version, int newVersion) async {
@@ -121,12 +134,16 @@ class DatabaseProvider extends DataProvider {
   }
 
   static Future<DatabaseProvider> open(String path) async {
+    var factoryWithLogs = SqfliteDatabaseFactoryLogger(databaseFactory,
+        options:
+            SqfliteLoggerOptions(type: SqfliteDatabaseFactoryLoggerType.all));
     // open the database
-    Database db = await openDatabase(path,
-        onConfigure: _onConfigure,
-        onCreate: _onCreate,
-        onUpgrade: _onUpgrade,
-        version: _dbVersion);
+    Database db = await factoryWithLogs.openDatabase(path,
+        options: OpenDatabaseOptions(
+            onConfigure: _onConfigure,
+            onCreate: _onCreate,
+            onUpgrade: _onUpgrade,
+            version: _dbVersion));
     await db.execute("PRAGMA foreign_keys = ON");
     DatabaseProvider repo = DatabaseProvider(db);
 
@@ -150,7 +167,7 @@ class DatabaseProvider extends DataProvider {
   @override
   Future<List<Project>> listProjects() async {
     List<Map<String, dynamic>> rawProjects = await _db.rawQuery('''
-        select id, name, colour, 
+        select id, name, colour,
             case archived
                 when 'false' then 0
                 when 'true' then 1

lib/models/sync/project_sync.dart

@@ -0,0 +1,29 @@
+import 'package:equatable/equatable.dart';
+import 'package:timecop/models/sync/sync_status.dart';
+
+// this class represents the sync status of a project, if it is attached to a project
+// that means the user wants it synced.
+class ProjectSync extends Equatable {
+  // Refers to the id stored in sqflite locally
+  final int internalID;
+  // refers to the id under which it is synced remotely (in that case it's an UUID)
+  final String syncID;
+  // Expresses the syncing status of the project
+  final SyncStatus status;
+  // a SHA fingerprint that when compared to the api will tell us
+  // if the project's tasks are up to date
+  final String tasksSHA;
+  // timestamp in epoch milliseconds since the last update.
+  final int lastUpdated;
+
+  const ProjectSync(
+      {required this.internalID,
+      required this.syncID,
+      required this.status,
+      required this.tasksSHA,
+      required this.lastUpdated});
+
+  @override
+  List<Object?> get props =>
+      [internalID, syncID, status.value, tasksSHA, lastUpdated];
+}

lib/models/sync/sync_status.dart

@@ -0,0 +1,12 @@
+enum SyncStatus {
+  // the object is NOT syncing
+  synced("SYNCED"),
+  // the object IS syncing
+  syncing("SYNCING"),
+  // last sync attempt failed
+  syncFailed("FAILED");
+
+  final String value;
+
+  const SyncStatus(this.value);
+}