wbrawner/thunderbird-android
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3059 from k9mail/clean_up_sync_code

Browse source 
"Simplify" sync code
This commit is contained in:
Vincent Breitmoser 2018-01-08 16:22:16 +01:00 committed by GitHub
commit 111f7fc194
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 98 additions and 234 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

122
k9mail/src/main/java/com/fsck/k9/controller/MessagingController.java
View file

@ -741,12 +741,11 @@ public class MessagingController {
if (remoteMessageStore != null) { if (remoteMessageStore != null) {
remoteMessageStore.sync(account, folder, listener, providedRemoteFolder); remoteMessageStore.sync(account, folder, listener, providedRemoteFolder);
} else { } else {
synchronizeMailboxSynchronousLegacy(account, folder, listener, providedRemoteFolder); synchronizeMailboxSynchronousLegacy(account, folder, listener);
} }
} }
void synchronizeMailboxSynchronousLegacy(final Account account, final String folder, final MessagingListener listener, void synchronizeMailboxSynchronousLegacy(Account account, String folder, MessagingListener listener) {
Folder providedRemoteFolder) {
Folder remoteFolder = null; Folder remoteFolder = null;
LocalFolder tLocalFolder = null; LocalFolder tLocalFolder = null;
@ -788,54 +787,43 @@ public class MessagingController {
tLocalFolder = localStore.getFolder(folder); tLocalFolder = localStore.getFolder(folder);
final LocalFolder localFolder = tLocalFolder; final LocalFolder localFolder = tLocalFolder;
localFolder.open(Folder.OPEN_MODE_RW); localFolder.open(Folder.OPEN_MODE_RW);
localFolder.updateLastUid();
Map<String, Long> localUidMap = localFolder.getAllMessagesAndEffectiveDates(); Map<String, Long> localUidMap = localFolder.getAllMessagesAndEffectiveDates();
if (providedRemoteFolder != null) { Store remoteStore = account.getRemoteStore();
Timber.v("SYNC: using providedRemoteFolder %s", folder);
remoteFolder = providedRemoteFolder;
} else {
Store remoteStore = account.getRemoteStore();
Timber.v("SYNC: About to get remote folder %s", folder); Timber.v("SYNC: About to get remote folder %s", folder);
remoteFolder = remoteStore.getFolder(folder); remoteFolder = remoteStore.getFolder(folder);
if (!verifyOrCreateRemoteSpecialFolder(account, folder, remoteFolder, listener)) {
return;
}
/*
* Synchronization process:
*
Open the folder
Upload any local messages that are marked as PENDING_UPLOAD (Drafts, Sent, Trash)
Get the message count
Get the list of the newest K9.DEFAULT_VISIBLE_LIMIT messages
getMessages(messageCount - K9.DEFAULT_VISIBLE_LIMIT, messageCount)
See if we have each message locally, if not fetch it's flags and envelope
Get and update the unread count for the folder
Update the remote flags of any messages we have locally with an internal date newer than the remote message.
Get the current flags for any messages we have locally but did not just download
Update local flags
For any message we have locally but not remotely, delete the local message to keep cache clean.
Download larger parts of any new messages.
(Optional) Download small attachments in the background.
*/
/*
* Open the remote folder. This pre-loads certain metadata like message count.
*/
Timber.v("SYNC: About to open remote folder %s", folder);
if (Expunge.EXPUNGE_ON_POLL == account.getExpungePolicy()) {
Timber.d("SYNC: Expunging folder %s:%s", account.getDescription(), folder);
remoteFolder.expunge();
}
remoteFolder.open(Folder.OPEN_MODE_RO);
if (!verifyOrCreateRemoteSpecialFolder(account, folder, remoteFolder, listener)) {
return;
} }
/*
* Synchronization process:
*
Open the folder
Upload any local messages that are marked as PENDING_UPLOAD (Drafts, Sent, Trash)
Get the message count
Get the list of the newest K9.DEFAULT_VISIBLE_LIMIT messages
getMessages(messageCount - K9.DEFAULT_VISIBLE_LIMIT, messageCount)
See if we have each message locally, if not fetch it's flags and envelope
Get and update the unread count for the folder
Update the remote flags of any messages we have locally with an internal date newer than the remote message.
Get the current flags for any messages we have locally but did not just download
Update local flags
For any message we have locally but not remotely, delete the local message to keep cache clean.
Download larger parts of any new messages.
(Optional) Download small attachments in the background.
*/
/*
* Open the remote folder. This pre-loads certain metadata like message count.
*/
Timber.v("SYNC: About to open remote folder %s", folder);
remoteFolder.open(Folder.OPEN_MODE_RO);
notificationController.clearAuthenticationErrorNotification(account, true); notificationController.clearAuthenticationErrorNotification(account, true);
/* /*
@ -1002,10 +990,7 @@ public class MessagingController {
System.currentTimeMillis()); System.currentTimeMillis());
} finally { } finally {
if (providedRemoteFolder == null) { closeFolder(remoteFolder);
closeFolder(remoteFolder);
}
closeFolder(tLocalFolder); closeFolder(tLocalFolder);
} }
@ -1125,12 +1110,6 @@ public class MessagingController {
final List<Message> largeMessages = new ArrayList<>(); final List<Message> largeMessages = new ArrayList<>();
final List<Message> smallMessages = new ArrayList<>(); final List<Message> smallMessages = new ArrayList<>();
if (!unsyncedMessages.isEmpty()) { if (!unsyncedMessages.isEmpty()) {
/*
* Reverse the order of the messages. Depending on the server this may get us
* fetch results for newest to oldest. If not, no harm done.
*/
Collections.sort(unsyncedMessages, new UidReverseComparator());
int visibleLimit = localFolder.getVisibleLimit(); int visibleLimit = localFolder.getVisibleLimit();
int listSize = unsyncedMessages.size(); int listSize = unsyncedMessages.size();
@ -1149,15 +1128,6 @@ public class MessagingController {
fetchUnsyncedMessages(account, remoteFolder, unsyncedMessages, smallMessages, largeMessages, progress, todo, fetchUnsyncedMessages(account, remoteFolder, unsyncedMessages, smallMessages, largeMessages, progress, todo,
fp); fp);
String updatedPushState = localFolder.getPushState();
for (Message message : unsyncedMessages) {
String newPushState = remoteFolder.getNewPushState(updatedPushState, message);
if (newPushState != null) {
updatedPushState = newPushState;
}
}
localFolder.setPushState(updatedPushState);
Timber.d("SYNC: Synced unsynced messages for folder %s", folder); Timber.d("SYNC: Synced unsynced messages for folder %s", folder);
} }
@ -1343,16 +1313,6 @@ public class MessagingController {
}); });
} }
private boolean shouldImportMessage(final Account account, final Message message,
final Date earliestDate) {
if (account.isSearchByDateCapable() && message.olderThan(earliestDate)) {
Timber.d("Message %s is older than %s, hence not saving", message.getUid(), earliestDate);
return false;
}
return true;
}
private <T extends Message> void downloadSmallMessages(final Account account, final Folder<T> remoteFolder, private <T extends Message> void downloadSmallMessages(final Account account, final Folder<T> remoteFolder,
final LocalFolder localFolder, final LocalFolder localFolder,
List<T> smallMessages, List<T> smallMessages,
@ -1363,8 +1323,6 @@ public class MessagingController {
FetchProfile fp) throws MessagingException { FetchProfile fp) throws MessagingException {
final String folder = remoteFolder.getName(); final String folder = remoteFolder.getName();
final Date earliestDate = account.getEarliestPollDate();
Timber.d("SYNC: Fetching %d small messages for folder %s", smallMessages.size(), folder); Timber.d("SYNC: Fetching %d small messages for folder %s", smallMessages.size(), folder);
remoteFolder.fetch(smallMessages, remoteFolder.fetch(smallMessages,
@ -1373,12 +1331,6 @@ public class MessagingController {
public void messageFinished(final T message, int number, int ofTotal) { public void messageFinished(final T message, int number, int ofTotal) {
try { try {
if (!shouldImportMessage(account, message, earliestDate)) {
progress.incrementAndGet();
return;
}
// Store the updated message locally // Store the updated message locally
final LocalMessage localMessage = localFolder.storeSmallMessage(message, new Runnable() { final LocalMessage localMessage = localFolder.storeSmallMessage(message, new Runnable() {
@Override @Override
@ -1436,18 +1388,12 @@ public class MessagingController {
final int todo, final int todo,
FetchProfile fp) throws MessagingException { FetchProfile fp) throws MessagingException {
final String folder = remoteFolder.getName(); final String folder = remoteFolder.getName();
final Date earliestDate = account.getEarliestPollDate();
Timber.d("SYNC: Fetching large messages for folder %s", folder); Timber.d("SYNC: Fetching large messages for folder %s", folder);
remoteFolder.fetch(largeMessages, fp, null); remoteFolder.fetch(largeMessages, fp, null);
for (T message : largeMessages) { for (T message : largeMessages) {
if (!shouldImportMessage(account, message, earliestDate)) {
progress.incrementAndGet();
continue;
}
if (message.getBody() == null) { if (message.getBody() == null) {
downloadSaneBody(account, remoteFolder, localFolder, message); downloadSaneBody(account, remoteFolder, localFolder, message);
} else { } else {

131
k9mail/src/main/java/com/fsck/k9/controller/imap/ImapSync.java
View file

@ -18,7 +18,6 @@ import com.fsck.k9.Account;
import com.fsck.k9.Account.Expunge; import com.fsck.k9.Account.Expunge;
import com.fsck.k9.AccountStats; import com.fsck.k9.AccountStats;
import com.fsck.k9.K9; import com.fsck.k9.K9;
import com.fsck.k9.Preferences;
import com.fsck.k9.activity.MessageReference; import com.fsck.k9.activity.MessageReference;
import com.fsck.k9.controller.MessagingController; import com.fsck.k9.controller.MessagingController;
import com.fsck.k9.controller.MessagingListener; import com.fsck.k9.controller.MessagingListener;
@ -332,9 +331,7 @@ class ImapSync {
/* /*
* If the folder is a "special" folder we need to see if it exists * If the folder is a "special" folder we need to see if it exists
* on the remote server. It if does not exist we'll try to create it. If we * on the remote server. It if does not exist we'll try to create it. If we
* can't create we'll abort. This will happen on every single Pop3 folder as * can't create we'll abort.
* designed and on Imap folders during error conditions. This allows us
* to treat Pop3 and Imap the same in this code.
*/ */
private boolean verifyOrCreateRemoteSpecialFolder(Account account, String folder, Folder remoteFolder, private boolean verifyOrCreateRemoteSpecialFolder(Account account, String folder, Folder remoteFolder,
MessagingListener listener) throws MessagingException { MessagingListener listener) throws MessagingException {
@ -420,11 +417,6 @@ class ImapSync {
final List<Message> largeMessages = new ArrayList<>(); final List<Message> largeMessages = new ArrayList<>();
final List<Message> smallMessages = new ArrayList<>(); final List<Message> smallMessages = new ArrayList<>();
if (!unsyncedMessages.isEmpty()) { if (!unsyncedMessages.isEmpty()) {
/*
* Reverse the order of the messages. Depending on the server this may get us
* fetch results for newest to oldest. If not, no harm done.
*/
Collections.sort(unsyncedMessages, new UidReverseComparator()); Collections.sort(unsyncedMessages, new UidReverseComparator());
int visibleLimit = localFolder.getVisibleLimit(); int visibleLimit = localFolder.getVisibleLimit();
int listSize = unsyncedMessages.size(); int listSize = unsyncedMessages.size();
@ -434,9 +426,7 @@ class ImapSync {
} }
FetchProfile fp = new FetchProfile(); FetchProfile fp = new FetchProfile();
if (remoteFolder.supportsFetchingFlags()) { fp.add(FetchProfile.Item.FLAGS);
fp.add(FetchProfile.Item.FLAGS);
}
fp.add(FetchProfile.Item.ENVELOPE); fp.add(FetchProfile.Item.ENVELOPE);
Timber.d("SYNC: About to fetch %d unsynced messages for folder %s", unsyncedMessages.size(), folder); Timber.d("SYNC: About to fetch %d unsynced messages for folder %s", unsyncedMessages.size(), folder);
@ -503,23 +493,6 @@ class ImapSync {
}); });
} }
// If the oldest message seen on this sync is newer than
// the oldest message seen on the previous sync, then
// we want to move our high-water mark forward
// this is all here just for pop which only syncs inbox
// this would be a little wrong for IMAP (we'd want a folder-level pref, not an account level pref.)
// fortunately, we just don't care.
Long oldestMessageTime = localFolder.getOldestMessageDate();
if (oldestMessageTime != null) {
Date oldestExtantMessage = new Date(oldestMessageTime);
if (oldestExtantMessage.before(downloadStarted) &&
oldestExtantMessage.after(new Date(account.getLatestOldMessageSeenTime()))) {
account.setLatestOldMessageSeenTime(oldestExtantMessage.getTime());
account.save(Preferences.getPreferences(context));
}
}
return newMessages.get(); return newMessages.get();
} }
@ -658,7 +631,7 @@ class ImapSync {
public void messageFinished(final T message, int number, int ofTotal) { public void messageFinished(final T message, int number, int ofTotal) {
try { try {
if (!shouldImportMessage(account, message, earliestDate)) { if (!shouldImportMessage(message, earliestDate)) {
progress.incrementAndGet(); progress.incrementAndGet();
return; return;
@ -728,7 +701,7 @@ class ImapSync {
remoteFolder.fetch(largeMessages, fp, null); remoteFolder.fetch(largeMessages, fp, null);
for (T message : largeMessages) { for (T message : largeMessages) {
if (!shouldImportMessage(account, message, earliestDate)) { if (!shouldImportMessage(message, earliestDate)) {
progress.incrementAndGet(); progress.incrementAndGet();
continue; continue;
} }
@ -775,45 +748,43 @@ class ImapSync {
) throws MessagingException { ) throws MessagingException {
final String folder = remoteFolder.getName(); final String folder = remoteFolder.getName();
if (remoteFolder.supportsFetchingFlags()) { Timber.d("SYNC: About to sync flags for %d remote messages for folder %s", syncFlagMessages.size(), folder);
Timber.d("SYNC: About to sync flags for %d remote messages for folder %s", syncFlagMessages.size(), folder);
FetchProfile fp = new FetchProfile(); FetchProfile fp = new FetchProfile();
fp.add(FetchProfile.Item.FLAGS); fp.add(FetchProfile.Item.FLAGS);
List<Message> undeletedMessages = new LinkedList<>(); List<Message> undeletedMessages = new LinkedList<>();
for (Message message : syncFlagMessages) { for (Message message : syncFlagMessages) {
if (!message.isSet(Flag.DELETED)) { if (!message.isSet(Flag.DELETED)) {
undeletedMessages.add(message); undeletedMessages.add(message);
}
}
remoteFolder.fetch(undeletedMessages, fp, null);
for (Message remoteMessage : syncFlagMessages) {
LocalMessage localMessage = localFolder.getMessage(remoteMessage.getUid());
boolean messageChanged = syncFlags(localMessage, remoteMessage);
if (messageChanged) {
boolean shouldBeNotifiedOf = false;
if (localMessage.isSet(Flag.DELETED) || isMessageSuppressed(localMessage)) {
for (MessagingListener l : getListeners()) {
l.synchronizeMailboxRemovedMessage(account, folder, localMessage);
}
} else {
if (shouldNotifyForMessage(account, localFolder, localMessage)) {
shouldBeNotifiedOf = true;
}
}
// we're only interested in messages that need removing
if (!shouldBeNotifiedOf) {
MessageReference messageReference = localMessage.makeMessageReference();
notificationController.removeNewMailNotification(account, messageReference);
} }
} }
progress.incrementAndGet();
remoteFolder.fetch(undeletedMessages, fp, null); for (MessagingListener l : getListeners()) {
for (Message remoteMessage : syncFlagMessages) { l.synchronizeMailboxProgress(account, folder, progress.get(), todo);
LocalMessage localMessage = localFolder.getMessage(remoteMessage.getUid());
boolean messageChanged = syncFlags(localMessage, remoteMessage);
if (messageChanged) {
boolean shouldBeNotifiedOf = false;
if (localMessage.isSet(Flag.DELETED) || isMessageSuppressed(localMessage)) {
for (MessagingListener l : getListeners()) {
l.synchronizeMailboxRemovedMessage(account, folder, localMessage);
}
} else {
if (shouldNotifyForMessage(account, localFolder, localMessage)) {
shouldBeNotifiedOf = true;
}
}
// we're only interested in messages that need removing
if (!shouldBeNotifiedOf) {
MessageReference messageReference = localMessage.makeMessageReference();
notificationController.removeNewMailNotification(account, messageReference);
}
}
progress.incrementAndGet();
for (MessagingListener l : getListeners()) {
l.synchronizeMailboxProgress(account, folder, progress.get(), todo);
}
} }
} }
} }
@ -840,28 +811,6 @@ class ImapSync {
localFolder.appendMessages(Collections.singletonList(message)); localFolder.appendMessages(Collections.singletonList(message));
Message localMessage = localFolder.getMessage(message.getUid()); Message localMessage = localFolder.getMessage(message.getUid());
// Certain (POP3) servers give you the whole message even when you ask for only the first x Kb
if (!message.isSet(Flag.X_DOWNLOADED_FULL)) {
/*
* Mark the message as fully downloaded if the message size is smaller than
* the account's autodownload size limit, otherwise mark as only a partial
* download. This will prevent the system from downloading the same message
* twice.
*
* If there is no limit on autodownload size, that's the same as the message
* being smaller than the max size
*/
if (account.getMaximumAutoDownloadMessageSize() == 0
|| message.getSize() < account.getMaximumAutoDownloadMessageSize()) {
localMessage.setFlag(Flag.X_DOWNLOADED_FULL, true);
} else {
// Set a flag indicating that the message has been partially downloaded and
// is ready for view.
localMessage.setFlag(Flag.X_DOWNLOADED_PARTIAL, true);
}
}
} }
private void downloadPartial(Folder remoteFolder, LocalFolder localFolder, Message message) private void downloadPartial(Folder remoteFolder, LocalFolder localFolder, Message message)
@ -913,10 +862,8 @@ class ImapSync {
return messageChanged; return messageChanged;
} }
private boolean shouldImportMessage(final Account account, final Message message, private boolean shouldImportMessage(Message message, Date earliestDate) {
final Date earliestDate) { if (message.olderThan(earliestDate)) {
if (account.isSearchByDateCapable() && message.olderThan(earliestDate)) {
Timber.d("Message %s is older than %s, hence not saving", message.getUid(), earliestDate); Timber.d("Message %s is older than %s, hence not saving", message.getUid(), earliestDate);
return false; return false;
} }

62
k9mail/src/test/java/com/fsck/k9/controller/MessagingControllerTest.java
View file

@ -616,9 +616,10 @@ public class MessagingControllerTest {
@Test @Test
public void synchronizeMailboxSynchronousLegacy_withOneMessageInRemoteFolder_shouldFinishWithoutError() public void synchronizeMailboxSynchronousLegacy_withOneMessageInRemoteFolder_shouldFinishWithoutError()
throws Exception { throws Exception {
configureRemoteStoreWithFolder();
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(listener).synchronizeMailboxFinished(account, FOLDER_NAME, 1, 0); verify(listener).synchronizeMailboxFinished(account, FOLDER_NAME, 1, 0);
} }
@ -626,9 +627,10 @@ public class MessagingControllerTest {
@Test @Test
public void synchronizeMailboxSynchronousLegacy_withEmptyRemoteFolder_shouldFinishWithoutError() public void synchronizeMailboxSynchronousLegacy_withEmptyRemoteFolder_shouldFinishWithoutError()
throws Exception { throws Exception {
configureRemoteStoreWithFolder();
messageCountInRemoteFolder(0); messageCountInRemoteFolder(0);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(listener).synchronizeMailboxFinished(account, FOLDER_NAME, 0, 0); verify(listener).synchronizeMailboxFinished(account, FOLDER_NAME, 0, 0);
} }
@ -636,9 +638,10 @@ public class MessagingControllerTest {
@Test @Test
public void synchronizeMailboxSynchronousLegacy_withNegativeMessageCountInRemoteFolder_shouldFinishWithError() public void synchronizeMailboxSynchronousLegacy_withNegativeMessageCountInRemoteFolder_shouldFinishWithError()
throws Exception { throws Exception {
configureRemoteStoreWithFolder();
messageCountInRemoteFolder(-1); messageCountInRemoteFolder(-1);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(listener).synchronizeMailboxFailed(account, FOLDER_NAME, verify(listener).synchronizeMailboxFailed(account, FOLDER_NAME,
"Exception: Message count -1 for folder Folder"); "Exception: Message count -1 for folder Folder");
@ -649,7 +652,7 @@ public class MessagingControllerTest {
throws Exception { throws Exception {
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(remoteFolder, never()).open(Folder.OPEN_MODE_RW); verify(remoteFolder, never()).open(Folder.OPEN_MODE_RW);
} }
@ -660,7 +663,7 @@ public class MessagingControllerTest {
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
configureRemoteStoreWithFolder(); configureRemoteStoreWithFolder();
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, null); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(remoteFolder).open(Folder.OPEN_MODE_RO); verify(remoteFolder).open(Folder.OPEN_MODE_RO);
} }
@ -669,7 +672,7 @@ public class MessagingControllerTest {
public void synchronizeMailboxSynchronousLegacy_withRemoteFolderProvided_shouldNotCloseRemoteFolder() throws Exception { public void synchronizeMailboxSynchronousLegacy_withRemoteFolderProvided_shouldNotCloseRemoteFolder() throws Exception {
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(remoteFolder, never()).close(); verify(remoteFolder, never()).close();
} }
@ -680,37 +683,15 @@ public class MessagingControllerTest {
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
configureRemoteStoreWithFolder(); configureRemoteStoreWithFolder();
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, null); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(remoteFolder).close(); verify(remoteFolder).close();
} }
@Test
public void synchronizeMailboxSynchronousLegacy_withAccountPolicySetToExpungeOnPoll_shouldExpungeRemoteFolder()
throws Exception {
messageCountInRemoteFolder(1);
when(account.getExpungePolicy()).thenReturn(Account.Expunge.EXPUNGE_ON_POLL);
configureRemoteStoreWithFolder();
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, null);
verify(remoteFolder).expunge();
}
@Test
public void synchronizeMailboxSynchronousLegacy_withAccountPolicySetToExpungeManually_shouldNotExpungeRemoteFolder()
throws Exception {
messageCountInRemoteFolder(1);
when(account.getExpungePolicy()).thenReturn(Account.Expunge.EXPUNGE_MANUALLY);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, null);
verify(remoteFolder, never()).expunge();
}
@Test @Test
public void synchronizeMailboxSynchronousLegacy_withAccountSetToSyncRemoteDeletions_shouldDeleteLocalCopiesOfDeletedMessages() public void synchronizeMailboxSynchronousLegacy_withAccountSetToSyncRemoteDeletions_shouldDeleteLocalCopiesOfDeletedMessages()
throws Exception { throws Exception {
configureRemoteStoreWithFolder();
messageCountInRemoteFolder(0); messageCountInRemoteFolder(0);
LocalMessage localCopyOfRemoteDeletedMessage = mock(LocalMessage.class); LocalMessage localCopyOfRemoteDeletedMessage = mock(LocalMessage.class);
when(account.syncRemoteDeletions()).thenReturn(true); when(account.syncRemoteDeletions()).thenReturn(true);
@ -718,7 +699,7 @@ public class MessagingControllerTest {
when(localFolder.getMessagesByUids(any(List.class))) when(localFolder.getMessagesByUids(any(List.class)))
.thenReturn(Collections.singletonList(localCopyOfRemoteDeletedMessage)); .thenReturn(Collections.singletonList(localCopyOfRemoteDeletedMessage));
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(localFolder).destroyMessages(messageListCaptor.capture()); verify(localFolder).destroyMessages(messageListCaptor.capture());
assertEquals(localCopyOfRemoteDeletedMessage, messageListCaptor.getValue().get(0)); assertEquals(localCopyOfRemoteDeletedMessage, messageListCaptor.getValue().get(0));
@ -735,7 +716,7 @@ public class MessagingControllerTest {
when(localMessage.olderThan(dateOfEarliestPoll)).thenReturn(false); when(localMessage.olderThan(dateOfEarliestPoll)).thenReturn(false);
when(localFolder.getMessages(null)).thenReturn(Collections.singletonList(localMessage)); when(localFolder.getMessages(null)).thenReturn(Collections.singletonList(localMessage));
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(localFolder, never()).destroyMessages(messageListCaptor.capture()); verify(localFolder, never()).destroyMessages(messageListCaptor.capture());
} }
@ -743,6 +724,7 @@ public class MessagingControllerTest {
@Test @Test
public void synchronizeMailboxSynchronousLegacy_withAccountSetToSyncRemoteDeletions_shouldDeleteLocalCopiesOfExistingMessagesBeforeEarliestPollDate() public void synchronizeMailboxSynchronousLegacy_withAccountSetToSyncRemoteDeletions_shouldDeleteLocalCopiesOfExistingMessagesBeforeEarliestPollDate()
throws Exception { throws Exception {
configureRemoteStoreWithFolder();
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
LocalMessage localMessage = localMessageWithCopyOnServer(); LocalMessage localMessage = localMessageWithCopyOnServer();
Date dateOfEarliestPoll = new Date(); Date dateOfEarliestPoll = new Date();
@ -752,7 +734,7 @@ public class MessagingControllerTest {
when(localFolder.getAllMessagesAndEffectiveDates()).thenReturn(Collections.singletonMap(MESSAGE_UID1, 0L)); when(localFolder.getAllMessagesAndEffectiveDates()).thenReturn(Collections.singletonMap(MESSAGE_UID1, 0L));
when(localFolder.getMessagesByUids(any(List.class))).thenReturn(Collections.singletonList(localMessage)); when(localFolder.getMessagesByUids(any(List.class))).thenReturn(Collections.singletonList(localMessage));
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(localFolder).destroyMessages(messageListCaptor.capture()); verify(localFolder).destroyMessages(messageListCaptor.capture());
assertEquals(localMessage, messageListCaptor.getValue().get(0)); assertEquals(localMessage, messageListCaptor.getValue().get(0));
@ -766,7 +748,7 @@ public class MessagingControllerTest {
when(account.syncRemoteDeletions()).thenReturn(false); when(account.syncRemoteDeletions()).thenReturn(false);
when(localFolder.getMessages(null)).thenReturn(Collections.singletonList(remoteDeletedMessage)); when(localFolder.getMessages(null)).thenReturn(Collections.singletonList(remoteDeletedMessage));
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(localFolder, never()).destroyMessages(messageListCaptor.capture()); verify(localFolder, never()).destroyMessages(messageListCaptor.capture());
} }
@ -774,11 +756,12 @@ public class MessagingControllerTest {
@Test @Test
public void synchronizeMailboxSynchronousLegacy_withAccountSupportingFetchingFlags_shouldFetchUnsychronizedMessagesListAndFlags() public void synchronizeMailboxSynchronousLegacy_withAccountSupportingFetchingFlags_shouldFetchUnsychronizedMessagesListAndFlags()
throws Exception { throws Exception {
configureRemoteStoreWithFolder();
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
hasUnsyncedRemoteMessage(); hasUnsyncedRemoteMessage();
when(remoteFolder.supportsFetchingFlags()).thenReturn(true); when(remoteFolder.supportsFetchingFlags()).thenReturn(true);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(remoteFolder, atLeastOnce()).fetch(any(List.class), fetchProfileCaptor.capture(), verify(remoteFolder, atLeastOnce()).fetch(any(List.class), fetchProfileCaptor.capture(),
any(MessageRetrievalListener.class)); any(MessageRetrievalListener.class));
@ -790,11 +773,12 @@ public class MessagingControllerTest {
@Test @Test
public void synchronizeMailboxSynchronousLegacy_withAccountNotSupportingFetchingFlags_shouldFetchUnsychronizedMessages() public void synchronizeMailboxSynchronousLegacy_withAccountNotSupportingFetchingFlags_shouldFetchUnsychronizedMessages()
throws Exception { throws Exception {
configureRemoteStoreWithFolder();
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
hasUnsyncedRemoteMessage(); hasUnsyncedRemoteMessage();
when(remoteFolder.supportsFetchingFlags()).thenReturn(false); when(remoteFolder.supportsFetchingFlags()).thenReturn(false);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(remoteFolder, atLeastOnce()).fetch(any(List.class), fetchProfileCaptor.capture(), verify(remoteFolder, atLeastOnce()).fetch(any(List.class), fetchProfileCaptor.capture(),
any(MessageRetrievalListener.class)); any(MessageRetrievalListener.class));
@ -806,12 +790,13 @@ public class MessagingControllerTest {
public void synchronizeMailboxSynchronousLegacy_withUnsyncedNewSmallMessage_shouldFetchBodyOfSmallMessage() public void synchronizeMailboxSynchronousLegacy_withUnsyncedNewSmallMessage_shouldFetchBodyOfSmallMessage()
throws Exception { throws Exception {
Message smallMessage = buildSmallNewMessage(); Message smallMessage = buildSmallNewMessage();
configureRemoteStoreWithFolder();
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
hasUnsyncedRemoteMessage(); hasUnsyncedRemoteMessage();
when(remoteFolder.supportsFetchingFlags()).thenReturn(false); when(remoteFolder.supportsFetchingFlags()).thenReturn(false);
respondToFetchEnvelopesWithMessage(smallMessage); respondToFetchEnvelopesWithMessage(smallMessage);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
verify(remoteFolder, atLeast(2)).fetch(any(List.class), fetchProfileCaptor.capture(), verify(remoteFolder, atLeast(2)).fetch(any(List.class), fetchProfileCaptor.capture(),
any(MessageRetrievalListener.class)); any(MessageRetrievalListener.class));
@ -823,12 +808,13 @@ public class MessagingControllerTest {
public void synchronizeMailboxSynchronousLegacy_withUnsyncedNewSmallMessage_shouldFetchStructureAndLimitedBodyOfLargeMessage() public void synchronizeMailboxSynchronousLegacy_withUnsyncedNewSmallMessage_shouldFetchStructureAndLimitedBodyOfLargeMessage()
throws Exception { throws Exception {
Message largeMessage = buildLargeNewMessage(); Message largeMessage = buildLargeNewMessage();
configureRemoteStoreWithFolder();
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
hasUnsyncedRemoteMessage(); hasUnsyncedRemoteMessage();
when(remoteFolder.supportsFetchingFlags()).thenReturn(false); when(remoteFolder.supportsFetchingFlags()).thenReturn(false);
respondToFetchEnvelopesWithMessage(largeMessage); respondToFetchEnvelopesWithMessage(largeMessage);
controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener, remoteFolder); controller.synchronizeMailboxSynchronousLegacy(account, FOLDER_NAME, listener);
//TODO: Don't bother fetching messages of a size we don't have //TODO: Don't bother fetching messages of a size we don't have
verify(remoteFolder, atLeast(4)).fetch(any(List.class), fetchProfileCaptor.capture(), verify(remoteFolder, atLeast(4)).fetch(any(List.class), fetchProfileCaptor.capture(),

17
k9mail/src/test/java/com/fsck/k9/controller/imap/ImapSyncTest.java
View file

@ -247,8 +247,7 @@ public class ImapSyncTest {
} }
@Test @Test
public void sync_withAccountSupportingFetchingFlags_shouldFetchUnsychronizedMessagesListAndFlags() public void sync_shouldFetchUnsynchronizedMessagesListAndFlags() throws Exception {
throws Exception {
messageCountInRemoteFolder(1); messageCountInRemoteFolder(1);
hasUnsyncedRemoteMessage(); hasUnsyncedRemoteMessage();
when(remoteFolder.supportsFetchingFlags()).thenReturn(true); when(remoteFolder.supportsFetchingFlags()).thenReturn(true);
@ -262,20 +261,6 @@ public class ImapSyncTest {
assertEquals(2, fetchProfileCaptor.getAllValues().get(0).size()); assertEquals(2, fetchProfileCaptor.getAllValues().get(0).size());
} }
@Test
public void sync_withAccountNotSupportingFetchingFlags_shouldFetchUnsychronizedMessages() throws Exception {
messageCountInRemoteFolder(1);
hasUnsyncedRemoteMessage();
when(remoteFolder.supportsFetchingFlags()).thenReturn(false);
imapSync.sync(account, FOLDER_NAME, listener, remoteFolder);
verify(remoteFolder, atLeastOnce()).fetch(any(List.class), fetchProfileCaptor.capture(),
any(MessageRetrievalListener.class));
assertEquals(1, fetchProfileCaptor.getAllValues().get(0).size());
assertTrue(fetchProfileCaptor.getAllValues().get(0).contains(FetchProfile.Item.ENVELOPE));
}
@Test @Test
public void sync_withUnsyncedNewSmallMessage_shouldFetchBodyOfSmallMessage() throws Exception { public void sync_withUnsyncedNewSmallMessage_shouldFetchBodyOfSmallMessage() throws Exception {
Message smallMessage = buildSmallNewMessage(); Message smallMessage = buildSmallNewMessage();