imapflow 1.7.8 → 2.0.0

package/test/fixtures/test-client.js

@@ -1,101 +0,0 @@
-'use strict';
-
-// Shared ImapFlow construction for unit tests that poke at internals without a live server.
-// One definition instead of a per-file copy, so a change to what the constructor needs lands
-// in one place and cannot drift between suites.
-
-const { Writable } = require('node:stream');
-
-const { ImapFlow } = require('../../lib/imap-flow');
-
-// A socket stub complete enough for setSocketHandlers(), clearSocketHandlers() and close() to
-// run against. removeListener/removeAllListeners matter most: close() removes the handlers it
-// installed, and a stub without them makes close() throw half-way through teardown with the
-// client still holding its socket and streamer references.
-const makeSocketStub = () => ({
-    destroyed: false,
-    destroy: () => {},
-    on: () => {},
-    once: () => {},
-    end: () => {},
-    unpipe: () => {},
-    removeListener: () => {},
-    removeAllListeners: () => {},
-    setKeepAlive: () => {},
-    setTimeout: () => {}
-});
-
-// Bare construction: no socket, no state overrides. Tests that need a transport use
-// makeSocketStub() or makeIdleReadyClient() instead of reaching for their own object literals.
-const makeClient = (overrides = {}) =>
-    new ImapFlow({
-        host: '127.0.0.1',
-        port: 993,
-        logger: false,
-        auth: { user: 'test', pass: 'secret' },
-        ...overrides
-    });
-
-// A client parked in SELECTED with a stubbed socket and a no-op idle(), ready for autoidle(),
-// lock handling and watchdog behavior to be exercised directly
-const makeIdleReadyClient = (overrides = {}) => {
-    let client = makeClient({ maxLockHoldTime: 0, ...overrides });
-    client.socket = makeSocketStub();
-    client.usable = true;
-    client.state = client.states.SELECTED;
-    client.mailbox = { path: 'INBOX', readOnly: false };
-    client.idle = async () => {};
-    return client;
-};
-
-// A fetchOne stand-in that serves `body` back in download()'s chunk-query shape
-// ({source: {start, maxLength}}), so download tests do not each restate that contract
-const chunkedFetchOne = body => async (range, query) => {
-    let start = query.source.start;
-    let maxLength = query.source.maxLength;
-    return { uid: 1, size: body.length, source: body.subarray(start, start + maxLength) };
-};
-
-// Installs a process-level unhandledRejection detector for one test. Shared because getting the
-// teardown wrong leaks a process listener into every test that runs after it, and because the
-// assertion has to read the same way wherever a suite checks that nothing escaped.
-const installRejectionDetector = test => {
-    // Tracked as a separate flag rather than by testing the reason: a rejection can carry a falsy
-    // value, and that is still an escaped rejection.
-    let unhandled = false;
-    let unhandledReason = null;
-    const handler = reason => {
-        unhandled = true;
-        unhandledReason = reason;
-    };
-    process.on('unhandledRejection', handler);
-
-    return {
-        check() {
-            process.removeListener('unhandledRejection', handler);
-            test.equal(unhandled, false, 'no unhandledRejection should fire' + (unhandledReason ? ': ' + unhandledReason.message : ''));
-        }
-    };
-};
-
-// A Writable that always defers its callback, so writing to a stream piped into it fills the
-// pipeline and forces the producer into backpressure. `delay` is only for tests that also need
-// wall-clock time to pass; deferring at all is what triggers the drain wait.
-const slowConsumer = (options = {}) => {
-    let { delay = 0, onChunk } = options;
-    return new Writable({
-        highWaterMark: 1,
-        write(chunk, enc, cb) {
-            if (typeof onChunk === 'function') {
-                onChunk(chunk);
-            }
-            if (delay) {
-                setTimeout(cb, delay);
-            } else {
-                setImmediate(cb);
-            }
-        }
-    });
-};
-
-module.exports = { makeClient, makeIdleReadyClient, makeSocketStub, chunkedFetchOne, installRejectionDetector, slowConsumer };

