You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
session-ios/Signal/test/util/OWSOrphanDataCleanerTest.m

252 lines
9.6 KiB
Matlab

//
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//
#import "OWSOrphanDataCleaner.h"
#import "SignalBaseTest.h"
#import <SignalServiceKit/OWSDevice.h>
#import <SignalServiceKit/OWSPrimaryStorage.h>
#import <SignalServiceKit/TSAttachmentStream.h>
#import <SignalServiceKit/TSContactThread.h>
#import <SignalServiceKit/TSIncomingMessage.h>
@interface OWSOrphanDataCleaner (Test)
+ (nullable NSSet<NSString *> *)filePathsInDirectorySafe:(NSString *)dirPath;
@end
#pragma mark -
@interface OWSOrphanDataCleanerTest : SignalBaseTest
@end
#pragma mark -
@implementation OWSOrphanDataCleanerTest
#ifdef BROKEN_TESTS
- (void)setUp
{
[super setUp];
// Register views, etc.
[OWSPrimaryStorage registerExtensionsWithMigrationBlock:^{
}];
// Set up initial conditions & Sanity check
XCTAssertEqual(0, [self numberOfItemsInAttachmentsFolder]);
XCTAssertEqual(0, [TSAttachmentStream numberOfKeysInCollection]);
XCTAssertEqual(0, [TSIncomingMessage numberOfKeysInCollection]);
XCTAssertEqual(0, [TSThread numberOfKeysInCollection]);
}
- (void)tearDown
{
[super tearDown];
}
- (int)numberOfItemsInAttachmentsFolder
{
NSString *legacyAttachmentsDirPath = TSAttachmentStream.legacyAttachmentsDirPath;
NSSet<NSString *> *_Nullable legacyAttachmentFilePaths =
[OWSOrphanDataCleaner filePathsInDirectorySafe:legacyAttachmentsDirPath];
NSString *sharedDataAttachmentsDirPath = TSAttachmentStream.sharedDataAttachmentsDirPath;
NSSet<NSString *> *_Nullable sharedDataAttachmentFilePaths =
[OWSOrphanDataCleaner filePathsInDirectorySafe:sharedDataAttachmentsDirPath];
NSMutableSet<NSString *> *attachmentFilePaths = [NSMutableSet new];
if (legacyAttachmentFilePaths) {
[attachmentFilePaths unionSet:legacyAttachmentFilePaths];
}
if (sharedDataAttachmentFilePaths) {
[attachmentFilePaths unionSet:sharedDataAttachmentFilePaths];
}
return (int)attachmentFilePaths.count;
}
- (TSIncomingMessage *)createIncomingMessageWithThread:(TSThread *)thread
attachmentIds:(NSArray<NSString *> *)attachmentIds
{
TSIncomingMessage *incomingMessage =
[[TSIncomingMessage alloc] initIncomingMessageWithTimestamp:1
inThread:thread
authorId:@"fake-author-id"
sourceDeviceId:OWSDevicePrimaryDeviceId
messageBody:@"footch"
attachmentIds:attachmentIds
expiresInSeconds:0
quotedMessage:nil
contactShare:nil];
[incomingMessage save];
return incomingMessage;
}
- (TSAttachmentStream *)createAttachmentStream
{
NSError *error;
TSAttachmentStream *attachmentStream =
[[TSAttachmentStream alloc] initWithContentType:@"image/jpeg" byteCount:12 sourceFilename:nil];
[attachmentStream writeData:[NSData new] error:&error];
XCTAssertNil(error);
[attachmentStream save];
return attachmentStream;
}
- (void)testInteractionsWithoutThreadAreDeleted
{
// This thread is intentionally not saved. It's meant to recreate a situation we've seen where interactions exist
// that reference the id of a thread that no longer exists. Presumably this is the result of a deleted thread not
// properly deleting it's interactions.
TSContactThread *unsavedThread = [[TSContactThread alloc] initWithUniqueId:@"this-thread-does-not-exist"];
__unused TSIncomingMessage *incomingMessage =
[self createIncomingMessageWithThread:unsavedThread attachmentIds:@[]];
XCTAssertEqual(1, [TSIncomingMessage numberOfKeysInCollection]);
XCTestExpectation *expectation = [self expectationWithDescription:@"Cleanup"];
[OWSOrphanDataCleaner auditAndCleanup:YES
completion:^{
[expectation fulfill];
}];
[self waitForExpectationsWithTimeout:5.0
handler:^(NSError *error) {
if (error) {
XCTFail(@"Expectation Failed with error: %@", error);
}
}];
XCTAssertEqual(0, [TSIncomingMessage numberOfKeysInCollection]);
}
- (void)testInteractionsWithThreadAreNotDeleted
{
TSContactThread *savedThread = [[TSContactThread alloc] initWithUniqueId:@"this-thread-exists"];
[savedThread save];
__unused TSIncomingMessage *incomingMessage = [self createIncomingMessageWithThread:savedThread attachmentIds:@[]];
XCTAssertEqual(1, [TSIncomingMessage numberOfKeysInCollection]);
XCTestExpectation *expectation = [self expectationWithDescription:@"Cleanup"];
[OWSOrphanDataCleaner auditAndCleanup:YES
completion:^{
[expectation fulfill];
}];
[self waitForExpectationsWithTimeout:5.0
handler:^(NSError *error) {
if (error) {
XCTFail(@"Expectation Failed with error: %@", error);
}
}];
XCTAssertEqual(1, [TSIncomingMessage numberOfKeysInCollection]);
}
- (void)testFilesWithoutInteractionsAreDeleted
{
// sanity check
XCTAssertEqual(0, [self numberOfItemsInAttachmentsFolder]);
TSAttachmentStream *attachmentStream = [self createAttachmentStream];
NSString *orphanFilePath = [attachmentStream originalFilePath];
BOOL fileExists = [[NSFileManager defaultManager] fileExistsAtPath:orphanFilePath];
XCTAssert(fileExists);
XCTAssertEqual(1, [self numberOfItemsInAttachmentsFolder]);
// Do multiple cleanup passes.
for (int i = 0; i < 2; i++) {
XCTestExpectation *expectation = [self expectationWithDescription:@"Cleanup"];
[OWSOrphanDataCleaner auditAndCleanup:YES
completion:^{
[expectation fulfill];
}];
[self waitForExpectationsWithTimeout:5.0
handler:^(NSError *error) {
if (error) {
XCTFail(@"Expectation Failed with error: %@", error);
}
}];
}
fileExists = [[NSFileManager defaultManager] fileExistsAtPath:orphanFilePath];
XCTAssertFalse(fileExists);
XCTAssertEqual(0, [self numberOfItemsInAttachmentsFolder]);
}
- (void)testFilesWithInteractionsAreNotDeleted
{
TSContactThread *savedThread = [[TSContactThread alloc] initWithUniqueId:@"this-thread-exists"];
[savedThread save];
TSAttachmentStream *attachmentStream = [self createAttachmentStream];
__unused TSIncomingMessage *incomingMessage =
[self createIncomingMessageWithThread:savedThread attachmentIds:@[ attachmentStream.uniqueId ]];
NSString *attachmentFilePath = [attachmentStream originalFilePath];
BOOL fileExists = [[NSFileManager defaultManager] fileExistsAtPath:attachmentFilePath];
XCTAssert(fileExists);
XCTAssertEqual(1, [self numberOfItemsInAttachmentsFolder]);
XCTestExpectation *expectation = [self expectationWithDescription:@"Cleanup"];
[OWSOrphanDataCleaner auditAndCleanup:YES
completion:^{
[expectation fulfill];
}];
[self waitForExpectationsWithTimeout:5.0
handler:^(NSError *error) {
if (error) {
XCTFail(@"Expectation Failed with error: %@", error);
}
}];
fileExists = [[NSFileManager defaultManager] fileExistsAtPath:attachmentFilePath];
XCTAssert(fileExists);
XCTAssertEqual(1, [self numberOfItemsInAttachmentsFolder]);
}
- (void)testFilesWithoutAttachmentStreamsAreDeleted
{
Explain send failures for text and media messages Motivation ---------- We were often swallowing errors or yielding generic errors when it would be better to provide specific errors. We also didn't create an attachment when attachments failed to send, making it impossible to show the user what was happening with an in-progress or failed attachment. Primary Changes --------------- - Funnel all message sending through MessageSender, and remove message sending from MessagesManager. - Record most recent sending error so we can expose it in the UI - Can resend attachments. - Update message status for attachments, just like text messages - Extracted UploadingService from MessagesManager - Saving attachment stream before uploading gives uniform API for send vs. resend - update status for downloading transcript attachments - TSAttachments have a local id, separate from the server allocated id This allows us to save the attachment before the allocation request. Which is is good because: 1. can show feedback to user faster. 2. allows us to show an error when allocation fails. Code Cleanup ------------ - Replaced a lot of global singleton access with injected dependencies to make for easier testing. - Never save group meta messages. Rather than checking before (hopefully) every save, do it in the save method. - Don't use callbacks for sync code. - Handle errors on writing attachment data - Fix old long broken tests that weren't even running. =( - Removed dead code - Use constants vs define - Port flaky travis fixes from Signal-iOS // FREEBIE
9 years ago
NSError *error;
TSAttachmentStream *attachmentStream =
[[TSAttachmentStream alloc] initWithContentType:@"image/jpeg" byteCount:0 sourceFilename:nil];
Explain send failures for text and media messages Motivation ---------- We were often swallowing errors or yielding generic errors when it would be better to provide specific errors. We also didn't create an attachment when attachments failed to send, making it impossible to show the user what was happening with an in-progress or failed attachment. Primary Changes --------------- - Funnel all message sending through MessageSender, and remove message sending from MessagesManager. - Record most recent sending error so we can expose it in the UI - Can resend attachments. - Update message status for attachments, just like text messages - Extracted UploadingService from MessagesManager - Saving attachment stream before uploading gives uniform API for send vs. resend - update status for downloading transcript attachments - TSAttachments have a local id, separate from the server allocated id This allows us to save the attachment before the allocation request. Which is is good because: 1. can show feedback to user faster. 2. allows us to show an error when allocation fails. Code Cleanup ------------ - Replaced a lot of global singleton access with injected dependencies to make for easier testing. - Never save group meta messages. Rather than checking before (hopefully) every save, do it in the save method. - Don't use callbacks for sync code. - Handle errors on writing attachment data - Fix old long broken tests that weren't even running. =( - Removed dead code - Use constants vs define - Port flaky travis fixes from Signal-iOS // FREEBIE
9 years ago
[attachmentStream writeData:[NSData new] error:&error];
// Intentionally not saved, because we want a lingering file.
Explain send failures for text and media messages Motivation ---------- We were often swallowing errors or yielding generic errors when it would be better to provide specific errors. We also didn't create an attachment when attachments failed to send, making it impossible to show the user what was happening with an in-progress or failed attachment. Primary Changes --------------- - Funnel all message sending through MessageSender, and remove message sending from MessagesManager. - Record most recent sending error so we can expose it in the UI - Can resend attachments. - Update message status for attachments, just like text messages - Extracted UploadingService from MessagesManager - Saving attachment stream before uploading gives uniform API for send vs. resend - update status for downloading transcript attachments - TSAttachments have a local id, separate from the server allocated id This allows us to save the attachment before the allocation request. Which is is good because: 1. can show feedback to user faster. 2. allows us to show an error when allocation fails. Code Cleanup ------------ - Replaced a lot of global singleton access with injected dependencies to make for easier testing. - Never save group meta messages. Rather than checking before (hopefully) every save, do it in the save method. - Don't use callbacks for sync code. - Handle errors on writing attachment data - Fix old long broken tests that weren't even running. =( - Removed dead code - Use constants vs define - Port flaky travis fixes from Signal-iOS // FREEBIE
9 years ago
NSString *orphanFilePath = [attachmentStream originalFilePath];
BOOL fileExists = [[NSFileManager defaultManager] fileExistsAtPath:orphanFilePath];
XCTAssert(fileExists);
XCTAssertEqual(1, [self numberOfItemsInAttachmentsFolder]);
XCTestExpectation *expectation = [self expectationWithDescription:@"Cleanup"];
[OWSOrphanDataCleaner auditAndCleanup:YES
completion:^{
[expectation fulfill];
}];
[self waitForExpectationsWithTimeout:5.0
handler:^(NSError *error) {
if (error) {
XCTFail(@"Expectation Failed with error: %@", error);
}
}];
fileExists = [[NSFileManager defaultManager] fileExistsAtPath:orphanFilePath];
XCTAssertFalse(fileExists);
XCTAssertEqual(0, [self numberOfItemsInAttachmentsFolder]);
}
#endif
@end