node-firebird 2.3.3 → 2.4.0

package/poc/node_modules/node-firebird/lib/wire/socket.js

@@ -1,175 +0,0 @@
-const net = require("net");
-const zlib = require("zlib");
-
-/**
- * Arc4 stream cipher for Firebird wire encryption.
- * Uses the SRP session key to create RC4 encryption/decryption streams.
- */
-class Arc4 {
-    constructor(key) {
-        this._s = new Uint8Array(256);
-        this._i = 0;
-        this._j = 0;
-
-        // KSA (Key-Scheduling Algorithm)
-        for (var i = 0; i < 256; i++) {
-            this._s[i] = i;
-        }
-
-        var j = 0;
-        for (var i = 0; i < 256; i++) {
-            j = (j + this._s[i] + key[i % key.length]) & 0xFF;
-            // Swap
-            var tmp = this._s[i];
-            this._s[i] = this._s[j];
-            this._s[j] = tmp;
-        }
-    }
-
-    /**
-     * Transform (encrypt/decrypt) data in place.
-     * RC4 is symmetric - encrypt and decrypt are the same operation.
-     */
-    transform(data) {
-        var out = Buffer.alloc(data.length);
-        for (var n = 0; n < data.length; n++) {
-            this._i = (this._i + 1) & 0xFF;
-            this._j = (this._j + this._s[this._i]) & 0xFF;
-
-            // Swap
-            var tmp = this._s[this._i];
-            this._s[this._i] = this._s[this._j];
-            this._s[this._j] = tmp;
-
-            var k = this._s[(this._s[this._i] + this._s[this._j]) & 0xFF];
-            out[n] = data[n] ^ k;
-        }
-        return out;
-    }
-}
-
-/**
- * Socket proxy.
- */
-class Socket {
-    constructor(port, host) {
-        this._socket = net.createConnection(port, host);
-        this._socket.setNoDelay(true);
-        this.compressor = null;
-        this.compressorBuffer = [];
-        this.decompressor = null;
-        this.decompressorBuffer = [];
-        this.buffer = null;
-        this.encrypt = false;
-        this.encryptCipher = null;
-        this.decryptCipher = null;
-
-        return new Proxy(this._socket, this);
-    }
-
-    /**
-     * Decompress and/or decrypt data when received.
-     * Override on data event.
-     */
-    on(event, cb) {
-        if (event === 'data') {
-            const mainCb = cb;
-            cb = (data) => {
-                // Decrypt first if encryption is enabled
-                if (this.encrypt) {
-                    data = this.decryptCipher.transform(data);
-                }
-
-                if (this.compress) {
-                    this.decompressor.write(data, () => {
-                        mainCb(Buffer.concat(this.decompressorBuffer));
-                        this.decompressorBuffer = []; // Reset buffer
-                    });
-                } else {
-                    mainCb(data);
-                }
-            };
-        }
-
-        this._socket.on(event, cb);
-    }
-
-    /**
-     * Compress and/or encrypt data before sending to socket.
-     */
-    write(data, defer = false) {
-        if (defer) {
-            this.buffer = Buffer.from(data);
-            return;
-        }
-
-        if (!defer && this.buffer) {
-            data = Buffer.concat([this.buffer, data]);
-            this.buffer = null;
-        }
-
-        if (this.compress) {
-            this.compressor.write(data, () => {
-                var compressedData = Buffer.concat(this.compressorBuffer);
-                this.compressorBuffer = []; // Reset buffer
-
-                // Encrypt after compression if encryption is enabled
-                if (this.encrypt) {
-                    compressedData = this.encryptCipher.transform(compressedData);
-                }
-
-                this._socket.write(compressedData);
-            });
-        } else if (this.encrypt) {
-            this._socket.write(this.encryptCipher.transform(data));
-        } else {
-            this._socket.write(data);
-        }
-    }
-
-    /**
-     * Enable compression/decompression on the fly.
-     */
-    enableCompression() {
-        this.compress = true;
-
-        // Create decompressor instance
-        this.decompressor = zlib.createInflate();
-        this.decompressor.on('data', (inflate) => {
-            this.decompressorBuffer.push(inflate);
-        });
-
-        // Create compressor instance
-        this.compressor = zlib.createDeflate({
-            flush: zlib.constants.Z_FULL_FLUSH,
-            finishFlush: zlib.constants.Z_SYNC_FLUSH
-        });
-        this.compressor.on('data', (deflate) => {
-            this.compressorBuffer.push(deflate);
-        });
-    }
-
-    /**
-     * Enable encryption/decryption using Arc4 cipher.
-     * @param {Buffer} sessionKey - The session key from SRP authentication.
-     */
-    enableEncryption(sessionKey) {
-        this.encrypt = true;
-        this.encryptCipher = new Arc4(sessionKey);
-        this.decryptCipher = new Arc4(sessionKey);
-    }
-
-    /**
-     * Proxy trap.
-     */
-    get(target, field) {
-        if (field in this) {
-            return this[field].bind(this);
-        }
-
-        return target[field];
-    }
-}
-
-module.exports = Socket;
-module.exports.Arc4 = Arc4;

