mirror of
https://github.com/gristlabs/grist-core.git
synced 2026-03-02 04:09:24 +00:00
(core) Add options to /status health-check endpoints to check DB and Redis liveness.
Summary: - /status accepts new optional query parameters: db=1, redis=1, and timeout=<ms> (defaults to 10_000). - These verify that the server can make trivial calls to DB/Redis, and that they return within the timeout. - New HealthCheck tests simulates DB and Redis problems. - Added resilience to Redis reconnects (helped by a test case that simulates disconnects) - When closing Redis-based session store, disconnect from Redis (to avoid hanging tests) Some associated test reorg: - Move stripeTools out of test/nbrowser, and remove an unnecessary dependency, to avoid starting up browser for gen-server tests. - Move TcpForwarder to its own file, to use in the new test. Test Plan: Added a new HealthCheck test that simulates DB and Redis problems. Reviewers: georgegevoian Reviewed By: georgegevoian Differential Revision: https://phab.getgrist.com/D4054
This commit is contained in:
@@ -51,9 +51,11 @@ export class TestServer {
|
||||
// TypeORM doesn't give us a very clean way to shut down the db connection,
|
||||
// and node-sqlite3 has become fussier about this, and in regular tests
|
||||
// we substitute sqlite for postgres.
|
||||
for (let i = 0; i < 30; i++) {
|
||||
if (!this.server.getNotifier().testPending) { break; }
|
||||
await delay(100);
|
||||
if (this.server.hasNotifier()) {
|
||||
for (let i = 0; i < 30; i++) {
|
||||
if (!this.server.getNotifier().testPending) { break; }
|
||||
await delay(100);
|
||||
}
|
||||
}
|
||||
await removeConnection();
|
||||
}
|
||||
|
||||
@@ -2,7 +2,7 @@ import {Events as BackboneEvents} from 'backbone';
|
||||
import {promisifyAll} from 'bluebird';
|
||||
import {assert} from 'chai';
|
||||
import * as http from 'http';
|
||||
import {AddressInfo, Server, Socket} from 'net';
|
||||
import {AddressInfo} from 'net';
|
||||
import * as sinon from 'sinon';
|
||||
import WebSocket from 'ws';
|
||||
import * as path from 'path';
|
||||
@@ -16,8 +16,9 @@ import {Client, ClientMethod} from 'app/server/lib/Client';
|
||||
import {CommClientConnect} from 'app/common/CommTypes';
|
||||
import {delay} from 'app/common/delay';
|
||||
import {isLongerThan} from 'app/common/gutil';
|
||||
import {connect as connectSock, fromCallback, getAvailablePort, listenPromise} from 'app/server/lib/serverUtils';
|
||||
import {fromCallback, listenPromise} from 'app/server/lib/serverUtils';
|
||||
import {Sessions} from 'app/server/lib/Sessions';
|
||||
import {TcpForwarder} from 'test/server/tcpForwarder';
|
||||
import * as testUtils from 'test/server/testUtils';
|
||||
import * as session from '@gristlabs/express-session';
|
||||
|
||||
@@ -494,62 +495,3 @@ function getWSSettings(docWorkerUrl: string): GristWSSettings {
|
||||
warn() { (log as any).warn(...arguments); },
|
||||
};
|
||||
}
|
||||
|
||||
// We'll test reconnects by making a connection through this TcpForwarder, which we'll use to
|
||||
// simulate disconnects.
|
||||
export class TcpForwarder {
|
||||
public port: number|null = null;
|
||||
private _connections = new Map<Socket, Socket>();
|
||||
private _server: Server|null = null;
|
||||
|
||||
constructor(private _serverPort: number) {}
|
||||
|
||||
public async pickForwarderPort(): Promise<number> {
|
||||
this.port = await getAvailablePort(5834);
|
||||
return this.port;
|
||||
}
|
||||
public async connect() {
|
||||
await this.disconnect();
|
||||
this._server = new Server((sock) => this._onConnect(sock));
|
||||
await listenPromise(this._server.listen(this.port));
|
||||
}
|
||||
public async disconnectClientSide() {
|
||||
await Promise.all(Array.from(this._connections.keys(), destroySock));
|
||||
if (this._server) {
|
||||
await new Promise((resolve) => this._server!.close(resolve));
|
||||
this._server = null;
|
||||
}
|
||||
this.cleanup();
|
||||
}
|
||||
public async disconnectServerSide() {
|
||||
await Promise.all(Array.from(this._connections.values(), destroySock));
|
||||
this.cleanup();
|
||||
}
|
||||
public async disconnect() {
|
||||
await this.disconnectClientSide();
|
||||
await this.disconnectServerSide();
|
||||
}
|
||||
public cleanup() {
|
||||
const pairs = Array.from(this._connections.entries());
|
||||
for (const [clientSock, serverSock] of pairs) {
|
||||
if (clientSock.destroyed && serverSock.destroyed) {
|
||||
this._connections.delete(clientSock);
|
||||
}
|
||||
}
|
||||
}
|
||||
private async _onConnect(clientSock: Socket) {
|
||||
const serverSock = await connectSock(this._serverPort);
|
||||
clientSock.pipe(serverSock);
|
||||
serverSock.pipe(clientSock);
|
||||
clientSock.on('error', (err) => serverSock.destroy(err));
|
||||
serverSock.on('error', (err) => clientSock.destroy(err));
|
||||
this._connections.set(clientSock, serverSock);
|
||||
}
|
||||
}
|
||||
|
||||
async function destroySock(sock: Socket): Promise<void> {
|
||||
if (!sock.destroyed) {
|
||||
await new Promise((resolve, reject) =>
|
||||
sock.on('close', resolve).destroy());
|
||||
}
|
||||
}
|
||||
|
||||
61
test/server/tcpForwarder.ts
Normal file
61
test/server/tcpForwarder.ts
Normal file
@@ -0,0 +1,61 @@
|
||||
import {Server, Socket} from 'net';
|
||||
import {connect as connectSock, getAvailablePort, listenPromise} from 'app/server/lib/serverUtils';
|
||||
|
||||
// We'll test reconnects by making a connection through this TcpForwarder, which we'll use to
|
||||
// simulate disconnects.
|
||||
export class TcpForwarder {
|
||||
public port: number|null = null;
|
||||
private _connections = new Map<Socket, Socket>();
|
||||
private _server: Server|null = null;
|
||||
|
||||
constructor(private _serverPort: number, private _serverHost?: string) {}
|
||||
|
||||
public async pickForwarderPort(): Promise<number> {
|
||||
this.port = await getAvailablePort(5834);
|
||||
return this.port;
|
||||
}
|
||||
public async connect() {
|
||||
await this.disconnect();
|
||||
this._server = new Server((sock) => this._onConnect(sock));
|
||||
await listenPromise(this._server.listen(this.port));
|
||||
}
|
||||
public async disconnectClientSide() {
|
||||
await Promise.all(Array.from(this._connections.keys(), destroySock));
|
||||
if (this._server) {
|
||||
await new Promise((resolve) => this._server!.close(resolve));
|
||||
this._server = null;
|
||||
}
|
||||
this.cleanup();
|
||||
}
|
||||
public async disconnectServerSide() {
|
||||
await Promise.all(Array.from(this._connections.values(), destroySock));
|
||||
this.cleanup();
|
||||
}
|
||||
public async disconnect() {
|
||||
await this.disconnectClientSide();
|
||||
await this.disconnectServerSide();
|
||||
}
|
||||
public cleanup() {
|
||||
const pairs = Array.from(this._connections.entries());
|
||||
for (const [clientSock, serverSock] of pairs) {
|
||||
if (clientSock.destroyed && serverSock.destroyed) {
|
||||
this._connections.delete(clientSock);
|
||||
}
|
||||
}
|
||||
}
|
||||
private async _onConnect(clientSock: Socket) {
|
||||
const serverSock = await connectSock(this._serverPort, this._serverHost);
|
||||
clientSock.pipe(serverSock);
|
||||
serverSock.pipe(clientSock);
|
||||
clientSock.on('error', (err) => serverSock.destroy(err));
|
||||
serverSock.on('error', (err) => clientSock.destroy(err));
|
||||
this._connections.set(clientSock, serverSock);
|
||||
}
|
||||
}
|
||||
|
||||
async function destroySock(sock: Socket): Promise<void> {
|
||||
if (!sock.destroyed) {
|
||||
await new Promise((resolve, reject) =>
|
||||
sock.on('close', resolve).destroy());
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user