postgrejs 2.22.7 → 2.23.0

package/cjs/protocol/frontend.js

@@ -1,255 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Frontend = void 0;
-const constants_js_1 = require("../constants.js");
-const encode_binaryarray_js_1 = require("../util/encode-binaryarray.js");
-const stringify_arrayliteral_js_1 = require("../util/stringify-arrayliteral.js");
-const protocol_js_1 = require("./protocol.js");
-const smart_buffer_js_1 = require("./smart-buffer.js");
-const DataFormat = protocol_js_1.Protocol.DataFormat;
-const StaticFlushBuffer = Buffer.from([
-    protocol_js_1.Protocol.FrontendMessageCode.Flush,
-    0x00,
-    0x00,
-    0x00,
-    0x04,
-]);
-const StaticTerminateBuffer = Buffer.from([
-    protocol_js_1.Protocol.FrontendMessageCode.Terminate,
-    0x00,
-    0x00,
-    0x00,
-    0x04,
-]);
-const StaticSyncBuffer = Buffer.from([
-    protocol_js_1.Protocol.FrontendMessageCode.Sync,
-    0x00,
-    0x00,
-    0x00,
-    0x04,
-]);
-class Frontend {
-    constructor(options) {
-        this._io = new smart_buffer_js_1.SmartBuffer(options?.buffer);
-    }
-    getSSLRequestMessage() {
-        return this._io
-            .start()
-            .writeUInt32BE(8) // Length of message contents in bytes, including self.
-            .writeUInt16BE(1234)
-            .writeUInt16BE(5679)
-            .flush();
-    }
-    getStartupMessage(args) {
-        const io = this._io
-            .start()
-            .writeInt32BE(0) // Preserve length
-            .writeInt16BE(protocol_js_1.Protocol.VERSION_MAJOR)
-            .writeInt16BE(protocol_js_1.Protocol.VERSION_MINOR);
-        for (const [k, v] of Object.entries(args)) {
-            if (k !== 'client_encoding')
-                io.writeCString(k, 'utf8').writeCString(v, 'utf8');
-        }
-        io.writeCString('client_encoding', 'utf8')
-            .writeCString('UTF8', 'utf8')
-            .writeUInt8(0);
-        return setLengthAndFlush(io, 0);
-    }
-    getPasswordMessage(password) {
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.PasswordMessage)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(password, 'utf8');
-        return setLengthAndFlush(io, 1);
-    }
-    getSASLMessage(sasl) {
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.PasswordMessage)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(sasl.mechanism, 'utf8')
-            .writeLString(sasl.clientFirstMessage);
-        return setLengthAndFlush(io, 1);
-    }
-    getSASLFinalMessage(session) {
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.PasswordMessage)
-            .writeInt32BE(0) // Preserve header
-            .writeString(session.clientFinalMessage);
-        return setLengthAndFlush(io, 1);
-    }
-    getParseMessage(args) {
-        if (args.statement && args.statement.length > 63)
-            throw new Error('Query name length must be lower than 63');
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Parse)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(args.statement || '', 'utf8')
-            .writeCString(args.sql, 'utf8')
-            .writeUInt16BE(args.paramTypes ? args.paramTypes.length : 0);
-        if (args.paramTypes) {
-            for (const t of args.paramTypes) {
-                io.writeUInt32BE(t || 0);
-            }
-        }
-        return setLengthAndFlush(io, 1);
-    }
-    getBindMessage(args) {
-        if (args.portal && args.portal.length > 63)
-            throw new Error('Portal name length must be lower than 63');
-        if (args.statement && args.statement.length > 63)
-            throw new Error('Query name length must be lower than 63');
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Bind)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(args.portal || '', 'utf8')
-            .writeCString(args.statement || '', 'utf8');
-        const { params, paramTypes, queryOptions } = args;
-        const columnFormat = queryOptions.columnFormat != null
-            ? queryOptions.columnFormat
-            : constants_js_1.DEFAULT_COLUMN_FORMAT;
-        if (params && params.length) {
-            io.writeInt16BE(params.length);
-            const formatOffset = io.offset;
-            for (let i = 0; i < params.length; i++) {
-                io.writeInt16BE(0); // Preserve
-            }
-            // Write parameter values
-            io.writeUInt16BE(params.length);
-            for (let i = 0; i < params?.length; i++) {
-                let v = params[i];
-                if (v === null || v === undefined) {
-                    io.writeInt32BE(-1);
-                    continue;
-                }
-                const dataTypeOid = paramTypes ? paramTypes[i] : undefined;
-                const dt = dataTypeOid ? args.typeMap.get(dataTypeOid) : undefined;
-                if (dt) {
-                    if (typeof dt.encodeAsNull === 'function' &&
-                        dt.encodeAsNull(v, queryOptions)) {
-                        io.writeInt32BE(-1);
-                        continue;
-                    }
-                    if (typeof dt.encodeBinary === 'function') {
-                        // Set param format to binary
-                        io.buffer.writeInt16BE(protocol_js_1.Protocol.DataFormat.binary, formatOffset + i * 2);
-                        // Preserve data length
-                        io.writeInt32BE(0);
-                        const dataOffset = io.offset;
-                        if (dt.elementsOID) {
-                            // If data type is array
-                            v = Array.isArray(v) ? v : [v];
-                            (0, encode_binaryarray_js_1.encodeBinaryArray)(io, v, dt.elementsOID, queryOptions, dt.encodeBinary, dt.encodeCalculateDim);
-                        }
-                        else {
-                            dt.encodeBinary(io, v, queryOptions);
-                        }
-                        io.buffer.writeInt32BE(io.length - dataOffset, dataOffset - 4); // Update length
-                    }
-                    else if (typeof dt.encodeText === 'function') {
-                        v = dt.elementsOID
-                            ? (0, stringify_arrayliteral_js_1.stringifyArrayLiteral)(v, queryOptions, dt.encodeText)
-                            : dt.encodeText(v, queryOptions);
-                        io.writeLString(v, 'utf8');
-                    }
-                }
-                else if (Buffer.isBuffer(v)) {
-                    // Set param format to binary
-                    io.buffer.writeInt16BE(protocol_js_1.Protocol.DataFormat.binary, formatOffset + i * 2);
-                    // Preserve data length
-                    io.writeInt32BE(0);
-                    const dataOffset = io.offset;
-                    io.writeBuffer(v);
-                    io.buffer.writeInt32BE(io.length - dataOffset, dataOffset - 4); // Update length
-                }
-                else {
-                    io.writeLString('' + v, 'utf8');
-                }
-            }
-        }
-        else {
-            io.writeUInt16BE(0);
-            io.writeUInt16BE(0);
-        }
-        if (Array.isArray(columnFormat)) {
-            io.writeUInt16BE(columnFormat.length);
-            for (let i = 0; i < columnFormat.length; i++) {
-                io.writeUInt16BE(columnFormat[i]);
-            }
-        }
-        else if (columnFormat === DataFormat.binary) {
-            io.writeUInt16BE(1);
-            io.writeUInt16BE(DataFormat.binary);
-        }
-        else
-            io.writeUInt16BE(0);
-        return setLengthAndFlush(io, 1);
-    }
-    getDescribeMessage(args) {
-        if (args.name && args.name.length > 63) {
-            throw new Error(args.type === 'P'
-                ? 'Portal'
-                : 'Statement name length must be lower than 63');
-        }
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Describe)
-            .writeInt32BE(0) // Preserve header
-            .writeUInt8(args.type.charCodeAt(0))
-            .writeCString(args.name || '', 'utf8');
-        return setLengthAndFlush(io, 1);
-    }
-    getExecuteMessage(args) {
-        if (args.fetchCount &&
-            (args.fetchCount < 0 || args.fetchCount > 4294967295)) {
-            throw new Error('fetchCount can be between 0 and 4294967295');
-        }
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Execute)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(args.portal || '', 'utf8')
-            .writeUInt32BE(args.fetchCount || 0);
-        return setLengthAndFlush(io, 1);
-    }
-    getCloseMessage(args) {
-        if (args.name && args.name.length > 63) {
-            throw new Error(args.type === 'P'
-                ? 'Portal'
-                : 'Statement name length must be lower than 63');
-        }
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Close)
-            .writeInt32BE(0) // Preserve header
-            .writeUInt8(args.type.charCodeAt(0))
-            .writeCString(args.name || '', 'utf8');
-        return setLengthAndFlush(io, 1);
-    }
-    getQueryMessage(sql) {
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Query)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(sql || '', 'utf8');
-        return setLengthAndFlush(io, 1);
-    }
-    getFlushMessage() {
-        return StaticFlushBuffer;
-    }
-    getTerminateMessage() {
-        return StaticTerminateBuffer;
-    }
-    getSyncMessage() {
-        return StaticSyncBuffer;
-    }
-}
-exports.Frontend = Frontend;
-function setLengthAndFlush(io, lengthOffset) {
-    io.buffer.writeUInt32BE(io.length - lengthOffset, lengthOffset);
-    return io.flush();
-}

