fix logic for imap appended drafts too

Author: NickOvt

lib/api/messages.js

@@ -134,10 +134,10 @@ module.exports = (db, server, messageHandler, userHandler, storageHandler, setti
         }
 
         if (includeHasDrafts && matchDraftReferences) {
-            // MIME References contains the entire thread ancestry. meta.reference is the exact mailbox/UID pair the draft was created for.
+            // References contains the entire thread ancestry. In-Reply-To identifies the direct parent for both API and IMAP drafts.
             group.draftReferences = {
                 $addToSet: {
-                    $cond: ['$draft', '$meta.reference', false]
+                    $cond: ['$draft', '$mimeTree.parsedHeader.in-reply-to', false]
                 }
             };
         }
@@ -171,13 +171,14 @@ module.exports = (db, server, messageHandler, userHandler, storageHandler, setti
             }
 
             if (matchDraftReferences) {
-                message.hasDrafts = ((matchingThreadCount && matchingThreadCount.draftReferences) || []).some(
-                    reference =>
-                        reference &&
-                        reference.mailbox &&
-                        reference.mailbox.toString() === message.mailbox.toString() &&
-                        reference.id === message.uid
+                const draftReferences = new Set(
+                    ((matchingThreadCount && matchingThreadCount.draftReferences) || [])
+                        .flatMap(reference => [].concat(reference || []))
+                        .flatMap(reference => reference.toString().split(/\s+/))
+                        .filter(reference => reference)
                 );
+
+                message.hasDrafts = draftReferences.has(message.msgid);
             } else {
                 message.hasDrafts = !!(matchingThreadCount && matchingThreadCount.hasDrafts);
             }

test/api/messages-test.js

@@ -10,6 +10,7 @@ const expect = chai.expect;
 chai.config.includeStack = true;
 const config = require('@zone-eu/wild-config');
 const { ObjectId } = require('mongodb');
+const { ImapFlow } = require('imapflow');
 const { parseSearchQuery, getMongoDBQuery } = require('../../lib/search-query');
 
 const server = supertest.agent(`http://127.0.0.1:${config.api.port}`);
@@ -259,6 +260,7 @@ describe('Messages tests', function () {
     let queryAttachmentMessageId;
     let queryFlaggedSeenAttachmentMessageId;
     let queryAltMailboxMessageId;
+    let testUsername;
     let testAddress;
 
     const queryFixture = {
@@ -335,7 +337,7 @@ describe('Messages tests', function () {
 
     before(async () => {
         const testUserTag = Date.now().toString(36);
-        const testUsername = `messagestestsuser-${testUserTag}`;
+        testUsername = `messagestestsuser-${testUserTag}`;
         testAddress = `${testUsername}@web.zone.test`;
         queryFixture.fromAddress = testAddress;
 
@@ -1065,6 +1067,97 @@ describe('Messages tests', function () {
         expect(archivedRoot).to.not.have.property('hasDrafts');
     });
 
+    it('should GET /users/:user/search expect success / IMAP APPEND draft hasDrafts matches only the direct parent', async () => {
+        const mailboxPath = `imap-draft-reference-${Date.now().toString(36)}`;
+        const mailboxResponse = await server
+            .post(`/users/${user}/mailboxes`)
+            .send({ path: `/${mailboxPath}`, hidden: false, retention: 10000 })
+            .expect(200);
+        const mailbox = mailboxResponse.body.id;
+
+        const root = await server
+            .post(`/users/${user}/mailboxes/${mailbox}/messages`)
+            .send({
+                to: [{ address: 'imap-draft@example.com' }],
+                subject: 'IMAP Draft Thread',
+                text: 'Root message'
+            })
+            .expect(200);
+
+        const reply = await server
+            .post(`/users/${user}/mailboxes/${mailbox}/messages`)
+            .send({
+                to: [{ address: 'imap-draft@example.com' }],
+                text: 'Intermediate reply',
+                reference: {
+                    mailbox,
+                    id: root.body.message.id,
+                    action: 'reply'
+                }
+            })
+            .expect(200);
+
+        await server.put(`/users/${user}/mailboxes/${mailbox}/messages/${reply.body.message.id}`).send({ draft: false }).expect(200);
+
+        const rootData = await server.get(`/users/${user}/mailboxes/${mailbox}/messages/${root.body.message.id}`).send({}).expect(200);
+        const replyData = await server.get(`/users/${user}/mailboxes/${mailbox}/messages/${reply.body.message.id}`).send({}).expect(200);
+        const rawDraft = [
+            `From: ${testAddress}`,
+            'To: imap-draft@example.com',
+            'Subject: Re: IMAP Draft Thread',
+            `Message-ID: <imap-draft-${Date.now().toString(36)}@web.zone.test>`,
+            `In-Reply-To: ${replyData.body.messageId}`,
+            `References: ${rootData.body.messageId} ${replyData.body.messageId}`,
+            'MIME-Version: 1.0',
+            'Content-Type: text/plain; charset=utf-8',
+            '',
+            'Draft uploaded with IMAP APPEND'
+        ].join('\r\n');
+
+        const client = new ImapFlow({
+            host: '127.0.0.1',
+            port: config.imap.port,
+            secure: true,
+            auth: {
+                user: testUsername,
+                pass: 'secretpassword'
+            },
+            tls: {
+                rejectUnauthorized: false
+            },
+            logger: false
+        });
+
+        let appendResult;
+        try {
+            await client.connect();
+            appendResult = await client.append(mailboxPath, rawDraft, ['\\Draft']);
+        } finally {
+            if (client.usable) {
+                await client.logout();
+            } else {
+                client.close();
+            }
+        }
+
+        expect(appendResult.uid).to.be.a('number');
+
+        const appendedDraft = await server.get(`/users/${user}/mailboxes/${mailbox}/messages/${appendResult.uid}`).send({}).expect(200);
+        expect(appendedDraft.body).to.not.have.property('reference');
+
+        const expandedThread = await server
+            .get(`/users/${user}/search?thread=${rootData.body.thread}&includeHasDrafts=true&limit=3`)
+            .send({})
+            .expect(200);
+
+        expect(expandedThread.body.results.map(entry => entry.id)).to.deep.equal([
+            appendResult.uid,
+            reply.body.message.id,
+            root.body.message.id
+        ]);
+        expect(expandedThread.body.results.map(entry => entry.hasDrafts)).to.deep.equal([false, true, false]);
+    });
+
     it('should GET /users/:user/search expect success / q supports subject and in keywords', async () => {
         const q = `subject:"${queryFixture.subjectKeyword}" in:${queryMailbox}`;
         const search = await searchQ(q);