fix(imap-search): ZMSA-77: revert ZMSA-67, add UID SEARCH protocol tests (#977)

* ZMSA-77: in case of UID SEARCH 1:N where N is the amount of messages in mailbox, treat the search as sequence search instead of UID search

* ZMSA-77: revert ZMSA-67 changes, add more UID SEARCH protocol tests

* remove unneded variable

* rename some search protocol tests

* add more search protocol tests

Author: NickOvt

imap-core/lib/commands/search.js

@@ -33,7 +33,7 @@ module.exports = {
         let parsed;
 
         try {
-            parsed = parseQueryTerms(terms, this.selected.uidList, isUid);
+            parsed = parseQueryTerms(terms, this.selected.uidList);
         } catch (E) {
             return callback(E);
         }
@@ -151,9 +151,8 @@ function isFixedRange(value) {
     return value.indexOf(':') >= 0 && value.indexOf(',') < 0;
 }
 
-function parseQueryTerms(terms, uidList, isUidSearch) {
+function parseQueryTerms(terms, uidList) {
     terms = [].concat(terms || []);
-    isUidSearch = !!isUidSearch;
 
     let pos = 0;
     let term;
@@ -184,12 +183,8 @@ function parseQueryTerms(terms, uidList, isUidSearch) {
         if (!termType) {
             // try if it is a sequence set
             if (imapTools.validateSequence(term)) {
-                let messageRange = imapTools.getMessageRange(uidList, term, isUidSearch);
-                if (isUidSearch && isFixedRange(term)) {
-                    messageRange.isContiguous = true;
-                }
                 // resolve sequence list to an array of UID values
-                curTerm = ['uid', messageRange];
+                curTerm = ['uid', imapTools.getMessageRange(uidList, term, false)];
             } else {
                 // no idea what the term is for
                 throw new Error('Unknown search term ' + term.toUpperCase());

imap-core/test/protocol-test.js

@@ -1867,5 +1867,138 @@ describe('IMAP Protocol integration tests', function () {
                 }
             );
         });
+
+        it('should search with UID SEARCH 1:N correctly if N equals to EXISTS response', function (done) {
+            let cmds = ['T1 LOGIN testuser pass', 'T2 SELECT INBOX', 'T3 UID SEARCH 1:6 NOT DELETED', 'T4 LOGOUT'];
+
+            testClient(
+                {
+                    commands: cmds,
+                    secure: true,
+                    port
+                },
+                function (resp) {
+                    resp = resp.toString();
+                    expect(resp.match(/^\* SEARCH /gm).length).to.equal(1);
+                    expect(/^\* SEARCH 101 102 103 104 105 106$/m.test(resp)).to.be.true;
+                    expect(/^T3 OK/m.test(resp)).to.be.true;
+                    done();
+                }
+            );
+        });
+
+        it('should search with UID SEARCH 1:N correctly if N does not equal to EXISTS response', function (done) {
+            let cmds = ['T1 LOGIN testuser pass', 'T2 SELECT INBOX', 'T3 UID SEARCH 1:3', 'T4 LOGOUT'];
+
+            testClient(
+                {
+                    commands: cmds,
+                    secure: true,
+                    port
+                },
+                function (resp) {
+                    resp = resp.toString();
+                    expect(resp.match(/^\* SEARCH /gm).length).to.equal(1);
+                    expect(/^\* SEARCH 101 102 103$/m.test(resp)).to.be.true;
+                    expect(/^T3 OK/m.test(resp)).to.be.true;
+                    done();
+                }
+            );
+        });
+
+        it('should intersect sequence set with UID search key in UID SEARCH', function (done) {
+            let cmds = ['T1 LOGIN testuser pass', 'T2 SELECT INBOX', 'T3 UID SEARCH 2:5 UID 103:104', 'T4 LOGOUT'];
+
+            testClient(
+                {
+                    commands: cmds,
+                    secure: true,
+                    port
+                },
+                function (resp) {
+                    resp = resp.toString();
+                    expect(resp.match(/^\* SEARCH /gm).length).to.equal(1);
+                    expect(/^\* SEARCH 103 104$/m.test(resp)).to.be.true;
+                    expect(/^T3 OK/m.test(resp)).to.be.true;
+                    done();
+                }
+            );
+        });
+
+        it('should treat 1:10 as sequence and 20:30 as UID set (empty intersection)', function (done) {
+            let cmds = ['T1 LOGIN testuser pass', 'T2 SELECT INBOX', 'T3 UID SEARCH 1:10 UID 20:30', 'T4 LOGOUT'];
+
+            testClient(
+                {
+                    commands: cmds,
+                    secure: true,
+                    port
+                },
+                function (resp) {
+                    resp = resp.toString();
+                    expect(/^\* SEARCH$/m.test(resp)).to.be.true;
+                    expect(/^\* SEARCH \d/m.test(resp)).to.be.false;
+                    expect(/^T3 OK/m.test(resp)).to.be.true;
+                    done();
+                }
+            );
+        });
+
+        it('should treat UID 1:10 as UID set and 20:30 as sequence (empty intersection)', function (done) {
+            let cmds = ['T1 LOGIN testuser pass', 'T2 SELECT INBOX', 'T3 UID SEARCH UID 1:10 20:30', 'T4 LOGOUT'];
+
+            testClient(
+                {
+                    commands: cmds,
+                    secure: true,
+                    port
+                },
+                function (resp) {
+                    resp = resp.toString();
+                    expect(/^\* SEARCH$/m.test(resp)).to.be.true;
+                    expect(/^\* SEARCH \d/m.test(resp)).to.be.false;
+                    expect(/^T3 OK/m.test(resp)).to.be.true;
+                    done();
+                }
+            );
+        });
+
+        it('should intersect sequence set with UID set when both match', function (done) {
+            let cmds = ['T1 LOGIN testuser pass', 'T2 SELECT INBOX', 'T3 UID SEARCH 1:4 UID 102:104', 'T4 LOGOUT'];
+
+            testClient(
+                {
+                    commands: cmds,
+                    secure: true,
+                    port
+                },
+                function (resp) {
+                    resp = resp.toString();
+                    expect(resp.match(/^\* SEARCH /gm).length).to.equal(1);
+                    expect(/^\* SEARCH 102 103 104$/m.test(resp)).to.be.true;
+                    expect(/^T3 OK/m.test(resp)).to.be.true;
+                    done();
+                }
+            );
+        });
+
+        it('should intersect UID set first and sequence set second', function (done) {
+            let cmds = ['T1 LOGIN testuser pass', 'T2 SELECT INBOX', 'T3 UID SEARCH UID 101:104 2:3', 'T4 LOGOUT'];
+
+            testClient(
+                {
+                    commands: cmds,
+                    secure: true,
+                    port
+                },
+                function (resp) {
+                    resp = resp.toString();
+                    expect(resp.match(/^\* SEARCH /gm).length).to.equal(1);
+                    expect(/^\* SEARCH 102 103$/m.test(resp)).to.be.true;
+                    expect(/^T3 OK/m.test(resp)).to.be.true;
+                    done();
+                }
+            );
+        });
     });
 });

imap-core/test/search-test.js

@@ -547,6 +547,16 @@ describe('#parseQueryTerms', function () {
 
 describe('UID sequence edge cases', function () {
     this.timeout(1000);
+    it('should treat bare sequence set as sequence numbers in UID SEARCH', function () {
+        const testUidList = [39, 40, 44, 52, 53, 54, 59, 72];
+
+        const parsed = parseQueryTerms(['1:3'], testUidList, true);
+
+        expect(parsed.query).to.have.length(1);
+        expect(parsed.query[0].key).to.equal('uid');
+        expect(parsed.query[0].value).to.deep.equal([39, 40, 44]);
+    });
+
     it('should handle overlaps, duplicates, reversed ranges, and *', function () {
         const testUidList = [2, 4, 6, 8, 10, 12];
         const seq = buildWeirdSequenceSet();