A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.
// SPDX-License-Identifier: AGPL-3.0-or-later
import {ConcurrencyLimitMiddleware} from '@app/api/middleware/ConcurrencyLimitMiddleware';
import type {HonoEnv} from '@app/api/types/HonoEnv';
import {AppErrorHandler} from '@fluxer/errors/src/domains/core/ErrorHandlers';
import {Hono} from 'hono';
import {describe, expect, test} from 'vitest';
interface Deferred {
promise: Promise<void>;
resolve: () => void;
}
function createDeferred(): Deferred {
let resolve: () => void = () => undefined;
const promise = new Promise<void>((resolveFn) => {
resolve = resolveFn;
});
return {promise, resolve};
}
function buildApp(maxInflightRequests: number) {
const release = createDeferred();
const entered = createDeferred();
const boomError = new Error('boom');
const routes = new Hono<HonoEnv>({strict: true});
routes.use(ConcurrencyLimitMiddleware({maxInflightRequests}));
routes.get('/_health', (ctx) => ctx.text('OK'));
routes.get('/_metrics', (ctx) => ctx.text('metrics'));
routes.get('/fast', (ctx) => ctx.text('fast'));
routes.get('/slow', async (ctx) => {
entered.resolve();
await release.promise;
return ctx.text('slow');
});
routes.get('/boom', () => {
throw boomError;
});
routes.onError(AppErrorHandler);
const app = new Hono<HonoEnv>({strict: true});
app.route('/v1', routes);
app.route('/', routes);
app.onError(AppErrorHandler);
return {app, release, entered};
}
describe('ConcurrencyLimitMiddleware', () => {
test('sheds with 503 once the in-flight ceiling is reached', async () => {
const {app, release, entered} = buildApp(1);
const inflight = app.request('/slow');
try {
await entered.promise;
const shed = await app.request('/fast');
expect(shed.status).toBe(503);
expect(shed.headers.get('Retry-After')).toBe('1');
expect(await shed.json()).toMatchObject({code: 'SERVICE_UNAVAILABLE'});
release.resolve();
expect((await inflight).status).toBe(200);
} finally {
release.resolve();
}
});
test('admits probe paths while shedding everything else', async () => {
const {app, release, entered} = buildApp(1);
const inflight = app.request('/slow');
try {
await entered.promise;
expect((await app.request('/_health')).status).toBe(200);
expect((await app.request('/_metrics')).status).toBe(200);
expect((await app.request('/v1/_health')).status).toBe(200);
expect((await app.request('/fast')).status).toBe(503);
release.resolve();
await inflight;
} finally {
release.resolve();
}
});
test('releases the slot when the handler throws', async () => {
const {app} = buildApp(1);
for (let attempt = 0; attempt < 3; attempt += 1) {
expect((await app.request('/boom')).status).toBe(500);
}
expect((await app.request('/fast')).status).toBe(200);
});
test('releases the slot taken by a shed request', async () => {
const {app, release, entered} = buildApp(1);
const inflight = app.request('/slow');
try {
await entered.promise;
expect((await app.request('/fast')).status).toBe(503);
expect((await app.request('/fast')).status).toBe(503);
release.resolve();
await inflight;
expect((await app.request('/fast')).status).toBe(200);
} finally {
release.resolve();
}
});
});