package/poc/node_modules/node-firebird/lib/wire/statement.js

@@ -1,48 +0,0 @@
-/***************************************
- *
- *   Statement
- *
- ***************************************/
-
-class Statement {
-    constructor(connection) {
-        this.connection = connection;
-    }
-
-    close(callback) {
-        this.connection.closeStatement(this, callback);
-    }
-
-    drop(callback) {
-        this.connection.dropStatement(this, callback);
-    }
-
-    release(callback) {
-        var cache_query = this.connection.getCachedQuery(this.query);
-        if (cache_query)
-            this.connection.closeStatement(this, callback);
-        else
-            this.connection.dropStatement(this, callback);
-    }
-
-    execute(transaction, params, callback, options) {
-        if (params instanceof Function) {
-            options = callback;
-            callback = params;
-            params = undefined;
-        }
-
-        this.options = options;
-        this.connection.executeStatement(transaction, this, params, callback, options);
-    }
-
-    fetch(transaction, count, callback) {
-        this.connection.fetch(this, transaction, count, callback);
-    }
-
-    fetchAll(transaction, callback) {
-        this.connection.fetchAll(this, transaction, callback);
-    }
-}
-
-module.exports = Statement;

package/poc/node_modules/node-firebird/package.json

@@ -1,38 +0,0 @@
-{
-    "name": "node-firebird",
-    "version": "2.3.1",
-    "description": "Pure JavaScript and Asynchronous Firebird client for Node.js.",
-    "keywords": [
-        "firebird",
-        "database",
-        "rdbms",
-        "sql"
-    ],
-    "homepage": "https://github.com/hgourvest/node-firebird",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/hgourvest/node-firebird.git"
-    },
-    "author": {
-        "name": "Henri Gourvest",
-        "email": "hgourvest@gmail.com"
-    },
-    "contributors": [
-        "Popa Marius Adrian <mapopa@gmail.com>",
-        "Peter Širka <petersirka@gmail.com>"
-    ],
-    "main": "./lib",
-    "types": "./lib/index.d.ts",
-    "license": "MPL-2.0",
-    "scripts": {
-        "test": "vitest run",
-        "lint": "oxlint"
-    },
-    "dependencies": {
-    },
-    "devDependencies": {
-        "coveralls-next": "^6.0.1",
-        "oxlint": "^0.15.11",
-        "vitest": "^4.0.18"
-    }
-}

package/poc/node_modules/node-firebird/vitest.config.js

