Merge pull request #1416 from matrix-org/andy/5873_initial_sync

Log when filters cannot be saved or loaded

Author: Anderas

MatrixSDK/Data/Store/MXFileStore/MXFileStore.m

@@ -1652,13 +1652,15 @@ - (void)saveMetaData
 #pragma mark - Matrix filters
 - (void)loadFilters
 {
+    MXLogDebug(@"[MXFileStore] Loading filters");
     NSString *file = [storePath stringByAppendingPathComponent:kMXFileStoreFiltersFile];
-    filters = [NSKeyedUnarchiver unarchiveObjectWithFile:file];
+    filters = [self loadObjectOfClasses:[NSSet setWithArray:@[NSDictionary.class, NSString.class]] fromFile:file];
 
     if (!filters)
     {
         // This is used as flag to indicate it has been mounted from the file
         filters = [NSMutableDictionary dictionary];
+        MXLogDebug(@"[MXFileStore] No filters loaded, creating empty dictionary");
     }
 }
 
@@ -1690,7 +1692,8 @@ - (void)saveFilters
             }
 
             // Store new data
-            [NSKeyedArchiver archiveRootObject:self->filters toFile:file];
+            MXLogDebug(@"[MXFileStore] Saving filters");
+            [self saveObject:self->filters toFile:file];
         });
     }
 }
@@ -2171,6 +2174,65 @@ - (MXFileRoomStore *)roomStoreForRoom:(NSString*)roomId
 
 
 #pragma mark - Tools
+
+- (void)saveObject:(id)object toFile:(NSString *)file
+{
+    if (@available(iOS 11.0, *))
+    {
+        NSError *error;
+        NSData *data = [NSKeyedArchiver archivedDataWithRootObject:object requiringSecureCoding:NO error:&error];
+        if (error)
+        {
+            MXLogDebug(@"[MXFileStore] Failed archiving root object with error: '%@'", error.localizedDescription);
+            return;
+        }
+        
+        BOOL success = [data writeToFile:file options:0 error:&error];
+        if (success)
+        {
+            MXLogDebug(@"[MXFileStore] Saved data successfully");
+        }
+        else
+        {
+            MXLogDebug(@"[MXFileStore] Failed saving data with error: '%@'", error.localizedDescription);
+        }
+    }
+    else
+    {
+        [NSKeyedArchiver archiveRootObject:object toFile:file];
+    }
+}
+
+- (id)loadObjectOfClasses:(NSSet<Class> *)classes fromFile:(NSString *)file
+{
+    if (@available(iOS 11.0, *))
+    {
+        NSData *data = [NSData dataWithContentsOfFile:file];
+        if (!data)
+        {
+            MXLogDebug(@"[MXFileStore] No data to load at file %@", file);
+            return nil;
+        }
+        
+        NSError *error;
+        id object = [NSKeyedUnarchiver unarchivedObjectOfClasses:classes fromData:data error:&error];
+        if (object)
+        {
+            MXLogDebug(@"[MXFileStore] Loaded object from class");
+            return object;
+        }
+        else
+        {
+            MXLogDebug(@"[MXFileStore] Failed loading object from class with error: '%@'", error.localizedDescription);
+            return nil;
+        }
+    }
+    else
+    {
+        return [NSKeyedUnarchiver unarchiveObjectWithFile:file];
+    }
+}
+
 /**
  List recursevely files in a folder
  

MatrixSDK/Data/Store/MXMemoryStore/MXMemoryStore.m

@@ -429,6 +429,11 @@ - (void)storeFilter:(nonnull MXFilterJSONModel*)filter withFilterId:(nonnull NSS
     filters[filterId] = filter.jsonString;
 }
 
+- (NSArray<NSString *> *)allFilterIds
+{
+    return filters.allKeys;
+}
+
 - (void)filterWithFilterId:(nonnull NSString*)filterId
                    success:(nonnull void (^)(MXFilterJSONModel * _Nullable filter))success
                    failure:(nullable void (^)(NSError * _Nullable error))failure

MatrixSDK/Data/Store/MXNoStore/MXNoStore.m

@@ -348,6 +348,11 @@ - (void)storeFilter:(nonnull MXFilterJSONModel*)filter withFilterId:(nonnull NSS
 {
 }
 
+- (NSArray<NSString *> *)allFilterIds
+{
+    return @[];
+}
+
 - (void)filterWithFilterId:(nonnull NSString*)filterId
                    success:(nonnull void (^)(MXFilterJSONModel * _Nullable filter))success
                    failure:(nullable void (^)(NSError * _Nullable error))failure

MatrixSDK/Data/Store/MXStore.h

@@ -521,6 +521,11 @@
  */
 - (void)storeFilter:(nonnull MXFilterJSONModel*)filter withFilterId:(nonnull NSString*)filterId;
 
+/**
+ Retrieve a list of all stored filter ids.
+ */
+- (nonnull NSArray <NSString *> *)allFilterIds;
+
 /**
  Retrieve a filter with a given id.
 

MatrixSDKTests/MXFilterTests.m

@@ -175,6 +175,7 @@ - (void)testFilterPermanentStorage
 
                         XCTAssertNotNil(filter2);
                         XCTAssertEqualObjects(filter, filter2);
+                        XCTAssertEqualObjects(fileStore.allFilterIds, @[syncFilterId]);
 
                         [expectation fulfill];
 

changelog.d/5873.bugfix

@@ -0,0 +1 @@
+MXFileStore: Log when filters cannot be saved or loaded