package/cjs/protocol/pg-socket.js

@@ -1,367 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PgSocket = void 0;
-const tslib_1 = require("tslib");
-const node_crypto_1 = tslib_1.__importDefault(require("node:crypto"));
-const node_net_1 = tslib_1.__importDefault(require("node:net"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const node_tls_1 = tslib_1.__importDefault(require("node:tls"));
-const putil_promisify_1 = tslib_1.__importDefault(require("putil-promisify"));
-const constants_js_1 = require("../constants.js");
-const safe_event_emitter_js_1 = require("../safe-event-emitter.js");
-const backend_js_1 = require("./backend.js");
-const database_error_js_1 = require("./database-error.js");
-const frontend_js_1 = require("./frontend.js");
-const protocol_js_1 = require("./protocol.js");
-const sasl_js_1 = require("./sasl.js");
-const DEFAULT_PORT_NUMBER = 5432;
-const COMMAND_RESULT_PATTERN = /^([^\d]+)(?: (\d+)(?: (\d+))?)?$/;
-class PgSocket extends safe_event_emitter_js_1.SafeEventEmitter {
-    constructor(options) {
-        super();
-        this.options = options;
-        this._state = constants_js_1.ConnectionState.CLOSED;
-        this._backend = new backend_js_1.Backend();
-        this._sessionParameters = {};
-        this._frontend = new frontend_js_1.Frontend({ buffer: options.buffer });
-        this.setMaxListeners(99);
-    }
-    get state() {
-        if (!this._socket || this._socket.destroyed)
-            this._state = constants_js_1.ConnectionState.CLOSED;
-        return this._state;
-    }
-    get processID() {
-        return this._processID;
-    }
-    get secretKey() {
-        return this._secretKey;
-    }
-    get sessionParameters() {
-        return this._sessionParameters;
-    }
-    connect() {
-        if (this._socket)
-            return;
-        this._state = constants_js_1.ConnectionState.CONNECTING;
-        const options = this.options;
-        const socket = (this._socket = new node_net_1.default.Socket());
-        const errorHandler = (err) => {
-            this._state = constants_js_1.ConnectionState.CLOSED;
-            this._removeListeners();
-            this._reset();
-            socket.destroy();
-            this._socket = undefined;
-            this.emit('error', err);
-        };
-        const connectHandler = () => {
-            socket.setTimeout(0);
-            if (this.options.keepAlive || this.options.keepAlive == null)
-                socket.setKeepAlive(true);
-            socket.write(this._frontend.getSSLRequestMessage());
-            socket.once('data', x => {
-                this._removeListeners();
-                if (x.toString() === 'S') {
-                    const tslOptions = { ...options.ssl, socket };
-                    if (options.host && node_net_1.default.isIP(options.host) === 0)
-                        tslOptions.servername = options.host;
-                    const tlsSocket = (this._socket = node_tls_1.default.connect(tslOptions));
-                    tlsSocket.once('error', errorHandler);
-                    tlsSocket.once('secureConnect', () => {
-                        this._removeListeners();
-                        this._handleConnect();
-                    });
-                    return;
-                }
-                if (x.toString() === 'N') {
-                    if (options.requireSSL) {
-                        return errorHandler(new Error('Server does not support SSL connections'));
-                    }
-                    this._removeListeners();
-                    this._handleConnect();
-                    return;
-                }
-                return errorHandler(new Error('There was an error establishing an SSL connection'));
-            });
-        };
-        socket.setNoDelay(true);
-        socket.setTimeout(options.connectTimeoutMs || 30000, () => errorHandler(new Error('Connection timed out')));
-        socket.once('error', errorHandler);
-        socket.once('connect', connectHandler);
-        this.emit('connecting');
-        const port = options.port || DEFAULT_PORT_NUMBER;
-        if (options.host && options.host.startsWith('/')) {
-            socket.connect(node_path_1.default.join(options.host, '/.s.PGSQL.' + port));
-        }
-        else
-            socket.connect(options.port || DEFAULT_PORT_NUMBER, options.host || 'localhost');
-    }
-    close() {
-        if (!this._socket || this._socket.destroyed) {
-            this._state = constants_js_1.ConnectionState.CLOSED;
-            this._socket = undefined;
-            this._reset();
-            return;
-        }
-        if (this._state === constants_js_1.ConnectionState.CLOSING)
-            return;
-        const socket = this._socket;
-        this._state = constants_js_1.ConnectionState.CLOSING;
-        this._removeListeners();
-        socket.once('close', () => this._handleClose());
-        socket.destroy();
-    }
-    sendParseMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendParseMessage', args });
-        this._send(this._frontend.getParseMessage(args), cb);
-    }
-    sendBindMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendBindMessage', args });
-        this._send(this._frontend.getBindMessage(args), cb);
-    }
-    sendDescribeMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendDescribeMessage', args });
-        this._send(this._frontend.getDescribeMessage(args), cb);
-    }
-    sendExecuteMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendDescribeMessage', args });
-        this._send(this._frontend.getExecuteMessage(args), cb);
-    }
-    sendCloseMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendCloseMessage', args });
-        this._send(this._frontend.getCloseMessage(args), cb);
-    }
-    sendQueryMessage(sql, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendQueryMessage', sql });
-        this._send(this._frontend.getQueryMessage(sql), cb);
-    }
-    sendFlushMessage(cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendFlushMessage' });
-        this._send(this._frontend.getFlushMessage(), cb);
-    }
-    sendTerminateMessage(cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendTerminateMessage' });
-        this._send(this._frontend.getTerminateMessage(), cb);
-    }
-    sendSyncMessage() {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendSyncMessage' });
-        this._send(this._frontend.getSyncMessage());
-    }
-    capture(callback) {
-        if (this._state === constants_js_1.ConnectionState.CLOSING ||
-            this._state === constants_js_1.ConnectionState.CLOSED) {
-            return Promise.reject(new Error('Connection closed'));
-        }
-        if (this._state !== constants_js_1.ConnectionState.READY)
-            return Promise.reject(new Error('Connection is not ready'));
-        return new Promise((resolve, reject) => {
-            const done = (err, result) => {
-                this.removeListener('close', closeHandler);
-                this.removeListener('error', errorHandler);
-                this.removeListener('message', msgHandler);
-                if (err)
-                    reject(err);
-                else
-                    resolve(result);
-            };
-            const errorHandler = (err) => {
-                this.removeListener('close', closeHandler);
-                this.removeListener('message', msgHandler);
-                reject(err);
-            };
-            const closeHandler = () => {
-                this.removeListener('error', errorHandler);
-                this.removeListener('message', msgHandler);
-                reject(new Error('Connection closed'));
-            };
-            const msgHandler = (code, msg) => {
-                const x = callback(code, msg, done);
-                if (putil_promisify_1.default.isPromise(x))
-                    x.catch(err => done(err));
-            };
-            this.once('close', closeHandler);
-            this.once('error', errorHandler);
-            this.on('message', msgHandler);
-        });
-    }
-    _removeListeners() {
-        if (!this._socket)
-            return;
-        this._socket.removeAllListeners('error');
-        this._socket.removeAllListeners('connect');
-        this._socket.removeAllListeners('data');
-        this._socket.removeAllListeners('close');
-    }
-    _reset() {
-        this._backend.reset();
-        this._sessionParameters = {};
-        this._processID = undefined;
-        this._secretKey = undefined;
-        this._saslSession = undefined;
-    }
-    _handleConnect() {
-        const socket = this._socket;
-        if (!socket)
-            return;
-        this._state = constants_js_1.ConnectionState.AUTHORIZING;
-        this._reset();
-        socket.on('data', (data) => this._handleData(data));
-        socket.on('error', (err) => this._handleError(err));
-        socket.on('close', () => this._handleClose());
-        this._send(this._frontend.getStartupMessage({
-            user: this.options.user || 'postgres',
-            database: this.options.database || '',
-            application_name: this.options.applicationName || '',
-        }));
-    }
-    _handleClose() {
-        this._reset();
-        this._socket = undefined;
-        this._state = constants_js_1.ConnectionState.CLOSED;
-        this.emit('close');
-    }
-    _handleError(err) {
-        if (this._state !== constants_js_1.ConnectionState.READY) {
-            this._socket?.end();
-        }
-        this.emit('error', err);
-    }
-    _handleData(data) {
-        this._backend.parse(data, (code, payload) => {
-            try {
-                switch (code) {
-                    case protocol_js_1.Protocol.BackendMessageCode.Authentication:
-                        this._handleAuthenticationMessage(payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.ErrorResponse:
-                        this.emit('error', new database_error_js_1.DatabaseError(payload));
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.NoticeResponse:
-                        this.emit('notice', payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.NotificationResponse:
-                        this.emit('notification', payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.ParameterStatus:
-                        this._handleParameterStatus(payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.BackendKeyData:
-                        this._handleBackendKeyData(payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.ReadyForQuery:
-                        if (this._state !== constants_js_1.ConnectionState.READY) {
-                            this._state = constants_js_1.ConnectionState.READY;
-                            this.emit('ready');
-                        }
-                        else
-                            this.emit('message', code, payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.CommandComplete: {
-                        const msg = this._handleCommandComplete(payload);
-                        this.emit('message', code, msg);
-                        break;
-                    }
-                    default:
-                        this.emit('message', code, payload);
-                }
-            }
-            catch (e) {
-                this._handleError(e);
-            }
-        });
-    }
-    _resolvePassword(cb) {
-        (async () => {
-            const pass = typeof this.options.password === 'function'
-                ? await this.options.password()
-                : this.options.password;
-            cb(pass || '');
-        })().catch(err => this._handleError(err));
-    }
-    _handleAuthenticationMessage(msg) {
-        if (!msg) {
-            this.emit('authenticate');
-            return;
-        }
-        switch (msg.kind) {
-            case protocol_js_1.Protocol.AuthenticationMessageKind.CleartextPassword:
-                this._resolvePassword(password => {
-                    this._send(this._frontend.getPasswordMessage(password));
-                });
-                break;
-            case protocol_js_1.Protocol.AuthenticationMessageKind.MD5Password:
-                this._resolvePassword(password => {
-                    const md5 = (x) => node_crypto_1.default.createHash('md5').update(x, 'utf8').digest('hex');
-                    const l = md5(password + this.options.user);
-                    const r = md5(Buffer.concat([Buffer.from(l), msg.salt]));
-                    const pass = 'md5' + r;
-                    this._send(this._frontend.getPasswordMessage(pass));
-                });
-                break;
-            case protocol_js_1.Protocol.AuthenticationMessageKind.SASL: {
-                if (!msg.mechanisms.includes('SCRAM-SHA-256')) {
-                    throw new Error('SASL: Only mechanism SCRAM-SHA-256 is currently supported');
-                }
-                const saslSession = (this._saslSession = sasl_js_1.SASL.createSession(this.options.user || '', 'SCRAM-SHA-256'));
-                this._send(this._frontend.getSASLMessage(saslSession));
-                break;
-            }
-            case protocol_js_1.Protocol.AuthenticationMessageKind.SASLContinue: {
-                const saslSession = this._saslSession;
-                if (!saslSession)
-                    throw new Error('SASL: Session not started yet');
-                this._resolvePassword(password => {
-                    sasl_js_1.SASL.continueSession(saslSession, password, msg.data);
-                    const buf = this._frontend.getSASLFinalMessage(saslSession);
-                    this._send(buf);
-                });
-                break;
-            }
-            case protocol_js_1.Protocol.AuthenticationMessageKind.SASLFinal: {
-                const session = this._saslSession;
-                if (!session)
-                    throw new Error('SASL: Session not started yet');
-                sasl_js_1.SASL.finalizeSession(session, msg.data);
-                this._saslSession = undefined;
-                break;
-            }
-            default:
-                break;
-        }
-    }
-    _handleParameterStatus(msg) {
-        this._sessionParameters[msg.name] = msg.value;
-    }
-    _handleBackendKeyData(msg) {
-        this._processID = msg.processID;
-        this._secretKey = msg.secretKey;
-    }
-    _handleCommandComplete(msg) {
-        const m = msg.command && msg.command.match(COMMAND_RESULT_PATTERN);
-        const result = {
-            command: m[1],
-        };
-        if (m[3] != null) {
-            result.oid = parseInt(m[2], 10);
-            result.rowCount = parseInt(m[3], 10);
-        }
-        else if (m[2])
-            result.rowCount = parseInt(m[2], 10);
-        return result;
-    }
-    _send(data, cb) {
-        if (this._socket && this._socket.writable) {
-            this._socket.write(data, cb);
-        }
-    }
-}
-exports.PgSocket = PgSocket;