@@ -1,24 +0,0 @@
-const { defineConfig } = require('vitest/config');
-
-module.exports = defineConfig({
-    test: {
-        globals: true,
-        testTimeout: 10000,
-        hookTimeout: 30000,
-        fileParallelism: false,
-        maxWorkers: 1,
-        isolate: false,
-        include: [
-            'test/arc4.js',
-            'test/protocol.js',
-            'test/srp.js',
-            'test/service.js',
-            'test/utf8-user-identification.js',
-            'test/index.js',
-            'test/db-crypt-config.js',
-            'test/timezone.js',
-            'test/decfloat.js',
-            'test/mock-server.js'
-        ],
-    },
-});

package/poc/package-lock.json

@@ -1,21 +0,0 @@
-{
-  "name": "node-firebird-pool-poc",
-  "version": "1.0.0",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {
-    "": {
-      "name": "node-firebird-pool-poc",
-      "version": "1.0.0",
-      "dependencies": {
-        "node-firebird": "^2.3.1"
-      }
-    },
-    "node_modules/node-firebird": {
-      "version": "2.3.1",
-      "resolved": "https://registry.npmjs.org/node-firebird/-/node-firebird-2.3.1.tgz",
-      "integrity": "sha512-3yTwiLHwgtLYRv+aS4frzsQEwHMDXkP5Z1SPM/W103TvMemVRoCIaxPYO7axnUrKhgTfPHGXzqC5umYlQail/w==",
-      "license": "MPL-2.0"
-    }
-  }
-}

package/poc/package.json

@@ -1,12 +0,0 @@
-{
-  "name": "node-firebird-pool-poc",
-  "version": "1.0.0",
-  "description": "Proof of concept for node-firebird pool bugs: _creating stuck, pending leak, post-destroy get()",
-  "scripts": {
-    "bug":   "node reproduce.js",
-    "fixed": "node reproduce-fixed.js"
-  },
-  "dependencies": {
-    "node-firebird": "^2.3.1"
-  }
-}

package/poc/reproduce-fixed.js

