Skip to content

test(health): add response shape contract tests for healthy and degra… #1065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
namdamdoi68-oss wants to merge 1 commit into
base: main
Choose a base branch
from
Open

test(health): add response shape contract tests for healthy and degra… #1065

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions backend/tests/health.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,75 @@ describe('GET /health', () => {
expect(typeof res.body.indexerLag).toBe('number');
expect(typeof res.body.uptime).toBe('number');
});

describe('response shape contract assertions', () => {
const EXPECTED_HEALTH_KEYS = ['db', 'indexerEnabled', 'indexerLag', 'status', 'uptime'];

it('matches exact response shape contract in healthy state (200 OK)', async () => {
vi.stubEnv('STREAM_CONTRACT_ID', 'CSOME_CONTRACT_ADDRESS');
prismaMock.indexerState.findUnique.mockResolvedValue(makeState(15));

const res = await request(app).get('/health');
expect(res.status).toBe(200);

// Verify exact keys set
expect(Object.keys(res.body).sort()).toEqual(EXPECTED_HEALTH_KEYS);

// Verify type & contract values
expect(res.body).toEqual({
status: 'ok',
db: 'connected',
indexerEnabled: true,
indexerLag: expect.any(Number),
uptime: expect.any(Number),
});
expect(res.body.indexerLag).toBe(15);
expect(res.body.uptime).toBeGreaterThanOrEqual(0);
});

it('matches exact response shape contract in degraded state (indexer lagging > 60s -> 503)', async () => {
vi.stubEnv('STREAM_CONTRACT_ID', 'CSOME_CONTRACT_ADDRESS');
prismaMock.indexerState.findUnique.mockResolvedValue(makeState(120));

const res = await request(app).get('/health');
expect(res.status).toBe(503);

// Verify exact keys set
expect(Object.keys(res.body).sort()).toEqual(EXPECTED_HEALTH_KEYS);

// Verify type & contract values
expect(res.body).toEqual({
status: 'degraded',
db: 'connected',
indexerEnabled: true,
indexerLag: expect.any(Number),
uptime: expect.any(Number),
});
expect(res.body.indexerLag).toBe(120);
expect(res.body.uptime).toBeGreaterThanOrEqual(0);
});

it('matches exact response shape contract in degraded state (DB disconnected -> 503)', async () => {
vi.stubEnv('STREAM_CONTRACT_ID', 'CSOME_CONTRACT_ADDRESS');
prismaMock.$queryRaw.mockRejectedValue(new Error('DB Connection Error'));
prismaMock.indexerState.findUnique.mockResolvedValue(makeState(5));

const res = await request(app).get('/health');
expect(res.status).toBe(503);

// Verify exact keys set
expect(Object.keys(res.body).sort()).toEqual(EXPECTED_HEALTH_KEYS);

// Verify type & contract values
expect(res.body).toEqual({
status: 'degraded',
db: 'disconnected',
indexerEnabled: true,
indexerLag: 5,
uptime: expect.any(Number),
});
expect(res.body.uptime).toBeGreaterThanOrEqual(0);
});
});
});

Loading