imapflow 1.6.4 → 1.6.6

package/test/copyuid-parser-test.js

@@ -151,3 +151,23 @@ module.exports['CopyUID Parser: uidValidity zero is stored as BigInt(0)'] = test
     test.equal(map.uidMap.get(1), 100);
     test.done();
 };
+
+// ============================================
+// Hostile server input
+// ============================================
+
+module.exports['CopyUID Parser: non-decimal uidValidity is ignored, uidMap still parsed'] = test => {
+    // isNaN() passed values like "1e5" and "Infinity" through, and BigInt() then threw,
+    // losing the whole COPYUID result
+    let map = {};
+    parseCopyUid(makeResponse([{ value: 'COPYUID' }, { value: '1e5' }, { value: '1' }, { value: '100' }]), map);
+    test.equal(map.uidValidity, undefined);
+    test.ok(map.uidMap instanceof Map);
+    test.equal(map.uidMap.get(1), 100);
+
+    let map2 = {};
+    parseCopyUid(makeResponse([{ value: 'COPYUID' }, { value: 'Infinity' }, { value: '1' }, { value: '100' }]), map2);
+    test.equal(map2.uidValidity, undefined);
+    test.equal(map2.uidMap.get(1), 100);
+    test.done();
+};

package/test/idle-polling-test.js

@@ -347,3 +347,84 @@ module.exports['Polling: no polling session without a saved select command'] = a
     test.equal(connection.idling, false, 'idling untouched');
     test.done();
 };
+
+module.exports['Polling: a falsy STATUS result stops the loop as PollFailed'] = async test => {
+    await withFakeTimers(async timers => {
+        let warnings = [];
+        let connection = createConnection({
+            missingIdleCommand: 'STATUS',
+            // Only STATUS is ever polled; a failure without a NO status makes the
+            // real STATUS implementation swallow the error and return false
+            respond: async () => {
+                throw new Error('Command failed');
+            }
+        });
+        connection.log.warn = entry => warnings.push(entry);
+
+        let idlePromise = idleCommand(connection, 60000);
+        await timers.drain();
+        await idlePromise;
+
+        test.ok(
+            warnings.some(entry => entry && entry.err && entry.err.code === 'PollFailed'),
+            'the falsy STATUS result surfaced as a PollFailed error'
+        );
+        test.equal(connection.idling, false, 'idling reset after the failed poll');
+        test.equal(connection.preCheck, false, 'preCheck released');
+        test.equal(timers.count(), 0, 'polling stopped');
+        test.done();
+    });
+};
+
+module.exports['Polling: a repeated break call is a no-op'] = async test => {
+    await withFakeTimers(async timers => {
+        let connection = createConnection();
+
+        let idlePromise = idleCommand(connection, 60000);
+        await timers.drain();
+        test.deepEqual(connection.commands, ['NOOP'], 'the immediate first poll ran');
+
+        // A caller may hold on to the break function and invoke it more than once
+        let preCheck = connection.preCheck;
+        await preCheck();
+        await preCheck();
+        await idlePromise;
+
+        test.equal(connection.idling, false, 'idling reset');
+        test.equal(connection.preCheck, false, 'preCheck released');
+        test.equal(timers.count(), 0, 'no timer left armed');
+
+        await timers.fire();
+        test.deepEqual(connection.commands, ['NOOP'], 'no further poll after the duplicate break');
+        test.done();
+    });
+};
+
+module.exports['Polling: a break in the initiation tick prevents the first poll'] = async test => {
+    await withFakeTimers(async timers => {
+        let connection = createConnection();
+        // Simulate a break request (e.g. a command being queued) landing in the same
+        // tick the loop is initiated: trap the loop installing its own preCheck and
+        // break through it immediately, before the first poll has started
+        let installedPreCheck = connection.preCheck;
+        Object.defineProperty(connection, 'preCheck', {
+            get: () => installedPreCheck,
+            set: value => {
+                installedPreCheck = value;
+                if (typeof value === 'function') {
+                    value();
+                }
+            }
+        });
+
+        let idlePromise = idleCommand(connection, 60000);
+        await timers.drain();
+        await idlePromise;
+
+        test.deepEqual(connection.commands, [], 'the already-cancelled session never polled');
+        test.equal(connection.idling, false, 'idling reset');
+        test.equal(connection.preCheck, false, 'preCheck released');
+        test.equal(timers.count(), 0, 'no timer left armed');
+        test.done();
+    });
+};

package/test/imap-compiler-test.js

@@ -642,10 +642,11 @@ module.exports['IMAP Compiler: partial range in SECTION'] = test =>
 
 // Returns the error a compile attempt raised, or undefined when it succeeded.
 // Several cases below assert that a token can never reach the wire, and the