@@ -1,150 +0,0 @@
-'use strict';
-
-/**
- * reproduce-fixed.js — Validates all fixes in pool-patched.js.
- *
- * Uses the same fake TCP server from reproduce.js (accepts connections but never
- * responds to the Firebird wire protocol). The patched Pool is instantiated
- * directly with Firebird's original attach function, so no server-side changes
- * are needed and the fix is purely in lib/pool.js.
- *
- * ─── Fix 1 · connectTimeout in check() ──────────────────────────────────────
- *
- *   A new options.connectTimeout value (ms) wraps the attach() call with a
- *   setTimeout. If attach() does not complete in time:
- *     • _creating is decremented (slot freed)
- *     • cb(Error) is called immediately (no hanging Promise)
- *     • setImmediate(check) is triggered (next pending request can be served)
- *   If attach() eventually returns a db after the timeout, the connection is
- *   discarded via db.connection._pooled = false + db.detach() (no socket leak).
- *
- * ─── Fix 2 · _destroyed flag in get() and check() ──────────────────────────
- *
- *   pool.get() called after pool.destroy() is immediately rejected with
- *   "Pool has been destroyed". No silent accumulation in pending.
- *
- * ─── Fix 3 · _destroyed guard inside the attach() callback ─────────────────
- *
- *   If pool.destroy() is called while an attach() is in flight, the late-
- *   arriving connection is discarded and the caller is notified with an error.
- *
- * ─── Fix 4 · destroy() drains pending ───────────────────────────────────────
- *
- *   All callbacks queued in this.pending when destroy() is called receive an
- *   immediate "Pool is being destroyed" error instead of hanging forever.
- *
- * ─── Fix 5 · destroy() counts in-use connections ────────────────────────────
- *
- *   Connections currently in use (dbinuse) are now counted down so that the
- *   destroy() completion callback is not blocked when in-use connections exist.
- *
- * ─── How to run ──────────────────────────────────────────────────────────────
- *
- *   npm install
- *   node reproduce-fixed.js
- *
- * Expected: all callbacks receive proper errors, _creating returns to 0,
- * process exits cleanly with code 0.
- */
-
-const Firebird        = require('node-firebird');
-const PatchedPool     = require('../lib/pool');
-const { log, poolState, startFakeServer } = require('./helpers');
-
-const FAKE_PORT       = 13051; // different port from reproduce.js to avoid conflicts
-const CONNECT_TIMEOUT = 1500;  // 1.5 s — short for demo; use 5–10 s in production
-const TICK_MS         = 600;
-
-startFakeServer(FAKE_PORT, (server) => {
-
-    const options = {
-        host:           '127.0.0.1',
-        port:           FAKE_PORT,
-        database:       '/tmp/poc.fdb',
-        user:           'SYSDBA',
-        password:       'masterkey',
-        lowercase_keys: true,
-        isPool:         true,       // mirrors what exports.pool() adds internally
-        connectTimeout: CONNECT_TIMEOUT, // ← the new option (Fix 1)
-    };
-
-    // Instantiate the patched Pool directly with Firebird's original attach function.
-    // This is equivalent to what exports.pool() does internally:
-    //   return new Pool(exports.attach, max, Object.assign({}, options, { isPool: true }));
-    const pool = new PatchedPool(Firebird.attach, 5, options);
-
-    console.log('\n══════════════════════════════════════════════════════════════════');
-    console.log('  node-firebird · pool fix validation (pool-patched.js)');
-    console.log(`  connectTimeout = ${CONNECT_TIMEOUT} ms`);
-    console.log('══════════════════════════════════════════════════════════════════\n');
-
-    // ── Fix 1 ─────────────────────────────────────────────────────────────────
-    log('FIX-1', `pool.get() — attach() will hang, timeout fires after ${CONNECT_TIMEOUT} ms`);
-
-    pool.get((err, db) => {
-        if (err) log('FIX-1 ✓ OK    ', `callback received error (expected): "${err.message}"`);
-        else     log('FIX-1 ✗ WRONG ', `got db — should have timed out`);
-    });
-
-    let tick = 0;
-
-    const interval = setInterval(() => {
-        tick++;
-        log('pool-state', poolState(pool));
-
-        // ── Fix 2 + Fix 4 (setup) ─────────────────────────────────────────────
-        if (tick === 3) {
-            // At this point the connectTimeout for tick-1 has already fired
-            // (1500 ms < 3 × 600 ms = 1800 ms), so pool is idle again.
-            log('FIX-4', 'Queuing a get() in pending, then destroying pool immediately');
-
-            pool.get((err, db) => {
-                // [Fix 4] destroy() must drain this callback right away.
-                if (err) log('FIX-4 ✓ OK    ', `pending callback received error: "${err.message}"`);
-                else     log('FIX-4 ✗ WRONG ', `got db after destroy: ${!!db}`);
-            });
-
-            log('FIX-4', `Before destroy — ${poolState(pool)}`);
-
-            // Suspend check() by inflating _creating so our queued get() stays in pending.
-            // (In real usage a second concurrent pool.get() while one is stuck in attach()
-            //  would naturally be in pending — this simulates that scenario without timing
-            //  tricks that make the PoC fragile.)
-            pool._creating = 5; // fill all slots so check() won't serve the pending cb
-            pool.destroy();
-            pool._creating = 0; // reset (already orphaned pool, just for readable output)
-
-            log('FIX-4', `After  destroy — ${poolState(pool)}`);
-            log('FIX-4', '↑ pending callback fired SYNCHRONOUSLY inside destroy()');
-        }
-
-        // ── Fix 2 ──────────────────────────────────────────────────────────────
-        if (tick === 4) {
-            log('FIX-2', 'pool.get() AFTER pool.destroy() — must be rejected immediately');
-
-            pool.get((err, db) => {
-                // [Fix 2] _destroyed guard in get() rejects this synchronously.
-                if (err) log('FIX-2 ✓ OK    ', `immediately rejected: "${err.message}"`);
-                else     log('FIX-2 ✗ WRONG ', `got db after destroy: ${!!db}`);
-            });
-
-            log('FIX-2', `After post-destroy get — ${poolState(pool)}`);
-        }
-
-        // ── Summary ────────────────────────────────────────────────────────────
-        if (tick === 5) {
-            clearInterval(interval);
-
-            console.log('\n══════════════════════════════════════════════════════════════════');
-            log('SUMMARY', `Final state      : ${poolState(pool)}`);
-            log('SUMMARY', `Fix 1 confirmed  : _creating returned to 0 after ${CONNECT_TIMEOUT} ms timeout`);
-            log('SUMMARY', 'Fix 2 confirmed  : post-destroy get() rejected immediately (_destroyed flag)');
-            log('SUMMARY', 'Fix 4 confirmed  : pending callback drained synchronously by destroy()');
-            log('SUMMARY', 'Process exits cleanly — no hanging sockets or unresolved callbacks');
-            console.log('══════════════════════════════════════════════════════════════════\n');
-
-            server.close();
-            process.exit(0); // exit(0) = all fixes validated
-        }
-    }, TICK_MS);
-});

