This repository has been archived by the owner on Nov 3, 2021. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #275 from mcav/downloadbodyreps-idempotent
Bug 912825 - [email] Message reader appears to duplicate body contents when buildBodyDom is called multiple times. r=asuth
- Loading branch information
Showing
8 changed files
with
159 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| define(['rdcommon/testcontext', './resources/th_main', 'exports'], | ||
| function($tc, $th_imap, exports) { | ||
|
|
||
| var TD = exports.TD = $tc.defineTestsFor( | ||
| { id: 'test_downloadbodyreps_idempotency' }, | ||
| null, | ||
| [$th_imap.TESTHELPER], ['app'] | ||
| ); | ||
|
|
||
| TD.commonCase('fetch only snippets', function(T, RT) { | ||
| var testUniverse = T.actor('testUniverse', 'U'), | ||
| testAccount = T.actor('testAccount', 'A', { universe: testUniverse }); | ||
|
|
||
| // Create a folder to test on | ||
| var eLazy = T.lazyLogger('misc'); | ||
| var folderName = 'test_downloadbodyreps_idempotency'; | ||
| // We want just one message in the inbox; IMAP already adds one for | ||
| // tests so that we can detect timezones, so only add one for other | ||
| // account types. | ||
| var messageCount = (testAccount.type === 'imap' ? 0 : 1); | ||
|
|
||
| // Set POP3 to not retrieve any of the message when fetching | ||
| // headers. Otherwise it might have already finished downloading | ||
| // short messages, which would make the assertions below | ||
| // inconsistent between prototols. | ||
| testUniverse.do_adjustSyncValues({ | ||
| POP3_SNIPPET_SIZE_GOAL: 0 | ||
| }); | ||
|
|
||
| // Use the inbox, so that POP3 will actually run its sync logic. | ||
| var testFolder = testAccount.do_useExistingFolderWithType('inbox', ''); | ||
| if (messageCount > 0) { | ||
| testAccount.do_addMessagesToFolder(testFolder, { count: messageCount }); | ||
| } | ||
| var testView = testAccount.do_openFolderView( | ||
| 'syncs', testFolder, null, null, { syncedToDawnOfTime: 'ignore' }); | ||
|
|
||
| // When requesting bodyReps multiple times, we should only see one | ||
| // set of "onchange" notifications -- after we actually download and | ||
| // change the body. In other words, we enforce an idempotency | ||
| // guarantee that the frontend doesn't have to worry about | ||
| // spurious/redundant body "onchange" notifications. | ||
| T.action('request full body after snippets', eLazy, function() { | ||
| // only the first job will actually download the bodies, the other | ||
| // jobs will still happen but will turn into no-ops | ||
| // this might need conn: true/etc. | ||
|
|
||
| // We need three of these: Two for "downloadBodyReps" calls, and | ||
| // one for the "withBodyReps" call. Only the first will actually | ||
| // cause us to download and save the bodyReps. | ||
| testAccount.expect_runOp('downloadBodyReps', { | ||
| local: false, server: true, save: 'server' }); | ||
| testAccount.expect_runOp('downloadBodyReps', { | ||
| local: false, server: true, save: false }); | ||
| testAccount.expect_runOp('downloadBodyReps', { | ||
| local: false, server: true, save: false }); | ||
|
|
||
| // TODO: POP3's logging (or th_main helper utilities) should be | ||
| // cleaned up to handle connection expectations in a way that lets | ||
| // us use the same expectations for IMAP as POP3. In this case, | ||
| // POP3 sets "USES_CONN = false", which renders the expect_runOp's | ||
| // "conn" helper useless. For IMAP, we already have a connection | ||
| // from the do_openFolderView, so we don't need conn: true here. | ||
| // But for POP3, the following expectations are needed to perform | ||
| // the same function as what "conn: true" woul dhave done in | ||
| // expect_runOp above, if POP3 supported that properly. | ||
| if (testAccount.type === 'pop3') { | ||
| RT.reportActiveActorThisStep(testAccount.eFolderAccount); | ||
| testAccount.eFolderAccount.ignore_createConnection(); | ||
| testAccount.eFolderAccount.ignore_saveAccountState(); | ||
| } | ||
|
|
||
| // there's only one message in the inbox | ||
| var header = testView.slice.items[0]; | ||
|
|
||
| // The first call should receive a modified onchange event. | ||
| eLazy.expect_value('modified'); | ||
| // Then we called getBody twice, so we should see two more | ||
| // "done" events _without_ seeing more change events. | ||
| eLazy.expect_value('done'); | ||
|
|
||
| // Fetch the body thrice; the first will generate onchange; | ||
| // the other two should just indicate that we've finished. | ||
| header.getBody({ downloadBodyReps: true }, function (body) { | ||
| // Attach the handler for this body here; it should only be | ||
| // called once even though we're calling getBody multiple | ||
| // times. | ||
| body.onchange = function() { | ||
| eLazy.value('modified'); | ||
| } | ||
| }); | ||
|
|
||
| header.getBody({ downloadBodyReps: true }, function(body) { | ||
| // Use { withBodyReps: true } so that the 'done' event | ||
| // happens after we see onchange. | ||
| header.getBody({ withBodyReps: true }, function() { | ||
| eLazy.value('done'); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| }); | ||
|
|
||
| }); // end define |