summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/imap/test/unit/test_imapStoreMsgOffline.js
blob: 4601d4b509e4d1f8e04eaef8f9e96d992f956c15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at http://mozilla.org/MPL/2.0/. */

/**
 * This test checks if the imap protocol code saves message to
 * offline stores correctly, when we fetch the message for display.
 * It checks:
 *   - Normal messages, no attachments.
 *   - Message with inline attachment (e.g., image)
 *   - Message with non-inline attachment (e.g., .doc file)
 *   - Message with mix of attachment types.
 */

var { MessageGenerator } = ChromeUtils.import(
  "resource://testing-common/mailnews/MessageGenerator.jsm"
);
var { PromiseTestUtils } = ChromeUtils.import(
  "resource://testing-common/mailnews/PromiseTestUtils.jsm"
);

var gMessageGenerator = new MessageGenerator();

var gMsgFile1 = do_get_file("../../../data/bugmail10");
var gMsgId1 = "200806061706.m56H6RWT004933@mrapp54.mozilla.org";
var gMsgFile2 = do_get_file("../../../data/image-attach-test");
var gMsgId2 = "4A947F73.5030709@example.com";
var gMsgFile3 = do_get_file("../../../data/external-attach-test");
var gMsgId3 = "876TY.5030709@example.com";

var gFirstNewMsg;
var gFirstMsgSize;
var gImapInboxOfflineStoreSize;

// Adds some messages directly to a mailbox (e.g. new mail).
function addMessagesToServer(messages, mailbox) {
  // For every message we have, we need to convert it to a file:/// URI.
  messages.forEach(function (message) {
    let URI = Services.io
      .newFileURI(message.file)
      .QueryInterface(Ci.nsIFileURL);
    // Create the ImapMessage and store it on the mailbox.
    mailbox.addMessage(new ImapMessage(URI.spec, mailbox.uidnext++, []));
  });
}

add_setup(async function () {
  // We aren't interested in downloading messages automatically.
  Services.prefs.setBoolPref(
    "mail.server.server1.autosync_offline_stores",
    false
  );
  Services.prefs.setBoolPref("mail.server.server1.offline_download", true);

  setupIMAPPump();

  // These hacks are required because we've created the inbox before
  //  running initial folder discovery, and adding the folder bails
  //  out before we set it as verified online, so we bail out, and
  //  then remove the INBOX folder since it's not verified.
  IMAPPump.inbox.hierarchyDelimiter = "/";
  IMAPPump.inbox.verifiedAsOnlineFolder = true;

  addMessagesToServer(
    [
      { file: gMsgFile1, messageId: gMsgId1 },
      { file: gMsgFile2, messageId: gMsgId2 },
      { file: gMsgFile3, messageId: gMsgId3 },
    ],
    IMAPPump.daemon.getMailbox("INBOX")
  );

  let listener = new PromiseTestUtils.PromiseUrlListener();
  IMAPPump.inbox.updateFolderWithListener(null, listener);
  await listener.promise;
});

var gIMAPService;

add_task(async function selectFirstMsg() {
  // We postpone creating the imap service until after we've set the prefs
  //  that it reads on its startup.
  gIMAPService = Cc[
    "@mozilla.org/messenger/messageservice;1?type=imap"
  ].getService(Ci.nsIMsgMessageService);

  let db = IMAPPump.inbox.msgDatabase;
  let msg1 = db.getMsgHdrForMessageID(gMsgId1);
  let listener = new PromiseTestUtils.PromiseUrlListener({
    OnStopRunningUrl: (aUrl, aExitCode) => {
      Assert.equal(aExitCode, 0);
    },
  });
  // We use the streamListener as a display consumer.
  let streamListener = new PromiseTestUtils.PromiseStreamListener();
  gIMAPService.loadMessage(
    IMAPPump.inbox.getUriForMsg(msg1),
    streamListener,
    null,
    listener,
    false
  );
  await listener.promise;
});

