HIPM-909: Replace Realm with SQLite/EF Core

HipMobileForms.sln

@@ -13,7 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "HipMobile", "HipMobile", "{
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "HipMobileUI", "HipMobileUI", "{9135C941-A58C-4733-B191-A61C6CA2A016}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HipMobileUI.UITests", "Sources\HipMobileUI.UITests\HipMobileUI.UITests.csproj", "{5CCB5487-8031-4BAB-9EBA-D4A04A1D010E}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "HipMobileUI.UITests", "Sources\HipMobileUI.UITests\HipMobileUI.UITests.csproj", "{5CCB5487-8031-4BAB-9EBA-D4A04A1D010E}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HipMobileUI.Android", "Sources\HipMobileUI.Android\HipMobileUI.Android.csproj", "{C400B409-92B2-4726-B24A-3942722189FA}"
 EndProject

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/AchievementFetcher.cs

@@ -12,14 +12,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers.Contracts;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.DtoToModelConverters;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.Managers;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.Models;
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.DataAccessLayer;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.ServiceAccessLayer.ContentApiAccesses.Contracts;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
 
 namespace PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers
 {
@@ -32,25 +33,22 @@ public AchievementFetcher(IAchievementsApiAccess client)
             this.client = client;
         }
 
-        public async Task<IEnumerable<IAchievement>> UpdateAchievements()
+        public async Task<IEnumerable<AchievementBase>> UpdateAchievements(ITransactionDataAccess dataAccess)
         {
-            var existingUnlocked = AchievementManager.GetAchievements()
-                                                           .Where(it => it.IsUnlocked)
-                                                           .Select(it => it.Id);
+            var existingUnlocked = dataAccess.Achievements().GetAchievements()
+                .Where(it => it.IsUnlocked)
+                .Select(it => it.Id);
 
             var achievementDtos = await client.GetAchievements();
             var unlockedAchievementIds = (await client.GetUnlockedAchievements())
                 .Select(it => it.Id.ToString()).ToList();
-
-            using (DbManager.StartTransaction())
+
+            var achievements = AchievementConverter.Convert(achievementDtos, dataAccess).ToList();
+            foreach (var unlocked in achievements.Where(it => unlockedAchievementIds.Contains(it.Id)))
             {
-                var achievements = AchievementConverter.Convert(achievementDtos).ToList();
-                foreach (var unlocked in achievements.Where(it => unlockedAchievementIds.Contains(it.Id)))
-                {
-                    unlocked.IsUnlocked = true;
-                }
-                return achievements.Where(it => it.IsUnlocked && !existingUnlocked.Contains(it.Id));
+                unlocked.IsUnlocked = true;
             }
+            return achievements.Where(it => it.IsUnlocked && !existingUnlocked.Contains(it.Id));
         }
     }
 }

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/BaseDataFetcher.cs

