Implement wire automatic reconnection
This commit is contained in:
parent
328cc63536
commit
00002525e4
@ -14,9 +14,9 @@ The glue for TypeScript to PostgreSQL.
|
|||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import pglue from "https://git.lua.re/luaneko/pglue/raw/tag/v0.1.3/mod.ts";
|
import pglue from "https://git.lua.re/luaneko/pglue/raw/tag/v0.2.0/mod.ts";
|
||||||
// ...or from github:
|
// ...or from github:
|
||||||
import pglue from "https://raw.githubusercontent.com/luaneko/pglue/refs/tags/v0.1.3/mod.ts";
|
import pglue from "https://raw.githubusercontent.com/luaneko/pglue/refs/tags/v0.2.0/mod.ts";
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"name": "@luaneko/pglue",
|
"name": "@luaneko/pglue",
|
||||||
"version": "0.1.3",
|
"version": "0.2.0",
|
||||||
"exports": "./mod.ts"
|
"exports": "./mod.ts"
|
||||||
}
|
}
|
||||||
|
12
mod.ts
12
mod.ts
@ -8,7 +8,7 @@ import {
|
|||||||
union,
|
union,
|
||||||
unknown,
|
unknown,
|
||||||
} from "./valita.ts";
|
} from "./valita.ts";
|
||||||
import { Pool, wire_connect, type LogLevel } from "./wire.ts";
|
import { Pool, wire_connect } from "./wire.ts";
|
||||||
import { sql_types, type SqlTypeMap } from "./query.ts";
|
import { sql_types, type SqlTypeMap } from "./query.ts";
|
||||||
|
|
||||||
export {
|
export {
|
||||||
@ -61,6 +61,7 @@ const ParsedOptions = object({
|
|||||||
runtime_params: record(string()).optional(() => ({})),
|
runtime_params: record(string()).optional(() => ({})),
|
||||||
max_connections: number().optional(() => 10),
|
max_connections: number().optional(() => 10),
|
||||||
idle_timeout: number().optional(() => 20),
|
idle_timeout: number().optional(() => 20),
|
||||||
|
reconnect_delay: number().optional(() => 5),
|
||||||
types: record(unknown())
|
types: record(unknown())
|
||||||
.optional(() => ({}))
|
.optional(() => ({}))
|
||||||
.map((types): SqlTypeMap => ({ ...sql_types, ...types })),
|
.map((types): SqlTypeMap => ({ ...sql_types, ...types })),
|
||||||
@ -101,10 +102,6 @@ export function connect(s: string, options: Options = {}) {
|
|||||||
|
|
||||||
postgres.connect = connect;
|
postgres.connect = connect;
|
||||||
|
|
||||||
export type PostgresEvents = {
|
|
||||||
log(level: LogLevel, ctx: object, msg: string): void;
|
|
||||||
};
|
|
||||||
|
|
||||||
export class Postgres extends Pool {
|
export class Postgres extends Pool {
|
||||||
readonly #options;
|
readonly #options;
|
||||||
|
|
||||||
@ -113,8 +110,9 @@ export class Postgres extends Pool {
|
|||||||
this.#options = options;
|
this.#options = options;
|
||||||
}
|
}
|
||||||
|
|
||||||
async connect() {
|
async connect(options: Options = {}) {
|
||||||
const wire = await wire_connect(this.#options);
|
const opts = ParsedOptions.parse({ ...this.#options, ...options });
|
||||||
|
const wire = await wire_connect(opts);
|
||||||
return wire.on("log", (l, c, s) => this.emit("log", l, c, s));
|
return wire.on("log", (l, c, s) => this.emit("log", l, c, s));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
68
wire.ts
68
wire.ts
@ -448,14 +448,15 @@ export interface WireOptions {
|
|||||||
readonly password: string;
|
readonly password: string;
|
||||||
readonly database: string | null;
|
readonly database: string | null;
|
||||||
readonly runtime_params: Record<string, string>;
|
readonly runtime_params: Record<string, string>;
|
||||||
|
readonly reconnect_delay: number;
|
||||||
readonly types: SqlTypeMap;
|
readonly types: SqlTypeMap;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type WireEvents = {
|
export type WireEvents = {
|
||||||
log(level: LogLevel, ctx: object, msg: string): void;
|
log(level: LogLevel, ctx: object, msg: string): void;
|
||||||
notice(notice: PostgresError): void;
|
notice(notice: PostgresError): void;
|
||||||
parameter(name: string, value: string, prev: string | null): void;
|
|
||||||
notify(channel: string, payload: string, process_id: number): void;
|
notify(channel: string, payload: string, process_id: number): void;
|
||||||
|
parameter(name: string, value: string, prev: string | null): void;
|
||||||
close(reason?: unknown): void;
|
close(reason?: unknown): void;
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -482,7 +483,10 @@ export async function wire_connect(options: WireOptions) {
|
|||||||
return await wire.connect(), wire;
|
return await wire.connect(), wire;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Wire extends TypedEmitter<WireEvents> implements Disposable {
|
export class Wire<V extends WireEvents = WireEvents>
|
||||||
|
extends TypedEmitter<V>
|
||||||
|
implements Disposable
|
||||||
|
{
|
||||||
readonly #params;
|
readonly #params;
|
||||||
readonly #connect;
|
readonly #connect;
|
||||||
readonly #query;
|
readonly #query;
|
||||||
@ -575,7 +579,16 @@ async function socket_connect(hostname: string, port: number) {
|
|||||||
|
|
||||||
function wire_impl(
|
function wire_impl(
|
||||||
wire: Wire,
|
wire: Wire,
|
||||||
{ host, port, user, database, password, runtime_params, types }: WireOptions
|
{
|
||||||
|
host,
|
||||||
|
port,
|
||||||
|
user,
|
||||||
|
database,
|
||||||
|
password,
|
||||||
|
runtime_params,
|
||||||
|
reconnect_delay,
|
||||||
|
types,
|
||||||
|
}: WireOptions
|
||||||
) {
|
) {
|
||||||
// current runtime parameters as reported by postgres
|
// current runtime parameters as reported by postgres
|
||||||
const params: Parameters = Object.create(null);
|
const params: Parameters = Object.create(null);
|
||||||
@ -586,6 +599,7 @@ function wire_impl(
|
|||||||
|
|
||||||
// wire supports re-connection; socket and read/write channels are null when closed
|
// wire supports re-connection; socket and read/write channels are null when closed
|
||||||
let connected = false;
|
let connected = false;
|
||||||
|
let should_reconnect = false;
|
||||||
let socket: Deno.Conn | null = null;
|
let socket: Deno.Conn | null = null;
|
||||||
let read_pop: Receiver<Uint8Array> | null = null;
|
let read_pop: Receiver<Uint8Array> | null = null;
|
||||||
let write_push: Sender<Uint8Array> | null = null;
|
let write_push: Sender<Uint8Array> | null = null;
|
||||||
@ -625,7 +639,7 @@ function wire_impl(
|
|||||||
} catch (e) {
|
} catch (e) {
|
||||||
throw (err = e);
|
throw (err = e);
|
||||||
} finally {
|
} finally {
|
||||||
if (connected) close(err);
|
onclose(err);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -640,6 +654,16 @@ function wire_impl(
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
case NotificationResponse.type: {
|
||||||
|
const { channel, payload, process_id } = ser_decode(
|
||||||
|
NotificationResponse,
|
||||||
|
msg
|
||||||
|
);
|
||||||
|
wire.emit("notify", channel, payload, process_id);
|
||||||
|
channels.get(channel)?.emit("notify", payload, process_id);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
case ParameterStatus.type: {
|
case ParameterStatus.type: {
|
||||||
const { name, value } = ser_decode(ParameterStatus, msg);
|
const { name, value } = ser_decode(ParameterStatus, msg);
|
||||||
const prev = params[name] ?? null;
|
const prev = params[name] ?? null;
|
||||||
@ -651,16 +675,6 @@ function wire_impl(
|
|||||||
wire.emit("parameter", name, value, prev);
|
wire.emit("parameter", name, value, prev);
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
case NotificationResponse.type: {
|
|
||||||
const { channel, payload, process_id } = ser_decode(
|
|
||||||
NotificationResponse,
|
|
||||||
msg
|
|
||||||
);
|
|
||||||
wire.emit("notify", channel, payload, process_id);
|
|
||||||
channels.get(channel)?.emit("notify", payload, process_id);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return false;
|
return false;
|
||||||
@ -688,7 +702,7 @@ function wire_impl(
|
|||||||
} catch (e) {
|
} catch (e) {
|
||||||
throw (err = e);
|
throw (err = e);
|
||||||
} finally {
|
} finally {
|
||||||
if (connected) close(err);
|
onclose(err);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -701,13 +715,26 @@ function wire_impl(
|
|||||||
read_pop = channel.receiver((push) => read_socket(s, push));
|
read_pop = channel.receiver((push) => read_socket(s, push));
|
||||||
write_push = channel.sender((pop) => write_socket(s, pop));
|
write_push = channel.sender((pop) => write_socket(s, pop));
|
||||||
await handle_auth(); // run auth with rw lock
|
await handle_auth(); // run auth with rw lock
|
||||||
connected = true;
|
(connected = true), (should_reconnect = reconnect_delay !== 0);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
throw (close(e), e);
|
throw (close(e), e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function reconnect() {
|
||||||
|
connect().catch((err) => {
|
||||||
|
log("warn", err as Error, `reconnect failed`);
|
||||||
|
setTimeout(reconnect, reconnect_delay);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
function close(reason?: unknown) {
|
function close(reason?: unknown) {
|
||||||
|
(should_reconnect = false), onclose(reason);
|
||||||
|
}
|
||||||
|
|
||||||
|
function onclose(reason?: unknown) {
|
||||||
|
if (!connected) return;
|
||||||
|
else connected = false;
|
||||||
socket?.close(), (socket = null);
|
socket?.close(), (socket = null);
|
||||||
read_pop?.close(reason), (read_pop = null);
|
read_pop?.close(reason), (read_pop = null);
|
||||||
write_push?.close(reason), (write_push = null);
|
write_push?.close(reason), (write_push = null);
|
||||||
@ -715,7 +742,8 @@ function wire_impl(
|
|||||||
delete (params as Record<string, string>)[name];
|
delete (params as Record<string, string>)[name];
|
||||||
st_cache.clear(), (st_ids = 0);
|
st_cache.clear(), (st_ids = 0);
|
||||||
(tx_status = "I"), (tx_stack.length = 0);
|
(tx_status = "I"), (tx_stack.length = 0);
|
||||||
connected &&= (wire.emit("close", reason), false);
|
should_reconnect &&= (setTimeout(reconnect, reconnect_delay), false);
|
||||||
|
wire.emit("close", reason);
|
||||||
}
|
}
|
||||||
|
|
||||||
// https://www.postgresql.org/docs/current/protocol-flow.html#PROTOCOL-FLOW-PIPELINING
|
// https://www.postgresql.org/docs/current/protocol-flow.html#PROTOCOL-FLOW-PIPELINING
|
||||||
@ -1390,7 +1418,7 @@ export type PoolEvents = {
|
|||||||
log(level: LogLevel, ctx: object, msg: string): void;
|
log(level: LogLevel, ctx: object, msg: string): void;
|
||||||
};
|
};
|
||||||
|
|
||||||
export interface PoolWire extends Wire {
|
export interface PoolWire<V extends WireEvents = WireEvents> extends Wire<V> {
|
||||||
readonly connection_id: number;
|
readonly connection_id: number;
|
||||||
readonly borrowed: boolean;
|
readonly borrowed: boolean;
|
||||||
release(): void;
|
release(): void;
|
||||||
@ -1400,8 +1428,8 @@ export interface PoolTransaction extends Transaction {
|
|||||||
readonly wire: PoolWire;
|
readonly wire: PoolWire;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Pool
|
export class Pool<V extends PoolEvents = PoolEvents>
|
||||||
extends TypedEmitter<PoolEvents>
|
extends TypedEmitter<V>
|
||||||
implements PromiseLike<PoolWire>, Disposable
|
implements PromiseLike<PoolWire>, Disposable
|
||||||
{
|
{
|
||||||
readonly #acquire;
|
readonly #acquire;
|
||||||
|
Loading…
Reference in New Issue
Block a user