add_task(async function select2ndMsg() {
  let msg1 = IMAPPump.inbox.msgDatabase.getMsgHdrForMessageID(gMsgId1);
  Assert.notEqual(msg1.flags & Ci.nsMsgMessageFlags.Offline, 0);
  let db = IMAPPump.inbox.msgDatabase;
  let msg2 = db.getMsgHdrForMessageID(gMsgId2);
  let listener = new PromiseTestUtils.PromiseUrlListener({
    OnStopRunningUrl: (aUrl, aExitCode) => {
      Assert.equal(aExitCode, 0);
    },
  });
  // We use the streamListener as a display consumer.
  let streamListener = new PromiseTestUtils.PromiseStreamListener();
  gIMAPService.loadMessage(
    IMAPPump.inbox.getUriForMsg(msg2),
    streamListener,
    null,
    listener,
    false
  );
  await listener.promise;
});

add_task(async function select3rdMsg() {
  let msg2 = IMAPPump.inbox.msgDatabase.getMsgHdrForMessageID(gMsgId2);
  Assert.notEqual(msg2.flags & Ci.nsMsgMessageFlags.Offline, 0);
  let db = IMAPPump.inbox.msgDatabase;
  let msg3 = db.getMsgHdrForMessageID(gMsgId3);
  let listener = new PromiseTestUtils.PromiseUrlListener();
  // We use the streamListener as a display consumer.
  let streamListener = new PromiseTestUtils.PromiseStreamListener();
  gIMAPService.loadMessage(
    IMAPPump.inbox.getUriForMsg(msg3),
    streamListener,
    null,
    listener,
    false
  );
  await listener.promise;
});

add_task(
  {
    // Can't turn this on because our fake server doesn't support body structure.
    skip_if: () => true,
  },
  function verify3rdMsg() {
    let db = IMAPPump.inbox.msgDatabase;
    let msg3 = db.getMsgHdrForMessageID(gMsgId3);
    Assert.equal(msg3.flags & Ci.nsMsgMessageFlags.Offline, 0);
  }
);

add_task(async function addNewMsgs() {
  let mbox = IMAPPump.daemon.getMailbox("INBOX");
  // Make a couple of messages.
  let messages = [];
  let bodyString = "";
  for (let i = 0; i < 100; i++) {
    bodyString +=
      "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890\r\n";
  }

  gMessageGenerator = new MessageGenerator();
  messages = messages.concat(
    gMessageGenerator.makeMessage({
      body: { body: bodyString, contentType: "text/plain" },
    })
  );

  gFirstNewMsg = mbox.uidnext;
  // Need to account for x-mozilla-status, status2, and envelope.
  gFirstMsgSize = messages[0].toMessageString().length + 102;

  messages.forEach(function (message) {
    let dataUri = Services.io.newURI(
      "data:text/plain;base64," + btoa(message.toMessageString())
    );
    mbox.addMessage(new ImapMessage(dataUri.spec, mbox.uidnext++, []));
  });

  let listener = new PromiseTestUtils.PromiseUrlListener();
  IMAPPump.inbox.updateFolderWithListener(null, listener);
  await listener.promise;
});
add_task(async function test_queuedOfflineDownload() {
  // Make sure that streaming the same message and then trying to download
  //  it for offline use doesn't end up in it getting added to the offline
  //  store twice.
  gImapInboxOfflineStoreSize = IMAPPump.inbox.filePath.fileSize + gFirstMsgSize;
  let newMsgHdr = IMAPPump.inbox.GetMessageHeader(gFirstNewMsg);
  let msgURI = newMsgHdr.folder.getUriForMsg(newMsgHdr);
  let msgServ = MailServices.messageServiceFromURI(msgURI);
  let listener = new PromiseTestUtils.PromiseStreamListener();
  msgServ.streamMessage(msgURI, listener, null, null, false, "", false);
  await listener.promise;
});
add_task(async function firstStreamFinished() {
  // nsIMsgFolder.downloadMessagesForOffline does not take a listener, so
  //  we invoke nsIImapService.downloadMessagesForOffline directly
  //  with a listener.
  let listener = new PromiseTestUtils.PromiseUrlListener();
  MailServices.imap.downloadMessagesForOffline(
    gFirstNewMsg,
    IMAPPump.inbox,
    listener,
    null
  );
  await listener.promise;
});
add_task(function checkOfflineStoreSize() {
  Assert.ok(IMAPPump.inbox.filePath.fileSize <= gImapInboxOfflineStoreSize);
});

add_task(function endTest() {
  teardownIMAPPump();
});