@@ -12,12 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using System.Linq;
-using System.Threading;
-using System.Threading.Tasks;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers.Contracts;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.Managers;
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.DataAccessLayer;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.Helpers;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 
 namespace PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers
 {
@@ -36,61 +37,61 @@ public BaseDataFetcher(IRoutesBaseDataFetcher routesBaseDataFetcher, IExhibitsBa
 
         public async Task<bool> IsDatabaseUpToDate()
         {
-            bool anyExhibitChanged = await exhibitsBaseDataFetcher.AnyExhibitChanged();
-            bool anyRouteChanged = await routesBaseDataFetcher.AnyRouteChanged();
+            bool anyExhibitChanged = await exhibitsBaseDataFetcher.AnyExhibitChanged(DbManager.DataAccess);
+            bool anyRouteChanged = await routesBaseDataFetcher.AnyRouteChanged(DbManager.DataAccess);
 
             return !(anyExhibitChanged || anyRouteChanged);
         }
 
         public async Task FetchBaseDataIntoDatabase(CancellationToken token, IProgressListener listener)
         {
-            var routes = RouteManager.GetRoutes().ToDictionary(x => x.IdForRestApi, x => x.Timestamp);
-            var exhibits = ExhibitManager.GetExhibits().ToDictionary(x => x.IdForRestApi, x => x.Timestamp);
-
-            double totalSteps = await exhibitsBaseDataFetcher.FetchNeededDataForExhibits(exhibits);
-            totalSteps += await routesBaseDataFetcher.FetchNeededDataForRoutes(routes);
-
-            if (token.IsCancellationRequested)
+            using (var transaction = DbManager.StartTransaction())
             {
-                return;
-            }
+                var routes = transaction.DataAccess.Routes().GetRoutes().ToDictionary(x => x.IdForRestApi, x => x.Timestamp);
+                var exhibits = transaction.DataAccess.Exhibits().GetExhibits().ToDictionary(x => x.IdForRestApi, x => x.Timestamp);
 
-            listener.SetMaxProgress(totalSteps);
+                double totalSteps = await exhibitsBaseDataFetcher.FetchNeededDataForExhibits(exhibits);
+                totalSteps += await routesBaseDataFetcher.FetchNeededDataForRoutes(routes);
 
-            await exhibitsBaseDataFetcher.FetchMediaData(token, listener);
-            if (token.IsCancellationRequested)
-            {
-                return;
-            }
-            await routesBaseDataFetcher.FetchMediaData(token, listener);
-            if (token.IsCancellationRequested)
-            {
-                return;
-            }
+                if (token.IsCancellationRequested)
+                {
+                    transaction.Rollback();
+                    return;
+                }
 
-            using (var transaction = DbManager.StartTransaction())
-            {
-                await exhibitsBaseDataFetcher.ProcessExhibits(listener);
+                listener.SetMaxProgress(totalSteps);
+
+                await exhibitsBaseDataFetcher.FetchMediaData(token, listener);
                 if (token.IsCancellationRequested)
                 {
                     transaction.Rollback();
                     return;
                 }
-                await routesBaseDataFetcher.ProcessRoutes(listener);
+                await routesBaseDataFetcher.FetchMediaData(token, listener);
                 if (token.IsCancellationRequested)
                 {
                     transaction.Rollback();
                     return;
                 }
+
+                await exhibitsBaseDataFetcher.ProcessExhibits(listener, transaction.DataAccess);
                 if (token.IsCancellationRequested)
                 {
                     transaction.Rollback();
+                    return;
+                }
+                await routesBaseDataFetcher.ProcessRoutes(listener, transaction.DataAccess);
+                if (token.IsCancellationRequested)
+                {
+                    transaction.Rollback();
+                    return;
                 }
             }
-            await dataToRemoveFetcher.FetchDataToDelete(token);
-            using (DbManager.StartTransaction())
+
+            using (var transaction = DbManager.StartTransaction())
             {
-                await dataToRemoveFetcher.CleanupRemovedData();
+                await dataToRemoveFetcher.FetchDataToDelete(token);
+                await dataToRemoveFetcher.CleanupRemovedData(transaction.DataAccess);
             }
         }
     }

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/Contracts/IAchievementFetcher.cs

@@ -12,21 +12,22 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.Models;
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.DataAccessLayer;
 using System.Collections.Generic;
 using System.Threading.Tasks;
-using PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.Models;
 
 namespace PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers.Contracts
 {
     public interface IAchievementFetcher
     {
         /// <summary>
-        /// Fetches the all achievements from the API and stores
+        /// Fetches all achievements from the API and stores
         /// them in the database, including locked ones.
         /// WARNING: If you call this method, use the return value to show
         /// notifications about new unlocked achievements!
         /// </summary>
         /// <returns>Achievements that have been newly added to the database and are unlocked.</returns>
-        Task<IEnumerable<IAchievement>> UpdateAchievements();
+        Task<IEnumerable<AchievementBase>> UpdateAchievements(ITransactionDataAccess dataAccess);
     }
 }

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/Contracts/IDataToRemoveFetcher.cs

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.DataAccessLayer;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -21,6 +22,6 @@ public interface IDataToRemoveFetcher
     {
         Task FetchDataToDelete(CancellationToken token);
 
-        Task CleanupRemovedData();
+        Task CleanupRemovedData(ITransactionDataAccess dataAccess);
     }
 }

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/Contracts/IExhibitsBaseDataFetcher.cs

@@ -16,6 +16,7 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.DataAccessLayer;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.Helpers;
 
 namespace PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers.Contracts
@@ -44,12 +45,12 @@ public interface IExhibitsBaseDataFetcher
         /// </summary>
         /// <param name="listener"></param>
         /// <returns></returns>
-        Task ProcessExhibits(IProgressListener listener);
+        Task ProcessExhibits(IProgressListener listener, ITransactionDataAccess dataAccess);
 
         /// <summary>
         /// Indicates whether any exhibit was changed
         /// </summary>
         /// <returns></returns>
-        Task<bool> AnyExhibitChanged();
+        Task<bool> AnyExhibitChanged(IReadOnlyDataAccess dataAccess);
     }
 }

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/Contracts/IFullDownloadableDataFetcher.cs

@@ -1,9 +1,6 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading;
+using System.Threading;
 using System.Threading.Tasks;
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.DataAccessLayer;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.Helpers;
 
 namespace PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers.Contracts