package/poc/reproduce.js

@@ -1,133 +0,0 @@
-'use strict';
-
-/**
- * reproduce.js — Demonstrates three bugs in node-firebird's Pool class (lib/pool.js).
- *
- * No real Firebird server is required. A fake TCP server (see helpers.js) accepts
- * connections but never responds to the Firebird wire protocol, triggering the bugs.
- *
- * ─── Bug 1 · _creating stuck forever ────────────────────────────────────────
- *
- *   In Pool.check(), when no idle connection exists:
- *
- *       self._creating++;
- *       this.attach(options, function(err, db) {
- *           self._creating--;   // ← only here
- *           ...
- *           cb(err, db);
- *       });
- *
- *   If attach() never calls back (TCP connects, but server stalls on Firebird
- *   protocol, e.g. SRP auth), _creating is never decremented. The pool slot is
- *   permanently locked. pool.get() callers wait forever.
- *
- * ─── Bug 2 · destroy() does not drain pending callbacks ─────────────────────
- *
- *   pool.destroy() only iterates this.internaldb (connected databases). Callbacks
- *   queued in this.pending (waiting for a free slot) are silently abandoned — they
- *   are never called, so any awaiting Promise hangs until the process exits.
- *
- *   Additionally, if any connection is currently in use (dbinuse > 0), the
- *   destroy() callback itself is never invoked because connectionCount never
- *   reached zero (the in-use branch falls through without calling detachCallback).
- *
- * ─── Bug 3 · pool.get() after pool.destroy() silently accumulates ────────────
- *
- *   There is no _destroyed guard. Calling pool.get() on a destroyed pool pushes
- *   the callback into this.pending and calls check(), which returns early because
- *   _destroyed is never checked. The callback is never served.
- *
- * ─── How to run ──────────────────────────────────────────────────────────────
- *
- *   npm install
- *   node reproduce.js
- *
- * Expected: process does NOT exit cleanly (hangs due to open sockets / pending
- * callbacks). Exit code 1 is forced after the demo to confirm bugs are present.
- */
-
-const Firebird        = require('node-firebird');
-const { log, poolState, startFakeServer } = require('./helpers');
-
-const FAKE_PORT   = 13050;
-const TICK_MS     = 600;   // interval between pool-state snapshots
-
-startFakeServer(FAKE_PORT, (server) => {
-
-    const options = {
-        host:           '127.0.0.1',
-        port:           FAKE_PORT,
-        database:       '/tmp/poc.fdb',
-        user:           'SYSDBA',
-        password:       'masterkey',
-        lowercase_keys: true,
-        isPool:         true,
-        // No connectTimeout — original (buggy) behaviour
-    };
-
-    const pool = Firebird.pool(5, options);
-
-    console.log('\n══════════════════════════════════════════════════════════════════');
-    console.log('  node-firebird · pool bug reproduction (original lib/pool.js)');
-    console.log('══════════════════════════════════════════════════════════════════\n');
-
-    // ── Bug 1 ─────────────────────────────────────────────────────────────────
-    log('BUG-1', 'pool.get() → TCP connects, Firebird protocol hangs, callback NEVER fires');
-
-    pool.get((err, db) => {
-        // ← BUG: this line is never reached
-        log('BUG-1 ✗ WRONG', `callback fired (unexpected): err=${err?.message} db=${!!db}`);
-    });
-
-    let tick = 0;
-
-    const interval = setInterval(() => {
-        tick++;
-        log('pool-state', poolState(pool));
-
-        // ── Bug 2 (setup) ──────────────────────────────────────────────────────
-        if (tick === 2) {
-            log('BUG-2', 'Queuing a second get() in pending, then calling destroy()');
-
-            pool.get((err, db) => {
-                // ← BUG: destroy() never calls this; the Promise hangs forever
-                if (err) log('BUG-2 ✓ OK    ', `pending callback received error: "${err.message}"`);
-                else     log('BUG-2 ✗ WRONG ', `got db unexpectedly: ${!!db}`);
-            });
-
-            log('BUG-2', `Before destroy — ${poolState(pool)}`);
-            pool.destroy();
-            log('BUG-2', `After  destroy — ${poolState(pool)}`);
-            log('BUG-2', '↑ pending callback was NEVER called — Promise hangs forever');
-        }
-
-        // ── Bug 3 ──────────────────────────────────────────────────────────────
-        if (tick === 3) {
-            log('BUG-3', 'pool.get() AFTER pool.destroy() — should be rejected immediately');
-
-            pool.get((err, db) => {
-                // ← BUG: no _destroyed guard; callback silently queued, never served
-                if (err) log('BUG-3 ✓ OK    ', `rejected: "${err.message}"`);
-                else     log('BUG-3 ✗ WRONG ', `got db after destroy: ${!!db}`);
-            });
-
-            log('BUG-3', `After post-destroy get — ${poolState(pool)}`);
-        }
-
-        // ── Summary ────────────────────────────────────────────────────────────
-        if (tick === 5) {
-            clearInterval(interval);
-
-            console.log('\n══════════════════════════════════════════════════════════════════');
-            log('SUMMARY', `Final state      : ${poolState(pool)}`);
-            log('SUMMARY', 'Bug 1 confirmed  : _creating=1, permanently stuck (slot lost)');
-            log('SUMMARY', 'Bug 2 confirmed  : pending callback from before destroy never fired');
-            log('SUMMARY', 'Bug 3 confirmed  : post-destroy get silently accumulated in pending');
-            log('SUMMARY', 'Process would hang forever without forced exit below');
-            console.log('══════════════════════════════════════════════════════════════════\n');
-
-            server.close();
-            process.exit(1); // exit(1) = bugs confirmed
-        }
-    }, TICK_MS);
-});

package/vitest.config.js

@@ -1,27 +0,0 @@
-const { defineConfig } = require('vitest/config');
-
-module.exports = defineConfig({
-    test: {
-        globals: true,
-        testTimeout: 10000,
-        hookTimeout: 30000,
-        fileParallelism: false,
-        maxWorkers: 1,
-        isolate: false,
-        include: [
-            'test/arc4.js',
-            'test/protocol.js',
-            'test/srp.js',
-            'test/service.js',
-            'test/utf8-user-identification.js',
-            'test/index.js',
-            'test/db-crypt-config.js',
-            'test/encoding.js',
-            'test/timezone.js',
-            'test/decfloat.js',
-            'test/mock-server.js',
-            'test/pool-fixes.js',
-            'test/blob-chunks.js'
-        ],
-    },
-});