package/test/fixtures/test-tls.js

@@ -1,8 +0,0 @@
-'use strict';
-
-// Self-signed certificate + key for in-process TLS/STARTTLS mock servers in tests.
-// Generated once with: openssl req -x509 -newkey rsa:2048 -nodes -subj "/CN=localhost"
-module.exports = {
-    cert: '-----BEGIN CERTIFICATE-----\nMIIDCTCCAfGgAwIBAgIUQSc0WP7RlcOqGCdsMaxzCA97mfkwDQYJKoZIhvcNAQEL\nBQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTI2MDYwODA0Mzg1NFoXDTM2MDYw\nNTA0Mzg1NFowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF\nAAOCAQ8AMIIBCgKCAQEA4TYnyK2nEn6wXEgVeEI3I9CDlONvWDO1Y51mslOaUwZR\nfuZp3YMUZDINNdZuFrREkD1WJfClRZtDKEurw9FfjEfA0gsM9RPvkQYXZ2zzhXgW\nx86li0Ra/Zx2RmajsWc+THTEpdOK0nqOqMMKFxiYJ7E+KiJY0X6HqKjdaB9CpZv7\nA1ROJoLjTnsdDG/NT9MCQxFbw05N2Bbbq+McKyXIEzxiZguYLIXsMKCi9MQOozvY\nT8X0AFWpFJCa8mRCW7LQngeSRQQckDONzHyELXnbvgIskr/WcmBEXMraTts3Z3QW\nouee6HFnYzi/pgCtVKX1Wu3oZm/nMblsWtopqg/YDwIDAQABo1MwUTAdBgNVHQ4E\nFgQUF5oycZ3ZaPs1fTaxZb666FQt+KcwHwYDVR0jBBgwFoAUF5oycZ3ZaPs1fTax\nZb666FQt+KcwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAWFk0\nMGw2pdkeU/s5j0T9GL8GjbOVC0G7H8tlx92XhQICmt/9GNHeb5nm84DgqRbkiTwS\nOXPoMsSvVEubnX0j/sqcbi5yQ6/YBG6Vx5E9CnfUbo4m9x1GofDkLdl+e6l636Mj\nWB5kJpNCH9sm2xPdLpl47pv/lwvyYjdy1DaATHn5nMGoM73IeEt0d4xoNN8Bso7B\nTTkjKRJ1QWgI2EjgU93x8tG4AqTj0CeH8Z6DDmfLhvJ6E0hSws4OQSnxWudh2aX8\niN+FkHgRobPS1GVCtibr+FxH1DtBv/grXhAbs4xP3Nf3m3Pn6AE0/lMtto3e67As\np4lf866gU9nbRkODqw==\n-----END CERTIFICATE-----\n',
-    key: '-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDhNifIracSfrBc\nSBV4Qjcj0IOU429YM7VjnWayU5pTBlF+5mndgxRkMg011m4WtESQPVYl8KVFm0Mo\nS6vD0V+MR8DSCwz1E++RBhdnbPOFeBbHzqWLRFr9nHZGZqOxZz5MdMSl04rSeo6o\nwwoXGJgnsT4qIljRfoeoqN1oH0Klm/sDVE4mguNOex0Mb81P0wJDEVvDTk3YFtur\n4xwrJcgTPGJmC5gshewwoKL0xA6jO9hPxfQAVakUkJryZEJbstCeB5JFBByQM43M\nfIQtedu+AiySv9ZyYERcytpO2zdndBai557ocWdjOL+mAK1UpfVa7ehmb+cxuWxa\n2imqD9gPAgMBAAECggEACgBGqgG+0/JuUIV0S/UyJP6t098kYwKrgR33S99XO21M\nvIRCRUT8kyp/La81D6sNCb6/jvXDJnaA9/l29OjdA7TCr6aFT8jahafYmDjdY5rz\n9Vw25nAFqRIuqm0FGJa2Id0O8oeUuEjFrGGPltD6c3Yf2u0li+rA3tDeQYZ0hjge\nsVXzgI58SbO1Z1XCAXcdbcJOqjpEJ3w99GB5J/B1dDui3KR5Q6+L34HfoW8XmY/X\nCLe+Jcuk06Xa31iZ+0NEMIPOhVoCW//PfgEWD/dfG3jXhk84/Pb8DXaGahOvRPTY\nH1AVrqRBqW6PezR4qU4PdUfU3sp5NEBZl3oaW7/weQKBgQD8CKI7ek00KUhc9j5m\nHGuSR+lUzLziXRBt7xw0JXLa1rfok2RGDeTdIEGSjBr8xsNOe5aga843geoLptNe\n7LRrtJajgHl39NXnblroNidufmXjt9CRgjUsQuIREpjq9NyUGIh8o26/uZLB/Knq\nJ7Uum9YUHI/eEztmI/CZDbnUbQKBgQDkwXaf5UxkY9tsdbw8jHhV5Ypy/hwLXAcI\n90sCI9/mSQAOA9qNa+944MbRfReTseM+OFXHJRHXfuMXPPOrtObtVN94ECwFVePO\n2MI5CHc/SYZ/4Icf+jpPY+TAJtEW/39muwak43cmLhmrSmb9ExMhwfDoQotFBDOQ\nLyPPfMo46wKBgFwpWBHB1kt1sSV1UjoKuHdkXnmI6KUp/OEGZ9zVuNs3W0br5uYL\nHJ6Ttga9vvyiPjcL0HfXFDCODCS4m2CB1DPydIdTapen6zRW0V1KuD6ab+3GgLlE\n0ObfikVN9KcuZR6unfJd3Ri05mqTVxrt7D4f9DekfiNqCvV9vPRq5YI9AoGBAMeS\nYUOucK9EzzIYpVjN1E5cLCWWvDDM4PZZiP8c/UGTfpC7m/i1qf7zW4F4eRFJqM+n\npm5PUPmIoeasLoonETENUskUktM008KqKQhI8oAsTUNTR5AGZsjMhc1+D/zYevXN\nRUaljFWq8ooWJzOzaIWTBfIb3BUiTToFZmCmpmZxAoGAH2W3eDhuKrsE50ntofhZ\nx9Uy0OD30nztyecen26kuljcX7qdWh564mBob75wGSAoYzGSePZjJ/tQ4FznXUes\n6F4gM8Y58d3YZOjNq3xnT7AfaJHNnnjxA4pfnGRVr3wA2vwyrD3McgAPXf+mnB23\nl8nz6wxk97WnaIyo7Ofi/+A=\n-----END PRIVATE KEY-----\n'
-};