@@ -17,7 +14,9 @@ public interface IFullDownloadableDataFetcher
         /// <param name="idForRestApi">The id for the REST API of the exhibit to be fetched</param>
         /// <param name="token">Used for cancelling the download</param>
         /// <param name="listener">Used for reporting progress</param>
+        /// <param name="dataAccess">Provides read/write access to the database</param>
         /// <returns></returns>
-        Task FetchFullDownloadableDataIntoDatabase(string downloadableId, int idForRestApi, CancellationToken token, IProgressListener listener);
+        Task FetchFullDownloadableDataIntoDatabase(
+            string downloadableId, int idForRestApi, CancellationToken token, IProgressListener listener);
     }
 }

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/Contracts/IFullExhibitDataFetcher.cs

@@ -12,10 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using System.Collections.Generic;
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.Helpers;
 using System.Threading;
 using System.Threading.Tasks;
-using PaderbornUniversity.SILab.Hip.Mobile.Shared.Helpers;
 
 namespace PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers.Contracts
 {
@@ -32,8 +31,9 @@ public interface IFullExhibitDataFetcher : IFullDownloadableDataFetcher
         /// <param name="token">For cancellation</param>
         /// <param name="listener">To update the progressbar of the downloadpage</param>
         /// <returns></returns>
-        Task FetchFullExhibitDataIntoDatabaseWithFetchedPagesAndMedia(string exhibitId, ExhibitPagesAndMediaContainer pagesAndMediaContainer, CancellationToken token,
-                                                                      IProgressListener listener);
+        Task FetchFullExhibitDataIntoDatabaseWithFetchedPagesAndMedia(
+            string exhibitId, ExhibitPagesAndMediaContainer pagesAndMediaContainer, CancellationToken token,
+            IProgressListener listener);
 
         /// <summary>
         /// Load pages for related exhibit and prefetch media of an exhibit for later use in a full route fetcher

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/Contracts/IFullRouteDataFetcher.cs

@@ -12,9 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using System.Threading;
-using System.Threading.Tasks;
-using PaderbornUniversity.SILab.Hip.Mobile.Shared.Helpers;
 
 namespace PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers.Contracts
 {

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/Contracts/IMediaDataFetcher.cs

@@ -12,32 +12,31 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using System;
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.DataAccessLayer;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.Helpers;
 
 namespace PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers.Contracts
 {
     /// <summary>
-    /// Fetcher for audio and images
+    /// Fetcher for audio and images.
     /// </summary>
     public interface IMediaDataFetcher
     {
         /// <summary>
-        /// Fetches the media data including the real files for the given ids
+        /// Fetches the media data including the real files for the given IDs.
         /// </summary>
         /// <param name="mediaIds"></param>
         /// <param name="token">Can be provided for canceling the action</param>
         /// <param name="progressListener">Can be provided for reporting progress on the download</param>
         Task FetchMedias(IList<int?> mediaIds, CancellationToken token, IProgressListener progressListener);
 
         /// <summary>
-        /// Combines media data and files
-        /// Must be called inside a database transaction
+        /// Combines media data and files, creating new image/audio entities in the database or updating existing ones.
+        /// Must be called inside a database transaction.
         /// </summary>
-        /// <returns></returns>
-        Task<FetchedMediaData> CombineMediasAndFiles();
+        Task<FetchedMediaData> CombineMediasAndFiles(ITransactionDataAccess dataAccess);
     }
 }

Sources/HiPMobile/BusinessLayer/ContentApiFetchers/Contracts/IRoutesBaseDataFetcher.cs

@@ -16,6 +16,7 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
+using PaderbornUniversity.SILab.Hip.Mobile.Shared.DataAccessLayer;
 using PaderbornUniversity.SILab.Hip.Mobile.Shared.Helpers;
 
 namespace PaderbornUniversity.SILab.Hip.Mobile.Shared.BusinessLayer.ContentApiFetchers.Contracts
@@ -44,12 +45,12 @@ public interface IRoutesBaseDataFetcher
         /// </summary>
         /// <param name="listener"></param>
         /// <returns></returns>
-        Task ProcessRoutes(IProgressListener listener);
+        Task ProcessRoutes(IProgressListener listener, ITransactionDataAccess dataAccess);
 
         /// <summary>
         /// Indicates whether any route was changed
         /// </summary>
         /// <returns></returns>
-        Task<bool> AnyRouteChanged();
+        Task<bool> AnyRouteChanged(IReadOnlyDataAccess dataAccess);
     }
 }