-// try/catch is the only interesting part of each.
-const compileError = async attributes => {
+// try/catch is the only interesting part of each. Takes either an attributes
+// array (compiled under a default tag/command) or a full response object.
+const compileError = async input => {
     try {
-        await compiler({ tag: 'A', command: 'CMD', attributes });
+        await compiler(Array.isArray(input) ? { tag: 'A', command: 'CMD', attributes: input } : input);
     } catch (err) {
         return err;
     }
@@ -663,10 +664,50 @@ module.exports['IMAP Compiler: SEQUENCE rejects values that are not sequence set
 
 module.exports['IMAP Compiler: SEQUENCE accepts every valid sequence-set form'] = test =>
     asyncWrapper(test, async test => {
-        for (let value of ['1', '*', '1:*', '*:1', '1,3,5', '1:3,7,9:*', '4294967295']) {
+        // '$' is the RFC 5182 SEARCHRES saved-result marker, valid as the entire set
+        for (let value of ['1', '*', '1:*', '*:1', '1,3,5', '1:3,7,9:*', '4294967295', '$']) {
             const compiled = (await compiler({ tag: 'A', command: 'FETCH', attributes: [{ type: 'SEQUENCE', value }] })).toString();
             test.equal(compiled, `A FETCH ${value}`);
         }
+
+        // '$' only stands for the whole set, never an element of one
+        for (let value of ['$,1', '1,$', '$:2']) {
+            let err = await compileError([{ type: 'SEQUENCE', value }]);
+            test.equal(err && err.code, 'InvalidSequenceSet', `${JSON.stringify(value)} must be rejected`);
+        }
+    });
+
+module.exports['IMAP Compiler: SEQUENCE validation stays linear on huge valid sets'] = test =>
+    asyncWrapper(test, async test => {
+        // The regex this replaced overflowed the engine's backtrack stack with an
+        // uncoded RangeError at roughly a million comma-separated elements - a set
+        // a fetch over a large mailbox can legitimately produce
+        const huge = Array.from({ length: 1500000 }, (_, i) => i + 1).join(',');
+        const compiled = await compiler({ tag: 'A', command: 'FETCH', attributes: [{ type: 'SEQUENCE', value: huge }] });
+        test.ok(compiled.toString().endsWith(huge), 'the huge but valid set must compile');
+    });
+
+module.exports['IMAP Compiler: SEQUENCE validation is skipped when logging'] = test =>
+    asyncWrapper(test, async test => {
+        // The incoming token parser accepts sequence-shaped tokens the strict grammar
+        // rejects (an ESEARCH set like "1:2:3", a folder name like "12:30:00"). Every
+        // parsed server response is re-compiled for the log, so a throw here would let
+        // one quirky server line kill the whole connection.
+        for (let value of ['1:2:3', '12:30:00', '1,2:3:4']) {
+            const compiled = (await compiler({ tag: '*', command: 'OK', attributes: [{ type: 'SEQUENCE', value }] }, { isLogging: true })).toString();
+            test.equal(compiled, `* OK ${value}`, 'logging re-compile must pass the token through');
+        }
+    });
+
+module.exports['IMAP Compiler: tag and command cannot carry a line terminator'] = test =>
+    asyncWrapper(test, async test => {
+        // The tag/command preamble is written verbatim ahead of any token, so it goes
+        // through the same choke point as everything else
+        let err = await compileError({ tag: 'A\r\nZZ LOGOUT', command: 'NOOP' });
+        test.equal(err && err.code, 'InvalidTokenValue', 'CRLF in the tag must be rejected');
+
+        err = await compileError({ tag: 'A', command: 'NOOP\r\nZZ LOGOUT' });
+        test.equal(err && err.code, 'InvalidTokenValue', 'CRLF in the command must be rejected');
     });
 
 module.exports['IMAP Compiler: quoted strings use IMAP escaping, not JSON escaping'] = test =>
@@ -707,6 +748,23 @@ module.exports['IMAP Compiler: NUMBER coerces its value instead of writing it th
         test.equal((await compiler({ tag: 'A', command: 'CMD', attributes: [{ type: 'NUMBER', value: '42' }] })).toString(), 'A CMD 42');
     });
 
+module.exports['IMAP Compiler: numeric tokens clamp to bounded non-negative integers'] = test =>
+    asyncWrapper(test, async test => {
+        // Infinity, negatives and unsafe magnitudes would otherwise emit bytes outside
+        // the number alphabet ("Infinity", "-5", "1e+300") and get a server BAD blamed
+        // on the server instead of the caller
+        for (let [value, expected] of [
+            [Infinity, '0'],
+            ['Infinity', '0'],
+            [-5, '0'],
+            ['2e21', '0'],
+            [4.6, '5']
+        ]) {
+            const compiled = (await compiler({ tag: 'A', command: 'CMD', attributes: [{ type: 'NUMBER', value }] })).toString();
+            test.equal(compiled, `A CMD ${expected}`, `${JSON.stringify(value)} must clamp to ${expected}`);
+        }
+    });
+
 module.exports['IMAP Compiler: partial range coerces its elements'] = test =>
     asyncWrapper(test, async test => {
         // The partial range is the last token component written verbatim, so it is
@@ -719,6 +777,18 @@ module.exports['IMAP Compiler: partial range coerces its elements'] = test =>
             await compiler({ tag: 'A', command: 'FETCH', attributes: [{ type: 'ATOM', value: 'BODY.PEEK', section: [], partial: [0, 1024] }] })
         ).toString();
         test.equal(normal, 'A FETCH BODY.PEEK[]<0.1024>');
+
+        // Floats and unbounded numerics clamp the same way NUMBER tokens do, so no
+        // non-digit byte ("512.5", "Infinity") can appear inside the partial range
+        const float = (
+            await compiler({ tag: 'A', command: 'FETCH', attributes: [{ type: 'ATOM', value: 'BODY.PEEK', section: [], partial: [0, 512.5] }] })
+        ).toString();
+        test.equal(float, 'A FETCH BODY.PEEK[]<0.513>');
+
+        const unbounded = (
+            await compiler({ tag: 'A', command: 'FETCH', attributes: [{ type: 'ATOM', value: 'BODY.PEEK', section: [], partial: ['Infinity', '2e21'] }] })
+        ).toString();
+        test.equal(unbounded, 'A FETCH BODY.PEEK[]<0.0>');
     });
 
 module.exports['IMAP Compiler: logging output never throws on unsendable values'] = test =>

package/test/imap-flow-coverage-test.js

@@ -591,9 +591,11 @@ module.exports['Coverage: reader caps very large throttle backoff'] = async test
     let readerPromise = runReaderWith(client, ['A1 BAD Request is throttled. Suggested Backoff Time: 999999999 milliseconds']);
     // give the reader a tick to register the throttle timer, then abort it
     await drain();
-    if (typeof client._throttleAbort === 'function') {
-        client._throttleAbort(true);
+    for (let entry of client._throttleWaits) {
+        clearTimeout(entry.timer);
+        entry.resolve(true);
     }
+    client._throttleWaits.clear();
     await readerPromise;
     test.ok(rejected);
     test.done();

package/test/imap-flow-fetch-download-test.js

@@ -852,3 +852,29 @@ module.exports['DownloadMany: decodes base64 and quoted-printable parts'] = asyn
     test.equal(res['3'].meta.disposition, 'attachment');
     test.done();
 };
+
+module.exports['Download: a buffering transform cannot defeat maxBytes'] = async test => {
+    // format=flowed unwrapping and the Japanese charset decoder both hold their whole input
+    // before emitting anything, so the limiter at the tail of the pipeline reports
+    // `limited === false` however much the server sends. Without a bound of their own the fetch
+    // loop would keep pulling the entire part.
+    for (let contentType of ['text/plain; format=flowed', 'text/plain; charset=iso-2022-jp']) {
+        let client = makeClient();
+        let mime = Buffer.from(`Content-Type: ${contentType}\r\nContent-Disposition: inline\r\n\r\n`);
+        let calls = 0;
+        client.fetchOne = async () => {
+            calls++;
+            let bodyParts = new Map();
+            bodyParts.set('2.mime', mime);
+            // full-size chunks keep hasMore true; the loop must stop on its own, not run dry
+            bodyParts.set('2', calls <= 40 ? Buffer.alloc(1024, 0x61) : Buffer.alloc(1));
+            return { uid: 1, size: 1024 * 1024, bodyParts };
+        };
+
+        let { content } = await client.download('1', '2', { chunkSize: 1024, maxBytes: 512 });
+        let data = await collect(content);
+        test.ok(data.length <= 512, `${contentType}: delivered ${data.length} bytes, expected no more than 512`);
+        test.ok(calls <= 3, `${contentType}: the fetch loop must stop at the bound, made ${calls} calls`);
+    }
+    test.done();
+};

package/test/imap-flow-internals-test.js

@@ -471,3 +471,137 @@ module.exports['Internals: untaggedFetch includes modseq and flagColor'] = async
     test.equal(evt.flagColor, 'red');
     test.done();
 };
+
+// ============================================================================
+// runInternal dispatch guards
+// ============================================================================
+
+module.exports['Internals: runInternal returns false for unknown command'] = async test => {
+    let client = makeClient();
+    client.socket = { destroyed: false };
+    let res = await client.runInternal('NOT_A_COMMAND');
+    test.equal(res, false);
+    test.done();
+};
+
+module.exports['Internals: runInternal throws NoConnection when the socket is destroyed'] = async test => {
+    let client = makeClient();
+    client.socket = { destroyed: true };
+    let err = null;
+    try {
+        await client.runInternal('NOOP');
+    } catch (e) {
+        err = e;
+    }
+    test.ok(err);
+    test.equal(err.code, 'NoConnection');
+    test.done();
+};
+
+// ============================================================================
+// send() onSend error containment
+// ============================================================================
+
+module.exports['Internals: send contains a throwing onSend callback'] = async test => {
+    let client = makeClient();
+    let written = [];
+    let warnings = [];
+    client.socket = { destroyed: false };
+    client.writeSocket = { destroyed: false, write: chunk => written.push(chunk) };
+    client.state = client.states.AUTHENTICATED;
+    client.log.warn = entry => warnings.push(entry);
+    client.currentRequest = { tag: 'A1', sent: false };
+
+    // The command is already on the wire when onSend runs, so a throwing callback
+    // must be logged and swallowed instead of rejecting the request
+    await client.send({
+        tag: 'A1',
+        command: 'NOOP',
+        attributes: [],
+        options: {
+            onSend: () => {
+                throw new Error('onSend boom');
+            }
+        }
+    });
+
+    test.equal(written.length, 1, 'the command was written to the socket');
+    test.equal(written[0].toString(), 'A1 NOOP\r\n', 'the actual wire bytes went out before onSend ran');
+    test.equal(client.currentRequest.sent, true, 'the request is marked as sent');
+    test.ok(
+        warnings.some(entry => entry && entry.err && entry.err.message === 'onSend boom'),
+        'the callback error was logged'
+    );
+    test.done();
+};
+
+// ============================================================================
+// countUnknownTag teardown guard
+// ============================================================================
+
+module.exports['Internals: countUnknownTag ignores tags on a closed connection'] = test => {
+    let client = makeClient();
+    client.isClosed = true;
+    client.countUnknownTag('A1');
+    test.equal(client._unknownTagCount, 0, 'teardown crossover is not counted');
+    test.done();
+};
+
+// ============================================================================
+// rejectUnparsedCompletion
+// ============================================================================
+
+// Installs a command that is current and on the wire, returning a holder for
+// the rejection the reader loop would deliver to the caller
+const armInFlight = (client, tag) => {
+    let captured = { err: null };
+    client.currentRequest = { tag, sent: true };
+    client.requestTagMap.set(tag, {
+        tag,
+        reject: err => {
+            captured.err = err;
+        }
+    });
+    return captured;
+};
+
+module.exports['Internals: rejectUnparsedCompletion ignores lines without an in-flight command'] = test => {
+    let client = makeClient();
+
+    client.currentRequest = false;
+    client.rejectUnparsedCompletion(Buffer.from('A1 OK done'), new Error('parse fail'));
+    test.equal(client.currentRequest, false, 'no request to settle');
+
+    // A command that is current but not yet on the wire must not be settled either
+    client.currentRequest = { tag: 'A1', sent: false };
+    client.rejectUnparsedCompletion(Buffer.from('A1 OK done'), new Error('parse fail'));
+    test.ok(client.currentRequest, 'the unsent request is untouched');
+    test.done();
+};
+
+module.exports['Internals: rejectUnparsedCompletion recovers the tag from NUL-padded raw bytes'] = async test => {
+    let client = makeClient();
+    let captured = armInFlight(client, 'A1');
+
+    // The parser died before extracting a tag - the raw line carries the buggy-server
+    // NUL padding, so the fallback must skip it and stop at the first non-tag byte
+    let parserError = new Error('parse fail');
+    client.rejectUnparsedCompletion(Buffer.from('\x00\x00A1 \x07garbage'), parserError);
+
+    test.ok(captured.err, 'the in-flight command was failed');
+    test.equal(captured.err.code, 'ParserError');
+    test.equal(captured.err.parserError, parserError);
+    test.equal(client.currentRequest, false, 'the request slot was cleared');
+    test.done();
+};
+
+module.exports['Internals: rejectUnparsedCompletion ignores a mismatched raw tag'] = test => {
+    let client = makeClient();
+    let captured = armInFlight(client, 'A1');
+
+    client.rejectUnparsedCompletion(Buffer.from('A2 NO other'), new Error('parse fail'));
+
+    test.equal(captured.err, null, 'a line for another tag settles nothing');
+    test.ok(client.currentRequest, 'the in-flight request stays current');
+    test.done();
+};

package/test/imap-flow-methods-test.js

@@ -795,3 +795,95 @@ module.exports['Methods: autoEnable does not retry when disableIMAP4rev2 already
     test.equal(calls.length, 1);
     test.done();
 };
+
+module.exports['Methods: untaggedExpunge refuses an unusable sequence number'] = async test => {
+    // Same bound untaggedExists() applies: an overflowing or non-decimal value must not
+    // decrement the live message count
+    let client = makeClient();
+    client.mailbox.exists = 10;
+    let events = [];
+    client.on('expunge', e => events.push(e));
+
+    await client.untaggedExpunge(false);
+    for (let bad of ['9'.repeat(400), '1e5', '0', 'abc', '']) {
+        await client.untaggedExpunge({ command: bad });
+    }
+    test.equal(client.mailbox.exists, 10, 'the live message count must be left alone');
+    test.equal(events.length, 0);
+
+    await client.untaggedExpunge({ command: '3' });
+    test.equal(client.mailbox.exists, 9, 'a usable sequence number is still applied');
+    test.equal(events.length, 1);
+    test.equal(events[0].seq, 3);
+    test.done();
+};
+
+module.exports['Methods: untaggedVanished survives a malformed response'] = async test => {
+    // "* VANISHED (EARLIER)" leaves no sequence set at all. Throwing here would abort the
+    // handler for the whole response, and handleResponse only warns - so every expunge the
+    // response did carry would be dropped and the client's mailbox view would go stale.
+    let client = makeClient();
+    let events = [];
+    client.on('expunge', e => events.push(e));
+
+    await client.untaggedVanished({ attributes: [[{ value: 'EARLIER' }]] });
+    await client.untaggedVanished({ attributes: [] });
+    await client.untaggedVanished({});
+    await client.untaggedVanished({ attributes: [[{ value: 'EARLIER' }], null] });
+
+    test.equal(events.length, 0, 'nothing to report, and nothing thrown');
+
+    // a well-formed response still works after the malformed ones
+    await client.untaggedVanished({ attributes: [[{ value: 'EARLIER' }], { value: '5:6' }] });
+    test.equal(events.length, 2);
+    test.equal(events[0].uid, 5);
+    test.equal(events[0].earlier, true);
+    test.done();
+};
+
+module.exports['Methods: untaggedExists refuses an overflowing count'] = async test => {
+    // Number('9'.repeat(400)) is Infinity: resolveRange('*') would then compile the literal
+    // string "Infinity" and every range-based command would fail until the next SELECT
+    let client = makeClient();
+    client.mailbox = { path: 'INBOX', exists: 5 };
+    let events = [];
+    client.on('exists', e => events.push(e));
+
+    await client.untaggedExists(false);
+    await client.untaggedExists({});
+    for (let bad of ['9'.repeat(400), '1e5', '-1', 'abc', '1.5', '']) {
+        await client.untaggedExists({ command: bad });
+    }
+    test.equal(client.mailbox.exists, 5, 'the live message count must be left alone');
+    test.equal(events.length, 0);
+
+    await client.untaggedExists({ command: '7' });
+    test.equal(client.mailbox.exists, 7, 'a usable count is still applied');
+    test.equal(events.length, 1);
+    test.done();
+};
+
+module.exports['Methods: throttleWait caps the delay and close() aborts it'] = async test => {
+    let client = makeClient();
+
+    // A server hint is unbounded; the wait may never outlive the client either
+    let started = Date.now();
+    let pending = client.throttleWait(7 * 24 * 3600 * 1000);
+    test.equal(client._throttleWaits.size, 1, 'the wait is tracked so close() can reach it');
+
+    client.close();
+    test.equal(await pending, true, 'an aborted wait reports true');
+    test.equal(client._throttleWaits.size, 0, 'the tracked wait is released');
+    test.ok(Date.now() - started < 5000, 'close() must not wait out the delay');
+
+    // normal expiry reports false and releases the entry. The back-off timer is deliberately
+    // unref'd, so the test has to hold the event loop open itself - in a real session the
+    // socket does that.
+    let client2 = makeClient();
+    let keepAlive = setTimeout(() => {}, 1000);
+    test.equal(await client2.throttleWait(1), false);
+    clearTimeout(keepAlive);
+    test.equal(client2._throttleWaits.size, 0);
+    client2.close();
+    test.done();
+};