package/test/handler-branches-test.js

@@ -1,310 +0,0 @@
-/* eslint no-unused-expressions: 0, prefer-arrow-callback: 0, new-cap: 0 */
-
-'use strict';
-
-const { parser, compiler } = require('../lib/handler/imap-handler');
-const { ImapStream } = require('../lib/handler/imap-stream');
-const { ParserInstance } = require('../lib/handler/parser-instance');
-const { TokenParser } = require('../lib/handler/token-parser');
-const { searchCompiler } = require('../lib/search-compiler');
-
-let asyncWrapper = (test, handler) => {
-    handler(test)
-        .then(() => test.done())
-        .catch(err => {
-            test.ifError(err);
-            test.done();
-        });
-};
-
-// ============================================================================
-// imap-compiler.js
-// ============================================================================
-
-// formatRespEntry: `return entry` when entry is a Buffer (line 23-25). A literal
-// whose value is a Buffer, compiled in non-logging mode, passes the Buffer straight
-// through formatRespEntry.
-module.exports['imap-compiler: Buffer literal value passes through formatRespEntry'] = test =>
-    asyncWrapper(test, async test => {
-        let out = (
-            await compiler({
-                tag: '*',
-                command: 'CMD',
-                attributes: [{ type: 'LITERAL', value: Buffer.from('hello world') }]
-            })
-        ).toString();
-        test.equal(out, '* CMD {11}\r\nhello world');
-    });
-
-// number node === 0 -> `Math.round(node) || 0` falls back to 0 (line 117). A bare
-// numeric attribute of 0 exercises the `|| 0` right side.
-module.exports['imap-compiler: bare number 0 attribute uses fallback'] = test =>
-    asyncWrapper(test, async test => {
-        let out = (
-            await compiler({
-                tag: '*',
-                command: 'CMD',
-                attributes: [0]
-            })
-        ).toString();
-        test.equal(out, '* CMD 0');
-    });
-
-// LITERAL node with empty value -> `!node.value ? 0 : ...` true side (line 133).
-module.exports['imap-compiler: LITERAL with empty string value yields {0}'] = test =>
-    asyncWrapper(test, async test => {
-        let out = (
-            await compiler({
-                tag: '*',
-                command: 'CMD',
-                attributes: [{ type: 'LITERAL', value: '' }]
-            })
-        ).toString();
-        test.equal(out, '* CMD {0}\r\n');
-    });
-
-// LITERAL- (literalMinus) with literal <= 4096 bytes in asArray mode -> exercises the
-// `(literalMinus && literalLength <= 4096)` branch of canAppend (line 139) and usePlus.
-module.exports['imap-compiler: LITERAL- inlines small literals in asArray mode'] = test =>
-    asyncWrapper(test, async test => {
-        let out = (
-            await compiler(
-                {
-                    tag: '*',
-                    command: 'CMD',
-                    attributes: [{ type: 'LITERAL', value: 'small' }]
-                },
-                { asArray: true, literalMinus: true }
-            )
-        ).map(entry => entry.toString());
-        // LITERAL- still appends a non-synchronizing '+' marker for inlined literals
-        test.deepEqual(out, ['* CMD {5+}\r\nsmall']);
-    });
-
-// LITERAL- with a literal larger than 4096 bytes in asArray mode -> canAppend false,
-// so the synchronizing-literal split path runs. The new resp segment is seeded with
-// `formatRespEntry(node.value, true) || []`. Using a Buffer value keeps formatRespEntry
-// returning the Buffer (the `|| []` right side, line 156, is the focus together with the
-// split branch).
-module.exports['imap-compiler: LITERAL- large literal splits (synchronizing) in asArray mode'] = test =>
-    asyncWrapper(test, async test => {
-        let big = Buffer.alloc(5000, 0x61); // 5000 bytes > 4096
-        let out = (
-            await compiler(
-                {
-                    tag: '*',
-                    command: 'CMD',
-                    attributes: [{ type: 'LITERAL', value: big }]
-                },
-                { asArray: true, literalMinus: true }
-            )
-        ).map(entry => entry.toString());
-        test.equal(out.length, 2);
-        test.equal(out[0], '* CMD {5000}\r\n');
-        test.equal(out[1], big.toString());
-    });
-
-// Synchronizing literal whose value is not a recognized type -> formatRespEntry(value, true)
-// returns null, so `|| []` kicks in (line 156 right side) and the seeded resp is empty.
-module.exports['imap-compiler: synchronizing literal with non-buffer value seeds empty segment'] = test =>
-    asyncWrapper(test, async test => {
-        let out = (
-            await compiler(
-                {
-                    tag: '*',
-                    command: 'CMD',
-                    // value is an object that is neither string/number/Buffer, so the size
-                    // marker derives from the UTF-8 byte length of its stringified form
-                    // ('[object Object]', 15 bytes) while formatRespEntry(value, true)
-                    // returns null -> the seeded resp falls back to [] (line 156 right side).
-                    attributes: [{ type: 'LITERAL', value: { length: 10 } }]
-                },
-                { asArray: true }
-            )
-        ).map(entry => entry.toString());
-        // Only the header segment is emitted; the empty seeded data segment is dropped
-        // because `if (resp.length)` is false at the end.
-        test.deepEqual(out, ['* CMD {15}\r\n']);
-    });
-
-// STRING node with falsy value -> `(node.value || '')` right side (line 165).
-module.exports['imap-compiler: STRING with empty/falsy value compiles to empty quoted string'] = test =>
-    asyncWrapper(test, async test => {
-        let out = (
-            await compiler({
-                tag: '*',
-                command: 'CMD',
-                attributes: [{ type: 'STRING', value: '' }]
-            })
-        ).toString();
-        test.equal(out, '* CMD ""');
-    });
-
-// response.attributes that is a single (non-array) object -> `[].concat(response.attributes)`
-// right side of the ternary on line 215.
-module.exports['imap-compiler: single non-array attributes object is wrapped'] = test =>
-    asyncWrapper(test, async test => {
-        let out = (
-            await compiler({
-                tag: '*',
-                command: 'CMD',
-                attributes: { type: 'ATOM', value: 'EXPUNGE' }
-            })
-        ).toString();
-        test.equal(out, '* CMD EXPUNGE');
-    });
-
-// ============================================================================
-// imap-stream.js
-// ============================================================================
-
-// Provide a logger object so the constructor takes the `this.options.logger` branch
-// (lines 61-62) instead of creating a child logger.
-module.exports['imap-stream: explicit logger option is used as-is'] = test => {
-    let calls = [];
-    let fakeLogger = {
-        trace: m => calls.push(m),
-        child: () => {
-            throw new Error('child should not be called when a logger is supplied');
-        }
-    };
-    let stream = new ImapStream({ cid: 'x', logger: fakeLogger });
-    test.equal(stream.log, fakeLogger, 'supplied logger object is used directly');
-    test.done();
-};
-
-// checkLiteralMarker: a line that is all digits + "}\r\n" but has no opening "{" makes
-// the backward scan run off the start of the line, hitting the final `return false`
-// (line 154).
-module.exports['imap-stream: checkLiteralMarker returns false when no opening brace is found'] = test => {
-    let stream = new ImapStream({ cid: 'x' });
-    // "12}\n": scan finds '}', then digits '2','1', runs past index 0 -> final return false
-    test.equal(stream.checkLiteralMarker(Buffer.from('12}\n')), false);
-    // also exercise the CRLF variant
-    test.equal(stream.checkLiteralMarker(Buffer.from('99}\r\n')), false);
-    test.done();
-};
-
-// _transform with a string chunk -> `chunk = Buffer.from(chunk, encoding)` (lines 299-301).
-// Call _transform directly with a string so the typeof === 'string' branch runs.
-// The string->Buffer conversion and byte counting happen synchronously, before the
-// chunk is queued for async processing, so readBytesCounter reflects the decoded length.
-module.exports['imap-stream: _transform converts string chunks to Buffers'] = test => {
-    let stream = new ImapStream({ cid: 'x' });
-    stream._transform('A1 NOOP\r\n', 'utf8', () => {});
-    test.equal(stream.readBytesCounter, Buffer.byteLength('A1 NOOP\r\n'), 'decoded byte length was counted');
-    stream.destroy();
-    test.done();
-};
-
-// ============================================================================
-// parser-instance.js
-// ============================================================================
-
-// Drive ParserInstance directly so getCommand is reached with a falsy (empty-string)
-// command and a non-"+" tag, exercising the `(this.command || '')` right side (line 71).
-// This state is not produced by normal parsing, so we construct it explicitly.
-module.exports['parser-instance: getCommand falls back to empty string for falsy command'] = test =>
-    asyncWrapper(test, async test => {
-        let inst = new ParserInstance('* ', {});
-        inst.tag = '*'; // not '+', so the early continuation branch is skipped
-        // Pre-set command to a value getElement would have produced, then blank the
-        // remainder so the `if (!this.command)` re-fetch path throws? No - instead we
-        // set command to empty string and clear remainder so getElement is NOT re-run
-        // is impossible (empty string is falsy). Use a getElement stub on the instance
-        // to deterministically yield an empty command without touching lib/ source.
-        inst.getElement = async () => '';
-        let command = await inst.getCommand();
-        test.equal(command, '', 'command is the empty string');
-    });
-
-// ============================================================================
-// token-parser.js
-// ============================================================================
-
-// Construct TokenParser directly with a falsy str, undefined options and a falsy
-// startPos to cover the `str || ''` (40), `options || {}` (41) and `startPos || 0`
-// (45) fallbacks. These cannot occur through ParserInstance.getAttributes (which
-// guards against an empty remainder), so direct construction is required.
-module.exports['token-parser: constructor fallbacks for empty str / no options / zero startPos'] = test =>
-    asyncWrapper(test, async test => {
-        let parent = { command: 'FETCH' };
-        let tp = new TokenParser(parent, 0, undefined, undefined);
-        test.equal(tp.str, '');
-        test.deepEqual(tp.options, {});
-        test.equal(tp.pos, 0);
-        let attrs = await tp.getAttributes();
-        test.deepEqual(attrs, []);
-    });
-
-// Cover the `(node.type || '')` fallback (line 85) by walking a tree that contains a
-// closed child node with a falsy type. Normal parsing always assigns a type, so the
-// tree is constructed explicitly.
-module.exports['token-parser: walk handles a closed node with a falsy type'] = test =>
-    asyncWrapper(test, async test => {
-        let parent = { command: 'FETCH' };
-        let tp = new TokenParser(parent, 0, '', {});
-        tp.tree = {
-            type: 'TREE',
-            isClosed: true,
-            childNodes: [{ type: false, isClosed: true, value: '', childNodes: [] }]
-        };
-        let attrs = await tp.getAttributes();
-        test.deepEqual(attrs, []);
-    });
-
-// ============================================================================
-// search-compiler.js
-// ============================================================================
-
-let createMockConnection = (options = {}) => ({
-    capabilities: new Map(options.capabilities || [['IMAP4rev1', true]]),
-    enabled: new Set(options.enabled || []),
-    mailbox: options.mailbox || {
-        flags: new Set(['\\Seen']),
-        permanentFlags: new Set(['\\*'])
-    }
-});
-
-// setOpt NOT branch (lines 46-48): EMAILID/THREADID call setOpt with an unguarded
-// params[term]. Passing the boolean `false` as the value reaches `value === false`
-// and pushes a leading NOT atom. (A `null` value also enters this branch, but setOpt
-// then crashes on `value.toString()` at line 56, so `false` is the only value that
-// drives this branch to completion through the public API.)
-module.exports['search-compiler: threadid false triggers setOpt NOT branch'] = test => {
-    let connection = createMockConnection({ capabilities: [['OBJECTID', true]] });
-    let attrs = searchCompiler(connection, { threadid: false });
-    test.deepEqual(attrs, [
-        { type: 'ATOM', value: 'NOT' },
-        { type: 'ATOM', value: 'THREADID' },
-        { type: 'ATOM', value: 'false' }
-    ]);
-    test.done();
-};
-
-// KEYWORD search where the flag is NOT usable via canUseFlag but IS already present in
-// the mailbox flags set -> exercises the `mailbox.flags.has(flag)` right side (line 297).
-module.exports['search-compiler: keyword already present in mailbox flags is accepted'] = test => {
-    // permanentFlags has no '\\*', so canUseFlag(mailbox, customFlag) is false, but the
-    // flag is in mailbox.flags, so the OR short-circuits to the right operand.
-    let connection = createMockConnection({
-        mailbox: {
-            flags: new Set(['$Label1']),
-            permanentFlags: new Set(['\\Seen']) // no '\\*' wildcard -> custom flags not auto-usable
-        }
-    });
-    let attrs = searchCompiler(connection, { keyword: '$Label1' });
-    test.deepEqual(attrs, [
-        { type: 'ATOM', value: 'KEYWORD' },
-        { type: 'ATOM', value: '$Label1' }
-    ]);
-    test.done();
-};
-
-// ============================================================================
-// Sanity: untagged parse still round-trips, just to keep the parser import exercised.
-module.exports['sanity: parser/compiler round-trip'] = test =>
-    asyncWrapper(test, async test => {
-        let parsed = await parser('* OK Ready', { allowUntagged: true });
-        test.equal(parsed.command, 'OK');
-    });