emailengine-app 2.68.1 → 2.70.0

package/lib/account.js

@@ -945,7 +945,7 @@ class Account {
             throw error;
         }
 
-        let state = false;
+        let state;
         if (result[0][1] && result[0][1].account) {
             // existing user
             state = 'existing';
@@ -1084,22 +1084,45 @@ class Account {
         };
     }
 
+    // Creates the consumer side of a cross-thread download stream, with a guard listener:
+    // the producer can post {error} before Hapi attaches its own 'error' listeners (or
+    // while the setup call is still pending). Without a listener that emission is an
+    // uncaught exception that kills the API worker.
+    createDownloadStream(failureLogMessage) {
+        const { port1, port2 } = new MessageChannel();
+        const stream = new MessagePortReadable(port1);
+
+        stream.on('error', err => {
+            this.logger.error({ msg: failureLogMessage, account: this.account, err });
+        });
+
+        return { stream, port2 };
+    }
+
     async getRawMessage(message) {
         await this.loadAccountData(this.account, true);
 
-        const { port1, port2 } = new MessageChannel();
-        const stream = new MessagePortReadable(port1);
+        const { stream, port2 } = this.createDownloadStream('Message source stream failed');
 
-        let streamCreated = await this.call(
-            {
-                cmd: 'getRawMessage',
-                account: this.account,
-                message,
-                timeout: this.timeout,
-                port: port2
-            },
-            [port2]
-        );
+        let streamCreated;
+        try {
+            streamCreated = await this.call(
+                {
+                    cmd: 'getRawMessage',
+                    account: this.account,
+                    message,
+                    timeout: this.timeout,
+                    port: port2
+                },
+                [port2]
+            );
+        } catch (err) {
+            // The setup call failed (timeout, worker gone, 404). Destroy the reader so
+            // its MessagePort + listener are released instead of leaking, and so any
+            // late producer data is not buffered forever.
+            stream.destroy();
+            throw err;
+        }
 
         if (streamCreated && streamCreated.headers) {
             stream.headers = streamCreated.headers;
@@ -1111,19 +1134,27 @@ class Account {
     async getAttachment(attachment) {
         await this.loadAccountData(this.account, true);
 
-        const { port1, port2 } = new MessageChannel();
-        const stream = new MessagePortReadable(port1);
+        const { stream, port2 } = this.createDownloadStream('Attachment stream failed');
 
-        let streamCreated = await this.call(
-            {
-                cmd: 'getAttachment',
-                account: this.account,
-                attachment,
-                timeout: this.timeout,
-                port: port2
-            },
-            [port2]
-        );
+        let streamCreated;
+        try {
+            streamCreated = await this.call(
+                {
+                    cmd: 'getAttachment',
+                    account: this.account,
+                    attachment,
+                    timeout: this.timeout,
+                    port: port2
+                },
+                [port2]
+            );
+        } catch (err) {
+            // The setup call failed (timeout, worker gone, 404). Destroy the reader so
+            // its MessagePort + listener are released instead of leaking, and so any
+            // late producer data is not buffered forever.
+            stream.destroy();
+            throw err;
+        }
 
         if (streamCreated && streamCreated.headers) {
             stream.headers = streamCreated.headers;
@@ -1236,16 +1267,7 @@ class Account {
             } catch (err) {
                 // should not happen
                 if (logger.notifyError) {
-                    logger.notifyError(err, event => {
-                        if (this.account) {
-                            event.setUser(this.account);
-                        }
-
-                        event.addMetadata('ee', {
-                            path,
-                            mailboxListing: typeof mailboxListing
-                        });
-                    });
+                    logger.notifyError(err, { user: this.account, meta: { path, mailboxListing: typeof mailboxListing } });
                 }
 
                 let message = 'Failed to process stored mailbox listing';
@@ -1259,22 +1281,44 @@ class Account {
         return mailboxes;
     }
 
+    // Worker backends return false for entities they can not find (e.g. an unknown mailbox path
+    // or message ID on IMAP). Convert such results into a 404 error for the API.
+    assertFound(result, message, code) {
+        if (!result) {
+            let error = Boom.boomify(new Error(message), { statusCode: 404 });
+            error.output.payload.code = code;
+            throw error;
+        }
+        return result;
+    }
+
+    assertMessageFound(result) {
+        return this.assertFound(result, 'Requested message was not found', 'MessageNotFound');
+    }
+
+    assertFolderFound(result) {
+        return this.assertFound(result, 'Requested mailbox folder was not found', 'FolderNotFound');
+    }
+
     async updateMessage(message, updates) {
         await this.loadAccountData(this.account, true);
 
-        return await this.call({
+        let result = await this.call({
             cmd: 'updateMessage',
             account: this.account,
             message,
             updates,
             timeout: this.timeout
         });
+
+        // IMAP backend returns false for unknown messages and folders
+        return this.assertMessageFound(result);
     }
 
     async updateMessages(path, search, updates) {
         await this.loadAccountData(this.account, true);
 
-        return await this.call({
+        let result = await this.call({
             cmd: 'updateMessages',
             account: this.account,
             path,
@@ -1282,6 +1326,9 @@ class Account {
             updates,
             timeout: this.timeout
         });
+
+        // IMAP backend returns false for unknown folders
+        return this.assertFolderFound(result);
     }
 
     async listMailboxes(query) {
@@ -1304,7 +1351,8 @@ class Account {
 
     async moveMessage(message, target, options) {
         await this.loadAccountData(this.account, true);
-        return await this.call({
+
+        let result = await this.call({
             cmd: 'moveMessage',
             account: this.account,
             message,
@@ -1312,11 +1360,15 @@ class Account {
             options,
             timeout: this.timeout
         });
+
+        // IMAP backend returns false for unknown messages and folders
+        return this.assertMessageFound(result);
     }
 
     async moveMessages(source, search, target) {
         await this.loadAccountData(this.account, true);
-        return await this.call({
+
+        let result = await this.call({
             cmd: 'moveMessages',
             account: this.account,
             source,
@@ -1324,24 +1376,30 @@ class Account {
             target,
             timeout: this.timeout
         });
+
+        // IMAP backend returns false for unknown folders
+        return this.assertFolderFound(result);
     }
 
     async deleteMessage(message, force) {
         await this.loadAccountData(this.account, true);
 
-        return await this.call({
+        let result = await this.call({
             cmd: 'deleteMessage',
             account: this.account,
             message,
             force,
             timeout: this.timeout
         });
+
+        // IMAP backend returns false for unknown messages and folders
+        return this.assertMessageFound(result);
     }
 
     async deleteMessages(path, search, force) {
         await this.loadAccountData(this.account, true);
 
-        return await this.call({
+        let result = await this.call({
             cmd: 'deleteMessages',
             account: this.account,
             path,
@@ -1349,6 +1407,9 @@ class Account {
             force,
             timeout: this.timeout
         });
+
+        // IMAP backend returns false for unknown folders
+        return this.assertFolderFound(result);
     }
 
     async getQuota() {
@@ -1416,13 +1477,7 @@ class Account {
                 results: getResult && getResult._source ? 1 : 0
             });
 
-            if (!getResult || !getResult._source) {
-                let message = 'Requested message was not found';
-                let error = Boom.boomify(new Error(message), { statusCode: 404 });
-                throw error;
-            }
-
-            let messageData = getResult._source;
+            let messageData = this.assertMessageFound(getResult && getResult._source);
             let response = {};
 
             response.hasMore = false;
@@ -1442,13 +1497,16 @@ class Account {
 
         await this.loadAccountData(this.account, true);
 
-        return await this.call({
+        let textData = await this.call({
             cmd: 'getText',
             account: this.account,
             text,
             options,
             timeout: this.timeout
         });
+
+        // IMAP backend returns false for unknown messages and folders
+        return this.assertMessageFound(textData);
     }
 
     async getMessage(message, options) {
@@ -1490,13 +1548,7 @@ class Account {
                 results: getResult && getResult._source ? 1 : 0
             });
 
-            if (!getResult || !getResult._source) {
-                let message = 'Requested message was not found';
-                let error = Boom.boomify(new Error(message), { statusCode: 404 });
-                throw error;
-            }
-
-            let messageData = getResult._source;
+            let messageData = this.assertMessageFound(getResult && getResult._source);
 
             // restore headers and text object as per the API response
             let headersObj = {};
@@ -1547,14 +1599,20 @@ class Account {
 
                 // download large inline attachments not stored in ES
                 for (let attachment of attachmentsToDownload) {
+                    let downloadStream;
                     try {
-                        let downloadStream = await this.getAttachment(attachment.id);
+                        downloadStream = await this.getAttachment(attachment.id);
                         if (downloadStream) {
                             let content = await download(downloadStream);
                             this.logger.trace({ msg: 'Fetched attachment content', account: this.account, attachment, size: content.length });
                             attachment.content = content.toString('base64');
                         }
                     } catch (err) {
+                        // Release the reader if download() failed mid-stream so its
+                        // MessagePort is not left open (destroy() is idempotent).
+                        if (downloadStream) {
+                            downloadStream.destroy();
+                        }
                         this.logger.error({ msg: 'Failed to fetch attachment content', account: this.account, attachment, err });
                     }
                 }
@@ -1595,6 +1653,9 @@ class Account {
 
             if (options.markAsSeen && (!messageData.flags || !messageData.flags.includes('\\Seen'))) {
                 // mark message as seen
+                if (!messageData.flags) {
+                    messageData.flags = [];
+                }
                 messageData.flags.push('\\Seen');
                 // do not wait until the update is completed, return immediately
                 this.updateMessage(message, { flags: { add: ['\\Seen'] } }).catch(err => {
@@ -1624,13 +1685,7 @@ class Account {
             timeout: this.timeout
         });
 
-        if (!messageData) {
-            let message = 'Requested message was not found';
-            let error = Boom.boomify(new Error(message), { statusCode: 404 });
-            throw error;
-        }
-
-        return messageData;
+        return this.assertMessageFound(messageData);
     }
 
     async getMessages(messageIds, options) {
@@ -1764,7 +1819,7 @@ class Account {
 
         await this.loadAccountData(this.account, true);
 
-        return await this.call(
+        let listing = await this.call(
             Object.assign(
                 {
                     cmd: 'listMessages',
@@ -1774,6 +1829,9 @@ class Account {
                 { timeout: this.timeout }
             )
         );
+
+        // IMAP and Gmail backends return false for unknown folders
+        return this.assertFolderFound(listing);
     }
 
     async searchMessages(query, searchOpts) {
@@ -2049,11 +2107,11 @@ class Account {
             let sizeMatch = {};
 
             if (query.search.larger) {
-                dateMatch.gte = query.search.larger;
+                sizeMatch.gte = query.search.larger;
             }
 
             if (query.search.smaller) {
-                dateMatch.lte = query.search.smaller;
+                sizeMatch.lte = query.search.smaller;
             }
 
             if (Object.keys(sizeMatch).length) {
@@ -2161,7 +2219,7 @@ class Account {
 
         await this.loadAccountData(this.account, true);
 
-        return await this.call(
+        let listing = await this.call(
             Object.assign(
                 {
                     cmd: 'listMessages',
@@ -2171,6 +2229,9 @@ class Account {
                 { timeout: this.timeout }
             )
         );
+
+        // IMAP and Gmail backends return false for unknown folders
+        return this.assertFolderFound(listing);
     }
 
     async uploadMessage(data) {
@@ -2285,7 +2346,7 @@ class Account {
             }
         } catch (err) {
             this.logger.error({ msg: 'Failed to get lock', lockKey, err });
-            if (Boom.isBoom) {
+            if (Boom.isBoom(err)) {
                 throw err;
             }
             let error = Boom.boomify(new Error('Failed to get flush lock, try again later'), { statusCode: 500 });
@@ -2344,7 +2405,9 @@ class Account {
                     // Flush ElasticSearch index for this account
                     const { index, client } = this.esClient;
                     if (!client) {
-                        return;
+                        // Account data in Redis was already flushed, only the index cleanup was skipped
+                        this.logger.error({ msg: 'Document store is enabled but the ElasticSearch client is not available', action: 'flush' });
+                        return true;
                     }
 
                     let deleteResult = {};
@@ -2555,7 +2618,7 @@ class Account {
                 account: accountData.account,
                 user: authData.user,
                 accessToken: authData.accessToken,
-                provider: accountData.oauth2.auth.provider,
+                provider: accountData.oauth2.provider,
                 registeredScopes: accountData.oauth2.scope,
                 cached: false
             };
@@ -2589,7 +2652,7 @@ class Account {
             account: accountData.account,
             user: accountData.oauth2.auth.user,
             accessToken,
-            provider: accountData.oauth2.auth.provider,
+            provider: accountData.oauth2.provider,
             registeredScopes: accountData.oauth2.scope,
             expires:
                 accountData.oauth2.expires && typeof accountData.oauth2.expires.toISOString === 'function'