Merge pull request #899 from ParsePlatform/nlutsenko.fileCache

Add ability to clear PFFile cache.

Author: nlutsenko

Parse/Internal/File/Controller/PFFileController.h

@@ -94,7 +94,8 @@
 #pragma mark - Cache
 ///--------------------------------------
 
-- (BFTask<PFVoid> *)clearFileCacheAsync;
+- (BFTask<PFVoid> *)clearFileCacheAsyncForFileWithState:(PFFileState *)fileState;
+- (BFTask<PFVoid> *)clearAllFileCacheAsync;
 
 - (NSString *)cachedFilePathForFileState:(PFFileState *)fileState;
 

Parse/Internal/File/Controller/PFFileController.m

@@ -259,7 +259,18 @@ - (NSString *)cacheFilesDirectoryPath {
     return [self.dataSource.fileManager parseCacheItemPathForPathComponent:PFFileControllerCacheDirectoryName_];
 }
 
-- (BFTask<PFVoid> *)clearFileCacheAsync {
+- (BFTask<PFVoid> *)clearFileCacheAsyncForFileWithState:(PFFileState *)fileState {
+    return [BFTask taskFromExecutor:[BFExecutor defaultExecutor] withBlock:^id{
+        NSString *filePath = [self cachedFilePathForFileState:fileState];
+        if (!filePath) {
+            return nil;
+        }
+        // No need to lock on this, since we are removing from a cache directory.
+        return [PFFileManager removeItemAtPathAsync:filePath withFileLock:NO];
+    }];
+}
+
+- (BFTask<PFVoid> *)clearAllFileCacheAsync {
     return [BFTask taskFromExecutor:[BFExecutor defaultExecutor] withBlock:^id{
         NSString *path = self.cacheFilesDirectoryPath;
         if ([[NSFileManager defaultManager] fileExistsAtPath:path]) {

Parse/PFFile.h

@@ -366,6 +366,24 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)cancel;
 
+///--------------------------------------
+#pragma mark - Cache
+///--------------------------------------
+
+/**
+ Clears all cached data for this file.
+
+ @return The task, with the result set to `nil` if the operation succeeds.
+ */
+- (BFTask *)clearCachedDataInBackground;
+
+/**
+ Clears all cached data for all downloaded files.
+
+ @return The task, with the result set to `nil` if the operation succeeds.
+ */
++ (BFTask *)clearAllCachedDataInBackground;
+
 @end
 
 NS_ASSUME_NONNULL_END

Parse/PFFile.m

@@ -217,6 +217,20 @@ - (void)cancel {
     }];
 }
 
+#pragma mark Cache
+
+- (BFTask *)clearCachedDataInBackground {
+    @weakify(self);
+    return [self.taskQueue enqueue:^id(BFTask *_) {
+        @strongify(self);
+        return [[[[self class] fileController] clearFileCacheAsyncForFileWithState:self.state] continueWithSuccessResult:nil];
+    }];
+}
+
++ (BFTask *)clearAllCachedDataInBackground {
+    return [[[self fileController] clearAllFileCacheAsync] continueWithSuccessResult:nil];
+}
+
 ///--------------------------------------
 #pragma mark - Private
 ///--------------------------------------

Tests/Unit/FileControllerTests.m

@@ -497,7 +497,33 @@ - (void)testUploadCancel {
     [self waitForTestExpectations];
 }
 
-- (void)testClearCaches {
+- (void)testClearFileCache {
+    id mockedDataSource = PFStrictProtocolMock(@protocol(PFFileManagerProvider));
+    id mockedFileManager = PFStrictClassMock([PFFileManager class]);
+
+    NSString *temporaryPath = [self temporaryDirectory];
+    NSString *downloadsPath = [temporaryPath stringByAppendingPathComponent:@"downloads"];
+
+    OCMStub([mockedDataSource fileManager]).andReturn(mockedFileManager);
+    OCMStub([mockedFileManager parseLocalSandboxDataDirectoryPath]).andReturn(temporaryPath);
+    OCMStub([mockedFileManager parseCacheItemPathForPathComponent:@"PFFileCache"]).andReturn(downloadsPath);
+
+    PFFileController *fileController = [PFFileController controllerWithDataSource:mockedDataSource];
+    PFFileState *fileState = [[PFMutableFileState alloc] initWithName:@"sampleData"
+                                                            urlString:temporaryPath
+                                                             mimeType:@"application/octet-stream"];
+
+    XCTestExpectation *expectation = [self currentSelectorTestExpectation];
+    [[fileController clearFileCacheAsyncForFileWithState:fileState] continueWithBlock:^id(BFTask *task) {
+        XCTAssertNil(task.error);
+        [expectation fulfill];
+        return nil;
+    }];
+
+    [self waitForTestExpectations];
+}
+
+- (void)testClearAllFilesCache {
     id mockedDataSource = PFStrictProtocolMock(@protocol(PFFileManagerProvider));
     id mockedFileManager = PFStrictClassMock([PFFileManager class]);
 
@@ -511,7 +537,7 @@ - (void)testClearCaches {
     PFFileController *fileController = [PFFileController controllerWithDataSource:mockedDataSource];
 
     XCTestExpectation *expectation = [self currentSelectorTestExpectation];
-    [[fileController clearFileCacheAsync] continueWithBlock:^id(BFTask *task) {
+    [[fileController clearAllFileCacheAsync] continueWithBlock:^id(BFTask *task) {
         XCTAssertNil(task.error);
         [expectation fulfill];
         return nil;

Tests/Unit/FileUnitTests.m

@@ -508,4 +508,40 @@ - (void)testCancel {
     [self waitForTestExpectations];
 }
 
+- (void)testClearCachedData {
+    id mockedFileController = [Parse _currentManager].coreManager.fileController;
+
+    PFFile *file = [PFFile fileWithName:@"a" data:[NSData data]];
+    OCMExpect([mockedFileController clearFileCacheAsyncForFileWithState:file.state]).andReturn([BFTask taskWithResult:nil]);
+
+    XCTestExpectation *expectation = [self currentSelectorTestExpectation];
+    [[file clearCachedDataInBackground] continueWithBlock:^id _Nullable(BFTask * _Nonnull task) {
+        XCTAssertNil(task.result);
+        XCTAssertFalse(task.faulted);
+        XCTAssertFalse(task.cancelled);
+        [expectation fulfill];
+        return nil;
+    }];
+    [self waitForTestExpectations];
+
+    OCMVerifyAll(mockedFileController);
+}
+
+- (void)testClearAllCachedData {
+    id mockedFileController = [Parse _currentManager].coreManager.fileController;
+    OCMExpect([mockedFileController clearAllFileCacheAsync]).andReturn([BFTask taskWithResult:nil]);
+
+    XCTestExpectation *expectation = [self currentSelectorTestExpectation];
+    [[PFFile clearAllCachedDataInBackground] continueWithBlock:^id _Nullable(BFTask * _Nonnull task) {
+        XCTAssertNil(task.result);
+        XCTAssertFalse(task.faulted);
+        XCTAssertFalse(task.cancelled);
+        [expectation fulfill];
+        return nil;
+    }];
+    [self waitForTestExpectations];
+
+    OCMVerifyAll(mockedFileController);
+}
+
 @end